API Reference

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

リソースタイプ

  1. デバイス
  2. エンタープライズ
  3. 利用資格
  4. グループ ライセンス
  5. Grouplicenseusers
  6. インストール
  7. Managedconfigurationsfordevice
  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 最後のレポートの生成以降にデバイス上で行われたアプリの状態の変化を含むレポートをアップロードします。このメソッドは、1 つのデバイスから 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 を取得します。
setStatesetState 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 が開始したフローで作成された企業では、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" に設定してホームページを設定すると)、基本的なストア レイアウトは無効になります。
登録解除 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 デバイスへのアプリの最新バージョンのインストールをリクエストします。アプリがすでにインストールされている場合は、必要に応じて最新バージョンに更新されます。

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

メソッド 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 クエリと一致する承認済み商品を検索します。クエリがない場合は承認済みのすべての商品を検索します。注: このアイテムは非推奨になりました。新しい統合ではこのメソッドは使用できません。 新しい推奨事項をご覧ください。
不承認 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 リソースには、accountIdentifieraccountType を含める必要があります。

対応するユーザーが同じアカウント ID ですでに存在する場合、そのユーザーはリソースで更新されます。この場合、displayName フィールドのみを変更できます。

list GET  /enterprises/enterpriseId/users メインのメールアドレスでユーザーを検索します。 これは、Google が管理するユーザーに対してのみサポートされます。EMM で管理されているユーザーの場合、ID は Users.insert 呼び出しの結果ですでに返されているため、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 の管理対象ユーザーには使用できません)。 リクエスト本文の Users リソースに新しい詳細を渡します。変更できるのは displayName フィールドのみです。他のフィールドは、未設定のままにするか、現在アクティブな値にする必要があります。

ウェブアプリ

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

メソッド 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 既存のウェブアプリを更新します。