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

來自 scte35 結束提示點的 Base 64 編碼資料。可包含 splice_insert() 或 time_signal() 指令。範例:- 使用 time_signal():「/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==」- 使用 splice_insert():「/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="

pod_template_name

string

Google Ad Manager 廣告連播範本名稱。

break_state

BreakState

廣告插播的目前狀態。

BreakState

廣告插播的狀態。

列舉
BREAK_STATE_UNSPECIFIED 廣告插播狀態不明。
BREAK_STATE_DECISIONED 廣告插播決定已開始,但尚未向使用者傳達。
BREAK_STATE_COMPLETE 已向使用者顯示廣告插播。

ClosedCaptionFormat

隱藏式輔助字幕檔案可能採用的格式。

列舉
CLOSED_CAPTION_FORMAT_UNSPECIFIED 未指定隱藏式輔助字幕格式。
TTML application/ttaf+xml
WEB_VTT 文字/vtt

ClosedCaptionUrlInfo

一個隱藏式輔助字幕檔案的中繼資料。

欄位
language_code

string

代表隱藏式輔助字幕檔案所用語言的 IETF BCP-47 語言代碼。

closed_caption_format

ClosedCaptionFormat

隱藏式輔助字幕檔案的格式。

url

string

隱藏式輔助字幕檔案的網址。

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 內的特定內容相關聯,這是另一種識別 LiveStreamEvent 的方式。格式必須為「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

隱藏式輔助字幕/字幕檔案的網址。

fw_caid

string

用於指定廣告的 Freewheel 自訂素材資源 ID。

GracenoteMetadata

內容的 Gracenote 中繼資料。

欄位
gracenote_id

string

必要欄位。指的是內容的 Gracenote ID。必須包含下列其中一個有效前置字:1. 「EP」- 第 2 輪系列的第 1 集。'MV' - 電影 3. SP- 體育賽事

gracenote_series_id

string

選用設定。這個欄位是指 Gracenote 系列 ID。開頭必須是「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 的另一種方法,如果 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

必要欄位。內容的中繼資料。

VideoContentId:

內容的中繼資料。

欄位
name

string

僅供輸出。影片內容的資源名稱。這個欄位的格式為:'networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}'

network_code 是 Google Ad Manager 中這項內容所屬的聯播網代碼。

content_source_id 是 Google Ad Manager 中這項內容應屬於的內容來源 ID。

cms_content_id 是 Google Ad Manager 中的 CMS 內容 ID,此 ID 是廣告請求的一部分,可指出 Ad Manager 可根據相應影片放送哪些廣告。這個值可以是數字或英數字元。

status

VideoContentStatus

內容的狀態。如果省略這個屬性,系統會使用預設值。

title

string

必要欄位。內容標題。

update_time

Timestamp

必要欄位。內容的上次修改時間。

publish_time

Timestamp

內容的發布時間。如果影片設計為在廣告規則中加入指定開始和結束時間,則這個欄位為必填欄位。

duration

Duration

內容的時間長度。支援的時間長度精確到毫秒等級。

cue_points[]

Duration

用於識別提示點。提示點是可在影片中插入廣告的時間點。提示點支援的時間精確度可達毫秒等級。如果影片包含片中廣告插播時間點,則這是必要欄位。

thumbnail_url

string

內容的縮圖網址。

metadata

Metadata

指出內容的自訂中繼資料。

gracenote_metadata

GracenoteMetadata

內容的 Gracenote 相關中繼資料。

syndication_metadata

VideoContentSyndicationInfo

內容聯合發布相關中繼資料。

dynamic_ad_insertion_metadata

DynamicAdInsertionInfo

內容的動態廣告插播相關中繼資料。

VideoContentStatus

用來針對內容放送或不要放送指定廣告的狀態選項。

列舉
ACTIVE 系統會放送指定內容廣告。
BLOCKED 如果狀態為「已封鎖」,系統就不會對這項內容放送廣告。
DELETED 內容會在 Ad Manager 中封存。如果 Ad Manager 收到已標示為「已刪除」的內容廣告請求,仍可放送內部廣告,或是指定廣告空間單元或其他指定條件的廣告。如要封鎖廣告,請將狀態設為「已封鎖」。

VideoContentSyndicationInfo

用於指定標準內容和聯播內容之間關係的中繼資料。

欄位
聯集欄位 syndication。VideoContentSyndicationMetadata 只能包含下列其中一個值。syndication 只能是下列其中一項:
canonical_video_content

string

標準內容的名稱。格式須為「networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}」且不屬於包含這個欄位的內容聯播網。

syndicated_video_content_names

SyndicatedVideoContentNames

聯合發布內容集合

VideoFormat

影片內容可採用的編碼格式。

列舉
VIDEO_FORMAT_UNSPECIFIED 未指定影片格式。
HLS application/x-mpegURL
DASH application/dash+xml

VideoIngestUrlInfo

中繼資料,指定用於設定條件及產生播放清單的 m3u8 檔案連結。

欄位
video_format

VideoFormat

影片格式。

video_preconditioned

VideoPreconditioned

指出內容是否已針對片中廣告設有條件,也就是說,您的區隔已在廣告時段分割。

url

string

m3u8 檔案連結。

VideoPreconditioned

影片內容的條件狀態。

列舉
NO 尚未設定。
YES 影片已經過條件變更/剪輯。