تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

Method: projects.databases.documents.get

الحصول على مستند واحد

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

يستخدم عنوان URL بنية تحويل الترميز gRPC.

المَعلمات

المَعلمات
`name`	`string` مطلوبة. اسم مورد المستند الذي تريد الحصول عليه. بالتنسيق: `projects/{projectId}/databases/{databaseId}/documents/{document_path}`.

name

string

مطلوبة. اسم مورد المستند الذي تريد الحصول عليه. بالتنسيق: projects/{projectId}/databases/{databaseId}/documents/{document_path}.

المَعلمات
`mask`	`object (DocumentMask)` الحقول المطلوب عرضها. وفي حال تم ترك السياسة بدون ضبط، سيتم عرض جميع الحقول. إذا كان المستند يحتوي على حقل غير متوفّر في هذا القناع، لن يتم عرض هذا الحقل في الاستجابة.
معلمة الاتحاد `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 التالية:

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.