Method: projects.databases.documents.get

Nhận được một tài liệu duy nhất.

Yêu cầu HTTP

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

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

Tham số đường dẫn

Thông số
name

string

Yêu cầu. Tên tài nguyên của Tài liệu cần lấy. Ở định dạng: projects/{projectId}/databases/{databaseId}/documents/{document_path} .

Tham số truy vấn

Thông số
mask

object ( DocumentMask )

Các trường để trả về. Nếu không được đặt, trả về tất cả các trường.

Nếu 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.

Tham số liên minh tính consistency_selector . Chế độ nhất quán cho giao dịch này. Nếu không được đặt, mặc định có tính nhất quán cao. consistency_selector chỉ có thể là một trong những điều sau đây:
transaction

string ( bytes format)

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

Một chuỗi được mã hóa base64.

readTime

string ( Timestamp format)

Đọc phiên bản của tài liệu tại thời điểm nhất định.

Đây phải là dấu thời gian chính xác đến micro giây trong vòng một giờ qua hoặc nếu Khôi phục theo thời điểm được bật, thì 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 ở định dạng RFC3339 UTC "Zulu", với độ phân giải nano giây và tối đa chín 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

Phần thân 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 ủy 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 Tổng quan về xác thực .