यूनिटी SDK बेसिक इंटीग्रेशन गाइड

यह गाइड आपको अपने एप्लिकेशन में Pushwoosh यूनिटी SDK को इंटीग्रेट करने की प्रक्रिया के बारे में बताती है।

पूर्वापेक्षाएँ

आवश्यकताएँ

• एक Pushwoosh अकाउंट।
• आपके अकाउंट में एक Pushwoosh प्रोजेक्ट सेटअप होना चाहिए।
• यूनिटी 2021.3 या बाद का संस्करण।
• iOS के लिए:
  • पुश नोटिफिकेशन भेजने के लिए कॉन्फ़िगर किया गया एक iOS प्लेटफ़ॉर्म। हम सबसे सरल तरीके के रूप में टोकन-आधारित प्रमाणीकरण का उपयोग करने की सलाह देते हैं।
  • सिम्युलेटर पर पुश भेजने के लिए गेटवे को Sandbox पर सेट करें।
• एंड्रॉइड के लिए:
  • एक कॉन्फ़िगर किया गया एंड्रॉइड प्लेटफ़ॉर्म।
  • आपके फायरबेस प्रोजेक्ट से project number (जिसे सेंडर आईडी भी कहा जाता है), google-services.json फ़ाइल, और package name।
  • आपके एंड्रॉइड एप्लिकेशन से जुड़ा एक फायरबेस प्रोजेक्ट। यदि आवश्यक हो तो फायरबेस सेटअप गाइड का पालन करें।
• Pushwoosh कंट्रोल पैनल से आपका Pushwoosh Application Code और Pushwoosh डिवाइस API टोकन।

इंटीग्रेशन के चरण

1. Pushwoosh यूनिटी SDK जोड़ें

स्कोप्ड रजिस्ट्री के माध्यम से UPM (अनुशंसित)

अपने Packages/manifest.json में निम्नलिखित जोड़ें:

Packages/manifest.json

{
  "dependencies": {
    "com.pushwoosh.unity.core": "6.2.7",
    "com.pushwoosh.unity.android": "6.2.7",
    "com.pushwoosh.unity.ios": "6.2.7"
  },
  "scopedRegistries": [
    {
      "name": "npmjs",
      "url": "https://registry.npmjs.org",
      "scopes": ["com.pushwoosh"]
    }
  ]
}

केवल उन्हीं प्लेटफ़ॉर्म पैकेजों को जोड़ें जिनकी आपको आवश्यकता है। उदाहरण के लिए, यदि आप केवल iOS को लक्षित करते हैं तो com.pushwoosh.unity.android को छोड़ दें।

Git URL के माध्यम से UPM

यूनिटी में, Window > Package Manager > + > Add package from git URL पर जाएं और निम्नलिखित URL एक-एक करके जोड़ें:

https://github.com/Pushwoosh/pushwoosh-unity.git?path=com.pushwoosh.unity.core
https://github.com/Pushwoosh/pushwoosh-unity.git?path=com.pushwoosh.unity.android
https://github.com/Pushwoosh/pushwoosh-unity.git?path=com.pushwoosh.unity.ios

.unitypackage

GitHub रिलीज़ से Pushwoosh.unitypackage डाउनलोड करें और Assets > Import Package > Custom Package के माध्यम से इम्पोर्ट करें।

2. एक्सटर्नल डिपेंडेंसी मैनेजर इंस्टॉल करें

SDK को नेटिव एंड्रॉइड और iOS डिपेंडेंसी को हल करने के लिए यूनिटी के लिए एक्सटर्नल डिपेंडेंसी मैनेजर (EDM4U) की आवश्यकता होती है।

अपने Packages/manifest.json में निम्नलिखित स्कोप्ड रजिस्ट्री जोड़ें:

{
  "scopedRegistries": [
    {
      "name": "package.openupm.com",
      "url": "https://package.openupm.com",
      "scopes": ["com.google.external-dependency-manager"]
    }
  ]
}

फिर पैकेज को अपनी डिपेंडेंसी में जोड़ें:

"com.google.external-dependency-manager": "1.2.183"

3. SDK को इनिशियलाइज़ करें

एक PushNotificator.cs स्क्रिप्ट बनाएं और इसे सीन में किसी भी GameObject से अटैच करें:

PushNotificator.cs

using UnityEngine;
using System.Collections.Generic;

public class PushNotificator : MonoBehaviour
{
    void Start()
    {
        Pushwoosh.ApplicationCode = "XXXXX-XXXXX";
        Pushwoosh.FcmProjectNumber = "XXXXXXXXXXXX";

        Pushwoosh.Instance.OnRegisteredForPushNotifications += (token) => {
            Debug.Log("Push token: " + token);
        };

        Pushwoosh.Instance.OnFailedToRegisteredForPushNotifications += (error) => {
            Debug.Log("Registration failed: " + error);
        };

        Pushwoosh.Instance.RegisterForPushNotifications();
    }
}

बदलें:

• XXXXX-XXXXX को अपने Pushwoosh एप्लीकेशन कोड से।
• XXXXXXXXXXXX को अपने फायरबेस प्रोजेक्ट नंबर से (केवल एंड्रॉइड)।

4. iOS नेटिव सेटअप

4.1 कैपेबिलिटीज़

यूनिटी से iOS प्रोजेक्ट बनाने के बाद, जेनरेट किए गए Xcode प्रोजेक्ट को खोलें और Signing & Capabilities में निम्नलिखित कैपेबिलिटीज़ जोड़ें:

• पुश नोटिफिकेशन
• बैकग्राउंड मोड जिसमें रिमोट नोटिफिकेशन चेक किया गया हो

टाइम सेंसिटिव नोटिफिकेशन (iOS 15+) के लिए, टाइम सेंसिटिव नोटिफिकेशन कैपेबिलिटी भी जोड़ें।

4.2 Info.plist

अपने Info.plist में Pushwoosh डिवाइस API टोकन जोड़ें:

Info.plist

<key>Pushwoosh_API_TOKEN</key>
<string>__PUSHWOOSH_DEVICE_API_TOKEN__</string>

4.3 संदेश डिलीवरी ट्रैकिंग

अपने Xcode प्रोजेक्ट में एक नोटिफिकेशन सर्विस एक्सटेंशन टारगेट जोड़ें। यह iOS पर सटीक डिलीवरी ट्रैकिंग और रिच मीडिया के लिए आवश्यक है।

एक्सटेंशन टारगेट जोड़ने के लिए नेटिव गाइड का पालन करें।

5. एंड्रॉइड नेटिव सेटअप

5.1 फायरबेस कॉन्फ़िगरेशन फ़ाइल जोड़ें

google-services.json फ़ाइल को अपने यूनिटी प्रोजेक्ट की Assets डायरेक्टरी में रखें।

5.2 Pushwoosh मेटाडेटा जोड़ें

<application> टैग के अंदर अपने Assets/Plugins/Android/AndroidManifest.xml में Pushwoosh डिवाइस API टोकन जोड़ें:

AndroidManifest.xml

<meta-data android:name="com.pushwoosh.apitoken" android:value="__YOUR_DEVICE_API_TOKEN__" />

सावधानी

सुनिश्चित करें कि आप अपने Pushwoosh कंट्रोल पैनल में टोकन को सही ऐप का एक्सेस दें। और जानें

6. प्रोजेक्ट चलाएँ

1. अपने लक्षित प्लेटफ़ॉर्म पर प्रोजेक्ट को बनाएँ और चलाएँ।
2. पूछे जाने पर पुश नोटिफिकेशन के लिए अनुमति दें।
3. Pushwoosh कंट्रोल पैनल पर जाएं और एक पुश नोटिफिकेशन भेजें।

विस्तारित इंटीग्रेशन

इस स्तर पर, आप पुश नोटिफिकेशन भेज और प्राप्त कर सकते हैं। नीचे दिए गए अनुभाग SDK की मुख्य कार्यक्षमता को कवर करते हैं।

पुश नोटिफिकेशन इवेंट लिसनर्स

SDK पुश नोटिफिकेशन को संभालने के लिए दो इवेंट लिसनर प्रदान करता है:

• OnPushNotificationsReceived — जब कोई पुश नोटिफिकेशन आता है तो ट्रिगर होता है
• OnPushNotificationsOpened — जब कोई उपयोगकर्ता किसी नोटिफिकेशन पर टैप करता है तो ट्रिगर होता है

SDK इनिशियलाइज़ेशन के दौरान इन लिसनर्स को सेट करें:

PushNotificator.cs

void Start()
{
    Pushwoosh.ApplicationCode = "XXXXX-XXXXX";
    Pushwoosh.FcmProjectNumber = "XXXXXXXXXXXX";

    Pushwoosh.Instance.OnPushNotificationsReceived += (payload) => {
        Debug.Log("Push received: " + payload);
    };

    Pushwoosh.Instance.OnPushNotificationsOpened += (payload) => {
        Debug.Log("Push opened: " + payload);
    };

    Pushwoosh.Instance.RegisterForPushNotifications();
}

उपयोगकर्ता कॉन्फ़िगरेशन

उपयोगकर्ताओं की पहचान करके और उनके गुणों को सेट करके पुश नोटिफिकेशन को व्यक्तिगत बनाएं:

// Set user ID for cross-device tracking
Pushwoosh.Instance.SetUserId("user-123");

// Set user email
Pushwoosh.Instance.SetEmail("user@example.com");

// Set user with both ID and email
Pushwoosh.Instance.SetUser("user-123", new List<string> { "user@example.com" });

// Set preferred language
Pushwoosh.Instance.SetLanguage("en");

टैग्स

टैग्स डिवाइस को असाइन किए गए की-वैल्यू पेयर होते हैं, जो उपयोगकर्ता सेगमेंटेशन और लक्षित संदेश भेजने में सक्षम बनाते हैं:

// String tag
Pushwoosh.Instance.SetStringTag("favorite_category", "electronics");

// Integer tag
Pushwoosh.Instance.SetIntTag("purchase_count", 5);

// List tag
Pushwoosh.Instance.SetListTag("interests", new List<object> { "sports", "music", "tech" });

// Get all tags
Pushwoosh.Instance.GetTags((tags, error) => {
    if (error != null) {
        Debug.Log("Error: " + error.Message);
        return;
    }
    foreach (var tag in tags) {
        Debug.Log(tag.Key + ": " + tag.Value);
    }
});

इवेंट्स

व्यवहार का विश्लेषण करने और स्वचालित संदेशों को ट्रिगर करने के लिए उपयोगकर्ता की कार्रवाइयों को ट्रैक करें:

// Track a login event
Pushwoosh.Instance.PostEvent("login", new Dictionary<string, object> {
    { "username", "user-123" },
    { "login_type", "email" }
});

// Track a purchase event
Pushwoosh.Instance.PostEvent("purchase", new Dictionary<string, object> {
    { "product_id", "SKU-001" },
    { "price", 29.99 },
    { "currency", "USD" }
});

संचार प्राथमिकताएँ

उपयोगकर्ताओं को प्रोग्रामेटिक रूप से पुश नोटिफिकेशन के लिए ऑप्ट-इन या ऑप्ट-आउट करने की अनुमति दें:

// Enable communication
Pushwoosh.Instance.SetCommunicationEnabled(true);

// Disable communication
Pushwoosh.Instance.SetCommunicationEnabled(false);

// Check current state
bool isEnabled = Pushwoosh.Instance.IsCommunicationEnabled();

बैज प्रबंधन

समर्थित प्लेटफ़ॉर्म पर ऐप बैज नंबर को नियंत्रित करें:

// Set badge to a specific number
Pushwoosh.Instance.SetBadgeNumber(3);

// Increment badge
Pushwoosh.Instance.AddBadgeNumber(1);

// Clear badge
Pushwoosh.Instance.SetBadgeNumber(0);

समस्या निवारण

यदि आपको इंटीग्रेशन प्रक्रिया के दौरान कोई समस्या आती है, तो समर्थन और समुदाय अनुभाग देखें।