Class: Google::Apis::YoutubeV3::Channel

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

A channel resource contains information about a YouTube channel.

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

Returns a new instance of Channel.



961
962
963
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 961

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

Instance Attribute Details

#audit_details ⇒ Google::Apis::YoutubeV3::ChannelAuditDetails

The auditDetails object encapsulates channel data that is relevant for YouTube Partners during the audit process. Corresponds to the JSON property auditDetails

Returns:



888
889
890
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 888

def audit_details
  @audit_details
end

#branding_settings ⇒ Google::Apis::YoutubeV3::ChannelBrandingSettings

Branding properties of a YouTube channel. Corresponds to the JSON property brandingSettings

Returns:



893
894
895
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 893

def branding_settings
  @branding_settings
end

#content_details ⇒ Google::Apis::YoutubeV3::ChannelContentDetails

Details about the content of a channel. Corresponds to the JSON property contentDetails

Returns:



898
899
900
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 898

def content_details
  @content_details
end

#content_owner_details ⇒ Google::Apis::YoutubeV3::ChannelContentOwnerDetails

The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel. Corresponds to the JSON property contentOwnerDetails

Returns:



904
905
906
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 904

def content_owner_details
  @content_owner_details
end

#conversion_pings ⇒ Google::Apis::YoutubeV3::ChannelConversionPings

The conversionPings object encapsulates information about conversion pings that need to be respected by the channel. Corresponds to the JSON property conversionPings

Returns:



910
911
912
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 910

def conversion_pings
  @conversion_pings
end

#etag ⇒ String

Etag of this resource. Corresponds to the JSON property etag

Returns:

  • (String) 


915
916
917
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 915

def etag
  @etag
end

#id ⇒ String

The ID that YouTube uses to uniquely identify the channel. Corresponds to the JSON property id

Returns:

  • (String) 


920
921
922
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 920

def id
  @id
end

#invideo_promotion ⇒ Google::Apis::YoutubeV3::InvideoPromotion

Describes an invideo promotion campaign consisting of multiple promoted items. A campaign belongs to a single channel_id. Corresponds to the JSON property invideoPromotion

Returns:



926
927
928
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 926

def invideo_promotion
  @invideo_promotion
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string "youtube# channel". Corresponds to the JSON property kind

Returns:

  • (String) 


932
933
934
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 932

def kind
  @kind
end

#localizations ⇒ Hash<String,Google::Apis::YoutubeV3::ChannelLocalization>

Localizations for different languages Corresponds to the JSON property localizations

Returns:



937
938
939
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 937

def localizations
  @localizations
end

#snippet ⇒ Google::Apis::YoutubeV3::ChannelSnippet

Basic details about a channel, including title, description and thumbnails. Next available id: 15. Corresponds to the JSON property snippet

Returns:



943
944
945
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 943

def snippet
  @snippet
end

#statistics ⇒ Google::Apis::YoutubeV3::ChannelStatistics

Statistics about a channel: number of subscribers, number of videos in the channel, etc. Corresponds to the JSON property statistics

Returns:



949
950
951
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 949

def statistics
  @statistics
end

#status ⇒ Google::Apis::YoutubeV3::ChannelStatus

JSON template for the status part of a channel. Corresponds to the JSON property status

Returns:



954
955
956
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 954

def status
  @status
end

#topic_details ⇒ Google::Apis::YoutubeV3::ChannelTopicDetails

Freebase topic information related to the channel. Corresponds to the JSON property topicDetails

Returns:



959
960
961
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 959

def topic_details
  @topic_details
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 966

def update!(**args)
  @audit_details = args[:audit_details] if args.key?(:audit_details)
  @branding_settings = args[:branding_settings] if args.key?(:branding_settings)
  @content_details = args[:content_details] if args.key?(:content_details)
  @content_owner_details = args[:content_owner_details] if args.key?(:content_owner_details)
  @conversion_pings = args[:conversion_pings] if args.key?(:conversion_pings)
  @etag = args[:etag] if args.key?(:etag)
  @id = args[:id] if args.key?(:id)
  @invideo_promotion = args[:invideo_promotion] if args.key?(:invideo_promotion)
  @kind = args[:kind] if args.key?(:kind)
  @localizations = args[:localizations] if args.key?(:localizations)
  @snippet = args[:snippet] if args.key?(:snippet)
  @statistics = args[:statistics] if args.key?(:statistics)
  @status = args[:status] if args.key?(:status)
  @topic_details = args[:topic_details] if args.key?(:topic_details)
end