یک آداپتور سیگنال امن ایجاد کنید، یک آداپتور سیگنال امن ایجاد کنید

پلتفرم مورد نظر را انتخاب کنید: اندروید، iOS

سیگنال‌های امن، داده‌های رمزگذاری‌شده‌ای هستند که یک دستگاه کلاینت جمع‌آوری کرده و با پیشنهاددهندگان منتخب به اشتراک می‌گذارد. این صفحه شما را در جمع‌آوری و ارسال سیگنال‌های امن به Google Ad Manager با استفاده از SDK تبلیغات رسانه‌ای تعاملی (IMA) راهنمایی می‌کند.

قبل از اینکه شروع کنی

قبل از ادامه، مطمئن شوید که IMA SDK for Android نسخه ۳.۲۹.۰ یا بالاتر را دارید.

رابط آداپتور سیگنال امن را ایجاد کنید

برای جمع‌آوری و ارائه سیگنال‌های امن، کلاس‌هایی ایجاد کنید که رابط را پیاده‌سازی می‌کنند:

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 هر آداپتور را یک بار با فراخوانی متد initialization آن آداپتور، مقداردهی اولیه می‌کند. این متد را برای شروع هرگونه وابستگی رمزگذاری، تنظیم حافظه‌های پنهان یا پیش‌محاسبه هر سیگنالی که در تمام فراخوانی‌های جمع‌آوری سیگنال ثابت می‌ماند، پیاده‌سازی کنید.

مثال زیر آداپتور را مقداردهی اولیه می‌کند:

  ...
  /**
   * 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 شما کار کند. برای اینکه آداپتور با چندین نسخه کار کند، تأیید کنید که نسخه زمان اجرا 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]);
  }
  ...

آداپتور را در گوگل ثبت کنید

برای اینکه گوگل به آداپتور اجازه جمع‌آوری سیگنال بدهد، باید نام بسته اندروید یا آن را در گوگل ثبت کنید. IMA SDK فقط آداپتورهایی را که در گوگل ثبت می‌کنید، مقداردهی اولیه می‌کند.

آداپتور را تأیید کنید

برای تأیید آداپتور، بخش‌های زیر را تکمیل کنید:

پیکربندی برنامه آزمایشی

قبل از اعتبارسنجی آداپتور، برنامه آزمایشی را پیکربندی کنید. مراحل زیر را انجام دهید:

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