REST Resource: networks.sources.content.adBreaks

リソース: AdBreak

ライブ動画イベントのミッドロール挿入点にディシジョン広告を使用するために使用されるミッドロール挿入点のメタデータ。

JSON 表現
{
  "name": string,
  "createTime": string,
  "expectedDuration": string,
  "customParams": string,
  "scte35CueOut": string,
  "podTemplateName": string,
  "breakState": enum (BreakState),
  "expectedStartTime": string,
  "expireDuration": string,
  "breakSequence": string,
  "breakParams": {
    object (BreakParams)
  },
  "matchParams": {
    object (MatchParams)
  },
  "servedBreak": {
    object (ServedBreak)
  }
}
フィールド
name

string

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

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

asset_key は、ミッドロール挿入点が作成された Google アド マネージャーのライブ ストリーム イベントのキーです。

adBreakId は広告ブレークのキーです。出力のみ。

createTime

string (Timestamp format)

出力専用。広告ブレークの作成日時。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

expectedDuration

string (Duration format)

必須。予想される休憩時間。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"

customParams
(deprecated)

string

省略可。アド マネージャーでカスタム条件をターゲティングする際に、この広告ブレークで広告リクエストに含める Key-Value ペアです。例: 'key1=value&key2=value2,value22' 非推奨: 「cust_params」キーを使用して、breakParams.ad_tag_params で cust_params を設定してください。

scte35CueOut

string

省略可。scte35 キューアウトの Base64 エンコード データです。splice_insert() または time_signal() コマンドを含めることができます。例: - time_signal() の場合: 「/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==」 - splice_insert() の場合: 「/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo=」

podTemplateName
(deprecated)

string

省略可。Google アド マネージャーの Pod テンプレート名。非推奨: 「ptpln」キーを使用して、breakParams.ad_tag_params で cust_params を設定してください。

breakState

enum (BreakState)

出力専用。広告ブレークの現在の状態。

expectedStartTime

string (Timestamp format)

省略可。広告ブレークの開始予定時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

expireDuration

string (Duration format)

省略可。expectedStartTime + expireDuration で広告ブレークを期限切れにします。expectedStartTime が設定されていない場合、広告ブレークは判定の開始から expireDuration 後に期限切れになります。デフォルト: 30 分 最小: 5 分 最大: 6 時間

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"

breakSequence

string (int64 format)

出力専用。広告ブレークのミッドロール シーケンス ID。breakParams.ad_tag_params で mridx キーを使用して明示的に指定した場合、複数の広告ブレークで同じ breakSequence を使用できます。これにより、2 つの Google アド マネージャーのミッドロール挿入点が効果的にリンクされます。

breakParams

object (BreakParams)

省略可。このブレークの広告リクエストに含めるブレーク パラメータ。

matchParams

object (MatchParams)

省略可。スティッチド DAI で、API を介して作成された広告ブレークをマニフェスト内の広告ブレークと照合する方法を決定するために使用されます。新しいブレークが検出されると、breakState が SCHEDULED または DECISIONED のイベントのすべての広告ブレークに対して一致関数が実行され、広告ブレークの matchParams で設定されたすべてのパラメータが検出されたブレークと一致するかどうかが確認されます。次のいずれかの条件が満たされると、一致が発生します。1. 広告ブレークには matchParams フィールドがあり、そのフィールドで設定されたすべてのパラメータが新しいブレークと一致します。2. 広告ブレークは DECISIONED で、matchParams フィールドがありません。

「すべて一致」の動作(空の matchParams が存在する場合に発生する)が誤って発生しないように、matchParams が設定されている場合は空にできません。フィールドがリクエストに含まれている場合は、そのフィールドの少なくとも 1 つのフィールドを設定する必要があります。

広告ブレークは次の順序でチェックされます。1. matchParams を使用し、expectedStartTime の昇順、createTime の昇順で並べ替え。並べ替え時に expectedStartTime のない広告ブレークが優先されます。2. matchParams を使用せず、expectedStartTime の昇順、createTime の昇順で並べ替え。並べ替え時に expectedStartTime のない広告ブレークが優先されます。

保留中の EABN がすべて一致しない場合、DAI は次に使用可能なミッドロール インデックスを使用して JIT 判定動作にフォールバックします。

servedBreak

object (ServedBreak)

出力専用。これは、配信された広告ブレークの実際の情報を反映したものです。COMPLETE breakState の広告ブレークに対してのみ設定されます。

メソッド

create

ライブ ストリーム内にミッドロール挿入点を作成する API。

list

ライブ ストリーム内の広告ブレークを一覧表示する API。