Documentation

Google_Service_AndroidEnterprise_Resource_Enterprises extends Google_Service_Resource
in package

The "enterprises" collection of methods.

Typical usage is: $androidenterpriseService = new Google_Service_AndroidEnterprise(...); $enterprises = $androidenterpriseService->enterprises;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
acknowledgeNotificationSet()  : mixed
Acknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications. (enterprises.acknowledgeNotificationSet)
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
completeSignup()  : Google_Service_AndroidEnterprise_Enterprise
Completes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token. (enterprises.completeSignup)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
createWebToken()  : Google_Service_AndroidEnterprise_AdministratorWebToken
Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information. (enterprises.createWebToken)
enroll()  : Google_Service_AndroidEnterprise_Enterprise
Enrolls an enterprise with the calling EMM. (enterprises.enroll)
generateSignupUrl()  : Google_Service_AndroidEnterprise_SignupInfo
Generates a sign-up URL. (enterprises.generateSignupUrl)
get()  : Google_Service_AndroidEnterprise_Enterprise
Retrieves the name and domain of an enterprise. (enterprises.get)
getServiceAccount()  : Google_Service_AndroidEnterprise_ServiceAccount
Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound.
getStoreLayout()  : Google_Service_AndroidEnterprise_StoreLayout
Returns the store layout for the enterprise. If the store layout has not been set, returns "basic" as the store layout type and no homepage.
listEnterprises()  : Google_Service_AndroidEnterprise_EnterprisesListResponse
Looks up an enterprise by domain name. This is only supported for enterprises created via the Google-initiated creation flow. Lookup of the id is not needed for enterprises created via the EMM-initiated flow since the EMM learns the enterprise ID in the callback specified in the Enterprises.generateSignupUrl call. (enterprises.listEnterprises)
pullNotificationSet()  : Google_Service_AndroidEnterprise_NotificationSet
Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending. A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty.
sendTestPushNotification()  : Google_Service_AndroidEnterprise_EnterprisesSendTestPushNotificationResponse
Sends a test notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.
setAccount()  : Google_Service_AndroidEnterprise_EnterpriseAccount
Sets the account that will be used to authenticate to the API as the enterprise. (enterprises.setAccount)
setStoreLayout()  : Google_Service_AndroidEnterprise_StoreLayout
Sets the store layout for the enterprise. By default, storeLayoutType is set to "basic" and the basic store layout is enabled. The basic layout only contains apps approved by the admin, and that have been added to the available product set for a user (using the setAvailableProductSet call).
unenroll()  : mixed
Unenrolls an enterprise from the calling EMM. (enterprises.unenroll)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

acknowledgeNotificationSet()

Acknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications. (enterprises.acknowledgeNotificationSet)

public acknowledgeNotificationSet([array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string notificationSetId The notification set ID as returned by Enterprises.PullNotificationSet. This must be provided.

Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

completeSignup()

Completes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token. (enterprises.completeSignup)

public completeSignup([array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_Enterprise
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string enterpriseToken The Enterprise token appended to the Callback URL.

opt_param

string completionToken The Completion token initially returned by GenerateSignupUrl.

Return values
Google_Service_AndroidEnterprise_Enterprise —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

createWebToken()

Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information. (enterprises.createWebToken)

public createWebToken(string $enterpriseId, Google_Service_AndroidEnterprise_AdministratorWebTokenSpec $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_AdministratorWebToken
Parameters
$enterpriseId : string

The ID of the enterprise.

$postBody : Google_Service_AndroidEnterprise_AdministratorWebTokenSpec
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_AndroidEnterprise_AdministratorWebToken —

enroll()

Enrolls an enterprise with the calling EMM. (enterprises.enroll)

public enroll(string $token, Google_Service_AndroidEnterprise_Enterprise $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_Enterprise
Parameters
$token : string

Required. The token provided by the enterprise to register the EMM.

$postBody : Google_Service_AndroidEnterprise_Enterprise
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_AndroidEnterprise_Enterprise —

generateSignupUrl()

Generates a sign-up URL. (enterprises.generateSignupUrl)

public generateSignupUrl([array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_SignupInfo
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string callbackUrl The callback URL to which the Admin will be redirected after successfully creating an enterprise. Before redirecting there the system will add a single query parameter to this URL named "enterpriseToken" which will contain an opaque token to be used for the CompleteSignup request. Beware that this means that the URL will be parsed, the parameter added and then a new URL formatted, i.e. there may be some minor formatting changes and, more importantly, the URL must be well-formed so that it can be parsed.

Return values
Google_Service_AndroidEnterprise_SignupInfo —

getServiceAccount()

Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound.

public getServiceAccount(string $enterpriseId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_ServiceAccount

The credentials contain private key data and are not stored server-side. This method can only be called after calling Enterprises.Enroll or Enterprises.CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error. Subsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials. Once the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource. (enterprises.getServiceAccount)

Parameters
$enterpriseId : string

The ID of the enterprise.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string keyType The type of credential to return with the service account. Required.

Return values
Google_Service_AndroidEnterprise_ServiceAccount —

getStoreLayout()

Returns the store layout for the enterprise. If the store layout has not been set, returns "basic" as the store layout type and no homepage.

public getStoreLayout(string $enterpriseId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_StoreLayout

(enterprises.getStoreLayout)

Parameters
$enterpriseId : string

The ID of the enterprise.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_AndroidEnterprise_StoreLayout —

listEnterprises()

Looks up an enterprise by domain name. This is only supported for enterprises created via the Google-initiated creation flow. Lookup of the id is not needed for enterprises created via the EMM-initiated flow since the EMM learns the enterprise ID in the callback specified in the Enterprises.generateSignupUrl call. (enterprises.listEnterprises)

public listEnterprises(string $domain[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_EnterprisesListResponse
Parameters
$domain : string

Required. The exact primary domain name of the enterprise to look up.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_AndroidEnterprise_EnterprisesListResponse —

pullNotificationSet()

Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending. A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty.

public pullNotificationSet([array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_NotificationSet

Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy. Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending. If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available. (enterprises.pullNotificationSet)

Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestMode The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.

Return values
Google_Service_AndroidEnterprise_NotificationSet —

sendTestPushNotification()

Sends a test notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.

public sendTestPushNotification(string $enterpriseId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_EnterprisesSendTestPushNotificationResponse

(enterprises.sendTestPushNotification)

Parameters
$enterpriseId : string

The ID of the enterprise.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_AndroidEnterprise_EnterprisesSendTestPushNotificationResponse —

setAccount()

Sets the account that will be used to authenticate to the API as the enterprise. (enterprises.setAccount)

public setAccount(string $enterpriseId, Google_Service_AndroidEnterprise_EnterpriseAccount $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_EnterpriseAccount
Parameters
$enterpriseId : string

The ID of the enterprise.

$postBody : Google_Service_AndroidEnterprise_EnterpriseAccount
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_AndroidEnterprise_EnterpriseAccount —

setStoreLayout()

Sets the store layout for the enterprise. By default, storeLayoutType is set to "basic" and the basic store layout is enabled. The basic layout only contains apps approved by the admin, and that have been added to the available product set for a user (using the setAvailableProductSet call).

public setStoreLayout(string $enterpriseId, Google_Service_AndroidEnterprise_StoreLayout $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_StoreLayout

Apps on the page are sorted in order of their product ID value. If you create a custom store layout (by setting storeLayoutType = "custom" and setting a homepage), the basic store layout is disabled. (enterprises.setStoreLayout)

Parameters
$enterpriseId : string

The ID of the enterprise.

$postBody : Google_Service_AndroidEnterprise_StoreLayout
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_AndroidEnterprise_StoreLayout —

unenroll()

Unenrolls an enterprise from the calling EMM. (enterprises.unenroll)

public unenroll(string $enterpriseId[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$enterpriseId : string

The ID of the enterprise.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
mixed —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results