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

Thông số
parent

string

Không bắt buộc. 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ì bạn không cần và không được đặt categoryName, regionCode, languageCode và showAll.

Định dạng: locations/{locationId} (ví dụ: locations/1234567890).
categoryName

string

Không bắt buộc. 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 có định dạng categories/{category_id} (ví dụ: categories/gcid:restaurant). Bắt buộc nếu bạn không đặt parent và showAll là false.
regionCode

string

Không bắt buộc. Mã quốc gia theo ISO 3166-1 alpha-2 để tìm các thuộc tính có sẵn. Bắt buộc nếu bạn không đặt parent.
languageCode

string

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

boolean

Không bắt buộc. Nếu bạn đặt thành true, siêu dữ liệu cho tất cả các thuộc tính hiện có sẽ được trả về, bất kể các trường parent và categoryName. Bạn phải cung cấp languageCode và regionCode khi đặt showAll 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, giá trị tối thiểu là 1.
pageToken

string

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

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 cho các thuộc tính có sẵn.
nextPageToken

string

Nếu số lượng thuộc tính vượt quá kích thước trang được yêu cầu, thì trường này sẽ được điền bằng 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 đến attributes.list. Nếu không có thêm thuộc tính nào, thì 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 OAuth 2.0 Overview.

AttributeMetadata

Siêu dữ liệu cho một thuộc tính. Chứa thông tin hiển thị cho 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 riêng biệt của thuộc tính.
valueType

enum (AttributeValueType)

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

string

Tên hiển thị đã bản địa hoá của thuộc tính (nếu có); nếu không, 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, tên nhóm sẽ là tiếng Anh. Các thuộc tính có liên quan được tập hợp thành một nhóm và phải được hiển thị cùng nhau dưới tiêu đề được cung cấp tại đây.
repeatable

boolean

Nếu là true, thuộc tính này sẽ hỗ trợ nhiều giá trị. Nếu là false, bạn chỉ nên cung cấp một giá trị.
valueMetadata[]

object (AttributeValueMetadata)

Đối với một số loại thuộc tính (ví dụ: enum), bạn sẽ thấy 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 đúng, thuộc tính này không còn được dùng nữa và không nên sử dụng nữa. Nếu thuộc tính này không còn được 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à trở thành lỗi.

AttributeValueMetadata

Siêu dữ liệu cho 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, tên sẽ hiển thị bằng tiếng Anh. Tên hiển thị của giá trị được dùng trong bối cảnh có tên hiển thị của thuộc tính.

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