Package google.maps.roads.selection.v1

索引

RoadsSelection

道路选择 API 的服务定义。

BatchCreateSelectedRoutes

rpc BatchCreateSelectedRoutes(BatchCreateSelectedRoutesRequest) returns (BatchCreateSelectedRoutesResponse)

创建多个 SelectedRoutes，并启动一个调度程序，以定期检索每个路线的缓存信息。

授权范围

需要以下 OAuth 范围：

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

rpc CreateSelectedRoute(CreateSelectedRouteRequest) returns (SelectedRoute)

创建 SelectedRoute 并启动一个调度，以定期检索路线的缓存信息。

授权范围

需要以下 OAuth 范围：

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

rpc DeleteSelectedRoute(DeleteSelectedRouteRequest) returns (Empty)

删除指定项目的指定 SelectedRoute。

授权范围

需要以下 OAuth 范围：

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

rpc GetSelectedRoute(GetSelectedRouteRequest) returns (SelectedRoute)

获取由其名称指定的 SelectedRoute。

授权范围

需要以下 OAuth 范围：

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

rpc ListSelectedRoutes(ListSelectedRoutesRequest) returns (ListSelectedRoutesResponse)

列出指定项目的所有 SelectedRoutes（带分页）。

授权范围

需要以下 OAuth 范围：

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

BatchCreateSelectedRoutesRequest

创建多个 SelectedRoute 的请求。

字段
parent

string

可选。所有选定路线共用的项目资源。格式：projects/{project} 如果设置了此字段，则 CreateSelectedRouteRequest 消息中的父字段必须为空或与此字段匹配。
requests[]

CreateSelectedRouteRequest

必需。用于指定要创建的所选路线的请求消息。最多可以批量创建 1,000 条所选路线。

BatchCreateSelectedRoutesResponse

创建多个 SelectedRoute 时的响应。

字段
selected_routes[]

SelectedRoute

已创建 SelectedRoutes。

CreateSelectedRouteRequest

创建 SelectedRoute 的请求。

字段
parent

string

必需。将创建 SelectedRoute 的项目。格式：projects/{project}
selected_route

SelectedRoute

必需。要创建的 SelectedRoute。
selected_route_id

string

可选。要用于 SelectedRoute 的 ID，该 ID 将成为 SelectedRoute 资源名称的最后一个组成部分。

此值应为 4-63 个字符，有效字符为“a-z”“A-Z”“0-9”或“-”。如果未提供或为空，系统会在资源创建后生成 UUID。

DeleteSelectedRouteRequest

用于删除 SelectedRoute 的请求。

字段
name

string

必需。要删除的 SelectedRoute 的名称。格式：projects/{project}/selectedRoutes/{selected_route}

GetSelectedRouteRequest

获取 SelectedRoute 的请求。

字段
name

string

必需。要检索的 SelectedRoute 的名称。格式：projects/{project}/selectedRoutes/{selected_route}

ListSelectedRoutesRequest

列出 SelectedRoute 的请求。

字段
parent

string

必需。父级，即所有 SelectedRoute 都将从中查询的项目。格式：projects/{project}/selectedRoutes
page_size

int32

可选。应为指定页面返回的结果数。如果未设置，则默认值为 100。如果指定的值为 0，则该值将设置为默认值。最大值为 5000，任何高于 5000 的值都将设置为 5000。
page_token

string

可选。从之前的 ListSelectedRoutes 调用接收的页面令牌。

ListSelectedRoutesResponse

列出 SelectedRoute 的响应。

字段
selected_routes[]

SelectedRoute

相应请求中指定的项目内存储的 SelectedRoutes 页面。
next_page_token

string

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

SelectedRoute

SelectedRoute 表示客户希望定期检索信息（例如时长）以用于合同用例的特定路线。

字段
name

string

标识符。SelectedRoute 的资源名称。

格式：projects/{project}/selectedRoutes/{selected_route}
display_name

string

可选。路线的显示名称。此字段为可选字段，可供客户使用。该名称不必是唯一的。
create_time

Timestamp

仅限输出。所选路线的首次创建时间。
state

State

仅限输出。所选路线的状态。
route_attributes

map<string, string>

可选。所选路线的自定义属性。添加这些属性后，在检索历史路线和实时路线信息时，可以过滤 / 分组路线。每条路线最多支持 10 个属性。每个键和值都应为非空字符串，且最多可包含 100 个字符。密钥不得以“goog”开头。
联合字段 route_type。目前仅支持 DynamicRoute。route_type 只能是下列其中一项：
dynamic_route

DynamicRoute

SelectedRoute 是动态路由。
validation_error

ValidationError

仅限输出。当状态为 STATE_INVALID 时，所选路线的验证错误。

DynamicRoute

这表示一条包含途经点（起点、目的地和中间点）的路线。实际路线保证会经过所有途经点，但可能会因路况变化而随时发生变化。

字段
origin

LatLng

必需。路线的起点位置。
destination

LatLng

必需。路线的终点。
intermediates[]

LatLng

可选。路线中的一组中间航点（不包括终点）。它们始终是途经点。最多支持 25 个中间航点。正确添加这些信息可以减少实际路线随时间的变化。

州

所选路线的状态。

枚举
STATE_UNSPECIFIED 未设置相应路线的状态。
STATE_SCHEDULING 路线已创建，正在安排中。
STATE_RUNNING 路由已创建，并且具有有效的时间表。
STATE_DELETING 相应路线已被标记为待删除。
STATE_VALIDATING 路线正在验证中。
STATE_INVALID 根据某项验证条件，相应路线无效。

ValidationError

所选路线的验证错误。

枚举
VALIDATION_ERROR_UNSPECIFIED 未设置相应路线的验证错误。
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION 相应路线不在项目管辖范围内。
VALIDATION_ERROR_LOW_ROAD_USAGE 该路线的道路使用率较低（很少有人经过）。