Places Insights API . v1

close()

Close httplib2 connections.

computeInsights(body=None, x__xgafv=None)

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.

Args:
  body: object, The request body.
    The object takes the form of:

{ # Request for the ComputeInsights RPC.
  "filter": { # Filters for the ComputeInsights RPC. # Required. Insight filter.
    "locationFilter": { # Location filters. Specifies the area of interest for the insight. # Required. Restricts results to places which are located in the area specified by location filters.
      "circle": { # A circle is defined by a center point and radius in meters. # Area as a circle.
        "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. # The latitude and longitude of the center of the circle.
          "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
          "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
        },
        "place": "A String", # **Format:** Must be in the format `places/PLACE_ID`, where `PLACE_ID` is the unique identifier of a place. For example: `places/ChIJgUbEo8cfqokR5lP9_Wh_DaM`.
        "radius": 42, # Optional. The radius of the circle in meters
      },
      "customArea": { # Custom Area. # Custom area specified by 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). # Required. The custom area represented as a polygon
          "coordinates": [ # Optional. The coordinates that define the polygon.
            { # 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.
              "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
              "longitude": 3.14, # 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. # Area as region.
        "place": "A String", # The unique identifier of a specific geographic region.
      },
    },
    "operatingStatus": [ # Optional. Restricts results to places whose operating status is included on this list. If operating_status is not set, OPERATING_STATUS_OPERATIONAL is used as default.
      "A String",
    ],
    "priceLevels": [ # Optional. Restricts results to places whose price level is included on this list. If `price_levels` is not set, all price levels are included in the results.
      "A String",
    ],
    "ratingFilter": { # Average user rating filters. # Optional. Restricts results to places whose average user ratings are in the range specified by rating_filter. If rating_filter is not set, all ratings are included in the result.
      "maxRating": 3.14, # Optional. Restricts results to places whose average user rating is strictly less than or equal to max_rating. Values must be between 1.0 and 5.0.
      "minRating": 3.14, # Optional. Restricts results to places whose average user rating is greater than or equal to min_rating. Values must be between 1.0 and 5.0.
    },
    "typeFilter": { # Place type filters. Only Place types from [Table a](https://developers.google.com/maps/documentation/places/web-service/place-types#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 included_primary_types and excluded_primary_types 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 included_types and excluded_types 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 {"included_types": ["restaurant"], "excluded_primary_types": ["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 included_types and excluded_types types or included_primary_types and excluded_primary_types, an INVALID_ARGUMENT error is returned. One of included_types or included_primary_types must be set. # Required. Place type filters.
      "excludedPrimaryTypes": [ # Optional. Excluded primary Place types.
        "A String",
      ],
      "excludedTypes": [ # Optional. Excluded Place types.
        "A String",
      ],
      "includedPrimaryTypes": [ # Optional. Included primary Place types.
        "A String",
      ],
      "includedTypes": [ # Optional. Included Place types.
        "A String",
      ],
    },
  },
  "insights": [ # Required. Insights to compute. Currently only INSIGHT_COUNT and INSIGHT_PLACES are supported.
    "A String",
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for the ComputeInsights RPC.
  "count": "A String", # Result for Insights.INSIGHT_COUNT.
  "placeInsights": [ # Result for Insights.INSIGHT_PLACES.
    { # Holds information about a place
      "place": "A String", # The unique identifier of the place. This resource name can be used to retrieve details about the place using the [Places API](https://developers.google.com/maps/documentation/places/web-service/reference/rest/v1/places/get).
    },
  ],
}