Google Business Performance API has a
NEW API method that allows fetching multiple `DailyMetrics` in a single API request. Review the
deprecation schedule and instructions to migrate over from v4 reportInsights API method to Google Business Profile Performance API.
REST Resource: locations.placeActionLinks
Stay organized with collections
Save and categorize content based on your preferences.
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 |
|
Creates a place action link associated with the specified location, and returns it. |
|
Deletes a place action link from the specified location. |
|
Gets the specified place action link. |
|
Lists the place action links for the specified location. |
|
Updates the specified place action link and returns it. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-16 UTC."],[[["\u003cp\u003e\u003ccode\u003ePlaceActionLink\u003c/code\u003e resource represents a link associated with a Google Business Profile location, allowing customers to take actions like booking appointments or ordering food.\u003c/p\u003e\n"],["\u003cp\u003eLinks are categorized by \u003ccode\u003eProviderType\u003c/code\u003e (merchant, aggregator) and \u003ccode\u003ePlaceActionType\u003c/code\u003e (appointment, order, etc.) and can be managed through create, delete, get, list, and patch methods.\u003c/p\u003e\n"],["\u003cp\u003eEach link has attributes like \u003ccode\u003euri\u003c/code\u003e, \u003ccode\u003eisEditable\u003c/code\u003e, and \u003ccode\u003eisPreferred\u003c/code\u003e, providing control and information about the link's behavior and status.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ePlaceActionLink\u003c/code\u003e includes timestamps for creation and updates (\u003ccode\u003ecreateTime\u003c/code\u003e, \u003ccode\u003eupdateTime\u003c/code\u003e) enabling tracking of link history.\u003c/p\u003e\n"]]],[],null,["- [Resource: PlaceActionLink](#PlaceActionLink)\n - [JSON representation](#PlaceActionLink.SCHEMA_REPRESENTATION)\n- [ProviderType](#ProviderType)\n- [PlaceActionType](#PlaceActionType)\n- [Methods](#METHODS_SUMMARY)\n\nResource: PlaceActionLink Represents a place action link and its attributes.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"providerType\": enum (/my-business/reference/placeactions/rest/v1/locations.placeActionLinks#ProviderType), \"isEditable\": boolean, \"uri\": string, \"placeActionType\": enum (/my-business/reference/placeactions/rest/v1/locations.placeActionLinks#PlaceActionType), \"isPreferred\": boolean, \"createTime\": string, \"updateTime\": string } ``` |\n\n| Fields ||\n|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n| `providerType` | `enum (`[ProviderType](/my-business/reference/placeactions/rest/v1/locations.placeActionLinks#ProviderType)`)` Output only. Specifies the provider type. |\n| `isEditable` | `boolean` Output only. Indicates whether this link can be edited by the client. |\n| `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). |\n| `placeActionType` | `enum (`[PlaceActionType](/my-business/reference/placeactions/rest/v1/locations.placeActionLinks#PlaceActionType)`)` Required. The type of place action that can be performed using this link. |\n| `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. |\n| `createTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.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\"`. |\n| `updateTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.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\"`. |\n\nProviderType The type of the link provider, can only be read.\n\n| Enums ||\n|-----------------------------|-------------------------------------------------------------------------|\n| `PROVIDER_TYPE_UNSPECIFIED` | Not specified. |\n| `MERCHANT` | A 1P provider such as a merchant, or an agency on behalf of a merchant. |\n| `AGGREGATOR_3P` | A 3P aggregator, such as a `Reserve with Google` partner. |\n\nPlaceActionType The type of place action that can be performed using the link.\n\n| Enums ||\n|---------------------------------|------------------------------------------------------------------|\n| `PLACE_ACTION_TYPE_UNSPECIFIED` | Not specified. |\n| `APPOINTMENT` | The action type is booking an appointment. |\n| `ONLINE_APPOINTMENT` | The action type is booking an online appointment. |\n| `DINING_RESERVATION` | The action type is making a dining reservation. |\n| `FOOD_ORDERING` | The action type is ordering food for delivery and/or takeout. |\n| `FOOD_DELIVERY` | The action type is ordering food for delivery. |\n| `FOOD_TAKEOUT` | The action type is ordering food for takeout. |\n| `SHOP_ONLINE` | The action type is shopping, that can be delivery and/or pickup. |\n\n| Methods ||\n|-----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|\n| [create](/my-business/reference/placeactions/rest/v1/locations.placeActionLinks/create) | Creates a place action link associated with the specified location, and returns it. |\n| [delete](/my-business/reference/placeactions/rest/v1/locations.placeActionLinks/delete) | Deletes a place action link from the specified location. |\n| [get](/my-business/reference/placeactions/rest/v1/locations.placeActionLinks/get) | Gets the specified place action link. |\n| [list](/my-business/reference/placeactions/rest/v1/locations.placeActionLinks/list) | Lists the place action links for the specified location. |\n| [patch](/my-business/reference/placeactions/rest/v1/locations.placeActionLinks/patch) | Updates the specified place action link and returns it. |"]]