معرفات API الرئيسية

يسرد هذا المقال المعرفات الأساسية المستخدمة في طلبات Pushwoosh API. هذه المعرفات مطلوبة للمصادقة، وإنشاء الرسائل، والاستهداف، والتقسيم، والتتبع، وإدارة المستخدمين عبر تطبيقاتك.

المعرفات العامة

Application code

معرف فريد يتم تعيينه لكل تطبيق في حساب Pushwoosh الخاص بك. وهو مطلوب في معظم استدعاءات API لتحديد التطبيق المستهدف.

أين تجده

لوحة تحكم Pushwoosh ← أسفل اسم التطبيق.

API access token

رمز فريد يتم تعيينه لحساب Pushwoosh، يستخدم لمصادقة طلبات API. يتيح الوصول لإدارة المشاريع، وإرسال الرسائل، وتعديل الإعدادات، واسترداد البيانات. كل حساب لديه رمز واحد على الأقل تم إنشاؤه افتراضيًا. اعرف المزيد

أين تجده

لوحة تحكم Pushwoosh ← الوصول إلى API.

معرفات الجهاز

Hardware ID

معرف فريد يتم تعيينه لجهاز بواسطة Pushwoosh SDK. يتم تعيينه تلقائيًا بواسطة SDK أو يتم تمريره أثناء تسجيل الجهاز. اعرف المزيد

أين تجده

• في سجلات الجهاز. اعرف المزيد

• في مستكشف المستخدم (User Explorer) عند البحث بواسطة User ID

• في ملف CSV الذي تم تنزيله من قائمة الشرائح (Segments)

Push token

رمز صادر عن مزودي المنصات يحدد زوج التطبيق-الجهاز لتوصيل إشعارات الدفع. يتم جمعه تلقائيًا بواسطة SDK عند منح أذونات الدفع. اعرف المزيد

أين تجده

• في سجلات الجهاز. اعرف المزيد

• في مستكشف المستخدم (User Explorer)، أدخل HWID في حقل البحث للعثور على الجهاز المرتبط، ثم افتح تفاصيل الجهاز لعرض رمز الدفع.

Device type

يشير إلى منصة الجهاز المستهدف باستخدام رمز رقمي. يتم تعيينه تلقائيًا بواسطة SDK.

القيم المدعومة:

1 – iOS
3 – Android
7 – macOS
8 – Windows
9 – Amazon
10 – Safari
11 – Chrome
12 – Firefox
14 – Email
17 – Huawei
18 – SMS
21 – WhatsApp
22 – Line

معرفات المستخدم

User ID

معرف مخصص يتم تعيينه لمستخدم، مما يتيح الاستهداف عبر الأجهزة وتخصيص الرسائل. اعرف المزيد

أين تجده

لوحة تحكم Pushwoosh ← الجمهور ← مستكشف المستخدم

معرفات الرسائل

Message code

معرف فريد يتم تعيينه لكل رسالة عند إنشائها. يتبع تنسيقًا محددًا: XXXX-XXXXXXXX-XXXXXXXX.

هذا الرمز ضروري لـ:

• تتبع حالة وتسليم رسالة معينة
• إلغاء (أو حذف) رسالة تم إرسالها مسبقًا
• الحصول على إحصائيات الرسالة

أين تجده

• لوحة تحكم Pushwoosh: انتقل إلى الحملات ← رسائل لمرة واحدة، ثم افتح خصائص الرسالة المطلوبة. سيتم عرض رمز الرسالة هناك.
• استجابة واجهة برمجة التطبيقات /createMessage: عند إنشاء رسالة جديدة عبر API، يتم تضمين رمز الرسالة في الاستجابة.

معرفات المحتوى

Preset code

معرف لإعداد مسبق لرسالة محفوظة (على سبيل المثال، إشعار دفع أو رسالة نصية قصيرة). اعرف المزيد

أين تجده

لوحة تحكم Pushwoosh ← المحتوى ← الإعدادات المسبقة.

يمكنك العثور على رمز الإعداد المسبق في مكانين:

• في عرض القائمة، معروضًا أسفل اسم الإعداد المسبق.

• في عنوان URL عند تحرير أو إنشاء إعداد مسبق (وهو الجزء الأخير من عنوان URL).

مثال:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/sms-presets/edit/AAAAA-BBBBB

رمز الإعداد المسبق: AAAAA-BBBBB

Rich media code

معرف لقالب رسالة داخل التطبيق. اعرف المزيد

أين تجده

لوحة تحكم Pushwoosh ← المحتوى ← الوسائط الغنية.

مثال: URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/rich-media/AAAAA-BBBBB/statistics رمز الوسائط الغنية: AAAAA-BBBBB

Email content code

رمز محتوى البريد الإلكتروني هو معرف فريد لمحتوى البريد الإلكتروني المحفوظ. اعرف المزيد

أين تجده

لوحة تحكم Pushwoosh ← المحتوى ← محتوى البريد الإلكتروني.

الرمز هو الجزء الأخير من عنوان URL.

مثال:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/email-content/edit/AAAAA-BBBBB رمز محتوى البريد الإلكتروني: AAAAA-BBBBB

معرفات الحملة

Campaign code

معرف فريد يستخدم للإشارة إلى حملة معينة للتتبع والتحليل.

أين تجده

يظهر رمز الحملة في عنوان URL عند عرض الإحصائيات المتعلقة بالحملة في لوحة تحكم Pushwoosh. لتحديد موقعه، انتقل إلى الإحصائيات ← الإحصائيات المجمعة، وانقر على الحملة المطلوبة، وانسخ الرمز الموجود في نهاية عنوان URL.

مثال:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/statistics/aggregated-message?campaignCode=YYYYY-YYYYY

رمز الحملة: YYYYY-YYYYY

Journey ID

معرف فريد يستخدم لربط الرسائل بحملات تسويقية معينة للتتبع وتحليل الأداء.

أين تجده

يظهر معرف الرحلة (Journey ID) في عنوان URL الخاص بلوحة الحملة في لوحة تحكم Pushwoosh.

مثال: URL: https://app.pushwoosh.com/journeys/XXXXX-XXXXX/1/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

معرف الرحلة (Journey ID): aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

معرفات التقسيم والاستهداف

Segment / Filter name

اسم شريحة مستخدم محددة مسبقًا تم إنشاؤها في Pushwoosh لاستهداف الجمهور. اعرف المزيد

أين تجده

لوحة تحكم Pushwoosh ← الشرائح.

Segment / Filter code

رمز فريد بالتنسيق XXXXX-XXXXX يحدد شريحة (تسمى أيضًا فلتر) في Pushwoosh. يستخدم هذا الرمز في استدعاءات API، ومنطق الأتمتة، وقواعد التقسيم الديناميكي.

أين تجده

• عبر طريقة API /listFilters.

• في شريط العنوان عند عرض شريحة في لوحة تحكم Pushwoosh:

مثال:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/segments/XXXE9-XXX49/detail رمز الشريحة: XXXE9-XXX49

Tag

سمة مخصصة يتم تعيينها للمستخدمين أو الأجهزة. تستخدم للتقسيم الديناميكي والتخصيص. اعرف المزيد

أين تجده

لوحة تحكم Pushwoosh ← العلامات أو عبر واجهة برمجة التطبيقات /getTags.

معرفات الحدث

Event name

اسم حدث يتم تتبعه (على سبيل المثال، purchase، login، subscription). يستخدم لتشغيل تدفقات العمل الآلية أو للتحليلات. اعرف المزيد

أين تجده

لوحة تحكم Pushwoosh ← الجمهور ← الأحداث.

معرفات الموقع الجغرافي

Geozone ID

يحدد منطقة جغرافية مسيجة تستخدم لتشغيل الإشعارات المستندة إلى الموقع. اعرف المزيد

أين تجده

لوحة تحكم Pushwoosh ← المناطق الجغرافية.