Method: projects.databases.documents.get

Mendapatkan satu dokumen.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
name

string

Wajib. Nama resource Dokumen yang akan didapatkan. Dalam format: projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Parameter kueri

Parameter
mask

object (DocumentMask)

Kolom yang akan ditampilkan. Jika tidak ditetapkan, semua kolom akan ditampilkan.

Jika dokumen memiliki kolom yang tidak ada dalam mask ini, kolom tersebut tidak akan ditampilkan dalam respons.
Parameter gabungan consistency_selector. Mode konsistensi untuk transaksi ini. Jika tidak disetel, setelan default-nya adalah konsistensi kuat. consistency_selector hanya ada berupa salah satu diantara berikut:
transaction

string (bytes format)

Membaca dokumen dalam transaksi.

String berenkode base64.
readTime

string (Timestamp format)

Membaca versi dokumen pada waktu tertentu.

Ini harus berupa stempel waktu presisi mikrodetik dalam satu jam terakhir, atau jika Pemulihan Point-in-Time diaktifkan, dapat juga berupa stempel waktu menit penuh dalam 7 hari terakhir.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons akan berisi instance Document.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Ringkasan Autentikasi.