מקבל מספר מסמכים.
מסמכים המוחזרים בשיטה זו אינם מובטחים שיוחזרו באותו סדר שבו התבקשו.
בקשת HTTP
POST https://firestore.googleapis.com/v1beta1/{database=projects/*/databases/*}/documents:batchGet
כתובת האתר משתמשת בתחביר GRPC Transcoding .
פרמטרים של נתיב
פרמטרים | |
---|---|
database | נדרש. שם מסד הנתונים. בפורמט: |
גוף הבקשה
גוף הבקשה מכיל נתונים עם המבנה הבא:
ייצוג JSON |
---|
{ "documents": [ string ], "mask": { object ( |
שדות | |
---|---|
documents[] | שמות המסמכים שיש לאחזר. בפורמט: |
mask | השדות להחזיר. אם לא מוגדר, מחזיר את כל השדות. אם למסמך יש שדה שאינו קיים במסיכה זו, שדה זה לא יוחזר בתגובה. |
consistency_selector של שדה האיחוד . מצב העקביות עבור עסקה זו. אם לא מוגדר, ברירת המחדל היא עקביות חזקה. consistency_selector יכול להיות רק אחד מהאפשרויות הבאות: | |
transaction | קורא מסמכים בעסקה. מחרוזת מקודדת base64. |
newTransaction | מתחיל עסקה חדשה וקורא את המסמכים. ברירת מחדל לעסקה לקריאה בלבד. מזהה העסקה החדש יוחזר כתגובה הראשונה בזרם. |
readTime | קורא מסמכים כפי שהיו בזמן הנתון. זו חייבת להיות חותמת זמן מדויקת של מיקרו-שנייה במהלך השעה האחרונה, או אם שחזור נקודת זמן מופעל, יכול להיות בנוסף חותמת זמן של דקה שלמה במהלך 7 הימים האחרונים. חותמת זמן בפורמט RFC3339 UTC "Zulu", עם רזולוציה של ננו-שניות ועד תשע ספרות חלקיות. דוגמאות: |
גוף תגובה
התגובה המוזרמת עבור Firestore.BatchGetDocuments
.
אם זה מצליח, גוף התגובה מכיל נתונים עם המבנה הבא:
ייצוג JSON |
---|
{ "transaction": string, "readTime": string, // Union field |
שדות | |
---|---|
transaction | העסקה שהחלה במסגרת בקשה זו. יוגדר רק בתגובה הראשונה, ורק אם הוגדרה מחרוזת מקודדת base64. |
readTime | השעה שבה המסמך נקרא. זה עשוי לעלות באופן מונוטי, במקרה זה מובטח שהמסמכים הקודמים בזרם התוצאות לא השתנו בין זמן הקריאה שלהם לזה. חותמת זמן בפורמט RFC3339 UTC "Zulu", עם רזולוציה של ננו-שניות ועד תשע ספרות חלקיות. דוגמאות: |
result שדה האיחוד. תוצאה בודדת. זה יכול להיות ריק אם השרת רק מחזיר עסקה. result יכולה להיות רק אחת מהאפשרויות הבאות: | |
found | מסמך שהתבקש. |
missing | שם מסמך שהתבקש אך אינו קיים. בפורמט: |
היקפי הרשאה
דורש אחד מהיקפי OAuth הבאים:
-
https://www.googleapis.com/auth/datastore
-
https://www.googleapis.com/auth/cloud-platform
למידע נוסף, עיין בסקירת האימות .