Lớp ima
Phương thức
Các hàm toàn cục 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ề trình quản lý luồng nếu có.
Nếu trình quản lý luồng chưa có sẵn, hệ thống sẽ trả về giá trị Không hợp lệ.
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 cài đặt IMA không bắt buộc. |
requestStream(streamRequest)
Bắt đầu một yêu cầu truyền phát không đồng bộ. Chế độ điều khiển sẽ trả về ngay cho 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 |
Lớp ima.AdBreakInfo
Trường
Phương thức
Chứa thông tin về điểm chèn quảng cáo. Được SDK truyền đến lệnh gọi lại sự kiện.
Thuộc tính
| 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 là |
duration |
|
Thời lượng tối đa của khoảng nghỉ tính bằng giây hoặc |
podIndex |
|
Đối với sự kiện phát trực tiếp, trả về mã điểm chèn dưới dạng chỉ mục nhóm hoặc |
timeOffset |
|
Vị trí của nhóm trong nội dung tính bằng giây.
Quảng cáo trước video trả về |
totalAds |
|
Tổng số quảng cáo có trong khoảng nghỉ quảng cáo này.
Giá trị là |
createAdBreakInfo()
Trả về ima.AdBreakInfo:
Lớp ima.AdEvent
Trường
Các sự kiện do trình quản lý quảng cáo kích hoạt.
Thuộc tính
| Tên | Loại | Mô tả |
|---|---|---|
AD_PERIOD_ENDED |
|
Được kích hoạt mỗi khi luồng chuyển từ quảng cáo hoặc đoạn giới thiệu sang nội dung. Lệnh này sẽ được kích hoạt ngay cả khi quảng cáo phát lần thứ hai hoặc khi tua vào quảng cáo. |
AD_PERIOD_STARTED |
|
Được kích hoạt mỗi khi luồng chuyển từ nội dung sang quảng cáo hoặc đoạn giới thiệu. Lệnh này sẽ được kích hoạt ngay cả khi quảng cáo phát lần thứ hai hoặc khi tua vào 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ị thứ nhất. |
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 hiển thị. |
MIDPOINT |
|
Được kích hoạt khi điểm 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 một quảng cáo. |
SKIPPABLE_STATE_CHANGED |
|
Được kích hoạt khi trạng thái có thể bỏ qua quảng cáo thay đổi. |
SKIPPED |
|
Được kích hoạt khi người dùng bỏ qua quảng cáo. |
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. |
Lớp ima.AdInfo
Trường
Phương thức
Chứa thông tin về một quảng cáo. Được SDK truyền đến lệnh gọi lại sự kiện.
Thuộc tính
| 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 này. |
adDescription |
|
Nội dung mô tả quảng cáo. |
adId |
|
Mã 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 (Mã nhận dạng thương mại theo tiêu chuẩn ngành) của một quảng cáo. Đây là Mã nhận dạng quảng cáo của mẫu quảng cáo đã chọn trong phản hồi VAST. |
creativeId |
|
Mã của mẫu quảng cáo đã chọn cho quảng cáo. |
currentTime |
|
Thời gian hiện tại trong quảng cáo tính bằng giây hoặc -1 nếu không xác định. |
dealId |
|
Trả về mã thoả thuận đầ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ày tính bằng giây hoặc -1 nếu không xác định. |
skipOffset |
|
Thời gian để 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 của trang web đăng ký nơi mã nhận dạng quảng cáo toàn cầu của mẫu quảng cáo đã chọn được lập danh mục. |
universalAdIDValue |
|
Mã nhận dạng quảng cáo toàn cầu của mẫu quảng cáo đã chọn cho quảng cáo. |
wrappers |
|
Một mảng ima.WrapperInfo chứa thông tin về trình bao bọc cho quảng cáo này. Thứ tự sẽ là từ trình bao bọc bên ngoài đến bên trong. |
createAdInfo()
Trả về ima.AdInfo:
Lớp ima.Companion
Trường
Phương thức
Chứa thông tin về quảng cáo đồng hành.
Thuộc tính
| Tên | Loại | Mô tả |
|---|---|---|
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ó. |
creativeType |
|
Biểu thị loại mẫu quảng cáo, thường là mimetype. |
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 sự kiện, trong đó khoá là sự kiện và giá trị là danh sách URL để ping theo sự kiện đó. |
url |
|
URL cho tài nguyên tĩnh của ứng dụng đồng hành 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ó. |
createCompanion()
Trả về ima.Companion:
Lớp ima.CuePoint
Trường
Phương thức
Chứa thông tin về một điểm tín hiệu.
Thuộc tính
| Tên | Loại | Mô tả |
|---|---|---|
end |
|
Thời gian kết thúc của một điểm tín hiệu tính bằng giây. Điều này tương ứng với một điểm chèn quảng cáo. |
hasPlayed |
|
Một boolean cho biết điểm tín hiệu đã phát. |
start |
|
Thời gian bắt đầu của một điểm tín hiệu tính bằng giây. Điều này tương ứng với một điểm chèn quảng cáo. |
createCuePoint()
Trả về ima.CuePoint:
Lớp ima.Error
Trường
Phương thức
Đối tượng được truyền đến trình xử lý lỗi nếu có lỗi.
Thuộc tính
| 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 của đối tượng này. |
createError()
Trả về ima.Error:
Lớp ima.ErrorEvent
Trường
Tất cả lỗi mà SDK có thể gửi lại.
Thuộc tính
| Tên | Loại | Mô tả |
|---|---|---|
BAD_STREAM_REQUEST |
|
Yêu cầu phát trực tuyến không được điền chính xác. |
COULD_NOT_LOAD_STREAM |
|
Không thể tải 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 đã cung cấp. |
Lớp ima.Player
Phương thức
adBreakEnded(adBreakInfo)
Không bắt buộc. Được gọi khi một khoảng nghỉ quảng cáo kết thúc.
| Thông số | Loại | Mô tả |
|---|---|---|
adBreakInfo |
ima.AdBreakInfo |
Chứa thông tin về điểm chèn quảng cáo. |
adBreakStarted(adBreakInfo)
Không bắt buộc. Được gọi khi một khoảng nghỉ quảng cáo bắt đầu.
| Thông số | Loại | Mô tả |
|---|---|---|
adBreakInfo |
ima.AdBreakInfo |
Chứa thông tin về điểm chèn quảng cáo. |
allVideoComplete()
Không bắt buộc. Được gọi khi tất cả video đã hoàn tất.
createPlayer()
Tạo một đối tượng Player IMA trống. Bạn phải triển khai hàm loadUrl để phát quảng cáo. Các hàm khác là không bắt buộc.
Trả về ima.Player:
loadUrl(streamInfo)
Được gọi khi trình phát bắt đầu phát một URL. Bạn phải triển khai phương thức này để tải luồng.
| Thông số | Loại | Mô tả |
|---|---|---|
streamInfo |
ima.StreamInfo |
Chứa thông tin cần thiết để phát nội dung. |
Lớp ima.StreamFormat
Trường
Xác định định dạng của luồng.
Thuộc tính
| Tên | Loại | Mô tả |
|---|---|---|
DASH |
|
|
HLS |
|
Lớp ima.StreamInfo
Trường
Phương thức
Thông tin được truyền từ sdk đến trình phát về luồng.
Thuộc tính
| Tên | Loại | Mô tả |
|---|---|---|
format |
|
Định dạng 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. |
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. |
createStreamInfo()
Trả về ima.StreamInfo:
Lớp ima.StreamManager
Phương thức
Đối tượng để quản lý việc phát trực tuyến.
addEventListener(event, callback)
Thêm trình nghe cho sự kiện đã chỉ định. Xem hằng số AdEvents cho các sự kiện được hỗ trợ.
| Thông số | Loại | Mô tả |
|---|---|---|
event |
string |
|
callback |
function |
createStreamManager(streamRequest, streamInitResponse)
Trả về ima.StreamManager:
| Thông số | Loại | Mô tả |
|---|---|---|
streamRequest |
ima.StreamRequest |
|
streamInitResponse |
ima.StreamInitResponse |
enableInteractiveAds()
Không được hỗ trợ. Thay vào đó, hãy truyền trực tiếp dữ liệu từ quảng cáo đồng hành đến RAF.
Bây giờ, đây là một hàm không có tác dụng.
getContentTime(streamTime)
Lấy thời gian tính bằng mili giây cho luồng VOD, đại diện cho thời gian trong nội dung không có quảng cáo.
Để biết thêm thông tin, hãy xem phần Câu hỏi thường gặp.
Để lấy thời gian nội dung cho thời gian phát trực tuyến hiện tại, hãy truyền vào -1.
Trả về Integer: Thời gian nội dung tương ứng với thời gian phát trực tuyến đã cho.
| Thông số | Loại | Mô tả |
|---|---|---|
streamTime |
Integer |
Thời gian trong luồng. |
getCuePoints()
Trả về tất cả điểm tín hiệu tương ứng với tất cả điểm chèn quảng cáo. Giá trị này chỉ áp dụng cho nội dung video theo yêu cầu, trong đó tất cả điểm chèn quảng cáo đều được biết trước. Tất cả thời gian đều thể hiện thời gian phát trực tuyến tính bằng giây.
Đối với luồng API ghép nối trên đám mây, thuộc tính hasPlayed của mỗi ima.CuePoint luôn là false.
Trả về Object: Một mảng chứa tất cả các điểm tín hiệu.
getPreviousCuePoint(time)
Trả về điểm tín hiệu trước thời điểm này. Điểm tín hiệu cho biết một điểm chèn quảng cáo. Tất cả thời gian đều thể hiện thời gian phát trực tuyến tính bằng giây.
Trả về ima.CuePoint: Một đối tượng có start, end và hasPlayed. Trả về giá trị Không hợp lệ nếu không có điểm tín hiệu nào.
| Thông số | Loại | Mô tả |
|---|---|---|
time |
Float |
Thời gian tra cứu, |
getStreamTime(contentTime)
Lấy thời gian của luồng từ thời gian nội dung cho VOD tính bằng mili giây.
Để biết thêm thông tin, hãy xem phần Câu hỏi thường gặp.
Trả về Integer: Thời gian phát trực tuyến tương ứng với thời gian nội dung đã cho.
| Thông số | Loại | Mô tả |
|---|---|---|
contentTime |
Integer |
Thời gian của nội dung. |
loadThirdPartyStream(streamManifest, streamSubtitle)
Tải siêu dữ liệu quảng cáo và gọi hàm loadUrl bằng dữ liệu streamManifestUrl và streamSubtitle đã cung cấp. Hàm này chỉ hoạt động khi loại yêu cầu phát trực tiếp là ima.StreamType.POD_VOD.
| Thông số | Loại | Mô tả |
|---|---|---|
streamManifest |
string |
URL tệp kê khai luồng có quảng cáo được nối. |
streamSubtitle |
ifArray |
Phụ đề liên kết với luồng hoặc |
onMessage(msg)
Xử lý tất cả thông báo đến từ đối tượng Video.
Phải được gọi cho mỗi thông báo nhận được trên roMessagePort.
| Thông số | Loại | Mô tả |
|---|---|---|
msg |
object |
Thông báo từ cổng roVideo. |
replaceAdTagParameters(adTagParameters)
Thay thế tất cả các thông số thẻ quảng cáo sẽ được sử dụng cho các yêu cầu quảng cáo sắp tới trong một sự kiện phát trực tiếp. Xin lưu ý rằng lệnh gọi này không hoạt động đối với luồng VOD.
| Thông số | Loại | Mô tả |
|---|---|---|
adTagParameters |
string |
Các thông số thẻ quảng cáo mới. |
start()
Bắt đầu phát luồng.
Lớp ima.StreamRequest
Trường
Phương thức
Dùng để 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 |
|
Không bắt buộc. Bạn có thể ghi đè một số thông số thẻ quảng cáo hạn chế trong 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 sẽ cung cấp thêm thông tin. Bạn cũng có thể sử dụng 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. |
adUiNode |
|
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 thành phần như nút Tại sao có quảng cáo này? và Bỏ qua trên phần tử này trong quảng cáo. 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. 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. Thông tin này được dùng để xác định luồng nào sẽ được phát. Khoá thành phần của yêu cầu phát trực tiếp là một giá trị nhận dạng có trong giao diện người dùng DFP. |
authToken |
|
Mã uỷ quyền yêu cầu phát trực tuyến. Được dùng thay cho khoá API để cho phép nội dung nghiêm ngặt hơn. Nhà xuất bản có thể kiểm soát các quyền truy cập vào luồng nội dung riêng lẻ dựa trên mã thông báo này. |
contentSourceId |
|
Bắt buộc đối với luồng 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á thành phần tuỳ chỉnh được dùng để xác định luồng cần phát. Bạn cần có khoá thành phần tuỳ chỉnh để phân phát yêu cầu luồng nhóm. |
format |
|
Định dạng của luồng. Giá trị mặc định là |
networkCode |
|
Mã mạng của nhà xuất bản thực hiện yêu cầu truyền trực tuyến. Bạn cần có mã mạng cho các yêu cầu phát trực tuyến phân phát nhóm được tạo bằng createPodLiveStreamRequest hoặc createPodVodStreamRequest. Các mã này cũng là bắt buộc đối với các yêu cầu truyền trực tuyến của tính năng ghép nối trên đám mây được tạo bằng createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest hoặc createVideoStitcherVodStreamRequestWithVodConfig. Các mã này không bắt buộc và được đề xuất cho các yêu cầu truyền trực tuyến 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 đã chọn trong giao diện người dùng Ad Manager, chẳng hạn như bật quảng cáo có giới hạn theo 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. Để tìm mã mạng, hãy xem bài viết này. |
player |
|
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 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. |
videoId |
|
Bắt buộc đối với luồng 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ò ý kiến về nhiều dữ liệu để sử dụng trong việc định thời gian chính xác cho các sự kiện ID3 HLS trực tiếp. |
videoStitcherSessionOptions |
|
Các tuỳ chọn phiên được dùng để đặt các thông số cụ thể của trình nối video cho VideoStitcher streamRequests. |
createLiveStreamRequest(assetKey, apiKey, networkCode)
Khởi tạo các thuộc tính bắt buộc của StreamRequest Trực tiếp. Việc sử dụng API này sẽ khiến mọi thuộc tính StreamType cụ thể khác bị bỏ qua.
Nếu bất kỳ tham số bắt buộc nào là chuỗi trống, thì quá trình ghi nhật ký lỗi sẽ xảy ra và API sẽ trả về một StreamRequest chung, không bỏ qua thuộc tính nào.
Trả về ima.StreamRequest: Đối tượng ima.StreamRequest có các thuộc tính Trực tiếp bắt buộc.
| Thông số | Loại | Mô tả |
|---|---|---|
assetKey |
string |
|
apiKey |
string |
Tham số được chỉ định cho thuộc tính |
networkCode |
string |
Mã mạng cho nhà xuất bản thực hiện yêu cầu truyền trực tuyến. Bạn không bắt buộc phải thêm mã mạng, nhưng nên làm như vậy. |
createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)
Khởi chạy các thuộc tính bắt buộc của Pod Live ima.StreamRequest.
Việc sử dụng API này sẽ khiến mọi thuộc tính ima.StreamType cụ thể khác bị bỏ qua.
Nếu bất kỳ tham số bắt buộc nào là chuỗi trống, thì quá trình ghi nhật ký lỗi sẽ xảy ra và API sẽ trả về một StreamRequest chung, không bỏ qua thuộc tính nào.
Trả về StreamRequest: Đối tượng ima.StreamRequest có các thuộc tính PodLive bắt buộc.
| Thông số | Loại | Mô tả |
|---|---|---|
customAssetKey |
string |
|
networkCode |
string |
|
apiKey |
string |
Tham số không bắt buộc được gán cho thuộc tính |
createPodVodStreamRequest(networkCode)
Khởi chạy các thuộc tính bắt buộc của ima.StreamRequest để đăng ký luồng VOD khi sử dụng tính năng phân phát nhóm DAI bằng trình nối video bên thứ ba. Hàm này đặt loại yêu cầu thành ima.StreamType.POD_VOD và xác thực tất cả thuộc tính bắt buộc đối với dữ liệu bị thiếu. Các lượt xác thực không thành công sẽ ghi lỗi vào bảng điều khiển gỡ lỗi.
Trả về StreamRequest: một đối tượng ima.StreamRequest. Nếu bạn chỉ định tất cả thuộc tính bắt buộc, thì loại yêu cầu sẽ được đặt thành ima.StreamType.POD_VOD.
| Thông số | Loại | Mô tả |
|---|---|---|
networkCode |
string |
mã mạng Google Ad Manager |
createStreamRequest()
Trả về ima.StreamRequest: Một đối tượng ima.StreamRequest trống.
createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)
Khởi chạy các thuộc tính bắt buộc của StreamRequest Video Stitcher Live. Việc sử dụng API này sẽ khiến mọi thuộc tính khác dành riêng cho StreamType bị bỏ qua.
Nếu bất kỳ tham số bắt buộc nào là chuỗi trống, thì quá trình ghi nhật ký lỗi sẽ xảy ra và API sẽ trả về một StreamRequest chung, không bỏ qua thuộc tính nào.
Trả về ima.StreamRequest: Đối tượng ima.StreamRequest có các thuộc tính VideoStitcherLive bắt buộc.
| Thông số | Loại | Mô tả |
|---|---|---|
customAssetKey |
string |
|
networkCode |
string |
|
liveConfigId |
string |
|
region |
string |
|
projectNumber |
string |
|
oAuthToken |
string |
createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)
Khởi chạy các thuộc tính bắt buộc của StreamRequest VOD của Trình nối video. Việc sử dụng API này sẽ khiến mọi thuộc tính khác dành riêng cho StreamType bị bỏ qua.
Nếu bất kỳ tham số bắt buộc nào là chuỗi trống, thì quá trình ghi nhật ký lỗi sẽ xảy ra và API sẽ trả về một StreamRequest chung, không bỏ qua thuộc tính nào.
Trả về ima.StreamRequest: Đối tượng ima.StreamRequest có các thuộc tính VideoStitcherVod bắt buộc.
| Thông số | Loại | Mô tả |
|---|---|---|
adTagUrl |
string |
|
networkCode |
string |
|
contentSourceUrl |
string |
|
region |
string |
|
projectNumber |
string |
|
oAuthToken |
string |
createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)
Khởi chạy các thuộc tính bắt buộc của Video Stitcher VOD
StreamRequest bằng cách sử dụng vodConfigId được tạo từ công cụ kết hợp video trên đám mây.
Việc sử dụng API này sẽ khiến mọi thuộc tính cụ thể khác của StreamType bị bỏ qua.
Nếu bất kỳ tham số bắt buộc nào là chuỗi trống, thì quá trình ghi nhật ký lỗi sẽ xảy ra và API sẽ trả về một StreamRequest chung, không bỏ qua thuộc tính nào.
Trả về ima.StreamRequest: Đối tượng ima.StreamRequest có các thuộc tính VideoStitcherVod bắt buộc.
| Thông số | Loại | Mô tả |
|---|---|---|
vodConfigId |
string |
|
networkCode |
string |
|
region |
string |
|
projectNumber |
string |
|
oAuthToken |
string |
createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)
Khởi chạy các thuộc tính bắt buộc của ima.StreamRequest VOD. Việc sử dụng API này sẽ khiến mọi thuộc tính cụ thể khác của ima.StreamType bị bỏ qua.
Nếu bất kỳ tham số bắt buộc nào là chuỗi trống, thì quá trình ghi nhật ký lỗi sẽ xảy ra và API sẽ trả về một StreamRequest chung, không bỏ qua thuộc tính nào.
Trả về ima.StreamRequest: Đối tượng ima.StreamRequest có
các thuộc tính VOD bắt buộc.
| Thông số | Loại | Mô tả |
|---|---|---|
contentSourceId |
string |
|
videoId |
string |
|
apiKey |
string |
Tham số được chỉ định cho thuộc tính |
networkCode |
string |
Mã mạng cho nhà xuất bản thực hiện yêu cầu truyền trực tuyến. Bạn không bắt buộc phải thêm mã mạng, nhưng nên làm như vậy. |
Lớp ima.StreamType
Trường
Xác định loại luồng mà trình phát được yêu cầu phát. Video quảng cáo trước và VOD phải phát từ đầu luồng.
Thuộc tính
| Tên | Loại | Mô tả |
|---|---|---|
LIVE |
|
Video này đã xuất hiện công khai. |
VOD |
|
Video này được cung cấp theo yêu cầu. |
Lớp ima.WrapperInfo
Trường
Phương thức
Chứa thông tin về trình bao bọc.
Thuộc tính
| Tên | Loại | Mô tả |
|---|---|---|
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 |
|
Tên đã khai báo của hệ thống quảng cáo hoặc một chuỗi trống nếu không xác định được. |
creativeAdId |
|
Mã quảng cáo trên mẫu quảng cáo hoặc một chuỗi trống nếu không xác định. |
creativeId |
|
Mã nhận dạng của mẫu quảng cáo hoặc một chuỗi trống nếu không xác định được. |
dealId |
|
Mã giao dịch hoặc chuỗi trống nếu không xác định được. |
createWrapperInfo()
Trả về ima.WrapperInfo: