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 では作成できません。

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

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

メソッド

create

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

get

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

list

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

patch

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