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ı. Biçimi: 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ümanın bu maskede bulunmayan bir alanı varsa o alan yanıtta döndürülmez.
Birleştirme parametresi consistency_selector. Bu işlem için tutarlılık modu. Politika ayarlanmazsa varsayılan olarak güçlü tutarlılık sağlanır. consistency_selector şunlardan yalnızca biri olabilir:
transaction

string (bytes format)

Bir işlemde dokümanı okur.

Base64 kodlu bir dize.
readTime

string (Timestamp format)

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

Bu, son 1 saat içindeki bir mikrosaniye hassasiyetli zaman damgası olmalıdır veya Belirli Bir Noktadan Kurtarma özelliği etkinleştirilmişse son 7 gün içindeki tam bir dakikalık zaman damgası da olabilir.

Nanosaniye çözünürlük ve en fazla dokuz kesir basamağı olan, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

İstek içeriği

İstek metni boş olmalıdır.

Yanıt metni

Başarılıysa yanıt metni, 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ış sayfasına göz atın.