Để thảo luận và đưa ra ý kiến phản hồi về các sản phẩm của chúng tôi, hãy tham gia kênh Discord chính thức của Ad Manager trong máy chủ Cộng đồng quảng cáo và đo lường của Google.

Trang này được dịch bởi Cloud Translation API.

SDK IMA DAI cho Roku

Lớp ima

Phương thức

disableLogging, getStreamManager, initSdk, requestStream

Các hàm chung kiểm soát SDK IMA.

`disableLogging()`

Tắt tính năng ghi nhật ký SDK. Tính năng ghi nhật ký sẽ bật theo mặc định.

`getStreamManager()`

Trả về một trình quản lý luồng nếu có. Nếu trình quản lý luồng phát chưa có sẵn, hệ thống sẽ trả về Invalid. Nếu xảy ra lỗi khi tạo trình quản lý luồng, thì một đối tượng lỗi sẽ được trả về.

Trả về object: Trình quản lý luồng hoặc đối tượng lỗi.

`initSdk(settings)`

Khởi chạy SDK.

Thông số	Loại	Mô tả
`settings`	`object`	Đối tượng chế độ cài đặt IMA không bắt buộc.

`requestStream(streamRequest)`

Bắt đầu một yêu cầu phát trực tiếp không đồng bộ. Lệnh điều khiển sẽ ngay lập tức quay lại trình phát sau khi gọi phương thức này.

Trả về object: lỗi hoặc không hợp lệ nếu không có lỗi

Thông số	Loại	Mô tả
`streamRequest`	`object`

Tên	Loại	Mô tả
`adPosition`		Chỉ mục của quảng cáo trong điểm chèn quảng cáo. Chỉ mục này là `1` cho quảng cáo độc lập.
`duration`		Thời lượng tối đa của khoảng thời gian này (tính bằng giây) hoặc `-1` nếu không xác định được.
`podIndex`		Đối với sự kiện phát trực tiếp, trả về mã nhận dạng điểm chèn dưới dạng chỉ mục nhóm hoặc `0` cho quảng cáo phát trước video. Không có quảng cáo sau video trong sự kiện phát trực tiếp. Giá trị mặc định là `-2`. Đối với video theo yêu cầu (VOD), trả về chỉ mục của nhóm quảng cáo. Đối với nhóm quảng cáo trong phần đầu video, hãy trả về `0`. Đối với quảng cáo trong video, hãy trả về `1`, `2`, ..., n. Đối với một nhóm quảng cáo cuối video, hàm này trả về n+1...n+x. Mặc định là `0` nếu quảng cáo này không thuộc một nhóm quảng cáo hoặc nhóm quảng cáo này không thuộc một danh sách phát.
`timeOffset`		Vị trí của nhóm trong nội dung, tính bằng giây. Quảng cáo đầu video trả về `0`, quảng cáo cuối video trả về `-1` và quảng cáo trong video trả về thời gian theo lịch của nhóm quảng cáo.
`totalAds`		Tổng số quảng cáo có trong thời điểm hiển thị quảng cáo này. Giá trị là `1` đối với quảng cáo độc lập.

Tên	Loại	Mô tả
`AD_PERIOD_ENDED`		Sự kiện này sẽ kích hoạt mỗi khi luồng phát chuyển từ quảng cáo hoặc đoạn chặn sang nội dung. Sự kiện này sẽ được kích hoạt ngay cả khi quảng cáo được phát lần thứ hai hoặc khi người dùng tìm đến một quảng cáo.
`AD_PERIOD_STARTED`		Sự kiện này sẽ kích hoạt mỗi khi luồng phát chuyển từ nội dung sang quảng cáo hoặc đoạn chặn. Sự kiện này sẽ được kích hoạt ngay cả khi quảng cáo được phát lần thứ hai hoặc khi người dùng tìm đến một quảng cáo.
`COMPLETE`		Được kích hoạt khi quảng cáo phát hết thời lượng.
`ERROR`		Được kích hoạt khi xảy ra lỗi.
`FIRST_QUARTILE`		Được kích hoạt khi đầu phát quảng cáo vượt qua tứ phân vị đầu tiên.
`ICON_FALLBACK_IMAGE_CLOSED`		Được kích hoạt khi người dùng đóng hộp thoại hình ảnh dự phòng của biểu tượng.
`ICON_FALLBACK_IMAGE_SHOWN`		Được kích hoạt khi hình ảnh dự phòng của biểu tượng xuất hiện.
`MIDPOINT`		Được kích hoạt khi đầu phát quảng cáo vượt qua điểm giữa.
`PROGRESS`		Được kích hoạt khi có thông tin cập nhật về tiến trình của quảng cáo.
`SKIPPABLE_STATE_CHANGED`		Được kích hoạt khi trạng thái có thể bỏ qua của quảng cáo thay đổi.
`SKIPPED`		Được kích hoạt khi quảng cáo bị bỏ qua.
`START`		Được kích hoạt khi quảng cáo bắt đầu phát.
`THIRD_QUARTILE`		Được kích hoạt khi đầu phát quảng cáo vượt qua tứ phân vị thứ ba.

Tên	Loại	Mô tả
`adBreakInfo`		Thông tin liên quan đến toàn bộ điểm chèn quảng cáo mà quảng cáo này xuất hiện.
`adDescription`		Nội dung mô tả của quảng cáo.
`adId`		Mã nhận dạng của quảng cáo hoặc một chuỗi trống nếu không xác định được.
`adSystem`		Hệ thống quảng cáo cung cấp mẫu quảng cáo.
`adTitle`		Tiêu đề của quảng cáo.
`advertiserName`		Tên nhà quảng cáo do bên phân phát xác định.
`companions`		Quảng cáo đồng hành được chỉ định trong phản hồi VAST.
`creativeAdId`		Mã ISCI (Giá trị nhận dạng thương mại theo tiêu chuẩn ngành) cho một quảng cáo. Đây là Ad-ID của mẫu quảng cáo đã chọn trong phản hồi VAST.
`creativeId`		Mã nhận dạng của mẫu quảng cáo đã chọn cho quảng cáo.
`currentTime`		Thời gian hiện tại trong một quảng cáo tính bằng giây hoặc -1 nếu không xác định được.
`dealId`		Trả về mã giao dịch đầu tiên có trong chuỗi trình bao bọc cho quảng cáo hiện tại, bắt đầu từ trên cùng.
`duration`		Thời lượng của quảng cáo đơn này tính bằng giây hoặc -1 nếu không xác định.
`skipOffset`		Thời gian cần thiết để quảng cáo có thể bỏ qua hoặc -1 nếu không xác định được.
`universalAdIDRegistry`		Một chuỗi dùng để xác định URL cho trang web đăng ký nơi Mã nhận dạng quảng cáo chung của mẫu quảng cáo đã chọn được lập danh mục.
`universalAdIDValue`		Universal Ad ID của mẫu quảng cáo đã chọn cho quảng cáo.
`wrappers`		Một mảng ima.WrapperInfo có thông tin về trình bao bọc cho quảng cáo này. Thứ tự sẽ từ trình bao bọc bên ngoài đến trình bao bọc bên trong.

Tên	Loại	Mô tả
`adSlotId`		Mã vị trí quảng cáo của quảng cáo đồng hành. Để trống nếu không có.
`apiFramework`		API cần thiết để thực thi quảng cáo này hoặc Không hợp lệ nếu không có sẵn.
`companionClickThrough`		URL nhấp qua của quảng cáo đồng hành.
`creativeType`		Đại diện cho creativetype thường là một loại MIME.
`height`		Chiều cao của quảng cáo đồng hành tính bằng pixel. 0 nếu không có.
`trackingEvents`		Bản đồ theo dõi các sự kiện, trong đó khoá là sự kiện và giá trị là danh sách các URL cần ping khi có sự kiện đó.
`url`		URL cho tài nguyên tĩnh của thành phần đi kèm này.
`width`		Chiều rộng của quảng cáo đồng hành, tính bằng pixel. 0 nếu không có.

Tên	Loại	Mô tả
`end`		Thời gian kết thúc của một điểm đánh dấu tính bằng giây. Điều này tương ứng với một khoảng thời gian chèn quảng cáo.
`hasPlayed`		Giá trị boolean cho biết cuepoint đã phát.
`start`		Thời gian bắt đầu của một điểm đánh dấu tính bằng giây. Điều này tương ứng với một khoảng thời gian chèn quảng cáo.

Tên	Loại	Mô tả
`id`		Mã của lỗi. Hãy xem hằng số ErrorEvent để biết danh sách mã lỗi.
`info`		Thông tin bổ sung về lỗi.
`type`		Luôn đặt thành lỗi để cho biết loại đối tượng này.

Tên	Loại	Mô tả
`BAD_STREAM_REQUEST`		Yêu cầu phát trực tiếp không được điền đúng cách.
`COULD_NOT_LOAD_STREAM`		Không tải được luồng.
`ERROR`		Lỗi không xác định.
`INVALID_RESPONSE`		Phản hồi của máy chủ không hợp lệ.
`STREAM_API_KEY_NOT_VALID`		Máy chủ không chấp nhận khoá API được cung cấp.

Tên	Loại	Mô tả
`format`		Định dạng của video: hls hoặc dash. Được xác định trong ima.StreamFormat.
`manifest`		URL của sự kiện phát trực tiếp.
`streamId`		Mã nhận dạng duy nhất của luồng phát.
`streamType`		Loại video: trực tiếp hoặc theo yêu cầu. Được xác định trong ima.StreamType.
`subtitles`		Phụ đề (nếu có). Không hợp lệ nếu không.

Thông số	Loại	Mô tả
`streamRequest`	`ima.StreamRequest`
`streamInitResponse`	`ima.StreamInitResponse`

Thông số	Loại	Mô tả
`streamManifest`	`string`	URL tệp kê khai luồng phát có quảng cáo được ghép.
`streamSubtitle`	`ifArray>\|Invalid`	Phụ đề liên kết với luồng phát hoặc `Invalid` nếu không có phụ đề.

Tên	Loại	Mô tả
`adTagParameters`		Không bắt buộc. Bạn có thể ghi đè một số thông số thẻ quảng cáo trên yêu cầu luồng của mình. Bài viết Cung cấp các thông số nhắm mục tiêu cho luồng của bạn cung cấp thêm thông tin. Bạn cũng có thể sử dụng các tham số dai-ot và dai-ov để ưu tiên phiên bản của luồng phát. Hãy xem phần Ghi đè thông số biến thể trong luồng để biết thêm thông tin.
`adUiNode`		Một nút biểu đồ cảnh nơi giao diện người dùng quảng cáo hiển thị. IMA đặt các phần tử như nút Tại sao có quảng cáo này và nút Bỏ qua trên phần tử này trong khi quảng cáo đang phát. Phần tử này phải phủ lên toàn bộ phần tử video.
`apiKey`		Không bắt buộc. Bạn có thể dùng các khoá này để xác thực các yêu cầu phát trực tuyến. Bạn phải thiết lập khoá xác thực DAI trong giao diện người dùng DFP.
`assetKey`		Bắt buộc đối với sự kiện phát trực tiếp. Tham số này được dùng để xác định luồng nào sẽ được phát. Khoá tài sản của yêu cầu phát trực tiếp là một giá trị nhận dạng mà bạn có thể tìm thấy trong giao diện người dùng DFP.
`authToken`		Mã uỷ quyền yêu cầu truyền phát trực tiếp. Được dùng thay cho khoá API để có chế độ uỷ quyền nội dung nghiêm ngặt hơn. Nhà xuất bản có thể kiểm soát từng uỷ quyền luồng nội dung dựa trên mã thông báo này.
`contentSourceId`		Bắt buộc đối với luồng phát theo yêu cầu. cmsid đến từ Nguồn nội dung video DFP trong giao diện người dùng DFP.
`customAssetKey`		Khoá tài sản tuỳ chỉnh được dùng để xác định luồng phát nào sẽ được phát. Bạn phải có khoá tài sản tuỳ chỉnh cho các yêu cầu phát trực tuyến phân phát nhóm.
`format`		Định dạng của luồng. Giá trị mặc định là `ima.StreamFormat.HLS`.
`networkCode`		Mã mạng của nhà xuất bản đưa ra yêu cầu phát trực tuyến. Bạn phải có mã mạng cho các yêu cầu về luồng phân phát nhóm được thực hiện bằng createPodLiveStreamRequest hoặc createPodVodStreamRequest. Bạn cũng phải có các mã này cho các yêu cầu về luồng kết hợp trên đám mây được thực hiện bằng createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest hoặc createVideoStitcherVodStreamRequestWithVodConfig. Đây là những mã không bắt buộc và nên dùng cho các yêu cầu về luồng dịch vụ đầy đủ được thực hiện bằng createLiveStreamRequest hoặc createVodStreamRequest. Việc thêm mã mạng sẽ áp dụng các chế độ cài đặt được chọn trong giao diện người dùng Ad Manager, chẳng hạn như việc bật quảng cáo bị hạn chế có lập trình. Đối với tính năng Phân phát nhóm và Ghép nối trên đám mây, việc thêm mã mạng sẽ xác định vị trí và phát luồng phát. Để tìm mã mạng, hãy xem bài viết này.
`player`		Một cách triển khai giao diện trình phát.
`ppid`		Không dùng nữa. Sử dụng adTagParameters. Không bắt buộc. Giá trị nhận dạng do nhà xuất bản cung cấp của Đối tượng DFP.
`streamActivityMonitorId`		Mã nhận dạng dùng để gỡ lỗi luồng bằng trình giám sát hoạt động truyền phát. Điều này giúp nhà xuất bản dễ dàng tìm thấy nhật ký luồng phát trong công cụ theo dõi hoạt động phát trực tiếp.
`videoId`		Bắt buộc đối với luồng phát theo yêu cầu. Giá trị nhận dạng cho nguồn nội dung video.
`videoObject`		Đối tượng video (chẳng hạn như Video roSGNode) chịu trách nhiệm phát video trên ứng dụng khách. Đối tượng này sẽ được thăm dò để lấy nhiều dữ liệu được dùng trong việc định thời gian thích hợp cho các sự kiện ID3 HLS trực tiếp.
`videoStitcherSessionOptions`		Các lựa chọn về phiên được dùng để đặt các thông số cụ thể của trình ghép video cho VideoStitcher streamRequests.

Thông số	Loại	Mô tả
`adTagUrl`	`string`
`networkCode`	`string`
`contentSourceUrl`	`string`
`region`	`string`
`projectNumber`	`string`
`oAuthToken`	`string`

Thông số	Loại	Mô tả
`vodConfigId`	`string`
`networkCode`	`string`
`region`	`string`
`projectNumber`	`string`
`oAuthToken`	`string`

Tên	Loại	Mô tả
`LIVE`		Video này đã xuất hiện công khai.
`VOD`		Bạn có thể xem video này theo yêu cầu.

SDK IMA DAI cho Roku Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.

Lớp ima

disableLogging()

getStreamManager()

initSdk(settings)

requestStream(streamRequest)

Lớp ima.AdBreakInfo

Thuộc tính

createAdBreakInfo()

Class ima.AdEvent

Thuộc tính

Lớp ima.AdInfo

Thuộc tính

createAdInfo()

Lớp ima.Companion

Thuộc tính

createCompanion()

Class ima.CuePoint

Thuộc tính

createCuePoint()

Lớp ima.Error

Thuộc tính

createError()

Class ima.ErrorEvent

Thuộc tính

Lớp ima.Player

adBreakEnded(adBreakInfo)

adBreakStarted(adBreakInfo)

allVideoComplete()

createPlayer()

loadUrl(streamInfo)

streamInitialized(streamInfo)

Class ima.StreamFormat

Thuộc tính

Lớp ima.StreamInfo

Thuộc tính

createStreamInfo()

Class ima.StreamManager

addEventListener(event, callback)

createStreamManager(streamRequest, streamInitResponse)

enableInteractiveAds()

getContentTime(streamTime)

getCuePoints()

getPreviousCuePoint(time)

getStreamTime(contentTime)

loadThirdPartyStream(streamManifest, streamSubtitle)

onMessage(msg)

replaceAdTagParameters(adTagParameters)

start()

Lớp ima.StreamRequest

Thuộc tính

createLiveStreamRequest(assetKey, apiKey, networkCode)

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

createPodVodStreamRequest(networkCode)

createStreamRequest()

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

Class ima.StreamType

Thuộc tính

Lớp ima.WrapperInfo

Thuộc tính

createWrapperInfo()

SDK IMA DAI cho Roku

`disableLogging()`

`getStreamManager()`

`initSdk(settings)`

`requestStream(streamRequest)`

`createAdBreakInfo()`

`createAdInfo()`

`createCompanion()`

`createCuePoint()`

`createError()`

`adBreakEnded(adBreakInfo)`

`adBreakStarted(adBreakInfo)`

`allVideoComplete()`

`createPlayer()`

`loadUrl(streamInfo)`

`streamInitialized(streamInfo)`

`createStreamInfo()`

`addEventListener(event, callback)`

`createStreamManager(streamRequest, streamInitResponse)`

`enableInteractiveAds()`

`getContentTime(streamTime)`

`getCuePoints()`

`getPreviousCuePoint(time)`

`getStreamTime(contentTime)`

`loadThirdPartyStream(streamManifest, streamSubtitle)`

`onMessage(msg)`

`replaceAdTagParameters(adTagParameters)`

`start()`

`createLiveStreamRequest(assetKey, apiKey, networkCode)`

`createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)`

`createPodVodStreamRequest(networkCode)`

`createStreamRequest()`

`createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)`

`createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)`

`createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)`

`createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)`

`createWrapperInfo()`