Updates: Check the release notes for new features and product updates.

REST Resource: brands.locations

Resource: Location

Information about a physical location of a brand.

JSON representation
{
  "name": string,
  "placeId": string,
  "locationEntryPointConfigs": [
    {
      object (LocationEntryPointConfig)
    }
  ],
  "agent": string,
  "locationTestUrl": string,
  "testUrls": [
    {
      object (TestUrl)
    }
  ],
  "conversationalSettings": {
    string: {
      object (ConversationalSetting)
    },
    ...
  },
  "defaultLocale": string,
  "listingId": string
}
Fields
name

string

The unique identifier of the location.

Read-only. Defined by the platform.

placeId

string

Required. The Place ID, or unique identifier used in Google Maps, for the location.

Not modifiable after being available to users through an agent.

locationEntryPointConfigs[]
(deprecated)

object (LocationEntryPointConfig)

List of entry point configurations for locations.

Not modifiable after being available to users through an agent.

agent

string

Required. The name of the agent associated with the location. If the brand identifier is "1234" and the agent identifier is "5678", this field resolves to "brands/1234/agents/5678".

locationTestUrl
(deprecated)

string

Output only. The URL for testing the location's conversational experience.

Defined by the platform.

testUrls[]

object (TestUrl)

Output only. URLs for testing the location's conversational experience.

Defined by the platform.

conversationalSettings

map (key: string, value: object (ConversationalSetting))

Optional. Conversational settings for an location, mapped to a locale. Locale is represented by a well-formed IETF BCP 47 language tag.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

defaultLocale

string

Required. The default locale for the location.

listingId

string (int64 format)

Output only. Identifies the Google My Business Listing this Location is associated with.

LocationEntryPointConfig

The entry point configuration for a location.

JSON representation
{
  "allowedEntryPoint": enum (EntryPoint)
}
Fields
allowedEntryPoint

enum (EntryPoint)

Required. The Google surfaces the location is enabled to appear on.

EntryPoint

The Google surfaces the location is enabled to appear on.

Enums
ENTRY_POINT_UNSPECIFIED Unspecified entry point.
PLACESHEET Surface that displays when users search for a business location on Google Search.
MAPS_TACTILE Surface that displays when users search for a business location on Google Maps.

Methods

create

Creates a new location for a brand.

delete

Deletes a location.

get

Get information about a location.

getLaunch

Gets the launch information for a location.

getVerification

Gets the verification information for a location.

list

Lists all the locations for a brand.

patch

Updates information about a location.

requestLaunch

Begins the launch process for a location.

requestVerification

Begins verification for a location.

updateLaunch

Updates the launch information for a location.