此 API 参考资料按资源类型编排整理。每种资源类型都有一种或多种数据表示形式以及一个或多个方法。
资源类型
- 设备
- 企业
- 使用权
- 群组许可
- Grouplicenseusers
- 安装次数
- 适用于设备的受管理配置
- Managedconfigurationsforuser
- Managedconfigurationssettings
- 权限
- 产品
- 服务账号密钥
- Storelayoutclusters
- 商店布局页面
- 用户
- Web 应用
设备
如需详细了解 Devices 资源,请参阅资源表示形式页面。
方法 | HTTP 请求 | 说明 |
---|---|---|
除非另有说明,否则 URI 均为 https://www.googleapis.com/androidenterprise/v1 的相对地址 | ||
forceReportUpload |
POST /enterprises/enterpriseId/users/userId/devices/deviceId/forceReportUpload
|
上传报告,其中包含自上次生成报告以来设备上应用状态发生的任何变化。对于给定设备,您每 24 小时最多可以调用此方法 3 次。 |
get |
GET /enterprises/enterpriseId/users/userId/devices/deviceId
|
检索设备的详细信息。 |
getState |
GET /enterprises/enterpriseId/users/userId/devices/deviceId/state
|
检索设备对 Google 服务的访问权限是启用还是停用。只有在 Google 管理控制台中启用在 Android 设备上强制执行 EMM 政策后,设备状态才会生效。否则,系统会忽略设备状态,并允许所有设备访问 Google 服务。 只有由 Google 管理的用户支持此功能。 |
list |
GET /enterprises/enterpriseId/users/userId/devices
|
检索用户所有设备的 ID。 |
setState |
PUT /enterprises/enterpriseId/users/userId/devices/deviceId/state
|
设置是启用还是停用设备对 Google 服务的访问权限。 只有在 Google 管理控制台中启用在 Android 设备上强制执行 EMM 政策后,设备状态才会生效。否则,系统会忽略设备状态,并允许所有设备访问 Google 服务。 只有由 Google 管理的用户支持此功能。 |
update |
PUT /enterprises/enterpriseId/users/userId/devices/deviceId
|
更新设备政策。 为确保正确执行政策,您需要通过在 Google Play 软件包的受管理配置中设置 allowed_accounts 来防止非受管帐号访问 Google Play。请参阅在 Google Play 中限制帐号。
|
企业
如需详细了解 Enterprises 资源,请参阅资源表示形式页面。
方法 | HTTP 请求 | 说明 |
---|---|---|
除非另有说明,否则 URI 均为 https://www.googleapis.com/androidenterprise/v1 的相对地址 | ||
acknowledgeNotificationSet |
POST /enterprises/acknowledgeNotificationSet
|
确认从 Enterprises.PullNotificationSet 收到的通知,以防止后续调用返回相同的通知。 |
completeSignup |
POST /enterprises/completeSignup
|
通过指定完成令牌和企业令牌,完成注册流程。对于给定的企业令牌,不得多次调用此请求。 |
createWebToken |
POST /enterprises/enterpriseId/createWebToken
|
返回用于访问可嵌入界面的唯一令牌。如需生成网页界面,请将生成的令牌传递到 Google Play 企业版 JavaScript API。每个令牌只能用于启动一个界面会话。如需了解详情,请参阅 JavaScript API 文档。 |
注册 |
POST /enterprises/enroll
|
为企业注册调用方 EMM。
必需的查询参数: |
generateSignupUrl |
POST /enterprises/signupUrl
|
生成注册网址。 |
get |
GET /enterprises/enterpriseId
|
检索企业的名称和网域。 |
getServiceAccount |
GET /enterprises/enterpriseId/serviceAccount
|
返回服务帐号和凭据。该服务帐号可通过调用 setAccount 与企业绑定。该服务帐号在此企业和 EMM 中是唯一的,如果该企业未绑定,则该服务帐号将被删除。凭据包含私钥数据,不会存储在服务器端。 此方法只能在调用 Enterprises.registered 或 Enterprises.CompleteSignup 之后、Enterprises.SetAccount 之前调用,其他时候会返回错误。 在第一次调用之后的后续调用将生成一组唯一的新凭据,并使之前生成的凭据失效。 将服务帐号绑定到企业后,可以使用 serviceAccountKeys 资源对其进行管理。 |
getStoreLayout |
GET /enterprises/enterpriseId/storeLayout
|
返回企业的商店布局。如果商店布局尚未设置,则返回“basic”作为商店布局类型,而不返回首页。 |
list |
GET /enterprises
|
按域名查找企业。
只有通过 Google 发起的创建流程创建的企业支持此功能。对于通过 EMM 发起的流程创建的企业,无需查询 ID,因为 EMM 通过 Enterprises.generateSignupUrl 调用中指定的回调获取企业 ID。
必需的查询参数: |
pullNotificationSet |
POST /enterprises/pullNotificationSet
|
针对与通过了请求身份验证的服务账号相关联的企业拉取并返回通知集。如果没有待处理的通知,通知集可能为空。
除非通知集为空,否则需要通过调用 Enterprises.AcKnowledgeNotificationSet 在 20 秒内确认返回的通知集。 在 20 秒内未确认的通知最终将重新包含在对另一个 PullNotificationSet 请求的响应中,并且根据 Google Cloud Platform Pub/Sub 系统政策,从未确认的通知最终将被删除。 系统可能会同时执行多个请求来检索通知,在这种情况下,如果有待处理的通知,系统会在每个调用方之间拆分待处理通知(如有)。 如果没有通知,则返回空的通知列表。 后续请求在有通知时可能会返回更多通知。 |
sendTestPushNotification |
POST /enterprises/enterpriseId/sendTestPushNotification
|
发送测试通知,以验证 EMM 与此企业的 Google Cloud Pub/Sub 服务的集成。 |
setAccount |
PUT /enterprises/enterpriseId/account
|
将用于向 API 进行身份验证的帐号设置为企业帐号。 |
setStoreLayout |
PUT /enterprises/enterpriseId/storeLayout
|
为企业设置商店布局。默认情况下,storeLayoutType 设置为“basic”,并且基本商店布局处于启用状态。基本布局仅包含管理员批准的应用,以及已添加到用户可用商品集中(使用 setAvailableProductSet 调用)的应用。页面上的应用会按其商品 ID 值进行排序。如果您创建自定义商店布局(通过将 storeLayoutType 设置为 "custom" 并设置首页),则会停用基本商店布局。 |
取消注册 |
POST /enterprises/enterpriseId/unenroll
|
从发起调用的 EMM 中取消注册企业。 |
使用权
如需详细了解 Entitlements 资源,请参阅资源表示形式页面。
方法 | HTTP 请求 | 说明 |
---|---|---|
除非另有说明,否则 URI 均为 https://www.googleapis.com/androidenterprise/v1 的相对地址 | ||
delete |
DELETE /enterprises/enterpriseId/users/userId/entitlements/entitlementId
|
移除用户对应用的权限。 注意:此项目已弃用。新的集成无法使用此方法,可以参阅我们的 新建议。 |
get |
GET /enterprises/enterpriseId/users/userId/entitlements/entitlementId
|
检索使用权的详细信息。注意:此项目已弃用。新的集成无法使用此方法,可以参阅我们的 新建议。 |
list |
GET /enterprises/enterpriseId/users/userId/entitlements
|
列出指定用户的所有使用权。系统仅设置了 ID。 注意:此项目已弃用。新的集成无法使用此方法,可以参阅我们的 新建议。 |
update |
PUT /enterprises/enterpriseId/users/userId/entitlements/entitlementId
|
为应用添加或更新用户使用权。 注意:此项目已弃用。新的集成无法使用此方法,可以参阅我们的 新建议。 |
群组许可
如需详细了解 Grouplicenses 资源,请参阅资源表示形式页面。
方法 | HTTP 请求 | 说明 |
---|---|---|
除非另有说明,否则 URI 均为 https://www.googleapis.com/androidenterprise/v1 的相对地址 | ||
get |
GET /enterprises/enterpriseId/groupLicenses/groupLicenseId
|
检索产品的企业群组许可详细信息。 注意:此项目已弃用。新的集成无法使用此方法,可以参阅我们的 新建议。 |
list |
GET /enterprises/enterpriseId/groupLicenses
|
检索企业拥有群组许可的所有产品的 ID。注意:此项目已弃用。新的集成无法使用此方法,可以参阅我们的 新建议。 |
群组许可用户
如需详细了解 Grouplicenseusers 资源,请参阅资源表示形式页面。
方法 | HTTP 请求 | 说明 |
---|---|---|
除非另有说明,否则 URI 均为 https://www.googleapis.com/androidenterprise/v1 的相对地址 | ||
list |
GET /enterprises/enterpriseId/groupLicenses/groupLicenseId/users
|
检索已获得许可授权的用户的 ID。注意:此项目已弃用。新的集成无法使用此方法,可以参阅我们的 新建议。 |
安装次数
如需详细了解 Installs 资源,请参阅资源表示形式页面。
方法 | HTTP 请求 | 说明 |
---|---|---|
除非另有说明,否则 URI 均为 https://www.googleapis.com/androidenterprise/v1 的相对地址 | ||
delete |
DELETE /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId
|
请求从设备中移除应用。调用 get 或 list 仍会将该应用显示为已安装在设备上,直到它被实际移除为止。 |
get |
GET /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId
|
检索设备上应用安装的详细信息。 |
list |
GET /enterprises/enterpriseId/users/userId/devices/deviceId/installs
|
检索指定设备上安装的所有应用的详细信息。 |
update |
PUT /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId
|
请求将最新版本的应用安装到设备。如果用户已安装应用,则它会在必要时更新到最新版本。 |
设备的受管理配置
如需详细了解 Managedconfigurationsfordevice 资源,请参阅资源表示形式页面。
方法 | HTTP 请求 | 说明 |
---|---|---|
除非另有说明,否则 URI 均为 https://www.googleapis.com/androidenterprise/v1 的相对地址 | ||
delete |
DELETE /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId
|
针对指定设备移除应用的按设备管理配置。 |
get |
GET /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId
|
检索按设备管理的配置的详细信息。 |
list |
GET /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice
|
列出指定设备的所有按设备管理的配置。 系统仅设置了 ID。 |
update |
PUT /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId
|
为指定设备的应用添加或更新按设备管理的配置。 |
用户的 Managed 配置
如需详细了解 Managedconfigurationsforuser 资源,请参阅资源表示形式页面。
方法 | HTTP 请求 | 说明 |
---|---|---|
除非另有说明,否则 URI 均为 https://www.googleapis.com/androidenterprise/v1 的相对地址 | ||
delete |
DELETE /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId
|
为指定用户移除应用的按用户管理的配置。 |
get |
GET /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId
|
针对指定用户检索应用的按用户管理配置的详细信息。 |
list |
GET /enterprises/enterpriseId/users/userId/managedConfigurationsForUser
|
列出指定用户的所有按用户管理的配置。仅设置了 ID。 |
update |
PUT /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId
|
为指定用户添加或更新应用的受管理配置设置。
如果您支持托管配置 iframe,则可以通过在请求中指定 mcmId 及其关联的配置变量(如果有)将托管配置应用于用户。或者,所有 EMM 都可以通过传递托管属性列表来应用托管配置。 |
Managedconfigurationssettings
如需详细了解 Managedconfigurationssettings 资源,请参阅资源表示形式页面。
方法 | HTTP 请求 | 说明 |
---|---|---|
除非另有说明,否则 URI 均为 https://www.googleapis.com/androidenterprise/v1 的相对地址 | ||
list |
GET /enterprises/enterpriseId/products/productId/managedConfigurationsSettings
|
列出指定应用的所有托管配置设置。 |
权限
有关 Permissions 资源的详细信息,请参阅资源表示形式页面。
方法 | HTTP 请求 | 说明 |
---|---|---|
除非另有说明,否则 URI 均为 https://www.googleapis.com/androidenterprise/v1 的相对地址 | ||
get |
GET /permissions/permissionId
|
检索 Android 应用权限的详细信息,以向企业管理员显示。 |
产品
如需详细了解 Products 资源,请参阅资源表示形式页面。
方法 | HTTP 请求 | 说明 |
---|---|---|
除非另有说明,否则 URI 均为 https://www.googleapis.com/androidenterprise/v1 的相对地址 | ||
批准 |
POST /enterprises/enterpriseId/products/productId/approve
|
批准指定的产品和相关的应用权限(如果有)。 每个企业客户最多可以批准 1,000 个产品。 如需了解如何使用 Google Play 企业版设计和创建商店布局,以向用户展示已获批准的商品,请参阅商店布局设计。 注意:此项目已弃用。新的集成无法使用此方法,可以参阅我们的 新建议。 |
generateApprovalUrl |
POST /enterprises/enterpriseId/products/productId/generateApprovalUrl
|
生成一个可在 iframe 中呈现的网址,以显示商品的权限(如果有)。企业管理员必须查看这些权限并代表其组织接受这些权限,才能批准该产品。 管理员应通过与 EMM 控制台中的单独界面元素互动来接受显示的权限,而后者反过来又应触发在 Products.approve 调用中将此网址用作 approvalUrlInfo.approvalUrl 属性来批准产品。
此网址只能用于显示最多 1 天的权限。
注意:此项目已弃用。新的集成无法使用此方法,可以参阅我们的 新建议。 |
get |
GET /enterprises/enterpriseId/products/productId
|
检索要显示给企业管理员的产品详细信息。 |
getAppRestrictionsSchema |
GET /enterprises/enterpriseId/products/productId/appRestrictionsSchema
|
检索定义了该产品的可配置属性的架构。所有产品都有架构,但如果未定义托管配置,此架构可能为空。此架构可用于填充可让管理员配置产品的界面。如需根据使用此 API 获取的架构应用托管配置,请参阅通过 Play 获取托管配置。 |
getPermissions |
GET /enterprises/enterpriseId/products/productId/permissions
|
检索此应用所需的 Android 应用权限。 |
list |
GET /enterprises/enterpriseId/products
|
查找与查询匹配的获批商品,如果没有查询,则查找所有已获批准的商品。注意:此项目已弃用。新的集成无法使用此方法,可以参阅我们的 新建议。 |
取消批准 |
POST /enterprises/enterpriseId/products/productId/unapprove
|
取消批准指定的商品(以及相关的应用权限,如果有) 注意:此项已弃用。新的集成无法使用此方法,可以参阅我们的 新建议。 |
服务帐号密钥
如需详细了解 Serviceaccountkeys 资源,请参阅资源表示形式页面。
方法 | HTTP 请求 | 说明 |
---|---|---|
除非另有说明,否则 URI 均为 https://www.googleapis.com/androidenterprise/v1 的相对地址 | ||
delete |
DELETE /enterprises/enterpriseId/serviceAccountKeys/keyId
|
移除与此企业关联的服务帐号的指定凭据并使指定凭据失效。调用服务帐号必须已通过调用 Enterprises.GetServiceAccount 检索,且必须已通过调用 Enterprises.SetAccount 设置为企业服务帐号。 |
插入 |
POST /enterprises/enterpriseId/serviceAccountKeys
|
为与此企业关联的服务账号生成新凭据。发起调用的服务帐号必须已通过调用 Enterprises.GetServiceAccount 进行检索,且必须已通过调用 Enterprises.SetAccount 设置为企业服务帐号。 在要插入的资源中应仅填充密钥的类型。 |
list |
GET /enterprises/enterpriseId/serviceAccountKeys
|
列出与此企业关联的服务账号的所有有效凭据。系统仅返回 ID 和密钥类型。调用服务帐号必须已通过调用 Enterprises.GetServiceAccount 检索,且必须已通过调用 Enterprises.SetAccount 设置为企业服务帐号。 |
Storelayoutclusters
如需详细了解 Storelayoutclusters 资源,请参阅资源表示形式页面。
方法 | HTTP 请求 | 说明 |
---|---|---|
除非另有说明,否则 URI 均为 https://www.googleapis.com/androidenterprise/v1 的相对地址 | ||
delete |
DELETE /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId
|
删除集群。 注意:此项目已废弃。新的集成无法使用此方法,可以参阅我们的 新建议。 |
get |
GET /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId
|
检索集群的详细信息。 注意:此项目已废弃。新的集成无法使用此方法,可以参阅我们的 新建议。 |
插入 |
POST /enterprises/enterpriseId/storeLayout/pages/pageId/clusters
|
在页面中插入新集群。 注意:此项目已废弃。新的集成无法使用此方法,可以参阅我们的 新建议。 |
list |
GET /enterprises/enterpriseId/storeLayout/pages/pageId/clusters
|
检索指定页面上所有集群的详细信息。 注意:此项目已废弃。新的集成无法使用此方法,可以参阅我们的 新建议。 |
update |
PUT /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId
|
更新集群。 注意:此项目已废弃。新的集成无法使用此方法,可以参阅我们的 新建议。 |
商店布局页面
如需详细了解 Storelayoutpages 资源,请参阅资源表示形式页面。
方法 | HTTP 请求 | 说明 |
---|---|---|
除非另有说明,否则 URI 均为 https://www.googleapis.com/androidenterprise/v1 的相对地址 | ||
delete |
DELETE /enterprises/enterpriseId/storeLayout/pages/pageId
|
删除商店页面。 注意:此项目已废弃。新的集成无法使用此方法,可以参阅我们的 新建议。 |
get |
GET /enterprises/enterpriseId/storeLayout/pages/pageId
|
检索存储页面的详细信息。 注意:此项目已废弃。新的集成无法使用此方法,可以参阅我们的 新建议。 |
插入 |
POST /enterprises/enterpriseId/storeLayout/pages
|
插入新的商店页面。 注意:此项目已废弃。新的集成无法使用此方法,可以参阅我们的 新建议。 |
list |
GET /enterprises/enterpriseId/storeLayout/pages
|
检索存储区中所有页面的详细信息。 注意:此项目已废弃。新的集成无法使用此方法,可以参阅我们的 新建议。 |
update |
PUT /enterprises/enterpriseId/storeLayout/pages/pageId
|
更新商店页面的内容。 注意:此项目已废弃。新的集成无法使用此方法,可以参阅我们的 新建议。 |
用户
如需详细了解 Users 资源,请参阅资源表示形式页面。
方法 | HTTP 请求 | 说明 |
---|---|---|
除非另有说明,否则 URI 均为 https://www.googleapis.com/androidenterprise/v1 的相对地址 | ||
delete |
DELETE /enterprises/enterpriseId/users/userId
|
删除了由 EMM 管理的用户。 |
generateAuthenticationToken |
POST /enterprises/enterpriseId/users/userId/authenticationToken
|
生成一个身份验证令牌,设备政策客户端可以使用该令牌在设备上预配指定的 EMM 管理的用户帐号。生成的令牌是一次性令牌,将在几分钟后过期。 您最多可以为每位用户配置 10 台设备。 此通话仅适用于 EMM 管理的帐号。 |
get |
GET /enterprises/enterpriseId/users/userId
|
检索用户的详细信息。 |
getAvailableProductSet |
GET /enterprises/enterpriseId/users/userId/availableProductSet
|
检索用户有权访问的一组产品。注意:此项目已弃用。新的集成无法使用此方法,可以参阅我们的 新建议。 |
插入 |
POST /enterprises/enterpriseId/users
|
创建由 EMM 管理的新用户。
在请求正文中传递的 Users 资源应包含 accountIdentifier 和 accountType 。
如果已存在具有相同帐号标识符的对应用户,系统将使用该资源更新该用户。在这种情况下,只能更改 |
list |
GET /enterprises/enterpriseId/users
|
按主电子邮件地址查找用户。
只有由 Google 管理的用户支持此功能。对于由 EMM 管理的用户,无需查找该 ID,因为 User-insert 调用的结果中已返回该 ID。
必需的查询参数: |
revokeDeviceAccess |
DELETE /enterprises/enterpriseId/users/userId/deviceAccess
|
撤消用户当前配置的所有设备的访问权限。用户将无法再在其任何受管理的设备上使用 Google Play 企业版商店。 此通话仅适用于 EMM 管理的帐号。 |
setAvailableProductSet |
PUT /enterprises/enterpriseId/users/userId/availableProductSet
|
修改用户有权访问的一组商品(称为列入白名单的商品)whitelisted。只有已获批准或之前已获批准的商品(获得批准的商品已撤消)才能列入白名单。 注意:此项目已弃用。新的集成无法使用此方法,可以参阅我们的 新建议。 |
update |
PUT /enterprises/enterpriseId/users/userId
|
更新由 EMM 管理的用户的详细信息。 仅适用于由 EMM 管理的用户(不适用于由 Google 管理的用户)。在请求正文的 Users 资源中传递新详细信息。只能更改 displayName 字段。其他字段必须未设置或具有当前活跃值。 |
Web 应用
如需详细了解 Webapps 资源,请参阅资源表示形式页面。
方法 | HTTP 请求 | 说明 |
---|---|---|
除非另有说明,否则 URI 均为 https://www.googleapis.com/androidenterprise/v1 的相对地址 | ||
delete |
DELETE /enterprises/enterpriseId/webApps/webAppId
|
删除现有 Web 应用。 |
get |
GET /enterprises/enterpriseId/webApps/webAppId
|
获取现有 Web 应用。 |
插入 |
POST /enterprises/enterpriseId/webApps
|
为企业创建新的 Web 应用。 |
list |
GET /enterprises/enterpriseId/webApps
|
检索指定企业的所有 Web 应用的详细信息。 |
update |
PUT /enterprises/enterpriseId/webApps/webAppId
|
更新现有 Web 应用。 |