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

用户生成的内容数据作者的相关信息。在 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) 中或仅添加(地区)或仅添加表格 A 或表格 B 中的主要地点类型(例如“餐馆”或“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] 的范围内。

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

用户评价的理由。这会突出显示最终用户可能感兴趣的用户评价部分。例如,如果搜索查询为“柴火披萨”,评价理由会突出显示与搜索查询相关的文字。

字段
highlighted_text

HighlightedText

review

Review

生成突出显示的文字所依据的评价。

HighlightedText

通过理由突出显示的文本。这是该评价的一部分。要突出显示的确切字词由 HighlightedTextRange 标记。突出显示的文本中可能有多个字词。

字段
text

string

highlighted_text_ranges[]

HighlightedTextRange

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

HighlightedTextRange

突出显示的文本的范围。

字段
start_index

int32

end_index

int32

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 组合 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

在地点对象的 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

此照片的作者。

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 Code。

location

LatLng

此地点的位置。

viewport

Viewport

适合在一般尺寸地图上显示相应地点的视口。

rating

double

1.0 到 5.0 之间的评分,基于对此地点的用户评价。

google_maps_uri

string

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

website_uri

string

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

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

实验性功能:如需了解详情,请参阅 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 针对地点所在区域生成的摘要。

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 可能为“澳大利亚”。

short_text

string

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

types[]

string

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

language_code

string

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

AreaSummary

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

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

字段
content_blocks[]

ContentBlock

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

归因

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

字段
provider

string

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

provider_uri

string

地点数据提供程序的 URI。

BusinessStatus

地点的商家状态。

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

GenerativeSummary

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

AI 生成的地点摘要。

字段
overview

LocalizedText

地点的概览。

description

LocalizedText

地点的详细说明。

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 进行设置。

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 Code (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 Place 提供免费服务。
PRICE_LEVEL_INEXPENSIVE Place 提供廉价服务。
PRICE_LEVEL_MODERATE 这个地方提供价格适中的服务。
PRICE_LEVEL_EXPENSIVE 地点提供昂贵的服务。
PRICE_LEVEL_VERY_EXPENSIVE 这个地方提供的服务非常昂贵。

参考

实验性功能:如需了解详情,请参阅 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

评价的时间戳。

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 上包含的地点类型(例如“餐馆”或“加油站”)。

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

如果存在任何冲突的类型(即某个类型同时出现在 include_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 中排除地点类型(例如“餐馆”或“加油站”)。

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

如果客户端同时提供 include_types [例如餐厅] 和 excluded_types [例如咖啡馆],则响应应包含餐馆地点而非咖啡馆。响应包含的地点至少与一个 include_types 匹配,但不与任何 excluded_types 匹配。

如果存在任何冲突的类型(即某个类型同时出现在 include_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 上的主要地点类型(例如“餐馆”或“加油站”)。一个地点只能有一个关联的受支持类型表中的一种主要类型。

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

如果存在任何冲突的主要类型(即某个类型同时出现在 include_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 种类型。

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

如果为某个地点类型指定了多种类型限制,则系统仅返回满足所有限制的地点。例如,如果我们{included_types = ["restaurant"], excluded_primary_types = ["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 值。将默认使用按热门程度排名。
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.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

用于为 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 是默认值。对于非分类查询(例如“Mountain View, CA”),我们建议您不设置 rankPreference。
DISTANCE 按距离对结果进行排名。
RELEVANCE 按相关性对结果进行排名。由常规排名堆栈确定的排序顺序。

SearchTextResponse

SearchText 的响应 proto。

字段
places[]

Place

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

contextual_contents[]

ContextualContent

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

上下文内容列表,其中每个条目都与地点字段中相同索引的相应地点相关联。首选与请求中的 text_query 相关的内容。如果其中某个地点无法获取背景信息,则该地点将返回非上下文内容。仅当此内容不适用于此地点时,此字段才为空。如果请求的话,此列表中包含的条目数应该与地点列表数量一样多。

next_page_token

string

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