Package google.type

目次

PostalAddress

郵便の配達先や支払場所などに使用される住所を表します。郵便住所がわかっていれば、郵便サービスによって住宅や私書箱などに商品を配達できます。これは地理的な場所（道路、町、山）を指し示すものではありません。

通常の用途では、住所はユーザーによる入力か既存データのインポートによって作成されます（プロセスの種類によります）。

住所の入力または編集に関するアドバイス: - https://github.com/google/libaddressinput など、多言語対応の住所ウィジェットを使用します。- フィールドの入力や編集に使用する UI 要素は、そのフィールドが使用されている国以外ではユーザーに表示しないでください。

このスキーマの使用方法の詳細については、https://support.google.com/business/answer/6397478 をご覧ください。

フィールド
revision

int32

PostalAddress のスキーマ リビジョン。最新のリビジョンである 0 に設定する必要があります。

新しいリビジョンはすべて、古いリビジョンとの下位互換性を保つ必要があります。
region_code

string

必須。住所の国 / 地域に対応する CLDR 地域コード。この値は推測されることはなく、正確な値が確保されるかどうかはユーザー次第です。詳しくは、https://cldr.unicode.org/ と https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html をご覧ください。たとえば、スイスの場合は「CH」になります。
language_code

string

（省略可）この住所の表記に使われている BCP-47 言語コード（わかっている場合）。多くの場合、これは入力フォームの UI 言語です。あるいは、住所の国や地域で使用されているいずれかの言語、またはそれらの言語を音訳したものと一致する場合もあります。これは特定の国で住所のフォーマットに影響する可能性がありますが、データの正確性にとっては重要でなく、検証やその他のフォーマット関連以外の操作には影響しません。

この値が不明な場合は省略してください（間違っている可能性があるデフォルトは指定しないでください）。

例: 「zh-Hant」、「ja」、「ja-Latn」、「en」。
postal_code

string

（省略可）住所の郵便番号。国によっては郵便番号が使用されていない場合や、指定する必要がない場合もありますが、使用されている場合は住所の他の部分と組み合わせて追加の検証を行うことができます（例: 米国での州と郵便番号の検証）。
sorting_code

string

（省略可）国固有の付加的な並べ替えコード。ほとんどの地域では、これは使用されていません。使用されている場合、値は「CEDEX」のような文字列か（その後に数字を付加した「CEDEX 7」のような形式の場合もあります）、数字のみとなります。たとえば、ジャマイカの「セクターコード」、マラウイの「配達区域インジケーター」、コートジボワールの「郵便局インジケーター」などがこれに該当します。
administrative_area

string

（省略可）その国 / 地域の郵便住所に使用される最上位の行政区域。たとえば、州、省、都道府県などがこれに該当します。特にスペインでは、これは自治州ではなく県になります（例: 「カタルーニャ」ではなく「バルセロナ」）。州や県などの行政区域が郵便住所に使用されない国もあります。たとえば、スイスではこの項目を空のままにします。
locality

string

（省略可）通常は住所の市区町村の部分を指します。たとえば、米国の市、イタリアのコムーネ、英国の郵便町です。国 / 地域によっては、これに相当する地域区分が明確に定義されていない場合や、この構造にうまく適合しない場合がありますが、その場合は locality を空のままにして address_lines を使用します。
sublocality

string

（省略可）住所の市区町村部分より下位の区分。たとえば、字、特別区、地区などがこれに該当します。
address_lines[]

string

住所の下位部分を記述する非構造化の住所行。

address_lines の値は型情報を持たず、単一の項目に複数の値を含めることがあるため（例: 「Austin, TX」）、行の順序が明確であることが重要です。住所行の順序は、その住所の国 / 地域の「封筒順」であることが必要です。これが一定でない可能性のある場所（日本など）では、address_language を使用して明示的に指定します（例: 順序が大区分から小区分の場合は「ja」、小区分から大区分の場合は「ja-Latn」または「en」）。このように、住所の最も詳細な部分の行を言語に基づいて選択できます。

住所の構造化表現として許容される最小限の形式は、region_code と、残りのすべての情報を格納する address_lines で構成するというものです。そのような住所を、ジオコーディングなしできわめて正確に近く書式設定することも可能ですが、住所の構成要素についての意味的な推論は、少なくとも部分的に解決されるまでは不可能です。

まったく構造化されていない住所を扱うときは、region_code と address_lines だけで構成される住所を作成してからジオコーディングすることが、おすすめの方法です（住所のどの部分が最上位の行政区画で、どれがその下の地域区画かを推測するのではなく）。
recipients[]

string

（省略可）その住所にいる受取人。このフィールドには、場合によっては複数の情報を含めることができます。たとえば、「様方」情報を含めることができます。
organization

string

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