Package google.ads.drx.video.v1

インデックス

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

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。

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」を付ける必要があります。

メタデータ

コンテンツのカスタム メタデータ。

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

コンテンツのステータス。省略した場合、デフォルト値は active になります。

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 ステータスが [BLOCKED] の場合、このコンテンツに対して広告は配信されません。
DELETED コンテンツはアド マネージャーでアーカイブされます。アド マネージャーが削除済みとマークされたコンテンツの広告リクエストを受け取った場合、自社広告や、広告枠ユニットまたはその他のターゲティング条件をターゲットとする広告は、引き続き配信されます。広告をブロックするには、ステータスを BLOCKED に設定します。

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

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

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 動画は条件付け/分割されています。