보안 처리된 신호 어댑터 만들기

보안 처리된 신호는 클라이언트 기기에서 수집하여 일부 입찰자와 공유하는 인코딩된 데이터입니다. 이 페이지에서는 IMA (Interactive Media Ads) 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에서 작동하도록 어댑터를 설계할 수 있습니다. 어댑터가 여러 버전에서 작동하려면 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. 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]);
  }
}