植入挤压式广告(Beta 版)

挤压式

Squeezeback 广告会将应用内容嵌入到较小的视图中,并在周围空间展示原生广告。这种广告格式让用户在与您的应用互动时,广告依然清晰可见。如需展示不覆盖应用内容的广告,请选择此格式。

本指南介绍了如何使用 GMA Next-Gen SDK 在应用中请求和展示 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;
  }
}