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 の値は型情報を持たず、1 つのフィールドに複数の値が含まれることがあるため("Austin, TX" など)、行の順序を明確にすることが重要です。所在地の行の順序は、その住所の国や地域での「あて名書きの順序」にしてください。あて名書きの順序が一定でない地域(日本など)では、address_language を使用して、順序を明示します(例: 順序が大区分から小区分の場合は "ja"、小区分から大区分の場合は "ja-Latn" や "en")。こうすることで、住所の最も細かな部分を表す行を言語に基づいて選択できます。

住所として認められる最小限の体系化表現は、regionCodeaddressLinesregionCode 以外の全情報を含む)で構成されます。そのような住所を、ジオコーディングなしできわめて正確に近く書式設定することも可能ですが、住所の構成要素についての意味的な推論は、少なくとも部分的に解決されるまでは不可能です。

まったく体系化されていない住所を扱う場合は、住所のどの部分が地域区分や行政区域を表しているか推測に任せるのではなく、regionCodeaddressLines のみを含む住所を作成してからジオコーディングを行うことをおすすめします。

recipients[]

string

省略可。その住所で受け取る人。この項目は、状況によって複数の情報を含むことがあります。たとえば、「様方」情報が含まれる場合があります。

organization

string

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