REST Resource: locations.placeActionLinks

AI-generated Key Takeaways

• PlaceActionLink resource represents a link associated with a Google Business Profile location, allowing customers to take actions like booking appointments or ordering food.

• Links are categorized by ProviderType (merchant, aggregator) and PlaceActionType (appointment, order, etc.) and can be managed through create, delete, get, list, and patch methods.

• Each link has attributes like uri, isEditable, and isPreferred, providing control and information about the link's behavior and status.

• PlaceActionLink includes timestamps for creation and updates (createTime, updateTime) enabling tracking of link history.

• Resource: PlaceActionLink
  • JSON representation
• ProviderType
• PlaceActionType
• Methods

Resource: PlaceActionLink

Represents a place action link and its attributes.

JSON representation
{ "name": string, "providerType": enum (ProviderType), "isEditable": boolean, "uri": string, "placeActionType": enum (PlaceActionType), "isPreferred": boolean, "createTime": string, "updateTime": string }

Fields
name	string Optional. The resource name, in the format locations/{locationId}/placeActionLinks/{place_action_link_id}. The name field will only be considered in placeActionLinks.patch and placeActionLinks.delete requests for updating and deleting links respectively. However, it will be ignored in placeActionLinks.create request, where place_action_link_id will be assigned by the server on successful creation of a new link and returned as part of the response.
providerType	enum (ProviderType) Output only. Specifies the provider type.
isEditable	boolean Output only. Indicates whether this link can be edited by the client.
uri	string Required. The link uri. The same uri can be reused for different action types across different locations. However, only one place action link is allowed for each unique combination of (uri, place action type, location).
placeActionType	enum (PlaceActionType) Required. The type of place action that can be performed using this link.
isPreferred	boolean Optional. Whether this link is preferred by the merchant. Only one link can be marked as preferred per place action type at a location. If a future request marks a different link as preferred for the same place action type, then the current preferred link (if any exists) will lose its preference.
createTime	string (Timestamp format) Output only. The time when the place action link was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime	string (Timestamp format) Output only. The time when the place action link was last modified. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

ProviderType

The type of the link provider, can only be read.

Enums
PROVIDER_TYPE_UNSPECIFIED	Not specified.
MERCHANT	A 1P provider such as a merchant, or an agency on behalf of a merchant.
AGGREGATOR_3P	A 3P aggregator, such as a Reserve with Google partner.

PlaceActionType

The type of place action that can be performed using the link.

Enums
PLACE_ACTION_TYPE_UNSPECIFIED	Not specified.
APPOINTMENT	The action type is booking an appointment.
ONLINE_APPOINTMENT	The action type is booking an online appointment.
DINING_RESERVATION	The action type is making a dining reservation.
FOOD_ORDERING	The action type is ordering food for delivery and/or takeout.
FOOD_DELIVERY	The action type is ordering food for delivery.
FOOD_TAKEOUT	The action type is ordering food for takeout.
SHOP_ONLINE	The action type is shopping, that can be delivery and/or pickup.

Methods
create	Creates a place action link associated with the specified location, and returns it.
delete	Deletes a place action link from the specified location.
get	Gets the specified place action link.
list	Lists the place action links for the specified location.
patch	Updates the specified place action link and returns it.