Introduzione a Fleet Engine

L'API Fleet Engine On-demand Rides and Deliveries consente di gestire le corse e lo stato dei veicoli per le applicazioni trip and Order Progress. Gestisce le transazioni tra l'SDK Driver, l'SDK Consumer e il servizio di backend, che può comunicare con Fleet Engine effettuando chiamate gRPC o REST.

Prerequisiti

Per lo sviluppo, assicurati di installare Cloud SDK (gcloud) e di eseguire l'autenticazione al tuo progetto.

Nota: valuta la possibilità di utilizzare l'ambiente interattivo Cloud Shell in cui sono già installati Cloud SDK e altre dipendenze, come curl. Vedi Utilizzo di Cloud Shell.

shell

gcloud auth login

Dovresti vedere un messaggio che indica che l'operazione è riuscita, ad esempio:

You are now logged in as [[e-mail]].
Your current project is [project-id].  You ...

Nota: modifica i valori delle variabili nei blocchi di codice per preparare i comandi successivi in modo che possano essere copiati e incollati direttamente.

Verifica che le API On-demand Rides and Deliveries Solution Fleet Engine siano configurate correttamente.

shell

gcloud --project=project-id services enable fleetengine.googleapis.com

Se questo comando genera un errore, contatta l'amministratore del progetto e il rappresentante dell'assistenza Google per ottenere l'accesso.

Logging

Fleet Engine può scrivere messaggi di log sulle chiamate API che riceve nei log della piattaforma Google Cloud. Consulta la documentazione di Cloud Logging per una panoramica su come leggere e analizzare i log.

Il logging potrebbe non essere abilitato per impostazione predefinita per i progetti creati prima del 10 febbraio 2022. Per ulteriori dettagli, consulta la documentazione di logging.

Librerie client

Pubblichiamo le librerie client in diversi linguaggi di programmazione comuni. Queste librerie contribuiranno a offrire agli sviluppatori un'esperienza migliore rispetto a REST o gRPC non elaborati. Per istruzioni su come ottenere le librerie client per la tua applicazione server, consulta Librerie client.

Gli esempi Java in questa documentazione presuppongono familiarità con gRPC.

Autenticazione e autorizzazione

Puoi configurare le funzionalità fornite da Avanzamento dei viaggi e degli ordini tramite Google Cloud Console. Queste API e questi SDK richiedono l'utilizzo di token web JSON firmati utilizzando account di servizio creati dalla console Cloud.

Configurazione del progetto Cloud

Per configurare il progetto cloud, crea prima il progetto, quindi crea gli account di servizio.

Per creare il tuo progetto Google Cloud:

1. Creare un progetto Google Cloud utilizzando la console Google Cloud.
2. Utilizzando la dashboard delle API e dei servizi, abilita l'API Local Rides and Deliveries.

Gli account di servizio sono associati a uno o più ruoli. Vengono utilizzati per creare token web JSON che concedono diversi set di autorizzazioni a seconda dei ruoli. In genere, per ridurre le possibilità di comportamenti illeciti, puoi creare più account di servizio, ciascuno con il set minimo di ruoli richiesto.

Lo stato di avanzamento dei viaggi e degli ordini utilizza i seguenti ruoli:

Ruolo	Descrizione
Utente SDK consumer di Fleet Engine roles/fleetengine.consumerSdkUser	Concede l'autorizzazione per cercare veicoli e recuperare informazioni su veicoli e corse. I token creati da un account di servizio con questo ruolo vengono in genere utilizzati dai dispositivi mobili delle app consumer per la consegna o il ridesharing.
Utente SDK driver Fleet Engine roles/fleetengine.driverSdkUser	Concede l'autorizzazione per aggiornare la posizione e i percorsi dei veicoli, nonché per recuperare informazioni su veicoli e corse. I token creati da un account di servizio con questo ruolo vengono in genere utilizzati dai dispositivi mobili dell'app di ridesharing o del fattorino.
Amministratore on demand di Fleet Engine roles/fleetengine.ondemandAdmin	Concede l'autorizzazione di lettura e scrittura per tutte le risorse per veicoli e viaggi. Le entità con questo ruolo non hanno bisogno di utilizzare JWT e devono invece utilizzare le credenziali predefinite dell'applicazione. Le rivendicazioni JWT personalizzate vengono ignorate. Questo ruolo deve essere limitato agli ambienti attendibili (backend del cliente).
Super user servizio Fleet Engine **(OBSOLETO)** roles/fleetengine.serviceSuperUser	Concede l'autorizzazione a tutti i veicoli e le API di viaggio. I token creati da un account di servizio con questo ruolo vengono in genere utilizzati dai server di backend. Questo ruolo è obsoleto. Preferisci invece roles/fleetengine.ondemandAdmin.

Ad esempio, puoi creare un account di servizio per ciascuno dei tre ruoli e assegnargli i rispettivi ruoli.

gcloud --project=project-id iam service-accounts create fleet-engine-consumer-sdk
gcloud projects add-iam-policy-binding project-id \
       --member=serviceAccount:[e-mail] \
       --role=roles/fleetengine.consumerSdkUser

gcloud --project=project-id iam service-accounts create fleet-engine-driver-sdk
gcloud projects add-iam-policy-binding project-id \
       --member=serviceAccount:[e-mail] \
       --role=roles/fleetengine.driverSdkUser

gcloud --project=project-id iam service-accounts create fleet-engine-su
gcloud projects add-iam-policy-binding project-id \
       --member=serviceAccount:[e-mail] \
       --role=roles/fleetengine.serviceSuperUser

Gli SDK Driver e Consumer si basano su questi ruoli standard.

In alternativa, è possibile creare ruoli personalizzati che consentono di raggruppare un set arbitrario di autorizzazioni. Gli SDK Driver e Consumer mostrano messaggi di errore ogni volta che manca un'autorizzazione richiesta. Di conseguenza, consigliamo vivamente di utilizzare l'insieme standard di ruoli presentato in precedenza e di non utilizzare i ruoli personalizzati.

Per praticità, se hai bisogno di creare token JWT per client non attendibili, l'aggiunta di utenti al ruolo Creatore token account di servizio consente loro di creare token con gli strumenti a riga di comando gcloud.

gcloud projects add-iam-policy-binding project-id \
       --member=user:[e-mail] \
       --role=roles/iam.serviceAccountTokenCreator

Dove [e-mail] è l'email utilizzata per l'autenticazione con gcloud (gcloud auth list --format='value(account)').

Nota: questa operazione concede al beneficiario l'autorizzazione a impersonare qualsiasi account di servizio nel progetto. Per impostare autorizzazioni più granulari, segui la documentazione di IAM sulla limitazione delle associazioni dei ruoli per un account di servizio specifico.

Libreria di autenticazione di Fleet Engine

Fleet Engine utilizza token web JSON (JWT) per limitare l'accesso alle API di Fleet Engine. La nuova libreria di autenticazione Fleet Engine, disponibile su GitHub, semplifica la creazione dei JWT di Fleet Engine e li firma in modo sicuro.

La libreria offre i seguenti vantaggi:

• Semplifica il processo di creazione dei token Fleet Engine.
• Fornisce meccanismi di firma dei token diversi dall'utilizzo di file di credenziali (ad esempio l'identità di un account di servizio).
• Collega i token firmati alle richieste in uscita effettuate da uno stub gRPC o da un client GAPIC.

Importante: ti consigliamo vivamente di utilizzare la libreria di autenticazione di Fleet Engine con tutte le implementazioni Java.

Creazione di un token web JSON (JWT) per l'autorizzazione

Quando non utilizzi la libreria di autenticazione Fleet Engine, i token web JSON (JWT) devono essere creati direttamente nel codebase. Per questo devi avere una conoscenza approfondita dei JWT e della loro relazione con Fleet Engine. Per questo consigliamo VIVAMENTE di sfruttare la libreria di autenticazione di Fleet Engine.

All'interno di Fleet Engine, i token JWT (JSON Web Token) forniscono l'autenticazione di breve durata e assicurano che i dispositivi possano modificare solo veicoli, corse o attività per i quali sono autorizzati. I JWT contengono un'intestazione e una sezione di attestazione. La sezione dell'intestazione contiene informazioni come la chiave privata da utilizzare (ottenuta dagli account di servizio) e l'algoritmo di crittografia. La sezione dell'attestazione contiene informazioni come l'ora di creazione del token, la durata (TTL) dei token, i servizi per i quali sta richiedendo l'accesso e altre informazioni sull'autorizzazione per limitare l'accesso, ad esempio l'ID veicolo.

Una sezione dell'intestazione JWT contiene i seguenti campi:

Campo	Descrizione
alg	L'algoritmo da utilizzare. "RS256".
typ	Il tipo di token. "JWT".
bambino	L'ID della chiave privata dell'account di servizio. Puoi trovare questo valore nel campo "private_key_id" del file JSON dell'account di servizio. Assicurati di utilizzare una chiave di un account di servizio con il livello di autorizzazioni corretto.

Una sezione delle attestazioni JWT contiene i seguenti campi:

Campo	Descrizione
iss	L'indirizzo email del tuo account di servizio.
Pub/Sub.	L'indirizzo email del tuo account di servizio.
aud	Il SERVICE_NAME del tuo account di servizio, in questo caso https://fleetengine.googleapis.com/
iat	Il timestamp di creazione del token, specificato in secondi trascorsi dalle ore 00:00:00 UTC del 1° gennaio 1970. Attendi 10 minuti per il disallineamento. Se il timestamp è troppo lontano nel passato o nel futuro, il server potrebbe segnalare un errore.
exp	Il timestamp di scadenza del token, specificato in secondi trascorsi dalle ore 00:00:00 UTC del 1° gennaio 1970. La richiesta non va a buon fine se il timestamp è lontano da più di un'ora.
authorization	A seconda del caso d'uso, può contenere "vehicleid" o "tripid".

La creazione di un token JWT si riferisce alla firma del token. Per istruzioni ed esempi di codice per la creazione e la firma del JWT, consulta Autorizzazione dell'account di servizio senza OAuth. Puoi quindi collegare un token firmato alle chiamate gRPC o ad altri metodi utilizzati per accedere a Fleet Engine.

Attestazioni JWT

Quando crei il payload JWT, aggiungi un'altra dichiarazione nella sezione dell'autorizzazione con la chiave vehicleid o tripid impostata sul valore dell'ID veicolo o dell'ID corsa per cui viene effettuata la chiamata.

L'SDK Driver utilizza sempre la dichiarazione vehicleid, sia durante la corsa sia durante l'utilizzo di un veicolo. Il backend di Fleet Engine assicura che il veicolo sia associato alla corsa richiesta prima di apportare la modifica.

L'SDK consumer utilizza sempre la dichiarazione tripid.

Il Fornitore di servizi di ridesharing o di consegna deve utilizzare vehicleid o tripid con l'asterisco (*) per indicare tutti i Veicoli e i Viaggi. Tieni presente che il JWT può contenere entrambi i token, anche se non richiesti, il che può semplificare l'implementazione della firma dei token.

Casi d'uso di JWT

Di seguito è riportato un token di esempio per Provider server:

{
  "alg": "RS256",
  "typ": "JWT",
  "kid": "private_key_id_of_provider_service_account"
}
.
{
  "iss": "[e-mail]",
  "sub": "[e-mail]",
  "aud": "https://fleetengine.googleapis.com/",
  "iat": 1511900000,
  "exp": 1511903600,
  "authorization": {
     "vehicleid": "*",
     "tripid": "*"
   }
}

Di seguito è riportato un token di esempio per App consumer:

{
  "alg": "RS256",
  "typ": "JWT",
  "kid": "private_key_id_of_consumer_service_account"
}
.
{
  "iss": "[e-mail]",
  "sub": "[e-mail]",
  "aud": "https://fleetengine.googleapis.com/",
  "iat": 1511900000,
  "exp": 1511903600,
  "authorization": {
     "tripid": "trip_54321"
   }
}

Di seguito è riportato un token di esempio per l'app Driver:

{
  "alg": "RS256",
  "typ": "JWT",
  "kid": "private_key_id_of_driver_service_account"
}
.
{
  "iss": "[e-mail]",
  "sub": "[e-mail]",
  "aud": "https://fleetengine.googleapis.com/",
  "iat": 1511900000,
  "exp": 1511903600,
  "authorization": {
     "vehicleid": "driver_12345"
   }
}

• Per il campo kid nell'intestazione, specifica l'ID della chiave privata dell'account di servizio. Puoi trovare questo valore nel campo private_key_id del file JSON dell'account di servizio.
• Per i campi iss e sub, specifica l'indirizzo email del tuo account di servizio. Puoi trovare questo valore nel campo client_email del file JSON dell'account di servizio.
• Per il campo aud, specifica https://SERVICE_NAME/.
• Per il campo iat, utilizza il timestamp al momento della creazione del token, specificato come secondi trascorsi dalle ore 00:00:00 UTC del 1° gennaio 1970. Attendi 10 minuti per il disallineamento. Se il timestamp è troppo distante nel passato o nel futuro, il server potrebbe segnalare un errore.
• Per il campo exp, utilizza il timestamp alla scadenza del token, specificato in secondi a partire dalle ore 00:00:00 UTC, 1° gennaio 1970. Il valore massimo consentito è iat + 3600.

Quando firmi il JWT da trasmettere a un dispositivo mobile, assicurati di utilizzare l'account di servizio per il ruolo SDK Driver o Consumer. In caso contrario, il dispositivo mobile avrà la possibilità di modificare lo stato che non dovrebbe avere.

Allo stesso modo, quando firmi il JWT da utilizzare per le chiamate con privilegi, assicurati di utilizzare l'account di servizio con il ruolo super utente. In caso contrario, l'operazione non riuscirà.

Generazione di un JWT per i test

La generazione di token dal terminale può essere utile durante i test.

Per seguire questi passaggi, il tuo account utente deve avere il ruolo Creatore token account di servizio:

gcloud projects add-iam-policy-binding project-id \
       --member=user:[e-mail] \
       --role=roles/iam.serviceAccountTokenCreator

Crea un nuovo file denominato unsigned_token.json con i contenuti seguenti. La proprietà iat indica l'ora attuale in secondi dopo l'epoca, che può essere recuperata eseguendo date +%s nel terminale. La proprietà exp rappresenta il tempo di scadenza in secondi dopo l'epoca, che può essere calcolato aggiungendo 3600 a iat. La scadenza non può superare un'ora nel futuro.

{
  "aud": "https://fleetengine.googleapis.com/",
  "iss": "[e-mail]",
  "sub": "[e-mail]",
  "iat": iat,
  "exp": exp,
  "authorization": {
     "vehicleid": "*",
     "tripid": "*"
   }
}

Quindi esegui questo comando gcloud per firmare il token per conto del tuo account di servizio Super User:

gcloud beta iam service-accounts sign-jwt --iam-account=[e-mail] unsigned_token.json signed_token.jwt

Ora all'interno del file signed_token.jwt dovrebbe essere archiviato un JWT con codifica Base64 firmato. Il token è valido per la prossima ora.

Ora puoi testare il token eseguendo un comando curl sull'endpoint REST Elenco veicoli:

curl -X GET "https://fleetengine.googleapis.com/v1/providers/project-id/vehicles" -H "Authorization: Bearer $(cat signed_token.jwt)"

Veicoli e relativo ciclo di vita

Un veicolo è l'entità che rappresenta una coppia conducente-veicolo. Al momento, un conducente e un veicolo non possono essere monitorati separatamente. Il fornitore di servizi di ridesharing o di consegna crea un veicolo utilizzando un ID fornitore (che deve corrispondere all'ID progetto del progetto Google Cloud che contiene l'account di servizio utilizzato per chiamare le API Fleet Engine) e un ID veicolo di proprietà del fornitore di servizi di ridesharing o di consegna.

Un veicolo che non è stato aggiornato tramite UpdateVehicle dopo sette giorni verrà eliminato automaticamente. È un errore chiamare CreateVehicle con una coppia ID provider/ID veicolo già esistente. Il caso di veicoli che non vengono aggiornati di frequente può essere gestito in due modi: chiamando frequentemente CreateVehicle con una coppia ID provider/ID veicolo prevista e ignorando l'errore se il veicolo esiste già; oppure chiamando CreateVehicle dopo che UpdateVehicle torna con un errore NOT_FOUND.

Aggiornamenti sulla posizione dei veicoli

Per ottenere le migliori prestazioni con Fleet Engine, fornisci un flusso di aggiornamenti sulla posizione dei veicoli. Per fornire questi aggiornamenti, utilizza uno dei seguenti metodi:

1. Utilizza Driver SDK - Android, iOS, l'opzione più semplice.
2. Utilizza codice personalizzato, utile se le posizioni vengono inoltrate attraverso il backend o se usi dispositivi diversi da Android o iOS.

Tipi di veicoli

L'entità Veicolo contiene un campo obbligatorio VehicleType, che contiene un enum Category che può essere specificato come AUTO, TAXI, TRUCK, TWO_WHEELER, BICYCLE o PEDESTRIAN. Il tipo di veicolo può essere utilizzato come criterio di filtro in SearchVehicles e ListVehicles.

Tutti i percorsi per i veicoli utilizzeranno il valore RouteTravelMode corrispondente se la categoria è impostata su AUTO, TWO_WHEELER, BICYCLE o PEDESTRIAN. Se la categoria è impostata su TAXI o TRUCK, il routing viene considerato come la modalità AUTO.

Attributi veicolo

L'entità Vehicle contiene un campo ripetuto di VehicleAttribute. Questi attributi non sono interpretati da Fleet Engine. L'API SearchVehicles include un campo per richiedere che il valore Vehicles corrispondente debba contenere tutti gli attributi inclusi impostati sul valore specificato.

Tieni presente che il campo dell'attributo si aggiunge a diversi altri campi supportati nel messaggio Vehicle, come vehicle_type e supported_trip_types.

Tappe restanti del veicolo

L'entità Veicolo contiene un campo ripetuto di TripWaypoint (RPC | REST), denominato waypoints(RPC | REST). Questo campo include le tappe rimanenti delle corse, nell'ordine in cui il veicolo li raggiunge. Fleet Engine calcola questo campo man mano che le corse vengono assegnate al veicolo e lo aggiorna quando le corse cambiano il loro stato. Queste tappe possono essere identificate dai campi TripId e WaypointType.

Espansione dell'idoneità di un veicolo per le corrispondenze

In genere, i servizi di ridesharing o fornitore di servizi di consegna sono responsabili della corrispondenza tra le richieste di corsa e i veicoli. Il servizio può utilizzare gli attributi del veicolo per includere un veicolo in un numero maggiore di ricerche. Ad esempio, il fornitore può implementare un insieme di attributi corrispondenti ai livelli di vantaggi o capacità offerti da un veicolo. Ad esempio, tre livelli potrebbero essere un insieme di attributi con valori booleani: is_bronze_level, is_silver_level e is_gold_level. Un veicolo può essere idoneo per tutti e tre. Quando Fleet Engine riceve una richiesta per una corsa che richiede funzionalità di livello argento, la ricerca include quel veicolo. Questo tipo di utilizzo degli attributi include i veicoli che offrono svariate funzionalità.

Esistono due modi per aggiornare gli attributi dei veicoli. Una è l'API UpdateVehicle. Quando si utilizza questa API, l'intero set di attributi dei veicoli viene impostato sul valore. Non è possibile aggiornare soltanto un singolo attributo. L'altro metodo è l'API UpdateVehicleAttributes. Questo metodo richiede solo gli attributi da aggiornare. Gli attributi inclusi nella richiesta verranno impostati sul nuovo valore o aggiunti; gli attributi non specificati non verranno modificati.

GUIDA: crea un veicolo

È necessario creare un'entità Vehicle per ogni veicolo da monitorare nella flotta.

Utilizza l'endpoint CreateVehicle con CreateVehicleRequest per creare un veicolo.

Nota: CreateVehicle richiede un account con il ruolo di super user Fleet Engine.

Il provider_id di Vehicle deve essere l'ID progetto (ad es. my-on-demand-project) del progetto Google Cloud che contiene gli account di servizio che verranno utilizzati per chiamare Fleet Engine. Tieni presente che anche se più account di servizio possono accedere a Fleet Engine per lo stesso fornitore di ridesharing o di consegna, Fleet Engine al momento non supporta gli account di servizio di più progetti Google Cloud che accedono allo stesso Vehicles.

Vehicle può essere creato nello stato OFFLINE o ONLINE. Se ONLINE è stato creato, l'elemento potrebbe essere restituito immediatamente in risposta a SearchVehicles query.

Un last_location iniziale può essere incluso nella chiamata CreateVehicle. Sebbene sia consentito, non è possibile creare un Vehicle nello stato ONLINE senza un last_location.

Consulta Tipi di veicolo per informazioni dettagliate sul campo del tipo di veicolo.

Consulta Attributi del veicolo per i dettagli sul campo degli attributi.

Il valore restituito da CreateVehicle è l'entità Vehicle creata.

Esempio

shell

curl -X POST \
  "https://fleetengine.googleapis.com/v1/providers/project-id/vehicles?vehicleId=vid-8241890" \
  -H "Authorization: Bearer $JWT" \
  -H "Content-Type: application/json" \
  --data-binary @- << EOM
{
    "vehicleState": "OFFLINE",
    "supportedTripTypes": ["EXCLUSIVE"],
    "maximumCapacity": 4,
    "vehicleType": {"category": "AUTO"},
    "attributes": [{"key": "on_trip", "value": "false"}]
}
EOM

Consulta il riferimento providers.vehicles.create.

Java

static final String PROJECT_ID = "project-id";

VehicleServiceBlockingStub vehicleService =
    VehicleService.newBlockingStub(channel);

String parent = "providers/" + PROJECT_ID;
Vehicle vehicle = Vehicle.newBuilder()
    .setVehicleState(VehicleState.OFFLINE)  // Initial state
    .addSupportedTripTypes(TripType.EXCLUSIVE)
    .setMaximumCapacity(4)
    .setVehicleType(VehicleType.newBuilder().setCategory(VehicleType.Category.AUTO))
    .addAttributes(VehicleAttribute.newBuilder()
        .setKey("on_trip").setValue("false"))  // Opaque to the Fleet Engine
    // Add .setBackToBackEnabled(true) to make this vehicle eligible for trip
    // matching while even if it is on a trip.  By default this is disabled.
    .build();

CreateVehicleRequest createVehicleRequest =
    CreateVehicleRequest.newBuilder()  // no need for the header
        .setParent(parent)
        .setVehicleId("vid-8241890")  // Vehicle ID assigned by Rideshare or Delivery Provider
        .setVehicle(vehicle)  // Initial state
        .build();

// In this case, the Vehicle is being created in the OFFLINE state and
// no initial position is being provided.  When the Driver App checks
// in with the Rideshare or Delivery Provider, the state can be set to ONLINE and
// the Driver App will update the Vehicle Location.

try {
  Vehicle createdVehicle =
      vehicleService.createVehicle(createVehicleRequest);
} catch (StatusRuntimeException e) {
  Status s = e.getStatus();
  switch (s.getCode()) {
    case ALREADY_EXISTS:
      break;
    case PERMISSION_DENIED:
      break;
  }
  return;
}
// If no Exception, Vehicle created successfully.

Log di Google Cloud Platform per la creazione di veicoli

L'API Fleet Engine scrive una voce di log tramite i log della piattaforma Google Cloud quando viene ricevuta una chiamata all'endpoint CreateVehicle. La voce di log include informazioni sui valori nella richiesta CreateVehicle. Se la chiamata ha esito positivo, saranno incluse anche le informazioni sul Vehicle che è stato restituito.

shell

gcloud --project=project-id logging read --freshness=1h '
  jsonPayload.request.vehicleId="vid-8241890"
  jsonPayload.@type="type.googleapis.com/maps.fleetengine.v1.CreateVehicleLog"
'

Devi stampare un record simile al seguente:

---
insertId: c2cf4d3a180251c1bdb892137c14f022
jsonPayload:
  '@type': type.googleapis.com/maps.fleetengine.v1.CreateVehicleLog
  request:
    vehicle:
      attributes:
      - key: on_trip
        value: 'false'
      maximumCapacity: 4
      state: VEHICLE_STATE_OFFLINE
      supportedTrips:
      - EXCLUSIVE_TRIP
      vehicleType:
        vehicleCategory: AUTO
    vehicleId: vid-8241890
  response:
    attributes:
    - key: on_trip
      value: 'false'
    availableCapacity: 4
    currentRouteSegmentHandle: AdSiwAwCO9gZ7Pw5UZZimOXOo41cJTjg/r3SuwVPQmuuaV0sU3+3UCY+z53Cl9i6mWHLoCKbBt9Vsj5PMRgOJ8zX
    maximumCapacity: 4
    name: providers/project-id/vehicles/vid-8241890
    state: VEHICLE_STATE_OFFLINE
    supportedTrips:
    - EXCLUSIVE_TRIP
    vehicleType:
      vehicleCategory: AUTO
labels:
  vehicle_id: vid-8241890
logName: projects/project-id/logs/fleetengine.googleapis.com%2Fcreate_vehicle
receiveTimestamp: '2021-09-22T03:25:16.361159871Z'
resource:
  labels:
    location: global
    resource_container: projects/project-id
  type: fleetengine.googleapis.com/Fleet
timestamp: '2021-09-22T03:25:15.724998Z'

Notifiche Cloud Pub/Sub per la creazione di veicoli

L'API Fleet Engine pubblica una notifica tramite Cloud Pub/Sub quando viene creato un nuovo veicolo. Per ricevere queste notifiche, segui le istruzioni riportate qui.

GUIDA: Aggiornare la posizione di un veicolo

Se non utilizzi l'SDK Driver per aggiornare la posizione del veicolo, puoi chiamare direttamente Fleet Engine indicando la posizione del veicolo. Per qualsiasi veicolo attivo, Fleet Engine si aspetta un aggiornamento della posizione almeno una volta al minuto e al massimo una volta ogni 5 secondi. Questi aggiornamenti richiedono solo i privilegi utente dell'SDK driver di Fleet Engine.

Esempio

shell

curl -X PUT \
  "https://fleetengine.googleapis.com/v1/providers/project-id/vehicles/vid-8241890?updateMask=last_location" \
  -H "Authorization: Bearer $JWT" \
  -H "Content-Type: application/json" \
  --data-binary @- << EOM
{
    "supplementalLocation": {"latitude": 12.1, "longitude": 14.5},
    "supplementalLocationTime": "$(date -u --iso-8601=seconds)",
    "supplementalLocationSensor": "CUSTOMER_SUPPLIED_LOCATION",
    "supplementalLocationAccuracy": 15
}
EOM

Consulta il riferimento providers.vehicles.update.

Java

static final String PROJECT_ID = "project-id";
static final String VEHICLE_ID = "vid-8241890";

VehicleServiceBlockingStub vehicleService = VehicleService.newBlockingStub(channel);

String vehicleName = "providers/" + PROJECT_ID + "/vehicles/" + VEHICLE_ID;
Vehicle updatedVehicle = Vehicle.newBuilder()
    .setLastLocation(VehicleLocation.newBuilder()
        .setSupplementalLocation(LatLng.newBuilder()
            .setLatitude(37.3382)
            .setLongitude(121.8863))
        .setSupplementalLocationTime(now())
        .setSupplementalLocationSensor(LocationSensor.CUSTOMER_SUPPLIED_LOCATION)
        .setSupplementalLocationAccuracy(DoubleValue.of(15.0)))  // Optional)
    .build();

UpdateVehicleRequest updateVehicleRequest = UpdateVehicleRequest.newBuilder()
    .setName(vehicleName)
    .setVehicle(updatedVehicle)
    .setUpdateMask(FieldMask.newBuilder()
        .addPaths("last_location"))
    .build();

try {
  Vehicle updatedVehicle =
      vehicleService.updateVehicle(updateVehicleRequest);
} catch (StatusRuntimeException e) {
  Status s = e.getStatus();
  switch (s.getCode()) {
    case NOT_FOUND:
      // Most implementations will call CreateVehicle in this case
      break;
    case PERMISSION_DENIED:
      break;
  }
  return;
}
// If no Exception, Vehicle updated successfully.

Istruzioni: aggiorna altri campi Veicolo

Gli aggiornamenti di altri attributi dello stato del veicolo avvengono con meno frequenza rispetto agli aggiornamenti della posizione. Gli aggiornamenti di attributi diversi da last_location richiedono i privilegi di super user di Fleet Engine.

UpdateVehicleRequest include un update_mask per indicare quali campi aggiornare. Il comportamento del campo è quello indicato nella documentazione di Protobuf per le maschere dei campi.

Nota: il campo update_mask deve essere sempre impostato. Se il campo update_mask non viene configurato, l'impostazione predefinita è la scrittura di tutti i campi. Ciò può causare comportamenti indesiderati.

Come indicato in Attributi dei veicoli, l'aggiornamento del campo attributes richiede la scrittura di tutti gli attributi da conservare. Non è possibile semplicemente aggiornare il valore di una coppia chiave-valore in una chiamata UpdateVehicle. Per aggiornare i valori di attributi specifici, è possibile utilizzare l'API UpdateVehicleAttributes.

Esempio

Questo esempio abilita back_to_back.

shell

curl -X PUT \
  "https://fleetengine.googleapis.com/v1/providers/project-id/vehicles/vid-8241890?updateMask=vehicle_state,attributes,back_to_back_enabled" \
  -H "Authorization: Bearer $JWT" \
  -H "Content-Type: application/json" \
  --data-binary @- << EOM
{
    "vehicleState": "ONLINE",
    "attributes": [
      {"key": "on_trip", "value": "true"},
      {"key": "cash_only", "value": "false"}
    ],
    "backToBackEnabled": true
}
EOM

Consulta il riferimento providers.vehicles.update.

Java

static final String PROJECT_ID = "project-id";
static final String VEHICLE_ID = "vid-8241890";

VehicleServiceBlockingStub vehicleService = VehicleService.newBlockingStub(channel);

String vehicleName = "providers/" + PROJECT_ID + "/vehicles/" + VEHICLE_ID;
Vehicle updatedVehicle = Vehicle.newBuilder()
    .setVehicleState(VehicleState.ONLINE)
    .addAllAttributes(ImmutableList.of(
        VehicleAttribute.newBuilder().setKey("on_trip").setValue("true").build(),
        VehicleAttribute.newBuilder().setKey("cash_only").setValue("false").build()))
    .setBackToBackEnabled(true)
    .build();

UpdateVehicleRequest updateVehicleRequest = UpdateVehicleRequest.newBuilder()
    .setName(vehicleName)
    .setVehicle(updatedVehicle)
    .setUpdateMask(FieldMask.newBuilder()
        .addPaths("vehicle_state")
        .addPaths("attributes")
        .addPaths("back_to_back_enabled"))
    .build();

// Attributes and vehicle state are being updated, so both are
// included in the field mask.  Note that of on_trip were
// not being updated, but rather cash_only was being changed,
// the desired value of "on_trip" would still need to be written
// as the attributes are completely replaced in an update operation.

try {
  Vehicle updatedVehicle =
      vehicleService.updateVehicle(updateVehicleRequest);
} catch (StatusRuntimeException e) {
  Status s = e.getStatus();
  switch (s.getCode()) {
    case NOT_FOUND:
      // Most implementations will call CreateVehicle in this case
      break;
    case PERMISSION_DENIED:
      break;
  }
  return;
}
// If no Exception, Vehicle updated successfully.

Log di Google Cloud Platform per gli aggiornamenti dei veicoli

L'API Fleet Engine scrive una voce di log tramite i log della piattaforma Google Cloud quando viene ricevuta una chiamata all'endpoint UpdateVehicle. La voce di log include informazioni sui valori nella richiesta UpdateVehicle. Se la chiamata ha esito positivo, saranno incluse anche le informazioni sul Vehicle che è stato restituito.

shell

gcloud --project=project-id logging read --freshness=1h '
  jsonPayload.request.vehicleId="vid-8241890"
  jsonPayload.@type="type.googleapis.com/maps.fleetengine.v1.UpdateVehicleLog"
'

Notifiche Cloud Pub/Sub per gli aggiornamenti del veicolo

L'API Fleet Engine pubblica una notifica tramite Cloud Pub/Sub quando viene aggiornato un veicolo esistente. Per ricevere queste notifiche, segui le istruzioni riportate qui.

ISTRUZIONI: Cerca veicoli

Fleet Engine supporta la ricerca di veicoli. L'API SearchVehicles ti consente di trovare i conducenti disponibili nelle vicinanze più adatti a un'attività come la manutenzione di una corsa o una richiesta di consegna. L'API SearchVehicles restituisce un elenco classificato di conducenti che corrispondono agli attributi delle attività con gli attributi dei veicoli del tuo parco risorse. Per ulteriori informazioni, consulta Ricerca di conducenti nelle vicinanze.

Esempio

Durante la ricerca di veicoli disponibili, Fleet Engine esclude i veicoli su percorsi attivi per impostazione predefinita. I servizi del Fornitore di servizi di ridesharing o del Fornitore di servizi di consegna devono includerli esplicitamente nelle richieste di ricerca. L'esempio seguente mostra come includere questi veicoli nella ricerca di veicoli corrispondenti a una corsa dal Grand Indonesia East Mall al Balai Sidang Jakarta Convention Center.

shell

Innanzitutto, aggiorna la posizione del veicolo che abbiamo creato nei passaggi precedenti in modo che sia idoneo. Nel mondo reale, questo viene fatto tramite l'SDK Driver in esecuzione su un dispositivo Android o iOS nel veicolo.

curl -X PUT \
  "https://fleetengine.googleapis.com/v1/providers/project-id/vehicles/vid-8241890?updateMask=last_location,attributes" \
  -H "Authorization: Bearer $JWT" \
  -H "Content-Type: application/json" \
  --data-binary @- << EOM
{
  "lastLocation": {
    "updateTime": "$( date -u +"%Y-%m-%dT%H:%M:%SZ" )",
    "location": {
      "latitude": "-6.195139",
      "longitude": "106.820826"
    }
  },
  "attributes": [{"key": "on_trip", "value": "false"}]
}
EOM

L'esecuzione della ricerca dovrebbe restituire almeno quel veicolo.

curl -X POST \
  "https://fleetengine.googleapis.com/v1/providers/project-id/vehicles:search" \
  -H "Authorization: Bearer $JWT" \
  -H "Content-Type: application/json" \
  --data-binary @- << EOM
{
  "pickupPoint": {
    "point": {"latitude": "-6.195139", "longitude": "106.820826"}
  },
  "dropoffPoint": {
    "point": {"latitude": "-6.1275", "longitude": "106.6537"}
  },
  "pickupRadiusMeters": 2000,
  "count": 10,
  "minimumCapacity": 2,
  "tripTypes": ["EXCLUSIVE"],
  "vehicleTypes": [{"category": "AUTO"}],
  "filter": "attributes.on_trip=\"false\"",
  "orderBy": "PICKUP_POINT_ETA",
  "includeBackToBack": true
}
EOM

Consulta il riferimento providers.vehicles.search.

Java

static final String PROJECT_ID = "project-id";

VehicleServiceBlockingStub vehicleService = VehicleService.newBlockingStub(channel);

String parent = "providers/" + PROJECT_ID;
SearchVehiclesRequest searchVehiclesRequest = SearchVehiclesRequest.newBuilder()
    .setParent(parent)
    .setPickupPoint( // Grand Indonesia East Mall
        TerminalLocation.newBuilder().setPoint(
            LatLng.newBuilder().setLatitude(-6.195139).setLongitude(106.820826)))
    .setDropoffPoint( // Balai Sidang Jakarta Convention Center
        TerminalLocation.newBuilder().setPoint(
            LatLng.newBuilder().setLatitude(-6.213796).setLongitude(106.807195)))
    .setPickupRadiusMeters(2000)
    .setCount(10)
    .setMinimumCapacity(2)
    .addTripTypes(TripType.EXCLUSIVE)
    .addVehicleTypes(VehicleType.newBuilder().setCategory(VehicleType.Category.AUTO))
    .setFilter("attributes.on_trip=\"false\"")
    .setOrderBy(VehicleMatchOrder.PICKUP_POINT_ETA)
    .setIncludeBackToBack(true) // Fleet Engine includes vehicles that are en route.
    .build();

// Error handling
// If matches are returned and the authentication passed, the request completed
// successfully

try {
  SearchVehiclesResponse searchVehiclesResponse =
      vehicleService.searchVehicles(searchVehiclesRequest);

  // Search results: Each vehicle match contains a vehicle entity and information
  // about the distance and ETA to the pickup point and dropoff point.
  List<VehicleMatch> vehicleMatches = searchVehiclesResponse.getMatchesList();
} catch (StatusRuntimeException e) {
  Status s = e.getStatus();
  switch (s.getCode()) {
    case NOT_FOUND:
      break;
    case PERMISSION_DENIED:
      break;
  }
  return;
}

Query di filtro dei veicoli

SearchVehicles e ListVehicles supportano l'applicazione di filtri in base agli attributi dei veicoli utilizzando una query di filtro. Per la sintassi delle query di filtro, vedi AIP-160 per alcuni esempi.

Tieni presente che le query di filtro supportano SOLO l'applicazione di filtri agli attributi del veicolo e non possono essere utilizzate per altri campi. La query di filtro funziona come una clausola AND con altri vincoli, come minimum_capacity o vehicle_types in SearchVehiclesRequest.

Nota: ti consigliamo vivamente di utilizzare il campo di query filter rispetto ai campi required_attributes, required_one_of_attributes e required_one_of_attributes_sets, poiché filter è progettato per sostituire questi campi. Se nel campo filter viene specificato un valore non vuoto, i seguenti campi devono essere vuoti: required_attributes, required_one_of_attributes e required_one_of_attributes_sets.

GUIDA: Elencare i veicoli

SearchVehicles è ottimizzato per trovare molto rapidamente un numero ridotto di veicoli in ordine di ordinamento e viene utilizzato principalmente per trovare conducenti nelle vicinanze più adatti a un'attività. Tuttavia, a volte potresti voler trovare tutti i veicoli che soddisfano alcuni criteri anche se è necessario sfogliare i risultati. ListVehicles è progettato per questo caso d'uso.

L'API ListVehicles ti consente di trovare tutti i veicoli che soddisfano alcune opzioni di richieste specifiche. L'API ListVehicles restituisce un elenco impaginato di veicoli nel progetto che soddisfa alcuni requisiti.

Per filtrare in base agli attributi dei veicoli, consulta la query di filtro dei veicoli.

Esempio

In questo esempio viene applicato un filtro in base a vehicle_type e agli attributi utilizzando la stringa filter.

shell

curl -X POST \
  "https://fleetengine.googleapis.com/v1/providers/project-id/vehicles:list" \
  -H "Authorization: Bearer $JWT" \
  -H "Content-Type: application/json" \
  --data-binary @- << EOM
{
  "vehicleTypes": [{"category": "AUTO"}],
  "filter": "attributes.on_trip=\"false\"",
}
EOM

Consulta il riferimento providers.vehicles.list.

Java

static final String PROJECT_ID = "project-id";

VehicleServiceBlockingStub vehicleService = VehicleService.newBlockingStub(channel);

String parent = "providers/" + PROJECT_ID;
ListVehiclesRequest listVehiclesRequest = ListVehiclesRequest.newBuilder()
    .setParent(parent)
    .addTripTypes(TripType.EXCLUSIVE)
    .addVehicleTypes(VehicleType.newBuilder().setCategory(VehicleType.Category.AUTO))
    .setFilter("attributes.on_trip=\"false\"")
    .setIncludeBackToBack(true) // Fleet Engine includes vehicles that are en route.
    .build();

// Error handling
// If matches are returned and the authentication passed, the request completed
// successfully

try {
  ListVehiclesResponse listVehiclesResponse =
      vehicleService.listVehicles(listVehiclesRequest);
} catch (StatusRuntimeException e) {
  Status s = e.getStatus();
  switch (s.getCode()) {
    case NOT_FOUND:
      break;
    case PERMISSION_DENIED:
      break;
  }
  return;
}

Viaggi e relativo ciclo di vita

L'API Trip e il ciclo di vita sono simili all'API e al ciclo di vita del veicolo. Il provider Ridesharing è responsabile della creazione delle corse utilizzando le interfacce Fleet Engine. Fleet Engine fornisce un servizio RPC, TripService e risorse REST, provider.trips . Queste interfacce consentono la creazione di entità Trip, le richieste di informazioni, la funzionalità di ricerca e la funzionalità di aggiornamento.

Un Trip dispone di un campo di stato per monitorare il suo avanzamento durante il ciclo di vita. I valori si spostano da NEW a COMPLETE più CANCELED e UNKNOWN_TRIP_STATUS. Fai riferimento a trip_status per RPC o a TripStatus per REST.

• NEW
• ENROUTE_TO_PICKUP
• ARRIVED_AT_PICKUP
• ENROUTE_TO_INTERMEDIATE_DESTINATION
• ARRIVED_AT_INTERMEDIATE_DESTINATION
• ENROUTE_TO_DROPOFF
• COMPLETE

Il servizio può aggiornare la corsa a CANCELED da uno qualsiasi di questi stati. Quando il servizio crea una corsa, il motore imposta lo stato su NEW. L'elemento vehicle_id è facoltativo. Come per i veicoli, i servizi eliminano automaticamente le corse dopo sette giorni senza aggiornamenti. Se il tuo servizio tenta di creare una corsa con un ID già esistente, viene restituito un errore. Una corsa è considerata "attiva" se è in uno stato diverso da COMPLETE o CANCELED. Questa distinzione è importante nel campo active_trips nell'entità Veicolo e in SearchTripsRequest.

Il servizio può modificare il valore vehicle_id assegnato a una corsa solo quando questa è attiva. Ad esempio, questo succede se un conducente annulla una corsa durante il percorso e la corsa viene riassegnata a un altro veicolo.

Lo stato è importante al momento di implementare il supporto back-to-back. Questo supporto consente al Fornitore di assegnare una nuova corsa a un Veicolo mentre questo è in una corsa attiva. Il codice per la creazione di una corsa back-to-back è uguale a una corsa singola e utilizza lo stesso ID veicolo. Fleet Engine aggiunge l'origine e la destinazione della nuova corsa alle tappe del veicolo. Per ulteriori informazioni sui viaggi consecutivi, vedi Creare viaggi con più tappe.

Nota: Fleet Engine non supporta l'eliminazione esplicita di una corsa. Il servizio elimina automaticamente le corse dopo sette giorni senza aggiornamenti. Google non conserva i dati personali. Se vuoi conservare i dati di viaggio, il Fornitore di ridesharing deve implementare questa funzionalità.

Tappe rimanenti del viaggio

L'entità Trip contiene un campo ripetuto di TripWaypoint (RPC | REST), denominato remainingWaypoints(RPC | REST). Questo campo include tutte le tappe che il veicolo dovrà percorrere in ordine prima del punto di partenza finale della corsa. Calcola in base alle tappe rimanenti del veicolo. Nei casi d'uso Back-to-back e Carpool, questo elenco contiene tappe di altre corse che verranno attraversate prima di questa corsa, ma esclude eventuali tappe dopo questa corsa. La tappa nell'elenco può essere identificata tramite TripId e WaypointType.

La relazione tra lo stato della corsa e le tappe rimanenti del veicolo

Le tappe rimanenti del veicolo (RPC | REST) verranno aggiornate quando Fleet Engine riceve una richiesta di modifica dello stato della corsa. Il waypoint precedente verrà rimosso dall'elenco dei waypoint rimanenti del veicolo quando l'impostazione tripStatus(RPC | REST) viene modificata da un altro stato a ENROUTE_TO_XXX. In altre parole, quando lo stato della corsa viene modificato da ENROUTE_TO_PICKUP ad ARRIVED_AT_PICKUP, il punto di prelievo della corsa sarà ancora presente nell'elenco delle tappe rimanenti del veicolo, ma quando lo stato del viaggio verrà modificato in ENROUTE_TO_INTERMEDIATE_DESTINATION o ENROUTE_TO_DROPOFF, il punto di prelievo rimanente verrà rimosso dalle tappe del veicolo.

Lo stesso vale per ARRIVED_AT_INTERMEDIATE_DESTINATION ed ENROUTE_TO_INTERMDEDIATE_DESTINATION. Quando ARRIVED_AT_INTERMEDIATE_DESTINATION, la destinazione intermedia corrente non viene rimossa dall'elenco delle tappe rimanenti del veicolo finché il veicolo non segnala che sta per dirigersi alla tappa successiva.

Quando lo stato della corsa viene modificato in COMPLETED, nessuna tappa di questa corsa sarà nell'elenco di tappe rimanenti del veicolo.

GUIDA: Crea un viaggio

Per consentire il monitoraggio e l'associazione di ogni richiesta di corsa ai veicoli del parco risorse è necessario creare un'entità Trip. Utilizza l'endpoint CreateTrip con CreateTripRequest per creare un Trip.

Per creare un viaggio sono necessari i seguenti attributi:

• parent: una stringa che include l'ID provider creato al momento della creazione del progetto Google Cloud.
• trip_id: una stringa creata da Ridesharing Provider.
• trip - Container con metadati di base che descrivono la corsa.
  • trip_type: enum che indica se il viaggio potrebbe avere altri passeggeri da un'origine e una destinazione diverse nello stesso veicolo (SHARED) o in un solo veicolo (EXCLUSIVE).
  • pickup_point: TerminalLocation che rappresenta il punto di partenza della corsa. Fai riferimento a Riferimento RPC o Riferimento REST

Quando crei un viaggio, puoi fornire number_of_passengers, dropoff_point e vehicle_id. Sebbene questi campi non siano obbligatori, se li fornisci, vengono conservati. Tutti gli altri campi Trip vengono ignorati. Ad esempio, tutte le corse iniziano con trip_status di NEW anche se superi un trip_status di CANCELED nella richiesta di creazione.

Nota: per utilizzare CreateTrip sono necessarie le credenziali per l'account con privilegi menzionati nella configurazione del progetto Cloud.

Esempio

L'esempio seguente crea un viaggio al Grand Indonesia East Mall. Il viaggio è per due passeggeri ed è esclusivo. Il provider_id di Trip deve essere uguale all'ID progetto. Nell'esempio, il fornitore di ridesharing ha creato il progetto Google Cloud project-id. Questo progetto deve avere gli account di servizio utilizzati per chiamare Fleet Engine. Lo stato del percorso è NEW.

Successivamente, dopo che il servizio associa la corsa a un veicolo, il servizio può chiamare UpdateTrip e modificare vehicle_id quando la corsa è assegnata a un veicolo.

shell

curl -X POST \
  "https://fleetengine.googleapis.com/v1/providers/project-id/trips?tripId=tid-1f97" \
  -H "Authorization: Bearer $JWT" \
  -H "Content-Type: application/json" \
  --data-binary @- << EOM
{
  "tripType": "EXCLUSIVE",
  "numberOfPassengers": 2,
  "pickupPoint": {
    "point": {"latitude": "-6.195139", "longitude": "106.820826"}
  },
  "dropoffPoint": {
    "point": {"latitude": "-6.1275", "longitude": "106.6537"}
  }
}
EOM

Consulta il riferimento providers.trips.create.

Java

static final String PROJECT_ID = "project-id";

TripServiceBlockingStub tripService = TripService.newBlockingStub(channel);

String parent = "providers/" + PROJECT_ID;
Trip trip = Trip.newBuilder()
    .setTripType(TripType.EXCLUSIVE) // Use TripType.SHARED for carpooling
    .setPickupPoint(                 // Grand Indonesia East Mall
        TerminalLocation.newBuilder().setPoint(
            LatLng.newBuilder().setLatitude(-6.195139).setLongitude(106.820826)))
    // Provide the number of passengers if available.
    .setNumberOfPassengers(2)
    // Provide the drop-off point if available.
    .setDropoffPoint(
        TerminalLocation.newBuilder().setPoint(
            LatLng.newBuilder().setLatitude(-6.1275).setLongitude(106.6537)))
    .build();

CreateTripRequest createTripRequest =
    CreateTripRequest.newBuilder()  // no need for the header
        .setParent(parent)
        .setTripId("tid-1f97")  // Trip ID assigned by the Provider
        .setTrip(trip)              // Initial state
        .build();

// Error handling
// If Fleet Engine does not have trip with that id and the credentials of the
// requestor pass, the service creates the trip successfully.

try {
  Trip createdTrip =
      tripService.createTrip(createTripRequest);
} catch (StatusRuntimeException e) {
  Status s = e.getStatus();
  switch (s.getCode()) {
    case ALREADY_EXISTS:
      break;
    case PERMISSION_DENIED:
      break;
  }
  return;
}

Log della piattaforma Google Cloud per Trip Creation

L'API Fleet Engine scrive una voce di log utilizzando i log della piattaforma Google Cloud alla ricezione di una chiamata all'endpoint CreateTrip. La voce di log include informazioni sui valori nella richiesta CreateTrip. Se la chiamata ha esito positivo, verranno incluse anche informazioni sul Trip restituito.

GUIDA: Aggiornare un percorso

L'entità Trip contiene campi che consentono il monitoraggio da parte del servizio e per segnalare l'avanzamento della corsa da parte dell'SDK Driver e dell'SDK Consumer. Per aggiornare le proprietà, utilizza il messaggio UpdateTripRequest. I campi Viaggio vengono aggiornati in base all'elemento field_mask della richiesta. Fai riferimento a UpdateTripRequest.

Nota: l'utilizzo di UpdateTripRequest per aggiornare trip_status o vehicle_id di un viaggio richiede le credenziali per l'account con privilegi del provider.

Il Fornitore di Ridesharing è responsabile dell'aggiornamento dei seguenti attributi:

• Stato del viaggio.
• ID veicolo. al momento della creazione o dopo aver abbinato il veicolo a un corsa.
• Modifiche a punto di partenza, arrivo o tappa.

Fleet Engine aggiorna automaticamente i seguenti campi quando utilizzi la funzionalità di condivisione del percorso tramite l'SDK driver o l'SDK consumer:

• Route
• Orario di arrivo stimato
• Distanza rimanente
• Posizione del veicolo
• Tappe rimanenti

Fai riferimento a Tripin RPC o Resource.Trip in REST.

Log di Google Cloud Platform per gli aggiornamenti sulle corse

L'API Fleet Engine scrive una voce di log utilizzando i log della piattaforma Google Cloud alla ricezione di una chiamata all'endpoint UpdateTrip. La voce di log include informazioni sui valori nella richiesta UpdateTrip. Se la chiamata ha esito positivo, includeranno anche informazioni sul Trip restituito.

GUIDA: Cerca percorsi

Fleet Engine supporta la ricerca delle corse. Come indicato in precedenza, un Viaggio viene eliminato automaticamente dopo sette giorni, pertanto SearchTrips non mostra una cronologia completa di tutti i Viaggi.

Sebbene SearchTrips sia un'API flessibile, l'elenco seguente prende in considerazione due casi d'uso.

• Determinazione delle corse attive di un veicolo: il fornitore può determinare le corse attualmente attive di un veicolo. All'interno di SearchTripsRequest, vehicle_id è impostato sul veicolo in esame e active_trips_only deve essere impostato su true.

• Riconciliazione dello stato del provider e di Fleet Engine: il provider può utilizzare SearchTrips per garantire la corrispondenza dello stato di viaggio e di quello di Fleet Engine. Ciò è particolarmente importante per TripStatus. Se lo stato di una corsa assegnata a un Veicolo non è impostato correttamente su COMPLETE o CANCELED, il Veicolo non è incluso da SearchVehicles.

Per utilizzare SearchTrips in questo modo, lascia vuoto il campo vehicle_id, imposta active_trips_only su true e imposta minimum_staleness su un tempo superiore a quello della maggior parte delle durate dei viaggi. Ad esempio, puoi utilizzare un'ora. I risultati includono i viaggi non COMPLETATI né ANNULLATI e che non sono stati aggiornati da oltre un'ora. Il provider deve esaminare queste corse per assicurarsi che il loro stato in Fleet Engine sia aggiornato correttamente.

Risoluzione dei problemi

In caso di errore DEADLINE_EXCEEDED, lo stato di Fleet Engine è sconosciuto. Il provider deve chiamare di nuovo CreateTrip, il che restituisce un codice 201 (CREATED) o 409 (CONFLICT). Nel secondo caso, la richiesta precedente è andata a buon fine prima del giorno DEADLINE_EXCEEDED. Consulta le guide delle API Consumer per ulteriori informazioni sulla gestione degli errori di corsa: Android o iOS.

Assistenza per le corse di Carpool

Puoi assegnare più corse SHARED a un veicolo che supporta TripType.SHARED. Devi specificare l'ordine di tutte le tappe non superate per tutte le corse assegnate al Veicolo in questa corsa condivisa tramite Trip.vehicle_waypoints quando assegni vehicle_id per una corsa condivisa (in una richiesta CreateTrip o UpdateTrip). Fai riferimento a vehicle_waypoints per RPC o a vehicleWaypoints per REST.

Nota: Trip.vehicle_waypoints deve contenere tutte le tappe rimanenti di tutte le corse assegnate al veicolo, ma non le tappe aggiuntive. Queste tappe devono essere ordinate in modo che, per una determinata corsa, il punto di prelievo si trovi prima delle destinazioni intermedie e che tutte le destinazioni intermedie siano prima del punto di discesa. Le tappe dei percorsi EXCLUSIVE non devono alternarsi con altre corse.

Supporto per più destinazioni

Individuare una destinazione intermedia

Il campo intermediateDestinations e il campo intermediateDestinationIndex in Trip (RPC | REST) vengono combinati per essere utilizzati per indicare la destinazione.

Aggiorna destinazione intermedia

Puoi aggiornare le destinazioni intermedie tramite UpdateTrip. Quando aggiorni le destinazioni intermedie, devi fornire un elenco completo delle destinazioni intermedie, incluse quelle che sono state visitate, non solo quella appena aggiunta o da modificare. Quando intermediateDestinationIndex punta a un indice dopo la posizione della destinazione intermedia appena aggiunta/modificata, quest'ultima non verrà aggiunta ai valori waypoints o remainingWaypoints del viaggio del veicolo. Il motivo è che le destinazioni intermedie prima del giorno intermediateDestinationIndex vengono trattate come già visitate.

Modifiche allo stato del viaggio

Il campo intermediateDestinationsVersion in (RPC | REST) è obbligatorio nella richiesta di aggiornamento dello stato del viaggio inviata a Fleet Engine per indicare che è stata superata una destinazione intermedia. La destinazione intermedia target viene specificata tramite il campo intermediateDestinationIndex. Quando tripStatus (RPC | REST) è ENROUTE_TO_INTERMEDIATE_DESTINATION, un numero compreso tra [0..N-1] indica la destinazione intermedia che verrà attraversata dal veicolo. Quando tripStatus è ARRIVED_AT_INTERMEDIATE_DESTINATION, un numero compreso tra [0..N-1] indica la destinazione intermedia in cui si trova il veicolo.

Esempio

Il seguente esempio di codice mostra come aggiornare lo stato di una corsa per dirigersi alla prima destinazione intermedia, supponendo che tu abbia creato una corsa con più destinazioni e che la corsa abbia superato il suo punto di prelievo.

Java

static final String PROJECT_ID = "project-id";
static final String TRIP_ID = "multi-destination-trip-A";

String tripName = "providers/" + PROJECT_ID + "/trips/" + TRIP_ID;
Trip trip = …; // Fetch trip object from FleetEngine or your storage.

TripServiceBlockingStub tripService = TripService.newBlockingStub(channel);

// Trip settings to update.
Trip trip = Trip.newBuilder()
    // Trip status cannot go back to a previous status once it is passed
    .setTripStatus(TripStatus.ENROUTE_TO_INTERMEDIATE_DESTINATION)
    // Enrouting to the first intermediate destination.
    .setIntermediateDestinationIndex(0)
    // intermediate_destinations_version MUST be provided to ensure you
    // have the same picture on intermediate destinations list as FleetEngine has.
    .setIntermediateDestinationsVersion(
        trip.getIntermediateDestinationsVersion())
    .build();

// Trip update request
UpdateTripRequest updateTripRequest =
    UpdateTripRequest.newBuilder()
        .setName(tripName)
        .setTrip(trip)
        .setUpdateMask(
            FieldMask.newBuilder()
                .addPaths("trip_status")
                .addPaths("intermediate_destination_index")
                // intermediate_destinations_version must not be in the
                // update mask.
                .build())
        .build();

// Error handling
try {
  Trip updatedTrip = tripService.updateTrip(updateTripRequest);
} catch (StatusRuntimeException e) {
  Status s = e.getStatus();
  switch (s.getCode()) {
    case NOT_FOUND:  // Trip does not exist.
      break;
    case FAILED_PRECONDITION:  // The given trip status is invalid, or the
                                // intermediate_destinations_version
                                // doesn’t match FleetEngine’s.
      break;
    case PERMISSION_DENIED:
      break;
  }
  return;
}

Istruzioni: iscriviti ai messaggi di notifica dell'API Fleet Engine

L'API Fleet Engine utilizza Google Cloud Pub/Sub per pubblicare notifiche sull'argomento creato dal progetto Google Cloud consumer. Pub/Sub non è abilitato per impostazione predefinita per Fleet Engine nel progetto Google Cloud. Invia una richiesta di assistenza o contatta il tuo Customer Engineer per abilitare Pub/Sub.

Nota: Pub/Sub non garantisce l'ordine dei messaggi.

Per creare un argomento nel tuo progetto Cloud, segui queste istruzioni. L'ID argomento deve essere "fleet_engine_notifications".

L'argomento deve essere creato nello stesso progetto Cloud che chiama le API Fleet Engine.

Una volta creato l'argomento, devi concedere l'autorizzazione dell'API Fleet Engine per pubblicare l'argomento. Per farlo, fai clic sull'argomento appena creato e aggiungi una nuova autorizzazione. Potrebbe essere necessario fare clic su MOSTRA RIQUADRO INFORMAZIONI per aprire l'editor delle autorizzazioni. L'entità deve essere [e-mail] e il ruolo deve essere Pub/Sub publisher.

Per configurare il tuo progetto Cloud per la sottoscrizione alle notifiche, segui queste istruzioni.

L'API Fleet Engine pubblica ogni notifica in due formati di dati diversi, protobuf e json. Il formato dei dati per ogni notifica è indicato negli attributi PubsubMessage con la chiave come data_format e il valore come protobuf o json.

Schema delle notifiche:

Protobuf

// A batch of notifications that is published by the Fleet Engine service using
// Cloud Pub/Sub in a single PubsubMessage.
message BatchNotification {
  // Required. At least one notification must exist.
  // List of notifications containing information related to changes in
  // Fleet Engine data.
  repeated Notification notifications = 1;
}

// A notification related to changes in Fleet Engine data.
// The data provides additional information specific to the type of the
// notification.
message Notification {
  // Required. At least one type must exist.
  // Type of notification.
  oneof type {
    // Notification related to changes in vehicle data.
    VehicleNotification vehicle_notification = 1;
  }
}

// Notification sent when a new vehicle was created.
message CreateVehicleNotification {
  // Required.
  // Vehicle must contain all fields that were set when it was created.
  Vehicle vehicle = 1;
}

// Notification sent when an existing vehicle is updated.
message UpdateVehicleNotification {
  // Required.
  // Vehicle must only contain name and fields that are present in the
  // field_mask field below.
  Vehicle vehicle = 1;

  // Required.
  // Contains vehicle field paths that were specifically requested
  // by the Provider.
  google.protobuf.FieldMask field_mask = 2;
}

// Notification related to changes in vehicle data.
message VehicleNotification {
  // Required. At least one type must be set.
  // Type of notification.
  oneof type {
    // Notification sent when a new vehicle was created.
    CreateVehicleNotification create_notification = 1;
    // Notification sent when an existing vehicle is updated.
    UpdateVehicleNotification update_notification = 2;
  }
}

JSON

• Veicolo
• FieldMask

BatchNotification: {
  "description": "A batch of notifications that is published by the Fleet Engine service using Cloud Pub/Sub in a single PubsubMessage.",
  "type": "object",
  "required": ["notifications"],
  "properties": {
    "notifications": {
      "description": "At least one notification must exist. List of notifications containing information related to changes in Fleet Engine data.",
      "type": "Notification[]"
    }
  }
}

Notification: {
  "description": "A notification related to changes in Fleet Engine data. The data provides additional information specific to the type of the notification.",
  "type": "object",
  "properties": {
    "vehicleNotification": {
      "description": "Notification related to changes in vehicle data.",
      "type": "VehicleNotification"
    }
  }
}

VehicleNotification: {
  "description": "Notification related to changes in vehicle data.",
  "type": "object",
  "properties": {
    "createNotification": {
      "description": "Notification sent when a new vehicle was created.",
      "type": "CreateVehicleNotification"
    },
    "updateNotification": {
      "description": "Notification sent when an existing vehicle is updated.",
      "type": "UpdateVehicleNotification"
    }
  }
}

CreateVehicleNotification: {
  "description": "Notification sent when a new vehicle was created.",
  "type": "object",
  "required": ["vehicle"],
  "properties": {
    "vehicle": {
      "description": "Vehicle must contain all fields that were set when it was created.",
      "type": "Vehicle"
    }
  }
}

UpdateVehicleNotification: {
  "description": "Notification sent when an existing vehicle is updated.",
  "type": "object",
  "required": ["vehicle", "fieldMask"],
  "properties": {
    "vehicle": {
      "description": "Vehicle must only contain name and fields that are present in the fieldMask field below.",
      "type": "Vehicle"
    },
    "fieldMask": {
      "description": "Contains vehicle field paths that were specifically requested by the Provider.",
      "type": "FieldMask"
    }
  }
}