如需了解此资源的方法列表,请参阅本页结尾部分。
资源表示形式
Enterprises 资源表示 EMM 与特定组织之间的绑定关系。可以使用此 API 通过以下两种不同方式之一实例化该绑定,如下所示:
- 对于由 Google 管理的网域客户,该流程包括使用
Enterprises.enroll
和Enterprises.setAccount
(以及从管理控制台和 Google API 控制台获取的工件),并通过或多或少的手动流程将其提交到 EMM。 - 对于 Google Play 企业版客户,此过程涉及使用
Enterprises.generateSignupUrl
和Enterprises.completeSignup
与 Google Play 企业版注册界面(Google 提供的机制)进行绑定,而无需手动操作。
{ "kind": "androidenterprise#enterprise", "id": string, "primaryDomain": string, "name": string, "administrator": [ { "email": string } ] }
属性名称 | 值 | 说明 | 备注 |
---|---|---|---|
administrator[] |
list |
企业管理员。只有通过 EMM 发起的流程创建的企业才支持此功能。 |
|
administrator[].email |
string |
管理员的电子邮件地址。 | |
id |
string |
企业的唯一 ID。 |
|
kind |
string |
||
name |
string |
企业的名称,例如“Example, Inc”。 | |
primaryDomain |
string |
企业的主域名,例如“example.com”。 |
方法
- acknowledgeNotificationSet
- 确认从 Enterprises.PullNotificationSet 收到的通知,以防止后续调用返回相同的通知。
- completeSignup
- 通过指定完成令牌和企业令牌来完成注册流程。对于给定的企业令牌,不得多次调用此请求。
- createWebToken
- 返回用于访问可嵌入界面的唯一令牌。如需生成网页界面,请将生成的令牌传递到 Google Play 企业版 JavaScript API。每个令牌只能用于启动一个界面会话。如需了解详情,请参阅 JavaScript API 文档。
- 注册
- 为企业注册调用方 EMM。
- generateSignupUrl
- 生成注册网址。
- get
- 检索企业的名称和域名。
- getServiceAccount
- 返回服务帐号和凭据。该服务帐号可通过调用 setAccount 与企业绑定。该服务帐号在此企业和 EMM 中是唯一的,如果该企业未绑定,则该服务帐号将被删除。凭据包含私钥数据,不会存储在服务器端。
此方法只能在调用 Enterprises.registered 或 Enterprises.CompleteSignup 之后、Enterprises.SetAccount 之前调用,其他时候会返回错误。
在第一次调用之后的后续调用将生成一组唯一的新凭据,并使之前生成的凭据失效。
将服务帐号绑定到企业后,可以使用 serviceAccountKeys 资源对其进行管理。 - getStoreLayout
- 返回企业的商店布局。如果商店布局尚未设置,则返回“basic”作为商店布局类型,而不返回首页。
- list
- 按域名查找企业。 只有通过 Google 发起的创建流程创建的企业支持此功能。对于通过 EMM 发起的流程创建的企业,无需查询 ID,因为 EMM 通过 Enterprises.generateSignupUrl 调用中指定的回调获取企业 ID。
- pullNotificationSet
- 针对与通过请求进行身份验证的服务帐号相关联的企业拉取并返回通知集。如果没有待处理的通知,通知集可能为空。
除非通知集为空,否则需要通过调用 Enterprises.AcKnowledgeNotificationSet 在 20 秒内确认返回的通知集。
在 20 秒内未确认的通知最终将重新包含在对另一个 PullNotificationSet 请求的响应中,并且根据 Google Cloud Platform Pub/Sub 系统政策,从未确认的通知最终将被删除。
系统可能会同时执行多个请求来检索通知,在这种情况下,如果有待处理的通知,系统会在每个调用方之间拆分待处理通知(如有)。
如果没有通知,则返回空的通知列表。 后续请求在有可用的通知后可能会返回更多通知。 - sendTestPushNotification
- 发送测试通知,以验证 EMM 与此企业的 Google Cloud Pub/Sub 服务的集成。
- setAccount
- 将用于向 API 进行身份验证的帐号设置为企业帐号。
- setStoreLayout
- 为企业设置商店布局。默认情况下,storeLayoutType 设置为“basic”,并且基本商店布局处于启用状态。基本布局仅包含管理员批准的应用,以及已添加到用户可用商品集中(使用 setAvailableProductSet 调用)的应用。页面上的应用会按其商品 ID 值进行排序。如果您创建自定义商店布局(通过将 storeLayoutType 设置为 "custom" 并设置首页),则会停用基本商店布局。
- 取消注册
- 为企业取消注册调用的 EMM。