Location Attributes

Overview

A Location represents a physical business location in your account. It is the starting point for accessing and harnessing the various endpoints the API has to offer.

Location Object

The following table details all available fields for Location objects. Fields marked as mandatory are required when creating or updating locations.

Core Attributes

Address Information

Contact Information

Business Details

Online Presence

Publishing Configuration

System Fields

Restaurant and Food Business-Specific Fields

Categorization & Organization

Place Action Links

Google place action links are the action buttons shown on the Business Profile (order, book, reserve, and more). See Managing Place Action Links for the write model and how to add a discovered link.

Notes

¹ Refer to the Places API for valid ISO codes ² Refer to Plan Sites for available site IDs ³ Only required for accounts with multiple subscriptions. Find about subscription ⁴ Get Primary Categories and Additional Categories here ⚑ Conditionally required

Business hours schema

Full BusinessHours__v3 reference

Phone Number Formats

Back to Contact info

• Must follow the international E.164 format. Ref here.
• Do not include the + sign or country code.
• Remove parentheses and special characters.
• Example:
  • Incorrect: (123)-456-7890, +1-123-456-7890
  • Correct: 1234567890

Supported Payment Methods

Full paymentMethods reference

Subcategories and Additional Categories

SubCategory

• A Subcategory can be considered as the primary category for the location.
• Only categories where PRIMARY is set to true are considered SubCategories.

AdditionalCategory

• An Additional Category can be considered as the secondary category for the location.
• Categories where PRIMARY is either true or false are considered AdditionalCategories.

Managing Place Action Links

Place action links are the action buttons Google shows on a Business Profile (order online, book, reserve, and so on). Manage them through the placeActionLinks array on the Create a new business location and Update business location endpoints.

Link object

Write model — append / upsert. Only the links you include are affected; links you leave out stay unchanged. A link is matched by name when present, otherwise by placeActionType + uri.

Add a link

Send a placeActionLinks entry with action set to add (the default), plus placeActionType and uri. Set isPreferred to true to make it the preferred link for its type.

{
  "input": {
    "placeActionLinks": [
      {
        "placeActionType": "FOOD_ORDERING",
        "uri": "https://order.example.com",
        "isPreferred": true,
        "action": "add"
      }
    ]
  }
}

Edit a link

There is no in-place update. In the same Update business location call, send the current link with action set to delete, then the new link with action set to add. The delete is matched by name when you have it, otherwise by placeActionType + uri.

{
  "input": {
    "placeActionLinks": [
      {
        "placeActionType": "FOOD_ORDERING",
        "uri": "https://old-order.example.com",
        "action": "delete"
      },
      {
        "placeActionType": "FOOD_ORDERING",
        "uri": "https://new-order.example.com",
        "isPreferred": true,
        "action": "add"
      }
    ]
  }
}

Add a discovered link

Links Google finds on its own are returned read-only under discoveredPlaceActionLinks. To take ownership of one, re-add it through placeActionLinks using the same placeActionType and uri with action set to add. After the write it moves under placeActionLinks; its name and submissionStatus stay null until it syncs to Google.

{
  "input": {
    "placeActionLinks": [
      {
        "placeActionType": "FOOD_ORDERING",
        "uri": "https://discovered-order.example.com",
        "action": "add"
      }
    ]
  }
}

Common Errors while creating a location