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 können Sie eine Antwortfeldmaske verwenden, die Sie mit dem URL-Parameter $fields oder fields bereitstellen, oder 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 Tag-Name des Felds protobuf. Der Feldpfad beginnt mit dem Antwortnachrichtentyp der obersten Ebene, gefolgt von einem oder mehreren Punkten und der nächsten Ebene des Feldnamens. Feldpfade werden im Allgemeinen so konstruiert:

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

Eine Feldmaske für Sonderfälle 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 (für die manuelle Prüfung).

X-Goog-FieldMask: *

Beispiel 2

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

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

Wir raten davon ab, die Platzhalter-Antwortfeldmaske (*) oder die Feldmaske auf oberster Ebene (Routen) in der Produktion anzugeben. Wählen Sie nur die benötigten Felder aus:

  • Ermöglicht unserem Server, Verarbeitungszyklen zu speichern, 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 neu hinzugefügte Feld automatisch in Ihre Antwort aufgenommen wird.

  • Dies 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.