API Reference

此 API 参考资料按资源类型编排整理。每种资源类型都有一种或多种数据表示形式以及一个或多个方法。

资源类型

  1. <ph type="x-smartling-placeholder"></ph> 设备
  2. <ph type="x-smartling-placeholder"></ph> 企业
  3. <ph type="x-smartling-placeholder"></ph> 使用权
  4. <ph type="x-smartling-placeholder"></ph> 群组许可
  5. <ph type="x-smartling-placeholder"></ph> 群组许可用户
  6. <ph type="x-smartling-placeholder"></ph> 安装次数
  7. <ph type="x-smartling-placeholder"></ph> Managedconfigurationsfordevice
  8. <ph type="x-smartling-placeholder"></ph> 用户的受管配置
  9. <ph type="x-smartling-placeholder"></ph> Managedconfigurationssettings
  10. <ph type="x-smartling-placeholder"></ph> 权限
  11. <ph type="x-smartling-placeholder"></ph> 产品
  12. <ph type="x-smartling-placeholder"></ph> Serviceaccountkeys
  13. <ph type="x-smartling-placeholder"></ph> 商店布局集群
  14. <ph type="x-smartling-placeholder"></ph> Storelayoutpages
  15. <ph type="x-smartling-placeholder"></ph> 用户
  16. <ph type="x-smartling-placeholder"></ph> Web 应用

设备

如需详细了解设备资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则将使用相对于 https://www.googleapis.com/androidenterprise/v1 的 URI
forceReportUpload POST  /enterprises/enterpriseId/users/userId/devices/deviceId/forceReportUpload 上传一份报告，其中包含自以下时间以来设备上应用状态发生的任何变化： 上次生成的报告您每次最多可调用此方法 3 次 对于给定设备而言，为 24 小时。
get GET  /enterprises/enterpriseId/users/userId/devices/deviceId 检索设备的详细信息。
getState GET  /enterprises/enterpriseId/users/userId/devices/deviceId/state 检索设备对 Google 服务的访问权限是已启用还是 已停用。 只有在 Android 设备上强制执行 EMM 政策时，设备状态才会生效 设备在 Google 管理控制台中启用。 否则，系统会忽略设备状态，并允许所有设备访问 Google 服务。 只有由 Google 管理的用户支持此设置。
list GET  /enterprises/enterpriseId/users/userId/devices 检索用户所有设备的 ID。
setState PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/state 设置是启用或停用设备对 Google 服务的访问权限。 只有在 Android 设备上强制执行 EMM 政策时，设备状态才会生效 设备在 Google 管理控制台中启用。 否则，系统会忽略设备状态，并允许所有设备访问 Google 服务。 只有由 Google 管理的用户支持此设置。
update PUT  /enterprises/enterpriseId/users/userId/devices/deviceId 更新设备政策。

为确保正确实施此政策，您需要防止 访问 Google Play，方法是设置 allowed_accounts Google Play 软件包。请参阅限制 账号。

企业

如需详细了解 Enterprises 资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则将使用相对于 https://www.googleapis.com/androidenterprise/v1 的 URI
acknowledgeNotificationSet POST  /enterprises/acknowledgeNotificationSet 确认从以下设备收到的通知： Enterprises.PullNotificationSet 来防止返回后续调用 相同的通知
completeSignup POST  /enterprises/completeSignup 通过指定完成令牌和 企业令牌。 对于给定的企业，不得多次调用此请求 令牌。
createWebToken POST  /enterprises/enterpriseId/createWebToken 返回用于访问嵌入式界面的唯一令牌。要生成 网页界面，将生成的令牌传递到 Google Play 企业版 JavaScript API。每个令牌只能用于启动一个界面会话。请参阅 <ph type="x-smartling-placeholder"></ph> JavaScript API 文档了解详情。
注册 POST  /enterprises/enroll 向发起调用的 EMM 注册企业。

必需的查询参数： token
generateSignupUrl POST  /enterprises/signupUrl 生成注册网址。
get GET  /enterprises/enterpriseId 检索企业的名称和域名。
getServiceAccount GET  /enterprises/enterpriseId/serviceAccount 返回服务账号和凭据。服务账号 可以通过调用 setAccount 绑定到该企业服务账号 专属于此企业和 EMM，如果企业 没有绑定凭据包含私钥数据，未存储 。
（
） 此方法只能在调用 Enterprises.enroll 或 Enterprises.CompleteSignup 及之前 Enterprises.SetAccount;但有时会返回错误。
（
） 在第一次调用之后的后续调用将生成一组新的唯一 并使之前生成的凭据失效。
（
） 服务账号绑定到企业账号后，即可对其进行管理 直接使用 serviceAccountKeys 资源。
getStoreLayout GET  /enterprises/enterpriseId/storeLayout 返回企业的商店布局。如果商店布局 尚未设置，则返回“basic”作为商店布局类型， 首页。
list GET  /enterprises 按域名查找企业。 只有通过 Google 发起的 创建流程通过 由于 EMM 在 2023 年 3 月 8 日之前学习了 （在 Enterprises.generateSignupUrl 调用中指定的回调）。

必需的查询参数： domain
pullNotificationSet POST  /enterprises/pullNotificationSet 拉取并返回为以下对象关联的企业所设置的通知： 针对请求进行身份验证的服务账号。通知集可能会 为空。
返回的通知集需要在 20 秒内确认 （除非调用 Enterprises.AcknowledgeNotificationSet） 通知设置为空。
如果您未在 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”并且已启用基本商店布局基本功能 布局仅包含已由管理员批准的应用，且这些应用 添加到用户的可用商品集（使用 <ph type="x-smartling-placeholder"></ph> setAvailableProductSet 调用中）。页面上的应用会按 产品 ID 值。如果您通过设置 storeLayoutType = "custom"和设置首页）， 已停用。
取消注册 POST  /enterprises/enterpriseId/unenroll 从发起调用的 EMM 中取消注册企业。

使用权

如需详细了解 Entitlements 资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则将使用相对于 https://www.googleapis.com/androidenterprise/v1 的 URI
delete DELETE  /enterprises/enterpriseId/users/userId/entitlements/entitlementId <ph type="x-smartling-placeholder"> 移除用户对某个应用的使用权。
get GET  /enterprises/enterpriseId/users/userId/entitlements/entitlementId <ph type="x-smartling-placeholder"> 检索使用权的详细信息。
list GET  /enterprises/enterpriseId/users/userId/entitlements <ph type="x-smartling-placeholder"> 列出指定用户的所有使用权。仅会设置 ID。
update PUT  /enterprises/enterpriseId/users/userId/entitlements/entitlementId <ph type="x-smartling-placeholder"> 为用户添加或更新应用使用权。

群组许可

如需详细了解 Grouplicenses 资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则将使用相对于 https://www.googleapis.com/androidenterprise/v1 的 URI
get GET  /enterprises/enterpriseId/groupLicenses/groupLicenseId <ph type="x-smartling-placeholder"> 检索某个产品的企业群组许可详细信息。
list GET  /enterprises/enterpriseId/groupLicenses <ph type="x-smartling-placeholder"> 检索企业拥有群组许可的所有产品的 ID。

群组许可用户

如需详细了解 Grouplicenseusers 资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则将使用相对于 https://www.googleapis.com/androidenterprise/v1 的 URI
list GET  /enterprises/enterpriseId/groupLicenses/groupLicenseId/users <ph type="x-smartling-placeholder"> 检索已被授予使用权的用户的 ID 。

安装次数

如需详细了解 Installs 资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则将使用相对于 https://www.googleapis.com/androidenterprise/v1 的 URI
delete DELETE  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId 从设备中移除应用的请求。对 get 或 “list”仍会将该应用显示为已安装在设备上，直到 它实际上已被移除
get GET  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId <ph type="x-smartling-placeholder"> 检索应用安装在设备上的详细信息。
list GET  /enterprises/enterpriseId/users/userId/devices/deviceId/installs <ph type="x-smartling-placeholder"> 检索指定设备上安装的所有应用的详细信息。
update PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId <ph type="x-smartling-placeholder"> 请求将最新版应用安装到设备上。如果应用 如果已安装，则更新到最新版本 。

Managedconfigurationsfordevice

如需详细了解 Managedconfigurationsfordevice 资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则将使用相对于 https://www.googleapis.com/androidenterprise/v1 的 URI
delete DELETE  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId <ph type="x-smartling-placeholder"> 针对指定 设备。
get GET  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId <ph type="x-smartling-placeholder"> 检索每台设备的受管配置的详细信息。
list GET  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice <ph type="x-smartling-placeholder"> 列出指定设备的所有单一设备受管配置。 仅会设置 ID。
update PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId <ph type="x-smartling-placeholder"> 为某个应用添加或更新按设备管理的 指定设备。

用户的受管配置

如需详细了解 Managedconfigurationsforuser 资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则将使用相对于 https://www.googleapis.com/androidenterprise/v1 的 URI
delete DELETE  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId <ph type="x-smartling-placeholder"> 针对指定 用户。
get GET  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId <ph type="x-smartling-placeholder"> 对于 。
list GET  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser <ph type="x-smartling-placeholder"> 列出指定用户的所有按用户管理的配置。仅限 ID。
update PUT  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId <ph type="x-smartling-placeholder"> 为指定用户添加或更新应用的托管配置设置。 如果您支持托管配置 iframe， 您可以指定 mcmId，将托管配置应用于用户。 及其关联的配置变量（如果有）。或者 通过传递受管配置列表，所有 EMM 都可以应用受管配置 属性。

Managedconfigurationssettings

如需详细了解 Managedconfigurationssettings 资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则将使用相对于 https://www.googleapis.com/androidenterprise/v1 的 URI
list GET  /enterprises/enterpriseId/products/productId/managedConfigurationsSettings 列出指定应用的所有托管配置设置。

Permissions

有关 Permissions 资源的详细信息，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则将使用相对于 https://www.googleapis.com/androidenterprise/v1 的 URI
get GET  /permissions/permissionId 检索 Android 应用权限的详细信息，以便向企业管理员显示。

产品

如需详细了解 Products 资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则将使用相对于 https://www.googleapis.com/androidenterprise/v1 的 URI
批准 POST  /enterprises/enterpriseId/products/productId/approve <ph type="x-smartling-placeholder">

批准指定商品和相关的应用权限（如果有）。 每个企业客户可以批准的产品数量上限 是 1,000。

了解如何使用 Google Play 企业版设计和创建商店 向用户展示获批的商品 请参阅商店布局设计。
generateApprovalUrl POST  /enterprises/enterpriseId/products/productId/generateApprovalUrl <ph type="x-smartling-placeholder"> 生成一个网址，该网址可在 iframe 中呈现以显示 权限（如果有）。企业管理员必须查看这些内容 并代表所属组织接受这些许可， 批准该产品。

管理员应接受显示的权限， 与 EMM 控制台中的单独界面元素互动 应触发将此网址用作 approvalUrlInfo.approvalUrl媒体资源 Products.approve 调用来批准商品。 此网址最多只能用于显示权限 1 天。
get GET  /enterprises/enterpriseId/products/productId 检索要显示给企业管理员的产品详细信息。
getAppRestrictionsSchema GET  /enterprises/enterpriseId/products/productId/appRestrictionsSchema <ph type="x-smartling-placeholder"> 检索定义此对象的可配置属性的架构 产品。所有商品都有对应的架构，但如果没有对应的架构，则此架构可能为空。 都已定义受管配置此架构可用于 填充一个供管理员配置产品的界面。 根据使用此生成的架构应用托管配置 API 的详细信息，请参阅 通过 Play 管理配置。
getPermissions GET  /enterprises/enterpriseId/products/productId/permissions <ph type="x-smartling-placeholder"> 检索此应用所需的 Android 应用权限。
list GET  /enterprises/enterpriseId/products <ph type="x-smartling-placeholder"> 查找与查询匹配的获批商品，或所有已获批准的商品 如果没有查询，则会发生此错误。
取消批准 POST  /enterprises/enterpriseId/products/productId/unapprove <ph type="x-smartling-placeholder"> 取消批准指定商品（以及相关的应用权限，如果有）

Serviceaccountkeys

如需详细了解 Serviceaccountkeys 资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则将使用相对于 https://www.googleapis.com/androidenterprise/v1 的 URI
delete DELETE  /enterprises/enterpriseId/serviceAccountKeys/keyId <ph type="x-smartling-placeholder"> 移除服务账号的指定凭据并使其失效 与此企业相关联。调用服务账号必须是 通过调用 Enterprises.GetServiceAccount 检索的 ID， 将其指定为企业服务账号。
插入 POST  /enterprises/enterpriseId/serviceAccountKeys <ph type="x-smartling-placeholder"> 为与此关联的服务账号生成新凭据 企业。调用方服务账号必须通过调用 Enterprises.GetServiceAccount，并且必须设置为“enterprises” 服务账号。

资源中只应填充键的类型 已插入。
list GET  /enterprises/enterpriseId/serviceAccountKeys <ph type="x-smartling-placeholder"> 列出与此账号关联的服务账号的所有有效凭据 企业。仅返回 ID 和密钥类型。调用服务 必须先通过调用 Enterprises.GetServiceAccount 检索到 Google 账号 并且必须通过调用 Enterprises.SetAccount。

商店布局集群

如需详细了解 Storelayoutclusters 资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则将使用相对于 https://www.googleapis.com/androidenterprise/v1 的 URI
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

如需详细了解 Storelayoutpages 资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则将使用相对于 https://www.googleapis.com/androidenterprise/v1 的 URI
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 更新商店页面的内容。

用户

如需详细了解用户资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则将使用相对于 https://www.googleapis.com/androidenterprise/v1 的 URI
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 <ph type="x-smartling-placeholder"> 检索用户有权访问的一组商品。
插入 POST  /enterprises/enterpriseId/users 创建由 EMM 管理的新用户。

Users 资源 应包括一个 accountIdentifier 和 accountType。

如果已存在具有相同账号标识符的相应用户， 系统就会使用相应资源更新用户在此例中，只有 displayName 字段可以更改。
list GET  /enterprises/enterpriseId/users 按主电子邮件地址查找用户。 只有由 Google 管理的用户支持此设置。ID 的查找结果不是 因为此 ID 已在 调用 Users.insert 调用的结果

必需的查询参数： email
revokeDeviceAccess DELETE  /enterprises/enterpriseId/users/userId/deviceAccess 撤消对目前已配置给用户的设备的访问权限。用户 将无法再在任何计算机上使用 Google Play 企业版商店 受管理的设备

此通话仅支持由 EMM 管理的账号。
setAvailableProductSet PUT  /enterprises/enterpriseId/users/userId/availableProductSet <ph type="x-smartling-placeholder"> 修改用户有权访问的一组产品（称为 列入白名单的商品）。只有 已批准 或之前获得批准的商品（审批结果被撤消的商品） 可以列入白名单。
update PUT  /enterprises/enterpriseId/users/userId 更新由 EMM 管理的用户的详细信息。

只能与受 EMM 管理的用户（而非 Google 管理的用户）搭配使用。 在 用户 添加相应的资源仅 displayName 字段 可以更改其他字段必须取消设置或使用 当前有效值。

Web 应用

如需详细了解 Webapps 资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则将使用相对于 https://www.googleapis.com/androidenterprise/v1 的 URI
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 应用。