Package google.ads.drx.video.v1

ดัชนี

AdBreakNotificationService

บริการ API ที่ช่วยให้ผู้เผยแพร่โฆษณาสร้างช่วงพักโฆษณาภายในสตรีมแบบสดได้

CreateAdBreak

rpc CreateAdBreak(CreateAdBreakRequest) returns (AdBreak)

API สำหรับสร้างช่วงพักโฆษณาภายในสตรีมแบบสด

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

สำหรับข้อมูลเพิ่มเติม โปรดดูที่ภาพรวมของ OAuth 2.0
ListAdBreaks

rpc ListAdBreaks(ListAdBreaksRequest) returns (ListAdBreaksResponse)

API สำหรับแสดงรายการช่วงพักโฆษณาในสตรีมแบบสด

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

สำหรับข้อมูลเพิ่มเติม โปรดดูที่ภาพรวมของ OAuth 2.0

VideoContentIngestionService

บริการ API สำหรับการนำเข้าเนื้อหาที่อนุญาตให้สร้างหรืออัปเดตเนื้อหาวิดีโอและข้อมูลเมตาที่เกี่ยวข้องใน Google Ad Manager

UpdateVideoContent

rpc UpdateVideoContent(UpdateVideoContentRequest) returns (VideoContent)

API เพื่อสร้างเนื้อหาใหม่หรืออัปเดตข้อมูลเมตาหากมีเนื้อหานั้นใน Ad Manager อยู่แล้ว แสดงผลเนื้อหาที่สำเร็จหรือ google.rpc.Code เมื่อล้มเหลว

ตัวอย่างคำขอมีลักษณะดังนี้

{
   "status": "ACTIVE",
   "title": "Best video ever",
   "updateTime": "2019-01-24T01:30:15.01Z",
   "duration": "230s",
   "cuePoints": ["55.532s", "192s"],
   "publishTime": "2019-01-24T01:30:15.01Z",
   "thumbnailUrl": "http://www.domain.com/tn.jpg",
   "metadata": {
       "keyValues": {
           "category": "sports",
           "tag": ["soccer", "messi"],
       }
   }
}
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

สำหรับข้อมูลเพิ่มเติม โปรดดูที่ภาพรวมของ OAuth 2.0

AdBreak

ข้อมูลเมตาของช่วงพักโฆษณาที่ใช้เพื่อตัดสินโฆษณาสำหรับช่วงพักโฆษณาในเหตุการณ์วิดีโอแบบสด

ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรของช่วงพักโฆษณา ฟิลด์นี้จะมีรูปแบบเป็น "networks//assets//adBreaks/"

network_code คือรหัสเครือข่ายใน Google Ad Manager ที่มีเนื้อหานี้

Asset_key เป็นคีย์ของเหตุการณ์สตรีมแบบสดในการจัดการโฆษณา Google ที่ใช้สร้างช่วงพักโฆษณา

ad_break_id เป็นคีย์ของช่วงพักโฆษณา เอาต์พุตเท่านั้น
expected_duration

Duration

ต้องระบุ ระยะเวลาพักที่คาดไว้
custom_params

string

คู่คีย์-ค่าจะรวมอยู่ในคำขอโฆษณาสำหรับช่วงพักโฆษณานี้สำหรับการกำหนดเป้าหมายตามเกณฑ์ที่กำหนดเองใน Ad Manager ตัวอย่างเช่น 'key1=value&key2=value2,value22'
scte_35_cue_out

string

ข้อมูลที่เข้ารหัสฐาน 64 จากข้อความสุดท้าย SCTE-35 อาจรวมคำสั่ง splice_insert() หรือ time_signal() ด้วย ตัวอย่าง: - with time_signal(): “/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==” - with splice_insert(): "/DAvAAAAAAAA///wFAVIAACPf+4+c2AAhALA
pod_template_name

string

ชื่อเทมเพลตพ็อด Google Ad Manager
break_state

BreakState

สถานะปัจจุบันของช่วงพักโฆษณา

BreakState

สถานะของช่วงพักโฆษณา

Enum
BREAK_STATE_UNSPECIFIED ไม่ทราบสถานะช่วงพักโฆษณา
BREAK_STATE_DECISIONED เริ่มการตัดสินใจเกี่ยวกับช่วงพักโฆษณาแล้วแต่ยังไม่แสดงต่อผู้ใช้
BREAK_STATE_COMPLETE ส่งช่วงพักโฆษณาให้ผู้ใช้แล้ว

ClosedCaptionFormat

รูปแบบไฟล์คำบรรยายแทนเสียง

Enum
CLOSED_CAPTION_FORMAT_UNSPECIFIED ไม่ได้ระบุรูปแบบคำบรรยาย
TTML application/ttaf+xml
WEB_VTT text/vtt

ClosedCaptionUrlInfo

ข้อมูลเมตาสำหรับไฟล์คำบรรยายแทนเสียงไฟล์เดียว

ช่อง
language_code

string

รหัสภาษา IETF BCP-47 ที่แสดงถึงภาษาที่ใช้ในไฟล์คำบรรยายแทนเสียง
closed_caption_format

ClosedCaptionFormat

รูปแบบของไฟล์คำบรรยายแทนเสียง
url

string

URL ไปยังไฟล์คำบรรยายแทนเสียง

CreateAdBreakRequest

คำขอสำหรับ AdBreakNotificationService.CreateAdBreak

ช่อง
parent

string

ช่องนี้ระบุ LiveStreamEvent ที่ช่วงพักโฆษณานี้ควรเชื่อมโยงโดยใช้คีย์เนื้อหาสตรีมแบบสด ต้องอยู่ในรูปแบบ "networks/{network_code}/assets/{asset_code}"
custom_parent

string

ช่องนี้ระบุ LiveStreamEvent ที่ช่วงพักโฆษณานี้ควรลิงก์ด้วยโดยใช้คีย์เนื้อหาที่กำหนดเอง โดยต้องอยู่ในรูปแบบ "networks/{network_code}/customAssets/{asset_code}"
content

string

นี่เป็นอีกวิธีหนึ่งในการระบุ LiveStreamEvent หากเชื่อมโยงกับเนื้อหาภายใน GAM ต้องอยู่ในรูปแบบ "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}"
ad_break

AdBreak

ต้องระบุ ช่วงพักโฆษณาจริง
ad_break_id

string

นี่คือ ad_break_id ที่ผู้ใช้ระบุผ่านคําขอได้

DynamicAdInsertionInfo

ข้อมูลเกี่ยวกับการแทรกโฆษณาแบบไดนามิก

ช่อง
video_ingest_url_info

VideoIngestUrlInfo

ลิงก์ไปยังไฟล์ m3u8 หลักที่ใช้ในการปรับสภาพและการสร้างเพลย์ลิสต์
media_update_time

Timestamp

เวลาที่แก้ไขไฟล์วิดีโอที่อ้างอิงใน video_ingest_url_info ครั้งล่าสุด
closed_caption_url_info[]

ClosedCaptionUrlInfo

URL ไปยังไฟล์คำอธิบายภาพ/คำบรรยาย
fw_caid

string

รหัสเนื้อหาที่กำหนดเองของ FreeWheel ซึ่งใช้สำหรับการกำหนดเป้าหมายโฆษณา

GracenoteMetadata

ข้อมูลเมตาของ Gracenote สำหรับเนื้อหา

ช่อง
gracenote_id

string

ต้องระบุ โปรดดูรหัส Gracenote สำหรับเนื้อหา ต้องมีคำนำหน้าที่ถูกต้องอย่างใดอย่างหนึ่งต่อไปนี้ 1. "EP" - ตอนของซีรีส์ 2 "MV" - ภาพยนตร์ 3 "SP" - การแข่งขันกีฬา
gracenote_series_id

string

ไม่บังคับ ช่องนี้หมายถึงรหัสชุด Gracenote ต้องขึ้นต้นด้วย "SH"

ListAdBreaksRequest

คำขอสำหรับ AdBreakNotificationService.ListAdBreaks

ช่อง
parent

string

ไม่บังคับ ช่องนี้ระบุ LiveStreamEvent ที่ช่วงพักโฆษณานี้ควรเชื่อมโยงโดยใช้คีย์เนื้อหาสตรีมแบบสด ต้องอยู่ในรูปแบบ "networks/{network_code}/assets/{asset_code}"
custom_parent

string

ไม่บังคับ ช่องนี้ระบุ LiveStreamEvent ที่ช่วงพักโฆษณานี้ควรลิงก์ด้วยโดยใช้คีย์เนื้อหาที่กำหนดเอง โดยต้องอยู่ในรูปแบบ "networks/{network_code}/customAssets/{asset_code}"
content

string

ไม่บังคับ นี่เป็นอีกวิธีหนึ่งในการระบุ LiveStreamEvent หากเชื่อมโยงกับเนื้อหาภายใน GAM ต้องอยู่ในรูปแบบ "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}"
page_size

int32

ไม่บังคับ จำนวนช่วงพักโฆษณาสูงสุดที่จะแสดง บริการอาจแสดงผลน้อยกว่าค่านี้ หากไม่ระบุ ระบบจะแสดงผลช่วงพักโฆษณาไม่เกิน 10 รายการ ค่าสูงสุดคือ 100 ค่าที่มากกว่า 100 จะถูกเปลี่ยนเป็น 100
page_token

string

ไม่บังคับ โทเค็นของหน้าเว็บที่ได้รับจากการโทร ListAdBreaks ก่อนหน้า โปรดระบุข้อมูลนี้เพื่อเรียกข้อมูลหน้าถัดไป

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

ListAdBreaksResponse

การตอบกลับสำหรับ AdBreakNotificationService.ListAdBreaks

ช่อง
ad_breaks[]

AdBreak

เอาต์พุตเท่านั้น รายการช่วงพักโฆษณาที่ตรงกับ LiveStreamEvent ที่ขอ
next_page_token

string

โทเค็นที่ส่งเป็น page_token เพื่อเรียกข้อมูลหน้าถัดไปได้ หากเว้นช่องนี้ไว้ จะไม่มีหน้าลำดับต่อมา

ข้อมูลเมตา

ข้อมูลเมตาที่กำหนดเองของเนื้อหา

ช่อง
key_values

map<string, Value>

ระบุข้อมูลเมตาที่กำหนดเองของเนื้อหาเป็นคู่คีย์-ค่า เฉพาะสตริงหรือรายการของสตริงเท่านั้นที่ยอมรับค่า

SyndicatedVideoContentNames

รายชื่อของเนื้อหาที่เผยแพร่ทั้งหมด

ช่อง
syndicated_video_content[]

string

ช่องที่ซ้ำของชื่อของเนื้อหาที่คัดลอกมา โดยต้องอยู่ในรูปแบบ "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}" และต้องอยู่ในเครือข่ายเดียวกับเนื้อหาที่มีฟิลด์นี้

UpdateVideoContentRequest

คำขอสำหรับ [VideoContentIngestionService.UpdateVideoContentRequest][]

ช่อง
video_content

VideoContent

ต้องระบุ ข้อมูลเมตาของเนื้อหา

เนื้อหาวิดีโอ

ข้อมูลเมตาของเนื้อหา

ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรของเนื้อหาวิดีโอ ช่องนี้มีรูปแบบเป็น "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}"

network_code คือรหัสเครือข่ายใน Google Ad Manager ที่มีเนื้อหานี้

content_source_id คือรหัสแหล่งที่มาของเนื้อหาใน Google Ad Manager ที่ควรมีเนื้อหานี้

cms_content_id คือรหัสเนื้อหา CMS ใน Google Ad Manager ซึ่งเป็นส่วนหนึ่งของคำขอโฆษณาเพื่อระบุว่า Ad Manager จะแสดงโฆษณารายการใดให้กับวิดีโอที่เกี่ยวข้องได้ ค่านี้จะเป็นตัวเลขหรือตัวอักษรและตัวเลขคละกันก็ได้
status

VideoContentStatus

สถานะของเนื้อหา หากไม่ระบุค่านี้ ค่าเริ่มต้นจะเป็นใช้งานอยู่
title

string

ต้องระบุ ชื่อเนื้อหา
update_time

Timestamp

ต้องระบุ เวลาที่แก้ไขล่าสุดของเนื้อหา
publish_time

Timestamp

เวลาที่เผยแพร่เนื้อหา นี่เป็นช่องที่ต้องกรอกหากวิดีโอออกแบบมาให้รวมอยู่ในกฎโฆษณาที่ระบุเวลาเริ่มต้นและเวลาสิ้นสุด
duration

Duration

ระยะเวลาของเนื้อหา ระยะเวลารองรับได้ถึงระดับมิลลิวินาที
cue_points[]

Duration

ระบุจุดเริ่มโฆษณา จุดเริ่มโฆษณาคือจุดในช่วงเวลาที่โฆษณาแทรกในวิดีโอได้ เพิ่มจุดเริ่มโฆษณาได้ถึงระดับมิลลิวินาที นี่คือช่องที่ต้องกรอกหากวิดีโอมีช่วงพักโฆษณาตอนกลาง
thumbnail_url

string

URL ภาพขนาดย่อของเนื้อหา
metadata

Metadata

ระบุข้อมูลเมตาที่กำหนดเองของเนื้อหา
gracenote_metadata

GracenoteMetadata

ข้อมูลเมตาที่เกี่ยวข้องกับเนื้อหาจาก Gracenote
syndication_metadata

VideoContentSyndicationInfo

ข้อมูลเมตาที่เกี่ยวข้องกับการเผยแพร่ของเนื้อหา
dynamic_ad_insertion_metadata

DynamicAdInsertionInfo

ข้อมูลเมตาที่เกี่ยวข้องกับการแทรกโฆษณาแบบไดนามิกของเนื้อหา

VideoContentStatus

ตัวเลือกสถานะเพื่อแสดงหรือไม่แสดงโฆษณาที่กำหนดเป้าหมายสำหรับเนื้อหา

Enum
ACTIVE โฆษณาที่กำหนดเป้าหมายจากเนื้อหาจะได้รับการแสดงผล
BLOCKED จะไม่มีการแสดงโฆษณาในเนื้อหานี้ หากสถานะเป็น "บล็อก"
DELETED ระบบจะเก็บเนื้อหาไว้ใน Ad Manager หาก Ad Manager ได้รับคำขอโฆษณาสำหรับเนื้อหาที่ทำเครื่องหมายว่า "ลบแล้ว" โฆษณาเฮาส์แอ็ด หรือโฆษณาที่กำหนดเป้าหมายไปยังหน่วยพื้นที่โฆษณาหรือเกณฑ์การกำหนดเป้าหมายอื่นๆ จะยังแสดงต่อได้ หากต้องการบล็อกโฆษณา ให้ตั้งค่าสถานะเป็น "บล็อก"

VideoContentSyndicationInfo

ข้อมูลเมตาสำหรับการระบุความสัมพันธ์ระหว่างเนื้อหา Canonical และเนื้อหาที่คัดลอกมา

ช่อง
ช่องการรวม syndication VideoContentSyndiationMetadata สามารถประกอบด้วยค่าใดข้อมูลหนึ่งต่อไปนี้เท่านั้น syndication ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
canonical_video_content

string

ชื่อของเนื้อหา Canonical ต้องอยู่ในรูปแบบ "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}" และต้องอยู่ในเครือข่ายเดียวกับเนื้อหาที่มีฟิลด์นี้
syndicated_video_content_names

SyndicatedVideoContentNames

คอลเล็กชันเนื้อหาที่คัดลอกมา

VideoFormat

รูปแบบที่อาจมีการเข้ารหัสเนื้อหาวิดีโอ

Enum
VIDEO_FORMAT_UNSPECIFIED ไม่ได้ระบุรูปแบบวิดีโอ
HLS application/x-mpegURL
DASH application/dash+xml

VideoIngestUrlInfo

ข้อมูลเมตาที่ระบุลิงก์ไปยังไฟล์ m3u8 ที่ใช้ในการปรับสภาพและการสร้างเพลย์ลิสต์

ช่อง
video_format

VideoFormat

รูปแบบของวิดีโอ
video_preconditioned

VideoPreconditioned

เพื่อระบุว่ามีการปรับสภาพเนื้อหาสำหรับโฆษณาตอนกลางหรือยัง ซึ่งหมายความว่ามีการแยกกลุ่มของคุณไว้แล้วเมื่อถึงช่วงพักโฆษณา
url

string

ลิงก์ไปยังไฟล์ m3u8

VideoPreconditioned

สถานะที่ปรับสภาพของเนื้อหาวิดีโอ

Enum
NO ยังไม่ได้ปรับสภาพ
YES วิดีโอมีการปรับสภาพ/แยก