REST Resource: partners.customers

リソース: Company

ゼロタッチ販売パートナー API とお客様 API の販売パートナー、ベンダー、またはお客様。

JSON 表現
{
  "name": string,
  "companyId": string,
  "companyName": string,
  "ownerEmails": [
    string
  ],
  "adminEmails": [
    string
  ],
  "termsStatus": enum (TermsStatus),
  "skipWelcomeEmail": boolean,
  "languageCode": string,
  "googleWorkspaceAccount": {
    object (GoogleWorkspaceAccount)
  }
}
フィールド
name

string

出力専用。会社の API リソース名。リソース名は次のいずれかの形式です。

  • partners/[PARTNER_ID]/customers/[CUSTOMER_ID]
  • partners/[PARTNER_ID]/vendors/[VENDOR_ID]
  • partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]

サーバーによって割り当てられます。

companyId

string (int64 format)

出力専用。会社の ID。サーバーによって割り当てられます。

companyName

string

必須。会社の名前。(例: XYZ Corp)。ゼロタッチ登録ポータルで会社の従業員に表示されます。

ownerEmails[]

string

必須。入力のみのオーナーロールのお客様のユーザーのメールアドレス。少なくとも 1 つの owner_email が必要です。所有者は、管理者と同じアクセス権を持ちますが、組織のポータル ユーザーの追加、削除、編集も行うことができます。

adminEmails[]

string

省略可。お客様の管理者ロールにあるユーザーのメールアドレス。各メールアドレスは Google アカウントに関連付けられている必要があります。

termsStatus

enum (TermsStatus)

出力専用。会社のユーザーが最新の利用規約に同意しているかどうか。TermsStatus をご覧ください。

skipWelcomeEmail

boolean

入力のみのtrue に設定した場合、ウェルカム メールは顧客に送信されません。追加の DEVICE_PROTECTION サービスを使用してデバイスの申請を行う場合は、デバイスの申請時にお客様に個別のメールが届くため、ウェルカム メールはスキップすることをおすすめします。ゼロタッチのお客様でない場合、このフィールドは無視されます。

languageCode

string

入力のみのBCP47 言語コードで表される、顧客の優先言語 / 地域。このフィールドは入力時に検証され、サポートされていない言語コードを含むリクエストは拒否されます。サポート対象の言語コード: アラビア語(ar) 中国語(香港) 中国語(繁体) 中国語(繁体) 中国語(簡体)(zh-CN) 中国語(繁体)(zh-TW) チェコ語(cs) デンマーク語(da) オランダ語(nl) 英語(UK)(en-GB) 英語(US)(en-US) フィリピン語( fil) フィンランド語(fi) フランス語(fr)

googleWorkspaceAccount

object (GoogleWorkspaceAccount)

出力専用。このお客様に関連付けられている Google Workspace アカウント。顧客の会社に対してのみ使用します。

TermsStatus

企業がゼロタッチ登録の利用規約(ToS)に同意していること。1 人のユーザーがウェブポータルを使用して会社の利用規約に同意できます。

利用規約はバージョン管理されています。つまり、利用規約が変更されると、少なくとも 1 人のユーザーが新しい利用規約に同意する必要があります。最初のユーザーが新しい利用規約に同意するまで、会社の利用規約のステータスは TERMS_STATUS_STALE になります。

列挙型
TERMS_STATUS_NOT_ACCEPTED 会社のどのユーザーも利用規約に同意していません。
TERMS_STATUS_ACCEPTED 会社のユーザーの 1 人が利用規約に同意しました。
TERMS_STATUS_STALE 会社のどのユーザーも現在の利用規約に同意しておらず、少なくとも 1 人のユーザーが以前の利用規約に同意しています。

GoogleWorkspaceAccount

Google Workspace のお客様。

JSON 表現
{
  "customerId": string,
  "preProvisioningTokens": [
    string
  ]
}
フィールド
customerId

string

必須。お客様 ID。

preProvisioningTokens[]

string

出力専用。デバイスの登録に以前使用されていた事前プロビジョニング トークン。

メソッド

create

ゼロタッチ登録の顧客を作成する。

list

partnerId 引数で識別される販売パートナーに登録されている顧客を一覧表示します。