REST Resource: attributes

Recurso: AttributeMetadata

Son los metadatos de un atributo. Contiene información de visualización del atributo, como un nombre localizado y un encabezado para agrupar los atributos relacionados.

Representación JSON
{
  "attributeId": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "isRepeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "isDeprecated": boolean
}
Campos
attributeId

string

Es el ID del atributo.

valueType

enum (AttributeValueType)

Es el tipo de valor del atributo. Se espera que los valores establecidos y recuperados sean de este tipo.

displayName

string

El nombre visible localizado del atributo, si está disponible; de lo contrario, es el nombre visible en inglés.

groupDisplayName

string

El nombre visible localizado del grupo que contiene este atributo, si está disponible; de lo contrario, el nombre del grupo en inglés. Los atributos relacionados se recopilan en un grupo y deben mostrarse juntos bajo el encabezado que se proporciona aquí.

isRepeatable

boolean

Si es verdadero, el atributo admite varios valores. Si es falso, se debe proporcionar un solo valor.

valueMetadata[]

object (AttributeValueMetadata)

Para algunos tipos de atributos (por ejemplo, enumeraciones), se proporciona una lista de los valores admitidos y los nombres visibles correspondientes a esos valores.

isDeprecated

boolean

Si es verdadero, el atributo deja de estar disponible y no debe usarse más. Si es obsoleto, la actualización de este atributo no generará errores, pero no se guardarán las actualizaciones. Después de que este deje de estar disponible, se quitará por completo y se convertirá en un error.

AttributeValueMetadata

Metadatos de los valores de atributos admitidos.

Representación JSON
{
  "value": value,
  "displayName": string
}
Campos
value

value (Value format)

Es el valor del atributo.

displayName

string

Es el nombre visible de este valor, localizado cuando esté disponible; de lo contrario, debe estar en inglés. El nombre visible del valor se diseñó para usarse en contexto con el nombre visible del atributo.

Por ejemplo, para un atributo de enumeración "Wi-Fi", podría incluir "Pagado" para representar la red Wi-Fi pagada.

Métodos

list

Muestra la lista de atributos disponibles que estarían disponibles para una ubicación con la categoría principal y el país especificados.