GOgoogle
locations

PATCH /v1/locations/{locationsId}/placeActionLinks/{placeActionLinksId}

Updates the specified place action link and returns it.

Request

  • Base URL
    https://mybusinessplaceactions.googleapis.com
  • Auth
    none declared

Path parameters

locationsIdstring required
placeActionLinksIdstring required

Query parameters

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

Request body

createTimestring google-datetime

Output only. The time when the place action link was created.

isEditableboolean

Output only. Indicates whether this link can be edited by the client.

isPreferredboolean

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.

namestring

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.

placeActionType'PLACE_ACTION_TYPE_UNSPECIFIED' | 'APPOINTMENT' | 'ONLINE_APPOINTMENT' | 'DINING_RESERVATION' | 'FOOD_ORDERING' | 'FOOD_DELIVERY' | 'FOOD_TAKEOUT' | 'SHOP_ONLINE' | 'SOLOPRENEUR_APPOINTMENT'

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

providerType'PROVIDER_TYPE_UNSPECIFIED' | 'MERCHANT' | 'AGGREGATOR_3P'

Output only. Specifies the provider type.

updateTimestring google-datetime

Output only. The time when the place action link was last modified.

uristring

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

Response

Successful response

createTimestring google-datetime

Output only. The time when the place action link was created.

isEditableboolean

Output only. Indicates whether this link can be edited by the client.

isPreferredboolean

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.

namestring

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.

placeActionType'PLACE_ACTION_TYPE_UNSPECIFIED' | 'APPOINTMENT' | 'ONLINE_APPOINTMENT' | 'DINING_RESERVATION' | 'FOOD_ORDERING' | 'FOOD_DELIVERY' | 'FOOD_TAKEOUT' | 'SHOP_ONLINE' | 'SOLOPRENEUR_APPOINTMENT'

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

providerType'PROVIDER_TYPE_UNSPECIFIED' | 'MERCHANT' | 'AGGREGATOR_3P'

Output only. Specifies the provider type.

updateTimestring google-datetime

Output only. The time when the place action link was last modified.

uristring

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

Changes

No recorded changes to this operation across all 3 revisions of this API.