本 API 參考資料是依照資源類型編排。各個資源類型都具有一或多種資料表示法，以及一或多種方法。
資源類型
- 裝置
- Enrollmenttokens
- 企業
- 授權
- Grouplicenses
- Grouplicenseusers
- 安裝次數
- 裝置的受管理設定
- Managedconfigurationsforuser
- 受管理的設定
- 權限
- 產品
- Serviceaccountkeys
- Storelayoutclusters
- Storelayoutpages
- 使用者
- Webapps
裝置
如需裝置資源的詳細資料，請參閱資源表示法頁面。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 除非另有註明，否則 URI 皆與 https://www.googleapis.com/androidenterprise/v1 相關 | ||
| forceReportUpload |
POST /enterprises/enterpriseId/users/userId/devices/deviceId/forceReportUpload
|
上傳報表，其中包含自上次產生報表以來，裝置上應用程式狀態的任何變更。針對特定裝置，您每 24 小時最多可呼叫這個方法 3 次。 |
| get |
GET /enterprises/enterpriseId/users/userId/devices/deviceId
|
擷取裝置的詳細資料。 |
| getState |
GET /enterprises/enterpriseId/users/userId/devices/deviceId/state
|
擷取裝置對 Google 服務的存取權是否已啟用或停用。只有在 Google 管理控制台中啟用「在 Android 裝置上強制執行 EMM 政策」時，裝置狀態才會生效。否則，系統會忽略裝置狀態，允許所有裝置存取 Google 服務。這項功能僅支援 Google 管理的使用者。 |
| list |
GET /enterprises/enterpriseId/users/userId/devices
|
擷取使用者所有裝置的 ID。 |
| setState |
PUT /enterprises/enterpriseId/users/userId/devices/deviceId/state
|
設定裝置是否啟用或停用 Google 服務存取權。 只有在 Google 管理控制台中啟用「在 Android 裝置上強制執行 EMM 政策」時，裝置狀態才會生效。否則，系統會忽略裝置狀態，允許所有裝置存取 Google 服務。這項功能僅支援 Google 管理的使用者。 |
| 更新 |
PUT /enterprises/enterpriseId/users/userId/devices/deviceId
|
更新裝置政策。
為確保政策能確實執行，您必須在 Google Play 套件的受管理設定中設定 allowed_accounts，禁止非受管理帳戶存取 Google Play。請參閱限制 Google Play 帳戶。
|
Enrollmenttokens
如需 Enrollmenttokens 資源的詳細資料，請參閱資源表示法網頁。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 除非另有註明，否則 URI 皆與 https://www.googleapis.com/androidenterprise/v1 相關 | ||
| create |
POST /enterprises/enterpriseId/enrollmentTokens
|
為企業建立註冊權杖。 這個方法是 EnrollmentTokensService 的一部分。 |
企業
如需 Enterprises 資源的詳細資料，請參閱資源表示法網頁。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 除非另有註明，否則 URI 皆與 https://www.googleapis.com/androidenterprise/v1 相關 | ||
| acknowledgeNotificationSet |
POST /enterprises/acknowledgeNotificationSet
|
確認從企業收到的通知。提取通知集可防止後續呼叫傳回相同通知。 |
| completeSignup |
POST /enterprises/completeSignup
|
指定完成權杖和企業權杖，完成註冊流程。針對特定企業權杖，不得多次呼叫這項要求。 |
| createWebToken |
POST /enterprises/enterpriseId/createWebToken
|
傳回可存取可嵌入式 UI 的專屬權杖。如要產生網頁 UI，請將產生的權杖傳遞至 Google Play 管理版 JavaScript API。每個權杖只能用來啟動一個 UI 工作階段。詳情請參閱 JavaScript API 說明文件。 |
| enroll |
POST /enterprises/enroll
|
向呼叫 EMM 註冊企業。
必要查詢參數：
|
| generateEnterpriseUpgradeUrl |
POST /enterprises/enterpriseId/generateEnterpriseUpgradeUrl
|
產生企業升級網址，將現有的 Google Play 管理版帳戶企業升級為受管理 Google 網域。詳情請參閱 企業升級指南。 |
| 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 啟動的流程建立企業時，不需要查詢 ID，因為 EMM 會在 Enterprises.generateSignupUrl 呼叫中指定的回呼中瞭解企業 ID。
必要查詢參數：
|
| 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」，並啟用基本商店版面配置。基本版面配置只會顯示管理員核准的應用程式，以及已新增至使用者可用產品組合的應用程式 (使用 setAvailableProductSet 呼叫)。頁面上的應用程式會依產品 ID 值排序。如果您建立自訂商店版面配置 (方法是設定 storeLayoutType = "custom" 並設定首頁)，系統會停用基本商店版面配置。 |
| 取消註冊 |
POST /enterprises/enterpriseId/unenroll
|
Unenrolls an enterprise from the calling EMM. |
授權
如需 Entitlements 資源的詳細資料，請參閱資源表示法網頁。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 除非另有註明，否則 URI 皆與 https://www.googleapis.com/androidenterprise/v1 相關 | ||
| delete |
DELETE /enterprises/enterpriseId/users/userId/entitlements/entitlementId
|
移除使用者的應用程式授權。 |
| get |
GET /enterprises/enterpriseId/users/userId/entitlements/entitlementId
|
擷取授權的詳細資料。 |
| list |
GET /enterprises/enterpriseId/users/userId/entitlements
|
列出指定使用者的所有授權。只設定 ID。 |
| 更新 |
PUT /enterprises/enterpriseId/users/userId/entitlements/entitlementId
|
為使用者新增或更新應用程式授權。 |
Grouplicenses
如需 Grouplicenses 資源的詳細資料，請參閱資源表示法網頁。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 除非另有註明，否則 URI 皆與 https://www.googleapis.com/androidenterprise/v1 相關 | ||
| get |
GET /enterprises/enterpriseId/groupLicenses/groupLicenseId
|
擷取企業產品群組授權的詳細資料。 |
| list |
GET /enterprises/enterpriseId/groupLicenses
|
擷取企業擁有群組授權的所有產品 ID。 |
Grouplicenseusers
如需 Grouplicenseusers 資源的詳細資料，請參閱資源表示法網頁。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 除非另有註明，否則 URI 皆與 https://www.googleapis.com/androidenterprise/v1 相關 | ||
| list |
GET /enterprises/enterpriseId/groupLicenses/groupLicenseId/users
|
擷取已獲授權的使用者 ID。 |
安裝次數
如需 Installs 資源的詳細資料，請參閱資源表示法網頁。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 除非另有註明，否則 URI 皆與 https://www.googleapis.com/androidenterprise/v1 相關 | ||
| delete |
DELETE /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId
|
要求從裝置移除應用程式。在實際移除應用程式之前，呼叫 get 或 list 仍會顯示應用程式已安裝在裝置上。
|
| get |
GET /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId
|
擷取裝置上應用程式安裝作業的詳細資料。 |
| list |
GET /enterprises/enterpriseId/users/userId/devices/deviceId/installs
|
擷取指定裝置上安裝的所有應用程式詳細資料。 |
| 更新 |
PUT /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId
|
要求在裝置上安裝最新版應用程式。如果已安裝應用程式，系統會視需要更新至最新版本。 |
Managedconfigurationsfordevice
如需 Managedconfigurationsfordevice 資源的詳細資料，請參閱資源表示法網頁。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 除非另有註明，否則 URI 皆與 https://www.googleapis.com/androidenterprise/v1 相關 | ||
| delete |
DELETE /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId
|
移除指定裝置的應用程式裝置專屬受管理設定。 |
| get |
GET /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId
|
擷取每個裝置的受管理設定詳細資料。 |
| list |
GET /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice
|
列出指定裝置的所有裝置專屬受管理設定。 只設定 ID。 |
| 更新 |
PUT /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId
|
為指定裝置的應用程式新增或更新裝置專屬的受管理設定。 |
Managedconfigurationsforuser
如需 Managedconfigurationsforuser 資源的詳細資料，請參閱資源表示法網頁。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 除非另有註明，否則 URI 皆與 https://www.googleapis.com/androidenterprise/v1 相關 | ||
| delete |
DELETE /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId
|
為指定使用者移除應用程式的個別使用者受管理設定。 |
| get |
GET /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId
|
為指定使用者擷取應用程式的個別使用者受管理設定詳細資料。 |
| list |
GET /enterprises/enterpriseId/users/userId/managedConfigurationsForUser
|
列出指定使用者的所有使用者專用受管理設定。只設定 ID。 |
| 更新 |
PUT /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId
|
為指定使用者新增或更新應用程式的受管理設定。
如果您支援受管理的設定 iframe，可以在要求中指定 mcmId 及其相關聯的設定變數 (如有)，對使用者套用受管理的設定。或者，所有 EMM 都可以傳遞受管理屬性清單，套用受管理設定。
|
Managedconfigurationssettings
如需 Managedconfigurationssettings 資源的詳細資料，請參閱資源表示法網頁。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 除非另有註明，否則 URI 皆與 https://www.googleapis.com/androidenterprise/v1 相關 | ||
| list |
GET /enterprises/enterpriseId/products/productId/managedConfigurationsSettings
|
列出指定應用程式的所有受管理設定。 |
權限
如需 Permissions 資源的詳細資料，請參閱資源表示法網頁。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 除非另有註明，否則 URI 皆與 https://www.googleapis.com/androidenterprise/v1 相關 | ||
| get |
GET /permissions/permissionId
|
擷取 Android 應用程式權限的詳細資料，供企業管理員查看。 |
產品
如需 Products 資源的詳細資料，請參閱資源表示法頁面。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 除非另有註明，否則 URI 皆與 https://www.googleapis.com/androidenterprise/v1 相關 | ||
| 核准 |
POST /enterprises/enterpriseId/products/productId/approve
|
核准指定產品和相關應用程式權限 (如有)。 每個企業客戶最多可核准 1,000 項產品。 如要瞭解如何使用 Google Play 管理版設計及建立商店版面配置，向使用者顯示核准的產品，請參閱「商店版面配置設計」。 |
| generateApprovalUrl |
POST /enterprises/enterpriseId/products/productId/generateApprovalUrl
|
產生可在 iframe 中顯示的網址，用來顯示產品的權限 (如有)。企業管理員必須查看這些權限，並代表機構接受，才能核准該產品。 管理員應與 EMM 控制台中的獨立 UI 元素互動，接受顯示的權限，這會觸發在 Products.approve 呼叫中使用這個網址做為 approvalUrlInfo.approvalUrl 屬性，以核准產品。
這個網址只能用於顯示權限，且最多只能顯示 1 天。
|
| get |
GET /enterprises/enterpriseId/products/productId
|
擷取產品詳細資料，供企業管理員查看。 |
| getAppRestrictionsSchema |
GET /enterprises/enterpriseId/products/productId/appRestrictionsSchema
|
擷取定義此產品可設定屬性的結構定義。所有產品都有架構，但如果未定義任何受管理設定，這個架構可能會是空白。這個結構定義可用於填入使用者介面，讓管理員設定產品。如要根據使用這個 API 取得的結構定義套用受管理的設定，請參閱「透過 Google Play 管理設定」。 |
| getPermissions |
GET /enterprises/enterpriseId/products/productId/permissions
|
擷取這個應用程式所需的 Android 應用程式權限。 |
| list |
GET /enterprises/enterpriseId/products
|
找出符合查詢條件的已核准產品，或找出所有已核准產品 (如果沒有查詢條件)。 |
| unapprove |
POST /enterprises/enterpriseId/products/productId/unapprove
|
取消核准指定產品 (以及相關應用程式權限，如有) |
Serviceaccountkeys
如需 Serviceaccountkeys 資源的詳細資料，請參閱資源表示法網頁。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 除非另有註明，否則 URI 皆與 https://www.googleapis.com/androidenterprise/v1 相關 | ||
| delete |
DELETE /enterprises/enterpriseId/serviceAccountKeys/keyId
|
移除並停用與這個企業相關聯的服務帳戶指定憑證。呼叫服務帳戶必須透過呼叫 Enterprises.GetServiceAccount 擷取，且必須透過呼叫 Enterprises.SetAccount 設為企業服務帳戶。 |
| insert |
POST /enterprises/enterpriseId/serviceAccountKeys
|
為與這個企業相關聯的服務帳戶產生新憑證。呼叫服務帳戶必須透過呼叫 Enterprises.GetServiceAccount 擷取，且必須透過呼叫 Enterprises.SetAccount 設為企業服務帳戶。 在要插入的資源中，只能填入鍵的類型。 |
| list |
GET /enterprises/enterpriseId/serviceAccountKeys
|
列出與這個企業相關聯的服務帳戶所有有效憑證。系統只會傳回 ID 和金鑰類型。呼叫服務帳戶必須透過呼叫 Enterprises.GetServiceAccount 擷取，且必須透過呼叫 Enterprises.SetAccount 設為企業服務帳戶。 |
Storelayoutclusters
如需 Storelayoutclusters 資源的詳細資料，請參閱資源表示法網頁。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 除非另有註明，否則 URI 皆與 https://www.googleapis.com/androidenterprise/v1 相關 | ||
| delete |
DELETE /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId
|
刪除叢集。 |
| get |
GET /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId
|
擷取叢集的詳細資料。 |
| insert |
POST /enterprises/enterpriseId/storeLayout/pages/pageId/clusters
|
在頁面中插入新叢集。 |
| list |
GET /enterprises/enterpriseId/storeLayout/pages/pageId/clusters
|
擷取指定頁面上所有叢集的詳細資料。 |
| 更新 |
PUT /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId
|
更新叢集。 |
Storelayoutpages
如需 Storelayoutpages 資源的詳細資料，請參閱資源表示法網頁。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 除非另有註明，否則 URI 皆與 https://www.googleapis.com/androidenterprise/v1 相關 | ||
| delete |
DELETE /enterprises/enterpriseId/storeLayout/pages/pageId
|
刪除商店頁面。 |
| get |
GET /enterprises/enterpriseId/storeLayout/pages/pageId
|
擷取商店頁面的詳細資料。 |
| insert |
POST /enterprises/enterpriseId/storeLayout/pages
|
插入新的商店頁面。 |
| list |
GET /enterprises/enterpriseId/storeLayout/pages
|
擷取商店中所有頁面的詳細資料。 |
| 更新 |
PUT /enterprises/enterpriseId/storeLayout/pages/pageId
|
更新商店頁面的內容。 |
使用者
如需 Users 資源的詳細資料，請參閱資源表示法頁面。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 除非另有註明，否則 URI 皆與 https://www.googleapis.com/androidenterprise/v1 相關 | ||
| 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
|
擷取使用者有權存取的一組產品。 |
| insert |
POST /enterprises/enterpriseId/users
|
建立新的 EMM 管理使用者。
要求主體中傳遞的「Users」資源應包含 accountIdentifier 和 accountType。
如果已有帳戶識別碼相同的對應使用者，系統會使用資源更新該使用者。在此情況下，只能變更 |
| list |
GET /enterprises/enterpriseId/users
|
依主要電子郵件地址查詢使用者。
這項功能僅支援 Google 管理的使用者。對於 EMM 管理的使用者，不需要查閱 ID，因為 ID 已在 Users.insert 呼叫的結果中傳回。
必要查詢參數：
|
| revokeDeviceAccess |
DELETE /enterprises/enterpriseId/users/userId/deviceAccess
|
撤銷使用者目前佈建的所有裝置存取權。使用者將無法再透過任何受管理裝置使用管理版 Play 商店。 這個呼叫只適用於 EMM 管理的帳戶。 |
| setAvailableProductSet |
PUT /enterprises/enterpriseId/users/userId/availableProductSet
|
修改使用者有權存取的一組產品 (稱為「許可清單」產品)。只有已核准的產品，或先前已核准的產品 (核准遭撤銷的產品)，才能加入許可清單。 |
| 更新 |
PUT /enterprises/enterpriseId/users/userId
|
更新 EMM 管理的使用者詳細資料。
只能與 EMM 管理的使用者搭配使用 (不適用於 Google 管理的使用者)。 在要求主體的「Users」資源中傳遞新詳細資料。只能變更 displayName 欄位。其他欄位必須未設定或使用目前有效的值。
|
網頁應用程式
如需 Webapps 資源的詳細資料，請參閱資源表示法網頁。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 除非另有註明，否則 URI 皆與 https://www.googleapis.com/androidenterprise/v1 相關 | ||
| delete |
DELETE /enterprises/enterpriseId/webApps/webAppId
|
Deletes an existing web app. |
| get |
GET /enterprises/enterpriseId/webApps/webAppId
|
取得現有的網頁應用程式。 |
| insert |
POST /enterprises/enterpriseId/webApps
|
為企業建立新的 Web 應用程式。 |
| list |
GET /enterprises/enterpriseId/webApps
|
擷取指定企業的所有 Web 應用程式詳細資料。 |
| 更新 |
PUT /enterprises/enterpriseId/webApps/webAppId
|
更新現有網頁應用程式。 |