- Solicitação HTTP
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- AttributeMetadata
- AttributeValueMetadata
Retorna a lista de atributos que estariam disponíveis para um local com a categoria principal e o país especificados.
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 |
Nome do recurso do local para procurar os atributos disponíveis. Se este campo for definido, CategoryName, regionCode, languageCode e showAll não são obrigatórios e não devem ser definidos. |
categoryName |
O ID estável da categoria principal para encontrar os atributos disponíveis. Precisa estar no formato categorias/{category_id}. |
regionCode |
O código de país ISO 3166-1 alfa-2 para encontrar os atributos disponíveis. |
languageCode |
O código de idioma BCP 47 para receber nomes de exibição de atributos. Se esse idioma não estiver disponível, eles serão fornecidos em inglês. |
showAll |
Os metadados de todos os atributos disponíveis são retornados quando este campo é definido como verdadeiro, desconsiderando os campos "pai" e "categoryName". LanguageCode e regionCode são obrigatórios quando showAll está definido como verdadeiro. |
pageSize |
Quantos atributos serão incluídos por página. O padrão é 200, e o mínimo é 1. |
pageToken |
Se especificado, a próxima página de metadados do atributo é 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 ( |
Campos | |
---|---|
attributeMetadata[] |
Uma coleção de metadados de atributos para os atributos disponíveis. |
nextPageToken |
Se o número de atributos exceder 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 |
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.
AttributeMetadata
Metadados para um atributo. Contém informações de exibição do atributo, incluindo um nome localizado e um título para agrupar atributos relacionados.
Representação JSON |
---|
{ "parent": string, "valueType": enum ( |
Campos | |
---|---|
parent |
O identificador exclusivo do atributo. |
valueType |
O tipo de valor do atributo. Espera-se que os valores definidos e recuperados sejam desse tipo. |
displayName |
O nome de exibição localizado para o atributo, se disponível. Caso contrário, o nome de exibição em inglês. |
groupDisplayName |
O nome de exibição localizado do grupo que contém esse atributo, se disponível. Caso contrário, o nome do grupo em inglês. Os atributos relacionados são reunidos em um grupo e devem ser exibidos juntos sob o título fornecido aqui. |
repeatable |
Se verdadeiro, o atributo aceita vários valores. Se for falso, forneça apenas um valor. |
valueMetadata[] |
Para alguns tipos de atributos, como tipos enumerados, é fornecida uma lista de valores compatíveis e os nomes de exibição correspondentes. |
deprecated |
Se for verdadeiro, o atributo será descontinuado e não poderá mais ser usado. Se o uso for suspenso, a atualização desse atributo não vai resultar em erro, mas as atualizações não serão salvas. Em algum momento após ser descontinuado, o atributo será totalmente removido e se tornará um erro. |
AttributeValueMetadata
Metadados para valores de atributo compatíveis.
Representação JSON |
---|
{ "value": value, "displayName": string } |
Campos | |
---|---|
value |
O valor do atributo. |
displayName |
O nome de exibição desse valor, localizado quando disponível. Caso contrário, será em inglês. O nome de exibição do valor precisa ser usado no contexto com o nome de exibição do atributo. Por exemplo, para um atributo de tipo enumerado "Wi-Fi", poderia conter "Pago" para representar uma rede Wi-Fi paga. |