Bild-im-Bild-Anzeigen implementieren (Beta)

Plattform auswählen: Android iOS

Bild im Bild

Bild-im-Bild-Anzeigen (BiB) werden in einem schwebenden Fenster eingeblendet, das über dem Inhalt auf dem Bildschirm, z. B. Artikeln, Feeds oder Gameplay, angezeigt wird. Mit diesem Format können Nutzer mit Ihrer App interagieren, während die Anzeige sichtbar bleibt. Mit diesem Format können Sie Anzeigen ausliefern, die nicht den gesamten Bildschirm einnehmen. Weitere Informationen zu Picture-in-Picture-Anzeigen

In diesem Leitfaden wird beschrieben, wie Sie mit GMA Next-Gen SDK Bild-im-Bild-Anzeigen in Ihrer App anfordern und präsentieren.

Hinweis

Führen Sie zuerst folgende Schritte aus:

Anzeige laden

Wenn Sie ein PictureInPictureAd-Objekt laden möchten, erstellen Sie eine Anzeigenanfrage und rufen Sie die Methode load auf:

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

Ersetzen Sie AD_UNIT_ID durch Ihre Anzeigenblock-ID.

Anzeige einblenden

Wenn Sie die Bild-im-Bild-Anzeige auf dem Bildschirm anzeigen möchten, konfigurieren Sie die Bild-im-Bild-Optionen und rufen Sie die Methode show auf. Im folgenden Beispiel wird die Standardposition der Anzeige und der Präsentationsbereich auf den Bildschirm festgelegt:

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

Position festlegen

Standardmäßig wird in GMA Next-Gen SDK eine Bild-im-Bild-Anzeige beim ersten Aufruf unten rechts auf dem Bildschirm oder an der zuletzt bekannten Position angezeigt, wenn sie schon einmal eingeblendet wurde. Wenn Sie anpassen möchten, wo die Anzeige eingeblendet wird, legen Sie die Position in den Bild-im-Bild-Optionen fest. Im folgenden Beispiel wird die Position oben auf dem Inhalt in der oberen linken Ecke des Bildschirms festgelegt:

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

Alle verfügbaren Stellen finden Sie unter PictureInPictureAdPosition.

Umfang der Präsentation festlegen

Standardmäßig wird mit GMA Next-Gen SDK eine Bild-im-Bild-Anzeige an den aktuellen Hostbildschirm gebunden. GMA Next-Gen SDK schließt die Anzeige, wenn die Ansichtshierarchie des Hostbildschirms nicht mehr im Arbeitsspeicher ist. Damit die Anzeige sichtbar bleibt, nachdem der Hostbildschirm aus dem Arbeitsspeicher entfernt wurde, legen Sie den Präsentationsbereich auf die Anwendung fest:

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

Weitere Informationen finden Sie unter Anzeige auf allen Bildschirmen sichtbar machen.

Callback für Anzeigenereignisse festlegen

Wenn Sie Lifecycle-Ereignisse für Bild-im-Bild-Anzeigen verarbeiten möchten, legen Sie den Ereignis-Callback für die Anzeige fest, bevor Sie sie präsentieren. Mit diesem Callback werden Standardereignisse wie Klicks und Impressionen gemeldet. Dieser Callback meldet auch Ereignisse, die sich speziell auf den Bild-im-Bild-Modus beziehen, z. B. wenn die Anzeige ein- oder ausgeblendet wird:

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

Anzeige ausblenden

Wenn Sie die schwebende Anzeige vom Bildschirm entfernen möchten, rufen Sie die Methode hide auf. Mit dieser Methode wird der Callback für das Ereignis „Anzeige ausgeblendet“ aufgerufen:

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

Anzeigenressourcen bereinigen

Um Speicherlecks zu vermeiden, sollten Sie die Referenz auf das Anzeigenobjekt löschen, wenn Ihre App die Anzeige nicht mehr verwendet. Das ist beispielsweise der Fall, wenn die Anzeige nicht mehr in Ihrer App zu sehen ist oder nicht mehr mit ihr interagiert wird. Bei Anzeigen mit Bildschirmbereich müssen Sie die Referenz löschen, wenn Ihre App den Hostbildschirm aus dem Arbeitsspeicher entfernt. Behalten Sie bei Anzeigen mit App-Umfang die Anzeigenreferenz bei, während der Nutzer zwischen Bildschirmen wechselt, und entfernen Sie die Referenz, wenn der Nutzer die Anzeige schließt:

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

Anzeige auf allen Bildschirmen sichtbar lassen

Wenn Sie den Präsentationsbereich auf die Anwendung festlegen, bleibt die Bild-im-Bild-Anzeige sichtbar, auch wenn Ihre App den Hosting-Bildschirm aus dem Arbeitsspeicher entfernt. Wenn der Nutzer den Hostbildschirm verlässt, muss Ihre App weiterhin Zugriff auf die Bild-im-Bild-Anzeige haben, damit er mit der Anzeige interagieren oder sie schließen kann. Wir empfehlen, die Anzeige in einem Singleton auf App-Ebene oder in einem gemeinsamen Statusmanager zu speichern und nicht in einer Instanzvariablen eines einzelnen Bildschirms.

Beispiele dafür, wie eine Anzeige auf verschiedenen Bildschirmen sichtbar bleibt, finden Sie in den folgenden Beispiel-Apps: