Cloud Firestore API

अपने-आप स्केलिंग, अच्छी परफ़ॉर्मेंस, और ऐप्लिकेशन डेवलपमेंट में आसानी के लिए बनाए गए NoSQL दस्तावेज़ डेटाबेस को ऐक्सेस करता है.

सेवा: Firestore.googleapis.com

इस सेवा को कॉल करने के लिए, हमारा सुझाव है कि आप Google की क्लाइंट लाइब्रेरी का इस्तेमाल करें. अगर इस सेवा को कॉल करने के लिए आपके ऐप्लिकेशन को आपकी अपनी लाइब्रेरी का इस्तेमाल करना है, तो एपीआई अनुरोध करते समय नीचे दी गई जानकारी का इस्तेमाल करें.

खोज से जुड़ा दस्तावेज़

डिस्कवरी दस्तावेज़ REST API के बारे में जानकारी देने और उसका इस्तेमाल करने के लिए, इस स्पेसिफ़िकेशन को मशीन से पढ़ सकता है. इसका इस्तेमाल क्लाइंट लाइब्रेरी, IDE प्लगिन, और Google API के साथ इंटरैक्ट करने वाले अन्य टूल बनाने में किया जाता है. एक सेवा, खोज के लिए कई दस्तावेज़ उपलब्ध करा सकती है. यह सेवा खोज के नतीजों से जुड़े ये दस्तावेज़ उपलब्ध कराती है:

सेवा एंडपॉइंट

सेवा एंडपॉइंट एक बेस यूआरएल होता है, जो एपीआई सेवा के नेटवर्क पते के बारे में बताता है. एक सेवा में एक से ज़्यादा सेवा एंडपॉइंट हो सकते हैं. इस सेवा में यह सर्विस एंडपॉइंट है और नीचे दिए गए सभी यूआरआई इस सर्विस एंडपॉइंट से मिलते-जुलते हैं:

  • 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 सभी बैकअप को सूची में रखता है.