The Verifications API and Business Information API is now launched! Migration work is required. Please see our deprecation schedule for more information related to deprecated endpoints. You may also sign up for our mailing list to receive updates.

Package google.mybusiness.placeactions.v1

Index

PlaceActions

This API enables managing PlaceAction links of business locations.

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.

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}.

DeletePlaceActionLinkRequest

Request message for PlaceActions.DeletePlaceActionLink.

Fields
name

string

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

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
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.

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.

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
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.