Implementace reklam typu obraz v obraze (beta)

Obraz v obraze

Reklamy typu obraz v obraze (PiP) se zobrazují v plovoucím okně, které zůstává nad obsahem na obrazovce, jako jsou články, informační kanály nebo hraní her. Tento formát umožňuje uživatelům interagovat s vaší aplikací, zatímco reklama zůstává viditelná. Chcete-li zobrazovat reklamy, které nezabírají celou obrazovku, zvolte tento formát. Další informace o reklamách typu obraz v obraze .

Tato příručka se zabývá vyžádáním a zobrazováním reklam typu obraz v obraze ve vaší aplikaci pomocí GMA Next-Gen SDK .

Než začnete

Než budete pokračovat, proveďte následující:

Načíst reklamu

Chcete-li načíst PictureInPictureAd , vytvořte požadavek na reklamu a zavolejte metodu 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)
      }
    },
  )
}

Jáva 

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

Nahraďte AD_UNIT_ID vaším ID reklamní jednotky.

Zobrazit reklamu

Chcete-li zobrazit reklamu v režimu obraz v obraze na obrazovce, nakonfigurujte možnosti obrazu v obraze a zavolejte metodu show . Následující příklad nastaví výchozí pozici reklamy a rozsah prezentace na obrazovku:

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

Jáva 

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

Nastavte pozici

Ve výchozím nastavení zobrazuje GMA Next-Gen SDK reklamu typu obraz v obraze v pravém dolním rohu obrazovky při prvním zobrazení nebo na poslední známé pozici, pokud se zobrazovala dříve. Chcete-li přizpůsobit, kde se reklama zobrazí, nastavte pozici v možnostech obrazu v obraze. Následující příklad nastavuje pozici nad obsahem v levém horním rohu obrazovky:

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

Jáva 

private PictureInPictureAdOptions createTopLeftPositionOptions() {
  return new PictureInPictureAdOptions.Builder()
      // Sets the ad position to the top-left corner of the screen.
      .setPosition(PictureInPictureAdPosition.TOP_LEFT)
      .build();
}

Všechny dostupné pozice naleznete v článku PictureInPictureAdPosition .

Nastavení rozsahu prezentace

Ve výchozím nastavení sada GMA Next-Gen SDK váže reklamu typu obraz v obraze k aktuální obrazovce hostitele. GMA Next-Gen SDK reklamu zavře, když hierarchie zobrazení obrazovky hostitele již není v paměti. Chcete-li, aby reklama zůstala viditelná i po odstranění obrazovky hostitele z paměti, nastavte rozsah prezentace na aplikaci:

Kotlin 

private fun createApplicationScopedOptions(): PictureInPictureAdOptions {
  return PictureInPictureAdOptions.Builder()
    // Keeps the ad visible beyond the host screen's lifecycle.
    .setPresentationScope(PictureInPictureAdPresentationScope.APPLICATION)
    .build()
}

Jáva 

private PictureInPictureAdOptions createApplicationScopedOptions() {
  return new PictureInPictureAdOptions.Builder()
      // Keeps the ad visible beyond the host screen's lifecycle.
      .setPresentationScope(PictureInPictureAdPresentationScope.APPLICATION)
      .build();
}

Další informace naleznete v článku Jak zajistit viditelnost reklamy na všech obrazovkách .

Nastavení zpětného volání reklamní události

Chcete-li zpracovat události životního cyklu reklamy typu obraz v obraze, nastavte na reklamu před jejím zobrazením zpětné volání události. Toto zpětné volání hlásí standardní události, jako jsou kliknutí a zobrazení. Toto zpětné volání také hlásí události specifické pro obraz v obraze, například kdy se reklama zobrazí nebo skryje:

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

Jáva 

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

Skrýt reklamu

Chcete-li odstranit plovoucí reklamu z obrazovky, zavolejte metodu hide . Tato metoda vyvolá zpětné volání události ad hidden:

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

Jáva 

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

Vyčištění reklamních zdrojů

Abyste se vyhnuli únikům paměti, odstraňte odkaz na reklamní objekt, jakmile aplikace přestane reklamu používat. Například když aplikace reklamu již nezobrazuje ani s ní znovu neinteraguje. U reklam s rozsahem obrazovky odstraňte odkaz, když aplikace odstraní hostitelskou obrazovku z paměti. U reklam s rozsahem aplikace si odkaz na reklamu zachovejte, když uživatel prochází mezi obrazovkami, a odkaz odstraňte, když uživatel reklamu zavře:

Kotlin 

private fun cleanUpPictureInPictureAd() {
  pipAd?.destroy()
  pipAd = null
}

Jáva 

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

Udržujte reklamu viditelnou na všech obrazovkách

Když nastavíte rozsah prezentace na aplikaci, reklama obraz v obraze zůstane viditelná i v případě, že aplikace odebere hostitelskou obrazovku z paměti. Aby bylo možné s reklamou interagovat nebo ji zavřít, když uživatel opustí hostitelskou obrazovku, musí si aplikace zachovat přístup k reklamě obraz v obraze. Doporučujeme uchovávat reklamu v singletonu na úrovni aplikace nebo ve sdíleném správci stavu, nikoli v proměnné instance jedné obrazovky.

Příklad toho, jak zajistit viditelnost reklamy na všech obrazovkách, naleznete v našich ukázkových aplikacích: