Package google.maps.places.v1

索引

地点

Places API 的服务定义。注意:每个请求(自动补全请求和 GetPhotoMedia 请求除外)都需要在请求 proto 之外设置字段掩码(all/*,不假设)。可以通过 HTTP 标头 X-Goog-FieldMask 设置字段掩码。请参阅:https://developers.google.com/maps/documentation/places/web-service/choose-fields

AutocompletePlaces

rpc AutocompletePlaces(AutocompletePlacesRequest) returns (AutocompletePlacesResponse)

返回指定输入的预测结果。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform
GetPhotoMedia

rpc GetPhotoMedia(GetPhotoMediaRequest) returns (PhotoMedia)

获取包含照片参考字符串的照片媒体。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform
GetPlace

rpc GetPlace(GetPlaceRequest) returns (Place)

根据地点的资源名称(格式为 places/{place_id} 的字符串)获取地点的详细信息。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform
SearchNearby

rpc SearchNearby(SearchNearbyRequest) returns (SearchNearbyResponse)

搜索位置附近的地点。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform
SearchText

rpc SearchText(SearchTextRequest) returns (SearchTextResponse)

基于文本查询的地点搜索。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

AddressDescriptor

位置的相关说明。包含一组排名靠前的附近地标、精确的包含区域及其与目标位置的关系。

字段
landmarks[]

Landmark

附近地标的排名列表。最容易识别且距离最近的地标会排在最前面。

areas[]

Area

包含区域或相邻区域的排名列表。最容易识别且最精确的区域会排在前面。

领域

区域信息以及区域与目标位置的关系。

区域包括可用于描述位置的精确子位置、社区和大型综合体。

字段
name

string

相应地区的资源名称。

place_id

string

相应区域的地点 ID。

display_name

LocalizedText

相应区域的显示名称。

containment

Containment

定义目标位置与区域之间的空间关系。

contain 属性

定义目标位置与区域之间的空间关系。

枚举
CONTAINMENT_UNSPECIFIED 未指定包含关系。
WITHIN 目标位置位于区域内,靠近中心。
OUTSKIRTS 目标位置位于区域区域内,靠近边缘。
NEAR 目标位置位于区域范围之外,但距离很近。

地标

地标的基本信息以及地标与目标位置的关系。

地标是可用于描述位置的醒目地点。

字段
name

string

地标的资源名称。

place_id

string

地标的地点 ID。

display_name

LocalizedText

地标的显示名称。

types[]

string

相应地标的一组类型标记。如需查看可能值的完整列表,请访问 https://developers.google.com/maps/documentation/places/web-service/place-types

spatial_relationship

SpatialRelationship

定义目标位置与地标之间的空间关系。

straight_line_distance_meters

float

目标中心点与地标中心点之间的直线距离(以米为单位)。在某些情况下,此值可能大于 travel_distance_meters

travel_distance_meters

float

从目标到地标的沿道路网的行驶距离(以米为单位,如果已知)。此值未考虑交通方式,例如步行、驾车或骑行。

SpatialRelationship

定义目标位置与地标之间的空间关系。

枚举
NEAR 如果以下没有更具体的关系,则这是默认关系。
WITHIN 地标具有空间几何图形,并且目标位于其边界内。
BESIDE 目标直接位于地标旁边。
ACROSS_THE_ROAD 目标位于道路另一侧,与地标直接相对。
DOWN_THE_ROAD 与地标位于同一路线,但不在地标旁边或对面。
AROUND_THE_CORNER 不在同一路线上,但只需转一次弯即可到达。
BEHIND 靠近地标的结构,但距离其街道入口较远。

AuthorAttribution

UGC 数据作者的相关信息。在 PhotoReview 中使用。

字段
display_name

string

PhotoReview 的作者姓名。

uri

string

PhotoReview 作者的 URI。

photo_uri

string

PhotoReview 的作者的个人资料照片 URI。

AutocompletePlacesRequest

AutocompletePlaces 的请求 proto。

字段
input

string

必需。要搜索的文本字符串。

location_bias

LocationBias

可选。使结果偏向于指定位置。

location_biaslocation_restriction 最多只能设置一个。如果两者均未设置,结果将按 IP 地址进行偏向,这意味着 IP 地址将映射到不精确的位置并用作偏向信号。

location_restriction

LocationRestriction

可选。将结果限制在指定位置。

location_biaslocation_restriction 最多只能设置一个。如果两者均未设置,结果将按 IP 地址进行偏向,这意味着 IP 地址将映射到不精确的位置并用作偏向信号。

included_primary_types[]

string

可选。地点类型 (https://developers.google.com/maps/documentation/places/web-service/place-types) 中包含的主要地点类型(例如“餐厅”或“加油站”),或仅包含 (regions),或仅包含 (cities)。仅当某个地点的主要类型包含在此列表中时,才会返回该地点。最多可以指定 5 个值。如果未指定任何类型,系统将返回所有地点类型。

included_region_codes[]

string

可选。仅包含指定地区的结果,最多可指定 15 个 CLDR 双字符地区代码。空集不会限制结果。如果同时设置了 location_restrictionincluded_region_codes,结果将位于交集区域。

language_code

string

可选。返回结果所用的语言。默认值为 en-US。如果 input 中使用的语言与 language_code 不同,或者返回的地点没有从本地语言到 language_code 的翻译,则结果可能采用混合语言。

region_code

string

可选。地区代码,以 CLDR 双字符地区代码的形式指定。这会影响地址格式、结果排名,还可能会影响返回的结果。这不会将结果限制在指定区域内。如需将结果限制在某个区域内,请使用 region_code_restriction

origin

LatLng

可选。用于计算到目的地的地理距离(以 distance_meters 形式返回)的起点。如果省略此值,则不会返回地理距离。

input_offset

int32

可选。一个从零开始的 Unicode 字符偏移量,值为 input,用于指示 input 中的光标位置。光标位置可能会影响返回的预测结果。

如果为空,则默认为 input 的长度。

include_query_predictions

bool

可选。如果为 true,则响应将同时包含地点预测和查询预测。否则,响应将仅返回地点预测结果。

session_token

string

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

会话在用户开始输入查询内容时开始,并在用户选择地点且系统执行“地点详情”或“地址验证”调用时结束。在每个会话中,用户可以输入多项查询内容,并最终发送一个地点详情或地址验证请求。会话中每个请求所用的凭据必须属于同一 Google Cloud 控制台项目。会话结束后,令牌将失效;您的应用必须为每个会话生成一个新的令牌。如果您省略 session_token 参数或重复使用会话令牌,系统会按未提供会话令牌的情况为会话计费(每个请求均单独结算)。

我们建议您遵循以下准则:

  • 针对所有“地点自动补全”调用使用会话令牌。
  • 为每个会话生成一个新的令牌。建议使用版本 4 UUID。
  • 确保会话中用于所有“地点自动补全”“地点详情”和“地址验证”请求的凭据属于同一 Cloud 控制台项目。
  • 请务必为每个新会话传递唯一的会话令牌。针对多个会话使用同一令牌会导致每个请求被单独计费。
include_pure_service_area_businesses

bool

可选。如果该字段设置为 true,则包含纯上门服务商家。纯上门服务商家是指为客户送货上门或提供上门服务,但不在自己的商家地址为客户提供服务的商家。例如,清洁服务类商家或管道工。这些商家在 Google 地图上没有实际地址或位置信息。对于这些商家,“地点”将不会返回包含 locationplus_code 和其他与位置相关的字段。

LocationBias

要搜索的地区。结果可能偏向指定区域。

字段

联合字段 type

type 只能是下列其中一项:

rectangle

Viewport

由东北角和西南角定义的视口。

circle

Circle

由中心点和半径定义的圆。

LocationRestriction

要搜索的地区。结果将限制为指定区域。

字段

联合字段 type

type 只能是下列其中一项:

rectangle

Viewport

由东北角和西南角定义的视口。

circle

Circle

由中心点和半径定义的圆。

AutocompletePlacesResponse

AutocompletePlaces 的响应 proto。

字段
suggestions[]

Suggestion

包含建议列表,按相关性降序排列。

建议

自动补全建议结果。

字段

联合字段 kind

kind 只能是下列其中一项:

place_prediction

PlacePrediction

某个营业地点的预测。

query_prediction

QueryPrediction

查询的预测结果。

FormattableText

表示地点或查询预测的文本。您可以直接使用该文本,也可以设置其格式。

字段
text

string

可直接使用或使用 matches 进行格式设置的文本。

matches[]

StringRange

一个字符串范围列表,用于标识输入请求在 text 中的匹配位置。这些范围可用于设置 text 的特定部分的格式。如果匹配是根据字符串匹配以外的其他条件(例如拼写更正或音译)确定的,则子字符串可能与 input 不完全匹配。

这些值是 text 的 Unicode 字符偏移量。系统保证这些范围按偏移值递增的顺序排列。

PlacePrediction

地点自动补全预测的预测结果。

字段
place

string

建议地点的资源名称。此名称可用于接受地点名称的其他 API。

place_id

string

建议地点的唯一标识符。此标识符可用于接受地点 ID 的其他 API。

text

FormattableText

包含返回结果的简明易懂的名称。对于商家结果,这通常是商家名称和地址。

建议希望显示单个界面元素的开发者使用 text。如果开发者希望显示两个单独但相关的界面元素,可能需要改用 structured_format。它们是表示地点预测的两种不同方式。用户不应尝试将 structured_format 解析为 text,反之亦然。

此文本可能与 GetPlace 返回的 display_name 不同。

如果请求 inputlanguage_code 使用不同的语言,或者如果地点没有从本地语言到 language_code 的翻译,则可能采用混合语言。

structured_format

StructuredFormat

地点预测的细分,包括包含地点名称的主要文本和包含其他消歧特征(例如城市或地区)的次要文本。

建议希望显示两个单独但相关的界面元素的开发者使用 structured_format。如果开发者希望显示单个界面元素,不妨改用 text。它们是表示地点预测的两种不同方式。用户不应尝试将 structured_format 解析为 text,反之亦然。

types[]

string

适用于相应地点的类型列表,来自 https://developers.google.com/maps/documentation/places/web-service/place-types 中的表 A 或表 B。

类型是对地点的分类。具有相同类型的地点将具有相似的特征。

distance_meters

int32

origin 开始的测地线长度(以米为单位,如果指定了 origin)。某些预测(例如路线)可能不会填充此字段。

QueryPrediction

查询自动补全预测的预测结果。

字段
text

FormattableText

预测的文本。此文本不代表地点,而是可在搜索端点(例如文本搜索)中使用的文本查询。

建议希望显示单个界面元素的开发者使用 text。如果开发者希望显示两个单独但相关的界面元素,可能需要改用 structured_format。它们是表示查询预测的两种不同方式。用户不应尝试将 structured_format 解析为 text,反之亦然。

如果请求 inputlanguage_code 使用不同的语言,或者部分查询没有从本地语言到 language_code 的翻译,则可能使用混合语言。

structured_format

StructuredFormat

将查询预测分解为包含查询内容的主要文本和包含其他消歧特征(例如城市或地区)的次要文本。

建议希望显示两个单独但相关的界面元素的开发者使用 structured_format。如果开发者希望显示单个界面元素,不妨改用 text。它们是表示查询预测的两种不同方式。用户不应尝试将 structured_format 解析为 text,反之亦然。

StringRange

用于标识给定文本中的子字符串。

字段
start_offset

int32

字符串的第一个 Unicode 字符的从零开始的偏移量(含)。

end_offset

int32

最后一个 Unicode 字符(不含)的从零开始的偏移量。

StructuredFormat

包含地点或查询预测结果的细分信息,分为主要文本和次要文本。

对于地点预测,主要文本包含地点的具体名称。对于查询预测,主要文本包含查询。

辅助文本包含其他消除歧义的特征(例如城市或地区),以进一步识别地点或优化查询。

字段
main_text

FormattableText

表示地点或查询的名称。

secondary_text

FormattableText

表示用于进一步标识地点或优化查询的其他消除歧义功能(例如城市或地区)。

圆形

以 LatLng 为中心和半径的圆。

字段
center

LatLng

必需。中心纬度和经度。

纬度的范围必须在 [-90.0, 90.0] 之间。经度的范围必须在 [-180.0, 180.0] 之间。

radius

double

必需。半径(以米为单位)。半径必须介于 [0.0, 50000.0] 之间。

ContentBlock

可单独投放的内容块。

字段
content

LocalizedText

与主题相关的内容。

referenced_places[]

string

所引用地点的资源名称列表。此名称可用于接受 Place 资源名称的其他 API。

ContextualContent

实验性功能:如需了解详情,请访问 https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative

与地点查询相关的上下文内容。

字段
reviews[]

Review

与地点查询相关的此地点的评价列表。

photos[]

Photo

有关此地点的照片的信息(包括参考信息),与地点查询相关。

justifications[]

Justification

实验性功能:如需了解详情,请访问 https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative

地点的理由。

理由

实验性功能:如需了解详情,请访问 https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative

地点的理由。理由回答了某个地点为何可能吸引最终用户的问题。

字段

联合字段 justification

justification 只能是下列其中一项:

review_justification

ReviewJustification

实验性功能:如需了解详情,请访问 https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative

business_availability_attributes_justification

BusinessAvailabilityAttributesJustification

实验性功能:如需了解详情,请访问 https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative

BusinessAvailabilityAttributesJustification

实验性功能:如需了解详情,请访问 https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative。BusinessAvailabilityAttributes 的理由。此示例展示了商家的一些可能吸引最终用户的属性。

字段
takeout

bool

相应地点是否提供外卖服务。

delivery

bool

如果某个地点提供送货服务。

dine_in

bool

如果某个场所提供堂食。

ReviewJustification

实验性功能:如需了解详情,请访问 https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative

用户评价理由。此属性用于突出显示最终用户可能会感兴趣的用户评价部分。例如,如果搜索查询是“firewood pizza”,评价理由会突出显示与搜索查询相关的文本。

字段
highlighted_text

HighlightedText

review

Review

突出显示的文本所依据的评价。

HighlightedText

由理由突出显示的文本。这是评价本身的一个子集。要突出显示的确切字词由 HighlightedTextRange 标记。文本中可能会有多个字词被突出显示。

字段
text

string

highlighted_text_ranges[]

HighlightedTextRange

突出显示文本的范围列表。

HighlightedTextRange

突出显示的文本的范围。

字段
start_index

int32

end_index

int32

EVChargeOptions

有关地点中托管的电动车辆充电站的信息。术语遵循 https://afdc.energy.gov/fuels/electricity_infrastructure.html。一个充电接口一次只能为一辆汽车充电。一个端口有一个或多个连接器。一个充电站有一个或多个充电桩。

字段
connector_count

int32

相应充电站的连接器数量。不过,由于某些充电端口可能配备多个连接器,但一次只能为一辆汽车充电,因此连接器的数量可能大于可同时充电的汽车总数。

connector_aggregation[]

ConnectorAggregation

包含相同类型和相同充电速率的连接器的电动汽车充电连接器聚合的列表。

ConnectorAggregation

按 [type, max_charge_rate_kw] 分组的电动汽车充电信息。显示具有相同类型和最大充电速率(以千瓦为单位)的连接器的电动汽车充电汇总数据。

字段
type

EVConnectorType

相应聚合的连接器类型。

max_charge_rate_kw

double

汇总中每个连接器的静态最大充电速率(以千瓦为单位)。

count

int32

相应汇总中的连接器数量。

availability_last_update_time

Timestamp

相应汇总中连接器可用性信息的上次更新时间。

available_count

int32

相应聚合中当前可用的连接器数量。

out_of_service_count

int32

相应汇总中目前处于停止服务状态的连接器数量。

EVConnectorType

如需详细了解电动汽车充电连接器类型,请参阅 http://ieeexplore.ieee.org/stamp/stamp.jsp?arnumber=6872107

枚举
EV_CONNECTOR_TYPE_UNSPECIFIED 未指定连接器。
EV_CONNECTOR_TYPE_OTHER 其他连接器类型。
EV_CONNECTOR_TYPE_J1772 J1772 1 型连接器。
EV_CONNECTOR_TYPE_TYPE_2 IEC 62196 Type 2 连接器。通常称为 MENNEKES。
EV_CONNECTOR_TYPE_CHADEMO CHAdeMO 型连接器。
EV_CONNECTOR_TYPE_CCS_COMBO_1 组合充电系统(交流电和直流电)。基于 SAE。Type-1 J-1772 连接器
EV_CONNECTOR_TYPE_CCS_COMBO_2 组合充电系统(交流电和直流电)。基于 Type-2 Mennekes 连接器
EV_CONNECTOR_TYPE_TESLA 通用 TESLA 连接器。在北美,这是 NACS,但在世界其他地区,这可能是非 NACS(例如 CCS Combo 2 (CCS2) 或 GB/T)。此值不太能代表实际的连接器类型,而更代表在 Tesla 自有充电站为 Tesla 品牌车辆充电的能力。
EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T GB/T 类型对应于中国的 GB/T 标准。此类型涵盖所有 GB_T 类型。
EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET 未指定墙壁插座。
EV_CONNECTOR_TYPE_NACS 北美充电系统 (NACS),已标准化为 SAE J3400。

FuelOptions

加油站中有关燃油选项的最新信息。这些信息会定期更新。

字段
fuel_prices[]

FuelPrice

相应加油站每种燃油的最新已知燃油价格。每种燃料类型对应一个条目。顺序并不重要。

FuelPrice

指定类型的燃料价格信息。

字段
type

FuelType

燃料类型。

price

Money

燃油价格。

update_time

Timestamp

上次更新燃油价格的时间。

FuelType

燃料类型。

枚举
FUEL_TYPE_UNSPECIFIED 未指定燃料类型。
DIESEL 柴油。
DIESEL_PLUS 柴油加燃料。
REGULAR_UNLEADED 常规无铅汽油。
MIDGRADE 中级。
PREMIUM Premium。
SP91 SP 91.
SP91_E10 SP 91 E10。
SP92 SP 92.
SP95 SP 95.
SP95_E10 SP95 E10。
SP98 SP 98.
SP99 SP 99.
SP100 SP 100。
LPG 液化石油气。
E80 E 80.
E85 E 85.
E100 E 100.
METHANE 甲烷。
BIO_DIESEL 生物柴油。
TRUCK_DIESEL 卡车柴油。

GetPhotoMediaRequest

请求使用照片资源名称提取某个地点的照片。

字段
name

string

必需。照片媒体的资源名称,格式为:places/{place_id}/photos/{photo_reference}/media

Place 对象的 photos.name 字段中返回的照片资源名称采用 places/{place_id}/photos/{photo_reference} 格式。您需要在照片资源末尾附加 /media,以获取照片媒体资源名称。

max_width_px

int32

可选。指定所需的最大图片宽度(以像素为单位)。如果图片小于指定值,则返回原始图片。如果图片在任一维度上都大于指定尺寸,系统会将其缩放为与两个维度中较小的维度相匹配,但会限制为原始宽高比。max_height_px 和 max_width_px 属性均接受介于 1 到 4800 之间的整数(含 1 和 4800)。如果该值不在允许的范围内,系统会返回 INVALID_ARGUMENT 错误。

必须至少指定 max_height_px 或 max_width_px 之一。如果未指定 max_height_px 和 max_width_px,系统会返回 INVALID_ARGUMENT 错误。

max_height_px

int32

可选。指定图片所需的最大高度(以像素为单位)。如果图片小于指定值,则返回原始图片。如果图片在任一维度上都大于指定尺寸,系统会将其缩放为与两个维度中较小的维度相匹配,但会限制为原始宽高比。max_height_px 和 max_width_px 属性均接受介于 1 到 4800 之间的整数(含 1 和 4800)。如果该值不在允许的范围内,系统会返回 INVALID_ARGUMENT 错误。

必须至少指定 max_height_px 或 max_width_px 之一。如果未指定 max_height_px 和 max_width_px,系统会返回 INVALID_ARGUMENT 错误。

skip_http_redirect

bool

可选。如果设置,则跳过默认的 HTTP 重定向行为,并呈现文本格式(例如,对于 HTTP 使用情形,以 JSON 格式)的响应。如果未设置,系统将发出 HTTP 重定向,以将调用重定向到图片媒体。对于非 HTTP 请求,此选项会被忽略。

GetPlaceRequest

用于根据地点资源名称(格式为 places/{place_id} 的字符串)提取地点的请求。

字段
name

string

必需。地点的资源名称,格式为 places/{place_id}

language_code

string

可选。如果地点详情有首选语言版本,系统会以该语言显示。

当前支持的语言列表:https://developers.google.com/maps/faq#languagesupport

region_code

string

可选。请求来源地的 Unicode 国家/地区代码 (CLDR)。此参数用于显示地点详情,例如特定于区域的地点名称(如果有)。此参数可能会根据适用法律影响结果。如需了解详情,请参阅 https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html

请注意,目前不支持 3 位数的地区代码。

session_token

string

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

会话在用户开始输入查询内容时开始,并在用户选择地点且系统执行“地点详情”或“地址验证”调用时结束。在每个会话中,用户可以输入多项查询内容,并最终发送一个地点详情或地址验证请求。会话中每个请求所用的凭据必须属于同一 Google Cloud 控制台项目。会话结束后,令牌将失效;您的应用必须为每个会话生成一个新的令牌。如果您省略 session_token 参数或重复使用会话令牌,系统会按未提供会话令牌的情况为会话计费(每个请求均单独结算)。

我们建议您遵循以下准则:

  • 针对所有“地点自动补全”调用使用会话令牌。
  • 为每个会话生成一个新的令牌。建议使用版本 4 UUID。
  • 确保会话中用于所有“地点自动补全”“地点详情”和“地址验证”请求的凭据属于同一 Cloud 控制台项目。
  • 请务必为每个新会话传递唯一的会话令牌。针对多个会话使用同一令牌会导致每个请求被单独计费。

照片

有关地点照片的信息。

字段
name

string

标识符。表示相应地点照片的引用,可用于再次查找相应地点照片(也称为 API“资源”名称:places/{place_id}/photos/{photo})。

width_px

int32

最大可用宽度(以像素为单位)。

height_px

int32

可用的最大高度(以像素为单位)。

author_attributions[]

AuthorAttribution

相应照片的作者。

flag_content_uri

string

用户可用于标记照片存在问题的链接。

google_maps_uri

string

用于在 Google 地图上显示照片的链接。

PhotoMedia

来自 Places API 的照片媒体。

字段
name

string

照片媒体的资源名称,格式为:places/{place_id}/photos/{photo_reference}/media

photo_uri

string

可用于渲染照片的短期有效 URI。

地点

表示某个地点的所有信息。

字段
name

string

相应地点的资源名称,格式为 places/{place_id}。可用于查找地点。

id

string

地点的唯一标识符。

display_name

LocalizedText

地点的本地化名称,适合用作简短且直观易懂的说明。例如,“Google Sydney”“Starbucks”“Pyrmont”等。

types[]

string

相应结果的一组类型标记。例如,“政治”和“地点”。如需查看可能值的完整列表,请参阅 https://developers.google.com/maps/documentation/places/web-service/place-types 中的表 A 和表 B

primary_type

string

指定结果的主要类型。此类型必须是 Places API 支持的类型之一。例如,“餐厅”“咖啡馆”“机场”等。一个地点只能有一个主要类型。如需查看可能值的完整列表,请参阅 https://developers.google.com/maps/documentation/places/web-service/place-types 中的表 A 和表 B。如果地点的主要类型是不受支持的类型,则可能缺少主要类型。如果存在主要类型,则该类型始终是 types 字段中的一种类型。

primary_type_display_name

LocalizedText

主要类型的显示名称,如果适用,则本地化为请求语言。如需查看可能值的完整列表,请参阅 https://developers.google.com/maps/documentation/places/web-service/place-types 中的表 A 和表 B。如果地点的主要类型是不受支持的类型,则可能缺少主要类型。

national_phone_number

string

以国家格式表示的地点电话号码(用户可读)。

international_phone_number

string

地点的电话号码(采用国际电话号码格式),方便用户阅读。

formatted_address

string

相应地点的完整且直观易懂的地址。

short_formatted_address

string

相应地点的简短且直观易懂的地址。

postal_address

PostalAddress

邮政地址格式的地址。

address_components[]

AddressComponent

每个地理位置级别的重复组件。请注意,address_components[] 数组有以下特点:- 地址组成部分的数组包含的组成部分可能多于 formatted_address。- 除了 formatted_address 中包含的政治实体之外,数组不一定会纳入包含地址的所有政治实体。若要检索包含特定地址的所有政治实体,您应使用反向地理编码,并将地址的纬度/经度作为参数传递给请求。- 两次请求之间的响应格式不一定相同。特别是,address_components 的数量因所请求的地址而异,对于同一个地址,数量也可能会随着时间推移而发生变化。组成部分在数组中的位置可能发生变化。组成部分的类型也可能发生变化。后续响应中可能缺少特定组成部分。

plus_code

PlusCode

相应地点位置的纬度/经度 Plus Code。

location

LatLng

相应营业地点的地理位置。

viewport

Viewport

适合在平均大小的地图上显示相应地点的视口。此视口不应作为商家的实际边界或服务区域。

rating

double

根据用户对此地点的评价得出的评分,介于 1.0 到 5.0 之间。

google_maps_uri

string

提供有关此地点的更多信息的网址。

website_uri

string

此地点的权威网站,例如商家主页。请注意,对于连锁店(例如宜家商场),此网址通常是单个商店的网站,而不是整个连锁店的网站。

reviews[]

Review

有关此地点的评价列表,按相关性排序。最多可返回 5 条评价。

regular_opening_hours

OpeningHours

正常营业时间。请注意,如果某个地点全天营业(24 小时),则不会设置 close 字段。客户端可以通过以下方式表示全天营业(24 小时):将 open 中的 dayhourminute 设置为值 000

time_zone

TimeZone

IANA 时区数据库时区。例如“America/New_York”。

photos[]

Photo

有关此地点的照片的信息(包括参考资料)。最多可返回 10 张照片。

adr_format_address

string

采用 adr 微格式的地点地址:http://microformats.org/wiki/adr

business_status

BusinessStatus

相应地点的营业状态。

price_level

PriceLevel

相应地点的价格水平。

attributions[]

Attribution

必须与此结果一起显示的一组数据提供程序。

icon_mask_base_uri

string

指向图标遮罩的截断网址。用户可以在末尾附加类型后缀(例如“.svg”或“.png”)来访问不同的图标类型。

icon_background_color

string

icon_mask 的背景颜色(采用十六进制格式),例如 #909CE1。

current_opening_hours

OpeningHours

接下来 7 天(包括今天)的营业时间。时间段从请求当天的午夜开始,到六天后的晚上 11:59 结束。此字段包含所有营业时间的 special_days 子字段,针对营业时间特殊的日期设置。

current_secondary_opening_hours[]

OpeningHours

包含未来 7 天的条目数组,其中包括商家次要营业时间的相关信息。次要营业时间与商家的主要营业时间不同。例如,餐厅可以将外卖自取时间或送餐时间指定为次要营业时间。此字段会根据地点的类型填充类型子字段,该子字段会从预定义的营业时间类型列表(例如 DRIVE_THROUGH、PICKUP 或 TAKEOUT)中提取数据。此字段包含所有营业时间的 special_days 子字段,针对营业时间特殊的日期设置。

regular_secondary_opening_hours[]

OpeningHours

包含一个条目数组,用于提供有关商家常规次要营业时间的信息。次要营业时间与商家的主要营业时间不同。例如,餐厅可以将外卖自取时间或送餐时间指定为次要营业时间。此字段会根据地点的类型,从预定义的营业时间类型列表(例如 DRIVE_THROUGH、PICKUP 或 TAKEOUT)中填充类型子字段。

editorial_summary

LocalizedText

包含地点的摘要。摘要包含文本概览,还包括这些文本概览的语言代码(如果适用)。摘要文本必须按原样呈现,不得修改或更改。

payment_options

PaymentOptions

相应场所接受的付款方式。如果付款选项数据不可用,则付款选项字段将处于未设置状态。

parking_options

ParkingOptions

地点提供的停车选项。

sub_destinations[]

SubDestination

与地点相关的子目的地列表。

fuel_options

FuelOptions

加油站中有关燃油选项的最新信息。这些信息会定期更新。

ev_charge_options

EVChargeOptions

电动汽车充电选项的相关信息。

generative_summary

GenerativeSummary

AI 生成的地点摘要。

containing_places[]

ContainingPlace

当前位置所在的地点列表。

address_descriptor

AddressDescriptor

相应地点的地址描述符。地址描述符包含有助于使用地标和区域描述位置的其他信息。如需查看地址描述符的区域覆盖范围,请访问 https://developers.google.com/maps/documentation/geocoding/address-descriptors/coverage

price_range

PriceRange

与某个地点相关联的价格范围。

review_summary

ReviewSummary

使用用户评价生成的地点 AI 摘要。

ev_charge_amenity_summary

EvChargeAmenitySummary

电动车辆充电站附近设施的摘要。

neighborhood_summary

NeighborhoodSummary

地点附近地图注点的摘要。

utc_offset_minutes

int32

相应地点的时区目前与世界协调时间 (UTC) 的偏移量(以分钟为单位)。以分钟表示,以支持偏差为小时分数(例如 X 小时 15 分钟)的时区。

user_rating_count

int32

相应地点的评价(无论是否包含文字)总数。

takeout

bool

指定商家是否支持外卖。

delivery

bool

指定商家是否支持配送。

dine_in

bool

指定商家是否支持室内或室外座位选项。

curbside_pickup

bool

指定商家是否支持路边自提。

reservable

bool

指定相应地点是否支持预订。

serves_breakfast

bool

指定相应场所是否供应早餐。

serves_lunch

bool

指定相应场所是否提供午餐。

serves_dinner

bool

指定相应场所是否提供晚餐。

serves_beer

bool

指定相应场所是否供应啤酒。

serves_wine

bool

指定相应场所是否供应葡萄酒。

serves_brunch

bool

指定营业地点是否供应早午餐。

serves_vegetarian_food

bool

指定相应地点是否供应素食。

outdoor_seating

bool

该场所提供户外座位。

live_music

bool

场所提供现场音乐表演。

menu_for_children

bool

有儿童菜单。

serves_cocktails

bool

该场所供应鸡尾酒。

serves_dessert

bool

该场所供应甜点。

serves_coffee

bool

场所供应咖啡。

good_for_children

bool

此场所适合儿童。

allows_dogs

bool

该场所允许带狗。

restroom

bool

地点有卫生间。

good_for_groups

bool

地点可容纳的群组数量。

good_for_watching_sports

bool

此场所适合观看体育赛事。

accessibility_options

AccessibilityOptions

地点提供的无障碍功能选项的相关信息。

pure_service_area_business

bool

指明相应地点是否为纯上门服务商家。纯上门服务商家是指为客户送货上门或提供上门服务,但不在自己的商家地址为客户提供服务的商家。例如,清洁服务类商家或管道工。这些商家可能没有实际地址或 Google 地图上的营业地点。

AccessibilityOptions

地点提供的无障碍功能选项的相关信息。

字段
wheelchair_accessible_parking

bool

该场所提供无障碍停车位。

wheelchair_accessible_entrance

bool

场所设有无障碍入口。

wheelchair_accessible_restroom

bool

场所设有无障碍卫生间。

wheelchair_accessible_seating

bool

该场所设有无障碍座席。

AddressComponent

构成格式化地址的结构化组件(如果此信息可用)。

字段
long_text

string

地址组成部分的完整文本说明或名称。例如,澳大利亚的地址组成部分可能包含“Australia”这一 long_name。

short_text

string

地址组成部分的缩写文本名称(如果有)。例如,澳大利亚的地址组成部分可能具有“AU”的 short_name。

types[]

string

一个数组,用于指示地址组成部分的类型。

language_code

string

用于设置相应组件格式的语言(采用 CLDR 表示法)。

归因

有关此地点的数据提供商的信息。

字段
provider

string

相应地点的提供商的名称。

provider_uri

string

地点的数据提供方的 URI。

BusinessStatus

相应地点的商家状态。

枚举
BUSINESS_STATUS_UNSPECIFIED 默认值。此值未使用。
OPERATIONAL 商家正在营业,但不一定现在营业。
CLOSED_TEMPORARILY 该场所已暂停营业。
CLOSED_PERMANENTLY 该场所已永久停业。

ContainingPlace

有关此地点所在位置的信息。

字段
name

string

相应地点所在的地点对应的资源名称。

id

string

相应地点所在的地点 ID。

EvChargeAmenitySummary

电动车辆充电站附近设施的摘要。这仅适用于类型为 electric_vehicle_charging_station 的地点。系统保证会提供 overview 字段,而其他字段为可选字段。

字段
overview

ContentBlock

可用设施概览。保证会提供此信息。

coffee

ContentBlock

附近咖啡馆的选项摘要。

restaurant

ContentBlock

附近餐厅的摘要。

store

ContentBlock

附近商店的摘要。

flag_content_uri

string

一个链接,用户可以通过该链接标记摘要存在的问题。

disclosure_text

LocalizedText

AI 披露声明消息“由 Gemini 总结”(及其本地化变体)。如果支持,则以请求中指定的语言显示。

GenerativeSummary

AI 生成的地点摘要。

字段
overview

LocalizedText

地点的概览。

overview_flag_content_uri

string

用户可用于标记概览摘要存在问题的链接。

disclosure_text

LocalizedText

AI 披露声明消息“由 Gemini 总结”(及其本地化变体)。如果支持,则以请求中指定的语言显示。

NeighborhoodSummary

地点附近地图注点的摘要。

字段
overview

ContentBlock

社区的概览摘要。

description

ContentBlock

社区的详细说明。

flag_content_uri

string

一个链接,用户可以通过该链接标记摘要存在的问题。

disclosure_text

LocalizedText

AI 披露声明消息“由 Gemini 总结”(及其本地化变体)。如果支持,则以请求中指定的语言显示。

OpeningHours

有关地点营业时间的信息。

字段
periods[]

Period

相应地点在一周内的营业时间段。这些时间段按时间顺序排列,采用的是地点本地时区。空值(但不是缺失值)表示某个地点从未营业,例如因装修而暂时关闭。

periods 的起始日期是不固定的,不应假定为星期日。API 会根据多种因素确定开始日期。例如,对于全天候营业的商家,第一个周期可能从提出请求的当天开始。对于其他商家,可能是他们一周内首次营业的日期。

注意:periods 数组的顺序与 weekday_descriptions 数组的顺序无关。请勿假设它们会在同一天开始。

weekday_descriptions[]

string

描述相应地点的营业时间的本地化字符串,一周中的每一天对应一个字符串。

注意:日期顺序和周的开始日期由语言区域设置(语言和地区)决定。periods 数组的顺序与 weekday_descriptions 数组的顺序无关。请勿假设它们会在同一天开始。

如果营业时间未知或无法转换为本地化文本,则为空。示例:“周日:18:00-06:00”

secondary_hours_type

SecondaryHoursType

用于标识次要营业时间的类型字符串。

special_days[]

SpecialDay

返回的营业时间涵盖的特殊日期对应的结构化信息。特殊日期是指可能会影响场所营业时间的日期,例如圣诞节。如果存在特殊营业时间,则为 current_opening_hours 和 current_secondary_opening_hours 设置。

next_open_time

Timestamp

当前营业时间段在未来最多 7 天内的下一次开始时间。仅当在处理请求时营业时间段处于非有效状态时,系统才会填充此字段。

next_close_time

Timestamp

当前营业时间段的结束时间在未来 7 天内。仅当营业时间段在提供请求时处于有效状态时,系统才会填充此字段。

open_now

bool

营业时间段目前是否处于有效状态。对于正常营业时间和当前营业时间,此字段表示相应地点是否在营业。对于次要营业时间和当前次要营业时间,此字段表示相应地点的次要营业时间是否处于有效状态。

时段

地点保持 open_now 状态的时段。

字段
open

Point

地点的开始营业时间。

close

Point

场所开始关闭的时间。

状态更改点。

字段
date

Date

相应地点的本地时区中的日期。

truncated

bool

相应端点是否被截断。当实际小时数超出我们愿意返回的小时数范围时,就会发生截断,因此我们会将小时数截断回这些边界。这可确保返回的时间不超过自请求当天午夜起的 24 * 7 小时。

day

int32

周几,以 0-6 范围内的整数表示。0 表示星期日,1 表示星期一,依此类推。

hour

int32

以 24 小时制表示的小时。范围是 0 到 23。

minute

int32

分钟。范围为 0 到 59。

SecondaryHoursType

用于标识次要工时的类型。

枚举
SECONDARY_HOURS_TYPE_UNSPECIFIED 未指定次要小时类型时的默认值。
DRIVE_THROUGH 银行、餐厅或药店的驾车通道开放时间。
HAPPY_HOUR 欢乐时光。
DELIVERY 送达时间。
TAKEOUT 外卖时段。
KITCHEN 厨房营业时间。
BREAKFAST 早餐时间。
LUNCH 午餐时间。
DINNER 晚餐时间。
BRUNCH 早午餐时间。
PICKUP 取货时段。
ACCESS 存储地点的开放时间。
SENIOR_HOURS 老年人专属时段。
ONLINE_SERVICE_HOURS 在线服务时段。

SpecialDay

返回的营业时间涵盖的特殊日期对应的结构化信息。特殊日期是指可能会影响场所营业时间的日期,例如圣诞节。

字段
date

Date

此特殊日期的日期。

ParkingOptions

有关地点的停车选项的信息。一个停车场可以同时支持多个选项。

字段
free_parking_lot

bool

该场所提供免费停车场。

paid_parking_lot

bool

该场所提供付费停车场。

free_street_parking

bool

此房源提供免费路边停车位。

paid_street_parking

bool

此场所提供收费路边停车位。

valet_parking

bool

该场所提供代客泊车服务。

free_garage_parking

bool

酒店提供免费停车库。

paid_garage_parking

bool

此场所提供收费停车库。

PaymentOptions

相应场所接受的付款方式。

字段
accepts_credit_cards

bool

商家接受信用卡付款。

accepts_debit_cards

bool

商家接受借记卡付款。

accepts_cash_only

bool

商家仅接受现金付款。具有此属性的场所可能仍接受其他付款方式。

accepts_nfc

bool

场所接受 NFC 支付。

PlusCode

Plus Code (http://plus.codes) 是一种位置引用,包含两种格式:用于定义 14 米 x 14 米(1/8000 度)或更小矩形的全局代码,以及用参考位置替换前缀的混合代码。

字段
global_code

string

地点的全局(完整)代码,例如“9FWM33GV+HQ”,表示 1/8000 度 x 1/8000 度(约 14 米 x 14 米)的区域。

compound_code

string

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

ReviewSummary

使用用户评价生成的地点 AI 摘要。

字段
text

LocalizedText

用户评价摘要。

flag_content_uri

string

一个链接,用户可以通过该链接标记摘要存在的问题。

disclosure_text

LocalizedText

AI 披露声明消息“由 Gemini 总结”(及其本地化变体)。如果支持,则以请求中指定的语言显示。

reviews_uri

string

用于在 Google 地图上显示相应地点的评价的链接。

SubDestination

子目的地是指与主要地点相关联的特定地点。这些标记可为在机场、国家公园、大学或体育场等大型或复杂场所内搜索的用户提供更具体的目的地。例如,机场的子目的地可能包括相关联的航站楼和停车场。子目的地会返回地点 ID 和地点资源名称,这些信息可用于后续的地点详情(新)请求,以获取更丰富的详细信息,包括子目的地的显示名称和位置。

字段
name

string

子目的地的资源名称。

id

string

子目的地的地点 ID。

折线

路线折线。仅支持编码多段线,该多段线可以作为字符串传递,并且包含最小程度的有损压缩。这是 Routes API 的默认输出。

字段
联合字段 polyline_type。封装折线的类型。Routes API 输出默认值为 encoded_polylinepolyline_type 只能是下列其中一项:
encoded_polyline

string

编码多段线,由 Routes API 默认返回。请参阅编码器解码器工具。

PriceLevel

相应地点的价格水平。

枚举
PRICE_LEVEL_UNSPECIFIED 地点价格水平未指定或未知。
PRICE_LEVEL_FREE 场所提供免费服务。
PRICE_LEVEL_INEXPENSIVE 商家提供价格实惠的服务。
PRICE_LEVEL_MODERATE 该场所提供价格适中的服务。
PRICE_LEVEL_EXPENSIVE 场所提供昂贵的服务。
PRICE_LEVEL_VERY_EXPENSIVE 场所提供的服务非常昂贵。

PriceRange

与某个地点相关联的价格范围。end_price 可以不设置,表示没有上限的范围(例如“超过 100 美元”)。

字段
start_price

Money

价格范围的下限(含)。价格应不低于此金额。

end_price

Money

价格范围的上限(不含)。价格应低于此金额。

查看

有关地点评价的信息。

字段
name

string

表示相应地点评价的引用,可用于再次查找相应地点评价(也称为 API“资源”名称:places/{place_id}/reviews/{review})。

relative_publish_time_description

string

格式化的近期时间字符串,以适合相应语言和国家/地区的形式表示相对于当前时间的评价时间。

text

LocalizedText

评价的本地化文本。

original_text

LocalizedText

评价文本的原始语言版本。

rating

double

介于 1.0 和 5.0 之间的数字,也称为星数。

author_attribution

AuthorAttribution

相应评价的作者。

publish_time

Timestamp

评价的时间戳。

flag_content_uri

string

用户可用于标记评价问题的链接。

google_maps_uri

string

用于在 Google 地图上显示相应评价的链接。

RouteModifiers

封装了一组在计算路线时要满足的可选条件。

字段
avoid_tolls

bool

可选。如果设置为 true,则尽可能避开收费公路,优先选择不包含收费公路的路线。仅适用于 DRIVETWO_WHEELER TravelMode

avoid_highways

bool

可选。如果设置为 true,则尽可能避开高速公路,优先选择不包含高速公路的路线。仅适用于 DRIVETWO_WHEELER TravelMode

avoid_ferries

bool

可选。如果设置为 true,则在合理的情况下避开轮渡,优先选择不包含轮渡的路线。仅适用于 DRIVETWO_WHEELER TravelMode

avoid_indoor

bool

可选。如果设置为 true,则尽可能避免室内导航,优先选择不包含室内导航的路线。仅适用于 WALK TravelMode

RoutingParameters

用于配置前往响应中地点的路线计算的参数,包括沿途地点(会影响结果排名)和用于计算结果中的出行时间的参数。

字段
origin

LatLng

可选。一种显式路线规划起点,用于替换多段线中定义的起点。默认情况下,系统会使用折线的起点。

travel_mode

TravelMode

可选。出行方式。

route_modifiers

RouteModifiers

可选。路线修饰符。

routing_preference

RoutingPreference

可选。指定如何计算路由摘要。服务器会尝试使用所选的路由偏好设置来计算路由。可感知路况的路线偏好设置仅适用于 DRIVETWO_WHEELER travelMode

RoutingPreference

一组值,用于指定计算路线时要考虑的因素。

枚举
ROUTING_PREFERENCE_UNSPECIFIED 未指定任何路线偏好设置。默认为 TRAFFIC_UNAWARE
TRAFFIC_UNAWARE 计算路线时不考虑实时路况。适用于交通状况无关紧要或不适用的情况。使用此值可实现最低延迟时间。注意:对于 TravelModeDRIVETWO_WHEELER,系统会根据道路网和与时间无关的平均路况信息而非当前路况信息来选择路线和时长。因此,路线可能包括暂时关闭的道路。受道路网变化、平均路况信息更新以及服务的分布式性质的影响,给定请求的结果可能会随时间的推移而发生变化。此外,在时间或频率不受限制的情况下,即使两条路线几乎相同,结果还是有可能不同。
TRAFFIC_AWARE 计算路线时会考虑实时路况。与 TRAFFIC_AWARE_OPTIMAL 相比,某些优化旨在大幅缩短延迟时间。
TRAFFIC_AWARE_OPTIMAL 计算路线时会考虑实时路况,但不会应用大多数性能优化。使用此值会产生最高的延迟时间。

RoutingSummary

从路线起点到响应中某个地点的时长和距离,以及从该地点到目的地的第二段路线(如果已请求)。注意:在字段掩码中添加 routingSummaries,但未在请求中同时包含 routingParameters.origin 参数或 searchAlongRouteParameters.polyline.encodedPolyline 参数,会导致错误。

字段
legs[]

Leg

行程的各个部分。

当您计算从一组出发地出发的行程时长和距离时,legs 包含一个路段,其中包含从出发地到目的地的时长和距离。当您搜索沿途地点时,legs 包含两个路段:一个是从出发地到该地点的路段,另一个是从该地点到目的地的路段。

directions_uri

string

一个链接,用于在 Google 地图上显示使用指定路线摘要中的途经点的路线。通过此链接生成的路线不一定与用于生成路线摘要的路线相同。该链接使用请求中提供的信息(包括 routingParameterssearchAlongRouteParameters 字段中的信息,如果适用)来生成路线链接。

行程段是指从一个地点到另一个地点的单段旅程。

字段
duration

Duration

完成此段行程所需的时间。

distance_meters

int32

相应行程段的距离。

SearchNearbyRequest

“附近搜索”的请求 proto。

字段
language_code

string

如果地点详情有首选语言版本,系统会以该语言显示。如果未指定或无法识别语言代码,则可能会返回任何语言的地点详细信息,但如果存在英语详细信息,则优先返回英语详细信息。

当前支持的语言列表:https://developers.google.com/maps/faq#languagesupport

region_code

string

请求来源地的 Unicode 国家/地区代码 (CLDR)。此参数用于显示地点详情,例如特定于区域的地点名称(如果有)。此参数可能会根据适用法律影响结果。

如需了解详情,请参阅 https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html

请注意,目前不支持 3 位数的地区代码。

included_types[]

string

https://developers.google.com/maps/documentation/places/web-service/place-types 中包含的地点类型(例如“restaurant”或“gas_station”)。

最多可以指定 表 A 中的 50 种类型。

如果存在任何冲突的类型(即某个类型同时出现在 included_types 和 excluded_types 中),系统会返回 INVALID_ARGUMENT 错误。

如果指定了地点类型并设置了多个类型限制,则系统只会返回满足所有限制的地点。例如,如果我们有 {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]},则返回的地点提供与“餐厅”相关的服务,但主要不是作为“餐厅”运营的。

excluded_types[]

string

排除的地点类型(例如“restaurant”或“gas_station”),请参阅 https://developers.google.com/maps/documentation/places/web-service/place-types

最多可以指定 表 A 中的 50 种类型。

如果客户端同时提供 included_types(例如餐厅)和 excluded_types(例如咖啡馆),则响应应包含餐厅但不能包含咖啡馆。响应中包含至少与一个 included_types 匹配且与任何 excluded_types 都不匹配的地点。

如果存在任何冲突的类型(即某个类型同时出现在 included_types 和 excluded_types 中),系统会返回 INVALID_ARGUMENT 错误。

如果指定了地点类型并设置了多个类型限制,则系统只会返回满足所有限制的地点。例如,如果我们有 {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]},则返回的地点提供与“餐厅”相关的服务,但主要不是作为“餐厅”运营的。

included_primary_types[]

string

来自 https://developers.google.com/maps/documentation/places/web-service/place-types 的主要地点类型(例如“restaurant”或“gas_station”)。一个地点只能有一个与支持的类型表相关联的主要类型。

最多可以指定 表 A 中的 50 种类型。

如果存在任何冲突的主要类型(即某种类型同时出现在 included_primary_types 和 excluded_primary_types 中),则返回 INVALID_ARGUMENT 错误。

如果指定了地点类型并设置了多个类型限制,则系统只会返回满足所有限制的地点。例如,如果我们有 {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]},则返回的地点提供与“餐厅”相关的服务,但主要不是作为“餐厅”运营的。

excluded_primary_types[]

string

https://developers.google.com/maps/documentation/places/web-service/place-types 中排除的主要地点类型(例如“餐厅”或“加油站”)。

最多可以指定 表 A 中的 50 种类型。

如果存在任何冲突的主要类型(即某种类型同时出现在 included_primary_types 和 excluded_primary_types 中),则返回 INVALID_ARGUMENT 错误。

如果指定了地点类型并设置了多个类型限制,则系统只会返回满足所有限制的地点。例如,如果我们有 {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]},则返回的地点提供与“餐厅”相关的服务,但主要不是作为“餐厅”运营的。

max_result_count

int32

返回的结果数上限。必须介于 1 到 20(默认值)之间(含边界值)。如果未设置该数量,则会回退到上限。如果该数字设置为负数或超过上限,系统会返回 INVALID_ARGUMENT 错误。

location_restriction

LocationRestriction

必需。要搜索的地区。

rank_preference

RankPreference

结果在回答中的排名方式。

routing_parameters

RoutingParameters

可选。影响搜索结果路由的参数。

LocationRestriction

要搜索的地区。

字段

联合字段 type

type 只能是下列其中一项:

circle

Circle

由中心点和半径定义的圆。

RankPreference

结果在回答中的排名方式。

枚举
RANK_PREFERENCE_UNSPECIFIED 未设置 RankPreference 值。默认情况下将使用按受欢迎程度排序。
DISTANCE 按距离对结果进行排名。
POPULARITY 按热门程度对结果进行排名。

SearchNearbyResponse

“附近搜索”的响应 proto。

字段
places[]

Place

满足用户要求的地点列表,例如地点类型、地点数量和特定位置限制。

routing_summaries[]

RoutingSummary

一个路线摘要列表,其中每个条目都与 places 字段中相同索引处的相应地点相关联。如果某个地点的路线摘要不可用,则该地点对应的条目将为空。如果请求了地点列表,此列表应包含与地点列表相同数量的条目。

SearchTextRequest

针对 SearchText 的请求 proto。

字段
text_query

string

必需。用于文本搜索的文本查询。

language_code

string

如果地点详情有首选语言版本,系统会以该语言显示。如果未指定或无法识别语言代码,则可能会返回任何语言的地点详细信息,但如果存在英语详细信息,则优先返回英语详细信息。

当前支持的语言列表:https://developers.google.com/maps/faq#languagesupport

region_code

string

请求来源地的 Unicode 国家/地区代码 (CLDR)。此参数用于显示地点详情,例如特定于区域的地点名称(如果有)。此参数可能会根据适用法律影响结果。

如需了解详情,请参阅 https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html

请注意,目前不支持 3 位数的地区代码。

rank_preference

RankPreference

结果在回答中的排名方式。

included_type

string

所请求的地点类型。如需查看支持的类型的完整列表,请访问:https://developers.google.com/maps/documentation/places/web-service/place-types。仅支持一种包含的类型。

open_now

bool

用于将搜索范围限制在当前营业的地点。默认值为 false。

min_rating

double

过滤掉平均用户评分严格低于此限制的结果。有效值必须是介于 0 到 5 之间的浮点数(含边界值),且以 0.5 为步长,即 [0, 0.5, 1.0, ... , 5.0](含边界值)。输入的评分将向上舍入到最接近的 0.5(上限)。例如,如果评分为 0.6,则会排除所有评分低于 1.0 的结果。

max_result_count
(deprecated)

int32

已弃用:请改用 page_size

每页可返回的结果数上限。如果可用结果的数量大于 max_result_count,则会返回 next_page_token,该值可传递给 page_token,以便在后续请求中获取下一页结果。如果提供的值为 0 或未提供值,则使用默认值 20。最大值为 20;大于 20 的值将被强制转换为 20。如果值为负数,系统会返回 INVALID_ARGUMENT 错误。

如果同时指定了 max_result_countpage_size,则将忽略 max_result_count

page_size

int32

可选。每页可返回的结果数上限。如果可用结果的数量大于 page_size,则会返回 next_page_token,该值可传递给 page_token,以便在后续请求中获取下一页结果。如果提供的值为 0 或未提供值,则使用默认值 20。最大值为 20;大于 20 的值将设置为 20。如果值为负数,系统会返回 INVALID_ARGUMENT 错误。

如果同时指定了 max_result_countpage_size,则将忽略 max_result_count

page_token

string

可选。从之前的 TextSearch 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 TextSearch 的所有参数(page_tokenpage_sizemax_result_count 除外)必须与提供页面令牌的初始调用相一致。否则,系统会返回 INVALID_ARGUMENT 错误。

price_levels[]

PriceLevel

用于将搜索范围限制为标记为特定价位的地点。用户可以选择任意价格等级组合。默认选择所有价位。

strict_type_filtering

bool

用于为 included_type 设置严格的类型过滤条件。如果设置为 true,则仅返回相同类型的结果。默认为 false。

location_bias

LocationBias

要搜索的地区。此位置用作偏差,这意味着可能会返回给定位置附近的结果。不能与 location_restriction 一起设置。

location_restriction

LocationRestriction

要搜索的地区。此位置用作限制条件,这意味着系统不会返回指定位置以外的结果。无法与 location_bias 一起设置。

ev_options

EVOptions

可选。设置地点搜索请求的可搜索电动汽车选项。

routing_parameters

RoutingParameters

可选。用于将用户路由到结果的其他参数。

search_along_route_parameters

SearchAlongRouteParameters

可选。用于沿路线搜索的其他参数 proto。

include_pure_service_area_businesses

bool

可选。如果该字段设置为 true,则包含纯上门服务商家。纯上门服务商家是指为客户送货上门或提供上门服务,但不在自己的商家地址为客户提供服务的商家。例如,清洁服务类商家或管道工。这些商家在 Google 地图上没有实际地址或位置信息。对于这些商家,“地点”将不会返回包含 locationplus_code 和其他与位置相关的字段。

EVOptions

地点搜索请求的可搜索电动汽车选项。

字段
minimum_charging_rate_kw

double

可选。所需的最低充电功率(以千瓦为单位)。充电速率低于指定速率的地点会被过滤掉。

connector_types[]

EVConnectorType

可选。首选电动汽车连接器类型的列表。不支持任何所列连接器类型的地点会被过滤掉。

LocationBias

要搜索的地区。此位置用作偏差,这意味着可能会返回给定位置附近的结果。

字段

联合字段 type

type 只能是下列其中一项:

rectangle

Viewport

由东北角和西南角定义的矩形框。rectangle.high() 必须是矩形视口的东北点。rectangle.low() 必须是矩形视口的西南点。rectangle.low().latitude() 不得大于 rectangle.high().latitude()。这会导致纬度范围为空。矩形视口的宽度不能超过 180 度。

circle

Circle

由中心点和半径定义的圆。

LocationRestriction

要搜索的地区。此位置用作限制条件,这意味着系统不会返回指定位置以外的结果。

字段

联合字段 type

type 只能是下列其中一项:

rectangle

Viewport

由东北角和西南角定义的矩形框。rectangle.high() 必须是矩形视口的东北点。rectangle.low() 必须是矩形视口的西南点。rectangle.low().latitude() 不得大于 rectangle.high().latitude()。这会导致纬度范围为空。矩形视口的宽度不能超过 180 度。

RankPreference

结果在回答中的排名方式。

枚举
RANK_PREFERENCE_UNSPECIFIED 对于“纽约市的餐厅”等类别查询,默认值为 RELEVANCE。对于“Mountain View, CA”等非类别查询,我们建议您将 rankPreference 保持未设置状态。
DISTANCE 按距离对结果进行排名。
RELEVANCE 按相关性对结果进行排名。由常规排名堆栈确定的排序顺序。

SearchAlongRouteParameters

指定来自 Routes API 的预先计算的折线,用于定义要搜索的路线。沿路线搜索类似于使用 locationBiaslocationRestriction 请求选项来调整搜索结果。不过,虽然 locationBiaslocationRestriction 选项可让您指定一个区域来调整搜索结果,但此选项可让您沿旅程路线调整结果。

结果不一定位于提供的路线沿途,而是根据从出发地到目的地的最短绕行时间,在由折线和(可选)locationBiaslocationRestriction 定义的搜索区域内进行排名。结果可能位于替代路线上,尤其是在所提供的折线未定义从出发地到目的地的最佳路线时。

字段
polyline

Polyline

必需。路线多段线。

SearchTextResponse

SearchText 的响应 proto。

字段
places[]

Place

满足用户文本搜索条件的地点列表。

routing_summaries[]

RoutingSummary

一个路线摘要列表,其中每个条目都与 places 字段中相同索引处的相应地点相关联。如果某个地点的路线摘要不可用,则该地点对应的条目将为空。如果请求了地点列表,此列表将包含与地点列表相同的条目数。

contextual_contents[]

ContextualContent

实验性功能:如需了解详情,请访问 https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative

一个上下文内容列表,其中每个条目都与 places 字段中相同索引处的相应位置相关联。优先选择与请求中的 text_query 相关的内容。如果某个地点的上下文相关内容不可用,则会返回非上下文相关内容。仅当相应地点没有内容时,此字段才会为空。如果请求了地点列表,此列表将包含与地点列表相同的条目数。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果此字段省略或为空,则不存在后续页面。

search_uri

string

通过该链接,用户可以在 Google 地图中搜索请求中指定的相同文本查询内容。

TravelMode

出行方式选项。这些选项会映射到 Routes API 提供的功能

枚举
TRAVEL_MODE_UNSPECIFIED 未指定出行方式。默认为 DRIVE
DRIVE 乘坐客车出行。
BICYCLE 骑自行车出行。不支持 search_along_route_parameters
WALK 步行出行。不支持 search_along_route_parameters
TWO_WHEELER 各种机动双轮车辆,例如滑板车和摩托车。请注意,这与涵盖人力驱动交通工具的 BICYCLE 出行方式不同。不支持 search_along_route_parameters。仅在支持双轮机动车的国家/地区中列出的国家/地区受支持。