Sélectionnez les champs à afficher

Développeurs de l'Espace économique européen (EEE)

Introduction

Lorsque vous appelez les méthodes Place Details (New), Nearby Search (New) ou Text Search (New), vous devez spécifier les champs que vous souhaitez 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 obtenir la liste complète des champs de données acceptés et de leurs SKU correspondants, consultez Champs de données de lieu (nouveau). Pour en savoir plus sur les champs spécifiques à chaque API, consultez les pages suivantes :

  • Paramètres FieldMask de Place Details (New)
  • Paramètres FieldMask de Nearby Search (New)
  • Paramètres FieldMask de Text Search (New)

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 méthode à l'aide du paramètre $fields ou fields, ou à l'aide 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.

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 corps de la réponse. Le chemin d'accès commence par le message de réponse de premier niveau et utilise un chemin d'accès séparé par des points vers le champ spécifié.

Créez un chemin de champ comme suit :

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

Vous pouvez demander tous les champs en utilisant un masque de champ *.

Pour en savoir plus sur la création de masques de champ, consultez field_mask.proto.

Déterminer les masques de champ à utiliser

Voici comment déterminer les masques de champ que vous souhaitez utiliser :

  1. Demandez tous les champs à l'aide d'un masque de champ *.
  2. Examinez la hiérarchie des champs dans la réponse et déterminez les champs que vous souhaitez utiliser.
  3. Créez votre masque de champ à l'aide de la hiérarchie des champs.

Définir un masque de champ de réponse pour Nearby Search (New) et Text Search (New)

Nearby Search (New) et Text Search (New) renvoient un tableau d'objets Place dans le champ places de la réponse. Pour ces API, places est le champ de premier niveau de la réponse.

Par exemple, pour afficher l'objet de réponse complet d'une requête Text Search (New) :

curl -X POST -d '{
  "textQuery" : "Spicy Vegetarian Food in Sydney, Australia"
}' \
-H 'Content-Type: application/json' -H 'X-Goog-Api-Key: API_KEY' \
-H 'X-Goog-FieldMask: *' \
'https://places.googleapis.com/v1/places:searchText'

L'objet de réponse complet d'un appel Text Search (New) se présente sous la forme suivante :

{
  "places": [
    {
      "name": "places/ChIJs5ydyTiuEmsR0fRSlU0C7k0",
      "id": "ChIJs5ydyTiuEmsR0fRSlU0C7k0",
      "types": [
        "vegetarian_restaurant",
        "vegan_restaurant",
        "meal_takeaway",
        "restaurant",
        "food",
        "point_of_interest",
        "establishment"
      ],
      "nationalPhoneNumber": "0433 479 794",
      "internationalPhoneNumber": "+61 433 479 794",
      "formattedAddress": "29 King St, Sydney NSW 2000, Australia",
      "displayName": {
        "text": "Spiced @ Barangaroo",
        "languageCode": "en"
      },      ...
    },
  ...
  ]
}

Par conséquent, vous spécifiez un masque de champ pour ces API sous la forme suivante :

places[.secondLevelField][.thirdLevelField][...]

Si vous souhaitez ne renvoyer que les champs formattedAddress et displayName, définissez votre masque de champ sur :

places.formattedAddress,places.displayName

La spécification de displayName inclut les champs text et language de displayName. Si vous ne souhaitez obtenir que le champ text, définissez le masque de champ comme suit :

places.formattedAddress,places.displayName.text

Définir un masque de champ de réponse pour Place Details (New)

Place Details (New) renvoie un seul objet Place au format suivant :

{
  "name": "places/ChIJkR8FdQNB0VQRm64T_lv1g1g",
  "id": "ChIJkR8FdQNB0VQRm64T_lv1g1g",
  "types": [
    "locality",
    "political"
  ],
  "formattedAddress": "Trinidad, CA 95570, USA",
  "displayName": {
    "text": "Trinidad",
    "languageCode": "en"
  }
  ...
}

Par conséquent, vous spécifiez un masque de champ pour cette API en indiquant les champs de l'objet Place que vous souhaitez renvoyer :

curl -X GET -H 'Content-Type: application/json' \
-H "X-Goog-Api-Key: API_KEY" \
-H "X-Goog-FieldMask: formattedAddress,displayName" \
https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw

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 = "places.formattedAddress,places.displayName"
)

Points à prendre en compte concernant le chemin d'accès au champ

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

  • Réduction des temps de traitement, ce qui permet de renvoyer les résultats avec une latence plus faible.
  • Garantit des performances de latence stables si l'API ajoute d'autres champs de réponse à l'avenir et que ces nouveaux champs nécessitent un temps de calcul supplémentaire. Si vous sélectionnez tous les champs, ou si vous sélectionnez tous les champs au niveau supérieur, vous risquez de constater une dégradation des performances lorsque tous les nouveaux champs sont automatiquement inclus dans votre réponse.
  • Réduit la taille de la réponse, ce qui se traduit par un débit réseau plus élevé.
  • S'assurer que vous ne demandez pas de données inutiles, ce qui permet d'éviter des temps de traitement et des frais de facturation inutiles.