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

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