ऑब्जेक्ट टैग API (बीटा)
ऑब्जेक्ट टैग किसी उपयोगकर्ता के बारे में संरचित डेटा को एक ही टैग में संग्रहीत करते हैं। Object प्रकार का टैग नामित फ़ील्ड वाला एक ऑब्जेक्ट रखता है, जैसे अपने amount और status के साथ अंतिम order। ObjectList प्रकार का टैग ऐसे ऑब्जेक्ट्स की एक ऐरे रखता है, जैसे सभी orders। कोई फ़ील्ड स्वयं भी एक ऑब्जेक्ट या ऑब्जेक्ट की सूची हो सकता है, जैसे profile का address। आप फ़ील्ड एक बार परिभाषित करते हैं, टैग API के माध्यम से मान लिखते और पढ़ते हैं, फ़ील्ड मानों के आधार पर सेगमेंट बनाते हैं, और Liquid की मदद से मानों को संदेशों में डालते हैं।
ऑब्जेक्ट टैग कैसे काम करते हैं
Anchor link toऑब्जेक्ट टैग में एक स्कीमा और एक मान होता है। स्कीमा टैग का नाम और फ़ील्ड की सूची है, जिसमें हर फ़ील्ड का अपना प्रकार होता है। मान फ़ील्ड में, हर उपयोगकर्ता के लिए अलग से, संग्रहीत होता है।
- फ़ील्ड। हर फ़ील्ड
<object>.<field>नाम वाला एक टैग है, उदाहरण के लिएorder.amount। आप फ़ील्ड के आधार पर सेगमेंट बनाते हैं, औरObjectटैग का फ़ील्ड इसी नाम से लिख सकते हैं। Objectमान। प्रति उपयोगकर्ता एक ऑब्जेक्ट, उदाहरण के लिए"order": {"amount": 120, "status": "paid"}।ObjectListमान। समान फ़ील्ड वाले ऑब्जेक्ट्स की एक ऐरे, उदाहरण के लिए"orders": [{"amount": 120, "status": "paid"}, {"amount": 50}]।- नेस्टेड ऑब्जेक्ट।
OBJECTप्रकार का फ़ील्ड, जिसके अपने फ़ील्ड होते हैं, उदाहरण के लिए फ़ील्डprofile.address.cityके साथprofile.address। - नेस्टेड सूची।
OBJECT_LISTप्रकार का फ़ील्ड, यानी ऑब्जेक्ट टैग के अंदर ऑब्जेक्ट्स की एक ऐरे, उदाहरण के लिएprofile.visits। नेस्टेड ऑब्जेक्ट और सूचियाँ देखें।
API में टैग और फ़ील्ड के प्रकार OBJECT और OBJECT_LIST हैं। कंट्रोल पैनल में ये ऑब्जेक्ट और ऑब्जेक्ट की सूची हैं। इस पेज पर ऑब्जेक्ट की सूची का मतलब ObjectList टैग या नेस्टेड सूची है।
ऑब्जेक्ट टैग हमेशा User-specific होते हैं, यानी मान उपयोगकर्ता का होता है, किसी एक डिवाइस का नहीं, और उपयोगकर्ता के सभी डिवाइस पर कॉपी किया जाता है। सामान्य टैग के लिए टैग्स API देखें।
नेस्टेड ऑब्जेक्ट और सूचियाँ
Anchor link toऑब्जेक्ट टैग का फ़ील्ड एक मान के बजाय अपने फ़ील्ड रख सकता है। नेस्टेड ऑब्जेक्ट, यानी OBJECT प्रकार का फ़ील्ड, एक ऑब्जेक्ट रखता है। नेस्टेड सूची, यानी OBJECT_LIST प्रकार का फ़ील्ड, ऑब्जेक्ट की सूची रखती है। सूची के एलिमेंट में भी नेस्टेड ऑब्जेक्ट और नेस्टेड सूचियाँ हो सकती हैं। हर फ़ील्ड अपना पूरा बिंदु वाला नाम रखता है, जैसे profile.address.city, और आप इन्हीं नामों के आधार पर सेगमेंट बनाते हैं।
उदाहरण के लिए, OBJECT प्रकार के profile टैग और OBJECT_LIST प्रकार के orders टैग की संरचना ऐसी हो सकती है:
profile OBJECT├── address OBJECT│ ├── city STRING│ └── geo OBJECT│ └── lat STRING└── visits OBJECT_LIST └── code STRING
orders OBJECT_LIST├── sku STRING├── meta OBJECT│ └── color STRING└── lines OBJECT_LIST └── qty INTEGERखोजने योग्य और केवल संग्रहीत फ़ील्ड
Anchor link toकिसी फ़ील्ड के साथ आप क्या कर सकते हैं, यह इस पर निर्भर करता है कि उसके ऊपर ऑब्जेक्ट की कितनी सूचियाँ हैं:
- फ़ील्ड के ऊपर कोई सूची नहीं। आप
profile.address.cityजैसे फ़ील्ड के आधार पर सेगमेंट बना सकते हैं, उसे उसके पूरे नाम से अलग से लिख सकते हैं, और संदेशों में उसका उपयोग कर सकते हैं। - फ़ील्ड के ऊपर एक सूची। आप
profile.visits.codeयाorders.meta.colorजैसे फ़ील्ड के आधार पर सेगमेंट बना सकते हैं और संदेशों में उसका उपयोग कर सकते हैं। उसे केवल पूरी सूची के हिस्से के रूप में लिखें। - फ़ील्ड के ऊपर दो सूचियाँ।
orders.lines.qtyजैसा फ़ील्ड केवल संग्रहीत होता है। इसका उपयोग संदेशों में करें, लेकिन सेगमेंट में नहीं।
सीमाएँ
Anchor link toPushwoosh ऑब्जेक्ट टैग पर, नेस्टेड ऑब्जेक्ट और नेस्टेड सूचियों सहित, ये सीमाएँ लागू करता है:
| सीमा | मान | सीमा पार होने पर |
|---|---|---|
| नेस्टिंग की गहराई | ऑब्जेक्ट और सूचियों के 3 स्तर। टैग स्वयं पहला स्तर है, इसलिए profile.address.geo अनुमत सबसे गहरा ऑब्जेक्ट है | स्कीमा विधि HTTP 400 लौटाती है, त्रुटियाँ देखें |
| एक ऑब्जेक्ट में फ़ील्ड | 1 से 20 तक, टैग के लिए और हर नेस्टेड ऑब्जेक्ट या नेस्टेड सूची के लिए | स्कीमा विधि HTTP 400 लौटाती है, त्रुटियाँ देखें |
| एक ऑब्जेक्ट टैग में मान वाले फ़ील्ड | 50, नेस्टेड फ़ील्ड सहित। OBJECT और OBJECT_LIST प्रकार के फ़ील्ड नहीं गिने जाते | स्कीमा विधि HTTP 400 लौटाती है, त्रुटियाँ देखें |
| पूरा फ़ील्ड नाम | 64 वर्ण, जैसे profile.address.city | स्कीमा विधि HTTP 400 लौटाती है, त्रुटियाँ देखें |
| ऑब्जेक्ट की एक सूची में एलिमेंट | 100, टैग के लिए और हर नेस्टेड सूची के लिए | लिखा गया पूरा मान अस्वीकार कर दिया जाता है |
| लिखे गए एक मान का आकार | JSON के 64 KB | लिखा गया पूरा मान अस्वीकार कर दिया जाता है |
अस्वीकृत मान को उसी तरह संभाला जाता है जैसे गलत फ़ील्ड प्रकार वाले मान को, लिखने से पूरा मान बदल जाता है देखें।
स्कीमा नियम
Anchor link toजब आप ऑब्जेक्ट टैग बनाते हैं या फ़ील्ड जोड़ते हैं, तो Pushwoosh इन नियमों की जांच करता है:
- ऑब्जेक्ट और फ़ील्ड के नामों में केवल लैटिन अक्षर, अंक और
_होते हैं। - टैग और हर नेस्टेड ऑब्जेक्ट या नेस्टेड सूची में 1 से 20 फ़ील्ड होते हैं। अन्य सीमाएँ भी लागू होती हैं। फ़ील्ड नाम केस-इनसेंसिटिव होते हैं, इसलिए
Amountऔरamountएक ही फ़ील्ड हैं। - फ़ील्ड का प्रकार इनमें से एक होता है:
INTEGER,STRING,LIST,DATE,BOOLEAN,PRICE,VERSION,OBJECT,OBJECT_LIST।OBJECTयाOBJECT_LISTप्रकार के फ़ील्ड को अपनेfieldsचाहिए। टाइमज़ोन फ़ील्ड समर्थित नहीं हैं। - फ़ील्ड ऐसा नाम नहीं ले सकता जो किसी दूसरे टैग के पास पहले से है। यदि टैग
order.noteमौजूद है, तोorderमें फ़ील्डnoteजोड़नाtag order.note already existsके साथ विफल होता है। - ऑब्जेक्ट अपना अंतिम फ़ील्ड नहीं खो सकता। इसके बजाय ऑब्जेक्ट हटाएं।
- उपयोग में मौजूद फ़ील्ड या ऑब्जेक्ट टैग को हटाया नहीं जा सकता। नेस्टेड ऑब्जेक्ट या नेस्टेड सूची तब उपयोग में मानी जाती है, जब उसके अंदर की किसी भी चीज़ का उपयोग होता है। त्रुटि बताती है कि इसका उपयोग कहां होता है, उदाहरण के लिए
field is in use: segment Big buyers, in-app Spring sale। टैग को संदर्भित करने वाले सेगमेंट, इन-ऐप, चल रहे Customer Journey कैंपेन, प्रीसेट, ईमेल टेम्पलेट और अन्य आइटम उपयोग के रूप में गिने जाते हैं।
कंट्रोल पैनल में ऑब्जेक्ट टैग प्रबंधित करें
Anchor link toकंट्रोल पैनल में नेस्टेड ऑब्जेक्ट और नेस्टेड सूचियों के बिना ऑब्जेक्ट टैग बनाएं:
- अपने कंट्रोल पैनल के टैग्स पेज पर, टैग बनाएं पर क्लिक करें।
- टैग का नाम दर्ज करें।
- मान का प्रकार में, ऑब्जेक्ट या ऑब्जेक्ट की सूची चुनें।
- फ़ील्ड के अंतर्गत, पहले फ़ील्ड का नाम दर्ज करें।
- फ़ील्ड का प्रकार चुनें।
- एक और फ़ील्ड जोड़ने के लिए, फ़ील्ड जोड़ें पर क्लिक करें।
- बनाएं पर क्लिक करें।
टैग पेज पर फ़ील्ड जोड़ें, या किसी फ़ील्ड को हटाने के लिए उसके बगल में हटाएँ पर क्लिक करें। कंट्रोल पैनल नेस्टेड ऑब्जेक्ट या नेस्टेड सूची नहीं बना सकता और न ही उसके फ़ील्ड बदल सकता है। API के माध्यम से बनाए गए नेस्टेड ऑब्जेक्ट या नेस्टेड सूची को यह ऑब्जेक्ट या ऑब्जेक्ट की सूची प्रकार के एक फ़ील्ड के रूप में दिखाता है। उस फ़ील्ड को हटाने से वह अपने अंदर की हर चीज़ के साथ हट जाता है।
स्कीमा प्रबंधित करें
Anchor link toनीचे दी गई REST विधियों से ऑब्जेक्ट टैग बनाएं और बदलें। /json/1.3/addTag का उपयोग केवल सामान्य टैग के लिए करें, क्योंकि यह फ़ील्ड परिभाषित नहीं कर सकता।
बेस URL
Anchor link tohttps://rpc-api.svc-nue.pushwoosh.comप्रमाणीकरण
Anchor link toहर अनुरोध में आपके सर्वर API टोकन के साथ Authorization हेडर शामिल होना चाहिए। डिवाइस API टोकन को HTTP 403 a device API token cannot call this method, use an account API token मिलता है।
Authorization: Api YOUR_API_TOKENएंडपॉइंट्स
Anchor link toये विधियां ऑब्जेक्ट टैग के स्कीमा को प्रबंधित करती हैं और उनके फ़ील्ड के मान पढ़ती हैं:
| विधि | पाथ | विवरण |
|---|---|---|
POST | /api/tags | अपने फ़ील्ड के साथ ऑब्जेक्ट टैग बनाएं |
GET | /api/tags/{name} | अपने फ़ील्ड के साथ ऑब्जेक्ट टैग प्राप्त करें |
GET | /api/tags | टैग सूचीबद्ध करें। ऑब्जेक्ट टैग अपने सभी fields के साथ आता है, नेस्टेड फ़ील्ड सहित, और फ़ील्ड अलग टैग के रूप में सूचीबद्ध नहीं होते |
POST | /api/tags/{name}/fields | ऑब्जेक्ट टैग, नेस्टेड ऑब्जेक्ट या नेस्टेड सूची में फ़ील्ड जोड़ें |
DELETE | /api/tags/{name}/fields/{field} | फ़ील्ड, नेस्टेड ऑब्जेक्ट या नेस्टेड सूची हटाएं |
DELETE | /api/tags/{name} | सभी फ़ील्ड के साथ ऑब्जेक्ट टैग हटाएं |
GET | /api/tags:values | किसी फ़ील्ड के संग्रहीत मान सूचीबद्ध करें, फ़ील्ड के संग्रहीत मान देखें |
POST /api/tags ऑब्जेक्ट टैग लौटाता है, और दोनों फ़ील्ड विधियां बदलाव के बाद {name} में दिया गया ऑब्जेक्ट {"tag": {...}} में लपेटकर लौटाती हैं। DELETE /api/tags/{name} {} लौटाता है।
यदि आपके खाते के लिए ऑब्जेक्ट टैग सक्षम नहीं हैं, तो ऑब्जेक्ट प्रकार के साथ POST /api/tags और दोनों फ़ील्ड विधियां HTTP 403 object tags are not enabled for the account के साथ विफल होती हैं। GET /api/tags/{name} और DELETE /api/tags/{name} HTTP 404 tag not found लौटाते हैं, और GET /api/tags ऑब्जेक्ट टैग सूचीबद्ध नहीं करता। ऑब्जेक्ट टैग सक्षम किए बिना आप एक भी नहीं बना सकते, इसलिए मान लिखने के लिए कुछ नहीं होता।
ऑब्जेक्ट टैग बनाएं
Anchor link toPOST /api/tags
अनुरोध बॉडी
Anchor link to| नाम | प्रकार | विवरण |
|---|---|---|
| name* | string | ऑब्जेक्ट टैग का नाम। |
| type* | string | एक ऑब्जेक्ट के लिए OBJECT या ऑब्जेक्ट की सूची के लिए OBJECT_LIST। |
| fields* | array | ऑब्जेक्ट के फ़ील्ड, 1 से 20 तक। |
| fields[].name* | string | फ़ील्ड का नाम। फ़ील्ड टैग <name>.<fields[].name> बन जाता है। |
| fields[].type* | string | फ़ील्ड का प्रकार: INTEGER, STRING, LIST, DATE, BOOLEAN, PRICE, VERSION, OBJECT या OBJECT_LIST। |
| fields[].fields | array | नेस्टेड ऑब्जेक्ट या नेस्टेड सूची के फ़ील्ड, 1 से 20 तक, उसी प्रारूप में। OBJECT और OBJECT_LIST प्रकारों के लिए आवश्यक, अन्य प्रकारों के लिए अनदेखा किया जाता है। |
{ "name": "orders", "type": "OBJECT_LIST", "fields": [ { "name": "amount", "type": "INTEGER" }, { "name": "status", "type": "STRING" } ]}{ "tag": { "name": "orders", "type": "OBJECT_LIST", "system": false, "user_specific": true, "has_right_ace_modify": true, "fields": [ { "name": "amount", "type": "INTEGER", "fields": [] }, { "name": "status", "type": "STRING", "fields": [] } ] }}user_specific के मान की परवाह किए बिना टैग User-specific के रूप में बनाया जाता है। GET /api/tags/{name} वही ऑब्जेक्ट tag रैपर के बिना लौटाता है। फ़ील्ड नाम के अनुसार क्रमबद्ध होते हैं, और नेस्टेड फ़ील्ड के बिना फ़ील्ड खाली fields ऐरे के साथ आता है।
नेस्टेड ऑब्जेक्ट और नेस्टेड सूचियाँ बनाने के लिए, फ़ील्ड को OBJECT या OBJECT_LIST प्रकार और उसके अपने fields दें। एक अनुरोध पूरी संरचना बनाता है:
{ "name": "profile", "type": "OBJECT", "fields": [ { "name": "address", "type": "OBJECT", "fields": [ { "name": "city", "type": "STRING" }, { "name": "geo", "type": "OBJECT", "fields": [{ "name": "lat", "type": "STRING" }] } ] }, { "name": "visits", "type": "OBJECT_LIST", "fields": [{ "name": "code", "type": "STRING" }] } ]}नेस्टेड फ़ील्ड अपने ऑब्जेक्ट के सापेक्ष नामों के साथ लौटते हैं, जैसे address के अंदर city। GET /api/tags/{name} केवल टैग का अपना नाम लेता है। profile.address जैसा नेस्टेड नाम HTTP 404 tag not found लौटाता है।
फ़ील्ड जोड़ें
Anchor link toPOST /api/tags/{name}/fields
{ "field": { "name": "note", "type": "STRING" }}नेस्टेड ऑब्जेक्ट या नेस्टेड सूची में फ़ील्ड जोड़ने के लिए, {name} में उसका पूरा नाम डालें, उदाहरण के लिए POST /api/tags/profile.address/fields या POST /api/tags/profile.visits/fields। नया फ़ील्ड अपने fields के साथ नेस्टेड ऑब्जेक्ट या नेस्टेड सूची हो सकता है:
{ "field": { "name": "company", "type": "OBJECT", "fields": [{ "name": "title", "type": "STRING" }] }}आप नया फ़ील्ड तुरंत पूरे टैग मान के हिस्से के रूप में लिख सकते हैं। यदि ऑब्जेक्ट में पहले से 20 फ़ील्ड हैं, फ़ील्ड कोई अन्य सीमा तोड़ता है, या पूरे फ़ील्ड नाम वाला टैग मौजूद है, तो फ़ील्ड जोड़ना विफल होता है, त्रुटियाँ देखें।
फ़ील्ड हटाएं
Anchor link toDELETE /api/tags/{name}/fields/{field}
उदाहरण के लिए, DELETE /api/tags/orders/fields/note फ़ील्ड orders.note को हटाता है। नेस्टेड ऑब्जेक्ट या नेस्टेड सूची का फ़ील्ड हटाने के लिए, {name} में उसका पूरा नाम डालें: DELETE /api/tags/profile.address/fields/city।
नेस्टेड ऑब्जेक्ट या नेस्टेड सूची को हटाने से उसके अंदर की हर चीज़ हट जाती है: DELETE /api/tags/profile/fields/address profile.address.city और profile.address.geo को भी हटाता है। आप किसी ऑब्जेक्ट का अंतिम फ़ील्ड, या उपयोग में मौजूद फ़ील्ड, नेस्टेड ऑब्जेक्ट या नेस्टेड सूची नहीं हटा सकते, त्रुटियाँ देखें।
त्रुटियाँ
Anchor link toत्रुटियाँ {"code": <n>, "message": "...", "details": [...]} प्रारूप में आती हैं। जब आप ऑब्जेक्ट टैग बनाते हैं, तो 400 संदेश का रूप validate: rpc error: code = InvalidArgument desc = <message> होता है, जहाँ <message> तालिका में दिया गया टेक्स्ट है। इन संदेशों में <object> ऑब्जेक्ट का पूरा नाम है, जैसे profile.address।
| HTTP स्थिति | संदेश | कारण |
|---|---|---|
| 400 | object tag and field names must contain only letters, digits and underscores | किसी नाम में कोई अन्य वर्ण है। |
| 400 | <object>: an object needs 1 to 20 fields | बनाते समय टैग, नेस्टेड ऑब्जेक्ट या नेस्टेड सूची में कोई फ़ील्ड नहीं है या 20 से अधिक फ़ील्ड हैं। |
| 400 | an object has at most 20 fields | जिस ऑब्जेक्ट में आप फ़ील्ड जोड़ते हैं, उसमें पहले से 20 फ़ील्ड हैं। |
| 400 | <object>.<field>: objects nest at most 3 levels deep | OBJECT या OBJECT_LIST फ़ील्ड चौथा स्तर बन जाएगा। |
| 400 | an object tag holds at most 50 fields with values, nested ones included | ऑब्जेक्ट टैग में मान वाले 50 से अधिक फ़ील्ड हो जाएँगे। |
| 400 | field <name> is given twice | केस को अनदेखा करते हुए, दो फ़ील्ड का नाम एक जैसा है। |
| 400 | <object>.<field>: object and field names together cannot be longer than 64 characters | पूरा फ़ील्ड नाम बहुत लंबा है। |
| 400 | <object>.<field>: field type must be INTEGER, STRING, LIST, DATE, BOOLEAN, PRICE, VERSION, OBJECT or OBJECT_LIST | असमर्थित फ़ील्ड प्रकार। |
| 400 | an object needs at least one field; delete the object instead | आपने किसी ऑब्जेक्ट का अंतिम फ़ील्ड हटाने की कोशिश की। |
| 400 | field is in use: ..., tag is in use: ... | फ़ील्ड, नेस्टेड ऑब्जेक्ट या नेस्टेड सूची के अंदर की कोई चीज़, या ऑब्जेक्ट टैग का उपयोग सेगमेंट, इन-ऐप, Customer Journey कैंपेन या अन्य आइटम में होता है। |
| 403 | object tags are not enabled for the account | खाते के लिए ऑब्जेक्ट टैग सक्षम नहीं हैं। |
| 403 | a device API token cannot call this method, use an account API token | अनुरोध डिवाइस API टोकन का उपयोग करता है। |
| 404 | tag not found | GET या DELETE /api/tags/{name}: ऐसा कोई टैग नहीं है, नाम एक फ़ील्ड है, या ऑब्जेक्ट टैग सक्षम नहीं हैं। |
| 404 | object tag not found, field not found | फ़ील्ड विधियां: ऐसा कोई ऑब्जेक्ट टैग, नेस्टेड ऑब्जेक्ट, नेस्टेड सूची या फ़ील्ड नहीं है। {name} में मान वाला फ़ील्ड होने पर भी object tag not found लौटता है। |
| 409 | tag already exists | ऑब्जेक्ट टैग के नाम वाला टैग मौजूद है। |
| 409 | tag <object>.<field> already exists | फ़ील्ड के पूरे नाम वाला टैग मौजूद है। |
मान लिखें
Anchor link toऑब्जेक्ट टैग के मान /setTags और /bulkSetTags से लिखें। ये विधियां अपना प्रमाणीकरण बनाए रखती हैं: /setTags Authorization: Token हेडर में डिवाइस API टोकन लेता है, और /bulkSetTags auth में API एक्सेस टोकन लेता है। Object मान को JSON ऑब्जेक्ट के रूप में और ObjectList मान को ऑब्जेक्ट्स की ऐरे के रूप में भेजें:
{ "request": { "application": "XXXXX-XXXXX", "userId": "user_42", "tags": { "order": { "amount": 120, "status": "paid" }, "orders": [ { "amount": 120, "status": "paid" }, { "amount": 50 } ] } }}यदि आप HWID द्वारा मान सेट करते हैं, तो वह उस डिवाइस के उपयोगकर्ता पर संग्रहीत होता है। स्कीमा विधियों के बेस URL पर POST /api/devices:set_tags उन्हीं नियमों के अनुसार ऑब्जेक्ट टैग लिखता है। इसकी प्रतिक्रिया ऑब्जेक्ट के फ़ील्ड को "profile.address.city" जैसे फ़्लैट नामों के रूप में सूचीबद्ध करती है।
नेस्टेड ऑब्जेक्ट JSON ऑब्जेक्ट लेता है, और नेस्टेड सूची ऑब्जेक्ट्स की ऐरे लेती है:
"tags": { "profile": { "address": { "city": "Berlin", "geo": { "lat": "52.5" } }, "visits": [{ "code": "v1" }] }, "orders": [ { "sku": "A-1", "meta": { "color": "red" }, "lines": [{ "qty": 2 }, { "qty": 3 }] } ]}हर फ़ील्ड अपने प्रकार के प्रारूप में मान लेता है:
| फ़ील्ड प्रकार | उदाहरण मान |
|---|---|
INTEGER | 120 |
STRING | "paid" |
LIST | ["gift", "express"] |
DATE | "2026-10-02 22:11" (UTC), "2026-10-02", या सेकंड में Unix टाइमस्टैम्प |
BOOLEAN | true या false |
PRICE | 19.95 |
VERSION | "1.0.0" |
लिखने से पूरा मान बदल जाता है
Anchor link toहर बार लिखने पर ऑब्जेक्ट टैग का संग्रहीत मान बदल दिया जाता है:
- नए मान में मौजूद न होने वाला फ़ील्ड हटा दिया जाता है।
nullके रूप में भेजा गया फ़ील्ड भी हटा दिया जाता है। null,[]या""पूरा मान हटा देता है।{}Objectटैग के सभी फ़ील्ड हटा देता है।- जो कुंजी ऑब्जेक्ट का फ़ील्ड नहीं है, उसे छोड़ दिया जाता है।
- यदि किसी भी गहराई पर कोई फ़ील्ड मान फ़ील्ड प्रकार से मेल नहीं खाता, तो टैग का पूरा मान अस्वीकार कर दिया जाता है और संग्रहीत मान वैसा ही रहता है। यही तब होता है जब मान कोई सीमा तोड़ता है: 100 से अधिक एलिमेंट वाली सूची या JSON के 64 KB से अधिक।
/setTags अपनी प्रतिक्रिया में अस्वीकृत मान की रिपोर्ट नहीं करता और HTTP 200 लौटाता है। परिणाम /getTags से जांचें या /bulkSetTags का उपयोग करें, जो हर टैग के लिए परिणाम रिपोर्ट करता है।
छिपे हुए फ़ील्ड
Anchor link toछिपा हुआ फ़ील्ड वह फ़ील्ड है जिसे Pushwoosh अपने उपयोग के लिए छिपा हुआ चिह्नित करता है। इस पेज की स्कीमा विधियों से आप कोई फ़ील्ड बना या छिपा नहीं सकते। /getTags छिपे हुए फ़ील्ड नहीं लौटाता, इसलिए जो मान आप पढ़ते हैं और वापस लिखते हैं, उसमें वे कभी नहीं होते। लिखने पर उनके साथ क्या होता है, यह प्रकार पर निर्भर करता है:
Object। नए मान में मौजूद न होने वाला छिपा हुआ फ़ील्ड किसी भी गहराई पर बना रहता है। नए मान में मौजूद न होने वाला दृश्यमान नेस्टेड ऑब्जेक्ट अपने अंदर की हर चीज़ के साथ हटा दिया जाता है, छिपे हुए फ़ील्ड सहित। पूरा मान हटाने से छिपे हुए फ़ील्ड भी हट जाते हैं।ObjectList। सूची लिखने से उसके सभी एलिमेंट बदल जाते हैं, और पुराने एलिमेंट के छिपे हुए फ़ील्ड खो जाते हैं। एलिमेंट का कोई पहचानकर्ता नहीं होता, इसलिए नए एलिमेंट को पुराने एलिमेंट से मिलाया नहीं जा सकता। यही नेस्टेड सूची पर भी लागू होता है।
Object का हिस्सा लिखें
Anchor link toपूरे टैग मान के बजाय Object टैग का एक फ़ील्ड, नेस्टेड ऑब्जेक्ट या नेस्टेड सूची उसके पूरे नाम से लिखें। increment और /setTags के अन्य ऑपरेशन फ़ील्ड पर काम करते हैं:
"tags": { "order.status": "shipped", "order.amount": { "operation": "increment", "value": 5 }}यही तरीका ऐसे नेस्टेड ऑब्जेक्ट के फ़ील्ड के लिए भी काम करता है जिसके ऊपर केवल ऑब्जेक्ट हों, जैसे "profile.address.city": "Paris"।
जिस नेस्टेड ऑब्जेक्ट या नेस्टेड सूची के ऊपर केवल ऑब्जेक्ट हों, उसे उसके पूरे नाम से अलग से लिखा जा सकता है, जैसे profile.address या profile.visits। मान केवल उसे बदलता है, और profile का बाकी हिस्सा वैसा ही रहता है। 100 एलिमेंट और 64 KB की सीमाएँ इसी मान से गिनी जाती हैं:
"tags": { "profile.address": { "city": "Paris" }, "profile.visits": [{ "code": "v2" }]}ऑब्जेक्ट की सूची के अंदर की कोई भी चीज़ अलग से नहीं लिखी जा सकती, क्योंकि यह स्पष्ट नहीं है कि कौन-सा एलिमेंट बदलना है। इसमें ObjectList टैग का फ़ील्ड, जैसे orders.sku, और एलिमेंट के अंदर की हर चीज़, जैसे orders.meta या profile.visits.code, शामिल है। /setTags ऐसे मान को छोड़ देता है। इसके बजाय पूरी सूची भेजें।
ऑब्जेक्ट टैग स्वचालित रूप से नहीं बनते
Anchor link toऐसे टैग के लिए ऑब्जेक्ट या ऑब्जेक्ट्स की ऐरे वाला मान, जो मौजूद नहीं है, छोड़ दिया जाता है। टैग ऑटो-क्रिएशन ऑब्जेक्ट टैग नहीं बनाता, इसलिए पहले POST /api/tags से स्कीमा बनाएं।
bulkSetTags परिणाम
Anchor link todetailed=true के साथ, /bulkSetTags स्थिति ऑब्जेक्ट टैग के लिए ok, tag not found और wrong value. expect :<type> के अलावा इनमें से एक परिणाम लौटाता है:
| परिणाम | कारण |
|---|---|
object tags are stored on the user only | ऑब्जेक्ट टैग User-specific नहीं है। |
cannot load the fields of the object | Pushwoosh ऑब्जेक्ट टैग के फ़ील्ड नहीं पढ़ सका। |
wrong value. expect an object (a map) or, for a list of objects, an array of maps | मान ऑब्जेक्ट टैग में फ़िट नहीं होता, किसी भी गहराई पर कोई फ़ील्ड मान अपने प्रकार से मेल नहीं खाता, या मान कोई सीमा तोड़ता है। |
a field of a list of objects cannot be set on its own, set the whole list | मान ऑब्जेक्ट की सूची के अंदर की किसी चीज़ पर सेट किया गया है, जैसे orders.sku या orders.meta। |
मान पढ़ें
Anchor link to/getTags Object मान को JSON ऑब्जेक्ट के रूप में और ObjectList मान को ऑब्जेक्ट्स की ऐरे के रूप में लौटाता है:
{ "status_code": 200, "status_message": "OK", "response": { "result": { "order": { "amount": 120, "status": "paid" }, "orders": [ { "amount": 120, "status": "paid" }, { "amount": 50 } ] } }}नेस्टेड ऑब्जेक्ट और नेस्टेड सूचियाँ किसी भी गहराई पर उसी रूप में लौटती हैं जिसमें आप उन्हें लिखते हैं, उदाहरण के लिए "profile": {"address": {"city": "Berlin"}, "visits": [{"code": "v1"}]}।
फ़ील्ड मान /getTags में सामान्य टैग मानों की तरह ही लौटाए जाते हैं: Date सेकंड में Unix टाइमस्टैम्प के रूप में, Price "120.00" जैसी स्ट्रिंग के रूप में, और Boolean 1 या 0 के रूप में।
फ़ील्ड के संग्रहीत मान
Anchor link toबेस URL पर GET /api/tags:values किसी फ़ील्ड में मौजूद अलग-अलग मान सूचीबद्ध करता है, हर मान के लिए सब्सक्राइबर की संख्या के साथ। name में फ़ील्ड का पूरा नाम दें, जैसे profile.address.city या orders.sku।
क्वेरी पैरामीटर
Anchor link to| नाम | प्रकार | विवरण |
|---|---|---|
| application* | string | एप्लिकेशन कोड, XXXXX-XXXXX। |
| name* | string | फ़ील्ड का पूरा नाम। |
| like | string | केवल वे मान लौटाएं जिनमें यह टेक्स्ट like_op द्वारा तय स्थिति में हो। |
| like_op | string | STARTS_WITH (डिफ़ॉल्ट), ENDS_WITH या CONTAINS। |
| order_by | string | VALUE (डिफ़ॉल्ट) या COUNT। |
| order_direction | string | ASC (डिफ़ॉल्ट) या DESC। |
| limit | integer | लौटाए जाने वाले मानों की संख्या। डिफ़ॉल्ट 100 है। |
| offset | integer | छोड़े जाने वाले मानों की संख्या। |
| page | integer | पृष्ठ संख्या, 0 से शुरू। limit और offset के बजाय per_page के साथ उपयोग किया जाता है। |
| per_page | integer | एक पृष्ठ पर मानों की संख्या। |
GET /api/tags:values?application=XXXXX-XXXXX&name=orders.sku&order_by=COUNT&order_direction=DESC{ "values": [ { "value": "A-1", "count": 120 }, { "value": "B-2", "count": 45 } ], "total": 2, "page": 0, "per_page": 100}Integer और Price फ़ील्ड कोई मान नहीं लौटाते, ठीक इन प्रकारों के सामान्य टैग की तरह। ऑब्जेक्ट टैग, नेस्टेड ऑब्जेक्ट या नेस्टेड सूची का स्वयं कोई अपना मान नहीं होता, इसलिए उसका नाम HTTP 404 tag not found लौटाता है।
फ़ील्ड के आधार पर सेगमेंट करें
Anchor link toसेगमेंट की शर्तें फ़ील्ड पर सेट करें, ऑब्जेक्ट टैग पर नहीं। सेगमेंटेशन भाषा में फ़ील्ड बिंदु वाले नाम का एक टैग है, और यह अपने प्रकार के ऑपरेटर लेता है:
AT("XXXXX-XXXXX", "order.amount", gte, 100)नेस्टेड ऑब्जेक्ट या नेस्टेड सूची का फ़ील्ड अपना पूरा नाम लेता है, जैसे profile.address.city, profile.visits.code या orders.meta.color। ऑब्जेक्ट टैग पर ही, नेस्टेड ऑब्जेक्ट पर या नेस्टेड सूची पर लगाई गई शर्त, जैसे profile.address, object tag has no value of its own, use one of its fields के साथ विफल होती है।
जिस फ़ील्ड के ऊपर ऑब्जेक्ट की दो सूचियाँ हैं, जैसे orders.lines.qty, वह केवल संग्रहीत होता है। ऐसी शर्त वाला सेगमेंट सहेजा जाता है, लेकिन उसकी गिनती करना या उसे भेजना a field inside a list nested in a list is stored only and cannot be searched के साथ विफल होता है।
ObjectList पर शर्तें
Anchor link toObjectList टैग के फ़ील्ड पर शर्त किसी उपयोगकर्ता से तब मेल खाती है, जब सूची का कम से कम एक एलिमेंट शर्त में फ़िट होता है। AND से जुड़ी, एक ही सूची के फ़ील्ड पर शर्तें एक ही एलिमेंट से मेल खानी चाहिए:
AT("XXXXX-XXXXX", "orders.amount", gte, 100) * AT("XXXXX-XXXXX", "orders.status", eq, "paid")इस सेगमेंट में वे उपयोगकर्ता हैं जिनका कम से कम एक ऑर्डर 100 या उससे अधिक का भी है और paid भी है। एक बड़े अवैतनिक ऑर्डर और एक छोटे भुगतान किए गए ऑर्डर वाला उपयोगकर्ता मेल नहीं खाता। एलिमेंट के अंदर के ऑब्जेक्ट के फ़ील्ड के लिए भी वही एलिमेंट जांचा जाता है: A-1 के बराबर orders.sku AND red के बराबर orders.meta.color ऐसे उपयोगकर्ता से मेल खाते हैं जिसका एक ऑर्डर दोनों शर्तें पूरी करता है। OR से जुड़ी शर्तों का एक ही एलिमेंट से मेल खाना ज़रूरी नहीं है। दो अलग-अलग सूचियों पर शर्तें हर सूची पर अलग से जांची जाती हैं।
ObjectList टैग के फ़ील्ड पर कुछ ऑपरेटर अलग तरह से काम करते हैं:
notset। सूची के किसी भी एलिमेंट में इस फ़ील्ड का मान नहीं है। सूची के बिना उपयोगकर्ता भी मेल खाता है।noteq। कम से कम एक एलिमेंट में इस फ़ील्ड का मान है, और वह मान दिए गए मान से अलग है। फ़ील्ड के बिना एलिमेंट नहीं गिने जाते।paidऔरnewस्थिति वाले ऑर्डर वाला उपयोगकर्ताnoteq "paid"से मेल खाता है।- List फ़ील्ड पर
notin। किसी भी एलिमेंट में दिए गए मानों में से कोई भी मान नहीं है। - दूसरे प्रकार के फ़ील्ड पर
notin। कम से कम एक एलिमेंट में इस फ़ील्ड का ऐसा मान है जो दिए गए मानों में नहीं है।
List फ़ील्ड पर notset और notin AND से जुड़ी अन्य शर्तों के साथ एक ही एलिमेंट से बंधे नहीं होते। ये नियम नेस्टेड सूचियों पर भी लागू होते हैं, जैसे profile.visits।
संदेशों में मानों का उपयोग करें
Anchor link toLiquid टेम्पलेट की मदद से ऑब्जेक्ट टैग के फ़ील्ड पुश नोटिफिकेशन, ईमेल, SMS और WhatsApp जैसे मैसेंजर संदेशों में डालें। Liquid केवल तभी काम करता है जब आपके खाते के लिए कंटेंट टेम्पलेट सक्षम हों। किसी भी गहराई पर फ़ील्ड को उसके पूरे नाम से लिखें:
Your city is {{ profile.address.city }}.ऑब्जेक्ट की सूची का एलिमेंट उसके इंडेक्स से लें, जो 0 से शुरू होता है:
Your first order is {{ orders[0].sku }}, quantity {{ orders[0].lines[0].qty }}.सूची के अंत से आगे का इंडेक्स, या ऐसी सूची जो उपयोगकर्ता के पास नहीं है, खाली स्ट्रिंग के रूप में रेंडर होती है। पहले एलिमेंट की जांच करें या default से फॉलबैक सेट करें:
{% if orders[0] %}Your first order is {{ orders[0].sku }}.{% endif %}Your first order is {{ orders[0].sku | default: "on its way" }}.ऑब्जेक्ट की सूची पर लूप चलाएं, एलिमेंट के अंदर की सूची सहित:
{% for o in orders %}{{ o.meta.color }}{% for l in o.lines %}{{ l.qty }}{% endfor %}{% endfor %}केवल संग्रहीत फ़ील्ड, जैसे orders.lines.qty, टेम्पलेट में अन्य फ़ील्ड की तरह ही काम करते हैं।
ऑब्जेक्ट टैग वाले सेगमेंट निर्यात करें
Anchor link to/exportSegment ऑब्जेक्ट टैग के फ़ील्ड निर्यात करता है:
- CSV। मान वाला हर फ़ील्ड उसके पूरे नाम वाला एक अलग कॉलम है, जैसे
order.amountयाprofile.address.city। ऑब्जेक्ट टैग, नेस्टेड ऑब्जेक्ट और नेस्टेड सूचियों को खुद कोई कॉलम नहीं मिलता। ऑब्जेक्ट की सूची के अंदर का फ़ील्ड, किसी भी गहराई पर, सभी एलिमेंट के अलग-अलग मानों को JSON ऐरे के रूप में रखता है, ठीक List टैग की तरह:["A-1","B-2"]। ऐरे क्रमबद्ध होती है और यह नहीं दिखाती कि कोई मान किस एलिमेंट से आया, इसलिए यह एलिमेंट का क्रम भी नहीं रखती। एलिमेंट को पूरा पाने के लिएjsonयाjson_each_lineमें निर्यात करें। jsonऔरjson_each_line। ऑब्जेक्ट टैग नेस्टेड रूप में आते हैं, उसी रूप में जिसमें/getTagsउन्हें लौटाता है।Objectटैगtagsमें एक एंट्री है जिसके फ़ील्डobject.fieldsके तहत होते हैं, और उसके अंदर का नेस्टेड ऑब्जेक्ट भी अपने फ़ील्डobject.fieldsके तहत रखता है, हर स्तर पर।ObjectListटैग एक एंट्री है जिसके एलिमेंटobject_list.itemsमें होते हैं, और नेस्टेड सूची भी ऐसी ही होती है। फ़ील्ड के नाम छोटे होते हैं, वे नाम के अनुसार क्रमबद्ध होते हैं, और अपना मान प्रकार के नाम वाली कुंजी के तहत रखते हैं:integer,string,list,date,boolean,priceयाversion:
{ "name": "profile", "object": { "fields": [ { "name": "address", "object": { "fields": [{ "name": "city", "string": "Berlin" }] } }, { "name": "visits", "object_list": { "items": [{ "fields": [{ "name": "code", "string": "v1" }] }] } } ] }}ObjectList टैग ऐसा दिखता है। इंटीजर मान स्ट्रिंग के रूप में आते हैं:
{ "name": "orders", "object_list": { "items": [ { "fields": [{ "name": "amount", "integer": "120" }, { "name": "status", "string": "paid" }] }, { "fields": [{ "name": "amount", "integer": "50" }] } ] }}नेस्टेड ऑब्जेक्ट और नेस्टेड सूची वाला एलिमेंट ऐसा दिखता है:
{ "fields": [ { "name": "meta", "object": { "fields": [{ "name": "color", "string": "red" }] } }, { "name": "lines", "object_list": { "items": [{ "fields": [{ "name": "qty", "integer": "2" }] }] } } ]}यदि tagsList किसी ऑब्जेक्ट टैग का नाम देता है, तो उसके सभी फ़ील्ड निर्यात किए जाते हैं, नेस्टेड फ़ील्ड सहित।