Felder auswählen, die zurückgegeben werden sollen

Wenn Sie die Methode ComputeRoutes() aufrufen, müssen Sie angeben, welche Felder in der Antwort zurückgegeben werden sollen. Dazu verwenden Sie eine Antwortfeldmaske, die Sie mit dem URL-Parameter $fields oder fields oder mit dem HTTP/gRPC-Header X-Goog-FieldMask angeben. Weitere Informationen finden Sie unter Systemparameter.

Feldmaske

Der Wert der Feldmaske ist eine durch Kommas getrennte Liste von Feldpfaden. Jeder Feldpfad ist eine durch Punkte getrennte Liste von Feldnamen, die die Nachrichtenhierarchie darstellen. Ein Feldname ist entweder der JSON-Objektschlüssel oder der Protobuf-Feld-Tag-Name. Der Feldpfad beginnt mit dem Antwortnachrichtentyp der obersten Ebene und wird optional von einem oder mehreren Punkten gefolgt, dann vom Feldnamen der nächsten Ebene. Im Allgemeinen werden Feldpfade so erstellt:

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

Ein Sonderfall der Feldmaske ist der Platzhalter „*“, der alle Felder der obersten Ebene auswählt.

Beispiele

Das folgende Beispiel zeigt, wie Feldmasken für die Methode ComputeRoutes() festgelegt werden.

Beispiel 1

Feldmaske aller verfügbaren Felder (zur manuellen Überprüfung).

X-Goog-FieldMask: *

Beispiel 2

Feldmaske für Dauer, Entfernung und Polylinie auf Routenebene (Beispiel für eine Produktionskonfiguration).

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

Wir raten von der Verwendung der Antwortfeldmaske mit dem Platzhalter (*) oder der Angabe der Feldmaske auf der obersten Ebene (Routen) in der Produktion ab. Wenn Sie nur die benötigten Felder auswählen:

  • kann unser Server Verarbeitungszyklen sparen, sodass wir Ihre Ergebnisse mit geringerer Latenz zurückgeben können.

  • wird eine stabile Latenzleistung gewährleistet. Wir fügen möglicherweise in Zukunft weitere Antwortfelder hinzu, die zusätzliche Rechenzeit erfordern. Wenn Sie alle Felder oder alle Felder auf der obersten Ebene auswählen, kann es zu Leistungseinbußen kommen, da alle neuen Felder, die wir hinzufügen, automatisch in Ihre Antwort aufgenommen werden.

  • führt zu einer kleineren Antwortgröße, was einen höheren Netzwerkdurchsatz bedeutet.

Weitere Informationen zum Erstellen von Feldpfaden finden Sie unter dem field_mask.proto.