تمت ترجمة هذه الصفحة بواسطة 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 التالية:

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