Choisir les informations à renvoyer

Lorsque vous appelez une méthode pour calculer une route ou une matrice de routage, vous devez spécifier les informations que vous souhaitez en listant les champs à renvoyer dans la réponse. Il n'existe pas de liste par défaut des champs renvoyés. Si vous omettez cette liste, les méthodes renvoient une erreur.

Vous spécifiez la liste de champs en créant un masque de champ de réponse. Vous transmettez ensuite le masque de champ de réponse à l'une ou l'autre des méthodes à l'aide du paramètre d'URL $fields ou fields, ou de l'en-tête HTTP ou gRPC X-Goog-FieldMask.

Le masquage de champ est une bonne pratique à appliquer pour vous assurer de ne pas demander de données inutiles. Vous pourrez ainsi réduire le temps de traitement et les frais facturés.

Pour en savoir plus sur les paramètres d'URL, consultez la section Paramètres système.

Définir un masque de champ de réponse

Le masque de champ de réponse est une liste de chemins séparés par une virgule, où chaque chemin spécifie un champ unique dans le message de réponse. Le chemin d'accès commence à partir du message de réponse de premier niveau et utilise un chemin d'accès au champ spécifié, séparé par des points.

Créez et spécifiez un chemin d'accès de champ comme suit:

  1. Recherchez les champs qui contiennent les informations dont vous avez besoin dans l'API Routes. Pour en savoir plus, consultez Références de champ.
  2. Déterminez les chemins des champs dont vous avez besoin et créez les masques de champ correspondants: pour en savoir plus, consultez Déterminer le masque de champ que vous souhaitez utiliser.

  3. Combinez les masques de champ pour tous les champs dont vous avez besoin, en les séparant par des virgules. Par exemple, pour demander le distanceMeters de l'étape du parcours, ainsi que la durée de chaque étape du parcours, saisissez-les tous les deux, séparés par une virgule, sans espace:

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

  4. Envoyez le masque de champ avec votre requête API. Par exemple, dans une requête cURL, vous devez spécifier le masque de champ avec -H et X-Goog-FieldMask:

    -H X-Goog-FieldMask: routes.legs.distanceMeters,routes.legs.steps.duration
Pour obtenir des exemples et en savoir plus, consultez les sections suivantes.

Références de champ

Pour connaître les champs que vous pouvez demander dans une réponse à l'aide de masques de champ, consultez les références de l'API Routes indiquées dans la liste suivante. Spécifiez les champs en casse camel, comme indiqué dans la documentation de référence. Par exemple, routePreference.

Ces références incluent les champs disponibles. Toutefois, vous devez vous reporter à la hiérarchie des champs pour déterminer le chemin d'accès complet du masque de champ. Pour savoir comment obtenir la hiérarchie des champs, consultez Déterminer le masque de champ que vous souhaitez utiliser.

  • Calculer le masque de champ de route
    • REST: spécifie les champs de l'objet Route dans la réponse à renvoyer, préfixés par routes., par exemple routes.distanceMeters.
    • gRPC: spécifie les champs de l'objet Route dans la réponse à renvoyer.
  • Compute route matrix field masks

Déterminer les masques de champ à utiliser

Voici comment déterminer les champs que vous souhaitez utiliser et créer les masques de champ correspondants:

  1. Demandez tous les champs à l'aide d'un masque de champ de *.
  2. Examinez la hiérarchie des champs dans la réponse pour ceux qui vous intéressent.

  3. Créez vos masques de champ en utilisant la hiérarchie des champs affichée à l'étape précédente, selon le format suivant:

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

Par exemple, pour cette réponse partielle d'un parcours:

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

Si vous ne souhaitez renvoyer que le champ distanceMeters pour l'étape du parcours, c'est-à-dire le dernier distanceMeters de l'exemple précédent, votre masque de champ est le suivant:

routes.legs.distanceMeters

Si vous souhaitez plutôt renvoyer le champ distanceMeters pour chaque étape de l'itinéraire, c'est-à-dire le distanceMeters sous steps dans l'exemple précédent, votre masque de champ se présente comme suit:

routes.legs.steps.distanceMeters

Si vous souhaitez renvoyer les deux, avec le résultat ci-dessus, votre masque de champ est le suivant:

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

Exemples de chemins de masque de champ

Cette section contient d'autres exemples sur la façon de spécifier un chemin de champ dans un masque de champ de réponse dans les appels REST et gRPC.

Appel REST vers computeRoutes

Dans le premier exemple, vous utilisez un appel REST à la méthode computeRoutes pour calculer un itinéraire. Dans cet exemple, dans l'en-tête, vous spécifiez des masques de champ pour renvoyer les champs distanceMeters et duration de l'itinéraire dans la réponse. N'oubliez pas de préfixer le nom du champ par routes.

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

Appel REST vers computeRouteMatrix

Pour la méthode REST computeRouteMatrix utilisée pour calculer une matrice de calcul d'itinéraires, dans l'en-tête, spécifiez de renvoyer originIndex, destinationIndex et duration pour chaque combinaison d'origine et de destination:

X-Goog-FieldMask: originIndex,destinationIndex,duration

Appel gRPC

Pour gRPC, définissez une variable contenant le masque de champ de réponse. Vous pouvez ensuite transmettre cette variable à la requête.

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

Remarques concernant les chemins d'accès des champs

N'incluez que les champs dont vous avez besoin dans la réponse pour renvoyer uniquement les champs dont vous avez besoin:

  • Réduit les temps de traitement, ce qui permet de renvoyer vos résultats avec une latence plus faible.
  • Assure des performances de latence stables. Si vous sélectionnez tous les champs ou tous les champs au niveau supérieur, vous risquez de constater une dégradation des performances lorsque de nouveaux champs sont ajoutés et automatiquement inclus dans votre réponse.
  • La taille de réponse est réduite, ce qui se traduit par un débit réseau plus élevé.
  • Elle vous assure de ne pas demander de données inutiles, ce qui permet d'éviter des délais de traitement et des frais facturés inutiles.

Pour en savoir plus sur la création d'un masque de champ, consultez le fichier field_mask.proto.

Demander un jeton de parcours

Pour demander à l'API Routes de renvoyer des jetons de routage pour les routes générées, procédez comme suit:

  1. Définissez les paramètres suivants, qui sont obligatoires pour renvoyer un jeton de parcours :
    • Définissez travelMode sur DRIVE.
    • Définissez routingPreference sur TRAFFIC_AWARE ou TRAFFIC_AWARE_OPTIMAL.
  2. Vérifiez qu'aucun point de cheminement de votre itinéraire n'est via.
  3. Spécifiez le masque de champ routes.routeToken pour renvoyer un jeton de parcours: 
    X-Goog-FieldMask: routes.routeToken

Vous pouvez utiliser le jeton de route pour votre itinéraire planifié dans le SDK Navigation. Pour en savoir plus, consultez Planifier un itinéraire (Android) ou Planifier un itinéraire (iOS).

Exemple de jeton de route

Voici un exemple de corps de requête cURL pour un point de départ unique, un itinéraire à destination unique, qui utilise des masques de champ pour demander un jeton d'itinéraire, ainsi que la durée, la distance et la polyligne de l'itinéraire:

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'

Pour en savoir plus, consultez la documentation de référence de l'API Compute Routes.