API Reference

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

リソースタイプ

  1. デバイス
  2. エンタープライズ
  3. 利用資格
  4. グループライセンス
  5. Grouplicenseusers
  6. インストール
  7. 管理対象設定（device）
  8. Managedconfigurationsforuser
  9. 管理対象構成の設定
  10. 権限
  11. プロダクト
  12. サービス アカウントキー
  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 のドキュメントをご覧ください。
enroll POST  /enterprises/enroll 呼び出し元の EMM に企業を登録します。

必須のクエリ パラメータ: token
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 エンタープライズのストア レイアウトを返します。ストア レイアウトが設定されていない場合、ストア レイアウト タイプとして「basic」を返し、ホームページは返しません。
list GET  /enterprises ドメイン名で企業を検索します。これは、Google が開始する作成フローで作成されたエンタープライズでのみサポートされます。EMM 開始フローで作成された企業では、Enterprises.generateSignupUrl 呼び出しで指定されたコールバックで企業 ID が学習されるため、ID の検索は必要ありません。

必須のクエリ パラメータ: domain
pullNotificationSet POST  /enterprises/pullNotificationSet リクエストに対して認証されたサービス アカウントに関連付けられた企業に対して、通知セットを pull して返します。保留中の通知がない場合は、通知セットが空になることがあります。
通知セットが空でない限り、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」に設定し、ホームページを設定すると）、基本ストア レイアウトが無効になります。
unenroll 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 リソースの詳細については、リソースの表記ページをご覧ください。

メソッド 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 アプリの最新バージョンをデバイスにインストールするようリクエストします。アプリがすでにインストールされている場合は、必要に応じて最新バージョンに更新されます。

デバイスの管理対象設定

デバイスの管理対象構成リソースの詳細については、リソースの表記ページをご覧ください。

メソッド 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

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

メソッド 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 リソースの詳細については、リソースの表記ページをご覧ください。

メソッド 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 です。

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

管理者は、EMM コンソールの個別の UI 要素を操作することで、表示された権限を承認する必要があります。これにより、プロダクトを承認するための Products.approve 呼び出しの approvalUrlInfo.approvalUrl プロパティとして、この URL の使用がトリガーされます。この 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 クエリに一致する承認済みの商品を検索します。クエリがない場合は、承認済みのすべての商品を探します。
不承認 POST  /enterprises/enterpriseId/products/productId/unapprove 指定したサービス（および該当する場合は関連するアプリの権限）を不承認にします

サービス アカウントキー

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 リソースについて詳しくは、リソースの表記のページをご覧ください。

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

ユーザー 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 の管理対象ユーザーに対しては、Users.insert 呼び出しの結果ですでに ID が返されているため、ID の検索は必要ありません。

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

この通話は EMM の管理対象アカウントでのみ利用できます。
setAvailableProductSet PUT  /enterprises/enterpriseId/users/userId/availableProductSet ユーザーがアクセスできる一連のアイテム（whitelisted許可リストに登録された商品）を変更します。許可リストに登録できるのは、承認された商品または以前に承認された商品（承認が取り消された商品）のみです。
update PUT  /enterprises/enterpriseId/users/userId EMM の管理対象ユーザーの詳細を更新します。

EMM の管理対象ユーザーのみが使用できます（Google の管理対象ユーザーでは使用できません）。 リクエストの本文でユーザー リソースの新しい詳細を渡します。変更できるのは 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 既存のウェブアプリを更新します。