Google Git
Sign in
code / google-api-go-client / 8552fe4980be7e4264606dfe569c107e56e85e18 / . / androidenterprise / v1 / androidenterprise-api.json
blob: cb518c2d434ef8312c5849a7a5a84d09d2546313 [file] [log] [blame]
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/androidenterprise": {
"description": "Manage corporate Android devices"
}
}
}
},
"basePath": "",
"baseUrl": "https://www.googleapis.com/",
"batchPath": "batch/androidenterprise/v1",
"canonicalName": "Android Enterprise",
"description": "Manages the deployment of apps to Android Enterprise devices.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/android/work/play/emm-api",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "androidenterprise:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://www.mtls.googleapis.com/",
"name": "androidenterprise",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"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.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"devices": {
"methods": {
"forceReportUpload": {
"description": "Uploads a report containing any changes in app states on the device since\nthe last report was generated. You can call this method up to 3 times every\n24 hours for a given device.\nIf you exceed the quota, then the Google Play EMM API returns \u003ccode\u003eHTTP\n429 Too Many Requests\u003c/code\u003e.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/forceReportUpload",
"httpMethod": "POST",
"id": "androidenterprise.devices.forceReportUpload",
"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"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/forceReportUpload",
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"get": {
"description": "Retrieves the details of a device.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}",
"httpMethod": "GET",
"id": "androidenterprise.devices.get",
"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"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}",
"response": {
"$ref": "Device"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"getState": {
"description": "Retrieves whether a device's access to Google services is enabled or\ndisabled.\nThe device state takes effect only if enforcing EMM policies on Android\ndevices is enabled in the Google Admin Console.\nOtherwise, the device state is ignored and all devices are allowed access\nto Google services.\nThis is only supported for Google-managed users.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state",
"httpMethod": "GET",
"id": "androidenterprise.devices.getState",
"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"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state",
"response": {
"$ref": "DeviceState"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"list": {
"description": "Retrieves the IDs of all of a user's devices.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices",
"httpMethod": "GET",
"id": "androidenterprise.devices.list",
"parameterOrder": [
"enterpriseId",
"userId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices",
"response": {
"$ref": "DevicesListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"setState": {
"description": "Sets whether a device's access to Google services is enabled or disabled.\nThe device state takes effect only if enforcing EMM policies on Android\ndevices is enabled in the Google Admin Console.\nOtherwise, the device state is ignored and all devices are allowed access\nto Google services.\nThis is only supported for Google-managed users.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state",
"httpMethod": "PUT",
"id": "androidenterprise.devices.setState",
"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"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state",
"request": {
"$ref": "DeviceState"
},
"response": {
"$ref": "DeviceState"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"update": {
"description": "Updates the device policy",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}",
"httpMethod": "PUT",
"id": "androidenterprise.devices.update",
"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\nfields will be modified.\n\nWhen set in a query parameter, this field should be specified as\n\u003ccode\u003eupdateMask=\u0026lt;field1\u0026gt;,\u0026lt;field2\u0026gt;,...\u003c/code\u003e",
"location": "query",
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}",
"request": {
"$ref": "Device"
},
"response": {
"$ref": "Device"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
}
}
},
"enterprises": {
"methods": {
"acknowledgeNotificationSet": {
"description": "Acknowledges notifications that were received from\nEnterprises.PullNotificationSet to prevent subsequent calls from returning\nthe same notifications.",
"flatPath": "androidenterprise/v1/enterprises/acknowledgeNotificationSet",
"httpMethod": "POST",
"id": "androidenterprise.enterprises.acknowledgeNotificationSet",
"parameterOrder": [],
"parameters": {
"notificationSetId": {
"description": "The notification set ID as returned by Enterprises.PullNotificationSet.\nThis must be provided.",
"location": "query",
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/acknowledgeNotificationSet",
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"completeSignup": {
"description": "Completes the signup flow, by specifying the Completion token and\nEnterprise token.\nThis request must not be called multiple times for a given Enterprise\nToken.",
"flatPath": "androidenterprise/v1/enterprises/completeSignup",
"httpMethod": "POST",
"id": "androidenterprise.enterprises.completeSignup",
"parameterOrder": [],
"parameters": {
"completionToken": {
"description": "The Completion token initially returned by GenerateSignupUrl.",
"location": "query",
"type": "string"
},
"enterpriseToken": {
"description": "The Enterprise token appended to the Callback URL.",
"location": "query",
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/completeSignup",
"response": {
"$ref": "Enterprise"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"createWebToken": {
"description": "Returns a unique token to access an embeddable UI. To generate a\nweb UI, pass the generated token into the managed Google Play javascript\nAPI. Each token may only be used to start one UI session. See the\njavascript API documentation for further information.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/createWebToken",
"httpMethod": "POST",
"id": "androidenterprise.enterprises.createWebToken",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/createWebToken",
"request": {
"$ref": "AdministratorWebTokenSpec"
},
"response": {
"$ref": "AdministratorWebToken"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"enroll": {
"description": "Enrolls an enterprise with the calling EMM.",
"flatPath": "androidenterprise/v1/enterprises/enroll",
"httpMethod": "POST",
"id": "androidenterprise.enterprises.enroll",
"parameterOrder": [
"token"
],
"parameters": {
"token": {
"description": "Required. The token provided by the enterprise to register the EMM.",
"location": "query",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/enroll",
"request": {
"$ref": "Enterprise"
},
"response": {
"$ref": "Enterprise"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"generateSignupUrl": {
"description": "Generates a sign-up URL.",
"flatPath": "androidenterprise/v1/enterprises/signupUrl",
"httpMethod": "POST",
"id": "androidenterprise.enterprises.generateSignupUrl",
"parameterOrder": [],
"parameters": {
"callbackUrl": {
"description": "The callback URL to which the Admin will be redirected after successfully\ncreating an enterprise. Before redirecting there the system will add a\nsingle query parameter to this URL named \"enterpriseToken\" which will\ncontain an opaque token to be used for the CompleteSignup request.\u003cbr\u003e\nBeware that this means that the URL will be parsed, the parameter added\nand then a new URL formatted, i.e. there may be some minor formatting\nchanges and, more importantly, the URL must be well-formed so that it can\nbe parsed.",
"location": "query",
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/signupUrl",
"response": {
"$ref": "SignupInfo"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"get": {
"description": "Retrieves the name and domain of an enterprise.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}",
"httpMethod": "GET",
"id": "androidenterprise.enterprises.get",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}",
"response": {
"$ref": "Enterprise"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"getServiceAccount": {
"description": "Returns a service account and credentials. The service account\ncan be bound to the enterprise by calling setAccount. The service account\nis unique to this enterprise and EMM, and will be deleted if the enterprise\nis unbound. The credentials contain private key data and are not stored\nserver-side.\n\u003cbr\u003e \u003cbr\u003e\nThis method can only be called after calling\nEnterprises.Enroll or Enterprises.CompleteSignup, and before\nEnterprises.SetAccount; at other times it will return an error.\n\u003cbr\u003e \u003cbr\u003e\nSubsequent calls after the first will generate a new, unique set of\ncredentials, and invalidate the previously generated credentials.\n\u003cbr\u003e \u003cbr\u003e\nOnce the service account is bound to the enterprise, it can be managed\nusing the serviceAccountKeys resource.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/serviceAccount",
"httpMethod": "GET",
"id": "androidenterprise.enterprises.getServiceAccount",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"keyType": {
"description": "The type of credential to return with the service account. Required.",
"enum": [
"GOOGLE_CREDENTIALS",
"PKCS12"
],
"location": "query",
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/serviceAccount",
"response": {
"$ref": "ServiceAccount"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"getStoreLayout": {
"description": "Returns the store layout for the enterprise. If the store layout\nhas not been set, returns \"basic\" as the store layout type and no\nhomepage.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout",
"httpMethod": "GET",
"id": "androidenterprise.enterprises.getStoreLayout",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout",
"response": {
"$ref": "StoreLayout"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"list": {
"description": "Looks up an enterprise by domain name.\nThis is only supported for enterprises created via the Google-initiated\ncreation flow. Lookup of the id is not needed for enterprises created via\nthe EMM-initiated flow since the EMM learns the enterprise ID in the\ncallback specified in the Enterprises.generateSignupUrl call.",
"flatPath": "androidenterprise/v1/enterprises",
"httpMethod": "GET",
"id": "androidenterprise.enterprises.list",
"parameterOrder": [
"domain"
],
"parameters": {
"domain": {
"description": "Required. The exact primary domain name of the enterprise to look up.",
"location": "query",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises",
"response": {
"$ref": "EnterprisesListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"pullNotificationSet": {
"description": "Pulls and returns a notification set for the enterprises associated with\nthe service account authenticated for the request. The notification set may\nbe empty if no notification are pending.\n\u003cbr\u003e\nA notification set returned needs to be acknowledged within 20 seconds\nby calling Enterprises.AcknowledgeNotificationSet, unless the\nnotification set is empty.\n\u003cbr\u003e\nNotifications that are not acknowledged within the 20 seconds will\neventually be included again in the response to another PullNotificationSet\nrequest, and those that are never acknowledged will ultimately be deleted\naccording to the Google Cloud Platform Pub/Sub system policy.\n\u003cbr\u003e\nMultiple requests might be performed concurrently to retrieve\nnotifications, in which case the pending notifications (if any) will be\nsplit among each caller, if any are pending.\n\u003cbr\u003e\nIf no notifications are present, an empty notification list is returned.\nSubsequent requests may return more notifications once they become\navailable.",
"flatPath": "androidenterprise/v1/enterprises/pullNotificationSet",
"httpMethod": "POST",
"id": "androidenterprise.enterprises.pullNotificationSet",
"parameterOrder": [],
"parameters": {
"requestMode": {
"description": "The request mode for pulling notifications.\n\u003cbr\u003e\nSpecifying \u003ccode\u003ewaitForNotifications\u003c/code\u003e will cause the request to\nblock and wait until one or more notifications are present, or return an\nempty notification list if no notifications are present after some time.\n\u003cbr\u003e\nSpeciying \u003ccode\u003ereturnImmediately\u003c/code\u003e will cause the request to\nimmediately return the pending notifications, or an empty list if no\nnotifications are present.\n\u003cbr\u003e\nIf omitted, defaults to \u003ccode\u003ewaitForNotifications\u003c/code\u003e.",
"enum": [
"WAIT_FOR_NOTIFICATIONS",
"RETURN_IMMEDIATELY"
],
"location": "query",
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/pullNotificationSet",
"response": {
"$ref": "NotificationSet"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"sendTestPushNotification": {
"description": "Sends a test notification to validate the EMM integration with\nthe Google Cloud Pub/Sub service for this enterprise.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/sendTestPushNotification",
"httpMethod": "POST",
"id": "androidenterprise.enterprises.sendTestPushNotification",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/sendTestPushNotification",
"response": {
"$ref": "EnterprisesSendTestPushNotificationResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"setAccount": {
"description": "Sets the account that will be used to authenticate to the API as the\nenterprise.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/account",
"httpMethod": "PUT",
"id": "androidenterprise.enterprises.setAccount",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/account",
"request": {
"$ref": "EnterpriseAccount"
},
"response": {
"$ref": "EnterpriseAccount"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"setStoreLayout": {
"description": "Sets the store layout for the enterprise. By default, storeLayoutType\nis set to \"basic\" and the basic store layout is enabled. The basic\nlayout only contains apps approved by the admin, and that have\nbeen added to the available product set for a user (using the\n\u003ca href=\"/android/work/play/emm-api/v1/users/setAvailableProductSet\"\u003e\nsetAvailableProductSet\u003c/a\u003e call). Apps on the page are sorted in order of\ntheir product ID value. If you create a custom store layout (by setting\nstoreLayoutType = \"custom\" and setting a homepage), the basic store\nlayout is disabled.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout",
"httpMethod": "PUT",
"id": "androidenterprise.enterprises.setStoreLayout",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout",
"request": {
"$ref": "StoreLayout"
},
"response": {
"$ref": "StoreLayout"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"unenroll": {
"description": "Unenrolls an enterprise from the calling EMM.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/unenroll",
"httpMethod": "POST",
"id": "androidenterprise.enterprises.unenroll",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/unenroll",
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
}
}
},
"entitlements": {
"methods": {
"delete": {
"description": "Removes an entitlement to an app for a user.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
"httpMethod": "DELETE",
"id": "androidenterprise.entitlements.delete",
"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"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"get": {
"description": "Retrieves details of an entitlement.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
"httpMethod": "GET",
"id": "androidenterprise.entitlements.get",
"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"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
"response": {
"$ref": "Entitlement"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"list": {
"description": "Lists all entitlements for the specified user. Only the ID is set.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements",
"httpMethod": "GET",
"id": "androidenterprise.entitlements.list",
"parameterOrder": [
"enterpriseId",
"userId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements",
"response": {
"$ref": "EntitlementsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"update": {
"description": "Adds or updates an entitlement to an app for a user.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
"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\npossible. Failure to install on one or more devices will not prevent\nthis operation from returning successfully, as long as the entitlement\nwas successfully assigned to the user.",
"location": "query",
"type": "boolean"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
"request": {
"$ref": "Entitlement"
},
"response": {
"$ref": "Entitlement"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
}
}
},
"grouplicenses": {
"methods": {
"get": {
"description": "Retrieves details of an enterprise's group license for a product.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}",
"httpMethod": "GET",
"id": "androidenterprise.grouplicenses.get",
"parameterOrder": [
"enterpriseId",
"groupLicenseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"groupLicenseId": {
"description": "The ID of the product the group license is for, e.g.\n\"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}",
"response": {
"$ref": "GroupLicense"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"list": {
"description": "Retrieves IDs of all products for which the enterprise has a group license.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/groupLicenses",
"httpMethod": "GET",
"id": "androidenterprise.grouplicenses.list",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/groupLicenses",
"response": {
"$ref": "GroupLicensesListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
}
}
},
"grouplicenseusers": {
"methods": {
"list": {
"description": "Retrieves the IDs of the users who have been granted entitlements\nunder the license.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}/users",
"httpMethod": "GET",
"id": "androidenterprise.grouplicenseusers.list",
"parameterOrder": [
"enterpriseId",
"groupLicenseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"groupLicenseId": {
"description": "The ID of the product the group license is for, e.g.\n\"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}/users",
"response": {
"$ref": "GroupLicenseUsersListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
}
}
},
"installs": {
"methods": {
"delete": {
"description": "Requests to remove an app from a device. A call to \u003ccode\u003eget\u003c/code\u003e or\n\u003ccode\u003elist\u003c/code\u003e will still show the app as installed on the device until\nit is actually removed.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
"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.\n\"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"get": {
"description": "Retrieves details of an installation of an app on a device.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
"httpMethod": "GET",
"id": "androidenterprise.installs.get",
"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.\n\"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
"response": {
"$ref": "Install"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"list": {
"description": "Retrieves the details of all apps installed on the specified device.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs",
"httpMethod": "GET",
"id": "androidenterprise.installs.list",
"parameterOrder": [
"enterpriseId",
"userId",
"deviceId"
],
"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"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs",
"response": {
"$ref": "InstallsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"update": {
"description": "Requests to install the latest version of an app to a device. If the app\nis already installed, then it is updated to the latest version if\nnecessary.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
"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.\n\"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
"request": {
"$ref": "Install"
},
"response": {
"$ref": "Install"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
}
}
},
"managedconfigurationsfordevice": {
"methods": {
"delete": {
"description": "Removes a per-device managed configuration for an app for the specified\ndevice.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}",
"httpMethod": "DELETE",
"id": "androidenterprise.managedconfigurationsfordevice.delete",
"parameterOrder": [
"enterpriseId",
"userId",
"deviceId",
"managedConfigurationForDeviceId"
],
"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"
},
"managedConfigurationForDeviceId": {
"description": "The ID of the managed configuration (a product ID), e.g.\n\"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}",
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"get": {
"description": "Retrieves details of a per-device managed configuration.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}",
"httpMethod": "GET",
"id": "androidenterprise.managedconfigurationsfordevice.get",
"parameterOrder": [
"enterpriseId",
"userId",
"deviceId",
"managedConfigurationForDeviceId"
],
"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"
},
"managedConfigurationForDeviceId": {
"description": "The ID of the managed configuration (a product ID), e.g.\n\"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}",
"response": {
"$ref": "ManagedConfiguration"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"list": {
"description": "Lists all the per-device managed configurations for the specified device.\nOnly the ID is set.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice",
"httpMethod": "GET",
"id": "androidenterprise.managedconfigurationsfordevice.list",
"parameterOrder": [
"enterpriseId",
"userId",
"deviceId"
],
"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"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice",
"response": {
"$ref": "ManagedConfigurationsForDeviceListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"update": {
"description": "Adds or updates a per-device managed configuration for an app for the\nspecified device.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}",
"httpMethod": "PUT",
"id": "androidenterprise.managedconfigurationsfordevice.update",
"parameterOrder": [
"enterpriseId",
"userId",
"deviceId",
"managedConfigurationForDeviceId"
],
"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"
},
"managedConfigurationForDeviceId": {
"description": "The ID of the managed configuration (a product ID), e.g.\n\"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}",
"request": {
"$ref": "ManagedConfiguration"
},
"response": {
"$ref": "ManagedConfiguration"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
}
}
},
"managedconfigurationsforuser": {
"methods": {
"delete": {
"description": "Removes a per-user managed configuration for an app for the specified user.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}",
"httpMethod": "DELETE",
"id": "androidenterprise.managedconfigurationsforuser.delete",
"parameterOrder": [
"enterpriseId",
"userId",
"managedConfigurationForUserId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"managedConfigurationForUserId": {
"description": "The ID of the managed configuration (a product ID), e.g.\n\"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}",
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"get": {
"description": "Retrieves details of a per-user managed configuration for an app for the\nspecified user.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}",
"httpMethod": "GET",
"id": "androidenterprise.managedconfigurationsforuser.get",
"parameterOrder": [
"enterpriseId",
"userId",
"managedConfigurationForUserId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"managedConfigurationForUserId": {
"description": "The ID of the managed configuration (a product ID), e.g.\n\"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}",
"response": {
"$ref": "ManagedConfiguration"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"list": {
"description": "Lists all the per-user managed configurations for the specified user. Only\nthe ID is set.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser",
"httpMethod": "GET",
"id": "androidenterprise.managedconfigurationsforuser.list",
"parameterOrder": [
"enterpriseId",
"userId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser",
"response": {
"$ref": "ManagedConfigurationsForUserListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"update": {
"description": "Adds or updates the managed configuration settings for an app for the\nspecified user.\nIf you support the \u003ca\nhref=\"https://developers.google.com/android/work/play/emm-api/managed-configurations-iframe\"\u003eManaged\nconfigurations iframe\u003c/a\u003e,\nyou can apply managed configurations to a user by specifying an\n\u003ccode\u003emcmId\u003c/code\u003e\nand its associated configuration variables (if any) in the request.\nAlternatively,\nall EMMs can apply managed configurations by passing a list of managed\nproperties.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}",
"httpMethod": "PUT",
"id": "androidenterprise.managedconfigurationsforuser.update",
"parameterOrder": [
"enterpriseId",
"userId",
"managedConfigurationForUserId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"managedConfigurationForUserId": {
"description": "The ID of the managed configuration (a product ID), e.g.\n\"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}",
"request": {
"$ref": "ManagedConfiguration"
},
"response": {
"$ref": "ManagedConfiguration"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
}
}
},
"managedconfigurationssettings": {
"methods": {
"list": {
"description": "Lists all the managed configurations settings for the specified app.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/managedConfigurationsSettings",
"httpMethod": "GET",
"id": "androidenterprise.managedconfigurationssettings.list",
"parameterOrder": [
"enterpriseId",
"productId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"productId": {
"description": "The ID of the product for which the managed configurations settings applies\nto.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/managedConfigurationsSettings",
"response": {
"$ref": "ManagedConfigurationsSettingsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
}
}
},
"permissions": {
"methods": {
"get": {
"description": "Retrieves details of an Android app permission for display to an enterprise\nadmin.",
"flatPath": "androidenterprise/v1/permissions/{permissionId}",
"httpMethod": "GET",
"id": "androidenterprise.permissions.get",
"parameterOrder": [
"permissionId"
],
"parameters": {
"language": {
"description": "The BCP47 tag for the user's preferred language (e.g. \"en-US\", \"de\")",
"location": "query",
"type": "string"
},
"permissionId": {
"description": "The ID of the permission.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/permissions/{permissionId}",
"response": {
"$ref": "Permission"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
}
}
},
"products": {
"methods": {
"approve": {
"description": "\u003cp\u003eApproves the specified product and the relevant app permissions, if any.\nThe maximum number of products that you can approve per enterprise customer\nis 1,000.\u003c/p\u003e\n\u003cp\u003eTo learn how to use managed Google Play to design and create a store\nlayout to display approved products to your users,\nsee \u003ca href=\"/android/work/play/emm-api/store-layout\"\u003eStore Layout\nDesign\u003c/a\u003e.\u003c/p\u003e",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/approve",
"httpMethod": "POST",
"id": "androidenterprise.products.approve",
"parameterOrder": [
"enterpriseId",
"productId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"productId": {
"description": "The ID of the product.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/approve",
"request": {
"$ref": "ProductsApproveRequest"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"generateApprovalUrl": {
"description": "Generates a URL that can be rendered in an iframe to display the\npermissions (if any) of a product. An enterprise admin must view these\npermissions and accept them on behalf of their organization in order to\napprove that product. \u003cbr\u003e\u003cbr\u003e\nAdmins should accept the displayed permissions by\ninteracting with a separate UI element in the EMM console, which in turn\nshould trigger the use of this URL as the\n\u003ccode\u003eapprovalUrlInfo.approvalUrl\u003c/code\u003e property in a\n\u003ccode\u003eProducts.approve\u003c/code\u003e call to approve the product.\nThis URL can only be used to display permissions for up to 1 day.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/generateApprovalUrl",
"httpMethod": "POST",
"id": "androidenterprise.products.generateApprovalUrl",
"parameterOrder": [
"enterpriseId",
"productId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"languageCode": {
"description": "The BCP 47 language code used for permission names and descriptions in\nthe returned iframe, for instance \"en-US\".",
"location": "query",
"type": "string"
},
"productId": {
"description": "The ID of the product.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/generateApprovalUrl",
"response": {
"$ref": "ProductsGenerateApprovalUrlResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"get": {
"description": "Retrieves details of a product for display to an enterprise admin.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}",
"httpMethod": "GET",
"id": "androidenterprise.products.get",
"parameterOrder": [
"enterpriseId",
"productId"
],
"parameters": {
"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\").",
"location": "query",
"type": "string"
},
"productId": {
"description": "The ID of the product, e.g. \"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}",
"response": {
"$ref": "Product"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"getAppRestrictionsSchema": {
"description": "Retrieves the schema that defines the configurable properties for this\nproduct. All products have a schema, but this schema may be empty if no\nmanaged configurations have been defined. This schema can be used to\npopulate a UI that allows an admin to configure the product.\nTo apply a managed configuration based on the schema obtained using this\nAPI, see\n\u003ca href=\"/android/work/play/emm-api/managed-configurations\"\u003eManaged\nConfigurations through Play\u003c/a\u003e.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/appRestrictionsSchema",
"httpMethod": "GET",
"id": "androidenterprise.products.getAppRestrictionsSchema",
"parameterOrder": [
"enterpriseId",
"productId"
],
"parameters": {
"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\").",
"location": "query",
"type": "string"
},
"productId": {
"description": "The ID of the product.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/appRestrictionsSchema",
"response": {
"$ref": "AppRestrictionsSchema"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"getPermissions": {
"description": "Retrieves the Android app permissions required by this app.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/permissions",
"httpMethod": "GET",
"id": "androidenterprise.products.getPermissions",
"parameterOrder": [
"enterpriseId",
"productId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"productId": {
"description": "The ID of the product.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/permissions",
"response": {
"$ref": "ProductPermissions"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"list": {
"description": "Finds approved products that match a query, or all approved products\nif there is no query.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/products",
"httpMethod": "GET",
"id": "androidenterprise.products.list",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"approved": {
"description": "Specifies whether to search among all products (false) or among\nonly products that have been approved (true). Only \"true\" is\nsupported, 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\").\nResults are returned in the language best matching the preferred\nlanguage.",
"location": "query",
"type": "string"
},
"maxResults": {
"description": "Defines how many results the list operation should return.\nThe default number depends on the resource collection.",
"format": "uint32",
"location": "query",
"type": "integer"
},
"query": {
"description": "The search query as typed in the Google Play store search box.\nIf omitted, all approved apps will be returned (using the pagination\nparameters), including apps that are not available in the store\n(e.g. unpublished apps).",
"location": "query",
"type": "string"
},
"token": {
"description": "Defines the token of the page to return, usually taken from\nTokenPagination.\nThis can only be used if token paging is enabled.",
"location": "query",
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/products",
"response": {
"$ref": "ProductsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"unapprove": {
"description": "Unapproves the specified product (and the relevant app permissions, if any)",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/unapprove",
"httpMethod": "POST",
"id": "androidenterprise.products.unapprove",
"parameterOrder": [
"enterpriseId",
"productId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"productId": {
"description": "The ID of the product.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/unapprove",
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
}
}
},
"serviceaccountkeys": {
"methods": {
"delete": {
"description": "Removes and invalidates the specified credentials for the service account\nassociated with this enterprise. The calling service account must have been\nretrieved by calling Enterprises.GetServiceAccount and must have been set\nas the enterprise service account by calling Enterprises.SetAccount.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/serviceAccountKeys/{keyId}",
"httpMethod": "DELETE",
"id": "androidenterprise.serviceaccountkeys.delete",
"parameterOrder": [
"enterpriseId",
"keyId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"keyId": {
"description": "The ID of the key.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/serviceAccountKeys/{keyId}",
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"insert": {
"description": "Generates new credentials for the service account associated with this\nenterprise. The calling service account must have been retrieved by calling\nEnterprises.GetServiceAccount and must have been set as the enterprise\nservice account by calling Enterprises.SetAccount. \u003cbr\u003e\u003cbr\u003e\nOnly the type of the key should be populated in the resource to be\ninserted.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/serviceAccountKeys",
"httpMethod": "POST",
"id": "androidenterprise.serviceaccountkeys.insert",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/serviceAccountKeys",
"request": {
"$ref": "ServiceAccountKey"
},
"response": {
"$ref": "ServiceAccountKey"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"list": {
"description": "Lists all active credentials for the service account associated with this\nenterprise. Only the ID and key type are returned. The calling service\naccount must have been retrieved by calling Enterprises.GetServiceAccount\nand must have been set as the enterprise service account by calling\nEnterprises.SetAccount.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/serviceAccountKeys",
"httpMethod": "GET",
"id": "androidenterprise.serviceaccountkeys.list",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/serviceAccountKeys",
"response": {
"$ref": "ServiceAccountKeysListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
}
}
},
"storelayoutclusters": {
"methods": {
"delete": {
"description": "Deletes a cluster.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}",
"httpMethod": "DELETE",
"id": "androidenterprise.storelayoutclusters.delete",
"parameterOrder": [
"enterpriseId",
"pageId",
"clusterId"
],
"parameters": {
"clusterId": {
"description": "The ID of the cluster.",
"location": "path",
"required": true,
"type": "string"
},
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"pageId": {
"description": "The ID of the page.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}",
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"get": {
"description": "Retrieves details of a cluster.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}",
"httpMethod": "GET",
"id": "androidenterprise.storelayoutclusters.get",
"parameterOrder": [
"enterpriseId",
"pageId",
"clusterId"
],
"parameters": {
"clusterId": {
"description": "The ID of the cluster.",
"location": "path",
"required": true,
"type": "string"
},
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"pageId": {
"description": "The ID of the page.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}",
"response": {
"$ref": "StoreCluster"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"insert": {
"description": "Inserts a new cluster in a page.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters",
"httpMethod": "POST",
"id": "androidenterprise.storelayoutclusters.insert",
"parameterOrder": [
"enterpriseId",
"pageId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"pageId": {
"description": "The ID of the page.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters",
"request": {
"$ref": "StoreCluster"
},
"response": {
"$ref": "StoreCluster"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"list": {
"description": "Retrieves the details of all clusters on the specified page.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters",
"httpMethod": "GET",
"id": "androidenterprise.storelayoutclusters.list",
"parameterOrder": [
"enterpriseId",
"pageId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"pageId": {
"description": "The ID of the page.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters",
"response": {
"$ref": "StoreLayoutClustersListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"update": {
"description": "Updates a cluster.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}",
"httpMethod": "PUT",
"id": "androidenterprise.storelayoutclusters.update",
"parameterOrder": [
"enterpriseId",
"pageId",
"clusterId"
],
"parameters": {
"clusterId": {
"description": "The ID of the cluster.",
"location": "path",
"required": true,
"type": "string"
},
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"pageId": {
"description": "The ID of the page.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}",
"request": {
"$ref": "StoreCluster"
},
"response": {
"$ref": "StoreCluster"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
}
}
},
"storelayoutpages": {
"methods": {
"delete": {
"description": "Deletes a store page.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}",
"httpMethod": "DELETE",
"id": "androidenterprise.storelayoutpages.delete",
"parameterOrder": [
"enterpriseId",
"pageId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"pageId": {
"description": "The ID of the page.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}",
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"get": {
"description": "Retrieves details of a store page.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}",
"httpMethod": "GET",
"id": "androidenterprise.storelayoutpages.get",
"parameterOrder": [
"enterpriseId",
"pageId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"pageId": {
"description": "The ID of the page.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}",
"response": {
"$ref": "StorePage"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"insert": {
"description": "Inserts a new store page.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages",
"httpMethod": "POST",
"id": "androidenterprise.storelayoutpages.insert",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages",
"request": {
"$ref": "StorePage"
},
"response": {
"$ref": "StorePage"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"list": {
"description": "Retrieves the details of all pages in the store.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages",
"httpMethod": "GET",
"id": "androidenterprise.storelayoutpages.list",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages",
"response": {
"$ref": "StoreLayoutPagesListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"update": {
"description": "Updates the content of a store page.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}",
"httpMethod": "PUT",
"id": "androidenterprise.storelayoutpages.update",
"parameterOrder": [
"enterpriseId",
"pageId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"pageId": {
"description": "The ID of the page.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}",
"request": {
"$ref": "StorePage"
},
"response": {
"$ref": "StorePage"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
}
}
},
"users": {
"methods": {
"delete": {
"description": "Deleted an EMM-managed user.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}",
"httpMethod": "DELETE",
"id": "androidenterprise.users.delete",
"parameterOrder": [
"enterpriseId",
"userId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}",
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"generateAuthenticationToken": {
"description": "Generates an authentication token which the device policy client can use to\nprovision the given EMM-managed user account on a device.\nThe generated token is single-use and expires after a few minutes.\n\nYou can provision a maximum of 10 devices per user.\n\nThis call only works with EMM-managed accounts.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/authenticationToken",
"httpMethod": "POST",
"id": "androidenterprise.users.generateAuthenticationToken",
"parameterOrder": [
"enterpriseId",
"userId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/authenticationToken",
"response": {
"$ref": "AuthenticationToken"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"get": {
"description": "Retrieves a user's details.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}",
"httpMethod": "GET",
"id": "androidenterprise.users.get",
"parameterOrder": [
"enterpriseId",
"userId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}",
"response": {
"$ref": "User"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"getAvailableProductSet": {
"description": "Retrieves the set of products a user is entitled to access.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/availableProductSet",
"httpMethod": "GET",
"id": "androidenterprise.users.getAvailableProductSet",
"parameterOrder": [
"enterpriseId",
"userId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/availableProductSet",
"response": {
"$ref": "ProductSet"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"insert": {
"description": "Creates a new EMM-managed user.\n\nThe \u003ca href=\"/android/work/play/emm-api/v1/users.html\"\u003eUsers\u003c/a\u003e resource\npassed in the body of the request should include an\n\u003ccode\u003eaccountIdentifier\u003c/code\u003e and an \u003ccode\u003eaccountType\u003c/code\u003e.\n\u003cp\u003eIf a corresponding user already exists with the same account identifier,\nthe user will be updated with the resource. In this case only the\n\u003ccode\u003edisplayName\u003c/code\u003e field can be changed.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users",
"httpMethod": "POST",
"id": "androidenterprise.users.insert",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users",
"request": {
"$ref": "User"
},
"response": {
"$ref": "User"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"list": {
"description": "Looks up a user by primary email address.\nThis is only supported for Google-managed users. Lookup of the id is not\nneeded for EMM-managed users because the id is already returned in the\nresult of the Users.insert call.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users",
"httpMethod": "GET",
"id": "androidenterprise.users.list",
"parameterOrder": [
"enterpriseId",
"email"
],
"parameters": {
"email": {
"description": "Required. The exact primary email address of the user to look up.",
"location": "query",
"required": true,
"type": "string"
},
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users",
"response": {
"$ref": "UsersListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"revokeDeviceAccess": {
"description": "Revokes access to all devices currently provisioned to the user. The user\nwill no longer be able to use the managed Play store on any of their\nmanaged devices.\n\nThis call only works with EMM-managed accounts.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/deviceAccess",
"httpMethod": "DELETE",
"id": "androidenterprise.users.revokeDeviceAccess",
"parameterOrder": [
"enterpriseId",
"userId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/deviceAccess",
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"setAvailableProductSet": {
"description": "Modifies the set of products that a user is entitled to access (referred to\nas \u003cem\u003ewhitelisted\u003c/em\u003e products). Only products that are\n\u003ca href=\"/android/work/play/emm-api/v1/products/approve\"\u003eapproved\u003c/a\u003e\nor products that were previously approved (products with revoked approval)\ncan be whitelisted.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/availableProductSet",
"httpMethod": "PUT",
"id": "androidenterprise.users.setAvailableProductSet",
"parameterOrder": [
"enterpriseId",
"userId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/availableProductSet",
"request": {
"$ref": "ProductSet"
},
"response": {
"$ref": "ProductSet"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"update": {
"description": "Updates the details of an EMM-managed user.\n\nCan be used with EMM-managed users only (not Google managed users).\nPass the new details in the\n\u003ca href=\"/android/work/play/emm-api/v1/users.html\"\u003eUsers\u003c/a\u003e\nresource in the request body. Only the \u003ccode\u003edisplayName\u003c/code\u003e field\ncan be changed. Other fields must either be unset or have the\ncurrently active value.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}",
"httpMethod": "PUT",
"id": "androidenterprise.users.update",
"parameterOrder": [
"enterpriseId",
"userId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}",
"request": {
"$ref": "User"
},
"response": {
"$ref": "User"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
}
}
},
"webapps": {
"methods": {
"delete": {
"description": "Deletes an existing web app.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/webApps/{webAppId}",
"httpMethod": "DELETE",
"id": "androidenterprise.webapps.delete",
"parameterOrder": [
"enterpriseId",
"webAppId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"webAppId": {
"description": "The ID of the web app.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/webApps/{webAppId}",
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"get": {
"description": "Gets an existing web app.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/webApps/{webAppId}",
"httpMethod": "GET",
"id": "androidenterprise.webapps.get",
"parameterOrder": [
"enterpriseId",
"webAppId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"webAppId": {
"description": "The ID of the web app.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/webApps/{webAppId}",
"response": {
"$ref": "WebApp"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"insert": {
"description": "Creates a new web app for the enterprise.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/webApps",
"httpMethod": "POST",
"id": "androidenterprise.webapps.insert",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/webApps",
"request": {
"$ref": "WebApp"
},
"response": {
"$ref": "WebApp"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"list": {
"description": "Retrieves the details of all web apps for a given enterprise.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/webApps",
"httpMethod": "GET",
"id": "androidenterprise.webapps.list",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/webApps",
"response": {
"$ref": "WebAppsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"update": {
"description": "Updates an existing web app.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/webApps/{webAppId}",
"httpMethod": "PUT",
"id": "androidenterprise.webapps.update",
"parameterOrder": [
"enterpriseId",
"webAppId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"webAppId": {
"description": "The ID of the web app.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/webApps/{webAppId}",
"request": {
"$ref": "WebApp"
},
"response": {
"$ref": "WebApp"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
}
}
}
},
"revision": "20200606",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Administrator": {
"description": "This represents an enterprise admin who can manage the enterprise\nin the managed Google Play store.",
"id": "Administrator",
"properties": {
"email": {
"description": "The admin's email address.",
"type": "string"
}
},
"type": "object"
},
"AdministratorWebToken": {
"description": "A token authorizing an admin to access an iframe.",
"id": "AdministratorWebToken",
"properties": {
"token": {
"description": "An opaque token to be passed to the Play front-end to generate an iframe.",
"type": "string"
}
},
"type": "object"
},
"AdministratorWebTokenSpec": {
"description": "Specification for a token used to generate iframes. The token specifies\nwhat data the admin is allowed to modify and the URI the iframe is\nallowed to communiate with.",
"id": "AdministratorWebTokenSpec",
"properties": {
"managedConfigurations": {
"$ref": "AdministratorWebTokenSpecManagedConfigurations",
"description": "Options for displaying the Managed Configuration page."
},
"parent": {
"description": "The URI of the parent frame hosting the iframe. To prevent XSS, the iframe\nmay not be hosted at other URIs. This URI must be https.\nUse whitespaces to separate multiple parent URIs.",
"type": "string"
},
"permission": {
"description": "Deprecated. Use \u003ccode\u003ePlaySearch.approveApps\u003c/code\u003e.",
"enumDescriptions": [
"Unknown permission.",
"Permission to approve and unapprove apps.",
"Permission to manage app restrictions."
],
"items": {
"enum": [
"UNKNOWN",
"APPROVE_APPS",
"MANAGE_MCM"
],
"type": "string"
},
"type": "array"
},
"playSearch": {
"$ref": "AdministratorWebTokenSpecPlaySearch",
"description": "Options for displaying the managed Play Search apps page."
},
"privateApps": {
"$ref": "AdministratorWebTokenSpecPrivateApps",
"description": "Options for displaying the Private Apps page."
},
"storeBuilder": {
"$ref": "AdministratorWebTokenSpecStoreBuilder",
"description": "Options for displaying the Organize apps page."
},
"webApps": {
"$ref": "AdministratorWebTokenSpecWebApps",
"description": "Options for displaying the Web Apps page."
}
},
"type": "object"
},
"AdministratorWebTokenSpecManagedConfigurations": {
"id": "AdministratorWebTokenSpecManagedConfigurations",
"properties": {
"enabled": {
"description": "Whether the Managed Configuration page is displayed. Default is true.",
"type": "boolean"
}
},
"type": "object"
},
"AdministratorWebTokenSpecPlaySearch": {
"id": "AdministratorWebTokenSpecPlaySearch",
"properties": {
"approveApps": {
"description": "Allow access to the iframe in \u003ca\nhref=\"https://developers.google.com/android/work/play/emm-api/managed-play-iframe#render\"\u003eapprove\nmode\u003c/a\u003e. Default is false.",
"type": "boolean"
},
"enabled": {
"description": "Whether the managed Play Search apps page is displayed. Default is true.",
"type": "boolean"
}
},
"type": "object"
},
"AdministratorWebTokenSpecPrivateApps": {
"id": "AdministratorWebTokenSpecPrivateApps",
"properties": {
"enabled": {
"description": "Whether the Private Apps page is displayed. Default is true.",
"type": "boolean"
}
},
"type": "object"
},
"AdministratorWebTokenSpecStoreBuilder": {
"id": "AdministratorWebTokenSpecStoreBuilder",
"properties": {
"enabled": {
"description": "Whether the Organize apps page is displayed. Default is true.",
"type": "boolean"
}
},
"type": "object"
},
"AdministratorWebTokenSpecWebApps": {
"id": "AdministratorWebTokenSpecWebApps",
"properties": {
"enabled": {
"description": "Whether the Web Apps page is displayed. Default is true.",
"type": "boolean"
}
},
"type": "object"
},
"AppRestrictionsSchema": {
"description": "Represents the list of app restrictions available to be pre-configured for\nthe product.",
"id": "AppRestrictionsSchema",
"properties": {
"kind": {
"description": "Deprecated.",
"type": "string"
},
"restrictions": {
"description": "The set of restrictions that make up this schema.",
"items": {
"$ref": "AppRestrictionsSchemaRestriction"
},
"type": "array"
}
},
"type": "object"
},
"AppRestrictionsSchemaChangeEvent": {
"description": "An event generated when a new app version is uploaded to Google Play and its\napp restrictions schema changed.\nTo fetch the app restrictions schema for an app, use\nProducts.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\napp restriction schema changed. This field will always be present.",
"type": "string"
}
},
"type": "object"
},
"AppRestrictionsSchemaRestriction": {
"description": "A restriction in the App Restriction Schema represents a piece of\nconfiguration that may be pre-applied.",
"id": "AppRestrictionsSchemaRestriction",
"properties": {
"defaultValue": {
"$ref": "AppRestrictionsSchemaRestrictionRestrictionValue",
"description": "The default value of the restriction. \u003ccode\u003ebundle\u003c/code\u003e and\n\u003ccode\u003ebundleArray\u003c/code\u003e restrictions never have a default value."
},
"description": {
"description": "A longer description of the restriction, giving more detail of what it\naffects.",
"type": "string"
},
"entry": {
"description": "For \u003ccode\u003echoice\u003c/code\u003e or \u003ccode\u003emultiselect\u003c/code\u003e restrictions, the list\nof possible entries' human-readable names.",
"items": {
"type": "string"
},
"type": "array"
},
"entryValue": {
"description": "For \u003ccode\u003echoice\u003c/code\u003e or \u003ccode\u003emultiselect\u003c/code\u003e restrictions, the list\nof possible entries' machine-readable values. These values should be used\nin the configuration, either as a single \u003ccode\u003estring\u003c/code\u003e value for a\n\u003ccode\u003echoice\u003c/code\u003e restriction or in a \u003ccode\u003estringArray\u003c/code\u003e for a\n\u003ccode\u003emultiselect\u003c/code\u003e restriction.",
"items": {
"type": "string"
},
"type": "array"
},
"key": {
"description": "The unique key that the product uses to identify the restriction,\ne.g. \"com.google.android.gm.fieldname\".",
"type": "string"
},
"nestedRestriction": {
"description": "For \u003ccode\u003ebundle\u003c/code\u003e or \u003ccode\u003ebundleArray\u003c/code\u003e restrictions, the list\nof nested restrictions. A \u003ccode\u003ebundle\u003c/code\u003e restriction is always nested\nwithin a \u003ccode\u003ebundleArray\u003c/code\u003e restriction, and a\n\u003ccode\u003ebundleArray\u003c/code\u003e restriction is at most two levels deep.",
"items": {
"$ref": "AppRestrictionsSchemaRestriction"
},
"type": "array"
},
"restrictionType": {
"description": "The type of the restriction.",
"enum": [
"BOOL",
"STRING",
"INTEGER",
"CHOICE",
"MULTISELECT",
"HIDDEN",
"BUNDLE",
"BUNDLE_ARRAY"
],
"enumDescriptions": [
"A restriction of boolean type.",
"A restriction of string type.",
"A restriction of integer type.",
"A choice of one item from a set.",
"A choice of multiple items from a set.",
"A hidden restriction of string type (the default value can be used\nto pass along information that cannot be modified, such as a version\ncode).",
"[M+ devices only] A bundle of restrictions",
"[M+ devices only] An array of restriction bundles"
],
"type": "string"
},
"title": {
"description": "The name of the restriction.",
"type": "string"
}
},
"type": "object"
},
"AppRestrictionsSchemaRestrictionRestrictionValue": {
"description": "A typed value for the restriction.",
"id": "AppRestrictionsSchemaRestrictionRestrictionValue",
"properties": {
"type": {
"description": "The type of the value being provided.",
"enum": [
"BOOL",
"STRING",
"INTEGER",
"CHOICE",
"MULTISELECT",
"HIDDEN",
"BUNDLE",
"BUNDLE_ARRAY"
],
"enumDescriptions": [
"A restriction of boolean type.",
"A restriction of string type.",
"A restriction of integer type.",
"A choice of one item from a set.",
"A choice of multiple items from a set.",
"A hidden restriction of string type (the default value can be used\nto pass along information that cannot be modified, such as a version\ncode).",
"[M+ devices only] A bundle of restrictions",
"[M+ devices only] An array of restriction bundles"
],
"type": "string"
},
"valueBool": {
"description": "The boolean value - this will only be present if type is bool.",
"type": "boolean"
},
"valueInteger": {
"description": "The integer value - this will only be present if type is integer.",
"format": "int32",
"type": "integer"
},
"valueMultiselect": {
"description": "The list of string values - this will only be present if type is\nmultiselect.",
"items": {
"type": "string"
},
"type": "array"
},
"valueString": {
"description": "The string value - this will be present for types string, choice and\nhidden.",
"type": "string"
}
},
"type": "object"
},
"AppState": {
"description": "List of states set by the app.",
"id": "AppState",
"properties": {
"keyedAppState": {
"description": "List of keyed app states.\nThis field will always be present.",
"items": {
"$ref": "KeyedAppState"
},
"type": "array"
},
"packageName": {
"description": "The package name of the app.\nThis field will always be present.",
"type": "string"
}
},
"type": "object"
},
"AppUpdateEvent": {
"description": "An event generated when a new version of an app is uploaded to Google Play.\nNotifications are sent for new public versions only: alpha, beta, or canary\nversions do not generate this event. To fetch up-to-date version history for\nan 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.\nThis field will always be present.",
"type": "string"
}
},
"type": "object"
},
"AppVersion": {
"description": "This represents a single version of the app.",
"id": "AppVersion",
"properties": {
"isProduction": {
"description": "True if this version is a production APK.",
"type": "boolean"
},
"track": {
"description": "Deprecated, use \u003ccode\u003etrackId\u003c/code\u003e instead.",
"enum": [
"APP_TRACK_UNSPECIFIED",
"PRODUCTION",
"BETA",
"ALPHA"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"trackId": {
"description": "Track ids that the app version is published in. Replaces the\n\u003ccode\u003etrack\u003c/code\u003e field (deprecated), but doesn't include the production\ntrack (see \u003ccode\u003eisProduction\u003c/code\u003e instead).",
"items": {
"type": "string"
},
"type": "array"
},
"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\nthe version.\nThe string is not necessarily unique or localized (for example, the string\ncould be \"1.4\").",
"type": "string"
}
},
"type": "object"
},
"ApprovalUrlInfo": {
"description": "Information on an approval URL.",
"id": "ApprovalUrlInfo",
"properties": {
"approvalUrl": {
"description": "A URL that displays a product's permissions and that can also be used to\napprove the product with the \u003ccode\u003eProducts.approve\u003c/code\u003e call.",
"type": "string"
}
},
"type": "object"
},
"AuthenticationToken": {
"description": "An AuthenticationToken is used by the EMM's device policy client on a device\nto provision the given EMM-managed user on that device.",
"id": "AuthenticationToken",
"properties": {
"token": {
"description": "The authentication token to be passed to the device policy client on the\ndevice where it can be used to provision the account for which this token\nwas generated.",
"type": "string"
}
},
"type": "object"
},
"AutoInstallConstraint": {
"description": "The auto-install constraint. Defines a set of restrictions for installation.\nAt least one of the fields must be set.",
"id": "AutoInstallConstraint",
"properties": {
"chargingStateConstraint": {
"description": "Charging state constraint.",
"enum": [
"CHARGING_STATE_CONSTRAINT_UNSPECIFIED",
"CHARGING_NOT_REQUIRED",
"CHARGING_REQUIRED"
],
"enumDescriptions": [
"",
"Device doesn't have to be charging.",
"Device has to be charging."
],
"type": "string"
},
"deviceIdleStateConstraint": {
"description": "Device idle state constraint.",
"enum": [
"DEVICE_IDLE_STATE_CONSTRAINT_UNSPECIFIED",
"DEVICE_IDLE_NOT_REQUIRED",
"DEVICE_IDLE_REQUIRED"
],
"enumDescriptions": [
"",
"Device doesn't have to be idle, app can be installed while the user is\ninteracting with the device.",
"Device has to be idle."
],
"type": "string"
},
"networkTypeConstraint": {
"description": "Network type constraint.",
"enum": [
"NETWORK_TYPE_CONSTRAINT_UNSPECIFIED",
"ANY_NETWORK",
"UNMETERED_NETWORK"
],
"enumDescriptions": [
"",
"Any active networks (Wi-Fi, cellular, etc.).",
"Any unmetered network (e.g. Wi-FI)."
],
"type": "string"
}
},
"type": "object"
},
"AutoInstallPolicy": {
"id": "AutoInstallPolicy",
"properties": {
"autoInstallConstraint": {
"description": "The constraints for auto-installing the app. You can specify a maximum of\none constraint.",
"items": {
"$ref": "AutoInstallConstraint"
},
"type": "array"
},
"autoInstallMode": {
"description": "The auto-install mode. If unset defaults to \"doNotAutoInstall\".",
"enum": [
"AUTO_INSTALL_MODE_UNSPECIFIED",
"DO_NOT_AUTO_INSTALL",
"AUTO_INSTALL_ONCE",
"FORCE_AUTO_INSTALL"
],
"enumDescriptions": [
"",
"The product is not installed automatically, the user needs to install it\nfrom the Play Store.",
"The product is automatically installed once, if the user uninstalls the\nproduct it will not be installed again.",
"The product is automatically installed, if the user uninstalls the\nproduct it will be installed again. On managed devices the DPC should\nblock uninstall."
],
"type": "string"
},
"autoInstallPriority": {
"description": "The priority of the install, as an unsigned integer. A lower number means\nhigher priority.",
"format": "int32",
"type": "integer"
},
"minimumVersionCode": {
"description": "The minimum version of the app. If a lower version of the app is installed,\nthen the app will be auto-updated according to the auto-install\nconstraints, instead of waiting for the regular auto-update. You can set a\nminimum version code for at most 20 apps per device.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ConfigurationVariables": {
"description": "A configuration variables resource contains the managed configuration\nsettings ID to be applied to a single user, as well as the variable set that\nis attributed to the user. The variable set will be used to replace\nplaceholders in the managed configuration settings.",
"id": "ConfigurationVariables",
"properties": {
"mcmId": {
"description": "The ID of the managed configurations settings.",
"type": "string"
},
"variableSet": {
"description": "The variable set that is attributed to the user.",
"items": {
"$ref": "VariableSet"
},
"type": "array"
}
},
"type": "object"
},
"Device": {
"description": "A Devices resource represents a mobile device managed by the EMM and\nbelonging to a specific enterprise user.",
"id": "Device",
"properties": {
"androidId": {
"description": "The Google Play Services Android ID for the device encoded as\na lowercase hex string. For example,\n\u003ccode\u003e\u0026quot;123456789abcdef0\u0026quot;\u003c/code\u003e.",
"type": "string"
},
"managementType": {
"description": "Identifies the extent to which the device is controlled by a managed\nGoogle Play EMM in various deployment configurations. \u003cbr\u003e\u003cbr\u003e\nPossible values include:\n\u003cul\u003e\u003cli\u003e\"\u003ccode\u003emanagedDevice\u003c/code\u003e\", a device that has the EMM's device\npolicy controller (DPC) as the device owner.\u003c/li\u003e\n\u003cli\u003e\"\u003ccode\u003emanagedProfile\u003c/code\u003e\", a device that has a profile managed\nby the DPC (DPC is profile owner) in addition to a separate, personal\nprofile that is unavailable to the DPC.\u003c/li\u003e\n\u003cli\u003e\"\u003ccode\u003econtainerApp\u003c/code\u003e\", no longer used (deprecated).\u003c/li\u003e\n\u003cli\u003e\"\u003ccode\u003eunmanagedProfile\u003c/code\u003e\", a device that has been allowed (by the\ndomain's admin, using the Admin Console to enable the privilege) to use\nmanaged Google Play, but the profile is itself\nnot owned by a DPC.\u003c/li\u003e\u003c/ul\u003e",
"enum": [
"MANAGED_DEVICE",
"MANAGED_PROFILE",
"CONTAINER_APP",
"UNMANAGED_PROFILE"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"policy": {
"$ref": "Policy",
"description": "The policy enforced on the device."
},
"report": {
"$ref": "DeviceReport",
"description": "The device report updated with the latest app states."
}
},
"type": "object"
},
"DeviceReport": {
"description": "Device report updated with the latest app states for managed apps on the\ndevice.",
"id": "DeviceReport",
"properties": {
"appState": {
"description": "List of app states set by managed apps on the device. App states are\ndefined by the app's developers.\nThis field will always be present.",
"items": {
"$ref": "AppState"
},
"type": "array"
},
"lastUpdatedTimestampMillis": {
"description": "The timestamp of the last report update in milliseconds since epoch.\nThis field will always be present.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"DeviceReportUpdateEvent": {
"description": "An event generated when an updated device report is available.",
"id": "DeviceReportUpdateEvent",
"properties": {
"deviceId": {
"description": "The Android ID of the device.\nThis field will always be present.",
"type": "string"
},
"report": {
"$ref": "DeviceReport",
"description": "The device report updated with the latest app states.\nThis field will always be present."
},
"userId": {
"description": "The ID of the user.\nThis field will always be present.",
"type": "string"
}
},
"type": "object"
},
"DeviceState": {
"description": "The state of a user's device, as accessed by the getState and setState\nmethods on device resources.",
"id": "DeviceState",
"properties": {
"accountState": {
"description": "The state of the Google account on the device. \"enabled\" indicates that\nthe Google account on the device can be used to access Google services\n(including Google Play), while \"disabled\" means that it cannot.\nA new device is initially in the \"disabled\" state.",
"enum": [
"ENABLED",
"DISABLED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"DevicesListResponse": {
"id": "DevicesListResponse",
"properties": {
"device": {
"description": "A managed device.",
"items": {
"$ref": "Device"
},
"type": "array"
}
},
"type": "object"
},
"Enterprise": {
"description": "An Enterprises resource represents the binding between an EMM and a\nspecific organization. That binding can be instantiated in one of two\ndifferent ways using this API as follows:\n\u003cul\u003e\u003cli\u003eFor Google managed domain customers, the process involves using\n\u003ccode\u003eEnterprises.enroll\u003c/code\u003e and \u003ccode\u003eEnterprises.setAccount\u003c/code\u003e (in\nconjunction with artifacts obtained from the Admin console and the Google\nAPI Console) and submitted to the EMM through a more-or-less manual\nprocess.\u003c/li\u003e\n\u003cli\u003eFor managed Google Play Accounts customers, the process involves using\n\u003ccode\u003eEnterprises.generateSignupUrl\u003c/code\u003e and\n\u003ccode\u003eEnterprises.completeSignup\u003c/code\u003e in conjunction with the managed\nGoogle Play sign-up UI (Google-provided mechanism) to create the binding\nwithout manual steps.\u003c/li\u003e\u003c/ul\u003e As an EMM, you can support either or both\napproaches in your EMM console. See \u003ca\nhref=\"/android/work/play/emm-api/create-enterprise\"\u003eCreate an Enterprise\u003c/a\u003e\nfor details.",
"id": "Enterprise",
"properties": {
"administrator": {
"description": "Admins of the enterprise. This is only supported for enterprises\ncreated via the EMM-initiated flow.",
"items": {
"$ref": "Administrator"
},
"type": "array"
},
"id": {
"description": "The unique ID for the enterprise.",
"type": "string"
},
"name": {
"description": "The name of the enterprise, for example, \"Example, Inc\".",
"type": "string"
},
"primaryDomain": {
"description": "The enterprise's primary domain, such as \"example.com\".",
"type": "string"
}
},
"type": "object"
},
"EnterpriseAccount": {
"description": "A service account that can be used to authenticate as the enterprise to\nAPI calls that require such authentication.",
"id": "EnterpriseAccount",
"properties": {
"accountEmail": {
"description": "The email address of the service account.",
"type": "string"
}
},
"type": "object"
},
"EnterprisesListResponse": {
"id": "EnterprisesListResponse",
"properties": {
"enterprise": {
"description": "An enterprise.",
"items": {
"$ref": "Enterprise"
},
"type": "array"
}
},
"type": "object"
},
"EnterprisesSendTestPushNotificationResponse": {
"id": "EnterprisesSendTestPushNotificationResponse",
"properties": {
"messageId": {
"description": "The message ID of the test push notification that was sent.",
"type": "string"
},
"topicName": {
"description": "The name of the Cloud Pub/Sub topic to which notifications for this\nenterprise's enrolled account will be sent.",
"type": "string"
}
},
"type": "object"
},
"Entitlement": {
"description": "The presence of an Entitlements resource indicates that a user has the right\nto use a particular app. Entitlements are user specific, not device specific.\nThis allows a user with an entitlement to an app to install the app on all\ntheir devices. It's also possible for a user to hold an entitlement to an app\nwithout installing the app on any device.\n\nThe API can be used to create an entitlement. As an option, you can also use\nthe API to trigger the installation of an app on all a user's managed devices\nat the same time the entitlement is created.\n\nIf the app is free, creating the entitlement also creates a group license\nfor that app. For paid apps, creating the entitlement consumes one license,\nand that license remains consumed until the entitlement is removed. If the\nenterprise hasn't purchased enough licenses, then no entitlement is created\nand the installation fails. An entitlement is also not created for an app if\nthe app requires permissions that the enterprise hasn't accepted.\n\nIf an entitlement is deleted, the app may be uninstalled from a user's\ndevice. As a best practice, uninstall the app by calling\n\u003ca class=\"method-link\" method=\"androidenterprise.installs.delete\"\u003e\nInstalls.delete()\u003c/a\u003e before deleting the entitlement.\n\nEntitlements for apps that a user pays for on an unmanaged profile have\n\u003ccode class=\"\"\u003e\"userPurchase\"\u003c/code\u003e as the entitlement reason. These\nentitlements cannot be removed via the API.",
"id": "Entitlement",
"properties": {
"productId": {
"description": "The ID of the product that the entitlement is for. For example,\n\u003ccode\u003e\u0026quot;app:com.google.android.gm\u0026quot;\u003c/code\u003e.",
"type": "string"
},
"reason": {
"description": "The reason for the entitlement. For example, \u003ccode class=\"\"\u003e\"free\"\u003c/code\u003e\nfor free apps. This property is temporary: it will be replaced by the \u003ccode\nclass=\"\"\u003eacquisition kind\u003c/code\u003e field of group licenses.",
"enum": [
"FREE",
"GROUP_LICENSE",
"USER_PURCHASE"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"EntitlementsListResponse": {
"id": "EntitlementsListResponse",
"properties": {
"entitlement": {
"description": "An entitlement of a user to a product (e.g. an app).\nFor example, a free app that they have installed, or a paid app that they\nhave been allocated a license to.",
"items": {
"$ref": "Entitlement"
},
"type": "array"
}
},
"type": "object"
},
"GroupLicense": {
"description": "Group license objects allow you to keep track of licenses (called\n\u003ca href=\"/android/work/play/emm-api/v1/entitlements\"\u003eentitlements\u003c/a\u003e)\nfor both free and paid apps. For a free app, a group license is created when\nan enterprise admin first approves the product in Google Play or when the\nfirst entitlement for the product is created for a user via the API. For a\npaid app, a group license object is only created when an enterprise admin\npurchases the product in Google Play for the first time.\n\nUse the API to query group licenses. A \u003ccode\u003eGrouplicenses\u003c/code\u003e resource\nincludes the total number of licenses purchased (paid apps only) and the\ntotal number of licenses currently in use. In other words, the total number\nof \u003ccode\u003eEntitlements\u003c/code\u003e that exist for the product.\n\nOnly one group license object is created per product and group license\nobjects are never deleted. If a product is unapproved, its group license\nremains. This allows enterprise admins to keep track of any remaining\nentitlements for the product.",
"id": "GroupLicense",
"properties": {
"acquisitionKind": {
"description": "How this group license was acquired. \u003ccode\u003e\u0026quot;bulkPurchase\u0026quot;\u003c/code\u003e\nmeans that this Grouplicenses resource was created because the enterprise\npurchased licenses for this product; otherwise, the value is\n\u003ccode\u003e\u0026quot;free\u0026quot;\u003c/code\u003e (for free products).",
"enum": [
"FREE",
"BULK_PURCHASE"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"approval": {
"description": "Whether the product to which this group license relates is currently\napproved by the enterprise. Products are approved when a group license is\nfirst created, but this approval may be revoked by an enterprise admin via\nGoogle Play. Unapproved products will not be visible to end users in\ncollections, and new entitlements to them should not normally be created.",
"enum": [
"APPROVED",
"UNAPPROVED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"numProvisioned": {
"description": "The total number of provisioned licenses for this product.\nReturned by read operations, but ignored in write operations.",
"format": "int32",
"type": "integer"
},
"numPurchased": {
"description": "The number of purchased licenses (possibly in multiple purchases).\nIf this field is omitted, then there is no limit on the number of licenses\nthat can be provisioned (for example, if the acquisition kind is\n\u003ccode\u003e\u0026quot;free\u0026quot;\u003c/code\u003e).",
"format": "int32",
"type": "integer"
},
"permissions": {
"description": "The permission approval status of the product. This field\nis only set if the product is approved. Possible states are:\u003cul\u003e\n\u003cli\u003e\"\u003ccode\u003ecurrentApproved\u003c/code\u003e\", the current set\nof permissions is approved, but additional permissions will require the\nadministrator to reapprove the product (If the product was approved\nwithout specifying the approved permissions setting, then this is the\ndefault behavior.),\u003c/li\u003e\n\u003cli\u003e\"\u003ccode\u003eneedsReapproval\u003c/code\u003e\", the product has unapproved permissions.\nNo additional product licenses can be assigned until the product is\nreapproved,\u003c/li\u003e\n\u003cli\u003e\"\u003ccode\u003eallCurrentAndFutureApproved\u003c/code\u003e\",\nthe current permissions are approved and any future permission updates\nwill be automatically approved without administrator review.\u003c/li\u003e\u003c/ul\u003e",
"enum": [
"CURRENT_APPROVED",
"NEEDS_REAPPROVAL",
"ALL_CURRENT_AND_FUTURE_APPROVED"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"productId": {
"description": "The ID of the product that the license is for. For example,\n\u003ccode\u003e\u0026quot;app:com.google.android.gm\u0026quot;\u003c/code\u003e.",
"type": "string"
}
},
"type": "object"
},
"GroupLicenseUsersListResponse": {
"id": "GroupLicenseUsersListResponse",
"properties": {
"user": {
"description": "A user of an enterprise.",
"items": {
"$ref": "User"
},
"type": "array"
}
},
"type": "object"
},
"GroupLicensesListResponse": {
"id": "GroupLicensesListResponse",
"properties": {
"groupLicense": {
"description": "A group license for a product approved for use in the enterprise.",
"items": {
"$ref": "GroupLicense"
},
"type": "array"
}
},
"type": "object"
},
"Install": {
"description": "The existence of an Installs resource indicates that an app is\ninstalled on a particular device (or that an install is pending).\n\nThe API can be used to create an install resource using the\n\u003ca class=\"method-link\" method=\"androidenterprise.installs.update\"\u003eupdate\u003c/a\u003e\nmethod. This triggers the actual install of the app on the device. If the\nuser does not already have an entitlement for the app, then an attempt is\nmade to create one. If this fails (for example, because the app is not free\nand 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\nthe\u0026nbsp;\u003ca class=\"method-link\" method=\"androidenterprise.installs.update\"\nstyle=\"font-style: normal; font-size: 14px; font-family: Roboto, sans-serif;\nline-height: 22.3999996185303px;\"\u003eupdate\u003c/a\u003e\u0026nbsp;method is\nused on an existing install, then the app will be updated to the latest\navailable version.\n\nNote that it is not possible to force the installation of a specific version\nof an app: the version code is read-only.\n\nIf a user installs an app themselves (as permitted by the enterprise), then\nagain an install resource and possibly an entitlement resource are\nautomatically created.\n\nThe API can also be used to delete an install resource, which triggers the\nremoval of the app from the device. Note that deleting an install does not\nautomatically remove the corresponding entitlement, even if there are no\nremaining installs. The install resource will also be deleted if the user\nuninstalls the app themselves.",
"id": "Install",
"properties": {
"installState": {
"description": "Install state. The state \u003ccode\u003e\u0026quot;installPending\u0026quot;\u003c/code\u003e\nmeans that an install request has recently been made and download to the\ndevice is in progress. The state \u003ccode\u003e\u0026quot;installed\u0026quot;\u003c/code\u003e\nmeans that the app has been installed. This field is read-only.",
"enum": [
"INSTALLED",
"INSTALL_PENDING"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"productId": {
"description": "The ID of the product that the install is for. For example,\n\u003ccode\u003e\u0026quot;app:com.google.android.gm\u0026quot;\u003c/code\u003e.",
"type": "string"
},
"versionCode": {
"description": "The version of the installed product. Guaranteed to be set only if the\ninstall state is \u003ccode\u003e\u0026quot;installed\u0026quot;\u003c/code\u003e.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"InstallFailureEvent": {
"description": "An event generated when an app installation failed on a device",
"id": "InstallFailureEvent",
"properties": {
"deviceId": {
"description": "The Android ID of the device.\nThis 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.\nThis field will always be present.",
"enum": [
"UNKNOWN",
"TIMEOUT"
],
"enumDescriptions": [
"Used whenever no better reason for failure can be provided.",
"Used when the installation timed out. This can cover a number of\nsituations, for example when the device did not have connectivity\nat any point during the retry period, or if the device is OOM."
],
"type": "string"
},
"productId": {
"description": "The id of the product (e.g. \"app:com.google.android.gm\") for which the\ninstall failure event occured. This field will always be present.",
"type": "string"
},
"userId": {
"description": "The ID of the user.\nThis field will always be present.",
"type": "string"
}
},
"type": "object"
},
"InstallsListResponse": {
"id": "InstallsListResponse",
"properties": {
"install": {
"description": "An installation of an app for a user on a specific device.\nThe existence of an install implies that the user must have an\nentitlement to the app.",
"items": {
"$ref": "Install"
},
"type": "array"
}
},
"type": "object"
},
"KeyedAppState": {
"description": "Represents a keyed app state containing a key, timestamp, severity level,\noptional description, and optional data.",
"id": "KeyedAppState",
"properties": {
"data": {
"description": "Additional field intended for machine-readable data. For example, a number\nor JSON object. To prevent XSS, we recommend removing any HTML from the\ndata before displaying it.",
"type": "string"
},
"key": {
"description": "Key indicating what the app is providing a state for. The content of the\nkey is set by the app's developer. To prevent XSS, we recommend removing\nany HTML from the key before displaying it.\nThis field will always be present.",
"type": "string"
},
"message": {
"description": "Free-form, human-readable message describing the app state. For example,\nan error message. To prevent XSS, we recommend removing any HTML from the\nmessage before displaying it.",
"type": "string"
},
"severity": {
"description": "Severity of the app state.\nThis field will always be present.",
"enum": [
"SEVERITY_UNKNOWN",
"SEVERITY_INFO",
"SEVERITY_ERROR"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"stateTimestampMillis": {
"description": "Timestamp of when the app set the state in milliseconds since epoch.\nThis field will always be present.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"LocalizedText": {
"description": "A localized string with its locale.",
"id": "LocalizedText",
"properties": {
"locale": {
"description": "The BCP47 tag for a locale. (e.g. \"en-US\", \"de\").",
"type": "string"
},
"text": {
"description": "The text localized in the associated locale.",
"type": "string"
}
},
"type": "object"
},
"MaintenanceWindow": {
"description": "Maintenance window for managed Google Play Accounts.\nThis allows Play store to update the apps on the foreground in the designated\nwindow.",
"id": "MaintenanceWindow",
"properties": {
"durationMs": {
"description": "Duration of the maintenance window, in milliseconds. The duration must be\nbetween 30 minutes and 24 hours (inclusive).",
"format": "int64",
"type": "string"
},
"startTimeAfterMidnightMs": {
"description": "Start time of the maintenance window, in milliseconds after midnight on the\ndevice. Windows can span midnight.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"ManagedConfiguration": {
"description": "A managed configuration resource contains the set of managed properties\ndefined by the app developer in the app's managed configurations schema,\nas 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\nconfiguration variables (if any) defined for the user."
},
"kind": {
"description": "Deprecated.",
"type": "string"
},
"managedProperty": {
"description": "The set of managed properties for this configuration.",
"items": {
"$ref": "ManagedProperty"
},
"type": "array"
},
"productId": {
"description": "The ID of the product that the managed configuration is for, e.g.\n\"app:com.google.android.gm\".",
"type": "string"
}
},
"type": "object"
},
"ManagedConfigurationsForDeviceListResponse": {
"id": "ManagedConfigurationsForDeviceListResponse",
"properties": {
"managedConfigurationForDevice": {
"description": "A managed configuration for an app on a specific device.",
"items": {
"$ref": "ManagedConfiguration"
},
"type": "array"
}
},
"type": "object"
},
"ManagedConfigurationsForUserListResponse": {
"id": "ManagedConfigurationsForUserListResponse",
"properties": {
"managedConfigurationForUser": {
"description": "A managed configuration for an app for a specific user.",
"items": {
"$ref": "ManagedConfiguration"
},
"type": "array"
}
},
"type": "object"
},
"ManagedConfigurationsSettings": {
"description": "A managed configurations settings resource contains the set of\nmanaged properties that have been configured for an Android app to be applied\nto a set of users. The app's developer would have\ndefined configurable properties in the managed configurations schema.",
"id": "ManagedConfigurationsSettings",
"properties": {
"lastUpdatedTimestampMillis": {
"description": "The last updated time of the managed configuration settings in\nmilliseconds since 1970-01-01T00:00:00Z.",
"format": "int64",
"type": "string"
},
"mcmId": {
"description": "The ID of the managed configurations settings.",
"type": "string"
},
"name": {
"description": "The name of the managed configurations settings.",
"type": "string"
}
},
"type": "object"
},
"ManagedConfigurationsSettingsListResponse": {
"id": "ManagedConfigurationsSettingsListResponse",
"properties": {
"managedConfigurationsSettings": {
"description": "A managed configurations settings for an app that may be assigned to a\ngroup of users in an enterprise.",
"items": {
"$ref": "ManagedConfigurationsSettings"
},
"type": "array"
}
},
"type": "object"
},
"ManagedProperty": {
"description": "A managed property of a managed configuration. The property must match one of\nthe properties in the app restrictions schema of the product. Exactly one of\nthe value fields must be populated, and it must match the property's type in\nthe 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\nbool.",
"type": "boolean"
},
"valueBundle": {
"$ref": "ManagedPropertyBundle",
"description": "The bundle of managed properties - this will only be present if type of the\nproperty is bundle."
},
"valueBundleArray": {
"description": "The list of bundles of properties - this will only be present if type of\nthe 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\ninteger.",
"format": "int32",
"type": "integer"
},
"valueString": {
"description": "The string value - this will only be present if type of the property is\nstring, choice or hidden.",
"type": "string"
},
"valueStringArray": {
"description": "The list of string values - this will only be present if type of the\nproperty is multiselect.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ManagedPropertyBundle": {
"description": "A bundle of managed properties.",
"id": "ManagedPropertyBundle",
"properties": {
"managedProperty": {
"description": "The list of managed properties.",
"items": {
"$ref": "ManagedProperty"
},
"type": "array"
}
},
"type": "object"
},
"NewDeviceEvent": {
"description": "An event generated when a new device is ready to be managed.",
"id": "NewDeviceEvent",
"properties": {
"deviceId": {
"description": "The Android ID of the device.\nThis 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\nEMM in various deployment configurations. \u003cbr\u003e\u003cbr\u003e\nPossible values include:\n\u003cul\u003e\u003cli\u003e\"\u003ccode\u003emanagedDevice\u003c/code\u003e\", a device where the DPC is set as\ndevice owner,\u003c/li\u003e\n\u003cli\u003e\"\u003ccode\u003emanagedProfile\u003c/code\u003e\", a device where the DPC is set as profile\nowner.\u003c/li\u003e\u003c/ul\u003e",
"enum": [
"MANAGED_DEVICE",
"MANAGED_PROFILE"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"userId": {
"description": "The ID of the user.\nThis field will always be present.",
"type": "string"
}
},
"type": "object"
},
"NewPermissionsEvent": {
"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\nthis application.\nUse Permissions.Get on the EMM API to retrieve details about these\npermissions.",
"items": {
"type": "string"
},
"type": "array"
},
"productId": {
"description": "The id of the product (e.g. \"app:com.google.android.gm\") for which new\npermissions were added. This field will always be present.",
"type": "string"
},
"requestedPermissions": {
"description": "The set of permissions that the app is currently requesting.\nUse Permissions.Get on the EMM API to retrieve details about these\npermissions.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Notification": {
"description": "A notification of one event relating to an enterprise.",
"id": "Notification",
"properties": {
"appRestrictionsSchemaChangeEvent": {
"$ref": "AppRestrictionsSchemaChangeEvent",
"description": "Notifications about new app restrictions schema changes."
},
"appUpdateEvent": {
"$ref": "AppUpdateEvent",
"description": "Notifications about app updates."
},
"deviceReportUpdateEvent": {
"$ref": "DeviceReportUpdateEvent",
"description": "Notifications about device report updates."
},
"enterpriseId": {
"description": "The ID of the enterprise for which the notification is sent.\nThis will always be present.",
"type": "string"
},
"installFailureEvent": {
"$ref": "InstallFailureEvent",
"description": "Notifications about an app installation failure."
},
"newDeviceEvent": {
"$ref": "NewDeviceEvent",
"description": "Notifications about new devices."
},
"newPermissionsEvent": {
"$ref": "NewPermissionsEvent",
"description": "Notifications about new app permissions."
},
"notificationType": {
"description": "Type of the notification.",
"enum": [
"UNKNOWN",
"TEST_NOTIFICATION",
"PRODUCT_APPROVAL",
"INSTALL_FAILURE",
"APP_UPDATE",
"NEW_PERMISSIONS",
"APP_RESTRICIONS_SCHEMA_CHANGE",
"PRODUCT_AVAILABILITY_CHANGE",
"NEW_DEVICE",
"DEVICE_REPORT_UPDATE"
],
"enumDescriptions": [
"",
"A test push notification.",
"Notification about change to a product's approval status.",
"Notification about an app installation failure.",
"Notification about app update.",
"Notification about new app permissions.",
"Notification about new app restrictions schema change.",
"Notification about product availability change.",
"Notification about a new device.",
"Notification about an updated device report."
],
"type": "string"
},
"productApprovalEvent": {
"$ref": "ProductApprovalEvent",
"description": "Notifications about changes to a product's approval status."
},
"productAvailabilityChangeEvent": {
"$ref": "ProductAvailabilityChangeEvent",
"description": "Notifications about product availability changes."
},
"timestampMillis": {
"description": "The time when the notification was published in\nmilliseconds since 1970-01-01T00:00:00Z.\nThis will always be present.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"NotificationSet": {
"description": "A resource returned by the PullNotificationSet API, which contains\na collection of notifications for enterprises associated with the service\naccount authenticated for the request.",
"id": "NotificationSet",
"properties": {
"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\nreceived with the Enterprises.AcknowledgeNotification API.\nThis will be omitted if no notifications are present.",
"type": "string"
}
},
"type": "object"
},
"PageInfo": {
"description": "Information about the current page.\n\nList operations that supports paging return only one \"page\" of results. This\nprotocol buffer message describes the page that has been returned.",
"id": "PageInfo",
"properties": {
"resultPerPage": {
"description": "Maximum number of results returned in one page.\n! The number of results included in the API response.",
"format": "int32",
"type": "integer"
},
"startIndex": {
"description": "Index of the first result returned in the current page.",
"format": "int32",
"type": "integer"
},
"totalResults": {
"description": "Total number of results available on the backend\n! The total number of results in the result set.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"Permission": {
"description": "A Permissions resource represents some extra capability, to be granted to an\nAndroid app, which requires explicit consent. An enterprise admin must\nconsent to these permissions on behalf of their users before an\nentitlement for the app can be created.\n\nThe permissions collection is read-only. The information provided for\neach permission (localized name and description) is intended to be\nused in the MDM user interface when obtaining consent from the\nenterprise.",
"id": "Permission",
"properties": {
"description": {
"description": "A longer description of the Permissions resource, giving more details of\nwhat it affects.",
"type": "string"
},
"name": {
"description": "The name of the permission.",
"type": "string"
},
"permissionId": {
"description": "An opaque string uniquely identifying the permission.",
"type": "string"
}
},
"type": "object"
},
"Policy": {
"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\"\nallows the device's user to configure the app update policy. \"always\"\nenables auto updates. \"never\" disables auto updates. \"wifiOnly\" enables\nauto updates only when the device is connected to wifi.",
"enum": [
"AUTO_UPDATE_POLICY_UNSPECIFIED",
"CHOICE_TO_THE_USER",
"NEVER",
"WIFI_ONLY",
"ALWAYS"
],
"enumDescriptions": [
"The auto update policy is not set.",
"The user can control auto-updates.",
"Apps are never auto-updated.",
"Apps are auto-updated over WiFi only.",
"Apps are auto-updated at any time. Data charges may apply."
],
"type": "string"
},
"deviceReportPolicy": {
"description": "Whether the device reports app states to the EMM. The default value is\n\"deviceReportDisabled\".",
"enum": [
"DEVICE_REPORT_POLICY_UNSPECIFIED",
"DEVICE_REPORT_DISABLED",
"DEVICE_REPORT_ENABLED"
],
"enumDescriptions": [
"The device report policy is not set.",
"Device reports are disabled.",
"Device reports are enabled."
],
"type": "string"
},
"maintenanceWindow": {
"$ref": "MaintenanceWindow",
"description": "The maintenance window defining when apps running in the foreground should\nbe updated."
},
"productAvailabilityPolicy": {
"description": "The availability granted to the device for the specified products. \"all\"\ngives the device access to all products, regardless of approval status.\n\"all\" does not enable automatic visibility of \"alpha\" or \"beta\" tracks.\n\"whitelist\" grants the device access the products specified in\nproductPolicy[]. Only products that are approved or products that were\npreviously approved (products with revoked approval) by the enterprise can\nbe whitelisted. If no value is provided, the availability set at the user\nlevel is applied by default.",
"enum": [
"PRODUCT_AVAILABILITY_POLICY_UNSPECIFIED",
"WHITELIST",
"ALL"
],
"enumDescriptions": [
"Unspecified, applies the user available product set by default.",
"The approved products with product availability set to AVAILABLE\nin the product policy are available.",
"All products are available except those explicitly marked as\nunavailable in the product availability policy."
],
"type": "string"
},
"productPolicy": {
"description": "The list of product policies. The \u003ccode\u003eproductAvailabilityPolicy\u003c/code\u003e\nneeds to be set to \u003ccode\u003eWHITELIST\u003c/code\u003e or \u003ccode\u003eALL\u003c/code\u003e for the\nproduct policies to be applied.",
"items": {
"$ref": "ProductPolicy"
},
"type": "array"
}
},
"type": "object"
},
"Product": {
"description": "A Products resource represents an app in the Google Play store that is\navailable to at least some users in the enterprise. (Some apps are restricted\nto a single enterprise, and no information about them is made available\noutside that enterprise.)\n\nThe information provided for each product (localized name, icon, link\nto the full Google Play details page) is intended to allow a basic\nrepresentation of the product within an EMM user interface.",
"id": "Product",
"properties": {
"appTracks": {
"description": "The tracks visible to the enterprise.",
"items": {
"$ref": "TrackInfo"
},
"type": "array"
},
"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": "Deprecated, use \u003ccode\u003eappTracks\u003c/code\u003e instead.",
"enumDescriptions": [
"",
"",
"",
""
],
"items": {
"enum": [
"APP_TRACK_UNSPECIFIED",
"PRODUCTION",
"BETA",
"ALPHA"
],
"type": "string"
},
"type": "array"
},
"category": {
"description": "The app category (e.g. RACING, SOCIAL, etc.)",
"type": "string"
},
"contentRating": {
"description": "The content rating for this app.",
"enum": [
"RATING_UNKNOWN",
"ALL",
"PRE_TEEN",
"TEEN",
"MATURE"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
},
"description": {
"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.\nThe value \u003ccode\u003epublicGoogleHosted\u003c/code\u003e means that the package is\navailable through the Play store and not restricted to a specific\nenterprise. The value \u003ccode\u003eprivateGoogleHosted\u003c/code\u003e means that the\npackage is a private app (restricted to an enterprise) but hosted by\nGoogle. The value \u003ccode\u003eprivateSelfHosted\u003c/code\u003e means that the package is\na private app (restricted to an enterprise) and is privately hosted.",
"enum": [
"PUBLIC_GOOGLE_HOSTED",
"PRIVATE_GOOGLE_HOSTED",
"PRIVATE_SELF_HOSTED"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"features": {
"description": "Noteworthy features (if any) of this product.",
"enumDescriptions": [
"",
"The app is a VPN."
],
"items": {
"enum": [
"FEATURE_UNKNOWN",
"VPN_APP"
],
"type": "string"
},
"type": "array"
},
"iconUrl": {
"description": "A link to an image that can be used as an icon for the product.\nThis image is suitable for use at up to 512px x 512px.",
"type": "string"
},
"lastUpdatedTimestampMillis": {
"description": "The approximate time (within 7 days) the app was last published, expressed\nin 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 \u003ccode\u003e\u003cem\u003eapp:\u0026lt;package name\u0026gt;\u003c/em\u003e\u003c/code\u003e. For\nexample, \u003ccode\u003eapp:com.google.android.gm\u003c/code\u003e represents the Gmail app.",
"type": "string"
},
"productPricing": {
"description": "Whether this product is free, free with in-app purchases, or paid.\nIf the pricing is unknown, this means the product is not generally\navailable anymore (even though it might still be available to\npeople who own it).",
"enum": [
"UNKNOWN",
"FREE",
"FREE_WITH_IN_APP_PURCHASE",
"PAID"
],
"enumDescriptions": [
"Unknown pricing, used to denote an approved product that is not\ngenerally available.",
"The product is free.",
"The product is free, but offers in-app purchases.",
"The product is paid."
],
"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.\nThis 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,\nfor use by an Enterprise admin.",
"type": "string"
}
},
"type": "object"
},
"ProductApprovalEvent": {
"description": "An event generated when a product's approval status is changed.",
"id": "ProductApprovalEvent",
"properties": {
"approved": {
"description": "Whether the product was approved or unapproved.\nThis field will always be present.",
"enum": [
"UNKNOWN",
"APPROVED",
"UNAPPROVED"
],
"enumDescriptions": [
"Conveys no information.",
"The product was approved.",
"The product was unapproved."
],
"type": "string"
},
"productId": {
"description": "The id of the product (e.g. \"app:com.google.android.gm\") for which the\napproval status has changed. This field will always be present.",
"type": "string"
}
},
"type": "object"
},
"ProductAvailabilityChangeEvent": {
"description": "An event generated whenever a product's availability changes.",
"id": "ProductAvailabilityChangeEvent",
"properties": {
"availabilityStatus": {
"description": "The new state of the product.\nThis field will always be present.",
"enum": [
"UNKNOWN",
"AVAILABLE",
"REMOVED",
"UNPUBLISHED"
],
"enumDescriptions": [
"Conveys no information.",
"The previously unavailable product is again available on Google Play.",
"The product was removed from Google Play.",
"The product was unpublished by the developer."
],
"type": "string"
},
"productId": {
"description": "The id of the product (e.g. \"app:com.google.android.gm\") for which the\nproduct availability changed. This field will always be present.",
"type": "string"
}
},
"type": "object"
},
"ProductPermission": {
"description": "A product permissions resource represents the set of permissions\nrequired by a specific app and whether or not they have been accepted\nby an enterprise admin.\n\nThe API can be used to read the set of permissions, and also to update\nthe 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.",
"enum": [
"REQUIRED",
"ACCEPTED"
],
"enumDescriptions": [
"The permission is required by the app but has not yet been accepted by\nthe enterprise.",
"The permission has been accepted by the enterprise."
],
"type": "string"
}
},
"type": "object"
},
"ProductPermissions": {
"description": "Information about the permissions required by a specific app and\nwhether they have been accepted by the enterprise.",
"id": "ProductPermissions",
"properties": {
"permission": {
"description": "The permissions required by the app.",
"items": {
"$ref": "ProductPermission"
},
"type": "array"
},
"productId": {
"description": "The ID of the app that the permissions relate to, e.g.\n\"app:com.google.android.gm\".",
"type": "string"
}
},
"type": "object"
},
"ProductPolicy": {
"description": "The policy for a product.",
"id": "ProductPolicy",
"properties": {
"autoInstallPolicy": {
"$ref": "AutoInstallPolicy",
"description": "The auto-install policy for the product."
},
"managedConfiguration": {
"$ref": "ManagedConfiguration",
"description": "The managed configuration for the product."
},
"productId": {
"description": "The ID of the product. For example,\n\u003ccode\u003e\u0026quot;app:com.google.android.gm\u0026quot;\u003c/code\u003e.",
"type": "string"
},
"trackIds": {
"description": "Grants the device visibility to the specified product release track(s),\nidentified by \u003ccode\u003etrackIds\u003c/code\u003e. The list of release tracks of a\nproduct can be obtained by calling Products.Get.",
"items": {
"type": "string"
},
"type": "array"
},
"tracks": {
"description": "Deprecated. Use \u003ccode\u003etrackIds\u003c/code\u003e instead.",
"enumDescriptions": [
"",
"",
"",
""
],
"items": {
"enum": [
"APP_TRACK_UNSPECIFIED",
"PRODUCTION",
"BETA",
"ALPHA"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ProductSet": {
"description": "A set of products.",
"id": "ProductSet",
"properties": {
"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\nis ignored if received. \"whitelist\" means that the user is entitled to\naccess the product set. \"includeAll\" means that all products are\naccessible, including products that are approved, products with revoked\napproval, and products that have never been approved. \"allApproved\" means\nthat the user is entitled to access all products that are approved for the\nenterprise. If the value is \"allApproved\" or \"includeAll\", the productId\nfield is ignored. If no value is provided, it is interpreted as\n\"whitelist\" for backwards compatibility.\nFurther \"allApproved\" or \"includeAll\" does not enable automatic\nvisibility of \"alpha\" or \"beta\" tracks for Android app. Use\nProductVisibility to enable \"alpha\" or \"beta\" tracks per user.",
"enum": [
"UNKNOWN",
"WHITELIST",
"INCLUDE_ALL",
"ALL_APPROVED"
],
"enumDescriptions": [
"This value should never be sent and ignored if received.",
"This product set constitutes a whitelist.",
"This product set represents all products.\nFor Android app it represents only \"production\" track.\n(The value of the productId field is therefore ignored).",
"This product set represents all approved products.\nFor Android app it represents only \"production\" track.\n(The value of the product_id field is therefore ignored)."
],
"type": "string"
},
"productVisibility": {
"description": "Additional list of product IDs making up the product set.\nUnlike the productID array, in this list It's possible to specify\nwhich tracks (alpha, beta, production) of a product are visible to the\nuser. See ProductVisibility and its fields for more information. Specifying\nthe same product ID both here and in the productId array is not allowed and\nit will result in an error.",
"items": {
"$ref": "ProductVisibility"
},
"type": "array"
}
},
"type": "object"
},
"ProductSigningCertificate": {
"id": "ProductSigningCertificate",
"properties": {
"certificateHashSha1": {
"description": "The base64 urlsafe encoded SHA1 hash of the certificate. (This field is\ndeprecated in favor of SHA2-256. It should not be used and may be\nremoved at any time.)",
"type": "string"
},
"certificateHashSha256": {
"description": "The base64 urlsafe encoded SHA2-256 hash of the certificate.",
"type": "string"
}
},
"type": "object"
},
"ProductVisibility": {
"description": "A product to be made visible to a user.",
"id": "ProductVisibility",
"properties": {
"productId": {
"description": "The product ID to make visible to the user.\nRequired for each item in the productVisibility list.",
"type": "string"
},
"trackIds": {
"description": "Grants the user visibility to the specified product track(s), identified by\n\u003ccode\u003etrackIds\u003c/code\u003e.",
"items": {
"type": "string"
},
"type": "array"
},
"tracks": {
"description": "Deprecated. Use \u003ccode\u003etrackIds\u003c/code\u003e instead.",
"enumDescriptions": [
"",
"",
"",
""
],
"items": {
"enum": [
"APP_TRACK_UNSPECIFIED",
"PRODUCTION",
"BETA",
"ALPHA"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ProductsApproveRequest": {
"id": "ProductsApproveRequest",
"properties": {
"approvalUrlInfo": {
"$ref": "ApprovalUrlInfo",
"description": "The approval URL that was shown to the user. Only the permissions shown\nto the user with that URL will be accepted, which may not be\nthe product's entire set of permissions. For example, the URL may only\ndisplay new permissions from an update after the product was approved,\nor not include new permissions if the product was updated since the URL\nwas generated."
},
"approvedPermissions": {
"description": "Sets how new permission requests for the product are handled.\n\"allPermissions\" automatically approves all current and future\npermissions for the product. \"currentPermissionsOnly\" approves the\ncurrent set of permissions for the product, but any future permissions\nadded through updates will require manual reapproval. If not specified,\nonly the current set of permissions will be approved.",
"enum": [
"CURRENT_PERMISSIONS_ONLY",
"ALL_PERMISSIONS"
],
"enumDescriptions": [
"Approve only the permissions the product requires at approval time.\nIf an update requires additional permissions, the app will not be updated\non devices associated with enterprise users until the additional\npermissions are approved.",
"All current and future permissions the app requires are automatically\napproved."
],
"type": "string"
}
},
"type": "object"
},
"ProductsGenerateApprovalUrlResponse": {
"id": "ProductsGenerateApprovalUrlResponse",
"properties": {
"url": {
"description": "A URL that can be rendered in an iframe to display the permissions (if\nany) of a product.\nThis URL can be used to approve the product only once and only within 24\nhours of being generated, using the \u003ccode\u003eProducts.approve\u003c/code\u003e call.\nIf the product is currently unapproved and has no permissions, this\nURL will point to an empty page.\nIf the product is currently approved, a URL will only be generated if\nthat product has added permissions since it was last approved, and the\nURL will only display those new permissions that have not yet been\naccepted.",
"type": "string"
}
},
"type": "object"
},
"ProductsListResponse": {
"id": "ProductsListResponse",
"properties": {
"pageInfo": {
"$ref": "PageInfo",
"description": "General pagination information."
},
"product": {
"description": "Information about a product (e.g. an app) in the Google Play store, for\ndisplay to an enterprise admin.",
"items": {
"$ref": "Product"
},
"type": "array"
},
"tokenPagination": {
"$ref": "TokenPagination",
"description": "Pagination information for token pagination."
}
},
"type": "object"
},
"ServiceAccount": {
"description": "A service account identity, including the name and credentials that can be\nused to authenticate as the service account.",
"id": "ServiceAccount",
"properties": {
"key": {
"$ref": "ServiceAccountKey",
"description": "Credentials that can be used to authenticate as this ServiceAccount."
},
"name": {
"description": "The account name of the service account, in the form of an email address.\nAssigned by the server.",
"type": "string"
}
},
"type": "object"
},
"ServiceAccountKey": {
"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\nis only populated when the ServiceAccountKey is created, and is not stored\nby Google.",
"type": "string"
},
"id": {
"description": "An opaque, unique identifier for this ServiceAccountKey.\nAssigned by the server.",
"type": "string"
},
"publicData": {
"description": "Public key data for the credentials file. This is an X.509 cert. If you are\nusing the \u003ccode\u003egoogleCredentials\u003c/code\u003e key type, this is identical to the\ncert that can be retrieved by using the X.509 cert url inside of the\ncredentials file.",
"type": "string"
},
"type": {
"annotations": {
"required": [
"androidenterprise.serviceaccountkeys.insert"
]
},
"description": "The file format of the generated key data.",
"enum": [
"GOOGLE_CREDENTIALS",
"PKCS12"
],
"enumDescriptions": [
"Google Credentials File format.",
"PKCS12 format. The password for the PKCS12 file is 'notasecret'.\nFor more information, see https://tools.ietf.org/html/rfc7292.\nThe data for keys of this type are base64 encoded according to RFC 4648\nSection 4. See http://tools.ietf.org/html/rfc4648#section-4."
],
"type": "string"
}
},
"type": "object"
},
"ServiceAccountKeysListResponse": {
"id": "ServiceAccountKeysListResponse",
"properties": {
"serviceAccountKey": {
"description": "The service account credentials.",
"items": {
"$ref": "ServiceAccountKey"
},
"type": "array"
}
},
"type": "object"
},
"SignupInfo": {
"description": "A resource returned by the GenerateSignupUrl API, which contains the\nSignup URL and Completion Token.",
"id": "SignupInfo",
"properties": {
"completionToken": {
"description": "An opaque token that will be required, along with the Enterprise Token,\nfor obtaining the enterprise resource from CompleteSignup.",
"type": "string"
},
"kind": {
"description": "Deprecated.",
"type": "string"
},
"url": {
"description": "A URL under which the Admin can sign up for an enterprise.\nThe page pointed to cannot be rendered in an iframe.",
"type": "string"
}
},
"type": "object"
},
"StoreCluster": {
"description": "Definition of a managed Google Play store cluster, a list of products\ndisplayed 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"
},
"name": {
"description": "Ordered list of localized strings giving the name of this page.\nThe text displayed is the one that best matches the user locale,\nor the first entry if there is no good match. There needs to be\nat least one entry.",
"items": {
"$ref": "LocalizedText"
},
"type": "array"
},
"orderInPage": {
"description": "String (US-ASCII only) used to determine order of this cluster within the\nparent page's elements. Page elements are sorted in lexicographic order\nof this field.\nDuplicated values are allowed, but ordering between elements with\nduplicate order is undefined.\n\nThe value of this field is never visible to a user, it is used solely\nfor the purpose of defining an ordering. Maximum length is 256\ncharacters.",
"type": "string"
},
"productId": {
"description": "List of products in the order they are displayed in the cluster. There\nshould not be duplicates within a cluster.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"StoreLayout": {
"description": "General setting for the managed Google Play store layout,\ncurrently only specifying the page to display the first time\nthe store is opened.",
"id": "StoreLayout",
"properties": {
"homepageId": {
"description": "The ID of the store page to be used as the homepage. The homepage is the\nfirst page shown in the managed Google Play Store.\n\nNot specifying a homepage is equivalent to setting the store layout\ntype to \"basic\".",
"type": "string"
},
"storeLayoutType": {
"description": "The store layout type. By default, this value is set to \"basic\"\nif the homepageId field is not set, and to \"custom\" otherwise.\nIf set to \"basic\", the layout will consist of all approved apps that\nhave been whitelisted for the user.",
"enum": [
"UNKNOWN",
"BASIC",
"CUSTOM"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"StoreLayoutClustersListResponse": {
"id": "StoreLayoutClustersListResponse",
"properties": {
"cluster": {
"description": "A store cluster of an enterprise.",
"items": {
"$ref": "StoreCluster"
},
"type": "array"
}
},
"type": "object"
},
"StoreLayoutPagesListResponse": {
"id": "StoreLayoutPagesListResponse",
"properties": {
"page": {
"description": "A store page of an enterprise.",
"items": {
"$ref": "StorePage"
},
"type": "array"
}
},
"type": "object"
},
"StorePage": {
"description": "Definition of a managed Google Play store page, made of a localized name\nand links to other pages. A page also contains clusters defined\nas a subcollection.",
"id": "StorePage",
"properties": {
"id": {
"description": "Unique ID of this page. Assigned by the server. Immutable once assigned.",
"type": "string"
},
"link": {
"description": "Ordered list of pages a user should be able to reach from this page.\nThe list can't include this page.\nIt is recommended that the basic pages are created first,\nbefore adding the links between pages.\n\nThe API doesn't verify that the pages exist or the pages are reachable.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "Ordered list of localized strings giving the name of this page.\nThe text displayed is the one that best matches the user locale,\nor the first entry if there is no good match. There needs to be\nat least one entry.",
"items": {
"$ref": "LocalizedText"
},
"type": "array"
}
},
"type": "object"
},
"TokenPagination": {
"description": "Pagination information returned by a List operation when token pagination\nis enabled.\n\nList operations that supports paging return only one \"page\" of results. This\nprotocol buffer message describes the page that has been returned.\n\nWhen using token pagination, clients should use the next/previous token\nto get another page of the result. The presence or absence of next/previous\ntoken indicates whether a next/previous page is available and provides a\nmean of accessing this page. ListRequest.page_token should be set to either\nnext_page_token or previous_page_token to access another page.",
"id": "TokenPagination",
"properties": {
"nextPageToken": {
"description": "Tokens to pass to the standard list field 'page_token'. Whenever available,\ntokens are preferred over manipulating start_index.",
"type": "string"
},
"previousPageToken": {
"type": "string"
}
},
"type": "object"
},
"TrackInfo": {
"description": "Id to name association of a track.",
"id": "TrackInfo",
"properties": {
"trackAlias": {
"description": "A modifiable name for a track. This is the visible name in the play\ndeveloper console.",
"type": "string"
},
"trackId": {
"description": "Unmodifiable, unique track identifier. This identifier is the\nreleaseTrackId in the url of the play developer console page that displays\nthe track information.",
"type": "string"
}
},
"type": "object"
},
"User": {
"description": "A Users resource represents an account associated with an enterprise. The\naccount may be specific to a device or to an individual user (who can then\nuse the account across multiple devices). The account may provide access to\nmanaged Google Play only, or to other Google services, depending on the\nidentity model:\n\u003cul\u003e\u003cli\u003eThe Google managed domain identity model requires synchronization to\nGoogle account sources (via \u003ccode\u003eprimaryEmail\u003c/code\u003e).\u003c/li\u003e\n\u003cli\u003eThe managed Google Play Accounts identity model provides a dynamic means\nfor enterprises to create user or device accounts as needed. These accounts\nprovide access to managed Google Play.\u003c/li\u003e\n\u003c/ul\u003e",
"id": "User",
"properties": {
"accountIdentifier": {
"annotations": {
"required": [
"androidenterprise.users.insert"
]
},
"description": "A unique identifier you create for this user, such as \"user342\" or\n\"asset#44418\". Do not use personally identifiable information (PII) for\nthis property. Must always be set for EMM-managed users.\nNot set for Google-managed users.",
"type": "string"
},
"accountType": {
"annotations": {
"required": [
"androidenterprise.users.insert"
]
},
"description": "The type of account that this user represents. A \u003ccode\u003euserAccount\u003c/code\u003e\ncan be installed on multiple devices, but a \u003ccode\u003edeviceAccount\u003c/code\u003e is\nspecific to a single device. An EMM-managed user (\u003ccode\u003eemmManaged\u003c/code\u003e)\ncan be either type (\u003ccode\u003euserAccount\u003c/code\u003e, \u003ccode\u003edeviceAccount\u003c/code\u003e),\nbut a Google-managed user (\u003ccode\u003egoogleManaged\u003c/code\u003e) is always a\n\u003ccode\u003euserAccount\u003c/code\u003e.",
"enum": [
"DEVICE_ACCOUNT",
"USER_ACCOUNT"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"displayName": {
"description": "The name that will appear in user interfaces. Setting this property is\noptional when creating EMM-managed users. If you do set this property,\nuse something generic about the organization (such as \"Example, Inc.\") or\nyour name (as EMM).\nNot used for Google-managed user accounts.\n@mutable androidenterprise.users.update",
"type": "string"
},
"id": {
"description": "The unique ID for the user.",
"type": "string"
},
"managementType": {
"description": "The entity that manages the user. With \u003ccode\u003egoogleManaged\u003c/code\u003e users,\nthe source of truth is Google so EMMs have to make sure a Google Account\nexists for the user. With \u003ccode\u003eemmManaged\u003c/code\u003e users, the\nEMM is in charge.",
"enum": [
"GOOGLE_MANAGED",
"EMM_MANAGED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"primaryEmail": {
"description": "The user's primary email address, for example, \"jsmith@example.com\".\nWill always be set for Google managed users and not set for EMM managed\nusers.",
"type": "string"
}
},
"type": "object"
},
"UsersListResponse": {
"id": "UsersListResponse",
"properties": {
"user": {
"description": "A user of an enterprise.",
"items": {
"$ref": "User"
},
"type": "array"
}
},
"type": "object"
},
"VariableSet": {
"description": "A variable set is a key-value pair of EMM-provided placeholders and\nits corresponding value, which is attributed to a user. For example,\n$FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders\nshould start with a '$' sign and should be alphanumeric only.",
"id": "VariableSet",
"properties": {
"placeholder": {
"description": "The placeholder string; defined by EMM.",
"type": "string"
},
"userValue": {
"description": "The value of the placeholder, specific to the user.",
"type": "string"
}
},
"type": "object"
},
"WebApp": {
"description": "A WebApps resource represents a web app created for an enterprise. Web apps\nare published to managed Google Play and can be distributed like other\nAndroid apps. On a user's device, a web app opens its specified URL.",
"id": "WebApp",
"properties": {
"displayMode": {
"description": "The display mode of the web app. \u003cbr\u003e\u003cbr\u003e\nPossible values include:\n\u003cul\u003e\u003cli\u003e\"\u003ccode\u003eminimalUi\u003c/code\u003e\", the device's status bar, navigation bar,\nthe app's URL, and a refresh button are visible when the app is open. For\nHTTP URLs, you can only select this option.\n\u003cli\u003e\"\u003ccode\u003estandalone\u003c/code\u003e\", the device's status bar and navigation\nbar are visible when the app is open.\n\u003cli\u003e\"\u003ccode\u003efullScreen\u003c/code\u003e\", the app opens in full screen mode, hiding\nthe device's status and navigation bars. All browser UI elements, page\nURL, system status bar and back button are not visible, and the web app\ntakes up the entirety of the available display area.\n\u003c/ul\u003e",
"enum": [
"DISPLAY_MODE_UNSPECIFIED",
"MINIMAL_UI",
"STANDALONE",
"FULL_SCREEN"
],
"enumDescriptions": [
"",
"Opens the web app with a minimal set of browser UI elements for\ncontrolling navigation and viewing the page URL.",
"Opens the web app to look and feel like a standalone native application.\nThe browser UI elements and page URL are not visible, however the system\nstatus bar and back button are visible.",
"Opens the web app in full screen without any visible controls. The\nbrowser UI elements, page URL, system status bar and back button are not\nvisible, and the web app takes up the entirety of the available display\narea."
],
"type": "string"
},
"icons": {
"description": "A list of icons representing this website. If absent, a default icon (for\ncreate) or the current icon (for update) will be used.",
"items": {
"$ref": "WebAppIcon"
},
"type": "array"
},
"isPublished": {
"description": "A flag whether the app has been published to the Play store yet.",
"type": "boolean"
},
"startUrl": {
"description": "The start URL, i.e. the URL that should load when the user opens the\napplication.",
"type": "string"
},
"title": {
"description": "The title of the web app as displayed to the user (e.g., amongst a list of\nother applications, or as a label for an icon).",
"type": "string"
},
"versionCode": {
"description": "The current version of the app.\n\n\u003cp\u003eNote that the version can automatically increase during the lifetime of\nthe web app, while Google does internal housekeeping to keep the web app\nup-to-date.",
"format": "int64",
"type": "string"
},
"webAppId": {
"description": "The ID of the application. A string of the form\n\u003ccode\u003e\u0026quot;app:\u0026lt;package name\u0026gt;\u0026quot;\u003c/code\u003e where the package name\nalways starts with the prefix\n\u003ccode\u003e\u0026quot;com.google.enterprise.webapp.\u0026quot;\u003c/code\u003e followed by a\nrandom id.",
"type": "string"
}
},
"type": "object"
},
"WebAppIcon": {
"description": "Icon for a web app.",
"id": "WebAppIcon",
"properties": {
"imageData": {
"description": "The actual bytes of the image in a base64url encoded string (c.f. RFC4648,\nsection 5 \"Base 64 Encoding with URL and Filename Safe Alphabet\").\n\u003cul\u003e\n\u003cli\u003eThe image type can be png or jpg.\n\u003cli\u003eThe image should ideally be square.\n\u003cli\u003eThe image should ideally have a size of 512x512.\n\u003c/ul\u003e",
"type": "string"
}
},
"type": "object"
},
"WebAppsListResponse": {
"id": "WebAppsListResponse",
"properties": {
"webApp": {
"description": "The manifest describing a web app.",
"items": {
"$ref": "WebApp"
},
"type": "array"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Google Play EMM API",
"version": "v1"
}