Class: Google::Apis::YoutubePartnerV1::VideoAdvertisingOption

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/youtube_partner_v1/classes.rb,
generated/google/apis/youtube_partner_v1/representations.rb,
generated/google/apis/youtube_partner_v1/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ VideoAdvertisingOption

Returns a new instance of VideoAdvertisingOption



3974
3975
3976
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3974

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#ad_breaks ⇒ Array<Google::Apis::YoutubePartnerV1::AdBreak>

A list of times when YouTube can show an in-stream advertisement during playback of the video. Corresponds to the JSON property adBreaks

Returns:



3927
3928
3929
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3927

def ad_breaks
  @ad_breaks
end

#ad_formats ⇒ Array<String>

A list of ad formats that the video is allowed to show. Corresponds to the JSON property adFormats

Returns:

  • (Array<String>) 


3932
3933
3934
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3932

def ad_formats
  @ad_formats
end

#auto_generated_breaks ⇒ Boolean Also known as: auto_generated_breaks?

Enables this video for automatically generated midroll breaks. Corresponds to the JSON property autoGeneratedBreaks

Returns:

  • (Boolean) 


3937
3938
3939
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3937

def auto_generated_breaks
  @auto_generated_breaks
end

#break_position ⇒ Array<String>

The point at which the break occurs during the video playback. Corresponds to the JSON property breakPosition

Returns:

  • (Array<String>) 


3943
3944
3945
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3943

def break_position
  @break_position
end

#id ⇒ String

The ID that YouTube uses to uniquely identify the video associated with the advertising settings. Corresponds to the JSON property id

Returns:

  • (String) 


3949
3950
3951
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3949

def id
  @id
end

#kind ⇒ String

The type of the API resource. For this resource, the value is youtubePartner# videoAdvertisingOption. Corresponds to the JSON property kind

Returns:

  • (String) 


3955
3956
3957
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3955

def kind
  @kind
end

#tp_ad_server_video_id ⇒ String

A value that uniquely identifies the video to the third-party ad server. Corresponds to the JSON property tpAdServerVideoId

Returns:

  • (String) 


3960
3961
3962
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3960

def tp_ad_server_video_id
  @tp_ad_server_video_id
end

#tp_targeting_url ⇒ String

The base URL for a third-party ad server from which YouTube can retrieve in- stream ads for the video. Corresponds to the JSON property tpTargetingUrl

Returns:

  • (String) 


3966
3967
3968
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3966

def tp_targeting_url
  @tp_targeting_url
end

#tp_url_parameters ⇒ String

A parameter string to append to the end of the request to the third-party ad server. Corresponds to the JSON property tpUrlParameters

Returns:

  • (String) 


3972
3973
3974
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3972

def tp_url_parameters
  @tp_url_parameters
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3979

def update!(**args)
  @ad_breaks = args[:ad_breaks] if args.key?(:ad_breaks)
  @ad_formats = args[:ad_formats] if args.key?(:ad_formats)
  @auto_generated_breaks = args[:auto_generated_breaks] if args.key?(:auto_generated_breaks)
  @break_position = args[:break_position] if args.key?(:break_position)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @tp_ad_server_video_id = args[:tp_ad_server_video_id] if args.key?(:tp_ad_server_video_id)
  @tp_targeting_url = args[:tp_targeting_url] if args.key?(:tp_targeting_url)
  @tp_url_parameters = args[:tp_url_parameters] if args.key?(:tp_url_parameters)
end