スクイーズバック広告(ベータ版)を実装する

スクイーズバック

Squeezeback 広告では、アプリのコンテンツが小さなビューに挿入され、周囲のスペースにネイティブ広告が表示されます。このフォーマットでは、広告が表示されていても、ユーザーはアプリを操作できます。アプリのコンテンツを覆わないディスプレイ広告を表示するには、このフォーマットを選択します。

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

始める前に

先に進む前に、次のことを実施してください。

  • GMA Next-Gen SDK を設定します。

  • GMA Next-Gen SDK バージョン 1.7.0 以降をインストールします。

  • テスト広告を有効にして、次のテスト用ネイティブ広告ユニット ID を使用します。

    /21775744923/example/squeezeback
    

広告を読み込む

SqueezebackAd オブジェクトを読み込むには、広告リクエストを作成して load メソッドを呼び出します。次の例では、読み込まれた squeezeback 広告を保存し、広告イベントに登録して、失敗した場合はエラーをログに記録します。

Kotlin

private fun loadSqueezebackAd() {
  val request = SqueezebackAdRequest.Builder(AD_UNIT_ID).build()

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

      override fun onAdLoaded(ad: SqueezebackAd) {
        Log.d(TAG, "Squeezeback ad loaded.")

        // Capture the SqueezebackAd reference for later use.
        squeezebackAd = ad
        setAdEventCallback(ad)
      }
    },
  )
}

Java

private void loadSqueezebackAd() {
  SqueezebackAdRequest request = new SqueezebackAdRequest.Builder(AD_UNIT_ID).build();

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

        @Override
        public void onAdLoaded(@NonNull SqueezebackAd ad) {
          Log.d(TAG, "Squeezeback ad loaded.");

          // Capture the SqueezebackAd reference for later use.
          squeezebackAd = ad;
          setAdEventCallback(ad);
        }
      });
}

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

広告を表示する

squeezeback 広告を画面に表示するには、show メソッドを呼び出します。

Kotlin

private fun showSqueezebackAd(activity: Activity) {
  // Capture the ad reference saved from the onAdLoaded callback.
  val ad = squeezebackAd
  if (ad != null) {
    ad.show(activity)
  } else {
    Log.d(TAG, "No ad to show.")
  }
}

Java

private void showSqueezebackAd(@NonNull Activity activity) {
  // Use the ad reference saved from the onAdLoaded callback.
  if (squeezebackAd != null) {
    squeezebackAd.show(activity);
  } else {
    Log.d(TAG, "No ad to show.");
  }
}

代替の背景色を設定する

デフォルトでは、GMA Next-Gen SDK は縮小されたアプリ コンテンツと広告の背後に濃いグレーの背景を表示します。この色をカスタマイズするには、広告を表示する際に広告オプションで代替の背景色を指定します。次の例では、代替の背景色をダークグレーに設定して広告を表示しています。

Kotlin

private fun showSqueezebackAdWithFallbackBackgroundColor(activity: Activity) {
  // Capture the ad reference saved from the onAdLoaded callback.
  val ad = squeezebackAd
  if (ad != null) {
    val options =
      SqueezebackAdOptions.Builder()
        // Sets the fallback background color for the space behind the shrunken content and ad.
        .setFallbackBackgroundColor(Color.DKGRAY)
        .build()
    ad.show(activity, options)
  } else {
    Log.d(TAG, "No ad to show.")
  }
}

Java

private void showSqueezebackAdWithFallbackBackgroundColor(@NonNull Activity activity) {
  // Use the ad reference saved from the onAdLoaded callback.
  if (squeezebackAd != null) {
    SqueezebackAdOptions options =
        new SqueezebackAdOptions.Builder()
            // Sets the fallback background color for the space behind the shrunken content and
            // ad.
            .setFallbackBackgroundColor(Color.DKGRAY)
            .build();
    squeezebackAd.show(activity, options);
  } else {
    Log.d(TAG, "No ad to show.");
  }
}

広告イベントをリッスンする

squeezeback 広告のライフサイクル イベントを処理するには、広告を表示する前に広告イベントに登録します。これらのイベント レポートは、クリックや表示回数などの広告インタラクションをレポートします。また、広告の表示、表示の失敗、非表示など、squeezeback 固有のイベントもレポートします。

Kotlin

private fun setAdEventCallback(squeezebackAd: SqueezebackAd) {
  squeezebackAd.adEventCallback =
    object : SqueezebackAdEventCallback {
      override fun onAdShown() {
        Log.d(TAG, "Squeezeback ad shown.")
      }

      override fun onAdHidden() {
        // Called when hide() is invoked or the user taps the close button.
        // The ad cannot be shown again after it is hidden.
        Log.d(TAG, "Squeezeback ad hidden.")
      }

      override fun onAdFailedToShow(error: FullScreenContentError) {
        Log.w(TAG, "Squeezeback ad failed to show: $error")
      }

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

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

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

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

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

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

Java

private void setAdEventCallback(@NonNull SqueezebackAd squeezebackAd) {
  squeezebackAd.setAdEventCallback(
      new SqueezebackAdEventCallback() {
        @Override
        public void onAdShown() {
          Log.d(TAG, "Squeezeback ad shown.");
        }

        @Override
        public void onAdHidden() {
          // Called when hide() is invoked or the user taps the close button.
          // The ad cannot be shown again after it is hidden.
          Log.d(TAG, "Squeezeback ad hidden.");
        }

        @Override
        public void onAdFailedToShow(@NonNull FullScreenContentError error) {
          Log.w(TAG, "Squeezeback ad failed to show: " + error);
        }

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

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

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

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

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

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

ユーザーが広告を閉じると、GMA Next-Gen SDK によって広告非表示イベントが呼び出され、広告を再度表示することはできなくなります。

広告を非表示にする

広告を削除してアプリのコンテンツをフルサイズに戻すには、hide メソッドを呼び出します。このメソッドは、広告非表示イベントを呼び出します。次の例では、保存された squeezeback 広告参照を確認し、利用可能な場合は広告を非表示にしています。

Kotlin

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

Java

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

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

メモリリークを回避するには、アプリが広告を使用し終えたときに広告オブジェクトへの参照を削除します。次の例では、広告をクリーンアップしています。

Kotlin

private fun cleanUpSqueezebackAd() {
  squeezebackAd?.destroy()
  squeezebackAd = null
}

Java

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