Class AdBreak

The AdBreak resource.

Inheritance

object

AdBreak

Implements

IMessage<AdBreak>

IEquatable<AdBreak>

IDeepCloneable<AdBreak>

IBufferMessage

IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class AdBreak : IMessage<AdBreak>, IEquatable<AdBreak>, IDeepCloneable<AdBreak>, IBufferMessage, IMessage

Constructors

AdBreak()

Declaration

public AdBreak()

AdBreak(AdBreak)

Declaration

public AdBreak(AdBreak other)

Parameters

Type	Name	Description
AdBreak	other

Properties

AdBreakId

Optional. Immutable. AdBreak ID. Must consist only of lowercase letters, digits, and hyphens. Ad break IDs have a maximum length of 63 characters. If not set, an ad break ID is generated as a UUID string.

Declaration

public string AdBreakId { get; set; }

Property Value

Type	Description
string

AdBreakName

AdBreakName-typed view over the Name resource name property.

Declaration

public AdBreakName AdBreakName { get; set; }

Property Value

Type	Description
AdBreakName

AssetKey

Optional. Immutable. The asset key of the LiveStreamEvent that the ad break belongs to. Either an asset key or a custom asset key must be provided for creation.

Declaration

public string AssetKey { get; set; }

Property Value

Type	Description
string

BreakSequence

Output only. The sequence id of the AdBreak. The unique sequence number of the created ad break. This value is only set after the AdBreak starts decisioning indicated by the ad break state's being [DECISIONED][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.DECISIONED] .

Declaration

public long BreakSequence { get; set; }

Property Value

Type	Description
long

BreakState

Output only. The state of the AdBreak.

Declaration

public AdBreakStateEnum.Types.AdBreakState BreakState { get; set; }

Property Value

Type	Description
AdBreakStateEnum.Types.AdBreakState

CustomAssetKey

Optional. Immutable. The custom asset key of the LiveStreamEvent that the ad break belongs to. Either an asset key or a custom asset key must be provided for creation.

Declaration

public string CustomAssetKey { get; set; }

Property Value

Type	Description
string

CustomParams

Optional. The key-value pairs to be included on the ad requests for this AdBreak. Key-value pairs to include on ad requests for this break for custom criteria targeting in Google Ad Manager, separated by = and joined by &.

Format:"key1=value&key2=value"

Declaration

public string CustomParams { get; set; }

Property Value

Type	Description
string

Duration

Required. The duration of the AdBreak. An expected duration in seconds with up to nine fractional digits, ending with s, for example, 3.5s. This value will be updated to match the actual duration from the manifest or pod request after the ad break's state is [COMPLETE][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.COMPLETE].

Declaration

public Duration Duration { get; set; }

Property Value

Type	Description
Duration

ExpectedStartTime

Optional. The expected start time of the ad break. When set, the scheduled ad break will be decisioned shortly before the expected start time. If this field is not set, ad decisioning begins immediately. An ad break can be created up to six hours before the expected start time.

Declaration

public Timestamp ExpectedStartTime { get; set; }

Property Value

Type	Description
Timestamp

HasAdBreakId

Gets whether the "ad_break_id" field is set

Declaration

public bool HasAdBreakId { get; }

Property Value

Type	Description
bool

HasAssetKey

Gets whether the "asset_key" field is set

Declaration

public bool HasAssetKey { get; }

Property Value

Type	Description
bool

HasBreakSequence

Gets whether the "break_sequence" field is set

Declaration

public bool HasBreakSequence { get; }

Property Value

Type	Description
bool

HasBreakState

Gets whether the "break_state" field is set

Declaration

public bool HasBreakState { get; }

Property Value

Type	Description
bool

HasCustomAssetKey

Gets whether the "custom_asset_key" field is set

Declaration

public bool HasCustomAssetKey { get; }

Property Value

Type	Description
bool

HasCustomParams

Gets whether the "custom_params" field is set

Declaration

public bool HasCustomParams { get; }

Property Value

Type	Description
bool

HasPodTemplateName

Gets whether the "pod_template_name" field is set

Declaration

public bool HasPodTemplateName { get; }

Property Value

Type	Description
bool

HasScte35CueOut

Gets whether the "scte_35_cue_out" field is set

Declaration

public bool HasScte35CueOut { get; }

Property Value

Type	Description
bool

Name

Identifier. The resource name of the AdBreak. This field uses the LiveStreamEvent resource's asset key in the URI, even if the ad break was created, updated, or queried using the custom asset key.

Format: networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break_id}

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

PodTemplateName

Optional. The pod template name of the AdBreak. This field is the required unique name across all pod templates in the network, not the display name.

Declaration

public string PodTemplateName { get; set; }

Property Value

Type	Description
string

Scte35CueOut

Optional. The Base64-encoded SCTE-35 command associated with the AdBreak. This field can include the splice_insert() or time_signal() command.

Examples

• time_signal()

  /DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==
  

• splice_insert()

  /DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo=
  

Declaration

public string Scte35CueOut { get; set; }

Property Value

Type	Description
string