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 bereitstellen, oder über den HTTP-/gRPC-Header X-Goog-FieldMask. Weitere Informationen finden Sie unter Systemparameter.

Feldmaske

Der Feldmaskenwert 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 Name des protobuf-Feld-Tags. Der Feldpfad beginnt beim Antwortnachrichtentyp der obersten Ebene und kann optional von einem oder mehreren Punkten gefolgt von der nächsten Ebene des Feldnamens gefolgt werden. Im Allgemeinen werden Feldpfade so konstruiert:

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

Eine Sonderfeldmaske ist ein Platzhalter „*“, mit dem alle Felder auf Stammebene ausgewählt werden.

Beispiele

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

Beispiel 1

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

X-Goog-FieldMask: *

Beispiel 2

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

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

Wir raten von der Verwendung der Platzhalter-Antwortfeldmaske (*) oder der Angabe der Feldmaske auf der obersten Ebene (Routen) in der Produktion ab. Wählen Sie nur die Felder aus, die Sie benötigen:

  • Ermöglicht unserem Server, Verarbeitungszyklen einzusparen, wodurch Ihre Ergebnisse mit einer geringeren Latenz zurückgegeben werden können.

  • Sorgt für eine stabile Latenzleistung. Möglicherweise werden in Zukunft weitere Antwortfelder hinzugefügt, die möglicherweise zusätzliche Rechenzeit erfordern. Wenn Sie alle Felder oder alle Felder auf der obersten Ebene auswählen, kann es zu Leistungseinbußen kommen, da jedes neu hinzugefügte Feld automatisch in Ihre Antwort aufgenommen wird.

  • Dies führt zu einer geringeren Antwortgröße und damit einem höheren Netzwerkdurchsatz.

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