Method: validateAddress

{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}

integer

PostalAddress のスキーマ リビジョン。0 以外の値を指定すると、API から INVALID_ARGUMENT エラーが返されます。

string

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

string

入力アドレスの言語コードは将来使用するために予約されており、今日は無視されます。API が、住所に対応する適切な言語で住所を返す。

string

（省略可）住所の郵便番号。国によっては郵便番号が使用されていない場合や、指定する必要がない場合もありますが、使用されている場合は住所の他の部分と組み合わせて追加の検証を行うことができます（例: 米国での州と郵便番号の検証）。

string

（省略可）国固有の付加的な並べ替えコード。ほとんどの地域では、これは使用されていません。使用されている場合、値は「CEDEX」のような文字列か（その後に数字を付加した「CEDEX 7」のような形式の場合もあります）、数字のみとなります。たとえば、ジャマイカの「セクターコード」、マラウイの「配達区域インジケーター」、コートジボワールの「郵便局インジケーター」などがこれに該当します。

string

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

string

（省略可）通常は住所の市区町村の部分を指します。たとえば、米国の市、イタリアのコムーネ、英国の郵便町名などがこれに該当します。地域区分が適切に定義されていないところや、この構造にうまく適合しない地域では、locality を空のままにして addressLines を使用してください。

string

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

string

必須。構造化されていない住所の下位部分を記述する行。

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

住所は、addressLines に含まれるすべての情報で構成します。regionCode が指定されていない場合、リージョンは住所行から推定されます。

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

string

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

string

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

{
  "verdict": {
    object (Verdict)
  },
  "address": {
    object (Address)
  },
  "geocode": {
    object (Geocode)
  },
  "metadata": {
    object (AddressMetadata)
  },
  "uspsData": {
    object (UspsData)
  }
}

object (Verdict)

全体的な判定フラグ

object (Address)

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

object (Geocode)

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

object (AddressMetadata)

成果物に関連するその他の情報。Address Validation API に送信されるすべてのアドレスに metadata が完全に入力されるとは限りません。

object (UspsData)

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

{
  "inputGranularity": enum (Granularity),
  "validationGranularity": enum (Granularity),
  "geocodeGranularity": enum (Granularity),
  "addressComplete": boolean,
  "hasUnconfirmedComponents": boolean,
  "hasInferredComponents": boolean,
  "hasReplacedComponents": boolean
}

enum (Granularity)

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

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

enum (Granularity)

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

住所コンポーネントごとの検証結果は google.maps.addressvalidation.v1.Address.address_components で確認できます。

enum (Granularity)

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

状況によっては、上記の validationGranularity と異なる場合があります。たとえば、データベースにはアパートの存在は記録されているものの、アパートの正確な位置がわからないケースがこれに該当します。その場合、validationGranularity は SUB_PREMISE ですが、geocodeGranularity は PREMISE になります。

boolean

未解決のトークンがない場合や、予期しない、または住所コンポーネントの欠落がない場合、その住所は完全であるとみなされます。詳しくは、missingComponentTypes、unresolvedTokens、unexpected の各フィールドをご覧ください。

boolean

1 つ以上の住所コンポーネントを分類または検証できません。詳しくは、google.maps.addressvalidation.v1.Address.address_components をご覧ください。

boolean

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

boolean

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

{
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "addressComponents": [
    {
      object (AddressComponent)
    }
  ],
  "missingComponentTypes": [
    string
  ],
  "unconfirmedComponentTypes": [
    string
  ],
  "unresolvedTokens": [
    string
  ]
}

string

住所を含む地域の住所形式ルールに従い、修正された住所を 1 行で入力します。

object (PostalAddress)

住所として検証された住所。

object (AddressComponent)

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

住所コンポーネントが特定の順序で並べられていない。リスト内の住所コンポーネントの順序は推測しません。

string

正しい形式の住所に存在すると想定されていたものの、入力で見つからず、推測できなかったコンポーネントの種類。このタイプのコンポーネントは、formattedAddress、postalAddress、addressComponents には存在しません。たとえば、「Boulder, Colorado, 80301, USA」などの入力の場合、['street_number', 'route'] になります。有効なタイプのリストについては、こちらをご覧ください。

string

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

string

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

{
  "componentName": {
    object (ComponentName)
  },
  "componentType": string,
  "confirmationLevel": enum (ConfirmationLevel),
  "inferred": boolean,
  "spellCorrected": boolean,
  "replaced": boolean,
  "unexpected": boolean
}

object (ComponentName)

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

string

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

enum (ConfirmationLevel)

コンポーネントが正しいという確信のレベルを示します。

boolean

構成要素が入力の一部ではなかったものの、住所の場所が推測され、完全な住所のものであると判断されたことを示します。

boolean

コンポーネント名のスペルが少し間違って修正されたことを示します。たとえば、間違った順序で表示される 2 文字を入力したなどです。外観が変更されていることを示します。

boolean

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

boolean

指定された地域の住所に存在しない住所コンポーネントを示します。入力の一部であったため、保持しています。

{
  "text": string,
  "languageCode": string
}

string

名前のテキスト。たとえば、番地の場合は「5th Avenue」、番地の場合は「1253」です。

string

BCP-47 言語コード。コンポーネント名が言語（番地など）に関連付けられていない場合、この属性は存在しません。

{
  "location": {
    object (LatLng)
  },
  "plusCode": {
    object (PlusCode)
  },
  "bounds": {
    object (Viewport)
  },
  "featureSizeMeters": number,
  "placeId": string,
  "placeTypes": [
    string
  ]
}

object (LatLng)

入力のジオコード位置情報。

場所 ID は、住所、緯度と経度の座標、Plus Code よりも優先的に使用します。運転ルートのルーティングや計算に使用する座標は常に、その座標に最も近い道路にスナップされます。目的地に速くまたは安全につながる道路ではなく、アクセス ポイントの近くにない場合もあります。また、位置情報がリバース ジオコーディングされている場合、返される住所が元の住所と一致するという保証はありません。

object (PlusCode)

location に対応する plus code。

object (Viewport)

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

number

ジオコーディングされた場所のサイズ（メートル単位）。これはジオコードされた場所の大まかな尺度ですが、意味論的意味ではなく物理サイズです。

string

この入力のジオコーディング先の PlaceID。

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

string

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

{
  "latitude": number,
  "longitude": number
}

number

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

number

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

{
  "globalCode": string,
  "compoundCode": string
}

string

プレイスのグローバル（フル）コード（「9FWM33GV+HQ」など）。1/8000 x 1/8000 度（14 x 14 m 程度）を表す。

string

プレイスの複合コード（「33GV+HQ, Ramberg, Norway」など）。グローバル コードのサフィックスが含まれ、プレフィックスが参照エンティティのフォーマット名に置き換えられます。

{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}

object (LatLng)

必須。ビューポートの下限。

object (LatLng)

必須。ビューポートの要点。

{
  "business": boolean,
  "poBox": boolean,
  "residential": boolean
}

boolean

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

boolean

PO ボックスの住所を示します。設定されていない場合は、値が不明であることを示します。

boolean

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

{
  "standardizedAddress": {
    object (UspsAddress)
  },
  "deliveryPointCode": string,
  "deliveryPointCheckDigit": string,
  "dpvConfirmation": string,
  "dpvFootnote": string,
  "dpvCmra": string,
  "dpvVacant": string,
  "dpvNoStat": 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
}

object (UspsAddress)

USPS 規格化された住所

string

2 桁のお届けポイント コード

string

配達場所チェック ディジット。この番号は、機械的にスキャンされたメールに対する delivery_point_barcode の末尾に追加されます。delivery_point_barcode、deliveryPointCheckDigit、postal code、ZIP+4 のすべての桁を加算すると、10 で割り切れる数値になります。

string

DPV の確認で表示される有効な値。1 文字を返します。

• Y: メインの番号とすべての予備の番号について、DPV の住所が確認されました。
• N: プライマリおよびセカンダリ番号情報が DPV の確認に失敗しました。
• S: プライマリ番号についてのみ DPV が確認され、未確認ではセカンダリ番号の情報が存在しています。
• D: プライマリ番号についてのみ DPV が確認され、セカンダリ番号の情報がありませんでした。

string

デリバリー ポイントの検証に関する脚注。同じ脚注の脚注が複数存在する場合があります。

• AA: ZIP+4 ファイルと一致する入力アドレス
• A1: 入力アドレスが ZIP+4 ファイルと一致しません。
• BB: DPV に一致（すべてのコンポーネント）
• CC: セカンダリ番号が一致しません（存在するが無効）
• N1: 高層ビルの住所に予備の電話番号がない
• M1: メインの電話番号がありません
• M3: メインの電話番号が無効です
• P1: 入力住所 RR または HC ボックス番号がない
• P3: 入力住所 PO、RR、または HC ボックス番号が無効です
• F1: 入力内容が軍の住所と一致
• G1: 一般的な配送先住所と一致する入力住所
• U1: 一意の郵便番号と一致する入力アドレス
• PB: PBSA レコードと一致する入力アドレス
• RR: DPV で確認済みのアドレスと PMB の情報
• R1: DPV で確認済みのアドレス（PMB 情報なし）
• R7: キャリア ルート R777 または R779 レコード

string

その住所が CMRA（商用メール受信代理店）であるかどうかを示します。CMRA はクライアント宛てのメールを受信するプライベート ビジネスです。1 文字を返します。

• Y: アドレスは CMRA
• N: アドレスは CMRA ではありません

string

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

• Y: 住所が空です。
• N: 住所が空でない

string

これはデータなしの住所ですか、それとも有効な住所ですか。米国の住所は、継続的に占有されていない住所または USPS が対応していない住所です。1 文字を返します。

• Y: 住所が有効ではない
• N: 住所は有効です

string

運送業者の経路コード。1 文字のプレフィックスと 3 桁のルート指定子で構成される 4 文字のコード。

接頭辞:

• C: キャリアルート（または都市ルート）
• R: 地方
• H: 高速道路の契約経路
• B: 私書箱のセクション
• G: 一般的な配送単位

string

運送業者の送料レートの表示

boolean

配送先住所は照合可能ですが、EWS ファイルには完全一致が利用可能になる予定です。

string

主要な郵便局の都市。

string

メインの郵便局の都道府県。

string

都市名の略称。

string

FIPS 郡コード。

string

国名。

string

Enhanced Line of Travel（eLOT）番号。

string

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

string

LACSLink のリターンコード。

string

LACSLink インジケーター。

boolean

私書箱のみの郵便番号。

string

番地や高層の記録とスイートの情報が一致する脚注。ビジネス名の一致が見つかった場合は、2 番目の番号が返されます。

• A: SuiteLink のレコード一致、ビジネスの住所が改善されました。
• 00: 一致なし。ビジネス拠点の住所は改善されない。

string

PMB（Private Mail Box）ユニット指定子。

string

PMB（私書箱）の番号

string

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

• F: 企業。これは、住所に最適な最高レベルの企業レコードとのマッチです。
• G: 一般配送。これは General Delivery の記録と一致します。
• H: 建築 / アパートこれはビルディングまたはアパートのレコードに一致します。
• P: オフィスボックスを投稿。これは私書箱に相当します。
• R: RALAL ROUTE または HIGHWAY CONTRACT: これは、地方ルートまたは高速道路契約レコードと一致します。どちらのレコードにもボックス番号の範囲が関連付けられている可能性があります。
• S: STREET RECORD: 有効なプライマリ番号の範囲を含むストリート レコードと一致します。

boolean

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

string

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

このエラーが存在する場合、USPS データ フィールドは入力されない可能性があります。

boolean

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

{
  "firstAddressLine": string,
  "firm": string,
  "secondAddressLine": string,
  "urbanization": string,
  "cityStateZipAddressLine": string,
  "city": string,
  "state": string,
  "zipCode": string,
  "zipCodeExtension": string
}

string

最初の住所の行。

string

会社名。

string

2 つ目の住所行。

string

プエルトリコの都市名。

string

市区町村 + 都道府県 + 郵便番号

string

市町村名。

string

2 文字の州コード。

string

郵便番号（例: 10009）。

string

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