Class: Google::Apis::YoutubeV3::ChannelSettings

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

Branding properties for the channel view.

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

Returns a new instance of ChannelSettings.



1684
1685
1686
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 1684

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

Instance Attribute Details

#country ⇒ String

The country of the channel. Corresponds to the JSON property country

Returns:

  • (String) 


1612
1613
1614
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 1612

def country
  @country
end

#default_language ⇒ String

Corresponds to the JSON property defaultLanguage

Returns:

  • (String) 


1617
1618
1619
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 1617

def default_language
  @default_language
end

#default_tab ⇒ String

Which content tab users should see when viewing the channel. Corresponds to the JSON property defaultTab

Returns:

  • (String) 


1622
1623
1624
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 1622

def default_tab
  @default_tab
end

#description ⇒ String

Specifies the channel description. Corresponds to the JSON property description

Returns:

  • (String) 


1627
1628
1629
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 1627

def description
  @description
end

#featured_channels_title ⇒ String

Title for the featured channels tab. Corresponds to the JSON property featuredChannelsTitle

Returns:

  • (String) 


1632
1633
1634
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 1632

def featured_channels_title
  @featured_channels_title
end

#featured_channels_urls ⇒ Array<String>

The list of featured channels. Corresponds to the JSON property featuredChannelsUrls

Returns:

  • (Array<String>) 


1637
1638
1639
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 1637

def featured_channels_urls
  @featured_channels_urls
end

#keywords ⇒ String

Lists keywords associated with the channel, comma-separated. Corresponds to the JSON property keywords

Returns:

  • (String) 


1642
1643
1644
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 1642

def keywords
  @keywords
end

#moderate_comments ⇒ Boolean Also known as: moderate_comments?

Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible. Corresponds to the JSON property moderateComments

Returns:

  • (Boolean) 


1648
1649
1650
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 1648

def moderate_comments
  @moderate_comments
end

#profile_color ⇒ String

A prominent color that can be rendered on this channel page. Corresponds to the JSON property profileColor

Returns:

  • (String) 


1654
1655
1656
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 1654

def profile_color
  @profile_color
end

#show_browse_view ⇒ Boolean Also known as: show_browse_view?

Whether the tab to browse the videos should be displayed. Corresponds to the JSON property showBrowseView

Returns:

  • (Boolean) 


1659
1660
1661
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 1659

def show_browse_view
  @show_browse_view
end

#show_related_channels ⇒ Boolean Also known as: show_related_channels?

Whether related channels should be proposed. Corresponds to the JSON property showRelatedChannels

Returns:

  • (Boolean) 


1665
1666
1667
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 1665

def show_related_channels
  @show_related_channels
end

#title ⇒ String

Specifies the channel title. Corresponds to the JSON property title

Returns:

  • (String) 


1671
1672
1673
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 1671

def title
  @title
end

#tracking_analytics_account_id ⇒ String

The ID for a Google Analytics account to track and measure traffic to the channels. Corresponds to the JSON property trackingAnalyticsAccountId

Returns:

  • (String) 


1677
1678
1679
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 1677

def 
  @tracking_analytics_account_id
end

#unsubscribed_trailer ⇒ String

The trailer of the channel, for users that are not subscribers. Corresponds to the JSON property unsubscribedTrailer

Returns:

  • (String) 


1682
1683
1684
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 1682

def unsubscribed_trailer
  @unsubscribed_trailer
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 1689

def update!(**args)
  @country = args[:country] if args.key?(:country)
  @default_language = args[:default_language] if args.key?(:default_language)
  @default_tab = args[:default_tab] if args.key?(:default_tab)
  @description = args[:description] if args.key?(:description)
  @featured_channels_title = args[:featured_channels_title] if args.key?(:featured_channels_title)
  @featured_channels_urls = args[:featured_channels_urls] if args.key?(:featured_channels_urls)
  @keywords = args[:keywords] if args.key?(:keywords)
  @moderate_comments = args[:moderate_comments] if args.key?(:moderate_comments)
  @profile_color = args[:profile_color] if args.key?(:profile_color)
  @show_browse_view = args[:show_browse_view] if args.key?(:show_browse_view)
  @show_related_channels = args[:show_related_channels] if args.key?(:show_related_channels)
  @title = args[:title] if args.key?(:title)
  @tracking_analytics_account_id = args[:tracking_analytics_account_id] if args.key?(:tracking_analytics_account_id)
  @unsubscribed_trailer = args[:unsubscribed_trailer] if args.key?(:unsubscribed_trailer)
end