Address Validation

AddressValidation クラス

google.maps.addressValidation.AddressValidation クラス
ライブラリ "addressValidation"

AddressValidation API にアクセスするための静的クラス。

const {AddressValidation} = await google.maps.importLibrary("addressValidation");

静的メソッド
fetchAddressValidation	fetchAddressValidation(request) パラメータ: request: AddressValidationRequest 戻り値: Promise<AddressValidation> 住所を検証します。https://developers.google.com/maps/documentation/javascript/address-validation/validate-address をご覧ください。

プロパティ
address readonly	タイプ: Address optional ジオコードではなく、住所自体に関する情報。
geocode readonly	タイプ: Geocode optional 住所がジオコーディングされた場所と位置に関する情報。
metadata readonly	タイプ: AddressMetadata optional 配信可能性に関連するその他の情報。metadata は、Address Validation API に送信されるすべての住所に完全に入力されるとは限りません。
responseId readonly	タイプ: string optional このレスポンスを識別する UUID。住所を再検証する必要がある場合は、新しいリクエストにこの UUID を含める必要があります。
uspsData readonly	タイプ: USPSData optional USPS が提供する追加の配送可能性フラグ。リージョン US と PR でのみ提供されます。
verdict readonly	タイプ: Verdict optional 全体的な判定フラグ

メソッド
継承: toJSON

AddressValidationRequest インターフェース

google.maps.addressValidation.AddressValidationRequest インターフェース

AddressValidation.fetchAddressValidation のリクエスト インターフェース。

プロパティ
address	タイプ: PostalAddressLiteral 検証対象の住所。フォーマットされていない住所は、PostalAddress.addressLines を介して送信する必要があります。
placeAutocompleteElement 省略可	タイプ: PlaceAutocompleteElement optional PlaceAutocompleteElement を使用している場合は、ここに含めて、AddressValidation API 呼び出しを予測入力セッション トークンにリンクします。
previousResponseId 省略可	タイプ: string optional このフィールドは、最初の Address Validation リクエストでは設定しないでください。1 つの住所を完全に検証するために複数のリクエストが必要な場合（たとえば、最初の検証後にユーザーが行った変更を再検証する必要がある場合）、後続の各リクエストでは、検証シーケンスの最初のレスポンスの AddressValidation.responseId をこのフィールドに入力する必要があります。
sessionToken 省略可	タイプ: AutocompleteSessionToken optional 請求処理のために Autocomplete セッションを識別するトークン。
uspsCASSEnabled 省略可	タイプ: boolean optional USPS CASS 互換モードを有効にします。これは、AddressValidation の AddressValidation.uspsData フィールドにのみ影響します。注: プエルトリコの住所に対する USPS CASS 対応リクエストの場合、address の PostalAddress.regionCode を「PR」として指定するか、address の PostalAddress.administrativeArea を「Puerto Rico」（大文字と小文字を区別しない）または「PR」として指定する必要があります。

Address クラス

google.maps.addressValidation.Address クラス
ライブラリ "addressValidation"

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

const {Address} = await google.maps.importLibrary("addressValidation");

プロパティ
components readonly	タイプ: Array<AddressComponent> 形式が整えられ、修正された住所の個々の住所コンポーネントと、検証情報。これにより、個々のコンポーネントの検証ステータスに関する情報が提供されます。
formattedAddress readonly	タイプ: string optional 後処理された住所。住所が所在する地域の住所形式ルールに従って、1 行の住所としてフォーマットされます。
missingComponentTypes readonly	タイプ: Array<string> 正しい形式の送付先住所に存在することが想定されているものの、入力で見つからず、推測できなかったコンポーネントのタイプ。このタイプのコンポーネントは、formatted_address、postal_address、address_components には存在しません。たとえば、「Boulder, Colorado, 80301, USA」のような入力に対しては ['street_number', 'route'] が返されます。指定できるタイプの一覧については、こちらをご覧ください。
postalAddress readonly	タイプ: PostalAddress optional 後処理された住所。住所として表されます。
unconfirmedComponentTypes readonly	タイプ: Array<string> address_components に存在するが、正しいことを確認できなかったコンポーネントのタイプ。このフィールドは便宜上提供されています。その内容は、address_components を反復処理して、AddressComponent.confirmationLevel が ConfirmationLevel.CONFIRMED ではない、または AddressComponent.inferred フラグが true に設定されていないすべてのコンポーネントのタイプを見つけることと同等です。指定できるタイプの一覧については、こちらをご覧ください。
unresolvedTokens readonly	タイプ: Array<string> 解決できなかった入力内のトークン。これは、住所の有効な部分として認識されなかった入力である可能性があります（たとえば、「123235253253 Main St, San Francisco, CA, 94105」のような入力では、未解決のトークンは ["123235253253"] のようになります。これは、有効な番地のように見えないためです）。

メソッド
継承: toJSON

AddressComponent クラス

google.maps.addressValidation.AddressComponent クラス
ライブラリ "addressValidation"

住所の 1 つのコンポーネント（例: 番地、市区町村）を表します。

const {AddressComponent} = await google.maps.importLibrary("addressValidation");

プロパティ
componentName readonly	タイプ: string optional コンポーネント名のテキスト。たとえば、通り名の場合は「5th Avenue」、番地の場合は「1253」です。
componentNameLanguageCode readonly	タイプ: string optional BCP-47 言語コード。コンポーネント名が言語に関連付けられていない場合（番地など）、このフィールドは表示されません。
componentType readonly	タイプ: string optional 住所コンポーネントのタイプ。使用可能なタイプのリストについては、表 2: プレイス サービスで返されるその他のタイプをご覧ください。
confirmationLevel readonly	タイプ: ConfirmationLevel optional コンポーネントが正しいという確実性のレベルを示します。
inferred readonly	タイプ: boolean true の場合、このコンポーネントは入力の一部ではなく、住所の場所から推測されたものです。完全な住所にするには、このコンポーネントを含めることをおすすめします。
replaced readonly	タイプ: boolean コンポーネントの名前がまったく別の名前に置き換えられたことを示します。たとえば、間違った郵便番号を正しい郵便番号に置き換える場合です。これは外観の変更ではなく、入力コンポーネントが別のものに変更されています。
spellCorrected readonly	タイプ: boolean コンポーネント名のスペルミスを修正したことを示します。API は、スペルのバリエーション（「centre」から「center」など）の変更を常にフラグ付けするわけではありません。
unexpected readonly	タイプ: boolean true の場合、このコンポーネントは、指定された地域の住所に存在しないことが想定されます。これは、入力の一部であったために保持されているだけです。

AddressMetadata クラス

google.maps.addressValidation.AddressMetadata クラス
ライブラリ "addressValidation"

アドレスのメタデータ。Address Validation API に送信されるすべての住所について、AddressMetadata が完全に設定されるとは限りません。

const {AddressMetadata} = await google.maps.importLibrary("addressValidation");

プロパティ
business readonly	タイプ: boolean
poBox readonly	タイプ: boolean
residential readonly	タイプ: boolean

メソッド
継承: toJSON

ConfirmationLevel 定数

google.maps.addressValidation.ConfirmationLevel constants
library "addressValidation"

コンポーネントが正しいという確実性のレベルを示す、さまざまな値。

これらの定数は文字列としても使用できます。TypeScript では、文字列リテラルは ConfirmationLevelString 型で定義されます。

const {ConfirmationLevel} = await google.maps.importLibrary("addressValidation");

定数
CONFIRMED
UNCONFIRMED_AND_SUSPICIOUS
UNCONFIRMED_BUT_PLAUSIBLE

Geocode クラス

google.maps.addressValidation.Geocode クラス
ライブラリ "addressValidation"

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

const {Geocode} = await google.maps.importLibrary("addressValidation");

プロパティ
bounds readonly	タイプ: LatLngBounds optional ジオコーディングされた場所の境界。
featureSizeMeters readonly	タイプ: number optional ジオコーディングされた場所のサイズ（メートル単位）。これは、ジオコーディングされた位置の粗さを示すもう 1 つの指標ですが、意味的な意味ではなく、物理的なサイズです。
location readonly	タイプ: LatLngAltitude optional 入力のジオコーディングされた位置。
placeId readonly	タイプ: string optional ジオコーディングされた場所のプレイス ID。住所、緯度 / 経度座標、Plus Code を使用するよりも、Place を使用することをおすすめします。ルート設定や運転ルートの計算に座標を使用すると、その座標に最も近い道路にポイントがスナップされます。この道路は、目的地に迅速または安全に到達できる道路ではない可能性があり、敷地へのアクセス ポイントの近くにない可能性があります。また、ロケーションをリバース ジオコーディングした場合、返される住所が元の住所と一致するとは限りません。
placeTypes readonly	タイプ: Array<string> 入力がジオコーディングされた場所のタイプ。（例: ['locality', 'political']）。タイプの完全なリストについては、Geocoding API のドキュメントをご覧ください。
plusCode readonly	タイプ: PlusCode optional location に対応する Plus Code。

メソッド
fetchPlace	fetchPlace() パラメータ: なし 戻り値: なし このジオコードの Place 表現を返します。場所の詳細をすべて取得するには、place.fetchFields() を呼び出す必要があります。
継承: toJSON

粒度定数

google.maps.addressValidation.Granularity constants
library "addressValidation"

住所またはジオコードが持つさまざまな粒度。住所の粒度を示すために使用される場合、これらの値は、住所が郵送先をどの程度細かく識別するかを示します。たとえば、「123 Main Street, Redwood City, CA, 94061」のような住所は PREMISE を識別し、「Redwood City, CA, 94061」のような住所は LOCALITY を識別します。ただし、Redwood City の「123 Main Street」のジオコードが見つからない場合は、住所がより詳細であっても、返されるジオコードの粒度は LOCALITY になる可能性があります。

これらの定数は文字列としても使用できます。TypeScript では、文字列リテラルは GranularityString 型で定義されます。

const {Granularity} = await google.maps.importLibrary("addressValidation");

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

PossibleNextAction 定数

google.maps.addressValidation.PossibleNextAction constants
library "addressValidation"

注: v=Beta チャンネルでのみ利用できます。

API レスポンスの解釈的な要約を提供します。これは、次に取るべきアクションを決定するのに役立ちます。このフィールドは API レスポンスの他のフィールドから派生したものであり、住所の正確性や配送可能性を保証するものではありません。

これらの定数は文字列としても使用できます。TypeScript では、文字列リテラルは PossibleNextActionString 型で定義されます。

const {PossibleNextAction} = await google.maps.importLibrary("addressValidation");

定数
ACCEPT	API レスポンスに、他の PossibleNextAction 値のいずれかを保証するシグナルが含まれていない。お客様にそれ以上確認を求めずに、後処理された住所を使用することもできます。ただし、その住所が有効であるとは限らず、修正が必要な場合もあります。独自のリスク評価に基づいて、お客様にプロンプトを表示するかどうか、またどのように表示するかを判断するのは、お客様の責任です。
CONFIRM	API レスポンスの 1 つ以上のフィールドは、後処理された住所に軽微な問題がある可能性を示しています。たとえば、postal_code 住所コンポーネントが replaced でした。お客様に住所を確認するよう促すことで、住所の品質を向上させることができます。
CONFIRM_ADD_SUBPREMISES	API レスポンスは、後処理された住所にサブプレミスが欠落している可能性があることを示しています。お客様に住所を確認してもらい、ユニット番号の追加を検討してもらうことで、住所の品質を向上させることができます。後処理された住所には、他にも軽微な問題がある可能性があります。注: この列挙値は、米国の住所に対してのみ返されます。
FIX	API レスポンスの 1 つ以上のフィールドが、後処理された住所に潜在的な問題があることを示しています。たとえば、verdict.validation_granularity が OTHER である場合です。住所を編集するようお客様に促すことで、住所の品質を向上させることができます。

USPSAddress クラス

google.maps.addressValidation.USPSAddress クラス
ライブラリ "addressValidation"

米国の住所の USPS 表現。

const {USPSAddress} = await google.maps.importLibrary("addressValidation");

プロパティ
city readonly	タイプ: string optional 市区町村名。
cityStateZipAddressLine readonly	タイプ: string optional 市区町村、都道府県、郵便番号を含む住所行。
firm readonly	タイプ: string optional 会社の名前。
firstAddressLine readonly	タイプ: string optional 住所の 1 行目
secondAddressLine readonly	タイプ: string optional 住所の 2 行目。
state readonly	タイプ: string optional 2 文字の州コード。
urbanization readonly	タイプ: string optional プエルトリコの都市化名。
zipCode readonly	タイプ: string optional 郵便番号（例: 「10009」）。
zipCodeExtension readonly	タイプ: string optional 4 桁の郵便番号拡張（例: 「5023」）。

メソッド
継承: toJSON

USPSData クラス

google.maps.addressValidation.USPSData クラス
ライブラリ "addressValidation"

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

const {USPSData} = await google.maps.importLibrary("addressValidation");

プロパティ
abbreviatedCity readonly	タイプ: string optional 都市の略称。
addressRecordType readonly	タイプ: string optional 入力された住所と一致する住所レコードのタイプ。
carrierRoute readonly	タイプ: string optional 配送業者ルートコード。1 文字の接頭辞と 3 桁のルート指定子で構成される 4 文字のコード。
carrierRouteIndicator readonly	タイプ: string optional キャリア ルート レートの並べ替えインジケーター。
cassProcessed readonly	タイプ: boolean リクエストが CASS 処理されたことを示すインジケーター。
county readonly	タイプ: string optional 郡名。
deliveryPointCheckDigit readonly	タイプ: string optional 配達ポイントのチェック ディジット。この番号は、機械でスキャンされた郵便物の delivery_point_barcode の末尾に追加されます。delivery_point_barcode、delivery_point_check_digit、郵便番号、ZIP+4 のすべての数字を足し合わせると、10 で割り切れる数字になります。
deliveryPointCode readonly	タイプ: string optional 2 桁の配達ポイントコード。
dpvCMRA readonly	タイプ: string optional 住所が CMRA（Commercial Mail Receiving Agency、顧客の郵便物を受け取る民間企業）であるかどうかを示します。1 文字を返します。
dpvConfirmation readonly	タイプ: string optional DPV 確認に指定できる値。1 文字を返すか、値を返しません。
dpvDoorNotAccessible readonly	タイプ: string optional USPS がドアをノックして郵便物を配達できない住所を示すフラグ。1 文字を返します。
dpvDrop readonly	タイプ: string optional このフラグは、郵便物が 1 つの場所にまとめて配達されることを示します。1 文字を返します。
dpvEnhancedDeliveryCode readonly	タイプ: string optional 住所に対して複数の DPV 戻りコードが有効であることを示します。1 文字を返します。
dpvFootnote readonly	タイプ: string optional 配送ポイント検証の脚注。複数の脚注を同じ文字列に連結できます。
dpvNonDeliveryDays readonly	タイプ: string optional このフラグは、郵便配達が毎日行われていないことを示します。1 文字を返します。
dpvNonDeliveryDaysValues readonly	タイプ: number optional 配達不可日を識別する整数。ビットフラグを使用して照会できます。0x40 - 日曜日は配達不可日、0x20 - 月曜日は配達不可日、0x10 - 火曜日は配達不可日、0x08 - 水曜日は配達不可日、0x04 - 木曜日は配達不可日、0x02 - 金曜日は配達不可日、0x01 - 土曜日は配達不可日
dpvNoSecureLocation readonly	タイプ: string optional フラグは、ドアにアクセスできるが、セキュリティ上の懸念により荷物を置かないことを示します。1 文字を返します。
dpvNoStat readonly	タイプ: string optional 住所が統計情報なしの住所か、有効な住所かを示します。「No stat」アドレスとは、継続的に使用されていないアドレス、または USPS がサービスを提供していないアドレスのことです。1 文字を返します。
dpvNoStatReasonCode readonly	タイプ: number optional NoStat タイプを示します。理由コードを int として返します。
dpvPBSA readonly	タイプ: string optional 住所が PBSA レコードと一致したことを示します。1 文字を返します。
dpvThrowback readonly	タイプ: string optional 郵便物が番地に配達されないことを示します。1 文字を返します。
dpvVacant readonly	タイプ: string optional 住所が空室かどうかを示します。1 文字を返します。
elotFlag readonly	タイプ: string optional eLOT 昇順 / 降順フラグ（A/D）。
elotNumber readonly	タイプ: string optional Enhanced Line of Travel（eLOT）番号。
errorMessage readonly	タイプ: string optional USPS データの取得に関するエラー メッセージ。このステータスは、人工的に作成された住所が検出されたために USPS の処理が一時停止された場合に表示されます。
fipsCountyCode readonly	タイプ: string optional FIPS 郡コード。
hasDefaultAddress readonly	タイプ: boolean デフォルトのアドレスが見つかったが、より具体的なアドレスが存在することを示すインジケーター。
hasNoEWSMatch readonly	タイプ: boolean お届け先住所は一致可能ですが、EWS ファイルには、完全一致がまもなく利用可能になると記載されています。
lacsLinkIndicator readonly	タイプ: string optional LACSLink インジケーター。
lacsLinkReturnCode readonly	タイプ: string optional LACSLink の戻りコード。
pmbDesignator readonly	タイプ: string optional PMB（私書箱）のユニット指定子。
pmbNumber readonly	タイプ: string optional PMB（私書箱）番号。
poBoxOnlyPostalCode readonly	タイプ: boolean 私書箱のみの郵便番号。
postOfficeCity readonly	タイプ: string optional 主要な郵便局の都市。
postOfficeState readonly	タイプ: string optional メインの郵便局の州。
standardizedAddress readonly	タイプ: USPSAddress optional USPS の標準的な住所表記。
suiteLinkFootnote readonly	タイプ: string optional 道路または高層ビルのレコードをスイート情報に一致させた場合の脚注。ビジネス名が一致した場合、2 つ目の番号が返されます。

メソッド
継承: toJSON

Verdict クラス

google.maps.addressValidation.Verdict クラス
ライブラリ "addressValidation"

指定された住所の後処理された住所を表します。

const {Verdict} = await google.maps.importLibrary("addressValidation");

プロパティ
addressComplete readonly	タイプ: boolean 未解決のトークン、予期しない住所コンポーネント、欠落している住所コンポーネントがない場合、住所は完全であると見なされます。未設定の場合、値が false であることを示します。詳しくは、Address.missingComponentTypes、Address.unresolvedTokens、AddressComponent.unexpected の各フィールドをご覧ください。
geocodeGranularity readonly	タイプ: Granularity optional Geocode の粒度に関する情報。これは、ジオコーディングされた場所の粗さまたは細かさのセマンティックな意味として理解できます。
hasInferredComponents readonly	タイプ: boolean 入力に含まれていない住所コンポーネントが少なくとも 1 つ推測（追加）されました。詳しくは、AddressComponent をご覧ください。
hasReplacedComponents readonly	タイプ: boolean optional 少なくとも 1 つの住所コンポーネントが置き換えられました。詳しくは、AddressComponent をご覧ください。
hasUnconfirmedComponents readonly	タイプ: boolean 少なくとも 1 つの住所コンポーネントを分類または検証できません。詳しくは、AddressComponent をご覧ください。
inputGranularity readonly	タイプ: Granularity optional 入力住所の粒度。これは、入力アドレスを解析した結果であり、検証シグナルは提供されません。検証シグナルについては、validationGranularity をご覧ください。
possibleNextAction readonly	注: v=Beta チャンネルでのみ利用できます。 タイプ: PossibleNextAction optional API レスポンスの他のフィールドに基づいて、次に実行できるアクション。詳しくは、PossibleNextAction をご覧ください。
validationGranularity readonly	タイプ: Granularity optional API が住所を完全に検証できる粒度レベル。たとえば、validationGranularity が PREMISE の場合、PREMISE 以上のレベルのすべての住所コンポーネントを検証できます。