Package google.maps.areainsights.v1

Índice

AreaInsights

Definición del servicio para la RPC de Places Aggregate.

ComputeInsights

rpc ComputeInsights(ComputeInsightsRequest) returns (ComputeInsightsResponse)

Este método te permite recuperar estadísticas sobre las áreas con una variedad de filtros, como área, tipo de lugar, estado de funcionamiento, nivel de precios y calificaciones. Actualmente, se admiten las estadísticas "count" y "places". Con las estadísticas de "count", puedes responder preguntas como "¿Cuántos restaurantes están ubicados en California, están en funcionamiento, son económicos y tienen una calificación promedio de al menos 4 estrellas?" (consulta la enumeración insight para obtener más detalles). Con las estadísticas de "lugares", puedes determinar qué lugares coinciden con el filtro solicitado. Luego, los clientes pueden usar esos nombres de recursos de lugar para recuperar más detalles sobre cada lugar individual con la API de Places.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

ComputeInsightsRequest

Solicitud de la RPC de ComputeInsights.

Campos
insights[]

Insight

Obligatorio. Estadísticas para calcular. Actualmente, solo se admiten INSIGHT_COUNT y INSIGHT_PLACES.

filter

Filter

Obligatorio. Filtro de estadísticas.

ComputeInsightsResponse

Respuesta para la RPC de ComputeInsights.

Campos
place_insights[]

PlaceInsight

Resultado de Insights.INSIGHT_PLACES.

count

int64

Resultado de Insights.INSIGHT_COUNT.

Filtrar

Son filtros para la RPC de ComputeInsights.

Campos
location_filter

LocationFilter

Obligatorio. Restringe los resultados a los lugares que se encuentran en el área especificada por los filtros de ubicación.

type_filter

TypeFilter

Obligatorio. Filtros de tipo de lugar

operating_status[]

OperatingStatus

Opcional. Restringe los resultados a los lugares cuyo estado de funcionamiento se incluye en esta lista. Si no se establece operating_status, se usa OPERATING_STATUS_OPERATIONAL de forma predeterminada.

price_levels[]

PriceLevel

Opcional. Restringe los resultados a los lugares cuyo nivel de precios se incluye en esta lista. Si no se configura price_levels, todos los niveles de precios se incluyen en los resultados.

rating_filter

RatingFilter

Opcional. Restringe los resultados a los lugares cuyas calificaciones promedio de los usuarios se encuentran en el rango especificado por rating_filter. Si no se establece rating_filter, se incluyen todas las calificaciones en el resultado.

Estadística

Estadísticas admitidas

Enumeraciones
INSIGHT_UNSPECIFIED No especificado.
INSIGHT_COUNT

Estadística de recuento

Cuando se especifica esta estadística, ComputeInsights muestra la cantidad de lugares que coinciden con los criterios de filtro especificados.

Solicitud de ejemplo:

{
  "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
    }
  }
}

Respuesta de ejemplo:

{
  "count": 1234
}
INSIGHT_PLACES

Lugares de devolución

Cuando se especifica esta estadística, ComputeInsights muestra los IDs de lugares que coinciden con los criterios de filtro especificados.

Solicitud de ejemplo:

{
  "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
    }
  }
}

Respuesta de ejemplo:

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

LocationFilter

Filtros de ubicación

Especifica el área de interés para la estadística.

Campos
Campo de unión area. Se debe especificar una de las siguientes opciones. Las direcciones (area) solo pueden ser una de las siguientes opciones:
circle

Circle

Área como un círculo

region

Region

Área como región

custom_area

CustomArea

Es un área personalizada especificada por un polígono.

Círculo

Un círculo se define por un punto central y un radio en metros.

Campos
radius

int32

Opcional. El radio del círculo en metros

Campo de unión center. El centro del círculo. Las direcciones (center) solo pueden ser una de las siguientes opciones:
lat_lng

LatLng

La latitud y longitud del centro del círculo.

place

string

Formato: Debe tener el formato places/PLACE_ID, en el que PLACE_ID es el identificador único de un lugar. Por ejemplo: places/ChIJgUbEo8cfqokR5lP9_Wh_DaM.

CustomArea

Área personalizada.

Campos
polygon

Polygon

Obligatorio. El área personalizada representada como un polígono

Polígono

Un polígono se representa con una serie de coordenadas conectadas en una secuencia ordenada en sentido contrario a las manecillas del reloj. Las coordenadas forman un bucle cerrado y definen una región rellena. La primera y la última coordenada son equivalentes y deben contener valores idénticos. El formato es una versión simplificada de los polígonos GeoJSON (solo admitimos un anillo exterior en sentido antihorario).

Campos
coordinates[]

LatLng

Opcional. Las coordenadas que definen el polígono.

Región

Una región es un límite geográfico, como ciudades, códigos postales, condados, estados, etcétera.

Campos
Campo de unión region. Define una región geográfica. Solo se puede especificar un tipo de región (p.ej., lugar) a la vez. Las direcciones (region) solo pueden ser una de las siguientes opciones:
place

string

Es el identificador único de una región geográfica específica.

OperatingStatus

Es el estado operativo del lugar.

Enumeraciones
OPERATING_STATUS_UNSPECIFIED No se especifica. No se debe usar este valor.
OPERATING_STATUS_OPERATIONAL El lugar está en funcionamiento y está abierto durante el horario definido.
OPERATING_STATUS_PERMANENTLY_CLOSED El lugar ya no está en funcionamiento.
OPERATING_STATUS_TEMPORARILY_CLOSED El lugar está cerrado temporalmente y se espera que vuelva a abrir en el futuro.

PlaceInsight

Contiene información sobre un lugar.

Campos
place

string

Es el identificador único del lugar. Este nombre de recurso se puede usar para recuperar detalles sobre el lugar con la API de Places.

PriceLevel

Es el nivel de precios del lugar.

Enumeraciones
PRICE_LEVEL_UNSPECIFIED No se especifica. No se debe usar este valor.
PRICE_LEVEL_FREE El lugar ofrece servicios gratuitos.
PRICE_LEVEL_INEXPENSIVE El lugar ofrece servicios económicos.
PRICE_LEVEL_MODERATE El lugar ofrece servicios a precios moderados.
PRICE_LEVEL_EXPENSIVE El lugar ofrece servicios costosos.
PRICE_LEVEL_VERY_EXPENSIVE El lugar ofrece servicios muy costosos.

RatingFilter

Filtros de calificación promedio de los usuarios

Campos
min_rating

float

Opcional. Restringe los resultados a los lugares cuya calificación promedio de los usuarios sea mayor o igual que min_rating. Los valores deben estar entre 1.0 y 5.0.

max_rating

float

Opcional. Restringe los resultados a los lugares cuya calificación promedio de los usuarios sea estrictamente menor o igual a max_rating. Los valores deben estar entre 1.0 y 5.0.

TypeFilter

Filtros de tipo de lugar

Solo se admiten los tipos de Place de la Tabla a.

Un lugar solo puede tener un tipo principal asociado. Por ejemplo, el tipo principal podría ser "restaurante_mexicano" o "parrillada". Usa included_primary_types y excluded_primary_types para filtrar los resultados según el tipo principal de un lugar.

Un lugar también puede tener varios valores de tipo asociados. Por ejemplo, un restaurante puede tener los siguientes tipos: "seafood_restaurant", "restaurant", "food", "point_of_interest", "establishment". Usa included_types y excluded_types para filtrar los resultados en la lista de tipos asociados con un lugar.

Si se especifica una búsqueda con varias restricciones de tipo, solo se muestran los lugares que satisfacen todas las restricciones. Por ejemplo, si especificas {"included_types": ["restaurant"], "excluded_primary_types": ["steak_house"]}, los lugares que se muestran proporcionan servicios relacionados con "restaurant", pero no operan principalmente como "steak_house".

Si hay tipos en conflicto, es decir, un tipo aparece en los tipos included_types y excluded_types, o en included_primary_types y excluded_primary_types, se muestra un error INVALID_ARGUMENT.

Se debe establecer uno de los siguientes valores: included_types o included_primary_types.

Campos
included_types[]

string

Opcional. Tipos de lugares incluidos

excluded_types[]

string

Opcional. Tipos de lugares excluidos

included_primary_types[]

string

Opcional. Se incluyeron los tipos de Place principales.

excluded_primary_types[]

string

Opcional. Tipos de Place principales excluidos