Scegli i campi da restituire

Quando chiami il metodo ComputeRoutes(), devi specificare i campi che da restituire nella risposta. Per farlo, utilizzi una maschera del campo di risposta, che fornisci con il parametro URL $fields o fields oppure utilizzando Intestazione HTTP/gRPC X-Goog-FieldMask. Per ulteriori informazioni, vedi Parametri di sistema.

Maschera dei campi

Il valore della maschera di campo è un elenco separato da virgole di percorsi dei campi. Percorso di ogni 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. La il percorso del campo inizia dal tipo di messaggio di risposta di primo livello ed è facoltativamente seguito da uno o più punti e dal nome del campo al livello successivo. In generale, i percorsi dei campi sono realizzati nel seguente modo:

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

Una maschera per il campo dei casi speciali è un carattere jolly "*", che seleziona tutti i campi a livello di directory principale campi.

Esempi

L'esempio seguente mostra come impostare le maschere dei campi per ComputeRoutes().

Esempio 1

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

X-Goog-FieldMask: *

Esempio 2

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

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

Consigliamo di non utilizzare la maschera del campo di risposta con il carattere jolly (*) o di specificare la maschera del campo al livello più alto (percorsi) in produzione. Seleziona solo i campi di cui hai bisogno:

  • Consente al nostro server di salvare i cicli di elaborazione, che ci consentono di restituire gli con una latenza minore.

  • 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 in tutti i campi o se selezioni tutti i campi al livello superiore, potresti riscontrare un peggioramento delle prestazioni poiché ogni nuovo campo che aggiungiamo incluso nella tua risposta.

  • Si traduce in una dimensione di risposta più piccola, che si traduce in una maggiore quantità e la velocità effettiva effettiva.

Per ulteriori informazioni su come creare percorsi dei campi, consulta field_mask.proto.