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, gefolgt von einem oder mehreren Punkten und dann der nächsten Ebene des Feldnamens. Im Allgemeinen werden Feldpfade so erstellt:

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

Eine spezielle 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 die manuelle Prü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 davon ab, in der Produktionsumgebung die Platzhalter-Feldmaske (*) für die Antwort zu verwenden oder die Feldmaske auf der obersten Ebene (Routen) anzugeben. Wählen Sie nur die Felder aus, die Sie benötigen:

  • Ermöglicht unserem Server, Verarbeitungszyklen zu sparen, sodass wir Ihre Ergebnisse mit einer geringeren Latenz zurückgeben können.

  • Sorgt für eine stabile Latenzleistung. Möglicherweise fügen wir in Zukunft weitere Antwortfelder hinzu, die zusätzliche Rechenzeit erfordern. 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.

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

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