API Reference

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

リソースタイプ

  1. デバイス
  2. Enrollmenttokens
  3. 企業
  4. 利用資格
  5. Grouplicenses
  6. Grouplicenseusers
  7. インストール数
  8. Managedconfigurationsfordevice
  9. Managedconfigurationsforuser
  10. Managedconfigurationssettings
  11. 権限
  12. プロダクト
  13. Serviceaccountkeys
  14. Storelayoutclusters
  15. Storelayoutpages
  16. ユーザー
  17. ウェブアプリ

デバイス

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 でアカウントを制限するをご覧ください。

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

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

pullNotificationSet POST  /enterprises/pullNotificationSet リクエストで認証されたサービス アカウントに関連付けられている企業向けに設定された通知を取得して返します。保留中の通知がない場合、通知セットは空になることがあります。
返された通知セットが空でない限り、20 秒以内に Enterprises.AcknowledgeNotificationSet を呼び出して通知セットを確認する必要があります。
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

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 呼び出しの approvalUrlInfo.approvalUrl プロパティとしてこの URL が使用され、プロダクトが承認されます。この URL は、権限を最大 1 日間表示するためにのみ使用できます。
get GET  /enterprises/enterpriseId/products/productId 企業管理者向けに表示する商品の詳細を取得します。
getAppRestrictionsSchema GET  /enterprises/enterpriseId/products/productId/appRestrictionsSchema このプロダクトの設定可能なプロパティを定義するスキーマを取得します。すべてのプロダクトにスキーマがありますが、管理対象の構成が定義されていない場合、このスキーマは空になることがあります。このスキーマを使用して、管理者がプロダクトを構成できる UI を作成できます。この 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 指定されたページにあるすべてのクラスタの詳細を取得します。
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 が含まれている必要があります。

同じアカウント識別子を持つ対応するユーザーがすでに存在する場合、ユーザーはリソースで更新されます。この場合、displayName フィールドのみを変更できます。
list GET  /enterprises/enterpriseId/users メインのメールアドレスでユーザーを検索します。これは、Google 管理ユーザーでのみサポートされています。EMM 管理対象ユーザーの場合、ID は Users.insert 呼び出しの結果ですでに返されているため、ID のルックアップは必要ありません。

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

revokeDeviceAccess DELETE  /enterprises/enterpriseId/users/userId/deviceAccess 現在ユーザーにプロビジョニングされているすべてのデバイスへのアクセス権を取り消します。ユーザーは、管理対象デバイスで managed Google 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 既存のウェブアプリを更新します。