با ارائه دهندگان سیگنال امن شروع کنید

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

قبل از شروع

قبل از ادامه، مطمئن شوید که IMA SDK برای Android نسخه 3.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 یک روش سیگنال جمع آوری را به صورت ناهمزمان فراخوانی می کند. این روش‌های جمع‌آوری سیگنال حاوی یک تابع تماس برای ارسال سیگنال‌های رمزگذاری‌شده یا گزارش خطا هستند.

مثال‌های زیر سیگنال‌های ایمن را از طریق تابع callback جمع‌آوری می‌کنند: 

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

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

برای اینکه Google به آداپتور برای جمع آوری سیگنال مجوز دهد، باید نام بسته Android یا در Google ثبت کنید. 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]);
  }
}