REST Resource: attributes

Risorsa: AttributeMetadata

Metadati relativi a un attributo. Contiene le informazioni di visualizzazione per l'attributo, tra cui un nome localizzato e un'intestazione per raggruppare gli attributi correlati.

Rappresentazione JSON
{
  "attributeId": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "isRepeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "isDeprecated": boolean
}
Campi
attributeId

string

L'ID dell'attributo.

valueType

enum (AttributeValueType)

Il tipo di valore dell'attributo. I valori impostati e recuperati dovrebbero essere di questo tipo.

displayName

string

Il nome visualizzato localizzato dell'attributo, se disponibile. altrimenti il nome visualizzato in inglese.

groupDisplayName

string

Il nome visualizzato localizzato del gruppo che contiene questo attributo, se disponibile. altrimenti il nome del gruppo in inglese. Gli attributi correlati vengono raccolti in un gruppo e devono essere visualizzati insieme sotto l'intestazione qui fornita.

isRepeatable

boolean

Se true, l'attributo supporta più valori. Se false, è necessario fornire un solo valore.

valueMetadata[]

object (AttributeValueMetadata)

Per alcuni tipi di attributi (ad esempio le enum), viene fornito un elenco di valori supportati e dei relativi nomi visualizzati.

isDeprecated

boolean

Se impostato su true, l'attributo è obsoleto e non deve più essere utilizzato. Se deprecato, l'aggiornamento di questo attributo non genererà un errore, ma gli aggiornamenti non verranno salvati. A un certo punto, dopo essere stato deprecato, l'attributo verrà rimosso completamente e diventerà un errore.

AttributeValueMetadata

Metadati per i valori degli attributi supportati.

Rappresentazione JSON
{
  "value": value,
  "displayName": string
}
Campi
value

value (Value format)

Il valore dell'attributo.

displayName

string

Il nome visualizzato di questo valore, localizzato dove disponibile; altrimenti in inglese. Il nome visualizzato del valore deve essere utilizzato nel contesto del nome visualizzato dell'attributo.

Ad esempio, per una connessione "Wi-Fi" attributo enum, potrebbe contenere "Pagato" per rappresentare le reti Wi-Fi a pagamento.

Metodi

list

Restituisce l'elenco degli attributi disponibili che sarebbero disponibili per una località con il paese e la categoria principali specificati.