APIHub
Back to Explore

My Business Place Actions API

The My Business Place Actions API lets you discover the place action types supported for a given location or region and manage the associated place action links for a Google Business location, including creating, reading, listing, updating, and deleting those links.

Analytics
none
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

608ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/v1/placeActionTypeMetadata

Returns the list of available place action types for a location or country.

  • filter (query) — 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.
  • languageCode (query) — 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.
  • pageSize (query, limit) — Optional. How many action types to include per page. Default is 10, minimum is 1.
  • pageToken (query) — 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.
DELETE

/v1/{name}

Deletes a place action link from the specified location.

  • name (path, required) — Required. The resource name of the place action link to remove from the location.
GET

/v1/{name}

Gets the specified place action link.

  • name (path, required) — Required. The name of the place action link to fetch.
PATCH

/v1/{name}

Updates the specified place action link and returns it.

  • name (path, 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.
  • updateMask (query) — 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.
GET

/v1/{parent}/placeActionLinks

Lists the place action links for the specified location.

  • parent (path, required) — Required. The name of the location whose place action links will be listed. `locations/{location_id}`.
  • filter (query) — 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.
  • pageSize (query, limit) — Optional. How many place action links to return per page. Default of 10. The minimum is 1.
  • pageToken (query) — Optional. If specified, returns the next page of place action links.
POST

/v1/{parent}/placeActionLinks

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.

  • parent (path, required) — Required. The resource name of the location where to create this place action link. `locations/{location_id}`.

6 endpoints auto-detected

curl -X GET \
  "https://mybusinessplaceactions.googleapis.com/v1/placeActionTypeMetadata"

mybusinessplaceactions.googleapis.com · HTTPS only