Package google.maps.places.v1

string

Name of the author of the Photo or Review.

string

URI of the author of the Photo or Review.

string

Profile photo URI of the author of the Photo or Review.

string

Required. The text string on which to search.

LocationBias

Optional. Bias results to a specified location.

At most one of location_bias or location_restriction should be set. If neither are set, the results will be biased by IP address, meaning the IP address will be mapped to an imprecise location and used as a biasing signal.

LocationRestriction

Optional. Restrict results to a specified location.

At most one of location_bias or location_restriction should be set. If neither are set, the results will be biased by IP address, meaning the IP address will be mapped to an imprecise location and used as a biasing signal.

string

Optional. Included primary Place type (for example, "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types. A Place is only returned if its primary type is included in this list. Up to 5 values can be specified. If no types are specified, all Place types are returned.

string

Optional. Only include results in the specified regions, specified as up to 15 CLDR two-character region codes. An empty set will not restrict the results. If both location_restriction and included_region_codes are set, the results will be located in the area of intersection.

string

Optional. The language in which to return results. Defaults to en-US. The results may be in mixed languages if the language used in input is different from language_code or if the returned Place does not have a translation from the local language to language_code.

string

Optional. The region code, specified as a CLDR two-character region code. This affects address formatting, result ranking, and may influence what results are returned. This does not restrict results to the specified region. To restrict results to a region, use region_code_restriction.

LatLng

Optional. The origin point from which to calculate geodesic distance to the destination (returned as distance_meters). If this value is omitted, geodesic distance will not be returned.

int32

Optional. A zero-based Unicode character offset of input indicating the cursor position in input. The cursor position may influence what predictions are returned.

If empty, defaults to the length of input.

bool

Optional. If true, the response will include both Place and query predictions. Otherwise the response will only return Place predictions.

string

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.

Viewport

A viewport defined by a northeast and a southwest corner.

Circle

A circle defined by a center point and radius.

Viewport

A viewport defined by a northeast and a southwest corner.

Circle

A circle defined by a center point and radius.

Suggestion

Contains a list of suggestions, ordered in descending order of relevance.

PlacePrediction

A prediction for a Place.

QueryPrediction

A prediction for a query.

string

Text that may be used as is or formatted with matches.

StringRange

A list of string ranges identifying where the input request matched in text. The ranges can be used to format specific parts of text. The substrings may not be exact matches of input if the matching was determined by criteria other than string matching (for example, spell corrections or transliterations).

These values are Unicode character offsets of text. The ranges are guaranteed to be ordered in increasing offset values.

string

The resource name of the suggested Place. This name can be used in other APIs that accept Place names.

string

The unique identifier of the suggested Place. This identifier can be used in other APIs that accept Place IDs.

FormattableText

Contains the human-readable name for the returned result. For establishment results, this is usually the business name and address.

text is recommended for developers who wish to show a single UI element. Developers who wish to show two separate, but related, UI elements may want to use structured_format instead. They are two different ways to represent a Place prediction. Users should not try to parse structured_format into text or vice versa.

This text may be different from the display_name returned by GetPlace.

May be in mixed languages if the request input and language_code are in different languages or if the Place does not have a translation from the local language to language_code.

StructuredFormat

A breakdown of the Place prediction into main text containing the name of the Place and secondary text containing additional disambiguating features (such as a city or region).

structured_format is recommended for developers who wish to show two separate, but related, UI elements. Developers who wish to show a single UI element may want to use text instead. They are two different ways to represent a Place prediction. Users should not try to parse structured_format into text or vice versa.

string

List of types that apply to this Place from Table A or Table B in https://developers.google.com/maps/documentation/places/web-service/place-types.

A type is a categorization of a Place. Places with shared types will share similar characteristics.

int32

The length of the geodesic in meters from origin if origin is specified. Certain predictions such as routes may not populate this field.

FormattableText

The predicted text. This text does not represent a Place, but rather a text query that could be used in a search endpoint (for example, Text Search).

text is recommended for developers who wish to show a single UI element. Developers who wish to show two separate, but related, UI elements may want to use structured_format instead. They are two different ways to represent a query prediction. Users should not try to parse structured_format into text or vice versa.

May be in mixed languages if the request input and language_code are in different languages or if part of the query does not have a translation from the local language to language_code.

StructuredFormat

A breakdown of the query prediction into main text containing the query and secondary text containing additional disambiguating features (such as a city or region).

structured_format is recommended for developers who wish to show two separate, but related, UI elements. Developers who wish to show a single UI element may want to use text instead. They are two different ways to represent a query prediction. Users should not try to parse structured_format into text or vice versa.

int32

Zero-based offset of the first Unicode character of the string (inclusive).

int32

Zero-based offset of the last Unicode character (exclusive).

FormattableText

Represents the name of the Place or query.

FormattableText

Represents additional disambiguating features (such as a city or region) to further identify the Place or refine the query.

LatLng

Required. Center latitude and longitude.

The range of latitude must be within [-90.0, 90.0]. The range of the longitude must be within [-180.0, 180.0].

double

Required. Radius measured in meters. The radius must be within [0.0, 50000.0].

int32

Number of connectors at this station. However, because some ports can have multiple connectors but only be able to charge one car at a time (e.g.) the number of connectors may be greater than the total number of cars which can charge simultaneously.

ConnectorAggregation

A list of EV charging connector aggregations that contain connectors of the same type and same charge rate.

EVConnectorType

The connector type of this aggregation.

double

The static max charging rate in kw of each connector in the aggregation.

int32

Number of connectors in this aggregation.

Timestamp

The timestamp when the connector availability information in this aggregation was last updated.

int32

Number of connectors in this aggregation that are currently available.

int32

Number of connectors in this aggregation that are currently out of service.

FuelPrice

The last known fuel price for each type of fuel this station has. There is one entry per fuel type this station has. Order is not important.

FuelType

The type of fuel.

Money

The price of the fuel.

Timestamp

The time the fuel price was last updated.

string

Required. The resource name of a photo media in the format: places/{place_id}/photos/{photo_reference}/media.

The resource name of a photo as returned in a Place object's photos.name field comes with the format places/{place_id}/photos/{photo_reference}. You need to append /media at the end of the photo resource to get the photo media resource name.

int32

Optional. Specifies the maximum desired width, in pixels, of the image. If the image is smaller than the values specified, the original image will be returned. If the image is larger in either dimension, it will be scaled to match the smaller of the two dimensions, restricted to its original aspect ratio. Both the max_height_px and max_width_px properties accept an integer between 1 and 4800, inclusively. If the value is not within the allowed range, an INVALID_ARGUMENT error will be returned.

At least one of max_height_px or max_width_px needs to be specified. If neither max_height_px nor max_width_px is specified, an INVALID_ARGUMENT error will be returned.

int32

Optional. Specifies the maximum desired height, in pixels, of the image. If the image is smaller than the values specified, the original image will be returned. If the image is larger in either dimension, it will be scaled to match the smaller of the two dimensions, restricted to its original aspect ratio. Both the max_height_px and max_width_px properties accept an integer between 1 and 4800, inclusively. If the value is not within the allowed range, an INVALID_ARGUMENT error will be returned.

At least one of max_height_px or max_width_px needs to be specified. If neither max_height_px nor max_width_px is specified, an INVALID_ARGUMENT error will be returned.

bool

Optional. If set, skip the default HTTP redirect behavior and render a text format (for example, in JSON format for HTTP use case) response. If not set, an HTTP redirect will be issued to redirect the call to the image media. This option is ignored for non-HTTP requests.

string

Required. The resource name of a place, in the places/{place_id} format.

string

Optional. Place details will be displayed with the preferred language if available.

Current list of supported languages: https://developers.google.com/maps/faq#languagesupport.

string

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.

string

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.

string

Identifier. A reference representing this place photo which may be used to look up this place photo again (also called the API "resource" name: places/{place_id}/photos/{photo}).

int32

The maximum available width, in pixels.

int32

The maximum available height, in pixels.

AuthorAttribution

This photo's authors.

string

The resource name of a photo media in the format: places/{place_id}/photos/{photo_reference}/media.

string

A short-lived uri that can be used to render the photo.

string

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

string

The unique identifier of a place.

LocalizedText

The localized name of the place, suitable as a short human-readable description. For example, "Google Sydney", "Starbucks", "Pyrmont", etc.

string

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

string

The primary type of the given result. This type must 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

LocalizedText

The display name of the primary type, localized to the request language if applicable. 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

string

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

string

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

string

A full, human-readable address for this place.

string

A short, human-readable address for this place.

AddressComponent

Repeated components for each locality level. Note the following facts about the address_components[] array: - The array of address components may contain more components than the formatted_address. - The array does not necessarily include all the political entities that contain an address, apart from those included in the formatted_address. To retrieve all the political entities that contain a specific address, you should use reverse geocoding, passing the latitude/longitude of the address as a parameter to the request. - The format of the response is not guaranteed to remain the same between requests. In particular, the number of address_components varies based on the address requested and can change over time for the same address. A component can change position in the array. The type of the component can change. A particular component may be missing in a later response.

PlusCode

Plus code of the place location lat/long.

LatLng

The position of this place.

Viewport

A viewport suitable for displaying the place on an average-sized map.

double

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

string

A URL providing more information about this place.

string

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.

Review

List of reviews about this place, sorted by relevance. A maximum of 5 reviews can be returned.

OpeningHours

The regular hours of operation.

Photo

Information (including references) about photos of this place. A maximum of 10 photos can be returned.

string

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

BusinessStatus

The business status for the place.

PriceLevel

Price level of the place.

Attribution

A set of data provider that must be shown with this result.

string

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

string

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

OpeningHours

The hours of operation for the next seven days (including today). The time period starts at midnight on the date of the request and ends at 11:59 pm six days later. This field includes the special_days subfield of all hours, set for dates that have exceptional hours.

OpeningHours

Contains an array of entries for the next seven days including information about secondary hours of a business. Secondary hours are different from a business's main hours. For example, a restaurant can specify drive through hours or delivery hours as its secondary hours. This field populates the type subfield, which draws from a predefined list of opening hours types (such as DRIVE_THROUGH, PICKUP, or TAKEOUT) based on the types of the place. This field includes the special_days subfield of all hours, set for dates that have exceptional hours.

OpeningHours

Contains an array of entries for information about regular secondary hours of a business. Secondary hours are different from a business's main hours. For example, a restaurant can specify drive through hours or delivery hours as its secondary hours. This field populates the type subfield, which draws from a predefined list of opening hours types (such as DRIVE_THROUGH, PICKUP, or TAKEOUT) based on the types of the place.

LocalizedText

Contains a summary of the place. A summary is comprised of a textual overview, and also includes the language code for these if applicable. Summary text must be presented as-is and can not be modified or altered.

PaymentOptions

Payment options the place accepts. If a payment option data is not available, the payment option field will be unset.

ParkingOptions

Options of parking provided by the place.

SubDestination

A list of sub destinations related to the place.

FuelOptions

The most recent information about fuel options in a gas station. This information is updated regularly.

EVChargeOptions

Information of ev charging options.

int32

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.

int32

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

bool

Specifies if the business supports takeout.

bool

Specifies if the business supports delivery.

bool

Specifies if the business supports indoor or outdoor seating options.

bool

Specifies if the business supports curbside pickup.

bool

Specifies if the place supports reservations.

bool

Specifies if the place serves breakfast.

bool

Specifies if the place serves lunch.

bool

Specifies if the place serves dinner.

bool

Specifies if the place serves beer.

bool

Specifies if the place serves wine.

bool

Specifies if the place serves brunch.

bool

Specifies if the place serves vegetarian food.

bool

Place provides outdoor seating.

bool

Place provides live music.

bool

Place has a children's menu.

bool

Place serves cocktails.

bool

Place serves dessert.

bool

Place serves coffee.

bool

Place is good for children.

bool

Place allows dogs.

bool

Place has restroom.

bool

Place accommodates groups.

bool

Place is suitable for watching sports.

AccessibilityOptions

Information about the accessibility options a place offers.

bool

Place offers wheelchair accessible parking.

bool

Places has wheelchair accessible entrance.

bool

Place has wheelchair accessible restroom.

bool

Place has wheelchair accessible seating.

string

The full text description or name of the address component. For example, an address component for the country Australia may have a long_name of "Australia".

string

An abbreviated textual name for the address component, if available. For example, an address component for the country of Australia may have a short_name of "AU".

string

An array indicating the type(s) of the address component.

string

The language used to format this components, in CLDR notation.

string

Name of the Place's data provider.

string

URI to the Place's data provider.

Period

The periods that this place is open during the week. The periods are in chronological order, starting with Sunday in the place-local timezone. An empty (but not absent) value indicates a place that is never open, e.g. because it is closed temporarily for renovations.

string

Localized strings describing the opening hours of this place, one string for each day of the week. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00"

SecondaryHoursType

A type string used to identify the type of secondary hours.

SpecialDay

Structured information for special days that fall within the period that the returned opening hours cover. Special days are days that could impact the business hours of a place, e.g. Christmas day. Set for current_opening_hours and current_secondary_opening_hours if there are exceptional hours.

bool

Is this place open right now? Always present unless we lack time-of-day or timezone data for these opening hours.

Point

The time that the place starts to be open.

Point

The time that the place starts to be closed.

Date

Date in the local timezone for the place.

bool

Whether or not this endpoint was truncated. Truncation occurs when the real hours are outside the times we are willing to return hours between, so we truncate the hours back to these boundaries. This ensures that at most 24 * 7 hours from midnight of the day of the request are returned.

int32

A day of the week, as an integer in the range 0-6. 0 is Sunday, 1 is Monday, etc.

int32

The hour in 2 digits. Ranges from 00 to 23.

int32

The minute in 2 digits. Ranges from 00 to 59.

Date

The date of this special day.

bool

Place offers free parking lots.

bool

Place offers paid parking lots.

bool

Place offers free street parking.

bool

Place offers paid street parking.

bool

Place offers valet parking.

bool

Place offers free garage parking.

bool

Place offers paid garage parking.

bool

Place accepts credit cards as payment.

bool

Place accepts debit cards as payment.

bool

Place accepts cash only as payment. Places with this attribute may still accept other payment methods.

bool

Place accepts NFC payments.

string

Place's global (full) code, such as "9FWM33GV+HQ", representing an 1/8000 by 1/8000 degree area (~14 by 14 meters).

string

Place's compound code, such as "33GV+HQ, Ramberg, Norway", containing the suffix of the global code and replacing the prefix with a formatted name of a reference entity.

string

The resource name of the sub destination.

string

The place id of the sub destination.

string

A reference representing this place review which may be used to look up this place review again (also called the API "resource" name: places/{place_id}/reviews/{review}).

string

A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country.

LocalizedText

The localized text of the review.

LocalizedText

The review text in its original language.

double

A number between 1.0 and 5.0, also called the number of stars.

AuthorAttribution

This review's author.

Timestamp

Timestamp for the review.

string

Place details will be displayed with the preferred language if available. If the language code is unspecified or unrecognized, place details of any language may be returned, with a preference for English if such details exist.

Current list of supported languages: https://developers.google.com/maps/faq#languagesupport.

string

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.

string

Included Place type (eg, "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types.

Up to 50 types from Table A may be specified.

If there are any conflicting types, i.e. a type appears in both included_types and excluded_types, an INVALID_ARGUMENT error is returned.

If a Place type is specified with multiple type restrictions, only places that satisfy all of the restrictions are returned. For example, if we have {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]}, the returned places provide "restaurant" related services but do not operate primarily as "restaurants".

string

Excluded Place type (eg, "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types.

Up to 50 types from Table A may be specified.

If the client provides both included_types (e.g. restaurant) and excluded_types (e.g. cafe), then the response should include places that are restaurant but not cafe. The response includes places that match at least one of the included_types and none of the excluded_types.

If there are any conflicting types, i.e. a type appears in both included_types and excluded_types, an INVALID_ARGUMENT error is returned.

If a Place type is specified with multiple type restrictions, only places that satisfy all of the restrictions are returned. For example, if we have {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]}, the returned places provide "restaurant" related services but do not operate primarily as "restaurants".

string

Included primary Place type (e.g. "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types. A place can only have a single primary type from the supported types table associated with it.

Up to 50 types from Table A may be specified.

If there are any conflicting primary types, i.e. a type appears in both included_primary_types and excluded_primary_types, an INVALID_ARGUMENT error is returned.

If a Place type is specified with multiple type restrictions, only places that satisfy all of the restrictions are returned. For example, if we have {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]}, the returned places provide "restaurant" related services but do not operate primarily as "restaurants".

string

Excluded primary Place type (e.g. "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types.

Up to 50 types from Table A may be specified.

If there are any conflicting primary types, i.e. a type appears in both included_primary_types and excluded_primary_types, an INVALID_ARGUMENT error is returned.

If a Place type is specified with multiple type restrictions, only places that satisfy all of the restrictions are returned. For example, if we have {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]}, the returned places provide "restaurant" related services but do not operate primarily as "restaurants".

int32

Maximum number of results to return. It must be between 1 and 20 (default), inclusively. If the number is unset, it falls back to the upper limit. If the number is set to negative or exceeds the upper limit, an INVALID_ARGUMENT error is returned.

LocationRestriction

Required. The region to search.

RankPreference

How results will be ranked in the response.

Circle

A circle defined by center point and radius.

Place

A list of places that meets user's requirements like places types, number of places and specific location restriction.

string

Required. The text query for textual search.

string

Place details will be displayed with the preferred language if available. If the language code is unspecified or unrecognized, place details of any language may be returned, with a preference for English if such details exist.

Current list of supported languages: https://developers.google.com/maps/faq#languagesupport.

string

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.

RankPreference

How results will be ranked in the response.

string

The requested place type. Full list of types supported: https://developers.google.com/maps/documentation/places/web-service/place-types. Only support one included type.

bool

Used to restrict the search to places that are currently open. The default is false.

double

Filter out results whose average user rating is strictly less than this limit. A valid value must be a float between 0 and 5 (inclusively) at a 0.5 cadence i.e. [0, 0.5, 1.0, ... , 5.0] inclusively. The input rating will round up to the nearest 0.5(ceiling). For instance, a rating of 0.6 will eliminate all results with a less than 1.0 rating.

int32

Maximum number of results to return. It must be between 1 and 20, inclusively. The default is 20. If the number is unset, it falls back to the upper limit. If the number is set to negative or exceeds the upper limit, an INVALID_ARGUMENT error is returned.

PriceLevel

Used to restrict the search to places that are marked as certain price levels. Users can choose any combinations of price levels. Default to select all price levels.

bool

Used to set strict type filtering for included_type. If set to true, only results of the same type will be returned. Default to false.

LocationBias

The region to search. This location serves as a bias which means results around given location might be returned. Cannot be set along with location_restriction.

LocationRestriction

The region to search. This location serves as a restriction which means results outside given location will not be returned. Cannot be set along with location_bias.

EVOptions

Optional. Set the searchable EV options of a place search request.

double

Optional. Minimum required charging rate in kilowatts. A place with a charging rate less than the specified rate is filtered out.

EVConnectorType

Optional. The list of preferred EV connector types. A place that does not support any of the listed connector types is filtered out.

Viewport

A rectangle box defined by northeast and southwest corner. rectangle.high() must be the northeast point of the rectangle viewport. rectangle.low() must be the southwest point of the rectangle viewport. rectangle.low().latitude() cannot be greater than rectangle.high().latitude(). This will result in an empty latitude range. A rectangle viewport cannot be wider than 180 degrees.

Circle

A circle defined by center point and radius.

Viewport

A rectangle box defined by northeast and southwest corner. rectangle.high() must be the northeast point of the rectangle viewport. rectangle.low() must be the southwest point of the rectangle viewport. rectangle.low().latitude() cannot be greater than rectangle.high().latitude(). This will result in an empty latitude range. A rectangle viewport cannot be wider than 180 degrees.

Place

A list of places that meet the user's text search criteria.