- HTTP 请求
- 请求正文
- 响应正文
- 路径
- 细分
- AnnotationOptions
- AnnotatedPath
- AnnotatedSegment
- SegmentSpanAttribute
- SegmentSpan
- LevelOfService
返回基于输入的路径,以及这些路径沿线动态属性的注解。
HTTP 请求
POST https://routes.googleapis.com/annotations/v2:annotatePaths
网址采用 gRPC 转码语法。
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{ "paths": [ { object ( |
字段 | |
---|---|
paths[] |
必需。请求填充动态属性数据的路线。所有路径都应具有相同的起始路段,即车辆当前所在的路段。假定车辆位于第一路段的起点。如果路径的起点并非同一段,系统将会返回错误。 |
annotationOptions |
必需。所请求的动态数据属性,应添加到输入路径中。如果为空,则不会为该请求添加注释。 |
响应正文
AnnotatePathsResponse 包含输入路径,其中包含为所有请求注解添加的额外数据。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"annotatedPaths": [
{
object ( |
字段 | |
---|---|
annotatedPaths[] |
输入带有请求属性注解的输入的路径。 |
路径
请求动态属性的路径。
路径应包含相连的可行驶路段。路径的路段假定路径遵循一条逻辑路线,如果在输入路段上找不到路线,则会返回错误。例如,如果路径中的段没有连接端点,或者路径为空,就会引发错误。
路径目前上限为 15 公里。系统会从第一个路段的起点测量路线,即假定车辆的位置。如果路径中某一路段的起点与第一个路段的起点相差超过 15 公里,则会返回错误。最后一个路段可以在 15 公里之前开始,在 15 公里之后结束。不会返回部分响应。
一条路径可以包含与另一条路径相同的线段,但线段注解可能会根据路径其他部分的不同而包含不同的响应。
JSON 表示法 |
---|
{
"segments": [
{
object ( |
字段 | |
---|---|
segments[] |
必需。构成路径的线段的有序列表。 |
分割部分
属于路径的路段。
JSON 表示法 |
---|
{ "polyline": { object ( |
字段 | |
---|---|
polyline |
必需。路段的多段线,用于在无法找到 ID 时识别路段;当 ID 相同时,还可用于区分两个路段。多段线使用标准 Google Maps Platform 编码多段线算法格式进行编码。 |
联合字段 id 。用于在 ID 空间中识别此细分受众群。必需。id 只能是下列其中一项: |
|
placeId |
此路段的地点 ID。在各种 API 中使用。 |
AnnotationOptions
为输入路径请求的注解。
JSON 表示法 |
---|
{ "includeLevelOfService": boolean } |
字段 | |
---|---|
includeLevelOfService |
可选。如果设置为 true,系统会用预测的流量值对响应中的路段进行注释。“服务等级”是一个通常用于描述流量分类的术语,但是此 API 中的服务定义等级只属于此 API。 |
AnnotatedPath
包含预测属性返回的输入路径的副本。
JSON 表示法 |
---|
{
"annotatedSegments": [
{
object ( |
字段 | |
---|---|
annotatedSegments[] |
构成主路径的有序路段列表,标有所请求的属性。 |
AnnotatedSegment
用于构建路径的细分,路径上带有动态数据属性注解。
JSON 表示法 |
---|
{ "segment": { object ( |
字段 | |
---|---|
segment |
细分详情,用于将其与其他细分区分开来。 |
segmentSpanAttributes[] |
分配给细分的属性。这些属性可能会因路段所在的路径而异。跨度可以覆盖整个片段。属性跨度将按前方顺序从车辆位置到路径末尾。 |
SegmentSpanAttribute
SegmentSpanAttribute 包含 API 返回的注释。
JSON 表示法 |
---|
{ "segmentSpan": { object ( |
字段 | |
---|---|
segmentSpan |
说明注释在片段上的适用情况。 |
levelOfService |
路段跨度的预计车流等级,根据车辆抵达路段起点时在此路段的预计车流速度定义。 |
SegmentSpan
用于分隔细分的子部分。如果跨度覆盖整个片段,则 startMeter 为 0,endMeter 为片段长度。
JSON 表示法 |
---|
{ "startMeters": integer, "endMeters": integer } |
字段 | |
---|---|
startMeters |
其中,跨度的起点是路段的多段线的起点。 |
endMeters |
其中 span 的终点是从线段的多段线的起点开始。 |
LevelOfService
预测的流量存储分区值,用于 ADAS 功能,映射到常规流量。此 API 返回的值是独立的,不应依赖于此 API 与其他 API 相对应。
枚举 | |
---|---|
LEVEL_OF_SERVICE_UNSPECIFIED |
默认值。该值表示没有可用的预测流量值。 |
LEVEL_OF_SERVICE_STOPPED |
流量已停止。 |
LEVEL_OF_SERVICE_STOP_AND_GO |
交通顺畅。 |
LEVEL_OF_SERVICE_SLOW |
预计行驶缓慢,但预计不会交通拥堵。 |
LEVEL_OF_SERVICE_NORMAL |
速度正常,预计不会减速。 |