SDK IMA giúp bạn dễ dàng tích hợp quảng cáo đa phương tiện vào trang web và ứng dụng của mình. SDK IMA có thể yêu cầu quảng cáo từ bất kỳ máy chủ quảng cáo tuân thủ VAST nào và quản lý việc phát quảng cáo trong các ứng dụng của bạn. Với SDK IMA DAI, ứng dụng tạo một yêu cầu phát trực tuyến cho quảng cáo và video nội dung – VOD hoặc nội dung trực tiếp. Sau đó, SDK sẽ trả về một luồng video kết hợp để bạn không phải quản lý việc chuyển đổi giữa video quảng cáo và video nội dung trong ứng dụng của mình.
Chọn giải pháp DAI mà bạn quan tâm
DAI (Chèn quảng cáo động) đầy đủ dịch vụ
Hướng dẫn này minh hoạ cách tích hợp SDK IMA DAI vào một ứng dụng trình phát video đơn giản. Nếu bạn muốn xem hoặc làm theo quá trình tích hợp mẫu hoàn chỉnh, hãy tải BasicExample từ GitHub xuống.
Tổng quan về IMA DAI
Việc triển khai IMA DAI bao gồm 4 thành phần SDK chính như được minh hoạ trong hướng dẫn này:
StreamDisplayContainer: Đối tượng vùng chứa nằm phía trên phần tử phát video và chứa các phần tử trên giao diện người dùng của quảng cáo.AdsLoader: Một đối tượng yêu cầu luồng và xử lý các sự kiện được kích hoạt bởi các đối tượng phản hồi yêu cầu luồng. Bạn chỉ nên tạo thực thể cho một trình tải quảng cáo. Trình tải này có thể được sử dụng lại trong suốt thời gian hoạt động của ứng dụng.StreamRequest: Một đối tượng xác định yêu cầu luồng. Các yêu cầu phát trực tiếp có thể là video theo yêu cầu hoặc sự kiện phát trực tiếp. Các yêu cầu sẽ chỉ định một mã nhận dạng nội dung, cũng như khoá API hoặc mã xác thực và các tham số khác.StreamManager: Một đối tượng xử lý các lượt tương tác và luồng chèn quảng cáo động với phần phụ trợ DAI. Trình quản lý luồng cũng xử lý các ping theo dõi, đồng thời chuyển tiếp luồng và các sự kiện quảng cáo đến nhà xuất bản.
Điều kiện tiên quyết
- Android Studio
- Ứng dụng trình phát video mẫu để tích hợp SDK
Tải xuống và chạy ứng dụng trình phát video mẫu
Ứng dụng mẫu cung cấp một trình phát video hoạt động và phát video HLS. Hãy sử dụng thông tin này làm điểm xuất phát để tích hợp các tính năng DAI của SDK IMA DAI.
Tải ứng dụng trình phát video mẫu xuống rồi trích xuất ứng dụng đó.
Khởi động Android Studio rồi chọn Open an existing Android Studio project (Mở một dự án Android Studio hiện có), hoặc nếu Android Studio đang chạy, hãy chọn File > New > Import Project (Tệp > Mới > Nhập dự án). Sau đó chọn
SampleVideoPlayer/build.gradle.Chạy đồng bộ hoá Gradle bằng cách chọn Tools > Android > Sync Project with Gradle Files (Công cụ > Android > Đồng bộ hoá dự án với tệp Gradle).
Đảm bảo rằng ứng dụng trình phát biên dịch và chạy trên một thiết bị Android thực hoặc Thiết bị Android ảo bằng cách sử dụng Run > Run 'app' (Chạy > Chạy "ứng dụng"). Quá trình truyền trực tuyến video thường mất một vài phút để tải trước khi phát.
Kiểm tra trình phát video mẫu
Trình phát video mẫu chưa chứa bất kỳ mã tích hợp SDK IMA DAI nào. Ứng dụng mẫu bao gồm hai phần chính:
samplevideoplayer/SampleVideoPlayer.java: Một trình phát HLS dựa trên ExoPlayer làm cơ sở để tích hợp IMA DAI.videoplayerapp/MyActivity.java: Hoạt động này tạo trình phát video và truyền vào đóContextvàSimpleExoPlayerView.
Thêm SDK IMA DAI vào ứng dụng trình phát
Bạn cũng phải bao gồm tệp tham chiếu đến SDK IMA DAI. Trong Android Studio, hãy thêm đoạn mã sau vào tệp build.gradle ở cấp ứng dụng, nằm tại 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.34.0'
}
Tích hợp SDK IMA DAI
Tạo một lớp mới có tên là
SampleAdsWrappertrong góivideoplayerapp(trongapp/java/com.google.ads.interactivemedia.v3.samples/videoplayerapp/) để góiSampleVideoPlayerhiện có và thêm logic triển khai IMA DAI. Để làm điều này, trước tiên, bạn phải tạo mộtAdsLoaderdùng để yêu cầu quảng cáo từ máy chủ quảng cáo.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()); } }Thêm phương thức
buildStreamRequest()vàoAdsLoaderđể có thể yêu cầu luồng có quảng cáo. Đây có thể là một sự kiện phát trực tiếp có quảng cáo (được đặt theo mặc định) hoặc một sự kiện phát video theo yêu cầu(VOD) trong đó phát nội dung được ghi hình sẵn có quảng cáo. Để bật tính năng phát trực tiếp VOD, hãy bình luận về yêu cầu phát trực tiếp và huỷ nhận xét về yêu cầu phát trực tiếp VOD.Để làm việc với DAI, trình phát phải chuyển sự kiện ID3 cho các sự kiện phát trực tiếp sang SDK IMA DAI. Trong mã mẫu sau đây, việc này được thực hiện bằng phương thức
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; }Bạn cũng cần có
VideoStreamPlayerđể phát luồng, vì vậy, hãy thêm phương thứccreateVideoStreamPlayer()để tạo một lớp ẩn danh triển khaiVideoStreamPlayer.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; }Triển khai trình nghe bắt buộc và thêm tính năng hỗ trợ để xử lý lỗi.
Vui lòng lưu ý việc triển khai
AdErrorListener, vì phương thức này gọi URL dự phòng nếu quảng cáo không phát được. Vì nội dung và quảng cáo nằm trong một luồng, nên bạn phải sẵn sàng gọi luồng dự phòng nếu luồng DAI gặp lỗi.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; }Thêm mã để ghi nhật ký.
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); } }Sửa đổi
MyActivitytrongvideoplayerappđể tạo thực thể và gọiSampleAdsWrapper.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); } }); } ... }Sửa đổi tệp bố cục của Hoạt động
activity_my.xmlđể thêm các phần tử trên giao diện người dùng cho việc ghi nhật ký.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> ...
Xin chúc mừng! Bạn hiện đang yêu cầu và hiển thị các quảng cáo dạng video trong ứng dụng Android. Để tinh chỉnh cách triển khai, hãy xem phần Dấu trang, Quay lại và tài liệu về API.
Khắc phục sự cố
Nếu bạn gặp sự cố khi phát quảng cáo dạng video, hãy thử tải BasicExample hoàn chỉnh xuống. Nếu hình ảnh hoạt động đúng cách trong BasicExample, thì có thể có vấn đề với mã tích hợp IMA của ứng dụng.
Nếu bạn vẫn gặp vấn đề, hãy truy cập vào diễn đàn SDK IMA.