Method: projects.databases.documents.batchGet

Lấy nhiều tài liệu.

Chúng tôi không đảm bảo trả lại các tài liệu bằng phương thức này theo đúng thứ tự mà chúng được 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

Tham số
database

string

Bắt buộc. Tên cơ sở dữ liệu. Theo đị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 của tài liệu cần truy xuất. Theo định dạng: projects/{projectId}/databases/{databaseId}/documents/{document_path}. Yêu cầu sẽ không thành công nếu có bất kỳ tài liệu nào không phải là tài nguyên con của database đã cho. Tên trùng lặp sẽ bị loại bỏ.
mask

object (DocumentMask)

Các trường cần trả về. Nếu không được đặt, hàm sẽ trả về tất cả các trường.

Nếu tài liệu có một trường không xuất hiện trong mặt nạ này, thì trường đó sẽ không được trả về trong phản hồi.
Trường 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, thì chế độ mặc định sẽ là mức độ nhất quán cao. consistency_selector chỉ có thể là một trong những trạng thái sau:
transaction

string (bytes format)

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

Một 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. 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 ở một thời điểm nhất định.

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

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 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

Phản hồi được truyền trực tuyến cho Firestore.BatchGetDocuments.

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 
{
  "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 được bắt đầu theo yêu cầu này. Sẽ chỉ được đặt trong phản hồi đầu tiên và chỉ khi BatchGetDocumentsRequest.new_transaction được đặt trong yêu cầu.

Một chuỗi được mã hoá base64.
readTime

string (Timestamp format)

Thời điểm đọc tài liệu. Điều này có thể tăng theo đơn, 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 sẽ không thay đổi giữa readTime và tài liệu này.

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

object (Document)

Giấy tờ đượ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. Theo đị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 đâ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.