Method: placeActionTypeMetadata.list

Retorna a lista de tipos de ação de lugar disponíveis para um local ou país.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
languageCode

string

Opcional. O código de idioma IETF BCP-47 para receber nomes de exibição. Se esse idioma não estiver disponível, eles serão fornecidos em inglês.

pageSize

integer

Opcional. Quantos tipos de ação incluir por página. O padrão é 10, e o mínimo é 1.

pageToken

string

Opcional. Se especificado, a próxima página dos metadados do tipo de ação do lugar é recuperada. O pageToken é retornado quando uma chamada para placeActionTypeMetadata.list retorna mais resultados do que o tamanho de página solicitado.

filter

string

Opcional. Um filtro que restringe os tipos de ação de lugar para os quais retornar metadados. A resposta inclui entradas que correspondem ao filtro. Oferecemos suporte apenas aos seguintes filtros: 1. location=XYZ, em que XYZ é uma string que indica o nome de recurso de um local, no formato locations/{locationId}. 2. region_code=XYZ, em que XYZ é um código de região Unicode CLDR para encontrar tipos de ação disponíveis.

Se nenhum filtro for fornecido, todos os tipos de ação de lugar vão ser retornados.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para PlaceActions.ListPlaceActionTypeMetadata.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "placeActionTypeMetadata": [
    {
      object (PlaceActionTypeMetadata)
    }
  ],
  "nextPageToken": string
}
Campos
placeActionTypeMetadata[]

object (PlaceActionTypeMetadata)

Uma coleção de metadados para os tipos de ação de lugar disponíveis.

nextPageToken

string

Se o número de tipos de ação exceder o tamanho da página solicitado, esse campo será preenchido com um token para buscar a próxima página em uma chamada subsequente para placeActionTypeMetadata.list. Se não houver mais resultados, este campo não estará presente na resposta.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.

PlaceActionTypeMetadata

Metadados dos tipos de ação de lugar compatíveis.

Representação JSON
{
  "placeActionType": enum (PlaceActionType),
  "displayName": string
}
Campos
placeActionType

enum (PlaceActionType)

O tipo de ação de lugar.

displayName

string

O nome de exibição localizado para o atributo, se disponível. Caso contrário, o nome de exibição em inglês.