REST Resource: attributes

Tài nguyên: AttributesMetadata

Siêu dữ liệu về một thuộc tính. Chứa thông tin hiển thị của thuộc tính, bao gồm tên được bản địa hoá và tiêu đề để nhóm các thuộc tính có liên quan lại với nhau.

Biểu diễn dưới dạng JSON
{
  "attributeId": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "isRepeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "isDeprecated": boolean
}
Trường
attributeId

string

Mã nhận dạng của thuộc tính.

valueType

enum (AttributeValueType)

Loại giá trị cho thuộc tính. Các giá trị được thiết lập và truy xuất phải thuộc loại này.

displayName

string

Tên hiển thị được bản địa hoá cho thuộc tính (nếu có); nếu không thì tên hiển thị bằng tiếng Anh.

groupDisplayName

string

Tên hiển thị được bản địa hoá của nhóm chứa thuộc tính này (nếu có); hoặc tên nhóm bằng tiếng Anh. Các thuộc tính có liên quan được thu thập thành một nhóm và phải được hiển thị cùng nhau bên dưới tiêu đề được cung cấp tại đây.

isRepeatable

boolean

Nếu đúng, thuộc tính này sẽ hỗ trợ nhiều giá trị. Nếu là false, bạn chỉ được cung cấp một giá trị duy nhất.

valueMetadata[]

object (AttributeValueMetadata)

Đối với một số loại thuộc tính (ví dụ: enum), bạn sẽ nhận được danh sách các giá trị được hỗ trợ và tên hiển thị tương ứng cho các giá trị đó.

isDeprecated

boolean

Nếu là true, thuộc tính này sẽ không được dùng nữa và không nên dùng nữa. Nếu không dùng nữa, thì việc cập nhật thuộc tính này sẽ không gây ra lỗi nhưng nội dung cập nhật sẽ không được lưu. Sau khi không được dùng nữa, thuộc tính này sẽ bị xoá hoàn toàn và sẽ trở thành lỗi.

AttributeValueMetadata

Siêu dữ liệu về các giá trị thuộc tính được hỗ trợ.

Biểu diễn dưới dạng JSON
{
  "value": value,
  "displayName": string
}
Trường
value

value (Value format)

Giá trị thuộc tính.

displayName

string

Tên hiển thị cho giá trị này (được bản địa hoá nếu có); nếu không thì bằng tiếng Anh. Tên hiển thị giá trị được dùng trong ngữ cảnh cùng với tên hiển thị của thuộc tính.

Ví dụ: đối với "WiFi" enum, thuộc tính này có thể chứa "Trả phí" để thể hiện Wi-Fi có tính phí.

Phương thức

list

Trả về danh sách các thuộc tính sẵn có đối với một vị trí có quốc gia và danh mục chính đã cho.