Class: Google::Apis::YoutubeV3::InvideoPromotion

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

Overview

Describes an invideo promotion campaign consisting of multiple promoted items. A campaign belongs to a single channel_id.

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) ⇒ InvideoPromotion

Returns a new instance of InvideoPromotion



3427
3428
3429
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3427

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

Instance Attribute Details

#default_timing ⇒ Google::Apis::YoutubeV3::InvideoTiming

Describes a temporal position of a visual widget inside a video. Corresponds to the JSON property defaultTiming

Returns:



3405
3406
3407
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3405

def default_timing
  @default_timing
end

#items ⇒ Array<Google::Apis::YoutubeV3::PromotedItem>

List of promoted items in decreasing priority. Corresponds to the JSON property items

Returns:



3410
3411
3412
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3410

def items
  @items
end

#position ⇒ Google::Apis::YoutubeV3::InvideoPosition

Describes the spatial position of a visual widget inside a video. It is a union of various position types, out of which only will be set one. Corresponds to the JSON property position

Returns:



3416
3417
3418
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3416

def position
  @position
end

#use_smart_timing ⇒ Boolean Also known as: use_smart_timing?

Indicates whether the channel's promotional campaign uses "smart timing." This feature attempts to show promotions at a point in the video when they are more likely to be clicked and less likely to disrupt the viewing experience. This feature also picks up a single promotion to show on each video. Corresponds to the JSON property useSmartTiming

Returns:

  • (Boolean) 


3424
3425
3426
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3424

def use_smart_timing
  @use_smart_timing
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3432
3433
3434
3435
3436
3437
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3432

def update!(**args)
  @default_timing = args[:default_timing] if args.key?(:default_timing)
  @items = args[:items] if args.key?(:items)
  @position = args[:position] if args.key?(:position)
  @use_smart_timing = args[:use_smart_timing] if args.key?(:use_smart_timing)
end