คลาส: StreamRequest

imaStreamRequest

class   static

ผู้ผลิต

StreamRequest

StreamRequest ใหม่()

ใช้สำหรับระบุพร็อพเพอร์ตี้ของคำขอสตรีม

พร็อพเพอร์ตี้

adTagParameters

static

สตริง

ไม่บังคับ คุณลบล้างพารามิเตอร์ชุดจำกัดของแท็กโฆษณา ในคำขอสตรีมได้ จัดเตรียมพารามิเตอร์การกำหนดเป้าหมายไปยังสตรีมของคุณ ให้ข้อมูลเพิ่มเติม นอกจากนี้ คุณยังใช้พารามิเตอร์ dai-ot และ dai-ov เพื่อกำหนดค่ากำหนดสำหรับตัวแปรของสตรีมได้ด้วย ดูข้อมูลเพิ่มเติมได้ที่ ลบล้างพารามิเตอร์ตัวแปรสตรีม

adUiNode

static

roSGNode

โหนดกราฟฉากที่จะแสดง UI โฆษณา IMA วางองค์ประกอบต่างๆ เช่น ทำไมจึงแสดงโฆษณานี้ และปุ่ม ข้าม บนองค์ประกอบนี้ระหว่างแสดงโฆษณา องค์ประกอบจะต้องซ้อนทับองค์ประกอบวิดีโอทั้งหมด

apiKey

static

สตริง

ไม่บังคับ สามารถใช้คีย์เหล่านี้เพื่อยืนยันการร้องขอสตรีมได้ ต้องตั้งค่าคีย์การตรวจสอบสิทธิ์ DAI ใน UI ของ DFP

assetKey

static

สตริง

จำเป็นสำหรับการสตรีมสด ใช้เพื่อกำหนดว่าจะเล่นสตรีมใด คีย์สินทรัพย์คำขอสตรีมสดเป็นตัวระบุที่สามารถพบได้ใน UI ของ DFP

authToken

static

สตริง

โทเค็นการอนุญาตการสตรีม ใช้แทนคีย์ API สำหรับการอนุญาตเนื้อหาที่เข้มงวดยิ่งขึ้น ผู้เผยแพร่สามารถควบคุมการอนุญาตเนื้อหาแต่ละรายการโดยอิงจากโทเค็นนี้ได้

contentSourceId

static

สตริง

จำเป็นสำหรับสตรีมตามความต้องการ cmsid มาจากแหล่งเนื้อหาวิดีโอ DFP ใน UI ของ DFP

customAssetKey

static

สตริง

คีย์สินทรัพย์ที่กำหนดเองใช้เพื่อกำหนดว่าจะเล่นสตรีมใด จำเป็นต้องมีคีย์สินทรัพย์ที่กำหนดเองสำหรับพ็อดที่ให้บริการคำขอสตรีม

รูปแบบ

static

ima.StreamFormat

รูปแบบของสตรีม ค่าเริ่มต้นเป็น ima.StreamFormat.HLS

networkCode

static

สตริง

รหัสเครือข่ายสำหรับผู้เผยแพร่ที่ทำการร้องขอสตรีม ต้องใช้รหัสเครือข่ายสำหรับการร้องขอสตรีมการให้บริการ Pod ที่สร้างด้วย createPodLiveStreamRequest หรือ createPodVodStreamRequest โค้ดเหล่านี้ยังจำเป็นสำหรับคำขอสตรีมการเย็บแบบคลาวด์ที่สร้างด้วย createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest หรือ createVideoStitcherVodStreamRequestWithVodConfig รหัสเหล่านี้เป็นทางเลือกและแนะนำสำหรับการร้องขอสตรีมบริการเต็มรูปแบบที่สร้างด้วย createLiveStreamRequest หรือ createVodStreamRequest การเพิ่มโค้ดเครือข่ายจะใช้การตั้งค่าที่เลือกไว้ใน UI ของ Ad Manager เช่น การเปิดใช้งานโฆษณาแบบจำกัดตามโปรแกรม สำหรับการให้บริการ Pod และการเย็บแบบคลาวด์ การเพิ่มรหัสเครือข่ายจะระบุตำแหน่งและเล่นสตรีม หากต้องการค้นหาโค้ดเครือข่าย โปรดดูบทความนี้

ผู้เล่น

static

(ima.Player หรือไม่ถูกต้อง)

การนำอินเทอร์เฟซของผู้เล่นไปใช้

ppid

static

สตริง

เลิกใช้งานแล้ว ใช้ adTagParameters ไม่บังคับ ตัวระบุที่ผู้เผยแพร่จัดเตรียมไว้สำหรับกลุ่มเป้าหมาย DFP

streamActivityMonitorId

static

สตริง

ID ที่จะใช้ในการดีบักสตรีมด้วยเครื่องมือตรวจสอบกิจกรรมสตรีม สิ่งนี้ใช้เพื่อให้มีวิธีที่สะดวกแก่ผู้เผยแพร่ในการค้นหาบันทึกสตรีมในเครื่องมือตรวจสอบกิจกรรมสตรีม

videoId

static

สตริง

จำเป็นสำหรับสตรีมตามความต้องการ ตัวระบุสำหรับแหล่งที่มาของเนื้อหาวิดีโอ

videoObject

static

(roVideo หรือ Invalid)

วัตถุวิดีโอ (เช่น Video roSGNode) ที่รับผิดชอบการเล่นวิดีโอบนแอปไคลเอ็นต์ วัตถุนี้จะถูกสำรวจข้อมูลต่างๆ เพื่อใช้ในการกำหนดเวลาเหตุการณ์ Live HLS ID3 อย่างเหมาะสม

videoStitcherSessionOptions

static

อาร์เรย์ของ V

ตัวเลือกเซสชันใช้ในการตั้งค่าพารามิเตอร์เฉพาะของผู้เย็บวิดีโอสำหรับ VideoStitcher streamRequests

เมธอด

createLiveStreamRequest

static

createLiveStreamRequest(assetKey, apiKey, networkCode) returns ima.StreamRequest

เริ่มต้นพร็อพเพอร์ตี้ที่จำเป็นของ Live StreamRequest การใช้ API นี้จะทำให้ระบบละเว้นพร็อพเพอร์ตี้อื่นๆ ที่เฉพาะเจาะจงสำหรับ StreamType หากพารามิเตอร์ที่จำเป็นเป็นสตริงว่าง ระบบจะบันทึกข้อผิดพลาดและ API จะแสดงผล StreamRequest ทั่วไปโดยไม่มีการละเว้นพร็อพเพอร์ตี้

พารามิเตอร์
assetKey	สตริง
apiKey	สตริง พารามิเตอร์ที่กำหนดให้กับคุณสมบัติ ima.StreamRequest.apiKey ของ ima.StreamRequest ที่ส่งคืน หากไม่มีคีย์ API ให้ส่งสตริงว่าง
networkCode	สตริง รหัสเครือข่ายสำหรับผู้เผยแพร่ที่ทำการร้องขอสตรีม การรวมรหัสเครือข่ายเป็นทางเลือก แต่ขอแนะนำ

การคืนสินค้า

ima.StreamRequest ima.StreamRequest วัตถุที่มีคุณสมบัติ Live ที่จำเป็น

createPodLiveStreamRequest

static

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey) ส่งคืน StreamRequest

เริ่มต้นคุณสมบัติที่จำเป็นของ Pod Live ima.StreamRequest การใช้ API นี้ทำให้คุณสมบัติเฉพาะอื่นๆ ของ ima.StreamType จะถูกละเว้น หากพารามิเตอร์ที่จำเป็นเป็นสตริงว่าง ระบบจะทำการบันทึกข้อผิดพลาดและ API จะส่งกลับ StreamRequest ทั่วไป โดยไม่มีคุณสมบัติใดที่ถูกละเว้น

พารามิเตอร์
customAssetKey	สตริง
networkCode	สตริง
apiKey	สตริง พารามิเตอร์ตัวเลือกที่กำหนดให้กับคุณสมบัติ ima.StreamRequest.apiKey ของ ima.StreamRequest ที่ส่งคืน โดยค่าเริ่มต้นเป็นสตริงว่าง

การคืนสินค้า

วัตถุ StreamRequest ima.StreamRequest ที่มีคุณสมบัติ PodLive ที่จำเป็น

createPodVodStreamRequest

static

createPodVodStreamRequest(networkCode) ส่งคืน StreamRequest

เริ่มต้นพร็อพเพอร์ตี้ที่จำเป็นของ ima.StreamRequest เพื่อ ลงทะเบียนสตรีม VOD เมื่อใช้ DAI Pod Serving กับโปรแกรม ตัดต่อวิดีโอของบุคคลที่สาม ฟังก์ชันนี้จะตั้งค่าประเภทคำขอเป็น ima.StreamType.POD_VOD และตรวจสอบพร็อพเพอร์ตี้ที่จำเป็นทั้งหมด สำหรับข้อมูลที่ขาดหายไป การตรวจสอบความถูกต้องที่ไม่สำเร็จจะบันทึกข้อผิดพลาดในคอนโซล การแก้ไขข้อบกพร่อง

พารามิเตอร์
networkCode	สตริง รหัสเครือข่าย Google Ad Manager

การคืนสินค้า

StreamRequest และวัตถุ ima.StreamRequest หากระบุคุณสมบัติที่จำเป็นทั้งหมดแล้ว ประเภทคำขอจะถูกตั้งเป็น ima.StreamType.POD_VOD

createStreamRequest

static

createStreamRequest() ส่งคืน ima.StreamRequest

การคืนสินค้า

ima.StreamRequest วัตถุ ima.StreamRequest ที่ว่างเปล่า

createVideoStitcherLiveStreamRequest

static

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken) ส่งคืน ima.StreamRequest

เริ่มต้นพร็อพเพอร์ตี้ที่จำเป็นของ Video Stitcher Live StreamRequest การใช้ API นี้จะทำให้ระบบละเว้นพร็อพเพอร์ตี้อื่นๆ ที่เฉพาะเจาะจงสำหรับ StreamType หากพารามิเตอร์ที่จำเป็นเป็นสตริงว่าง ระบบจะบันทึกข้อผิดพลาดและ API จะแสดงผล StreamRequest ทั่วไปโดยไม่มีการละเว้นพร็อพเพอร์ตี้

พารามิเตอร์
customAssetKey	สตริง
networkCode	สตริง
liveConfigId	สตริง
ภูมิภาค	สตริง
projectNumber	สตริง
oAuthToken	สตริง

การคืนสินค้า

วัตถุ ima.StreamRequest ima.StreamRequest ที่มีคุณสมบัติ VideoStitcherLive ที่จำเป็น

createVideoStitcherVodStreamRequest

static

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken) ส่งคืน ima.StreamRequest

เริ่มต้นพร็อพเพอร์ตี้ที่จำเป็นของ VOD ของเครื่องมือตัดต่อวิดีโอ StreamRequest การใช้ API นี้จะทำให้ระบบละเว้นพร็อพเพอร์ตี้อื่นๆ ที่เฉพาะเจาะจงสำหรับ StreamType หากพารามิเตอร์ที่จำเป็นเป็นสตริงว่าง ระบบจะบันทึกข้อผิดพลาดและ API จะแสดงผล StreamRequest ทั่วไปโดยไม่มีการละเว้นพร็อพเพอร์ตี้

พารามิเตอร์
adTagUrl	สตริง
networkCode	สตริง
contentSourceUrl	สตริง
ภูมิภาค	สตริง
projectNumber	สตริง
oAuthToken	สตริง

การคืนสินค้า

วัตถุ ima.StreamRequest ima.StreamRequest ที่มีคุณสมบัติ VideoStitcherVod ที่จำเป็น

createVideoStitcherVodStreamRequestWithVodConfig

static

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken) ส่งคืน ima.StreamRequest

เริ่มต้นคุณสมบัติที่จำเป็นของ Video Stitcher VOD StreamRequest โดยใช้ vodConfigId ที่สร้างจาก Cloud Video Stitcher การใช้ API นี้ทำให้คุณสมบัติเฉพาะอื่นๆ ของ StreamType จะถูกละเว้น หากพารามิเตอร์ที่จำเป็นเป็นสตริงว่าง ระบบจะทำการบันทึกข้อผิดพลาดและ API จะส่งกลับ StreamRequest ทั่วไป โดยไม่มีคุณสมบัติใดที่ถูกละเว้น

พารามิเตอร์
vodConfigId	สตริง
networkCode	สตริง
ภูมิภาค	สตริง
projectNumber	สตริง
oAuthToken	สตริง

การคืนสินค้า

วัตถุ ima.StreamRequest ima.StreamRequest ที่มีคุณสมบัติ VideoStitcherVod ที่จำเป็น

createVodStreamRequest

static

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode) ส่งคืน ima.StreamRequest

เริ่มต้นพร็อพเพอร์ตี้ที่จำเป็นของ VOD ima.StreamRequest การใช้ API นี้จะทำให้ระบบละเว้นพร็อพเพอร์ตี้อื่นๆ ที่เฉพาะเจาะจงสำหรับ ima.StreamType หากพารามิเตอร์ที่จำเป็นเป็นสตริงว่าง ระบบจะบันทึกข้อผิดพลาดและ API จะแสดงผล StreamRequest ทั่วไปโดยไม่มีการละเว้นพร็อพเพอร์ตี้

พารามิเตอร์
contentSourceId	สตริง
videoId	สตริง
apiKey	สตริง พารามิเตอร์ที่กำหนดให้กับคุณสมบัติ ima.StreamRequest.apiKey ของ ima.StreamRequest ที่ส่งคืน หากไม่มีคีย์ API ให้ส่งสตริงว่าง
networkCode	สตริง รหัสเครือข่ายสำหรับผู้เผยแพร่ที่ทำการร้องขอสตรีม การรวมรหัสเครือข่ายเป็นทางเลือก แต่ขอแนะนำ

การคืนสินค้า

ima.StreamRequest ima.StreamRequest วัตถุที่มีคุณสมบัติ VOD ที่จำเป็น