REST Resource: attributes

Recurso: 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
{
  "attributeId": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "isRepeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "isDeprecated": boolean
}
Campos
attributeId

string

ID do atributo.

valueType

enum (AttributeValueType)

O tipo de valor do 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, 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, 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.

isRepeatable

boolean

Se verdadeiro, o atributo aceita vários valores. Se for falso, forneça apenas um valor.

valueMetadata[]

object (AttributeValueMetadata)

Para alguns tipos de atributos, como tipos enumerados, é fornecida uma lista de valores compatíveis e os nomes de exibição correspondentes.

isDeprecated

boolean

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

value (Value format)

O valor do atributo.

displayName

string

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.

Métodos

list

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