Scegli i campi da restituire

Quando chiami il metodo ComputeRoutes(), devi specificare quali campi vuoi che vengano restituiti nella risposta. Per farlo, utilizza una maschera del campo di risposta, fornita con il parametro URL $fields o fields, oppure utilizza l'intestazione HTTP/gRPC X-Goog-FieldMask. Per ulteriori informazioni, consulta Parametri di sistema.

Maschera del campo

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

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

Una maschera per il campo delle richieste speciali è un carattere jolly "*", che seleziona tutti i campi di livello principale.

Esempi

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

Esempio 1

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

X-Goog-FieldMask: *

Esempio 2

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

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

Sconsigliamo l'utilizzo della maschera per il campo di risposta con carattere jolly (*) o di specificare la maschera del campo al livello superiore (route) in produzione. Selezionando solo i campi che ti servono:

  • Consente al nostro server di salvare i cicli di elaborazione, permettendoci di restituire i tuoi risultati con una latenza inferiore.

  • Garantisce prestazioni di latenza stabili. In futuro potremmo aggiungere altri campi di risposta e questi nuovi campi potrebbero richiedere più tempo di calcolo. Se selezioni tutti i campi o tutti i campi al livello superiore, potresti riscontrare un peggioramento delle prestazioni perché qualsiasi nuovo campo che aggiungeremo verrà incluso automaticamente nella tua risposta.

  • Si traduce in una dimensione della risposta più piccola, che si traduce in una velocità effettiva di rete maggiore.

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