你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

GeocodingBatchRequestItem interface

Batch Query 对象

属性

addressLine

相对于区域的地址的官方街道线,由 locality 或 postalCode 属性指定。 此元素的典型用途是提供街道地址或任何官方地址。

如果提供了查询,则 不应使用此参数。

adminDistrict

地址的国家/地区细分部分,例如 WA。

如果提供了查询,则 不应使用此参数。

adminDistrict2

结构化地址的县,如国王。

如果提供了查询,则 不应使用此参数。

adminDistrict3

结构化地址的命名区域。

如果提供了查询,则 不应使用此参数。

bbox

地球上定义为边界框对象的矩形区域。 矩形的边由经度和纬度值定义。 有关详细信息,请参阅位置和区域类型。 指定此参数时,计算位置查询的结果时会考虑地理区域。

示例:[lon1, lat1, lon2, lat2]

coordinates

地球上的一个点,指定为经度和纬度。 指定此参数时,将考虑用户的位置,返回的结果可能与用户更相关。 示例:[lon, lat]

countryRegion

将地理编码结果限制为指定的 ISO 3166-1 Alpha-2 区域/国家/地区代码 ,例如 FR。 这会将搜索限制为指定的区域。

如果提供了查询,则 不应使用此参数。

locality

地址的区域部分,例如西雅图。

如果提供了查询,则 不应使用此参数。

optionalId

将在相应 batchItem 中显示的请求的 ID

postalCode

地址的邮政编码部分。

如果提供了查询,则 不应使用此参数。

query

一个字符串,其中包含有关位置的信息,例如地址或地标名称。

top

将返回的最大响应数。 默认值:5,最小值:1,最大值:20。

view

一个指定 ISO 3166-1 Alpha-2 区域/国家/地区代码的字符串。 这将更改地缘政治争议边界和标签,以与指定的用户区域保持一致。

属性详细信息

addressLine

相对于区域的地址的官方街道线,由 locality 或 postalCode 属性指定。 此元素的典型用途是提供街道地址或任何官方地址。

如果提供了查询,则 不应使用此参数。

addressLine?: string

属性值

string

adminDistrict

地址的国家/地区细分部分,例如 WA。

如果提供了查询,则 不应使用此参数。

adminDistrict?: string

属性值

string

adminDistrict2

结构化地址的县,如国王。

如果提供了查询,则 不应使用此参数。

adminDistrict2?: string

属性值

string

adminDistrict3

结构化地址的命名区域。

如果提供了查询,则 不应使用此参数。

adminDistrict3?: string

属性值

string

bbox

地球上定义为边界框对象的矩形区域。 矩形的边由经度和纬度值定义。 有关详细信息,请参阅位置和区域类型。 指定此参数时,计算位置查询的结果时会考虑地理区域。

示例:[lon1, lat1, lon2, lat2]

bbox?: number[]

属性值

number[]

coordinates

地球上的一个点,指定为经度和纬度。 指定此参数时,将考虑用户的位置,返回的结果可能与用户更相关。 示例:[lon, lat]

coordinates?: number[]

属性值

number[]

countryRegion

将地理编码结果限制为指定的 ISO 3166-1 Alpha-2 区域/国家/地区代码 ,例如 FR。 这会将搜索限制为指定的区域。

如果提供了查询,则 不应使用此参数。

countryRegion?: string

属性值

string

locality

地址的区域部分,例如西雅图。

如果提供了查询,则 不应使用此参数。

locality?: string

属性值

string

optionalId

将在相应 batchItem 中显示的请求的 ID

optionalId?: string

属性值

string

postalCode

地址的邮政编码部分。

如果提供了查询,则 不应使用此参数。

postalCode?: string

属性值

string

query

一个字符串,其中包含有关位置的信息,例如地址或地标名称。

query?: string

属性值

string

top

将返回的最大响应数。 默认值:5,最小值:1,最大值:20。

top?: number

属性值

number

view

一个指定 ISO 3166-1 Alpha-2 区域/国家/地区代码的字符串。 这将更改地缘政治争议边界和标签,以与指定的用户区域保持一致。

view?: string

属性值

string