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.

Method: placeActionTypeMetadata.list

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

HTTP request

GET https://mybusinessplaceactions.googleapis.com/v1/placeActionTypeMetadata

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
languageCode

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.

pageSize

integer

Optional. How many action types to include per page. Default is 10, minimum is 1.

pageToken

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/{locationId}. 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.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for PlaceActions.ListPlaceActionTypeMetadata.

JSON representation
{
  "placeActionTypeMetadata": [
    {
      object (PlaceActionTypeMetadata)
    }
  ],
  "nextPageToken": string
}
Fields
placeActionTypeMetadata[]

object (PlaceActionTypeMetadata)

A collection of metadata for the available place action types.

nextPageToken

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.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/business.manage

For more information, see the OAuth 2.0 Overview.

PlaceActionTypeMetadata

Metadata for supported place action types.

JSON representation
{
  "placeActionType": enum (PlaceActionType),
  "displayName": string
}
Fields
placeActionType

enum (PlaceActionType)

The place action type.

displayName

string

The localized display name for the attribute, if available; otherwise, the English display name.