Address Validation (beta)

AddressValidation 类

google.maps.addressValidation.AddressValidation 类

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

用于访问 AddressValidation API 的静态类。

通过调用 const {AddressValidation} = await google.maps.importLibrary("addressValidation") 进行访问。
请参阅 Maps JavaScript API 中的库。

静态方法
fetchAddressValidation	fetchAddressValidation(request) 参数：  request：AddressValidationRequest 返回值：  Promise<AddressValidation> 验证地址。请参阅 https://developers.google.com/maps/documentation/javascript/address-validation/validate-address。

属性
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 接口

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

针对 AddressValidation.fetchAddressValidation 的请求接口。

属性
address	类型：  PostalAddressLiteral 正在验证地址。未设置格式的地址应通过 PostalAddress.addressLines 提交。
placeAutocompleteElement optional	类型：  PlaceAutocompleteElement optional 如果使用 PlaceAutocompleteElement，请在此处添加该元素，以将会话令牌与 AddressValidation API 调用相关联。
previousResponseId optional	类型：  string optional 对于第一个地址验证请求，不得设置此字段。如果需要更多请求才能完全验证单个地址（例如，如果用户在初始验证后所做的更改需要重新验证），则每个后续请求都必须使用验证序列中第一个响应中的 AddressValidation.responseId 填充此字段。
sessionToken optional	类型：  AutocompleteSessionToken optional 用于标识自动补全会话的令牌，以便进行结算。
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 类

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

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

通过调用 const {Address} = await google.maps.importLibrary("addressValidation") 进行访问。
请参阅 Maps JavaScript API 中的库。

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

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

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

通过调用 const {AddressComponent} = await google.maps.importLibrary("addressValidation") 进行访问。
请参阅 Maps JavaScript API 中的库。

属性
componentName	类型：  string optional 组件名称文本。例如，街道名称“第五大道”或门牌号“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 类

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

地址的元数据。对于发送到 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 常量

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

表示组件正确性的不同可能值。

通过调用 const {ConfirmationLevel} = await google.maps.importLibrary("addressValidation") 进行访问。
请参阅 Maps JavaScript API 中的库。

常量
CONFIRMED
UNCONFIRMED_AND_SUSPICIOUS
UNCONFIRMED_BUT_PLAUSIBLE

地理编码类

google.maps.addressValidation.Geocode 类

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

包含输入内容经过地理编码后得到的地点信息。

通过调用 const {Geocode} = await google.maps.importLibrary("addressValidation") 进行访问。
请参阅 Maps JavaScript API 中的库。

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

方法
fetchPlace	fetchPlace() 参数：无 返回值：无 返回相应地理编码的 Place 表示形式。如需获取完整的地点详情，应调用 place.fetchFields()。

粒度常量

google.maps.addressValidation.Granularity 常量

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

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

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

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

通过调用 const {PossibleNextAction} = await google.maps.importLibrary("addressValidation") 进行访问。
请参阅 Maps JavaScript API 中的库。

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

USPSAddress 类

google.maps.addressValidation.USPSAddress 类

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

美国邮政服务 (USPS) 提供的美国地址表示法。

通过调用 const {USPSAddress} = await google.maps.importLibrary("addressValidation") 进行访问。
请参阅 Maps JavaScript API 中的库。

属性
city	类型：  string optional 城市名称。
cityStateZipAddressLine	类型：  string optional 包含城市、州和邮政编码的地址行。
firm	类型：  string optional 公司的名称。
firstAddressLine	类型：  string optional 地址的第一行。
secondAddressLine	类型：  string optional 地址的第二行。
state	类型：  string optional 由 2 个字母组成的州代码。
urbanization	类型：  string optional 波多黎各城市化名称。
zipCode	类型：  string optional 邮政编码，例如“10009”。
zipCodeExtension	类型：  string optional 4 位数的邮政编码扩展信息，例如“5023”。

USPSData 类

google.maps.addressValidation.USPSData 类

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

相应地址的 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 邮递路线代码。由一个字母前缀和三个数字的路线指定符组成的四字符代码。
carrierRouteIndicator	类型：  string optional 运输公司路线费率排序指示符。
cassProcessed	类型：  boolean 指示相应请求已通过 CASS 处理。
county	类型：  string optional 县名称。
deliveryPointCheckDigit	类型：  string optional 配送点校验位。此数字会添加到机械扫描邮件的投递点条形码末尾。将 delivery_point_barcode、delivery_point_check_digit、邮政编码和 ZIP+4 的所有数字相加，所得结果应能被 10 整除。
deliveryPointCode	类型：  string optional 2 位数送货点代码。
dpvCMRA	类型：  string optional 指明相应地址是否为 CMRA（商业邮件接收代理机构）- 一种为客户接收邮件的私营企业。返回单个字符。
dpvConfirmation	类型：  string optional DPV 确认的可能值。返回单个字符或不返回值。
dpvDoorNotAccessible	类型：  string optional 此标志表示 USPS 无法上门投递邮件的地址。返回单个字符。
dpvDrop	类型：  string optional 标志表示邮件投递到某个地点的单个信箱。返回单个字符。
dpvEnhancedDeliveryCode	类型：  string optional 表示相应地址有多个有效的 DPV 返回代码。返回单个字符。
dpvFootnote	类型：  string optional 送达地址验证中的脚注。多个脚注可以串联在同一字符串中。
dpvNonDeliveryDays	类型：  string optional 标志表示邮件递送并非每周每天都进行。返回单个字符。
dpvNonDeliveryDaysValues	类型：  number optional 用于标识非配送日期的整数。可以使用位标志进行查询：0x40 - 星期日为非送货日 0x20 - 星期一为非送货日 0x10 - 星期二为非送货日 0x08 - 星期三为非送货日 0x04 - 星期四为非送货日 0x02 - 星期五为非送货日 0x01 - 星期六为非送货日
dpvNoSecureLocation	类型：  string optional 此标志表示门可通行，但出于安全考虑，包裹不会放在门口。返回单个字符。
dpvNoStat	类型：  string optional 指明相应地址是“无统计信息”地址还是“有效”地址。无统计地址是指未持续有人居住的地址或 USPS 不提供服务的地址。返回单个字符。
dpvNoStatReasonCode	类型：  number optional 表示 NoStat 类型。以整数形式返回原因代码。
dpvPBSA	类型：  string optional 表示地址与 PBSA 记录匹配。返回单个字符。
dpvThrowback	类型：  string optional 表示邮件不会递送到街道地址。返回单个字符。
dpvVacant	类型：  string optional 指明地址是否为空。返回单个字符。
elotFlag	类型：  string optional eLOT 升序/降序标志 (A/D)。
elotNumber	类型：  string optional 增强型出行路线 (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（私人邮箱）编号。
poBoxOnlyPostalCode	类型：  boolean 仅限邮政信箱的邮政编码。
postOfficeCity	类型：  string optional 主要邮局城市。
postOfficeState	类型：  string optional 主邮局状态。
standardizedAddress	类型：  USPSAddress optional USPS 标准化地址。
suiteLinkFootnote	类型：  string optional 将街道或高层建筑记录与套房信息进行匹配时生成的脚注。如果找到匹配的商家名称，则返回辅助号码。

Verdict 类

google.maps.addressValidation.Verdict 类

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

表示所提供地址的后处理地址。

通过调用 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 系统推断（即添加）了至少一个输入中没有的地址组成部分，详情请参阅 AddressComponent。
hasReplacedComponents	类型：  boolean optional 至少一个地址组成部分被替换 - 详情请参阅 AddressComponent。
hasUnconfirmedComponents	类型：  boolean 至少有一个地址组成部分无法归类或验证，详情请参阅 AddressComponent。
inputGranularity	类型：  Granularity optional 输入地址的粒度。这是解析输入地址的结果，不提供任何验证信号。如需了解验证信号，请参阅 validationGranularity。
possibleNextAction	类型：  PossibleNextAction optional 根据 API 响应中的其他字段，可能需要采取的后续操作。详情请参见 PossibleNextAction。
validationGranularity	类型：  Granularity optional API 可以完全验证地址的精细度级别。例如，validationGranularity 为 PREMISE 表示可以验证级别为 PREMISE 及更广范围的所有地址组成部分。