Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-136513.7 KB
locations

Updates the specified place action link and returns it.

patch/v1/{+name}

Path parameters

namestring required

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.

Query parameters

updateMaskstring

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

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

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

Output only. Specifies the provider type.

createTimestring google-datetime

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

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.

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.

isEditableboolean

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

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.

Response

Successful response