Google Play EMM API
Manages the deployment of apps to Android Enterprise devices.
Developer tools#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Manages the deployment of apps to Android Enterprise devices.
Endpoints 77
devices
- POSTUploads a report containing any changes in app states on the device since the last report was generated
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/devices/:deviceId/forceReportUploadUploads 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… - GETRetrieves the details of a device.
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/devices/:deviceIdRetrieves the details of a device. - PUTUpdates the device policy
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/devices/:deviceId?updateMask=stringUpdates the device policy. To ensure the policy is properly enforced, you need to prevent unmanaged accounts from accessing Google Play by setting the… - GETChecks if a device can access Google apps and services for a user
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/devices/:deviceId/stateChecks if a device can access Google apps and services for a user. Returns whether access is "enabled" or "disabled". A "disabled" state prevents the user's… - PUTSets whether a device's access to Google services (including Google Play) is enabled or disabled for the specified user
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/devices/:deviceId/stateSets whether a device's access to Google services (including Google Play) is enabled or disabled for the specified user. Setting the state to "enabled" allows… - GETRetrieves the IDs of all of a user's devices.
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/devicesRetrieves the IDs of all of a user's devices.
enrollmentTokens
- POSTReturns a token for device enrollment
/androidenterprise/v1/enterprises/:enterpriseId/enrollmentTokensReturns 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…
enterprises
- POSTAcknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from…
/androidenterprise/v1/enterprises/acknowledgeNotificationSet?notificationSetId=stringAcknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications. - POSTCompletes the signup flow, by specifying the Completion token and Enterprise token
/androidenterprise/v1/enterprises/completeSignup?completionToken=string&enterpriseToken=stringCompletes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token. - POSTReturns a unique token to access an embeddable UI
/androidenterprise/v1/enterprises/:enterpriseId/createWebTokenReturns 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… - POSTEnrolls an enterprise with the calling EMM.
/androidenterprise/v1/enterprises/enroll?token=stringEnrolls an enterprise with the calling EMM. - POSTGenerates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google…
/androidenterprise/v1/enterprises/:enterpriseId/generateEnterpriseUpgradeUrl?adminEmail=string&allowedDomains=stringGenerates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. See the guide to upgrading an… - POSTGenerates a sign-up URL.
/androidenterprise/v1/enterprises/signupUrl?adminEmail=string&allowedDomains=string&callbackUrl=stringGenerates a sign-up URL. - GETRetrieves the name and domain of an enterprise.
/androidenterprise/v1/enterprises/:enterpriseIdRetrieves the name and domain of an enterprise. - GETReturns a service account and credentials
/androidenterprise/v1/enterprises/:enterpriseId/serviceAccount?keyType=googleCredentialsReturns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this… - GETReturns the store layout for the enterprise
/androidenterprise/v1/enterprises/:enterpriseId/storeLayoutReturns the store layout for the enterprise. If the store layout has not been set, returns "basic" as the store layout type and no homepage. - PUTSets the store layout for the enterprise
/androidenterprise/v1/enterprises/:enterpriseId/storeLayoutSets 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… - GETLooks up an enterprise by domain name
/androidenterprise/v1/enterprises?domain=stringLooks 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… - POSTPulls and returns a notification set for the enterprises associated with the service account authenticated for the…
/androidenterprise/v1/enterprises/pullNotificationSet?requestMode=waitForNotificationsPulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty… - POSTSends a test notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.
/androidenterprise/v1/enterprises/:enterpriseId/sendTestPushNotificationSends a test notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise. - PUTSets the account that will be used to authenticate to the API as the enterprise.
/androidenterprise/v1/enterprises/:enterpriseId/accountSets the account that will be used to authenticate to the API as the enterprise. - POSTUnenrolls an enterprise from the calling EMM.
/androidenterprise/v1/enterprises/:enterpriseId/unenrollUnenrolls an enterprise from the calling EMM.
entitlements
- GETRetrieves details of an entitlement
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/entitlements/:entitlementIdRetrieves details of an entitlement. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations. - PUTAdds or updates an entitlement to an app for a user
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/entitlements/:entitlementId?install=trueAdds 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… - DELETERemoves an entitlement to an app for a user
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/entitlements/:entitlementIdRemoves 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… - GETLists all entitlements for the specified user
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/entitlementsLists 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…
grouplicenses
- GETRetrieves details of an enterprise's group license for a product
/androidenterprise/v1/enterprises/:enterpriseId/groupLicenses/:groupLicenseIdRetrieves 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… - GETRetrieves IDs of all products for which the enterprise has a group license
/androidenterprise/v1/enterprises/:enterpriseId/groupLicensesRetrieves 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…
grouplicenseusers
- GETRetrieves the IDs of the users who have been granted entitlements under the license
/androidenterprise/v1/enterprises/:enterpriseId/groupLicenses/:groupLicenseId/usersRetrieves the IDs of the users who have been granted entitlements under the license. Note: This item has been deprecated. New integrations cannot use this…
installs
- GETRetrieves details of an installation of an app on a device.
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/devices/:deviceId/installs/:installIdRetrieves details of an installation of an app on a device. - PUTRequests to install the latest version of an app to a device
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/devices/:deviceId/installs/:installIdRequests 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. - DELETERequests to remove an app from a device
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/devices/:deviceId/installs/:installIdRequests 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… - GETRetrieves the details of all apps installed on the specified device.
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/devices/:deviceId/installsRetrieves the details of all apps installed on the specified device.
managedconfigurationsfordevice
- GETRetrieves details of a per-device managed configuration.
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/devices/:deviceId/managedConfigurationsForDevice/:managedConfigurationForDeviceIdRetrieves details of a per-device managed configuration. - PUTAdds or updates a per-device managed configuration for an app for the specified device.
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/devices/:deviceId/managedConfigurationsForDevice/:managedConfigurationForDeviceIdAdds or updates a per-device managed configuration for an app for the specified device. - DELETERemoves a per-device managed configuration for an app for the specified device.
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/devices/:deviceId/managedConfigurationsForDevice/:managedConfigurationForDeviceIdRemoves a per-device managed configuration for an app for the specified device. - GETLists all the per-device managed configurations for the specified device
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/devices/:deviceId/managedConfigurationsForDeviceLists all the per-device managed configurations for the specified device. Only the ID is set.
managedconfigurationsforuser
- GETRetrieves details of a per-user managed configuration for an app for the specified user.
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/managedConfigurationsForUser/:managedConfigurationForUserIdRetrieves details of a per-user managed configuration for an app for the specified user. - PUTAdds or updates the managed configuration settings for an app for the specified user
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/managedConfigurationsForUser/:managedConfigurationForUserIdAdds or updates the managed configuration settings for an app for the specified user. If you support the Managed configurations iframe, you can apply managed… - DELETERemoves a per-user managed configuration for an app for the specified user.
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/managedConfigurationsForUser/:managedConfigurationForUserIdRemoves a per-user managed configuration for an app for the specified user. - GETLists all the per-user managed configurations for the specified user
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/managedConfigurationsForUserLists all the per-user managed configurations for the specified user. Only the ID is set.
managedconfigurationssettings
- GETLists all the managed configurations settings for the specified app.
/androidenterprise/v1/enterprises/:enterpriseId/products/:productId/managedConfigurationsSettingsLists all the managed configurations settings for the specified app.
permissions
- GETRetrieves details of an Android app permission for display to an enterprise admin.
/androidenterprise/v1/permissions/:permissionId?language=stringRetrieves details of an Android app permission for display to an enterprise admin.
products
- POSTApproves the specified product and the relevant app permissions, if any
/androidenterprise/v1/enterprises/:enterpriseId/products/:productId/approveApproves 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.… - POSTGenerates a URL that can be rendered in an iframe to display the permissions (if any) of a product
/androidenterprise/v1/enterprises/:enterpriseId/products/:productId/generateApprovalUrl?languageCode=stringGenerates 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… - GETRetrieves details of a product for display to an enterprise admin.
/androidenterprise/v1/enterprises/:enterpriseId/products/:productId?language=stringRetrieves details of a product for display to an enterprise admin. - GETRetrieves the schema that defines the configurable properties for this product
/androidenterprise/v1/enterprises/:enterpriseId/products/:productId/appRestrictionsSchema?language=stringRetrieves the schema that defines the configurable properties for this product. All products have a schema, but this schema may be empty if no managed… - GETRetrieves the Android app permissions required by this app.
/androidenterprise/v1/enterprises/:enterpriseId/products/:productId/permissionsRetrieves the Android app permissions required by this app. - GETFinds approved products that match a query, or all approved products if there is no query
/androidenterprise/v1/enterprises/:enterpriseId/products?approved=true&language=string&maxResults=0&query=string&token=stringFinds 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… - POSTUnapproves the specified product (and the relevant app permissions, if any) **Note:** This item has been deprecated
/androidenterprise/v1/enterprises/:enterpriseId/products/:productId/unapproveUnapproves the specified product (and the relevant app permissions, if any) Note: This item has been deprecated. New integrations cannot use this method and…
serviceaccountkeys
- DELETERemoves and invalidates the specified credentials for the service account associated with this enterprise
/androidenterprise/v1/enterprises/:enterpriseId/serviceAccountKeys/:keyIdRemoves and invalidates the specified credentials for the service account associated with this enterprise. The calling service account must have been… - GETLists all active credentials for the service account associated with this enterprise
/androidenterprise/v1/enterprises/:enterpriseId/serviceAccountKeysLists all active credentials for the service account associated with this enterprise. Only the ID and key type are returned. The calling service account must… - POSTGenerates new credentials for the service account associated with this enterprise
/androidenterprise/v1/enterprises/:enterpriseId/serviceAccountKeysGenerates new credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling…
storelayoutclusters
- GETRetrieves details of a cluster.
/androidenterprise/v1/enterprises/:enterpriseId/storeLayout/pages/:pageId/clusters/:clusterIdRetrieves details of a cluster. - PUTUpdates a cluster.
/androidenterprise/v1/enterprises/:enterpriseId/storeLayout/pages/:pageId/clusters/:clusterIdUpdates a cluster. - DELETEDeletes a cluster.
/androidenterprise/v1/enterprises/:enterpriseId/storeLayout/pages/:pageId/clusters/:clusterIdDeletes a cluster. - GETRetrieves the details of all clusters on the specified page.
/androidenterprise/v1/enterprises/:enterpriseId/storeLayout/pages/:pageId/clustersRetrieves the details of all clusters on the specified page. - POSTInserts a new cluster in a page.
/androidenterprise/v1/enterprises/:enterpriseId/storeLayout/pages/:pageId/clustersInserts a new cluster in a page.
storelayoutpages
- GETRetrieves details of a store page.
/androidenterprise/v1/enterprises/:enterpriseId/storeLayout/pages/:pageIdRetrieves details of a store page. - PUTUpdates the content of a store page.
/androidenterprise/v1/enterprises/:enterpriseId/storeLayout/pages/:pageIdUpdates the content of a store page. - DELETEDeletes a store page.
/androidenterprise/v1/enterprises/:enterpriseId/storeLayout/pages/:pageIdDeletes a store page. - GETRetrieves the details of all pages in the store.
/androidenterprise/v1/enterprises/:enterpriseId/storeLayout/pagesRetrieves the details of all pages in the store. - POSTInserts a new store page.
/androidenterprise/v1/enterprises/:enterpriseId/storeLayout/pagesInserts a new store page.
users
- GETRetrieves a user's details.
/androidenterprise/v1/enterprises/:enterpriseId/users/:userIdRetrieves a user's details. - PUTUpdates the details of an EMM-managed user
/androidenterprise/v1/enterprises/:enterpriseId/users/:userIdUpdates 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… - DELETEDeleted an EMM-managed user.
/androidenterprise/v1/enterprises/:enterpriseId/users/:userIdDeleted an EMM-managed user. - POSTGenerates an authentication token which the device policy client can use to provision the given EMM-managed user…
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/authenticationTokenGenerates 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… - GETRetrieves the set of products a user is entitled to access
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/availableProductSetRetrieves 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… - PUTModifies the set of products that a user is entitled to access (referred to as *whitelisted* products)
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/availableProductSetModifies 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… - GETLooks up a user by primary email address
/androidenterprise/v1/enterprises/:enterpriseId/users?email=stringLooks 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… - POSTCreates a new EMM-managed user
/androidenterprise/v1/enterprises/:enterpriseId/usersCreates a new EMM-managed user. The Users resource passed in the body of the request should include an accountIdentifier and an accountType. If a… - DELETERevokes access to all devices currently provisioned to the user
/androidenterprise/v1/enterprises/:enterpriseId/users/:userId/deviceAccessRevokes 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…
webapps
- GETGets an existing web app.
/androidenterprise/v1/enterprises/:enterpriseId/webApps/:webAppIdGets an existing web app. - PUTUpdates an existing web app.
/androidenterprise/v1/enterprises/:enterpriseId/webApps/:webAppIdUpdates an existing web app. - DELETEDeletes an existing web app.
/androidenterprise/v1/enterprises/:enterpriseId/webApps/:webAppIdDeletes an existing web app. - GETRetrieves the details of all web apps for a given enterprise.
/androidenterprise/v1/enterprises/:enterpriseId/webAppsRetrieves the details of all web apps for a given enterprise. - POSTCreates a new web app for the enterprise.
/androidenterprise/v1/enterprises/:enterpriseId/webAppsCreates a new web app for the enterprise.
API details
- Base URL
https://androidenterprise.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 77 operations on 52 pathsGET 34POST 20PUT 13DELETE 10
- Main resources
- enterprises 15users 9products 7devices 6storelayoutclusters 5storelayoutpages 5webapps 5entitlements 4installs 4managedconfigurationsfordevice 4
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Google Play EMM API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Google Play EMM API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Uploads a report containing any changes in app states on the device since the last report was generated” (POST /androidenterprise/v1/enterprises/:enterpriseId/users/:userId/devices/:deviceId/forceReportUpload), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Google Play EMM API?
Manages the deployment of apps to Android Enterprise devices. It is listed under Developer tools and has 77 endpoints.
Who publishes the Google Play EMM API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Google Play EMM API?
Requests go to https://androidenterprise.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Google Play EMM API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.
How many endpoints does the Google Play EMM API have?
77 operations on 52 paths (34 GET, 20 POST, 13 PUT, 10 DELETE). The largest groups are enterprises, users, products, devices.
Is forking the Google Play EMM API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.