واجهة برمجة تطبيقات Tags

ملاحظة

لتعيين قيم الـ tag لـ HWIDs و UserIDs، استخدم أسلوب /setTags من Device API. يُعد addTag اختياريًا، لأن setTags يُنشئ أي اسم tag لا يتعرف عليه بعد ويستنتج النوع من القيمة: العدد الصحيح يصبح Integer، والعدد الذي يحتوي على فاصلة عشرية يصبح Price، والسلسلة النصية تصبح String (أو Date، لتنسيق تاريخ ووقت معترف به مثل 2024-10-02 22:11)، والمصفوفة تصبح List، والقيمة المنطقية تصبح Boolean. يكون الـ tag الذي يُنشأ تلقائيًا من نوع User-specific دائمًا (user_specific: true). استخدم addTag لـ tag من نوع Version، حيث لا يمكن للإنشاء التلقائي استنتاجه، أو لـ tag من نوع General (user_specific: false). يتم تمكين الإنشاء التلقائي للـ tags افتراضيًا لغالبية الحسابات. إذا لم يُنشئ setTags tag جديدًا كما هو متوقع، اتصل بـ دعم Pushwoosh للتحقق مما إذا كان قد تم إيقافه لحسابك.

لتخزين بيانات منظمة، مثل طلب أو قائمة طلبات، في tag واحد، استخدم الـ object tags (تجريبي). لا يستطيع addTag إنشاءها، لأنه لا يقبل الحقول.

addTag

POST https://api.pushwoosh.com/json/1.3/addTag

تُنشئ tag في حسابك.

نص الطلب

الاسم	النوع	الوصف
auth*	string	رمز الوصول إلى API من لوحة تحكم Pushwoosh.
tag*	object	معلمات الـ Tag.
tag.name*	string	اسم الـ Tag.
tag.type*	integer	نوع الـ Tag. انظر القيم الممكنة أدناه.
tag.user_specific	boolean	عندما تكون القيمة true، يتم تخزين قيمة الـ tag على مستوى المستخدم ومشاركتها عبر جميع أجهزة المستخدم عند تعيينها بواسطة UserID. عندما تكون القيمة false (الافتراضي)، يكون الـ tag على مستوى الجهاز ويتم تعيينه لكل HWID.
tag.application_specific	boolean	مُهمَل. يُقبَل ولكن يتم تجاهله، لأن العلامات لم تعد تنقسم إلى علامات خاصة بالتطبيق وعلامات على مستوى الحساب. يمكنك عدم إرساله.

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "result": true
  }
}

مثال

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel
    "tag": {
      "name": "TAG_NAME",           // required.
      "type": 1,                    // required. See possible values below
      "user_specific": false        // optional. true = user-level tag (shared across all devices); false = device-level tag (default)
    }
  }
}

أنواع قيم الـ tag الممكنة:

• 1 - Integer (عدد صحيح)
• 2 - String (سلسلة نصية)
• 3 - List (قائمة)
• 4 - Date (تاريخ)
• 5 - Boolean (قيمة منطقية)
• 6 - Decimal (عشري). مثال: 19.95
• 7 - Version (إصدار). مثال: “1.0.0.0”

deleteTag

POST https://api.pushwoosh.com/json/1.3/deleteTag

تزيل tag بالكامل مع جميع المعلومات المرتبطة به من قاعدة البيانات.

نص الطلب

الاسم	النوع	الوصف
auth*	string	رمز الوصول إلى API من لوحة تحكم Pushwoosh.
tag*	object	معلمات الـ Tag.
tag.name*	string	اسم الـ tag المراد حذفه.

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "result": true
  }
}

مثال

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel
    "tag": {
      "name": "TAG_NAME"            // required. Name of a tag to delete
    }
  }
}

listTags

POST https://api.pushwoosh.com/json/1.3/listTags

تسترجع قائمة بالـ tags الموجودة في الحساب.

نص الطلب

الاسم	النوع	الوصف
auth*	string	رمز الوصول إلى API من لوحة تحكم Pushwoosh.

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "tags": [{
      "name":"Language",
      "type":2,
      "isUserSpecific":true,
      "isApplicationSpecific":true
    }, {
      "name":"List tag",
      "type":3,
      "isUserSpecific":false,
      "isApplicationSpecific":true
    }]
  }
}

يوضح isUserSpecific ما إذا كانت العلامة من نوع User-specific. أما isApplicationSpecific فقيمته دائمًا true ويُحتفَظ به للتوافق مع الإصدارات السابقة فقط، لأن العلامات لم تعد تنقسم إلى علامات خاصة بالتطبيق وعلامات على مستوى الحساب. لا تعتمد على هذا الحقل.

مثال

{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H" // API access token from Pushwoosh Control Panel
  }
}

أنواع الـ Tag:

• 1 - Integer (عدد صحيح)
• 2 - String (سلسلة نصية)
• 3 - List (قائمة)
• 4 - Date (تاريخ)
• 5 - Boolean (قيمة منطقية)
• 6 - Decimal (عشري). مثال: 19.95
• 7 - Version (إصدار). مثال: “1.0.0.0”