דף זה תורגם על ידי 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, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: `"2014-10-02T15:01:23Z"` ו-`"2014-10-02T15:01:23.045123456Z"`.

גוף הבקשה חייב להיות ריק.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה מכיל מופע של Document.

נדרש אחד מהיקפי ההרשאות הבאים של OAuth: