Method: annotatePaths (Automotive)

Renvoie les chemins de retour basés sur les segments d'entrée avec des annotations pour les attributs dynamiques le long des chemins.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "paths": [
    {
      object (Path)
    }
  ],
  "annotationOptions": {
    object (AnnotationOptions)
  }
}
Champs
paths[]

object (Path)

Obligatoire. Itinéraires demandés à renseigner avec les données d'attributs dynamiques. Tous les chemins doivent correspondre à la même section de départ (celle sur laquelle se trouve actuellement le véhicule). Le véhicule est supposé se trouver au début de la première section. Si les chemins ne commencent pas au même segment, une erreur est renvoyée.
annotationOptions

object (AnnotationOptions)

Obligatoire. Attributs de données dynamiques demandés qui doivent être ajoutés aux chemins d'entrée. Si ce champ est vide, la requête ne sera pas annotée.

Corps de la réponse

AnnotatePathsResponse contient les chemins d'entrée avec des données supplémentaires ajoutées pour toutes les annotations demandées.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "annotatedPaths": [
    {
      object (AnnotatedPath)
    }
  ]
}
Champs
annotatedPaths[]

object (AnnotatedPath)

Chemins d'accès de l'entrée annotés avec les attributs demandés.

Chemin d'accès

Chemin sur lequel les attributs dynamiques sont demandés.

Un chemin doit comporter des segments reliés et praticables. Les segments d'un chemin sont supposés suivre un itinéraire logique. Si un itinéraire est introuvable sur les segments d'entrée, une erreur est renvoyée. Par exemple, si les segments d'un chemin ne possèdent pas de points de terminaison de connexion ou qu'un chemin est vide, cela génère une erreur.

La longueur d'un chemin est actuellement limitée à 15 km. Le trajet est mesuré à partir du début de la première section, c'est-à-dire la position supposée du véhicule. Une erreur est renvoyée si un tronçon de chemin commence à plus de 15 km du début du premier segment. Le dernier tronçon peut commencer avant 15 km et se terminer au-delà de 15 km. Aucune réponse partielle ne sera renvoyée.

Un chemin d'accès peut contenir les mêmes segments qu'un autre chemin, mais les annotations de segment peuvent contenir des réponses différentes en fonction des différences au niveau d'autres parties du chemin.

Représentation JSON 
{
  "segments": [
    {
      object (Segment)
    }
  ]
}
Champs
segments[]

object (Segment)

Obligatoire. Liste numérotée de segments constituant le chemin.

Segment

Segment appartenant à un chemin.

Représentation 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.
}
Champs
polyline

object (Polyline)

Obligatoire. La polyligne du segment, qui permet d'identifier le segment si l'ID est introuvable, et de différencier deux segments s'ils ont le même ID. La polyligne est encodée selon le format standard d'algorithme des polylignes encodées par Google Maps Platform.
Champ d'union id. Utilisé pour identifier ce segment dans un espace d'ID. Obligatoire. id ne peut être qu'un des éléments suivants :
placeId

string

ID de lieu pour cette section de route. Utilisé dans toutes les API.

AnnotationOptions

Annotations demandées pour les chemins d'entrée.

Représentation JSON 
{
  "includeLevelOfService": boolean
}
Champs
includeLevelOfService

boolean

Facultatif. Lorsque ce paramètre est défini sur "true", les segments de la réponse sont annotés avec les valeurs de trafic prévu. "Niveau de service" est un terme généralement utilisé pour décrire la catégorisation du flux de trafic, mais les définitions de niveau de service de cette API appartiennent à cette seule API.

AnnotatedPath

Copie d'un chemin d'entrée renvoyé avec des attributs prédits.

Représentation JSON 
{
  "annotatedSegments": [
    {
      object (AnnotatedSegment)
    }
  ]
}
Champs
annotatedSegments[]

object (AnnotatedSegment)

Liste numérotée de segments constituant le chemin principal, annoté avec les attributs demandés.

AnnotatedSegment

Un segment qui construit un chemin d'accès, annoté avec des attributs de données dynamiques.

Représentation JSON 
{
  "segment": {
    object (Segment)
  },
  "segmentSpanAttributes": [
    {
      object (SegmentSpanAttribute)
    }
  ]
}
Champs
segment

object (Segment)

Détails du segment permettant de le distinguer des autres segments
segmentSpanAttributes[]

object (SegmentSpanAttribute)

Attributs attribués au segment. Ces attributs peuvent varier en fonction du chemin d'accès d'une section. Un span peut couvrir la totalité du segment. Les segments d'attribut sont dans l'ordre chronologique, de l'emplacement du véhicule à la fin du chemin.

SegmentSpanAttribute

SegmentSpanAttribute contient les annotations renvoyées par l'API.

Représentation JSON 
{
  "segmentSpan": {
    object (SegmentSpan)
  },
  "levelOfService": enum (LevelOfService)
}
Champs
segmentSpan

object (SegmentSpan)

Décrit où les annotations s'appliquent sur le segment.
levelOfService

enum (LevelOfService)

Niveau de trafic prévu pour la section de la section, défini par les vitesses de circulation prévues sur ce segment lorsque le véhicule arrive au début de cette section.

SegmentSpan

Permet de délimiter une sous-section d'un segment. Si un tronçon couvre la totalité de la section, les startMeters sont de 0 et les endMeter sont la longueur de la section.

Représentation JSON 
{
  "startMeters": integer,
  "endMeters": integer
}
Champs
startMeters

integer

Le début de l'étendue correspond au point de départ de la polyligne du segment.
endMeters

integer

L'extrémité de l'étendue correspond au point de départ de la polyligne du segment.

LevelOfService

Valeurs prédites du bucket de trafic, à utiliser pour la fonctionnalité ADAS, qui correspondent aux niveaux généraux de trafic. Les valeurs renvoyées par cette API sont indépendantes et ne doivent pas être considérées comme correspondant à d'autres API.

Enums
LEVEL_OF_SERVICE_UNSPECIFIED Valeur par défaut. Cette valeur signifie qu'aucune valeur de trafic prévu n'est disponible.
LEVEL_OF_SERVICE_STOPPED Le trafic est interrompu.
LEVEL_OF_SERVICE_STOP_AND_GO Les embouteillages sont interrompus.
LEVEL_OF_SERVICE_SLOW Un ralentissement est prévu, mais aucun embouteillage n'est prévu.
LEVEL_OF_SERVICE_NORMAL Vitesse normale ; aucun ralentissement n'est prévu.