"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"description":"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.",
"description":"Updates the device policy. This method supports patch semantics.",
"httpMethod":"PATCH",
"id":"androidenterprise.devices.patch",
"parameterOrder":[
"enterpriseId",
"userId",
"deviceId"
],
"parameters":{
"deviceId":{
"description":"The ID of the device.",
"location":"path",
"required":true,
"type":"string"
},
"enterpriseId":{
"description":"The ID of the enterprise.",
"location":"path",
"required":true,
"type":"string"
},
"updateMask":{
"description":"Mask that identifies which fields to update. If not set, all modifiable fields will be modified.\n\nWhen set in a query parameter, this field should be specified as updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...",
"description":"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.",
"description":"Mask that identifies which fields to update. If not set, all modifiable fields will be modified.\n\nWhen set in a query parameter, this field should be specified as updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...",
"description":"Acknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications.",
"description":"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.",
"description":"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.",
"description":"Deletes the binding between the EMM and enterprise. This is now deprecated. Use this method only to unenroll customers that were previously enrolled with the insert call, then enroll them again with the enroll call.",
"description":"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.\nBeware 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.",
"description":"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.\n\nThis method can only be called after calling Enterprises.Enroll or Enterprises.CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error.\n\nSubsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials.\n\nOnce the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource.",
"description":"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.",
"description":"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.",
"httpMethod":"GET",
"id":"androidenterprise.enterprises.list",
"parameterOrder":[
"domain"
],
"parameters":{
"domain":{
"description":"The exact primary domain name of the enterprise to look up.",
"description":"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.\nA notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty.\nNotifications 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.\nMultiple 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.\nIf no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available.",
"description":"The request mode for pulling notifications.\nSpecifying 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.\nSpeciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present.\nIf omitted, defaults to waitForNotifications.",
"description":"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.",
"description":"Adds or updates an entitlement to an app for a user. This method supports patch semantics.",
"httpMethod":"PATCH",
"id":"androidenterprise.entitlements.patch",
"parameterOrder":[
"enterpriseId",
"userId",
"entitlementId"
],
"parameters":{
"enterpriseId":{
"description":"The ID of the enterprise.",
"location":"path",
"required":true,
"type":"string"
},
"entitlementId":{
"description":"The ID of the entitlement (a product ID), e.g. \"app:com.google.android.gm\".",
"location":"path",
"required":true,
"type":"string"
},
"install":{
"description":"Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.",
"description":"Adds or updates an entitlement to an app for a user.",
"httpMethod":"PUT",
"id":"androidenterprise.entitlements.update",
"parameterOrder":[
"enterpriseId",
"userId",
"entitlementId"
],
"parameters":{
"enterpriseId":{
"description":"The ID of the enterprise.",
"location":"path",
"required":true,
"type":"string"
},
"entitlementId":{
"description":"The ID of the entitlement (a product ID), e.g. \"app:com.google.android.gm\".",
"location":"path",
"required":true,
"type":"string"
},
"install":{
"description":"Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.",
"description":"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.",
"httpMethod":"DELETE",
"id":"androidenterprise.installs.delete",
"parameterOrder":[
"enterpriseId",
"userId",
"deviceId",
"installId"
],
"parameters":{
"deviceId":{
"description":"The Android ID of the device.",
"location":"path",
"required":true,
"type":"string"
},
"enterpriseId":{
"description":"The ID of the enterprise.",
"location":"path",
"required":true,
"type":"string"
},
"installId":{
"description":"The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
"description":"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. This method supports patch semantics.",
"httpMethod":"PATCH",
"id":"androidenterprise.installs.patch",
"parameterOrder":[
"enterpriseId",
"userId",
"deviceId",
"installId"
],
"parameters":{
"deviceId":{
"description":"The Android ID of the device.",
"location":"path",
"required":true,
"type":"string"
},
"enterpriseId":{
"description":"The ID of the enterprise.",
"location":"path",
"required":true,
"type":"string"
},
"installId":{
"description":"The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
"description":"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.",
"httpMethod":"PUT",
"id":"androidenterprise.installs.update",
"parameterOrder":[
"enterpriseId",
"userId",
"deviceId",
"installId"
],
"parameters":{
"deviceId":{
"description":"The Android ID of the device.",
"location":"path",
"required":true,
"type":"string"
},
"enterpriseId":{
"description":"The ID of the enterprise.",
"location":"path",
"required":true,
"type":"string"
},
"installId":{
"description":"The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
"description":"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. This method supports patch semantics.",
"description":"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.",
"description":"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.\n\nTo 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.",
"description":"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.\n\nAdmins 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.",
"description":"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.",
"description":"Finds approved products that match a query, or all approved products if there is no query.",
"httpMethod":"GET",
"id":"androidenterprise.products.list",
"parameterOrder":[
"enterpriseId"
],
"parameters":{
"approved":{
"description":"Specifies whether to search among all products (false) or among only products that have been approved (true). Only \"true\" is supported, and should be specified.",
"location":"query",
"type":"boolean"
},
"enterpriseId":{
"description":"The ID of the enterprise.",
"location":"path",
"required":true,
"type":"string"
},
"language":{
"description":"The BCP47 tag for the user's preferred language (e.g. \"en-US\", \"de\"). Results are returned in the language best matching the preferred language.",
"location":"query",
"type":"string"
},
"maxResults":{
"description":"Specifies the maximum number of products that can be returned per request. If not specified, uses a default value of 100, which is also the maximum retrievable within a single response.",
"format":"uint32",
"location":"query",
"type":"integer"
},
"query":{
"description":"The search query as typed in the Google Play store search box. If omitted, all approved apps will be returned (using the pagination parameters), including apps that are not available in the store (e.g. unpublished apps).",
"location":"query",
"type":"string"
},
"token":{
"description":"A pagination token is contained in a request''s response when there are more products. The token can be used in a subsequent request to obtain more products, and so forth. This parameter cannot be used in the initial request.",
"description":"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.",
"description":"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.\n\nOnly the type of the key should be populated in the resource to be inserted.",
"description":"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.",
"description":"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.\n\nThis call only works with EMM-managed accounts.",
"description":"Generates a token (activation code) to allow this user to configure their managed account in the Android Setup Wizard. Revokes any previously generated token.\n\nThis call only works with Google managed accounts.",
"description":"Creates a new EMM-managed user.\n\nThe Users resource passed in the body of the request should include an accountIdentifier and an accountType.\nIf 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.",
"description":"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.",
"httpMethod":"GET",
"id":"androidenterprise.users.list",
"parameterOrder":[
"enterpriseId",
"email"
],
"parameters":{
"email":{
"description":"The exact primary email address of the user to look up.",
"description":"Updates the details of an EMM-managed user.\n\nCan 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. This method supports patch semantics.",
"description":"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.\n\nThis call only works with EMM-managed accounts.",
"description":"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.",
"description":"Updates the details of an EMM-managed user.\n\nCan 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.",
"description":"Specification for a token used to generate iframes. The token specifies what data the admin is allowed to modify and the URI the iframe is allowed to communiate with.",
"description":"Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#administratorWebTokenSpec\".",
"type":"string"
},
"parent":{
"description":"The URI of the parent frame hosting the iframe. To prevent XSS, the iframe may not be hosted at other URIs. This URI must be https.",
"type":"string"
},
"permission":{
"description":"The list of permissions the admin is granted within the iframe. The admin will only be allowed to view an iframe if they have all of the permissions associated with it. The only valid value is \"approveApps\" that will allow the admin to access the iframe in \"approve\" mode.",
"description":"An event generated when a new app version is uploaded to Google Play and its app restrictions schema changed. To fetch the app restrictions schema for an app, use Products.getAppRestrictionsSchema on the EMM API.",
"id":"AppRestrictionsSchemaChangeEvent",
"properties":{
"productId":{
"description":"The id of the product (e.g. \"app:com.google.android.gm\") for which the app restriction schema changed. This field will always be present.",
"description":"The default value of the restriction. bundle and bundleArray restrictions never have a default value."
},
"description":{
"description":"A longer description of the restriction, giving more detail of what it affects.",
"type":"string"
},
"entry":{
"description":"For choice or multiselect restrictions, the list of possible entries' human-readable names.",
"items":{
"type":"string"
},
"type":"array"
},
"entryValue":{
"description":"For choice or multiselect restrictions, the list of possible entries' machine-readable values. These values should be used in the configuration, either as a single string value for a choice restriction or in a stringArray for a multiselect restriction.",
"items":{
"type":"string"
},
"type":"array"
},
"key":{
"description":"The unique key that the product uses to identify the restriction, e.g. \"com.google.android.gm.fieldname\".",
"type":"string"
},
"nestedRestriction":{
"description":"For bundle or bundleArray restrictions, the list of nested restrictions. A bundle restriction is always nested within a bundleArray restriction, and a bundleArray restriction is at most two levels deep.",
"description":"An event generated when a new version of an app is uploaded to Google Play. Notifications are sent for new public versions only: alpha, beta, or canary versions do not generate this event. To fetch up-to-date version history for an app, use Products.Get on the EMM API.",
"id":"AppUpdateEvent",
"properties":{
"productId":{
"description":"The id of the product (e.g. \"app:com.google.android.gm\") that was updated. This field will always be present.",
"description":"This represents a single version of the app.",
"id":"AppVersion",
"properties":{
"track":{
"description":"The track that this app was published in. For example if track is \"alpha\", this is an alpha version of the app.",
"type":"string"
},
"versionCode":{
"description":"Unique increasing identifier for the app version.",
"format":"int32",
"type":"integer"
},
"versionString":{
"description":"The string used in the Play store by the app developer to identify the version. The string is not necessarily unique or localized (for example, the string could be \"1.4\").",
"description":"Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#authenticationToken\".",
"type":"string"
},
"token":{
"description":"The authentication token to be passed to the device policy client on the device where it can be used to provision the account for which this token was generated.",
"description":"A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings.",
"description":"A Devices resource represents a mobile device managed by the EMM and belonging to a specific enterprise user.",
"id":"Device",
"properties":{
"androidId":{
"description":"The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, \"123456789abcdef0\".",
"type":"string"
},
"kind":{
"default":"androidenterprise#device",
"description":"Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#device\".",
"type":"string"
},
"managementType":{
"description":"Identifies the extent to which the device is controlled by a managed Google Play EMM in various deployment configurations.\n\nPossible values include: \n- \"managedDevice\", a device that has the EMM's device policy controller (DPC) as the device owner. \n- \"managedProfile\", a device that has a profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC. \n- \"containerApp\", no longer used (deprecated). \n- \"unmanagedProfile\", a device that has been allowed (by the domain's admin, using the Admin Console to enable the privilege) to use managed Google Play, but the profile is itself not owned by a DPC.",
"type":"string"
},
"policy":{
"$ref":"Policy",
"description":"The policy enforced on the device."
"description":"The state of a user's device, as accessed by the getState and setState methods on device resources.",
"id":"DeviceState",
"properties":{
"accountState":{
"description":"The state of the Google account on the device. \"enabled\" indicates that the Google account on the device can be used to access Google services (including Google Play), while \"disabled\" means that it cannot. A new device is initially in the \"disabled\" state.",
"type":"string"
},
"kind":{
"default":"androidenterprise#deviceState",
"description":"Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#deviceState\".",
"description":"An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows: \n- For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process. \n- For managed Google Play Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the managed Google Play sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details.",
"id":"Enterprise",
"properties":{
"administrator":{
"description":"Admins of the enterprise. This is only supported for enterprises created via the EMM-initiated flow.",
"items":{
"$ref":"Administrator"
},
"type":"array"
},
"id":{
"description":"The unique ID for the enterprise.",
"type":"string"
},
"kind":{
"default":"androidenterprise#enterprise",
"description":"Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#enterprise\".",
"type":"string"
},
"name":{
"description":"The name of the enterprise, for example, \"Example, Inc\".",
"type":"string"
},
"primaryDomain":{
"annotations":{
"required":[
"androidenterprise.enterprises.insert"
]
},
"description":"The enterprise's primary domain, such as \"example.com\".",
"description":"The presence of an Entitlements resource indicates that a user has the right to use a particular app. Entitlements are user specific, not device specific. This allows a user with an entitlement to an app to install the app on all their devices. It's also possible for a user to hold an entitlement to an app without installing the app on any device.\n\nThe API can be used to create an entitlement. As an option, you can also use the API to trigger the installation of an app on all a user's managed devices at the same time the entitlement is created.\n\nIf the app is free, creating the entitlement also creates a group license for that app. For paid apps, creating the entitlement consumes one license, and that license remains consumed until the entitlement is removed. If the enterprise hasn't purchased enough licenses, then no entitlement is created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn't accepted.\n\nIf an entitlement is deleted, the app may be uninstalled from a user's device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement.\n\nEntitlements for apps that a user pays for on an unmanaged profile have \"userPurchase\" as the entitlement reason. These entitlements cannot be removed via the API.",
"id":"Entitlement",
"properties":{
"kind":{
"default":"androidenterprise#entitlement",
"description":"Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#entitlement\".",
"type":"string"
},
"productId":{
"description":"The ID of the product that the entitlement is for. For example, \"app:com.google.android.gm\".",
"type":"string"
},
"reason":{
"description":"The reason for the entitlement. For example, \"free\" for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses.",
"description":"The entitlement resources for the user.",
"id":"EntitlementsListResponse",
"properties":{
"entitlement":{
"description":"An entitlement of a user to a product (e.g. an app). For example, a free app that they have installed, or a paid app that they have been allocated a license to.",
"description":"Group license objects allow you to keep track of licenses (called entitlements) for both free and paid apps. For a free app, a group license is created when an enterprise admin first approves the product in Google Play or when the first entitlement for the product is created for a user via the API. For a paid app, a group license object is only created when an enterprise admin purchases the product in Google Play for the first time.\n\nUse the API to query group licenses. A Grouplicenses resource includes the total number of licenses purchased (paid apps only) and the total number of licenses currently in use. In other words, the total number of Entitlements that exist for the product.\n\nOnly one group license object is created per product and group license objects are never deleted. If a product is unapproved, its group license remains. This allows enterprise admins to keep track of any remaining entitlements for the product.",
"id":"GroupLicense",
"properties":{
"acquisitionKind":{
"description":"How this group license was acquired. \"bulkPurchase\" means that this Grouplicenses resource was created because the enterprise purchased licenses for this product; otherwise, the value is \"free\" (for free products).",
"type":"string"
},
"approval":{
"description":"Whether the product to which this group license relates is currently approved by the enterprise. Products are approved when a group license is first created, but this approval may be revoked by an enterprise admin via Google Play. Unapproved products will not be visible to end users in collections, and new entitlements to them should not normally be created.",
"type":"string"
},
"kind":{
"default":"androidenterprise#groupLicense",
"description":"Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#groupLicense\".",
"type":"string"
},
"numProvisioned":{
"description":"The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations.",
"format":"int32",
"type":"integer"
},
"numPurchased":{
"description":"The number of purchased licenses (possibly in multiple purchases). If this field is omitted, then there is no limit on the number of licenses that can be provisioned (for example, if the acquisition kind is \"free\").",
"format":"int32",
"type":"integer"
},
"permissions":{
"description":"The permission approval status of the product. This field is only set if the product is approved. Possible states are: \n- \"currentApproved\", the current set of permissions is approved, but additional permissions will require the administrator to reapprove the product (If the product was approved without specifying the approved permissions setting, then this is the default behavior.), \n- \"needsReapproval\", the product has unapproved permissions. No additional product licenses can be assigned until the product is reapproved, \n- \"allCurrentAndFutureApproved\", the current permissions are approved and any future permission updates will be automatically approved without administrator review.",
"type":"string"
},
"productId":{
"description":"The ID of the product that the license is for. For example, \"app:com.google.android.gm\".",
"description":"The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending).\n\nThe API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app, then an attempt is made to create one. If this fails (for example, because the app is not free and there is no available license), then the creation of the install fails.\n\nThe API can also be used to update an installed app. If the update method is used on an existing install, then the app will be updated to the latest available version.\n\nNote that it is not possible to force the installation of a specific version of an app: the version code is read-only.\n\nIf a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created.\n\nThe API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves.",
"id":"Install",
"properties":{
"installState":{
"description":"Install state. The state \"installPending\" means that an install request has recently been made and download to the device is in progress. The state \"installed\" means that the app has been installed. This field is read-only.",
"type":"string"
},
"kind":{
"default":"androidenterprise#install",
"description":"Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#install\".",
"type":"string"
},
"productId":{
"description":"The ID of the product that the install is for. For example, \"app:com.google.android.gm\".",
"type":"string"
},
"versionCode":{
"description":"The version of the installed product. Guaranteed to be set only if the install state is \"installed\".",
"description":"An event generated when an app installation failed on a device",
"id":"InstallFailureEvent",
"properties":{
"deviceId":{
"description":"The Android ID of the device. This field will always be present.",
"type":"string"
},
"failureDetails":{
"description":"Additional details on the failure if applicable.",
"type":"string"
},
"failureReason":{
"description":"The reason for the installation failure. This field will always be present.",
"type":"string"
},
"productId":{
"description":"The id of the product (e.g. \"app:com.google.android.gm\") for which the install failure event occured. This field will always be present.",
"type":"string"
},
"userId":{
"description":"The ID of the user. This field will always be present.",
"description":"The install resources for the device.",
"id":"InstallsListResponse",
"properties":{
"install":{
"description":"An installation of an app for a user on a specific device. The existence of an install implies that the user must have an entitlement to the app.",
"description":"Maintenance window for managed Google Play Accounts. This allows Play store to update the apps on the foreground in the designated window.",
"id":"MaintenanceWindow",
"properties":{
"durationMs":{
"description":"Duration of the maintenance window, in milliseconds. The duration must be between 30 minutes and 24 hours (inclusive).",
"format":"int64",
"type":"string"
},
"startTimeAfterMidnightMs":{
"description":"Start time of the maintenance window, in milliseconds after midnight on the device. Windows can span midnight.",
"description":"A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user.",
"id":"ManagedConfiguration",
"properties":{
"configurationVariables":{
"$ref":"ConfigurationVariables",
"description":"Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user."
"description":"A managed configurations settings resource contains the set of managed properties that have been configured for an Android app to be applied to a set of users. The app's developer would have defined configurable properties in the managed configurations schema.",
"description":"A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema.",
"id":"ManagedProperty",
"properties":{
"key":{
"description":"The unique key that identifies the property.",
"type":"string"
},
"valueBool":{
"description":"The boolean value - this will only be present if type of the property is bool.",
"type":"boolean"
},
"valueBundle":{
"$ref":"ManagedPropertyBundle",
"description":"The bundle of managed properties - this will only be present if type of the property is bundle."
},
"valueBundleArray":{
"description":"The list of bundles of properties - this will only be present if type of the property is bundle_array.",
"items":{
"$ref":"ManagedPropertyBundle"
},
"type":"array"
},
"valueInteger":{
"description":"The integer value - this will only be present if type of the property is integer.",
"format":"int32",
"type":"integer"
},
"valueString":{
"description":"The string value - this will only be present if type of the property is string, choice or hidden.",
"type":"string"
},
"valueStringArray":{
"description":"The list of string values - this will only be present if type of the property is multiselect.",
"description":"An event generated when a new device is ready to be managed.",
"id":"NewDeviceEvent",
"properties":{
"deviceId":{
"description":"The Android ID of the device. This field will always be present.",
"type":"string"
},
"dpcPackageName":{
"description":"Policy app on the device.",
"type":"string"
},
"managementType":{
"description":"Identifies the extent to which the device is controlled by an Android EMM in various deployment configurations.\n\nPossible values include: \n- \"managedDevice\", a device where the DPC is set as device owner, \n- \"managedProfile\", a device where the DPC is set as profile owner.",
"type":"string"
},
"userId":{
"description":"The ID of the user. This field will always be present.",
"description":"An event generated when new permissions are added to an app.",
"id":"NewPermissionsEvent",
"properties":{
"approvedPermissions":{
"description":"The set of permissions that the enterprise admin has already approved for this application. Use Permissions.Get on the EMM API to retrieve details about these permissions.",
"items":{
"type":"string"
},
"type":"array"
},
"productId":{
"description":"The id of the product (e.g. \"app:com.google.android.gm\") for which new permissions were added. This field will always be present.",
"type":"string"
},
"requestedPermissions":{
"description":"The set of permissions that the app is currently requesting. Use Permissions.Get on the EMM API to retrieve details about these permissions.",
"description":"A resource returned by the PullNotificationSet API, which contains a collection of notifications for enterprises associated with the service account authenticated for the request.",
"id":"NotificationSet",
"properties":{
"kind":{
"default":"androidenterprise#notificationSet",
"description":"Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#notificationSet\".",
"type":"string"
},
"notification":{
"description":"The notifications received, or empty if no notifications are present.",
"items":{
"$ref":"Notification"
},
"type":"array"
},
"notificationSetId":{
"description":"The notification set ID, required to mark the notification as received with the Enterprises.AcknowledgeNotification API. This will be omitted if no notifications are present.",
"description":"A Permissions resource represents some extra capability, to be granted to an Android app, which requires explicit consent. An enterprise admin must consent to these permissions on behalf of their users before an entitlement for the app can be created.\n\nThe permissions collection is read-only. The information provided for each permission (localized name and description) is intended to be used in the MDM user interface when obtaining consent from the enterprise.",
"id":"Permission",
"properties":{
"description":{
"description":"A longer description of the Permissions resource, giving more details of what it affects.",
"type":"string"
},
"kind":{
"default":"androidenterprise#permission",
"description":"Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#permission\".",
"type":"string"
},
"name":{
"description":"The name of the permission.",
"type":"string"
},
"permissionId":{
"description":"An opaque string uniquely identifying the permission.",
"description":"The device policy for a given managed device.",
"id":"Policy",
"properties":{
"autoUpdatePolicy":{
"description":"The auto-update policy for apps installed on the device. \"choiceToTheUser\" allows the device's user to configure the app update policy. \"always\" enables auto updates. \"never\" disables auto updates. \"wifiOnly\" enables auto updates only when the device is connected to wifi.",
"description":"The availability granted to the device for the specified products. \"all\" gives the device access to all products, regardless of approval status. \"all\" does not enable automatic visibility of \"alpha\" or \"beta\" tracks. \"whitelist\" grants the device access the products specified in productPolicy[]. Only products that are approved or products that were previously approved (products with revoked approval) by the enterprise can be whitelisted. If no value is provided, the availability set at the user level is applied by default.",
"description":"A Products resource represents an app in the Google Play store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.)\n\nThe information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an EMM user interface.",
"id":"Product",
"properties":{
"appVersion":{
"description":"App versions currently available for this product.",
"items":{
"$ref":"AppVersion"
},
"type":"array"
},
"authorName":{
"description":"The name of the author of the product (for example, the app developer).",
"type":"string"
},
"availableCountries":{
"description":"The countries which this app is available in.",
"items":{
"type":"string"
},
"type":"array"
},
"availableTracks":{
"description":"The tracks that are visible to the enterprise.",
"description":"The localized promotional description, if available.",
"type":"string"
},
"detailsUrl":{
"description":"A link to the (consumer) Google Play details page for the product.",
"type":"string"
},
"distributionChannel":{
"description":"How and to whom the package is made available. The value publicGoogleHosted means that the package is available through the Play store and not restricted to a specific enterprise. The value privateGoogleHosted means that the package is a private app (restricted to an enterprise) but hosted by Google. The value privateSelfHosted means that the package is a private app (restricted to an enterprise) and is privately hosted.",
"type":"string"
},
"iconUrl":{
"description":"A link to an image that can be used as an icon for the product. This image is suitable for use at up to 512px x 512px.",
"type":"string"
},
"kind":{
"default":"androidenterprise#product",
"description":"Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#product\".",
"type":"string"
},
"lastUpdatedTimestampMillis":{
"description":"The approximate time (within 7 days) the app was last published, expressed in milliseconds since epoch.",
"format":"int64",
"type":"string"
},
"minAndroidSdkVersion":{
"description":"The minimum Android SDK necessary to run the app.",
"format":"int32",
"type":"integer"
},
"permissions":{
"description":"A list of permissions required by the app.",
"items":{
"$ref":"ProductPermission"
},
"type":"array"
},
"productId":{
"description":"A string of the form app:\u003cpackage name\u003e. For example, app:com.google.android.gm represents the Gmail app.",
"type":"string"
},
"productPricing":{
"description":"Whether this product is free, free with in-app purchases, or paid. If the pricing is unknown, this means the product is not generally available anymore (even though it might still be available to people who own it).",
"type":"string"
},
"recentChanges":{
"description":"A description of the recent changes made to the app.",
"type":"string"
},
"requiresContainerApp":{
"description":"Deprecated.",
"type":"boolean"
},
"screenshotUrls":{
"description":"A list of screenshot links representing the app.",
"items":{
"type":"string"
},
"type":"array"
},
"signingCertificate":{
"$ref":"ProductSigningCertificate",
"description":"The certificate used to sign this product."
},
"smallIconUrl":{
"description":"A link to a smaller image that can be used as an icon for the product. This image is suitable for use at up to 128px x 128px.",
"type":"string"
},
"title":{
"description":"The name of the product.",
"type":"string"
},
"workDetailsUrl":{
"description":"A link to the managed Google Play details page for the product, for use by an Enterprise admin.",
"description":"An event generated when a product's approval status is changed.",
"id":"ProductApprovalEvent",
"properties":{
"approved":{
"description":"Whether the product was approved or unapproved. This field will always be present.",
"type":"string"
},
"productId":{
"description":"The id of the product (e.g. \"app:com.google.android.gm\") for which the approval status has changed. This field will always be present.",
"description":"An event generated whenever a product's availability changes.",
"id":"ProductAvailabilityChangeEvent",
"properties":{
"availabilityStatus":{
"description":"The new state of the product. This field will always be present.",
"type":"string"
},
"productId":{
"description":"The id of the product (e.g. \"app:com.google.android.gm\") for which the product availability changed. This field will always be present.",
"description":"A product permissions resource represents the set of permissions required by a specific app and whether or not they have been accepted by an enterprise admin.\n\nThe API can be used to read the set of permissions, and also to update the set to indicate that permissions have been accepted.",
"id":"ProductPermission",
"properties":{
"permissionId":{
"description":"An opaque string uniquely identifying the permission.",
"type":"string"
},
"state":{
"description":"Whether the permission has been accepted or not.",
"description":"The ID of the product. For example, \"app:com.google.android.gm\".",
"type":"string"
},
"tracks":{
"description":"Grants visibility to the specified track(s) of the product to the device. The track available to the device is based on the following order of preference: alpha, beta, production. For example, if an app has a prod version, a beta version and an alpha version and the enterprise has been granted visibility to both the alpha and beta tracks, if tracks is {\"beta\", \"production\"} then the beta version of the app is made available to the device. If there are no app versions in the specified track adding the \"alpha\" and \"beta\" values to the list of tracks will have no effect. Note that the enterprise requires access to alpha and/or beta tracks before users can be granted visibility to apps in those tracks.\n\nThe allowed sets are: {} (considered equivalent to {\"production\"}) {\"production\"} {\"beta\", \"production\"} {\"alpha\", \"beta\", \"production\"} The order of elements is not relevant. Any other set of tracks will be rejected with an error.",
"description":"Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#productSet\".",
"type":"string"
},
"productId":{
"description":"The list of product IDs making up the set of products.",
"items":{
"type":"string"
},
"type":"array"
},
"productSetBehavior":{
"description":"The interpretation of this product set. \"unknown\" should never be sent and is ignored if received. \"whitelist\" means that the user is entitled to access the product set. \"includeAll\" means that all products are accessible, including products that are approved, products with revoked approval, and products that have never been approved. \"allApproved\" means that the user is entitled to access all products that are approved for the enterprise. If the value is \"allApproved\" or \"includeAll\", the productId field is ignored. If no value is provided, it is interpreted as \"whitelist\" for backwards compatibility. Further \"allApproved\" or \"includeAll\" does not enable automatic visibility of \"alpha\" or \"beta\" tracks for Android app. Use ProductVisibility to enable \"alpha\" or \"beta\" tracks per user.",
"type":"string"
},
"productVisibility":{
"description":"Additional list of product IDs making up the product set. Unlike the productID array, in this list It's possible to specify which tracks (alpha, beta, production) of a product are visible to the user. See ProductVisibility and its fields for more information. Specifying the same product ID both here and in the productId array is not allowed and it will result in an error.",
"description":"The base64 urlsafe encoded SHA1 hash of the certificate. (This field is deprecated in favor of SHA2-256. It should not be used and may be removed at any time.)",
"type":"string"
},
"certificateHashSha256":{
"description":"The base64 urlsafe encoded SHA2-256 hash of the certificate.",
"description":"A product to be made visible to a user.",
"id":"ProductVisibility",
"properties":{
"productId":{
"description":"The product ID to make visible to the user. Required for each item in the productVisibility list.",
"type":"string"
},
"tracks":{
"description":"Grants visibility to the specified track(s) of the product to the user. The track available to the user is based on the following order of preference: alpha, beta, production. For example, if an app has a prod version, a beta version and an alpha version and the enterprise has been granted visibility to both the alpha and beta tracks, if tracks is {\"beta\", \"production\"} the user will be able to install the app and they will get the beta version of the app. If there are no app versions in the specified track adding the \"alpha\" and \"beta\" values to the list of tracks will have no effect. Note that the enterprise requires access to alpha and/or beta tracks before users can be granted visibility to apps in those tracks.\n\nThe allowed sets are: {} (considered equivalent to {\"production\"}) {\"production\"} {\"beta\", \"production\"} {\"alpha\", \"beta\", \"production\"} The order of elements is not relevant. Any other set of tracks will be rejected with an error.",
"description":"The approval URL that was shown to the user. Only the permissions shown to the user with that URL will be accepted, which may not be the product's entire set of permissions. For example, the URL may only display new permissions from an update after the product was approved, or not include new permissions if the product was updated since the URL was generated."
},
"approvedPermissions":{
"description":"Sets how new permission requests for the product are handled. \"allPermissions\" automatically approves all current and future permissions for the product. \"currentPermissionsOnly\" approves the current set of permissions for the product, but any future permissions added through updates will require manual reapproval. If not specified, only the current set of permissions will be approved.",
"description":"A URL that can be rendered in an iframe to display the permissions (if any) of a product. This URL can be used to approve the product only once and only within 24 hours of being generated, using the Products.approve call. If the product is currently unapproved and has no permissions, this URL will point to an empty page. If the product is currently approved, a URL will only be generated if that product has added permissions since it was last approved, and the URL will only display those new permissions that have not yet been accepted.",
"description":"Credentials that can be used to authenticate as a service account.",
"id":"ServiceAccountKey",
"properties":{
"data":{
"description":"The body of the private key credentials file, in string format. This is only populated when the ServiceAccountKey is created, and is not stored by Google.",
"type":"string"
},
"id":{
"description":"An opaque, unique identifier for this ServiceAccountKey. Assigned by the server.",
"type":"string"
},
"kind":{
"default":"androidenterprise#serviceAccountKey",
"description":"Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#serviceAccountKey\".",
"type":"string"
},
"publicData":{
"description":"Public key data for the credentials file. This is an X.509 cert. If you are using the googleCredentials key type, this is identical to the cert that can be retrieved by using the X.509 cert url inside of the credentials file.",
"type":"string"
},
"type":{
"annotations":{
"required":[
"androidenterprise.serviceaccountkeys.insert"
]
},
"description":"The file format of the generated key data.",
"description":"Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.",
"id":"StoreCluster",
"properties":{
"id":{
"description":"Unique ID of this cluster. Assigned by the server. Immutable once assigned.",
"type":"string"
},
"kind":{
"default":"androidenterprise#storeCluster",
"description":"Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#storeCluster\".",
"type":"string"
},
"name":{
"description":"Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.",
"items":{
"$ref":"LocalizedText"
},
"type":"array"
},
"orderInPage":{
"description":"String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.\n\nThe value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters.",
"type":"string"
},
"productId":{
"description":"List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.",
"description":"General setting for the managed Google Play store layout, currently only specifying the page to display the first time the store is opened.",
"id":"StoreLayout",
"properties":{
"homepageId":{
"description":"The ID of the store page to be used as the homepage. The homepage is the first page shown in the managed Google Play Store.\n\nNot specifying a homepage is equivalent to setting the store layout type to \"basic\".",
"type":"string"
},
"kind":{
"default":"androidenterprise#storeLayout",
"description":"Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#storeLayout\".",
"type":"string"
},
"storeLayoutType":{
"description":"The store layout type. By default, this value is set to \"basic\" if the homepageId field is not set, and to \"custom\" otherwise. If set to \"basic\", the layout will consist of all approved apps that have been whitelisted for the user.",
"description":"Definition of a managed Google Play store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.",
"id":"StorePage",
"properties":{
"id":{
"description":"Unique ID of this page. Assigned by the server. Immutable once assigned.",
"type":"string"
},
"kind":{
"default":"androidenterprise#storePage",
"description":"Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#storePage\".",
"type":"string"
},
"link":{
"description":"Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.\n\nNo attempt is made to verify that all pages are reachable from the homepage.",
"items":{
"type":"string"
},
"type":"array"
},
"name":{
"description":"Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.",
"description":"A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to managed Google Play only, or to other Google services, depending on the identity model: \n- The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). \n- The managed Google Play Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to managed Google Play.",
"id":"User",
"properties":{
"accountIdentifier":{
"annotations":{
"required":[
"androidenterprise.users.insert"
]
},
"description":"A unique identifier you create for this user, such as \"user342\" or \"asset#44418\". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.",
"type":"string"
},
"accountType":{
"annotations":{
"required":[
"androidenterprise.users.insert"
]
},
"description":"The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.",
"type":"string"
},
"displayName":{
"description":"The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as \"Example, Inc.\") or your name (as EMM). Not used for Google-managed user accounts.",
"type":"string"
},
"id":{
"description":"The unique ID for the user.",
"type":"string"
},
"kind":{
"default":"androidenterprise#user",
"description":"Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#user\".",
"type":"string"
},
"managementType":{
"description":"The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.",
"type":"string"
},
"primaryEmail":{
"description":"The user's primary email address, for example, \"jsmith@example.com\". Will always be set for Google managed users and not set for EMM managed users.",
"description":"A UserToken is used by a user when setting up a managed device or profile with their managed Google Play account on a device. When the user enters their email address and token (activation code) the appropriate EMM app can be automatically downloaded.",
"id":"UserToken",
"properties":{
"kind":{
"default":"androidenterprise#userToken",
"description":"Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#userToken\".",
"type":"string"
},
"token":{
"description":"The token (activation code) to be entered by the user. This consists of a sequence of decimal digits. Note that the leading digit may be 0.",
"description":"A variable set is a key-value pair of EMM-provided placeholders and its corresponding value, which is attributed to a user. For example, $FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders should start with a '$' sign and should be alphanumeric only.",
"id":"VariableSet",
"properties":{
"kind":{
"default":"androidenterprise#variableSet",
"description":"Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#variableSet\".",
"type":"string"
},
"placeholder":{
"description":"The placeholder string; defined by EMM.",
"type":"string"
},
"userValue":{
"description":"The value of the placeholder, specific to the user.",
