このリソースのメソッドの一覧は、このページの最後に掲載されています。
リソース表記
Enterprises リソースは、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 } ], "googleAuthenticationSettings": { "googleAuthenticationRequired": string, "dedicatedDevicesAllowed": string, "createdAt": { "seconds": long, "nanos": integer }, "updatedAt": { "seconds": long, "nanos": integer } }, "enterpriseType": string, "managedGoogleDomainType": string }
プロパティ名 | 値 | 説明 | メモ |
---|---|---|---|
administrator[] |
list |
企業の管理者。これは、EMM を起点とするフローで作成された企業でのみサポートされます。 |
|
administrator[].email |
string |
管理者のメールアドレス。 | |
enterpriseType |
string |
企業のタイプ。 有効な値は次のとおりです。
|
|
googleAuthenticationSettings |
nested object |
Google が提供するユーザー認証の設定。 | |
googleAuthenticationSettings.createdAt |
nested object |
設定が最初に作成または変更されたときのタイムスタンプ。 | |
googleAuthenticationSettings.createdAt.nanos |
integer |
非負の小数以下の秒数(ナノ秒単位)。小数以下を含む負の秒の値は、時間を前方にカウントする負ではない nanos 値を持つ必要があります。0~999,999,999 の範囲(境界を含む)になります。 | |
googleAuthenticationSettings.createdAt.seconds |
long |
UNIX エポック 1970-01-01T00:00:00Z からの UTC 時刻の秒数を表します。0001-01-01T00:00:00Z から 9999-12-31T23:59:59Z の範囲(境界を含む)になります。 | |
googleAuthenticationSettings.dedicatedDevicesAllowed |
string |
専用デバイスが許可されているかどうか。 有効な値は次のとおりです。
|
|
googleAuthenticationSettings.googleAuthenticationRequired |
string |
Google 認証が必要かどうか。 有効な値は次のとおりです。
|
|
googleAuthenticationSettings.updatedAt |
nested object |
設定が最後に変更されたときのタイムスタンプ。 | |
googleAuthenticationSettings.updatedAt.nanos |
integer |
非負の小数以下の秒数(ナノ秒単位)。小数以下を含む負の秒の値は、時間を前方にカウントする負ではない nanos 値を持つ必要があります。0~999,999,999 の範囲(境界を含む)になります。 | |
googleAuthenticationSettings.updatedAt.seconds |
long |
UNIX エポック 1970-01-01T00:00:00Z からの UTC 時刻の秒数を表します。0001-01-01T00:00:00Z から 9999-12-31T23:59:59Z の範囲(境界を含む)になります。 | |
id |
string |
企業の一意の ID。 |
|
id |
string |
企業の一意の ID。 |
|
kind |
string |
||
managedGoogleDomainType |
string |
管理対象の Google ドメインのタイプ。
有効な値は次のとおりです。
|
|
name |
string |
企業の名前(「Example, Inc」など)。 | |
primaryDomain |
string |
企業のプライマリ ドメイン(「example.com」など)。 |
メソッド
- acknowledgeNotificationSet
- 企業から受信した通知を 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
- 企業のストア レイアウトを返します。ストア レイアウトが設定されていない場合は、ストア レイアウト タイプとして「basic」を返し、ホームページは返しません。
- list
- ドメイン名で企業を検索します。これは、Google が開始した作成フローで作成された企業でのみサポートされます。EMM によって開始されたフローで作成された企業の場合、ID のルックアップは必要ありません。EMM は、Enterprises.generateSignupUrl 呼び出しで指定されたコールバックで企業 ID を学習するためです。
- pullNotificationSet
- リクエストで認証されたサービス アカウントに関連付けられている企業向けに設定された通知を取得して返します。保留中の通知がない場合、通知セットは空になることがあります。
返された通知セットが空でない限り、20 秒以内に Enterprises.AcknowledgeNotificationSet を呼び出して通知セットを確認する必要があります。
20 秒以内に確認されなかった通知は、最終的に別の PullNotificationSet リクエストのレスポンスに再び含まれます。確認されなかった通知は、最終的に Google Cloud Platform Pub/Sub システム ポリシーに従って削除されます。
通知を取得するために複数のリクエストが同時に実行されることがあります。その場合、保留中の通知(ある場合)は、保留中の通知がある場合は、各呼び出し元に分割されます。
通知がない場合は、空の通知リストが返されます。後続のリクエストでは、通知が利用可能になると、より多くの通知が返されることがあります。 - sendTestPushNotification
- この企業で Google Cloud Pub/Sub サービスとの EMM 統合を検証するためのテスト通知を送信します。
- setAccount
- API の認証に使用するアカウントをエンタープライズとして設定します。
- setStoreLayout
- 企業のストア レイアウトを設定します。デフォルトでは、storeLayoutType は「basic」に設定され、基本的なストア レイアウトが有効になっています。基本レイアウトには、管理者が承認し、ユーザーが利用できるプロダクト セットに追加されたアプリ( setAvailableProductSet 呼び出しを使用)のみが含まれます。ページ上のアプリは、プロダクト ID 値の順に並べ替えられます。ストアのカスタム レイアウトを作成した場合(storeLayoutType = "custom" を設定してホームページを設定した場合)、ストアの基本レイアウトは無効になります。
- 登録解除
- 呼び出し元の EMM から企業を登録解除します。