Method: searchAlongRoute

搜索出行路线沿途的地点。

HTTP 请求

POST https://mapstools.googleapis.com/v1alpha:searchAlongRoute

网址采用 gRPC 转码语法。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "routingPreference": enum (RoutingPreference),
  "includeExtendedDetails": boolean,
  "travelMode": enum (RouteTravelMode),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "encodedPolyline": string,
  "retrievalToken": string,
  "routeEndpoints": {
    object (RouteEndpoints)
  }
  // End of mutually exclusive fields.
}
字段
textQuery

string

必需。自然语言搜索查询（例如“电动汽车充电桩”“咖啡”）。
languageCode

string

可选。摘要和地点详情的语言。默认值为“en-US”。
regionCode

string

可选。位置的国家/地区代码 (CLDR)（例如“US”）。
routingPreference

enum (RoutingPreference)

可选。可选路由偏好设置，用于指定如何使用路况数据。默认值为 TRAFFIC_UNAWARE。
includeExtendedDetails

boolean

可选。在响应中包含扩展的地点详情。

当用户请求需要丰富的定性数据洞见、实时动态或专门的实体属性时，请将此字段设置为 true：- 定性评价、客户情绪和反馈。- 具体产品/服务，例如菜单项、菜品、特色美食、饮品或商家亮点。- 氛围、室内装饰、美学、环境或情调等定性描述。- 实时数据和专门设施规格、访客政策/提示、等待时间。

对于标准发现搜索（例如菜系、商店类型）、位置/地址查询、联系信息、营业时间和标准元数据/设施，请保留 false（默认）。

启用此字段可能会导致延迟时间增加。
travelMode

enum (RouteTravelMode)

可选。指定用于计算路线和绕行路线的出行方式。默认为 DRIVE。WALK 和 BICYCLE 仅支持 routeEndpoints。不支持 TRANSIT。
路线规范：现有路线、路线令牌或起点/终点。以下是互斥字段的列表。在响应中，最多只能设置其中一个字段：
encodedPolyline

string

表示路线的编码多段线字符串。请参阅 https://developers.google.com/maps/documentation/utilities/polylinealgorithm
retrievalToken

string

从之前的 v1alpha.computeRoutes 调用返回的检索令牌，表示路线。
routeEndpoints

object (RouteEndpoints)

明确的路线端点（出发地和目的地）。
互斥字段结束。

响应正文

如果成功，则响应正文包含一个 SearchAlongRouteResponse 实例。

授权范围

需要以下 OAuth 作用域：

  • https://www.googleapis.com/auth/maps-platform.mapstools