API Reference

この API リファレンスは、リソースタイプ別にまとめられています。各リソースタイプには、1 つ以上のデータ表現と 1 つ以上のメソッドがあります。

リソースタイプ

  1. デバイス
  2. 企業
  3. 利用資格
  4. グループライセンス
  5. Grouplicenseusers
  6. インストール数
  7. デバイスの管理対象構成
  8. Managedconfigurationsforuser
  9. Managedconfigurationssettings
  10. 権限
  11. プロダクト
  12. Serviceaccountkeys
  13. Storelayoutclusters
  14. Storelayoutpages
  15. ユーザー
  16. ウェブアプリ

デバイス

Devices リソースの詳細については、リソース表現ページをご覧ください。

メソッド 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 が管理するユーザーにのみ対応しています。
update PUT  /enterprises/enterpriseId/users/userId/devices/deviceId デバイス ポリシーを更新します。

ポリシーが適切に適用されるようにするには、Google Play パッケージの管理対象構成で allowed_accounts を設定して、管理対象外のアカウントが Google Play にアクセスできないようにする必要があります。Google Play でアカウントを制限するをご覧ください。

企業

Enterprises リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/androidenterprise/v1 を基準とします。
acknowledgeNotificationSet POST  /enterprises/acknowledgeNotificationSet Enterprises.PullNotificationSet から受信した通知を承認し、以降の呼び出しで同じ通知が返されないようにします。
completeSignup POST  /enterprises/completeSignup 完了トークンとエンタープライズ トークンを指定して、登録フローを完了します。このリクエストは、特定のエンタープライズ トークンに対して複数回呼び出すことはできません。
createWebToken POST  /enterprises/enterpriseId/createWebToken 埋め込み可能な UI にアクセスするための一意のトークンを返します。ウェブ UI を生成するには、生成されたトークンを managed Google Play JavaScript API に渡します。各トークンは 1 つの UI セッションの開始にのみ使用できます。詳しくは、 JavaScript API ドキュメントをご覧ください。
登録 POST  /enterprises/enroll 呼び出し元の EMM に企業を登録します。

必須のクエリ パラメータ: token

generateEnterpriseUpgradeUrl POST  /enterprises/enterpriseId/generateEnterpriseUpgradeUrl 既存の managed Google Play アカウント エンタープライズを Managed Google Domains にアップグレードするためのエンタープライズ アップグレード URL を生成します。
generateSignupUrl POST  /enterprises/signupUrl 登録 URL を生成します。
get GET  /enterprises/enterpriseId エンタープライズの名前とドメインを取得します。
getServiceAccount GET  /enterprises/enterpriseId/serviceAccount サービス アカウントと認証情報を返します。サービス アカウントは、setAccount を呼び出してエンタープライズにバインドできます。このサービス アカウントは、このエンタープライズと EMM に固有のものであり、エンタープライズが未バインドの場合、削除されます。認証情報には秘密鍵データが含まれ、サーバーサイドには保存されません。

このメソッドは、Enterprises.Enroll または Enterprises.CompleteSignup を呼び出した後、Enterprises.SetAccount の前にのみ呼び出すことができます。それ以外の場合は、エラーが返されます。

最初の呼び出しの後に呼び出すと、一意の新しい認証情報セットが生成され、以前に生成された認証情報が無効になります。

サービス アカウントがエンタープライズにバインドされると、serviceAccountKeys リソースを使用して管理できるようになります。

。
getStoreLayout GET  /enterprises/enterpriseId/storeLayout 企業のストア レイアウトを返します。ストアのレイアウトが設定されていない場合、ストアのレイアウト タイプとして「基本」が返され、ホームページは返されません。
list GET  /enterprises ドメイン名でエンタープライズを検索します。これは、Google が開始する作成フローで作成されたエンタープライズでのみサポートされます。EMM が開始するフローによって作成されたエンタープライズでは、EMM が Enterprises.generateSignupUrl 呼び出しで指定されたコールバックでエンタープライズ ID を学習するため、ID の検索は必要ありません。

必須のクエリ パラメータ: domain

pullNotificationSet POST  /enterprises/pullNotificationSet リクエストで認証されたサービス アカウントに関連付けられているエンタープライズ用の通知セットを取得して返します。保留中の通知がない場合、通知セットは空になることがあります。
返された通知セットは、通知セットが空でない場合、Enterprises.AcknowledgeNotificationSet を呼び出して 20 秒以内に確認する必要があります。
20 秒以内に確認応答がない場合、通知は最終的に別の PullNotificationSet リクエストのレスポンスに再び含まれます。確認応答がない場合、最終的には Google Cloud Platform Pub/Sub システム ポリシーに従って削除されます。
通知を取得するために複数のリクエストが同時に実行される場合があります。その場合、保留中の通知（ある場合）は、各呼び出し元に分割されます（保留中の通知がある場合）。
通知が存在しない場合、空の通知リストが返されます。その後のリクエストで、利用可能になった通知が返されることがあります。
sendTestPushNotification POST  /enterprises/enterpriseId/sendTestPushNotification テスト通知を送信して、このエンタープライズの Google Cloud Pub/Sub サービスとの EMM 統合を検証します。
setAccount PUT  /enterprises/enterpriseId/account エンタープライズとして API の認証に使用するアカウントを設定します。
setStoreLayout PUT  /enterprises/enterpriseId/storeLayout 企業の店舗レイアウトを設定します。デフォルトでは、storeLayoutType は「basic」に設定され、基本的なストア レイアウトが有効になっています。基本レイアウトには、管理者によって承認され、ユーザーが利用できるプロダクトセットに追加されたアプリのみが含まれます（ setAvailableProductSet 呼び出しを使用）。ページ上のアプリは、プロダクト ID 値の順に並べ替えられます。カスタム ストア レイアウトを作成した場合（storeLayoutType = "custom" を設定してホームページを設定した場合）、基本的なストア レイアウトは無効になります。
登録を解除する POST  /enterprises/enterpriseId/unenroll 呼び出し元の 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 のみが設定されています。
update 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 指定されたデバイスにインストールされているすべてのアプリの詳細を取得します。
update PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId デバイスに最新バージョンのアプリをインストールするようリクエストします。アプリがすでにインストールされている場合は、必要に応じて最新バージョンに更新されます。

デバイスの管理対象設定

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 のみが設定されています。
update 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 のみが設定されます。
update 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

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 件です。

managed Google Play を使用してストアのレイアウトを設計して作成し、承認済みの商品をユーザーに表示する方法については、ストアのレイアウトの設計をご覧ください。
generateApprovalUrl POST  /enterprises/enterpriseId/products/productId/generateApprovalUrl iframe でレンダリングして商品の権限（存在する場合）を表示できる URL を生成します。エンタープライズ管理者は、そのプロダクトを承認するために、これらの権限を表示し、組織に代わって承認する必要があります。

管理者は、EMM コンソールの別の UI 要素を操作して、表示された権限を承認する必要があります。これにより、Products.approve 呼び出しでこの URL が approvalUrlInfo.approvalUrl プロパティとして使用され、プロダクトが承認されます。この URL は、最大 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 クエリに一致する承認済み商品、またはクエリがない場合すべての承認済み商品を検索します。
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 指定されたページのすべてのクラスタの詳細を取得します。
update 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 ストアのすべてのページの詳細を取得します。
update PUT  /enterprises/enterpriseId/storeLayout/pages/pageId ストアページのコンテンツを更新します。

Users

Users リソースについて詳しくは、リソースの表記のページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/androidenterprise/v1 を基準とします。
delete DELETE  /enterprises/enterpriseId/users/userId EMM 管理対象のユーザーを削除しました。
generateAuthenticationToken POST  /enterprises/enterpriseId/users/userId/authenticationToken デバイス ポリシー クライアントがデバイスに特定の EMM 管理対象ユーザー アカウントをプロビジョニングするために使用できる認証トークンを生成します。生成されたトークンは 1 回限りで、数分後に期限切れになります。

ユーザーあたり最大 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 を持つ対応するユーザーがすでに存在する場合、そのユーザーはリソースで更新されます。この場合、変更できるのは displayName フィールドのみです。
list GET  /enterprises/enterpriseId/users メインのメールアドレスでユーザーを検索します。これは Google 管理のユーザーでのみサポートされます。EMM 管理のユーザーの場合、ID は Users.insert 呼び出しの結果ですでに返されているため、ID の検索は必要ありません。

必須のクエリ パラメータ: email

revokeDeviceAccess DELETE  /enterprises/enterpriseId/users/userId/deviceAccess 現在ユーザーにプロビジョニングされているすべてのデバイスへのアクセス権を取り消します。ユーザーは、管理対象のデバイスで管理対象の Play ストアを使用できなくなります。

この呼び出しは、EMM 管理対象のアカウントでのみ機能します。
setAvailableProductSet PUT  /enterprises/enterpriseId/users/userId/availableProductSet ユーザーがアクセス権を持つプロダクトのセット（ホワイトリストに登録されたプロダクト）を変更します。ホワイトリストに登録できるのは、承認済みの商品または以前に承認された商品（承認が取り消された商品）のみです。
update 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 既存のウェブアプリを削除します。
get GET  /enterprises/enterpriseId/webApps/webAppId 既存のウェブアプリを取得します。
insert POST  /enterprises/enterpriseId/webApps 企業用の新しいウェブアプリを作成します。
list GET  /enterprises/enterpriseId/webApps 特定のエンタープライズのすべてのウェブアプリの詳細を取得します。
update PUT  /enterprises/enterpriseId/webApps/webAppId 既存のウェブアプリを更新します。