Package google.maps.roads.selection.v1

Index

RoadsSelection

Définition de service pour l'API Roads Selection.

BatchCreateSelectedRoutes

rpc BatchCreateSelectedRoutes(BatchCreateSelectedRoutesRequest) returns (BatchCreateSelectedRoutesResponse)

Crée plusieurs SelectedRoutes et lance une planification pour récupérer périodiquement les informations du cache pour chacun des itinéraires.

Champs d'application des autorisations

Requiert l'habilitation OAuth suivante :

  • https://www.googleapis.com/auth/cloud-platform
CreateSelectedRoute

rpc CreateSelectedRoute(CreateSelectedRouteRequest) returns (SelectedRoute)

Crée un SelectedRoute et lance une planification pour récupérer périodiquement les informations du cache pour l'itinéraire.

Champs d'application des autorisations

Requiert l'habilitation OAuth suivante :

  • https://www.googleapis.com/auth/cloud-platform
DeleteSelectedRoute

rpc DeleteSelectedRoute(DeleteSelectedRouteRequest) returns (Empty)

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

Champs d'application des autorisations

Requiert l'habilitation OAuth suivante :

  • https://www.googleapis.com/auth/cloud-platform
GetSelectedRoute

rpc GetSelectedRoute(GetSelectedRouteRequest) returns (SelectedRoute)

Obtient un SelectedRoute tel que spécifié par son nom.

Champs d'application des autorisations

Requiert l'habilitation OAuth suivante :

  • https://www.googleapis.com/auth/cloud-platform
ListSelectedRoutes

rpc ListSelectedRoutes(ListSelectedRoutesRequest) returns (ListSelectedRoutesResponse)

Répertorie tous les SelectedRoutes pour le projet spécifié avec pagination.

Champs d'application des autorisations

Requiert l'habilitation OAuth suivante :

  • https://www.googleapis.com/auth/cloud-platform

BatchCreateSelectedRoutesRequest

Demande de création de plusieurs SelectedRoute.

Champs
parent

string

Facultatif. Ressource de projet partagée par toutes les routes sélectionnées. Format : projects/{project}. Si ce champ est défini, le champ parent des messages CreateSelectedRouteRequest doit être vide ou correspondre à ce champ.
requests[]

CreateSelectedRouteRequest

Obligatoire. Message de la requête spécifiant la route sélectionnée à créer. Vous pouvez créer jusqu'à 1 000 itinéraires sélectionnés par lot.

BatchCreateSelectedRoutesResponse

Réponse à la création de plusieurs SelectedRoute.

Champs
selected_routes[]

SelectedRoute

SelectedRoutes créé.

CreateSelectedRouteRequest

Demande de création d'un SelectedRoute.

Champs
parent

string

Obligatoire. Projet sous lequel le SelectedRoute sera créé. Format : projects/{project}
selected_route

SelectedRoute

Obligatoire. SelectedRoute à créer.
selected_route_id

string

Facultatif. ID à utiliser pour SelectedRoute, qui constituera le composant final du nom de ressource de SelectedRoute.

Cette valeur doit contenir entre 4 et 63 caractères, et les caractères valides sont "a-z", "A-Z", "0-9" ou "-". Si elle n'est pas fournie ou est vide, un UUID sera généré après la création de la ressource.

DeleteSelectedRouteRequest

Demande de suppression d'un SelectedRoute.

Champs
name

string

Obligatoire. Nom de la SelectedRoute à supprimer. Format : projects/{project}/selectedRoutes/{selected_route}

GetSelectedRouteRequest

Demande d'obtention d'un SelectedRoute.

Champs
name

string

Obligatoire. Nom du SelectedRoute à récupérer. Format : projects/{project}/selectedRoutes/{selected_route}

ListSelectedRoutesRequest

Requête permettant de lister les SelectedRoute.

Champs
parent

string

Obligatoire. Parent à partir duquel toutes les SelectedRoute seront interrogées. Format : projects/{project}/selectedRoutes
page_size

int32

Facultatif. Nombre de résultats à renvoyer pour une page donnée. Si aucune valeur n'est définie, la valeur par défaut est 100. Si la valeur 0 est indiquée, la valeur par défaut sera définie. La valeur maximale est de 5 000. Toute valeur supérieure sera ramenée à 5 000.
page_token

string

Facultatif. Jeton de page reçu d'un appel ListSelectedRoutes précédent.

ListSelectedRoutesResponse

Réponse listant les SelectedRoute.

Champs
selected_routes[]

SelectedRoute

Page de SelectedRoutes stockée dans le projet spécifié dans la requête.
next_page_token

string

Jeton pouvant être envoyé en tant que page_token pour récupérer la page suivante. Si ce champ est vide, il n'y a pas d'autres pages.

SelectedRoute

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.

Champs
name

string

Identifiant. Nom de ressource de SelectedRoute.

Format : projects/{project}/selectedRoutes/{selected_route}
display_name

string

Facultatif. Nom à afficher de la route. Il s'agit d'un champ facultatif que le client peut utiliser. Il ne doit pas forcément être unique.
create_time

Timestamp

Uniquement en sortie. Heure à laquelle l'itinéraire sélectionné a été créé.
state

State

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

map<string, string>

Facultatif. Attributs personnalisés de la route sélectionnée. L'ajout de ces informations permet de filtrer / regrouper les itinéraires lors de la récupération des informations historiques et en temps réel. Jusqu'à 10 attributs sont acceptés par itinéraire. Chaque clé et valeur doit être une chaîne non vide et peut comporter jusqu'à 100 caractères. Les clés ne doivent pas commencer par "goog".
Champ d'union route_type. Pour le moment, seul DynamicRoute est pris en charge. La route_type ne peut être qu'un des éléments suivants :
dynamic_route

DynamicRoute

SelectedRoute est une route dynamique.
validation_error

ValidationError

Uniquement en sortie. Erreur de validation de l'itinéraire sélectionné lorsque l'état est STATE_INVALID.

DynamicRoute

Il s'agit d'un itinéraire avec des points de cheminement (origine, destination et points intermédiaires). L'itinéraire réel est garanti de passer par tous les points de cheminement, mais il peut changer de temps en temps en raison des conditions de circulation variables.

Champs
origin

LatLng

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

LatLng

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

LatLng

Facultatif. Ensemble de points de cheminement intermédiaires sur l'itinéraire (à l'exclusion des points de départ et d'arrivée). Il s'agit toujours de points de passage. Vous pouvez ajouter jusqu'à 25 points de cheminement intermédiaires. Si vous les ajoutez correctement, vous pourrez réduire la variation de l'itinéraire réel de temps en temps.

État

État de la route sélectionnée.

Enums
STATE_UNSPECIFIED L'état de cette route n'est pas défini.
STATE_SCHEDULING La route a été créée et est en cours de planification.
STATE_RUNNING La route a été créée et dispose d'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 selon l'un des critères de validation.

ValidationError

Erreur de validation pour la route sélectionnée.

Enums
VALIDATION_ERROR_UNSPECIFIED L'erreur de validation de cette route n'est pas définie.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION L'itinéraire 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).