Method: projects.databases.documents.get

Nhận một tài liệu.

Yêu cầu HTTP

GET https://firestore.googleapis.com/v1beta1/{name=projects/*/databases/*/documents/*/**}

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

Tham số đường dẫn

Tham số
name

string

Bắt buộc. Tên tài nguyên của Tài liệu cần tải. Theo định dạng: projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Tham số truy vấn

Tham số
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.

Tham số 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, 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.

readTime

string (Timestamp format)

Đọc phiên bản của tài liệu tại 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""2014-10-02T15:01:23.045123456Z".

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

Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của Document.

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.