REST Resource: enterprises

リソース: Enterprise

企業に適用された構成。

JSON 表現 
{
  "name": string,
  "enabledNotificationTypes": [
    enum (NotificationType)
  ],
  "pubsubTopic": string,
  "primaryColor": integer,
  "logo": {
    object (ExternalData)
  },
  "enterpriseDisplayName": string,
  "termsAndConditions": [
    {
      object (TermsAndConditions)
    }
  ],
  "appAutoApprovalEnabled": boolean,
  "signinDetails": [
    {
      object (SigninDetail)
    }
  ],
  "contactInfo": {
    object (ContactInfo)
  },
  "googleAuthenticationSettings": {
    object (GoogleAuthenticationSettings)
  },
  "enterpriseType": enum (EnterpriseType),
  "managedGooglePlayAccountsEnterpriseType": enum (ManagedGooglePlayAccountsEnterpriseType),
  "managedGoogleDomainType": enum (ManagedGoogleDomainType)
}
フィールド
name

string

作成時にサーバーによって生成されるエンタープライズの名前（enterprises/{enterpriseId} 形式）。
enabledNotificationTypes[]

enum (NotificationType)

企業向けに有効になっている Google Pub/Sub 通知のタイプ。
pubsubTopic

string

Pub/Sub 通知がパブリッシュされるトピック（projects/{project}/topics/{topic} 形式）。このフィールドは、Pub/Sub 通知が有効になっている場合にのみ必要です。
primaryColor

integer

デバイス管理アプリの UI に表示する主な色を示す RGB 形式の色。色のコンポーネントは (red << 16) | (green << 8) | blue として保存されます。各コンポーネントの値は 0 ～ 255 の範囲です。
enterpriseDisplayName

string

ユーザーに表示される企業の名前。このフィールドの最大長は 100 文字です。
termsAndConditions[]

object (TermsAndConditions)

この企業向けにデバイスをプロビジョニングする際に同意する必要がある利用規約。このリスト内の値ごとに用語のページが生成されます。
appAutoApprovalEnabled
(deprecated)

boolean

非推奨で未使用。
signinDetails[]

object (SigninDetail)

企業のログイン情報。
contactInfo

object (ContactInfo)

EMM で管理されている企業の連絡先情報。
googleAuthenticationSettings

object (GoogleAuthenticationSettings)

Google が提供するユーザー認証の設定。
enterpriseType

enum (EnterpriseType)

出力専用。企業のタイプ。
managedGooglePlayAccountsEnterpriseType

enum (ManagedGooglePlayAccountsEnterpriseType)

出力専用。managed Google Play アカウント エンタープライズのタイプ。
managedGoogleDomainType

enum (ManagedGoogleDomainType)

出力専用。管理対象の Google ドメインのタイプ。

NotificationType

デバイス管理サーバーが Google Pub/Sub を介して送信する可能性のある通知の種類。

列挙型
NOTIFICATION_TYPE_UNSPECIFIED この値は無視されます。
ENROLLMENT デバイスが登録されたときに送信される通知。
COMPLIANCE_REPORT

サポート終了。
STATUS_REPORT デバイスがステータス レポートを発行したときに送信される通知。
COMMAND デバイス コマンドが完了したときに送信される通知。
USAGE_LOGS デバイスが BatchUsageLogEvents を送信したときに送信される通知。
ENTERPRISE_UPGRADE エンタープライズ アップグレード用に送信される通知。エンタープライズ アップグレードとは、managed Google Play アカウント エンタープライズを Managed Google Domains にアップグレードするプロセスです。

ExternalData

外部の場所にホストされているデータ。データは Android Device Policy によってダウンロードされ、ハッシュと照合されます。

JSON 表現 
{
  "url": string,
  "sha256Hash": string
}
フィールド
url

string

データの絶対 URL。http または https スキームを使用する必要があります。Android Device Policy は GET リクエストで認証情報を提供しないため、URL は一般公開されている必要があります。URL に長いランダムなコンポーネントを含めることで、攻撃者が URL を発見するのを防ぐことができます。
sha256Hash

string

URL でホストされているコンテンツの Base64 エンコードされた SHA-256 ハッシュ。コンテンツがこのハッシュと一致しない場合、Android Device Policy はデータを使用しません。

TermsAndConditions

プロビジョニング時に同意する利用規約ページ。

JSON 表現 
{
  "header": {
    object (UserFacingMessage)
  },
  "content": {
    object (UserFacingMessage)
  }
}
フィールド
header

object (UserFacingMessage)

HTML コンテンツの上に表示される短いヘッダー。
content

object (UserFacingMessage)

整形式の HTML 文字列。クライアントで android.text.Html#fromHtml を使用して解析されます。

SigninDetail

企業のログインの詳細を含むリソース。enterprises を使用して、特定の企業の SigninDetail を管理します。

企業の場合、次の 3 つのフィールド（signinUrl、allowPersonalUsage、tokenTag）の組み合わせによって一意に識別される SigninDetail をいくつでも作成できます。同じ（signinUrl、allowPersonalUsage、tokenTag）を持つ 2 つの SigninDetail を作成することはできません（tokenTag は省略可能なフィールドです）。

Patch: オペレーションは、SigninDetails の現在のリストを SigninDetails の新しいリストで更新します。

  • 保存された SigninDetail 構成が渡されると、同じ signinEnrollmentToken と qrCode が返されます。
  • 保存されていない同一の SigninDetail 構成を複数渡すと、それらの SigninDetail 構成のうち最初のものが保存されます。
  • 構成がすでに存在する場合、特定のパッチ API 呼び出しで複数回リクエストすることはできません。そうしないと、重複キーエラーが発生し、オペレーション全体が失敗します。
  • リクエストから特定の SigninDetail 構成を削除すると、ストレージからも削除されます。その後、同じ SigninDetail 構成に対して別の signinEnrollmentToken と qrCode をリクエストできます。
JSON 表現 
{
  "signinUrl": string,
  "signinEnrollmentToken": string,
  "qrCode": string,
  "allowPersonalUsage": enum (AllowPersonalUsage),
  "defaultStatus": enum (SigninDetailDefaultStatus),
  "tokenTag": string
}
フィールド
signinUrl

string

ログイン登録トークンでデバイスがプロビジョニングされた場合の認証用のログイン URL。ログイン エンドポイントは、ログインに成功した場合は https://enterprise.google.com/android/enroll?et= の形式の URL で、ログインに失敗した場合は https://enterprise.google.com/android/enroll/invalid の形式の URL で認証フローを終了する必要があります。
signinEnrollmentToken

string

カスタム ログインフローをトリガーするために使用される企業全体の登録トークン。サーバーによって生成される読み取り専用のフィールドです。
qrCode

string

この登録トークンでデバイスを登録するための QR コードを生成するために使用できる UTF-8 表現の JSON 文字列。NFC を使用してデバイスを登録するには、NFC レコードに JSON のプロパティのシリアル化された java.util.Properties 表現が含まれている必要があります。サーバーによって生成される読み取り専用のフィールドです。
allowPersonalUsage

enum (AllowPersonalUsage)

この登録トークンでプロビジョニングされたデバイスで個人使用を許可するかどうかを制御します。

会社所有デバイスの場合:

  • 個人用デバイスでの使用を有効にすると、ユーザーはデバイスで仕事用プロファイルを設定できます。
  • 個人使用を無効にするには、ユーザーがデバイスを完全管理対象デバイスとしてプロビジョニングする必要があります。

個人所有のデバイスの場合:

  • 個人用デバイスでの使用を有効にすると、ユーザーはデバイスで仕事用プロファイルを設定できます。
  • 個人利用を無効にすると、デバイスのプロビジョニングは行われません。個人所有のデバイスでは、個人使用を無効にすることはできません。
defaultStatus

enum (SigninDetailDefaultStatus)

省略可。企業でログイン URL をデフォルトで使用するかどうか。defaultStatus が SIGNIN_DETAIL_IS_DEFAULT に設定された SigninDetail は、Google アカウントの登録方法に使用されます。企業の signinDetails のうち、defaultStatus を SIGNIN_DETAIL_IS_DEFAULT に設定できるのは 1 つのみです。Enterprise に 1 つ以上の signinDetails があり、そのいずれにも defaultStatus が SIGNIN_DETAIL_IS_DEFAULT に設定されていない場合、リストの最初の signinDetails が選択され、defaultStatus が SIGNIN_DETAIL_IS_DEFAULT に設定されます。Enterprise に signinDetails が指定されていない場合、Google アカウントのデバイス登録は失敗します。
tokenTag

string

SigninDetail のインスタンスを区別するための EMM 指定のメタデータ。

SigninDetailDefaultStatus

企業でログイン URL をデフォルトで使用するかどうか。

列挙型
SIGNIN_DETAIL_DEFAULT_STATUS_UNSPECIFIED SIGNIN_DETAIL_IS_NOT_DEFAULT と同じです。
SIGNIN_DETAIL_IS_DEFAULT ログイン URL は、デフォルトで企業で使用されます。
SIGNIN_DETAIL_IS_NOT_DEFAULT ログイン URL は、デフォルトでは企業で使用されません。

ContactInfo

managed Google Play エンタープライズの連絡先情報。

JSON 表現 
{
  "contactEmail": string,
  "dataProtectionOfficerName": string,
  "dataProtectionOfficerEmail": string,
  "dataProtectionOfficerPhone": string,
  "euRepresentativeName": string,
  "euRepresentativeEmail": string,
  "euRepresentativePhone": string
}
フィールド
contactEmail

string

連絡先のメールアドレス。管理対象 Google Play に関する重要なお知らせの送信に使用されます。
dataProtectionOfficerName

string

データ保護オフィサーの名前。
dataProtectionOfficerEmail

string

データ保護オフィサーのメールアドレス。メールアドレスは検証されますが、確認はされません。
dataProtectionOfficerPhone

string

データ保護オフィサーの電話番号。電話番号は検証されますが、確認はされません。
euRepresentativeName

string

EU 担当者の名前。
euRepresentativeEmail

string

EU 担当者のメールアドレス。メールアドレスは検証されますが、確認はされません。
euRepresentativePhone

string

EU 担当者の電話番号。電話番号は検証済みですが、確認されていません。

GoogleAuthenticationSettings

Google が提供するユーザー認証の設定が含まれます。

JSON 表現 
{
  "googleAuthenticationRequired": enum (GoogleAuthenticationRequired)
}
フィールド
googleAuthenticationRequired

enum (GoogleAuthenticationRequired)

出力専用。登録プロセス中に Google によるユーザー認証が必要かどうか。IT 管理者は、ナレッジ ワーカーのデバイスで Google 認証を有効にするかどうかを指定できます。この値は Google 管理コンソールからのみ設定できます。Google 認証は signinUrl で使用できます。Google 認証が必要で signinUrl が指定されている場合、Google 認証は signinUrl の前に起動されます。

GoogleAuthenticationRequired

この企業で Google 認証が必要かどうかを設定します。

列挙型
GOOGLE_AUTHENTICATION_REQUIRED_UNSPECIFIED この値は使用されません。
NOT_REQUIRED Google 認証は必要ありません。
REQUIRED ユーザーは Google による認証を正常に完了する必要があります。

EnterpriseType

企業のタイプ。

列挙型
ENTERPRISE_TYPE_UNSPECIFIED この値は使用されません。
MANAGED_GOOGLE_DOMAIN 企業が管理対象の Google ドメインに属している。
MANAGED_GOOGLE_PLAY_ACCOUNTS_ENTERPRISE エンタープライズは managed Google Play アカウント エンタープライズです。

ManagedGooglePlayAccountsEnterpriseType

managed Google Play アカウント エンタープライズのタイプ。

列挙型
MANAGED_GOOGLE_PLAY_ACCOUNTS_ENTERPRISE_TYPE_UNSPECIFIED managed Google Play アカウント エンタープライズのタイプが指定されていません。
CUSTOMER_MANAGED 企業は顧客管理である
EMM_MANAGED 企業は EMM 管理対象です（非推奨）。

ManagedGoogleDomainType

管理対象の Google ドメインのタイプ。

列挙型
MANAGED_GOOGLE_DOMAIN_TYPE_UNSPECIFIED 管理対象の Google ドメインのタイプが指定されていません。
TYPE_TEAM 管理対象の Google ドメインはメールアドレスが確認済みのチームです。
TYPE_DOMAIN 管理対象の Google ドメインの所有権が確認されている。

メソッド

create

 企業を作成します。

delete

 エンタープライズと、それに関連付けられているすべてのアカウントとデータを完全に削除します。

generateEnterpriseUpgradeUrl

 既存の managed Google Play アカウント エンタープライズを Managed Google Domains にアップグレードするためのエンタープライズ アップグレード URL を生成します。

get

 企業を取得します。

list

 EMM で管理されている企業を一覧表示します。

patch

 企業を更新します。