Questo documento descrive i modi in cui puoi trovare informazioni sulle attività da un server o un browser. Fleet Engine supporta due modi per trovare le attività:
Cerca attività: puoi cercare le attività in base ai seguenti ID:
- ID attività: utilizzato da utenti come gli operatori di flotte che hanno accesso alla visualizzazione completa dei dati delle attività.
- ID tracciamento: utilizzato dal software client per fornire informazioni limitate a un utente finale, ad esempio quando è previsto il recapito di un pacco a casa sua.
Assicurati di comprendere la differenza tra l'ID attività e l'ID monitoraggio attività. Non sono la stessa cosa. Consulta Campi di attività di base nella guida sulle attività pianificate.
Elenca attività: accesso ampio alle attività, riservato solo agli utenti attendibili.
Cercare le attività
Questa sezione descrive come cercare le attività in base all'ID attività o all'ID monitoraggio. Deve soddisfare i seguenti requisiti:
Le ricerche in base all'ID monitoraggio devono rispettare le regole di visibilità riportate in Regole di visibilità per gli oggetti monitorati.
Utilizza il token più limitato possibile per limitare i rischi per la sicurezza. Ad esempio, se utilizzi un token consumer per la consegna, tutte le chiamate restituiscono solo le informazioni pertinenti per l'utente finale, come il mittente o il destinatario di una spedizione. Fleet Engine oscura tutte le altre informazioni nelle risposte. Per ulteriori informazioni sui token, consulta JSON Web Token.
Cerca attività per ID attività
Puoi cercare un'attività tramite il relativo ID da un ambiente server utilizzando gRPC o REST. I seguenti esempi mostrano come utilizzare la libreria gRPC Java o una richiesta REST per GetTask.
gRPC
static final String PROJECT_ID = "my-delivery-co-gcp-project";
static final String TASK_ID = "task-8597549";
DeliveryServiceBlockingStub deliveryService =
DeliveryServiceGrpc.newBlockingStub(channel);
// Task request
String taskName = "providers/" + PROJECT_ID + "/tasks/" + TASK_ID;
GetTaskRequest getTaskRequest = GetTaskRequest.newBuilder() // No need for the header
.setName(taskName)
.build();
try {
Task task = deliveryService.getTask(getTaskRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case NOT_FOUND:
break;
case PERMISSION_DENIED:
break;
}
return;
}
REST
GET https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks/<taskId>
- <id> è un identificatore univoco dell'attività.
- <taskId> è l'ID dell'attività da cercare.
- L'intestazione della richiesta deve contenere un campo Authorization con il valore Bearer <token>, dove <token> è emesso dal tuo server secondo le linee guida descritte in Ruoli dell'account di servizio e Token web JSON.
- Il corpo della richiesta deve essere vuoto.
- Se la ricerca va a buon fine, il corpo della risposta contiene un'entità attività.
Comando curl
di esempio:
# Set JWT, PROJECT_ID, and TASK_ID in the local environment
curl -H "Authorization: Bearer ${JWT}" \
"https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks/${TASK_ID}"
Cercare le attività per ID monitoraggio
Gli esempi riportati di seguito mostrano come cercare le attività in base al relativo ID tracciabilità della spedizione utilizzando gRPC o una chiamata REST HTTP a GetTaskTrackingInfo
.
gRPC
static final String PROJECT_ID = "my-delivery-co-gcp-project";
static final String TRACKING_ID = "TID-7449w087464x5";
DeliveryServiceBlockingStub deliveryService =
DeliveryServiceGrpc.newBlockingStub(channel);
// Tasks request
String parent = "providers/" + PROJECT_ID;
GetTaskTrackingInfoRequest getTaskTrackingInfoRequest = GetTaskTrackingInfoRequest.newBuilder() // No need for the header
.setParent(parent)
.setTrackingId(TRACKING_ID)
.build();
try {
TaskTrackingInfo taskTrackingInfo = deliveryService.getTaskTrackingInfo(getTaskTrackingInfoRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case NOT_FOUND:
break;
case PERMISSION_DENIED:
break;
}
return;
}
REST
GET https://fleetengine.googleapis.com/v1/providers/<project_id>/taskTrackingInfo/<tracking_id>
<tracking_id> è l'ID monitoraggio associato all'attività.
L'intestazione della richiesta deve contenere un campo Authorization con il valore Bearer <token>, dove <token> indica il ruolo corretto dell'account di servizio. Vedi Ruoli dell'account di servizio.
Se la ricerca va a buon fine, il corpo della risposta contiene un'entità taskTrackingInfo.
Comando curl
di esempio:
# Set JWT, PROJECT_ID, and TRACKING_ID in the local environment
curl -H "Authorization: Bearer ${JWT}" \
"https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/taskTrackingInfo/${TRACKING_ID}"
Elenca attività
L'elenco delle attività richiede un accesso ampio alle attività. Le attività di elenco sono destinate solo agli utenti di fiducia. Utilizza i token di autenticazione Delivery Fleet Reader o Delivery Admin quando effettui richieste di attività dell'elenco. Per ulteriori informazioni, consulta Ruoli dell'account di servizio.
Elenchi paginati
Gli elenchi di attività sono suddivisi in pagine. È possibile specificare un formato di pagina nelle richieste di attività di elenco. Se viene specificata una dimensione di pagina, il numero di attività restituite non è superiore alla dimensione di pagina specificata. Se non è presente alcuna dimensione di pagina, viene utilizzato un valore predefinito ragionevole. Se la dimensione della pagina richiesta supera un valore massimo interno, viene utilizzato il valore massimo interno.
Un elenco di attività può includere un token per la lettura della pagina di risultati successiva. Per recuperare la pagina successiva, emetti di nuovo la stessa richiesta insieme al token pagina. Quando il token pagina restituito è vuoto, non sono disponibili altre attività per il recupero.
Campi per la creazione di un elenco di attività
Fleet Engine oscura i seguenti campi quando elenca le attività:
VehicleStop.planned_location
VehicleStop.state
VehicleStop.TaskInfo.taskId
Utilizza i seguenti formati di campo in base alle proposte di miglioramento delle API di Google:
Tipo di campo | Formato | Esempio |
---|---|---|
Timestamp | RFC-3339 | task_outcome_time = 2022-03-01T11:30:00-08:00 |
Durata | Numero di secondi seguito da s |
task_duration = 120s |
Enum | Stringa | state = CLOSED AND type = PICKUP |
Località | point.latitude e point.longitude |
planned_location.point.latitude > 36.1 AND planned_location.point.longitude < -122.0 |
Filtrare le attività elencate
Puoi filtrare le attività elencate in base alla maggior parte delle proprietà. Per la sintassi delle query di filtro, consulta AIP-160. Se non viene specificata alcuna query di filtro, vengono elencate tutte le attività.
La tabella seguente mostra le proprietà di attività valide che puoi utilizzare per filtrare:
Proprietà delle attività per filtrare gli elenchi | |
---|---|
|
|
Consulta l'articolo AIP-160 per un elenco completo degli operatori di query di filtro.
Esempi di attività nell'elenco
L'esempio seguente mostra come elencare le attività per un attributo deliveryVehicleId
e un attributo task, sia con la libreria gRPC Java sia con la chiamata REST HTTP a ListTasks
.
Una risposta corretta può comunque essere vuota. Una risposta vuota indica che non sono associate attività al deliveryVehicleId
fornito.
gRPC
static final String PROJECT_ID = "my-delivery-co-gcp-project";
static final String TRACKING_ID = "TID-7449w087464x5";
DeliveryServiceBlockingStub deliveryService =
DeliveryServiceGrpc.newBlockingStub(channel);
// Tasks request
String parent = "providers/" + PROJECT_ID;
ListTasksRequest listTasksRequest = ListTasksRequest.newBuilder() // No need for the header
.setParent(parent)
.setFilter("delivery_vehicle_id = 123 AND attributes.foo = true")
.build();
try {
ListTasksResponse listTasksResponse = deliveryService.listTasks(listTasksRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case NOT_FOUND:
break;
case PERMISSION_DENIED:
break;
}
return;
}
REST
GET https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks
Per applicare un filtro alle attività elencate, includi un parametro URL "filter" con una query di filtro con escape per URL come valore.
L'intestazione della richiesta deve contenere un campo Authorization con il valore Bearer <token>, dove <token> indica il ruolo corretto dell'account di servizio. Vedi Ruoli dell'account di servizio.
Una ricerca riuscita fornisce un corpo di risposta con la seguente struttura:
// JSON representation
{
"tasks": [
{
object (Task)
}
],
"nextPageToken": string,
"totalSize": integer
}
Comando curl
di esempio:
# Set JWT, PROJECT_ID, and VEHICLE_ID in the local environment
curl -H "Authorization: Bearer ${JWT}" \
"https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks?filter=state%20%3D%20OPEN%20AND%20delivery_vehicle_id%20%3D%20${VEHICLE_ID}"