Method: validateAddress

住所を検証します。

HTTP リクエスト

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

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

リクエスト本文

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

JSON 表現 
{
  "address": {
    object (PostalAddress)
  },
  "previousResponseId": string,
  "enableUspsCass": boolean,
  "languageOptions": {
    object (LanguageOptions)
  }
}
フィールド
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 を使用するか、1 行目に番地と名称を含み、2 行目に市区町村、都道府県、郵便番号を含む google.type.PostalAddress.address_lines を少なくとも 2 つ指定することをおすすめします。
languageOptions

object (LanguageOptions)

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

Address Validation API がレスポンスに追加の情報を含めることを可能にします。

レスポンスの本文

Address Validation リクエストのレスポンス。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

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

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

この出力は、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 が住所を完全にvalidateできる粒度。たとえば、validationGranularity が PREMISE の場合、PREMISE 以上の精度レベルを持つすべての住所コンポーネントを検証できることを示します。

住所ごとのコンポーネント検証の結果は google.maps.addressvalidation.v1.Address.address_components にあります。
geocodeGranularity

enum (Granularity)

geocode の粒度に関する情報。これは、ジオコーディングされた位置情報がどの程度粗いか、または細かいかを示すセマンティックな意味と理解できます。

これは、上記の validationGranularity とは異なる場合があります。たとえば、データベースにアパート番号の存在が記録されていても、大きなマンション内にあるアパートの正確な位置情報はわからない場合があります。この場合、validationGranularity は SUB_PREMISE になりますが、geocodeGranularity は PREMISE になります。
addressComplete

boolean

未解決のトークンや、予期しない住所コンポーネント、欠落している住所コンポーネントがない場合、住所は完全とみなされます。詳細については、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 を識別します。ただし、レッドウッド シティで「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

コンポーネント名のスペルミスが修正されたことを示します。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)

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

プレイス ID は、住所、緯度/経度の座標、Plus Code よりも優先して使用することをおすすめします。ルート選択や運転ルートの計算で座標を使用すると、ポイントは常にその座標に最も近い道路にスナップされます。目的地に迅速かつ安全にアクセスできる道路ではなく、宿泊施設への出入り口の近くにないとは限りません。また、ビジネスがリバース ジオコーディングされても、返される住所が元の住所と同じになるとは限りません。
plusCode

object (PlusCode)

location に対応する Plus Code。
bounds

object (Viewport)

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

number

ジオコーディングされた場所のサイズ（メートル単位）。これはジオコーディングされた場所の粗さのもう 1 つの尺度ですが、意味論的意味よりも物理サイズで示されます。
placeId

string

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

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

string

入力がジオコーディングされた場所のタイプ（1 つ以上）。たとえば、['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）は、14mx14m（1/8,000）以下の長方形を定義するグローバル コードと、プレフィックスを参照場所に置き換える複合コードの 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 データ。Address Validation API に送信されるすべての米国または PR の住所について、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、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: 2 番目の番号が一致せず、必須ではありません
  • C1: 一致しないが必須となるセカンダリ番号
  • N1: 高層住所に予備の番号がありません
  • M1: メインの電話番号がありません
  • M3: メインの番号が無効です
  • P1: PO、RR、HC の箱番号を入力していない
  • P3: 入力した住所に PO、RR、HC Box 番号が無効です
  • F1: 入力住所が軍施設の住所と一致しました
  • G1: 一般的な配送先住所と一致する入力住所
  • U1: 一意の郵便番号に一致する入力住所
  • PB: PBSA レコードと一致した入力アドレス
  • RR: DPV が PMB 情報を含む住所を確認
  • R1: PMB 情報のない DPV 確認済み住所
  • 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（College, Military and Other Types） - ZIP + 4 件のレコードが USPS によりデータに反映されています。
  • 5: レギュラー - この住所が配達を受けていないことを示し、配達可能な住所としてカウントされません。
  • 6: 二次必須 - この住所には二次情報が必要です。
dpvDrop

string

フラグは、サイトの単一の受信可能にメールが配信されたことを示します。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 確認済みで、確認されていない予備の番号情報が存在していたか、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

エンハンスト Line of Travel（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 または HIGHWAY CONTRACT: これは、RURAL ROUTE または HIGHWAY CONTRACT のいずれかのレコードに一致します。どちらのレコードにも、Box 番号の範囲が関連付けられている可能性があります。
  • S: STREET RECORD: 有効なプライマリ数値範囲を含む Street レコードに一致します。
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）。