API Reference

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

リソースタイプ

  1. デバイス
  2. エンタープライズ
  3. 利用資格
  4. グループ ライセンス
  5. グループ ライセンス ユーザー
  6. インストール
  7. managedconfigurationsfordevice
  8. Managedconfigurationsforuser
  9. Managedconfigurationssettings
  10. 権限
  11. プロダクト
  12. サービスアカウントキー
  13. Storelayoutclusters
  14. ストア レイアウト ページ
  15. ユーザー
  16. ウェブアプリ

デバイス

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

メソッド 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 が管理するユーザーに対してのみサポートされます。
update 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 を生成するには、生成されたトークンを 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 を EMM が学習するため、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 リクエスト 説明
特に明記されていない限り、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 のみが設定されます。 注: このアイテムのサポートは終了しました。新しい統合ではこのメソッドは使用できません。 新しい推奨事項を参照してください。
update PUT  /enterprises/enterpriseId/users/userId/entitlements/entitlementId ユーザーの利用資格をアプリに追加または更新します。注: このアイテムのサポートは終了しました。新しい統合ではこのメソッドは使用できません。 新しい推奨事項を参照してください。

グループ ライセンス

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

メソッド HTTP リクエスト 説明
特に明記されていない限り、https://www.googleapis.com/androidenterprise/v1 からの相対 URI
get GET  /enterprises/enterpriseId/groupLicenses/groupLicenseId プロダクトの企業のグループ ライセンスの詳細を取得します。注: このアイテムのサポートは終了しました。新しい統合ではこのメソッドは使用できません。 新しい推奨事項を参照してください。
list GET  /enterprises/enterpriseId/groupLicenses 企業がグループ ライセンスを持っているすべてのプロダクトの ID を取得します。注: このアイテムのサポートは終了しました。新しい統合ではこのメソッドは使用できません。 新しい推奨事項を参照してください。

グループ ライセンス ユーザー

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 指定したデバイスにインストールされているすべてのアプリの詳細を取得します。
update PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId 最新バージョンのアプリをデバイスにインストールするためのリクエスト。アプリがすでにインストールされている場合は、必要に応じて最新バージョンに更新されます。

Managedconfigurationsfordevice

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 のみが設定されます。
update PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId 指定したデバイスについて、アプリについてデバイスごとの管理対象設定を追加または更新します。

Managedconfigurationsforuser

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 のみが設定されます。
update PUT  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId 指定したユーザーに対して、アプリの管理対象設定を追加または更新します。 管理対象構成の iframe をサポートしている場合は、リクエストで mcmId とそれに関連付けられた構成変数(存在する場合)を指定することで、ユーザーに管理対象構成を適用できます。または、すべての EMM で管理対象プロパティのリストを渡すことで管理対象設定を適用できます。

Managedconfigurationssettings

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 アプリの権限の詳細を取得します。

サービス

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

メソッド HTTP リクエスト 説明
特に明記されていない限り、https://www.googleapis.com/androidenterprise/v1 からの相対 URI
承認 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 リクエスト 説明
特に明記されていない限り、https://www.googleapis.com/androidenterprise/v1 からの相対 URI
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 リクエスト 説明
特に明記されていない限り、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 指定されたページ内のすべてのクラスタの詳細を取得します。
update 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 ストア内のすべてのページの詳細を取得します。
update PUT  /enterprises/enterpriseId/storeLayout/pages/pageId ストアページのコンテンツを更新します。

ユーザー

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

メソッド HTTP リクエスト 説明
特に明記されていない限り、https://www.googleapis.com/androidenterprise/v1 からの相対 URI
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 リクエスト 説明
特に明記されていない限り、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 指定した企業のすべてのウェブアプリの詳細を取得します。
update PUT  /enterprises/enterpriseId/webApps/webAppId 既存のウェブアプリを更新します。