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 ( |
Fields | |
---|---|
name |
Google identifier for this location in the form: |
languageCode |
Immutable. The language of the location. Set during creation and not updateable. |
storeCode |
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 |
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, |
phoneNumbers |
Optional. The different phone numbers that customers can use to get in touch with the business. |
categories |
Optional. The different categories that describe the business. |
storefrontAddress |
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 |
websiteUri |
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 |
Optional. Operating hours for the business. |
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 |
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[] |
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 |
Optional. Additional information that is surfaced in AdWords. |
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 |
openInfo |
Optional. A flag that indicates whether the location is currently open for business. |
metadata |
Output only. Additional non-user-editable information. |
profile |
Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g. hotels, motels, inns). |
relationshipData |
Optional. All locations and chain related to this one. |
moreHours[] |
Optional. More hours for a business's different departments or specific customers. |
serviceItems[] |
Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically. |
Methods |
|
---|---|
|
Deletes a location. |
|
Returns the specified location. |
|
Looks up all the attributes set for a given location. |
|
Gets the Google-updated version of the specified location. |
|
Updates the specified location. |
|
Update attributes for a given location. |