Felder für die Rückgabe auswählen

Wenn Sie eine Route oder Routenmatrix anfordern, müssen Sie mit einer Feldmaske angeben, welche Informationen in der Antwort zurückgegeben werden sollen. Es gibt keine Standardliste der zurückgegebenen Felder. Wenn Sie keine Feldmaske angeben, geben die Methoden einen Fehler zurück.

Mit einer Feldmaske wird außerdem verhindert, dass unnötige Daten angefordert werden, was wiederum die Antwortlatenz verringert und unnötige Kosten für Informationen vermeidet, die Ihr System nicht benötigt.

Die Liste der benötigten Felder geben Sie in einer Antwortfeldmaske an. Sie übergeben die Antwortfeldmaske dann an eine der Methoden, indem Sie den URL-Parameter $fields oder fields oder den HTTP- oder gRPC-Header X-Goog-FieldMask verwenden.

Weitere Informationen zu URL-Parametern finden Sie unter Systemparameter.

Antwortfeldmaske definieren

Die Antwortfeldmaske ist eine durch Kommas getrennte Liste von Pfaden, wobei jeder Pfad ein eindeutiges Feld in der Antwortnachricht angibt. Der Pfad beginnt bei der Antwortnachricht der obersten Ebene und verwendet einen durch Punkte getrennten Pfad zum angegebenen Feld.

So erstellen und geben Sie einen Feldpfad an:

1. Suchen Sie in der Routes API nach den Feldern, die die benötigten Informationen enthalten. Weitere Informationen finden Sie unter Feldverweise.
2. Pfade für die benötigten Felder ermitteln und Feldmasken dafür erstellen: Weitere Informationen finden Sie unter Feldmaske festlegen.

3. Kombinieren Sie die Feldmasken für alle erforderlichen Felder und trennen Sie sie durch Kommas. Wenn Sie beispielsweise den distanceMeters für den Streckenabschnitt sowie die Dauer für jeden Schritt des Streckenabschnitts anfordern möchten, geben Sie beide Werte durch ein Komma getrennt und ohne Leerzeichen ein:

   routes.legs.distanceMeters,routes.legs.steps.duration

4. Senden Sie die Feldmaske mit Ihrer API-Anfrage. In einer cURL-Anfrage geben Sie die Feldmaske beispielsweise mit -H und X-Goog-FieldMask an:

   -H X-Goog-FieldMask: routes.legs.distanceMeters,routes.legs.steps.duration

Beispiele und weitere Informationen finden Sie in den folgenden Abschnitten.

Feldverweise

Informationen zu den Feldern, die Sie in einer Antwort über Feldmasken anfordern können, finden Sie in den Routes API-Referenzen in der folgenden Liste. Geben Sie die Felder in Camel Case an, wie in der Referenz gezeigt. Beispiel: routePreference.

Parameter Werte müssen dagegen wie dargestellt eingegeben werden. Geben Sie beispielsweise für routingPreference den Wert TRAFFIC_AWARE ein.

Diese Verweise enthalten die verfügbaren Felder. Sie müssen jedoch die Hierarchie der Felder berücksichtigen, um den vollständigen Pfad der Feldmaske zu ermitteln. Weitere Informationen zum Abrufen der Hierarchie der Felder finden Sie unter Feldmaske festlegen.

• Maske für das Feld „Route“ berechnen
  • REST: Gibt die Felder des Route-Objekts in der Antwort an, die zurückgegeben werden sollen. Sie müssen mit routes. beginnen, z. B. routes.distanceMeters.
  • gRPC: Gibt an, welche Felder des Route-Objekts in der Antwort zurückgegeben werden sollen.
• Feldmasken für die Routenmatrix berechnen
  • REST: Gibt an, welche Felder des Antworttexts zurückgegeben werden sollen.
  • gRPC: Gibt die Felder des RouteMatrixElement-Objekts in der Antwort an, die zurückgegeben werden sollen.

Feldmasken festlegen

So können Sie festlegen, welche Felder Sie verwenden möchten, und die Feldmasken dafür erstellen:

1. Fordere alle Felder an, indem du eine Feldmaske von * verwendest.
   Achtung:Sie können diese Platzhalterfeldmaske während der Entwicklung verwenden, um festzustellen, welche Felder Sie benötigen. Verwenden Sie sie jedoch nicht in der Produktion. Wenn Sie alle Felder in der Produktion anfordern, entstehen höhere Kosten und es kommt zu längeren Antwortzeiten. Ihre Kosten können sich auch unerwartet erhöhen, wenn erweiterte Funktionen hinzugefügt werden, da diese Feldmaske sie automatisch einschließt. Fordern Sie stattdessen nur die Felder an, die Sie benötigen, um Ihre Kosten zu minimieren und die Antwortzeit zu verkürzen.
2. Suchen Sie in der Antwort nach der gewünschten Feldhierarchie.

3. Erstellen Sie Ihre Feldmasken anhand der im vorherigen Schritt gezeigten Feldhierarchie in diesem Format:

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

   Hinweis:Verwenden Sie in der Liste der Feldpfade keine Leerzeichen.

Beispiel für eine Teilantwort einer Route:

"routes": [
    {
        "legs": [
            {  "steps": [
                    {"distanceMeters": 119},
                    {"distanceMeters": 41}  ]
            }
        ],
        "distanceMeters": 160
    }
]

Wenn Sie nur das Feld distanceMeters für den Streckenabschnitt zurückgeben möchten, also die letzte distanceMeters im vorherigen Beispiel, lautet die Feldmaske so:

routes.legs.distanceMeters

Wenn Sie stattdessen das Feld distanceMeters für jeden Schritt des Streckenabschnitts zurückgeben möchten, also das distanceMeters unter steps im vorherigen Beispiel, lautet die Feldmaske so:

routes.legs.steps.distanceMeters

Wenn Sie beide zurückgeben möchten, sieht die Feldmaske mit dem obigen Ergebnis so aus:

routes.legs.distanceMeters,routes.legs.steps.distanceMeters

Beispielpfade für Feldmasken

Dieser Abschnitt enthält weitere Beispiele dazu, wie Sie einen Feldpfad als Teil einer Antwortfeldmaske in REST- und gRPC-Aufrufen angeben.

REST-Aufruf an computeRoutes

Im ersten Beispiel wird ein REST-Aufruf an die Methode computeRoutes verwendet, um eine Route zu berechnen. In diesem Beispiel geben Sie im Header Feldmasken an, um die Routenfelder distanceMeters und duration in der Antwort zurückzugeben. Denken Sie daran, dem Feldnamen das Präfix routes voranzustellen.

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

REST-Aufruf an computeRouteMatrix

Geben Sie für die REST-Methode computeRouteMatrix, die zum Berechnen einer Routenmatrix verwendet wird, in der Kopfzeile an, dass für jede Kombination aus Start- und Zielort originIndex, destinationIndex und duration zurückgegeben werden sollen:

X-Goog-FieldMask: originIndex,destinationIndex,duration

gRPC-Aufruf

Legen Sie für gRPC eine Variable mit der Antwortfeldmaske fest. Sie können diese Variable dann an die Anfrage übergeben.

const (
  fieldMask = "routes.distanceMeters,routes.duration,routes.polyline.encodedPolyline"
)

Hinweise zu Feldpfaden

Fügen Sie nur die erforderlichen Felder in die Antwort ein, damit nur die erforderlichen Felder zurückgegeben werden:

• Reduziert die Verarbeitungszeiten, sodass die Ergebnisse mit einer geringeren Latenz zurückgegeben werden.
• Sorgt für eine stabile Latenzleistung. Wenn Sie alle Felder oder alle Felder auf oberster Ebene auswählen, kann es zu Leistungseinbußen kommen, wenn neue Felder hinzugefügt und dann automatisch in die Antwort eingeschlossen werden.
• Die Antwortgröße ist kleiner, was zu einem höheren Netzwerkdurchsatz führt.
• So wird verhindert, dass Sie unnötige Daten anfordern, was wiederum hilft, unnötige Verarbeitungszeiten und in Rechnung gestellte Gebühren zu vermeiden.

Hinweis:Wenn eine Antwortnachricht geparst wird und ein Feld in der Antwortnachricht seinen Standardwert enthält, wird das Feld möglicherweise aus der Antwort entfernt, auch wenn Sie es in der Antwortfeldmaske angegeben haben. Weitere Informationen finden Sie im Sprachleitfaden (proto3). Wenn Sie beispielsweise eine Routenmatrix berechnen, kann das Feld distanceMeters der Antwort den Wert 0 enthalten, den Standardwert. Da 0 der Standardwert von distanceMeters ist, wird er aus der Antwort entfernt.

Weitere Informationen zum Erstellen einer Feldmaske finden Sie in field_mask.proto.