Method: attributes.list

Retorna a lista de atributos que estariam disponíveis para um local com a categoria principal e o país informados.

Solicitação HTTP

GET https://mybusinessbusinessinformation.googleapis.com/v1/attributes

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

Parâmetros de consulta

Parâmetros
parent

string

Opcional. Nome do recurso do local para procurar atributos disponíveis. Se esse campo estiver definido, categoryName, regionCode, languageCode e showAll não serão obrigatórios e não poderão ser definidos.

Formato: locations/{locationId} (por exemplo, locations/1234567890).
categoryName

string

Opcional. O ID estável da categoria principal para encontrar os atributos disponíveis. Precisa estar no formato categories/{category_id} (por exemplo, categories/gcid:restaurant). Obrigatório se parent não estiver definido e showAll for falso.
regionCode

string

Opcional. O código de país ISO 3166-1 alfa-2 para encontrar os atributos disponíveis. Obrigatório se parent não estiver definido.
languageCode

string

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

boolean

Opcional. Se definido como verdadeiro, os metadados de todos os atributos disponíveis serão retornados, desconsiderando os campos parent e categoryName. languageCode e regionCode são obrigatórios quando showAll está definido como verdadeiro.
pageSize

integer

O total de atributos a serem incluídos por página. O padrão é 200, e o mínimo é 1.
pageToken

string

Se especificado, a próxima página de metadados de atributo será recuperada.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta para AttributesService.ListAttributeMetadata.

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

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

object (AttributeMetadata)

Uma coleção de metadados de atributos para os atributos disponíveis.
nextPageToken

string

Se o número de atributos for maior que o tamanho da página solicitado, esse campo será preenchido com um token para buscar a próxima página de atributos em uma chamada subsequente para attributes.list. Se não houver mais atributos, 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 OAuth 2.0 Overview.

AttributeMetadata

Metadados para um atributo. Contém informações de exibição para o atributo, incluindo um nome localizado e um título para agrupar atributos relacionados.

Representação JSON 
{
  "parent": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "repeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "deprecated": boolean
}
Campos
parent

string

O identificador exclusivo do atributo.
valueType

enum (AttributeValueType)

O tipo de valor para o atributo. Espera-se que os valores definidos e recuperados sejam desse tipo.
displayName

string

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

string

O nome de exibição localizado do grupo que contém esse atributo, se disponível. Caso contrário, será o nome do grupo em inglês. Os atributos relacionados são coletados no grupo e devem ser exibidos juntos abaixo do título fornecido aqui.
repeatable

boolean

Se for verdadeiro, o atributo será compatível com vários valores. Se for falso, somente um valor será informado.
valueMetadata[]

object (AttributeValueMetadata)

Para alguns tipos de atributos (por exemplo, tipos enumerados), é fornecida uma lista de valores compatíveis e nomes de exibição correspondentes para esses valores.
deprecated

boolean

Se for verdadeiro, o atributo será obsoleto e não deverá mais ser usado. Se for obsoleta, a atualização deste atributo não resultará em erro, mas as atualizações não serão salvas. Em algum momento após a descontinuação, o atributo será removido por completo e se tornará um erro.

AttributeValueMetadata

Metadados de valores de atributo compatíveis.

Representação JSON 
{
  "value": value,
  "displayName": string
}
Campos
value

value (Value format)

O valor do atributo.
displayName

string

O nome de exibição para este valor, localizado onde estiver disponível. Caso contrário, será em inglês. O nome de exibição do valor deve ser usado no contexto com o nome de exibição do atributo.

Por exemplo, para um atributo de tipo enumerado "WiFi", ele pode conter "Paid" para representar o Wi-Fi pago.