Method: projects.databases.documents.get

Tek bir doküman alır.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
name

string

Zorunlu. Alınacak Dokümanın kaynak adı. Belirtilen biçimde: projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Sorgu parametreleri

Parametreler
mask

object (DocumentMask)

Döndürülecek alanlar. Ayarlanmazsa tüm alanları döndürür.

Dokümanda, bu maskede bulunmayan bir alan varsa bu alan yanıtta döndürülmez.
Birleştirme parametresi consistency_selector. Bu işlem için tutarlılık modu. Ayarlanmazsa varsayılan olarak güçlü tutarlılık kullanılır. consistency_selector şunlardan yalnızca biri olabilir:
transaction

string (bytes format)

Bir işlemde belgeyi okur.

base64 kodlu bir dize.
readTime

string (Timestamp format)

Belgenin belirtilen zamandaki sürümünü okur.

Bu, son bir saat içindeki mikrosaniyelik bir hassasiyet zaman damgası olmalıdır. Belirli bir noktadan önceyi kurtarma özelliği etkinse son 7 gün içindeki bir tam dakikalık zaman damgası da olabilir.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

İstek içeriği

İsteğin gövdesi boş olmalıdır.

Yanıt gövdesi

Başarılı olursa yanıt gövdesi, Document öğesinin bir örneğini içerir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış başlıklı makaleye bakın.