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