Namespace Google.Apis.AndroidEnterprise.v1

Classes

AndroidEnterpriseBaseServiceRequest<TResponse>

A base abstract class for AndroidEnterprise requests.

AndroidEnterpriseService.Scope

Available OAuth 2.0 scopes for use with the Google Play EMM API.

AndroidEnterpriseService.ScopeConstants

Available OAuth 2.0 scope constants for use with the Google Play EMM API.

DevicesResource.ForceReportUploadRequest

Uploads a report containing any changes in app states on the device since the last report was generated. You can call this method up to 3 times every 24 hours for a given device. If you exceed the quota, then the Google Play EMM API returns HTTP 429 Too Many Requests.

DevicesResource.GetRequest

Retrieves the details of a device.

DevicesResource.GetStateRequest

Retrieves whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.

DevicesResource.ListRequest

Retrieves the IDs of all of a user's devices.

DevicesResource.SetStateRequest

Sets whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.

DevicesResource.UpdateRequest

Updates the device policy. To ensure the policy is properly enforced, you need to prevent unmanaged accounts from accessing Google Play by setting the allowed_accounts in the managed configuration for the Google Play package. See restrict accounts in Google Play. When provisioning a new device, you should set the device policy using this method before adding the managed Google Play Account to the device, otherwise the policy will not be applied for a short period of time after adding the account to the device.

EnrollmentTokensResource

The "enrollmentTokens" collection of methods.

EnrollmentTokensResource.CreateRequest

Returns a token for device enrollment. The DPC can encode this token within the QR/NFC/zero-touch enrollment payload or fetch it before calling the on-device API to authenticate the user. The token can be generated for each device or reused across multiple devices.

EnterprisesResource

The "enterprises" collection of methods.

EnterprisesResource.AcknowledgeNotificationSetRequest

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

EnterprisesResource.CompleteSignupRequest

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.

EnterprisesResource.CreateWebTokenRequest

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.

EnterprisesResource.EnrollRequest

Enrolls an enterprise with the calling EMM.

EnterprisesResource.GenerateEnterpriseUpgradeUrlRequest

Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. Note: This feature is not generally available.

EnterprisesResource.GenerateSignupUrlRequest

Generates a sign-up URL.

EnterprisesResource.GetRequest

Retrieves the name and domain of an enterprise.

EnterprisesResource.GetServiceAccountRequest

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. 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. Note: After you create a key, you might need to wait for 60 seconds or more before you perform another operation with the key. If you try to perform an operation with the key immediately after you create the key, and you receive an error, you can retry the request with exponential backoff .

EnterprisesResource.GetStoreLayoutRequest

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.

EnterprisesResource.ListRequest

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.

EnterprisesResource.PullNotificationSetRequest

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. 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.

EnterprisesResource.SendTestPushNotificationRequest

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

EnterprisesResource.SetAccountRequest

Sets the account that will be used to authenticate to the API as the enterprise.

EnterprisesResource.SetStoreLayoutRequest

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). 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.

EnterprisesResource.UnenrollRequest

Unenrolls an enterprise from the calling EMM.

EntitlementsResource

The "entitlements" collection of methods.

EntitlementsResource.DeleteRequest

Removes an entitlement to an app for a user. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

EntitlementsResource.GetRequest

Retrieves details of an entitlement. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

EntitlementsResource.ListRequest

Lists all entitlements for the specified user. Only the ID is set. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

EntitlementsResource.UpdateRequest

Adds or updates an entitlement to an app for a user. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

GrouplicensesResource

The "grouplicenses" collection of methods.

GrouplicensesResource.GetRequest

Retrieves details of an enterprise's group license for a product. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

GrouplicensesResource.ListRequest

Retrieves IDs of all products for which the enterprise has a group license. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

GrouplicenseusersResource

The "grouplicenseusers" collection of methods.

GrouplicenseusersResource.ListRequest

Retrieves the IDs of the users who have been granted entitlements under the license. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

InstallsResource

The "installs" collection of methods.

InstallsResource.DeleteRequest

Requests to remove an app from a device. A call to get or list will still show the app as installed on the device until it is actually removed. A successful response indicates that a removal request has been sent to the device. The call will be considered successful even if the app is not present on the device (e.g. it was never installed, or was removed by the user).

InstallsResource.GetRequest

Retrieves details of an installation of an app on a device.

InstallsResource.ListRequest

Retrieves the details of all apps installed on the specified device.

InstallsResource.UpdateRequest

Requests to install the latest version of an app to a device. If the app is already installed, then it is updated to the latest version if necessary.

ManagedconfigurationsfordeviceResource

The "managedconfigurationsfordevice" collection of methods.

ManagedconfigurationsfordeviceResource.DeleteRequest

Removes a per-device managed configuration for an app for the specified device.

ManagedconfigurationsfordeviceResource.GetRequest

Retrieves details of a per-device managed configuration.

ManagedconfigurationsfordeviceResource.ListRequest

Lists all the per-device managed configurations for the specified device. Only the ID is set.

ManagedconfigurationsfordeviceResource.UpdateRequest

Adds or updates a per-device managed configuration for an app for the specified device.

ManagedconfigurationsforuserResource

The "managedconfigurationsforuser" collection of methods.

ManagedconfigurationsforuserResource.DeleteRequest

Removes a per-user managed configuration for an app for the specified user.

ManagedconfigurationsforuserResource.GetRequest

Retrieves details of a per-user managed configuration for an app for the specified user.

ManagedconfigurationsforuserResource.ListRequest

Lists all the per-user managed configurations for the specified user. Only the ID is set.

ManagedconfigurationsforuserResource.UpdateRequest

Adds or updates the managed configuration settings for an app for the specified user. If you support the Managed configurations iframe, you can apply managed configurations to a user by specifying an mcmId and its associated configuration variables (if any) in the request. Alternatively, all EMMs can apply managed configurations by passing a list of managed properties.

ManagedconfigurationssettingsResource

The "managedconfigurationssettings" collection of methods.

ManagedconfigurationssettingsResource.ListRequest

Lists all the managed configurations settings for the specified app.

PermissionsResource

The "permissions" collection of methods.

PermissionsResource.GetRequest

Retrieves details of an Android app permission for display to an enterprise admin.

ProductsResource

The "products" collection of methods.

ProductsResource.ApproveRequest

Approves the specified product and the relevant app permissions, if any. The maximum number of products that you can approve per enterprise customer is 1,000. To learn how to use managed Google Play to design and create a store layout to display approved products to your users, see Store Layout Design. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

ProductsResource.GenerateApprovalUrlRequest

Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product. Admins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to approve the product. This URL can only be used to display permissions for up to 1 day. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

ProductsResource.GetAppRestrictionsSchemaRequest

Retrieves the schema that defines the configurable properties for this product. All products have a schema, but this schema may be empty if no managed configurations have been defined. This schema can be used to populate a UI that allows an admin to configure the product. To apply a managed configuration based on the schema obtained using this API, see Managed Configurations through Play.

ProductsResource.GetPermissionsRequest

Retrieves the Android app permissions required by this app.

ProductsResource.GetRequest

Retrieves details of a product for display to an enterprise admin.

ProductsResource.ListRequest

Finds approved products that match a query, or all approved products if there is no query. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

ProductsResource.UnapproveRequest

Unapproves the specified product (and the relevant app permissions, if any) Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

ServiceaccountkeysResource

The "serviceaccountkeys" collection of methods.

ServiceaccountkeysResource.DeleteRequest

Removes and invalidates the specified credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.

ServiceaccountkeysResource.InsertRequest

Generates new credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount. Only the type of the key should be populated in the resource to be inserted.

ServiceaccountkeysResource.ListRequest

Lists all active credentials for the service account associated with this enterprise. Only the ID and key type are returned. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.

StorelayoutclustersResource

The "storelayoutclusters" collection of methods.

StorelayoutclustersResource.DeleteRequest

Deletes a cluster.

StorelayoutclustersResource.GetRequest

Retrieves details of a cluster.

StorelayoutclustersResource.InsertRequest

Inserts a new cluster in a page.

StorelayoutclustersResource.ListRequest

Retrieves the details of all clusters on the specified page.

StorelayoutclustersResource.UpdateRequest

Updates a cluster.

StorelayoutpagesResource

The "storelayoutpages" collection of methods.

StorelayoutpagesResource.DeleteRequest

Deletes a store page.

StorelayoutpagesResource.GetRequest

Retrieves details of a store page.

StorelayoutpagesResource.InsertRequest

Inserts a new store page.

StorelayoutpagesResource.ListRequest

Retrieves the details of all pages in the store.

StorelayoutpagesResource.UpdateRequest

Updates the content of a store page.

UsersResource

The "users" collection of methods.

UsersResource.DeleteRequest

Deleted an EMM-managed user.

UsersResource.GenerateAuthenticationTokenRequest

Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device. The generated token is single-use and expires after a few minutes. You can provision a maximum of 10 devices per user. This call only works with EMM-managed accounts.

UsersResource.GetAvailableProductSetRequest

Retrieves the set of products a user is entitled to access. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

UsersResource.GetRequest

Retrieves a user's details.

UsersResource.InsertRequest

Creates a new EMM-managed user. The Users resource passed in the body of the request should include an accountIdentifier and an accountType. If a corresponding user already exists with the same account identifier, the user will be updated with the resource. In this case only the displayName field can be changed.

UsersResource.ListRequest

Looks up a user by primary email address. This is only supported for Google-managed users. Lookup of the id is not needed for EMM-managed users because the id is already returned in the result of the Users.insert call.

UsersResource.RevokeDeviceAccessRequest

Revokes access to all devices currently provisioned to the user. The user will no longer be able to use the managed Play store on any of their managed devices. This call only works with EMM-managed accounts.

UsersResource.SetAvailableProductSetRequest

Modifies the set of products that a user is entitled to access (referred to as whitelisted products). Only products that are approved or products that were previously approved (products with revoked approval) can be whitelisted. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

UsersResource.UpdateRequest

Updates the details of an EMM-managed user. Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value.

WebappsResource

The "webapps" collection of methods.

WebappsResource.DeleteRequest

Deletes an existing web app.

WebappsResource.GetRequest

Gets an existing web app.

WebappsResource.InsertRequest

Creates a new web app for the enterprise.

WebappsResource.ListRequest

Retrieves the details of all web apps for a given enterprise.

WebappsResource.UpdateRequest

Updates an existing web app.

Enums

AndroidEnterpriseBaseServiceRequest<TResponse>.AltEnum

Data format for response.

AndroidEnterpriseBaseServiceRequest<TResponse>.XgafvEnum

V1 error format.

EnterprisesResource.GetServiceAccountRequest.KeyTypeEnum

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

EnterprisesResource.PullNotificationSetRequest.RequestModeEnum

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. Specifying 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.