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

پلاتفرم را انتخاب کنید: Android iOS Unity

تصویر در تصویر

آگهی‌های تصویردرتصویر (PiP) در پنجره شناوری نمایش داده می‌شوند که روی محتوای صفحه (مثل مقاله‌ها، فیدها، یا شیوه بازی) باقی می‌ماند. این قالب به کاربران اجازه می‌دهد درحالی‌که آگهی همچنان قابل‌مشاهده است، با برنامه‌تان تعامل داشته باشند. برای نمایش آگهی‌هایی که کل صفحه را اشغال نمی‌کنند، این قالب را انتخاب کنید.

این راهنما درخواست و نمایش آگهی‌های تصویردرتصویر در برنامه شما را بااستفاده از GMA Next-Gen SDK پوشش می‌دهد.

قبل‌از شروع

پیش‌از ادامه دادن، کارهای زیر را انجام دهید:

بار کردن آگهی

برای بار کردن شیء PictureInPictureAd ، درخواست آگهی ایجاد کنید و روش بار کردن را فراخوانی کنید:

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

نمایش آگهی

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

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

پنهان کردن آگهی

برای برداشتن آگهی شناور از صفحه، روش پنهان کردن را فراخوانی کنید. این روش رویداد پنهان آگهی را فراخوانی می‌کند:

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;
  }
}

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

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

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