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)

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

GetPhotoMedia

rpc GetPhotoMedia(GetPhotoMediaRequest) returns (PhotoMedia)

使用照片引用字符串获取照片媒体。

GetPlace

rpc GetPlace(GetPlaceRequest) returns (Place)

根据地点的资源名称获取其详情,资源名称是 places/{place_id} 格式的字符串。

SearchNearby

rpc SearchNearby(SearchNearbyRequest) returns (SearchNearbyResponse)

搜索位置附近的地点。

SearchText

rpc SearchText(SearchTextRequest) returns (SearchTextResponse)

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

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”)。仅当此地方的主要类型包含在此列表中时,才会返回该地方。最多可以指定 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

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

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

include_query_predictions

bool

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

session_token

string

可选。用于标识用于结算的自动补全会话的字符串。必须是网址和文件名安全 base64 字符串,长度最多为 36 个 ASCII 字符。否则,系统将返回 INVALID_ARGUMENT 错误。

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

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

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

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] 的范围内。

EVChargeOptions

在 Place 中托管的电动汽车充电站的相关信息。相关术语遵循以下格式: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 类型 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)。此值不能代表实际的连接器类型,更代表在特斯拉自有充电站为特斯拉品牌车辆充电的能力。
EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T GB/T 类型对应于中国的 GB/T 标准。此类型涵盖所有 GB_T 类型。
EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET 未指定的墙壁插座。

FuelOptions

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

字段
fuel_prices[]

FuelPrice

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

FuelPrice

给定类型的燃油价格信息。

字段
type

FuelType

燃料的类型。

price

Money

燃料的价格。

update_time

Timestamp

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

FuelType

燃料类型。

枚举
FUEL_TYPE_UNSPECIFIED 未指定燃料类型。
DIESEL 柴油。
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。
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_STRING 错误。

至少需要指定 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_STRING 错误。

至少需要指定 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

此照片的作者。

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

此结果的一组类型标记。例如,“political”和“locality”。如需查看可能值的完整列表,请参阅表 A 和表 B(网址为 https://developers.google.com/maps/documentation/places/web-service/place-types

primary_type

string

指定结果的主要类型。此类型必须是 Places API 支持的类型之一。例如,“餐馆”“咖啡馆”“机场”等。一个地点只能有一个主要类型。如需查看可能值的完整列表,请参阅表 A 和表 B(网址为 https://developers.google.com/maps/documentation/places/web-service/place-types

primary_type_display_name

LocalizedText

主要类型的显示名称,已本地化为请求语言(如果适用)。如需查看可能值的完整列表,请参阅表 A 和表 B(网址为 https://developers.google.com/maps/documentation/places/web-service/place-types

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 代码。

location

LatLng

此地点的位置。

viewport

Viewport

适于在平均大小的地图上显示地点的视口。

rating

double

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

google_maps_uri

string

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

website_uri

string

此地点的官方网站,例如商家的首页。请注意,对于连锁商家的地点(例如宜家商店),此处通常指单个商店(而非整个连锁店)的网站。

reviews[]

Review

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

regular_opening_hours

OpeningHours

正常营业时间。

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 天(包括今天)的营业时间。此时间段从请求日期的午夜开始,到 6 天后的晚上 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

电动汽车充电选项信息。

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

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

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

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

types[]

string

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

language_code

string

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

归因

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

字段
provider

string

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

provider_uri

string

地点数据提供程序的 URI。

BusinessStatus

地点的商家状态。

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

OpeningHours

地点的营业时间信息。

字段
periods[]

Period

此地点在一周中营业的时段。这些时间段按时间顺序排列,从当地时区的星期日开始。空(但不缺失)值表示地点从不营业,例如,由于该地点暂停营业进行翻修。

weekday_descriptions[]

string

描述此地点营业时间的本地化字符串,一个字符串对应一周中的每一天。如果营业时间未知或无法转换为本地化文本,则此字段为空。示例:“周日:18:00–06:00”

secondary_hours_type

SecondaryHoursType

用于标识辅助营业时间类型的类型字符串。

special_days[]

SpecialDay

返回营业时间所涵盖时段内的特殊日期的结构化信息。特殊日子是指可能影响某个地点的营业时间(例如圣诞节)的日子。如果有异常营业时间,请设为 current_opening_hours 和 current_secondary_opening_hours 的值。

open_now

bool

这个地方现在正在营业吗?始终显示,除非我们缺少这些营业时间的时段或时区数据。

时段

地点保持“open_now”状态的时间段。

字段
open

Point

地点开始营业的时间。

close

Point

地点开始停止营业的时间。

状态变化点。

字段
date

Date

地点的当地时区日期。

truncated

bool

此端点是否已被截断。当实际小时数超出了我们愿意返回小时数的时间范围时,就会被截断,因此我们会截断小时数,使其回到这些边界值。这可确保返回请求当天午夜后最多 24 * 7 小时。

day

int32

星期几,以 0-6 之间的整数表示。0 表示星期日,1 表示星期一,等等。

hour

int32

以 2 位数表示的小时数。范围是 00 到 23。

minute

int32

以 2 位数表示的分钟。范围是 00 到 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 代码 (http://plus.codes) 是两种格式的位置参考:定义一个 14mx14m(1/8000 度)或更小的矩形的全局代码,以及复合代码(用参考位置替换前缀)。

字段
global_code

string

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

compound_code

string

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

SubDestination

与该地点相关的地点资源名称和子目的地的 ID。例如,不同的航站楼是机场的不同目的地。

字段
name

string

子目的地的资源名称。

id

string

子目的地的地点 ID。

PriceLevel

地点的价格水平。

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

回顾

与地点评价相关的信息。

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

评价的时间戳。

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 个类型。

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

如果指定了多种类型限制的地点类型,系统仅返回满足所有限制的地点。例如,如果我们有 {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]},返回的地点提供与“restaurant”相关的服务,但主要经营方式并不是“餐厅”。

excluded_types[]

string

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

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

如果客户端同时提供了 include_types(例如餐厅)和 excluded_types(例如:ca 要使用),则在响应中包含的地点应为餐馆,而不是咖啡厅。响应包含的地点信息至少与包含的其中一个类型匹配,但与任何排除的类型均不匹配。

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

如果指定了多种类型限制的地点类型,系统仅返回满足所有限制的地点。例如,如果我们有 {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]},返回的地点提供与“restaurant”相关的服务,但主要经营方式并不是“餐厅”。

included_primary_types[]

string

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

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

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

如果指定了多种类型限制的地点类型,系统仅返回满足所有限制的地点。例如,如果我们有 {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]},返回的地点提供与“restaurant”相关的服务,但主要经营方式并不是“餐厅”。

excluded_primary_types[]

string

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

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

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

如果指定了多种类型限制的地点类型,系统仅返回满足所有限制的地点。例如,如果我们有 {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]},返回的地点提供与“restaurant”相关的服务,但主要经营方式并不是“餐厅”。

max_result_count

int32

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

location_restriction

LocationRestriction

必需。要搜索的地区。

rank_preference

RankPreference

结果在响应中如何排序。

LocationRestriction

要搜索的地区。

字段

联合字段 type

type 只能是下列其中一项:

circle

Circle

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

RankPreference

结果在响应中如何排序。

枚举
RANK_PREFERENCE_UNSPECIFIED 未设置 RankPreference 值。将默认使用按 POPULARITY 的排名。
DISTANCE 按距离对结果进行排名。
POPULARITY 按热门程度对结果排名。

SearchNearbyResponse

“搜索附近”功能的响应 proto。

字段
places[]

Place

符合用户要求的地点列表,例如地点类型、地点数量和具体位置限制。

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)。输入评分将四舍五入为最接近的 0.5(上限)。例如,如果评分为 0.6,则会排除评分低于 1.0 的所有结果。

max_result_count

int32

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

price_levels[]

PriceLevel

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

strict_type_filtering

bool

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

location_bias

LocationBias

要搜索的地区。此位置充当偏差,表示可能会返回指定位置附近的结果。不能与 location_restriction 一起设置。

location_restriction

LocationRestriction

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

ev_options

EVOptions

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

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”。对于非分类查询(例如“加利福尼亚州山景城”),我们建议您不要设置 rankPreference。
DISTANCE 按距离对结果进行排名。
RELEVANCE 按相关性对结果排名。排序顺序由正常排名堆栈确定。

SearchTextResponse

SearchText 的响应 proto。

字段
places[]

Place

符合用户文本搜索条件的地点列表。