Niestandardowe formaty reklam natywnych

Niestandardowe formaty reklam natywnych

Oprócz formatów natywnych zdefiniowanych przez system wydawcy Ad Managera mogą tworzyć własne formaty reklam natywnych, definiując niestandardowe listy komponentów. Nazywamy je niestandardowymi formatami reklam natywnych i można ich używać w przypadku reklam zarezerwowanych. Pozwala to wydawcom przekazywać dowolne uporządkowane dane do swoich aplikacji. Reklamy te są reprezentowane przez obiekt NativeCustomFormatAd.

Ładowanie niestandardowych formatów reklam natywnych

Z tego przewodnika dowiesz się, jak wczytywać i wyświetlać niestandardowe formaty reklam natywnych.

Tworzenie AdLoader

Podobnie jak reklamy natywne, niestandardowe formaty reklam natywnych są wczytywane za pomocą klasy AdLoader:

Java

AdLoader adLoader = new AdLoader.Builder(context, "/21775744923/example/native")
    .forCustomFormatAd("10063170",
      new NativeCustomFormatAd.OnCustomFormatAdLoadedListener() {
          @Override
          public void onCustomFormatAdLoaded(NativeCustomFormatAd ad) {
              // Show the custom format and record an impression.
          }
      },
      new NativeCustomFormatAd.OnCustomClickListener() {
          @Override
          public void onCustomClick(NativeCustomFormatAd ad, String s) {
              // Handle the click action
          }
      })
    .withAdListener( ... )
    .withNativeAdOptions( ... )
    .build();

Kotlin

val adLoader = AdLoader.Builder(this, "/21775744923/example/native")
        .forCustomFormatAd("10063170",
            { ad ->
                // Show the custom format and record an impression.
            },
            { ad, s ->
            // Handle the click action
            })
        .withAdListener( ... )
        .withNativeAdOptions( ... )
        .build()

Metoda forCustomFormatAd konfiguruje AdLoader do wysyłania żądań dotyczących niestandardowych formatów reklam natywnych. Metoda ta ma 3 parametry:

  • Identyfikator niestandardowego formatu reklamy natywnej, którego AdLoader powinien zażądać. Z każdym niestandardowym formatem natywnej reklamy jest powiązany identyfikator. Ten parametr wskazuje, którego formatu aplikacja chce użyć w żądaniu AdLoader.
  • OnCustomFormatAdLoadedListener wywoływany po wczytaniu reklamy.
  • Opcjonalnie możesz ustawić akcję OnCustomClickListener, która zostanie wykonana, gdy użytkownik dotknie lub kliknie reklamę. Więcej informacji o tym odbiorcy znajdziesz w sekcji „Przetwarzanie kliknięć i wyświetleń”.

Ponieważ pojedyncza jednostka reklamowa może być skonfigurowana tak, aby wyświetlać więcej niż 1 format kreacji, funkcja forCustomFormatAd może być wywoływana wielokrotnie z użyciem unikalnych identyfikatorów formatów, aby przygotować ładowarkę reklam na potrzeby obsługi większej liczby możliwych formatów reklam natywnych niestandardowych.

Identyfikator niestandardowego formatu reklamy natywnej

Identyfikator formatu używany do identyfikowania niestandardowego formatu reklamy natywnej można znaleźć w interfejsie Ad Managera w sekcji Natywny w menu Wyświetlanie:

Obok nazwy każdego niestandardowego formatu reklamy natywnej znajduje się jego identyfikator. Kliknięcie jednej z nazw spowoduje wyświetlenie ekranu z informacjami o polach formatu:

Tutaj możesz dodawać, edytować i usuwać poszczególne pola. Zanotuj nazwę każdego zasobu. Nazwa jest kluczem używanym do uzyskiwania danych o każdym komponencie podczas wyświetlania niestandardowego formatu reklamy natywnej.

Wyświetlanie niestandardowych formatów reklam natywnych

Niestandardowe formaty reklam natywnych różnią się od zdefiniowanych przez system tym, że wydawcy mogą samodzielnie zdefiniować listę komponentów reklamy. Dlatego proces wyświetlania takiego formatu różni się od procesów związanych z formatami zdefiniowanymi przez system w kilku aspektach:

  1. Ponieważ klasa NativeCustomFormatAd ma obsługiwać wszystkie niestandardowe formaty reklam natywnych zdefiniowane w Ad Managerze, nie ma nazwanych „getterów” komponentów. Zamiast tego oferuje metody takie jak getText i getImage, które przyjmują nazwę pola jako parametr.
  2. Nie ma specjalnej klasy widoku reklamy, takiej jak NativeAdView, która mogłaby być używana z NativeCustomFormatAd. Możesz użyć dowolnego układu, który będzie odpowiedni dla Twoich użytkowników.
  3. Ponieważ nie ma dedykowanej klasy ViewGroup, nie musisz rejestrować żadnego z widoków, których używasz do wyświetlania komponentów reklamy. Dzięki temu zaoszczędzisz kilka linii kodu podczas wyświetlania reklamy, ale będziesz też musiał później wykonać trochę dodatkowej pracy, aby obsłużyć kliknięcia.

Oto przykład funkcji, która wyświetla wartość NativeCustomFormatAd:

Java

public void displayCustomFormatAd (ViewGroup parent,
                                     NativeCustomFormatAd customFormatAd) {
    // Inflate a layout and add it to the parent ViewGroup.
    LayoutInflater inflater = (LayoutInflater) parent.getContext()
            .getSystemService(Context.LAYOUT_INFLATER_SERVICE);
    View adView = inflater.inflate(R.layout.custom_format_ad, parent);

    // Locate the TextView that will hold the value for "Headline" and
    // set its text.
    TextView myHeadlineView = (TextView) adView.findViewById(R.id.headline);
    myHeadlineView.setText(customFormatAd.getText("Headline"));

    // Locate the ImageView that will hold the value for "MainImage" and
    // set its drawable.
    Button myMainImageView = (ImageView) adView.findViewById(R.id.main_image);
    myMainImageView.setImageDrawable(
            customFormatAd.getImage("MainImage").getDrawable());

    ...
    // Continue locating views and displaying assets until finished.
    ...
}

Kotlin

public fun displayCustomFormatAd (parent: ViewGroup,
                                customFormatAd: NativeCustomFormatAd) {
    val adView = layoutInflater
            .inflate(R.layout.ad_simple_custom_format, null)

    val myHeadlineView = adView.findViewById<TextView>(R.id.headline)
    myHeadlineView.setText(customFormatAd.getText("Headline"));

    // Locate the ImageView that will hold the value for "MainImage" and
    // set its drawable.
    val myMainImageView = adView.findViewById(R.id.main_image);
    myMainImageView.setImageDrawable(
            customFormatAd.getImage("MainImage").drawable);

    ...
    // Continue locating views and displaying assets until finished.
    ...
}

Renderowanie ikony Informacja

W ramach wsparcia aktu prawnego o usługach cyfrowych (DSA) reklamy z rezerwacją wyświetlane w Europejskim Obszarze Gospodarczym (EOG) muszą zawierać ikonę Informacje i link do strony „O tej reklamie” w Google. Implementując niestandardowe reklamy natywne, odpowiadasz za renderowanie ikony Informacja. Podczas renderowania głównych komponentów reklamy zalecamy zadbanie o renderowanie i ustawienie detektora kliknięć tej ikony.

W tym przykładzie zakładamy, że w hierarchii widoku zdefiniowano element <ImageView />, aby przechowywać w nim logo AdChoices.

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android">
    <ImageView
        android:id="@+id/adChoices"
        android:layout_width="15dp"
        android:layout_height="15dp"
        android:adjustViewBounds="true"
        android:contentDescription="AdChoices icon." />
</LinearLayout>

W poniższych przykładach renderowana jest ikona Informacja, a kliknięcie powoduje odpowiednie działanie.

Java

private AdSimpleCustomTemplateBinding customTemplateBinding;

private void populateAdView(final NativeCustomFormatAd nativeCustomFormatAd) {
  // Render the AdChoices icon.
  String adChoicesKey = NativeAdAssetNames.ASSET_ADCHOICES_CONTAINER_VIEW;
  NativeAd.Image adChoicesAsset = nativeCustomFormatAd.getImage(adChoicesKey);
  if (adChoicesAsset == null) {
    customTemplateBinding.adChoices.setVisibility(View.GONE);
  } else {
    customTemplateBinding.adChoices.setVisibility(View.VISIBLE);
    customTemplateBinding.adChoices.setImageDrawable(adChoicesAsset.getDrawable());

    // Enable clicks on AdChoices.
    customTemplateBinding.adChoices.setOnClickListener(
        new View.OnClickListener() {
          @Override
          public void onClick(View v) {
            nativeCustomFormatAd.performClick(adChoicesKey);
          }
        });
  }
  ...
}

Kotlin

private lateinit var customTemplateBinding: AdSimpleCustomTemplateBinding

private fun populateAdView(nativeCustomFormatAd: NativeCustomFormatAd) {
  // Render the AdChoices icon.
  val adChoicesKey = NativeAdAssetNames.ASSET_ADCHOICES_CONTAINER_VIEW
  val adChoicesAsset = nativeCustomFormatAd.getImage(adChoicesKey)
  if (adChoicesAsset == null) {
    customTemplateBinding.adChoices.visibility = View.GONE
  } else {
    customTemplateBinding.adChoices.setImageDrawable(adChoicesAsset.drawable)
    customTemplateBinding.adChoices.visibility = View.VISIBLE

    // Enable clicks on AdChoices.
    customTemplateBinding.adChoices.setOnClickListener {
      nativeCustomFormatAd.performClick(adChoicesKey)
    }
  }
  ...
}

Natywny film w niestandardowych formatach reklam natywnych

Podczas tworzenia formatu niestandardowego możesz określić, czy ma on być odpowiedni do wyświetlania reklam wideo.

W implementacji aplikacji możesz użyć elementu NativeCustomFormatAd.getMediaContent(), aby pobrać treści multimedialne. Następnie wywołaj setMediaContent(), aby ustawić zawartość multimediów w widoku multimediów. Jeśli reklama nie zawiera treści wideo, przygotuj alternatywne plany wyświetlania reklamy bez filmu.

Przykład poniżej sprawdza, czy reklama zawiera treści wideo, i wyświetla obraz, jeśli film nie jest dostępny:

Java

// Called when a custom native ad loads.
@Override
public void onCustomFormatAdLoaded(final NativeCustomFormatAd ad) {

  MediaContent mediaContent = ad.getMediaContent();

  // Assumes you have a FrameLayout in your view hierarchy with the id media_placeholder.
  FrameLayout mediaPlaceholder = (FrameLayout) findViewById(R.id.media_placeholder);

  // Apps can check the MediaContent's hasVideoContent property to determine if the
  // NativeCustomFormatAd has a video asset.
  if (mediaContent != null && mediaContent.hasVideoContent()) {
    MediaView mediaView = new MediaView(mediaPlaceholder.getContext());
    mediaView.setMediaContent(mediaContent);
    mediaPlaceholder.addView(mediaView);

    // Create a new VideoLifecycleCallbacks object and pass it to the VideoController. The
    // VideoController will call methods on this object when events occur in the video
    // lifecycle.
    VideoController vc = mediaContent.getVideoController();
    vc.setVideoLifecycleCallbacks(
        new VideoController.VideoLifecycleCallbacks() {
          @Override
          public void onVideoEnd() {
            // Publishers should allow native ads to complete video playback before
            // refreshing or replacing them with another ad in the same UI location.
            super.onVideoEnd();
          }
        });
  } else {
    ImageView mainImage = new ImageView(this);
    mainImage.setAdjustViewBounds(true);
    mainImage.setImageDrawable(ad.getImage("MainImage").getDrawable());
    mediaPlaceholder.addView(mainImage);
    mainImage.setOnClickListener(
        new View.OnClickListener() {
          @Override
          public void onClick(View view) {
            ad.performClick("MainImage");
          }
        });
  }
}

Kotlin

// Called when a custom native ad loads.
NativeCustomFormatAd.OnCustomFormatAdLoadedListener { ad ->

  val mediaContent = ad.mediaContent

  // Apps can check the MediaContent's hasVideoContent property to determine if the
  // NativeCustomFormatAd has a video asset.
  if (mediaContent != null && mediaContent.hasVideoContent()) {
    val mediaView = MediaView(mediaPlaceholder.getContest())
    mediaView.mediaContent = mediaContent

    val videoController = mediaContent.videoController

    // Create a new VideoLifecycleCallbacks object and pass it to the VideoController. The
    // VideoController will call methods on this object when events occur in the video
    // lifecycle.
    if (videoController != null) {
      videoController.videoLifecycleCallbacks =
        object : VideoController.VideoLifecycleCallbacks() {
          override fun onVideoEnd() {
            // Publishers should allow native ads to complete video playback before refreshing
            // or replacing them with another ad in the same UI location.
            super.onVideoEnd()
          }
        }
    }
  } else {
    val mainImage = ImageView(this)
    mainImage.adjustViewBounds = true
    mainImage.setImageDrawable(ad.getImage("MainImage")?.drawable)

    mainImage.setOnClickListener { ad.performClick("MainImage") }
    customTemplateBinding.simplecustomMediaPlaceholder.addView(mainImage)
  }
}

Więcej informacji o dostosowywaniu wyświetlania filmów w niestandardowych reklamach natywnych znajdziesz w sekcji MediaContent.

Aby zobaczyć przykład działania natywnych reklam wideo, pobierz przykład niestandardowego renderowania w usłudze Ad Manager.

Kliknięcia i wyświetlenia niestandardowego formatu reklamy natywnej

W przypadku niestandardowych formatów reklam natywnych aplikacja jest odpowiedzialna za rejestrowanie wyświetleń i zgłaszanie zdarzeń kliknięcia do pakietu SDK do reklam mobilnych Google.

Rejestrowanie wyświetleń

Aby zarejestrować wyświetlenie reklamy w niestandardowym formacie, wywołaj metodę recordImpression w odpowiednim obiekcie NativeCustomFormatAd:

myCustomFormatAd.recordImpression();

Jeśli Twoja aplikacja przypadkowo wywoła metodę dwukrotnie w przypadku tej samej reklamy, SDK automatycznie zapobiegnie zarejestrowaniu zduplikowanego wyświetlenia w ramach pojedynczego żądania.

Raportowanie kliknięć

Aby zgłosić do SDK, że kliknięcie nastąpiło w przypadku wyświetlenia zasobu, wywołaj metodę performClick na odpowiednim obiekcie NativeCustomFormatAd i przekaż nazwę zasobu, który został kliknięty. Jeśli np. masz zasób w formacie niestandardowym o nazwie „MainImage” i chcesz zgłaszać kliknięcia na ImageView odpowiadające temu zasobowi, Twój kod będzie wyglądać tak:

myCustomFormatAd.performClick("MainImage");

Pamiętaj, że nie musisz wywoływać tej metody w przypadku każdego wyświetlenia powiązanego z Twoją reklamą. Jeśli masz inne pole o nazwie „Podpis”, które ma być wyświetlane, ale nie jest klikane przez użytkownika, aplikacja nie musi wywoływać funkcji performClick w przypadku tego zasobu.

Odpowiedź na niestandardowe działania po kliknięciu

Gdy nastąpi kliknięcie reklamy w niestandardowym formacie, pakiet SDK może w tej kolejności próbować 3 możliwe odpowiedzi:

  1. Wywołaj OnCustomClickListener z AdLoader, jeśli został podany.
  2. W przypadku każdego adresu URL precyzyjnego linku reklamy spróbuj znaleźć usługę rozwiązywania treści i uruchom pierwszą, która się rozwiąże.
  3. Otwórz przeglądarkę i otwórz tradycyjny adres URL docelowy reklamy.

Metoda forCustomFormatAd przyjmuje argument OnCustomClickListener. Jeśli przekazujesz obiekt listenera, pakiet SDK wywołuje zamiast tego metodę onCustomClick i nie podejmuje żadnych dalszych działań. Jeśli jednak jako parametr listenera podasz wartość null, pakiet SDK użyje linku docelowego lub adresów URL docelowych zarejestrowanych w reklamie.

Słuchacze kliknięć niestandardowych umożliwiają aplikacji wybranie najlepszego działania w odpowiedzi na kliknięcie, np. zaktualizowanie interfejsu użytkownika, uruchomienie nowej aktywności lub po prostu odnotowanie kliknięcia. Oto przykład, który po prostu rejestruje kliknięcie:

Java

AdLoader adLoader = new AdLoader.Builder(context, "/21775744923/example/native")
    .forCustomFormatAd("10063170",
      new NativeCustomFormatAd.OnCustomFormatAdLoadedListener() {
        // Display the ad.
      },
      new NativeCustomFormatAd.OnCustomClickListener() {
          @Override
          public void onCustomClick(NativeCustomFormatAd ad, String assetName) {
            Log.i("MyApp", "A custom click just happened for " + assetName + "!");
          }
      }).build();

Kotlin

val adLoader = AdLoader.Builder(this, "/21775744923/example/native")
    .forCustomFormatAd("10063170",
        { ad ->
            // Display the ad.
        },
        { ad, assetName ->
                Log.i("MyApp", "A custom click just happened for $assetName!")
    }).build()

Na początku może się wydawać dziwne, że istnieją niestandardowe odbiorniki kliknięć. W końcu Twoja aplikacja właśnie poinformowała pakiet SDK o tym, że kliknięcie nastąpiło, więc dlaczego pakiet SDK miałby to zgłosić aplikacji?

Ten przepływ informacji jest przydatny z kilku powodów, ale najważniejszym jest to, że pozwala pakietowi SDK zachować kontrolę nad odpowiedzią na kliknięcie. Może on automatycznie wysyłać zapytania do zewnętrznych adresów URL służących do śledzenia, które zostały określone np. dla kreacji, oraz wykonywać inne zadania w tle bez dodatkowego kodu.