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 một đố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 tập hợp con của các thuộc tính ima.Ad.

getAdId()


Trả về string:

getAdPodInfo()


Trả về google.ima.dai.api.AdPodInfo:

getAdSystem()


Trả về string:

getAdvertiserName()


Trả về string:

getApiFramework()


Trả về string:

getCompanionAds()


Trả về Array.<google.ima.dai.api.CompanionAd>:

getCreativeAdId()


Trả về string:

getCreativeId()


Trả về string:

getDealId()


Trả về string:

getDescription()


Trả về string:

getDuration()


Trả về number:

getTitle()


Trả về string:

getVastMediaHeight()


Trả về number:

getVastMediaWidth()


Trả về number:

getWrapperAdIds()


Trả về Array.<string>:

getWrapperAdSystems()


Trả về Array.<string>:

getWrapperCreativeIds()


Trả về 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 về 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ả về number:

getMaxDuration()


Trả về number:

getPodIndex()


Trả về number:

getTimeOffset()


Trả về number:

getTotalAds()


Trả về number:

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

Trường

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

Thuộc tính

Tên Loại Mô tả
adBreakDuration

adPosition

currentTime

duration

totalAds

Lớp 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ủa các thuộc tính ima.CompanionAd.

getAdSlotId()


Trả về string:

getContent()


Trả về string:

getContentType()


Trả về string:

getHeight()


Trả về number:

getWidth()


Trả về number:

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

Trường

Một lớp để chỉ định các thuộc tính của điểm tín hiệu, đại diện cho một điểm chèn 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 tín hiệ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 tín hiệ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 luồng.

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á thành phần yêu cầu phát trực tiếp là một giá trị nhận dạng có thể được tìm thấy trong giao diện người dùng DFP.

Lớp 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

Điểm tín hiệu quảng cáo cho luồng 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. Giá trị này sẽ chỉ được điền trong trình nghe sự kiện cho AdEvent CUEPOINTS_CHANGED.
errorMessage

streamId

subtitles

url

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

Phương thức

Loại sự kiện này do trình quản lý luồng đưa ra dưới dạng thông báo khi trạng thái luồng 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: đối tượng trả về có thông tin về luồng.

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 một khoảng nghỉ quảng cáo kết thúc.
AD_BREAK_STARTED

Được kích hoạt khi một khoảng nghỉ 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 khi người dùng nhấp hoặc nhấn vào phần tử lượt nhấp trong khi quảng cáo đang phát.
COMPLETE

Được kích hoạt khi quảng cáo kết thúc.
CUEPOINTS_CHANGED

Được gửi cho các luồng theo yêu cầu khi điểm tín hiệ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 tứ phân vị đầu tiên.
LOADED

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

Được kích hoạt khi quảng cáo đạ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 đạt đến tứ phân vị thứ ba.

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

Phương thức

Xử lý các luồng chèn quảng cáo động. Lớp này quản lý các hoạt động tương tác với phần phụ trợ DAI và xử lý ping theo dõi cũng như chuyển tiếp luồng và sự kiện quảng cáo đến 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

Thành phần trình phát video thực tế.

contentTimeForStreamTime(streamTime)

Trả về thời lượng 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.

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

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 dự kiến khoá "TXXX" có giá trị là chuỗi siêu dữ liệu do người dùng xác định. 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 tín hiệ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 tín hiệ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 người dùng đã tua để quay lại điểm chèn quảng cáo.

Trả về google.ima.dai.api.CuePoint: điểm tín hiệu trước đó cho thời gian phát trực tuyến nhất định.

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

thời gian phát trực tuyến đã được tua đến.

processMetadata(type, data, timestamp)

Xử lý siêu dữ liệu được tính giờ 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ẻ thô. Đối với ID3, phải là toàn bộ thẻ.
timestamp number

Thời điểm xử lý dữ liệu.

requestStream(streamRequest)

Yêu cầu tải một luồng bằng cách sử dụ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. Thành phần này được dùng làm trình thu nhận lượt nhấp hoặc nhấn trong khi quảng cáo đang phát và có thể dẫn đến việc di chuyển 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 khoảng thời gian nội dung nhất định. Trả về thời lượng nội dung đã cho cho sự kiện phát trực tiếp.

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

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

Lớp 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 trực tuyến.

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 nhất định trên yêu cầu luồng. Bài viết Cung cấp 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 cho lựa chọn ưu tiên về biến thể luồng. 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 luồng. Mã này được định cấu hình thông qua Giao diện người dùng quản trị DFP và được cung cấp cho nhà xuất bản để mở khoá nội dung của họ. API này xác minh các ứ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 của luồng. Mã này được dùng để cung cấp một cách thuận tiện cho phép nhà xuất bản tìm thấy nhật ký luồng trong công cụ theo dõi hoạt động luồng.

Lớp 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 luồng.

Thuộc tính

Tên Loại Mô tả
contentSourceId

Giá trị nhận dạng duy nhất của nội dung của nhà xuất bản, từ một CMS. Bắt buộc đối với các luồng 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 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.