REST Resource: attributes

Recurso: AttributeMetadata

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

string

O ID do atributo.

valueType

enum (AttributeValueType)

O tipo de valor para o atributo. Os valores definidos e recuperados devem ser desse tipo.

displayName

string

o nome de exibição localizado do 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 coletados 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, apenas um valor deverá ser fornecido.

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 a esses valores.

isDeprecated

boolean

Se for verdadeiro, o atributo será descontinuado e não deverá mais ser usado. Se ele for descontinuado, a atualização deste 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 dos 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. em inglês. O nome de exibição do valor deve ser usado em contexto com o nome de exibição do atributo.

Por exemplo, para uma rede Wi-Fi, atributo enum, que pode conter "Pago" para representar o Wi-Fi pago.

Métodos

list

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