API SDK IMA DAI của Google

    1. google.ima.dai.api.Ad
    2. google.ima.dai.api.AdPodInfo
    3. google.ima.dai.api.AdProgressData
    4. google.ima.dai.api.CompanionAd
    5. google.ima.dai.api.CuePoint
    6. google.ima.dai.api.LiveStreamRequest
    7. google.ima.dai.api.StreamData
    8. google.ima.dai.api.StreamEvent
    9. google.ima.dai.api.StreamEvent.Type
    10. google.ima.dai.api.StreamManager
    11. google.ima.dai.api.StreamRequest
    12. google.ima.dai.api.VODStreamRequest
    13. google.ima.VERSION

Lớp google.ima.dai.api.Ad

Phương thức

Một lớp đại diện cho đối tượng quảng cáo trong quá trình chèn quảng cáo động. Lớp này hiển thị một nhóm nhỏ các thuộc tính ima.Ad.

getAdId()


Trả lại string:

getAdPodInfo()


Trả lại google.ima.dai.api.AdPodInfo:

getAdSystem()


Trả lại string:

getAdvertiserName()


Trả lại string:

getApiFramework()


Trả lại string:

getCompanionAds()


Trả lại Array.<google.ima.dai.api.CompanionAd>:

getCreativeAdId()


Trả lại string:

getCreativeId()


Trả lại string:

getDealId()


Trả lại string:

getDescription()


Trả lại string:

getDuration()


Trả lại number:

getTitle()


Trả lại string:

getVastMediaHeight()


Trả lại number:

getVastMediaWidth()


Trả lại number:

getWrapperAdIds()


Trả lại Array.<string>:

getWrapperAdSystems()


Trả lại Array.<string>:

getWrapperCreativeIds()


Trả lại Array.<string>:

Lớp google.ima.dai.api.AdPodInfo

Phương thức

Một lớp đại diện cho đối tượng thông tin nhóm quảng cáo trong quá trình chèn quảng cáo động. Lớp này hiển thị một tập hợp con của các thuộc tính ima.AdPodInfo.

getAdPosition()


Trả lại number:

getMaxDuration()


Trả lại number:

getPodIndex()


Trả lại number:

getTimeOffset()


Trả lại number:

getTotalAds()


Trả lại number:

Lớp google.ima.dai.api.AdProgressData

Trường

Một lớp để chỉ định dữ liệu về tiến trình quảng cáo.

Thuộc tính

Tên Loại Mô tả
adBreakDuration

adPosition

currentTime

duration

totalAds

Class google.ima.dai.api.CompanionAd

Phương thức

Một lớp đại diện cho đối tượng quảng cáo đồng hành trong quá trình chèn quảng cáo động. Lớp này hiển thị một tập hợp con các thuộc tính ima.CompanionAd.

getAdSlotId()


Trả lại string:

getContent()


Trả lại string:

getContentType()


Trả lại string:

getHeight()


Trả lại number:

getWidth()


Trả lại number:

Class google.ima.dai.api.CuePoint

Trường

Một lớp để chỉ định các thuộc tính của một điểm đánh dấu, đại diện cho một khoảng thời gian quảng cáo trong luồng VOD DAI.

Thuộc tính

Tên Loại Mô tả
end

Thời gian kết thúc của điểm đánh dấu này.
played

Nếu điểm đánh dấu này đã được phát.
start

Thời gian bắt đầu của điểm đánh dấu này.

Lớp google.ima.dai.api.LiveStreamRequest

Trường

Một lớp để chỉ định các thuộc tính của yêu cầu phát trực tiếp.

Hàm khởi tạo:
Thông số Loại Mô tả
opt_liveStreamRequest Object

đối tượng đã được chỉ định các thuộc tính yêu cầu truyền phát trực tiếp.

Thuộc tính

Tên Loại Mô tả
assetKey

Thông tin 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.

Class google.ima.dai.api.StreamData

Trường

Một lớp để chỉ định dữ liệu luồng.

Thuộc tính

Tên Loại Mô tả
adProgressData

Thông tin liên quan đến thời gian của quảng cáo đang phát.
cuepoints

Các điểm đánh dấu quảng cáo cho luồng phát theo yêu cầu. Những thông tin này có thể thay đổi khi sự kiện phát trực tiếp diễn ra. Tham số này sẽ chỉ được điền sẵn trong trình nghe sự kiện cho CUEPOINTS_CHANGED AdEvent.
errorMessage

streamId

subtitles

url

Class google.ima.dai.api.StreamEvent

Phương thức

Loại sự kiện này được trình quản lý luồng phát đưa ra dưới dạng thông báo khi trạng thái luồng phát thay đổi.

getAd()


Trả về google.ima.dai.api.Ad: đối tượng trả về có thông tin quảng cáo.

getStreamData()


Trả về google.ima.dai.api.StreamData: trả về đối tượng có thông tin về luồng phát.

Enum google.ima.dai.api.StreamEvent.Type

Trường

Danh sách các loại sự kiện mà SDK IMA hỗ trợ.

Giá trị

Giá trị Mô tả
AD_BREAK_ENDED

Được kích hoạt khi điểm chèn quảng cáo kết thúc.
AD_BREAK_STARTED

Được kích hoạt khi một khoảng chèn quảng cáo bắt đầu.
AD_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.
CLICK

Được gửi đi khi phần tử nhấp được nhấp hoặc nhấn vào trong khi quảng cáo đang phát.
COMPLETE

Được kích hoạt khi quảng cáo phát xong.
CUEPOINTS_CHANGED

Được gửi cho các luồng phát theo yêu cầu khi các điểm đánh dấu thay đổi.
ERROR

Được kích hoạt khi xảy ra lỗi.
FIRST_QUARTILE

Được kích hoạt khi quảng cáo đạt đến phần tư đầu tiên.
LOADED

Được kích hoạt khi có tệp kê khai luồng phát.
MIDPOINT

Được kích hoạt khi quảng cáo phát đến điểm giữa.
STARTED

Được kích hoạt khi quảng cáo bắt đầu.
STREAM_INITIALIZED

Được kích hoạt khi luồng được khởi tạo.
THIRD_QUARTILE

Được kích hoạt khi quảng cáo phát đến phần tư thứ ba.

Class google.ima.dai.api.StreamManager

Phương thức

Xử lý các luồng chèn quảng cáo động. Nó quản lý các hoạt động tương tác với phần phụ trợ DAI và xử lý các ping theo dõi cũng như chuyển tiếp các sự kiện về luồng phát và quảng cáo cho nhà xuất bản. Trình quản lý này không kế thừa từ BaseAdsManager vì đây không phải là trình quản lý cho một quảng cáo cụ thể, mà là trình quản lý cho toàn bộ luồng

Hàm khởi tạo:
Thông số Loại Mô tả
videoElement HTMLVideoElement

Phần tử trình phát video thực tế.

contentTimeForStreamTime(streamTime)

Trả về thời gian nội dung không có quảng cáo cho một thời gian phát trực tuyến nhất định. Trả về thời gian phát trực tiếp đã cho của sự kiện phát trực tiếp.

Trả về number: thời gian nội dung tương ứng với thời gian phát trực tiếp đã cho sau khi quảng cáo bị xoá.

Thông số Loại Mô tả
streamTime number

thời gian phát trực tiếp có quảng cáo được chèn (tính bằng giây).

onTimedMetadata(metadata)

Truyền vào một từ điển siêu dữ liệu đã xử lý. Từ điển này mong đợi khoá "TXXX" với chuỗi siêu dữ liệu do người dùng xác định làm giá trị. Nếu trình phát của bạn cung cấp siêu dữ liệu thô, hãy gọi ima.dai.api.StreamManager.processMetadata.

Thông số Loại Mô tả
metadata Object

Từ điển siêu dữ liệu.

previousCuePointForStreamTime(streamTime)

Trả về điểm đánh dấu trước đó cho thời gian phát trực tiếp đã cho. Trả về giá trị rỗng nếu không có điểm đánh dấu như vậy. Phương thức này được dùng để triển khai các tính năng như quay lại nhanh và được gọi khi nhà xuất bản phát hiện thấy người dùng đã tua để đưa người dùng trở lại một khoảng thời gian chèn quảng cáo.

Trả về google.ima.dai.api.CuePoint: điểm đánh dấu trước đó cho thời gian phát trực tiếp đã cho.

Thông số Loại Mô tả
streamTime number

thời gian phát trực tiếp đã được chuyển đến.

processMetadata(type, data, timestamp)

Xử lý siêu dữ liệu có dấu thời gian cho sự kiện phát trực tiếp. Sử dụng nếu trình phát video của bạn cung cấp siêu dữ liệu chưa được phân tích cú pháp cùng với dấu thời gian, nếu không, hãy gọi ima.dai.api.StreamManager.onTimedMetadata.

Thông số Loại Mô tả
type string

Loại siêu dữ liệu. Phải là "ID3".
data Uint8Array

Dữ liệu thô của thẻ. Đối với ID3, phải là toàn bộ thẻ.
timestamp number

Thời gian xử lý dữ liệu.

requestStream(streamRequest)

Yêu cầu tải một luồng bằng các thông số luồng được cung cấp.

Thông số Loại Mô tả
streamRequest google.ima.dai.api.StreamRequest

chứa các tham số để tải siêu dữ liệu luồng.

setClickElement(clickElement)

Đặt phần tử lượt nhấp vào quảng cáo. Phần tử này được dùng làm bộ nhận lượt nhấp hoặc lượt nhấn trong khi quảng cáo đang phát và có thể dẫn đến việc điều hướng ra khỏi trang hiện tại.

Thông số Loại Mô tả
clickElement Element

phần tử được dùng làm lượt nhấp vào quảng cáo.

streamTimeForContentTime(contentTime)

Trả về thời gian phát trực tuyến có quảng cáo cho một thời gian nội dung nhất định. Trả về thời gian nội dung đã cho cho sự kiện phát trực tiếp.

Trả về number: thời gian phát trực tiếp tương ứng với thời gian nội dung đã cho sau khi quảng cáo được chèn.

Thông số Loại Mô tả
contentTime number

thời lượng nội dung không có quảng cáo (tính bằng giây).

Class google.ima.dai.api.StreamRequest

Trường

Một lớp để chỉ định các thuộc tính của yêu cầu truyền phát.

Thuộc tính

Tên Loại Mô tả
adTagParameters

Bạn có thể ghi đè một số thông số thẻ quảng cáo trong yêu cầu luồng phát. 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ó thể sử dụng các tham số dai-ot và dai-ov để đặt lựa chọn ưu tiên về biến thể 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.
apiKey

Khoá API yêu cầu truyền trực tuyến. Khoá này được định cấu hình thông qua giao diện người dùng Quản trị viên DFP và được cung cấp cho nhà xuất bản để mở khoá nội dung của họ. Nó xác minh những ứng dụng đang cố gắng truy cập vào nội dung.
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.

Class google.ima.dai.api.VODStreamRequest

Trường

Một lớp để chỉ định các thuộc tính của yêu cầu phát trực tuyến VOD.

Hàm khởi tạo:
Thông số Loại Mô tả
opt_VODStreamRequest Object

đối tượng đã được chỉ định các thuộc tính yêu cầu phát trực tuyến.

Thuộc tính

Tên Loại Mô tả
contentSourceId

Giá trị nhận dạng riêng biệt của nội dung nhà xuất bản, từ một CMS. Bắt buộc đối với các luồng phát theo yêu cầu.
videoId

Giá trị nhận dạng cho nguồn nội dung video. Bắt buộc đối với luồng phát theo yêu cầu.

Hằng số google.ima.VERSION

Một chuỗi chứa phiên bản đầy đủ của SDK.