REST Resource: accounts.businessInfo

リソース: BusinessInfo

BusinessInfo メッセージには、販売者のビジネスに関する重要な情報が含まれています。

このメッセージには、実店舗の住所、カスタマー サービスの連絡先、地域固有の ID などのビジネスの重要な詳細情報が含まれます。

JSON 表現 
{
  "name": string,
  "address": {
    object (PostalAddress)
  },
  "phone": {
    object (PhoneNumber)
  },
  "phoneVerificationState": enum (PhoneVerificationState),
  "customerService": {
    object (CustomerService)
  },
  "koreanBusinessRegistrationNumber": string
}
フィールド
name

string

ID。ビジネス情報のリソース名。形式: accounts/{account}/businessInfo
address

object (PostalAddress)

省略可。ビジネス拠点の住所。サポートされているフィールドは、regionCode、addressLines、postalCode、administrativeArea、locality のみです。他のフィールドはすべて無視されます。
phone

object (PhoneNumber)

出力専用。ビジネスの電話番号。
phoneVerificationState

enum (PhoneVerificationState)

出力専用。ビジネスの電話確認のステータス。
customerService

object (CustomerService)

省略可。ビジネスのカスタマー サービス。
koreanBusinessRegistrationNumber

string

省略可。10 桁の韓国の法人登録番号（「XXX-XX-XXXXX」の形式でダッシュで区切る）。

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

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

PhoneNumber

API ワイヤー形式に適した、電話番号を表すオブジェクト。

この表現は、次のように表されます。

  • 電話番号のロケール固有のフォーマット（「+1 (650) 253-0000 ext. 123」など）には使用しないでください。

  • は、効率的なストレージ用に設計されていません。

  • 通話には適さない場合があります。その目的には、専用のライブラリ（参照を参照）を使用して番号を解析する必要があります。

この数値をさまざまなユースケースに合わせてフォーマットするなど、有意義な処理を行うには、まず i18n.phonenumbers.PhoneNumber オブジェクトに変換します。

たとえば、Java では次のようになります。

com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); }

参照: - https://github.com/google/libphonenumber

JSON 表現 
{
  "extension": string,

  // Union field kind can be only one of the following:
  "e164Number": string,
  "shortCode": {
    object (ShortCode)
  }
  // End of list of possible types for union field kind.
}
フィールド
extension

string

電話番号の番号。長さが最大 40 桁の一連の番号であることを除き、内線番号については ITU 勧告で標準化されていません。桁数以外に、「,」（ポーズを指します）や「#」などの他のダイヤル文字もここに保存されます。

現在、短いコードを含む拡張機能を使用する地域はないため、通常、このフィールドは E.164 番号と組み合わせてのみ設定されます。将来的にショートコードの拡張ができるように、E.164 番号とは別に保持されます。
共用体フィールド kind。必須。通常の電話番号またはショートコードのいずれか。今後、以下の oneof に新しいフィールドが追加される可能性があります。そのため、クライアントは、コードが設定されているフィールドが設定されていない電話番号を無視する必要があります。kind は次のいずれかになります。
e164Number

string

先頭にプラス記号（+）を付けて、その後に国番号（1 ～ 3 桁）と加入者番号からなる緩和された ITU E.164 形式の電話番号を指定します。スペースやフォーマットは追加しません。例: - 正しい: "+15552220123" - 正しくない: "+1 (555) 222-01234 x123"。

ITU E.164 形式では後者が 12 桁に制限されていますが、実際にはすべての国がこの制限を遵守しているわけではないため、この制限を緩和しています。国内専用番号は使用できません。

参照: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164- https://en.wikipedia.org/wiki/List_of_country_calling_codes
shortCode

object (ShortCode)

ショートコード。

参照: - https://en.wikipedia.org/wiki/Short_code

ShortCode

ショートコードを表すオブジェクト。通常、通常の電話番号よりもはるかに短い電話番号で、MMS システムと SMS システムのメッセージの宛先として使用できるほか、略称による通話にも使用できます（例: 「プランの残り分を確認するには 611 にテキストを送信してください」）。

ショートコードは地域に限定され、国際電話をかけることはできません。つまり、同じショートコードが異なる地域に存在し、地域が同じ国番号を共有していても（米国とカナダなど）、使用量と料金が異なる場合があります。

JSON 表現 
{
  "regionCode": string,
  "number": string
}
フィールド
regionCode

string

必須。このショートコードへの通話が可能な地域の BCP-47 地域コード（「US」や「BB」など）。

参照: - http://www.unicode.org/reports/tr35/#unicode_region_subtag
number

string

必須。先頭のプラス記号（+）や国コードを含まないショートコードの数字（例: 611）。

PhoneVerificationState

スマートフォンの確認ステータス。

列挙型
PHONE_VERIFICATION_STATE_UNSPECIFIED デフォルト値。この値は使用されません。
PHONE_VERIFICATION_STATE_VERIFIED スマートフォンが確認済みである。
PHONE_VERIFICATION_STATE_UNVERIFIED スマートフォンが未確認である

CustomerService

カスタマー サービス情報。

JSON 表現 
{
  "uri": string,
  "email": string,
  "phone": {
    object (PhoneNumber)
  }
}
フィールド
uri

string

省略可。カスタマー サービスにアクセスできる URI。
email

string

省略可。カスタマー サービスに連絡できるメールアドレス。
phone

object (PhoneNumber)

省略可。カスタマー サービスに電話をかけることができる電話番号。

メソッド

getBusinessInfo

 アカウントのビジネス情報を取得します。

updateBusinessInfo

 アカウントのビジネス情報を更新します。