Package google.maps.places.v1

索引

地点

Places API 的服务定义。注意:除了自动补全请求之外,每个请求都需要在请求 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) 中的主地点类型(例如“restaurant”或“gas_station”),或者仅包含 (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

可单独投放的内容块。

字段
topic

string

内容的主题,例如“概览”或“餐厅”。

content

LocalizedText

与主题相关的内容。

references

References

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

与此内容块相关的参考文献。

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] 分组的电动汽车充电信息。显示具有相同类型和最大充电速率(以千瓦为单位)的充电桩的 EV 充电汇总数据。

字段
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 类型 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

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

max_width_px

int32

可选。指定图片所需的最大宽度(以像素为单位)。如果图片小于指定的值,系统会返回原始图片。如果图片的任一尺寸较大,系统会将其缩放为两者尺寸中的较小者,同时保持原始宽高比。max_height_px 和 max_width_px 属性均接受介于 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(包括这两个数值)之间的整数。如果该值不在允许的范围内,系统会返回 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 悉尼”“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

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

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

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][google.maps.places.v1.Place.OpeningHours.Period.open] 中的 [day][Point.day] 设置为 0,将 [hour][Point.hour] 设置为 0,并将 [minute][Point.minute] 设置为 0

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

接下来七天(包括今天)的营业时间。该时间段从请求日期的零点开始,到六天后的晚上 11:59 结束。此字段包含所有小时的 special_days 子字段,用于为具有特殊营业时间的日期设置。

current_secondary_opening_hours[]

OpeningHours

包含接下来七天的一系列条目,包括商家次要营业时间的相关信息。辅助营业时间不同于商家的主营业时间。例如,餐厅可以将自助取餐时间或外卖时间指定为次要营业时间。此字段用于填充“type”子字段,该字段会根据地点的类型从预定义的营业时间类型列表(例如 DRIVE_THROUGH、PICKUP 或 TAKEOUT)中提取数据。此字段包含所有小时的 special_days 子字段,用于为具有特殊营业时间的日期设置。

regular_secondary_opening_hours[]

OpeningHours

包含一系列条目,用于提供有关商家常规次要营业时间的信息。辅助营业时间不同于商家的主营业时间。例如,餐厅可以将自助取餐时间或外卖时间指定为次要营业时间。此字段用于填充“type”子字段,该字段会根据地点的类型从预定义的营业时间类型列表(例如 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

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

AI 生成的地点摘要。

area_summary

AreaSummary

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

AI 生成的地点所在区域的摘要。

containing_places[]

ContainingPlace

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

address_descriptor

AddressDescriptor

地点的地址描述符。地址描述符包含其他信息,可帮助使用地标和区域描述地点。如需了解地址描述符的区域覆盖范围,请参阅 https://developers.google.com/maps/documentation/geocoding/address-descriptors/coverage

price_range

PriceRange

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

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

地址组成部分的完整文本说明或名称。例如,澳大利亚这个国家/地区的地址组成部分的 long_name 可能为“Australia”。

short_text

string

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

types[]

string

一个数组,表示地址组成部分的类型。

language_code

string

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

AreaSummary

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

AI 生成的地点所在区域的摘要。

字段
content_blocks[]

ContentBlock

构成地区摘要的内容块。每个区块都有一个单独的关于该区域的主题。

flag_content_uri

string

一个链接,供用户举报摘要存在的问题。

归因

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

字段
provider

string

地点的数据提供商的名称。

provider_uri

string

地点数据提供方的 URI。

BusinessStatus

相应地点的营业状态。

枚举
BUSINESS_STATUS_UNSPECIFIED 默认值。此值未使用。
OPERATIONAL 相应商家正在营业,但不一定当前就处于营业状态。
CLOSED_TEMPORARILY 相应商家已暂停营业。
CLOSED_PERMANENTLY 相应商家已永久停业。

ContainingPlace

此地点所在地点的相关信息。

字段
name

string

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

id

string

相应地点所在地点的 ID。

GenerativeSummary

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

AI 生成的地点摘要。

字段
overview

LocalizedText

地点的概览。

overview_flag_content_uri

string

用户可以通过此链接标记概览摘要中的问题。

description

LocalizedText

地点的详细说明。

description_flag_content_uri

string

用户可以通过此链接举报说明摘要存在的问题。

references

References

用于生成摘要说明的参考文档。

OpeningHours

地点的营业时间信息。

字段
periods[]

Period

此地点在一周内正常营业的时间段。这些时段按时间顺序排列,从地点当地时区的星期日开始。空值(但不为缺失值)表示相应地点从未营业,例如因装修而暂时停业。

weekday_descriptions[]

string

用于描述此地点营业时间的本地化字符串,一周内每天对应一个字符串。如果小时数未知或无法转换为本地化文本,则为空。示例:“周日: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/8,000 度] 或更小的矩形)和复合代码(将前缀替换为参考位置)。

字段
global_code

string

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

compound_code

string

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

SubDestination

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

字段
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

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

参考

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

生成内容的相关参考。

字段
reviews[]

Review

作为参考的评价。

places[]

string

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

查看

与地点评价相关的信息。

字段
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

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

您最多可以指定 表格 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 中排除的主要地点类型(例如“restaurant”或“gas_station”)。

您最多可以指定 表格 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

适用于“附近搜索”的响应原型。

字段
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 对于类别查询(例如“纽约市餐厅”),默认是“相关性”。对于非分类查询(例如“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

情境内容列表,其中每个条目都与“地点”字段中同一索引中的相应地点相关联。首选与请求中的 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。仅在支持双轮机动车的国家和地区列出的国家/地区受支持。