The Q&A API is now launched! Migration work is required. Please see our deprecation schedule for more information related to deprecated endpoints. You may also sign up for our mailing list to receive updates.

REST Resource: locations

Resource: Location

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

JSON representation
{
  "name": string,
  "languageCode": string,
  "storeCode": string,
  "title": string,
  "phoneNumbers": {
    object (PhoneNumbers)
  },
  "categories": {
    object (Categories)
  },
  "storefrontAddress": {
    object (PostalAddress)
  },
  "websiteUri": string,
  "regularHours": {
    object (BusinessHours)
  },
  "specialHours": {
    object (SpecialHours)
  },
  "serviceArea": {
    object (ServiceAreaBusiness)
  },
  "labels": [
    string
  ],
  "adWordsLocationExtensions": {
    object (AdWordsLocationExtensions)
  },
  "latlng": {
    object (LatLng)
  },
  "openInfo": {
    object (OpenInfo)
  },
  "metadata": {
    object (Metadata)
  },
  "profile": {
    object (Profile)
  },
  "relationshipData": {
    object (RelationshipData)
  },
  "moreHours": [
    {
      object (MoreHours)
    }
  ]
}
Fields
name

string

Google identifier for this location in the form: locations/{locationId}.

languageCode

string

Immutable. The language of the location. Set during creation and not updateable.

storeCode

string

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

title

string

Required. 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). Don't add unnecessary information to your name (for example, prefer "Google" over "Google Inc. - Mountain View Corporate Headquarters"). Don't 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").

phoneNumbers

object (PhoneNumbers)

Optional. The different phone numbers that customers can use to get in touch with the business.

categories

object (Categories)

Optional. The different categories that describe the business.

storefrontAddress

object (PostalAddress)

Optional. 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. This field should only be set for businesses that have a storefront. This field should not be set for locations of type CUSTOMER_LOCATION_ONLY.

websiteUri

string

Optional. 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)

Optional. Operating hours for the business.

specialHours

object (SpecialHours)

Optional. Special hours for the business. This typically includes holiday hours, and other times outside of regular operating hours. These override regular business hours. This field cannot be set without regular hours.

serviceArea

object (ServiceAreaBusiness)

Optional. 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.

labels[]

string

Optional. A collection of free-form strings to allow you to tag your business. These labels are NOT user facing; only you can see them. Must be between 1-255 characters per label.

adWordsLocationExtensions

object (AdWordsLocationExtensions)

Optional. Additional information that is surfaced in AdWords.

latlng

object (LatLng)

Optional. 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 the latlng value was updated through the Business Profile website. This field can only be updated by approved clients.

openInfo

object (OpenInfo)

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

metadata

object (Metadata)

Output only. Additional non-user-editable information.

profile

object (Profile)

Required. Describes your business in your own voice and shares with users the unique story of your business and offerings.

relationshipData

object (RelationshipData)

Output only. All locations and chain related to this one.

moreHours[]

object (MoreHours)

Optional. More hours for a business's different departments or specific customers.

Methods

associate

Associates a location to a place ID.

clearLocationAssociation

Clears an association between a location and its place ID.

delete

Deletes a location.

get

Returns the specified location.

getAttributes

Looks up all the attributes set for a given location.

getGoogleUpdated

Gets the Google-updated version of the specified location.

patch

Updates the specified location.

updateAttributes

Looks up all the attributes provided for a given location.