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 nào tuân thủ VAST và quản lý việc phát quảng cáo trong ứng dụng của bạn. Với SDK IMA DAI, ứng dụng sẽ tạo một yêu cầu truyền phát 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 quảng cáo và video nội dung trong ứng dụng.
Chọn giải pháp DAI mà bạn quan tâm
DAI trọn gói
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 một ví dụ tích hợp mẫu đã hoàn tất, hãy tải ví dụ đơn giản xuống từ GitHub.
Tổng quan về IMA DAI
Việc triển khai SDK IMA DAI bao gồm hai thành phần chính như minh hoạ trong hướng dẫn này:
StreamRequest
–VODStreamRequest
hoặcLiveStreamRequest
: Một đối tượng xác định yêu cầu truyền trực tuyến. Yêu cầu phát trực tuyến có thể là cho video theo yêu cầu hoặc sự kiện phát trực tiếp. Các yêu cầu chỉ định mã nội dung, cũng như khoá API hoặc mã thông báo xác thực và các thông số khác.StreamManager
: Một đối tượng xử lý các luồng chèn quảng cáo động và tương tác với phần phụ trợ DAI. Trình quản lý luồng cũng xử lý ping theo dõi và chuyển tiếp sự kiện quảng cáo và luồng đến nhà xuất bản.
Điều kiện tiên quyết
- Ba tệp trống
- dai.html
- dai.css
- dai.js
- Python đã cài đặt trên máy tính hoặc máy chủ web để dùng cho việc kiểm thử
Khởi động máy chủ phát triển
Vì SDK IMA DAI tải các phần phụ thuộc bằng cùng một giao thức với trang tải phần phụ thuộc, nên bạn cần sử dụng máy chủ web để kiểm thử ứng dụng. Một cách nhanh chóng để khởi động máy chủ phát triển cục bộ là sử dụng máy chủ tích hợp sẵn của Python.
Sử dụng dòng lệnh, từ thư mục chứa tệp
index.html
, hãy chạy:python -m http.server 8000
Trong trình duyệt web, hãy chuyển đến
http://localhost:8000/
Bạn cũng có thể sử dụng bất kỳ máy chủ web nào khác, chẳng hạn như Máy chủ HTTP Apache.
Tạo trình phát video đơn giản
Trước tiên, hãy sửa đổi dai.html để tạo một phần tử video HTML5 đơn giản và một div để sử dụng cho lượt nhấp. Ngoài ra, hãy thêm các thẻ cần thiết để tải các tệp dai.css và dai.js, cũng như để nhập trình phát video hls.js
. Sau đó, hãy sửa đổi dai.css để chỉ định kích thước và vị trí của các phần tử trang.
Cuối cùng, trong dai.js, hãy xác định các biến để lưu trữ thông tin yêu cầu luồng và một hàm initPlayer()
để chạy khi trang tải.
dai.html
<html>
<head>
<script src="https://cdn.jsdelivr.net/npm/hls.js@latest"></script>
<script src="dai.js"></script>
<link rel="stylesheet" href="dai.css" type="text/css">
</head>
<body onLoad="initPlayer()">
<h2>IMA DAI SDK DAI Demo (HLS.JS)</h2>
<video id="video"></video>
<div id="ad-ui"></div>
</body>
</html>
dai.css
#video,
#ad-ui {
width: 640px;
height: 360px;
position: absolute;
top: 35px;
left: 0;
}
#ad-ui {
cursor: pointer;
}
dai.js
var BACKUP_STREAM =
'https://storage.googleapis.com/interactive-media-ads/media/bbb.m3u8'
// Livestream asset key.
var TEST_ASSET_KEY = "sN_IYUG8STe1ZzhIIE_ksA";
// VOD content source and video IDs.
var TEST_CONTENT_SOURCE_ID = "2548831";
var TEST_VIDEO_ID = "tears-of-steel";
var hls = new Hls(); // hls.js video player
var videoElement;
var adUiElement;
var isAdBreak;
function initPlayer() {
videoElement = document.getElementById('video');
adUiElement = document.getElementById('adUi');
}
Tải SDK IMA DAI
Tiếp theo, hãy thêm khung IMA bằng cách sử dụng thẻ tập lệnh trong dai.html, trước thẻ cho dai.js.
dai.html
<html>
<head>
<script src="https://cdn.jsdelivr.net/npm/hls.js@latest"></script>
<script type="text/javascript" src="//imasdk.googleapis.com/js/sdkloader/ima3_dai.js"></script>
<script src="dai.js"></script>
<link rel="stylesheet" href="dai.css" type="text/css">
</head>
Khởi chạy StreamManager và tạo yêu cầu truyền trực tuyến
Để yêu cầu một nhóm quảng cáo, hãy tạo một ima.dai.api.StreamManager
. Lớp này chịu trách nhiệm yêu cầu và quản lý luồng DAI. Hàm khởi tạo lấy một thành phần video và thực thể thu được sẽ lấy một thành phần giao diện người dùng quảng cáo để xử lý các lượt nhấp vào quảng cáo.
Sau đó, hãy xác định các hàm yêu cầu luồng. Ví dụ này bao gồm các hàm cho cả VOD và sự kiện phát trực tiếp, tạo các thực thể của VODStreamRequest
và LiveStreamRequest
tương ứng, sau đó gọi streamManager.requestStream()
bằng các tham số streamRequest
. Đối với sự kiện phát trực tiếp, bạn cũng cần thêm một trình xử lý để theo dõi các sự kiện siêu dữ liệu theo thời gian và chuyển tiếp các sự kiện đó đến StreamManager
. Bạn có thể chú thích hoặc bỏ chú thích mã để phù hợp với trường hợp sử dụng của mình.
Cả hai phương thức đều sử dụng một khoá API không bắt buộc. Nếu đang sử dụng luồng được bảo vệ, bạn cần tạo khoá xác thực DAI.
Cả hai luồng trong ví dụ này đều không được bảo vệ, vì vậy apiKey
không được sử dụng.
dai.js
function initPlayer() {
videoElement = document.getElementById('video');
adUiElement = document.getElementById('adUi');
streamManager = new google.ima.dai.api.StreamManager(videoElement, adUiElement)
// Timed metadata is only used for LIVE streams.
hls.on(Hls.Events.FRAG_PARSING_METADATA, function(event, data) {
if (streamManager && data) {
// For each ID3 tag in the metadata, pass in the type - ID3, the
// tag data (a byte array), and the presentation timestamp (PTS).
data.samples.forEach(function(sample) {
streamManager.processMetadata('ID3', sample.data, sample.pts);
});
}
});
requestVODStream(TEST_CONTENT_SOURCE_ID, TEST_VIDEO_ID, null);
// Uncomment the line below and comment out the one above to request a
// LIVE stream instead of a VOD stream.
//requestLiveStream(TEST_ASSET_KEY, null);
}
function requestVODStream(cmsId, videoId, apiKey) {
var streamRequest = new google.ima.dai.api.VODStreamRequest();
streamRequest.contentSourceId = cmsId;
streamRequest.videoId = videoId;
streamRequest.apiKey = apiKey;
streamManager.requestStream(streamRequest);
}
function requestLiveStream(assetKey, apiKey) {
var streamRequest = new google.ima.dai.api.LiveStreamRequest();
streamRequest.assetKey = assetKey;
streamRequest.apiKey = apiKey;
streamManager.requestStream(streamRequest);
}
Xử lý sự kiện phát trực tuyến
Cuối cùng, bạn cần triển khai trình nghe sự kiện cho các sự kiện video chính. Ví dụ đơn giản này xử lý các sự kiện LOADED
, ERROR
, AD_BREAK_STARTED
và AD_BREAK_ENDED
bằng cách gọi hàm onStreamEvent()
. Hàm này xử lý lỗi và quá trình tải luồng, cũng như tắt các nút điều khiển trình phát trong khi quảng cáo đang phát (đây là yêu cầu của SDK). Khi luồng được tải, trình phát video sẽ tải và phát URL được cung cấp bằng hàm loadUrl()
.
Bạn cũng nên thiết lập trình nghe sự kiện cho các sự kiện pause
và start
của phần tử video để cho phép người dùng tiếp tục phát khi IMA tạm dừng trong các khoảng nghỉ quảng cáo.
Để hoạt động với DAI, trình phát tuỳ chỉnh của bạn phải truyền các sự kiện ID3 cho sự kiện phát trực tiếp đến SDK DAI IMA như trong mã mẫu.
dai.js
var isAdBreak;
function initPlayer() {
videoElement = document.getElementById('video');
adUiElement = document.getElementById('adUi');
streamManager = new google.ima.dai.api.StreamManager(videoElement, adUiElement);
videoElement.addEventListener('pause', onStreamPause);
videoElement.addEventListener('play', onStreamPlay);
streamManager.addEventListener(
[google.ima.dai.api.StreamEvent.Type.LOADED,
google.ima.dai.api.StreamEvent.Type.ERROR,
google.ima.dai.api.StreamEvent.Type.AD_BREAK_STARTED,
google.ima.dai.api.StreamEvent.Type.AD_BREAK_ENDED],
onStreamEvent,
false);
...
function onStreamEvent(e) {
switch (e.type) {
case google.ima.dai.api.StreamEvent.Type.LOADED:
console.log('Stream loaded');
loadUrl(e.getStreamData().url);
break;
case google.ima.dai.api.StreamEvent.Type.ERROR:
console.log('Error loading stream, playing backup stream.' + e);
loadUrl(BACKUP_STREAM);
break;
case google.ima.dai.api.StreamEvent.Type.AD_BREAK_STARTED:
console.log('Ad Break Started');
isAdBreak = true;
videoElement.controls = false;
adUiElement.style.display = 'block';
break;
case google.ima.dai.api.StreamEvent.Type.AD_BREAK_ENDED:
console.log('Ad Break Ended');
isAdBreak = false;
videoElement.controls = true;
adUiElement.style.display = 'none';
break;
default:
break;
}
}
function loadUrl(url) {
console.log('Loading:' + url);
hls.loadSource(url);
hls.attachMedia(videoElement);
hls.on(Hls.Events.MANIFEST_PARSED, function() {
console.log('Video Play');
videoElement.play();
});
}
function onStreamPause() {
console.log('paused');
if (isAdBreak) {
videoElement.controls = true;
adUiElement.style.display = 'none';
}
}
function onStreamPlay() {
console.log('played');
if (isAdBreak) {
videoElement.controls = false;
adUiElement.style.display = 'block';
}
}
Vậy là xong! Bạn hiện đang yêu cầu và hiển thị quảng cáo bằng SDK IMA DAI. Để tìm hiểu về các tính năng SDK nâng cao hơn, hãy xem các hướng dẫn khác hoặc mẫu trên GitHub.