پیاده‌سازی آگهی‌های تصویردرتصویر (نسخه بتا)

انتخاب پلاتفرم: 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)
      }
    },
  )
}

جاوا

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 را با شناسه واحد آگهی‌تان جایگزین کنید.

نمایش آگهی

برای نمایش آگهی تصویردرتصویر روی صفحه، گزینه‌های تصویردرتصویر را پیکربندی کنید و روش 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.")
  }
}

جاوا

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()
}

جاوا

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()
}

جاوا

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}")
      }
    }
}

جاوا

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.")
  }
}

جاوا

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
}

جاوا

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

آگهی در صفحه‌نمایش‌های مختلف قابل‌مشاهده بماند

وقتی محدوده ارائه را روی برنامه تنظیم می‌کنید، آگهی تصویردرتصویر حتی وقتی برنامه شما صفحه میزبانی را از حافظه برمی‌دارد قابل‌مشاهده باقی می‌ماند. برای تعامل با آگهی یا بستن آن وقتی کاربر از صفحه میزبان خارج می‌شود، برنامه شما باید دسترسی به آگهی تصویردرتصویر را حفظ کند. توصیه می‌کنیم آگهی را در یک تک‌عضوی سطح برنامه یا مدیر وضعیت مشترک نگه دارید نه در متغیر نمونه یک صفحه.

برای نمونه‌هایی از نحوه قابل‌مشاهده نگه داشتن آگهی در سراسر صفحه‌ها، برنامه‌های نمونه زیر را ببینید: