HTTP\n429 Too Many Requests
.",
+ "description": "Uploads a report containing any changes in app states on the device since the last report was generated. You can call this method up to 3 times every 24 hours for a given device. If you exceed the quota, then the Google Play EMM API returns HTTP 429 Too Many Requests.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/forceReportUpload",
"httpMethod": "POST",
"id": "androidenterprise.devices.forceReportUpload",
@@ -180,7 +180,7 @@
]
},
"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.",
+ "description": "Retrieves whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state",
"httpMethod": "GET",
"id": "androidenterprise.devices.getState",
@@ -249,7 +249,7 @@
]
},
"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.",
+ "description": "Sets whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state",
"httpMethod": "PUT",
"id": "androidenterprise.devices.setState",
@@ -313,7 +313,7 @@
"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\nupdateMask=<field1>,<field2>,...
",
+ "description": "Mask that identifies which fields to update. If not set, all modifiable fields will be modified. When set in a query parameter, this field should be specified as updateMask=waitForNotifications
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.\nreturnImmediately
will cause the request to\nimmediately return the pending notifications, or an empty list if no\nnotifications are present.\nwaitForNotifications
.",
+ "description": "The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.",
"enum": [
"waitForNotifications",
"returnImmediately"
],
+ "enumDescriptions": [
+ "Wait until one or more notifications are present.",
+ "Returns immediately whether notifications are present or not."
+ ],
"location": "query",
"type": "string"
}
@@ -589,7 +597,7 @@
]
},
"sendTestPushNotification": {
- "description": "Sends a test notification to validate the EMM integration with\nthe Google Cloud Pub/Sub service for this enterprise.",
+ "description": "Sends a test notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/sendTestPushNotification",
"httpMethod": "POST",
"id": "androidenterprise.enterprises.sendTestPushNotification",
@@ -613,7 +621,7 @@
]
},
"setAccount": {
- "description": "Sets the account that will be used to authenticate to the API as the\nenterprise.",
+ "description": "Sets the account that will be used to authenticate to the API as the enterprise.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/account",
"httpMethod": "PUT",
"id": "androidenterprise.enterprises.setAccount",
@@ -640,7 +648,7 @@
]
},
"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\nsetAvailableProductSet 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.",
+ "description": "Sets the store layout for the enterprise. By default, storeLayoutType is set to \"basic\" and the basic store layout is enabled. The basic layout only contains apps approved by the admin, and that have been added to the available product set for a user (using the setAvailableProductSet call). Apps on the page are sorted in order of their product ID value. If you create a custom store layout (by setting storeLayoutType = \"custom\" and setting a homepage), the basic store layout is disabled.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout",
"httpMethod": "PUT",
"id": "androidenterprise.enterprises.setStoreLayout",
@@ -819,7 +827,7 @@
"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.",
+ "description": "Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.",
"location": "query",
"type": "boolean"
},
@@ -862,7 +870,7 @@
"type": "string"
},
"groupLicenseId": {
- "description": "The ID of the product the group license is for, e.g.\n\"app:com.google.android.gm\".",
+ "description": "The ID of the product the group license is for, e.g. \"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
@@ -905,7 +913,7 @@
"grouplicenseusers": {
"methods": {
"list": {
- "description": "Retrieves the IDs of the users who have been granted entitlements\nunder the license.",
+ "description": "Retrieves the IDs of the users who have been granted entitlements under the license.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}/users",
"httpMethod": "GET",
"id": "androidenterprise.grouplicenseusers.list",
@@ -921,7 +929,7 @@
"type": "string"
},
"groupLicenseId": {
- "description": "The ID of the product the group license is for, e.g.\n\"app:com.google.android.gm\".",
+ "description": "The ID of the product the group license is for, e.g. \"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
@@ -940,7 +948,7 @@
"installs": {
"methods": {
"delete": {
- "description": "Requests to remove an app from a device. A call to get
or\nlist
will still show the app as installed on the device until\nit is actually removed.",
+ "description": "Requests to remove an app from a device. A call to get or list will still show the app as installed on the device until it is actually removed.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
"httpMethod": "DELETE",
"id": "androidenterprise.installs.delete",
@@ -964,7 +972,7 @@
"type": "string"
},
"installId": {
- "description": "The ID of the product represented by the install, e.g.\n\"app:com.google.android.gm\".",
+ "description": "The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
@@ -1006,7 +1014,7 @@
"type": "string"
},
"installId": {
- "description": "The ID of the product represented by the install, e.g.\n\"app:com.google.android.gm\".",
+ "description": "The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
@@ -1065,7 +1073,7 @@
]
},
"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.",
+ "description": "Requests to install the latest version of an app to a device. If the app is already installed, then it is updated to the latest version if necessary.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
"httpMethod": "PUT",
"id": "androidenterprise.installs.update",
@@ -1089,7 +1097,7 @@
"type": "string"
},
"installId": {
- "description": "The ID of the product represented by the install, e.g.\n\"app:com.google.android.gm\".",
+ "description": "The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
@@ -1117,7 +1125,7 @@
"managedconfigurationsfordevice": {
"methods": {
"delete": {
- "description": "Removes a per-device managed configuration for an app for the specified\ndevice.",
+ "description": "Removes a per-device managed configuration for an app for the specified device.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}",
"httpMethod": "DELETE",
"id": "androidenterprise.managedconfigurationsfordevice.delete",
@@ -1141,7 +1149,7 @@
"type": "string"
},
"managedConfigurationForDeviceId": {
- "description": "The ID of the managed configuration (a product ID), e.g.\n\"app:com.google.android.gm\".",
+ "description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
@@ -1183,7 +1191,7 @@
"type": "string"
},
"managedConfigurationForDeviceId": {
- "description": "The ID of the managed configuration (a product ID), e.g.\n\"app:com.google.android.gm\".",
+ "description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
@@ -1204,7 +1212,7 @@
]
},
"list": {
- "description": "Lists all the per-device managed configurations for the specified device.\nOnly the ID is set.",
+ "description": "Lists all the per-device managed configurations for the specified device. Only the ID is set.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice",
"httpMethod": "GET",
"id": "androidenterprise.managedconfigurationsfordevice.list",
@@ -1242,7 +1250,7 @@
]
},
"update": {
- "description": "Adds or updates a per-device managed configuration for an app for the\nspecified device.",
+ "description": "Adds or updates a per-device managed configuration for an app for the specified device.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}",
"httpMethod": "PUT",
"id": "androidenterprise.managedconfigurationsfordevice.update",
@@ -1266,7 +1274,7 @@
"type": "string"
},
"managedConfigurationForDeviceId": {
- "description": "The ID of the managed configuration (a product ID), e.g.\n\"app:com.google.android.gm\".",
+ "description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
@@ -1311,7 +1319,7 @@
"type": "string"
},
"managedConfigurationForUserId": {
- "description": "The ID of the managed configuration (a product ID), e.g.\n\"app:com.google.android.gm\".",
+ "description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
@@ -1329,7 +1337,7 @@
]
},
"get": {
- "description": "Retrieves details of a per-user managed configuration for an app for the\nspecified user.",
+ "description": "Retrieves details of a per-user managed configuration for an app for the specified user.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}",
"httpMethod": "GET",
"id": "androidenterprise.managedconfigurationsforuser.get",
@@ -1346,7 +1354,7 @@
"type": "string"
},
"managedConfigurationForUserId": {
- "description": "The ID of the managed configuration (a product ID), e.g.\n\"app:com.google.android.gm\".",
+ "description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
@@ -1367,7 +1375,7 @@
]
},
"list": {
- "description": "Lists all the per-user managed configurations for the specified user. Only\nthe ID is set.",
+ "description": "Lists all the per-user managed configurations for the specified user. Only the ID is set.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser",
"httpMethod": "GET",
"id": "androidenterprise.managedconfigurationsforuser.list",
@@ -1398,7 +1406,7 @@
]
},
"update": {
- "description": "Adds or updates the managed configuration settings for an app for the\nspecified user.\nIf you support the Managed\nconfigurations iframe,\nyou can apply managed configurations to a user by specifying an\nmcmId
\nand its associated configuration variables (if any) in the request.\nAlternatively,\nall EMMs can apply managed configurations by passing a list of managed\nproperties.",
+ "description": "Adds or updates the managed configuration settings for an app for the specified user. If you support the Managed configurations iframe, you can apply managed configurations to a user by specifying an mcmId and its associated configuration variables (if any) in the request. Alternatively, all EMMs can apply managed configurations by passing a list of managed properties.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}",
"httpMethod": "PUT",
"id": "androidenterprise.managedconfigurationsforuser.update",
@@ -1415,7 +1423,7 @@
"type": "string"
},
"managedConfigurationForUserId": {
- "description": "The ID of the managed configuration (a product ID), e.g.\n\"app:com.google.android.gm\".",
+ "description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
@@ -1459,7 +1467,7 @@
"type": "string"
},
"productId": {
- "description": "The ID of the product for which the managed configurations settings applies\nto.",
+ "description": "The ID of the product for which the managed configurations settings applies to.",
"location": "path",
"required": true,
"type": "string"
@@ -1478,7 +1486,7 @@
"permissions": {
"methods": {
"get": {
- "description": "Retrieves details of an Android app permission for display to an enterprise\nadmin.",
+ "description": "Retrieves details of an Android app permission for display to an enterprise admin.",
"flatPath": "androidenterprise/v1/permissions/{permissionId}",
"httpMethod": "GET",
"id": "androidenterprise.permissions.get",
@@ -1511,7 +1519,7 @@
"products": {
"methods": {
"approve": {
- "description": "Approves 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.
\nTo learn how to use managed Google Play to design and create a store\nlayout to display approved products to your users,\nsee Store Layout\nDesign.
", + "description": " Approves the specified product and the relevant app permissions, if any. The maximum number of products that you can approve per enterprise customer is 1,000. To learn how to use managed Google Play to design and create a store layout to display approved products to your users, see Store Layout Design. ", "flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/approve", "httpMethod": "POST", "id": "androidenterprise.products.approve", @@ -1542,7 +1550,7 @@ ] }, "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.approvalUrlInfo.approvalUrl
property in a\nProducts.approve
call to approve the product.\nThis URL can only be used to display permissions for up to 1 day.",
+ "description": "Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product. Admins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to approve the product. This URL can only be used to display permissions for up to 1 day.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/generateApprovalUrl",
"httpMethod": "POST",
"id": "androidenterprise.products.generateApprovalUrl",
@@ -1558,7 +1566,7 @@
"type": "string"
},
"languageCode": {
- "description": "The BCP 47 language code used for permission names and descriptions in\nthe returned iframe, for instance \"en-US\".",
+ "description": "The BCP 47 language code used for permission names and descriptions in the returned iframe, for instance \"en-US\".",
"location": "query",
"type": "string"
},
@@ -1614,7 +1622,7 @@
]
},
"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\nManaged\nConfigurations through Play.",
+ "description": "Retrieves the schema that defines the configurable properties for this product. All products have a schema, but this schema may be empty if no managed configurations have been defined. This schema can be used to populate a UI that allows an admin to configure the product. To apply a managed configuration based on the schema obtained using this API, see Managed Configurations through Play.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/appRestrictionsSchema",
"httpMethod": "GET",
"id": "androidenterprise.products.getAppRestrictionsSchema",
@@ -1681,7 +1689,7 @@
]
},
"list": {
- "description": "Finds approved products that match a query, or all approved products\nif there is no query.",
+ "description": "Finds approved products that match a query, or all approved products if there is no query.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/products",
"httpMethod": "GET",
"id": "androidenterprise.products.list",
@@ -1690,7 +1698,7 @@
],
"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.",
+ "description": "Specifies whether to search among all products (false) or among only products that have been approved (true). Only \"true\" is supported, and should be specified.",
"location": "query",
"type": "boolean"
},
@@ -1701,23 +1709,23 @@
"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.",
+ "description": "The BCP47 tag for the user's preferred language (e.g. \"en-US\", \"de\"). Results are returned in the language best matching the preferred language.",
"location": "query",
"type": "string"
},
"maxResults": {
- "description": "Defines how many results the list operation should return.\nThe default number depends on the resource collection.",
+ "description": "Defines how many results the list operation should return. The 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).",
+ "description": "The search query as typed in the Google Play store search box. If omitted, all approved apps will be returned (using the pagination parameters), including apps that are not available in the store (e.g. unpublished apps).",
"location": "query",
"type": "string"
},
"token": {
- "description": "Defines the token of the page to return, usually taken from\nTokenPagination.\nThis can only be used if token paging is enabled.",
+ "description": "Defines the token of the page to return, usually taken from TokenPagination. This can only be used if token paging is enabled.",
"location": "query",
"type": "string"
}
@@ -1763,7 +1771,7 @@
"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.",
+ "description": "Removes and invalidates the specified credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/serviceAccountKeys/{keyId}",
"httpMethod": "DELETE",
"id": "androidenterprise.serviceaccountkeys.delete",
@@ -1791,7 +1799,7 @@
]
},
"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. accountIdentifier
and an accountType
.\nIf a corresponding user already exists with the same account identifier,\nthe user will be updated with the resource. In this case only the\ndisplayName
field can be changed.",
+ "description": "Creates a new EMM-managed user. The Users resource passed in the body of the request should include an accountIdentifier and an accountType. If a corresponding user already exists with the same account identifier, the user will be updated with the resource. In this case only the displayName field can be changed.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users",
"httpMethod": "POST",
"id": "androidenterprise.users.insert",
@@ -2325,7 +2333,7 @@
]
},
"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.",
+ "description": "Looks up a user by primary email address. This is only supported for Google-managed users. Lookup of the id is not needed for EMM-managed users because the id is already returned in the result of the Users.insert call.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users",
"httpMethod": "GET",
"id": "androidenterprise.users.list",
@@ -2356,7 +2364,7 @@
]
},
"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.",
+ "description": "Revokes access to all devices currently provisioned to the user. The user will no longer be able to use the managed Play store on any of their managed devices. This call only works with EMM-managed accounts.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/deviceAccess",
"httpMethod": "DELETE",
"id": "androidenterprise.users.revokeDeviceAccess",
@@ -2384,7 +2392,7 @@
]
},
"setAvailableProductSet": {
- "description": "Modifies the set of products that a user is entitled to access (referred to\nas whitelisted products). Only products that are\napproved\nor products that were previously approved (products with revoked approval)\ncan be whitelisted.",
+ "description": "Modifies the set of products that a user is entitled to access (referred to as *whitelisted* products). Only products that are approved or products that were previously approved (products with revoked approval) can be whitelisted.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/availableProductSet",
"httpMethod": "PUT",
"id": "androidenterprise.users.setAvailableProductSet",
@@ -2418,7 +2426,7 @@
]
},
"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\nUsers\nresource in the request body. Only the displayName
field\ncan be changed. Other fields must either be unset or have the\ncurrently active value.",
+ "description": "Updates the details of an EMM-managed user. Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}",
"httpMethod": "PUT",
"id": "androidenterprise.users.update",
@@ -2602,11 +2610,11 @@
}
}
},
- "revision": "20200707",
+ "revision": "20200801",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Administrator": {
- "description": "This represents an enterprise admin who can manage the enterprise\nin the managed Google Play store.",
+ "description": "This represents an enterprise admin who can manage the enterprise in the managed Google Play store.",
"id": "Administrator",
"properties": {
"email": {
@@ -2628,7 +2636,7 @@
"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.",
+ "description": "Specification for a token used to generate iframes. The token specifies what data the admin is allowed to modify and the URI the iframe is allowed to communiate with.",
"id": "AdministratorWebTokenSpec",
"properties": {
"managedConfigurations": {
@@ -2636,11 +2644,11 @@
"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.",
+ "description": "The URI of the parent frame hosting the iframe. To prevent XSS, the iframe may not be hosted at other URIs. This URI must be https. Use whitespaces to separate multiple parent URIs.",
"type": "string"
},
"permission": {
- "description": "Deprecated. Use PlaySearch.approveApps
.",
+ "description": "Deprecated. Use PlaySearch.approveApps.",
"enumDescriptions": [
"Unknown permission.",
"Permission to approve and unapprove apps.",
@@ -2652,6 +2660,11 @@
"approveApps",
"manageMcm"
],
+ "enumDescriptions": [
+ "Unknown permission.",
+ "Permission to approve and unapprove apps.",
+ "Permission to manage app restrictions."
+ ],
"type": "string"
},
"type": "array"
@@ -2689,7 +2702,7 @@
"id": "AdministratorWebTokenSpecPlaySearch",
"properties": {
"approveApps": {
- "description": "Allow access to the iframe in approve\nmode. Default is false.",
+ "description": "Allow access to the iframe in approve mode. Default is false.",
"type": "boolean"
},
"enabled": {
@@ -2730,7 +2743,7 @@
"type": "object"
},
"AppRestrictionsSchema": {
- "description": "Represents the list of app restrictions available to be pre-configured for\nthe product.",
+ "description": "Represents the list of app restrictions available to be pre-configured for the product.",
"id": "AppRestrictionsSchema",
"properties": {
"kind": {
@@ -2748,48 +2761,48 @@
"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.",
+ "description": "An event generated when a new app version is uploaded to Google Play and its app restrictions schema changed. To fetch the app restrictions schema for an app, use Products.getAppRestrictionsSchema on the EMM API.",
"id": "AppRestrictionsSchemaChangeEvent",
"properties": {
"productId": {
- "description": "The id of the product (e.g. \"app:com.google.android.gm\") for which the\napp restriction schema changed. This field will always be present.",
+ "description": "The id of the product (e.g. \"app:com.google.android.gm\") for which the app restriction schema changed. This field will always be present.",
"type": "string"
}
},
"type": "object"
},
"AppRestrictionsSchemaRestriction": {
- "description": "A restriction in the App Restriction Schema represents a piece of\nconfiguration that may be pre-applied.",
+ "description": "A restriction in the App Restriction Schema represents a piece of configuration that may be pre-applied.",
"id": "AppRestrictionsSchemaRestriction",
"properties": {
"defaultValue": {
"$ref": "AppRestrictionsSchemaRestrictionRestrictionValue",
- "description": "The default value of the restriction. bundle
and\nbundleArray
restrictions never have a default value."
+ "description": "The default value of the restriction. bundle and bundleArray restrictions never have a default value."
},
"description": {
- "description": "A longer description of the restriction, giving more detail of what it\naffects.",
+ "description": "A longer description of the restriction, giving more detail of what it affects.",
"type": "string"
},
"entry": {
- "description": "For choice
or multiselect
restrictions, the list\nof possible entries' human-readable names.",
+ "description": "For choice or multiselect restrictions, the list of possible entries' human-readable names.",
"items": {
"type": "string"
},
"type": "array"
},
"entryValue": {
- "description": "For choice
or multiselect
restrictions, the list\nof possible entries' machine-readable values. These values should be used\nin the configuration, either as a single string
value for a\nchoice
restriction or in a stringArray
for a\nmultiselect
restriction.",
+ "description": "For choice or multiselect restrictions, the list of possible entries' machine-readable values. These values should be used in the configuration, either as a single string value for a choice restriction or in a stringArray for a multiselect restriction.",
"items": {
"type": "string"
},
"type": "array"
},
"key": {
- "description": "The unique key that the product uses to identify the restriction,\ne.g. \"com.google.android.gm.fieldname\".",
+ "description": "The unique key that the product uses to identify the restriction, e.g. \"com.google.android.gm.fieldname\".",
"type": "string"
},
"nestedRestriction": {
- "description": "For bundle
or bundleArray
restrictions, the list\nof nested restrictions. A bundle
restriction is always nested\nwithin a bundleArray
restriction, and a\nbundleArray
restriction is at most two levels deep.",
+ "description": "For bundle or bundleArray restrictions, the list of nested restrictions. A bundle restriction is always nested within a bundleArray restriction, and a bundleArray restriction is at most two levels deep.",
"items": {
"$ref": "AppRestrictionsSchemaRestriction"
},
@@ -2813,7 +2826,7 @@
"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).",
+ "A hidden restriction of string type (the default value can be used to pass along information that cannot be modified, such as a version code).",
"[M+ devices only] A bundle of restrictions",
"[M+ devices only] An array of restriction bundles"
],
@@ -2848,7 +2861,7 @@
"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).",
+ "A hidden restriction of string type (the default value can be used to pass along information that cannot be modified, such as a version code).",
"[M+ devices only] A bundle of restrictions",
"[M+ devices only] An array of restriction bundles"
],
@@ -2864,14 +2877,14 @@
"type": "integer"
},
"valueMultiselect": {
- "description": "The list of string values - this will only be present if type is\nmultiselect.",
+ "description": "The list of string values - this will only be present if type is multiselect.",
"items": {
"type": "string"
},
"type": "array"
},
"valueString": {
- "description": "The string value - this will be present for types string, choice and\nhidden.",
+ "description": "The string value - this will be present for types string, choice and hidden.",
"type": "string"
}
},
@@ -2882,25 +2895,25 @@
"id": "AppState",
"properties": {
"keyedAppState": {
- "description": "List of keyed app states.\nThis field will always be present.",
+ "description": "List of keyed app states. This field will always be present.",
"items": {
"$ref": "KeyedAppState"
},
"type": "array"
},
"packageName": {
- "description": "The package name of the app.\nThis field will always be present.",
+ "description": "The package name of the app. This 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.",
+ "description": "An event generated when a new version of an app is uploaded to Google Play. Notifications are sent for new public versions only: alpha, beta, or canary versions do not generate this event. To fetch up-to-date version history for an app, use Products.Get on the EMM API.",
"id": "AppUpdateEvent",
"properties": {
"productId": {
- "description": "The id of the product (e.g. \"app:com.google.android.gm\") that was updated.\nThis field will always be present.",
+ "description": "The id of the product (e.g. \"app:com.google.android.gm\") that was updated. This field will always be present.",
"type": "string"
}
},
@@ -2915,7 +2928,7 @@
"type": "boolean"
},
"track": {
- "description": "Deprecated, use trackId
instead.",
+ "description": "Deprecated, use trackId instead.",
"enum": [
"appTrackUnspecified",
"production",
@@ -2931,7 +2944,7 @@
"type": "string"
},
"trackId": {
- "description": "Track ids that the app version is published in. Replaces the\ntrack
field (deprecated), but doesn't include the production\ntrack (see isProduction
instead).",
+ "description": "Track ids that the app version is published in. Replaces the track field (deprecated), but doesn't include the production track (see isProduction instead).",
"items": {
"type": "string"
},
@@ -2943,7 +2956,7 @@
"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\").",
+ "description": "The string used in the Play store by the app developer to identify the version. The string is not necessarily unique or localized (for example, the string could be \"1.4\").",
"type": "string"
}
},
@@ -2954,25 +2967,25 @@
"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 Products.approve
call.",
+ "description": "A URL that displays a product's permissions and that can also be used to approve the product with the Products.approve 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.",
+ "description": "An AuthenticationToken is used by the EMM's device policy client on a device to 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.",
+ "description": "The authentication token to be passed to the device policy client on the device where it can be used to provision the account for which this token was generated.",
"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.",
+ "description": "The auto-install constraint. Defines a set of restrictions for installation. At least one of the fields must be set.",
"id": "AutoInstallConstraint",
"properties": {
"chargingStateConstraint": {
@@ -2998,7 +3011,7 @@
],
"enumDescriptions": [
"",
- "Device doesn't have to be idle, app can be installed while the user is\ninteracting with the device.",
+ "Device doesn't have to be idle, app can be installed while the user is interacting with the device.",
"Device has to be idle."
],
"type": "string"
@@ -3024,7 +3037,7 @@
"id": "AutoInstallPolicy",
"properties": {
"autoInstallConstraint": {
- "description": "The constraints for auto-installing the app. You can specify a maximum of\none constraint.",
+ "description": "The constraints for auto-installing the app. You can specify a maximum of one constraint.",
"items": {
"$ref": "AutoInstallConstraint"
},
@@ -3040,19 +3053,19 @@
],
"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."
+ "The product is not installed automatically, the user needs to install it from the Play Store.",
+ "The product is automatically installed once, if the user uninstalls the product it will not be installed again.",
+ "The product is automatically installed, if the user uninstalls the product it will be installed again. On managed devices the DPC should block uninstall."
],
"type": "string"
},
"autoInstallPriority": {
- "description": "The priority of the install, as an unsigned integer. A lower number means\nhigher priority.",
+ "description": "The priority of the install, as an unsigned integer. A lower number means higher 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.",
+ "description": "The minimum version of the app. If a lower version of the app is installed, then the app will be auto-updated according to the auto-install constraints, instead of waiting for the regular auto-update. You can set a minimum version code for at most 20 apps per device.",
"format": "int32",
"type": "integer"
}
@@ -3060,7 +3073,7 @@
"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.",
+ "description": "A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings.",
"id": "ConfigurationVariables",
"properties": {
"mcmId": {
@@ -3078,15 +3091,15 @@
"type": "object"
},
"Device": {
- "description": "A Devices resource represents a mobile device managed by the EMM and\nbelonging to a specific enterprise user.",
+ "description": "A Devices resource represents a mobile device managed by the EMM and belonging to a specific enterprise user.",
"id": "Device",
"properties": {
"androidId": {
- "description": "The Google Play Services Android ID for the device encoded as\na lowercase hex string. For example,\n"123456789abcdef0"
.",
+ "description": "The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, \"123456789abcdef0\".",
"type": "string"
},
"managementType": {
- "description": "Identifies the extent to which the device is controlled by a managed\nGoogle Play EMM in various deployment configurations.
\nPossible values include:\n
managedDevice
\", a device that has the EMM's device\npolicy controller (DPC) as the device owner.managedProfile
\", 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.containerApp
\", no longer used (deprecated).unmanagedProfile
\", 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.Enterprises.enroll
and Enterprises.setAccount
(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.Enterprises.generateSignupUrl
and\nEnterprises.completeSignup
in conjunction with the managed\nGoogle Play sign-up UI (Google-provided mechanism) to create the binding\nwithout manual steps.\"userPurchase\"
as the entitlement reason. These\nentitlements cannot be removed via the API.",
+ "description": "The presence of an Entitlements resource indicates that a user has the right to use a particular app. Entitlements are user specific, not device specific. This allows a user with an entitlement to an app to install the app on all their devices. It's also possible for a user to hold an entitlement to an app without installing the app on any device. The API can be used to create an entitlement. As an option, you can also use the API to trigger the installation of an app on all a user's managed devices at the same time the entitlement is created. If the app is free, creating the entitlement also creates a group license for that app. For paid apps, creating the entitlement consumes one license, and that license remains consumed until the entitlement is removed. If the enterprise hasn't purchased enough licenses, then no entitlement is created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn't accepted. If an entitlement is deleted, the app may be uninstalled from a user's device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement. Entitlements for apps that a user pays for on an unmanaged profile have \"userPurchase\" as the entitlement reason. These entitlements cannot be removed via the API.",
"id": "Entitlement",
"properties": {
"productId": {
- "description": "The ID of the product that the entitlement is for. For example,\n"app:com.google.android.gm"
.",
+ "description": "The ID of the product that the entitlement is for. For example, \"app:com.google.android.gm\".",
"type": "string"
},
"reason": {
- "description": "The reason for the entitlement. For example, \"free\"
\nfor free apps. This property is temporary: it will be replaced by the acquisition kind
field of group licenses.",
+ "description": "The reason for the entitlement. For example, \"free\" for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses.",
"enum": [
"free",
"groupLicense",
@@ -3275,7 +3288,7 @@
"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.",
+ "description": "An entitlement of a user to a product (e.g. an app). For example, a free app that they have installed, or a paid app that they have been allocated a license to.",
"items": {
"$ref": "Entitlement"
},
@@ -3285,11 +3298,11 @@
"type": "object"
},
"GroupLicense": {
- "description": "Group license objects allow you to keep track of licenses (called\nentitlements)\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 Grouplicenses
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 Entitlements
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.",
+ "description": "Group license objects allow you to keep track of licenses (called entitlements) for both free and paid apps. For a free app, a group license is created when an enterprise admin first approves the product in Google Play or when the first entitlement for the product is created for a user via the API. For a paid app, a group license object is only created when an enterprise admin purchases the product in Google Play for the first time. Use the API to query group licenses. A Grouplicenses resource includes the total number of licenses purchased (paid apps only) and the total number of licenses currently in use. In other words, the total number of Entitlements that exist for the product. Only one group license object is created per product and group license objects are never deleted. If a product is unapproved, its group license remains. This allows enterprise admins to keep track of any remaining entitlements for the product.",
"id": "GroupLicense",
"properties": {
"acquisitionKind": {
- "description": "How this group license was acquired. "bulkPurchase"
\nmeans that this Grouplicenses resource was created because the enterprise\npurchased licenses for this product; otherwise, the value is\n"free"
(for free products).",
+ "description": "How this group license was acquired. \"bulkPurchase\" means that this Grouplicenses resource was created because the enterprise purchased licenses for this product; otherwise, the value is \"free\" (for free products).",
"enum": [
"free",
"bulkPurchase"
@@ -3301,7 +3314,7 @@
"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.",
+ "description": "Whether the product to which this group license relates is currently approved by the enterprise. Products are approved when a group license is first created, but this approval may be revoked by an enterprise admin via Google Play. Unapproved products will not be visible to end users in collections, and new entitlements to them should not normally be created.",
"enum": [
"approved",
"unapproved"
@@ -3313,17 +3326,17 @@
"type": "string"
},
"numProvisioned": {
- "description": "The total number of provisioned licenses for this product.\nReturned by read operations, but ignored in write operations.",
+ "description": "The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations.",
"format": "int32",
"type": "integer"
},
"numPurchased": {
- "description": "The number of purchased licenses (possibly in multiple purchases).\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"free"
).",
+ "description": "The number of purchased licenses (possibly in multiple purchases). If this field is omitted, then there is no limit on the number of licenses that can be provisioned (for example, if the acquisition kind is \"free\").",
"format": "int32",
"type": "integer"
},
"permissions": {
- "description": "The permission approval status of the product. This field\nis only set if the product is approved. Possible states are:currentApproved
\", 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.),needsReapproval
\", the product has unapproved permissions.\nNo additional product licenses can be assigned until the product is\nreapproved,allCurrentAndFutureApproved
\",\nthe current permissions are approved and any future permission updates\nwill be automatically approved without administrator review."app:com.google.android.gm"
.",
+ "description": "The ID of the product that the license is for. For example, \"app:com.google.android.gm\".",
"type": "string"
}
},
@@ -3370,11 +3383,11 @@
"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\nupdate\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 update 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.",
+ "description": "The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending). The API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app, then an attempt is made to create one. If this fails (for example, because the app is not free and there is no available license), then the creation of the install fails. The API can also be used to update an installed app. If the update method is used on an existing install, then the app will be updated to the latest available version. Note that it is not possible to force the installation of a specific version of an app: the version code is read-only. If a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created. The API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves.",
"id": "Install",
"properties": {
"installState": {
- "description": "Install state. The state "installPending"
\nmeans that an install request has recently been made and download to the\ndevice is in progress. The state "installed"
\nmeans that the app has been installed. This field is read-only.",
+ "description": "Install state. The state \"installPending\" means that an install request has recently been made and download to the device is in progress. The state \"installed\" means that the app has been installed. This field is read-only.",
"enum": [
"installed",
"installPending"
@@ -3386,11 +3399,11 @@
"type": "string"
},
"productId": {
- "description": "The ID of the product that the install is for. For example,\n"app:com.google.android.gm"
.",
+ "description": "The ID of the product that the install is for. For example, \"app:com.google.android.gm\".",
"type": "string"
},
"versionCode": {
- "description": "The version of the installed product. Guaranteed to be set only if the\ninstall state is "installed"
.",
+ "description": "The version of the installed product. Guaranteed to be set only if the install state is \"installed\".",
"format": "int32",
"type": "integer"
}
@@ -3402,7 +3415,7 @@
"id": "InstallFailureEvent",
"properties": {
"deviceId": {
- "description": "The Android ID of the device.\nThis field will always be present.",
+ "description": "The Android ID of the device. This field will always be present.",
"type": "string"
},
"failureDetails": {
@@ -3410,23 +3423,23 @@
"type": "string"
},
"failureReason": {
- "description": "The reason for the installation failure.\nThis field will always be present.",
+ "description": "The reason for the installation failure. This 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."
+ "Used when the installation timed out. This can cover a number of situations, for example when the device did not have connectivity at 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.",
+ "description": "The id of the product (e.g. \"app:com.google.android.gm\") for which the install failure event occured. This field will always be present.",
"type": "string"
},
"userId": {
- "description": "The ID of the user.\nThis field will always be present.",
+ "description": "The ID of the user. This field will always be present.",
"type": "string"
}
},
@@ -3436,7 +3449,7 @@
"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.",
+ "description": "An installation of an app for a user on a specific device. The existence of an install implies that the user must have an entitlement to the app.",
"items": {
"$ref": "Install"
},
@@ -3446,23 +3459,23 @@
"type": "object"
},
"KeyedAppState": {
- "description": "Represents a keyed app state containing a key, timestamp, severity level,\noptional description, and optional data.",
+ "description": "Represents a keyed app state containing a key, timestamp, severity level, optional 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.",
+ "description": "Additional field intended for machine-readable data. For example, a number or JSON object. To prevent XSS, we recommend removing any HTML from the data 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.",
+ "description": "Key indicating what the app is providing a state for. The content of the key is set by the app's developer. To prevent XSS, we recommend removing any HTML from the key before displaying it. This 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.",
+ "description": "Free-form, human-readable message describing the app state. For example, an error message. To prevent XSS, we recommend removing any HTML from the message before displaying it.",
"type": "string"
},
"severity": {
- "description": "Severity of the app state.\nThis field will always be present.",
+ "description": "Severity of the app state. This field will always be present.",
"enum": [
"severityUnknown",
"severityInfo",
@@ -3476,7 +3489,7 @@
"type": "string"
},
"stateTimestampMillis": {
- "description": "Timestamp of when the app set the state in milliseconds since epoch.\nThis field will always be present.",
+ "description": "Timestamp of when the app set the state in milliseconds since epoch. This field will always be present.",
"format": "int64",
"type": "string"
}
@@ -3499,16 +3512,16 @@
"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.",
+ "description": "Maintenance window for managed Google Play Accounts. This allows Play store to update the apps on the foreground in the designated window.",
"id": "MaintenanceWindow",
"properties": {
"durationMs": {
- "description": "Duration of the maintenance window, in milliseconds. The duration must be\nbetween 30 minutes and 24 hours (inclusive).",
+ "description": "Duration of the maintenance window, in milliseconds. The duration must be between 30 minutes and 24 hours (inclusive).",
"format": "int64",
"type": "string"
},
"startTimeAfterMidnightMs": {
- "description": "Start time of the maintenance window, in milliseconds after midnight on the\ndevice. Windows can span midnight.",
+ "description": "Start time of the maintenance window, in milliseconds after midnight on the device. Windows can span midnight.",
"format": "int64",
"type": "string"
}
@@ -3516,12 +3529,12 @@
"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.",
+ "description": "A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user.",
"id": "ManagedConfiguration",
"properties": {
"configurationVariables": {
"$ref": "ConfigurationVariables",
- "description": "Contains the ID of the managed configuration profile and the set of\nconfiguration variables (if any) defined for the user."
+ "description": "Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user."
},
"kind": {
"description": "Deprecated.",
@@ -3535,7 +3548,7 @@
"type": "array"
},
"productId": {
- "description": "The ID of the product that the managed configuration is for, e.g.\n\"app:com.google.android.gm\".",
+ "description": "The ID of the product that the managed configuration is for, e.g. \"app:com.google.android.gm\".",
"type": "string"
}
},
@@ -3568,11 +3581,11 @@
"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.",
+ "description": "A managed configurations settings resource contains the set of managed properties that have been configured for an Android app to be applied to a set of users. The app's developer would have defined configurable properties in the managed configurations schema.",
"id": "ManagedConfigurationsSettings",
"properties": {
"lastUpdatedTimestampMillis": {
- "description": "The last updated time of the managed configuration settings in\nmilliseconds since 1970-01-01T00:00:00Z.",
+ "description": "The last updated time of the managed configuration settings in milliseconds since 1970-01-01T00:00:00Z.",
"format": "int64",
"type": "string"
},
@@ -3591,7 +3604,7 @@
"id": "ManagedConfigurationsSettingsListResponse",
"properties": {
"managedConfigurationsSettings": {
- "description": "A managed configurations settings for an app that may be assigned to a\ngroup of users in an enterprise.",
+ "description": "A managed configurations settings for an app that may be assigned to a group of users in an enterprise.",
"items": {
"$ref": "ManagedConfigurationsSettings"
},
@@ -3601,7 +3614,7 @@
"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.",
+ "description": "A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema.",
"id": "ManagedProperty",
"properties": {
"key": {
@@ -3609,31 +3622,31 @@
"type": "string"
},
"valueBool": {
- "description": "The boolean value - this will only be present if type of the property is\nbool.",
+ "description": "The boolean value - this will only be present if type of the property is bool.",
"type": "boolean"
},
"valueBundle": {
"$ref": "ManagedPropertyBundle",
- "description": "The bundle of managed properties - this will only be present if type of the\nproperty is bundle."
+ "description": "The bundle of managed properties - this will only be present if type of the property is bundle."
},
"valueBundleArray": {
- "description": "The list of bundles of properties - this will only be present if type of\nthe property is bundle_array.",
+ "description": "The list of bundles of properties - this will only be present if type of the property is bundle_array.",
"items": {
"$ref": "ManagedPropertyBundle"
},
"type": "array"
},
"valueInteger": {
- "description": "The integer value - this will only be present if type of the property is\ninteger.",
+ "description": "The integer value - this will only be present if type of the property is integer.",
"format": "int32",
"type": "integer"
},
"valueString": {
- "description": "The string value - this will only be present if type of the property is\nstring, choice or hidden.",
+ "description": "The string value - this will only be present if type of the property is string, choice or hidden.",
"type": "string"
},
"valueStringArray": {
- "description": "The list of string values - this will only be present if type of the\nproperty is multiselect.",
+ "description": "The list of string values - this will only be present if type of the property is multiselect.",
"items": {
"type": "string"
},
@@ -3661,7 +3674,7 @@
"id": "NewDeviceEvent",
"properties": {
"deviceId": {
- "description": "The Android ID of the device.\nThis field will always be present.",
+ "description": "The Android ID of the device. This field will always be present.",
"type": "string"
},
"dpcPackageName": {
@@ -3669,7 +3682,7 @@
"type": "string"
},
"managementType": {
- "description": "Identifies the extent to which the device is controlled by an Android\nEMM in various deployment configurations. managedDevice
\", a device where the DPC is set as\ndevice owner,managedProfile
\", a device where the DPC is set as profile\nowner.productAvailabilityPolicy
\nneeds to be set to WHITELIST
or ALL
for the\nproduct policies to be applied.",
+ "description": "The list of product policies. The productAvailabilityPolicy needs to be set to WHITELIST or ALL for the product policies to be applied.",
"items": {
"$ref": "ProductPolicy"
},
@@ -3912,7 +3925,7 @@
"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.",
+ "description": "A Products resource represents an app in the Google Play store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.) The information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an EMM user interface.",
"id": "Product",
"properties": {
"appTracks": {
@@ -3941,7 +3954,7 @@
"type": "array"
},
"availableTracks": {
- "description": "Deprecated, use appTracks
instead.",
+ "description": "Deprecated, use appTracks instead.",
"enumDescriptions": [
"",
"",
@@ -3955,6 +3968,12 @@
"beta",
"alpha"
],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
"type": "string"
},
"type": "array"
@@ -3990,7 +4009,7 @@
"type": "string"
},
"distributionChannel": {
- "description": "How and to whom the package is made available.\nThe value publicGoogleHosted
means that the package is\navailable through the Play store and not restricted to a specific\nenterprise. The value privateGoogleHosted
means that the\npackage is a private app (restricted to an enterprise) but hosted by\nGoogle. The value privateSelfHosted
means that the package is\na private app (restricted to an enterprise) and is privately hosted.",
+ "description": "How and to whom the package is made available. The value publicGoogleHosted means that the package is available through the Play store and not restricted to a specific enterprise. The value privateGoogleHosted means that the package is a private app (restricted to an enterprise) but hosted by Google. The value privateSelfHosted means that the package is a private app (restricted to an enterprise) and is privately hosted.",
"enum": [
"publicGoogleHosted",
"privateGoogleHosted",
@@ -4014,16 +4033,20 @@
"featureUnknown",
"vpnApp"
],
+ "enumDescriptions": [
+ "",
+ "The app is a VPN."
+ ],
"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.",
+ "description": "A link to an image that can be used as an icon for the product. This image is suitable for use at up to 512px x 512px.",
"type": "string"
},
"lastUpdatedTimestampMillis": {
- "description": "The approximate time (within 7 days) the app was last published, expressed\nin milliseconds since epoch.",
+ "description": "The approximate time (within 7 days) the app was last published, expressed in milliseconds since epoch.",
"format": "int64",
"type": "string"
},
@@ -4040,11 +4063,11 @@
"type": "array"
},
"productId": {
- "description": "A string of the form app:<package name>
. For\nexample, app:com.google.android.gm
represents the Gmail app.",
+ "description": "A string of the form *app:"app:com.google.android.gm"
.",
+ "description": "The ID of the product. For example, \"app:com.google.android.gm\".",
"type": "string"
},
"trackIds": {
- "description": "Grants the device visibility to the specified product release track(s),\nidentified by trackIds
. The list of release tracks of a\nproduct can be obtained by calling Products.Get.",
+ "description": "Grants the device visibility to the specified product release track(s), identified by trackIds. The list of release tracks of a product can be obtained by calling Products.Get.",
"items": {
"type": "string"
},
"type": "array"
},
"tracks": {
- "description": "Deprecated. Use trackIds
instead.",
+ "description": "Deprecated. Use trackIds instead.",
"enumDescriptions": [
"",
"",
@@ -4224,6 +4247,12 @@
"beta",
"alpha"
],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
"type": "string"
},
"type": "array"
@@ -4243,7 +4272,7 @@
"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.",
+ "description": "The interpretation of this product set. \"unknown\" should never be sent and is ignored if received. \"whitelist\" means that the user is entitled to access the product set. \"includeAll\" means that all products are accessible, including products that are approved, products with revoked approval, and products that have never been approved. \"allApproved\" means that the user is entitled to access all products that are approved for the enterprise. If the value is \"allApproved\" or \"includeAll\", the productId field is ignored. If no value is provided, it is interpreted as \"whitelist\" for backwards compatibility. Further \"allApproved\" or \"includeAll\" does not enable automatic visibility of \"alpha\" or \"beta\" tracks for Android app. Use ProductVisibility to enable \"alpha\" or \"beta\" tracks per user.",
"enum": [
"unknown",
"whitelist",
@@ -4253,13 +4282,13 @@
"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)."
+ "This product set represents all products. For Android app it represents only \"production\" track. (The value of the productId field is therefore ignored).",
+ "This product set represents all approved products. For Android app it represents only \"production\" track. (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.",
+ "description": "Additional list of product IDs making up the product set. Unlike the productID array, in this list It's possible to specify which tracks (alpha, beta, production) of a product are visible to the user. See ProductVisibility and its fields for more information. Specifying the same product ID both here and in the productId array is not allowed and it will result in an error.",
"items": {
"$ref": "ProductVisibility"
},
@@ -4272,7 +4301,7 @@
"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.)",
+ "description": "The base64 urlsafe encoded SHA1 hash of the certificate. (This field is deprecated in favor of SHA2-256. It should not be used and may be removed at any time.)",
"type": "string"
},
"certificateHashSha256": {
@@ -4287,18 +4316,18 @@
"id": "ProductVisibility",
"properties": {
"productId": {
- "description": "The product ID to make visible to the user.\nRequired for each item in the productVisibility list.",
+ "description": "The product ID to make visible to the user. Required for each item in the productVisibility list.",
"type": "string"
},
"trackIds": {
- "description": "Grants the user visibility to the specified product track(s), identified by\ntrackIds
.",
+ "description": "Grants the user visibility to the specified product track(s), identified by trackIds.",
"items": {
"type": "string"
},
"type": "array"
},
"tracks": {
- "description": "Deprecated. Use trackIds
instead.",
+ "description": "Deprecated. Use trackIds instead.",
"enumDescriptions": [
"",
"",
@@ -4312,6 +4341,12 @@
"beta",
"alpha"
],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
"type": "string"
},
"type": "array"
@@ -4324,17 +4359,17 @@
"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."
+ "description": "The approval URL that was shown to the user. Only the permissions shown to the user with that URL will be accepted, which may not be the product's entire set of permissions. For example, the URL may only display new permissions from an update after the product was approved, or not include new permissions if the product was updated since the URL was generated."
},
"approvedPermissions": {
- "description": "Sets how new permission requests for the product are handled.\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.",
+ "description": "Sets how new permission requests for the product are handled. \"allPermissions\" automatically approves all current and future permissions for the product. \"currentPermissionsOnly\" approves the current set of permissions for the product, but any future permissions added through updates will require manual reapproval. If not specified, only the current set of permissions will be approved.",
"enum": [
"currentPermissionsOnly",
"allPermissions"
],
"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."
+ "Approve only the permissions the product requires at approval time. If an update requires additional permissions, the app will not be updated on devices associated with enterprise users until the additional permissions are approved.",
+ "All current and future permissions the app requires are automatically approved."
],
"type": "string"
}
@@ -4345,7 +4380,7 @@
"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 Products.approve
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.",
+ "description": "A URL that can be rendered in an iframe to display the permissions (if any) of a product. This URL can be used to approve the product only once and only within 24 hours of being generated, using the Products.approve call. If the product is currently unapproved and has no permissions, this URL will point to an empty page. If the product is currently approved, a URL will only be generated if that product has added permissions since it was last approved, and the URL will only display those new permissions that have not yet been accepted.",
"type": "string"
}
},
@@ -4359,7 +4394,7 @@
"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.",
+ "description": "Information about a product (e.g. an app) in the Google Play store, for display to an enterprise admin.",
"items": {
"$ref": "Product"
},
@@ -4373,7 +4408,7 @@
"type": "object"
},
"ServiceAccount": {
- "description": "A service account identity, including the name and credentials that can be\nused to authenticate as the service account.",
+ "description": "A service account identity, including the name and credentials that can be used to authenticate as the service account.",
"id": "ServiceAccount",
"properties": {
"key": {
@@ -4381,7 +4416,7 @@
"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.",
+ "description": "The account name of the service account, in the form of an email address. Assigned by the server.",
"type": "string"
}
},
@@ -4392,15 +4427,15 @@
"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.",
+ "description": "The body of the private key credentials file, in string format. This is only populated when the ServiceAccountKey is created, and is not stored by Google.",
"type": "string"
},
"id": {
- "description": "An opaque, unique identifier for this ServiceAccountKey.\nAssigned by the server.",
+ "description": "An opaque, unique identifier for this ServiceAccountKey. Assigned 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 googleCredentials
key type, this is identical to the\ncert that can be retrieved by using the X.509 cert url inside of the\ncredentials file.",
+ "description": "Public key data for the credentials file. This is an X.509 cert. If you are using the googleCredentials key type, this is identical to the cert that can be retrieved by using the X.509 cert url inside of the credentials file.",
"type": "string"
},
"type": {
@@ -4416,7 +4451,7 @@
],
"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."
+ "PKCS12 format. The password for the PKCS12 file is 'notasecret'. For more information, see https://tools.ietf.org/html/rfc7292. The data for keys of this type are base64 encoded according to RFC 4648 Section 4. See http://tools.ietf.org/html/rfc4648#section-4."
],
"type": "string"
}
@@ -4437,11 +4472,11 @@
"type": "object"
},
"SignupInfo": {
- "description": "A resource returned by the GenerateSignupUrl API, which contains the\nSignup URL and Completion Token.",
+ "description": "A resource returned by the GenerateSignupUrl API, which contains the Signup 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.",
+ "description": "An opaque token that will be required, along with the Enterprise Token, for obtaining the enterprise resource from CompleteSignup.",
"type": "string"
},
"kind": {
@@ -4449,14 +4484,14 @@
"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.",
+ "description": "A URL under which the Admin can sign up for an enterprise. The 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.",
+ "description": "Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.",
"id": "StoreCluster",
"properties": {
"id": {
@@ -4464,18 +4499,18 @@
"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.",
+ "description": "Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.",
"items": {
"$ref": "LocalizedText"
},
"type": "array"
},
"orderInPage": {
- "description": "String (US-ASCII only) used to determine order of this cluster within the\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.",
+ "description": "String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined. The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters.",
"type": "string"
},
"productId": {
- "description": "List of products in the order they are displayed in the cluster. There\nshould not be duplicates within a cluster.",
+ "description": "List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.",
"items": {
"type": "string"
},
@@ -4485,15 +4520,15 @@
"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.",
+ "description": "General setting for the managed Google Play store layout, currently only specifying the page to display the first time the store is opened.",
"id": "StoreLayout",
"properties": {
"homepageId": {
- "description": "The ID of the store page to be used as the homepage. The homepage is the\nfirst page shown in the managed Google Play Store.\n\nNot specifying a homepage is equivalent to setting the store layout\ntype to \"basic\".",
+ "description": "The ID of the store page to be used as the homepage. The homepage is the first page shown in the managed Google Play Store. Not specifying a homepage is equivalent to setting the store layout type 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.",
+ "description": "The store layout type. By default, this value is set to \"basic\" if the homepageId field is not set, and to \"custom\" otherwise. If set to \"basic\", the layout will consist of all approved apps that have been whitelisted for the user.",
"enum": [
"unknown",
"basic",
@@ -4536,7 +4571,7 @@
"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.",
+ "description": "Definition of a managed Google Play store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.",
"id": "StorePage",
"properties": {
"id": {
@@ -4544,14 +4579,14 @@
"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.",
+ "description": "Ordered list of pages a user should be able to reach from this page. The list can't include this page. It is recommended that the basic pages are created first, before adding the links between pages. The 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.",
+ "description": "Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.",
"items": {
"$ref": "LocalizedText"
},
@@ -4561,11 +4596,11 @@
"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.",
+ "description": "Pagination information returned by a List operation when token pagination is enabled. List operations that supports paging return only one \"page\" of results. This protocol buffer message describes the page that has been returned. When using token pagination, clients should use the next/previous token to get another page of the result. The presence or absence of next/previous token indicates whether a next/previous page is available and provides a mean of accessing this page. ListRequest.page_token should be set to either next_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.",
+ "description": "Tokens to pass to the standard list field 'page_token'. Whenever available, tokens are preferred over manipulating start_index.",
"type": "string"
},
"previousPageToken": {
@@ -4579,18 +4614,18 @@
"id": "TrackInfo",
"properties": {
"trackAlias": {
- "description": "A modifiable name for a track. This is the visible name in the play\ndeveloper console.",
+ "description": "A modifiable name for a track. This is the visible name in the play developer 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.",
+ "description": "Unmodifiable, unique track identifier. This identifier is the releaseTrackId in the url of the play developer console page that displays the 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:\nprimaryEmail
).userAccount
\ncan be installed on multiple devices, but a deviceAccount
is\nspecific to a single device. An EMM-managed user (emmManaged
)\ncan be either type (userAccount
, deviceAccount
),\nbut a Google-managed user (googleManaged
) is always a\nuserAccount
.",
+ "description": "The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.",
"enum": [
"deviceAccount",
"userAccount"
@@ -4620,7 +4655,7 @@
"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",
+ "description": "The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as \"Example, Inc.\") or your name (as EMM). Not used for Google-managed user accounts. @mutable androidenterprise.users.update",
"type": "string"
},
"id": {
@@ -4628,7 +4663,7 @@
"type": "string"
},
"managementType": {
- "description": "The entity that manages the user. With googleManaged
users,\nthe source of truth is Google so EMMs have to make sure a Google Account\nexists for the user. With emmManaged
users, the\nEMM is in charge.",
+ "description": "The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.",
"enum": [
"googleManaged",
"emmManaged"
@@ -4640,7 +4675,7 @@
"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.",
+ "description": "The user's primary email address, for example, \"jsmith@example.com\". Will always be set for Google managed users and not set for EMM managed users.",
"type": "string"
}
},
@@ -4660,7 +4695,7 @@
"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.",
+ "description": "A variable set is a key-value pair of EMM-provided placeholders and its corresponding value, which is attributed to a user. For example, $FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders should start with a '$' sign and should be alphanumeric only.",
"id": "VariableSet",
"properties": {
"placeholder": {
@@ -4675,11 +4710,11 @@
"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.",
+ "description": "A WebApps resource represents a web app created for an enterprise. Web apps are published to managed Google Play and can be distributed like other Android 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. minimalUi
\", 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.\nstandalone
\", the device's status bar and navigation\nbar are visible when the app is open.\nfullScreen
\", 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.\nNote 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.",
+ "description": "The current version of the app. Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date.",
"format": "int64",
"type": "string"
},
"webAppId": {
- "description": "The ID of the application. A string of the form\n Approves the specified product and the relevant app permissions, if any. The maximum number of products that you can approve per enterprise customer is 1,000. To learn how to use managed Google Play to design and create a store layout to display approved products to your users, see Store Layout Design. If a corresponding user already exists with the same account identifier, the user will be updated with the resource. In this case only the "app:<package name>"
where the package name\nalways starts with the prefix\n"com.google.enterprise.webapp."
followed by a\nrandom id.",
+ "description": "The ID of the application. A string of the form \"app:\n
",
+ "description": "The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 \"Base 64 Encoding with URL and Filename Safe Alphabet\"). - The image type can be png or jpg. - The image should ideally be square. - The image should ideally have a size of 512x512. ",
"type": "string"
}
},
diff --git a/src/apis/androidenterprise/v1.ts b/src/apis/androidenterprise/v1.ts
index 1d9384f2e5..edbaf0d80b 100644
--- a/src/apis/androidenterprise/v1.ts
+++ b/src/apis/androidenterprise/v1.ts
@@ -194,7 +194,7 @@ export namespace androidenterprise_v1 {
*/
parent?: string | null;
/**
- * Deprecated. Use <code>PlaySearch.approveApps</code>.
+ * Deprecated. Use PlaySearch.approveApps.
*/
permission?: string[] | null;
/**
@@ -222,7 +222,7 @@ export namespace androidenterprise_v1 {
}
export interface Schema$AdministratorWebTokenSpecPlaySearch {
/**
- * Allow access to the iframe in <a href="https://developers.google.com/android/work/play/emm-api/managed-play-iframe#render">approve mode</a>. Default is false.
+ * Allow access to the iframe in approve mode. Default is false.
*/
approveApps?: boolean | null;
/**
@@ -275,7 +275,7 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$AppRestrictionsSchemaRestriction {
/**
- * The default value of the restriction. <code>bundle</code> and <code>bundleArray</code> restrictions never have a default value.
+ * The default value of the restriction. bundle and bundleArray restrictions never have a default value.
*/
defaultValue?: Schema$AppRestrictionsSchemaRestrictionRestrictionValue;
/**
@@ -283,11 +283,11 @@ export namespace androidenterprise_v1 {
*/
description?: string | null;
/**
- * For <code>choice</code> or <code>multiselect</code> restrictions, the list of possible entries' human-readable names.
+ * For choice or multiselect restrictions, the list of possible entries' human-readable names.
*/
entry?: string[] | null;
/**
- * For <code>choice</code> or <code>multiselect</code> restrictions, the list of possible entries' machine-readable values. These values should be used in the configuration, either as a single <code>string</code> value for a <code>choice</code> restriction or in a <code>stringArray</code> for a <code>multiselect</code> restriction.
+ * For choice or multiselect restrictions, the list of possible entries' machine-readable values. These values should be used in the configuration, either as a single string value for a choice restriction or in a stringArray for a multiselect restriction.
*/
entryValue?: string[] | null;
/**
@@ -295,7 +295,7 @@ export namespace androidenterprise_v1 {
*/
key?: string | null;
/**
- * For <code>bundle</code> or <code>bundleArray</code> restrictions, the list of nested restrictions. A <code>bundle</code> restriction is always nested within a <code>bundleArray</code> restriction, and a <code>bundleArray</code> restriction is at most two levels deep.
+ * For bundle or bundleArray restrictions, the list of nested restrictions. A bundle restriction is always nested within a bundleArray restriction, and a bundleArray restriction is at most two levels deep.
*/
nestedRestriction?: Schema$AppRestrictionsSchemaRestriction[];
/**
@@ -337,7 +337,7 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$ApprovalUrlInfo {
/**
- * A URL that displays a product's permissions and that can also be used to approve the product with the <code>Products.approve</code> call.
+ * A URL that displays a product's permissions and that can also be used to approve the product with the Products.approve call.
*/
approvalUrl?: string | null;
}
@@ -372,11 +372,11 @@ export namespace androidenterprise_v1 {
*/
isProduction?: boolean | null;
/**
- * Deprecated, use <code>trackId</code> instead.
+ * Deprecated, use trackId instead.
*/
track?: string | null;
/**
- * Track ids that the app version is published in. Replaces the <code>track</code> field (deprecated), but doesn't include the production track (see <code>isProduction</code> instead).
+ * Track ids that the app version is published in. Replaces the track field (deprecated), but doesn't include the production track (see isProduction instead).
*/
trackId?: string[] | null;
/**
@@ -450,11 +450,11 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$Device {
/**
- * The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, <code>"123456789abcdef0"</code>.
+ * The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, "123456789abcdef0".
*/
androidId?: string | null;
/**
- * Identifies the extent to which the device is controlled by a managed Google Play EMM in various deployment configurations. <br><br> Possible values include: <ul><li>"<code>managedDevice</code>", a device that has the EMM's device policy controller (DPC) as the device owner.</li> <li>"<code>managedProfile</code>", a device that has a profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC.</li> <li>"<code>containerApp</code>", no longer used (deprecated).</li> <li>"<code>unmanagedProfile</code>", a device that has been allowed (by the domain's admin, using the Admin Console to enable the privilege) to use managed Google Play, but the profile is itself not owned by a DPC.</li></ul>
+ * Identifies the extent to which the device is controlled by a managed Google Play EMM in various deployment configurations. Possible values include: - "managedDevice", a device that has the EMM's device policy controller (DPC) as the device owner. - "managedProfile", a device that has a profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC. - "containerApp", no longer used (deprecated). - "unmanagedProfile", a device that has been allowed (by the domain's admin, using the Admin Console to enable the privilege) to use managed Google Play, but the profile is itself not owned by a DPC.
*/
managementType?: string | null;
/**
@@ -512,7 +512,7 @@ export namespace androidenterprise_v1 {
accountState?: string | null;
}
/**
- * An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows: <ul><li>For Google managed domain customers, the process involves using <code>Enterprises.enroll</code> and <code>Enterprises.setAccount</code> (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process.</li> <li>For managed Google Play Accounts customers, the process involves using <code>Enterprises.generateSignupUrl</code> and <code>Enterprises.completeSignup</code> in conjunction with the managed Google Play sign-up UI (Google-provided mechanism) to create the binding without manual steps.</li></ul> As an EMM, you can support either or both approaches in your EMM console. See <a href="/android/work/play/emm-api/create-enterprise">Create an Enterprise</a> for details.
+ * An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows: - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process. - For managed Google Play Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the managed Google Play sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details.
*/
export interface Schema$Enterprise {
/**
@@ -558,15 +558,15 @@ export namespace androidenterprise_v1 {
topicName?: string | null;
}
/**
- * The presence of an Entitlements resource indicates that a user has the right to use a particular app. Entitlements are user specific, not device specific. This allows a user with an entitlement to an app to install the app on all their devices. It's also possible for a user to hold an entitlement to an app without installing the app on any device. The API can be used to create an entitlement. As an option, you can also use the API to trigger the installation of an app on all a user's managed devices at the same time the entitlement is created. If the app is free, creating the entitlement also creates a group license for that app. For paid apps, creating the entitlement consumes one license, and that license remains consumed until the entitlement is removed. If the enterprise hasn't purchased enough licenses, then no entitlement is created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn't accepted. If an entitlement is deleted, the app may be uninstalled from a user's device. As a best practice, uninstall the app by calling <a class="method-link" method="androidenterprise.installs.delete"> Installs.delete()</a> before deleting the entitlement. Entitlements for apps that a user pays for on an unmanaged profile have <code class="">"userPurchase"</code> as the entitlement reason. These entitlements cannot be removed via the API.
+ * The presence of an Entitlements resource indicates that a user has the right to use a particular app. Entitlements are user specific, not device specific. This allows a user with an entitlement to an app to install the app on all their devices. It's also possible for a user to hold an entitlement to an app without installing the app on any device. The API can be used to create an entitlement. As an option, you can also use the API to trigger the installation of an app on all a user's managed devices at the same time the entitlement is created. If the app is free, creating the entitlement also creates a group license for that app. For paid apps, creating the entitlement consumes one license, and that license remains consumed until the entitlement is removed. If the enterprise hasn't purchased enough licenses, then no entitlement is created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn't accepted. If an entitlement is deleted, the app may be uninstalled from a user's device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement. Entitlements for apps that a user pays for on an unmanaged profile have "userPurchase" as the entitlement reason. These entitlements cannot be removed via the API.
*/
export interface Schema$Entitlement {
/**
- * The ID of the product that the entitlement is for. For example, <code>"app:com.google.android.gm"</code>.
+ * The ID of the product that the entitlement is for. For example, "app:com.google.android.gm".
*/
productId?: string | null;
/**
- * The reason for the entitlement. For example, <code class="">"free"</code> for free apps. This property is temporary: it will be replaced by the <code class="">acquisition kind</code> field of group licenses.
+ * The reason for the entitlement. For example, "free" for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses.
*/
reason?: string | null;
}
@@ -577,11 +577,11 @@ export namespace androidenterprise_v1 {
entitlement?: Schema$Entitlement[];
}
/**
- * Group license objects allow you to keep track of licenses (called <a href="/android/work/play/emm-api/v1/entitlements">entitlements</a>) for both free and paid apps. For a free app, a group license is created when an enterprise admin first approves the product in Google Play or when the first entitlement for the product is created for a user via the API. For a paid app, a group license object is only created when an enterprise admin purchases the product in Google Play for the first time. Use the API to query group licenses. A <code>Grouplicenses</code> resource includes the total number of licenses purchased (paid apps only) and the total number of licenses currently in use. In other words, the total number of <code>Entitlements</code> that exist for the product. Only one group license object is created per product and group license objects are never deleted. If a product is unapproved, its group license remains. This allows enterprise admins to keep track of any remaining entitlements for the product.
+ * Group license objects allow you to keep track of licenses (called entitlements) for both free and paid apps. For a free app, a group license is created when an enterprise admin first approves the product in Google Play or when the first entitlement for the product is created for a user via the API. For a paid app, a group license object is only created when an enterprise admin purchases the product in Google Play for the first time. Use the API to query group licenses. A Grouplicenses resource includes the total number of licenses purchased (paid apps only) and the total number of licenses currently in use. In other words, the total number of Entitlements that exist for the product. Only one group license object is created per product and group license objects are never deleted. If a product is unapproved, its group license remains. This allows enterprise admins to keep track of any remaining entitlements for the product.
*/
export interface Schema$GroupLicense {
/**
- * How this group license was acquired. <code>"bulkPurchase"</code> means that this Grouplicenses resource was created because the enterprise purchased licenses for this product; otherwise, the value is <code>"free"</code> (for free products).
+ * How this group license was acquired. "bulkPurchase" means that this Grouplicenses resource was created because the enterprise purchased licenses for this product; otherwise, the value is "free" (for free products).
*/
acquisitionKind?: string | null;
/**
@@ -593,15 +593,15 @@ export namespace androidenterprise_v1 {
*/
numProvisioned?: number | null;
/**
- * The number of purchased licenses (possibly in multiple purchases). If this field is omitted, then there is no limit on the number of licenses that can be provisioned (for example, if the acquisition kind is <code>"free"</code>).
+ * The number of purchased licenses (possibly in multiple purchases). If this field is omitted, then there is no limit on the number of licenses that can be provisioned (for example, if the acquisition kind is "free").
*/
numPurchased?: number | null;
/**
- * The permission approval status of the product. This field is only set if the product is approved. Possible states are:<ul> <li>"<code>currentApproved</code>", the current set of permissions is approved, but additional permissions will require the administrator to reapprove the product (If the product was approved without specifying the approved permissions setting, then this is the default behavior.),</li> <li>"<code>needsReapproval</code>", the product has unapproved permissions. No additional product licenses can be assigned until the product is reapproved,</li> <li>"<code>allCurrentAndFutureApproved</code>", the current permissions are approved and any future permission updates will be automatically approved without administrator review.</li></ul>
+ * The permission approval status of the product. This field is only set if the product is approved. Possible states are: - "currentApproved", the current set of permissions is approved, but additional permissions will require the administrator to reapprove the product (If the product was approved without specifying the approved permissions setting, then this is the default behavior.), - "needsReapproval", the product has unapproved permissions. No additional product licenses can be assigned until the product is reapproved, - "allCurrentAndFutureApproved", the current permissions are approved and any future permission updates will be automatically approved without administrator review.
*/
permissions?: string | null;
/**
- * The ID of the product that the license is for. For example, <code>"app:com.google.android.gm"</code>.
+ * The ID of the product that the license is for. For example, "app:com.google.android.gm".
*/
productId?: string | null;
}
@@ -618,19 +618,19 @@ export namespace androidenterprise_v1 {
user?: Schema$User[];
}
/**
- * The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending). The API can be used to create an install resource using the <a class="method-link" method="androidenterprise.installs.update">update</a> method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app, then an attempt is made to create one. If this fails (for example, because the app is not free and there is no available license), then the creation of the install fails. The API can also be used to update an installed app. If the <a class="method-link" method="androidenterprise.installs.update" style="font-style: normal; font-size: 14px; font-family: Roboto, sans-serif; line-height: 22.3999996185303px;">update</a> method is used on an existing install, then the app will be updated to the latest available version. Note that it is not possible to force the installation of a specific version of an app: the version code is read-only. If a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created. The API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves.
+ * The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending). The API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app, then an attempt is made to create one. If this fails (for example, because the app is not free and there is no available license), then the creation of the install fails. The API can also be used to update an installed app. If the update method is used on an existing install, then the app will be updated to the latest available version. Note that it is not possible to force the installation of a specific version of an app: the version code is read-only. If a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created. The API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves.
*/
export interface Schema$Install {
/**
- * Install state. The state <code>"installPending"</code> means that an install request has recently been made and download to the device is in progress. The state <code>"installed"</code> means that the app has been installed. This field is read-only.
+ * Install state. The state "installPending" means that an install request has recently been made and download to the device is in progress. The state "installed" means that the app has been installed. This field is read-only.
*/
installState?: string | null;
/**
- * The ID of the product that the install is for. For example, <code>"app:com.google.android.gm"</code>.
+ * The ID of the product that the install is for. For example, "app:com.google.android.gm".
*/
productId?: string | null;
/**
- * The version of the installed product. Guaranteed to be set only if the install state is <code>"installed"</code>.
+ * The version of the installed product. Guaranteed to be set only if the install state is "installed".
*/
versionCode?: number | null;
}
@@ -827,7 +827,7 @@ export namespace androidenterprise_v1 {
*/
dpcPackageName?: string | null;
/**
- * Identifies the extent to which the device is controlled by an Android EMM in various deployment configurations. <br><br> Possible values include: <ul><li>"<code>managedDevice</code>", a device where the DPC is set as device owner,</li> <li>"<code>managedProfile</code>", a device where the DPC is set as profile owner.</li></ul>
+ * Identifies the extent to which the device is controlled by an Android EMM in various deployment configurations. Possible values include: - "managedDevice", a device where the DPC is set as device owner, - "managedProfile", a device where the DPC is set as profile owner.
*/
managementType?: string | null;
/**
@@ -915,7 +915,7 @@ export namespace androidenterprise_v1 {
notificationSetId?: string | null;
}
/**
- * Information about the current page. List operations that supports paging return only one "page" of results. This protocol buffer message describes the page that has been returned.
+ * Information about the current page. List operations that supports paging return only one "page" of results. This protocol buffer message describes the page that has been returned.
*/
export interface Schema$PageInfo {
/**
@@ -932,7 +932,7 @@ export namespace androidenterprise_v1 {
totalResults?: number | null;
}
/**
- * A Permissions resource represents some extra capability, to be granted to an Android app, which requires explicit consent. An enterprise admin must consent to these permissions on behalf of their users before an entitlement for the app can be created. The permissions collection is read-only. The information provided for each permission (localized name and description) is intended to be used in the MDM user interface when obtaining consent from the enterprise.
+ * A Permissions resource represents some extra capability, to be granted to an Android app, which requires explicit consent. An enterprise admin must consent to these permissions on behalf of their users before an entitlement for the app can be created. The permissions collection is read-only. The information provided for each permission (localized name and description) is intended to be used in the MDM user interface when obtaining consent from the enterprise.
*/
export interface Schema$Permission {
/**
@@ -969,12 +969,12 @@ export namespace androidenterprise_v1 {
*/
productAvailabilityPolicy?: string | null;
/**
- * The list of product policies. The <code>productAvailabilityPolicy</code> needs to be set to <code>WHITELIST</code> or <code>ALL</code> for the product policies to be applied.
+ * The list of product policies. The productAvailabilityPolicy needs to be set to WHITELIST or ALL for the product policies to be applied.
*/
productPolicy?: Schema$ProductPolicy[];
}
/**
- * A Products resource represents an app in the Google Play store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.) The information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an EMM user interface.
+ * A Products resource represents an app in the Google Play store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.) The information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an EMM user interface.
*/
export interface Schema$Product {
/**
@@ -994,7 +994,7 @@ export namespace androidenterprise_v1 {
*/
availableCountries?: string[] | null;
/**
- * Deprecated, use <code>appTracks</code> instead.
+ * Deprecated, use appTracks instead.
*/
availableTracks?: string[] | null;
/**
@@ -1014,7 +1014,7 @@ export namespace androidenterprise_v1 {
*/
detailsUrl?: string | null;
/**
- * How and to whom the package is made available. The value <code>publicGoogleHosted</code> means that the package is available through the Play store and not restricted to a specific enterprise. The value <code>privateGoogleHosted</code> means that the package is a private app (restricted to an enterprise) but hosted by Google. The value <code>privateSelfHosted</code> means that the package is a private app (restricted to an enterprise) and is privately hosted.
+ * How and to whom the package is made available. The value publicGoogleHosted means that the package is available through the Play store and not restricted to a specific enterprise. The value privateGoogleHosted means that the package is a private app (restricted to an enterprise) but hosted by Google. The value privateSelfHosted means that the package is a private app (restricted to an enterprise) and is privately hosted.
*/
distributionChannel?: string | null;
/**
@@ -1038,7 +1038,7 @@ export namespace androidenterprise_v1 {
*/
permissions?: Schema$ProductPermission[];
/**
- * A string of the form <code><em>app:<package name></em></code>. For example, <code>app:com.google.android.gm</code> represents the Gmail app.
+ * A string of the form *app:<package name>*. For example, app:com.google.android.gm represents the Gmail app.
*/
productId?: string | null;
/**
@@ -1101,7 +1101,7 @@ export namespace androidenterprise_v1 {
productId?: string | null;
}
/**
- * A product permissions resource represents the set of permissions required by a specific app and whether or not they have been accepted by an enterprise admin. The API can be used to read the set of permissions, and also to update the set to indicate that permissions have been accepted.
+ * A product permissions resource represents the set of permissions required by a specific app and whether or not they have been accepted by an enterprise admin. The API can be used to read the set of permissions, and also to update the set to indicate that permissions have been accepted.
*/
export interface Schema$ProductPermission {
/**
@@ -1139,15 +1139,15 @@ export namespace androidenterprise_v1 {
*/
managedConfiguration?: Schema$ManagedConfiguration;
/**
- * The ID of the product. For example, <code>"app:com.google.android.gm"</code>.
+ * The ID of the product. For example, "app:com.google.android.gm".
*/
productId?: string | null;
/**
- * Grants the device visibility to the specified product release track(s), identified by <code>trackIds</code>. The list of release tracks of a product can be obtained by calling Products.Get.
+ * Grants the device visibility to the specified product release track(s), identified by trackIds. The list of release tracks of a product can be obtained by calling Products.Get.
*/
trackIds?: string[] | null;
/**
- * Deprecated. Use <code>trackIds</code> instead.
+ * Deprecated. Use trackIds instead.
*/
tracks?: string[] | null;
}
@@ -1180,7 +1180,7 @@ export namespace androidenterprise_v1 {
}
export interface Schema$ProductsGenerateApprovalUrlResponse {
/**
- * A URL that can be rendered in an iframe to display the permissions (if any) of a product. This URL can be used to approve the product only once and only within 24 hours of being generated, using the <code>Products.approve</code> call. If the product is currently unapproved and has no permissions, this URL will point to an empty page. If the product is currently approved, a URL will only be generated if that product has added permissions since it was last approved, and the URL will only display those new permissions that have not yet been accepted.
+ * A URL that can be rendered in an iframe to display the permissions (if any) of a product. This URL can be used to approve the product only once and only within 24 hours of being generated, using the Products.approve call. If the product is currently unapproved and has no permissions, this URL will point to an empty page. If the product is currently approved, a URL will only be generated if that product has added permissions since it was last approved, and the URL will only display those new permissions that have not yet been accepted.
*/
url?: string | null;
}
@@ -1217,11 +1217,11 @@ export namespace androidenterprise_v1 {
*/
productId?: string | null;
/**
- * Grants the user visibility to the specified product track(s), identified by <code>trackIds</code>.
+ * Grants the user visibility to the specified product track(s), identified by trackIds.
*/
trackIds?: string[] | null;
/**
- * Deprecated. Use <code>trackIds</code> instead.
+ * Deprecated. Use trackIds instead.
*/
tracks?: string[] | null;
}
@@ -1251,7 +1251,7 @@ export namespace androidenterprise_v1 {
*/
id?: string | null;
/**
- * Public key data for the credentials file. This is an X.509 cert. If you are using the <code>googleCredentials</code> key type, this is identical to the cert that can be retrieved by using the X.509 cert url inside of the credentials file.
+ * Public key data for the credentials file. This is an X.509 cert. If you are using the googleCredentials key type, this is identical to the cert that can be retrieved by using the X.509 cert url inside of the credentials file.
*/
publicData?: string | null;
/**
@@ -1295,7 +1295,7 @@ export namespace androidenterprise_v1 {
*/
name?: Schema$LocalizedText[];
/**
- * String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined. The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters.
+ * String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined. The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters.
*/
orderInPage?: string | null;
/**
@@ -1308,7 +1308,7 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$StoreLayout {
/**
- * The ID of the store page to be used as the homepage. The homepage is the first page shown in the managed Google Play Store. Not specifying a homepage is equivalent to setting the store layout type to "basic".
+ * The ID of the store page to be used as the homepage. The homepage is the first page shown in the managed Google Play Store. Not specifying a homepage is equivalent to setting the store layout type to "basic".
*/
homepageId?: string | null;
/**
@@ -1337,7 +1337,7 @@ export namespace androidenterprise_v1 {
*/
id?: string | null;
/**
- * Ordered list of pages a user should be able to reach from this page. The list can't include this page. It is recommended that the basic pages are created first, before adding the links between pages. The API doesn't verify that the pages exist or the pages are reachable.
+ * Ordered list of pages a user should be able to reach from this page. The list can't include this page. It is recommended that the basic pages are created first, before adding the links between pages. The API doesn't verify that the pages exist or the pages are reachable.
*/
link?: string[] | null;
/**
@@ -1346,7 +1346,7 @@ export namespace androidenterprise_v1 {
name?: Schema$LocalizedText[];
}
/**
- * Pagination information returned by a List operation when token pagination is enabled. List operations that supports paging return only one "page" of results. This protocol buffer message describes the page that has been returned. When using token pagination, clients should use the next/previous token to get another page of the result. The presence or absence of next/previous token indicates whether a next/previous page is available and provides a mean of accessing this page. ListRequest.page_token should be set to either next_page_token or previous_page_token to access another page.
+ * Pagination information returned by a List operation when token pagination is enabled. List operations that supports paging return only one "page" of results. This protocol buffer message describes the page that has been returned. When using token pagination, clients should use the next/previous token to get another page of the result. The presence or absence of next/previous token indicates whether a next/previous page is available and provides a mean of accessing this page. ListRequest.page_token should be set to either next_page_token or previous_page_token to access another page.
*/
export interface Schema$TokenPagination {
/**
@@ -1369,7 +1369,7 @@ export namespace androidenterprise_v1 {
trackId?: string | null;
}
/**
- * A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to managed Google Play only, or to other Google services, depending on the identity model: <ul><li>The Google managed domain identity model requires synchronization to Google account sources (via <code>primaryEmail</code>).</li> <li>The managed Google Play Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to managed Google Play.</li> </ul>
+ * A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to managed Google Play only, or to other Google services, depending on the identity model: - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). - The managed Google Play Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to managed Google Play.
*/
export interface Schema$User {
/**
@@ -1377,7 +1377,7 @@ export namespace androidenterprise_v1 {
*/
accountIdentifier?: string | null;
/**
- * The type of account that this user represents. A <code>userAccount</code> can be installed on multiple devices, but a <code>deviceAccount</code> is specific to a single device. An EMM-managed user (<code>emmManaged</code>) can be either type (<code>userAccount</code>, <code>deviceAccount</code>), but a Google-managed user (<code>googleManaged</code>) is always a <code>userAccount</code>.
+ * The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
*/
accountType?: string | null;
/**
@@ -1389,7 +1389,7 @@ export namespace androidenterprise_v1 {
*/
id?: string | null;
/**
- * The entity that manages the user. With <code>googleManaged</code> users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With <code>emmManaged</code> users, the EMM is in charge.
+ * The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
*/
managementType?: string | null;
/**
@@ -1421,7 +1421,7 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$WebApp {
/**
- * The display mode of the web app. <br><br> Possible values include: <ul><li>"<code>minimalUi</code>", the device's status bar, navigation bar, the app's URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option. <li>"<code>standalone</code>", the device's status bar and navigation bar are visible when the app is open. <li>"<code>fullScreen</code>", the app opens in full screen mode, hiding the device's status and navigation bars. All browser UI elements, page URL, system status bar and back button are not visible, and the web app takes up the entirety of the available display area. </ul>
+ * The display mode of the web app. Possible values include: - "minimalUi", the device's status bar, navigation bar, the app's URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option. - "standalone", the device's status bar and navigation bar are visible when the app is open. - "fullScreen", the app opens in full screen mode, hiding the device's status and navigation bars. All browser UI elements, page URL, system status bar and back button are not visible, and the web app takes up the entirety of the available display area.
*/
displayMode?: string | null;
/**
@@ -1441,11 +1441,11 @@ export namespace androidenterprise_v1 {
*/
title?: string | null;
/**
- * The current version of the app. <p>Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date.
+ * The current version of the app. Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date.
*/
versionCode?: string | null;
/**
- * The ID of the application. A string of the form <code>"app:<package name>"</code> where the package name always starts with the prefix <code>"com.google.enterprise.webapp."</code> followed by a random id.
+ * The ID of the application. A string of the form "app:<package name>" where the package name always starts with the prefix "com.google.enterprise.webapp." followed by a random id.
*/
webAppId?: string | null;
}
@@ -1454,7 +1454,7 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$WebAppIcon {
/**
- * The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe Alphabet"). <ul> <li>The image type can be png or jpg. <li>The image should ideally be square. <li>The image should ideally have a size of 512x512. </ul>
+ * The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe Alphabet"). - The image type can be png or jpg. - The image should ideally be square. - The image should ideally have a size of 512x512.
*/
imageData?: string | null;
}
@@ -1473,7 +1473,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.devices.forceReportUpload
- * @desc Uploads a report containing any changes in app states on the device since the last report was generated. You can call this method up to 3 times every 24 hours for a given device. If you exceed the quota, then the Google Play EMM API returns HTTP 429 Too Many Requests
.
+ * @desc Uploads a report containing any changes in app states on the device since the last report was generated. You can call this method up to 3 times every 24 hours for a given device. If you exceed the quota, then the Google Play EMM API returns HTTP 429 Too Many Requests.
* @example
* // Before running the sample:
* // - Enable the API at:
@@ -2188,11 +2188,7 @@ export namespace androidenterprise_v1 {
* deviceId: 'placeholder-value',
* // The ID of the enterprise.
* enterpriseId: 'placeholder-value',
- * // Mask that identifies which fields to update. If not set, all modifiable
- * // fields will be modified.
- * //
- * // When set in a query parameter, this field should be specified as
- * // updateMask=<field1>,<field2>,...
+ * // Mask that identifies which fields to update. If not set, all modifiable fields will be modified. When set in a query parameter, this field should be specified as updateMask=updateMask=<field1>,<field2>,...
+ * @param {string=} params.updateMask Mask that identifies which fields to update. If not set, all modifiable fields will be modified. When set in a query parameter, this field should be specified as updateMask=updateMask=<field1>,<field2>,...
+ * Mask that identifies which fields to update. If not set, all modifiable fields will be modified. When set in a query parameter, this field should be specified as updateMask=
- * // Beware that this means that the URL will be parsed, the parameter added
- * // and then a new URL formatted, i.e. there may be some minor formatting
- * // changes and, more importantly, the URL must be well-formed so that it can
- * // be parsed.
+ * // The callback URL to which the Admin will be redirected after successfully creating an enterprise. Before redirecting there the system will add a single query parameter to this URL named "enterpriseToken" which will contain an opaque token to be used for the CompleteSignup request. Beware that this means that the URL will be parsed, the parameter added and then a new URL formatted, i.e. there may be some minor formatting changes and, more importantly, the URL must be well-formed so that it can be parsed.
* callbackUrl: 'placeholder-value',
* });
* console.log(res.data);
@@ -3034,7 +3022,7 @@ export namespace androidenterprise_v1 {
* @memberOf! ()
*
* @param {object} params Parameters for request
- * @param {string=} params.callbackUrl The callback URL to which the Admin will be redirected after successfully creating an enterprise. Before redirecting there the system will add a single query parameter to this URL named "enterpriseToken" which will contain an opaque token to be used for the CompleteSignup request.
Beware that this means that the URL will be parsed, the parameter added and then a new URL formatted, i.e. there may be some minor formatting changes and, more importantly, the URL must be well-formed so that it can be parsed.
+ * @param {string=} params.callbackUrl The callback URL to which the Admin will be redirected after successfully creating an enterprise. Before redirecting there the system will add a single query parameter to this URL named "enterpriseToken" which will contain an opaque token to be used for the CompleteSignup request. Beware that this means that the URL will be parsed, the parameter added and then a new URL formatted, i.e. there may be some minor formatting changes and, more importantly, the URL must be well-formed so that it can be parsed.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
@@ -3251,7 +3239,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.enterprises.getServiceAccount
- * @desc Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound. The credentials contain private key data and are not stored server-side.
This method can only be called after calling Enterprises.Enroll or Enterprises.CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error.
Subsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials.
Once the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource.
+ * @desc Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound. The credentials contain private key data and are not stored server-side. This method can only be called after calling Enterprises.Enroll or Enterprises.CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error. Subsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials. Once the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource.
* @example
* // Before running the sample:
* // - Enable the API at:
@@ -3520,7 +3508,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.enterprises.list
- * @desc Looks up an enterprise by domain name. This is only supported for enterprises created via the Google-initiated creation flow. Lookup of the id is not needed for enterprises created via the EMM-initiated flow since the EMM learns the enterprise ID in the callback specified in the Enterprises.generateSignupUrl call.
+ * @desc Looks up an enterprise by domain name. This is only supported for enterprises created via the Google-initiated creation flow. Lookup of the id is not needed for enterprises created via the EMM-initiated flow since the EMM learns the enterprise ID in the callback specified in the Enterprises.generateSignupUrl call.
* @example
* // Before running the sample:
* // - Enable the API at:
@@ -3655,7 +3643,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.enterprises.pullNotificationSet
- * @desc Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending.
A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty.
Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy.
Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending.
If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available.
+ * @desc Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending. A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty. Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy. Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending. If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available.
* @example
* // Before running the sample:
* // - Enable the API at:
@@ -3680,17 +3668,7 @@ export namespace androidenterprise_v1 {
*
* // Do the magic
* const res = await androidenterprise.enterprises.pullNotificationSet({
- * // The request mode for pulling notifications.
- * //
- * // Specifying waitForNotifications
will cause the request to
- * // block and wait until one or more notifications are present, or return an
- * // empty notification list if no notifications are present after some time.
- * //
- * // Speciying returnImmediately
will cause the request to
- * // immediately return the pending notifications, or an empty list if no
- * // notifications are present.
- * //
- * // If omitted, defaults to waitForNotifications
.
+ * // The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.
* requestMode: 'placeholder-value',
* });
* console.log(res.data);
@@ -3711,7 +3689,7 @@ export namespace androidenterprise_v1 {
* @memberOf! ()
*
* @param {object} params Parameters for request
- * @param {string=} params.requestMode The request mode for pulling notifications.
Specifying waitForNotifications
will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time.
Speciying returnImmediately
will cause the request to immediately return the pending notifications, or an empty list if no notifications are present.
If omitted, defaults to waitForNotifications
.
+ * @param {string=} params.requestMode The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
@@ -4096,7 +4074,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.enterprises.setStoreLayout
- * @desc Sets the store layout for the enterprise. By default, storeLayoutType is set to "basic" and the basic store layout is enabled. The basic layout only contains apps approved by the admin, and that have been added to the available product set for a user (using the setAvailableProductSet call). Apps on the page are sorted in order of their product ID value. If you create a custom store layout (by setting storeLayoutType = "custom" and setting a homepage), the basic store layout is disabled.
+ * @desc Sets the store layout for the enterprise. By default, storeLayoutType is set to "basic" and the basic store layout is enabled. The basic layout only contains apps approved by the admin, and that have been added to the available product set for a user (using the setAvailableProductSet call). Apps on the page are sorted in order of their product ID value. If you create a custom store layout (by setting storeLayoutType = "custom" and setting a homepage), the basic store layout is disabled.
* @example
* // Before running the sample:
* // - Enable the API at:
@@ -4406,7 +4384,7 @@ export namespace androidenterprise_v1 {
export interface Params$Resource$Enterprises$Generatesignupurl
extends StandardParameters {
/**
- * The callback URL to which the Admin will be redirected after successfully creating an enterprise. Before redirecting there the system will add a single query parameter to this URL named "enterpriseToken" which will contain an opaque token to be used for the CompleteSignup request.
Beware that this means that the URL will be parsed, the parameter added and then a new URL formatted, i.e. there may be some minor formatting changes and, more importantly, the URL must be well-formed so that it can be parsed.
+ * The callback URL to which the Admin will be redirected after successfully creating an enterprise. Before redirecting there the system will add a single query parameter to this URL named "enterpriseToken" which will contain an opaque token to be used for the CompleteSignup request. Beware that this means that the URL will be parsed, the parameter added and then a new URL formatted, i.e. there may be some minor formatting changes and, more importantly, the URL must be well-formed so that it can be parsed.
*/
callbackUrl?: string;
}
@@ -4443,7 +4421,7 @@ export namespace androidenterprise_v1 {
export interface Params$Resource$Enterprises$Pullnotificationset
extends StandardParameters {
/**
- * The request mode for pulling notifications.
Specifying waitForNotifications
will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time.
Speciying returnImmediately
will cause the request to immediately return the pending notifications, or an empty list if no notifications are present.
If omitted, defaults to waitForNotifications
.
+ * The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.
*/
requestMode?: string;
}
@@ -4929,10 +4907,7 @@ export namespace androidenterprise_v1 {
* enterpriseId: 'placeholder-value',
* // The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm".
* entitlementId: 'placeholder-value',
- * // Set to true to also install the product on all the user's devices where
- * // possible. Failure to install on one or more devices will not prevent
- * // this operation from returning successfully, as long as the entitlement
- * // was successfully assigned to the user.
+ * // Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.
* install: 'placeholder-value',
* // The ID of the user.
* userId: 'placeholder-value',
@@ -5153,8 +5128,7 @@ export namespace androidenterprise_v1 {
* const res = await androidenterprise.grouplicenses.get({
* // The ID of the enterprise.
* enterpriseId: 'placeholder-value',
- * // The ID of the product the group license is for, e.g.
- * // "app:com.google.android.gm".
+ * // The ID of the product the group license is for, e.g. "app:com.google.android.gm".
* groupLicenseId: 'placeholder-value',
* });
* console.log(res.data);
@@ -5457,8 +5431,7 @@ export namespace androidenterprise_v1 {
* const res = await androidenterprise.grouplicenseusers.list({
* // The ID of the enterprise.
* enterpriseId: 'placeholder-value',
- * // The ID of the product the group license is for, e.g.
- * // "app:com.google.android.gm".
+ * // The ID of the product the group license is for, e.g. "app:com.google.android.gm".
* groupLicenseId: 'placeholder-value',
* });
* console.log(res.data);
@@ -5593,7 +5566,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.installs.delete
- * @desc Requests to remove an app from a device. A call to get
or list
will still show the app as installed on the device until it is actually removed.
+ * @desc Requests to remove an app from a device. A call to get or list will still show the app as installed on the device until it is actually removed.
* @example
* // Before running the sample:
* // - Enable the API at:
@@ -5622,8 +5595,7 @@ export namespace androidenterprise_v1 {
* deviceId: 'placeholder-value',
* // The ID of the enterprise.
* enterpriseId: 'placeholder-value',
- * // The ID of the product represented by the install, e.g.
- * // "app:com.google.android.gm".
+ * // The ID of the product represented by the install, e.g. "app:com.google.android.gm".
* installId: 'placeholder-value',
* // The ID of the user.
* userId: 'placeholder-value',
@@ -5755,8 +5727,7 @@ export namespace androidenterprise_v1 {
* deviceId: 'placeholder-value',
* // The ID of the enterprise.
* enterpriseId: 'placeholder-value',
- * // The ID of the product represented by the install, e.g.
- * // "app:com.google.android.gm".
+ * // The ID of the product represented by the install, e.g. "app:com.google.android.gm".
* installId: 'placeholder-value',
* // The ID of the user.
* userId: 'placeholder-value',
@@ -6038,8 +6009,7 @@ export namespace androidenterprise_v1 {
* deviceId: 'placeholder-value',
* // The ID of the enterprise.
* enterpriseId: 'placeholder-value',
- * // The ID of the product represented by the install, e.g.
- * // "app:com.google.android.gm".
+ * // The ID of the product represented by the install, e.g. "app:com.google.android.gm".
* installId: 'placeholder-value',
* // The ID of the user.
* userId: 'placeholder-value',
@@ -6272,8 +6242,7 @@ export namespace androidenterprise_v1 {
* deviceId: 'placeholder-value',
* // The ID of the enterprise.
* enterpriseId: 'placeholder-value',
- * // The ID of the managed configuration (a product ID), e.g.
- * // "app:com.google.android.gm".
+ * // The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm".
* managedConfigurationForDeviceId: 'placeholder-value',
* // The ID of the user.
* userId: 'placeholder-value',
@@ -6416,8 +6385,7 @@ export namespace androidenterprise_v1 {
* deviceId: 'placeholder-value',
* // The ID of the enterprise.
* enterpriseId: 'placeholder-value',
- * // The ID of the managed configuration (a product ID), e.g.
- * // "app:com.google.android.gm".
+ * // The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm".
* managedConfigurationForDeviceId: 'placeholder-value',
* // The ID of the user.
* userId: 'placeholder-value',
@@ -6735,8 +6703,7 @@ export namespace androidenterprise_v1 {
* deviceId: 'placeholder-value',
* // The ID of the enterprise.
* enterpriseId: 'placeholder-value',
- * // The ID of the managed configuration (a product ID), e.g.
- * // "app:com.google.android.gm".
+ * // The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm".
* managedConfigurationForDeviceId: 'placeholder-value',
* // The ID of the user.
* userId: 'placeholder-value',
@@ -6989,8 +6956,7 @@ export namespace androidenterprise_v1 {
* const res = await androidenterprise.managedconfigurationsforuser.delete({
* // The ID of the enterprise.
* enterpriseId: 'placeholder-value',
- * // The ID of the managed configuration (a product ID), e.g.
- * // "app:com.google.android.gm".
+ * // The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm".
* managedConfigurationForUserId: 'placeholder-value',
* // The ID of the user.
* userId: 'placeholder-value',
@@ -7124,8 +7090,7 @@ export namespace androidenterprise_v1 {
* const res = await androidenterprise.managedconfigurationsforuser.get({
* // The ID of the enterprise.
* enterpriseId: 'placeholder-value',
- * // The ID of the managed configuration (a product ID), e.g.
- * // "app:com.google.android.gm".
+ * // The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm".
* managedConfigurationForUserId: 'placeholder-value',
* // The ID of the user.
* userId: 'placeholder-value',
@@ -7396,7 +7361,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.managedconfigurationsforuser.update
- * @desc Adds or updates the managed configuration settings for an app for the specified user. If you support the Managed configurations iframe, you can apply managed configurations to a user by specifying an mcmId
and its associated configuration variables (if any) in the request. Alternatively, all EMMs can apply managed configurations by passing a list of managed properties.
+ * @desc Adds or updates the managed configuration settings for an app for the specified user. If you support the Managed configurations iframe, you can apply managed configurations to a user by specifying an mcmId and its associated configuration variables (if any) in the request. Alternatively, all EMMs can apply managed configurations by passing a list of managed properties.
* @example
* // Before running the sample:
* // - Enable the API at:
@@ -7423,8 +7388,7 @@ export namespace androidenterprise_v1 {
* const res = await androidenterprise.managedconfigurationsforuser.update({
* // The ID of the enterprise.
* enterpriseId: 'placeholder-value',
- * // The ID of the managed configuration (a product ID), e.g.
- * // "app:com.google.android.gm".
+ * // The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm".
* managedConfigurationForUserId: 'placeholder-value',
* // The ID of the user.
* userId: 'placeholder-value',
@@ -7654,8 +7618,7 @@ export namespace androidenterprise_v1 {
* const res = await androidenterprise.managedconfigurationssettings.list({
* // The ID of the enterprise.
* enterpriseId: 'placeholder-value',
- * // The ID of the product for which the managed configurations settings applies
- * // to.
+ * // The ID of the product for which the managed configurations settings applies to.
* productId: 'placeholder-value',
* });
* console.log(res.data);
@@ -7950,7 +7913,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.products.approve
- * @desc
Admins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the approvalUrlInfo.approvalUrl
property in a Products.approve
call to approve the product. This URL can only be used to display permissions for up to 1 day.
+ * @desc Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product. Admins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to approve the product. This URL can only be used to display permissions for up to 1 day.
* @example
* // Before running the sample:
* // - Enable the API at:
@@ -8113,8 +8076,7 @@ export namespace androidenterprise_v1 {
* const res = await androidenterprise.products.generateApprovalUrl({
* // The ID of the enterprise.
* enterpriseId: 'placeholder-value',
- * // The BCP 47 language code used for permission names and descriptions in
- * // the returned iframe, for instance "en-US".
+ * // The BCP 47 language code used for permission names and descriptions in the returned iframe, for instance "en-US".
* languageCode: 'placeholder-value',
* // The ID of the product.
* productId: 'placeholder-value',
@@ -8392,7 +8354,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.products.getAppRestrictionsSchema
- * @desc Retrieves the schema that defines the configurable properties for this product. All products have a schema, but this schema may be empty if no managed configurations have been defined. This schema can be used to populate a UI that allows an admin to configure the product. To apply a managed configuration based on the schema obtained using this API, see Managed Configurations through Play.
+ * @desc Retrieves the schema that defines the configurable properties for this product. All products have a schema, but this schema may be empty if no managed configurations have been defined. This schema can be used to populate a UI that allows an admin to configure the product. To apply a managed configuration based on the schema obtained using this API, see Managed Configurations through Play.
* @example
* // Before running the sample:
* // - Enable the API at:
@@ -8702,27 +8664,17 @@ export namespace androidenterprise_v1 {
*
* // Do the magic
* const res = await androidenterprise.products.list({
- * // Specifies whether to search among all products (false) or among
- * // only products that have been approved (true). Only "true" is
- * // supported, and should be specified.
+ * // Specifies whether to search among all products (false) or among only products that have been approved (true). Only "true" is supported, and should be specified.
* approved: 'placeholder-value',
* // The ID of the enterprise.
* enterpriseId: 'placeholder-value',
- * // The BCP47 tag for the user's preferred language (e.g. "en-US", "de").
- * // Results are returned in the language best matching the preferred
- * // language.
+ * // The BCP47 tag for the user's preferred language (e.g. "en-US", "de"). Results are returned in the language best matching the preferred language.
* language: 'placeholder-value',
- * // Defines how many results the list operation should return.
- * // The default number depends on the resource collection.
+ * // Defines how many results the list operation should return. The default number depends on the resource collection.
* maxResults: 'placeholder-value',
- * // The search query as typed in the Google Play store search box.
- * // If omitted, all approved apps will be returned (using the pagination
- * // parameters), including apps that are not available in the store
- * // (e.g. unpublished apps).
+ * // The search query as typed in the Google Play store search box. If omitted, all approved apps will be returned (using the pagination parameters), including apps that are not available in the store (e.g. unpublished apps).
* query: 'placeholder-value',
- * // Defines the token of the page to return, usually taken from
- * // TokenPagination.
- * // This can only be used if token paging is enabled.
+ * // Defines the token of the page to return, usually taken from TokenPagination. This can only be used if token paging is enabled.
* token: 'placeholder-value',
* });
* console.log(res.data);
@@ -9208,7 +9160,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.serviceaccountkeys.insert
- * @desc Generates new credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.
Only the type of the key should be populated in the resource to be inserted.
+ * @desc Generates new credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount. Only the type of the key should be populated in the resource to be inserted.
* @example
* // Before running the sample:
* // - Enable the API at:
@@ -11219,7 +11171,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.users.generateAuthenticationToken
- * @desc Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device. The generated token is single-use and expires after a few minutes. You can provision a maximum of 10 devices per user. This call only works with EMM-managed accounts.
+ * @desc Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device. The generated token is single-use and expires after a few minutes. You can provision a maximum of 10 devices per user. This call only works with EMM-managed accounts.
* @example
* // Before running the sample:
* // - Enable the API at:
@@ -11634,7 +11586,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.users.insert
- * @desc Creates a new EMM-managed user. The Users resource passed in the body of the request should include an accountIdentifier
and an accountType
. displayName
field can be changed.
+ * @desc Creates a new EMM-managed user. The Users resource passed in the body of the request should include an accountIdentifier and an accountType. If a corresponding user already exists with the same account identifier, the user will be updated with the resource. In this case only the displayName field can be changed.
* @example
* // Before running the sample:
* // - Enable the API at:
@@ -11782,7 +11734,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.users.list
- * @desc Looks up a user by primary email address. This is only supported for Google-managed users. Lookup of the id is not needed for EMM-managed users because the id is already returned in the result of the Users.insert call.
+ * @desc Looks up a user by primary email address. This is only supported for Google-managed users. Lookup of the id is not needed for EMM-managed users because the id is already returned in the result of the Users.insert call.
* @example
* // Before running the sample:
* // - Enable the API at:
@@ -11917,7 +11869,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.users.revokeDeviceAccess
- * @desc Revokes access to all devices currently provisioned to the user. The user will no longer be able to use the managed Play store on any of their managed devices. This call only works with EMM-managed accounts.
+ * @desc Revokes access to all devices currently provisioned to the user. The user will no longer be able to use the managed Play store on any of their managed devices. This call only works with EMM-managed accounts.
* @example
* // Before running the sample:
* // - Enable the API at:
@@ -12044,7 +11996,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.users.setAvailableProductSet
- * @desc Modifies the set of products that a user is entitled to access (referred to as whitelisted products). Only products that are approved or products that were previously approved (products with revoked approval) can be whitelisted.
+ * @desc Modifies the set of products that a user is entitled to access (referred to as *whitelisted* products). Only products that are approved or products that were previously approved (products with revoked approval) can be whitelisted.
* @example
* // Before running the sample:
* // - Enable the API at:
@@ -12193,7 +12145,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.users.update
- * @desc Updates the details of an EMM-managed user. Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName
field can be changed. Other fields must either be unset or have the currently active value.
+ * @desc Updates the details of an EMM-managed user. Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value.
* @example
* // Before running the sample:
* // - Enable the API at: