このページは Cloud Translation API によって翻訳されました。

IMA DAI SDK スタートガイド

IMA SDK を使用すると、ウェブサイトやアプリにマルチメディア広告を簡単に統合できます。IMA SDK は任意のネットワークから広告をリクエストし、 <ph type="x-smartling-placeholder"></ph> VAST 準拠の広告サーバーを実装し、アプリでの広告再生を管理できます。IMA DAI SDK を使用すると、広告およびコンテンツ動画（VOD またはライブコンテンツ）のストリームリクエスト。すると、SDK は統合動画ストリームであるため、広告とコンテンツ動画の切り替えを管理する手間が省けます。確認できます。

ご希望の DAI ソリューションを選択する

フルサービス DAI

このガイドでは、IMA DAI SDK をシンプルな動画プレーヤーに統合する方法を説明します。。完成したサンプルを表示または BasicExample を GitHub で管理できます。

IMA DAI の概要

IMA DAI の実装には、こちらのガイド:

StreamDisplayContainer: 動画再生要素の上に配置され、広告の UI 要素を格納するコンテナオブジェクト。
AdsLoader: ストリームをリクエストし、ストリームリクエストレスポンスオブジェクトによってトリガーされたイベントを処理するオブジェクト。広告ローダは 1 つのみインスタンス化してください。このローダは、説明します。
StreamRequest: ストリームリクエストを定義するオブジェクト。ストリーミングリクエストはビデオオンデマンドまたはライブ使用できます。リクエストでは、Content ID、API キーまたは認証トークン、あります。
StreamManager: ダイナミック広告挿入のストリームと DAI バックエンドとのインタラクションを処理するオブジェクト。「ストリームマネージャーはトラッキング ping も処理し、あります。

前提条件

Android Studio
SDK 統合用の動画プレーヤーアプリのサンプル

サンプルの動画プレーヤーアプリをダウンロードして実行する

サンプルアプリには、HLS 動画を再生できる動画プレーヤーが用意されています。次の用途で使用は、IMA DAI SDK の DAI 機能を統合するための出発点となります。

サンプルの動画プレーヤーをダウンロードします。アプリ抽出できます。
Android Studio を起動し、[Open an existing Android Studio project] を選択します。 Android Studio がすでに実行されている場合は、[File] >新規 >インポートプロジェクトです。[SampleVideoPlayer/build.gradle] を選択します。
[Tools] > [Android >プロジェクトと Gradle ファイルを同期するをご覧ください。
プレーヤーアプリが実際の Android デバイスまたは実際の Android デバイス上でコンパイルされ、実行されることを確認します。 [Run] > [Run >'app' を実行します。この動画では、読み込みが完了するまで少し時間がかかります。

で確認できます。

サンプルの動画プレーヤーを確認する

サンプル動画プレーヤーには、IMA DAI SDK の統合コードがまだ含まれていません。このサンプルアプリは、主に次の 2 つの部分で構成されています。

samplevideoplayer/SampleVideoPlayer.java: 以下として機能する ExoPlayer ベースの HLS プレーヤー。 IMA DAI 統合の基礎となっています。
videoplayerapp/MyActivity.java: このアクティビティでは動画プレーヤーが作成され、 Context と SimpleExoPlayerView を渡します。

プレーヤーアプリに IMA DAI SDK を追加する

また、IMA DAI SDK への参照も含める必要があります。Android Studio で、次の場所にあるアプリケーションレベルの build.gradle ファイルに追加します。 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'
}

IMA DAI SDK を統合する

videoplayerapp パッケージに SampleAdsWrapper という新しいクラスを作成します。（app/java/com.google.ads.interactivemedia.v3.samples/videoplayerapp/）～既存の SampleVideoPlayer をラップし、IMA DAI を実装するロジックを追加します。宛先そのためには、まず、広告のリクエストに使用する AdsLoader を作成する必要があります配信できるようになります。

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

buildStreamRequest() メソッドを AdsLoader に追加して、ストリーミングできます。広告が表示されるライブ配信（デフォルトで設定）か、あらかじめ録画されたコンテンツを広告付きで再生するビデオオンデマンド（VOD）ストリーム。宛先 VOD ストリームを有効にし、ライブ配信リクエストをコメントアウトして、コメント化解除します。 VOD ストリームのリクエスト。

DAI を使用するには、ライブストリームの ID3 イベントを IMA DAI に渡す必要があります。使用できます。次のサンプルコードでは、 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;
}

ストリームを再生するには VideoStreamPlayer も必要です。 createVideoStreamPlayer() メソッドがあります。このメソッドは、 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;
}

必要なリスナーを実装し、エラー処理のサポートを追加します。

AdErrorListener の実装に注目してください。これは、URL が置き換えられると代替 URL が呼び出されるため、広告を再生できない。コンテンツと広告は 1 つのストリーム内にあるため、 DAI ストリームでエラーが発生した場合に代替ストリームを呼び出せる状態にしておく

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

ロギングのコードを追加します。

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

videoplayerapp の MyActivity を変更して、インスタンス化して呼び出す 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);
            }
        });
    }
...
}

アクティビティの UI 要素を追加するように、アクティビティのレイアウトファイル activity_my.xml を変更します。説明します。

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>
...

おめでとうございます。Android で動画広告をリクエストして表示できるようになりました。実装を微調整するには、以下をご覧ください。ブックマーク、 Snapback と API ドキュメントをご覧ください。

トラブルシューティング

動画広告の再生に問題がある場合は、再生済みの動画広告をダウンロードしてみてください BasicExample BasicExample で正しく機能する場合は、追加する必要があります

それでも問題が解決しない場合は、IMA SDK にアクセスしてください。フォーラムをご覧ください。

IMA DAI SDK スタートガイド

フルサービス DAI

IMA DAI の概要

前提条件

サンプルの動画プレーヤー アプリをダウンロードして実行する

サンプルの動画プレーヤーを確認する

プレーヤー アプリに IMA DAI SDK を追加する

IMA DAI SDK を統合する

videoplayerapp/SampleAdsWrapper.java

videoplayerapp/SampleAdsWrapper.java

videoplayerapp/SampleAdsWrapper.java

videoplayerapp/SampleAdsWrapper.java

videoplayerapp/SampleAdsWrapper.java

videoplayerapp/MyActivity.java

res/layout/activity_my.xml

トラブルシューティング

サンプルの動画プレーヤーアプリをダウンロードして実行する

プレーヤーアプリに IMA DAI SDK を追加する