Method: projects.databases.documents.batchGet

Nhận nhiều tài liệu.

Google không đảm bảo việc trả lại tài liệu bằng phương thức này theo đúng thứ tự mà chúng tôi yêu cầu.

yêu cầu HTTP

POST https://firestore.googleapis.com/v1/{database=projects/*/databases/*}/documents:batchGet

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

Tham số đường dẫn

Thông số
database

string

Bắt buộc. Tên cơ sở dữ liệu. Ở định dạng: projects/{projectId}/databases/{databaseId}.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "documents": [
    string
  ],
  "mask": {
    object (DocumentMask)
  },

  // Union field consistency_selector can be only one of the following:
  "transaction": string,
  "newTransaction": {
    object (TransactionOptions)
  },
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}
Trường
documents[]

string

Tên tài liệu cần truy xuất. Ở định dạng: projects/{projectId}/databases/{databaseId}/documents/{document_path}. Yêu cầu sẽ không thành công nếu bất kỳ tài liệu nào không phải là tài nguyên con của database đã cho. Những tên trùng lặp sẽ bị loại bỏ.
mask

object (DocumentMask)

Các trường cần trả về. Nếu bạn không đặt chính sách này, hệ thống sẽ trả về tất cả các trường.

Nếu một tài liệu có một trường không có trong mặt nạ này, thì trường đó sẽ không được trả về trong phản hồi.
Trường kết hợp consistency_selector. Chế độ nhất quán cho giao dịch này. Nếu bạn không đặt chính sách này, hệ thống sẽ đặt mặc định là tính nhất quán cao. consistency_selector chỉ có thể là một trong những trạng thái sau đây:
transaction

string (bytes format)

Đọc tài liệu trong một giao dịch.

Chuỗi được mã hoá base64.
newTransaction

object (TransactionOptions)

Bắt đầu một giao dịch mới và đọc tài liệu. Mặc định là giao dịch chỉ có thể đọc. Mã giao dịch mới sẽ được trả về dưới dạng phản hồi đầu tiên trong luồng.
readTime

string (Timestamp format)

Đọc tài liệu như tại thời điểm đã cho.

Đây phải là một dấu thời gian có độ chính xác là micrô giây trong vòng 1 giờ qua, hoặc nếu tính năng Khôi phục tại một thời điểm đang bật, thì đây cũng có thể là dấu thời gian cả phút trong vòng 7 ngày qua.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".

Nội dung phản hồi

Đã truyền trực tuyến câu trả lời cho Firestore.BatchGetDocuments.

Nếu thành công, 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 
{
  "transaction": string,
  "readTime": string,

  // Union field result can be only one of the following:
  "found": {
    object (Document)
  },
  "missing": string
  // End of list of possible types for union field result.
}
Trường
transaction

string (bytes format)

Giao dịch đã bắt đầu theo yêu cầu này. Sẽ chỉ được thiết lập trong phản hồi đầu tiên và chỉ khi BatchGetDocumentsRequest.new_transaction được thiết lập trong yêu cầu.

Chuỗi được mã hoá base64.
readTime

string (Timestamp format)

Thời gian tài liệu được đọc. Chỉ số này có thể tăng lên một cách đơn điệu, trong trường hợp này, các tài liệu trước đó trong luồng kết quả được đảm bảo không thay đổi giữa thời gian đọc và thời gian này.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
Trường kết hợp result. Một kết quả duy nhất. Trường này có thể trống nếu máy chủ chỉ trả về một giao dịch. result chỉ có thể là một trong những trạng thái sau đây:
found

object (Document)

Tài liệu đã được yêu cầu.
missing

string

Tên tài liệu đã được yêu cầu nhưng không tồn tại. Ở định dạng: projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Phạm vi uỷ quyền

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

  • 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ề việc xác thực.