สร้างอะแดปเตอร์สัญญาณที่ปลอดภัย

สัญญาณที่ปลอดภัยคือข้อมูลที่เข้ารหัสซึ่งอุปกรณ์ไคลเอ็นต์รวบรวมและแชร์กับผู้เสนอราคาบางราย หน้านี้จะแนะนําคุณเกี่ยวกับการรวบรวมและส่งสัญญาณที่ปลอดภัยไปยัง 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 จะเริ่มต้นอะแดปเตอร์แต่ละตัว 1 ครั้งโดยเรียกใช้เมธอดการเริ่มต้น ของอะแดปเตอร์ ใช้เมธอดนี้เพื่อเริ่มการอ้างอิงการเข้ารหัส ตั้งค่าแคช หรือคำนวณล่วงหน้าสำหรับสัญญาณที่ยังคงเหมือนเดิมในการเรียกใช้การรวบรวมสัญญาณทั้งหมด

ตัวอย่างต่อไปนี้เริ่มต้นใช้งานอแดปเตอร์

  ...
  /**
   * 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 หรือทรัพยากร Dependency ในแอปพลิเคชัน
  • SDK หรือ Dependency ของคุณไม่มีสิทธิ์หรือความยินยอมจากผู้ใช้ที่จำเป็นในการทำงาน

ระบุเวอร์ชันของอะแดปเตอร์

ในเวิร์กโฟลว์ ให้ตรวจสอบว่าคุณได้ระบุเวอร์ชันของอแดปเตอร์แล้ว 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

หากต้องการให้ Google อนุญาตอะแดปเตอร์สำหรับการรวบรวมสัญญาณ คุณต้องลงทะเบียนชื่อแพ็กเกจ Android หรือ กับ Google IMA SDK จะเริ่มต้นเฉพาะอะแดปเตอร์ที่คุณลงทะเบียนกับ Google เท่านั้น

ตรวจสอบอะแดปเตอร์

หากต้องการตรวจสอบความถูกต้องของอแดปเตอร์ ให้ทําตามส่วนต่อไปนี้

กำหนดค่าแอปพลิเคชันทดสอบ

ก่อนตรวจสอบอะแดปเตอร์ ให้กำหนดค่าแอปพลิเคชันทดสอบ ทำตาม ขั้นตอนต่อไปนี้

  1. เพิ่มทรัพยากร Dependency สำหรับ 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]);
  }
}