GoogleMapsPlacesV1Place

import type { GoogleMapsPlacesV1Place } from "https://googleapis.deno.dev/v1/places:v1.ts";

All the information representing a Place.

interface GoogleMapsPlacesV1Place {

accessibilityOptions?: GoogleMapsPlacesV1PlaceAccessibilityOptions;

addressComponents?: GoogleMapsPlacesV1PlaceAddressComponent[];

addressDescriptor?: GoogleMapsPlacesV1AddressDescriptor;

adrFormatAddress?: string;

allowsDogs?: boolean;

attributions?: GoogleMapsPlacesV1PlaceAttribution[];

businessStatus?:

| "BUSINESS_STATUS_UNSPECIFIED"

| "OPERATIONAL"

| "CLOSED_TEMPORARILY"

| "CLOSED_PERMANENTLY";

containingPlaces?: GoogleMapsPlacesV1PlaceContainingPlace[];

curbsidePickup?: boolean;

currentOpeningHours?: GoogleMapsPlacesV1PlaceOpeningHours;

currentSecondaryOpeningHours?: GoogleMapsPlacesV1PlaceOpeningHours[];

delivery?: boolean;

dineIn?: boolean;

displayName?: GoogleTypeLocalizedText;

editorialSummary?: GoogleTypeLocalizedText;

evChargeAmenitySummary?: GoogleMapsPlacesV1PlaceEvChargeAmenitySummary;

evChargeOptions?: GoogleMapsPlacesV1EVChargeOptions;

formattedAddress?: string;

fuelOptions?: GoogleMapsPlacesV1FuelOptions;

generativeSummary?: GoogleMapsPlacesV1PlaceGenerativeSummary;

goodForChildren?: boolean;

goodForGroups?: boolean;

goodForWatchingSports?: boolean;

googleMapsLinks?: GoogleMapsPlacesV1PlaceGoogleMapsLinks;

googleMapsUri?: string;

iconBackgroundColor?: string;

iconMaskBaseUri?: string;

id?: string;

internationalPhoneNumber?: string;

liveMusic?: boolean;

location?: GoogleTypeLatLng;

menuForChildren?: boolean;

name?: string;

nationalPhoneNumber?: string;

neighborhoodSummary?: GoogleMapsPlacesV1PlaceNeighborhoodSummary;

outdoorSeating?: boolean;

parkingOptions?: GoogleMapsPlacesV1PlaceParkingOptions;

paymentOptions?: GoogleMapsPlacesV1PlacePaymentOptions;

photos?: GoogleMapsPlacesV1Photo[];

plusCode?: GoogleMapsPlacesV1PlacePlusCode;

postalAddress?: GoogleTypePostalAddress;

priceLevel?:

| "PRICE_LEVEL_UNSPECIFIED"

| "PRICE_LEVEL_FREE"

| "PRICE_LEVEL_INEXPENSIVE"

| "PRICE_LEVEL_MODERATE"

| "PRICE_LEVEL_EXPENSIVE"

| "PRICE_LEVEL_VERY_EXPENSIVE";

priceRange?: GoogleMapsPlacesV1PriceRange;

primaryType?: string;

primaryTypeDisplayName?: GoogleTypeLocalizedText;

pureServiceAreaBusiness?: boolean;

rating?: number;

regularOpeningHours?: GoogleMapsPlacesV1PlaceOpeningHours;

regularSecondaryOpeningHours?: GoogleMapsPlacesV1PlaceOpeningHours[];

reservable?: boolean;

restroom?: boolean;

reviews?: GoogleMapsPlacesV1Review[];

reviewSummary?: GoogleMapsPlacesV1PlaceReviewSummary;

servesBeer?: boolean;

servesBreakfast?: boolean;

servesBrunch?: boolean;

servesCocktails?: boolean;

servesCoffee?: boolean;

servesDessert?: boolean;

servesDinner?: boolean;

servesLunch?: boolean;

servesVegetarianFood?: boolean;

servesWine?: boolean;

shortFormattedAddress?: string;

subDestinations?: GoogleMapsPlacesV1PlaceSubDestination[];

takeout?: boolean;

timeZone?: GoogleTypeTimeZone;

types?: string[];

userRatingCount?: number;

utcOffsetMinutes?: number;

viewport?: GoogleGeoTypeViewport;

websiteUri?: string;

}

§Properties

accessibilityOptions?: GoogleMapsPlacesV1PlaceAccessibilityOptions

[src]

Information about the accessibility options a place offers.

addressComponents?: GoogleMapsPlacesV1PlaceAddressComponent[]

[src]

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.

addressDescriptor?: GoogleMapsPlacesV1AddressDescriptor

[src]

The address descriptor of the place. Address descriptors include additional information that help describe a location using landmarks and areas. See address descriptor regional coverage in https://developers.google.com/maps/documentation/geocoding/address-descriptors/coverage.

adrFormatAddress?: string

[src]

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

allowsDogs?: boolean

[src]

Place allows dogs.

attributions?: GoogleMapsPlacesV1PlaceAttribution[]

[src]

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

businessStatus?: "BUSINESS_STATUS_UNSPECIFIED" | "OPERATIONAL" | "CLOSED_TEMPORARILY" | "CLOSED_PERMANENTLY"

[src]

The business status for the place.

containingPlaces?: GoogleMapsPlacesV1PlaceContainingPlace[]

[src]

List of places in which the current place is located.

curbsidePickup?: boolean

[src]

Specifies if the business supports curbside pickup.

currentOpeningHours?: GoogleMapsPlacesV1PlaceOpeningHours

[src]

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.

currentSecondaryOpeningHours?: GoogleMapsPlacesV1PlaceOpeningHours[]

[src]

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.

delivery?: boolean

[src]

Specifies if the business supports delivery.

dineIn?: boolean

[src]

Specifies if the business supports indoor or outdoor seating options.

displayName?: GoogleTypeLocalizedText

[src]

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

editorialSummary?: GoogleTypeLocalizedText

[src]

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.

evChargeAmenitySummary?: GoogleMapsPlacesV1PlaceEvChargeAmenitySummary

[src]

The summary of amenities near the EV charging station.

evChargeOptions?: GoogleMapsPlacesV1EVChargeOptions

[src]

Information of ev charging options.

formattedAddress?: string

[src]

A full, human-readable address for this place.

fuelOptions?: GoogleMapsPlacesV1FuelOptions

[src]

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

generativeSummary?: GoogleMapsPlacesV1PlaceGenerativeSummary

[src]

AI-generated summary of the place.

goodForChildren?: boolean

[src]

Place is good for children.

goodForGroups?: boolean

[src]

Place accommodates groups.

goodForWatchingSports?: boolean

[src]

Place is suitable for watching sports.

googleMapsLinks?: GoogleMapsPlacesV1PlaceGoogleMapsLinks

[src]

Links to trigger different Google Maps actions.

googleMapsUri?: string

[src]

A URL providing more information about this place.

iconBackgroundColor?: string

[src]

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

iconMaskBaseUri?: string

[src]

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

id?: string

[src]

The unique identifier of a place.

internationalPhoneNumber?: string

[src]

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

liveMusic?: boolean

[src]

Place provides live music.

location?: GoogleTypeLatLng

[src]

The position of this place.

menuForChildren?: boolean

[src]

Place has a children's menu.

name?: string

[src]

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

nationalPhoneNumber?: string

[src]

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

neighborhoodSummary?: GoogleMapsPlacesV1PlaceNeighborhoodSummary

[src]

A summary of points of interest near the place.

outdoorSeating?: boolean

[src]

Place provides outdoor seating.

parkingOptions?: GoogleMapsPlacesV1PlaceParkingOptions

[src]

Options of parking provided by the place.

paymentOptions?: GoogleMapsPlacesV1PlacePaymentOptions

[src]

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

photos?: GoogleMapsPlacesV1Photo[]

[src]

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

plusCode?: GoogleMapsPlacesV1PlacePlusCode

[src]

Plus code of the place location lat/long.

postalAddress?: GoogleTypePostalAddress

[src]

The address in postal address format.

[src]

Price level of the place.

priceRange?: GoogleMapsPlacesV1PriceRange

[src]

The price range associated with a Place.

primaryType?: string

[src]

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.

primaryTypeDisplayName?: GoogleTypeLocalizedText

[src]

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. The primary type may be missing if the place's primary type is not a supported type.

pureServiceAreaBusiness?: boolean

[src]

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.

rating?: number

[src]

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

regularOpeningHours?: GoogleMapsPlacesV1PlaceOpeningHours

[src]

The regular hours of operation. Note that if a place is always open (24 hours), the close field will not be set. Clients can rely on always open (24 hours) being represented as an open period containing day with value 0, hour with value 0, and minute with value 0.

regularSecondaryOpeningHours?: GoogleMapsPlacesV1PlaceOpeningHours[]

[src]

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.

reservable?: boolean

[src]

Specifies if the place supports reservations.

restroom?: boolean

[src]

Place has restroom.

reviews?: GoogleMapsPlacesV1Review[]

[src]

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

reviewSummary?: GoogleMapsPlacesV1PlaceReviewSummary

[src]

AI-generated summary of the place using user reviews.

servesBeer?: boolean

[src]

Specifies if the place serves beer.

servesBreakfast?: boolean

[src]

Specifies if the place serves breakfast.

servesBrunch?: boolean

[src]

Specifies if the place serves brunch.

servesCocktails?: boolean

[src]

Place serves cocktails.

servesCoffee?: boolean

[src]

Place serves coffee.

servesDessert?: boolean

[src]

Place serves dessert.

servesDinner?: boolean

[src]

Specifies if the place serves dinner.

servesLunch?: boolean

[src]

Specifies if the place serves lunch.

servesVegetarianFood?: boolean

[src]

Specifies if the place serves vegetarian food.

servesWine?: boolean

[src]

Specifies if the place serves wine.

shortFormattedAddress?: string

[src]

A short, human-readable address for this place.

subDestinations?: GoogleMapsPlacesV1PlaceSubDestination[]

[src]

A list of sub-destinations related to the place.

takeout?: boolean

[src]

Specifies if the business supports takeout.

timeZone?: GoogleTypeTimeZone

[src]

IANA Time Zone Database time zone. For example "America/New_York".

types?: string[]

[src]

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

userRatingCount?: number

[src]

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

utcOffsetMinutes?: number

[src]

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.

viewport?: GoogleGeoTypeViewport

[src]

A viewport suitable for displaying the place on an average-sized map. This viewport should not be used as the physical boundary or the service area of the business.

websiteUri?: string

[src]

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.