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.

Pour spécifier la liste des champs, créez 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.

L'utilisation d'un masque de champ est une bonne pratique à suivre pour vous assurer de ne pas demander de données inutiles, ce qui permet d'éviter le temps de traitement et les frais facturés.

Pour en savoir plus sur les paramètres d'URL, consultez la page 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 d'accès séparés par une virgule, où chaque chemin d'accès 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 d'accès 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 à utiliser.

3. Combinez les masques de champ pour tous les champs dont vous avez besoin, en les séparant par une virgule. Par exemple, pour demander le distanceMeters pour la section de l'itinéraire ainsi que la durée de chaque étape de l'itinéraire, saisissez les deux informations, séparées par une virgule, sans espaces:

   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 plus d'informations, 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 documentations de référence de l'API Routes, dont le lien figure dans la liste suivante. Spécifiez les champs en Camel Case ("casse de chameau"), comme indiqué dans la documentation de référence. Par exemple, routePreference.

En revanche, vous devez saisir les valeurs des paramètres comme indiqué. Par exemple, pour routingPreference, vous devez saisir TRAFFIC_AWARE.

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

• Calculer le masque de champ de route
  • REST: spécifie les champs de l'objet Route dans la réponse à renvoyer, précédés de routes. (par exemple, routes.distanceMeters).
  • gRPC: spécifie les champs de l'objet Route dans la réponse à renvoyer.
• Calculer les masques de champ de la matrice de routes
  • REST: spécifie les champs du corps de la réponse à renvoyer.
  • gRPC: spécifie les champs de l'objet RouteMatrixElement dans la réponse à renvoyer.

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 *.
   Attention:Bien que vous puissiez utiliser ce masque de champ générique pendant le développement pour déterminer les champs dont vous avez besoin, évitez de l'utiliser en production. Demander tous les champs en production entraîne des coûts plus élevés et des temps de réponse plus longs. Le coût peut également augmenter de manière inattendue à mesure que des fonctionnalités plus avancées sont ajoutées, car ce masque de champ les inclura automatiquement. Demandez plutôt uniquement les champs dont vous avez besoin pour réduire vos coûts et votre temps de réponse.
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 présentée à l'étape précédente, en utilisant le format suivant:

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

   Remarque:N'utilisez pas d'espaces dans la liste des chemins d'accès aux champs.

Par exemple, pour cette réponse partielle à partir d'une route:

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

Si vous souhaitez renvoyer uniquement le champ distanceMeters pour la section de l'itinéraire, c'est-à-dire le dernier distanceMeters de l'échantillon précédent, votre masque de champ se présentera comme suit:

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 se présente comme suit:

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

Exemples de chemins d'accès au masque de champ

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

Appel REST à 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 d'ajouter le préfixe routes au nom du champ.

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

Appel REST à computeRouteMatrix

Pour la méthode REST computeRouteMatrix utilisée pour calculer une matrice de routage, dans l'en-tête, spécifiez pour renvoyer originIndex, destinationIndex et duration pour chaque combinaison de point de départ 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

Incluez uniquement les champs dont vous avez besoin dans la réponse pour ne renvoyer que les champs dont vous avez besoin:

• Réduit les temps de traitement afin que les résultats soient renvoyés avec une latence plus faible.
• Garantit 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, puis sont 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 permet de ne pas demander de données inutiles, ce qui permet d'éviter des délais de traitement et des frais facturés inutiles.

Remarque:Lorsqu'un message de réponse est analysé et qu'un champ du message de réponse contient sa valeur par défaut, ce champ peut être omis de la réponse, même si vous l'avez spécifié dans le masque de champ de réponse. Pour en savoir plus, consultez le guide du langage (proto3). Par exemple, lorsque vous calculez une matrice de routage, le champ distanceMeters de la réponse peut contenir la valeur 0, sa valeur par défaut. Comme 0 est la valeur par défaut de distanceMeters, elle est omise de la réponse.

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

Demander un jeton de routage

Pour demander que l'API Routes renvoie des jetons de route 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 route :
   • 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 route :

   X-Goog-FieldMask: routes.routeToken

Remarque:En raison de l'état dynamique des routes, les itinéraires générés avec un jeton donné peuvent différer de l'itinéraire planifié. Pour minimiser les différences, utilisez le jeton dans les minutes suivant sa génération.

Vous pouvez utiliser le jeton d'itinéraire 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.