Paramètres de requête

Ce document fournit une présentation claire de tous les paramètres du composant API Places Insights. Nous les examinerons en détail, et vous proposerons pratiques afin de vous aider à utiliser cet outil pour vos besoins en données géographiques.

L'API Places Insights vous permet d'effectuer plusieurs fonctions clés:

  • Compter des lieux: déterminez le nombre de lieux correspondant à des lieux tels que le type d'emplacement, le statut de l'établissement, le niveau de prix et les notes.
  • Récupérer des détails sur un lieu: obtenez les noms des lieux qui correspondent aux les filtres spécifiés, puis récupérer des informations plus détaillées à l'aide de la propriété API Places.
  • Filtrage flexible: appliquez des filtres complets pour obtenir des insights précis. Voici les filtres disponibles:
    • Zone géographique (cercle, région ou polygone personnalisé)
    • Types de lieu
    • Statut
    • Niveaux de prix
    • Plages de classification

Paramètres obligatoires

Cette section traite des paramètres requis lors de l'envoi d'une requête au API Places Insights. Chaque demande doit fournir les éléments suivants:

  • Type d'insight.
  • Un filtre de lieu et de type

Insight

Spécifie le type d'insights que vous souhaitez calculer. Les types d'insights suivants sont compatibles:

  • INSIGHT_COUNT: renvoie le nombre de lieux correspondant aux critères de filtre.
  • INSIGHT_PLACES: renvoie les ID de lieu correspondant aux critères de filtre.

Remarque: Si cette option est sélectionnée, l'API Places Insights renvoie les ID de lieu. uniquement si la valeur de count est inférieure ou égale à 100.

Filtre

Spécifie les critères de filtrage des lieux. Vous devez au minimum spécifier la LocationFilter et TypeFilter.

Filtre d'emplacement

Un filtre de lieu peut présenter l'un des types suivants:

  • circle: définit une zone sous la forme d'un cercle avec un centre et un rayon.
  • region: définit une zone en tant que région.
  • custom_area: définit une zone sous la forme d'un polygone personnalisé.
Cercle

Si vous sélectionnez votre zone géographique sous forme de cercle, vous devez fournir un center et un radius. Le centre peut être une latitude et une longitude, ou le lieu ID du centre du cercle.

  • centre:
    • lat_lng: latitude et longitude du centre du cercle. Latitudes doit être un nombre compris entre -90 et 90 inclus. La longitude doit être un nombre compris entre -180 et 180 inclus.
    • place: ID de lieu au centre du cercle. Notez que seuls les points d'accès sont pris en charge. Cette chaîne doit commencer par le préfixe places/.
  • radius: rayon du cercle en mètres. Ce nombre doit être positif.
Région

Vous pouvez définir votre zone en tant que région à l'aide du paramètre place. Utiliser un ID de lieu représentant une zone géographique (par exemple, une zone représentable par un ). Par exemple, l'ID de lieu de Tampa, FL est places/ChIJ4dG5s4K3wogRY7SWr4kTX6c

Types de régions non pris en charge
establishment place_of_worship
floor post_box
food postal_code_suffix
general_contractor room
geocode street_address
health street_number
intersection sublocality_level_5
landmark subpremise

Vous pouvez utiliser le champ types d'un appel de l'API Geocoding pour déterminer le type de lieu ou d'adresse associé à un ID de lieu (par exemple, s'il s'agit d'un ville, quartier ou pays.

Zone personnalisée

Définit la surface d'un polygone personnalisé à l'aide de coordonnées.

Vous pouvez vous rendre sur https://geojson.io/ pour dessiner un polygone personnalisé et saisir ces coordonnées dans la requête. Un polygone doit comporter au moins 4 caractères. coordonnées, où la première et la dernière sont identiques. En plus des première et dernière coordonnées, il ne doit pas y avoir d'autres coordonnées en double. Exemple :

"coordinates":[
   {
      "latitude":37.776,
      "longitude":-122.666
   },
   {
      "latitude":37.130,
      "longitude":-121.898
   },
   {
      "latitude":37.326,
      "longitude":-121.598
   },
   {
      "latitude":37.912,
      "longitude":-122.247
   },
   {
      "latitude":37.776,
      "longitude":-122.666
   }
]

Filtre de type

Spécifie les types de lieux à inclure ou à exclure. Pour obtenir la liste des adresses IP et les types de lieux secondaires compatibles avec l'API Places Insights, consultez Tableau A dans le guide Types de lieux de l'API Places (Nouveau). Au moins un type included_types ou included_primary_types doit être inclus.

  • included_types: liste des types de lieux inclus.
  • excluded_types: liste des types de lieux exclus.
  • included_primary_types: liste des principaux types de lieux inclus.
  • excluded_primary_types: liste des types de lieux principaux exclus.

Pour en savoir plus sur le fonctionnement des filtres de type et des types de lieux, consultez l'article En savoir plus sur le type filtres.

Paramètres facultatifs

Les trois autres filtres sont facultatifs:

  • operating_status: spécifie l'état des lieux à inclure ou à exclure. Le filtrage par operating_status: OPERATING_STATUS_OPERATIONAL est utilisé par défaut. (une valeur spécifique).
  • price_levels: spécifie les niveaux de prix des lieux. La valeur par défaut est "no" (tous les niveaux de prix sont inclus dans les résultats).
  • rating_filter: spécifie la plage d'évaluations des lieux. La valeur par défaut est "no" (toutes les notes sont incluses dans les résultats).

Statut

Filtrez en fonction de l'état de fonctionnement (opérationnel ou temporaire, par exemple) fermé).

Niveau de prix

Filtrez en fonction du niveau de prix (sans frais, moyen ou cher, par exemple).

Filtre "Note"

Il filtre les lieux en fonction des notes moyennes des visiteurs. Ces deux champs sont sont facultatifs. Par conséquent, s'ils sont omis, ils incluent aussi par défaut qui n'ont pas de note.

  • min_rating: note moyenne minimale des utilisateurs (entre 1 et 5).
  • max_rating: note moyenne maximale des utilisateurs (entre 1 et 5).