Method: projects.databases.documents.batchGet

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

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

בקשת HTTP

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

כתובת האתר משתמשת בתחביר GRPC Transcoding .

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

פרמטרים
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 "Zulu", עם רזולוציה של ננו-שניות ועד תשע ספרות חלקיות. דוגמאות: "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 "Zulu", עם רזולוציה של ננו-שניות ועד תשע ספרות חלקיות. דוגמאות: "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

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