Implementer bilde-i-bilde-annonser (betaversjon)

Bilde-i-bilde

Bilde-i-bilde-annonser (PiP) vises i et flytende vindu som holder seg oppå innhold på skjermen, for eksempel artikler, feeder eller spilling. Dette formatet lar brukerne samhandle med appen din mens annonsen forblir synlig. For å vise annonser som ikke tar over hele skjermen, velg dette formatet. Finn ut mer om bilde-i-bilde-annonser .

Denne veiledningen dekker hvordan du ber om og viser bilde-i-bilde-annonser i appen din ved hjelp av GMA Next-Gen SDK .

Før du begynner

Før du fortsetter, gjør følgende:

Last inn en annonse

For å laste inn en PictureInPictureAd , opprett en annonseforespørsel og kall 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)
      }
    },
  )
}

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

Erstatt AD_UNIT_ID med annonseenhets-ID-en din.

Vis annonsen

For å vise bilde-i-bilde-annonsen på skjermen, konfigurer bilde-i-bilde-alternativene og kall show metoden. Følgende eksempel angir standardposisjonen til annonsen og presentasjonsområdet på skjermen:

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

Angi posisjonen

Som standard viser GMA Next-Gen SDK en bilde-i-bilde-annonse nederst til høyre på skjermen når den vises første gang, eller på den sist kjente posisjonen hvis den ble vist tidligere. For å tilpasse hvor annonsen vises, angi posisjonen i bilde-i-bilde-alternativene dine. Følgende eksempel angir posisjonen over innholdet øverst til venstre på skjermen:

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

For alle tilgjengelige stillinger, se PictureInPictureAdPosition .

Angi presentasjonsomfanget

Som standard binder GMA Next-Gen SDK en bilde-i-bilde-annonse til gjeldende vertsskjerm. GMA Next-Gen SDK lukker annonsen når vertsskjermens visningshierarki ikke lenger er i minnet. For å holde annonsen synlig etter at vertsskjermen er fjernet fra minnet, angir du presentasjonsomfanget til applikasjonen:

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

Hvis du vil ha mer informasjon, kan du se Hold annonsen synlig på tvers av skjermer .

Angi tilbakekalling for annonsehendelse

For å håndtere livssyklushendelser for bilde-i-bilde-annonser, angi tilbakekallingen for hendelser på annonsen din før den vises. Denne tilbakekallingen rapporterer standardhendelser, for eksempel klikk og visninger. Denne tilbakekallingen rapporterer også bilde-i-bilde-spesifikke hendelser, for eksempel når annonsen vises eller skjules:

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

Skjul annonsen

For å fjerne den flytende annonsen fra skjermen, kall hide -metoden. Denne metoden kaller tilbakekallingen for hendelsen 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.")
  }
}

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

Rydd opp i annonseressursene

For å unngå minnelekkasjer, fjern referansen til annonseobjektet når appen er ferdig med å bruke annonsen. For eksempel når appen ikke lenger viser eller samhandler med annonsen igjen. For annonser med skjermomfang, fjern referansen når appen fjerner vertsskjermen fra minnet. For annonser med appomfang, behold annonsereferansen mens brukeren navigerer på tvers av skjermer, og fjern referansen når brukeren lukker annonsen:

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

Hold annonsen synlig på tvers av skjermer

Når du angir presentasjonsomfanget for appen, forblir bilde-i-bilde-annonsen synlig selv om appen fjerner vertsskjermen fra minnet. For å samhandle med eller lukke annonsen når brukeren navigerer bort fra vertsskjermen, må appen beholde tilgangen til bilde-i-bilde-annonsen. Vi anbefaler at du oppbevarer annonsen i en singleton på appnivå eller en delt tilstandsadministrator i stedet for i en enkelt skjerms instansvariabel.

For et eksempel på hvordan du kan holde en annonse synlig på tvers av skjermer, se våre eksempelapper: