如需本資源的方法清單,請見本頁結尾。
資源表示法
Enterprise 資源代表 EMM 與特定機構之間的繫結。您可以使用這個 API,透過下列兩種不同方式之一,例項化該繫結:
- 如果是 Google 管理的網域客戶,則須使用
Enterprises.enroll
和Enterprises.setAccount
(搭配從管理控制台和 Google API 控制台取得的構件),並透過手動程序提交至 EMM。 - 對於 Google Play 管理版帳戶客戶,這項程序需要搭配使用
Enterprises.generateSignupUrl
和Enterprises.completeSignup
,以及 Google Play 管理版註冊 UI (Google 提供的機制),才能建立繫結,不必手動操作。
{ "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 |
企業類型。
可接受的值如下:
|
|
googleAuthenticationSettings |
nested object |
Google 提供的使用者驗證設定。 | |
googleAuthenticationSettings.createdAt |
nested object |
首次建立或修改設定的時間戳記。 | |
googleAuthenticationSettings.createdAt.nanos |
integer |
以奈秒為單位的非負秒數小數。如果秒數值為負數,且包含小數,奈秒值仍須為非負數,且會向前計時。值必須介於 0 到 999,999,999 之間 (含)。 | |
googleAuthenticationSettings.createdAt.seconds |
long |
代表自 Unix 紀元 1970-01-01T00:00:00Z 起算的世界標準時間秒數。必須介於 0001-01-01T00:00:00Z 到 9999-12-31T23:59:59Z (含) 之間。 | |
googleAuthenticationSettings.dedicatedDevicesAllowed |
string |
是否允許專用裝置。
可接受的值如下:
|
|
googleAuthenticationSettings.googleAuthenticationRequired |
string |
是否需要 Google 驗證。
可接受的值如下:
|
|
googleAuthenticationSettings.updatedAt |
nested object |
上次修改設定的時間戳記。 | |
googleAuthenticationSettings.updatedAt.nanos |
integer |
以奈秒為單位的非負秒數小數。如果秒數值為負數,且包含小數,奈秒值仍須為非負數,且會向前計時。值必須介於 0 到 999,999,999 之間 (含)。 | |
googleAuthenticationSettings.updatedAt.seconds |
long |
代表自 Unix 紀元 1970-01-01T00:00:00Z 起算的世界標準時間秒數。必須介於 0001-01-01T00:00:00Z 到 9999-12-31T23:59:59Z (含) 之間。 | |
id |
string |
企業的專屬 ID。 |
|
id |
string |
企業的專屬 ID。 |
|
kind |
string |
||
managedGoogleDomainType |
string |
受管理 Google 網域的類型
可接受的值如下:
|
|
name |
string |
企業名稱,例如「Example, Inc」。 | |
primaryDomain |
string |
企業的主要網域,例如「example.com」。 |
方法
- acknowledgeNotificationSet
- 確認從企業收到的通知。提取通知集,防止後續呼叫傳回相同通知。
- completeSignup
- 指定完成權杖和企業權杖,完成註冊流程。針對特定企業權杖,不得多次呼叫這項要求。
- createWebToken
- 傳回可存取可嵌入式 UI 的專屬權杖。如要產生網頁 UI,請將產生的權杖傳遞至 Google Play 管理版 JavaScript API。每個權杖只能用來啟動一個 UI 工作階段。詳情請參閱 JavaScript API 說明文件。
- enroll
- 向呼叫 EMM 註冊企業。
- generateEnterpriseUpgradeUrl
- 產生企業升級網址,將現有的 Google Play 管理版帳戶企業升級為受管理 Google 網域。詳情請參閱 企業升級指南。
- generateSignupUrl
- 產生註冊網址。
- get
- 擷取企業的名稱和網域。
- getServiceAccount
- 傳回服務帳戶和憑證。您可以呼叫 setAccount,將服務帳戶繫結至企業。這個服務帳戶是專為這個企業和 EMM 建立,如果取消繫結企業,系統就會刪除這個帳戶。憑證包含私密金鑰資料,且不會儲存在伺服器端。
這個方法只能在呼叫 Enterprises.Enroll 或 Enterprises.CompleteSignup 之後,以及呼叫 Enterprises.SetAccount 之前呼叫;在其他時間呼叫則會傳回錯誤。
第一次呼叫後,後續呼叫會產生一組新的專屬憑證,並使先前產生的憑證失效。
服務帳戶與企業繫結後,即可使用 serviceAccountKeys 資源進行管理。
. - getStoreLayout
- 傳回企業的商店版面配置。如果商店版面配置尚未設定,則會傳回「基本」做為商店版面配置類型,且沒有首頁。
- list
- :依網域名稱查詢企業。 這項功能僅適用於透過 Google 發起的建立流程建立的企業。透過 EMM 啟動的流程建立企業時,EMM 會在 Enterprises.generateSignupUrl 呼叫中指定的回呼中瞭解企業 ID,因此不需要查閱 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。