REST Resource: adBreak.networks.assets.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 アド マネージャーの連続配信広告テンプレート名。非推奨: 「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 の広告ブレークに対してのみ設定されます。

BreakState

アドブレークの状態。

列挙型
BREAK_STATE_UNSPECIFIED 広告ブレークの状態が不明です。
BREAK_STATE_DECISIONED 広告ブレークの判定が開始されたが、まだユーザーに配信されていない。
BREAK_STATE_COMPLETE ユーザーに広告ブレークが配信されました。
BREAK_STATE_SCHEDULED ミッドロール挿入点が判定のスケジュールに登録されています。
BREAK_STATE_EXPIRED 広告ブレークの有効期限が切れており、使用できません。デフォルトでは、広告ブレークは expectedStartTime の 30 分後、または expectedStartTime が設定されていない場合は広告ブレークの判定開始から 30 分後に期限切れになります。有効期限は、expireDuration フィールドを使用して明示的に設定できます。

BreakParams

広告ブレークに関連付けられたパラメータ。

JSON 表現 
{
  "macros": [
    {
      object (KeyValue)
    }
  ],
  "adTagParams": [
    {
      object (KeyValue)
    }
  ]
}
フィールド
macros[]

object (KeyValue)

省略可。広告タグ内の任意のプレースホルダを置き換えるカスタム マクロ値。広告リクエスト時に、DAI は %%DAI_PATTERN:[MACRO_KEY]%% 形式の広告タグ マクロを展開します。ここで、MACRO_KEY はキーです。

設定すると、これらのマクロは Pod Serving リクエストで設定されたマクロよりも優先されます。
adTagParams[]

object (KeyValue)

省略可。プライマリ広告リクエストの広告タグ パラメータをオーバーライドします。

これらは、cust_params が設定された Pod サービング リクエストの前にトリガーされるかどうかを判断するために使用されます。

通常、パラメータはブレークのメイン広告リクエストのクエリ文字列パラメータをオーバーライドします。カスタム URL 形式を使用する一部の広告サーバーでは、広告サーバーの要件を満たすために、パラメータによって広告タグ内の特定の場所がオーバーライドされることがあります。AdBreak で「mridx」値を設定すると、有効な正の整数である場合、breakSequence フィールドが指定された値でオーバーライドされます。これは、GAM 以外の広告サーバーでも同様です。

設定すると、これらのパラメータは Pod Serving リクエストで設定されたパラメータよりも優先されます。

KeyValue

Key-Value ペアを表します。

JSON 表現 
{
  "key": string,
  "value": string
}
フィールド
key

string

必須。この Key-Value ペアのキー。
value

string

必須。この Key-Value ペアの値。

MatchParams

検出されたスティッチ DAI 広告ブレークと照合するパラメータ。

JSON 表現 
{
  "scte35Binary": string,
  "scte35Upid": string,
  "scte35EventId": integer,
  "breakDuration": boolean
}
フィールド
scte35Binary

string

省略可。SCTE-35 バイナリ。このフィールドを一致させるには、マニフェスト内の広告ブレークに同じ SCTE-35 バイナリ文字列（base64 エンコード）が必要です。空の場合、スキップされます。
scte35Upid

string

省略可。SCTE-35 UPID（一意の番組識別子）。このフィールドを一致させるには、マニフェスト内の広告ブレークに同じ SCTE-35 UPID が必要です。UPID は、SCTE-35 バイナリから解析される値です。空の場合、スキップされます。
scte35EventId

integer (uint32 format)

省略可。SCTE-35 イベント ID。このフィールドを一致させるには、マニフェスト内の広告ブレークのイベント ID（スプライス イベント ID/セグメンテーション イベント ID）が同じである必要があります。イベント ID は、SCTE-35 バイナリから解析される値です。空の場合、スキップされます。
breakDuration

boolean

省略可。休憩時間。このフィールドを一致させるには、マニフェスト内の広告ブレークのブレーク時間が、広告ブレークの expectedDuration と同じである必要があります（許容範囲は 1 ミリ秒）。false の場合、スキップされます。

ServedBreak

配信された広告ブレークの実際の情報を表します。

JSON 表現 
{
  "breakDetectTime": string,
  "detectedDuration": string,
  "scte35CueOut": string
}
フィールド
breakDetectTime

string (Timestamp format)

出力専用。一致する広告ブレークが検出された時刻。Pod サービングの場合、これは広告ポッドの最初のセグメント/マニフェストがリクエストされた時間です。スティッチング DAI の場合、これはマニフェストで広告ブレークが最初に検出された時間です。

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"。
detectedDuration

string (Duration format)

出力専用。検出された長さが一致する広告ブレークに渡されます。

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

string

出力専用。検出された base64 エンコードの SCTE-35 メッセージが、一致する広告ブレークで渡されました。

メソッド

create

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

delete

 ライブ ストリーム内のミッドロール挿入点を削除する API。

get

 ライブ ストリーム内の広告ブレークを取得する API。

list

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

patch

 ライブ ストリーム内の広告ブレークを更新する API。