Method: attributes.list

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

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

Tham số
parent

string

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

string

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

string

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

string

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

boolean

Siêu dữ liệu cho tất cả thuộc tính hiện có sẽ được trả về khi trường này được đặt thành true, bỏ qua các trường mẹ vàcategoryName. Ngôn ngữ mã và mã vùng là bắt buộc khi showAll được đặt thành true.
pageSize

integer

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

string

Nếu bạn 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
}
Trường
attributeMetadata[]

object (AttributeMetadata)

Tập hợp siêu dữ liệu thuộc tính của 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 đã 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 thuộc tính tiếp theo trong lệnh gọi tiếp theo tới attributes.list. Nếu không còn 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 bài viết Tổng quan về OAuth 2.0.

AttributeMetadata

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 
{
  "parent": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "repeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "deprecated": boolean
}
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ị đượ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.
repeatable

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ị đó.
deprecated

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í.