REST Resource: projects.trips

Risorsa: Trip

Un viaggio.

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

string

Solo output. Identificatore. Il nome della risorsa del viaggio. Formato: projects/{project_number}/trips/{tripId}.

config

object (TripConfig)

Immutabile. La configurazione del viaggio.

androidAppId

string

Solo input. Immutabile. L'ID applicazione dell'app per Android che utilizzerà il viaggio. È necessario impostare almeno uno tra androidAppId e iosAppId.

iosAppId

string

Solo input. Immutabile. L'ID pacchetto iOS dell'applicazione mobile che utilizzerà il viaggio. È necessario impostare almeno uno tra androidAppId e iosAppId.

authToken

object (AuthToken)

Solo output. Un token opaco che autorizza l'accesso per iniziare un viaggio NavConnect in Google Maps o Waze e concede a queste applicazioni l'accesso per aggiornare il viaggio. Restituiti solo da trips.create.

state

enum (State)

Solo output. Lo stato del viaggio.

execution

object (TripExecution)

Solo output. Gli ultimi dati sull'esecuzione del viaggio. Questo valore potrebbe non essere impostato se il viaggio è in stato di errore.

createTime

string (Timestamp format)

Solo output. Ora in base al server in cui è stato creato il viaggio.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Solo output. Ora in cui il server ha ricevuto l'ultimo aggiornamento del viaggio.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

TripConfig

Configurazione del viaggio.

Rappresentazione JSON
{
  "enableHighFrequencyUpdates": boolean,
  "enablePubsub": boolean,
  "pubsubFieldMask": string,
  "enableRemainingRouteReporting": boolean
}
Campi
enableHighFrequencyUpdates

boolean

Facoltativo. Se abilitare gli aggiornamenti del viaggio ad alta frequenza.

NOTA: l'attivazione di questa funzionalità registra il viaggio nell'utilizzo del livello Enterprise ed è soggetta alle tariffe del livello Enterprise.

enablePubsub

boolean

Facoltativo. Indica se attivare le notifiche Pub/Sub per il viaggio.

pubsubFieldMask

string (FieldMask format)

Facoltativo. Se impostato, nelle notifiche pub/sub verrà incluso solo il sottoinsieme specificato dei campi del viaggio.

Se non è impostato, tutti i campi del viaggio verranno inclusi nelle notifiche pub/sub (comportamento predefinito).

I seguenti campi non sono supportati:

  • androidAppId
  • iosAppId
  • authToken
  • config

NOTA: questo campo viene ignorato se enablePubsub è false.

Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: "user.displayName,photo".

enableRemainingRouteReporting

boolean

Facoltativo. Indica se attivare i report sul percorso rimanente per il viaggio.

NOTA: l'attivazione di questa funzionalità registra il viaggio nell'utilizzo del livello Enterprise ed è soggetta alle tariffe del livello Enterprise.

AuthToken

Un token di autenticazione.

Rappresentazione JSON
{
  "token": string,
  "expireTime": string
}
Campi
token

string

Solo output. Il token di autenticazione da passare all'applicazione mobile.

expireTime

string (Timestamp format)

Solo output. Ora in cui il token di autenticazione scadrà.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

Stato

Tutti i possibili stati della corsa.

Enum
STATE_UNSPECIFIED Lo stato del viaggio non è specificato.
NEW Il viaggio è stato creato, ma non è ancora iniziato.
ENROUTE Il trasportatore è in viaggio verso la destinazione.
ARRIVED Il trasportatore è arrivato a destinazione.
SUSPENDED Il viaggio è stato sospeso.
FAILED Il viaggio non è stato completato correttamente.
CLIENT_ERROR Il viaggio non è andato a buon fine a causa di un errore del client.
CANCELED Il viaggio è stato annullato esplicitamente dallo sviluppatore.

TripExecution

Dati sull'esecuzione del viaggio.

Rappresentazione JSON
{
  "origin": {
    object (Location)
  },
  "destination": {
    object (Stop)
  },
  "location": {
    object (Location)
  },
  "remainingRoute": {
    object (Route)
  },
  "traveledDuration": string,
  "remainingDuration": string,
  "traveledDistanceMeters": integer,
  "remainingDistanceMeters": integer,
  "stopAddedInRoute": boolean
}
Campi
origin

object (Location)

Solo output. Origine del viaggio, che in genere è la posizione del trasportatore all'inizio del viaggio NavConnect.

destination

object (Stop)

Solo output. La destinazione del viaggio segnalata dall'applicazione mobile.

location

object (Location)

Solo output. Il segnale di localizzazione che rappresenta l'ultima posizione nota del trasportatore. Se disponibile, questa sarà la posizione agganciata alla strada.

remainingRoute

object (Route)

Solo output. Fornisce la polilinea per la parte rimanente del percorso.

traveledDuration

string (Duration format)

Solo output. Tempo di viaggio finora.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".

remainingDuration

string (Duration format)

Solo output. Tempo rimanente del viaggio stimato da Google.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".

traveledDistanceMeters

integer

Solo output. Distanza percorsa dall'origine in metri.

remainingDistanceMeters

integer

Solo output. Distanza rimanente dalla destinazione in metri.

stopAddedInRoute

boolean

Solo output. Indica se è stata aggiunta una fermata lungo il percorso.

Località

Una posizione segnalata dall'applicazione mobile.

Rappresentazione JSON
{
  "point": {
    object (LatLng)
  },
  "sourceTime": string,
  "serverTime": string
}
Campi
point

object (LatLng)

Solo output. Latitudine/longitudine della posizione.

sourceTime

string (Timestamp format)

Solo output. L'ora in cui è stata recuperata la posizione, come indicato dal cliente.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

serverTime

string (Timestamp format)

Solo output. L'ora in cui il server ha ricevuto questo aggiornamento della posizione.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

LatLng

Un oggetto che rappresenta una coppia latitudine/longitudine. Questi valori sono espressi come una coppia di numeri double per rappresentare i gradi di latitudine e longitudine. Se non diversamente specificato, questo oggetto deve essere conforme allo standard WGS84. I valori devono rientrare negli intervalli normalizzati.

Rappresentazione JSON
{
  "latitude": number,
  "longitude": number
}
Campi
latitude

number

La latitudine in gradi. Deve essere compreso nell'intervallo [-90,0, +90,0].

longitude

number

La longitudine in gradi. Deve essere compreso nell'intervallo [-180,0, +180,0].

Interrompi

Una fermata del viaggio in cui deve essere eseguita un'attività.

Rappresentazione JSON
{
  "point": {
    object (LatLng)
  }
}
Campi
point

object (LatLng)

Obbligatorio. La posizione della fermata come latitudine/longitudine.

Route

Una polilinea dell'itinerario.

Rappresentazione JSON
{
  "trafficInformation": [
    {
      object (SpeedReadingInterval)
    }
  ],

  // Union field format can be only one of the following:
  "simplePolyline": {
    object (SimplePolyline)
  },
  "encodedPolyline": string,
  "s2Polyline": string,
  "geoJson": {
    object
  }
  // End of list of possible types for union field format.
}
Campi
trafficInformation[]

object (SpeedReadingInterval)

Solo output. Informazioni sul traffico sulla polilinea descritta come intervalli di lettura della velocità.

NOTE:

  • Gli intervalli non si sovrappongono.
  • Gli intervalli sono contigui.
  • Gli intervalli coprono l'intera polilinea.
  • Gli intervalli sono ordinati in base all'indice crescente.
  • La velocità è specificata per ogni intervallo.

Campo unione format. Il formato della route.

Il formato compilato è controllato dal parametro route_polyline_format. Se non viene impostato, il valore predefinito è una polilinea semplice. format può essere solo uno dei seguenti tipi:

simplePolyline

object (SimplePolyline)

Solo output. Il percorso come semplice elenco di latlng.

encodedPolyline

string

Solo output. Il percorso come polilinea codificata. Consulta https://developers.google.com/maps/documentation/utilities/polylinealgorithm.

s2Polyline

string (bytes format)

Solo output. Il percorso come S2Polyline codificata. Vedi https://s2geometry.io/devguide/basic_types.html.

Una stringa con codifica in base64.

geoJson

object (Struct format)

Solo output. Il percorso come LineString GeoJSON. Vedi https://tools.ietf.org/html/rfc7946#section-3.1.4.

SimplePolyline

Rappresenta una polilinea utilizzando un semplice elenco di punti.

Rappresentazione JSON
{
  "points": [
    {
      object (LatLng)
    }
  ]
}
Campi
points[]

object (LatLng)

Solo output. Elenco ordinato di punti che rappresentano la polilinea.

SpeedReadingInterval

Indicatore della densità del traffico su un segmento contiguo di un percorso. Dato un percorso con punti P_0, P_1, ... , P_N (indice basato su zero), SpeedReadingInterval definisce un intervallo e descrive il relativo traffico utilizzando le categorie Speed.

Rappresentazione JSON
{
  "speed": enum (Speed),
  "startPolylinePointIndex": integer,
  "endPolylinePointIndex": integer
}
Campi
speed

enum (Speed)

Solo output. Velocità del traffico in questo intervallo.

startPolylinePointIndex

integer

Solo output. L'indice iniziale di questo intervallo nel percorso.

endPolylinePointIndex

integer

Solo output. L'indice finale di questo intervallo nel percorso.

Velocità

La classificazione della velocità della polilinea in base ai dati sul traffico.

Enum
SPEED_UNSPECIFIED La velocità non è specificata.
NORMAL Velocità normale, nessun ritardo dovuto al traffico.
SLOW Rallentamento rilevato, volume di traffico da basso a medio.
TRAFFIC_JAM Rallentamenti dovuti al traffico, inclusi i casi di coda.

Metodi

create

Crea un viaggio.

get

Riceve un viaggio.