Method: annotatePaths (Automotive)

入力セグメント ベースのパスを、パスに沿った動的属性のアノテーションとともに返します。

HTTP リクエスト

POST https://routes.googleapis.com/annotations/v2:annotatePaths

この URL は gRPC Transcoding 構文を使用します。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "paths": [
    {
      object (Path)
    }
  ],
  "annotationOptions": {
    object (AnnotationOptions)
  }
}
フィールド
paths[]

object (Path)

必須。動的属性データを入力するようリクエストされるルート。すべての経路には、同じ開始セグメント（現在車両が走行しているセグメント）を指定する必要があります。車両は最初のセグメントの開始時であると想定されます。経路が同じセグメントで始まっていない場合、エラーが返されます。
annotationOptions

object (AnnotationOptions)

必須。入力パスに追加する必要がある、リクエストされた動的データ属性。空の場合、リクエストにアノテーションが付けられません。

レスポンスの本文

AnnotatePathsResponse には、リクエストされたすべてのアノテーションの追加データが追加された入力パスが含まれます。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "annotatedPaths": [
    {
      object (AnnotatedPath)
    }
  ]
}
フィールド
annotatedPaths[]

object (AnnotatedPath)

リクエストされた属性でアノテーションが付けられた入力からのパス。

Path

動的属性がリクエストされているパス。

経路には、接続され走行可能なセグメントが必要です。パスのセグメントは論理ルートに従っているものと想定され、入力セグメントでルートが見つからなかった場合は、エラーが返されます。たとえば、パス内のセグメントに接続エンドポイントがない場合や、パスが空の場合、エラーが発生します。

現在、歩道の全長は 15 km に制限されています。この経路は、最初のセグメント（車両の想定位置）の始点から測定されます。経路内のセグメントの開始地点が最初のセグメントの始点から 15 km を超えている場合は、エラーが返されます。最後のセグメントは、15 km より前で開始し、15 km を超えて終了してもかまいません。部分的なレスポンスは返されません。

パスには別のパスと同じセグメントを含めることができますが、セグメント アノテーションには、パスの他の部分の違いに基づいて異なるレスポンスを含めることができます。

JSON 表現 
{
  "segments": [
    {
      object (Segment)
    }
  ]
}
フィールド
segments[]

object (Segment)

必須。パスを形成するセグメントの順序付きリスト。

分類して表示

パスに属するセグメント。

JSON 表現 
{
  "polyline": {
    object (Polyline)
  },

  // Union field id can be only one of the following:
  "placeId": string
  // End of list of possible types for union field id.
}
フィールド
polyline

object (Polyline)

必須。セグメントのポリライン。ID が見つからない場合にセグメントを識別し、同じ ID を持つ 2 つのセグメントを区別するために使用できます。ポリラインは、標準の Google Maps Platform エンコード ポリライン アルゴリズム形式を使用してエンコードされます。
共用体フィールド id。ID 空間内でこのセグメントを識別するために使用されます。必須。id は次のいずれかになります。
placeId

string

この道路セグメントの場所 ID。API 全体で使用されます。

AnnotationOptions

入力パスに対してリクエストされたアノテーション。

JSON 表現 
{
  "includeLevelOfService": boolean
}
フィールド
includeLevelOfService

boolean

省略可。true に設定すると、レスポンスのセグメントに予測トラフィック量の注釈が付けられます。「サービスレベル」はトラフィック フローの分類を表すために一般的に使用される用語ですが、この API におけるサービス定義のレベルはこの API のみに属します。

AnnotatedPath

予測された属性とともに返される入力パスのコピー。

JSON 表現 
{
  "annotatedSegments": [
    {
      object (AnnotatedSegment)
    }
  ]
}
フィールド
annotatedSegments[]

object (AnnotatedSegment)

メインパスを形成するセグメントの順序付きリスト。リクエストされた属性でアノテーションが付けられます。

AnnotatedSegment

経路を構築するセグメントで、動的データ属性でアノテーションが付けられています。

JSON 表現 
{
  "segment": {
    object (Segment)
  },
  "segmentSpanAttributes": [
    {
      object (SegmentSpanAttribute)
    }
  ]
}
フィールド
segment

object (Segment)

他のセグメントと区別するためのセグメントの詳細です。
segmentSpanAttributes[]

object (SegmentSpanAttribute)

セグメントに割り当てられている属性。これらの属性は、セグメントが配置されているパスによって異なる場合があります。スパンはセグメント全体をカバーできます。属性スパンは、車両の位置から経路の終点まで順方向になります。

SegmentSpanAttribute

SegmentSpanAttribute には、API から返されたアノテーションが含まれます。

JSON 表現 
{
  "segmentSpan": {
    object (SegmentSpan)
  },
  "levelOfService": enum (LevelOfService)
}
フィールド
segmentSpan

object (SegmentSpan)

アノテーションが適用されるセグメント内の場所を示します。
levelOfService

enum (LevelOfService)

セグメントの区間の予測交通量レベル。車両がセグメントの始点に到着したときにこのセグメントで予想される交通速度によって定義されます。

SegmentSpan

セグメントのサブセクションを区切るために使用されます。スパンがセグメント全体をカバーしている場合、startMeters は 0 に、endMeters はセグメントの長さになります。

JSON 表現 
{
  "startMeters": integer,
  "endMeters": integer
}
フィールド
startMeters

integer

スパンの始点は、セグメントのポリラインの始点となります。
endMeters

integer

スパンの終点は、セグメントのポリラインの始点となります。

LevelOfService

予測トラフィック バケットの値。ADAS 機能に使用されます。一般的なレベルのトラフィックにマッピングされます。この API から返される値は独立した値であるため、他の API に対応する値に依存しないでください。

列挙型
LEVEL_OF_SERVICE_UNSPECIFIED デフォルト値。この値は、利用可能な予測トラフィック値がないことを意味します。
LEVEL_OF_SERVICE_STOPPED トラフィックは停止されます。
LEVEL_OF_SERVICE_STOP_AND_GO 交通渋滞は止まりません。
LEVEL_OF_SERVICE_SLOW 渋滞は予測されますが、渋滞は予測されていません。
LEVEL_OF_SERVICE_NORMAL 通常の速度です。渋滞は予測されません。