REST Resource: selection.v1.projects.selectedRoutes

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

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "state": enum (State),
  "routeAttributes": {
    string: string,
    ...
  },

  // Union field route_type can be only one of the following:
  "dynamicRoute": {
    object (DynamicRoute)
  }
  // End of list of possible types for union field route_type.
  "validationError": enum (ValidationError)
}
Felder
name

string

ID. Ressourcenname von SelectedRoute.

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

string

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

string (Timestamp format)

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

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
state

enum (State)

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

map (key: string, value: 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.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Union-Feld route_type. Derzeit wird nur DynamicRoute unterstützt. Für route_type ist nur einer der folgenden Werte zulässig:
dynamicRoute

object (DynamicRoute)

SelectedRoute ist eine dynamische Route.
validationError

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

JSON-Darstellung 
{
  "origin": {
    object (LatLng)
  },
  "destination": {
    object (LatLng)
  },
  "intermediates": [
    {
      object (LatLng)
    }
  ]
}
Felder
origin

object (LatLng)

Erforderlich. Startort der Route.
destination

object (LatLng)

Erforderlich. Endpunkt der Route.
intermediates[]

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

LatLng

Ein Objekt, das ein Paar aus Breiten- und Längengrad darstellt. Es wird als Paar aus Werten vom Typ „Double“ (Breiten- und Längengrad) ausgedrückt. Sofern nicht anders angegeben, muss dieses Objekt dem WGS84-Standard entsprechen. Die Werte müssen innerhalb normalisierter Bereiche liegen.

JSON-Darstellung 
{
  "latitude": number,
  "longitude": number
}
Felder
latitude

number

Der Breitengrad in Grad. Er muss im Bereich [-90,0, +90,0] liegen.
longitude

number

Der Längengrad in Grad. Er muss im Bereich [-180,0, +180,0] liegen.

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.

Methoden

batchCreate

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

create

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

delete

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

get

 Ruft eine SelectedRoute anhand ihres Namens ab.

list

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