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 ressources SelectedRoute et lance une planification pour récupérer régulièrement les informations de cache pour chacune des routes.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • roads.selectedRoutes.batchCreate

Pour en savoir plus, consultez la documentation IAM.

BatchDeleteSelectedRoutes

rpc BatchDeleteSelectedRoutes(BatchDeleteSelectedRoutesRequest) returns (Empty)

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

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • roads.selectedRoutes.batchDelete

Pour en savoir plus, consultez la documentation IAM.

BatchUpdateSelectedRoutes

rpc BatchUpdateSelectedRoutes(BatchUpdateSelectedRoutesRequest) returns (BatchUpdateSelectedRoutesResponse)

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

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • roads.selectedRoutes.batchUpdate

Pour en savoir plus, consultez la documentation IAM.

CreateSelectedRoute

rpc CreateSelectedRoute(CreateSelectedRouteRequest) returns (SelectedRoute)

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

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • roads.selectedRoutes.create

Pour en savoir plus, consultez la documentation IAM.

DeleteSelectedRoute

rpc DeleteSelectedRoute(DeleteSelectedRouteRequest) returns (Empty)

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

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Nécessite l'autorisation IAM suivante sur la ressource name :

  • roads.selectedRoutes.delete

Pour en savoir plus, consultez la documentation IAM.

GetSelectedRoute

rpc GetSelectedRoute(GetSelectedRouteRequest) returns (SelectedRoute)

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

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Nécessite l'autorisation IAM suivante sur la ressource name :

  • roads.selectedRoutes.get

Pour en savoir plus, consultez la documentation IAM.

ListSelectedRoutes

rpc ListSelectedRoutes(ListSelectedRoutesRequest) returns (ListSelectedRoutesResponse)

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

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • roads.selectedRoutes.list

Pour en savoir plus, consultez la documentation IAM.

UpdateSelectedRoute

rpc UpdateSelectedRoute(UpdateSelectedRouteRequest) returns (SelectedRoute)

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

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Nécessite l'autorisation IAM suivante sur la ressource name :

  • roads.selectedRoutes.update

Pour en savoir plus, consultez la documentation IAM.

BatchCreateSelectedRoutesRequest

Requête de création de plusieurs SelectedRoute.

Champs
parent

string

Obligatoire. Ressource de projet partagée par toutes les routes sélectionnées dans le lot. Il est obligatoire, car la requête par lot n'accepte qu'un seul parent. Format : projects/{project}

requests[]

CreateSelectedRouteRequest

Obligatoire. Message de requête spécifiant la route sélectionnée à créer. Vous pouvez créer jusqu'à 1 000 itinéraires sélectionnés dans un lot. La ressource parente de chaque requête doit être vide ou correspondre à l'élément parent de premier niveau.

BatchCreateSelectedRoutesResponse

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

Champs
selected_routes[]

SelectedRoute

SelectedRoute ressources créées.

BatchDeleteSelectedRoutesRequest

Requête de suppression de plusieurs SelectedRoute.

Champs
parent

string

Obligatoire. Ressource de projet partagée par toutes les routes sélectionnées à supprimer. Il est obligatoire, car la requête par lot n'accepte qu'un seul parent. Format : projects/{project}

names[]

string

Obligatoire. Noms des routes sélectionnées à supprimer. Vous pouvez supprimer jusqu'à 1 000 routes sélectionnées par lot. Format : projects/{project}/selectedRoutes/{selected_route}

BatchUpdateSelectedRoutesRequest

Requête de mise à jour de plusieurs SelectedRoute.

Champs
parent

string

Obligatoire. Ressource de projet partagée par toutes les routes sélectionnées dans le lot. Il est obligatoire, car la requête par lot n'accepte qu'un seul parent. Format : projects/{project}

requests[]

UpdateSelectedRouteRequest

Obligatoire. Message de requête spécifiant la route sélectionnée à mettre à jour. Vous pouvez mettre à jour jusqu'à 1 000 routes sélectionnées par lot. La ressource parente de chaque requête doit être vide ou correspondre à l'élément parent de premier niveau.

update_mask

FieldMask

Facultatif. Liste des champs à mettre à jour, partagée par toutes les requêtes enfants du lot.

Les chemins d'accès aux champs sont relatifs à SelectedRoute. Vous ne devez mettre à jour que display_name, route_attributes, dynamic_routing et dynamic_route (y compris origin, destination et intermediates).

Exemple : "display_name,route_attributes,dynamic_routing,dynamic_route".

S'il est défini, ce update_mask s'applique à toutes les requêtes enfants qui ne spécifient pas leur propre update_mask. Si * est spécifié, tous les champs modifiables sont entièrement remplacés. Si les champs update_mask sont définis au niveau de la requête par lot et de la requête enfant, ils doivent correspondre.

Si ce champ est omis, le update_mask de la requête enfant prendra effet. Si le champ update_mask d'une requête enfant est également omis, tous les champs modifiables renseignés dans le champ selected_route de la requête enfant sont implicitement mis à jour.

BatchUpdateSelectedRoutesResponse

Réponse de la mise à jour de plusieurs SelectedRoute.

Champs
selected_routes[]

SelectedRoute

SelectedRoute ressource mise à jour.

CreateSelectedRouteRequest

Requête de création d'un SelectedRoute.

Champs
parent

string

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

selected_route

SelectedRoute

Obligatoire. SelectedRoute à créer.

selected_route_id

string

Facultatif. ID à utiliser pour l'élément SelectedRoute, qui constituera le composant final du nom de ressource de l'élément 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 vous ne fournissez pas d'ID ou si le champ est vide, un UUID sera généré après la création de la ressource.

DeleteSelectedRouteRequest

Requête de suppression d'un SelectedRoute.

Champs
name

string

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

GetSelectedRouteRequest

Requête pour obtenir un SelectedRoute.

Champs
name

string

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

ListSelectedRoutesRequest

Requête permettant de lister les ressources SelectedRoute.

Champs
parent

string

Obligatoire. parent, qui est le projet à 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 ce nombre n'est pas défini, la valeur par défaut est 100. Lorsque la valeur 0 est spécifiée, la valeur par défaut est définie. La valeur maximale est de 5 000. Toute valeur supérieure à 5 000 est définie sur 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 ressources SelectedRoute stockées 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, aucune page suivante n'existe.

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.

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 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).

create_time

Timestamp

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

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 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.

Champ d'union route_type. Seule la région DynamicRoute est compatible. 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 pour la route sélectionnée lorsque l'état est STATE_INVALID.

dynamic_routing

bool

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 dynamic_routing est défini sur false, l'itinéraire réel reste fixe, quelles que soient les conditions de circulation. Sinon, si dynamic_routing est défini sur true, l'itinéraire réel peut changer en fonction des conditions de circulation.

Champs
origin

LatLng

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

destination

LatLng

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

intermediates[]

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.

É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).

UpdateSelectedRouteRequest

Requête de mise à jour d'un SelectedRoute.

Champs
selected_route

SelectedRoute

Obligatoire. SelectedRoute à mettre à jour. Le champ name de la route permet d'identifier la route à mettre à jour. Format : projects/{project}/selectedRoutes/{selected_route}

update_mask

FieldMask

Facultatif. Liste des champs à mettre à jour.

Les chemins d'accès aux champs sont relatifs à SelectedRoute. Vous ne devez mettre à jour que display_name, route_attributes, dynamic_routing et dynamic_route (y compris origin, destination et intermediates).

Exemple : "display_name,route_attributes,dynamic_routing,dynamic_route".

Si * est spécifié, tous les champs modifiables sont entièrement remplacés.

Si update_mask est omis, tous les champs modifiables renseignés dans selected_route sont implicitement mis à jour.