Package google.ads.drx.video.v1

索引

AdBreakNotificationService

ライブ ストリーム内でミッドロール挿入点を作成できる API サービス。

広告ブレークの作成

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 の概要をご覧ください。

動画コンテンツ取り込みサービス

Google アド マネージャーで動画コンテンツやそれに関連するメタデータを作成または更新できる、コンテンツ取り込み用の API サービス。

UpdateVideoContent

rpc UpdateVideoContent(UpdateVideoContentRequest) returns (VideoContent)

新しいコンテンツを作成するための API や、コンテンツがすでにアド マネージャーに存在する場合はメタデータを更新する 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 の概要をご覧ください。

AdBreak

ライブ動画イベントでミッドロール挿入点を決定するための広告ブレーク メタデータです。

フィールド
name

string

出力のみ。広告ブレークのリソース名。このフィールドの形式は「networks//assets//adBreaks/」 になります。

network_code は、このコンテンツが属する Google アド マネージャーのネットワーク コードです。

asset_key は、Google 広告管理のライブ ストリーム イベントのキーであり、その下に広告ブレークが作成されます。

ad_break_id は、ミッドロール挿入点のキーです。出力のみ。
expected_duration

Duration

必須。想定される中断期間。
custom_params

string

アド マネージャーのカスタム条件ターゲティングでこのブレークの広告リクエストに含める Key-Value ペア。例: 'key1=value&key2=value2,value22'
scte_35_cue_out

string

scte35 キューアウトの Base64 エンコード データ。splice_insert() または time_signal() コマンドを含めることもできます。--
pod_template_name

string

Google アド マネージャーの連続配信広告のテンプレート名。
break_state

BreakState

広告ブレークの現在の状態。

ブレイク状態

広告ブレークの状態。

列挙型
BREAK_STATE_UNSPECIFIED 広告ブレークの状態は不明です。
BREAK_STATE_DECISIONED 広告ブレークの決定が開始されましたが、まだユーザーに配信されていません。
BREAK_STATE_COMPLETE 広告ブレークがユーザーに配信されました。

クローズド キャプション フォーマット

自動字幕起こしファイルの形式です。

列挙型
CLOSED_CAPTION_FORMAT_UNSPECIFIED 字幕形式が指定されていません。
TTML application/ttaf+xml
WEB_VTT テキスト/vtt

ClosedCaptionUrlInfo

1 つの字幕ファイルのメタデータ。

フィールド
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

これは、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

字幕ファイルの URL。
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」を付ける必要があります。

ListAdBreaksRequest

AdBreakNotificationService.ListAdBreaks のリクエスト。

フィールド
parent

string

（省略可）このフィールドでは、ライブ ストリーム アセットキーを使用して、この広告ブレークを関連付ける LiveStreamEvent を特定します。形式は「{networks/{network_code}/assets/{asset_code}」です。
custom_parent

string

（省略可）このフィールドには、カスタム アセット キーを使用して、この広告ブレークを関連付けたい LiveStreamEvent を指定します。形式は「{networks/{network_code}/customAssets/{asset_code}」です。
content

string

（省略可）これは、GAM 内のコンテンツに関連付けられている場合に LiveStreamEvent を識別するもう一つの方法です。形式は「{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>

コンテンツのカスタム メタデータを Key-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 アド マネージャーのネットワーク コードです。

content_source_id は、このコンテンツが属する Google アド マネージャーのコンテンツ ソース ID です。

cms_content_id は、Google アド マネージャーの CMS コンテンツ ID です。対応する動画に対してアド マネージャーから配信可能な広告を識別するための広告リクエストの一部として作成されます。この値は、数字または英数字のいずれかです。
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

ダイナミック広告挿入に関連するコンテンツのメタデータ。

動画コンテンツのステータス

コンテンツでターゲット広告を配信するかどうかを示すオプション。

列挙型
ACTIVE コンテンツ ターゲット広告が配信される。
BLOCKED ステータスが「BLOCKED」の場合、このコンテンツには広告が配信されません。
DELETED そのコンテンツはアド マネージャーでアーカイブされます。アド マネージャーで「削除」とマークされたコンテンツの広告リクエストを受け取った場合は、自社広告、広告枠ユニットなどのターゲティング条件をターゲティングしている広告は引き続き配信可能です。広告をブロックするには、ステータスを [ブロック中] に設定します。

VideoContentSyndicationInfo

正規コンテンツとシンジケート コンテンツとの関係を指定するためのメタデータ。

フィールド
共用体フィールド syndication。VideoContentSyndiationMetadata には、次のいずれか 1 つのみを含めることができます。syndication は次のいずれかになります。
canonical_video_content

string

正規コンテンツの名前。形式は「{networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}」であり、このフィールドを含むコンテンツと同じネットワークに属している必要があります。
syndicated_video_content_names

SyndicatedVideoContentNames

シンジケート コンテンツのコレクション

動画フォーマット

動画コンテンツをエンコードできる形式。

列挙型
VIDEO_FORMAT_UNSPECIFIED 動画フォーマットが指定されていません。
HLS application/x-mpegURL
DASH application/dash+xml

動画取り込みの URL 情報

条件付けとプレイリストの生成に使用される m3u8 ファイルへのリンクを指定するメタデータ。

フィールド
video_format

VideoFormat

動画の形式。
video_preconditioned

VideoPreconditioned

コンテンツに対してミッドロール広告がすでに条件付けられているかどうかを示す。つまり、広告ブレークの時点でセグメントが分割されていることを意味します。
url

string

m3u8 ファイルへのリンク。

動画事前の条件付け

動画コンテンツの条件付けされた状態。

列挙型
NO まだ条件付けされていません。
YES 動画の条件付けやばらつきがある。