Package google.maps.roads.selection.v1

Index

RoadsSelection

Dienstdefinition für die Roads Selection API.

BatchCreateSelectedRoutes

rpc BatchCreateSelectedRoutes(BatchCreateSelectedRoutesRequest) returns (BatchCreateSelectedRoutesResponse)

Erstellt mehrere SelectedRoutes und startet einen Zeitplan, um regelmäßig Cacheinformationen für jede der Routen abzurufen.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc CreateSelectedRoute(CreateSelectedRouteRequest) returns (SelectedRoute)

Erstellt eine SelectedRoute und startet einen Zeitplan, um regelmäßig Cache-Informationen für die Route abzurufen.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc DeleteSelectedRoute(DeleteSelectedRouteRequest) returns (Empty)

Löscht die angegebene SelectedRoute für das angegebene Projekt.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc GetSelectedRoute(GetSelectedRouteRequest) returns (SelectedRoute)

Ruft eine SelectedRoute anhand ihres Namens ab.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc ListSelectedRoutes(ListSelectedRoutesRequest) returns (ListSelectedRoutesResponse)

Listet alle SelectedRoutes für das angegebene Projekt mit Paginierung auf.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

BatchCreateSelectedRoutesRequest

Anfrage zum Erstellen mehrerer SelectedRoute.

Felder
parent

string

Optional. Die Projektressource, die von allen ausgewählten Routen gemeinsam verwendet wird. Format: projects/{project}. Wenn dieser Wert festgelegt ist, muss das Feld „parent“ in den CreateSelectedRouteRequest-Nachrichten entweder leer sein oder mit diesem Feld übereinstimmen.
requests[]

CreateSelectedRouteRequest

Erforderlich. Die Anfragenachricht, in der die ausgewählte Route angegeben ist, die erstellt werden soll. In einem Batch können maximal 1.000 ausgewählte Routen erstellt werden.

BatchCreateSelectedRoutesResponse

Antwort auf das Erstellen mehrerer SelectedRoute.

Felder
selected_routes[]

SelectedRoute

SelectedRoutes wurde erstellt.

CreateSelectedRouteRequest

Anfrage zum Erstellen eines SelectedRoute

Felder
parent

string

Erforderlich. Das Projekt, in dem die SelectedRoute erstellt wird. Format: projects/{project}
selected_route

SelectedRoute

Erforderlich. Die zu erstellende SelectedRoute.
selected_route_id

string

Optional. Die für SelectedRoute zu verwendende ID, die als letzte Komponente des Ressourcennamens von SelectedRoute verwendet wird.

Dieser Wert sollte 4 bis 63 Zeichen umfassen. Gültige Zeichen sind „a–z“, „A–Z“, „0–9“ oder „–“. Wenn er nicht angegeben oder leer ist, wird nach der Ressourcenerstellung eine UUID generiert.

DeleteSelectedRouteRequest

Anfrage zum Löschen einer Dienstleistung (SelectedRoute)

Felder
name

string

Erforderlich. Der Name der zu löschenden SelectedRoute. Format: projects/{project}/selectedRoutes/{selected_route}

GetSelectedRouteRequest

Anfrage zum Abrufen eines SelectedRoute

Felder
name

string

Erforderlich. Der Name des abzurufenden SelectedRoute. Format: projects/{project}/selectedRoutes/{selected_route}

ListSelectedRoutesRequest

Anfrage zum Auflisten von SelectedRoute.

Felder
parent

string

Erforderlich. Das übergeordnete Element, also das Projekt, aus dem alle SelectedRoute abgefragt werden. Format: projects/{project}/selectedRoutes
page_size

int32

Optional. Die Anzahl der Ergebnisse, die für eine bestimmte Seite zurückgegeben werden sollen. Wenn nicht festgelegt, beträgt der Standardwert 100. Wenn der Wert 0 angegeben wird, wird der Standardwert verwendet. Der Höchstwert beträgt 5.000. Jeder Wert über 5.000 wird auf 5.000 festgelegt.
page_token

string

Optional. Ein Seitentoken, das von einem vorherigen ListSelectedRoutes-Aufruf empfangen wurde.

ListSelectedRoutesResponse

Antwort mit einer Liste von SelectedRoute.

Felder
selected_routes[]

SelectedRoute

Eine Seite mit SelectedRoutes, die im im Antrag angegebenen Projekt gespeichert ist.
next_page_token

string

Token, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld leer ist, gibt es keine nachfolgenden Seiten.

SelectedRoute

Eine „SelectedRoute“ stellt eine bestimmte Route dar, für die ein Kunde regelmäßig Informationen (z.B. Dauer) für vertraglich vereinbarte Anwendungsfälle abrufen möchte.

Felder
name

string

ID. Ressourcenname von SelectedRoute.

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

string

Optional. Anzeigename der Route. Dieses Feld ist optional und kann vom Kunden verwendet werden. Er muss nicht eindeutig sein.
create_time

Timestamp

Nur Ausgabe. Gibt an, wann die ausgewählte Route zum ersten Mal erstellt wurde.
state

State

Nur Ausgabe. Der Status der ausgewählten Route.
route_attributes

map<string, string>

Optional. Die benutzerdefinierten Attribute für die ausgewählte Route. Wenn Sie sie hinzufügen, können die Routen beim Abrufen von Verlaufs- und Echtzeitinformationen gefiltert bzw. gruppiert werden. Pro Route werden bis zu 10 Attribute unterstützt. Jeder Schlüssel und Wert muss ein nicht leerer String sein und darf bis zu 100 Zeichen enthalten. Die Schlüssel dürfen nicht mit „goog“ beginnen.
Union-Feld route_type. Derzeit wird nur DynamicRoute unterstützt. Für route_type ist nur einer der folgenden Werte zulässig:
dynamic_route

DynamicRoute

SelectedRoute ist eine dynamische Route.
validation_error

ValidationError

Nur Ausgabe. Der Validierungsfehler für die ausgewählte Route, wenn der Status STATE_INVALID ist.

DynamicRoute

Dies entspricht einer Route mit Wegpunkten (Start-, Ziel- und Zwischenpunkte). Die tatsächliche Route führt garantiert über alle Wegpunkte, kann sich aber aufgrund der sich ändernden Verkehrslage von Zeit zu Zeit ändern.

Felder
origin

LatLng

Erforderlich. Startort der Route.
destination

LatLng

Erforderlich. Endpunkt der Route.
intermediates[]

LatLng

Optional. Eine Reihe von Wegpunkten entlang der Route (ohne Endpunkte). Es handelt sich immer um Durchgangspunkte. Es werden bis zu 25 Wegpunkte unterstützt. Wenn Sie sie richtig hinzufügen, kann die Abweichung der tatsächlichen Route von Zeit zu Zeit verringert werden.

Status

Der Status der ausgewählten Route.

Enums
STATE_UNSPECIFIED Der Status dieser Route ist nicht festgelegt.
STATE_SCHEDULING Die Route wurde erstellt und wird geplant.
STATE_RUNNING Die Route wurde erstellt und hat einen aktiven Zeitplan.
STATE_DELETING Die Route wurde zum Löschen markiert.
STATE_VALIDATING Die Route wird gerade validiert.
STATE_INVALID Die Route ist aufgrund eines der Validierungskriterien ungültig.

ValidationError

Der Validierungsfehler für die ausgewählte Route.

Enums
VALIDATION_ERROR_UNSPECIFIED Der Validierungsfehler dieser Route ist nicht festgelegt.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION Die Route liegt außerhalb des Zuständigkeitsbereichs des Projekts.
VALIDATION_ERROR_LOW_ROAD_USAGE Die Straße wird nur wenig befahren.