如需本資源的方法清單,請見本頁結尾。
資源表示法
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 } ], "enterpriseType":string , "managedGoogleDomainType":string }
屬性名稱 | 值 | 說明 | 附註 |
---|---|---|---|
administrator[] |
list |
企業管理員。這項功能僅適用於透過 EMM 啟動的流程建立的企業。 |
|
administrator[].email |
string |
管理員的電子郵件地址。 | |
enterpriseType |
string |
企業類型。 可接受的值如下:
|
|
id |
string |
企業的專屬 ID。 |
|
kind |
string |
||
managedGoogleDomainType |
string |
受管理 Google 網域的類型
可接受的值:
|
|
name |
string |
企業名稱,例如「Example, Inc」。 | |
primaryDomain |
string |
企業的主網域,例如「example.com」。 |
方法
- acknowledgeNotificationSet
- 確認從 Enterprise.PullNotificationSet 收到的通知,以免後續呼叫傳回相同的通知。
- completeSignup
- 指定完成權杖和企業權杖,完成註冊流程。請勿針對特定企業權杖多次呼叫這項要求。
- createWebToken
- 傳回專屬權杖,用於存取可嵌入的 UI。如要產生網頁 UI,請將產生的權杖傳遞至受管理的 Google Play JavaScript API。每個權杖只能用於啟動一個 UI 工作階段。詳情請參閱 JavaScript API 說明文件。
- enroll
- 透過呼叫的 EMM 註冊企業。
- generateSignupUrl
- 產生註冊網址。
- get
- 擷取企業的名稱和網域。
- getServiceAccount
- 會傳回服務帳戶和憑證。您可以呼叫 setAccount,將服務帳戶繫結至企業。服務帳戶是這家企業和 EMM 專屬,如果企業解除綁定,就會遭到刪除。憑證包含私密金鑰資料,不會儲存在伺服器端。
這個方法只能在呼叫 Enterprises.Enroll 或 Enterprises.CompleteSignup 後,以及 Enterprise.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 取消註冊企業。