सुरक्षित सिग्नल अडैप्टर बनाना

सुरक्षित सिग्नल, कोड में बदले गए उस डेटा को कहते हैं जिसे क्लाइंट डिवाइस, चुनिंदा लोगों के साथ इकट्ठा और शेयर करता है बिड करने वालों को ध्यान में रखकर बनाया गया है. इस पेज पर, इंटरैक्टिव मीडिया विज्ञापन (IMA) SDK टूल का इस्तेमाल करके, Google Ad Manager को सुरक्षित सिग्नल इकट्ठा करने और भेजने के बारे में बताया गया है.

शुरू करने से पहले

आगे बढ़ने से पहले, पक्का करें कि आपके पास Android के लिए IMA SDK टूल का v3.29.0 या इसके बाद का वर्शन हो.

सुरक्षित सिग्नल अडैप्टर इंटरफ़ेस बनाएं

सुरक्षित सिग्नल इकट्ठा करने और उपलब्ध कराने के लिए, ऐसी क्लास बनाएं जो इंटरफ़ेस:

package companydomain.path.to.securesignals;
import android.content.Context;
import androidx.annotation.Keep;
import com.google.ads.interactivemedia.v3.api.signals.SecureSignalsAdapter;

/**
 * An example implementation of Secure Signals adapter.
 */
@Keep
public final class MySecureSignalsAdapter implements SecureSignalsAdapter {
  /**
   * Default constructor with no arguments for IMA SDK to instantiate this class.
   */
  public MySecureSignalsAdapter() {
  }
}

अडैप्टर को शुरू करना

IMA SDK टूल, अडैप्टर के शुरू करने के तरीके को कॉल करके, हर अडैप्टर को एक बार शुरू करता है. किसी भी एन्क्रिप्शन डिपेंडेंसी को शुरू करने के लिए यह तरीका लागू करें कैश मेमोरी में सेव करने या किसी भी सिग्नल में एक जैसे बने रहने वाले सिग्नल का पहले से आकलन करके कलेक्शन कॉल का जवाब देने के लिए किया जा सकता है.

यहां दिए गए उदाहरण में, अडैप्टर को शुरू किया गया है:

  ...
  /**
   * Initialize your SDK and any dependencies.
   * IMA SDK calls this function exactly once before signal collection.
   *
   * @param context  The activity context that creates an ads loader.
   * @param callback A callback function to pass initialization results to IMA SDK.
   */
  @Override
  public void initialize(Context context, SecureSignalsInitializeCallback callback) {
    // Initialize your SDK and any dependencies.
    ...

    // Notify IMA SDK of initialization success.
    callback.onSuccess();

    // If signal collection fails, call callback.onFailure();
    // callback.onFailure(new Exception("Signal collection failed."));
  }
  ...

सिग्नल कलेक्शन

विज्ञापन अनुरोध शुरू होने से पहले, IMA SDK, सिग्नल इकट्ठा करने के तरीके को असाइनोक्रोनस तरीके से कॉल करता है. इन सिग्नल कलेक्टर तरीकों में, कॉलबैक फ़ंक्शन होता है एन्क्रिप्ट किए गए सिग्नल पास करें या किसी गड़बड़ी की शिकायत करें.

नीचे दिए गए उदाहरण, कॉलबैक के ज़रिए सुरक्षित सिग्नल इकट्ठा करते हैं फ़ंक्शन:

  ...
  /**
   * Invokes your SDK to collect, encrypt and pass the signal collection results to IMA SDK.
   * IMA SDK calls this function before each ad request.
   *
   * @param context  The activity context that creates an ads loader.
   * @param callback A callback function to pass signal collection results to IMA SDK.
   */
  @Override
  public void collectSignals(Context context, SecureSignalsCollectSignalsCallback callback) {

    try {
      // Collect and encrypt the signals.
      String signals = ...;

      // Pass the encrypted signals to IMA SDK.
      callback.onSuccess(signals);
    } catch (Exception e) {
      // Pass signal collection failures to IMA SDK.
      callback.onFailure(e);
    }
  }
  ...

गड़बड़ियों की शिकायत करना

आपकी अडैप्टर क्लास का इस्तेमाल करने वाले उपयोगकर्ताओं से संपर्क करने के लिए, सिग्नल इकट्ठा करने के दौरान हुई सभी गड़बड़ियों की शिकायत करें और उन्हें सिग्नल कलेक्टर कॉलबैक को भेजें. इस प्रोसेस से, ऐप्लिकेशन में अडैप्टर को इंटिग्रेट करने के दौरान आने वाली समस्याओं को हल किया जाता है.

ये गड़बड़ियां दिख सकती हैं:

  • ऐप्लिकेशन में आपका SDK टूल या कोई डिपेंडेंसी नहीं मिली.
  • आपके SDK टूल या डिपेंडेंसी के पास काम करने के लिए, ज़रूरी अनुमति या उपयोगकर्ता की सहमति नहीं है.

अडैप्टर का वर्शन बताएं

अपने वर्कफ़्लो में, पक्का करें कि आपने अडैप्टर का वर्शन बताया हो. IMA SDK टूल, हर विज्ञापन अनुरोध में आपके अडैप्टर वर्शन को शामिल करता है और उन्हें बिड रिक्वेस्ट में सुरक्षित सिग्नल के साथ पास करता है.

बिड रिक्वेस्ट में, अडैप्टर वर्शन के आधार पर, एन्क्रिप्शन, कोड में बदलने, और फ़ॉर्मैटिंग की जानकारी की पहचान की जा सकती है. अडैप्टर, सुरक्षित सिग्नल बनाने के लिए इनका इस्तेमाल करता है.

नीचे दिए गए उदाहरण में अडैप्टर वर्शन के बारे में बताया गया है:

  ...
  /**
   * Specifies this adapter's version.
   */
  private static final VersionInfo AdapterVersion = new VersionInfo(1, 0, 1);
  ...
  /**
   * @return The version of this adapter.
   *         IMA SDK calls this function before each ad request.
   */
  @Override
  public VersionInfo getVersion() {
    return AdapterVersion;
  }
  ...

SDK टूल के रनटाइम का वर्शन दिखाएं

अपने SDK टूल के कई वर्शन के साथ काम करने के लिए, अडैप्टर को डिज़ाइन किया जा सकता है. अडैप्टर कई वर्शन के साथ काम करता है, तो पक्का करें कि आप का इस्तेमाल किया है. हर विज्ञापन अनुरोध में, IMA SDK टूल, एडेप्टर वर्शन के साथ रनटाइम वर्शन शामिल करता है.

SDK टूल के रनटाइम वर्शन के लिए अनुरोध करने और रिटर्न के इन उदाहरणों के बारे में यहां बताया गया है:

  ...
  /**
   * @return The version of your SDK that this adapter is depending on.
   *         IMA SDK calls this function before each ad request.
   */
  @Override
  public VersionInfo getSDKVersion() {
    // Request the version from your SDK and convert to an IMAVersion.
    int[] mySDKVersion = ...;

    return new VersionInfo(mySDKVersion[0], mySDKVersion[1], mySDKVersion[2]);
  }
  ...

अडैप्टर को Google के साथ रजिस्टर करना

Google, सिग्नल इकट्ठा करने के लिए अडैप्टर को अनुमति दे सके, इसके लिए आपको Google के साथ Android पैकेज का नाम या डिवाइस का नाम रजिस्टर करना होगा. IMA SDK टूल सिर्फ़ उन अडैप्टर को शुरू करता है जिन्हें Google के साथ रजिस्टर किया जाता है.

अडैप्टर की पुष्टि करना

अडैप्टर की पुष्टि करने के लिए, नीचे दिए गए सेक्शन को पूरा करें:

टेस्ट ऐप्लिकेशन कॉन्फ़िगर करें

अडैप्टर की पुष्टि करने से पहले, टेस्ट ऐप्लिकेशन कॉन्फ़िगर करें. इसे पूरा करें इसके लिए, नीचे दिया गया तरीका अपनाएं:

  1. IMA SDK के लिए डिपेंडेंसी को ऐप्लिकेशन-लेवल की Gradle फ़ाइल में जोड़ें मॉड्यूल, जैसे कि app/build.gradle:

    dependencies {
      implementation 'com.google.ads.interactivemedia.v3:interactivemedia:3.29.0'
    }
    
  2. बिल्ड डिपेंडेंसी जोड़ें, जैसे कि आपका अडैप्टर और SDK टूल.

सिग्नल की पुष्टि करना

यह पुष्टि करने के लिए कि आपका अडैप्टर सिग्नल भेजता है, विज्ञापन को मॉनिटर करने के लिए नेटवर्क प्रॉक्सी का इस्तेमाल करें आपके ऐप्लिकेशन के ट्रैफ़िक का अनुरोध करता है. सफल होने पर, आपको प्रत्येक विज्ञापन अनुरोध.

सभी उदाहरणों की समीक्षा करें

इस सेक्शन में, सभी चरणों का पूरा उदाहरण दिया गया है. यह आपके रेफ़रंस के लिए उपलब्ध है.

package companydomain.path.to.securesignals;
import android.content.Context;
import androidx.annotation.Keep;
import com.google.ads.interactivemedia.v3.api.VersionInfo;
import com.google.ads.interactivemedia.v3.api.signals.SecureSignalsAdapter;
import com.google.ads.interactivemedia.v3.api.signals.SecureSignalsCollectSignalsCallback;
import com.google.ads.interactivemedia.v3.api.signals.SecureSignalsInitializeCallback;

/**
 * An example implementation of Secure Signals adapter.
 */
@Keep
public final class MySecureSignalsAdapter implements SecureSignalsAdapter {
  /**
   * Specifies this adapter's version.
   */
  private static final VersionInfo AdapterVersion = new VersionInfo(1, 0, 1);
  /**
   * Default constructor with no arguments for IMA SDK to instantiate this class.
   */
  public MySecureSignalsAdapter() {
  }
  /**
   * Initialize your SDK and any dependencies.
   * IMA SDK calls this function exactly once before signal collection.
   *
   * @param context  The activity context that creates an ads loader.
   * @param callback A callback function to pass initialization results to IMA SDK.
   */
  @Override
  public void initialize(Context context, SecureSignalsInitializeCallback callback) {
    try {
      // Initialize your SDK and any dependencies.
      ...

      // Notify IMA SDK of initialization success.
      callback.onSuccess();
    } catch (Exception e) {
      // Pass initialization failures to IMA SDK.
      callback.onFailure(e);
    }
  }
  /**
   * Invokes your SDK to collect, encrypt and send the signal collection results to IMA SDK.
   * IMA SDK calls this function before each ad request.
   *
   * @param context  The activity context that creates an ads loader.
   * @param callback A callback function to pass signal collection results to IMA SDK.
   */
  @Override
  public void collectSignals(Context context, SecureSignalsCollectSignalsCallback callback) {
    try {
      // Collect and encrypt the signals.
      String signals = ...;

      // Pass the encrypted signals to IMA SDK.
      callback.onSuccess(signals);
    } catch (Exception e) {
      // Pass signal collection failures to IMA SDK.
      callback.onFailure(e);
    }
  }
  /**
   * @return The version of this adapter.
   * IMA SDK calls this function before each ad request.
   */
  @Override
  public VersionInfo getVersion() {
    return AdapterVersion;
  }
  /**
   * @return The version of your SDK that this adapter is depending on.
   * IMA SDK calls this function before each ad request.
   */
  @Override
  public VersionInfo getSDKVersion() {
    // Request the version from your SDK and convert to an IMAVersion.
    int[] mySDKVersion = ...;
    return new VersionInfo(mySDKVersion[0], mySDKVersion[1], mySDKVersion[2]);
  }
}