অবজেক্ট ট্যাগ 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 toএকটি ObjectList ট্যাগের ফিল্ডের শর্ত একজন ব্যবহারকারীর সাথে মেলে যখন তালিকার অন্তত একটি এলিমেন্ট শর্তটি পূরণ করে। 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 ট্যাগ দেখতে এরকম। Integer মান স্ট্রিং হিসেবে আসে:
{ "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 কোনো অবজেক্ট ট্যাগের নাম দেয়, তাহলে নেস্টেড ফিল্ডসহ তার সমস্ত ফিল্ড এক্সপোর্ট করা হয়।