Method: projects.databases.collectionGroups.fields.list

Liệt kê siêu dữ liệu và cấu hình của trường cho cơ sở dữ liệu này.

Hiện tại, FirestoreAdmin.ListFields chỉ hỗ trợ các trường trang thông tin đã bị ghi đè rõ ràng. Để gửi truy vấn này, hãy gọi FirestoreAdmin.ListFields với bộ lọc được đặt thành indexConfig.usesAncestorConfig:false orttlConfig:*`.

Yêu cầu HTTP

GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/collectionGroups/*}/fields

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

Tham số đường dẫn

Tham số
parent

string

Bắt buộc. Tên cha mẹ của biểu mẫu projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}

Tham số truy vấn

Tham số
filter

string

Bộ lọc để áp dụng cho kết quả danh sách. Hiện tại, FirestoreAdmin.ListFields chỉ hỗ trợ các trường trang thông tin đã bị ghi đè rõ ràng. Để tạo truy vấn này, hãy gọi FirestoreAdmin.ListFields bằng một bộ lọc bao gồm indexConfig.usesAncestorConfig:false .
pageSize

integer

Số lượng kết quả trả về.
pageToken

string

Mã thông báo trang, được trả về từ lệnh gọi trước đó đến FirestoreAdmin.ListFields, có thể dùng để lấy trang kết quả tiếp theo.

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

Câu trả lời cho FirestoreAdmin.ListFields.

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 
{
  "fields": [
    {
      object (Field)
    }
  ],
  "nextPageToken": string
}
Trường
fields[]

object (Field)

Các trường được yêu cầu.
nextPageToken

string

Mã thông báo trang có thể được dùng để yêu cầu một trang kết quả khác. Nếu trang trống, thì đây là trang cuối cùng.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau đây:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Để biết thêm thông tin, hãy xem bài viết Tổng quan về hoạt động xác thực.