Method: projects.databases.documents.get

Mendapat satu dokumen.

permintaan HTTP

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

URL menggunakan sintaks Transcoding gRPC .

Parameter jalur

Parameter
name

string

Diperlukan. Nama sumber daya Dokumen yang akan diperoleh. Dalam format: projects/{projectId}/databases/{databaseId}/documents/{document_path} .

Parameter kueri

Parameter
mask

object ( DocumentMask )

Bidang yang akan dikembalikan. Jika tidak disetel, kembalikan semua bidang.

Jika dokumen memiliki kolom yang tidak ada dalam mask ini, kolom tersebut tidak akan dikembalikan dalam respons.

Parameter gabungan consistency_selector . Mode konsistensi untuk transaksi ini. Jika tidak disetel, defaultnya adalah konsistensi yang kuat. consistency_selector hanya dapat berupa salah satu dari berikut ini:
transaction

string ( bytes format)

Membaca dokumen dalam suatu transaksi.

String yang dikodekan 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 satu menit penuh dalam 7 hari terakhir.

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

Permintaan tubuh

Badan permintaan harus kosong.

Badan respons

Jika berhasil, isi respons berisi turunan Document .

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk informasi lebih lanjut, lihat Ikhtisar Otentikasi .