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 を「プエルトリコ」として指定する必要があります。（「PR」）を入力します。

コンポーネント化された address を使用するか、2 つ以上の google.type.PostalAddress.address_lines を指定して、1 行目に番地と名前、2 行目に市区町村、都道府県、郵便番号を含めることをおすすめします。
languageOptions

object (LanguageOptions)

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

レスポンスに追加の情報を含めるために Address Validation API を有効にします。
sessionToken

string

省略可。請求処理のために予測入力セッションを識別する文字列。URL とファイル名セーフ、長さが 36 文字以下の base64 文字列にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。

セッションは、ユーザーが Autocomplete クエリを実行すると開始し、場所を選択して Place Details または Address Validation への呼び出しを行うと終了します。各セッションには複数の Autocomplete クエリがあり、その後に 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 の値は型情報を持たず、単一のフィールドに複数の値が含まれることもあるため（例: "Austin, TX"）、行の順序が明確であることが重要です。住所の順序は「封筒順」にする必要があります入力します。

住所の構造的表現として最低限許容されるものは、addressLines に配置されたすべての情報です。regionCode が指定されていない場合、地域は住所行から推測されます。

完全に構造化されていない住所を処理するには、住所のどの部分が地域区分や行政区域であるかを推測するのではなく、addressLines のみを含む住所を作成してからジオコーディングを行うことをおすすめします。
recipients[]

string

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

string

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

LanguageOptions

プレビュー: この機能は、pre-GA（一般提供前）のプレビュー版です。一般提供前のプロダクトと機能では、サポートが制限されることがあります。また、一般提供前のプロダクトや機能の変更は、他の一般提供前のバージョンと互換性がない場合があります。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)

成果物に関するその他の情報。metadata は、Address Validation API に送信されるすべての住所に対して完全に入力されるとは限りません。
uspsData

object (UspsData)

USPS から提供される追加の配送に関するフラグ。リージョン US と PR でのみ提供されます。
englishLatinAddress

object (Address)

プレビュー: この機能は、pre-GA（一般提供前）のプレビュー版です。一般提供前のプロダクトと機能では、サポートが制限されることがあります。また、一般提供前のプロダクトや機能の変更は、他の一般提供前のバージョンと互換性がない場合があります。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」のような住所です。「Redwood City, CA, 94061」のように、PREMISE を識別します。LOCALITY を識別します。ただし、「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

object (PostalAddress)

郵便の宛先として表される後処理の住所。
addressComponents[]

object (AddressComponent)

順序なしリスト。フォーマット済みおよび修正された住所に含まれる個々の住所要素、および検証情報。個々のコンポーネントの検証ステータスに関する情報が提供されます。

住所コンポーネントの順序は決まっていません。リスト内の住所コンポーネントの順序は想定しないでください。
missingComponentTypes[]

string

正しい形式の送付先住所に存在すると想定されているものの、入力に含まれていない、かつ推定できないコンポーネントのタイプ。このタイプのコンポーネントは、formattedAddress、postalAddress、addressComponents に存在しません。たとえば、「Boulder, Colorado, 80301, USA」のような入力の場合、['street_number', 'route'] になります。利用可能なタイプのリストについては、こちらをご覧ください。
unconfirmedComponentTypes[]

string

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

string

解決できなかった入力内のトークン。これは、住所の有効な部分として認識されなかった入力である可能性があります（たとえば、「123235253253 Main St, San Francisco, CA, 94105」のような入力の場合、未解決のトークンは有効な番地には見えないため、["123235253253"] のようになります。

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

コンポーネント名のスペルミスを修正することを示します。「centre」を変更した場合など、スペルのバリエーションを別のバリエーションに変更した場合、API は常にフラグを付けるわけではありません「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)

入力のジオコーディングされた場所。

プレイス ID は、住所、緯度と経度の座標、Plus Code ではなく、プレイス ID の使用をおすすめします。運転ルートを計算したりルートを計算したりする際に座標を使用すると、その座標に最も近い道路にポイントがスナップされます。この道路は、目的地にすばやくまたは安全に通じる道路ではなく、宿泊施設へのアクセス ポイントの近くにない場合があります。また、場所がリバース ジオコーディングされた場合、返される住所が元の住所と一致する保証はありません。
plusCode

object (PlusCode)

location に対応する Plus Code。
bounds

object (Viewport)

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

number

ジオコーディングされた場所のサイズ（メートル単位）。これも、ジオコードされた位置の大まかな粗さを表しますが、セマンティックな意味ではなく物理的なサイズで表します。
placeId

string

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

プレイス 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）は、14 mx14 m（次数の 1/8,000 分の 1）以下の長方形を定義するグローバル コードと、プレフィックスを基準位置に置き換える複合コードという 2 つの形式の位置参照です。

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

string

場所のグローバル（完全な）コード（「9FWM33GV+HQ」など）。1/8, 000 x 1/8,000 度（約 14 x 14 メートル）の領域を表します。
compoundCode

string

場所の複合コード（「33GV+HQ, Ramberg, Norway」など）。グローバル コードの接尾辞を含み、接頭辞が参照エンティティのフォーマットされた名前に置き換えられます。

ビューポート

緯度と経度のビューポート。対角線上に low と high の 2 つのポイントとして表されます。ビューポートは閉じた領域、つまりその境界線を含む領域と見なされます。緯度境界は -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

アドレスのメタデータ。metadata は、Address Validation API に送信されるすべての住所に対して完全に入力されるとは限りません。

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

boolean

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

boolean

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

boolean

居住地の住所であることを示します。設定されていない場合、値が不明であることを示します。

UspsData

住所の USPS データ。uspsData は、Address Validation API に送信されるすべての米国またはプエルトリコの住所に対して完全な住所が入力されるとは限りません。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、postal code、ZIP+4 のすべての桁を足すと、10 で割り切れる数値になります。
dpvConfirmation

string

DPV 確認に使用できる値。1 文字を返すか、値を返しません。

  • N: プライマリおよびセカンダリの電話番号情報を DPV で確認できませんでした。
  • D: メインの電話番号についてのみ住所が DPV で確認されましたが、予備の電話番号の情報がありませんでした。
  • S: メインの電話番号についてのみ、住所が DPV で確認されました。予備の電話番号の情報は確認されましたが、確認されていません。
  • Y: メインの番号と予備の番号について、アドレスが DPV で確認されました。
  • 空: レスポンスに dpvConfirmation 値が含まれていない場合、そのアドレスは DPV 確認用に送信されていません。
dpvFootnote

string

配送ポイントの検証の脚注。複数の脚注を同じ文字列にまとめることができます。

  • AA: ZIP+4 ファイルに一致する入力アドレス
  • A1: 入力アドレスが ZIP+4 ファイルと一致しませんでした
  • BB: DPV に一致（すべてのコンポーネント）
  • CC: 予備の電話番号が一致せず、必須ではない
  • C1: 2 番目の番号が一致しませんが、入力は必須です
  • N1: 高層ビルの住所に予備の番号がありません
  • M1: メインの電話番号がありません
  • M3: メインの電話番号が無効です
  • P1: 入力された住所の PO、RR、または HC の箱番号が入力されていません
  • P3: 入力した住所の PO、RR、または HC のボックス番号が無効です
  • F1: 入力住所が軍施設の住所と一致する
  • G1: 入力住所が一般的な配送先住所と一致している
  • U1: 入力された住所が一意の郵便番号に一致
  • PB: 入力アドレスが PBSA レコードと一致
  • RR: DPV 確認済みアドレスと PMB 情報
  • R1: DPV 確認済みアドレス（PMB 情報なし）
  • R7: Carrier Route R777 または R779 レコード
  • IA: 通知先住所が特定されました
  • TA: 末尾のアルファをドロップすることで一致したメインの番号
dpvCmra

string

住所が CMRA（Commercial Mail Received Agency）（顧客の郵便物を受け取る民間企業）であるかどうかを示します。1 文字を返します。

  • Y: アドレスは CMRA です
  • N: 住所が CMRA ではありません
dpvVacant

string

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

  • Y: 住所が空です
  • N: 住所が空ではありません
dpvNoStat

string

これは統計のないアドレスですか、それともアクティブなアドレスですか？「どの統計住所も」とは、継続的に居住していないものや、USPS がサービスを提供していない住所のことです。1 文字を返します。

  • Y: アドレスが有効ではありません。
  • N: アドレスは有効です。
dpvNoStatReasonCode

integer

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

  • 1: IDA（Internal Drop Address）– USPS から直接郵便物を受け取らないが、サービスを提供する持ち込み住所に配送されるアドレス。
  • 2: CDS - まだ配送可能になっていない住所。例: ロット数とメインの番号は決まっているが、居住用の構造がまだ存在しない新しい区分。
  • 3: 衝突 - 実際には DPV でない住所が確認できました。
  • 4: CMZ（大学、軍事、その他のタイプ）- USPS がデータに組み込んだ ZIP + 4 レコード。
  • 5: Regular - 配信を受信していないアドレスであり、そのアドレスは配信の可能性があるものとしてカウントされないことを示します。
  • 6: 二次必須 - この住所には二次情報が必要です。
dpvDrop

string

フラグは、メールがサイト上の 1 つの受信可能なものに配信されることを示します。1 文字を返します。

  • Y: メールは、サイトの 1 つの受信ボックスに配信されます。
  • N: メールは、サイトの 1 つの受信者に配信されません。
dpvThrowback

string

郵便物が番地に配達されないことを示します。1 文字を返します。

  • Y: 郵便は番地に配達されません。
  • N: 郵便は番地に配達されます。
dpvNonDeliveryDays

string

フラグは、メール配信が毎日行われていないことを示します。1 文字を返します。

  • Y: メール配信は毎日行われません。
  • N: メール配信が毎日行われるわけではない。
dpvNonDeliveryDaysValues

integer

配信されない日を識別する整数値。ビットフラグを使用して調べることができます。 0x40 – 日曜日は未配送日 0x20 – 月曜日は未配送日 0x10 – 火曜日は未配送日 0x08 – 水曜日は未配送日 0x04 – 木曜日は未配送日 0x02 – 金曜日は未配送日 0x02 – 金曜日は未配送日 0x1
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 で確認されており、セカンダリ番号情報が存在していたが確認されなかったか、DPV を一致させセカンダリ情報を必須とするためにプライマリ番号の末尾のアルファが 1 つドロップされました。
  • 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（Private Mail Box）ユニット指定子。
pmbNumber

string

PMB（個人用メールボックス）番号
addressRecordType

string

入力アドレスに一致するアドレス レコードのタイプ。

  • F: FIRM。これは、住所に使用できる最高レベルの一致である Firm Record との一致です。
  • G: 一般的な配信。これは一般配信レコードと一致します。
  • H: 建物 / マンション。これはビルディングまたはアパートの記録と一致しています。
  • P: オフィス用ボックス。これは私書箱と一致します。
  • R: RURAL ROUTE or HIGHWAY CONTRACT: Rural Route または Highway Contract のいずれかの記録に一致します。どちらにもボックス番号の範囲が関連付けられている可能性があります。
  • S: STREET RECORD: 有効なメインの数値範囲を含むストリート レコードと一致します。
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。