Package google.maps.areainsights.v1

Index

AreaInsights

Définition de service pour l'appel RPC Places Aggregate.

ComputeInsights

rpc ComputeInsights(ComputeInsightsRequest) returns (ComputeInsightsResponse)

Cette méthode vous permet de récupérer des insights sur les zones à l'aide de différents filtres, tels que la zone, le type d'établissement, l'état de fonctionnement, le niveau de prix et les notes. Actuellement, les insights "count" (nombre) et "places" (lieux) sont acceptés. Les insights "count" vous permettent de répondre à des questions telles que "Combien de restaurants en Californie sont opérationnels, abordables et ont une note moyenne d'au moins quatre étoiles ?" (pour en savoir plus, consultez l'énumération insight). Les insights sur les lieux vous permettent de déterminer les lieux correspondant au filtre demandé. Les clients peuvent ensuite utiliser ces noms de ressources de lieu pour obtenir plus d'informations sur chaque lieu à l'aide de l'API Places.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

ComputeInsightsRequest

Requête pour le RPC ComputeInsights.

Champs
insights[]

Insight

Obligatoire. Insights à calculer. Actuellement, seuls INSIGHT_COUNT et INSIGHT_PLACES sont acceptés.
filter

Filter

Obligatoire. Filtre des insights.

ComputeInsightsResponse

Réponse pour l'RPC ComputeInsights.

Champs
place_insights[]

PlaceInsight

Résultat pour Insights.INSIGHT_PLACES.
count

int64

Résultat pour Insights.INSIGHT_COUNT.

Filtre

Filtres pour l'RPC ComputeInsights.

Champs
location_filter

LocationFilter

Obligatoire. Limite les résultats aux lieux situés dans la zone spécifiée par les filtres de localisation.
type_filter

TypeFilter

Obligatoire. Filtres de type de lieu
operating_status[]

OperatingStatus

Facultatif. Limite les résultats aux lieux dont l'état de fonctionnement est inclus dans cette liste. Si le champ "operating_status" n'est pas défini, la valeur OPERATING_STATUS_OPERATIONAL est utilisée par défaut.
price_levels[]

PriceLevel

Facultatif. Limite les résultats aux lieux dont le niveau de prix figure dans cette liste. Si price_levels n'est pas défini, tous les niveaux de prix sont inclus dans les résultats.
rating_filter

RatingFilter

Facultatif. Limite les résultats aux lieux dont les notes moyennes des utilisateurs se situent dans la plage spécifiée par rating_filter. Si rating_filter n'est pas défini, toutes les notes sont incluses dans le résultat.

Insight

Insights disponibles

Enums
INSIGHT_UNSPECIFIED Non spécifié.
INSIGHT_COUNT

Insight sur le nombre

Lorsque cet insight est spécifié, ComputeInsights renvoie le nombre d'établissements correspondant aux critères de filtrage spécifiés.

Exemple de requête :

{
  "insights": ["INSIGHT_COUNT"],
  "filter": {
    "locationFilter": {
      "region": {
        "place": "places/ChIJPV4oX_65j4ARVW8IJ6IJUYs"
      }
    },
    "typeFilter": {
      "includedTypes": ["restaurant"]
    },
    "operatingStatus": ["OPERATING_STATUS_OPERATIONAL"],
    "priceLevels": [
      "PRICE_LEVEL_FREE",
      "PRICE_LEVEL_INEXPENSIVE"
    ],
    "ratingFilter": {
      "minRating": 4.0
    }
  }
}

Exemple de réponse :

{
  "count": 1234
}
INSIGHT_PLACES

Adresses de retour

Lorsque cet insight est spécifié, ComputeInsights renvoie les ID de lieux correspondant aux critères de filtre spécifiés.

Exemple de requête :

{
  "insights": ["INSIGHT_PLACES"],
  "filter": {
    "locationFilter": {
      "region": {
        "place": "places/ChIJPV4oX_65j4ARVW8IJ6IJUYs"
      }
    },
    "typeFilter": {
      "includedTypes": ["restaurant"]
    },
    "operatingStatus": ["OPERATING_STATUS_OPERATIONAL"],
    "priceLevels": [
      "PRICE_LEVEL_FREE",
      "PRICE_LEVEL_INEXPENSIVE"
    ],
    "ratingFilter": {
      "minRating": 4.0
    }
  }
}

Exemple de réponse :

{
  "placeInsights": [
    {"place": "places/ABC"},
    {"place": "places/PQR"},
    {"place": "places/XYZ"}
  ]
}

LocationFilter

Filtres de lieux

Spécifie la zone d'intérêt de l'insight.

Champs
Champ d'union area. L'une des options suivantes doit être spécifiée. area ne peut être qu'un des éléments suivants :
circle

Circle

Aire sous forme de cercle.
region

Region

Zone en tant que région.
custom_area

CustomArea

Zone personnalisée spécifiée par un polygone.

Cercle

Un cercle est défini par un point central et un rayon en mètres.

Champs
radius

int32

Facultatif. Rayon du cercle en mètres
Champ d'union center. Centre du cercle. center ne peut être qu'un des éléments suivants :
lat_lng

LatLng

Latitude et longitude du centre du cercle.
place

string

Format:doit être au format places/PLACE_ID, où PLACE_ID est l'identifiant unique d'un lieu. Exemple : places/ChIJgUbEo8cfqokR5lP9_Wh_DaM

CustomArea

Zone personnalisée

Champs
polygon

Polygon

Obligatoire. Zone personnalisée représentée sous forme de polygone

Polygone

Un polygone est représenté par une série de coordonnées connectées dans une séquence ordonnée dans le sens antihoraire. Les coordonnées forment une boucle fermée et définissent une région remplie. Les premières et dernières coordonnées sont équivalentes et doivent contenir des valeurs identiques. Il s'agit d'une version simplifiée des polygones GeoJSON (un seul anneau extérieur dans le sens antihoraire est accepté).

Champs
coordinates[]

LatLng

Facultatif. Coordonnées qui définissent le polygone.

Région

Une région est une limite géographique, comme une ville, un code postal, un comté ou un État.

Champs
Champ d'union region. Définit une région géographique. Vous ne pouvez spécifier qu'un seul type de région (par exemple, un lieu) à la fois. region ne peut être qu'un des éléments suivants :
place

string

Identifiant unique d'une région géographique spécifique.

OperatingStatus

État de fonctionnement du lieu.

Enums
OPERATING_STATUS_UNSPECIFIED Non spécifié. Cette valeur ne doit pas être utilisée.
OPERATING_STATUS_OPERATIONAL L'établissement est opérationnel et ouvert aux heures définies.
OPERATING_STATUS_PERMANENTLY_CLOSED L'établissement n'est plus en activité.
OPERATING_STATUS_TEMPORARILY_CLOSED Cet établissement est temporairement fermé et devrait rouvrir à l'avenir.

PlaceInsight

Contient des informations sur un lieu

Champs
place

string

Identifiant unique du lieu. Ce nom de ressource permet de récupérer des informations sur le lieu à l'aide de l'API Places.

PriceLevel

Niveau de prix du lieu.

Enums
PRICE_LEVEL_UNSPECIFIED Non spécifié. Cette valeur ne doit pas être utilisée.
PRICE_LEVEL_FREE L'établissement propose des services sans frais.
PRICE_LEVEL_INEXPENSIVE L'établissement propose des services abordables.
PRICE_LEVEL_MODERATE L'établissement propose des services à des prix modérés.
PRICE_LEVEL_EXPENSIVE L'établissement propose des services onéreux.
PRICE_LEVEL_VERY_EXPENSIVE L'établissement propose des services très onéreux.

RatingFilter

Filtres de note moyenne des utilisateurs.

Champs
min_rating

float

Facultatif. Limite les résultats aux lieux dont la note moyenne est supérieure ou égale à min_rating. Les valeurs doivent être comprises entre 1,0 et 5,0.
max_rating

float

Facultatif. Limite les résultats aux lieux dont la note moyenne est strictement inférieure ou égale à max_rating. Les valeurs doivent être comprises entre 1,0 et 5,0.

TypeFilter

Filtres de type de lieu

Seuls les types de lieux du tableau a sont acceptés.

Un lieu ne peut être associé qu'à un seul type principal. Par exemple, le type principal peut être "restaurant_mexicain" ou "steakhouse". Utilisez included_primary_types et excluded_primary_types pour filtrer les résultats en fonction du type principal d'un lieu.

Un lieu peut également être associé à plusieurs valeurs de type. Par exemple, un restaurant peut avoir les types suivants: "seafood_restaurant", "restaurant", "food", "point_of_interest" et "establishment". Utilisez included_types et excluded_types pour filtrer les résultats de la liste des types associés à un lieu.

Si une recherche est spécifiée avec plusieurs restrictions de type, seules les zones géographiques qui répondent à toutes les restrictions sont renvoyées. Par exemple, si vous spécifiez {"included_types": ["restaurant"], "excluded_primary_types": ["steak_house"]}, les lieux affichés proposent des services liés à un "restaurant", mais ne sont pas principalement des "steak_house".

Si des types sont en conflit, c'est-à-dire qu'un type apparaît à la fois dans les types "included_types" et "excluded_types" ou "included_primary_types" et "excluded_primary_types", une erreur INVALID_ARGUMENT est renvoyée.

L'un des éléments "included_types" ou "included_primary_types" doit être défini.

Champs
included_types[]

string

Facultatif. Types de lieux inclus.
excluded_types[]

string

Facultatif. Types de lieux exclus.
included_primary_types[]

string

Facultatif. Ajout des principaux types de lieux.
excluded_primary_types[]

string

Facultatif. Types de lieux principaux exclus