このリソースのメソッドの一覧は、このページの最後に掲載されています。
リソース表記
Enterprises リソースは、EMM と特定の組織間のバインディングを表します。このバインディングは、次の 2 つの方法のいずれかでインスタンス化できます。
- Google 管理ドメインをご利用のお客様の場合、
Enterprises.enroll
とEnterprises.setAccount
を使用して(管理コンソールと Google API コンソールから取得したアーティファクトとともに)、ほぼ手動のプロセスで EMM に送信します。 - managed Google Play アカウントをご利用のお客様の場合、
Enterprises.generateSignupUrl
とEnterprises.completeSignup
を、managed Google Play の登録 UI(Google 提供のメカニズム)とともに使用して、手動の手順なしでバインディングを作成します。
{ "kind": "androidenterprise#enterprise", "id":string , "primaryDomain":string , "name":string , "administrator": [ { "email":string } ], "enterpriseType":string , "managedGoogleDomainType":string }
プロパティ名 | 値 | 説明 | メモ |
---|---|---|---|
administrator[] |
list |
企業の管理者。これは、EMM が開始したフローによって作成された企業でのみサポートされます。 |
|
administrator[].email |
string |
管理者のメールアドレス。 | |
enterpriseType |
string |
企業のタイプ。 有効な値は次のとおりです。
|
|
id |
string |
企業の一意の ID。 |
|
kind |
string |
||
managedGoogleDomainType |
string |
管理対象の Google ドメインのタイプ。
有効な値は次のとおりです。
|
|
name |
string |
企業の名前(例: 「Example, Inc」)。 | |
primaryDomain |
string |
企業のプライマリ ドメイン(「example.com」など)。 |
メソッド
- acknowledgeNotificationSet
- Enterprises.PullNotificationSet から受信した通知を承認し、後続の呼び出しで同じ通知が返されないようにします。
- completeSignup
- 完了トークンとエンタープライズ トークンを指定して、登録フローを完了します。このリクエストは、特定のエンタープライズ トークンに対して複数回呼び出すことはできません。
- createWebToken
- 埋め込み可能な UI にアクセスするための一意のトークンを返します。ウェブ UI を生成するには、生成されたトークンを managed Google Play JavaScript API に渡します。各トークンは 1 つの UI セッションの開始にのみ使用できます。詳しくは、 JavaScript API ドキュメントをご覧ください。
- 登録
- 呼び出し元の EMM に企業を登録します。
- generateEnterpriseUpgradeUrl
- 既存の managed Google Play アカウント エンタープライズを Managed Google Domains にアップグレードするためのエンタープライズ アップグレード URL を生成します。
- generateSignupUrl
- 登録用 URL を生成します。
- get
- エンタープライズの名前とドメインを取得します。
- getServiceAccount
- サービス アカウントと認証情報を返します。サービス アカウントは、setAccount を呼び出してエンタープライズにバインドできます。このサービス アカウントは、このエンタープライズと EMM に固有のものであり、エンタープライズが未バインドの場合、削除されます。認証情報には秘密鍵データが含まれ、サーバーサイドには保存されません。
このメソッドは、Enterprises.Enroll または Enterprises.CompleteSignup を呼び出した後、Enterprises.SetAccount の前にのみ呼び出すことができます。それ以外の場合は、エラーが返されます。
最初の呼び出しの後に呼び出すと、一意の新しい認証情報セットが生成され、以前に生成された認証情報が無効になります。
サービス アカウントがエンタープライズにバインドされると、serviceAccountKeys リソースを使用して管理できるようになります。
. - getStoreLayout
- 企業のストア レイアウトを返します。ストアのレイアウトが設定されていない場合、ストアのレイアウト タイプとして「基本」が返され、ホームページは返されません。
- list
- ドメイン名でエンタープライズを検索します。これは、Google が開始する作成フローで作成されたエンタープライズでのみサポートされます。EMM が開始するフローによって作成されたエンタープライズでは、EMM が Enterprises.generateSignupUrl 呼び出しで指定されたコールバックでエンタープライズ ID を学習するため、ID の検索は必要ありません。
- pullNotificationSet
- リクエストで認証されたサービス アカウントに関連付けられているエンタープライズに対する通知セットを取得して返します。保留中の通知がない場合、通知セットは空になることがあります。
返された通知セットは、通知セットが空でない場合、Enterprises.AcknowledgeNotificationSet を呼び出して 20 秒以内に確認する必要があります。
20 秒以内に確認応答がない場合、通知は最終的に別の PullNotificationSet リクエストのレスポンスに再び含まれます。確認応答がない場合、最終的には Google Cloud Platform Pub/Sub システム ポリシーに従って削除されます。
通知を取得するために複数のリクエストが同時に実行される場合があります。その場合、保留中の通知(ある場合)は、各呼び出し元に分割されます(保留中の通知がある場合)。
通知が存在しない場合、空の通知リストが返されます。後続のリクエストでは、利用可能になった通知が返される場合があります。 - sendTestPushNotification
- テスト通知を送信して、このエンタープライズの Google Cloud Pub/Sub サービスとの EMM 統合を検証します。
- setAccount
- API への認証に使用するアカウントをエンタープライズとして設定します。
- setStoreLayout
- 企業の店舗レイアウトを設定します。デフォルトでは、storeLayoutType は「basic」に設定され、基本的なストア レイアウトが有効になっています。基本レイアウトには、管理者によって承認され、ユーザーが利用できるプロダクトセットに追加されたアプリのみが含まれます( setAvailableProductSet 呼び出しを使用)。ページ上のアプリは、プロダクト ID 値の順に並べ替えられます。カスタム ストア レイアウトを作成した場合(storeLayoutType = "custom" を設定してホームページを設定した場合)、基本的なストア レイアウトは無効になります。
- 登録を解除する
- 呼び出し元の EMM から企業の登録を解除します。