Class: Google::Ads::AdManager::V1::AdBreak

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/ads/admanager/v1/ad_break_messages.rb

Overview

The AdBreak resource.

Instance Attribute Summary collapse

Instance Attribute Details

#ad_break_id ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



105
106
107
108
 
# File 'proto_docs/google/ads/admanager/v1/ad_break_messages.rb', line 105

class AdBreak
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#asset_key ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



105
106
107
108
 
# File 'proto_docs/google/ads/admanager/v1/ad_break_messages.rb', line 105

class AdBreak
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#break_sequence ⇒ ::Integer (readonly)

Returns 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 .

Returns:

  • (::Integer) —

    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 .



105
106
107
108
 
# File 'proto_docs/google/ads/admanager/v1/ad_break_messages.rb', line 105

class AdBreak
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#break_state ⇒ ::Google::Ads::AdManager::V1::AdBreakStateEnum::AdBreakState (readonly)

Returns Output only. The state of the AdBreak.

Returns:



105
106
107
108
 
# File 'proto_docs/google/ads/admanager/v1/ad_break_messages.rb', line 105

class AdBreak
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#custom_asset_key ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



105
106
107
108
 
# File 'proto_docs/google/ads/admanager/v1/ad_break_messages.rb', line 105

class AdBreak
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#custom_params ⇒ ::String

Returns 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".

Returns:

  • (::String) —

    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"



105
106
107
108
 
# File 'proto_docs/google/ads/admanager/v1/ad_break_messages.rb', line 105

class AdBreak
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#duration ⇒ ::Google::Protobuf::Duration

Returns 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.

Returns:

  • (::Google::Protobuf::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.



105
106
107
108
 
# File 'proto_docs/google/ads/admanager/v1/ad_break_messages.rb', line 105

class AdBreak
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#expected_start_time ⇒ ::Google::Protobuf::Timestamp

Returns 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.

Returns:

  • (::Google::Protobuf::Timestamp) —

    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.



105
106
107
108
 
# File 'proto_docs/google/ads/admanager/v1/ad_break_messages.rb', line 105

class AdBreak
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns 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}.

Returns:

  • (::String) —

    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}



105
106
107
108
 
# File 'proto_docs/google/ads/admanager/v1/ad_break_messages.rb', line 105

class AdBreak
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#pod_template_name ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



105
106
107
108
 
# File 'proto_docs/google/ads/admanager/v1/ad_break_messages.rb', line 105

class AdBreak
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#scte_35_cue_out ⇒ ::String

Returns 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= .

Returns:

  • (::String) —

    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= 


105
106
107
108
 
# File 'proto_docs/google/ads/admanager/v1/ad_break_messages.rb', line 105

class AdBreak
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end