REST Resource: selection.v1.projects.selectedRoutes

Ressource : SelectedRoute

Un SelectedRoute représente un itinéraire spécifique pour lequel un client souhaite récupérer régulièrement des informations (par exemple, la durée) pour des cas d'utilisation contractuels.

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "state": enum (State),
  "routeAttributes": {
    string: string,
    ...
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dynamicRoute": {
    object (DynamicRoute)
  }
  // End of mutually exclusive fields.
  "validationError": enum (ValidationError),
  "dynamicRouting": boolean
}
Champs
name

string

Identifiant. Nom de ressource de SelectedRoute.

Format : projects/{project}/selectedRoutes/{selectedRoute}
displayName

string

Facultatif. Nom à afficher de la route. Il s'agit d'un champ facultatif qui peut être utilisé par le client. Il ne doit pas forcément être unique. La longueur est limitée à 100 caractères (comptés en points de code Unicode).
createTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle la route sélectionnée a été créée.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
state

enum (State)

Uniquement en sortie. État de la route sélectionnée.
routeAttributes

map (key: string, value: string)

Facultatif. Attributs personnalisés de la route sélectionnée. L'ajout de ces tags permet de filtrer ou de regrouper les itinéraires lors de la récupération des informations historiques et en temps réel sur les itinéraires. Vous pouvez utiliser jusqu'à 25 attributs par itinéraire. Chaque clé et chaque valeur doivent être une chaîne non vide et peuvent comporter jusqu'à 100 caractères (comptés en points de code Unicode). Les clés ne doivent pas commencer par goog.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Seule l'option DynamicRoute est acceptée. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
dynamicRoute

object (DynamicRoute)

SelectedRoute est une route dynamique.
Fin des champs mutuellement exclusifs.
validationError

enum (ValidationError)

Uniquement en sortie. Erreur de validation pour la route sélectionnée lorsque l'état est STATE_INVALID.
dynamicRouting

boolean

Facultatif. Si la valeur est définie sur true, l'itinéraire sélectionné peut être modifié de manière dynamique en fonction du trafic en temps réel selon les points de cheminement d'entrée. Si la valeur est définie sur false, l'itinéraire sélectionné sera un itinéraire fixe qui ne tient pas compte du trafic en temps réel et qui suit le chemin calculé au moment de la création, sans tenir compte du trafic. En cas d'omission, la valeur par défaut est false, ce qui indique qu'il s'agit d'un itinéraire fixe.

DynamicRoute

Il représente un itinéraire avec des points de cheminement (point de départ, destination et points intermédiaires). L'itinéraire réel passera par tous les points de cheminement. Si dynamicRouting est défini sur false, l'itinéraire réel reste fixe, quelles que soient les conditions de circulation. Sinon, si dynamicRouting est défini sur true, l'itinéraire réel peut changer en fonction des conditions de circulation.

Représentation JSON 
{
  "origin": {
    object (LatLng)
  },
  "destination": {
    object (LatLng)
  },
  "intermediates": [
    {
      object (LatLng)
    }
  ]
}
Champs
origin

object (LatLng)

Obligatoire. Lieu de départ de l'itinéraire.
destination

object (LatLng)

Obligatoire. Lieu d'arrivée de l'itinéraire.
intermediates[]

object (LatLng)

Facultatif. Ensemble de points de cheminement intermédiaires le long de l'itinéraire (à l'exclusion des points de terminaison). Il s'agit toujours de points de passage. Vous pouvez ajouter jusqu'à 25 points de cheminement intermédiaires. En les ajoutant correctement, vous pouvez réduire les variations de l'itinéraire réel de temps en temps.

LatLng

Objet représentant une paire latitude/longitude. Cette valeur est exprimée par une paire de doubles représentant les degrés de latitude et de longitude. Sauf indication contraire, cet objet doit être conforme à la norme WGS84. Les valeurs doivent se situer dans les limites normalisées.

Représentation JSON 
{
  "latitude": number,
  "longitude": number
}
Champs
latitude

number

Latitude en degrés. Elle doit être comprise dans la plage [-90.0, +90.0].
longitude

number

Longitude en degrés. Elle doit être comprise dans la plage [-180.0, +180.0].

État

État de la route sélectionnée.

Enums
STATE_UNSPECIFIED L'état de cette route n'est pas défini.
STATE_SCHEDULING L'itinéraire a été créé et est en cours de planification.
STATE_RUNNING La route a été créée et est associée à une programmation active.
STATE_DELETING La route a été marquée pour suppression.
STATE_VALIDATING La route est en cours de validation.
STATE_INVALID La route n'est pas valide d'après l'un des critères de validation.

ValidationError

Erreur de validation pour l'itinéraire sélectionné.

Enums
VALIDATION_ERROR_UNSPECIFIED L'erreur de validation de cette route n'est pas définie.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION La route se trouve en dehors de la juridiction du projet.
VALIDATION_ERROR_LOW_ROAD_USAGE La route est peu fréquentée (très peu de personnes l'empruntent).

Méthodes

batchCreate

 Crée plusieurs ressources SelectedRoute et lance une planification pour récupérer régulièrement les informations de cache pour chacune des routes.

batchDelete

 Supprime plusieurs ressources SelectedRoute pour le projet spécifié.

batchUpdate

 Met à jour plusieurs ressources SelectedRoute spécifiées par leur nom.

create

 Crée une SelectedRoute et lance une planification pour récupérer régulièrement les informations de cache de l'itinéraire.

delete

 Supprime la SelectedRoute spécifiée pour le projet spécifié.

get

 Récupère un SelectedRoute spécifié par son nom.

list

 Répertorie toutes les ressources SelectedRoute du projet spécifié avec pagination.

patch

 Met à jour un SelectedRoute spécifié par son nom.