Method: projects.databases.importDocuments

מייבאת מסמכים אל Google Cloud Firestore. מסמכים קיימים עם אותו שם יוחלפו. הייבוא מתבצע ברקע, וניתן לעקוב אחר ההתקדמות שלו ולנהל אותה באמצעות משאב הפעולה שנוצר. אם מתבטלת פעולה של מסד נתונים.ImportDocuments מתבטלת, יכול להיות שקבוצת משנה של הנתונים כבר יובאה אל Cloud Firestore.

בקשת HTTP

POST https://firestore.googleapis.com/v1/{name=projects/*/databases/*}:importDocuments

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

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

פרמטרים
name

string

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

גוף הבקשה

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

ייצוג JSON 
{
  "collectionIds": [
    string
  ],
  "inputUriPrefix": string,
  "namespaceIds": [
    string
  ]
}
שדות
collectionIds[]

string

אילו מזהי אוספים לייבא המשמעות של 'לא צוין' היא כל האוספים הכלולים בייבוא.
inputUriPrefix

string

מיקום הקבצים שיוצאו. הערך חייב להתאים לפלטUriPrefix של ExportDocumentsResponse מייצוא שהושלם בהצלחה. למידע נוסף: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.
namespaceIds[]

string

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

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

גוף התשובה

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

היקפי הרשאות

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

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

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