Enterprises

有关此类资源的方法列表,请参阅本页面的结尾部分。

资源表示形式

Enterprises 资源表示 EMM 与特定组织之间的绑定。可以使用此 API 通过以下两种不同的方式实例化该绑定:

  • 对于 Google 管理的网域的客户,此流程涉及使用 Enterprises.enrollEnterprises.setAccount(与从管理控制台和 Google API 控制台获得的制品结合使用),并通过或多或少的手动流程提交给 EMM。
  • 对于受管理的 Google Play 账号客户,该流程涉及将 Enterprises.generateSignupUrlEnterprises.completeSignup 与受管理的 Google Play 注册界面(Google 提供的机制)结合使用,以创建绑定,而无需手动操作。
作为 EMM,您可以在 EMM 控制台中支持这两种方法中的一种或同时支持这两种方法。如需了解详情,请参阅创建企业

{
  "kind": "androidenterprise#enterprise",
  "id": string,
  "primaryDomain": string,
  "name": string,
  "administrator": [
    {
      "email": string
    }
  ],
  "googleAuthenticationSettings": {
    "googleAuthenticationRequired": string,
    "dedicatedDevicesAllowed": string,
    "createdAt": {
      "seconds": long,
      "nanos": integer
    },
    "updatedAt": {
      "seconds": long,
      "nanos": integer
    }
  },
  "enterpriseType": string,
  "managedGoogleDomainType": string
}
属性名称 说明 备注
administrator[] list 企业管理员。仅支持通过 EMM 启动的流程创建的企业。

administrator[].email string 管理员的电子邮件地址。
enterpriseType string 企业的类型。

可接受的值包括:
  • enterpriseTypeUnspecified
  • managedGoogleDomain
  • managedGooglePlayAccountsEnterprise
googleAuthenticationSettings nested object Google 提供的用户身份验证的设置。
googleAuthenticationSettings.createdAt nested object 设置首次创建或修改时的时间戳。
googleAuthenticationSettings.createdAt.nanos integer 秒的非负分数(纳秒精度)。对于含小数部分的负秒数,仍必须包含按时间递升的非负纳秒值。必须介于 0 到 999999999 之间(含边界值)。
googleAuthenticationSettings.createdAt.seconds long 表示从 Unix epoch (1970-01-01T00:00:00Z) 起算的秒数,采用世界协调时间 (UTC)。必须介于 0001-01-01T00:00:00Z 到 9999-12-31T23:59:59Z 之间(含边界值)。
googleAuthenticationSettings.dedicatedDevicesAllowed string 是否允许使用专用设备。

可接受的值包括:
  • allowed
  • dedicatedDevicesAllowedUnspecified
  • disallowed
googleAuthenticationSettings.googleAuthenticationRequired string 是否需要 Google 身份验证。

可接受的值包括:
  • googleAuthenticationRequiredUnspecified
  • notRequired
  • required
googleAuthenticationSettings.updatedAt nested object 设置上次修改时的时间戳。
googleAuthenticationSettings.updatedAt.nanos integer 秒的非负分数(纳秒精度)。对于含小数部分的负秒数,仍必须包含按时间递升的非负纳秒值。必须介于 0 到 999999999 之间(含边界值)。
googleAuthenticationSettings.updatedAt.seconds long 表示从 Unix epoch (1970-01-01T00:00:00Z) 起算的秒数,采用世界协调时间 (UTC)。必须介于 0001-01-01T00:00:00Z 到 9999-12-31T23:59:59Z 之间(含边界值)。
id string 企业的唯一 ID。

id string 企业的唯一 ID。

kind string
managedGoogleDomainType string 受管理的 Google 网域的类型

可接受的值为:
  • managedGoogleDomainTypeUnspecified
  • typeDomain
  • typeTeam
name string 企业的名称,例如“Example, Inc”。
primaryDomain string 企业的主域名,例如“example.com”。

方法

acknowledgeNotificationSet
确认从企业收到的通知。PullNotificationSet 可防止后续调用返回相同的通知。
completeSignup
通过指定完成令牌和企业令牌来完成注册流程。 对于给定的企业令牌,不得多次调用此请求。
createWebToken
返回用于访问可嵌入界面的唯一令牌。如需生成 Web 界面,请将生成的令牌传递到 Google Play 企业版 JavaScript API 中。每个令牌只能用于启动一个界面会话。如需了解详情,请参阅 JavaScript API 文档
enroll
使用调用 EMM 注册企业。
generateEnterpriseUpgradeUrl
生成企业升级网址,以将现有的 Google Play 企业版账号集升级为 Google 企业版域名。 如需了解详情,请参阅 企业升级指南
generateSignupUrl
生成注册网址。
get
检索企业的名称和网域。
getServiceAccount
返回服务账号和凭据。通过调用 setAccount,可以将服务账号绑定到企业。此服务账号是相应企业和 EMM 独有的,如果企业解除绑定,此服务账号将被删除。凭据包含私钥数据,不会存储在服务器端。

此方法只能在调用 Enterprises.Enroll 或 Enterprises.CompleteSignup 之后、调用 Enterprises.SetAccount 之前调用;在其他时间调用此方法会返回错误。

首次调用之后进行的后续调用将生成一组新的唯一凭据,并使之前生成的凭据失效。

将服务账号绑定到企业后,可以使用 serviceAccountKeys 资源对其进行管理。

getStoreLayout
返回企业的商店布局。如果商店布局尚未设置,则返回“基本”作为商店布局类型,并且不返回首页。
list
按域名查找企业。 仅支持通过 Google 发起的创建流程创建的企业。对于通过 EMM 发起的流程创建的企业,无需查找 ID,因为 EMM 会在 Enterprises.generateSignupUrl 调用中指定的回调中了解企业 ID。
pullNotificationSet
拉取并返回与已通过身份验证的服务账号关联的企业的一组通知。如果没有待处理的通知,通知集可能为空。
返回的通知集需要在 20 秒内通过调用 Enterprises.AcknowledgeNotificationSet 进行确认,除非通知集为空。
未在 20 秒内确认的通知最终会再次包含在对另一个 PullNotificationSet 请求的响应中,而从未确认的通知最终会根据 Google Cloud Platform Pub/Sub 系统政策被删除。
可能会同时执行多个请求来检索通知,在这种情况下,待处理的通知(如果有)将拆分给每个调用方(如果有)。
如果没有通知,则返回一个空的通知列表。 后续请求可能会在通知可用时返回更多通知。
sendTestPushNotification
发送测试通知,以验证 EMM 与相应企业的 Google Cloud Pub/Sub 服务的集成。
setAccount
将用于向 API 进行身份验证的账号设置为企业账号。
setStoreLayout
为企业设置商店布局。默认情况下,storeLayoutType 设置为“basic”,并且基本商店布局处于启用状态。基本布局仅包含管理员批准并已添加到用户可用产品集中的应用(使用 setAvailableProductSet 调用)。页面上的应用按其商品 ID 值排序。如果您创建自定义商店布局(通过设置 storeLayoutType = "custom" 并设置首页),则基本商店布局会被停用。
退订
从调用 EMM 中取消注册企业。