REST Resource: accounts

リソース: Account

アカウントはビジネス情報を格納するコンテナです。ビジネス用のビジネス情報を管理しているユーザーがお客様のみの場合は、個人の Google アカウントを使用できます。複数のユーザーと共同でビジネス情報を管理するには、ビジネス アカウントを作成します。

JSON 表現 
{
  "name": string,
  "accountName": string,
  "primaryOwner": string,
  "type": enum (AccountType),
  "role": enum (AccountRole),
  "verificationState": enum (VerificationState),
  "vettedState": enum (VettedState),
  "accountNumber": string,
  "permissionLevel": enum (PermissionLevel),
  "organizationInfo": {
    object (OrganizationInfo)
  }
}
フィールド
name

string

変更不可。リソース名（accounts/{account_id} 形式）。
accountName

string

必須。アカウントの名前。アカウントの種類が PERSONAL の場合、これはユーザー アカウントの姓と名です。
primaryOwner

string

必須。入力のみ。作成するアカウントのメインのオーナーとなるアカウントのリソース名。accounts/{account_id} の形式にする必要があります。
type

enum (AccountType)

必須。アカウントのタイプが含まれます。この API を使用して、タイプ PERSONAL および ORGANIZATION のアカウントを作成することはできません。
role

enum (AccountRole)

出力のみ。このアカウントの AccountRole を指定します。
verificationState

enum (VerificationState)

出力のみ。オーナー確認が完了すると、今後作成されるビジネス情報は自動的に Google マップに接続され、管理を必要とすることなく Google+ ページが作成されます。
vettedState

enum (VettedState)

出力のみ。アカウントが Google によって精査されているかどうかを示します。審査済みのアカウントは、VETTED_PARTNER の方法でビジネスのオーナー確認を行うことができます。
accountNumber

string

出力のみ。アカウントの参照番号（プロビジョニングされている場合）。
permissionLevel

enum (PermissionLevel)

出力のみ。このアカウントに対してユーザーが持つ権限レベルを指定します。
organizationInfo

object (OrganizationInfo)

出力のみ。組織に関する追加情報。組織アカウントにのみ入力されます。

AccountType

アカウントの種類（個人用/ユーザー アカウント、ビジネス アカウント）を示します。

列挙型
ACCOUNT_TYPE_UNSPECIFIED 指定されていません。
PERSONAL エンドユーザー アカウント。
LOCATION_GROUP ビジネスのグループ。詳しくは、ヘルプセンターの記事をご覧ください。
USER_GROUP 組織のスタッフをグループに分けるためのユーザー グループ。詳しくは、ヘルプセンターの記事をご覧ください。
ORGANIZATION 会社を表す組織。詳しくは、ヘルプセンターの記事をご覧ください。

AccountRole

認証されたユーザーがこのアカウントに対して持っているアクセス権を示します。詳しくは、ヘルプセンターの記事をご覧ください。

列挙型
ACCOUNT_ROLE_UNSPECIFIED 指定されていません。
PRIMARY_OWNER このユーザーがアカウントのメインの所有者です。
OWNER アカウントのユーザー オーナー。
MANAGER このユーザーはこのアカウントを管理できます。
SITE_MANAGER アカウントの一部の機能は、ユーザーが管理できます。

VerificationState

アカウントの確認ステータスを示します。

列挙型
VERIFICATION_STATE_UNSPECIFIED 指定されていません。
VERIFIED 確認済みのアカウント。
UNVERIFIED 確認が済んでおらず、確認がリクエストされていないアカウントです。
VERIFICATION_REQUESTED 確認がリクエストされたものの、確認は済んでいないアカウント。

VettedState

アカウントが審査された状態を示します。

列挙型
VETTED_STATE_UNSPECIFIED 指定なし
NOT_VETTED アカウントは Google によって精査されていません。
VETTED アカウントが Google によって審査され、有効な状態である。審査済みのグループ アカウントに直接アクセスできるアカウントは、自動的に審査されます。
INVALID アカウントは審査されましたが、無効な状態です。アカウントは、未検証のアカウントと同じように動作します。

PermissionLevel

認証されたユーザーがこのアカウントに対して持っているアクセス権を示します。

列挙型
PERMISSION_LEVEL_UNSPECIFIED 指定されていません。
OWNER_LEVEL ユーザーにはオーナー レベルの権限があります。
MEMBER_LEVEL ユーザーはメンバーレベルの権限を持っています。

OrganizationInfo

組織について保存されている追加情報。

JSON 表現 
{
  "registeredDomain": string,
  "address": {
    object (PostalAddress)
  },
  "phoneNumber": string
}
フィールド
registeredDomain

string

出力のみ。アカウントの登録済みドメイン。
address

object (PostalAddress)

出力のみ。アカウントの住所。
phoneNumber

string

出力のみ。組織の連絡先電話番号。

PostalAddress

郵便の配達先や支払場所などに使用される住所を表します。郵便住所がわかっていれば、郵便サービスによって住宅や私書箱などに商品を配達できます。これは地理的な場所（道路、町、山）を指し示すものではありません。

通常の用途では、住所はユーザーによる入力か既存データのインポートによって作成されます（プロセスの種類によります）。

住所の入力または編集に関するアドバイス: - https://github.com/google/libaddressinput など、多言語対応の住所ウィジェットを使用します。- フィールドの入力や編集に使用する UI 要素は、そのフィールドが使用されている国以外ではユーザーに表示しないでください。

このスキーマの使用方法の詳細については、https://support.google.com/business/answer/6397478 をご覧ください。

JSON 表現 
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
フィールド
revision

integer

PostalAddress のスキーマ リビジョン。最新のリビジョンである 0 に設定する必要があります。

新しいリビジョンはすべて、古いリビジョンとの下位互換性を保つ必要があります。
regionCode

string

必須。住所の国 / 地域に対応する CLDR 地域コード。この値は推測されることはなく、正確な値が確保されるかどうかはユーザー次第です。詳しくは、https://cldr.unicode.org/ と https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html をご覧ください。たとえば、スイスの場合は「CH」になります。
languageCode

string

（省略可）この住所の表記に使われている BCP-47 言語コード（わかっている場合）。多くの場合、これは入力フォームの UI 言語です。あるいは、住所の国や地域で使用されているいずれかの言語、またはそれらの言語を音訳したものと一致する場合もあります。これは特定の国で住所のフォーマットに影響する可能性がありますが、データの正確性にとっては重要でなく、検証やその他のフォーマット関連以外の操作には影響しません。

この値が不明な場合は省略してください（間違っている可能性があるデフォルトは指定しないでください）。

例: 「zh-Hant」、「ja」、「ja-Latn」、「en」。
postalCode

string

（省略可）住所の郵便番号。国によっては郵便番号が使用されていない場合や、指定する必要がない場合もありますが、使用されている場合は住所の他の部分と組み合わせて追加の検証を行うことができます（例: 米国での州と郵便番号の検証）。
sortingCode

string

（省略可）国固有の付加的な並べ替えコード。ほとんどの地域では、これは使用されていません。使用されている場合、値は「CEDEX」のような文字列か（その後に数字を付加した「CEDEX 7」のような形式の場合もあります）、数字のみとなります。たとえば、ジャマイカの「セクターコード」、マラウイの「配達区域インジケーター」、コートジボワールの「郵便局インジケーター」などがこれに該当します。
administrativeArea

string

（省略可）その国 / 地域の郵便住所に使用される最上位の行政区域。たとえば、州、省、都道府県などがこれに該当します。特にスペインでは、これは自治州ではなく県になります（例: 「カタルーニャ」ではなく「バルセロナ」）。州や県などの行政区域が郵便住所に使用されない国もあります。たとえば、スイスではこの項目を空のままにします。
locality

string

（省略可）通常は住所の市区町村の部分を指します。たとえば、米国の市、イタリアのコムーネ、英国の郵便町名などがこれに該当します。地域区分が適切に定義されていないところや、この構造にうまく適合しない地域では、locality を空のままにして addressLines を使用してください。
sublocality

string

（省略可）住所の市区町村部分より下位の区分。たとえば、字、特別区、地区などがこれに該当します。
addressLines[]

string

構造化されていない住所の下位部分を記述する行。

addressLines の値は型情報を持たず、単一のフィールドに複数の値を含めることができるため（例: 「Austin, TX」）、行の順序が明確であることが重要です。住所行の順序は、その住所の国 / 地域の「宛名書きの順序」にします。これが一定でない可能性のある場所（日本など）では、address_language を使用して明示的に指定します（例: 順序が大区分から小区分の場合は「ja」、小区分から大区分の場合は「ja-Latn」または「en」）。そうすることで、住所の最も細かい部分の行を言語に基づいて選択できます。

住所の構造化表現として許容される最小限の形式は、regionCode を設定し、残りすべての情報を addressLines に格納するというものです。そのような住所はジオコーディングしなくてもおおよそフォーマットできますが、住所の構成要素の意味は、少なくとも部分的にわからなければ推測できません。

完全に構造化されていない住所を処理するには、（住所のどの部分が地域区分で、どの部分が行政区域であるかを推測するのではなく）regionCode と addressLines のみを含む住所を作成してからジオコーディングを行うことをおすすめします。
recipients[]

string

（省略可）その住所にいる受取人。このフィールドには、場合によっては複数の情報を含めることができます。たとえば、「様方」情報を含めることができます。
organization

string

（省略可）その住所にある組織の名前。

Methods

create

 指定された親の下に、指定された名前とタイプでアカウントを作成します。

get

 指定されたアカウントを取得します。

list

 認証されたユーザーのすべてのアカウントを一覧表示します。

patch

 指定したビジネス アカウントを更新します。