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

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

UpdateVideoContent

rpc UpdateVideoContent(UpdateVideoContentRequest) returns (VideoContent)

新しいコンテンツを作成したり、コンテンツがすでにアド マネージャーに存在する場合はメタデータを更新したりするための 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() コマンドが含まれることがある。例: - time_signal() を使用する場合: "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==" - splice_insert() あり: "/DAvAAAAAAAAAA///wFAVIAACPf+/+sABAAWAADVnALvAL
pod_template_name

string

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

BreakState

ミッドロール挿入点の現在の状態。

BreakState

ミッドロール挿入点の状態。

列挙型
BREAK_STATE_UNSPECIFIED ミッドロール挿入点のステータスが不明です。
BREAK_STATE_DECISIONED ミッドロール挿入点の決定が開始されましたが、まだユーザーに配信されていません。
BREAK_STATE_COMPLETE ミッドロール挿入点がユーザーに配信されました。

ClosedCaptionFormat

字幕ファイルの形式。

列挙型
CLOSED_CAPTION_FORMAT_UNSPECIFIED 字幕の形式が指定されていません。
TTML application/ttaf+xml
WEB_VTT text/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

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

VideoContentStatus

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

列挙型
ACTIVE コンテンツ ターゲット広告が配信されます。
BLOCKED ステータスが「ブロック」の場合、このコンテンツには広告は配信されません。
DELETED コンテンツはアド マネージャーでアーカイブされます。「削除済み」のマークが付いたコンテンツの広告リクエストがアド マネージャーで届いた場合は、自社広告や、広告枠ユニットや他のターゲティング条件をターゲットとしている広告が配信されます。広告をブロックするには、ステータスを [ブロック] に設定します。

VideoContentSyndicationInfo

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

フィールド
共用体フィールド syndication。VideoContentSyndiationMetadata には、次のいずれかのみを含めることができます。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 動画には条件付け/スプライス加工が施されています。