Package google.maps.addressvalidation.v1

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

string

经过处理后的地址，格式为单行地址，遵循地址所在区域的地址格式规则。

注意：此地址的格式可能与 postal_address 字段中的地址格式不一致。例如，postal_address 始终将国家/地区表示为 2 个字母的 region_code，例如“US”或“NZ”。与之相反，此字段使用国家/地区名称的长形式，例如“美国”或“新西兰”。

PostalAddress

经过处理后的地址，表示为邮政地址。

AddressComponent

无序列表。经过格式设置和更正的地址的各个地址组成部分，以及验证信息。这会提供有关各个组件的验证状态的信息。

地址组成部分没有特定的排序方式。请勿对列表中地址组成部分的排序做出任何假设。

string

预计应在格式正确的邮寄地址中存在但在输入中未找到且无法推断的组件类型。例如，如果输入值为“Boulder, Colorado, 80301, USA”，则 ['street_number', 'route'] 就是相应的地理编码。您可以在此处找到可能的类型列表。

注意：当您认为自己已提供缺少的组件时，可能会看到缺少组件类型。例如，如果输入的地址包含建筑物名称，但不包含门牌号，就可能会出现这种情况。在地址“渋谷区渋谷３丁目　 Shibuya Stream”中，“Shibuya Stream”建筑物名称的组成部分类型为 premise，但缺少门牌号，因此 missing_component_types 将包含 premise。

string

address_components 中存在但无法确认是否正确的组件类型。此字段是为了方便起见而提供的：其内容相当于迭代 address_components 以查找 confirmation_level 不为 CONFIRMED 或 inferred 标志未设置为 true 的所有组件的类型。您可以在此处找到可能的类型列表。

string

输入中无法解析的任何令牌。这可能是因为输入内容未被识别为地址的有效部分。例如，对于“Parcel 0000123123 & 0000456456 Str # Guthrie Center IA 50115 US”这样的输入，未解析的令牌可能如下所示：["Parcel", "0000123123", "&", "0000456456"]。

ComponentName

此组件的名称。

string

地址组成部分的类型。如需查看可能类型的列表，请参阅表 2：地点服务返回的其他类型。

ConfirmationLevel

表示我们对组件正确性的确信程度。

bool

表示该组成部分并非输入内容的一部分，但我们根据地址位置推断出了该组成部分，并认为应提供该组成部分以便提供完整地址。

bool

表示更正了组件名称中的拼写错误。该 API 并不总会标记从一种拼写变体更改为另一种拼写变体，例如将“centre”更改为“center”。此外，它也不一定会标记常见的拼写错误，例如将“Amphitheater Pkwy”更改为“Amphitheatre Pkwy”。

bool

表示组件的名称已被完全不同的名称替换，例如错误的邮政编码被替换为与地址相符的邮政编码。这不是外观上的更改，输入组件已更改为其他组件。

bool

表示给定地区的邮政地址中不应包含的地址组成部分。我们之所以保留该信息，是因为它是输入内容的一部分。

bool

表示这是商家的地址。如果未设置，则表示值未知。

bool

表示邮政信箱地址。如果未设置，则表示值未知。

bool

表示这是住宅的地址。如果未设置，则表示值未知。

string

名称文本。例如，街道名称为“第 5 大道”，门牌号为“1253”。

string

BCP-47 语言代码。如果组件名称与语言无关（例如门牌号），则不会显示此属性。

LatLng

输入内容经过地理编码的位置。

建议使用地点 ID，而不是使用地址、纬度/经度坐标或 Plus Code。在规划路线或计算驾车路线时使用坐标，始终会导致相应点被捕获到距离这些坐标最近的道路。此路线可能无法快速或安全地抵达目的地，也可能不在相应房源的入口附近。此外，对某个位置进行逆向地理编码时，无法保证返回的地址与原始地址一致。

PlusCode

与 location 对应的 Plus Code。

Viewport

经过地理编码的地点的边界。

float

经过地理编码的地点的大小（以米为单位）。这是衡量经过地理编码的位置粗糙程度的另一种方法，但以实际大小（而非语义含义）衡量。

string

此输入地理编码的地点的 PlaceID。

如需详细了解地点 ID，请点击此处。

string

输入内容经过地理编码后对应的地点类型。例如，['locality', 'political']。您可以点击此处查看完整的类型列表。

bool

预览：以英语返回 google.maps.addressvalidation.v1.Address。如需了解详情，请参阅 google.maps.addressvalidation.v1.ValidationResult.english_latin_address。

string

地点的全局（完整）代码，例如“9FWM33GV+HQ”，表示 1/8, 000 度 x 1/8,000 度（约 14 米 x 14 米）的区域。

string

地点的混合代码，例如“33GV+HQ, Ramberg, Norway”，其中包含全局代码的后缀，并将前缀替换为参考实体的格式化名称。

ValidationConclusion

必需。验证尝试序列的结果。

如果将此字段设置为 VALIDATION_CONCLUSION_UNSPECIFIED，系统会返回 INVALID_ARGUMENT 错误。

string

必需。此反馈所针对的回复的 ID。这应为一系列地址验证尝试中的第一个响应中的 [response_id][google.maps.addressvalidation.v1.ValidateAddressRequest.response_id]。

string

地址的第一行。

string

公司名称。

string

地址的第二行。

string

波多黎各城市化区域名称。

string

城市 + 州/省级行政区 + 邮政编码。

string

城市名称。

string

由 2 个字母组成的州代码。

string

邮政编码，例如 10009。

string

4 位数的邮政编码附加信息，例如 5023。

UspsAddress

USPS 标准地址。

string

2 位数投递点代码

string

送货点校验码。对于机械扫描的邮件，此编号会添加到 delivery_point_barcode 的末尾。将 delivery_point_barcode、delivery_point_check_digit、邮政编码和 ZIP+4 的所有数字相加，所得数字应为 10 的倍数。

string

DPV 确认的可能值。返回单个字符或不返回任何值。

• N：主号码和所有辅助号码信息均未能通过 DPV 确认。
• D：仅主号码的地址通过了 DPV 确认，次要号码信息缺失。
• S：只有主号码的地址通过了 DPV 确认，次要号码的信息存在但未经确认。
• Y：主要号码和所有辅助号码的地址已通过 DPV 确认。
• 空：如果响应不包含 dpv_confirmation 值，则表示地址未提交以进行 DPV 确认。

string

送货点验证中的脚注。多个脚注可以串联在同一字符串中。

• AA：与邮政编码+4 文件匹配的输入地址
• A1：输入的地址与邮政编码+4 文件不匹配
• BB：与 DPV 匹配（所有组件）
• CC：辅助号码不匹配，但不是必需的
• C1：辅助号码不匹配，但必填
• N1：高层建筑地址缺少辅助编号
• M1：缺少主号码
• M3：主号码无效
• P1：输入地址缺少 PO、RR 或 HC 信箱号
• P3：输入的地址邮政信箱、RR 信箱或 HC 信箱编号无效
• F1：输入的地址与军事地址匹配
• G1：输入的地址与通用送货地址匹配
• U1：输入的地址与唯一的邮政编码匹配
• PB：与 PBSA 记录匹配的输入地址
• RR：包含 PMB 信息的 DPV 确认地址
• R1：没有 PMB 信息的 DPV 确认地址
• R7：运营商路线 R777 或 R779 记录
• IA：已识别出已获知地址
• TA：通过舍弃尾随字母匹配的主号码

string

指明相应地址是否为 CMRA（商业邮件接收代理机构），即为客户接收邮件的私营企业。返回单个字符。

• Y：地址是 CMRA
• N：地址不是 CMRA

string

这个地方是否空闲？返回单个字符。

• Y：地址空置
• N：地址不空闲

string

这是无状态地址还是有效地址？无统计地址是指未持续有人居住或 USPS 不提供服务的地址。返回单个字符。

• Y：地址处于非活动状态
• N：地址处于有效状态

int32

表示 NoStat 类型。以 int 的形式返回原因代码。

• 1：IDA（内部投递地址）- 这些地址不会直接从 USPS 接收邮件，而是会投递到为其提供服务的投递地址。
• 2：CDS - 尚未可配送的地址。例如，已确定地块和主编号，但尚无可供入住的结构的新分区。
• 3：碰撞 - 实际未通过 DPV 确认的地址。
• 4：CMZ（学院、军事和其他类型）- USPS 已将邮政编码 + 4 个记录纳入数据中。
• 5：常规 - 表示未送达的地址，这些地址不会计入可能送达的地址。
• 6：必须提供辅助信息 - 地址需要辅助信息。

string

此标志表示邮件会投递到某个地点的单个收件箱。返回单个字符。

• Y：邮件会投递到相应地点的单个收件箱。
• N：邮件未投递到相应地点的单个收件箱。

string

表示邮件未投递到相应街道地址。返回单个字符。

• Y：邮件未送达街道地址。
• N：邮件会配送到街道地址。

string

此标志表示邮件递送并非每周七天都进行。返回单个字符。

• Y：邮件配送并非每周七天都进行。
• N：未指明邮件配送不是每周七天都进行。

int32

用于标识未投放天数的整数。您可以使用位标志进行查询：0x40 - 星期日为非送货日；0x20 - 星期一为非送货日；0x10 - 星期二为非送货日；0x08 - 星期三为非送货日；0x04 - 星期四为非送货日；0x02 - 星期五为非送货日；0x01 - 星期六为非送货日

string

此标志表示可以进入门户，但由于安全问题，快递员不会将包裹留在门口。返回单个字符。

• Y：出于安全考虑，系统不会保留该文件包。
• N：未指明软件包不会因安全问题而保留。

string

表示地址与 PBSA 记录匹配。返回单个字符。

• Y：地址与 PBSA 记录匹配。
• N：地址与 PBSA 记录不匹配。

string

此标志表示 USPS 无法敲门递送邮件的地址。返回单个字符。

• Y：无法进入门内。
• N：未指明门无法进入。

string

表示该地址有多个有效的 DPV 返回代码。返回单个字符。

• Y：主要号码和所有辅助号码的地址已通过 DPV 确认。
• N：主号码和所有辅助号码信息均未能通过 DPV 确认。
• S：仅主号码的地址通过了 DPV 验证，次要号码信息存在但未经验证，或者主号码的尾随字母被舍弃以进行 DPV 匹配，并且需要提供次要信息。
• D：仅主号码的地址通过了 DPV 确认，次要号码信息缺失。
• R：地址已确认，但分配给了虚构的路线 R777 和 R779，并且未提供 USPS 配送服务。

string

运输公司路线代码。一个由一个字母前缀和一个三位数路线标识符组成的四位字符代码。

前缀：

• C：运营商路线（或城市路线）
• R：乡村路线
• H：高速公路合同路线
• B：邮政信箱部分
• G：一般配送部门

string

运营商路线费率排序指标。

bool

送货地址可匹配，但 EWS 文件显示很快就会有完全匹配的地址。

string

主邮局所在的城市。

string

主邮局状态。

string

城市的缩写。

string

FIPS 县代码。

string

郡/县名称。

string

增强型航线 (eLOT) 编号。

string

eLOT 升序/降序标志 (A/D)。

string

LACSLink 返回代码。

string

LACSLink 指示器。

bool

仅限邮政信箱的邮政编码。

string

将街道或高层建筑记录与套房信息进行匹配时生成的脚注。如果找到商家名称匹配项，则会返回辅助号码。

• A：SuiteLink 记录匹配，商家地址经过改进。
• 00：没有匹配项，商家地址未得到改进。

string

PMB（私人邮箱）单元标识符。

string

PMB（私人邮箱）编号；

string

与输入地址匹配的地址记录的类型。

• F：FIRM。这是与公司记录的匹配，这是地址可获得的最精确匹配级别。
• G：一般配送。此地址与“General Delivery”（一般递送）记录匹配。
• H：建筑物 / 公寓。此值与建筑物或公寓记录匹配。
• P：邮政信箱。此地址与邮政信箱相符。
• R：乡村道路或高速公路合同：与乡村道路或高速公路合同记录匹配，这两者都可能具有关联的邮政信箱编号范围。
• S：街道记录：与包含有效主号码范围的街道记录匹配。

bool

指示找到了默认地址，但存在更具体的地址。

string

USPS 数据检索错误消息。如果 USPS 检测到人为创建的地址，则会暂停处理，并填充此字段。

出现此错误时，USPS 数据字段可能不会填充。

bool

指示请求已通过 CASS 处理的指标。

PostalAddress

必需。要验证的地址。无格式的地址应通过 address_lines 提交。

此输入中的字段总长度不得超过 280 个字符。

您可以在此处找到受支持的地区。

输入地址中的 language_code 值是预留供日后使用的，目前会被忽略。系统会根据所给地址的首选语言（由系统识别）来填充经过验证的地址结果。

Address Validation API 会忽略 recipients 和 organization 中的值。这些字段中的所有值都将被舍弃，不会返回。请勿设置这些值。

string

对于首次地址验证请求，此字段必须为空。如果需要发出更多请求才能完全验证单个地址（例如，如果用户在初始验证后所做的更改需要重新验证），则每个后续请求都必须使用验证序列中第一个响应中的 response_id 填充此字段。

bool

启用 USPS CASS 兼容模式。这只会影响 google.maps.addressvalidation.v1.ValidationResult 的 google.maps.addressvalidation.v1.ValidationResult.usps_data 字段。注意：对于启用了 USPS CASS 的波多黎各地址请求，address 的 google.type.PostalAddress.region_code 必须提供为“PR”，或者 address 的 google.type.PostalAddress.administrative_area 必须提供为“Puerto Rico”（不区分大小写）或“PR”。

建议使用组件化 address，或者至少指定两个 google.type.PostalAddress.address_lines，其中第一行包含门牌号和街道名称，第二行包含城市、州/省/直辖市/自治区和邮政编码。

LanguageOptions

可选。预览版：此功能目前为正式发布前的预览版。正式发布前的产品和功能获得的支持可能较为有限，并且对其作出的更改可能不兼容其他正式发布前版本。正式发布前的产品或功能受 Google Maps Platform 服务专用条款约束。如需了解详情，请参阅发布阶段说明。

使 Address Validation API 能够在响应中包含其他信息。

string

可选。用于标识自动补全会话的字符串，以便进行结算。必须是网址和文件名安全的 base64 字符串，长度不得超过 36 个 ASCII 字符。否则，系统会返回 INVALID_ARGUMENT 错误。

会话在用户发出自动补全查询时开始，并在用户选择地点并发出地点详情或地址验证调用时结束。在每个会话中，用户可以输入多项自动补全查询，并最终发出一个地点详情或地址验证请求。在一个会话中，每个请求使用的凭据都必须属于同一 Google Cloud 控制台项目。会话结束后，令牌将失效；您的应用必须为每个会话生成一个新的令牌。如果您省略 sessionToken 参数或重复使用会话令牌，系统会按未提供会话令牌的情况为会话计费（每个请求均单独结算）。

注意：Address Validation 只能在使用 Autocomplete（新版）API（而非 Autocomplete API）的会话中使用。如需了解详情，请访问 https://developers.google.com/maps/documentation/places/web-service/session-pricing。

ValidationResult

地址验证结果。

string

用于标识此响应的 UUID。如果需要重新验证地址，则必须在新的请求中附上此 UUID。

Verdict

总体判定标志

Address

与地理编码相对，与地址本身相关的信息。

Geocode

与地址经过地理编码后对应的地点和地理位置相关的信息。

AddressMetadata

与可送达性相关的其他信息。无法保证为发送到 Address Validation API 的每个地址都填充完整的 metadata。

UspsData

USPS 提供的额外可送达性标志。仅在区域 US 和 PR 中提供。

Address

预览版：此功能目前为正式发布前的预览版。正式发布前的产品和功能获得的支持可能较为有限，并且对其作出的更改可能不兼容其他正式发布前版本。正式发布前的产品或功能受 Google Maps Platform 服务专用条款约束。如需了解详情，请参阅发布阶段说明。

翻译成英语的地址。

转换后的地址无法作为 API 输入重复使用。该服务提供这些信息，以便用户使用其母语确认或拒绝对原始提供的地址进行验证。

如果地址的某个部分没有英语译文，该服务会使用使用拉丁字母的其他语言返回该部分。如需了解如何选择备用语言，请参阅此处。如果地址的某个部分没有任何使用拉丁字母的语言的翻译或转写，该服务会以与地址关联的本地语言返回该部分。

使用 google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address 标志启用此输出。

注意：english_latin_address 中的 google.maps.addressvalidation.v1.Address.unconfirmed_component_types 字段和 english_latin_address.address_components 中的 google.maps.addressvalidation.v1.AddressComponent.confirmation_level 字段未填充。

Granularity

输入地址的粒度。这是解析输入地址的结果，不会提供任何验证信号。如需了解验证信号，请参阅下文中的 validation_granularity。

例如，如果输入的地址包含特定门牌号，则此处的 input_granularity 将为 SUB_PREMISE。如果我们无法在数据库中匹配到公寓号，或者公寓号无效，则 validation_granularity 可能为 PREMISE 或更低。

Granularity

API 可以完全验证地址的精细级别。例如，validation_granularity 为 PREMISE 表示可以验证级别为 PREMISE 或更粗的所有地址组成部分。

您可以在 google.maps.addressvalidation.v1.Address.address_components 中找到每个地址组成部分的验证结果。

Granularity

有关 geocode 精细度的相关信息。这可以理解为地理编码位置的精确程度。

这可能与上面的 validation_granularity 不同。例如，我们的数据库可能会记录某个门牌号的存在，但没有该门牌号在大型公寓楼中的确切位置。在这种情况下，validation_granularity 将为 SUB_PREMISE，但 geocode_granularity 将为 PREMISE。

bool

如果没有未解析的令牌、没有意外的地址组成部分或缺少地址组成部分，则地址会被视为完整。如果未设置，表示值为 false。如需了解详情，请参阅 missing_component_types、unresolved_tokens 或 unexpected 字段。

bool

至少有一个地址组件无法分类或验证，详情请参阅 google.maps.addressvalidation.v1.Address.address_components。

bool

系统推断（添加）了输入中不存在的至少一个地址组成部分，如需了解详情，请参阅 google.maps.addressvalidation.v1.Address.address_components。

bool

至少有一个地址组成部分已替换，如需了解详情，请参阅 google.maps.addressvalidation.v1.Address.address_components。