דף זה תורגם על ידי Cloud Translation API.

Cloud Firestore API

גישה למסד הנתונים של NoSQL לאחסון מסמכים שמיועד להתאמה לעומס (scaling) באופן אוטומטי, לביצועים גבוהים ולפיתוח אפליקציות בקלות.

שירות: Firestore.googleapis.com

כדי לקרוא לשירות הזה, מומלץ להשתמש בספריות הלקוח ש-Google מספקת. אם האפליקציה שלכם צריכה להשתמש בספריות משלכם כדי לקרוא לשירות הזה, השתמשו במידע הבא כשתשלחו את בקשות ה-API.

מסמך הגילוי

מסמך Discovery הוא מפרט קריא למחשבים לתיאור ולשימוש בממשקי API ל-REST. הוא משמש לבניית ספריות לקוח, יישומי פלאגין בסביבת פיתוח משולבת (IDE) וכלים אחרים שיוצרים אינטראקציה עם Google APIs. שירות אחד יכול לספק כמה מסמכי גילוי. השירות הזה מספק את מסמכי הגילוי הבאים:

נקודת קצה בשירות

נקודת קצה של שירות היא כתובת URL בסיסית שמציינת את כתובת הרשת של שירות API. לשירות אחד יכולות להיות כמה נקודות קצה (endpoints) של שירות. לשירות הזה יש את נקודת הקצה הבאה של השירות, וכל מזהי ה-URI הבאים הם יחסיים לנקודת הקצה של השירות:

https://firestore.googleapis.com

משאב REST: v1beta2.projects.databases

שיטות
`exportDocuments`	`POST /v1beta2/{name=projects//databases/}:exportDocuments` ייצוא עותק של כל המסמכים או של קבוצת משנה שלהם מ-Google Cloud Firestore למערכת אחסון אחרת, כמו Google Cloud Storage.
`importDocuments`	`POST /v1beta2/{name=projects//databases/}:importDocuments` מייבאת מסמכים אל Google Cloud Firestore.

משאב REST: v1beta2.projects.databases.collectionGroups.fields

שיטות
`get`	`GET /v1beta2/{name=projects//databases//collectionGroups//fields/}` מקבל את המטא-נתונים וההגדרות של השדה.
`list`	`GET /v1beta2/{parent=projects//databases//collectionGroups/*}/fields` פירוט ההגדרות והמטא-נתונים של השדות למסד הנתונים הזה.
`patch`	`PATCH /v1beta2/{field.name=projects//databases//collectionGroups//fields/}` ההגדרה מעדכנת את ההגדרות האישיות של השדה.

משאב REST: v1beta2.projects.databases.collectionGroups.indexes

שיטות
`create`	`POST /v1beta2/{parent=projects//databases//collectionGroups/*}/indexes` ייווצר אינדקס מורכב.
`delete`	`DELETE /v1beta2/{name=projects//databases//collectionGroups//indexes/}` מחיקת אינדקס מורכב.
`get`	`GET /v1beta2/{name=projects//databases//collectionGroups//indexes/}` הפונקציה מקבלת אינדקס מורכב.
`list`	`GET /v1beta2/{parent=projects//databases//collectionGroups/*}/indexes` בתיבת הדו-שיח הזו רשומים אינדקסים מורכבים.

משאב REST: v1beta1.projects.databases

שיטות
`exportDocuments`	`POST /v1beta1/{name=projects//databases/}:exportDocuments` ייצוא עותק של כל המסמכים או של קבוצת משנה שלהם מ-Google Cloud Firestore למערכת אחסון אחרת, כמו Google Cloud Storage.
`importDocuments`	`POST /v1beta1/{name=projects//databases/}:importDocuments` מייבאת מסמכים אל Google Cloud Firestore.

משאב REST: v1beta1.projects.databases.documents

שיטות
`batchGet`	`POST /v1beta1/{database=projects//databases/}/documents:batchGet` מקבלת מספר מסמכים.
`batchWrite`	`POST /v1beta1/{database=projects//databases/}/documents:batchWrite` חלה על קבוצה של פעולות כתיבה.
`beginTransaction`	`POST /v1beta1/{database=projects//databases/}/documents:beginTransaction` מתחיל עסקה חדשה.
`commit`	`POST /v1beta1/{database=projects//databases/}/documents:commit` מבצעת טרנזקציה ומעדכנת את המסמכים באופן אופציונלי.
`createDocument`	`POST /v1beta1/{parent=projects//databases//documents/**}/{collectionId}` יצירת מסמך חדש.
`delete`	`DELETE /v1beta1/{name=projects//databases//documents//*}` מוחק מסמך.
`get`	`GET /v1beta1/{name=projects//databases//documents//*}` מתקבל מסמך אחד.
`list`	`GET /v1beta1/{parent=projects//databases//documents//*}/{collectionId}` רשימת מסמכים.
`listCollectionIds`	`POST /v1beta1/{parent=projects//databases//documents}:listCollectionIds` רשימת כל מזהי האוספים מתחת למסמך.
`listDocuments`	`GET /v1beta1/{parent=projects//databases//documents}/{collectionId}` רשימת מסמכים.
`partitionQuery`	`POST /v1beta1/{parent=projects//databases//documents}:partitionQuery` הפונקציה מחלקת שאילתה על ידי החזרת סמני מחיצות שבהם אפשר להשתמש כדי להריץ את השאילתה במקביל.
`patch`	`PATCH /v1beta1/{document.name=projects//databases//documents//*}` תעדכן או מוסיפה מסמך.
`rollback`	`POST /v1beta1/{database=projects//databases/}/documents:rollback` העסקה מוחזרת לגרסה קודמת.
`runAggregationQuery`	`POST /v1beta1/{parent=projects//databases//documents}:runAggregationQuery` מריץ שאילתת צבירה.
`runQuery`	`POST /v1beta1/{parent=projects//databases//documents}:runQuery` מריץ שאילתה.

משאב REST: v1beta1.projects.databases.indexes

שיטות
`create`	`POST /v1beta1/{parent=projects//databases/}/indexes` יוצר את האינדקס שצוין.
`delete`	`DELETE /v1beta1/{name=projects//databases//indexes/*}` מחיקת אינדקס.
`get`	`GET /v1beta1/{name=projects//databases//indexes/*}` מקבלת אינדקס.
`list`	`GET /v1beta1/{parent=projects//databases/}/indexes` רשימת האינדקסים שתואמים למסננים שצוינו.

משאב REST: v1.projects.databases

שיטות
`create`	`POST /v1/{parent=projects/*}/databases` יצירת מסד נתונים.
`delete`	`DELETE /v1/{name=projects//databases/}` מחיקת מסד נתונים.
`exportDocuments`	`POST /v1/{name=projects//databases/}:exportDocuments` ייצוא עותק של כל המסמכים או של קבוצת משנה שלהם מ-Google Cloud Firestore למערכת אחסון אחרת, כמו Google Cloud Storage.
`get`	`GET /v1/{name=projects//databases/}` קבלת מידע על מסד נתונים.
`importDocuments`	`POST /v1/{name=projects//databases/}:importDocuments` מייבאת מסמכים אל Google Cloud Firestore.
`list`	`GET /v1/{parent=projects/*}/databases` רשימה של כל מסדי הנתונים בפרויקט.
`patch`	`PATCH /v1/{database.name=projects//databases/}` עדכון מסד נתונים.
`restore`	`POST /v1/{parent=projects/*}/databases:restore` יצירת מסד נתונים חדש על ידי שחזור מגיבוי קיים.

משאב REST: v1.projects.databases.backupSchedules

שיטות
`create`	`POST /v1/{parent=projects//databases/}/backupSchedules` יצירת לוח זמנים לגיבוי במסד נתונים.
`delete`	`DELETE /v1/{name=projects//databases//backupSchedules/*}` מחיקת לוח זמנים לגיבוי.
`get`	`GET /v1/{name=projects//databases//backupSchedules/*}` מקבלת מידע על לוח זמנים לגיבוי.
`list`	`GET /v1/{parent=projects//databases/}/backupSchedules` רשימת לוחות הזמנים לגיבוי.
`patch`	`PATCH /v1/{backupSchedule.name=projects//databases//backupSchedules/*}` לוח הזמנים לגיבוי יתעדכן.

משאב REST: v1.projects.databases.collectionGroups.fields

שיטות
`get`	`GET /v1/{name=projects//databases//collectionGroups//fields/}` מקבל את המטא-נתונים וההגדרות של השדה.
`list`	`GET /v1/{parent=projects//databases//collectionGroups/*}/fields` פירוט ההגדרות והמטא-נתונים של השדות למסד הנתונים הזה.
`patch`	`PATCH /v1/{field.name=projects//databases//collectionGroups//fields/}` ההגדרה מעדכנת את ההגדרות האישיות של השדה.

משאב REST: v1.projects.databases.collectionGroups.indexes

שיטות
`create`	`POST /v1/{parent=projects//databases//collectionGroups/*}/indexes` ייווצר אינדקס מורכב.
`delete`	`DELETE /v1/{name=projects//databases//collectionGroups//indexes/}` מחיקת אינדקס מורכב.
`get`	`GET /v1/{name=projects//databases//collectionGroups//indexes/}` הפונקציה מקבלת אינדקס מורכב.
`list`	`GET /v1/{parent=projects//databases//collectionGroups/*}/indexes` בתיבת הדו-שיח הזו רשומים אינדקסים מורכבים.

משאב REST: v1.projects.databases.documents

שיטות
`batchGet`	`POST /v1/{database=projects//databases/}/documents:batchGet` מקבלת מספר מסמכים.
`batchWrite`	`POST /v1/{database=projects//databases/}/documents:batchWrite` חלה על קבוצה של פעולות כתיבה.
`beginTransaction`	`POST /v1/{database=projects//databases/}/documents:beginTransaction` מתחיל עסקה חדשה.
`commit`	`POST /v1/{database=projects//databases/}/documents:commit` מבצעת טרנזקציה ומעדכנת את המסמכים באופן אופציונלי.
`createDocument`	`POST /v1/{parent=projects//databases//documents/**}/{collectionId}` יצירת מסמך חדש.
`delete`	`DELETE /v1/{name=projects//databases//documents//*}` מוחק מסמך.
`get`	`GET /v1/{name=projects//databases//documents//*}` מתקבל מסמך אחד.
`list`	`GET /v1/{parent=projects//databases//documents//*}/{collectionId}` רשימת מסמכים.
`listCollectionIds`	`POST /v1/{parent=projects//databases//documents}:listCollectionIds` רשימת כל מזהי האוספים מתחת למסמך.
`listDocuments`	`GET /v1/{parent=projects//databases//documents}/{collectionId}` רשימת מסמכים.
`partitionQuery`	`POST /v1/{parent=projects//databases//documents}:partitionQuery` הפונקציה מחלקת שאילתה על ידי החזרת סמני מחיצות שבהם אפשר להשתמש כדי להריץ את השאילתה במקביל.
`patch`	`PATCH /v1/{document.name=projects//databases//documents//*}` תעדכן או מוסיפה מסמך.
`rollback`	`POST /v1/{database=projects//databases/}/documents:rollback` העסקה מוחזרת לגרסה קודמת.
`runAggregationQuery`	`POST /v1/{parent=projects//databases//documents}:runAggregationQuery` מריץ שאילתת צבירה.
`runQuery`	`POST /v1/{parent=projects//databases//documents}:runQuery` מריץ שאילתה.

משאב REST: v1.projects.databases.operations

שיטות
`cancel`	`POST /v1/{name=projects//databases//operations/*}:cancel` הפעלת ביטול אסינכרוני בפעולה ממושכת.
`delete`	`DELETE /v1/{name=projects//databases//operations/*}` מחיקה של פעולה ממושכת.
`get`	`GET /v1/{name=projects//databases//operations/*}` קבלת המצב העדכני של פעולה ממושכת.
`list`	`GET /v1/{name=projects//databases/}/operations` בתיבת הדו-שיח הזו מפורטות הפעולות שתואמות למסנן שצוין בבקשה.

משאב REST: v1.projects.locations

שיטות
`get`	`GET /v1/{name=projects//locations/}` קבלת מידע על מיקום.
`list`	`GET /v1/{name=projects/*}/locations` בתיבת הדו-שיח הזו מפורטים המיקומים הנתמכים בשירות הזה.

משאב REST: v1.projects.locations.backups

שיטות
`delete`	`DELETE /v1/{name=projects//locations//backups/*}` הגיבוי יימחק.
`get`	`GET /v1/{name=projects//locations//backups/*}` קבלת מידע על גיבוי.
`list`	`GET /v1/{parent=projects//locations/}/backups` רשימה של כל הגיבויים.