Mulai menggunakan IMA DAI SDK

IMA SDK memudahkan pengintegrasian iklan multimedia ke dalam situs dan aplikasi Anda. IMA SDK dapat minta iklan dari semua server iklan yang sesuai dengan VAST dan mengelola pemutaran iklan di aplikasi Anda. Dengan IMA DAI SDK, aplikasi membuat permintaan streaming untuk iklan dan video konten—baik VOD maupun konten live. SDK kemudian menampilkan gabungan streaming video, sehingga Anda tidak perlu mengelola peralihan antara iklan dan video konten dalam aplikasi Anda.

Pilih solusi DAI yang Anda minati

DAI layanan penuh

Panduan ini menunjukkan cara mengintegrasikan IMA DAI SDK ke dalam pemutar video sederhana . Jika Anda ingin melihat atau mengikuti contoh yang telah selesai integrasi, download BasicExample dari GitHub.

Ringkasan IMA DAI

Penerapan IMA DAI melibatkan empat komponen SDK utama seperti yang ditunjukkan dalam panduan:

  • StreamDisplayContainer: Objek penampung yang berada di atas elemen pemutaran video dan menampung elemen UI iklan.
  • AdsLoader: Objek yang meminta stream dan menangani peristiwa yang dipicu oleh objek respons permintaan streaming. Sebaiknya Anda hanya membuat instance satu loader iklan, yang dapat digunakan kembali selama masa pakai aplikasi.
  • StreamRequest: Objek yang menentukan permintaan streaming. Permintaan streaming dapat berupa video on demand atau live feed. Permintaan menentukan ID konten, serta kunci API atau token autentikasi, dan parameter.
  • StreamManager: Objek yang menangani interaksi dan streaming penyisipan iklan dinamis dengan backend DAI. Tujuan stream manager juga menangani ping pelacakan serta meneruskan streaming dan peristiwa iklan ke penayang.

Prasyarat

Mendownload dan menjalankan contoh aplikasi pemutar video

Aplikasi contoh menyediakan pemutar video yang berfungsi dan memutar video HLS. Gunakan ini sebagai titik awal untuk mengintegrasikan kemampuan DAI IMA DAI SDK.

  1. Download pemutar video sampel aplikasi dan mengekstraknya.

  2. Mulai Android Studio, pilih Open an existing Android Studio project, atau jika Android Studio sudah berjalan, pilih File > Baru > Impor Project. Lalu pilih SampleVideoPlayer/build.gradle.

  3. Jalankan sinkronisasi Gradle dengan memilih Tools > Android > Menyinkronkan Project dengan File Gradle.

  4. Pastikan aplikasi pemutar mengompilasi dan berjalan di perangkat Android fisik atau Perangkat Virtual Android menggunakan Run > Jalankan 'app'. Wajar saja untuk video tersebut streaming guna mengambil beberapa saat untuk dimuat sebelum diputar.

Memeriksa pemutar video sampel

Pemutar video contoh belum berisi kode integrasi IMA DAI SDK apa pun. Aplikasi contoh terdiri dari dua bagian utama:

  1. samplevideoplayer/SampleVideoPlayer.java: Pemutar HLS berbasis ExoPlayer yang berfungsi sebagai dasar untuk integrasi IMA DAI.

  2. videoplayerapp/MyActivity.java: Aktivitas ini membuat pemutar video dan meneruskan Context dan SimpleExoPlayerView ke dalamnya.

Menambahkan IMA DAI SDK ke aplikasi pemutar

Anda juga harus menyertakan referensi ke IMA DAI SDK. Di Android Studio, tambahkan berikut ke file build.gradle tingkat aplikasi, yang terletak di app/build.gradle:

repositories {
  google()
  mavenCentral()
}

dependencies {
    implementation 'androidx.appcompat:appcompat:1.6.1'
    implementation 'androidx.media3:media3-exoplayer:1.3.1'
    implementation 'com.google.ads.interactivemedia.v3:interactivemedia:3.35.0'
}

Mengintegrasikan IMA DAI SDK

  1. Buat class baru bernama SampleAdsWrapper di paket videoplayerapp (dalam app/java/com.google.ads.interactivemedia.v3.samples/videoplayerapp/) ke menggabungkan SampleVideoPlayer yang ada dan menambahkan logika yang menerapkan IMA DAI. Kepada melakukannya, Anda harus terlebih dahulu membuat AdsLoader yang digunakan untuk meminta iklan dari server iklan.

    videoplayerapp/SampleAdsWrapper.java
    package com.google.ads.interactivemedia.v3.samples.videoplayerapp;

import android.annotation.TargetApi;
import android.content.Context;
import android.os.Build;
import android.view.ViewGroup;
import android.webkit.WebView;

import com.google.ads.interactivemedia.v3.api.AdErrorEvent;
import com.google.ads.interactivemedia.v3.api.AdEvent;
import com.google.ads.interactivemedia.v3.api.AdsLoader;
import com.google.ads.interactivemedia.v3.api.AdsManagerLoadedEvent;
import com.google.ads.interactivemedia.v3.api.CuePoint;
import com.google.ads.interactivemedia.v3.api.ImaSdkFactory;
import com.google.ads.interactivemedia.v3.api.ImaSdkSettings;
import com.google.ads.interactivemedia.v3.api.StreamDisplayContainer;
import com.google.ads.interactivemedia.v3.api.StreamManager;
import com.google.ads.interactivemedia.v3.api.StreamRequest;
import com.google.ads.interactivemedia.v3.api.player.VideoProgressUpdate;
import com.google.ads.interactivemedia.v3.api.player.VideoStreamPlayer;
import com.google.ads.interactivemedia.v3.samples.samplevideoplayer.SampleVideoPlayer;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;

public class SampleAdsWrapper implements AdEvent.AdEventListener,
        AdErrorEvent.AdErrorListener, AdsLoader.AdsLoadedListener {

    // Livestream asset key.
    private static final String TEST_ASSET_KEY = "sN_IYUG8STe1ZzhIIE_ksA";

    // VOD content source and video IDs.
    private static final String TEST_CONTENT_SOURCE_ID = "2548831";
    private static final String TEST_VIDEO_ID = "tears-of-steel";

    private static final String PLAYER_TYPE = "DAISamplePlayer";

    /**
     * Log interface, so you can output the log commands to the UI or similar.
     */
    public interface Logger {
        void log(String logMessage);
    }

    private ImaSdkFactory sdkFactory;
    private AdsLoader adsLoader;
    private StreamDisplayContainer displayContainer;
    private StreamManager streamManager;
    private List<VideoStreamPlayer.VideoStreamPlayerCallback> playerCallbacks;

    private SampleVideoPlayer videoPlayer;
    private Context context;
    private ViewGroup adUiContainer;

    private String fallbackUrl;
    private Logger logger;

    public SampleAdsWrapper(Context context, SampleVideoPlayer videoPlayer,
                            ViewGroup adUiContainer) {
        this.videoPlayer = videoPlayer;
        this.context = context;
        this.adUiContainer = adUiContainer;
        sdkFactory = ImaSdkFactory.getInstance();
        playerCallbacks = new ArrayList<>();
        createAdsLoader();
        displayContainer = sdkFactory.createStreamDisplayContainer(
            this.adUiContainer,
            videoStreamPlayer
        );
    }

    private void createAdsLoader() {
        ImaSdkSettings settings = new ImaSdkSettings();
        adsLoader = sdkFactory.createAdsLoader(context);
    }

    public void requestAndPlayAds() {
        adsLoader.addAdErrorListener(this);
        adsLoader.addAdsLoadedListener(this);
        adsLoader.requestStream(buildStreamRequest());
    }
}

  2. Tambahkan metode buildStreamRequest() ke AdsLoader agar dapat meminta melakukan streaming dengan iklan. bisa berupa livestream dengan iklan (ditetapkan secara default) atau streaming video on-demand(VOD) yang memutar konten rekaman dengan iklan. Kepada mengaktifkan streaming VOD, menjadikan permintaan live stream sebagai komentar, dan menghapus tanda komentar Permintaan streaming VOD.

    Agar dapat digunakan dengan DAI, pemutar harus meneruskan peristiwa ID3 untuk livestream ke IMA DAI SDK. Pada kode contoh berikut, hal ini dilakukan oleh Metode callback.onUserTextReceived().

    videoplayerapp/SampleAdsWrapper.java
    private StreamRequest buildStreamRequest() {
    VideoStreamPlayer videoStreamPlayer = createVideoStreamPlayer();
    videoPlayer.setSampleVideoPlayerCallback(
            new SampleVideoPlayer.SampleVideoPlayerCallback() {
                @Override
                public void onUserTextReceived(String userText) {
                    for (VideoStreamPlayer.VideoStreamPlayerCallback callback :
                            playerCallbacks) {
                        callback.onUserTextReceived(userText);
                    }
                }

                @Override
                public void onSeek(int windowIndex, long positionMs) {
                    // See if you would seek past an ad, and if so, jump back to it.
                    long newSeekPositionMs = positionMs;
                    if (streamManager != null) {
                        CuePoint prevCuePoint  =
                                streamManager.getPreviousCuePointForStreamTime(positionMs / 1000);
                        if (prevCuePoint != null && !prevCuePoint.isPlayed()) {
                            newSeekPositionMs = (long) (prevCuePoint.getStartTime() * 1000);
                        }
                    }
                    videoPlayer.seekTo(windowIndex, newSeekPositionMs);
                }

                @Override
                public void onContentComplete() {
                    for (VideoStreamPlayer.VideoStreamPlayerCallback callback : playerCallbacks) {
                        callback.onContentComplete();
                    }
                }

                @Override
                public void onPause() {
                    for (VideoStreamPlayer.VideoStreamPlayerCallback callback : playerCallbacks) {
                        callback.onPause();
                    }
                }

                @Override
                public void onResume() {
                    for (VideoStreamPlayer.VideoStreamPlayerCallback callback : playerCallbacks) {
                        callback.onResume();
                    }
                }

                @Override
                public void onVolumeChanged(int percentage) {
                    for (VideoStreamPlayer.VideoStreamPlayerCallback callback : playerCallbacks) {
                        callback.onVolumeChanged(percentage);
                    }
                }
            });

    // Livestream request.
    StreamRequest request = sdkFactory.createLiveStreamRequest(
            TEST_ASSET_KEY, null, displayContainer);

    // VOD request. Comment the createLiveStreamRequest() line above and uncomment this
    // createVodStreamRequest() below to switch from a livestream to a VOD stream.
    // StreamRequest request = sdkFactory.createVodStreamRequest(TEST_CONTENT_SOURCE_ID,
    //        TEST_VIDEO_ID, null, displayContainer);
    return request;
}

  3. Anda juga memerlukan VideoStreamPlayer untuk memutar streaming, jadi tambahkan createVideoStreamPlayer(), yang membuat class anonim yang mengimplementasikan VideoStreamPlayer.

    videoplayerapp/SampleAdsWrapper.java
    private VideoStreamPlayer createVideoStreamPlayer() {
    VideoStreamPlayer player = new VideoStreamPlayer() {
        @Override
        public void loadUrl(String url, List<HashMap<String, String>> subtitles) {
            videoPlayer.setStreamUrl(url);
            videoPlayer.play();
        }

        @Override
        public void addCallback(
            VideoStreamPlayerCallback videoStreamPlayerCallback) {
                playerCallbacks.add(videoStreamPlayerCallback);
        }

        @Override
        public void removeCallback(
            VideoStreamPlayerCallback videoStreamPlayerCallback) {
                playerCallbacks.remove(videoStreamPlayerCallback);
        }

        @Override
        public void onAdBreakStarted() {
            // Disable player controls.
            videoPlayer.enableControls(false);
            log("Ad Break Started\n");
        }

        @Override
        public void onAdBreakEnded() {
            // Re-enable player controls.
            videoPlayer.enableControls(true);
            log("Ad Break Ended\n");
        }

        @Override
        public VideoProgressUpdate getContentProgress() {
            return new VideoProgressUpdate(videoPlayer.getCurrentPosition(),
                    videoPlayer.getDuration());
        }

        @Override
        public int getVolume() {
            return videoPlayer.getVolume();
        }
    };
    return player;
}

  4. Implementasikan pemroses yang diperlukan dan tambahkan dukungan untuk penanganan error.

    Perhatikan implementasi AdErrorListener, karena memanggil URL fallback jika iklan gagal diputar. Karena konten dan iklan berada dalam satu streaming, Anda harus siap memanggil streaming fallback jika streaming DAI mengalami error.

    videoplayerapp/SampleAdsWrapper.java
    /** AdErrorListener implementation **/
@Override
public void onAdError(AdErrorEvent event) {
    // play fallback URL.
    videoPlayer.setStreamUrl(fallbackUrl);
    videoPlayer.enableControls(true);
    videoPlayer.play();
}

/** AdEventListener implementation **/
@Override
public void onAdEvent(AdEvent event) {
    switch (event.getType()) {
        case AD_PROGRESS:
            // Do nothing or else log are filled by these messages.
            break;
        default:
            log(String.format("Event: %s\n", event.getType()));
            break;
    }
}

/** AdsLoadedListener implementation **/
@Override
public void onAdsManagerLoaded(AdsManagerLoadedEvent event) {
    streamManager = event.getStreamManager();
    streamManager.addAdErrorListener(this);
    streamManager.addAdEventListener(this);
    streamManager.init();
}

/** Sets fallback URL in case ads stream fails. **/
void setFallbackUrl(String url) {
    fallbackUrl = url;
}

  5. Tambahkan kode untuk logging.

    videoplayerapp/SampleAdsWrapper.java
    /** Sets logger for displaying events to screen. Optional. **/
void setLogger(Logger logger) {
    this.logger = logger;
}

private void log(String message) {
    if (logger != null) {
        logger.log(message);
    }
}

  6. Ubah MyActivity di videoplayerapp untuk membuat instance dan memanggil SampleAdsWrapper.

    videoplayerapp/MyActivity.java
    import android.view.ViewGroup;
import android.widget.ScrollView;
...
public class MyActivity extends AppCompatActivity {
...
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_my);
        View rootView = findViewById(R.id.videoLayout);
        videoPlayer = new SampleVideoPlayer(rootView.getContext(),
                (SimpleExoPlayerView) rootView.findViewById(R.id.playerView));
        videoPlayer.enableControls(false);

        final SampleAdsWrapper sampleAdsWrapper = new SampleAdsWrapper(this, videoPlayer,
            (ViewGroup) rootView.findViewById(R.id.adUiContainer));
        sampleAdsWrapper.setFallbackUrl(DEFAULT_STREAM_URL);

        final ScrollView scrollView = (ScrollView) findViewById(R.id.logScroll);
        final TextView textView = (TextView) findViewById(R.id.logText);

        sampleAdsWrapper.setLogger(new SampleAdsWrapper.Logger() {
            @Override
            public void log(String logMessage) {
                Log.i(APP_LOG_TAG, logMessage);
                if (textView != null) {
                    textView.append(logMessage);
                }
                if (scrollView != null) {
                    scrollView.post(new Runnable() {
                        @Override
                        public void run() {
                            scrollView.fullScroll(View.FOCUS_DOWN);
                        }
                    });
                }
            }
        });

        playButton = (ImageButton) rootView.findViewById(R.id.playButton);
        // Set up play button listener to play video then hide play button.
        playButton.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                sampleAdsWrapper.requestAndPlayAds();
                playButton.setVisibility(View.GONE);
            }
        });
    }
...
}

  7. Ubah file tata letak Aktivitas activity_my.xml untuk menambahkan elemen UI pembuatan log.

    res/layout/activity_my.xml
    ...
    <TextView
        android:id="@+id/playerDescription"
        android:text="@string/video_description"
        android:textAlignment="center"
        android:gravity="center_horizontal"
        android:layout_width="match_parent"
        android:layout_height="0dp"
        android:layout_weight="0.1"
        android:textSize="@dimen/font_size" />
    <!-- UI element for viewing SDK event log -->
    <ScrollView
        android:id="@+id/logScroll"
        android:layout_width="match_parent"
        android:layout_height="0dp"
        android:layout_weight="0.5"
        android:padding="5dp"
        android:background="#DDDDDD">

        <TextView
            android:id="@+id/logText"
            android:layout_width="match_parent"
            android:layout_height="wrap_content">
        </TextView>
    </ScrollView>
...

Selamat! Anda kini meminta dan menampilkan iklan video di Android . Untuk menyesuaikan penerapan, lihat Bookmark, Snapback, dan API dokumentasi.

Pemecahan masalah

Jika Anda mengalami masalah saat memutar iklan video, coba download iklan video yang telah selesai BasicExample. Jika konfigurasinya berjalan dengan baik di BasicExample, maka kemungkinan ada masalah dengan kode integrasi IMA aplikasi Anda.

Jika Anda masih mengalami masalah, buka IMA SDK forum ini.