- HTTP request
- Request body
- Response body
- Authorization scopes
- Insight
- Filter
- LocationFilter
- Circle
- LatLng
- Region
- CustomArea
- Polygon
- TypeFilter
- OperatingStatus
- PriceLevel
- RatingFilter
- PlaceInsight
Compute Insights RPC
This method lets you retrieve insights about areas using a variaty of filter such as: area, place type, operating status, price level and ratings. Currently "count" and "places" insights are supported. With "count" insights you can answer questions such as "How many restaurant are located in California that are operational, are inexpensive and have an average rating of at least 4 stars" (see insight
enum for more details). With "places" insights, you can determine which places match the requested filter. Clients can then use those place resource names to fetch more details about each individual place using the Places API.
HTTP request
POST https://areainsights.googleapis.com/v1:computeInsights
The URL uses gRPC Transcoding syntax.
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "insights": [ enum ( |
Fields | |
---|---|
insights[] |
Required. Insights to compute. Currently only INSIGHT_COUNT and INSIGHT_PLACES are supported. |
filter |
Required. Insight filter. |
Response body
Response for the v1.computeInsights RPC.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"placeInsights": [
{
object ( |
Fields | |
---|---|
placeInsights[] |
Result for Insights.INSIGHT_PLACES. |
count |
Result for Insights.INSIGHT_COUNT. |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
Insight
Supported insights.
Enums | |
---|---|
INSIGHT_UNSPECIFIED |
Not Specified. |
INSIGHT_COUNT |
Count insight. When this insight is specified v1.computeInsights returns the number of places that match the specified filter criteria.
|
INSIGHT_PLACES |
Return Places When this insight is specified v1.computeInsights returns Places that match the specified filter criteria.
|
Filter
Filters for the v1.computeInsights RPC.
JSON representation |
---|
{ "locationFilter": { object ( |
Fields | |
---|---|
locationFilter |
Required. Restricts results to places which are located in the area specified by location filters. |
typeFilter |
Required. Place type filters. |
operatingStatus[] |
Optional. Restricts results to places whose operating status is included on this list. If operatingStatus is not set, OPERATING_STATUS_OPERATIONAL is used as default. |
priceLevels[] |
Optional. Restricts results to places whose price level is included on this list. If price_level is not set, all price levels are included in the results. |
ratingFilter |
Optional. Restricts results to places whose average user ratings are in the range specified by ratingFilter. If ratingFilter is not set, all ratings are included in the result. |
LocationFilter
Location filters.
Specifies the area of interest for the insight.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field area . One of the following must be specified. area can be only one of the following: |
|
circle |
Area as a circle. |
region |
Area as region. |
customArea |
Custom area specified by a polygon. |
Circle
A circle is defined by a center point and radius in meters.
JSON representation |
---|
{ "radius": integer, // Union field |
Fields | |
---|---|
radius |
Optional. The radius of the circle in meters |
Union field center . The center of the circle. center can be only one of the following: |
|
latLng |
The latitude and longitude of the center of the circle. |
place |
The Place resource name of the center of the circle. Only point places are supported. |
LatLng
An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.
JSON representation |
---|
{ "latitude": number, "longitude": number } |
Fields | |
---|---|
latitude |
The latitude in degrees. It must be in the range [-90.0, +90.0]. |
longitude |
The longitude in degrees. It must be in the range [-180.0, +180.0]. |
Region
A region is a geographic boundary such as: cities, postal codes, counties, states, etc.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field region . Defines a geographic region. Only one type of region (e.g. place) can specified at a time. region can be only one of the following: |
|
place |
The unique identifier of a specific geographic region. |
CustomArea
Custom Area.
JSON representation |
---|
{
"polygon": {
object ( |
Fields | |
---|---|
polygon |
Required. The custom area represented as a polygon |
Polygon
A polygon is represented by a series of connected coordinates in an counterclockwise ordered sequence. The coordinates form a closed loop and define a filled region. The first and last coordinates are equivalent, and they must contain identical values. The format is a simplified version of GeoJSON polygons (we only support one counterclockwise exterior ring).
JSON representation |
---|
{
"coordinates": [
{
object ( |
Fields | |
---|---|
coordinates[] |
Optional. The coordinates that define the polygon. |
TypeFilter
Place type filters.
Only Place types from Table a are supported.
A place can only have a single primary type associated with it. For example, the primary type might be "mexican_restaurant" or "steak_house". Use includedPrimaryTypes and excludedPrimaryTypes to filter the results on a place's primary type.
A place can also have multiple type values associated with it. For example a restaurant might have the following types: "seafood_restaurant", "restaurant", "food", "point_of_interest", "establishment". Use includedTypes and excludedTypes to filter the results on the list of types associated with a place.
If a search is specified with multiple type restrictions, only places that satisfy all of the restrictions are returned. For example, if you specify {"includedTypes": ["restaurant"], "excludedPrimaryTypes": ["steak_house"]}, the returned places provide "restaurant" related services but do not operate primarily as a "steak_house".
If there are any conflicting types, i.e. a type appears in both includedTypes and excludedTypes types or includedPrimaryTypes and excludedPrimaryTypes, an INVALID_ARGUMENT error is returned.
One of includedTypes or includedPrimaryTypes must be set.
JSON representation |
---|
{ "includedTypes": [ string ], "excludedTypes": [ string ], "includedPrimaryTypes": [ string ], "excludedPrimaryTypes": [ string ] } |
Fields | |
---|---|
includedTypes[] |
Optional. Included Place types. |
excludedTypes[] |
Optional. Excluded Place types. |
includedPrimaryTypes[] |
Optional. Included primary Place types. |
excludedPrimaryTypes[] |
Optional. Excluded primary Place types. |
OperatingStatus
Operating status of the place.
Enums | |
---|---|
OPERATING_STATUS_UNSPECIFIED |
Not Specified. |
OPERATING_STATUS_OPERATIONAL |
The place is operational and its open during its defined hours. |
OPERATING_STATUS_PERMANENTLY_CLOSED |
The Place is no longer in business. |
OPERATING_STATUS_TEMPORARILY_CLOSED |
The Place is temporarily closed and expected to reopen in the future. |
PriceLevel
Price level of the place.
Enums | |
---|---|
PRICE_LEVEL_UNSPECIFIED |
Place price level is unspecified or unknown. |
PRICE_LEVEL_FREE |
Place provides free services. |
PRICE_LEVEL_INEXPENSIVE |
Place provides inexpensive services. |
PRICE_LEVEL_MODERATE |
Place provides moderately priced services. |
PRICE_LEVEL_EXPENSIVE |
Place provides expensive services. |
PRICE_LEVEL_VERY_EXPENSIVE |
Place provides very expensive services. |
RatingFilter
Average user rating filters.
JSON representation |
---|
{ "minRating": number, "maxRating": number } |
Fields | |
---|---|
minRating |
Optional. Restricts results to places whose average user rating is greater than or equal to minRating. Values must be between 1.0 and 5.0. |
maxRating |
Optional. Restricts results to places whose average user rating is strictly less than or equal to maxRating. Values must be between 1.0 and 5.0. |
PlaceInsight
Holds information about a place
JSON representation |
---|
{ "place": string } |
Fields | |
---|---|
place |
The unique identifier of the place. This resource name can be used to retrieve details about the place using the Places API. |