REST Resource: attributes

Resource: AttributeMetadata

Metadata untuk atribut. Berisi informasi tampilan untuk atribut, termasuk nama yang dilokalkan dan judul untuk mengelompokkan beberapa atribut terkait.

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

string

ID atribut.

valueType

enum (AttributeValueType)

Jenis nilai untuk atribut. Nilai yang ditetapkan dan diambil akan diharapkan dari jenis ini.

displayName

string

Nama tampilan yang dilokalkan untuk atribut, jika tersedia; jika tidak, nama tampilan bahasa Inggris.

groupDisplayName

string

Nama tampilan grup yang dilokalkan yang berisi atribut ini, jika tersedia; jika tidak, nama grup bahasa Inggris. Atribut terkait dikumpulkan ke dalam grup dan harus ditampilkan bersamaan di bawah judul yang diberikan di sini.

isRepeatable

boolean

Jika true (benar), atribut mendukung beberapa nilai. Jika salah, hanya satu nilai yang harus diberikan.

valueMetadata[]

object (AttributeValueMetadata)

Untuk beberapa jenis atribut (misalnya, enum), daftar nilai yang didukung dan nama tampilan yang sesuai untuk nilai tersebut disediakan.

isDeprecated

boolean

Jika true (benar), atribut tidak digunakan lagi dan seharusnya tidak digunakan lagi. Jika tidak digunakan lagi, memperbarui atribut ini tidak akan menghasilkan error, tetapi pembaruan tidak akan disimpan. Pada titik tertentu setelah tidak digunakan lagi, atribut akan dihapus sepenuhnya dan akan menjadi error.

AttributeValueMetadata

Metadata untuk nilai atribut yang didukung.

Representasi JSON
{
  "value": value,
  "displayName": string
}
Kolom
value

value (Value format)

Nilai atribut.

displayName

string

Nama tampilan untuk nilai ini, dilokalkan jika tersedia; sebaliknya, dalam bahasa Inggris. Nama tampilan nilai dimaksudkan untuk digunakan dalam konteks dengan nama tampilan atribut.

Misalnya, untuk "Wi-Fi" atribut enum, ini dapat berisi "Berbayar" untuk mewakili Wi-Fi berbayar.

Metode

list

Menampilkan daftar atribut yang tersedia yang akan tersedia untuk lokasi dengan kategori dan negara utama tertentu.