Tek bir doküman alır.
HTTP isteği
GET https://firestore.googleapis.com/v1/{name=projects/*/databases/*/documents/*/**}
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
Yol parametreleri
| Parametreler | |
|---|---|
name |
Zorunlu. Alınacak Dokümanın kaynak adı. Belirtilen biçimde: |
Sorgu parametreleri
| Parametreler | |
|---|---|
mask |
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 |
Bir işlemde belgeyi okur. base64 kodlu bir dize. |
readTime |
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" biçiminde, nanosaniye çözünürlüğüne ve en fazla dokuz kesirli basamağa sahip bir zaman damgası. Örnekler: |
İ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/datastorehttps://www.googleapis.com/auth/cloud-platform
Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış başlıklı makaleye bakın.