Package google.mybusiness.placeactions.v1

Index

• PlaceActions (interface)
• CreatePlaceActionLinkRequest (message)
• DeletePlaceActionLinkRequest (message)
• ErrorCode (enum)
• GetPlaceActionLinkRequest (message)
• ListPlaceActionLinksRequest (message)
• ListPlaceActionLinksResponse (message)
• ListPlaceActionTypeMetadataRequest (message)
• ListPlaceActionTypeMetadataResponse (message)
• PlaceActionLink (message)
• PlaceActionLink.ProviderType (enum)
• PlaceActionType (enum)
• PlaceActionTypeMetadata (message)
• UpdatePlaceActionLinkRequest (message)

PlaceActions

This API enables managing PlaceAction links of business locations.

CreatePlaceActionLink

rpc CreatePlaceActionLink(CreatePlaceActionLinkRequest) returns (PlaceActionLink) Creates a place action link associated with the specified location, and returns it. The request is considered duplicate if the parent, place_action_link.uri and place_action_link.place_action_type are the same as a previous request. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

DeletePlaceActionLink
rpc DeletePlaceActionLink(DeletePlaceActionLinkRequest) returns (Empty) Deletes a place action link from the specified location. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

GetPlaceActionLink
rpc GetPlaceActionLink(GetPlaceActionLinkRequest) returns (PlaceActionLink) Gets the specified place action link. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

ListPlaceActionLinks
rpc ListPlaceActionLinks(ListPlaceActionLinksRequest) returns (ListPlaceActionLinksResponse) Lists the place action links for the specified location. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

ListPlaceActionTypeMetadata
rpc ListPlaceActionTypeMetadata(ListPlaceActionTypeMetadataRequest) returns (ListPlaceActionTypeMetadataResponse) Returns the list of available place action types for a location or country. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

UpdatePlaceActionLink
rpc UpdatePlaceActionLink(UpdatePlaceActionLinkRequest) returns (PlaceActionLink) Updates the specified place action link and returns it. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

CreatePlaceActionLinkRequest

Request message for PlaceActions.CreatePlaceActionLink.

Fields
parent	string Required. The resource name of the location where to create this place action link. locations/{location_id}.
place_action_link	PlaceActionLink Required. The place action link to be created.

DeletePlaceActionLinkRequest

Request message for PlaceActions.DeletePlaceActionLink.

Fields
name	string Required. The resource name of the place action link to remove from the location.

ErrorCode

Error codes for internal failures.

Enums
ERROR_CODE_UNSPECIFIED	Unspecified error code.
UNVERIFIED_LOCATION	The location is not verified.
INVALID_LOCATION_CATEGORY	The location category is not eligible for the place action type. The place action type causing the error will be returned in the metadata, with string "place_action_type" as the key and PlaceActionType enum value string as the value.
INVALID_URL	The url is malformed/invalid. The place action url that is invalid will be returned in the metadata, with the string "url" as the key and the url as the value.
URL_PROVIDER_NOT_ALLOWED	The url has a provider that is not allowed. The place action url that is disallowed will be returned in the metadata, with the string "url" as the key and the url as the value.
TOO_MANY_VALUES	Too many values have been set for the place action type. The type for which the limit is reached will be returned in the metadata, with the string "place_action_type" as the key and PlaceActionType enum value string as the value.
DELETED_LINK	The requested place action link has been deleted. The corresponding url will be returned in the metadata, with the string "url" as the key and the url as the value.
LINK_ALREADY_EXISTS	An update is being requested to convert a place action link to one that already exists, with the same uri and type at the specified location.
SCALABLE_DEEP_LINK_INVALID_MULTIPLICITY	The domain that the link contains has already been used, and there is a limit of one link per domain for each PlaceActionType.
LINK_DOES_NOT_EXIST	A link has been specified that cannot be found in the database.

GetPlaceActionLinkRequest

Request message for PlaceActions.GetPlaceActionLink.

Fields
name	string Required. The name of the place action link to fetch.

ListPlaceActionLinksRequest

Request message for PlaceActions.ListPlaceActionLinks. This will list place action links for a location, in no specific order. This may fail to return links that have been created recently (within the past 24 hours) through other surfaces e.g. Google MyBusiness website. Any link created more than 24 hours ago will show up through this API.

Fields
parent	string Required. The name of the location whose place action links will be listed. locations/{location_id}.
filter	string Optional. A filter constraining the place action links to return. The response includes entries that match the filter. We support only the following filter: 1. place_action_type=XYZ where XYZ is a valid PlaceActionType.
page_size	int32 Optional. How many place action links to return per page. Default of 10. The minimum is 1.
page_token	string Optional. If specified, returns the next page of place action links.

ListPlaceActionLinksResponse

Response message for PlaceActions.ListPlaceActionLinks.

Fields
place_action_links[]	PlaceActionLink The returned list of place action links.
next_page_token	string If there are more place action links than the requested page size, then this field is populated with a token to fetch the next page of results.

ListPlaceActionTypeMetadataRequest

Request message for PlaceActions.ListPlaceActionTypeMetadata. The results will be returned in no specific order.

Fields
language_code	string Optional. The IETF BCP-47 code of language to get display names in. If this language is not available, they will be provided in English.
page_size	int32 Optional. How many action types to include per page. Default is 10, minimum is 1.
page_token	string Optional. If specified, the next page of place action type metadata is retrieved. The pageToken is returned when a call to placeActionTypeMetadata.list returns more results than can fit into the requested page size.
filter	string Optional. A filter constraining the place action types to return metadata for. The response includes entries that match the filter. We support only the following filters: 1. location=XYZ where XYZ is a string indicating the resource name of a location, in the format locations/{location_id}. 2. region_code=XYZ where XYZ is a Unicode CLDR region code to find available action types. If no filter is provided, all place action types are returned.

ListPlaceActionTypeMetadataResponse

Response message for PlaceActions.ListPlaceActionTypeMetadata.

Fields
place_action_type_metadata[]	PlaceActionTypeMetadata A collection of metadata for the available place action types.
next_page_token	string If the number of action types exceeded the requested page size, this field will be populated with a token to fetch the next page on a subsequent call to placeActionTypeMetadata.list. If there are no more results, this field will not be present in the response.

PlaceActionLink

Represents a place action link and its attributes.

Fields
name	string Optional. The resource name, in the format locations/{location_id}/placeActionLinks/{place_action_link_id}. The name field will only be considered in UpdatePlaceActionLink and DeletePlaceActionLink requests for updating and deleting links respectively. However, it will be ignored in CreatePlaceActionLink 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.
provider_type	ProviderType Output only. Specifies the provider type.
is_editable	bool 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).
place_action_type	PlaceActionType Required. The type of place action that can be performed using this link.
is_preferred	bool 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.
create_time	Timestamp Output only. The time when the place action link was created.
update_time	Timestamp Output only. The time when the place action link was last modified.

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.

PlaceActionTypeMetadata

Metadata for supported place action types.

Fields
place_action_type	PlaceActionType The place action type.
display_name	string The localized display name for the attribute, if available; otherwise, the English display name.

UpdatePlaceActionLinkRequest

Request message for PlaceActions.UpdatePlaceActionLink.

Fields
place_action_link	PlaceActionLink Required. The updated place action link.
update_mask	FieldMask Required. The specific fields to update. The only editable fields are uri, place_action_type and is_preferred. If the updated link already exists at the same location with the same place_action_type and uri, fails with an ALREADY_EXISTS error.