Scegli i campi da restituire

Quando chiami il metodo ComputeRoutes(), devi specificare i campi che vuoi vengano restituiti nella risposta. Puoi farlo utilizzando una maschera di campo della risposta, che fornisci con il parametro URL $fields o fields, oppure utilizzando l' intestazione HTTP/gRPC X-Goog-FieldMask. Per saperne di più, consulta la sezione Parametri di sistema.

Maschera di campo

Il valore della maschera di campo è un elenco separato da virgole di percorsi di campo. Ogni percorso di campo è un elenco di nomi di campi separati da punti che rappresentano la gerarchia dei messaggi. Un nome di campo è la chiave dell'oggetto JSON o il nome del tag del campo protobuf. Il percorso di campo inizia con il tipo di messaggio di risposta di primo livello e, facoltativamente, è seguito da uno o più punti e poi dal nome del campo di livello successivo. In generale, i percorsi di campo vengono creati nel seguente modo:

topLevelField[.secondLevelField][.thirdLevelField][...]

Una maschera di campo speciale è un carattere jolly "*", che seleziona tutti i campi di primo livello.

Esempi

L'esempio seguente mostra come impostare le maschere di campo per il metodo ComputeRoutes().

Esempio 1

Maschera di campo di tutti i campi disponibili (per l'ispezione manuale).

X-Goog-FieldMask: *

Esempio 2

Maschera di campo di durata, distanza e polilinee a livello di percorso (un esempio di configurazione di produzione).

X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline

Sconsigliamo l'utilizzo della maschera di campo della risposta con carattere jolly (*) o la specifica della maschera di campo a livello di primo livello (percorsi) in produzione. Selezionare solo i campi di cui hai bisogno:

  • Consente al nostro server di risparmiare cicli di elaborazione, il che ci consente di restituire i risultati con una latenza inferiore.

  • Garantisce prestazioni di latenza stabili. In futuro potremmo aggiungere altri campi di risposta e questi nuovi campi potrebbero richiedere tempi di calcolo aggiuntivi. Se selezioni tutti i campi o tutti i campi di primo livello, potresti riscontrare un peggioramento delle prestazioni perché qualsiasi nuovo campo che aggiungiamo verrà incluso automaticamente nella risposta.

  • Comporta una dimensione della risposta inferiore, che si traduce in una maggiore velocità effettiva della rete.

Per saperne di più su come creare i percorsi di campo, consulta il field_mask.proto.