このリソースのメソッドの一覧は、このページの最後に掲載されています。
リソース表記
エンタープライズ リソースは、EMM と特定の組織との間のバインディングを表します。このバインディングは、この API を使用して、次の 2 つの異なる方法のいずれかでインスタンス化できます。
- Google が管理するドメインのお客様の場合、このプロセスには
Enterprises.enrollとEnterprises.setAccountを使用し（管理コンソールや Google API Console から取得したアーティファクトも併せて）、ほぼ手動で 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
}
]
}
| プロパティ名 | 値 | 説明 | メモ |
|---|---|---|---|
administrator[] |
list |
企業の管理者。この機能は、EMM で開始されたフローで作成されたエンタープライズでのみサポートされています。 |
|
administrator[].email |
string |
管理者のメールアドレス。 | |
id |
string |
企業の一意の ID。 |
|
kind |
string |
||
name |
string |
企業の名前（例: 「Example, Inc」）。 | |
primaryDomain |
string |
企業のプライマリ ドメイン（「example.com」など）。 |
Methods
- acknowledgeNotificationSet
- Enterprises.PullNotificationSet から受信した通知を確認し、後続の呼び出しで同じ通知を返さないようにします。
- completeSignup
- 完了トークンとエンタープライズ トークンを指定して、登録フローを完了します。このリクエストを特定のエンタープライズ トークンに対して複数回呼び出すことはできません。
- createWebToken
- 埋め込み可能な UI にアクセスするための一意のトークンを返します。ウェブ UI を生成するには、生成されたトークンを managed Google Play JavaScript API に渡します。各トークンは 1 つの UI セッションの開始にのみ使用できます。詳しくは、 JavaScript API のドキュメントをご覧ください。
- 登録
- 通話元の EMM に企業を登録します。
- generateSignupUrl
- 登録 URL を生成します。
- get
- 企業の名前とドメインを取得します。
- getServiceAccount
- サービス アカウントと認証情報を返します。setAccount を呼び出すと、サービス アカウントを企業にバインドできます。サービス アカウントはこの企業と EMM に固有のものであり、エンタープライズがバインド解除されると削除されます。認証情報には秘密鍵データが含まれており、サーバー側に保存されることはありません。
このメソッドは、Enterprises.Enroll または Enterprises.CompleteSignup の呼び出し後、Enterprises.SetAccount の前にのみ呼び出すことができます。それ以外の場合はエラーを返します。
最初の呼び出しの後続の呼び出しでは、新しい一意の認証情報セットが生成され、以前に生成された認証情報が無効になります。
サービス アカウントが企業にバインドされると、serviceAccountKeys リソースを使用して管理できるようになります。 - getStoreLayout
- 企業のストア レイアウトを返します。ストア レイアウトが設定されていない場合、ストア レイアウト タイプとして「basic」を返し、ホームページは返しません。
- list
- ドメイン名で企業を検索します。これは、Google が開始した作成フローで作成されたエンタープライズでのみサポートされています。EMM が開始したフローで作成された企業では、EMM が Enterprises.generateSignupUrl 呼び出しで指定されたコールバックで企業 ID を学習するため、ID のルックアップは必要ありません。
- pullNotificationSet
- リクエストに対して認証されたサービス アカウントに関連付けられている企業向けの通知セットを pull して返します。保留中の通知がない場合は、通知セットが空になることがあります。
返された通知セットは、通知セットが空の場合を除いて、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 から企業の登録を解除します。