Collection: accounts.locations

Resource: Location

A location. See the help center article for a detailed description of these fields, or use the category endpoint for a list of valid business categories.

JSON representation
{
  "name": string,
  "languageCode": string,
  "storeCode": string,
  "locationName": string,
  "primaryPhone": string,
  "additionalPhones": [
    string
  ],
  "address": {
    object(Address)
  },
  "primaryCategory": {
    object(Category)
  },
  "additionalCategories": [
    {
      object(Category)
    }
  ],
  "websiteUrl": string,
  "regularHours": {
    object(BusinessHours)
  },
  "specialHours": {
    object(SpecialHours)
  },
  "serviceArea": {
    object(ServiceAreaBusiness)
  },
  "locationKey": {
    object(LocationKey)
  },
  "labels": [
    string
  ],
  "adWordsLocationExtensions": {
    object(AdWordsLocationExtensions)
  },
  "photos": {
    object(Photos)
  },
  "latlng": {
    object(LatLng)
  },
  "openInfo": {
    object(OpenInfo)
  },
  "locationState": {
    object(LocationState)
  },
  "attributes": [
    {
      object(Attribute)
    }
  ],
  "metadata": {
    object(Metadata)
  },
  "priceLists": [
    {
      object(PriceList)
    }
  ],
}
Fields
name

string

Google identifier for this location in the form: accounts/{accountId}/locations/{location_id}

In the context of matches, this field will not be populated.

languageCode

string

The language of the location. Set during creation and not updateable. Available since v3.1.

storeCode

string

External identifier for this location, which must be unique inside a given account. This is a means of associating the location with your own records.

locationName

string

Location name should reflect your business's real-world name, as used consistently on your storefront, website, and stationery, and as known to customers. Any additional information, when relevant, can be included in other fields of the resource (for example, Address, Categories). Do not add unnecessary information to your name (for example, prefer "Google" over "Google Inc. - Mountain View Corporate Headquarters"). It is NOT permitted to include marketing taglines, store codes, special characters, hours or closed/open status, phone numbers, website URLs, service/product information, location/address or directions, or containment information (for example, "Chase ATM in Duane Reade").

primaryPhone

string

A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible.

additionalPhones[]

string

Up to two phone numbers (mobile or landline, no fax) at which your business can be called, in addition to your primary phone number.

address

object(Address)

A precise, accurate address to describe your business location. PO boxes or mailboxes located at remote locations are not acceptable. At this time, you can specify a maximum of five addressLines values in the address.

primaryCategory

object(Category)

Category that best describes the core business this location engages in.

additionalCategories[]

object(Category)

Additional categories to describe your business. Categories help your customers find accurate, specific results for services they're interested in. To keep your business information accurate and live, make sure that you use as few categories as possible to describe your overall core business. Choose categories that are as specific as possible, but representative of your main business.

websiteUrl

string

A URL for this business. If possible, use a URL that represents this individual business location instead of a generic website/URL that represents all locations, or the brand.

regularHours

object(BusinessHours)

Operating hours for the business.

specialHours

object(SpecialHours)

Special hours for the business. This typically includes holiday hours, and other times outside of regular operating hours. These override regular business hours.

serviceArea

object(ServiceAreaBusiness)

Service area businesses provide their service at the customer's location. If this business is a service area business, this field describes the area(s) serviced by the business.

locationKey

object(LocationKey)

A collection of keys that link this business to other Google properties, such as a Google+ page and Google Maps Places.

labels[]

string

A collection of free-form strings to allow you to tag your business. These labels are NOT user facing; only you can see them. Limited to 255 characters (per label).

adWordsLocationExtensions

object(AdWordsLocationExtensions)

Additional information that is surfaced in AdWords.

photos

object(Photos)

Photos for this location. Only supported if the location has a Google+ page associated with it.

latlng

object(LatLng)

User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided latlng value was accepted during create, or latlng value was updated through the Google My Business website. This field cannot be updated.

openInfo

object(OpenInfo)

A flag that indicates whether the location is currently open for business.

locationState

object(LocationState)

A set of booleans that reflect the state of a location.

Note: This field is used in responses only. Any value specified here in a request is ignored.

attributes[]

object(Attribute)

Attributes for this location.

metadata

object(Metadata)

Note: This field is used in responses only. Any value specified here in a request is ignored.

priceLists[]

object(PriceList)

Price list information for this location.

Address

Represents the physical location of the business.

Example addresses:

addressLines: "1600 Amphitheatre Parkway"
locality: Mountain View
administrativeArea: CA
country: US
postalCode: 94043

addressLines: Minato, Roppongi, 6−10−1 Roppongi Hills
locality: Tokyo
administrativeArea: Tokyo
country: JP
postalCode: 106-61263
JSON representation
{
  "addressLines": [
    string
  ],
  "subLocality": string,
  "locality": string,
  "administrativeArea": string,
  "country": string,
  "postalCode": string,
}
Fields
addressLines[]

string

The precise address information for the business below the sub-locality level. For most countries, the first line should include a street number and street name. Suite numbers, floors, building numbers, etc., may also be included. Imprecise information like cross-streets and nearby landmarks should only be included in regions where the official street address does not accurately pinpoint the business's location. Maximum 80 characters.

subLocality

string

The suburb where the business is located. This is the division just smaller than a locality (city). Previously referred to in Google My Business Locations as "district". Maximum 80 characters. Also known as: "district" (South Korea), "neighborhood" (Brazil, Mexico), "village / township" (Malaysia). Examples: Manhattan (United States), Centro (Mexico), Songpa District (South Korea.)

locality

string

The city or town where the business is located. Also known as: "district" (Hong Kong, Turkey), "post town" (United Kingdom). Examples: Chicago (United States), Berlin (Germany), London (United Kingdom). Maximum 80 characters.

administrativeArea

string

The state or province where the business is located. Using the full ISO 3166-2 code is preferred, such as US-CA for California or DE-BE for Berlin. Not all countries require this field. Use the address editor in the product to determine whether it is appropriate for an address in a particular country. Also known as: "area" (Hong Kong), "county" (Ireland, Taiwan, United Kingdom), "department" (Colombia, Nicaragua), "district" (Indonesia), "do/si" (South Korea), "emirate" (United Arab Emirates), "island," "oblast" (Russia, Ukraine), "parish," "prefecture" (Japan). Examples: California (United States), Ontario (Canada), Uttar Pradesh (India). Maximum 80 characters.

country

string

The ISO 3166-1 alpha-2 country code where the business is located. After a location is created, the country cannot be changed.

postalCode

string

The postal code of the business. If the postal code begins with zero, make sure that your formatting does not remove the zero as the first digit. Also known as: "zip code" (United States), "PIN code" (India).

BusinessHours

Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances.

JSON representation
{
  "periods": [
    {
      object(TimePeriod)
    }
  ],
}
Fields
periods[]

object(TimePeriod)

A collection of times that this location is open for business. Each period represents a range of hours when the location is open during the week.

TimePeriod

Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.

JSON representation
{
  "openDay": enum(DayOfWeek),
  "openTime": string,
  "closeDay": enum(DayOfWeek),
  "closeTime": string,
}
Fields
openDay

enum(DayOfWeek)

Indicates the day of the week this period starts on.

openTime

string

Time in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field.

closeDay

enum(DayOfWeek)

Indicates the day of the week this period ends on.

closeTime

string

Time in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field.

DayOfWeek

Represents a day of week.

Enums
DAY_OF_WEEK_UNSPECIFIED The unspecified day-of-week.
MONDAY The day-of-week of Monday.
TUESDAY The day-of-week of Tuesday.
WEDNESDAY The day-of-week of Wednesday.
THURSDAY The day-of-week of Thursday.
FRIDAY The day-of-week of Friday.
SATURDAY The day-of-week of Saturday.
SUNDAY The day-of-week of Sunday.

SpecialHours

Represents a set of time periods when a location's operational hours differ from its normal business hours.

JSON representation
{
  "specialHourPeriods": [
    {
      object(SpecialHourPeriod)
    }
  ],
}
Fields
specialHourPeriods[]

object(SpecialHourPeriod)

A list of exceptions to the business's regular hours.

SpecialHourPeriod

Represents a single time period when a location's operational hours differ from its normal business hours. A special hour period must represent a range of less than 24 hours. The openTime and startDate must predate the closeTime and endDate. The closeTime and endDate can extend to 11:59 a.m. on the day after the specified startDate. For example, the following inputs are valid:

startDate=2015-11-23, openTime=08:00, closeTime=18:00
startDate=2015-11-23, endDate=2015-11-23, openTime=08:00, closeTime=18:00
startDate=2015-11-23, endDate=2015-11-24, openTime=13:00, closeTime=11:59

The following inputs are NOT valid:

startDate=2015-11-23, openTime=13:00, closeTime=11:59
startDate=2015-11-23, endDate=2015-11-24, openTime=13:00, closeTime=12:00
startDate=2015-11-23, endDate=2015-11-25, openTime=08:00, closeTime=18:00
JSON representation
{
  "startDate": {
    object(Date)
  },
  "openTime": string,
  "endDate": {
    object(Date)
  },
  "closeTime": string,
  "isClosed": boolean,
}
Fields
startDate

object(Date)

The calendar date this special hour period starts on.

openTime

string

The wall time on startDate when a location opens, expressed in 24hr ISO 8601 extended format. (hh:mm) Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Must be specified if isClosed is false.

endDate

object(Date)

The calendar date this special hour period ends on. If endDate field is not set, default to date specified in startDate. If set, this field must be equal to or at most 1 day after startDate.

closeTime

string

The wall time on endDate when a location closes, expressed in 24hr ISO 8601 extended format. (hh:mm) Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Must be specified if isClosed is false.

isClosed

boolean

If true, endDate, openTime, and closeTime are ignored, and the date specified in startDate is treated as the location being closed for the entire day.

Date

Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and google.protobuf.Timestamp.

JSON representation
{
  "year": number,
  "month": number,
  "day": number,
}
Fields
year

number

Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.

month

number

Month of year. Must be from 1 to 12.

day

number

Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.

ServiceAreaBusiness

Service area businesses provide their service at the customer's location (for example, a locksmith or plumber).

JSON representation
{
  "businessType": enum(BusinessType),

  // Union field coverageArea can be only one of the following:
  "radius": {
    object(PointRadius)
  },
  "places": {
    object(Places)
  },
  // End of list of possible types for union field coverageArea.
}
Fields
businessType

enum(BusinessType)

Indicates the type of the service area business.

Union field coverageArea. Indicates the coverage area where the business offers service. coverageArea can be only one of the following:
radius

object(PointRadius)

The area that this business serves centered around a point.

places

object(Places)

The area that this business serves defined through a set of places.

BusinessType

Indicates whether this business only offers services onsite at a customer location (for example, a tow truck), or at both an address and onsite (for example, a pizza store with a dining area, that also delivers to customers).

Enums
BUSINESS_TYPE_UNSPECIFIED

Not specified

Note: This field is used in responses only. Any value specified here in a request is ignored.

CUSTOMER_LOCATION_ONLY Offers service only in the surrounding area (not at the business address).
CUSTOMER_AND_BUSINESS_LOCATION Offers service at the business address and the surrounding area.

PointRadius

A radius around a particular point (latitude/longitude).

JSON representation
{
  "latlng": {
    object(LatLng)
  },
  "radiusKm": number,
}
Fields
latlng

object(LatLng)

The latitude/longitude that specifies the center of an area defined by the radius.

radiusKm

number

The distance in kilometers of the area around the point.

LatLng

An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.

Example of normalization code in Python:

def NormalizeLongitude(longitude):
  """Wraps decimal degrees longitude to [-180.0, 180.0]."""
  q, r = divmod(longitude, 360.0)
  if r > 180.0 or (r == 180.0 and q <= -1.0):
    return r - 360.0
  return r

def NormalizeLatLng(latitude, longitude):
  """Wraps decimal degrees latitude and longitude to
  [-90.0, 90.0] and [-180.0, 180.0], respectively."""
  r = latitude % 360.0
  if r <= 90.0:
    return r, NormalizeLongitude(longitude)
  elif r >= 270.0:
    return r - 360, NormalizeLongitude(longitude)
  else:
    return 180 - r, NormalizeLongitude(longitude + 180.0)

assert 180.0 == NormalizeLongitude(180.0)
assert -180.0 == NormalizeLongitude(-180.0)
assert -179.0 == NormalizeLongitude(181.0)
assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)

The code in logs/storage/validator/logs_validator_traits.cc treats this type as if it were annotated as ST_LOCATION.

JSON representation
{
  "latitude": number,
  "longitude": number,
}
Fields
latitude

number

The latitude in degrees. It must be in the range [-90.0, +90.0].

longitude

number

The longitude in degrees. It must be in the range [-180.0, +180.0].

Places

Defines the union of areas represented by a set of places.

JSON representation
{
  "placeInfos": [
    {
      object(PlaceInfo)
    }
  ],
}
Fields
placeInfos[]

object(PlaceInfo)

The areas represented by place IDs.

PlaceInfo

Defines an area that's represented by a place ID.

JSON representation
{
  "name": string,
  "placeId": string,
}
Fields
name

string

The localized name of the place. For example, Scottsdale, AZ.

placeId

string

The ID of the place.

LocationKey

Alternate / surrogate key references for a location.

JSON representation
{
  "plusPageId": string,
  "placeId": string,
  "explicitNoPlaceId": boolean,
  "requestId": string,
}
Fields
plusPageId

string

If this location has a Google+ page associated with it, this is populated with the Google+ page ID for this location.

Note: This field is used in responses only. Any value specified here in a request is ignored.

placeId

string

If this location has been verified and is connected to/appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs.

If this location is unverified, this field may be populated if the location has been associated with a place that appears on Google Maps.

This field can be set during Create calls, but not for Update.

The additional explicitNoPlaceId bool qualifies whether an unset place ID is deliberate or not.

explicitNoPlaceId

boolean

A value of true indicates that an unset place ID is deliberate, which is different from no association being made yet.

Note: This field is used in responses only. Any value specified here in a request is ignored.

requestId

string

The requestId used to create this location. May be empty if this location was created outside of the GMB API or Google My Business Locations.

Note: This field is used in responses only. Any value specified here in a request is ignored.

AdWordsLocationExtensions

Additional information that is surfaced in AdWords.

JSON representation
{
  "adPhone": string,
}
Fields
adPhone

string

An alternate phone number to display on AdWords location extensions instead of the location's primary phone number.

Photos

A collection of photos representing the business, categorized by photo type. The URL for each photo should point to a publicly accessible image. Photos should be supplied in either JPG or PNG format unless specified otherwise. If the photo was added by using Google My Business Locations or this API, the user-provided URL is used. If the photo was uploaded via the Google My Business Photos App, the photo uses a generated URL hosted by Google. Exceptions: profilePhotoUrl and coverPhotoUrl are always under a Google domain. With the exception of profilePhotoUrl and coverPhotoUrl, all photos must measure a minimum of 250px on the short edge, with a file size of at least 10240 bytes.

All uploaded photos should follow the Google My Business guidelines for photos.

JSON representation
{
  "profilePhotoUrl": string,
  "coverPhotoUrl": string,
  "logoPhotoUrl": string,
  "exteriorPhotoUrls": [
    string
  ],
  "interiorPhotoUrls": [
    string
  ],
  "productPhotoUrls": [
    string
  ],
  "photosAtWorkUrls": [
    string
  ],
  "foodAndDrinkPhotoUrls": [
    string
  ],
  "menuPhotoUrls": [
    string
  ],
  "commonAreasPhotoUrls": [
    string
  ],
  "roomsPhotoUrls": [
    string
  ],
  "teamPhotoUrls": [
    string
  ],
  "additionalPhotoUrls": [
    string
  ],
  "preferredPhoto": enum(PreferredPhoto),
}
Fields
profilePhotoUrl

string

The profile photo helps people recognize your business across Google. Profile photos must be square, with a minimum size of 250px and a maximum size of 500px. Allowed formats are JPG, PNG, and GIF.

coverPhotoUrl

string

The cover photo showcases the personality of your business. Cover photos must have a 16:9 aspect ratio, with a minimum size of 480px x 270px, and a maximum size of 2120px x 1192px.

logoPhotoUrl

string

The logo photo helps customers to recognize your brand. Upon upload, logo images are fitted into a square (transparent vertical or horizontal lines are added on two sides of the image if the original image is not square).

exteriorPhotoUrls[]

string

Exterior photos help customers to recognize your business as they approach from different directions.

interiorPhotoUrls[]

string

Interior photos show customers what your business location looks like inside.

productPhotoUrls[]

string

Product photos showcase the products sold by your business.

photosAtWorkUrls[]

string

At work photos show you and your employees serving your customers.

foodAndDrinkPhotoUrls[]

string

Food and drink photos display the food and drink items served by your business.

menuPhotoUrls[]

string

Menu photos show customers what your food menu looks like.

commonAreasPhotoUrls[]

string

Common area photos show customers the common areas of your business location.

roomsPhotoUrls[]

string

Room photos show customers the inside of your guest rooms.

teamPhotoUrls[]

string

Team photos show your management team and your employees.

additionalPhotoUrls[]

string

Use the additional photos category for images that don't fit in any of the other categories.

preferredPhoto

enum(PreferredPhoto)

Indicate which photo should be shown first in Google Maps and Search.

PreferredPhoto

Types of photo that should be shown first in Google Maps and Search.

Enums
PREFERRED_PHOTO_UNSPECIFIED Not specified.
PROFILE Profile photo.
COVER Cover photo.

OpenInfo

Indicates whether the location is currently open for business. All locations are open by default, unless updated to be closed.

JSON representation
{
  "status": enum(OpenForBusiness),
  "canReopen": boolean,
}
Fields
status

enum(OpenForBusiness)

Indicates whether the location is currently open for business.

canReopen

boolean

Indicates whether this business is eligible for re-open.

Note: This field is used in responses only. Any value specified here in a request is ignored.

OpenForBusiness

Indicates the status of a location.

Enums
OPEN_FOR_BUSINESS_UNSPECIFIED Not specified.
OPEN Indicates that the location is open.
CLOSED_PERMANENTLY Indicates that the location has been permanently closed.

LocationState

Contains a set of booleans that reflect the state of a Location.

JSON representation
{
  "isGoogleUpdated": boolean,
  "isDuplicate": boolean,
  "isSuspended": boolean,
  "canUpdate": boolean,
  "canDelete": boolean,
  "isVerified": boolean,
  "needsReverification": boolean,
  "isPendingReview": boolean,
  "isDisabled": boolean,
  "isPublished": boolean,
  "isDisconnected": boolean,
  "hasPendingVerification": boolean,
}
Fields
isGoogleUpdated

boolean

Indicates whether the place ID associated with this location has updates.

Note: This field is used in responses only. Any value specified here in a request is ignored.

isDuplicate

boolean

Indicates whether the location is a duplicate of another location. See metadata.duplicate for more information.

Note: This field is used in responses only. Any value specified here in a request is ignored.

isSuspended

boolean

Indicates whether the location is suspended. Suspended locations are not visible to end users in Google products. If you believe this was a mistake, see the help center article.

Note: This field is used in responses only. Any value specified here in a request is ignored.

canUpdate

boolean

Indicates whether the location can be updated.

Note: This field is used in responses only. Any value specified here in a request is ignored.

canDelete

boolean

Indicates whether the location can be deleted using the Google My Business UI.

Note: This field is used in responses only. Any value specified here in a request is ignored.

isVerified

boolean

Indicates whether the location is verified.

Note: This field is used in responses only. Any value specified here in a request is ignored.

needsReverification

boolean

Indicates whether the location requires reverification.

Note: This field is used in responses only. Any value specified here in a request is ignored.

isPendingReview

boolean

Indicates whether the review of the location is pending.

Note: This field is used in responses only. Any value specified here in a request is ignored.

isDisabled

boolean

Indicates whether the location is disabled

Note: This field is used in responses only. Any value specified here in a request is ignored.

isPublished

boolean

Indicates whether the location is published.

Note: This field is used in responses only. Any value specified here in a request is ignored.

isDisconnected

boolean

Indicates whether the location is disconnected from a place on Google Maps.

Note: This field is used in responses only. Any value specified here in a request is ignored.

hasPendingVerification

boolean

Indicates whether the location has pending verification requests.

Note: This field is used in responses only. Any value specified here in a request is ignored.

Attribute

A location attribute. Attributes provide additional information about a location. The attributes that can be set on a location may vary based on the properties of that location (for example, category). Available attributes are determined by Google and may be added and removed without API changes.

JSON representation
{
  "attributeId": string,
  "valueType": enum(AttributeValueType),
  "values": [
    value
  ],
  "repeatedEnumValue": {
    object(RepeatedEnumAttributeValue)
  },
  "urlValues": [
    {
      object(UrlAttributeValue)
    }
  ],
}
Fields
attributeId

string

The ID of the attribute. Attribute ids are provided by Google.

valueType

enum(AttributeValueType)

The type of value that this attribute contains. This should be used to determine how to interpret the value.

Note: This field is used in responses only. Any value specified here in a request is ignored.

values[]

value (Value format)

The values for this attribute. The type of the values supplied must match that expected for that attribute; see AttributeValueType. This is a repeated field where multiple attribute values may be provided. Current attribute types only support one value, but future types may support multiple values.

repeatedEnumValue

object(RepeatedEnumAttributeValue)

When the attribute value type is REPEATED_ENUM this contains the attribute value, and the other values fields must be empty. Available since v3.1.

urlValues[]

object(UrlAttributeValue)

When the attribute value type is URL this field contains the value(s) for this attribute, and the other values fields must be empty. Available since v3.1.

RepeatedEnumAttributeValue

Values for an attribute with valueType of REPEATED_ENUM. This consists of two lists of value ids: those that are set (true) and those that are unset (false). Values absent are considered unknown. At least one value must be specified. Available since v3.1.

JSON representation
{
  "setValues": [
    string
  ],
  "unsetValues": [
    string
  ],
}
Fields
setValues[]

string

Enum values that are set.

unsetValues[]

string

Enum values that are unset.

UrlAttributeValue

Values for an attribute with valueType of URL. Available since v3.1.

JSON representation
{
  "url": string,
}
Fields
url

string

The URL.

Metadata

Additional non-user-editable information about the location.

JSON representation
{
  "duplicate": {
    object(Duplicate)
  },
  "mapsUrl": string,
}
Fields
duplicate

object(Duplicate)

Information about the location that this location duplicates. Only present when locationState.is_duplicate is true.

mapsUrl

string

A link to the location on Maps. Available since v3.1.

Duplicate

Information about the location that this location duplicates.

JSON representation
{
  "locationName": string,
  "placeId": string,
  "ownership": enum(Ownership),
  "access": enum(Access),
}
Fields
locationName

string

The resource name of the location that this duplicates. Only populated if the authenticated user has access rights to that location and that location is not deleted.

placeId

string

The place ID of the location that this duplicates.

ownership
(deprecated)

enum(Ownership)

Indicates the ownership status between this location and the location that it duplicates.

access

enum(Access)

Indicates whether user has access to the location it duplicates. Available since v3.1.

Ownership

The ownership status between this location and the location that it duplicates. Replaced by Access.

Enums
OWNERSHIP_UNSPECIFIED Not specified.
SAME The location that this duplicates is under same ownership.
DIFFERENT The location that this duplicates is under different ownership.
UNKNOWN Unable to determine any information about the location that this duplicates. That location might be deleted or an unknown error state has occurred.

Access

User's access level to the location that it duplicates. This replaces Ownership and should be used instead.

Enums
ACCESS_UNSPECIFIED Not specified.
ACCESS_UNKNOWN Unable to determine whether the user has access to the location that it duplicates.
ALLOWED User has access to the location that it duplicates.
INSUFFICIENT User doesn't have access to the location that it duplicates.

PriceList

A list of item price information. Price lists are structured as one or more price lists, each containing one or more sections with one or more items. For example, food price lists may represent breakfast/lunch/dinner menus, with sections for burgers/steak/seafood.

JSON representation
{
  "priceListId": string,
  "labels": [
    {
      object(Label)
    }
  ],
  "sourceUrl": string,
  "sections": [
    {
      object(Section)
    }
  ],
}
Fields
priceListId

string

ID for the price list. Price list, section, and item IDs cannot be duplicated within this Location.

labels[]

object(Label)

Required. Language-tagged labels for the price list. At least one set of labels is required.

sourceUrl

string

Optional source URL of where the price list was retrieved from. For example, this could be the URL of the page that was automatically scraped to populate the menu information.

sections[]

object(Section)

Sections for this price list.

Label

Label to be used when displaying the price list, section, or item.

JSON representation
{
  "displayName": string,
  "description": string,
  "languageCode": string,
}
Fields
displayName

string

Required. Display name for the price list, section, or item.

description

string

Description of the price list, section, or item.

languageCode

string

Optional. The CLDR language code that these strings apply for. Only one set of labels may be set per language.

Section

A section of the price list containing one or more items.

JSON representation
{
  "sectionId": string,
  "labels": [
    {
      object(Label)
    }
  ],
  "items": [
    {
      object(Item)
    }
  ],
}
Fields
sectionId

string

ID for the section. Price list, section and, item IDs cannot be duplicated within this Location.

labels[]

object(Label)

Required. Language-tagged labels for the section. Section names should be 140 characters or less, descriptions 140 characters or less. At least one set of labels is required.

items[]

object(Item)

Items that are contained within this section of the price list.

Item

A singular list item. Each variation of an item in the price list should have its own Item with its own price data.

JSON representation
{
  "itemId": string,
  "labels": [
    {
      object(Label)
    }
  ],
  "price": {
    object(Money)
  },
  "photoUrls": [
    string
  ],
}
Fields
itemId

string

ID for the item. Price list, section, and item IDs cannot be duplicated within this Location.

labels[]

object(Label)

Required. Language tagged labels for the item. Item names should be 140 characters or less, descriptions 250 characters or less. At least one set of labels is required.

price

object(Money)

Price of the item.

photoUrls[]

string

URLs of photos attached to this item.

Money

Represents an amount of money with its currency type.

JSON representation
{
  "currencyCode": string,
  "units": string,
  "nanos": number,
}
Fields
currencyCode

string

The 3-letter currency code defined in ISO 4217.

units

string (int64 format)

The whole units of the amount. For example, if currencyCode is "USD", then 1 unit is one US dollar.

nanos

number

Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example, $-1.75 is represented as units=-1 and nanos=-750,000,000.

Methods

associate

Associates a location to a place ID.

batchGet

Gets all of the specified locations in the given account.

clearAssociation

Clears an association between a location and its place ID.

create

Creates a new location owned by the specified account, and returns it.

delete

Deletes a location.

findMatches

Finds all of the possible locations that are a match to the specified location.

get

Gets the specified location.

getGoogleUpdated

Gets the Google-updated version of the specified location.

list

Lists the locations for the specified account.

patch

Updates the specified location.

reportInsights

Returns a report containing insights on one or more metrics by location.

transfer

Transfer a location from one account to another.

Send feedback about...

Google My Business API
Google My Business API
Need help? Visit our support page.