Method: projects.databases.documents.listDocuments

הצגת רשימה של מסמכים.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. השם של משאב ההורה. בפורמט: projects/{projectId}/databases/{databaseId}/documents או projects/{projectId}/databases/{databaseId}/documents/{document_path}.

לדוגמה: projects/my-project/databases/my-database/documents או projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
collectionId

string

זה שינוי אופציונלי. מזהה הקולקציה, ביחס ל-parent, לרשימה.

לדוגמה: chatrooms או messages.

הפעולה הזו היא אופציונלית, ואם לא צוין אחרת, Firestore יציג מסמכים מכל האוספים בהתאם לparent שצוין.

פרמטרים של שאילתה

פרמטרים
pageSize

integer

זה שינוי אופציונלי. המספר המקסימלי של מסמכים שיש להחזיר בתגובה אחת.

Firestore עשוי להחזיר פחות מהערך הזה.
pageToken

string

זה שינוי אופציונלי. אסימון דף שהתקבל מתגובה קודמת של documents.list.

ספקו אותו כדי לאחזר את הדף הבא. במהלך העימוד, כל הפרמטרים האחרים (למעט pageSize) חייבים להתאים לערכים שהוגדרו בבקשה שיצרה את אסימון הדף.
orderBy

string

זה שינוי אופציונלי. הסדר האופציונלי של המסמכים שיש להחזיר.

לדוגמה: priority desc, __name__ desc.

הפעולה הזו משקפת את ORDER BY שנעשה בו שימוש בשאילתות של Firestore אבל בייצוג מחרוזות. אם חסר מידע, המסמכים יסודרו לפי __name__ ASC.
mask

object (DocumentMask)

זה שינוי אופציונלי. השדות שיש להחזיר. אם המדיניות לא מוגדרת, כל השדות מוחזרים.

אם מסמך כולל שדה שלא נמצא במסכה הזו, השדה הזה לא יוחזר.
showMissing

boolean

אם ברשימה אמורים להופיע מסמכים חסרים.

אם מסמך חסר, הוא לא קיים, אבל יש מסמכי משנה שמוצבים מתחתיו. אם הערך הוא True, מסמכים חסרים כאלה יוחזרו עם מפתח אבל לא יוגדרו בהם שדות, createTime או updateTime.

בבקשות עם showMissing אסור לציין where או orderBy.
פרמטר איחוד 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".

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאות

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

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

מידע נוסף זמין בסקירה הכללית על אימות.