Pierwsze kroki z rozszerzeniem Exoplayer IMA

Pakiety IMA SDK ułatwiają integrację reklam multimedialnych z witrynami i aplikacjami. Pakiety IMA SDK mogą żądać reklam z dowolnego serwera reklam zgodnego z VAST i zarządzać odtwarzaniem reklam w Twoich aplikacjach. Dzięki pakietom IMA SDK po stronie klienta zachowujesz kontrolę nad odtwarzaniem treści wideo, a pakiet SDK obsługuje odtwarzanie reklam. Reklamy wyświetlają się w osobnym odtwarzaczu nad odtwarzaczem treści w aplikacji.

W tym przewodniku pokazujemy, jak zintegrować pakiet IMA SDK z pustym projektem Android Studio za pomocą rozszerzenia ExoPlayer IMA. Jeśli chcesz wyświetlić ukończoną przykładową integrację lub z niej skorzystać, pobierz z GitHuba BasicExample.

Omówienie po stronie klienta IMA

Implementacja pakietu IMA po stronie klienta obejmuje 4 główne komponenty pakietu SDK, które zostały przedstawione w tym przewodniku:

  • AdDisplayContainer: obiekt kontenera, w którym są renderowane reklamy.
  • AdsLoader: obiekt, który wysyła żądania reklam i obsługuje zdarzenia z odpowiedzi na żądania reklam. Należy uruchomić tylko jeden program wczytujący reklamy, którego można używać wielokrotnie przez cały czas korzystania z aplikacji.
  • AdsRequest: obiekt definiujący żądanie reklamy. Żądania reklam określają adres URL tagu reklamy VAST oraz parametry dodatkowe, takie jak wymiary reklamy.
  • AdsManager: obiekt, który zawiera odpowiedź na żądanie reklamy, steruje odtwarzaniem i nasłuchuje zdarzeń reklamowych wywoływanych przez pakiet SDK.

Wymagania wstępne

Zanim zaczniesz, musisz mieć Androida Studio w wersji 3.0 lub nowszej.

1. Utwórz nowy projekt Android Studio

Aby utworzyć projekt Android Studio, wykonaj te czynności:

  1. Uruchom Android Studio.
  2. Wybierz Rozpocznij nowy projekt Android Studio.
  3. Na stronie Wybierz projekt wybierz szablon Pusta aktywność.
  4. Kliknij Dalej.
  5. Na stronie Skonfiguruj projekt nadaj projektowi nazwę i jako język wybierz Java.
  6. Kliknij Zakończ.

2. Dodaj do projektu rozszerzenie ExoPlayer IMA

Najpierw w pliku build.gradle na poziomie aplikacji dodaj importy rozszerzenia do sekcji zależności. Ze względu na rozmiar rozszerzenia ExoPlayer IMA zaimplementuj i włącz multidex. Jest to konieczne w przypadku aplikacji, których minSdkVersion ma wartość 20 lub mniejszą. Dodaj też nowy obiekt compileOptions, aby określić informacje o zgodności wersji Javy.

app/build.gradle 
android {
    namespace 'com.google.ads.interactivemedia.v3.samples.exoplayerexample'
    compileSdkVersion 34

    compileOptions {
        sourceCompatibility JavaVersion.VERSION_17
        targetCompatibility JavaVersion.VERSION_17
    }
  }

  defaultConfig {
      applicationId "com.google.ads.interactivemedia.v3.samples.exoplayerexample"
      minSdkVersion 21
      targetSdkVersion 34
      multiDexEnabled true
      versionCode 1
      versionName "1.0"
  }

    ...
}
dependencies {
    implementation 'androidx.multidex:multidex:2.0.1'
    implementation 'androidx.media3:media3-ui:1.2.1'
    implementation 'androidx.media3:media3-exoplayer:1.2.1'
    implementation 'androidx.media3:media3-exoplayer-ima:1.2.1'

    ...
}

Dodaj uprawnienia użytkownika wymagane przez pakiet IMA SDK do wysyłania żądań reklam.

app/src/main/AndroidManifest.xml 
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.project name">

    <!-- Required permissions for the IMA SDK -->
    <uses-permission android:name="android.permission.INTERNET"/>
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

    ...

</manifest>

Dodaj deklaracje intencji

Jeśli Twoja aplikacja jest kierowana na Androida 11 (poziom interfejsu API 30) lub nowszego, obecne i najnowsze wersje pakietu IMA SDK wymagają wyraźnej deklaracji zamiaru otwierania linków internetowych. Dodaj ten fragment kodu do pliku manifestu aplikacji, by umożliwić klikanie reklam (użytkownicy klikający przycisk Więcej informacji). 
  <?xml version="1.0" encoding="utf-8"?>
  <manifest xmlns:android="http://schemas.android.com/apk/res/android"
      package="com.example.project name">

      ...

    </application>

    <queries>
      <intent>
          <action android:name="android.intent.action.VIEW" />
          <data android:scheme="https" />
      </intent>
      <intent>
          <action android:name="android.intent.action.VIEW" />
          <data android:scheme="http" />
      </intent>
    </queries>
  </manifest>

3. Tworzenie kontenera interfejsu reklamy

Utwórz obiekt StyledPlayerView z odpowiednim identyfikatorem, by używać go jako obiektu ExoPlayer PlayerView. Zmień też androidx.constraintlayout.widget.ConstraintLayout na LinearLayout.

app/src/main/res/layout/activity_main.xml 
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

    <androidx.media3.ui.PlayerView
        android:id="@+id/player_view"
        android:layout_width="match_parent"
        android:layout_height="wrap_content" />

</LinearLayout>

4. Dodaj adres URL treści i adres URL tagu reklamy na potrzeby żądania reklam

Dodaj wpisy do pola strings.xml, by przechowywać adres URL treści i adres URL tagu reklamy VAST.

app/src/main/res/values/strings.xml 
<resources>
    <string name="app_name">Your_Project_Name</string>
    <string name="content_url"><![CDATA[https://storage.googleapis.com/gvabox/media/samples/stock.mp4]]></string>
    <string name="ad_tag_url"><![CDATA[https://pubads.g.doubleclick.net/gampad/ads?iu=/21775744923/external/single_ad_samples&sz=640x480&cust_params=sample_ct%3Dlinear&ciu_szs=300x250%2C728x90&gdfp_req=1&output=vast&unviewed_position_start=1&env=vp&impl=s&correlator=]]></string>

</resources>

5. Importowanie rozszerzenia ExoPlayer IMA

Dodaj instrukcje importu dla rozszerzenia ExoPlayer. Następnie zaktualizuj klasę MainActivity, aby rozszerzyć zakres Activity, dodając zmienne prywatne dla PlayerView, SimpleExoPlayer i ImaAdsLoader.

app/src/main/java/com/example/project name/MainActivity.java 

import android.app.Activity;
import android.net.Uri;
import android.os.Bundle;
import androidx.media3.common.MediaItem;
import androidx.media3.common.util.Util;
import androidx.media3.datasource.DataSource;
import androidx.media3.datasource.DefaultDataSource;
import androidx.media3.exoplayer.ExoPlayer;
import androidx.media3.exoplayer.ima.ImaAdsLoader;
import androidx.media3.exoplayer.source.DefaultMediaSourceFactory;
import androidx.media3.exoplayer.source.MediaSource;
import androidx.media3.ui.PlayerView;
import androidx.multidex.MultiDex;

...

public class MainActivity extends Activity {

  private PlayerView playerView;
  private ExoPlayer player;
  private ImaAdsLoader adsLoader;

}

6. Tworzenie instancji adsLoader

Zastąp metodę onCreate i dodaj wymagane przypisania zmiennych, aby utworzyć nowy obiekt adsLoader z adresem URL tagu reklamy.

app/src/main/java/com/example/project name/MainActivity.java 

...

public class MainActivity extends Activity {

  private PlayerView playerView;
  private ExoPlayer player;
  private ImaAdsLoader adsLoader;

  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    MultiDex.install(this);

    playerView = findViewById(R.id.player_view);

    // Create an AdsLoader.
      adsLoader =
        new ImaAdsLoader.Builder(/* context= */ this)
            .setAdEventListener(buildAdEventListener())
            .build();
  }

  public AdEvent.AdEventListener buildAdEventListener() {

    AdEvent.AdEventListener imaAdEventListener = event -> {
      AdEvent.AdEventType eventType = event.getType();
      // Log IMA events for debugging.
      // The ExoPlayer IMA extension already handles IMA events and does not need anything
      // additional here to function.
    };

    return imaAdEventListener;
  }

}

7. Inicjowanie i uruchamianie odtwarzacza

Dodaj metody, aby zainicjować i zwolnić odtwarzacz. W metodzie inicjowania utwórz SimpleExoPlayer. Następnie utwórz AdsMediaSource i ustaw go dla odtwarzacza.

app/src/main/java/com/example/project name/MainActivity.java 
public class MainActivity extends Activity {

  ...

  private void releasePlayer() {
    adsLoader.setPlayer(null);
    playerView.setPlayer(null);
    player.release();
    player = null;
  }

  private void initializePlayer() {
    // Set up the factory for media sources, passing the ads loader and ad view providers.
    DataSource.Factory dataSourceFactory = new DefaultDataSource.Factory(this);

    MediaSource.Factory mediaSourceFactory =
        new DefaultMediaSourceFactory(dataSourceFactory)
            .setLocalAdInsertionComponents(unusedAdTagUri -> adsLoader, playerView);

    // Create an ExoPlayer and set it as the player for content and ads.
    player = new ExoPlayer.Builder(this).setMediaSourceFactory(mediaSourceFactory).build();
    playerView.setPlayer(player);
    adsLoader.setPlayer(player);

    // Create the MediaItem to play, specifying the content URI and ad tag URI.
    Uri contentUri = Uri.parse(getString(R.string.content_url));
    Uri adTagUri = Uri.parse(getString(R.string.ad_tag_url));
    MediaItem mediaItem =
        new MediaItem.Builder()
            .setUri(contentUri)
            .setAdsConfiguration(new MediaItem.AdsConfiguration.Builder(adTagUri).build())
            .build();

    // Prepare the content and ad to be played with the SimpleExoPlayer.
    player.setMediaItem(mediaItem);
    player.prepare();

    // Set PlayWhenReady. If true, content and ads will autoplay.
    player.setPlayWhenReady(false);
  }
}

8. Obsługa zdarzeń odtwarzacza

Na koniec utwórz wywołania zwrotne dla zdarzeń cyklu życia gracza:

  • onStart
  • onResume
  • onStop
  • onPause
  • onDestroy
app/src/main/java/com/example/project name/MainActivity.java 
public class MainActivity extends Activity {

  private PlayerView playerView;
  private SimpleExoPlayer player;
  private ImaAdsLoader adsLoader;

  @Override
  protected void onCreate(Bundle savedInstanceState) {
      super.onCreate(savedInstanceState);
      setContentView(R.layout.activity_my);

      playerView = findViewById(R.id.player_view);

      // Create an AdsLoader.
      adsLoader =
        new ImaAdsLoader.Builder(/* context= */ this)
            .setAdEventListener(buildAdEventListener())
            .build();
  }

  @Override
  public void onStart() {
    super.onStart();
    //
    if (Util.SDK_INT > 23) {
      initializePlayer();
      if (playerView != null) {
        playerView.onResume();
      }
    }
  }

  @Override
  public void onResume() {
    super.onResume();
    if (Util.SDK_INT <= 23 || player == null) {
      initializePlayer();
      if (playerView != null) {
        playerView.onResume();
      }
    }
  }

  @Override
  public void onPause() {
    super.onPause();
    if (Util.SDK_INT <= 23) {
      if (playerView != null) {
        playerView.onPause();
      }
      releasePlayer();
    }
  }

  @Override
  public void onStop() {
    super.onStop();
    if (Util.SDK_INT > 23) {
      if (playerView != null) {
        playerView.onPause();
      }
      releasePlayer();
    }
  }

  @Override
  protected void onDestroy() {
    super.onDestroy();
    adsLoader.release();
  }

  ...

}

Znakomicie. Masz już żądanie i wyświetlanie reklam za pomocą pakietu IMA SDK. Informacje o dodatkowych funkcjach pakietu SDK znajdziesz w innych przewodnikach lub przykładach w GitHubie.