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

प्लैटफ़ॉर्म चुनें: Android iOS

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

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

जारी रखने से पहले, पुष्टि करें कि आपके पास Android v3.29.0 या इसके बाद के वर्शन के लिए IMA SDK मौजूद है.

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

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

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);
    }
  }
  ...

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

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

आपको इस तरह की गड़बड़ियां दिख सकती हैं:

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

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

अपने वर्कफ़्लो में, पुष्टि करें कि आपने अडैप्टर का वर्शन बताया है. 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, अडैप्टर के वर्शन के साथ रनटाइम वर्शन को शामिल करता है.

यहां दिए गए उदाहरणों में, एसडीके रनटाइम के वर्शन का अनुरोध किया गया है और उसे दिखाया गया है:

  ...
  /**
   * @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 पैकेज का नाम या iOS बंडल आईडी रजिस्टर करना होगा. IMA SDK, सिर्फ़ उन अडैप्टर को शुरू करता है जिन्हें आपने Google के साथ रजिस्टर किया है.

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

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

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

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

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

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

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

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

पूरी तरह से तैयार उदाहरणों की समीक्षा करना

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

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]);
  }
}