索引
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 ではなく、プレイス ID の使用をおすすめします。運転ルートを計算したりルートを計算したりする際に座標を使用すると、その座標に最も近い道路にポイントがスナップされます。この道路は、目的地にすばやくまたは安全に通じる道路ではなく、宿泊施設へのアクセス ポイントの近くにない場合があります。また、場所がリバース ジオコーディングされた場合、返される住所が元の住所と一致する保証はありません。 |
plus_code |
|
bounds |
ジオコーディングされた場所の境界。 |
feature_size_meters |
ジオコーディングされた場所のサイズ(メートル単位)。これも、ジオコードされた位置の大まかな粗さを表しますが、セマンティックな意味ではなく物理的なサイズで表します。 |
place_id |
この入力がジオコーディングする場所の PlaceID。 プレイス ID について詳しくは、こちらをご覧ください。 |
place_types[] |
入力がジオコーディングされた場所のタイプ(複数可)。たとえば、 |
LanguageOptions
プレビュー: この機能は、pre-GA(一般提供前)のプレビュー版です。一般提供前のプロダクトと機能では、サポートが制限されることがあります。また、一般提供前のプロダクトや機能の変更は、他の一般提供前のバージョンと互換性がない場合があります。pre-GA のサービスには、Google Maps Platform サービス固有の規約が適用されます。詳細については、リリース ステージの説明をご覧ください。
レスポンスに追加の情報を含めるために Address Validation API を有効にします。
フィールド | |
---|---|
return_english_latin_address |
プレビュー: |
PlusCode
Plus Code(http://plus.codes)は、14 mx14 m(次数の 1/8000 分の 1)以下の長方形を定義するグローバル コードと、プレフィックスを基準位置に置き換える複合コードという 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 データ。uspsData
は、Address Validation API に送信されるすべての米国またはプエルトリコの住所に対して完全な住所が入力されるとは限りません。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 つの受信可能なものに配信されることを示します。1 文字を返します。
|
dpv_throwback |
郵便物が番地に配達されないことを示します。1 文字を返します。
|
dpv_non_delivery_days |
フラグは、メール配信が毎日行われていないことを示します。1 文字を返します。
|
dpv_non_delivery_days_values |
配信されない日を識別する整数値。ビットフラグを使用して調べることができます。 0x40 – 日曜日は未配送日 0x20 – 月曜日は未配送日 0x10 – 火曜日は未配送日 0x08 – 水曜日は未配送日 0x04 – 木曜日は未配送日 0x02 – 金曜日は未配送日 0x02 – 金曜日は未配送日 0x1 |
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 |
拡張旅行事業(eLOT)番号。 |
elot_flag |
eLOT 昇順/降順フラグ(A/D)。 |
lacs_link_return_code |
LACSLink の戻りコード。 |
lacs_link_indicator |
LACSLink インジケータ |
po_box_only_postal_code |
私書箱のみの郵便番号。 |
suitelink_footnote |
街路や高層ビルのレコードと部屋情報を照合する際の脚注。ビジネス名の一致が見つかった場合は、予備の番号が返されます。
|
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 を有効にします。 |
session_token |
省略可。請求処理のために予測入力セッションを識別する文字列です。URL とファイル名セーフ、長さが 36 文字以下の base64 文字列にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。 セッションは、ユーザーが Autocomplete クエリを実行すると開始し、場所を選択して Place Details または Address Validation への呼び出しを行うと終了します。各セッションには複数の Autocomplete クエリがあり、その後に 1 つの Place Details または Address Validation リクエストが可能です。セッション内の各リクエストに使用される認証情報は、同じ Google Cloud コンソール プロジェクトに属している必要があります。セッションが終了するとトークンは無効になるため、アプリはセッションごとに新しいトークンを生成する必要があります。 注: Address Validation は Autocomplete(新)API を使用するセッションでのみ使用できます。Autocomplete API では使用できません。詳しくは、https://developers.google.com/maps/documentation/places/web-service/session-pricing をご覧ください。 |
ValidateAddressResponse
住所確認リクエストに対するレスポンス。
フィールド | |
---|---|
result |
住所検証の結果。 |
response_id |
このレスポンスを識別する UUID。アドレスの再検証が必要な場合は、新しいリクエストにこの UUID を含める必要があります。 |
ValidationResult
住所の検証結果。
フィールド | |
---|---|
verdict |
総合判定フラグ |
address |
ジオコードではなく、住所自体に関する情報。 |
geocode |
住所がジオコーディングされた場所と場所に関する情報。 |
metadata |
成果物に関するその他の情報。 |
usps_data |
USPS から提供される追加の配送に関するフラグ。リージョン |
english_latin_address |
プレビュー: この機能は、pre-GA(一般提供前)のプレビュー版です。一般提供前のプロダクトと機能では、サポートが制限されることがあります。また、一般提供前のプロダクトや機能の変更は、他の一般提供前のバージョンと互換性がない場合があります。pre-GA のサービスには、Google Maps Platform サービス固有の規約が適用されます。詳細については、リリース ステージの説明をご覧ください。 英語に翻訳された住所。 変換された住所は API 入力として再利用できません。このサービスでは、ユーザーが各自の母国語を使用して、最初に指定された住所が正しいことを確認または拒否できるようにするためにメールアドレスが提供されます。 住所の一部が英語に翻訳されていない場合、サービスはラテン文字を使用する代替言語でその部分を返します。代替言語が選択される仕組みについては、こちらをご覧ください。住所の一部にラテン文字を使用する言語の翻訳や訳文がない場合は、住所に関連付けられたローカル言語でその部分が返されます。 この出力を有効にするには、 注: |
判定
住所検証の結果とジオコードの概要。
フィールド | |
---|---|
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 |
その他すべての粒度は、配信できないため一緒にバケット化されます。 |