REST Resource: projects.trips

Ressource: Fahrt

Eine Fahrt.

JSON-Darstellung
{
  "name": string,
  "config": {
    object (TripConfig)
  },
  "androidAppId": string,
  "iosAppId": string,
  "authToken": {
    object (AuthToken)
  },
  "state": enum (State),
  "execution": {
    object (TripExecution)
  },
  "createTime": string,
  "updateTime": string
}
Felder
name

string

Nur Ausgabe. ID. Der Ressourcenname der Fahrt. Format: projects/{project_number}/trips/{tripId}.

config

object (TripConfig)

Nicht veränderbar. Die Konfiguration für die Fahrt.

androidAppId

string

Nur Eingabe. Nicht veränderbar. Die Android-App-ID der mobilen App, die die Fahrt nutzen wird. Es muss mindestens androidAppId oder iosAppId festgelegt werden.

iosAppId

string

Nur Eingabe. Nicht veränderbar. Die iOS-Paket-ID der mobilen App, die die Fahrt verwenden wird. Es muss mindestens androidAppId oder iosAppId festgelegt werden.

authToken

object (AuthToken)

Nur Ausgabe. Ein vertrauliches Token, das den Zugriff zum Starten einer NavConnect-Fahrt in Google Maps oder Waze autorisiert und diesen Anwendungen Zugriff zum Aktualisieren der Fahrt gewährt. Wird nur von trips.create zurückgegeben.

state

enum (State)

Nur Ausgabe. Der Status der Fahrt.

execution

object (TripExecution)

Nur Ausgabe. Die neuesten Daten zur Ausführung der Fahrt. Dieser Wert kann nicht festgelegt werden, wenn sich die Fahrt in einem Fehlerstatus befindet.

createTime

string (Timestamp format)

Nur Ausgabe. Die Uhrzeit, zu der die Fahrt auf dem Server 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"

updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem der Server die letzte Aktualisierung der Fahrt empfangen hat.

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

TripConfig

Konfiguration für die Fahrt.

JSON-Darstellung
{
  "enableHighFrequencyUpdates": boolean,
  "enablePubsub": boolean,
  "pubsubFieldMask": string
}
Felder
enableHighFrequencyUpdates

boolean

Optional. Gibt an, ob häufige Aktualisierungen von Fahrten aktiviert werden sollen.

HINWEIS: Wenn Sie diese Funktion aktivieren, wird die Fahrt unter der Nutzung der Enterprise-Stufe protokolliert und unterliegt den Tarifen der Enterprise-Stufe.

enablePubsub

boolean

Optional. Gibt an, ob Pub/Sub-Benachrichtigungen für die Fahrt aktiviert werden sollen.

pubsubFieldMask

string (FieldMask format)

Optional. Wenn diese Option festgelegt ist, wird nur die angegebene Teilmenge der Trip-Felder in die Pub/Sub-Benachrichtigungen aufgenommen.

Wenn nicht festgelegt, werden alle Felder des Typs „Trip“ in die Pub/Sub-Benachrichtigungen aufgenommen (Standardverhalten).

Die folgenden Felder werden nicht unterstützt:

  • androidAppId
  • iosAppId
  • authToken
  • config

HINWEIS: Dieses Feld wird ignoriert, wenn enablePubsub „false“ ist.

Dies ist eine durch Kommas getrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".

AuthToken

Ein Authentifizierungstoken.

JSON-Darstellung
{
  "token": string,
  "expireTime": string
}
Felder
token

string

Nur Ausgabe. Das Authentifizierungstoken, das an die mobile App übergeben werden soll.

expireTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem das Authentifizierungstoken abläuft.

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

Bundesland

Alle möglichen Fahrtstatus.

Enums
STATE_UNSPECIFIED Der Status der Fahrt ist nicht angegeben.
NEW Die Fahrt wurde erstellt, hat aber noch nicht begonnen.
ENROUTE Der Transporteur ist auf dem Weg zum Ziel.
ARRIVED Der Transporteur ist am Zielort angekommen.
SUSPENDED Die Reise wurde unterbrochen.
FAILED Die Fahrt konnte nicht abgeschlossen werden.
CLIENT_ERROR Die Fahrt ist aufgrund eines Clientfehlers fehlgeschlagen.

TripExecution

Daten zur Ausführung der Fahrt.

JSON-Darstellung
{
  "origin": {
    object (Location)
  },
  "destination": {
    object (Stop)
  },
  "location": {
    object (Location)
  },
  "traveledDuration": string,
  "remainingDuration": string,
  "traveledDistanceMeters": integer,
  "remainingDistanceMeters": integer,
  "stopAddedInRoute": boolean
}
Felder
origin

object (Location)

Nur Ausgabe. Der Ausgangspunkt der Fahrt, der in der Regel der Standort des Transportunternehmens zu Beginn der NavConnect-Fahrt ist.

destination

object (Stop)

Nur Ausgabe. Das von der mobilen App gemeldete Ziel der Fahrt.

location

object (Location)

Nur Ausgabe. Das Standortsignal, das den letzten bekannten Standort des Transporteurs darstellt. Dies ist der auf die Straße ausgerichtete Standort, sofern verfügbar.

traveledDuration

string (Duration format)

Nur Ausgabe. Bisher zurückgelegte Zeit.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".

remainingDuration

string (Duration format)

Nur Ausgabe. Die von Google geschätzte verbleibende Zeit für diese Fahrt.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".

traveledDistanceMeters

integer

Nur Ausgabe. Zurückgelegte Entfernung vom Ursprung in Metern.

remainingDistanceMeters

integer

Nur Ausgabe. Verbleibende Entfernung zum Ziel in Metern.

stopAddedInRoute

boolean

Nur Ausgabe. Gibt an, ob der Route ein Zwischenstopp hinzugefügt wurde.

Standort

Ein Standort, der von der mobilen Anwendung gemeldet wird.

JSON-Darstellung
{
  "point": {
    object (LatLng)
  },
  "sourceTime": string,
  "serverTime": string
}
Felder
point

object (LatLng)

Nur Ausgabe. Breiten-/Längengrad des Standorts

sourceTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem der Standort ermittelt wurde, wie vom Client angegeben.

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"

serverTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem der Server dieses Standort-Update empfangen hat.

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

LatLng

Ein Objekt, das ein Paar aus Breiten- und Längengrad darstellt. Dies 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.

Beenden

Ein Stopp auf der Fahrt, an dem eine Aufgabe ausgeführt werden soll.

JSON-Darstellung
{
  "point": {
    object (LatLng)
  }
}
Felder
point

object (LatLng)

Erforderlich. Der Standort der Haltestelle als Breiten-/Längengrad.

Methoden

create

Erstellt eine Reise.

get

Ruft eine Fahrt ab.