AddressValidation クラス
google.maps.addressValidation.AddressValidation
クラス
AddressValidation API にアクセスするための静的クラス。
const {AddressValidation} = await google.maps.importLibrary("addressValidation")
を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
静的メソッド | |
---|---|
fetchAddressValidation |
fetchAddressValidation(request) パラメータ:
戻り値:
Promise<AddressValidation> |
プロパティ | |
---|---|
address |
タイプ:
Address optional ジオコードではなく、住所そのものに関する情報。 |
geocode |
タイプ:
Geocode optional 住所のジオコーディング先の場所とスポットに関する情報。 |
metadata |
タイプ:
AddressMetadata optional 配信可能性に関連するその他の情報。Address Validation API に送信されるすべてのアドレスに対して metadata が完全に設定される保証はありません。 |
responseId |
タイプ:
string optional このレスポンスを識別する UUID。住所の再検証が必要な場合は、この UUID を新しいリクエストに含める必要があります。 |
uspsData |
タイプ:
USPSData optional USPS が提供する配送可能性に関する追加のフラグ。リージョン US と PR でのみ提供されます。 |
verdict |
タイプ:
Verdict optional 全体的な判定フラグ |
メソッド | |
---|---|
toJSON |
toJSON() パラメータ: なし
戻り値:
Object AddressValidation クラスを同じプロパティを持つ JSON オブジェクトに変換します。 |
AddressValidationRequest インターフェース
google.maps.addressValidation.AddressValidationRequest
インターフェース
AddressValidation.fetchAddressValidation
のリクエスト インターフェース。
プロパティ | |
---|---|
address |
タイプ:
PostalAddressLiteral 検証中の住所。書式設定されていない住所は、 PostalAddress.addressLines から送信してください。 |
previousResponseId optional |
タイプ:
string optional このフィールドは、最初のアドレス検証リクエストでは設定しないでください。1 つの住所を完全に検証するために複数のリクエストが必要な場合(たとえば、最初の検証後にユーザーが行った変更を再検証する必要がある場合)、後続の各リクエストで、検証シーケンスの最初に応答された AddressValidation.responseId をこのフィールドに入力する必要があります。 |
uspsCASSEnabled optional |
タイプ:
boolean optional USPS CASS 互換モードを有効にします。これは AddressValidation の AddressValidation.uspsData フィールドにのみ影響します。注: USPS CASS 対応のリクエストでプエルトリコの住所を指定する場合は、address の PostalAddress.regionCode を「PR」として指定するか、address の PostalAddress.administrativeArea を「Puerto Rico」(大文字と小文字を区別しない)または「PR」として指定する必要があります。 |
Address クラス
google.maps.addressValidation.Address
クラス
後処理された住所の詳細。後処理では、住所のスペルミスを修正したり、誤った部分を置き換えたり、欠落した部分を推測したりします。
const {Address} = await google.maps.importLibrary("addressValidation")
を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
プロパティ | |
---|---|
components |
タイプ:
Array<AddressComponent> 形式が設定され修正された住所の個々の住所コンポーネントと、検証情報。これにより、個々のコンポーネントの検証ステータスに関する情報が提供されます。 |
formattedAddress |
タイプ:
string optional 後処理された住所。住所が所在する地域の住所形式ルールに従って 1 行の住所としてフォーマットされます。 |
missingComponentTypes |
タイプ:
Array<string> 正しい形式の住所に存在することが想定されるが、入力には存在せず、推測もできないコンポーネントのタイプ。このタイプのコンポーネントは、 formatted_address 、postal_address 、address_components には存在しません。たとえば、「Boulder, Colorado, 80301, USA」という入力に対して ['street_number', 'route'] が返されることがあります。使用可能なタイプのリストについては、こちらをご覧ください。 |
postalAddress |
タイプ:
PostalAddress optional 郵便住所として表される後処理済み住所。 |
unconfirmedComponentTypes |
タイプ:
Array<string> address_components に存在するが、正しいことを確認できなかったコンポーネントのタイプ。このフィールドは便宜上提供されています。その内容は、address_components を反復処理して、AddressComponent.confirmationLevel が ConfirmationLevel.CONFIRMED ではないか、AddressComponent.inferred フラグが true に設定されていないすべてのコンポーネントのタイプを見つけることと同等です。使用可能なタイプのリストについては、こちらをご覧ください。 |
unresolvedTokens |
タイプ:
Array<string> 解決できなかった入力内のトークン。これは、住所の有効な部分として認識されなかった入力である可能性があります(たとえば、「123235253253 Main St, San Francisco, CA, 94105」という入力では、有効な番地ではないため、未解決のトークンは ["123235253253"] のように見えることがあります)。 |
AddressComponent クラス
google.maps.addressValidation.AddressComponent
クラス
住所の 1 つのコンポーネント(町名、市区町村など)を表します。
const {AddressComponent} = await google.maps.importLibrary("addressValidation")
を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
プロパティ | |
---|---|
componentName |
タイプ:
string optional コンポーネント名のテキスト。たとえば、通り名の場合は「5th Avenue」、番地の場合は「1253」などです。 |
componentNameLanguageCode |
タイプ:
string optional BCP-47 言語コード。コンポーネント名が言語に関連付けられていない場合(番地など)、これは存在しません。 |
componentType |
タイプ:
string optional 住所コンポーネントのタイプ。使用可能なタイプのリストについては、表 2: プレイス サービスで返されるその他のタイプをご覧ください。 |
confirmationLevel |
タイプ:
ConfirmationLevel optional コンポーネントが正しいことの確実性レベルを示します。 |
inferred |
タイプ:
boolean true の場合、このコンポーネントは入力の一部ではありませんでしたが、住所の位置情報から推測されました。完全な住所には、このコンポーネントを含めることが推奨されます。 |
replaced |
タイプ:
boolean コンポーネントの名前がまったく別の名前に置き換えられたことを示します。たとえば、間違った郵便番号を住所に合った正しい郵便番号に置き換えるなどです。これは外観上の変更ではなく、入力コンポーネントが別のものに変更されています。 |
spellCorrected |
タイプ:
boolean コンポーネント名のスペルミスを修正したことを示します。API は、「centre」から「center」のように、スペルが異なるだけの変更を常に検出するわけではありません。 |
unexpected |
タイプ:
boolean true の場合、このコンポーネントは指定された地域の住所に存在しないことが想定されます。入力の一部であったため、保持されています。 |
AddressMetadata クラス
google.maps.addressValidation.AddressMetadata
クラス
住所のメタデータ。Address Validation API に送信されるすべてのアドレスに対して AddressMetadata が完全に設定される保証はありません。
const {AddressMetadata} = await google.maps.importLibrary("addressValidation")
を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
プロパティ | |
---|---|
business |
タイプ:
boolean |
poBox |
タイプ:
boolean |
residential |
タイプ:
boolean |
ConfirmationLevel 定数
google.maps.addressValidation.ConfirmationLevel
定数
コンポーネントが正しいことの確実性のレベルを示すさまざまな値。
const {ConfirmationLevel} = await google.maps.importLibrary("addressValidation")
を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
定数 | |
---|---|
CONFIRMED |
|
UNCONFIRMED_AND_SUSPICIOUS |
|
UNCONFIRMED_BUT_PLAUSIBLE |
Geocode クラス
google.maps.addressValidation.Geocode
クラス
入力がジオコーディングされた場所に関する情報が含まれます。
const {Geocode} = await google.maps.importLibrary("addressValidation")
を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
プロパティ | |
---|---|
bounds |
タイプ:
LatLngBounds optional ジオコーディングされた場所の境界。 |
featureSizeMeters |
タイプ:
number optional ジオコード化された場所のサイズ(メートル単位)。これは、ジオコーディングされた位置の粗さを測定する別の方法ですが、意味ではなく物理的なサイズで測定します。 |
location |
タイプ:
LatLngAltitude optional 入力のジオコーディングされた位置。 |
placeId |
タイプ:
string optional ジオコーディングされた場所のプレイス ID。住所、緯度/経度座標、Plus Code よりも Place の使用が推奨されます。ルーティングや運転ルートの計算に座標を使用すると、常にその座標に最も近い道路にポイントがスナップされます。この道路は、目的地に迅速かつ安全に到達できる道路ではない可能性があり、物件へのアクセス ポイントの近くにない可能性があります。また、位置情報のリバース ジオコーディングでは、返される住所が元の住所と一致する保証はありません。 |
placeTypes |
タイプ:
Array<string> 入力がジオコーディングされた場所のタイプ。たとえば、 ['locality', 'political'] .タイプの一覧については、Geocoding API のドキュメントをご覧ください。 |
plusCode |
タイプ:
PlusCode optional location に対応する Plus Code。 |
メソッド | |
---|---|
fetchPlace |
fetchPlace() パラメータ: なし
戻り値: なし
この Geocode の Place 表現を返します。場所の詳細情報を取得するには、place.fetchFields() を呼び出す必要があります。 |
粒度定数
google.maps.addressValidation.Granularity
定数
住所またはジオコードが持つことができるさまざまな粒度。address の粒度を示すために使用される場合、これらの値は、アドレスがどの程度の粒度で宛先を識別するかを示します。たとえば、「123 Main Street, Redwood City, CA, 94061」のような住所は PREMISE
を識別しますが、「Redwood City, CA, 94061」のような住所は LOCALITY
を識別します。ただし、Redwood City の「123 Main Street」のジオコードが見つからない場合、住所はより詳細であっても、返されるジオコードは LOCALITY
の粒度になる可能性があります。
const {Granularity} = await google.maps.importLibrary("addressValidation")
を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
定数 | |
---|---|
BLOCK |
住所またはジオコードがブロックを示している。日本など、ブロックレベルのアドレス指定がある地域でのみ使用されます。 |
OTHER |
その他のすべての粒度(配信できないため、まとめてバケット化されます)。 |
PREMISE |
建物レベルの結果。 |
PREMISE_PROXIMITY |
住所の建物レベルの位置を近似するジオコード。 |
ROUTE |
ジオコードまたは住所は、ルート(道路、道路、高速道路など)まで細かく指定されています。 |
SUB_PREMISE |
建物レベル以下の結果(アパートなど)。 |
PossibleNextAction 定数
google.maps.addressValidation.PossibleNextAction
定数
API レスポンスの解釈的な概要を提供し、次に取るべきアクションを判断するのに役立ちます。このフィールドは API レスポンスの他のフィールドから派生したものであり、住所の正確性や配達可能性を保証するものではありません。
const {PossibleNextAction} = await google.maps.importLibrary("addressValidation")
を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
定数 | |
---|---|
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
クラス
米国の住所の USPS 表現。
const {USPSAddress} = await google.maps.importLibrary("addressValidation")
を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
プロパティ | |
---|---|
city |
タイプ:
string optional 市区町村名。 |
cityStateZipAddressLine |
タイプ:
string optional 市区町村、都道府県、郵便番号を含む住所行。 |
firm |
タイプ:
string optional 会社の名前。 |
firstAddressLine |
タイプ:
string optional 住所の 1 行目。 |
secondAddressLine |
タイプ:
string optional 住所の 2 行目。 |
state |
タイプ:
string optional 2 文字の州コード。 |
urbanization |
タイプ:
string optional プエルトリコの都市化の名前。 |
zipCode |
タイプ:
string optional 郵便番号(例: 10009)。 |
zipCodeExtension |
タイプ:
string optional 4 桁の郵便番号指定オプション(例: 5023)。 |
USPSData クラス
google.maps.addressValidation.USPSData
クラス
住所の USPS データ。Address Validation API に送信された米国またはプエルトリコのアドレスすべてに対して、USPSData が完全に設定されるとは限りません。レスポンスの主な部分として uspsData を使用する場合は、レスポンスにバックアップ アドレス フィールドを統合することをおすすめします。
const {USPSData} = await google.maps.importLibrary("addressValidation")
を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
プロパティ | |
---|---|
abbreviatedCity |
タイプ:
string optional 省略された都市名。 |
addressRecordType |
タイプ:
string optional 入力された住所と一致する住所レコードのタイプ。 |
carrierRoute |
タイプ:
string optional 配達ルートのコード。1 文字のプレフィックスと 3 桁のルート指定子で構成される 4 文字のコード。 |
carrierRouteIndicator |
タイプ:
string optional 携帯通信会社のルートレートの並べ替えインジケーター。 |
cassProcessed |
タイプ:
boolean リクエストが CASS 処理されたことを示すインジケーター。 |
county |
タイプ:
string optional 郡名。 |
deliveryPointCheckDigit |
タイプ:
string optional 配送ポイントのチェック ディジット。この番号は、機械でスキャンされた郵便物の delivery_point_barcode の末尾に追加されます。delivery_point_barcode、delivery_point_check_digit、郵便番号、ZIP+4 のすべての数字を足すと、10 で割り切れる数になります。 |
deliveryPointCode |
タイプ:
string optional 2 桁の配送ポイント コード。 |
dpvCMRA |
タイプ:
string optional 住所が CMRA(Commercial Mail Receiving Agency)かどうかを示します。CMRA は、クライアントのメールを受け取る民間企業です。1 文字を返します。 |
dpvConfirmation |
タイプ:
string optional DPV 確認の有効な値。1 文字を返すか、値を返しません。 |
dpvDoorNotAccessible |
タイプ:
string optional フラグは、USPS がドアをノックして郵便物を配達できない住所を示します。1 文字を返します。 |
dpvDrop |
タイプ:
string optional フラグは、メールがサイトの 1 つの受取場所に配達されることを示します。1 文字を返します。 |
dpvEnhancedDeliveryCode |
タイプ:
string optional 住所に対して複数の DPV 戻りコードが有効であることを示します。1 文字を返します。 |
dpvFootnote |
タイプ:
string optional 配送ポイントの検証からの脚注。複数の脚注を同じ文字列に連結できます。 |
dpvNonDeliveryDays |
タイプ:
string optional フラグは、メール配信が毎日行われないことを示します。1 文字を返します。 |
dpvNonDeliveryDaysValues |
タイプ:
number optional 配達されない日を識別する整数。ビットフラグを使用して照会できます。0x40 - 日曜日は配達不可 0x20 - 月曜日は配達不可 0x10 - 火曜日は配達不可 0x08 - 水曜日は配達不可 0x04 - 木曜日は配達不可 0x02 - 金曜日は配達不可 0x01 - 土曜日は配達不可 |
dpvNoSecureLocation |
タイプ:
string optional ドアにアクセスできるが、セキュリティ上の懸念から荷物は配達されないことを示すフラグ。1 文字を返します。 |
dpvNoStat |
タイプ:
string optional 住所が統計なしの住所か、有効な住所かを示します。No stat addresses は、継続的に占有されていない住所、または USPS がサービスを提供していない住所です。1 文字を返します。 |
dpvNoStatReasonCode |
タイプ:
number optional NoStat タイプを示します。理由コードを整数として返します。 |
dpvPBSA |
タイプ:
string optional アドレスが PBSA レコードと一致したことを示します。1 文字を返します。 |
dpvThrowback |
タイプ:
string optional メールが住所に配達されないことを示します。1 文字を返します。 |
dpvVacant |
タイプ:
string optional 住所が空いているかどうかを示します。1 文字を返します。 |
elotFlag |
タイプ:
string optional eLOT 昇順/降順フラグ(A/D)。 |
elotNumber |
タイプ:
string optional Enhanced Line of Travel(eLOT)番号。 |
errorMessage |
タイプ:
string optional USPS のデータ取得に関するエラー メッセージ。これは、人工的に作成された住所が検出されたために USPS の処理が一時停止された場合に設定されます。 |
fipsCountyCode |
タイプ:
string optional FIPS 郡コード。 |
hasDefaultAddress |
タイプ:
boolean デフォルトのアドレスが見つかったが、より具体的なアドレスが存在することを示すインジケーター。 |
hasNoEWSMatch |
タイプ:
boolean 配送先住所は一致しますが、EWS ファイルには完全一致がまもなく利用可能になることが示されています。 |
lacsLinkIndicator |
タイプ:
string optional LACSLink インジケーター。 |
lacsLinkReturnCode |
タイプ:
string optional LACSLink の戻りコード。 |
pmbDesignator |
タイプ:
string optional PMB(私書箱)ユニット指定子。 |
pmbNumber |
タイプ:
string optional PMB(Private Mail Box)番号。 |
poBoxOnlyPostalCode |
タイプ:
boolean 私書箱専用の郵便番号。 |
postOfficeCity |
タイプ:
string optional 主要な郵便局の市区町村。 |
postOfficeState |
タイプ:
string optional メインの郵便局の状態。 |
standardizedAddress |
タイプ:
USPSAddress optional USPS の標準化された住所。 |
suiteLinkFootnote |
タイプ:
string optional 街路または高層ビルのレコードと部屋番号情報を照合した結果の脚注。ビジネス名の照合で一致が見つかった場合、セカンダリ番号が返されます。 |
Verdict クラス
google.maps.addressValidation.Verdict
クラス
指定された住所の後処理済み住所を表します。
const {Verdict} = await google.maps.importLibrary("addressValidation")
を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
プロパティ | |
---|---|
addressComplete |
タイプ:
boolean 未解決のトークンがなく、予期しない住所コンポーネントや欠落している住所コンポーネントがない場合、住所は完全であると見なされます。設定されていない場合、値が false であることを示します。詳細については、Address.missingComponentTypes 、Address.unresolvedTokens 、AddressComponent.unexpected フィールドをご覧ください。 |
geocodeGranularity |
タイプ:
Granularity optional Geocode の粒度に関する情報。これは、ジオコーディングされた位置の粗さまたは細かさのセマンティックな意味として理解できます。 |
hasInferredComponents |
タイプ:
boolean 入力に含まれていないアドレス コンポーネントが 1 つ以上推測(追加)されました。詳しくは、 AddressComponent をご覧ください。 |
hasReplacedComponents |
タイプ:
boolean optional 少なくとも 1 つのアドレス コンポーネントが置き換えられました。詳しくは、 AddressComponent をご覧ください。 |
hasUnconfirmedComponents |
タイプ:
boolean 少なくとも 1 つの住所コンポーネントを分類または検証できません。詳しくは、 AddressComponent をご覧ください。 |
inputGranularity |
タイプ:
Granularity optional 入力アドレスの粒度。これは入力アドレスの解析結果であり、検証シグナルは提供されません。検証シグナルについては、 validationGranularity を参照してください。 |
possibleNextAction |
タイプ:
PossibleNextAction optional API レスポンスの他のフィールドに基づいて実行できる次のアクション。詳しくは、 PossibleNextAction をご覧ください。 |
validationGranularity |
タイプ:
Granularity optional API がアドレスを完全に検証できる粒度レベル。たとえば、 validationGranularity が PREMISE の場合、PREMISE 以上のレベルのすべての住所コンポーネントを検証できることを示します。 |