重要なエンドポイントが無効化される前に、Google Business Profile API 統合をアップデートする必要があります。2022 年 4 月から発生する可能性がある機能中断を避けるため、サポート終了スケジュールと説明を参照しましょう。

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)

必須。アカウントのタイプを含む。PERSONAL 型と ORGANIZATION のアカウントは、この API を使用して作成できません。
role

enum (AccountRole)

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

enum (VerificationState)

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

enum (VettedState)

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

string

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

enum (PermissionLevel)

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

object (OrganizationInfo)

出力のみ。組織の追加情報。組織アカウントのみにデータが入力されます。

口座種別

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

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

アカウントの役割

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

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

VerificationState

アカウントの確認状態を示します。

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

予測状態

アカウントに関する詳しい状態を示します。

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

権限レベル

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

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

組織情報

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

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

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