Method: annotatePaths (Automotive)

Gibt die segmentbasierten Eingabepfade mit Anmerkungen für dynamische Attribute entlang der Pfade zurück.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "paths": [
    {
      object (Path)
    }
  ],
  "annotationOptions": {
    object (AnnotationOptions)
  }
}
Felder
paths[]

object (Path)

Erforderlich. Die angeforderten Routen, die mit dynamischen Attributdaten gefüllt werden sollen. Alle Pfade sollten dasselbe Startsegment haben, also das Segment, in dem sich das Fahrzeug gerade befindet. Es wird angenommen, dass sich das Fahrzeug am Anfang des ersten Abschnitts befindet. Wenn Pfade nicht bei demselben Segment beginnen, wird ein Fehler zurückgegeben.
annotationOptions

object (AnnotationOptions)

Erforderlich. Die angeforderten dynamischen Datenattribute, die den Eingabepfaden hinzugefügt werden sollen. Wenn das Feld leer ist, wird die Anfrage nicht annotiert.

Antworttext

AnnotatePathsResponse enthält die Eingabepfade mit zusätzlichen Daten, die für alle angeforderten Annotationen hinzugefügt wurden.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "annotatedPaths": [
    {
      object (AnnotatedPath)
    }
  ]
}
Felder
annotatedPaths[]

object (AnnotatedPath)

Pfade aus der Eingabe, die mit angeforderten Attributen annotiert wurden.

Pfad

Ein Pfad, für den dynamische Attribute angefordert werden.

Ein Pfad sollte miteinander verbundene und befahrbare Segmente enthalten. Es wird angenommen, dass die Segmente eines Pfads einer logischen Route folgen. Wenn in den Eingabesegmenten keine Route gefunden werden kann, wird ein Fehler zurückgegeben. Wenn beispielsweise Segmente in einem Pfad keine Verbindungsendpunkte haben oder ein Pfad leer ist, wird ein Fehler ausgegeben.

Eine Strecke ist derzeit auf 15 km Länge beschränkt. Die Strecke wird vom Anfang des ersten Abschnitts aus gemessen, also vom angenommenen Fahrzeugstandort. Ein Fehler wird zurückgegeben, wenn ein Segment in einem Pfad weiter als 15 km vom Anfang des ersten Abschnitts entfernt beginnt. Es ist zulässig, dass der letzte Abschnitt vor 15 km beginnt und über 15 km endet. Es werden keine Teilantworten zurückgegeben.

Ein Pfad kann dieselben Segmente wie ein anderer Pfad enthalten. Die Segmentanmerkungen können jedoch aufgrund von Unterschieden in anderen Teilen des Pfads unterschiedliche Antworten enthalten.

JSON-Darstellung 
{
  "segments": [
    {
      object (Segment)
    }
  ]
}
Felder
segments[]

object (Segment)

Erforderlich. Eine geordnete Liste von Segmenten, die den Pfad bildet.

Segment

Segment, das zu einem Pfad gehört

JSON-Darstellung 
{
  "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.
}
Felder
polyline

object (Polyline)

Erforderlich. Die Polylinie des Segments. Sie kann verwendet werden, um das Segment zu identifizieren, wenn die ID nicht gefunden werden kann, und um zwischen zwei Segmenten zu unterscheiden, wenn sie dieselbe ID haben. Die Polylinie wird mit dem Standardformat für codierte Polylinien der Google Maps Platform codiert.
Union-Feld id. Wird zum Identifizieren dieses Segments innerhalb eines ID-Bereichs verwendet. Erforderlich. Für id ist nur einer der folgenden Werte zulässig:
placeId

string

Orts-ID für diesen Straßenabschnitt Wird in allen APIs verwendet.

AnnotationOptions

Angeforderte Annotationen für die Eingabepfade.

JSON-Darstellung 
{
  "includeLevelOfService": boolean
}
Felder
includeLevelOfService

boolean

Optional. Ist die Richtlinie auf „true“ gesetzt, werden die Segmente in der Antwort mit prognostizierten Traffic-Werten versehen. „Servicelevel“ ist ein allgemein verwendeter Begriff, um die Kategorisierung des Trafficflusses zu beschreiben, aber die Ebene der Dienstdefinitionen in dieser API gehört allein zu dieser API.

AnnotatedPath

Eine Kopie eines Eingabepfads, der mit vorhergesagten Attributen zurückgegeben wurde.

JSON-Darstellung 
{
  "annotatedSegments": [
    {
      object (AnnotatedSegment)
    }
  ]
}
Felder
annotatedSegments[]

object (AnnotatedSegment)

Eine geordnete Liste von Segmenten, die den Hauptpfad bilden und mit angeforderten Attributen versehen sind.

AnnotatedSegment

Ein Segment, das einen Pfad aufbaut und mit dynamischen Datenattributen gekennzeichnet ist.

JSON-Darstellung 
{
  "segment": {
    object (Segment)
  },
  "segmentSpanAttributes": [
    {
      object (SegmentSpanAttribute)
    }
  ]
}
Felder
segment

object (Segment)

Segmentdetails, die zur Unterscheidung von anderen Segmenten dienen.
segmentSpanAttributes[]

object (SegmentSpanAttribute)

Dem Segment zugewiesene Attribute. Diese Attribute können sich je nach Pfad unterscheiden, in dem sich ein Segment befindet. Eine Spanne kann das gesamte Segment abdecken. Attribut-Spans sind in der Reihenfolge vom Fahrzeugstandort bis zum Ende des Pfads angeordnet.

SegmentSpanAttribute

Ein SegmentSpanAttribute enthält die von der API zurückgegebenen Annotationen.

JSON-Darstellung 
{
  "segmentSpan": {
    object (SegmentSpan)
  },
  "levelOfService": enum (LevelOfService)
}
Felder
segmentSpan

object (SegmentSpan)

Beschreibt, wo im Segment die Anmerkungen gelten.
levelOfService

enum (LevelOfService)

Die voraussichtliche Verkehrslage für die Spanne des Segments. Sie ergibt sich aus der voraussichtlichen Verkehrsgeschwindigkeit für diesen Abschnitt, wenn das Fahrzeug am Anfang des Abschnitts ankommt.

SegmentSpan

Wird zur Trennung eines Unterabschnitts eines Segments verwendet. Wenn eine Spanne das gesamte Segment abdeckt, ist startMeters 0 und endMeters die Segmentlänge.

JSON-Darstellung 
{
  "startMeters": integer,
  "endMeters": integer
}
Felder
startMeters

integer

Der Beginn der Spanne ist vom Startpunkt der Polylinie des Segments aus.
endMeters

integer

Das Ende der Spanne befindet sich dabei vom Startpunkt der Polylinie des Segments.

LevelOfService

Vorhergesagte Traffic-Bucket-Werte zur Verwendung für die ADAS-Funktionalität, die dem allgemeinen Traffic entsprechen. Die von dieser API zurückgegebenen Werte sind unabhängig und sollten nicht als Werte anderer APIs herangezogen werden.

Enums
LEVEL_OF_SERVICE_UNSPECIFIED Standardwert. Dieser Wert bedeutet, dass kein prognostizierter Traffic-Wert verfügbar ist.
LEVEL_OF_SERVICE_STOPPED Der Verkehr wurde angehalten.
LEVEL_OF_SERVICE_STOP_AND_GO Stop-and-drop.
LEVEL_OF_SERVICE_SLOW Es wird ein Stau erwartet, es werden aber keine Staus vorhergesagt.
LEVEL_OF_SERVICE_NORMAL Normale Geschwindigkeit, es wird keine Verlangsamung vorhergesagt.