Skip to main content
Place action links are URLs shown on the profile for actions like order online, book, or reserve. Google validates URLs and types. Use list to read existing links and obtain resource names for update or delete. Base path: /api/v1/misc/google-business
FieldTypeNotes
namestringResource name in format locations/{locationId}/placeActionLinks/{place_action_link_id}. Ignored on create, used on patch/delete.
providerTypeenumOutput-only. Provider type (MERCHANT, AGGREGATOR_3P, PROVIDER_TYPE_UNSPECIFIED).
isEditablebooleanOutput-only. Whether the link can be edited by the client.
uristringRequired by Google for create. Link URL.
placeActionTypeenumRequired by Google for create. Action type represented by the link.
isPreferredbooleanOptional. Only one preferred link per placeActionType for a location.
createTimestringOutput-only RFC3339 timestamp.
updateTimestringOutput-only RFC3339 timestamp.

placeActionType values

ValueTypical use
APPOINTMENTGeneric appointment booking.
ONLINE_APPOINTMENTOnline appointment booking.
DINING_RESERVATIONTable reservations.
FOOD_ORDERINGOrder food.
FOOD_DELIVERYDelivery.
FOOD_TAKEOUTTakeout.
SHOP_ONLINEE-commerce or online shopping.

providerType values (output-only)

ValueMeaning
PROVIDER_TYPE_UNSPECIFIEDUnspecified provider type.
MERCHANTMerchant-owned link (or agency acting for the merchant).
AGGREGATOR_3PThird-party aggregator integration.

How availability is determined in Google

Google also provides place action type metadata at the API level (for example with location or region filters and optional language localization). In practice, allowed values can differ by business category and location setup. For reliable behavior:
  1. Read current links for the selected location.
  2. Update only action types that are already accepted or explicitly available for that location context.

Endpoint: GET /api/v1/misc/google-business/location/place-action-links
QueryRequiredDescription
teamIdYesTeam identifier.
pageSizeNo1 to 100.
pageTokenNoPagination.
Response: placeActionLinks array and optional nextPageToken. Each link may include name, uri, placeActionType, isPreferred, and output-only Google metadata such as providerType, isEditable, createTime, updateTime.
Endpoint: POST /api/v1/misc/google-business/location/place-action-links

Body

FieldRequiredDescription
teamIdYesTeam identifier.
placeActionLinkYesNested object sent to Google. Should include at least uri and placeActionType for create.

Example (nested-only payload)

{
  "teamId": "team_123",
  "placeActionLink": {
    "uri": "https://example.com/order",
    "placeActionType": "FOOD_ORDERING",
    "isPreferred": true
  }
}

Endpoint: PATCH /api/v1/misc/google-business/location/place-action-links
FieldRequiredDescription
teamIdYesTeam identifier.
nameYesFull resource name from Google, for example locations/{locationId}/placeActionLinks/{id}. Must belong to the selected authorized location.
fieldsYesSubset of updated fields: uri, placeActionType, isPreferred (one or more).
placeActionLinkYesNested object with updated values. Include keys matching fields.

Example

{
  "teamId": "team_123",
  "name": "locations/12345678901234567890/placeActionLinks/abcdef",
  "fields": ["uri", "isPreferred"],
  "placeActionLink": {
    "uri": "https://example.com/new-order",
    "isPreferred": true
  }
}

Endpoint: DELETE /api/v1/misc/google-business/location/place-action-links
{
  "teamId": "team_123",
  "name": "locations/12345678901234567890/placeActionLinks/abcdef"
}
name must be the full Google resource name including /placeActionLinks/ and must belong to the selected authorized location.

Availability caveats

Google may restrict place action links and action types based on business category, location, region, and profile eligibility.
  • Some placeActionType values may be rejected for specific business categories.
  • Features can vary between locations on the same account.
  • Recommended flow: call list first, then create/update using supported values for that location.