Scegli i campi da restituire

Quando chiami il metodo ComputeRoutes(), devi specificare quali campi vuoi vengano restituiti nella risposta. Per farlo, utilizza una maschera del campo di risposta, fornita con il parametro URL $fields o fields, oppure l'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 di campo. 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 di campo protobuf. Il percorso del campo parte 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 vengono creati nel seguente modo:

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

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

Esempi

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

Esempio 1

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

X-Goog-FieldMask: *

Esempio 2

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

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

Consigliamo di non utilizzare la maschera del campo di risposta con caratteri jolly (*) o di specificare la maschera del campo al livello superiore (route) in produzione. Selezionando solo i campi di cui hai bisogno:

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

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

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

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