परिचय
मेटाडेटा आपको डोडो पेमेंट्स में अपने ऑब्जेक्ट्स के बारे में अतिरिक्त, संरचित जानकारी स्टोर करने की अनुमति देता है। आप अधिकांश डोडो पेमेंट्स ऑब्जेक्ट्स, जैसे कि भुगतान, सदस्यताएँ, और अधिक पर मेटाडेटा संलग्न कर सकते हैं।अवलोकन
- Metadata keys की लंबाई 40 characters तक हो सकती है
- Metadata values string, integer, number या boolean हो सकते हैं; strings की लंबाई 500 characters तक हो सकती है
- Objects, arrays और
nullको Metadata values के रूप में स्वीकार नहीं किया जाता - प्रत्येक object में अधिकतम 50 Metadata key-value pairs हो सकते हैं
- Keys में केवल alphanumeric characters, dashes और underscores होने चाहिए
- हमारे API का उपयोग करके Metadata को search नहीं किया जा सकता, लेकिन यह API responses और webhooks में लौटाया जाता है
उपयोग के मामले
मेटाडेटा निम्नलिखित के लिए उपयोगी है:- बाहरी आईडी या संदर्भ स्टोर करना
- आंतरिक टिप्पणियाँ जोड़ना
- डोडो पेमेंट्स ऑब्जेक्ट्स को अपने सिस्टम से लिंक करना
- लेनदेन को श्रेणीबद्ध करना
- रिपोर्टिंग के लिए कस्टम विशेषताएँ जोड़ना
मेटाडेटा जोड़ना
आप API के माध्यम से ऑब्जेक्ट्स बनाते या अपडेट करते समय मेटाडेटा जोड़ सकते हैं। उत्पादों के लिए, आपके पास डैशबोर्ड UI से सीधे मेटाडेटा जोड़ने का विकल्प भी है।API के माध्यम से
डैशबोर्ड UI के माध्यम से (केवल उत्पाद)
उत्पादों के लिए, आप उत्पाद बनाते या संपादित करते समय डोडो पेमेंट्स डैशबोर्ड से सीधे मेटाडेटा जोड़ सकते हैं। मेटाडेटा अनुभाग आपको कोड लिखे बिना आसानी से कस्टम कुंजी-मूल्य जोड़ने की अनुमति देता है।
मेटाडेटा पुनः प्राप्त करना
मेटाडेटा ऑब्जेक्ट्स को पुनः प्राप्त करते समय API प्रतिक्रियाओं में शामिल होता है:Checkout session (
GET /checkouts/{id}) को retrieve करने पर metadata प्राप्त नहीं होता। Session status response में केवल id, created_at, payment_id, payment_status, customer_email और customer_name शामिल होते हैं। Session creation के समय संलग्न किए गए Metadata को इसके बजाय resulting payment से पढ़ें, इसके लिए उस endpoint द्वारा लौटाए गए payment_id का उपयोग करें।Search और Filtering
हालाँकि हमारे API के माध्यम से Metadata को सीधे search नहीं किया जा सकता, आप यह कर सकते हैं:- महत्वपूर्ण identifiers को Metadata में store करें
- Objects को उनके primary IDs का उपयोग करके retrieve करें
- अपने application code में results को filter करें
Best Practices
करें:
- Metadata keys के लिए consistent naming conventions का उपयोग करें
- अपने Metadata schema को internally document करें
- Values को छोटा और meaningful रखें
- Metadata का उपयोग केवल static data के लिए करें
- अलग-अलग systems के लिए prefixes का उपयोग करने पर विचार करें (जैसे,
crm_id,inventory_sku)
न करें:
- Metadata में sensitive data store न करें
- बार-बार बदलने वाली values के लिए Metadata का उपयोग न करें
- Critical business logic के लिए Metadata पर निर्भर न रहें
- ऐसी duplicate information store न करें जो object में कहीं और उपलब्ध हो
- Metadata keys में special characters का उपयोग न करें