Felder auswählen, die zurückgegeben werden sollen

Wenn Sie die ComputeRoutes()-Methode 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 angeben, oder den HTTP-/gRPC-Header X-Goog-FieldMask. 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 Name des Protobuf-Feld-Tags. Der Feldpfad beginnt mit dem Antwortnachrichtentyp der obersten Ebene. Optional folgen ein oder mehrere Punkte und dann die nächste Ebene des Feldnamens. Im Allgemeinen werden Feldpfade so aufgebaut:

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

Ein Sonderfall für eine Feldmaske ist der 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 (für manuelle Überprüfung)

X-Goog-FieldMask: *

Beispiel 2

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

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

Wir raten davon ab, in der Produktionsumgebung die Antwortfeldmaske mit dem Wildcard-Zeichen (*) oder die Feldmaske auf oberster Ebene (Routen) zu verwenden. Wählen Sie nur die Felder aus, die Sie benötigen:

  • So können wir auf unserem Server Verarbeitungszyklen einsparen und Ihnen die Ergebnisse mit einer geringeren Latenz zurückgeben.

  • Sorgt für eine stabile Latenzleistung. Wir werden möglicherweise in Zukunft weitere Antwortfelder hinzufügen. Diese neuen Felder erfordern möglicherweise zusätzliche Rechenzeit. Wenn Sie alle Felder oder alle Felder auf oberster Ebene auswählen, kann es zu Leistungseinbußen kommen, da jedes neue Feld, das wir hinzufügen, automatisch in Ihre Antwort aufgenommen wird.

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

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