places

GET /v1/places/{placesId}

Get the details of a place based on its resource name, which is a string in the places/{place_id} format.

Request

  • Base URL
    https://places.googleapis.com
  • URL
    https://places.googleapis.com/v1/places/{placesId}
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/cloud-platform
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/maps-platform.places
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/maps-platform.places
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/maps-platform.places.details
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/maps-platform.places.details

Path parameters

placesIdstring required

Query parameters

languageCodestring

Optional. Place details will be displayed with the preferred language if available. Current list of supported languages: https://developers.google.com/maps/faq#languagesupport.

regionCodestring

Optional. The Unicode country/region code (CLDR) of the location where the request is coming from. This parameter is used to display the place details, like region-specific place name, if available. The parameter can affect results based on applicable law. For more information, see https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. Note that 3-digit region codes are not currently supported.

sessionTokenstring

Optional. A string which identifies an Autocomplete session for billing purposes. Must be a URL and filename safe base64 string with at most 36 ASCII characters in length. Otherwise an INVALID_ARGUMENT error is returned. The session begins when the user starts typing a query, and concludes when they select a place and a call to Place Details or Address Validation is made. Each session can have multiple queries, followed by one Place Details or Address Validation request. The credentials used for each request within a session must belong to the same Google Cloud Console project. Once a session has concluded, the token is no longer valid; your app must generate a fresh token for each session. If the session_token parameter is omitted, or if you reuse a session token, the session is charged as if no session token was provided (each request is billed separately). We recommend the following guidelines: * Use session tokens for all Place Autocomplete calls. * Generate a fresh token for each session. Using a version 4 UUID is recommended. * Ensure that the credentials used for all Place Autocomplete, Place Details, and Address Validation requests within a session belong to the same Cloud Console project. * Be sure to pass a unique session token for each new session. Using the same token for more than one session will result in each request being billed individually.

Response

Successful response

adrFormatAddressstring

The place's address in adr microformat: http://microformats.org/wiki/adr.

allowsDogsboolean

Place allows dogs.

businessStatus'BUSINESS_STATUS_UNSPECIFIED' | 'OPERATIONAL' | 'CLOSED_TEMPORARILY' | 'CLOSED_PERMANENTLY' | 'FUTURE_OPENING'

The business status for the place.

curbsidePickupboolean

Specifies if the business supports curbside pickup.

deliveryboolean

Specifies if the business supports delivery.

dineInboolean

Specifies if the business supports indoor or outdoor seating options.

formattedAddressstring

A full, human-readable address for this place.

goodForChildrenboolean

Place is good for children.

goodForGroupsboolean

Place accommodates groups.

goodForWatchingSportsboolean

Place is suitable for watching sports.

googleMapsUristring

A URL providing more information about this place.

iconBackgroundColorstring

Background color for icon_mask in hex format, e.g. #909CE1.

iconMaskBaseUristring

A truncated URL to an icon mask. User can access different icon type by appending type suffix to the end (eg, ".svg" or ".png").

idstring

The unique identifier of a place.

internationalPhoneNumberstring

A human-readable phone number for the place, in international format.

liveMusicboolean

Place provides live music.

menuForChildrenboolean

Place has a children's menu.

movedPlacestring

If this Place is permanently closed and has moved to a new Place, this field contains the new Place's resource name, in places/{place_id} format. If this Place moved multiple times, this field will represent the first moved place. This field will not be populated if this Place has not moved.

movedPlaceIdstring

If this Place is permanently closed and has moved to a new Place, this field contains the new Place's place ID. If this Place moved multiple times, this field will represent the first moved Place. This field will not be populated if this Place has not moved.

namestring

This Place's resource name, in places/{place_id} format. Can be used to look up the Place.

nationalPhoneNumberstring

A human-readable phone number for the place, in national format.

outdoorSeatingboolean

Place provides outdoor seating.

priceLevel'PRICE_LEVEL_UNSPECIFIED' | 'PRICE_LEVEL_FREE' | 'PRICE_LEVEL_INEXPENSIVE' | 'PRICE_LEVEL_MODERATE' | 'PRICE_LEVEL_EXPENSIVE' | 'PRICE_LEVEL_VERY_EXPENSIVE'

Price level of the place.

primaryTypestring

The primary type of the given result. This type must be one of the Places API supported types. For example, "restaurant", "cafe", "airport", etc. A place can only have a single primary type. For the complete list of possible values, see Table A and Table B at https://developers.google.com/maps/documentation/places/web-service/place-types. The primary type may be missing if the place's primary type is not a supported type. When a primary type is present, it is always one of the types in the types field.

pureServiceAreaBusinessboolean

Indicates whether the place is a pure service area business. Pure service area business is a business that visits or delivers to customers directly but does not serve customers at their business address. For example, businesses like cleaning services or plumbers. Those businesses may not have a physical address or location on Google Maps.

ratingnumber double

A rating between 1.0 and 5.0, based on user reviews of this place.

reservableboolean

Specifies if the place supports reservations.

restroomboolean

Place has restroom.

servesBeerboolean

Specifies if the place serves beer.

servesBreakfastboolean

Specifies if the place serves breakfast.

servesBrunchboolean

Specifies if the place serves brunch.

servesCocktailsboolean

Place serves cocktails.

servesCoffeeboolean

Place serves coffee.

servesDessertboolean

Place serves dessert.

servesDinnerboolean

Specifies if the place serves dinner.

servesLunchboolean

Specifies if the place serves lunch.

servesVegetarianFoodboolean

Specifies if the place serves vegetarian food.

servesWineboolean

Specifies if the place serves wine.

shortFormattedAddressstring

A short, human-readable address for this place.

takeoutboolean

Specifies if the business supports takeout.

typesstring[]

A set of type tags for this result. For example, "political" and "locality". For the complete list of possible values, see Table A and Table B at https://developers.google.com/maps/documentation/places/web-service/place-types

userRatingCountinteger

The total number of reviews (with or without text) for this place.

utcOffsetMinutesinteger

Number of minutes this place's timezone is currently offset from UTC. This is expressed in minutes to support timezones that are offset by fractions of an hour, e.g. X hours and 15 minutes.

websiteUristring

The authoritative website for this place, e.g. a business' homepage. Note that for places that are part of a chain (e.g. an IKEA store), this will usually be the website for the individual store, not the overall chain.

Changes

No recorded changes to this operation across all 5 revisions of this API.