Method: projects.databases.documents.batchGet

מקבלת מספר מסמכים.

לא בטוח שמסמכים שמוחזרים באמצעות השיטה הזו יוחזרו באותו סדר שבו ביקשו.

בקשת HTTP

POST https://firestore.googleapis.com/v1beta1/{database=projects/*/databases/*}/documents:batchGet

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

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

פרמטרים
database

string

חובה. שם מסד הנתונים. בפורמט: projects/{projectId}/databases/{databaseId}.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "documents": [
    string
  ],
  "mask": {
    object (DocumentMask)
  },

  // Union field consistency_selector can be only one of the following:
  "transaction": string,
  "newTransaction": {
    object (TransactionOptions)
  },
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}
שדות
documents[]

string

שמות המסמכים שיש לאחזר. בפורמט: projects/{projectId}/databases/{databaseId}/documents/{document_path}. הבקשה תיכשל אם מסמך כלשהו אינו משאב צאצא של database הנתון. שמות כפולים יוסרו.
mask

object (DocumentMask)

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

אם מסמך כולל שדה שלא נמצא במסכה הזו, השדה הזה לא יוחזר.
שדה איחוד consistency_selector. מצב העקביות לעסקה הזו. אם המדיניות לא מוגדרת, ברירת המחדל היא עקביות חזקה. consistency_selector יכול להיות רק אחד מהבאים:
transaction

string (bytes format)

קריאת מסמכים בעסקה.

מחרוזת בקידוד base64.
newTransaction

object (TransactionOptions)

מתחיל עסקה חדשה וקורא את המסמכים. ברירת המחדל היא עסקה לקריאה בלבד. מזהה העסקה החדש יוחזר כתגובה הראשונה בשידור.
readTime

string (Timestamp format)

קריאת מסמכים כפי שהם היו בזמן הנתון.

זו צריכה להיות חותמת זמן ברמת דיוק של מיקרו-שנייה בשעה האחרונה. אם האפשרות 'שחזור נקודת זמן' מופעלת, היא יכולה להיות גם חותמת זמן של דקה שלמה מ-7 הימים האחרונים.

חותמת זמן בפורמט "זולו" RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

גוף התשובה

התשובה שהועברה בסטרימינג עבור Firestore.BatchGetDocuments.

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

ייצוג JSON 
{
  "transaction": string,
  "readTime": string,

  // Union field result can be only one of the following:
  "found": {
    object (Document)
  },
  "missing": string
  // End of list of possible types for union field result.
}
שדות
transaction

string (bytes format)

העסקה שהתחילה כחלק מהבקשה הזו. תוגדר רק בתגובה הראשונה, ורק אם הוגדר BatchGetDocumentsRequest.new_transaction בבקשה.

מחרוזת בקידוד base64.
readTime

string (Timestamp format)

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

חותמת זמן בפורמט "זולו" RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
שדה איחוד result. תוצאה אחת. השדה הזה יכול להיות ריק אם השרת רק מחזיר עסקה. result יכול להיות רק אחד מהבאים:
found

object (Document)

המסמך המבוקש.
missing

string

שם המסמך שהתבקש, אבל לא קיים. בפורמט: projects/{projectId}/databases/{databaseId}/documents/{document_path}.

היקפי הרשאות

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

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

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