Package google.ads.drx.video.v1

ดัชนี

บริการการแจ้งเตือนช่วงพักโฆษณา

บริการ 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
แสดงรายการช่วงพักโฆษณา

rpc ListAdBreaks(ListAdBreaksRequest) returns (ListAdBreaksResponse)

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

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

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

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

โปรดดูข้อมูลเพิ่มเติมที่ภาพรวม OAuth 2.0

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

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

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

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

ช่วงพักโฆษณา

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

ช่อง
name

string

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

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

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

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

Duration

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

string

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

string

ข้อมูลที่เข้ารหัสฐาน 64 จากข้อความ SCTE35 โดยอาจรวมถึงคําสั่ง splice_insert() หรือ time_signal() ตัวอย่างเช่น - ที่มี time_signal(): "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==” - พร้อมด้วย splice_insert(): "/DAvAAAAAAAA///wFAVIAACPCPf="/+c2AAALV4AUAUWAUAUAU
pod_template_name

string

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

BreakState

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

BreakState

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

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

รูปแบบคําอธิบายภาพ

รูปแบบที่อาจใช้ไฟล์คําอธิบายภาพ

Enum
CLOSED_CAPTION_FORMAT_UNSPECIFIED ไม่ได้ระบุรูปแบบคําบรรยาย
TTML แอปพลิเคชัน/ttaf+xml
WEB_VTT ข้อความ/Vtt

ข้อมูล URL ที่ปิด

ข้อมูลเมตาสําหรับไฟล์คําอธิบายภาพ 1 ไฟล์

ช่อง
language_code

string

รหัสภาษา IETF BCP-47 แสดงภาษาที่ไฟล์คําอธิบายภาพปิดอยู่
closed_caption_format

ClosedCaptionFormat

รูปแบบไฟล์คําบรรยาย
url

string

URL ไปยังไฟล์คําอธิบายภาพ

สร้างช่วงพักโฆษณา

คําขอรับเงิน 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 ที่ผู้ใช้สามารถระบุผ่านคําขอได้

ข้อมูลการแทรกโฆษณาแบบไดนามิก

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

ช่อง
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"

ขอรายการช่วงพักโฆษณา

คําขอรับเงิน 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 ต้องตรงกับการเรียกใช้โทเค็นของหน้าเว็บ

การตอบกลับรายการโฆษณา

คําตอบสําหรับ AdBreakNotificationService.ListAdBreaks

ช่อง
ad_breaks[]

AdBreak

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

string

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

Metadata

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

ช่อง
key_values

map<string, Value>

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

ชื่อเนื้อหาวิดีโอที่เผยแพร่

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

ช่อง
syndicated_video_content[]

string

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

อัปเดตคําขอเนื้อหาวิดีโอ

คําขอสําหรับ [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 คือ 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

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

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

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

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

ข้อมูลการเผยแพร่เนื้อหาวิดีโอ

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

ช่อง
ช่อง Union syndication VideoContentSyndiationMetadata จะมีได้เพียงรายการต่อไปนี้อย่างใดอย่างหนึ่ง syndication ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
canonical_video_content

string

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

SyndicatedVideoContentNames

คอลเล็กชันของเนื้อหาที่เผยแพร่

รูปแบบวิดีโอ

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

Enum
VIDEO_FORMAT_UNSPECIFIED ไม่ได้ระบุรูปแบบวิดีโอ
HLS แอปพลิเคชัน/x-mpegURL
DASH แอปพลิเคชัน/ขีดคั่น+xml

ข้อมูล URL ของวิดีโอ

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

ช่อง
video_format

VideoFormat

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

VideoPreconditioned

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

string

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

มีการปรับสภาพวิดีโอล่วงหน้า

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

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