Method: attributes.list

Trả về danh sách các thuộc tính có thể sử dụng cho một vị trí với danh mục chính và quốc gia cụ thể.

Yêu cầu HTTP

GET https://mybusinessbusinessinformation.googleapis.com/v1/attributes

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số truy vấn

Các tham số
parent

string

Tên tài nguyên của vị trí để tra cứu các thuộc tính hiện có. Nếu bạn đặt trường này, thì bạn không bắt buộc phải đặt cảcategoryName, RegionCode, languageCode và showAll, cũng như không đặt chế độ này.
categoryName

string

Mã nhận dạng ổn định của danh mục chính để tìm các thuộc tính có sẵn. Phải ở định dạng danh mục/{category_id}.
regionCode

string

Mã quốc gia ISO 3166-1 alpha-2 để tìm các thuộc tính có sẵn.
languageCode

string

Mã ngôn ngữ BCP 47 để lấy tên hiển thị thuộc tính. Nếu không có ngôn ngữ này, họ sẽ được cung cấp bằng tiếng Anh.
showAll

boolean

Siêu dữ liệu cho tất cả các thuộc tính có sẵn sẽ được trả về khi trường này được đặt thành true, bỏ qua các trường parent vàcategoryName. Bắt buộc phải có languageCode và RegionCode khi showAll được đặt thành true.
pageSize

integer

Số lượng thuộc tính cần đưa vào mỗi trang. Giá trị mặc định là 200, tối thiểu là 1.
pageToken

string

Nếu được chỉ định, hệ thống sẽ truy xuất trang tiếp theo của siêu dữ liệu thuộc tính.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Phản hồi cho AttributesService.ListAttributeMetadata.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "attributeMetadata": [
    {
      object (AttributeMetadata)
    }
  ],
  "nextPageToken": string
}
Các trường
attributeMetadata[]

object (AttributeMetadata)

Tập hợp siêu dữ liệu thuộc tính cho các thuộc tính hiện có.
nextPageToken

string

Nếu số lượng thuộc tính vượt quá kích thước trang được yêu cầu, trường này sẽ được điền sẵn một mã thông báo để tìm nạp trang tiếp theo của thuộc tính trong lệnh gọi tiếp theo đến attributes.list. Nếu không có thêm thuộc tính nào khác, trường này sẽ không xuất hiện trong phản hồi.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/business.manage

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

AttributeMetadata

Siêu dữ liệu cho một thuộc tính. Chứa thông tin về màn hình của thuộc tính, bao gồm tên đã 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 
{
  "parent": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "repeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "deprecated": boolean
}
Các trường
parent

string

Giá trị nhận dạng duy nhất của thuộc tính.
valueType

enum (AttributeValueType)

Loại giá trị cho thuộc tính. Các giá trị đã đặt và truy xuất phải thuộc loại này.
displayName

string

Tên hiển thị đã 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ị đã bản địa hoá của nhóm chứa thuộc tính này, nếu có; nếu không thì tên nhóm bằng tiếng Anh. Các thuộc tính liên quan được tập hợp thành một nhóm và cần hiển thị cùng nhau trong tiêu đề nêu tại đây.
repeatable

boolean

Nếu đúng, thuộc tính này hỗ trợ nhiều giá trị. Nếu giá trị là sai thì 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), danh sách các giá trị được hỗ trợ và tên hiển thị tương ứng cho các giá trị đó được cung cấp.
deprecated

boolean

Nếu đúng thì thuộc tính này không được dùng nữa và không nên được sử dụng nữa. Nếu không dùng nữa, 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. Vào một thời điểm nào đó sau khi không được dùng nữa, thuộc tính này sẽ bị xoá hoàn toàn và 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
}
Các 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ị của 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 thuộc tính enum "Wi-Fi", thuộc tính này có thể chứa "Có tính phí" để thể hiện Wi-Fi có tính phí.