Wählen Sie aus, welche Informationen zurückgegeben werden sollen

Wenn Sie eine Methode aufrufen, um eine Route oder Routenmatrix zu berechnen, müssen Sie angeben, welche Informationen Sie erhalten möchten, indem Sie die Felder in der Antwort zurückgegeben werden. Es gibt keine Standardliste der zurückgegebenen Felder. Wenn Sie diese Liste weglassen, geben die Methoden einen Fehler zurück.

Zum Angeben der Feldliste erstellen Sie eine Antwortfeldmaske. Sie bestehen dann die Antwortfeldmaske auf eine der beiden Methoden mithilfe des URL-Parameters $fields oder fields oder mithilfe des HTTP- oder gRPC-Headers X-Goog-FieldMask.

Die Verwendung einer Feldmaske ist eine gute Designpraxis, um sicherzustellen, dass Sie keine und unnötige Daten, was wiederum dazu beiträgt, unnötige Verarbeitungszeiten und in Rechnung gestellte Kosten zu vermeiden.

Weitere Informationen zu URL-Parametern finden Sie unter Systemparameter.

Antwortfeldmaske definieren

Die Antwortfeldmaske ist eine durch Kommas getrennte Liste von Pfaden, in denen jeder Pfad path gibt ein eindeutiges Feld in der Antwortnachricht an. Der Pfad beginnt mit der Antwortnachricht der obersten Ebene und enthält durch einen Punkt getrennte Pfad zum angegebenen Feld.

Erstellen Sie einen Feldpfad und geben Sie ihn so an:

  1. Suchen Sie die Felder mit den benötigten Informationen aus der Routes API. Weitere Informationen findest du unter Feldverweise.
  2. Pfade für die benötigten Felder bestimmen und Feldmasken dafür erstellen: Weitere Informationen finden Sie unter Zu verwendende Feldmaske bestimmen.
  3. Kombinieren Sie die Feldmasken für alle benötigten Felder und trennen Sie die Feldmasken durch Kommas. Wenn Sie beispielsweise die distanceMeters für den Routenabschnitt und die Dauer für jeden Routenabschnitt anfordern möchten, geben Sie beide 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 würden Sie beispielsweise die Feldmaske mit -H und X-Goog-FieldMask angeben:

    -H X-Goog-FieldMask: routes.legs.distanceMeters,routes.legs.steps.duration
Beispiele und weitere Informationen finden Sie in den folgenden Abschnitten.

Feldverweise

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

Diese Referenzen umfassen die verfügbaren Felder. Sie müssen sich jedoch auf die Hierarchie der Felder beziehen, um den vollständigen Feldmaskenpfad zu ermitteln. Weitere Informationen zum Abrufen der Hierarchie der Felder finden Sie im Hilfeartikel Welche Feldmaske soll verwendet werden?.

  • Feldmaske für Compute-Route
    • REST: Gibt die Felder der Route-Objekt im Antwort mit dem Präfix routes., z. B.: routes.distanceMeters.
    • gRPC: Gibt die Felder der Route-Objekt im die zurückgegeben werden soll.
  • Feldmasken der Routenmatrix berechnen

Bestimmen, welche Feldmasken verwendet werden sollen

So legen Sie fest, welche Felder Sie verwenden möchten, und erstellen die Feldmasken:

  1. Alle Felder anfordern mit einer Feldmaske von *.
  2. Sehen Sie sich die Hierarchie der Felder in der Antwort an. die gewünschten Felder hinzu.
  3. Erstellen Sie Ihre Feldmasken unter Verwendung der im vorherigen Schritt gezeigten Hierarchie der Felder im folgenden Format:

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

Für diese Teilantwort von einer Route gilt beispielsweise Folgendes:

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

So geben Sie für den Routenabschnitt nur das Feld distanceMeters zurück: Das heißt, die Feldmaske im letzten distanceMeters im vorherigen Beispiel lautet so:

routes.legs.distanceMeters

Wenn Sie stattdessen das Feld distanceMeters für jeden Schritt des Routenabschnitts zurückgeben möchten, Das heißt, der distanceMeters unter steps im vorherigen Beispiel lautet Ihre Feldmaske:

routes.legs.steps.distanceMeters

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

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

Beispiele für Feldmaskenpfade

Dieser Abschnitt enthält weitere Beispiele zum Angeben eines Feldpfads als Teil einer Antwortfeldmaske in REST- und gRPC-Aufrufen.

REST-Aufruf an computeRoutes

Im ersten Beispiel verwenden Sie einen REST-Aufruf an die computeRoutes-Methode zur Berechnung eine Route 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 routes voranzustellen.

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

REST-Aufruf an computeRouteMatrix

Für REST computeRouteMatrix -Methode zur Berechnung einer Routenmatrix. Geben Sie im Header an, dass die Daten zurückgegeben werden sollen. originIndex, destinationIndex und duration für jede Ursprungskombination und Ziel:

X-Goog-FieldMask: originIndex,destinationIndex,duration

gRPC-Aufruf

Legen Sie für gRPC eine Variable fest, die die Antwortfeldmaske enthält. Sie können diese Variable dann an die Anfrage übergeben.

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

Überlegungen zu Feldpfaden

Nehmen Sie nur die Felder in die Antwort auf, die Sie benötigen, um nur das Feld die Sie benötigen:

  • Verringert die Verarbeitungszeiten, sodass Ihre Ergebnisse mit einer geringeren Latenz zurückgegeben werden.
  • Sorgt für eine stabile Latenzleistung. Wenn Sie oder alle Felder auf der obersten Ebene auswählen, kann es zu Leistungseinbußen kommen, wenn neue Felder hinzugefügt werden. automatisch in Ihrer Antwort enthalten.
  • Ergibt eine kleinere Antwortgröße, was zu einem höheren Netzwerkdurchsatz führt.
  • Sorgt dafür, dass keine unnötigen Daten angefordert werden, um unnötige Verarbeitungszeiten und in Rechnung gestellte Kosten zu vermeiden.

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

Routingtoken anfordern

So fordern Sie an, dass die Routes API Routentokens für generierte Routen zurückgibt:

  1. Legen Sie die folgenden Parameter fest, die erforderlich sind, um ein Routentoken zurückzugeben:
    • Setzen Sie travelMode auf DRIVE.
    • Legen Sie routingPreference auf TRAFFIC_AWARE oder TRAFFIC_AWARE_OPTIMAL fest.
  2. Achten Sie darauf, dass keiner der Wegpunkte Ihrer Route via-Wegpunkte ist.
  3. Geben Sie die Feldmaske routes.routeToken an, um ein Routentoken zurückzugeben:
    X-Goog-FieldMask: routes.routeToken

Sie können das Routentoken für Ihre geplante Route im Navigation SDK verwenden. Weitere Informationen finden Sie unter Route planen (Android) oder Route planen (iOS)

Beispiel für Routentoken

Hier ist ein Beispiel für einen cURL-Anfragetext für einen einzelnen Start- und Zielort Route mit Feldmasken zum Anfordern eines Routing-Tokens zusammen mit der Route Dauer, Entfernung und Polylinienlinie der Route:

curl -X POST -d
{"origin":{
    "location": {
        "latLng":{
            "latitude":  -37.8167,
            "longitude": 144.9619
        }
    }
},
"destination":{
    "location": {
        "latLng":{
            "latitude":-37.8155,
            "longitude": 144.9663
        }
    }
},
"routingPreference":"TRAFFIC_AWARE",
"travelMode":"DRIVE"
}
-H 'X-Goog-Api-Key: YOUR_API_KEY' \
-H X-Goog-FieldMask: routes.routeToken,routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline
'https://routes.googleapis.com/directions/v2:computeRoutes'

Weitere Informationen finden Sie in der Referenz zur Compute Routes API