API Reference

本 API 參考資料是依照資源類型編排。各個資源類型都具有一或多種資料表示法，以及一或多種方法。

資源類型

  1. 裝置數
  2. 企業
  3. 授權
  4. 團體授權
  5. 群組授權使用者
  6. 安裝次數
  7. Managedconfigurationsfordevice
  8. 使用者適用的受管理設定
  9. Managedconfigurationssettings
  10. 權限
  11. 產品
  12. Serviceaccountkeys
  13. 商店版面配置叢集
  14. Storelayoutpages
  15. 位使用者
  16. 網頁應用程式

裝置數

如要進一步瞭解 Devices 資源，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI，除非另有說明
forceReportUpload POST  /enterprises/enterpriseId/users/userId/devices/deviceId/forceReportUpload 上傳一份報表，內含自以下時間之後的裝置應用程式狀態變化 最近產生的報表每次最多可呼叫此方法 3 次 每個裝置 24 小時。
取得 GET  /enterprises/enterpriseId/users/userId/devices/deviceId 擷取裝置的詳細資料。
getState GET  /enterprises/enterpriseId/users/userId/devices/deviceId/state 擷取裝置是否已啟用 Google 服務的存取權，或 已停用。 只有在 Android 裝置強制執行 EMM 政策時，裝置狀態才會生效 已在 Google 管理控制台中啟用裝置。 否則，系統會忽略裝置狀態並允許存取所有裝置 。 這項功能僅適用於由 Google 管理的使用者。
清單 GET  /enterprises/enterpriseId/users/userId/devices 擷取使用者所有裝置的 ID。
setState PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/state 設定是否啟用或停用裝置的 Google 服務存取權。 只有在 Android 裝置強制執行 EMM 政策時，裝置狀態才會生效 已在 Google 管理控制台中啟用裝置。 否則，系統會忽略裝置狀態並允許存取所有裝置 。 這項功能僅適用於由 Google 管理的使用者。
更新 PUT  /enterprises/enterpriseId/users/userId/devices/deviceId 更新裝置政策。

如要確保政策正確強制執行，請防止未受管 將存取 Google Play 的使用者帳戶設為 Google Cloud 控制台的受管理設定中的 allowed_accounts Play 套件。查看限制 帳戶

企業

如要進一步瞭解 Enterprises 資源，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI，除非另有說明
acknowledgeNotificationSet POST  /enterprises/acknowledgeNotificationSet 確認收到下列來源的通知 Enterprises.PullNotificationSet 可防止後續呼叫傳回 相同的通知
completeSignup POST  /enterprises/completeSignup 透過指定完成權杖，以及 企業權杖。 無法對指定的 Enterprise 多次呼叫這項要求 權杖。
createWebToken POST  /enterprises/enterpriseId/createWebToken 傳回專屬權杖來存取嵌入式 UI。如要產生 並把產生的權杖傳遞至 Google Play 管理版 JavaScript 也能使用 Google Cloud CLI 或 Compute Engine API每個權杖只能用來啟動一個 UI 工作階段。詳情請參閱 如需其他資訊，請參閱 JavaScript API 說明文件。
註冊 POST  /enterprises/enroll 透過 EMM 為企業註冊。

必要的查詢參數： token
generateSignupUrl POST  /enterprises/signupUrl 產生註冊網址。
取得 GET  /enterprises/enterpriseId 擷取企業的名稱和網域。
getServiceAccount GET  /enterprises/enterpriseId/serviceAccount 傳回服務帳戶和憑證。服務帳戶 即可呼叫 setAccount 與企業連結。服務帳戶 是這個企業和 EMM 的專屬 ID，如果是企業，就會遭到刪除 沒有繫結。憑證包含私密金鑰資料，不會儲存 伺服器端代碼

只有在呼叫 Enterprises.enroll 或 Enterprises.CompleteSignup 以及之前的之前 Enterprises.SetAccount;否則會傳回錯誤

則在第一個以後的後續呼叫中，將會產生一組新的不重複 憑證，並使先前產生的憑證失效。

將服務帳戶繫結至企業後，即可管理服務帳戶 使用 serviceAccountKeys 資源
getStoreLayout GET  /enterprises/enterpriseId/storeLayout 傳回企業的商店版面配置。如果商店版面配置 尚未設定，傳回「basic」設為商店版面配置類型， 首頁。
清單 GET  /enterprises 依網域名稱查詢企業。 這個選項僅適用於透過 Google 發起的 建立流程如果是透過 是從 EMM 啟動的流程，因為 EMM 會學習 Enterprises.generateSignupUrl 呼叫中指定的回呼。

必要的查詢參數： domain
pullNotificationSet POST  /enterprises/pullNotificationSet 提取並傳回與 已依此要求完成驗證的服務帳戶。通知設定則可能是 如果沒有待處理的通知，則會空白。
傳回的通知集需要在 20 秒內確認 呼叫 Enterprises.AcknowledgeNotificationSet，除非 通知集空白。
如未在 20 秒內確認通知， 最終會再次包含在對另一個 PullNotificationSet 的回應中 任何從未確認過的要求都將遭到刪除 更新依據。
可能會同時執行多項要求來擷取 在這種情況下，系統會發出待處理通知 (如有) 就會分配給每個呼叫端 (如果有任何待處理)。
如果沒有任何通知，則會傳回空白的通知清單。 後續要求可能會在送出後傳回更多通知 廣告。
sendTestPushNotification POST  /enterprises/enterpriseId/sendTestPushNotification 傳送測試通知，驗證與 EMM 的整合結果 使用 Cloud Pub/Sub 服務
setAccount PUT  /enterprises/enterpriseId/account 將要用來驗證 API 的帳戶設為 企業。
setStoreLayout PUT  /enterprises/enterpriseId/storeLayout 設定企業的商店版面配置。根據預設，storeLayoutType 是設為「basic」並啟用基本商店版面配置基本 版面配置只包含經管理員核准，且 的方法是使用 setAvailableProductSet 呼叫)。頁面上的應用程式會按照 產品 ID 值如果您要建立自訂商店版面配置 (透過 storeLayoutType =「custom」以及設定首頁) 基本商店 版面配置已停用。
取消註冊 POST  /enterprises/enterpriseId/unenroll 為企業取消註冊通話 EMM。

授權

如要進一步瞭解授權資源，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI，除非另有說明
刪除 DELETE  /enterprises/enterpriseId/users/userId/entitlements/entitlementId 移除使用者的應用程式授權。
取得 GET  /enterprises/enterpriseId/users/userId/entitlements/entitlementId 擷取授權的詳細資料。
清單 GET  /enterprises/enterpriseId/users/userId/entitlements 列出指定使用者的所有授權。系統只會設定 ID。
更新 PUT  /enterprises/enterpriseId/users/userId/entitlements/entitlementId 為使用者新增或更新應用程式授權。

團體授權

如需 Grouplicenses 資源詳細資料，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI，除非另有說明
取得 GET  /enterprises/enterpriseId/groupLicenses/groupLicenseId 擷取產品的企業群組授權詳細資料。
清單 GET  /enterprises/enterpriseId/groupLicenses 擷取企業具有團體授權的所有產品 ID。

群組授權使用者

如需 Grouplicenseusers 資源詳細資料，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI，除非另有說明
清單 GET  /enterprises/enterpriseId/groupLicenses/groupLicenseId/users 擷取已獲得授權的使用者 ID 授權。

安裝次數

如要進一步瞭解 Installs 資源詳細資料，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI，除非另有說明
刪除 DELETE  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId 要求從裝置中移除應用程式。對 get 的呼叫或 在 之前，list 仍會在裝置上安裝應用程式 但實際上是移除的
取得 GET  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId 擷取應用程式安裝在裝置上的詳細資料。
清單 GET  /enterprises/enterpriseId/users/userId/devices/deviceId/installs 擷取安裝在指定裝置上所有應用程式的詳細資料。
更新 PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId 將最新版本的應用程式安裝到裝置上的要求。如果應用程式 已安裝；如果已安裝，則系統已更新至最新版本 無從得知

Managedconfigurationsfordevice

如需受管理的設定裝置資源詳細資料，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI，除非另有說明
刪除 DELETE  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId 針對指定的應用程式移除依個別裝置管理的設定 裝置。
取得 GET  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId 擷取個別裝置的受管理設定詳細資料。
清單 GET  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice 列出指定裝置的所有個別裝置管理設定。 系統只會設定 ID。
更新 PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId 為 。

使用者適用的受管理設定

如需 Managed 設定 for 使用者資源詳細資料，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI，除非另有說明
刪除 DELETE  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId 移除特定使用者對指定應用程式的管理設定 內容。
取得 GET  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId 擷取使用者管理的應用程式相關設定詳細資料 指定使用者。
清單 GET  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser 列出指定使用者的所有每位使用者管理設定。僅限 ID 已設定完成
更新 PUT  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId 為指定使用者新增或更新應用程式的受管理設定。 如果您支援受管理的設定 iframe， 您可以指定 mcmId 以及與要求相關聯的設定變數 (如有)。另外 所有 EMM 都能透過傳送受管理的設定清單來套用受管理的設定 資源。

Managedconfigurationssettings

如要進一步瞭解 Managedconfigurationssettings 資源，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI，除非另有說明
清單 GET  /enterprises/enterpriseId/products/productId/managedConfigurationsSettings 列出指定應用程式的所有受管理設定。

權限

如需 Permissions 資源的詳細資料，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI，除非另有說明
取得 GET  /permissions/permissionId 擷取可供企業管理員顯示的 Android 應用程式權限詳細資料。

產品

如要進一步瞭解 Products 資源，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI，除非另有說明
核准 POST  /enterprises/enterpriseId/products/productId/approve

核准指定產品及相關應用程式權限 (如有)。 每位企業客戶可核准的產品數量上限 1,000 次

瞭解如何使用 Google Play 管理版設計及建立商店 以便向使用者顯示已核准的產品， 請參閱「儲存版面配置設計」。
generateApprovalUrl POST  /enterprises/enterpriseId/products/productId/generateApprovalUrl 產生可在 iframe 中顯示的網址，以顯示 權限 (如果有的話)。企業管理員必須查看 並代表其所屬機構接受這些權限 核准該產品

管理員應由下列員工接受顯示的權限： 與 EMM 控制台中的個別 UI 元素互動 會觸發將這個網址做為 approvalUrlInfo.approvalUrl 房源 Products.approve，請對方核准產品。 這個網址最多只能用來顯示 1 天的權限。
取得 GET  /enterprises/enterpriseId/products/productId 擷取要向企業管理員顯示的產品詳細資料。
getAppRestrictionsSchema GET  /enterprises/enterpriseId/products/productId/appRestrictionsSchema 擷取定義可設定屬性的結構定義 產品。所有產品都有結構定義，但如果沒有結構定義，這個結構定義可能會留空 並已定義受管理的設定。這個結構定義可用於 填入使用者介面，以便管理員設定產品。 如要根據使用這項指令取得的結構定義，套用受管理的設定 API，請參閱 透過 Play 管理受管理的設定。
getPermissions GET  /enterprises/enterpriseId/products/productId/permissions 擷取這個應用程式所需的 Android 應用程式權限。
清單 GET  /enterprises/enterpriseId/products 尋找符合查詢條件的已核准產品，或是所有已核准的產品 沒有查詢的話
取消核准 POST  /enterprises/enterpriseId/products/productId/unapprove 取消核准指定產品 (以及相關的應用程式權限 (如果有的話))

Serviceaccountkeys

如需 Serviceaccountkeys 資源詳細資料，請參閱資源表示法頁面。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI，除非另有說明
刪除 DELETE  /enterprises/enterpriseId/serviceAccountKeys/keyId 移除服務帳戶的指定憑證並失效 與這個企業相關聯的角色呼叫服務帳戶必須符合下列條件 呼叫 Enterprises.GetServiceAccount 加以擷取，且 呼叫 Enterprises.SetAccount，藉此驗證企業服務帳戶
插入 POST  /enterprises/enterpriseId/serviceAccountKeys 為與這個專案相關聯的服務帳戶產生新憑證 企業。呼叫服務帳戶必須經由呼叫 Enterprises.GetServiceAccount 必須設為企業帳戶 呼叫 Enterprises.SetAccount

只需在待開發資源中填入金鑰類型 已插入
清單 GET  /enterprises/enterpriseId/serviceAccountKeys 列出與這個相關聯服務帳戶的所有有效憑證 企業。系統只會傳回 ID 和金鑰類型。呼叫服務 必須通過呼叫 Enterprises.GetServiceAccount 才能擷取帳戶 且必須透過呼叫 Enterprises.SetAccount。

商店版面配置叢集

如需 Storelayoutclusters 資源詳細資料，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI，除非另有說明
刪除 DELETE  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId 刪除叢集。
取得 GET  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId 擷取叢集的詳細資料。
插入 POST  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters 在網頁上插入新叢集。
清單 GET  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters 擷取指定頁面中所有叢集的詳細資料。
更新 PUT  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId 更新叢集。

Storelayoutpages

如要進一步瞭解 Storelayoutpages 資源，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI，除非另有說明
刪除 DELETE  /enterprises/enterpriseId/storeLayout/pages/pageId 刪除商店頁面。
取得 GET  /enterprises/enterpriseId/storeLayout/pages/pageId 擷取商店頁面的詳細資料。
插入 POST  /enterprises/enterpriseId/storeLayout/pages 插入新的商店頁面。
清單 GET  /enterprises/enterpriseId/storeLayout/pages 擷取商店中所有網頁的詳細資料。
更新 PUT  /enterprises/enterpriseId/storeLayout/pages/pageId 更新商店頁面的內容。

位使用者

如要進一步瞭解使用者資源，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI，除非另有說明
刪除 DELETE  /enterprises/enterpriseId/users/userId 已刪除由 EMM 管理的使用者。
generateAuthenticationToken POST  /enterprises/enterpriseId/users/userId/authenticationToken 產生驗證權杖，供裝置政策用戶端用於 在裝置上佈建由 EMM 管理的使用者帳戶。 產生的權杖僅限單次使用，幾分鐘後就會失效。

每位使用者最多只能佈建 10 部裝置。

這場通話僅適用於由 EMM 管理的帳戶。
取得 GET  /enterprises/enterpriseId/users/userId 擷取使用者的詳細資料。
getAvailableProductSet GET  /enterprises/enterpriseId/users/userId/availableProductSet 擷取使用者有權存取的產品組合。
插入 POST  /enterprises/enterpriseId/users 建立新的 EMM 管理使用者。

Users 資源 傳遞的內文中應包含 accountIdentifier 及 accountType。

如果對應的使用者已存在相同的帳戶 ID， 使用者就會收到更新的資源本例中只有 可變更「displayName」欄位。
清單 GET  /enterprises/enterpriseId/users 依主要電子郵件地址查詢使用者。 這項功能僅適用於由 Google 管理的使用者。查詢 ID 並不是 所需的 EMM 管理使用者所需的 ID，因為 。

必要的查詢參數： email
revokeDeviceAccess DELETE  /enterprises/enterpriseId/users/userId/deviceAccess 撤銷使用者目前佈建所有裝置的存取權。該使用者 將無法再透過使用者的 受管理的裝置。

這場通話僅適用於由 EMM 管理的帳戶。
setAvailableProductSet PUT  /enterprises/enterpriseId/users/userId/availableProductSet 修改使用者有權存取的產品組合 (請參閱 標記為已加入許可清單的產品)。僅限符合以下條件的產品 已核准 或先前已核准的產品 (已撤銷核准的產品) 可以加入許可清單
更新 PUT  /enterprises/enterpriseId/users/userId 更新 EMM 管理使用者的詳細資料。

僅適用於受 EMM 管理的使用者 (而非 Google 受管理使用者)。 在 使用者 將資源傳送至要求主體中僅限 displayName 欄位 可以變更其他欄位則不得設定或含有 目前使用的值。

網頁應用程式

如要進一步瞭解 Webapps 資源，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI，除非另有說明
刪除 DELETE  /enterprises/enterpriseId/webApps/webAppId 刪除現有的網頁應用程式。
取得 GET  /enterprises/enterpriseId/webApps/webAppId 取得現有的網頁應用程式。
插入 POST  /enterprises/enterpriseId/webApps 為企業建立新的網頁應用程式。
清單 GET  /enterprises/enterpriseId/webApps 擷取特定企業所有網頁應用程式的詳細資料。
更新 PUT  /enterprises/enterpriseId/webApps/webAppId 更新現有的網頁應用程式。