Address Validation

AddressValidation 类

class google.maps.addressValidation.AddressValidation
library "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 与送达率相关的其他信息。对于发送到 Address Validation API 的每个地址，metadata 不一定都会完全填充。
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 提交。
internalUsageAttributionIds 可选	类型：Iterable<string> optional 用于将调用归因于特定软件包或 OSS 库的标识符。
placeAutocompleteElement 可选	类型：PlaceAutocompleteElement optional 如果使用 PlaceAutocompleteElement，请在此处添加该元素，以便将 AddressValidation API 调用与自动补全会话令牌相关联。
previousResponseId 可选	类型：string optional 对于第一个地址验证请求，不得设置此字段。如果需要更多请求才能完全验证单个地址（例如，如果用户在初始验证后所做的更改需要重新验证），则每个后续请求都必须使用验证序列中第一个响应的 AddressValidation.responseId 填充此字段。
sessionToken 可选	类型：AutocompleteSessionToken optional 一个令牌，用于标识自动补全会话，以便进行结算。
uspsCASSEnabled 可选	类型：boolean optional 启用 USPS CASS 兼容模式。这仅会影响 AddressValidation 的 AddressValidation.uspsData 字段。注意：对于启用了 USPS CASS 的波多黎各地址请求，address 的 PostalAddress.regionCode 必须提供为“PR”，或者 address 的 PostalAddress.administrativeArea 必须提供为“Puerto Rico”（不区分大小写）或“PR”。

Address 类

class google.maps.addressValidation.Address
library "addressValidation"

后处理地址的详细信息。后处理包括更正地址中拼写错误的部分、替换不正确的部分以及推断缺失的部分。

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

属性
components readonly	类型：Array<AddressComponent> 经过格式设置和更正的地址的各个地址组成部分，以及验证信息。这会提供有关各个组件的验证状态的信息。
formattedAddress readonly	类型：string optional 经过后处理的地址，格式为单行地址，遵循地址所在区域的地址格式规则。
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 类

class google.maps.addressValidation.AddressComponent
library "addressValidation"

表示地址的单个组成部分（例如街道名称、城市）。

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 类

class google.maps.addressValidation.AddressMetadata
library "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
库 "addressValidation"

不同的可能值，用于指明组件正确的确定性级别。

这些常量也可以用作字符串。在 TypeScript 中，字符串字面量由 ConfirmationLevelString 类型定义。

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

常量
CONFIRMED
UNCONFIRMED_AND_SUSPICIOUS
UNCONFIRMED_BUT_PLAUSIBLE

Geocode 类

class google.maps.addressValidation.Geocode
library "addressValidation"

包含输入内容经过地理编码后对应的地点的相关信息。

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

属性
bounds readonly	类型：LatLngBounds optional 经过地理编码的地点的边界。
featureSizeMeters readonly	类型：number optional 经过地理编码的地点的尺寸（以米为单位）。这是衡量经过地理编码的位置的粗略程度的另一个指标，但采用的是物理大小而非语义。
location readonly	类型：LatLngAltitude optional 输入的地理编码位置。
placeId readonly	类型：string optional 经过地理编码的地点的地点 ID。建议您使用地点，而不是地址、纬度/经度坐标或 Plus Code。使用坐标进行路线规划或计算行车路线时，系统始终会将该点吸附到距离这些坐标最近的道路上。这条路可能无法快速或安全地到达目的地，也可能不在房产入口附近。此外，对位置进行反向地理编码时，无法保证返回的地址与原始地址一致。
placeTypes readonly	类型：Array<string> 输入内容经过地理编码后对应的地点类型。例如，['locality', 'political']。如需查看类型的完整列表，请参阅 Geocoding API 文档。
plusCode readonly	类型：PlusCode optional 与 location 对应的 Plus Code。

方法
fetchPlace	fetchPlace() 参数：无 返回值：无 返回此 Geocode 的 Place 表示法。如需获取完整的地点详情，应调用 place.fetchFields()。
继承： toJSON

粒度常量

常量 google.maps.addressValidation.Granularity
库 "addressValidation"

地址或地理编码可以具有的各种粒度。当用于指示地址的粒度时，这些值表示地址标识邮寄目的地的粒度有多细。例如，“123 Main Street, Redwood City, CA, 94061”这样的地址标识的是 PREMISE，而“Redwood City, CA, 94061”这样的地址标识的是 LOCALITY。但是，如果我们无法在红木城找到“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
库 "addressValidation"

注意：仅在 v=beta 渠道中提供。

提供对 API 响应的解释性摘要，旨在帮助确定可能采取的后续行动。此字段派生自 API 响应中的其他字段，不应被视为地址准确性或可送达性的保证。

这些常量也可以用作字符串。在 TypeScript 中，字符串字面量由 PossibleNextActionString 类型定义。

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

常量
ACCEPT	API 响应不包含需要其他 PossibleNextAction 值的信号。您可以考虑直接使用经过后期处理的地址，而无需进一步提示客户，但这并不能保证地址有效，并且地址可能仍包含更正内容。您有责任根据自己的风险评估，确定是否以及如何提示客户。
CONFIRM	API 响应的一个或多个字段表明，经过后处理的地址可能存在一些小问题，例如 postal_code 地址组成部分为 replaced。提示客户检查地址有助于提高地址质量。
CONFIRM_ADD_SUBPREMISES	API 响应表明，经过后期处理的地址可能缺少子场所。提示客户检查地址并考虑添加单元号，有助于提高地址质量。经过后期处理的地址可能还存在其他一些小问题。注意：此枚举值只能针对美国地址返回。
FIX	API 响应的一个或多个字段表明后处理地址存在潜在问题，例如 verdict.validation_granularity 为 OTHER。提示客户修改地址有助于提高地址质量。

USPSAddress 类

class google.maps.addressValidation.USPSAddress
library "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 地址的第一行。
secondAddressLine readonly	类型：string optional 地址的第二行。
state readonly	类型：string optional 由 2 个字母组成的州代码。
urbanization readonly	类型：string optional 波多黎各城市化名称。
zipCode readonly	类型：string optional 邮政编码，例如“10009”。
zipCodeExtension readonly	类型：string optional 4 位数邮政编码扩展，例如“5023”。

方法
继承： toJSON

USPSData 类

class google.maps.addressValidation.USPSData
library "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 承运商路线代码。由一个字母前缀和三位数字路线标识符组成的四字符代码。
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（商业邮件接收机构），即为客户接收邮件的私营企业。返回单个字符。
dpvConfirmation readonly	类型：string optional DPV 确认的可能值。返回单个字符或不返回值。
dpvDoorNotAccessible readonly	类型：string optional 此标记表示 USPS 无法上门投递邮件的地址。返回单个字符。
dpvDrop readonly	类型：string optional 此标志表示邮件会递送到某个地点的单个收件箱。返回单个字符。
dpvEnhancedDeliveryCode readonly	类型：string optional 表示该地址有多个有效的 DPV 返回代码。返回单个字符。
dpvFootnote readonly	类型：string optional 来自投递点验证的脚注。多个脚注可能会串联在同一个字符串中。
dpvNonDeliveryDays readonly	类型：string optional 此标记表示并非每周每天都提供邮件递送服务。返回单个字符。
dpvNonDeliveryDaysValues readonly	类型：number optional 用于标识不送货日期的整数。可以使用位标志进行查询：0x40 - 星期日不送货 0x20 - 星期一不送货 0x10 - 星期二不送货 0x08 - 星期三不送货 0x04 - 星期四不送货 0x02 - 星期五不送货 0x01 - 星期六不送货
dpvNoSecureLocation readonly	类型：string optional 此标记表示门可以进入，但出于安全考虑，包裹不会留在此处。返回单个字符。
dpvNoStat readonly	类型：string optional 指明地址是无统计信息地址还是有效地址。“无统计数据”地址是指未被持续占用的地址或 USPS 不提供服务的地址。返回单个字符。
dpvNoStatReasonCode readonly	类型：number optional 指明 NoStat 类型。以 int 形式返回原因代码。
dpvPBSA readonly	类型：string optional 表示地址与 PBSA 记录匹配。返回单个字符。
dpvThrowback readonly	类型：string optional 表示邮件未递送到街道地址。返回单个字符。
dpvVacant readonly	类型：string optional 指明地址是否空置。返回单个字符。
elotFlag readonly	类型：string optional eLOT 升序/降序标志 (A/D)。
elotNumber readonly	类型：string optional 增强型行程路线 (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 将街道或高层建筑记录与套房信息进行匹配时产生的脚注。如果找到匹配的商家名称，则会返回辅助号码。

方法
继承： toJSON

Verdict 类

class google.maps.addressValidation.Verdict
library "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 至少有一个地址组成部分是推断（即添加）出来的，而不是输入的内容，如需了解详情，请参阅 AddressComponent。
hasReplacedComponents readonly	类型：boolean optional 至少有一个地址组成部分被替换 - 请参阅 AddressComponent 了解详情。
hasUnconfirmedComponents readonly	类型：boolean 至少有一个地址组成部分无法分类或验证，如需了解详情，请参阅 AddressComponent。
inputGranularity readonly	类型：Granularity optional 输入地址的粒度。这是解析输入地址的结果，不提供任何验证信号。如需了解验证信号，请参阅 validationGranularity。
possibleNextAction readonly	注意：仅在 v=beta 渠道中提供。 类型：PossibleNextAction optional 根据 API 响应中的其他字段，可能需要采取的后续操作。详情请参见 PossibleNextAction。
validationGranularity readonly	类型：Granularity optional API 可以完全验证地址的精细程度。例如，如果 validationGranularity 为 PREMISE，则表示可以验证 PREMISE 级别及更高级别的所有地址组成部分。