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 は、recipientsorganization の値を無視します。これらのフィールドの値はすべて破棄され、返されません。設定しないでください。

previousResponseId

string

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

enableUspsCass

boolean

USPS CASS 互換モードを有効にします。google.maps.addressvalidation.v1.ValidationResultgoogle.maps.addressvalidation.v1.ValidationResult.usps_data フィールドにのみ影響します。注: プエルトリコの住所に対する USPS CASS 対応リクエストの場合、addressgoogle.type.PostalAddress.region_code を「PR」として指定するか、addressgoogle.type.PostalAddress.administrative_area を「プエルトリコ」(大文字と小文字を区別しない)または「PR」として指定する必要があります。

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

languageOptions

object (LanguageOptions)

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

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

レスポンスの本文

住所検証リクエストへのレスポンス。

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

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 Service Specific Terms が適用されます。詳細については、リリース ステージの説明をご覧ください。

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 から提供される追加の配送フラグ。USPR リージョンでのみ提供されます。

englishLatinAddress

object (Address)

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

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

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

注: englishLatinAddressgoogle.maps.addressvalidation.v1.Address.unconfirmed_component_types フィールドと englishLatinAddress.address_componentsgoogle.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をご覧ください。

たとえば、入力住所に特定のマンション番号が含まれている場合、inputGranularitySUB_PREMISE になります。データベース内のアパート番号が一致しない場合、またはアパート番号が無効な場合、validationGranularityPREMISE 以下である可能性が高くなります。

validationGranularity

enum (Granularity)

API で住所を完全に検証できる粒度。validateたとえば、validationGranularityPREMISE の場合、PREMISE 以上おおまかなレベルのすべての住所コンポーネントが検証可能であることを示します。

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

geocodeGranularity

enum (Granularity)

geocode の粒度に関する情報。これは、ジオコーディングされた位置情報がどの程度粗いかまたは詳細であるかという意味論的意味として理解することができます。

これは、上記の validationGranularity とは異なる場合があります。たとえば、当社のデータベースには、アパート番号の存在が記録されていても、大きなマンションの集合住宅の正確な場所はわからない場合があります。この場合、validationGranularitySUB_PREMISE になりますが、geocodeGranularityPREMISE になります。

addressComplete

boolean

未解決のトークンや、予期しない住所コンポーネント、欠落している住所コンポーネントがない場合、住所は完全とみなされます。詳しくは、missingComponentTypesunresolvedTokens、または 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 その他の粒度は提供できないため、1 つにまとめられます。

住所

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

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

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

unconfirmedComponentTypes[]

string

addressComponents に存在するが、正確であることを確認できなかったコンポーネントのタイプ。このフィールドは便宜上用意されており、その内容は addressComponents を反復処理して confirmationLevelCONFIRMED でないか、inferred フラグが true に設定されていないすべてのコンポーネントの型を検出する場合と同じです。使用可能なタイプのリストについては、こちらをご覧ください。

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)

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

住所、緯度と経度の座標、Plus Codes よりもプレイス 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 Codes(http://plus.codes)は、14mx14m(1/8,000 の度数)以下の長方形を定義するグローバル コードと、プレフィックスを参照の場所に置き換える複合コードという 2 つの形式を持つ場所の参照です。

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

string

場所のグローバル(完全)コード。例: 1/8, 000 x 1/8,000 度の領域(14 x 14 m 以下)を表す「9FWM33GV+HQ」。

compoundCode

string

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

ビューポート

緯度と経度のビューポート。2 つの対角線上の lowhigh のポイントで表されます。ビューポートは閉じた領域と見なされます。つまり、その境界が含まれます。緯度の範囲は -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 の場合、緯度の範囲は空です。

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

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

{ "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 に送信されたすべての米国または PR の住所について、完全に入力される保証はありません。レスポンスの主要部分として 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 の確認に使用できる値。1 文字を返すか、値を返しません。

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

string

デリバリー ポイントの検証の脚注。1 つの文字列に複数の脚注をつなぎ合わせることができます。

  • AA: ZIP+4 ファイルと一致する入力アドレス
  • A1: 入力アドレスが ZIP+4 ファイルと一致しませんでした
  • BB: DPV に一致(すべてのコンポーネント)
  • CC: 予備の電話番号が一致せず、必須ではありません
  • C1: 一致しないが必須となる予備の番号
  • N1: 高層の住所に予備の番号がありません
  • M1: メインの番号がありません
  • M3: メインの番号が無効です
  • P1: 入力住所の PO、RR、HC の箱番号がない
  • P3: 入力された住所の PO、RR、または HC Box 番号が無効
  • 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

統計値のないアドレスですか、それとも有効なアドレスですか?No stat アドレスとは、継続的に占有されていない住所や、USPS がサービスを提供していない住所のことです。1 文字を返します。

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

integer

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

  • 1: IDA(Internal Drop Address)– USPS から直接メールを受信しないが、サービスを提供するドロップ アドレスに配送されるアドレス。
  • 2: CDS - まだ配達されていない住所です。たとえば、区画と 1 次番号は決定されているものの、占有率の構造がまだ存在しない新しい区分です。
  • 3: 競合 - 実際には DPV で確認されていない住所です。
  • 4: CMZ(College, Military and Other Types) - ZIP + 4 件のレコードが USPS によってデータに組み込まれています。
  • 5: 標準 - 住所が配達されていないことを示します。また、その住所は配信候補としてカウントされません。
  • 6: セカンダリ(必須) - このアドレスには予備の情報が必要です。
dpvDrop

string

メールがサイトの単一の受信可能に配信されたことを示すフラグ。1 文字を返します。

  • Y: サイトの単一の受信可能先にメールが配信されます。
  • N: メールはサイトの特定の受信先には配信されません。
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 が確認されたのに、2 つ目の番号の情報が未確認で存在していたか、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(私用メールボックス)のユニット指定子。

pmbNumber

string

PMB(私用メールボックス)番号

addressRecordType

string

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

  • F: FIRM。これは、住所で使用できる最も細かい一致レベルである企業レコードとの一致です。
  • G: 一般配達。これは一般納品レコードと一致します。
  • H: 建物 / アパート。ビルディングまたはアパートのレコードと一致します。
  • P: オフィス ボックスの設置。これは私書箱に一致しています。
  • R: RURAL ROUTE または HIGHWAY CONTRACT: これは、Rural Route または Highway Contract レコードに一致します。どちらのレコードにも、Box 番号の範囲が関連付けられている可能性があります。
  • 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)。