ピクチャー イン ピクチャー広告（ベータ版）を実装する

プラットフォームを選択: Android iOS

ピクチャー イン ピクチャー

ピクチャー イン ピクチャー（PiP）広告は、記事、フィード、ゲームプレイなど、画面上のコンテンツの上に重ねて表示されるフローティング ウィンドウに表示されます。このフォーマットでは、広告が表示されていても、ユーザーはアプリを操作できます。画面全体に表示されない広告の場合は、このフォーマットを選択してください。

このガイドでは、GMA Next-Gen SDK を使用してアプリでピクチャー イン ピクチャー広告をリクエストして表示する方法について説明します。

始める前に

続行する前に、次のことを実施してください。

広告を読み込む

PictureInPictureAd オブジェクトを読み込むには、広告リクエストを作成して load メソッドを呼び出します。

Kotlin

private fun loadPictureInPictureAd() {
  val request = PictureInPictureAdRequest.Builder(AD_UNIT_ID).build()

  PictureInPictureAd.load(
    request,
    object : AdLoadCallback<PictureInPictureAd> {
      override fun onAdFailedToLoad(adError: LoadAdError) {
        Log.w(TAG, "Picture-in-Picture ad failed to load: $adError")
      }

      override fun onAdLoaded(ad: PictureInPictureAd) {
        Log.d(TAG, "Picture-in-Picture ad loaded.")

        // Capture the PictureInPictureAd reference for later use.
        pipAd = ad
        setAdEventCallback(ad)
      }
    },
  )
}

Java

private void loadPictureInPictureAd() {
  PictureInPictureAdRequest request = new PictureInPictureAdRequest.Builder(AD_UNIT_ID).build();

  PictureInPictureAd.load(
      request,
      new AdLoadCallback<PictureInPictureAd>() {
        @Override
        public void onAdFailedToLoad(@NonNull LoadAdError adError) {
          Log.w(TAG, "Picture-in-Picture ad failed to load: " + adError);
        }

        @Override
        public void onAdLoaded(@NonNull PictureInPictureAd ad) {
          Log.d(TAG, "Picture-in-Picture ad loaded.");

          // Capture the PictureInPictureAd reference for later use.
          pipAd = ad;
          setAdEventCallback(ad);
        }
      });
}

AD_UNIT_ID は、実際の広告ユニット ID に置き換えてください。

広告を表示する

ピクチャー イン ピクチャー広告を画面に表示するには、ピクチャー イン ピクチャー オプションを設定し、show メソッドを呼び出します。次の例では、画面に対する広告のデフォルトの位置とプレゼンテーション スコープを設定しています。

Kotlin

private fun showPictureInPictureAd(activity: Activity) {
  // Capture the ad reference saved from the onAdLoaded callback.
  val ad = pipAd
  if (ad != null) {
    val options =
      PictureInPictureAdOptions.Builder()
        // Uses the Google Mobile Ads SDK's default screen position.
        .setPosition(PictureInPictureAdPosition.DEFAULT)
        // Binds the ad lifecycle to the host screen.
        .setPresentationScope(PictureInPictureAdPresentationScope.SCREEN)
        .build()
    ad.show(activity, options)
  } else {
    Log.d(TAG, "No ad to show.")
  }
}

Java

private void showPictureInPictureAd(@NonNull Activity activity) {
  // Use the ad reference saved from the onAdLoaded callback.
  if (pipAd != null) {
    PictureInPictureAdOptions options =
        new PictureInPictureAdOptions.Builder()
            // Uses the Google Mobile Ads SDK's default screen position.
            .setPosition(PictureInPictureAdPosition.DEFAULT)
            // Binds the ad lifecycle to the host screen.
            .setPresentationScope(PictureInPictureAdPresentationScope.SCREEN)
            .build();
    pipAd.show(activity, options);
  } else {
    Log.d(TAG, "No ad to show.");
  }
}

位置を設定する

デフォルトでは、GMA Next-Gen SDK は、最初に表示するときは画面の右下、以前に表示されたことがある場合は最後に確認された位置にピクチャー イン ピクチャー広告を表示します。広告の表示位置をカスタマイズするには、ピクチャー イン ピクチャーのオプションで位置を設定します。次の例では、コンテンツに重ねた、画面の左上の位置を設定しています。

Kotlin

private fun createTopLeftPositionOptions(): PictureInPictureAdOptions {
  return PictureInPictureAdOptions.Builder()
    // Sets the ad position to the top-left corner of the screen.
    .setPosition(PictureInPictureAdPosition.TOP_LEFT)
    .build()
}

Java

private PictureInPictureAdOptions createTopLeftPositionOptions() {
  return new PictureInPictureAdOptions.Builder()
      // Sets the ad position to the top-left corner of the screen.
      .setPosition(PictureInPictureAdPosition.TOP_LEFT)
      .build();
}

使用可能なすべての位置については、PictureInPictureAdPosition をご覧ください。

プレゼンテーション スコープを設定する

デフォルトでは、GMA Next-Gen SDK はピクチャー イン ピクチャー広告を現在のホスト画面にバインドします。GMA Next-Gen SDK は、ホスト画面のビュー階層がメモリから削除されると、広告を閉じます。ホスト画面がメモリから削除された後も広告を表示したままにするには、プレゼンテーション スコープをアプリに設定します。

Kotlin

private fun createApplicationScopedOptions(): PictureInPictureAdOptions {
  return PictureInPictureAdOptions.Builder()
    // Keeps the ad visible beyond the host screen's lifecycle.
    .setPresentationScope(PictureInPictureAdPresentationScope.APPLICATION)
    .build()
}

Java

private PictureInPictureAdOptions createApplicationScopedOptions() {
  return new PictureInPictureAdOptions.Builder()
      // Keeps the ad visible beyond the host screen's lifecycle.
      .setPresentationScope(PictureInPictureAdPresentationScope.APPLICATION)
      .build();
}

詳しくは、画面を切り替えても広告を表示したままにするをご覧ください。

広告イベントのコールバックを設定する

ピクチャー イン ピクチャー広告のライフサイクル イベントを処理するには、広告を表示する前に広告にイベント コールバックを設定します。このコールバックが、クリックやインプレッションなどの標準イベントをレポートします。また、広告の表示や非表示など、ピクチャー イン ピクチャー固有のイベントもレポートします。

Kotlin

private fun setAdEventCallback(pipAd: PictureInPictureAd) {
  pipAd.adEventCallback =
    object : PictureInPictureAdEventCallback {
      override fun onAdShown() {
        Log.d(TAG, "Picture-in-Picture ad shown.")
      }

      override fun onAdHidden() {
        Log.d(TAG, "Picture-in-Picture ad hidden.")
      }

      override fun onAdImpression() {
        Log.d(TAG, "Picture-in-Picture ad recorded an impression.")
      }

      override fun onAdClicked() {
        Log.d(TAG, "Picture-in-Picture ad recorded a click.")
      }

      override fun onAdShowedFullScreenContent() {
        Log.d(TAG, "Picture-in-Picture ad showed full screen content.")
      }

      override fun onAdDismissedFullScreenContent() {
        Log.d(TAG, "Picture-in-Picture ad dismissed full screen content.")
      }

      override fun onAdFailedToShowFullScreenContent(
        fullScreenContentError: FullScreenContentError
      ) {
        Log.w(
          TAG,
          "Picture-in-Picture ad failed to show full screen content: $fullScreenContentError",
        )
      }

      override fun onAdPaid(value: AdValue) {
        Log.d(TAG, "Picture-in-Picture ad paid: ${value.valueMicros} ${value.currencyCode}")
      }
    }
}

Java

private void setAdEventCallback(@NonNull PictureInPictureAd pipAd) {
  pipAd.setAdEventCallback(
      new PictureInPictureAdEventCallback() {
        @Override
        public void onAdShown() {
          Log.d(TAG, "Picture-in-Picture ad shown.");
        }

        @Override
        public void onAdHidden() {
          Log.d(TAG, "Picture-in-Picture ad hidden.");
        }

        @Override
        public void onAdImpression() {
          Log.d(TAG, "Picture-in-Picture ad recorded an impression.");
        }

        @Override
        public void onAdClicked() {
          Log.d(TAG, "Picture-in-Picture ad recorded a click.");
        }

        @Override
        public void onAdShowedFullScreenContent() {
          Log.d(TAG, "Picture-in-Picture ad showed full screen content.");
        }

        @Override
        public void onAdDismissedFullScreenContent() {
          Log.d(TAG, "Picture-in-Picture ad dismissed full screen content.");
        }

        @Override
        public void onAdFailedToShowFullScreenContent(
            @NonNull FullScreenContentError fullScreenContentError) {
          Log.w(
              TAG,
              "Picture-in-Picture ad failed to show full screen content: "
                  + fullScreenContentError);
        }

        @Override
        public void onAdPaid(@NonNull AdValue value) {
          Log.d(
              TAG,
              "Picture-in-Picture ad paid: "
                  + value.getValueMicros()
                  + " "
                  + value.getCurrencyCode());
        }
      });
}

広告を非表示にする

画面からフローティング広告を削除するには、hide メソッドを呼び出します。このメソッドは、広告非表示イベント コールバックを呼び出します。

Kotlin

private fun hidePictureInPictureAd() {
  // Capture the ad reference saved from the onAdLoaded callback.
  val ad = pipAd
  if (ad != null) {
    ad.hide()
  } else {
    Log.d(TAG, "No ad to hide.")
  }
}

Java

private void hidePictureInPictureAd() {
  // Use the ad reference saved from the onAdLoaded callback.
  if (pipAd != null) {
    pipAd.hide();
  } else {
    Log.d(TAG, "No ad to hide.");
  }
}

広告のリソースをクリーンアップする

メモリリークを回避するには、アプリが広告の使用を終えたときに広告オブジェクトへの参照を削除します。たとえば、アプリで広告の表示や操作が行われなくなったときです。画面をスコープとする広告では、アプリがメモリからホスト画面を削除するときに参照を削除します。アプリをスコープとする広告では、ユーザーが画面を切り替えている間は広告の参照を保持し、ユーザーが広告を閉じたら参照を破棄します。

Kotlin

private fun cleanUpPictureInPictureAd() {
  pipAd?.destroy()
  pipAd = null
}

Java

private void cleanUpPictureInPictureAd() {
  // Use the ad reference saved from the onAdLoaded callback.
  if (pipAd != null) {
    pipAd.destroy();
    pipAd = null;
  }
}

画面を切り替えても広告を表示したままにする

プレゼンテーション スコープをアプリに設定すると、アプリがメモリからホスト画面を削除しても、ピクチャー イン ピクチャー広告は表示されたままになります。ユーザーがホスト画面から移動したときに広告を操作したり閉じたりするには、アプリがピクチャー イン ピクチャー広告へのアクセスを保持する必要があります。広告は、単一画面のインスタンス変数ではなく、アプリレベルのシングルトンまたは共有状態マネージャーに保持することをおすすめします。

画面を切り替えても広告を表示したままにする方法の例については、次のサンプルアプリをご覧ください。