Lớp: StreamRequest

ima.StreamRequest

class   static

Hàm dựng

StreamRequest

StreamRequest() mới

Được sử dụng để chỉ định các thuộc tính của yêu cầu luồng.

Thuộc tính

adTagParameters

static

Chuỗi

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 các biến thể 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

static

roSGNode

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 phát. Phần tử này phải phủ lên toàn bộ phần tử video.

apiKey

static

Chuỗi

Không bắt buộc. Những khóa này có thể được sử dụng để xác thực các yêu cầu luồng. Khóa xác thực DAI phải được thiết lập trong giao diện người dùng DFP.

assetKey

static

Chuỗi

Bắt buộc đối với phát trực tiếp. Tính năng này được sử dụng để xác định luồng nào sẽ được phát. Yêu cầu phát trực tiếp khóa tài sản là một mã định danh có thể tìm thấy trong giao diện người dùng DFP.

authToken

static

Chuỗi

Mã thông báo ủy quyền yêu cầu luồng. Được sử dụng thay cho khóa API để xác thực nội dung chặt chẽ hơn. Nhà xuất bản có thể kiểm soát quyền cấp phép cho từng luồng nội dung dựa trên mã thông báo này.

contentSourceId

static

Chuỗi

Bắt buộc đối với các 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

static

Chuỗi

Khóa nội dung tùy chỉnh được sử dụng để xác định luồng nào sẽ được phát. Khóa tài sản tùy chỉnh là bắt buộc đối với các yêu cầu phát trực tuyến phục vụ pod.

định dạng

static

ima.StreamFormat

Định dạng của luồng. Giá trị mặc định là ima.StreamFormat.HLS.

networkCode

static

Chuỗi

Mã mạng dành cho nhà xuất bản thực hiện yêu cầu phát trực tuyến. Mã mạng là bắt buộc đối với Pod phục vụ các yêu cầu phát trực tuyến được thực hiện bằng createPodLiveStreamRequest hoặc createPodVodStreamRequest. Các mã này cũng cần thiết cho các yêu cầu luồng ghép nối đám mây được thực hiện bằng createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest hoặc createVideoStitcherVodStreamRequestWithVodConfig. Các mã này là tùy chọn và được khuyến nghị cho các yêu cầu phát 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 cài đặt được chọn trong Giao diện người dùng Ad Manager, chẳng hạn như bật quảng cáo giới hạn theo chương trình. Đối với việc phục vụ Pod và ghép nối đám mây, việc thêm mã mạng sẽ định vị và phát luồng. Để tìm mã mạng, hãy xem bài viết này.

cầu thủ

static

(ima.Player hoặc Không hợp lệ)

Một bản triển khai giao diện trình phát.

ppid

static

Chuỗi

Không dùng nữa. Sử dụng adTagParameters. Không bắt buộc. Một giá trị nhận dạng do nhà xuất bản cung cấp của Đối tượng DFP.

streamActivityMonitorId

static

Chuỗi

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. Đây là cách thuận tiện để giúp nhà xuất bản 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

static

Chuỗi

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

static

(roVideo hoặc Không hợp lệ)

Đối tượng video (chẳng hạn như Video roSGNode) chịu trách nhiệm phát lại video trên ứng dụng khách. Đối tượng này sẽ được thăm dò để tìm kiếm nhiều dữ liệu khác nhau nhằm mục đích định thời gian chính xác cho các sự kiện Live HLS ID3.

videoStitcherSessionOptions

static

Mảng V

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.

Phương thức

createLiveStreamRequest

static

createLiveStreamRequest(assetKey, apiKey, networkCode) trả về ima.StreamRequest

Khởi tạo các thuộc tính bắt buộc của Live StreamRequest. Sử dụng API này sẽ bỏ qua mọi thuộc tính cụ thể khác của StreamType. Nếu bất kỳ tham số bắt buộc nào là chuỗi rỗng, quá trình ghi nhật ký lỗi sẽ xảy ra và API trả về StreamRequest chung, không bỏ qua bất kỳ thuộc tính nào.

Tham số

assetKey

chuỗi

apiKey

chuỗi

Tham số được chỉ định cho thuộc tính ima.StreamRequest.apiKey của ima.StreamRequest được trả về. Nếu không có khoá API, hãy truyền một chuỗi trống.

networkCode

chuỗi

Mã mạng dành cho nhà xuất bản thực hiện yêu cầu phát trực tuyến. Việc thêm mã mạng là tùy chọn nhưng được khuyến khích.
Giá trị trả về

Đối tượng ima.StreamRequest ima.StreamRequest có các thuộc tính Live bắt buộc.

createPodLiveStreamRequest

static

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey) trả về StreamRequest

Khởi tạo 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 khác dành riêng cho ima.StreamType đều 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ẽ diễn ra và API sẽ trả về StreamRequest chung mà không bỏ qua thuộc tính nào.

Tham số

customAssetKey

chuỗi

networkCode

chuỗi

apiKey

chuỗi

Tham số tùy chọn được gán cho thuộc tính ima.StreamRequest.apiKey của ima.StreamRequest được trả về; mặc định là chuỗi trống.

Giá trị trả về

StreamRequest Đối tượng ima.StreamRequest có các thuộc tính PodLive bắt buộc.

createPodVodStreamRequest

static

createPodVodStreamRequest(networkCode) trả về StreamRequest

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 với một trình ghép 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ả các thuộc tính bắt buộc đối với dữ liệu bị thiếu. Các quy trình xác thực không thành công sẽ ghi lại lỗi trong bảng điều khiển gỡ lỗi.

Tham số

networkCode

chuỗi

mã mạng Google Ad Manager
Giá trị trả về

StreamRequest là đối tượng ima.StreamRequest. Nếu tất cả các thuộc tính bắt buộc được chỉ định, loại yêu cầu sẽ được đặt thành ima.StreamType.POD_VOD.

createStreamRequest

static

createStreamRequest() trả về ima.StreamRequest

Giá trị trả về

ima.StreamRequest Một đối tượng ima.StreamRequest trống.

createVideoStitcherLiveStreamRequest

static

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken) trả về ima.StreamRequest

Khởi tạo các thuộc tính bắt buộc của Video Stitcher Live StreamRequest. Sử dụng API này sẽ bỏ qua mọi thuộc tính cụ thể khác của StreamType. Nếu bất kỳ tham số bắt buộc nào là chuỗi rỗng, quá trình ghi nhật ký lỗi sẽ xảy ra và API trả về StreamRequest chung, không bỏ qua bất kỳ thuộc tính nào.

Tham số

customAssetKey

chuỗi

networkCode

chuỗi

liveConfigId

chuỗi

khu vực

chuỗi

projectNumber

chuỗi

oAuthToken

chuỗi
Giá trị trả về

Đối tượng ima.StreamRequest ima.StreamRequest có thuộc tính VideoStitcherLive bắt buộc.

createVideoStitcherVodStreamRequest

static

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken) trả về ima.StreamRequest

Khởi chạy các thuộc tính bắt buộc của Video Stitcher VOD StreamRequest. 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ẽ diễn ra và API sẽ trả về StreamRequest chung mà không bỏ qua thuộc tính nào.

Tham số

adTagUrl

chuỗi

networkCode

chuỗi

contentSourceUrl

chuỗi

khu vực

chuỗi

projectNumber

chuỗi

oAuthToken

chuỗi
Giá trị trả về

Đối tượng ima.StreamRequest ima.StreamRequest có thuộc tính VideoStitcherVod bắt buộc.

createVideoStitcherVodStreamRequestWithVodConfig

static

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken) trả về ima.StreamRequest

Khởi tạo các thuộc tính bắt buộc của một 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 khác dành riêng cho StreamType đều 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ẽ diễn ra và API sẽ trả về StreamRequest chung mà không bỏ qua thuộc tính nào.

Tham số

vodConfigId

chuỗi

networkCode

chuỗi

khu vực

chuỗi

projectNumber

chuỗi

oAuthToken

chuỗi
Giá trị trả về

ima.StreamRequest Đối tượng ima.StreamRequest có các thuộc tính VideoStitcherVod bắt buộc.

createVodStreamRequest

static

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode) trả về ima.StreamRequest

Khởi tạo các thuộc tính bắt buộc của VOD ima.StreamRequest. Sử dụng API này sẽ bỏ qua mọi thuộc tính cụ thể khác của ima.StreamType. Nếu bất kỳ tham số bắt buộc nào là chuỗi rỗng, quá trình ghi nhật ký lỗi sẽ xảy ra và API trả về StreamRequest chung, không bỏ qua bất kỳ thuộc tính nào.

Tham số

contentSourceId

chuỗi

videoId

chuỗi

apiKey

chuỗi

Tham số được chỉ định cho thuộc tính ima.StreamRequest.apiKey của ima.StreamRequest được trả về. Nếu không có khoá API, hãy truyền một chuỗi trống.

networkCode

chuỗi

Mã mạng dành cho nhà xuất bản thực hiện yêu cầu phát trực tuyến. Việc thêm mã mạng là tùy chọn nhưng được khuyến khích.
Giá trị trả về

Đối tượng ima.StreamRequest ima.StreamRequest có các thuộc tính VOD bắt buộc.