Package google.ads.drx.video.v1

索引

VideoContentIngestionService

內容擷取 API 服務，可在 Google Ad Manager 中建立或更新影片內容及其相關中繼資料。

UpdateVideoContent

rpc UpdateVideoContent(UpdateVideoContentRequest) returns (VideoContent)

如果內容已存在於 Ad Manager 中，可使用 API 建立新內容或更新中繼資料。成功時傳回內容，失敗時傳回 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 總覽。

ClosedCaptionFormat

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

列舉
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

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

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 的劇集。「MV」- 電影 3. 「SP」- 體育賽事
gracenote_series_id

string

(選用步驟) 這個欄位是指 Gracenote 系列 ID。開頭必須為「SH」。

中繼資料

內容的自訂中繼資料。

欄位
key_values

map<string, Value>

以鍵/值組合形式識別內容的自訂中繼資料。值只能是字串或字串清單。

SyndicatedVideoContentNames

所有聯合發布內容的名稱清單。

欄位
syndicated_video_content[]

string

重複欄位：聯合發布內容的名稱。格式必須為「networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}」，且必須與含有這個欄位的內容屬於同一個電視網。

UpdateVideoContentRequest

Request for [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，這個內容應屬於該 ID。

cms_content_id 是 Google Ad Manager 中的 CMS 內容 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 影片已設定條件/分割。