索引
AddressValidation
(インターフェース)Address
(メッセージ)AddressComponent
(メッセージ)AddressComponent.ConfirmationLevel
(列挙型)AddressMetadata
(メッセージ)ComponentName
(メッセージ)Geocode
(メッセージ)LanguageOptions
(メッセージ)PlusCode
(メッセージ)ProvideValidationFeedbackRequest
(メッセージ)ProvideValidationFeedbackRequest.ValidationConclusion
(列挙型)ProvideValidationFeedbackResponse
(メッセージ)UspsAddress
(メッセージ)UspsData
(メッセージ)ValidateAddressRequest
(メッセージ)ValidateAddressResponse
(メッセージ)ValidationResult
(メッセージ)Verdict
(メッセージ)Verdict.Granularity
(列挙型)
AddressValidation
住所を検証するサービス。
ProvideValidationFeedback |
---|
一連の検証試行の結果に関するフィードバック。これは、同じ住所に対して一連の検証呼び出しが行われた後の最後の呼び出しであり、取引が完了したときに呼び出す必要があります。これは、住所を完全に検証するために必要な一連の |
ValidateAddress |
---|
住所を検証します。 |
住所
後処理された住所の詳細。後処理には、住所のスペルミスのある部分の修正、不正確な部分の置き換え、欠落している部分の推測などが含まれます。
フィールド | |
---|---|
formatted_address |
住所がある地域の住所形式ルールに従って、1 行で住所の形式をとった後処理された住所。 |
postal_address |
郵送先住所として表される、後処理済みの住所。 |
address_components[] |
順序なしリスト。書式設定および修正された住所の個々の住所コンポーネントと検証情報。これにより、個々のコンポーネントの検証ステータスに関する情報が得られます。 住所コンポーネントの順番は決まっていません。リスト内の住所コンポーネントの順序は仮定しないでください。 |
missing_component_types[] |
正しい形式の送付先住所に存在することが期待されているが、入力には含まれず、推定もできなかったコンポーネントのタイプ。このタイプのコンポーネントは、 |
unconfirmed_component_types[] |
|
unresolved_tokens[] |
解決できなかった入力内のトークン。これは、住所の有効な部分として認識されなかった入力である可能性があります(たとえば、「123235253253 Main St, San Francisco, CA, 94105」のような入力では、未解決のトークンは有効な番地とは見なされないため、 |
AddressComponent
番地、市区町村、都道府県などの住所コンポーネントを表します。
フィールド | |
---|---|
component_name |
このコンポーネントの名前。 |
component_type |
住所コンポーネントのタイプ。利用可能なタイプのリストについては、表 2: プレイス サービスで返されるその他のタイプをご覧ください。 |
confirmation_level |
コンポーネントが正しいことの確実性を示します。 |
inferred |
コンポーネントが入力に含まれなかったものの、住所の位置から推測され、完全な住所に対して提供されるはずであることを示しています。 |
spell_corrected |
コンポーネント名のスペルミスが修正されたことを示します。API では、「centre」を「center」に変更する場合など、スペルのバリエーション間での変更が必ず報告されるわけではありません。また、「Amphitheater Pkwy」を「Amphitheatre Pkwy」に変更した場合など、よくあるスペルミスが報告されるわけではありません。 |
replaced |
コンポーネントの名前がまったく別の名前に置き換えられたことを示します。たとえば、間違った郵便番号が住所に適切な名前に置き換えられた場合などです。これは外観上の変更ではなく、入力コンポーネントが別のものに変更されました。 |
unexpected |
指定された地域の住所には含まれていない住所コンポーネントを示します。これは、入力の一部であったという理由だけで保持しています。 |
ConfirmationLevel
確認レベルの設定可能な値。
列挙型 | |
---|---|
CONFIRMATION_LEVEL_UNSPECIFIED |
デフォルト値。この値は使用されません。 |
CONFIRMED |
このコンポーネントが存在し、住所の残りの部分で理にかなっていることを確認できました。 |
UNCONFIRMED_BUT_PLAUSIBLE |
このコンポーネントは確認できませんでしたが、存在する可能性はあります。たとえば、特定の番地が不明な道路にある、既知の有効な範囲の番地など。 |
UNCONFIRMED_AND_SUSPICIOUS |
このコンポーネントは確認されていないため、間違っている可能性があります。たとえば、住所の残りの部分と一致しない近隣地域が該当します。 |
AddressMetadata
住所のメタデータ。metadata
で、Address Validation API に送信されるすべての住所が完全に入力されるとは限りません。
フィールド | |
---|---|
business |
ビジネスの住所であることを示します。未設定の場合、値が不明であることを示します。 |
po_box |
私書箱の住所を表します。未設定の場合、値が不明であることを示します。 |
residential |
これが住宅の住所であることを示します。未設定の場合、値が不明であることを示します。 |
ComponentName
コンポーネントの名前のラッパー。
フィールド | |
---|---|
text |
名前のテキスト。たとえば、番地には「5th Avenue」、番地には「1253」と入力します。 |
language_code |
BCP-47 言語コード。コンポーネント名が言語(番地など)に関連付けられていない場合、存在しません。 |
ジオコード
入力がジオコーディングされた場所に関する情報が含まれます。
フィールド | |
---|---|
location |
入力のジオコーディングされた場所。 プレイス ID は、住所、緯度/経度の座標、Plus Code よりも優先して使用することをおすすめします。ルート選択や運転ルートの計算で座標を使用すると、ポイントは常にその座標に最も近い道路にスナップされます。目的地に迅速かつ安全にアクセスできる道路ではなく、宿泊施設への出入り口の近くにないとは限りません。また、ビジネスがリバース ジオコーディングされても、返される住所が元の住所と同じになるとは限りません。 |
plus_code |
|
bounds |
ジオコーディングされた場所の境界。 |
feature_size_meters |
ジオコーディングされた場所のサイズ(メートル単位)。これはジオコーディングされた場所の粗さのもう 1 つの尺度ですが、意味論的意味よりも物理サイズで示されます。 |
place_id |
この入力でジオコーディングする場所の PlaceID。 プレイス ID について詳しくは、こちらをご覧ください。 |
place_types[] |
入力がジオコーディングされた場所のタイプ(1 つ以上)。たとえば、 |
LanguageOptions
プレビュー: この機能はプレビュー版(pre-GA)です。一般提供前のプロダクトと機能では、サポートが制限されることがあります。また、一般提供前のプロダクトや機能の変更は、他の一般提供前のバージョンと互換性がない場合があります。pre-GA のサービスには、Google Maps Platform サービス固有の規約 が適用されます。詳細については、リリース ステージの説明をご覧ください。
Address Validation API がレスポンスに追加の情報を含めることを可能にします。
フィールド | |
---|---|
return_english_latin_address |
プレビュー: 英語で |
PlusCode
Plus Code(http://plus.codes)は、14mx14m(1/8,000)以下の長方形を定義するグローバル コードと、プレフィックスを参照場所に置き換える複合コードの 2 つの形式で場所の参照です。
フィールド | |
---|---|
global_code |
場所のグローバル(完全)コード。「9FWM33GV+HQ」など、1/8, 000 x 1/8,000 度の領域(約 14 x 14 メートル)を表します。 |
compound_code |
場所の複合コード(「33GV+HQ, Ramberg, Norway」など)。グローバル コードの接尾辞が含まれ、接頭辞は参照エンティティのフォーマットされた名前に置き換えられます。 |
ProvideValidationFeedbackRequest
検証フィードバックの送信リクエスト。
フィールド | |
---|---|
conclusion |
必須。一連の検証試行の結果。 このフィールドが |
response_id |
必須。このフィードバックの対象となる回答の ID。これは、一連の住所検証の試行における最初のレスポンスの [response_id][google.maps.addressvalidation.v1.ValidateAddressRequest.response_id] である必要があります。 |
ValidationConclusion
住所の検証に必要な一連の住所検証リクエストの最終的な結果。
列挙型 | |
---|---|
VALIDATION_CONCLUSION_UNSPECIFIED |
この値は使用されません。ProvideValidationFeedbackRequest.conclusion フィールドが VALIDATION_CONCLUSION_UNSPECIFIED に設定されている場合、INVALID_ARGUMENT エラーが返されます。 |
VALIDATED_VERSION_USED |
Address Validation API から返された住所のバージョンがトランザクションに使用されていた。 |
USER_VERSION_USED |
お客様から提供された住所のバージョンが取引に使用されました |
UNVALIDATED_VERSION_USED |
前回の検証後に入力されたが、再検証されていないバージョンの住所がトランザクションに使用されていました。 |
UNUSED |
取引は放棄され、住所は使用されませんでした。 |
ProvideValidationFeedbackResponse
このタイプにはフィールドがありません。
検証フィードバックのレスポンス。
フィードバックが正常に送信された場合、レスポンスは空になります。
UspsAddress
USPS による米国の住所の表現。
フィールド | |
---|---|
first_address_line |
住所の 1 行目。 |
firm |
会社名。 |
second_address_line |
住所の 2 行目。 |
urbanization |
プエルトリコの都市化の名前。 |
city_state_zip_address_line |
市区町村 + 都道府県 + 郵便番号。 |
city |
市町村名。 |
state |
2 文字の州コード。 |
zip_code |
郵便番号。例: 10009。 |
zip_code_extension |
4 桁の郵便番号の拡張コード(例: 5023)。 |
UspsData
住所の USPS データ。Address Validation API に送信されるすべての米国または PR の住所について、uspsData
が完全に入力されるとは限りません。レスポンスの主な部分として uspsData を使用する場合は、バックアップの住所フィールドをレスポンスに統合することをおすすめします。
フィールド | |
---|---|
standardized_address |
USPS の標準化された住所です。 |
delivery_point_code |
2 桁の配送先コード |
delivery_point_check_digit |
配送先のチェック ディジット。この番号は、機械的にスキャンされたメールの場合、delivery_point_barcode の末尾に追加されます。Delivery_point_barcode、delivery_point_check_digit、postal code、ZIP+4 のすべての桁を加算すると、10 で割り切れる数値になります。 |
dpv_confirmation |
DPV の確認に使用できる値です。1 文字を返すか、値を返しません。
|
dpv_footnote |
提供ポイントの検証の脚注複数の脚注を同じ文字列の中でつなぎ合わせることができます。
|
dpv_cmra |
住所が CMRA(Commercial Mail Received Agency)(顧客の郵便物が届く民間企業)かどうかを指定します。1 文字を返します。
|
dpv_vacant |
この場所は空ですか?1 文字を返します。
|
dpv_no_stat |
これは統計アドレスがありませんか、それとも有効な住所ですか?データを継続的に占有していない住所や、USPS がサービスを提供していない住所とは、1 文字を返します。
|
dpv_no_stat_reason_code |
NoStat 型を示します。理由コードを int として返します。
|
dpv_drop |
フラグは、サイトの単一の受信可能にメールが配信されたことを示します。1 文字を返します。
|
dpv_throwback |
番地に郵便物が配送されていないことを示します。1 文字を返します。
|
dpv_non_delivery_days |
フラグは、メールの配信が毎日行われないことを示します。1 文字を返します。
|
dpv_non_delivery_days_values |
配達不能の日数を示す整数。次のビットフラグを使用して照会できます。0x40 – 日曜日は配達不能の日 0x20 – 月曜日は配達不能の日 0x10 – 火曜日は配達不能の日 0x08 – 水曜日は配達不能の日 0x04 – 木曜日は配達不能の日 0x02 – 金曜日は配達不能の日 0x01 |
dpv_no_secure_location |
フラグはドアにアクセス可能であるものの、セキュリティ上の懸念により荷物が放置されていないことを示します。1 文字を返します。
|
dpv_pbsa |
アドレスが PBSA レコードと一致したことを示します。1 文字を返します。
|
dpv_door_not_accessible |
USPS が郵便物を配達できない住所であることを示すフラグ。1 文字を返します。
|
dpv_enhanced_delivery_code |
同じ住所に対して複数の DPV 戻りコードが有効であることを示します。1 文字を返します。
|
carrier_route |
運送業者のルートコード。1 文字の接頭辞と 3 桁のルート指定子からなる 4 文字のコード。 接頭辞:
|
carrier_route_indicator |
運送業者のルート送料並べ替えインジケーター。 |
ews_no_match |
配送先住所は一致していますが、EWS ファイルには完全一致がまもなく利用可能になることを示しています。 |
post_office_city |
郵便局の主要都市。 |
post_office_state |
メインの郵便局の都道府県。 |
abbreviated_city |
都市の略称。 |
fips_county_code |
FIPS の郡コード。 |
county |
国名。 |
elot_number |
エンハンスト Line of Travel(eLOT)番号。 |
elot_flag |
eLOT 昇順/降順フラグ(A/D)。 |
lacs_link_return_code |
LACSLink 戻りコード。 |
lacs_link_indicator |
LACSLink インジケーター。 |
po_box_only_postal_code |
私書箱のみの郵便番号。 |
suitelink_footnote |
番地や高層ビルのレコードとスイートの情報とのマッチングに関する脚注。一致するビジネス名が見つかった場合は、2 番目の番号が返されます。
|
pmb_designator |
PMB(Private Mail Box)の単位指定子。 |
pmb_number |
PMB(私書箱)番号 |
address_record_type |
入力住所に一致する住所レコードのタイプ。
|
default_address |
デフォルトの住所が見つかったものの、より具体的な住所が存在することを示すインジケーター。 |
error_message |
USPS データの取得に関するエラー メッセージです。人為的に作成された住所が検出されたために USPS の処理が停止したときに入力されます。 このエラーがある場合、USPS データ フィールドが入力されていない可能性があります。 |
cass_processed |
リクエストが CASS で処理されたことを示すインジケーター。 |
ValidateAddressRequest
住所を検証するためのリクエスト。
フィールド | |
---|---|
address |
必須。検証される住所。書式設定されていない住所は、 この入力のフィールドの合計長は 280 文字以内にする必要があります。 サポートされているリージョンについては、こちらをご覧ください。 入力アドレスの Address Validation API は、 |
previous_response_id |
最初の住所確認リクエストでは、このフィールドを空にする必要があります。1 つの住所を完全に検証するために追加のリクエストが必要な場合(最初の検証後にユーザーが行った変更を再検証する必要がある場合など)、各フォローアップ リクエストで、検証シーケンスの最初のレスポンスの |
enable_usps_cass |
USPS CASS 互換モードを有効にします。これは コンポーネント化された |
language_options |
(省略可)プレビュー: この機能はプレビュー版(pre-GA)です。一般提供前のプロダクトと機能では、サポートが制限されることがあります。また、一般提供前のプロダクトや機能の変更は、他の一般提供前のバージョンと互換性がない場合があります。pre-GA のサービスには、Google Maps Platform サービス固有の規約 が適用されます。詳細については、リリース ステージの説明をご覧ください。 Address Validation API がレスポンスに追加の情報を含めることを可能にします。 |
ValidateAddressResponse
Address Validation リクエストのレスポンス。
フィールド | |
---|---|
result |
住所検証の結果。 |
response_id |
このレスポンスを識別する UUID。アドレスの再検証が必要な場合は、新しいリクエストにこの UUID を付ける必要があります。 |
ValidationResult
住所の検証結果。
フィールド | |
---|---|
verdict |
全体の判定フラグ |
address |
ジオコードではなく、住所そのものに関する情報。 |
geocode |
住所のジオコーディングを行った場所と場所に関する情報。 |
metadata |
提供状況に関連するその他の情報。 |
usps_data |
USPS により提供される追加の配送フラグ。リージョン |
english_latin_address |
プレビュー: この機能はプレビュー版(pre-GA)です。一般提供前のプロダクトと機能では、サポートが制限されることがあります。また、一般提供前のプロダクトや機能の変更は、他の一般提供前のバージョンと互換性がない場合があります。pre-GA のサービスには、Google Maps Platform サービス固有の規約 が適用されます。詳細については、リリース ステージの説明をご覧ください。 英語に翻訳された住所。住所に英語の翻訳がない場合、ラテン文字を使用した代替言語でその住所が返されます。代替言語の選択方法については、こちらをご覧ください。住所にラテン文字を使用する言語の翻訳や文字変換がない場合は、住所に関連付けられた現地言語でその部分が返されます。 この出力は、 注: |
判断
住所検証の結果とジオコーディングの概要。
フィールド | |
---|---|
input_granularity |
入力アドレスの粒度。これは入力住所を解析した結果であり、検証シグナルは提供しません。検証シグナルについては、下記の たとえば、入力された住所に特定のアパート番号が含まれている場合、ここでの |
validation_granularity |
API が住所を完全にvalidateできる粒度。たとえば、 住所ごとのコンポーネント検証の結果は |
geocode_granularity |
これは、上記の |
address_complete |
未解決のトークンや、予期しない住所コンポーネント、欠落している住所コンポーネントがない場合、住所は完全とみなされます。詳細については、 |
has_unconfirmed_components |
少なくとも 1 つの住所コンポーネントを分類または検証できません。詳しくは、 |
has_inferred_components |
入力には含まれていなかった住所コンポーネントが 1 つ以上推測(追加)されました。詳細については、 |
has_replaced_components |
少なくとも 1 つの住所コンポーネントが置き換えられました。詳しくは、 |
粒度
住所またはジオコードのさまざまな粒度。これらの値が住所の粒度を示す場合、住所が送付先を識別する粒度を示します。たとえば、「123 Main Street, Redwood City, CA, 94061」のような住所は PREMISE
を識別し、「Redwood City, CA, 94061」は LOCALITY
を識別します。ただし、レッドウッド シティで「123 Main Street」のジオコードが見つからない場合は、住所がより詳細であっても、返されるジオコーディングの粒度は LOCALITY
の粒度になることがあります。
列挙型 | |
---|---|
GRANULARITY_UNSPECIFIED |
デフォルト値。この値は使用されません。 |
SUB_PREMISE |
アパートなど、建物より下のレベルの結果。 |
PREMISE |
建物レベルの結果。 |
PREMISE_PROXIMITY |
住所の建物レベルのおおよその位置を推定するジオコード。 |
BLOCK |
住所またはジオコードがブロックを示しています。日本など、ブロックレベルのアドレス指定があるリージョンでのみ使用されます。 |
ROUTE |
ジオコードまたは住所が、道路、道路、高速道路など、経路を細かく制御している。 |
OTHER |
その他の粒度はすべて提供対象ではないため、まとめてバケット化しています。 |