این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Method: projects.databases.documents.get

یک سند واحد می گیرد.

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

URL از دستور GRPC Transcoding استفاده می کند.

مولفه های

مولفه های
`name`	`string` ضروری. نام منبع سند برای دریافت. در قالب: `projects/{projectId}/databases/{databaseId}/documents/{document_path}` .

name

string

ضروری. نام منبع سند برای دریافت. در قالب: projects/{projectId}/databases/{databaseId}/documents/{document_path} .

مولفه های
`mask`	`object ( DocumentMask )` زمینه هایی برای بازگشت. اگر تنظیم نشود، همه فیلدها را برمی گرداند. اگر سند دارای فیلدی باشد که در این ماسک وجود ندارد، آن فیلد در پاسخ بازگردانده نمی شود.
پارامتر Union `consistency_selector` . حالت سازگاری برای این معامله. اگر تنظیم نشده باشد، به طور پیش‌فرض روی سازگاری قوی تنظیم می‌شود. `consistency_selector` تنها می تواند یکی از موارد زیر باشد:
`transaction`	`string ( bytes format)` سند را در یک معامله می خواند. رشته ای با کد base64.
`readTime`	`string ( Timestamp format)` نسخه سند را در زمان معین می خواند. این باید یک مهر زمانی دقیق میکروثانیه در یک ساعت گذشته باشد، یا اگر بازیابی نقطه در زمان فعال باشد، می‌تواند یک مهر زمانی کامل در 7 روز گذشته باشد. مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: `"2014-10-02T15:01:23Z"` و `"2014-10-02T15:01:23.045123456Z"` .

بدنه درخواست باید خالی باشد.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Document است.

به یکی از حوزه های OAuth زیر نیاز دارد:

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.