本 API 參考資料是依照資源類型編排。各個資源類型都具有一或多種資料表示法,以及一或多種方法。
資源類型
- 裝置
- 企業
- 授權
- Grouplicenses
- Grouplicenseusers
- 安裝
- 受管理的設定
- 使用者適用的代管設定
- 受管理的設定
- 權限
- 產品
- Serviceaccountkeys
- Storelayoutclusters
- Storelayoutpages
- 使用者
- 網頁應用程式
裝置
如需裝置資源詳細資料,請參閱資源表示法網頁。
方法 | HTTP 要求 | 說明 |
---|---|---|
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI (除非另外註明) | ||
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 中的帳戶」。 |
企業
如需 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。如要產生網路 UI,請將產生的權杖傳遞至 Google Play 管理版 JavaScript API。每個權杖都只能用於啟動一個 UI 工作階段。詳情請參閱 JavaScript API 說明文件。 |
註冊 |
POST /enterprises/enroll
|
使用呼叫式 EMM 為企業註冊。
必要查詢參數:
|
generateSignupUrl |
POST /enterprises/signupUrl
|
產生註冊網址。 |
get |
GET /enterprises/enterpriseId
|
擷取企業的名稱和網域。 |
getServiceAccount |
GET /enterprises/enterpriseId/serviceAccount
|
傳回服務帳戶和憑證。該服務帳戶可呼叫 setAccount 來繫結至企業。服務帳戶專屬於此企業和 EMM,如果企業未繫結,就會刪除。憑證包含私密金鑰資料,且不會儲存在伺服器端。 您必須等到呼叫 Enterprise.Register 或 Enterprises.CompleteSignup 後,才能呼叫這個方法,而 Enterprises.SetAccount 之前則會傳回錯誤。 第一個呼叫後的後續呼叫會產生一組新的不重複的憑證,而會使先前產生的憑證失效。 將服務帳戶與企業建立繫結後,即可使用 serviceAccountKeys 資源來管理服務帳戶。 |
getStoreLayout |
GET /enterprises/enterpriseId/storeLayout
|
傳回企業的商店版面配置。如果尚未設定商店版面配置,則會傳回「基本」做為商店版面配置類型,且沒有首頁。 |
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
|
為呼叫的 EMM 取消註冊企業。 |
授權
如要進一步瞭解授權資源,請參閱資源表示法網頁。
方法 | HTTP 要求 | 說明 |
---|---|---|
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI (除非另外註明) | ||
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 要求 | 說明 |
---|---|---|
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI (除非另外註明) | ||
get |
GET /enterprises/enterpriseId/groupLicenses/groupLicenseId
|
擷取產品的企業群組授權詳細資料。 注意:此項目已淘汰。新的整合無法使用此方法,並可以參閱我們的 新建議。 |
list |
GET /enterprises/enterpriseId/groupLicenses
|
針對企業具備群組授權的所有產品擷取 ID。 注意:此項目已淘汰。新的整合無法使用此方法,並可以參閱我們的 新建議。 |
Grouplicense 使用者
如需 Grouplicenseusers 資源詳細資料,請參閱資源表示法網頁。
方法 | HTTP 要求 | 說明 |
---|---|---|
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI (除非另外註明) | ||
list |
GET /enterprises/enterpriseId/groupLicenses/groupLicenseId/users
|
擷取已依據授權獲得授權的使用者 ID。注意:此項目已淘汰。新的整合無法使用此方法,並可以參閱我們的 新建議。 |
安裝次數
如需 Installs 資源的詳細資料,請參閱資源表示法網頁。
方法 | HTTP 要求 | 說明 |
---|---|---|
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI (除非另外註明) | ||
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
|
要求將最新版應用程式安裝到裝置。如果應用程式已安裝,則視需要更新至最新版本。 |
適用於裝置的 Managedconfigurations
如需 Managedconfigurationsfordevice 資源的詳細資料,請參閱資源表示法頁面。
方法 | HTTP 要求 | 說明 |
---|---|---|
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI (除非另外註明) | ||
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 資源的詳細資料,請參閱資源表示法頁面。
方法 | HTTP 要求 | 說明 |
---|---|---|
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI (除非另外註明) | ||
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 資源詳細資料,請參閱資源表示法頁面。
方法 | HTTP 要求 | 說明 |
---|---|---|
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI (除非另外註明) | ||
list |
GET /enterprises/enterpriseId/products/productId/managedConfigurationsSettings
|
列出指定應用程式的所有受管理設定。 |
權限
如需 Permissions 資源的詳細資料,請參閱資源表示法網頁。
方法 | HTTP 要求 | 說明 |
---|---|---|
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI (除非另外註明) | ||
get |
GET /permissions/permissionId
|
擷取 Android 應用程式權限的詳細資料,供企業管理員查看。 |
產品
如要進一步瞭解產品資源,請參閱資源表示法網頁。
方法 | 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 元素互動,藉此接受顯示的權限,進而觸發使用這個網址做為 Products.approve 呼叫中的 approvalUrlInfo.approvalUrl 屬性,以核准產品。這個網址只能用來顯示權限 (最多 1 天)。
注意:此項目已淘汰。新的整合無法使用此方法,並可以參閱我們的 新建議。 |
get |
GET /enterprises/enterpriseId/products/productId
|
擷取產品詳細資料,供企業管理員查看。 |
getAppRestrictionsSchema |
GET /enterprises/enterpriseId/products/productId/appRestrictionsSchema
|
擷取定義這項產品可設定屬性的結構定義。所有產品都有結構定義,但如未定義任何受管理設定,結構定義可能會空白。這個結構定義可用於填入 UI,以便管理員設定產品。如要根據透過這個 API 取得的結構定義套用代管設定,請參閱「透過 Play 提供的受管理設定」。 |
getPermissions |
GET /enterprises/enterpriseId/products/productId/permissions
|
擷取此應用程式所需的 Android 應用程式權限。 |
list |
GET /enterprises/enterpriseId/products
|
尋找與查詢相符的已核准產品。如果沒有查詢,則尋找所有已核准的產品。注意:此項目已淘汰。新的整合無法使用此方法,並可以參閱我們的 新建議。 |
取消核准 |
POST /enterprises/enterpriseId/products/productId/unapprove
|
取消核准指定的產品 (以及相關的應用程式權限,如果有的話) 注意:這個項目已淘汰。新的整合無法使用此方法,並可以參閱我們的 新建議。 |
服務帳戶金鑰
如需 Serviceaccountkeys 資源的詳細資料,請參閱資源表示法網頁。
方法 | HTTP 要求 | 說明 |
---|---|---|
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI (除非另外註明) | ||
delete |
DELETE /enterprises/enterpriseId/serviceAccountKeys/keyId
|
移除並撤銷與這個企業相關聯的服務帳戶指定憑證。您必須呼叫 Enterprises.GetServiceAccount 才能擷取呼叫的服務帳戶,且必須透過呼叫 Enterprises.SetAccount 將其設為企業服務帳戶。 |
insert |
POST /enterprises/enterpriseId/serviceAccountKeys
|
為與這個企業相關聯的服務帳戶產生新憑證。呼叫的服務帳戶必須透過呼叫 Enterprise.GetServiceAccount 才能擷取,且必須透過呼叫 Enterprises.SetAccount 設為企業服務帳戶。 您只能在要插入的資源中填入金鑰類型。 |
list |
GET /enterprises/enterpriseId/serviceAccountKeys
|
列出與這個企業相關聯的服務帳戶所有有效憑證。系統只會傳回 ID 和鍵類型。呼叫的服務帳戶必須透過呼叫 Enterprises.GetServiceAccount 來擷取,並且已透過呼叫 Enterprises.SetAccount 設定為企業服務帳戶。 |
Storelayoutclusters
如需 Storelayoutclusters 資源的詳細資料,請參閱資源表示法頁面。
方法 | HTTP 要求 | 說明 |
---|---|---|
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI (除非另外註明) | ||
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 資源詳細資料,請參閱資源表示法頁面。
方法 | HTTP 要求 | 說明 |
---|---|---|
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI (除非另外註明) | ||
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
|
更新商店頁面的內容。 注意: 這個項目已淘汰。新的整合無法使用此方法,並可以參閱我們的 新建議。 |
使用者
如要進一步瞭解使用者資源,請參閱資源表示法網頁。
方法 | HTTP 要求 | 說明 |
---|---|---|
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI (除非另外註明) | ||
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 。如果已有對應使用者使用相同的帳戶 ID,使用者將會以資源更新。在這種情況下,您只能變更 |
list |
GET /enterprises/enterpriseId/users
|
依主要電子郵件地址查詢使用者。這項功能僅適用於 Google 管理的使用者。EMM 管理的使用者無須查詢 ID,因為系統已在 Users.insert 呼叫的結果中傳回 ID。
必要查詢參數:
|
revokeDeviceAccess |
DELETE /enterprises/enterpriseId/users/userId/deviceAccess
|
撤銷使用者目前佈建的所有裝置的存取權。使用者將無法再於任何受管理的裝置上使用 Play 管理版商店。 這項呼叫僅適用於由 EMM 管理的帳戶。 |
setAvailableProductSet |
PUT /enterprises/enterpriseId/users/userId/availableProductSet
|
修改使用者有權存取的產品組合 (稱為「已加入許可清單」whitelisted的產品)。只有已核准的產品或先前已核准 (獲得核准的產品) 才能加入許可清單。注意:此項目已淘汰。新的整合無法使用此方法,並可以參閱我們的 新建議。 |
更新 |
PUT /enterprises/enterpriseId/users/userId
|
更新由 EMM 管理的使用者詳細資料。
只可與由 EMM 管理的使用者搭配使用,不適用於 Google 受管理使用者。 在要求主體的 Users 資源中傳遞新詳細資料。只有 displayName 欄位可以變更。其他欄位則必須未設定,或是含有目前使用中的值。 |
Web 應用程式
如需 Webapps 資源的詳細資料,請參閱資源表示法網頁。
方法 | HTTP 要求 | 說明 |
---|---|---|
相對於 https://www.googleapis.com/androidenterprise/v1 的 URI (除非另外註明) | ||
delete |
DELETE /enterprises/enterpriseId/webApps/webAppId
|
刪除現有的網頁應用程式。 |
get |
GET /enterprises/enterpriseId/webApps/webAppId
|
取得現有的網頁應用程式。 |
insert |
POST /enterprises/enterpriseId/webApps
|
為企業建立新的網頁應用程式。 |
list |
GET /enterprises/enterpriseId/webApps
|
擷取特定企業的所有網頁應用程式詳細資料。 |
更新 |
PUT /enterprises/enterpriseId/webApps/webAppId
|
更新現有的網頁應用程式。 |