Method: validateAddress

住所を検証します。

HTTP リクエスト

POST https://addressvalidation.googleapis.com/v1:validateAddress

この URL は gRPC Transcoding 構文を使用します。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "address": {
    object (PostalAddress)
  },
  "previousResponseId": string,
  "enableUspsCass": boolean,
  "languageOptions": {
    object (LanguageOptions)
  },
  "sessionToken": string
}
フィールド
address

object (PostalAddress)

必須。住所の確認中。フォーマットされていない住所は addressLines 経由で送信する必要があります。

この入力のフィールドの合計長は 280 文字以内にする必要があります。

サポートされている地域については、こちらをご覧ください。

入力アドレスの languageCode 値は将来の使用のために予約されており、現在は無視されます。検証済みの住所の結果は、システムによって特定された、その住所の優先言語に基づいて入力されます。

Address Validation API は、recipients と organization の値を無視します。これらのフィールドの値は破棄され、返されません。設定しないでください。
previousResponseId

string

最初の住所確認リクエストでは、このフィールドを空にする必要があります。1 つの住所を完全に検証するためにさらにリクエストが必要な場合（たとえば、最初の検証後にユーザーが行った変更を再検証する必要がある場合など）、各フォローアップ リクエストで、検証シーケンスの最初のレスポンスの responseId をこのフィールドに入力する必要があります。
enableUspsCass

boolean

USPS CASS 互換モードを有効にします。これは google.maps.addressvalidation.v1.ValidationResult の google.maps.addressvalidation.v1.ValidationResult.usps_data フィールドにのみ影響します。注: プエルトリコの住所に対する USPS CASS 対応リクエストでは、address の google.type.PostalAddress.region_code を「PR」として指定するか、address の google.type.PostalAddress.administrative_area を「Puerto Rico」（大文字と小文字は区別されません）または「PR」として指定する必要があります。

コンポーネント化された address を使用することをおすすめします。または、少なくとも 2 つの google.type.PostalAddress.address_lines を指定し、最初の行に番地と町名、2 番目の行に市区町村、都道府県、郵便番号を指定します。
languageOptions

object (LanguageOptions)

省略可。プレビュー版: この機能はプレビュー版（一般提供前）です。一般提供前のプロダクトと機能では、サポートが制限されることがあります。また、一般提供前のプロダクトや機能の変更は、他の一般提供前のバージョンと互換性がない場合があります。pre-GA のサービスには、Google Maps Platform サービス固有の規約が適用されます。詳細については、リリース ステージの説明をご覧ください。

Address Validation API がレスポンスに追加情報を含めることができるようにします。
sessionToken

string

省略可。請求目的で Autocomplete セッションを識別する文字列。URL とファイル名に安全な base64 文字列で、ASCII 文字で 36 文字以内にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。

セッションは、ユーザーが Autocomplete クエリを実行したときに開始され、ユーザーが場所を選択し、Places Details または Address Validation が呼び出されると終了します。セッションによっては、複数のオートコンプリート クエリが入力された後に、1 つの Place Details リクエストまたは Address Validation リクエストが実行される場合もあります。セッション内の各リクエストに使用する認証情報は、同じ Google Cloud コンソール プロジェクトに属している必要があります。セッションが終了すると、トークンは無効になります。アプリでは、セッションごとに新しいトークンを生成する必要があります。sessionToken パラメータを省略する場合や、セッション トークンを再利用する場合は、セッション トークンが指定されていない場合と同様にセッションが課金されます（各リクエストが個別に課金されます）。

注: Address Validation は、Autocomplete API ではなく、Autocomplete（新規）API を使用するセッションでのみ使用できます。詳しくは、https://developers.google.com/maps/documentation/places/web-service/session-pricing をご覧ください。

レスポンスの本文

住所確認リクエストに対するレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "result": {
    object (ValidationResult)
  },
  "responseId": string
}
フィールド
result

object (ValidationResult)

住所確認の結果。
responseId

string

このレスポンスを識別する UUID。住所の再確認が必要な場合は、この UUID を新しいリクエストに添付する必要があります。

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 以外の値を指定すると、API は INVALID_ARGUMENT エラーを返します。
regionCode

string

省略可。住所の国 / 地域に対応する CLDR 地域コード。詳細については、https://cldr.unicode.org/ と https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html をご覧ください。例: スイスの場合は「CH」です。地域コードが指定されていない場合は、住所から推測されます。最適なパフォーマンスを得るには、地域コードがわかっている場合はそのコードを含めることをおすすめします。リージョンが不整合または重複していると、パフォーマンスが低下する可能性があります。たとえば、addressLines にすでにリージョンが含まれている場合は、このフィールドにリージョン コードを再度指定しないでください。サポートされている地域については、よくある質問をご覧ください。
languageCode

string

入力アドレスの言語コードは将来の使用のために予約されており、現在は無視されます。API は、住所が存在する場所に適した言語で住所を返します。
postalCode

string

省略可。住所の郵便番号。すべての国で郵便番号の使用や存在を必要としているわけではありませんが、使用されている場合は、住所の他の部分で追加の確認が行われることがあります（例: 米国での州 / 郵便番号の確認）。
sortingCode

string

省略可。追加の国固有の並べ替えコード。ほとんどの地域では、これは使用されていません。使用される場合、値は「CEDEX」などの文字列で、必要に応じて数字が続く場合もあります（「CEDEX 7」など）。または、単なる数字で、「セクター コード」（ジャマイカ）、「配達エリア インジケーター」（マラウイ）、「郵便局インジケーター」（コートジボアール）を表します。
administrativeArea

string

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

string

省略可。通常は住所の市区町村の部分を指します。たとえば、米国の市、イタリアのコムーネ、英国の郵便町名などがこれに該当します。地域区分が明確に定義されていない地域や、この体系が当てはまらない地域では、locality を空のままにして addressLines を使用します。
sublocality

string

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

string

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

addressLines の値は型情報を持たず、1 つのフィールドに複数の値が含まれることがあるため（"Austin, TX" など）、行の順序を明確にすることが重要です。所在地の行の順序は、その住所の国や地域での「あて名書きの順序」にしてください。

住所として認められる最小限の体系化表現は、addressLines に配置されるすべての情報で構成されます。regionCode が指定されていない場合、リージョンは住所から推測されます。

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

string

このフィールドは設定しないでください。Address Validation API では現在使用されていません。現時点では、このフィールドが設定されたリクエストは API によって拒否されませんが、情報は破棄され、レスポンスで返されることはありません。
organization

string

このフィールドは設定しないでください。Address Validation API では現在使用されていません。現時点では、このフィールドが設定されたリクエストは API によって拒否されませんが、情報は破棄され、レスポンスで返されることはありません。

LanguageOptions

プレビュー版: この機能はプレビュー版（一般提供前）です。一般提供前のプロダクトと機能では、サポートが制限されることがあります。また、一般提供前のプロダクトや機能の変更は、他の一般提供前のバージョンと互換性がない場合があります。pre-GA のサービスには、Google Maps Platform サービス固有の規約が適用されます。詳細については、リリース ステージの説明をご覧ください。

Address Validation API がレスポンスに追加情報を含めることができるようにします。

JSON 表現 
{
  "returnEnglishLatinAddress": boolean
}
フィールド
returnEnglishLatinAddress

boolean

プレビュー: 英語で google.maps.addressvalidation.v1.Address を返します。詳しくは、google.maps.addressvalidation.v1.ValidationResult.english_latin_address をご覧ください。

ValidationResult

住所の検証結果。

JSON 表現 
{
  "verdict": {
    object (Verdict)
  },
  "address": {
    object (Address)
  },
  "geocode": {
    object (Geocode)
  },
  "metadata": {
    object (AddressMetadata)
  },
  "uspsData": {
    object (UspsData)
  },
  "englishLatinAddress": {
    object (Address)
  }
}
フィールド
verdict

object (Verdict)

全体的な判定結果のフラグ
address

object (Address)

ジオコードではなく、住所自体に関する情報。
geocode

object (Geocode)

住所がジオコーディングされた場所と場所に関する情報。
metadata

object (AddressMetadata)

配信に関連するその他の情報。Address Validation API に送信されるすべての住所について、metadata が完全に入力される保証はありません。
uspsData

object (UspsData)

USPS が提供する追加の配送可能フラグ。リージョン US と PR でのみ指定されます。
englishLatinAddress

object (Address)

プレビュー版: この機能はプレビュー版（一般提供前）です。一般提供前のプロダクトと機能では、サポートが制限されることがあります。また、一般提供前のプロダクトや機能の変更は、他の一般提供前のバージョンと互換性がない場合があります。pre-GA のサービスには、Google Maps Platform サービス固有の規約が適用されます。詳細については、リリース ステージの説明をご覧ください。

英語に翻訳された住所。

変換された住所は、API 入力として再利用できません。ユーザーが母国語で、最初に提供した住所の検証を確認または拒否できるように、このサービスが提供されています。

住所の一部に英語の翻訳がない場合は、その部分はラテン文字を使用する代替言語で返されます。代替言語の選択方法については、こちらをご覧ください。住所の一部にラテン文字を使用する言語での翻訳や音訳がない場合は、その部分は住所に対応する現地の言語で返されます。

この出力を有効にするには、google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address フラグを使用します。

注: englishLatinAddress の google.maps.addressvalidation.v1.Address.unconfirmed_component_types フィールドと englishLatinAddress.address_components の google.maps.addressvalidation.v1.AddressComponent.confirmation_level フィールドには値が入力されません。

判定

住所の検証結果とジオコードの概要。

JSON 表現 
{
  "inputGranularity": enum (Granularity),
  "validationGranularity": enum (Granularity),
  "geocodeGranularity": enum (Granularity),
  "addressComplete": boolean,
  "hasUnconfirmedComponents": boolean,
  "hasInferredComponents": boolean,
  "hasReplacedComponents": boolean
}
フィールド
inputGranularity

enum (Granularity)

入力アドレスの粒度。これは入力アドレスの解析結果であり、検証シグナルは提供されません。検証シグナルについては、下記の validationGranularity をご覧ください。

たとえば、入力アドレスに特定の部屋番号が含まれている場合、ここでの inputGranularity は SUB_PREMISE になります。データベースのアパート番号と一致しないか、アパート番号が無効な場合、validationGranularity は PREMISE 以下になる可能性があります。
validationGranularity

enum (Granularity)

API がアドレスを完全に検証できる粒度レベル。たとえば、validationGranularity が PREMISE の場合、PREMISE 以上のレベルのすべての住所コンポーネントを検証できます。

住所の構成要素ごとの検証結果は google.maps.addressvalidation.v1.Address.address_components にあります。
geocodeGranularity

enum (Granularity)

geocode の粒度に関する情報。これは、ジオコーディングされた位置の精度を意味するセマンティックな意味として理解できます。

これは、上記の validationGranularity とは異なる場合があります。たとえば、データベースにはアパートの番号が記録されているものの、大きなアパート団地内のアパートの正確な位置が記録されていない場合があります。この場合、validationGranularity は SUB_PREMISE ですが、geocodeGranularity は PREMISE になります。
addressComplete

boolean

未解決のトークンがなく、住所のコンポーネントが予期せず欠落していない場合、住所は完全と見なされます。未設定の場合、値は false です。詳細については、missingComponentTypes、unresolvedTokens、unexpected フィールドをご覧ください。
hasUnconfirmedComponents

boolean

住所のコンポーネントのうち少なくとも 1 つを分類または検証できません。詳細については、google.maps.addressvalidation.v1.Address.address_components をご覧ください。
hasInferredComponents

boolean

入力に含まれていない住所のコンポーネントが少なくとも 1 つ推論（追加）されました。詳しくは、google.maps.addressvalidation.v1.Address.address_components をご覧ください。
hasReplacedComponents

boolean

住所のコンポーネントが 1 つ以上置き換えられました。詳細については、google.maps.addressvalidation.v1.Address.address_components をご覧ください。

粒度

住所またはジオコードに設定できるさまざまな粒度。住所の粒度を示すために使用する場合、これらの値は、住所が郵送先を識別する粒度を示します。たとえば、「123 Main Street, Redwood City, CA, 94061」という住所は PREMISE を表し、「Redwood City, CA, 94061」という住所は LOCALITY を表します。ただし、Redwood City の「123 Main Street」のジオコードが見つからない場合は、住所の精度がそれより高いにもかかわらず、返されるジオコードの精度は LOCALITY になることがあります。

列挙型
GRANULARITY_UNSPECIFIED デフォルト値。この値は使用されません。
SUB_PREMISE アパートなど、建物単位より下位の結果。
PREMISE 建物レベルの結果。
PREMISE_PROXIMITY 住所の建物レベルの位置を近似したジオコード。
BLOCK 住所またはジオコードはブロックを示します。ブロックレベルのアドレス指定が使用されている地域（日本など）でのみ使用されます。
ROUTE ジオコードまたは住所が道路、道路、高速道路などのルート単位で指定されている。
OTHER その他のすべての粒度。配信できないため、まとめてバケット化されます。

住所

処理後の住所の詳細。後処理には、住所のスペルミスの修正、誤った部分の置き換え、不足している部分の推定が含まれます。

JSON 表現 
{
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "addressComponents": [
    {
      object (AddressComponent)
    }
  ],
  "missingComponentTypes": [
    string
  ],
  "unconfirmedComponentTypes": [
    string
  ],
  "unresolvedTokens": [
    string
  ]
}
フィールド
formattedAddress

string

住所が存在する地域の住所形式ルールに従って、1 行の住所としてフォーマットされた、後処理済みの住所。

注: このアドレスの形式は、postalAddress フィールドのアドレスの形式と一致しない場合があります。たとえば、postalAddress は常に国を 2 文字の regionCode（「US」や「NZ」など）として表します。一方、このフィールドでは、国名の長い形式（「米国」や「ニュージーランド」など）が使用されます。
postalAddress

object (PostalAddress)

住所として表された、後処理済みの住所。
addressComponents[]

object (AddressComponent)

順序なしリスト。形式が整えられて修正された住所の個々の住所構成要素と、検証情報。これにより、個々のコンポーネントの検証ステータスに関する情報が提供されます。

住所コンポーネントは特定の順序で並べられていません。リスト内の住所の要素の順序を前提としない。
missingComponentTypes[]

string

正しい形式の郵送先住所に存在することが想定されるが、入力に見つからず、推測もできないコンポーネントのタイプ。たとえば、「Boulder, Colorado, 80301, USA」という入力に対して ['street_number', 'route'] という値を指定します。使用可能なタイプのリストについては、こちらをご覧ください。

注: 不足しているコンポーネントをすでに指定していると思われる場合でも、不足しているコンポーネントのタイプが表示されることがあります。たとえば、入力された住所に建物名は含まれていても、建物番号が含まれていない場合に、この問題が発生することがあります。住所「渋谷区渋谷３丁目　 Shibuya Stream」では、建物名「Shibuya Stream」のコンポーネント タイプは premise ですが、施設番号がないため、missingComponentTypes には premise が含まれます。
unconfirmedComponentTypes[]

string

addressComponents に存在するコンポーネントのタイプ。正しいことを確認できなかったコンポーネントです。このフィールドは便宜上提供されています。その内容は、addressComponents を反復処理して、confirmationLevel が CONFIRMED でないか、inferred フラグが true に設定されていないすべてのコンポーネントのタイプを見つけることに相当します。使用可能なタイプのリストについては、こちらをご覧ください。
unresolvedTokens[]

string

入力内の解決できなかったトークン。住所の有効な部分として認識されなかった入力である可能性があります。たとえば、「Parcel 0000123123 & 0000456456 Str # Guthrie Center IA 50115 US」という入力の場合、未解決のトークンは ["Parcel", "0000123123", "&", "0000456456"] のように表示されます。

AddressComponent

住所の構成要素（番地、市区町村、都道府県など）を表します。

JSON 表現 
{
  "componentName": {
    object (ComponentName)
  },
  "componentType": string,
  "confirmationLevel": enum (ConfirmationLevel),
  "inferred": boolean,
  "spellCorrected": boolean,
  "replaced": boolean,
  "unexpected": boolean
}
フィールド
componentName

object (ComponentName)

このコンポーネントの名前。
componentType

string

住所コンポーネントのタイプ。使用可能なタイプのリストについては、表 2: プレイス サービスで返されるその他のタイプをご覧ください。
confirmationLevel

enum (ConfirmationLevel)

コンポーネントが正しいことの確信度を示します。
inferred

boolean

入力の一部ではなかったが、住所の場所から推測されたコンポーネントであり、完全な住所として提供すべきであることを示します。
spellCorrected

boolean

コンポーネント名のスペルミスの修正を示します。API は、スペルのバリエーションの変更を常に報告するわけではありません（「centre」を「center」に変更した場合など）。また、「Amphitheater Pkwy」を「Amphitheatre Pkwy」に変更するなど、よくあるスペルミスが常に報告されるわけではありません。
replaced

boolean

コンポーネントの名前が完全に異なる名前に置き換えられたことを意味します。たとえば、間違った郵便番号が住所に対応する正しい郵便番号に置き換えられたことを意味します。これは外観の変更ではなく、入力コンポーネントが別のコンポーネントに変更されています。
unexpected

boolean

指定された地域の郵便住所に存在することが想定されない住所構成要素を示します。入力の一部であるためのみ保持しています。

ComponentName

コンポーネント名のラッパー。

JSON 表現 
{
  "text": string,
  "languageCode": string
}
フィールド
text

string

名前のテキスト。たとえば、通り名の場合は「5th Avenue」、番地の場合は「1253」と入力します。
languageCode

string

BCP-47 言語コード。コンポーネント名が言語に関連付けられていない場合（番地など）は、このフィールドは表示されません。

ConfirmationLevel

確認レベルに指定できる値。

列挙型
CONFIRMATION_LEVEL_UNSPECIFIED デフォルト値。この値は使用されません。
CONFIRMED このコンポーネントが存在し、住所の他の部分のコンテキストで妥当であることを確認できました。
UNCONFIRMED_BUT_PLAUSIBLE このコンポーネントは確認できませんでしたが、存在する可能性はあります。たとえば、特定の建物番号が不明な道路で、既知の有効な番号範囲内の番地などです。
UNCONFIRMED_AND_SUSPICIOUS このコンポーネントは確認されていないため、誤っている可能性があります。たとえば、住所の残りの部分と一致しない地域などです。

ジオコード

入力がジオコーディングされた場所に関する情報が含まれます。

JSON 表現 
{
  "location": {
    object (LatLng)
  },
  "plusCode": {
    object (PlusCode)
  },
  "bounds": {
    object (Viewport)
  },
  "featureSizeMeters": number,
  "placeId": string,
  "placeTypes": [
    string
  ]
}
フィールド
location

object (LatLng)

入力のジオコーディングされた位置情報。

住所、緯度/経度の座標、Plus Code を使用するよりも、プレイス ID を使用することをおすすめします。ルート検索やルート案内で座標を使用すると、その座標に最も近い道路にポイントがスナップされます。目的地に迅速かつ安全に到達できる道路ではない可能性があります。また、物件へのアクセス ポイントの近くにないこともあります。また、位置情報をリバース ジオコーディングしても、返された住所が元の住所と一致するとは限りません。
plusCode

object (PlusCode)

location に対応する Plus Code。
bounds

object (Viewport)

ジオコーディングされた場所の境界。
featureSizeMeters

number

ジオコーディングされた場所のサイズ（メートル単位）。これは、ジオコーディングされた位置情報の粗さを表すもう 1 つの指標ですが、意味的な意味ではなく物理的なサイズで表されます。
placeId

string

この入力がジオコーディングされる場所の PlaceID。

Place ID について詳しくは、こちらをご覧ください。
placeTypes[]

string

入力がジオコーディングされた場所のタイプ。たとえば、['locality', 'political'].タイプの一覧については、こちらをご覧ください。

LatLng

緯度と経度のペアを表すオブジェクト。これは緯度を表す倍精度値と経度を表す倍精度値のペアで表現されます。特に明記されていない場合、このオブジェクトは WGS84 規格に準拠する必要があります。値は正規化範囲内で指定する必要があります。

JSON 表現 
{
  "latitude": number,
  "longitude": number
}
フィールド
latitude

number

緯度（度単位）。範囲 [-90.0, +90.0] 内になければなりません。
longitude

number

経度（度単位）。範囲 [-180.0, +180.0] 内になければなりません。

PlusCode

Plus Code（http://plus.codes）は、2 つの形式の場所の参照情報です。14 m x 14 m（8000 分の 1）以下の長方形を定義するグローバル コードと、プレフィックスを参照地に置き換えた複合コードです。

JSON 表現 
{
  "globalCode": string,
  "compoundCode": string
}
フィールド
globalCode

string

場所のグローバル（完全）コード（「9FWM33GV+HQ」など）。8000 分の 1 x 8000 分の 1 度（約 14 メートル x 14 メートル）のエリアを表します。
compoundCode

string

場所の複合コード（「33GV+HQ, Ramberg, Norway」など）。グローバル コードの接尾辞が含まれ、接頭辞は参照エンティティの形式付きの名前に置き換えられています。

ビューポート

緯度と経度のビューポート。対角線上の 2 つの low ポイントと high ポイントで表されます。ビューポートは閉じた領域と見なされます。つまり、境界が含まれます。緯度の範囲は -90 ～ 90 度、経度の範囲は -180 ～ 180 度の範囲で指定してください。さまざまなケースには次のようなものがあります。

  • low = high の場合、ビューポートは単一のポイントで構成されます。

  • low.longitude > high.longitude の場合、経度の範囲が反転します（ビューポートが経度 180 度線を越えます）。

  • low.longitude = -180 度、high.longitude = 180 度の場合、ビューポートにはすべての経度が含まれます。

  • low.longitude = 180 度、high.longitude = -180 度の場合、経度の範囲は空になります。

  • low.latitude > high.latitude の場合、緯度範囲は空になります。

low と high の両方に値を入力する必要があります。また、（上記の定義で指定されているように）表されるボックスを空にすることはできません。ビューポートが空の場合、エラーが発生します。

たとえば、このビューポートはニューヨーク市を完全に囲んでいます。

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

JSON 表現 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
フィールド
low

object (LatLng)

必須。ビューポートの低い部分。
high

object (LatLng)

必須。ビューポートの高さ。

AddressMetadata

住所のメタデータ。Address Validation API に送信されるすべての住所について、metadata が完全に入力される保証はありません。

JSON 表現 
{
  "business": boolean,
  "poBox": boolean,
  "residential": boolean
}
フィールド
business

boolean

ビジネスの住所であることを示します。未設定の場合、値が不明であることを示します。
poBox

boolean

私書箱の住所であることを示します。未設定の場合、値が不明であることを示します。
residential

boolean

住所であることを示します。未設定の場合、値が不明であることを示します。

UspsData

住所の USPS データ。Address Validation API に送信された米国またはプエルトリコの住所について、uspsData が完全に入力される保証はありません。uspsData をレスポンスの主な部分として使用する場合は、レスポンスにバックアップ アドレス フィールドを統合することをおすすめします。

JSON 表現 
{
  "standardizedAddress": {
    object (UspsAddress)
  },
  "deliveryPointCode": string,
  "deliveryPointCheckDigit": string,
  "dpvConfirmation": string,
  "dpvFootnote": string,
  "dpvCmra": string,
  "dpvVacant": string,
  "dpvNoStat": string,
  "dpvNoStatReasonCode": integer,
  "dpvDrop": string,
  "dpvThrowback": string,
  "dpvNonDeliveryDays": string,
  "dpvNonDeliveryDaysValues": integer,
  "dpvNoSecureLocation": string,
  "dpvPbsa": string,
  "dpvDoorNotAccessible": string,
  "dpvEnhancedDeliveryCode": string,
  "carrierRoute": string,
  "carrierRouteIndicator": string,
  "ewsNoMatch": boolean,
  "postOfficeCity": string,
  "postOfficeState": string,
  "abbreviatedCity": string,
  "fipsCountyCode": string,
  "county": string,
  "elotNumber": string,
  "elotFlag": string,
  "lacsLinkReturnCode": string,
  "lacsLinkIndicator": string,
  "poBoxOnlyPostalCode": boolean,
  "suitelinkFootnote": string,
  "pmbDesignator": string,
  "pmbNumber": string,
  "addressRecordType": string,
  "defaultAddress": boolean,
  "errorMessage": string,
  "cassProcessed": boolean
}
フィールド
standardizedAddress

object (UspsAddress)

USPS の標準化された住所。
deliveryPointCode

string

2 桁の配送所コード
deliveryPointCheckDigit

string

配送ポイントのチェック ディジット。この番号は、機械的にスキャンされた郵便物の delivery_point_barcode の末尾に追加されます。delivery_point_barcode、deliveryPointCheckDigit、郵便番号、ZIP+4 のすべての桁を加算すると、10 で割り切れる数になります。
dpvConfirmation

string

DPV 確認の有効な値。単一の文字を返すか、値を返しません。

  • N: プライマリ番号とセカンダリ番号の情報が DPV で確認されませんでした。
  • D: 住所がプライマリ番号のみで DPV で確認され、セカンダリ番号の情報が不足しています。
  • S: 住所はプライマリ番号のみで DPV で確認済みであり、セカンダリ番号の情報は存在するものの確認されていません。
  • Y: プライマリ番号とセカンダリ番号の住所が DPV で確認済み。
  • 空: レスポンスに dpvConfirmation 値が含まれていない場合、住所は DPV 確認のために送信されていません。
dpvFootnote

string

配送ポイントの検証に関する脚注。複数の脚注を同じ文字列に連結できます。

  • AA: ZIP+4 ファイルに一致する入力アドレス
  • A1: 入力された住所が ZIP+4 ファイルと一致しませんでした
  • BB: DPV に一致（すべてのコンポーネント）
  • CC: 2 番目の電話番号が一致せず、必須ではない
  • C1: 2 番目の電話番号が一致していないが必須
  • N1: 高層ビルの住所に副番号がない
  • M1: プライマリ番号がない
  • M3: プライマリ番号が無効です
  • P1: 入力された住所の私書箱番号（PO、RR、HC）が欠落している
  • P3: 入力された住所の私書箱番号が正しくない
  • F1: 軍施設の住所に一致する入力アドレス
  • G1: 一般配達先住所に一致する入力アドレス
  • U1: 一意の郵便番号に一致する住所を入力します。
  • PB: PBSA レコードに一致する入力アドレス
  • RR: DPV が PMB 情報を使用して住所を確認済み
  • R1: PMB 情報なしで DPV が確認した住所
  • R7: 運送業者ルート R777 または R779 レコード
  • IA: 通知先住所が特定された
  • TA: 末尾のアルファベットを削除して一致したプライマリ番号
dpvCmra

string

住所が CMRA（商業郵便受取業者）であるかどうかを示します。CMRA とは、クライアントの郵便物を受け取る民間企業です。1 文字を返します。

  • Y: アドレスが CMRA である
  • N: 住所が CMRA ではない
dpvVacant

string

この場所は空いていますか？1 文字を返します。

  • Y: 住所が空き家である
  • N: 住所が空き家ではない
dpvNoStat

string

統計情報のない住所ですか？それとも有効な住所ですか？統計アドレスは、継続的に居住していないアドレスや USPS がサービスを提供していないアドレスは使用できません。1 文字を返します。

  • Y: アドレスがアクティブではありません
  • N: アドレスが有効
dpvNoStatReasonCode

integer

NoStat タイプを示します。理由コードを整数として返します。

  • 1: IDA（内部配送先住所）- USPS から直接郵便物が届くのではなく、配送先住所として指定されている住所。
  • 2: CDS - まだ配達できない住所。たとえば、区画とプライマリ番号が決定されているが、居住可能な建物がまだ存在しない新しい分譲地などです。
  • 3: 競合 - 実際に DPV 確認が行われないアドレス。
  • 4: CMZ（大学、軍隊、その他の種類）- USPS がデータに組み込んだ ZIP + 4 レコード。
  • 5: 通常 - 配送が行われない住所を示します。これらの住所は配送の対象としてカウントされません。
  • 6: セカンダリ必須 - アドレスにセカンダリ情報が必要です。
dpvDrop

string

1 つのサイト内の 1 つの受信トレイに郵便物が配達されることを示すフラグ。1 文字を返します。

  • Y: 郵便物は、サイト内の 1 つの受信トレイに配達されます。
  • N: 郵便物は、サイト内の 1 つの受信トレイに配達されません。
dpvThrowback

string

郵便物が住所に発送されないことを示します。1 文字を返します。

  • Y: 郵便物が番地に配達されない。
  • N: 郵便物は住所宛てに配達されます。
dpvNonDeliveryDays

string

郵便配達が毎日行われないことを示すフラグ。1 文字を返します。

  • Y: 郵便配達は毎日行われるわけではありません。
  • N: 郵便配達が毎日行われていないことを示す記号はありません。
dpvNonDeliveryDaysValues

integer

配達が行われない日を識別する整数。ビットフラグを使用して照会できます。0x40 - 日曜日は配達日ではない 0x20 - 月曜日は配達日ではない 0x10 - 火曜日は配達日ではない 0x08 - 水曜日は配達日ではない 0x04 - 木曜日は配達日ではない 0x02 - 金曜日は配達日ではない 0x01 - 土曜日は配達日ではない
dpvNoSecureLocation

string

ドアは開くことができますが、セキュリティ上の理由から荷物は置きません。1 文字を返します。

  • Y: セキュリティ上の懸念から、パッケージは残されません。
  • N: セキュリティ上の懸念からパッケージが残されないという兆候はありません。
dpvPbsa

string

住所が PBSA レコードと一致したことを示します。1 文字を返します。

  • Y: 住所が PBSA レコードと一致しました。
  • N: 住所が PBSA レコードと一致しませんでした。
dpvDoorNotAccessible

string

USPS がドアをノックして郵便物を配達できない住所を示すフラグ。1 文字を返します。

  • Y: ドアにはアクセスできません。
  • N: ドアが開かないことを示す表示はありません。
dpvEnhancedDeliveryCode

string

住所に対して複数の DPV 戻りコードが有効であることを示します。1 文字を返します。

  • Y: プライマリ番号とセカンダリ番号の住所が DPV で確認済み。
  • N: プライマリ番号とセカンダリ番号の情報が DPV で確認されませんでした。
  • S: 住所がプライマリ番号でのみ DPV で確認され、セカンダリ番号の情報は存在するものの確認されていないか、プライマリ番号の末尾のアルファベットが 1 つ削除されて DPV が一致し、セカンダリ情報が必須になっている。
  • D: 住所がプライマリ番号のみで DPV で確認され、セカンダリ番号の情報が不足しています。
  • R: 住所は確認されているが、ファントム ルート R777 と R779 に割り当てられており、USPS 配達は提供されていない。
carrierRoute

string

運送業者のルートコード。1 文字の接頭辞と 3 桁のルート記号で構成される 4 文字のコード。

接頭辞:

  • C: 運送業者のルート（または市内ルート）
  • R: 農村ルート
  • H: 高速道路契約ルート
  • B: 郵便私書箱セクション
  • G: 一般配送ユニット
carrierRouteIndicator

string

運送業者のルート料金の並べ替えインジケーター。
ewsNoMatch

boolean

配送先住所は一致しますが、EWS ファイルには、完全一致がまもなく利用可能になると示されています。
postOfficeCity

string

メインの郵便局がある都市。
postOfficeState

string

メインの郵便局の状態。
abbreviatedCity

string

都市の省略形。
fipsCountyCode

string

FIPS 郡コード。
county

string

郡名。
elotNumber

string

拡張ルート（eLOT）番号。
elotFlag

string

eLOT 昇順/降順フラグ（A/D）。
poBoxOnlyPostalCode

boolean

郵便番号（私書箱のみ）。
pmbDesignator

string

PMB（私書箱）ユニットの指定子。
pmbNumber

string

PMB（私書箱）番号
addressRecordType

string

入力された住所と一致する住所レコードのタイプ。

  • F: FIRM。これは、住所に対して利用可能な最も細かいレベルの一致である、企業レコードとの一致です。
  • G: 一般配送。これは一般配達レコードと一致しています。
  • H: 建物 / アパート。これは、建物またはアパートのレコードと一致しています。
  • P: 郵便受け。これは私書箱に一致しています。
  • R: RURAL ROUTE または HIGHWAY CONTRACT: これは、Rural Route レコードまたは Highway Contract レコードのいずれかに一致します。どちらにも、関連付けられたボックス番号の範囲が設定されている場合があります。
  • S: ストリート レコード: 有効なプライマリ番号範囲を含むストリート レコードと一致しています。
defaultAddress

boolean

デフォルトの住所が見つかったものの、より具体的な住所が存在することを示すインジケーター。
errorMessage

string

USPS データの取得に関するエラー メッセージ。人為的に作成された住所が検出されたために USPS の処理が停止された場合に入力されます。

このエラーが発生すると、USPS データ フィールドにデータが入力されないことがあります。
cassProcessed

boolean

リクエストが CASS で処理されたことを示すインジケーター。

UspsAddress

米国の住所の USPS 表現。

JSON 表現 
{
  "firstAddressLine": string,
  "firm": string,
  "secondAddressLine": string,
  "urbanization": string,
  "cityStateZipAddressLine": string,
  "city": string,
  "state": string,
  "zipCode": string,
  "zipCodeExtension": string
}
フィールド
firstAddressLine

string

住所の 1 行目。
firm

string

会社名。
secondAddressLine

string

住所の 2 行目。
urbanization

string

プエルトリコの都市名。
cityStateZipAddressLine

string

市区群 + 都道府県 + 郵便番号
city

string

市町村名。
state

string

2 文字の州コード。
zipCode

string

郵便番号（例: 10009）。
zipCodeExtension

string

4 桁の郵便番号の拡張（例: 5023）。