הטמעה של מודעות מסוג 'תמונה בתוך תמונה' (בטא)

בחירת פלטפורמה: 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)
      }
    },
  )
}

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 במזהה יחידת המודעות.

הצגת המודעה

כדי להציג את המודעה בפורמט "תמונה בתוך תמונה" במסך, צריך להפעיל את השיטה 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());
        }
      });
}

הסתרת המודעה

כדי להסיר את המודעה הצפה מהמסך, צריך להפעיל את ה-method‏ 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;
  }
}

המודעה צריכה להיות גלויה בכל המסכים

כשמגדירים את היקף ההצגה לאפליקציה, המודעה בפורמט "תמונה בתוך תמונה" נשארת גלויה גם כשהאפליקציה מסירה את המסך המארח מהזיכרון. כדי שהמשתמש יוכל לקיים אינטראקציה עם המודעה או לסגור אותה כשהוא עובר מהמסך המארח, האפליקציה צריכה לשמור על הגישה למודעה במצב "תמונה בתוך תמונה". מומלץ לשמור את המודעה במנהל מצב משותף או ב-singleton ברמת האפליקציה, ולא במשתנה מופע של מסך יחיד.

כדי לראות דוגמאות לאופן שבו אפשר להשאיר מודעה גלויה במסכים שונים, עיינו באפליקציות לדוגמה הבאות: