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

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

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

Thuộc tính

Tên Loại Nội dung 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á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 để xác định các thuộc tính của một điểm dừng, đạ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 Nội dung mô tả
end

Thời gian kết thúc cho điểm dừng này.
played

Liệu điểm dừng này đã được phát.
start

Thời gian bắt đầu cho điểm dừng 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 Nội dung mô tả
opt_liveStreamRequest Object

đã 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 Nội dung mô tả
assetKey

Giá trị này dùng để xác định nên phát luồng nào. Khoá nội dung yêu cầu truyền trực tiếp là một giá trị nhận dạng có thể 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 Nội dung mô tả
adProgressData

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

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

streamId

subtitles

url

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

Phương thức

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

getAd()


Trả về google.ima.dai.api.Ad: trả về đối tượng 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 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ị Nội dung 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 điểm chèn quảng cáo bắt đầu.
AD_PROGRESS

Được kích hoạt khi có cập nhật đối với tiến trình của một quảng cáo.
CLICK

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

Được kích hoạt khi quảng cáo hoàn tất.
CUEPOINTS_CHANGED

Được điều phối cho các sự kiện phát trực tiếp theo yêu cầu khi điểm dừng thay đổi.
ERROR

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

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

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

Được kích hoạt khi một 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 khởi tạo luồng.
THIRD_QUARTILE

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

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

Phương thức

Xử lý luồng chèn quảng cáo động. Thư viện này quản lý các lượt tương tác với phần phụ trợ DAI, đồng thời xử lý các ping theo dõi cũng như chuyển tiếp các sự kiện và luồng 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ì không phải là trình quản lý cho một quảng cáo cụ thể, mà là một trình quản lý cho toàn bộ luồng

Hàm khởi tạo:
Thông số Loại Nội dung 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 tiếp nhất định. Trả về thời gian phát trực tiếp nhất định cho các 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 nhất định sau khi quảng cáo bị xoá.

Thông số Loại Nội dung 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)

Chuyển vào từ điển của siêu dữ liệu đã xử lý. Từ điển yêu cầu 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 Nội dung mô tả
metadata Object

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

previousCuePointForStreamTime(streamTime)

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

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

Thông số Loại Nội dung mô tả
streamTime number

thời gian phát trực tiếp mong muốn.

processMetadata(type, data, timestamp)

Xử lý siêu dữ liệu đã xác định 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 Nội dung mô tả
type string

Loại cho 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 điểm cần xử lý dữ liệu.

requestStream(streamRequest)

Yêu cầu tải luồng bằng các tham số luồng đã cung cấp.

Thông số Loại Nội dung mô tả
streamRequest google.ima.dai.api.StreamRequest

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

setClickElement(clickElement)

Thiết lập phần tử nhấp qua quảng cáo. Phần tử 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ể khiến người dùng rời khỏi trang hiện tại.

Thông số Loại Nội dung mô tả
clickElement Element

yếu tố được sử dụng khi nhấp vào quảng cáo.

streamTimeForContentTime(contentTime)

Trả về thời gian phát trực tiếp có quảng cáo cho một thời điểm nội dung nhất định. Trả về thời gian nội dung cụ thể của chương trình 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 nhất định sau khi chèn quảng cáo.

Thông số Loại Nội dung mô tả
contentTime number

thời gian 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 phát.

Thuộc tính

Tên Loại Nội dung mô tả
adTagParameters

Bạn có thể ghi đè một bộ thông số thẻ quảng cáo có giới hạn theo yêu cầu luồng của mình. Cung cấp các tham số nhắm mục tiêu cho luồng của bạn sẽ 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ể của luồng. Hãy xem bài viết Ghi đè tham số biến thể của luồng để biết thêm thông tin.
apiKey

Khoá API yêu cầu phát trực tiếp. Mã này được định cấu hình thông qua giao diện người dùng quản trị trong DFP và được cung cấp cho nhà xuất bản để mở khoá nội dung của họ. Chính sách này xác minh các ứng dụng đang cố gắng truy cập vào nội dung.
streamActivityMonitorId

Mã được dùng để gỡ lỗi luồng bằng trình giám sát hoạt động của luồng. Tính năng này dùng để cung cấp một cách thuận tiện cho phép nhà xuất bản tìm nhật ký luồng trong công cụ giám sát hoạt động phát trực tuyến.

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 truyền trực tuyến VOD.

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

đã 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 Nội dung mô tả
contentSourceId

Giá trị nhận dạng duy nhất của nội dung của nhà xuất bản trong một Hệ thống quản lý nội dung (CMS). Bắt buộc đối với sự kiện phát trực tiếp 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 sự kiện phát trực tiếp theo yêu cầu.

google.ima.VERSION không đổi

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