Class: Google::Apis::YoutubeV3::YouTubeService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/youtube_v3/service.rb

Overview

YouTube Data API v3

The YouTube Data API v3 is an API that provides access to YouTube data, such as videos, playlists, and channels.

Examples:

require 'google/apis/youtube_v3'

Youtube = Google::Apis::YoutubeV3 # Alias the module
service = Youtube::YouTubeService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE =
"https://youtube.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeYouTubeService

Returns a new instance of YouTubeService.



48
49
50
51
52
53
# File 'lib/google/apis/youtube_v3/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-youtube_v3',
        client_version: Google::Apis::YoutubeV3::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



41
42
43
# File 'lib/google/apis/youtube_v3/service.rb', line 41

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



46
47
48
# File 'lib/google/apis/youtube_v3/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#bind_live_broadcast(id, part, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, stream_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::LiveBroadcast

Bind a broadcast to a stream.

Parameters:

  • id (String)

    Broadcast to bind to the stream

  • part (Array<String>, String)

    The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • on_behalf_of_content_owner_channel (String) (defaults to: nil)

    This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The * onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

  • stream_id (String) (defaults to: nil)

    Stream to bind, if not set unbind the current one.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
# File 'lib/google/apis/youtube_v3/service.rb', line 1269

def bind_live_broadcast(id, part, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, stream_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/liveBroadcasts/bind', options)
  command.response_representation = Google::Apis::YoutubeV3::LiveBroadcast::Representation
  command.response_class = Google::Apis::YoutubeV3::LiveBroadcast
  command.query['id'] = id unless id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['onBehalfOfContentOwnerChannel'] = on_behalf_of_content_owner_channel unless on_behalf_of_content_owner_channel.nil?
  command.query['part'] = part unless part.nil?
  command.query['streamId'] = stream_id unless stream_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_caption(id, on_behalf_of: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a resource.

Parameters:

  • id (String)
  • on_behalf_of (String) (defaults to: nil)

    ID of the Google+ Page for the channel that the request is be on behalf of

  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



178
179
180
181
182
183
184
185
186
# File 'lib/google/apis/youtube_v3/service.rb', line 178

def delete_caption(id, on_behalf_of: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'youtube/v3/captions', options)
  command.query['id'] = id unless id.nil?
  command.query['onBehalfOf'] = on_behalf_of unless on_behalf_of.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_channel_section(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a resource.

Parameters:

  • id (String)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



520
521
522
523
524
525
526
527
# File 'lib/google/apis/youtube_v3/service.rb', line 520

def delete_channel_section(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'youtube/v3/channelSections', options)
  command.query['id'] = id unless id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_comment(id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a resource.

Parameters:

  • id (String)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



954
955
956
957
958
959
960
# File 'lib/google/apis/youtube_v3/service.rb', line 954

def delete_comment(id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'youtube/v3/comments', options)
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_live_broadcast(id, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Delete a given broadcast.

Parameters:

  • id (String)

    Broadcast to delete.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • on_behalf_of_content_owner_channel (String) (defaults to: nil)

    This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The * onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1328
1329
1330
1331
1332
1333
1334
1335
1336
# File 'lib/google/apis/youtube_v3/service.rb', line 1328

def delete_live_broadcast(id, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'youtube/v3/liveBroadcasts', options)
  command.query['id'] = id unless id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['onBehalfOfContentOwnerChannel'] = on_behalf_of_content_owner_channel unless on_behalf_of_content_owner_channel.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_live_chat_ban(id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a chat ban.

Parameters:

  • id (String)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1704
1705
1706
1707
1708
1709
1710
# File 'lib/google/apis/youtube_v3/service.rb', line 1704

def delete_live_chat_ban(id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'youtube/v3/liveChat/bans', options)
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_live_chat_message(id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a chat message.

Parameters:

  • id (String)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1766
1767
1768
1769
1770
1771
1772
# File 'lib/google/apis/youtube_v3/service.rb', line 1766

def delete_live_chat_message(id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'youtube/v3/liveChat/messages', options)
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_live_chat_moderator(id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a chat moderator.

Parameters:

  • id (String)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1878
1879
1880
1881
1882
1883
1884
# File 'lib/google/apis/youtube_v3/service.rb', line 1878

def delete_live_chat_moderator(id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'youtube/v3/liveChat/moderators', options)
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_live_stream(id, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an existing stream for the authenticated user.

Parameters:

  • id (String)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • on_behalf_of_content_owner_channel (String) (defaults to: nil)

    This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The * onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2008
2009
2010
2011
2012
2013
2014
2015
2016
# File 'lib/google/apis/youtube_v3/service.rb', line 2008

def delete_live_stream(id, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'youtube/v3/liveStreams', options)
  command.query['id'] = id unless id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['onBehalfOfContentOwnerChannel'] = on_behalf_of_content_owner_channel unless on_behalf_of_content_owner_channel.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_playlist(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a resource.

Parameters:

  • id (String)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2752
2753
2754
2755
2756
2757
2758
2759
# File 'lib/google/apis/youtube_v3/service.rb', line 2752

def delete_playlist(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'youtube/v3/playlists', options)
  command.query['id'] = id unless id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_playlist_image(id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a resource.

Parameters:

  • id (String) (defaults to: nil)

    Id to identify this image. This is returned from by the List method.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2333
2334
2335
2336
2337
2338
2339
2340
# File 'lib/google/apis/youtube_v3/service.rb', line 2333

def delete_playlist_image(id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'youtube/v3/playlistImages', options)
  command.query['id'] = id unless id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_playlist_item(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a resource.

Parameters:

  • id (String)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2549
2550
2551
2552
2553
2554
2555
2556
# File 'lib/google/apis/youtube_v3/service.rb', line 2549

def delete_playlist_item(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'youtube/v3/playlistItems', options)
  command.query['id'] = id unless id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_subscription(id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a resource.

Parameters:

  • id (String)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3111
3112
3113
3114
3115
3116
3117
# File 'lib/google/apis/youtube_v3/service.rb', line 3111

def delete_subscription(id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'youtube/v3/subscriptions', options)
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

This method returns an undefined value.

Deletes a resource.

Parameters:

  • linking_token (String)

    Delete the partner links with the given linking token.

  • type (String)

    Type of the link to be deleted.

  • external_channel_id (String) (defaults to: nil)

    Channel ID to which changes should be applied, for delegation.

  • part (Array<String>, String) (defaults to: nil)

    Do not use. Required for compatibility.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
# File 'lib/google/apis/youtube_v3/service.rb', line 3350

def delete_third_party_link(linking_token, type, external_channel_id: nil, part: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'youtube/v3/thirdPartyLinks', options)
  command.query['externalChannelId'] = external_channel_id unless external_channel_id.nil?
  command.query['linkingToken'] = linking_token unless linking_token.nil?
  command.query['part'] = part unless part.nil?
  command.query['type'] = type unless type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_video(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a resource.

Parameters:

  • id (String)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3630
3631
3632
3633
3634
3635
3636
3637
# File 'lib/google/apis/youtube_v3/service.rb', line 3630

def delete_video(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'youtube/v3/videos', options)
  command.query['id'] = id unless id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#download_caption(id, on_behalf_of: nil, on_behalf_of_content_owner: nil, tfmt: nil, tlang: nil, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Downloads a caption track.

Parameters:

  • id (String)

    The ID of the caption track to download, required for One Platform.

  • on_behalf_of (String) (defaults to: nil)

    ID of the Google+ Page for the channel that the request is be on behalf of

  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • tfmt (String) (defaults to: nil)

    Convert the captions into this format. Supported options are sbv, srt, and vtt.

  • tlang (String) (defaults to: nil)

    tlang is the language code; machine translate the captions into this language.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • download_dest (IO, String) (defaults to: nil)

    IO stream or filename to receive content download

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
# File 'lib/google/apis/youtube_v3/service.rb', line 226

def download_caption(id, on_behalf_of: nil, on_behalf_of_content_owner: nil, tfmt: nil, tlang: nil, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block)
  if download_dest.nil?
    command = make_simple_command(:get, 'youtube/v3/captions/{id}', options)
  else
    command = make_download_command(:get, 'youtube/v3/captions/{id}', options)
    command.download_dest = download_dest
  end
  command.params['id'] = id unless id.nil?
  command.query['onBehalfOf'] = on_behalf_of unless on_behalf_of.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['tfmt'] = tfmt unless tfmt.nil?
  command.query['tlang'] = tlang unless tlang.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_video_rating(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::GetVideoRatingResponse

Retrieves the ratings that the authorized user gave to a list of specified videos.

Parameters:

  • id (Array<String>, String)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
# File 'lib/google/apis/youtube_v3/service.rb', line 3669

def get_video_rating(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/videos/getRating', options)
  command.response_representation = Google::Apis::YoutubeV3::GetVideoRatingResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::GetVideoRatingResponse
  command.query['id'] = id unless id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_abuse_report(part, abuse_report_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::AbuseReport

Inserts a new resource into this collection.

Parameters:

  • part (Array<String>, String)

    The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.

  • abuse_report_object (Google::Apis::YoutubeV3::AbuseReport) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



78
79
80
81
82
83
84
85
86
87
88
# File 'lib/google/apis/youtube_v3/service.rb', line 78

def insert_abuse_report(part, abuse_report_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/abuseReports', options)
  command.request_representation = Google::Apis::YoutubeV3::AbuseReport::Representation
  command.request_object = abuse_report_object
  command.response_representation = Google::Apis::YoutubeV3::AbuseReport::Representation
  command.response_class = Google::Apis::YoutubeV3::AbuseReport
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_caption(part, caption_object = nil, on_behalf_of: nil, on_behalf_of_content_owner: nil, sync: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::Caption

Inserts a new resource into this collection.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.

  • caption_object (Google::Apis::YoutubeV3::Caption) (defaults to: nil)
  • on_behalf_of (String) (defaults to: nil)

    ID of the Google+ Page for the channel that the request is be on behalf of

  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • sync (Boolean) (defaults to: nil)

    Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • upload_source (IO, String) (defaults to: nil)

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil)

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
# File 'lib/google/apis/youtube_v3/service.rb', line 284

def insert_caption(part, caption_object = nil, on_behalf_of: nil, on_behalf_of_content_owner: nil, sync: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'youtube/v3/captions', options)
  else
    command = make_upload_command(:post, 'youtube/v3/captions', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::YoutubeV3::Caption::Representation
  command.request_object = caption_object
  command.response_representation = Google::Apis::YoutubeV3::Caption::Representation
  command.response_class = Google::Apis::YoutubeV3::Caption
  command.query['onBehalfOf'] = on_behalf_of unless on_behalf_of.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['part'] = part unless part.nil?
  command.query['sync'] = sync unless sync.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_channel_banner(channel_banner_resource_object = nil, channel_id: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::ChannelBannerResource

Inserts a new resource into this collection.

Parameters:

  • channel_banner_resource_object (Google::Apis::YoutubeV3::ChannelBannerResource) (defaults to: nil)
  • channel_id (String) (defaults to: nil)

    Unused, channel_id is currently derived from the security context of the requestor.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • on_behalf_of_content_owner_channel (String) (defaults to: nil)

    This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The * onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • upload_source (IO, String) (defaults to: nil)

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil)

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
# File 'lib/google/apis/youtube_v3/service.rb', line 471

def insert_channel_banner(channel_banner_resource_object = nil, channel_id: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'youtube/v3/channelBanners/insert', options)
  else
    command = make_upload_command(:post, 'youtube/v3/channelBanners/insert', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::YoutubeV3::ChannelBannerResource::Representation
  command.request_object = channel_banner_resource_object
  command.response_representation = Google::Apis::YoutubeV3::ChannelBannerResource::Representation
  command.response_class = Google::Apis::YoutubeV3::ChannelBannerResource
  command.query['channelId'] = channel_id unless channel_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['onBehalfOfContentOwnerChannel'] = on_behalf_of_content_owner_channel unless on_behalf_of_content_owner_channel.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_channel_section(part, channel_section_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::ChannelSection

Inserts a new resource into this collection.

Parameters:

  • part (Array<String>, String)

    The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and contentDetails.

  • channel_section_object (Google::Apis::YoutubeV3::ChannelSection) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • on_behalf_of_content_owner_channel (String) (defaults to: nil)

    This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The * onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



578
579
580
581
582
583
584
585
586
587
588
589
590
# File 'lib/google/apis/youtube_v3/service.rb', line 578

def insert_channel_section(part, channel_section_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/channelSections', options)
  command.request_representation = Google::Apis::YoutubeV3::ChannelSection::Representation
  command.request_object = channel_section_object
  command.response_representation = Google::Apis::YoutubeV3::ChannelSection::Representation
  command.response_class = Google::Apis::YoutubeV3::ChannelSection
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['onBehalfOfContentOwnerChannel'] = on_behalf_of_content_owner_channel unless on_behalf_of_content_owner_channel.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_comment(part, comment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::Comment

Inserts a new resource into this collection.

Parameters:

  • part (Array<String>, String)

    The part parameter identifies the properties that the API response will include. Set the parameter value to snippet. The snippet part has a quota cost of 2 units.

  • comment_object (Google::Apis::YoutubeV3::Comment) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



985
986
987
988
989
990
991
992
993
994
995
# File 'lib/google/apis/youtube_v3/service.rb', line 985

def insert_comment(part, comment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/comments', options)
  command.request_representation = Google::Apis::YoutubeV3::Comment::Representation
  command.request_object = comment_object
  command.response_representation = Google::Apis::YoutubeV3::Comment::Representation
  command.response_class = Google::Apis::YoutubeV3::Comment
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_comment_thread(part, comment_thread_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::CommentThread

Inserts a new resource into this collection.

Parameters:

  • part (Array<String>, String)

    The part parameter identifies the properties that the API response will include. Set the parameter value to snippet. The snippet part has a quota cost of 2 units.

  • comment_thread_object (Google::Apis::YoutubeV3::CommentThread) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



855
856
857
858
859
860
861
862
863
864
865
# File 'lib/google/apis/youtube_v3/service.rb', line 855

def insert_comment_thread(part, comment_thread_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/commentThreads', options)
  command.request_representation = Google::Apis::YoutubeV3::CommentThread::Representation
  command.request_object = comment_thread_object
  command.response_representation = Google::Apis::YoutubeV3::CommentThread::Representation
  command.response_class = Google::Apis::YoutubeV3::CommentThread
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_live_broadcast(part, live_broadcast_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::LiveBroadcast

Inserts a new stream for the authenticated user.

Parameters:

  • part (Array<String>, String)

    The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, contentDetails, and status.

  • live_broadcast_object (Google::Apis::YoutubeV3::LiveBroadcast) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • on_behalf_of_content_owner_channel (String) (defaults to: nil)

    This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The * onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
# File 'lib/google/apis/youtube_v3/service.rb', line 1387

def insert_live_broadcast(part, live_broadcast_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/liveBroadcasts', options)
  command.request_representation = Google::Apis::YoutubeV3::LiveBroadcast::Representation
  command.request_object = live_broadcast_object
  command.response_representation = Google::Apis::YoutubeV3::LiveBroadcast::Representation
  command.response_class = Google::Apis::YoutubeV3::LiveBroadcast
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['onBehalfOfContentOwnerChannel'] = on_behalf_of_content_owner_channel unless on_behalf_of_content_owner_channel.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_live_broadcast_cuepoint(cuepoint_object = nil, id: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, part: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::Cuepoint

Insert cuepoints in a broadcast

Parameters:

  • cuepoint_object (Google::Apis::YoutubeV3::Cuepoint) (defaults to: nil)
  • id (String) (defaults to: nil)

    Broadcast to insert ads to, or equivalently external_video_id for internal use.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • on_behalf_of_content_owner_channel (String) (defaults to: nil)

    This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The * onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

  • part (Array<String>, String) (defaults to: nil)

    The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
# File 'lib/google/apis/youtube_v3/service.rb', line 1453

def insert_live_broadcast_cuepoint(cuepoint_object = nil, id: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, part: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/liveBroadcasts/cuepoint', options)
  command.request_representation = Google::Apis::YoutubeV3::Cuepoint::Representation
  command.request_object = cuepoint_object
  command.response_representation = Google::Apis::YoutubeV3::Cuepoint::Representation
  command.response_class = Google::Apis::YoutubeV3::Cuepoint
  command.query['id'] = id unless id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['onBehalfOfContentOwnerChannel'] = on_behalf_of_content_owner_channel unless on_behalf_of_content_owner_channel.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_live_chat_ban(part, live_chat_ban_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::LiveChatBan

Inserts a new resource into this collection.

Parameters:

  • part (Array<String>, String)

    The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response returns. Set the parameter value to snippet.

  • live_chat_ban_object (Google::Apis::YoutubeV3::LiveChatBan) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
# File 'lib/google/apis/youtube_v3/service.rb', line 1735

def insert_live_chat_ban(part, live_chat_ban_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/liveChat/bans', options)
  command.request_representation = Google::Apis::YoutubeV3::LiveChatBan::Representation
  command.request_object = live_chat_ban_object
  command.response_representation = Google::Apis::YoutubeV3::LiveChatBan::Representation
  command.response_class = Google::Apis::YoutubeV3::LiveChatBan
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_live_chat_message(part, live_chat_message_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::LiveChatMessage

Inserts a new resource into this collection.

Parameters:

  • part (Array<String>, String)

    The part parameter serves two purposes. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the parameter value to snippet.

  • live_chat_message_object (Google::Apis::YoutubeV3::LiveChatMessage) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
# File 'lib/google/apis/youtube_v3/service.rb', line 1797

def insert_live_chat_message(part, live_chat_message_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/liveChat/messages', options)
  command.request_representation = Google::Apis::YoutubeV3::LiveChatMessage::Representation
  command.request_object = live_chat_message_object
  command.response_representation = Google::Apis::YoutubeV3::LiveChatMessage::Representation
  command.response_class = Google::Apis::YoutubeV3::LiveChatMessage
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_live_chat_moderator(part, live_chat_moderator_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::LiveChatModerator

Inserts a new resource into this collection.

Parameters:

  • part (Array<String>, String)

    The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response returns. Set the parameter value to snippet.

  • live_chat_moderator_object (Google::Apis::YoutubeV3::LiveChatModerator) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
# File 'lib/google/apis/youtube_v3/service.rb', line 1909

def insert_live_chat_moderator(part, live_chat_moderator_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/liveChat/moderators', options)
  command.request_representation = Google::Apis::YoutubeV3::LiveChatModerator::Representation
  command.request_object = live_chat_moderator_object
  command.response_representation = Google::Apis::YoutubeV3::LiveChatModerator::Representation
  command.response_class = Google::Apis::YoutubeV3::LiveChatModerator
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_live_stream(part, live_stream_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::LiveStream

Inserts a new stream for the authenticated user.

Parameters:

  • part (Array<String>, String)

    The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, cdn, content_details, and status.

  • live_stream_object (Google::Apis::YoutubeV3::LiveStream) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • on_behalf_of_content_owner_channel (String) (defaults to: nil)

    This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The * onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
# File 'lib/google/apis/youtube_v3/service.rb', line 2067

def insert_live_stream(part, live_stream_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/liveStreams', options)
  command.request_representation = Google::Apis::YoutubeV3::LiveStream::Representation
  command.request_object = live_stream_object
  command.response_representation = Google::Apis::YoutubeV3::LiveStream::Representation
  command.response_class = Google::Apis::YoutubeV3::LiveStream
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['onBehalfOfContentOwnerChannel'] = on_behalf_of_content_owner_channel unless on_behalf_of_content_owner_channel.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_playlist(part, playlist_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::Playlist

Inserts a new resource into this collection.

Parameters:

  • part (Array<String>, String)

    The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.

  • playlist_object (Google::Apis::YoutubeV3::Playlist) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • on_behalf_of_content_owner_channel (String) (defaults to: nil)

    This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The * onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'lib/google/apis/youtube_v3/service.rb', line 2809

def insert_playlist(part, playlist_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/playlists', options)
  command.request_representation = Google::Apis::YoutubeV3::Playlist::Representation
  command.request_object = playlist_object
  command.response_representation = Google::Apis::YoutubeV3::Playlist::Representation
  command.response_class = Google::Apis::YoutubeV3::Playlist
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['onBehalfOfContentOwnerChannel'] = on_behalf_of_content_owner_channel unless on_behalf_of_content_owner_channel.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_playlist_image(playlist_image_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, part: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::PlaylistImage

Inserts a new resource into this collection.

Parameters:

  • playlist_image_object (Google::Apis::YoutubeV3::PlaylistImage) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • on_behalf_of_content_owner_channel (String) (defaults to: nil)

    This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The * onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

  • part (Array<String>, String) (defaults to: nil)

    The part parameter specifies the properties that the API response will include.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
# File 'lib/google/apis/youtube_v3/service.rb', line 2389

def insert_playlist_image(playlist_image_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, part: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/playlistImages', options)
  command.request_representation = Google::Apis::YoutubeV3::PlaylistImage::Representation
  command.request_object = playlist_image_object
  command.response_representation = Google::Apis::YoutubeV3::PlaylistImage::Representation
  command.response_class = Google::Apis::YoutubeV3::PlaylistImage
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['onBehalfOfContentOwnerChannel'] = on_behalf_of_content_owner_channel unless on_behalf_of_content_owner_channel.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_playlist_item(part, playlist_item_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::PlaylistItem

Inserts a new resource into this collection.

Parameters:

  • part (Array<String>, String)

    The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.

  • playlist_item_object (Google::Apis::YoutubeV3::PlaylistItem) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
# File 'lib/google/apis/youtube_v3/service.rb', line 2591

def insert_playlist_item(part, playlist_item_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/playlistItems', options)
  command.request_representation = Google::Apis::YoutubeV3::PlaylistItem::Representation
  command.request_object = playlist_item_object
  command.response_representation = Google::Apis::YoutubeV3::PlaylistItem::Representation
  command.response_class = Google::Apis::YoutubeV3::PlaylistItem
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_subscription(part, subscription_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::Subscription

Inserts a new resource into this collection.

Parameters:

  • part (Array<String>, String)

    The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.

  • subscription_object (Google::Apis::YoutubeV3::Subscription) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
# File 'lib/google/apis/youtube_v3/service.rb', line 3142

def insert_subscription(part, subscription_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/subscriptions', options)
  command.request_representation = Google::Apis::YoutubeV3::Subscription::Representation
  command.request_object = subscription_object
  command.response_representation = Google::Apis::YoutubeV3::Subscription::Representation
  command.response_class = Google::Apis::YoutubeV3::Subscription
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_test(part, test_item_object = nil, external_channel_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::TestItem

POST method.

Parameters:

  • part (Array<String>, String)
  • test_item_object (Google::Apis::YoutubeV3::TestItem) (defaults to: nil)
  • external_channel_id (String) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
# File 'lib/google/apis/youtube_v3/service.rb', line 3311

def insert_test(part, test_item_object = nil, external_channel_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/tests', options)
  command.request_representation = Google::Apis::YoutubeV3::TestItem::Representation
  command.request_object = test_item_object
  command.response_representation = Google::Apis::YoutubeV3::TestItem::Representation
  command.response_class = Google::Apis::YoutubeV3::TestItem
  command.query['externalChannelId'] = external_channel_id unless external_channel_id.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

Inserts a new resource into this collection.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies the thirdPartyLink resource parts that the API request and response will include. Supported values are linkingToken, status, and snippet.

  • third_party_link_object (Google::Apis::YoutubeV3::ThirdPartyLink) (defaults to: nil)
  • external_channel_id (String) (defaults to: nil)

    Channel ID to which changes should be applied, for delegation.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
# File 'lib/google/apis/youtube_v3/service.rb', line 3386

def insert_third_party_link(part, third_party_link_object = nil, external_channel_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/thirdPartyLinks', options)
  command.request_representation = Google::Apis::YoutubeV3::ThirdPartyLink::Representation
  command.request_object = third_party_link_object
  command.response_representation = Google::Apis::YoutubeV3::ThirdPartyLink::Representation
  command.response_class = Google::Apis::YoutubeV3::ThirdPartyLink
  command.query['externalChannelId'] = external_channel_id unless external_channel_id.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_video(part, video_object = nil, auto_levels: nil, notify_subscribers: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, stabilize: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::Video

Inserts a new resource into this collection.

Parameters:

  • part (Array<String>, String)

    The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.

  • video_object (Google::Apis::YoutubeV3::Video) (defaults to: nil)
  • auto_levels (Boolean) (defaults to: nil)

    Should auto-levels be applied to the upload.

  • notify_subscribers (Boolean) (defaults to: nil)

    Notify the channel subscribers about the new video. As default, the notification is enabled.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • on_behalf_of_content_owner_channel (String) (defaults to: nil)

    This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The * onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

  • stabilize (Boolean) (defaults to: nil)

    Should stabilize be applied to the upload.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • upload_source (IO, String) (defaults to: nil)

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil)

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
# File 'lib/google/apis/youtube_v3/service.rb', line 3744

def insert_video(part, video_object = nil, auto_levels: nil, notify_subscribers: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, stabilize: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'youtube/v3/videos', options)
  else
    command = make_upload_command(:post, 'youtube/v3/videos', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::YoutubeV3::Video::Representation
  command.request_object = video_object
  command.response_representation = Google::Apis::YoutubeV3::Video::Representation
  command.response_class = Google::Apis::YoutubeV3::Video
  command.query['autoLevels'] = auto_levels unless auto_levels.nil?
  command.query['notifySubscribers'] = notify_subscribers unless notify_subscribers.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['onBehalfOfContentOwnerChannel'] = on_behalf_of_content_owner_channel unless on_behalf_of_content_owner_channel.nil?
  command.query['part'] = part unless part.nil?
  command.query['stabilize'] = stabilize unless stabilize.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_activities(part, channel_id: nil, home: nil, max_results: nil, mine: nil, page_token: nil, published_after: nil, published_before: nil, region_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::ListActivitiesResponse

Retrieves a list of resources, possibly filtered.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those nested properties.

  • channel_id (String) (defaults to: nil)
  • home (Boolean) (defaults to: nil)
  • max_results (Fixnum) (defaults to: nil)

    The maxResults parameter specifies the maximum number of items that should be returned in the result set.

  • mine (Boolean) (defaults to: nil)
  • page_token (String) (defaults to: nil)

    The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

  • published_after (String) (defaults to: nil)
  • published_before (String) (defaults to: nil)
  • region_code (String) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
# File 'lib/google/apis/youtube_v3/service.rb', line 129

def list_activities(part, channel_id: nil, home: nil, max_results: nil, mine: nil, page_token: nil, published_after: nil, published_before: nil, region_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/activities', options)
  command.response_representation = Google::Apis::YoutubeV3::ListActivitiesResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::ListActivitiesResponse
  command.query['channelId'] = channel_id unless channel_id.nil?
  command.query['home'] = home unless home.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['mine'] = mine unless mine.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['part'] = part unless part.nil?
  command.query['publishedAfter'] = published_after unless published_after.nil?
  command.query['publishedBefore'] = published_before unless published_before.nil?
  command.query['regionCode'] = region_code unless region_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_captions(part, video_id, id: nil, on_behalf_of: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::ListCaptionsResponse

Retrieves a list of resources, possibly filtered.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet.

  • video_id (String)

    Returns the captions for the specified video.

  • id (Array<String>, String) (defaults to: nil)

    Returns the captions with the given IDs for Stubby or Apiary.

  • on_behalf_of (String) (defaults to: nil)

    ID of the Google+ Page for the channel that the request is on behalf of.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



343
344
345
346
347
348
349
350
351
352
353
354
355
# File 'lib/google/apis/youtube_v3/service.rb', line 343

def list_captions(part, video_id, id: nil, on_behalf_of: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/captions', options)
  command.response_representation = Google::Apis::YoutubeV3::ListCaptionsResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::ListCaptionsResponse
  command.query['id'] = id unless id.nil?
  command.query['onBehalfOf'] = on_behalf_of unless on_behalf_of.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['part'] = part unless part.nil?
  command.query['videoId'] = video_id unless video_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_channel_sections(part, channel_id: nil, hl: nil, id: nil, mine: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::ListChannelSectionsResponse

Retrieves a list of resources, possibly filtered.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies a comma-separated list of one or more channelSection resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channelSection resource, the snippet property contains other properties, such as a display title for the channelSection. If you set part=snippet, the API response will also contain all of those nested properties.

  • channel_id (String) (defaults to: nil)

    Return the ChannelSections owned by the specified channel ID.

  • hl (String) (defaults to: nil)

    Return content in specified language

  • id (Array<String>, String) (defaults to: nil)

    Return the ChannelSections with the given IDs for Stubby or Apiary.

  • mine (Boolean) (defaults to: nil)

    Return the ChannelSections owned by the authenticated user.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



637
638
639
640
641
642
643
644
645
646
647
648
649
650
# File 'lib/google/apis/youtube_v3/service.rb', line 637

def list_channel_sections(part, channel_id: nil, hl: nil, id: nil, mine: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/channelSections', options)
  command.response_representation = Google::Apis::YoutubeV3::ListChannelSectionsResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::ListChannelSectionsResponse
  command.query['channelId'] = channel_id unless channel_id.nil?
  command.query['hl'] = hl unless hl.nil?
  command.query['id'] = id unless id.nil?
  command.query['mine'] = mine unless mine.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_channels(part, category_id: nil, for_handle: nil, for_username: nil, hl: nil, id: nil, managed_by_me: nil, max_results: nil, mine: nil, my_subscribers: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::ListChannelsResponse

Retrieves a list of resources, possibly filtered.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies a comma-separated list of one or more channel resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set part=contentDetails, the API response will also contain all of those nested properties.

  • category_id (String) (defaults to: nil)

    Return the channels within the specified guide category ID.

  • for_handle (String) (defaults to: nil)

    Return the channel associated with a YouTube handle.

  • for_username (String) (defaults to: nil)

    Return the channel associated with a YouTube username.

  • hl (String) (defaults to: nil)

    Stands for "host language". Specifies the localization language of the metadata to be filled into snippet.localized. The field is filled with the default metadata if there is no localization in the specified language. The parameter value must be a language code included in the list returned by the i18nLanguages.list method (e.g. en_US, es_MX).

  • id (Array<String>, String) (defaults to: nil)

    Return the channels with the specified IDs.

  • managed_by_me (Boolean) (defaults to: nil)

    Return the channels managed by the authenticated user.

  • max_results (Fixnum) (defaults to: nil)

    The maxResults parameter specifies the maximum number of items that should be returned in the result set.

  • mine (Boolean) (defaults to: nil)

    Return the ids of channels owned by the authenticated user.

  • my_subscribers (Boolean) (defaults to: nil)

    Return the channels subscribed to the authenticated user

  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • page_token (String) (defaults to: nil)

    The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'lib/google/apis/youtube_v3/service.rb', line 762

def list_channels(part, category_id: nil, for_handle: nil, for_username: nil, hl: nil, id: nil, managed_by_me: nil, max_results: nil, mine: nil, my_subscribers: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/channels', options)
  command.response_representation = Google::Apis::YoutubeV3::ListChannelsResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::ListChannelsResponse
  command.query['categoryId'] = category_id unless category_id.nil?
  command.query['forHandle'] = for_handle unless for_handle.nil?
  command.query['forUsername'] = for_username unless for_username.nil?
  command.query['hl'] = hl unless hl.nil?
  command.query['id'] = id unless id.nil?
  command.query['managedByMe'] = managed_by_me unless managed_by_me.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['mine'] = mine unless mine.nil?
  command.query['mySubscribers'] = my_subscribers unless my_subscribers.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_comment_threads(part, all_threads_related_to_channel_id: nil, channel_id: nil, id: nil, max_results: nil, moderation_status: nil, order: nil, page_token: nil, search_terms: nil, text_format: nil, video_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::ListCommentThreadsResponse

Retrieves a list of resources, possibly filtered.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include.

  • all_threads_related_to_channel_id (String) (defaults to: nil)

    Returns the comment threads of all videos of the channel and the channel comments as well.

  • channel_id (String) (defaults to: nil)

    Returns the comment threads for all the channel comments (ie does not include comments left on videos).

  • id (Array<String>, String) (defaults to: nil)

    Returns the comment threads with the given IDs for Stubby or Apiary.

  • max_results (Fixnum) (defaults to: nil)

    The maxResults parameter specifies the maximum number of items that should be returned in the result set.

  • moderation_status (String) (defaults to: nil)

    Limits the returned comment threads to those with the specified moderation status. Not compatible with the 'id' filter. Valid values: published, heldForReview, likelySpam.

  • order (String) (defaults to: nil)
  • page_token (String) (defaults to: nil)

    The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

  • search_terms (String) (defaults to: nil)

    Limits the returned comment threads to those matching the specified key words. Not compatible with the 'id' filter.

  • text_format (String) (defaults to: nil)

    The requested text format for the returned comments.

  • video_id (String) (defaults to: nil)

    Returns the comment threads of the specified video.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
# File 'lib/google/apis/youtube_v3/service.rb', line 915

def list_comment_threads(part, all_threads_related_to_channel_id: nil, channel_id: nil, id: nil, max_results: nil, moderation_status: nil, order: nil, page_token: nil, search_terms: nil, text_format: nil, video_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/commentThreads', options)
  command.response_representation = Google::Apis::YoutubeV3::ListCommentThreadsResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::ListCommentThreadsResponse
  command.query['allThreadsRelatedToChannelId'] = all_threads_related_to_channel_id unless all_threads_related_to_channel_id.nil?
  command.query['channelId'] = channel_id unless channel_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['moderationStatus'] = moderation_status unless moderation_status.nil?
  command.query['order'] = order unless order.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['part'] = part unless part.nil?
  command.query['searchTerms'] = search_terms unless search_terms.nil?
  command.query['textFormat'] = text_format unless text_format.nil?
  command.query['videoId'] = video_id unless video_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_comments(part, id: nil, max_results: nil, page_token: nil, parent_id: nil, text_format: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::ListCommentsResponse

Retrieves a list of resources, possibly filtered.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies a comma-separated list of one or more comment resource properties that the API response will include.

  • id (Array<String>, String) (defaults to: nil)

    Returns the comments with the given IDs for One Platform.

  • max_results (Fixnum) (defaults to: nil)

    The maxResults parameter specifies the maximum number of items that should be returned in the result set.

  • page_token (String) (defaults to: nil)

    The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

  • parent_id (String) (defaults to: nil)

    Returns replies to the specified comment. Note, currently YouTube features only one level of replies (ie replies to top level comments). However replies to replies may be supported in the future.

  • text_format (String) (defaults to: nil)

    The requested text format for the returned comments.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
# File 'lib/google/apis/youtube_v3/service.rb', line 1033

def list_comments(part, id: nil, max_results: nil, page_token: nil, parent_id: nil, text_format: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/comments', options)
  command.response_representation = Google::Apis::YoutubeV3::ListCommentsResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::ListCommentsResponse
  command.query['id'] = id unless id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['parentId'] = parent_id unless parent_id.nil?
  command.query['part'] = part unless part.nil?
  command.query['textFormat'] = text_format unless text_format.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_i18n_languages(part, hl: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::ListI18nLanguagesResponse

Retrieves a list of resources, possibly filtered.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies the i18nLanguage resource properties that the API response will include. Set the parameter value to snippet.

  • hl (String) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
# File 'lib/google/apis/youtube_v3/service.rb', line 1173

def list_i18n_languages(part, hl: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/i18nLanguages', options)
  command.response_representation = Google::Apis::YoutubeV3::ListI18nLanguagesResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::ListI18nLanguagesResponse
  command.query['hl'] = hl unless hl.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_i18n_regions(part, hl: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::ListI18nRegionsResponse

Retrieves a list of resources, possibly filtered.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies the i18nRegion resource properties that the API response will include. Set the parameter value to snippet.

  • hl (String) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
# File 'lib/google/apis/youtube_v3/service.rb', line 1206

def list_i18n_regions(part, hl: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/i18nRegions', options)
  command.response_representation = Google::Apis::YoutubeV3::ListI18nRegionsResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::ListI18nRegionsResponse
  command.query['hl'] = hl unless hl.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_live_broadcasts(part, broadcast_status: nil, broadcast_type: nil, id: nil, max_results: nil, mine: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::ListLiveBroadcastsResponse

Retrieve the list of broadcasts associated with the given channel.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, status and statistics.

  • broadcast_status (String) (defaults to: nil)

    Return broadcasts with a certain status, e.g. active broadcasts.

  • broadcast_type (String) (defaults to: nil)

    Return only broadcasts with the selected type.

  • id (Array<String>, String) (defaults to: nil)

    Return broadcasts with the given ids from Stubby or Apiary.

  • max_results (Fixnum) (defaults to: nil)

    The maxResults parameter specifies the maximum number of items that should be returned in the result set.

  • mine (Boolean) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • on_behalf_of_content_owner_channel (String) (defaults to: nil)

    This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The * onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

  • page_token (String) (defaults to: nil)

    The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'lib/google/apis/youtube_v3/service.rb', line 1530

def list_live_broadcasts(part, broadcast_status: nil, broadcast_type: nil, id: nil, max_results: nil, mine: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/liveBroadcasts', options)
  command.response_representation = Google::Apis::YoutubeV3::ListLiveBroadcastsResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::ListLiveBroadcastsResponse
  command.query['broadcastStatus'] = broadcast_status unless broadcast_status.nil?
  command.query['broadcastType'] = broadcast_type unless broadcast_type.nil?
  command.query['id'] = id unless id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['mine'] = mine unless mine.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['onBehalfOfContentOwnerChannel'] = on_behalf_of_content_owner_channel unless on_behalf_of_content_owner_channel.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_live_chat_messages(live_chat_id, part, hl: nil, max_results: nil, page_token: nil, profile_image_size: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::LiveChatMessageListResponse

Retrieves a list of resources, possibly filtered.

Parameters:

  • live_chat_id (String)

    The id of the live chat for which comments should be returned.

  • part (Array<String>, String)

    The part parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id and snippet.

  • hl (String) (defaults to: nil)

    Specifies the localization language in which the system messages should be returned.

  • max_results (Fixnum) (defaults to: nil)

    The maxResults parameter specifies the maximum number of items that should be returned in the result set.

  • page_token (String) (defaults to: nil)

    The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identify other pages that could be retrieved.

  • profile_image_size (Fixnum) (defaults to: nil)

    Specifies the size of the profile image that should be returned for each user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
# File 'lib/google/apis/youtube_v3/service.rb', line 1844

def list_live_chat_messages(live_chat_id, part, hl: nil, max_results: nil, page_token: nil, profile_image_size: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/liveChat/messages', options)
  command.response_representation = Google::Apis::YoutubeV3::LiveChatMessageListResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::LiveChatMessageListResponse
  command.query['hl'] = hl unless hl.nil?
  command.query['liveChatId'] = live_chat_id unless live_chat_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['part'] = part unless part.nil?
  command.query['profileImageSize'] = profile_image_size unless profile_image_size.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_live_chat_moderators(live_chat_id, part, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::LiveChatModeratorListResponse

Retrieves a list of resources, possibly filtered.

Parameters:

  • live_chat_id (String)

    The id of the live chat for which moderators should be returned.

  • part (Array<String>, String)

    The part parameter specifies the liveChatModerator resource parts that the API response will include. Supported values are id and snippet.

  • max_results (Fixnum) (defaults to: nil)

    The maxResults parameter specifies the maximum number of items that should be returned in the result set.

  • page_token (String) (defaults to: nil)

    The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'lib/google/apis/youtube_v3/service.rb', line 1951

def list_live_chat_moderators(live_chat_id, part, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/liveChat/moderators', options)
  command.response_representation = Google::Apis::YoutubeV3::LiveChatModeratorListResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::LiveChatModeratorListResponse
  command.query['liveChatId'] = live_chat_id unless live_chat_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_live_streams(part, id: nil, max_results: nil, mine: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::ListLiveStreamsResponse

Retrieve the list of streams associated with the given channel. --

Parameters:

  • part (Array<String>, String)

    The part parameter specifies a comma-separated list of one or more liveStream resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, cdn, and status.

  • id (Array<String>, String) (defaults to: nil)

    Return LiveStreams with the given ids from Stubby or Apiary.

  • max_results (Fixnum) (defaults to: nil)

    The maxResults parameter specifies the maximum number of items that should be returned in the result set.

  • mine (Boolean) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • on_behalf_of_content_owner_channel (String) (defaults to: nil)

    This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The * onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

  • page_token (String) (defaults to: nil)

    The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
# File 'lib/google/apis/youtube_v3/service.rb', line 2139

def list_live_streams(part, id: nil, max_results: nil, mine: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/liveStreams', options)
  command.response_representation = Google::Apis::YoutubeV3::ListLiveStreamsResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::ListLiveStreamsResponse
  command.query['id'] = id unless id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['mine'] = mine unless mine.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['onBehalfOfContentOwnerChannel'] = on_behalf_of_content_owner_channel unless on_behalf_of_content_owner_channel.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_members(part, filter_by_member_channel_id: nil, has_access_to_level: nil, max_results: nil, mode: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::MemberListResponse

Retrieves a list of members that match the request criteria for a channel.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies the member resource parts that the API response will include. Set the parameter value to snippet.

  • filter_by_member_channel_id (String) (defaults to: nil)

    Comma separated list of channel IDs. Only data about members that are part of this list will be included in the response.

  • has_access_to_level (String) (defaults to: nil)

    Filter members in the results set to the ones that have access to a level.

  • max_results (Fixnum) (defaults to: nil)

    The maxResults parameter specifies the maximum number of items that should be returned in the result set.

  • mode (String) (defaults to: nil)

    Parameter that specifies which channel members to return.

  • page_token (String) (defaults to: nil)

    The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
# File 'lib/google/apis/youtube_v3/service.rb', line 2257

def list_members(part, filter_by_member_channel_id: nil, has_access_to_level: nil, max_results: nil, mode: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/members', options)
  command.response_representation = Google::Apis::YoutubeV3::MemberListResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::MemberListResponse
  command.query['filterByMemberChannelId'] = filter_by_member_channel_id unless filter_by_member_channel_id.nil?
  command.query['hasAccessToLevel'] = has_access_to_level unless has_access_to_level.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['mode'] = mode unless mode.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_memberships_levels(part, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::MembershipsLevelListResponse

Retrieves a list of all pricing levels offered by a creator to the fans.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies the membershipsLevel resource parts that the API response will include. Supported values are id and snippet.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2293
2294
2295
2296
2297
2298
2299
2300
2301
# File 'lib/google/apis/youtube_v3/service.rb', line 2293

def list_memberships_levels(part, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/membershipsLevels', options)
  command.response_representation = Google::Apis::YoutubeV3::MembershipsLevelListResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::MembershipsLevelListResponse
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_playlist_images(max_results: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, page_token: nil, parent: nil, part: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::PlaylistImageListResponse

Retrieves a list of resources, possibly filtered.

Parameters:

  • max_results (Fixnum) (defaults to: nil)

    The maxResults parameter specifies the maximum number of items that should be returned in the result set.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • on_behalf_of_content_owner_channel (String) (defaults to: nil)

    This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The * onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

  • page_token (String) (defaults to: nil)

    The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

  • parent (String) (defaults to: nil)

    Return PlaylistImages for this playlist id.

  • part (Array<String>, String) (defaults to: nil)

    The part parameter specifies a comma-separated list of one or more playlistImage resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
# File 'lib/google/apis/youtube_v3/service.rb', line 2460

def list_playlist_images(max_results: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, page_token: nil, parent: nil, part: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/playlistImages', options)
  command.response_representation = Google::Apis::YoutubeV3::PlaylistImageListResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::PlaylistImageListResponse
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['onBehalfOfContentOwnerChannel'] = on_behalf_of_content_owner_channel unless on_behalf_of_content_owner_channel.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_playlist_items(part, id: nil, max_results: nil, on_behalf_of_content_owner: nil, page_token: nil, playlist_id: nil, video_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::ListPlaylistItemsResponse

Retrieves a list of resources, possibly filtered.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies a comma-separated list of one or more playlistItem resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlistItem resource, the snippet property contains numerous fields, including the title, description, position, and resourceId properties. As such, if you set part= snippet, the API response will contain all of those properties.

  • id (Array<String>, String) (defaults to: nil)
  • max_results (Fixnum) (defaults to: nil)

    The maxResults parameter specifies the maximum number of items that should be returned in the result set.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • page_token (String) (defaults to: nil)

    The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

  • playlist_id (String) (defaults to: nil)

    Return the playlist items within the given playlist.

  • video_id (String) (defaults to: nil)

    Return the playlist items associated with the given video ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
# File 'lib/google/apis/youtube_v3/service.rb', line 2652

def list_playlist_items(part, id: nil, max_results: nil, on_behalf_of_content_owner: nil, page_token: nil, playlist_id: nil, video_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/playlistItems', options)
  command.response_representation = Google::Apis::YoutubeV3::ListPlaylistItemsResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::ListPlaylistItemsResponse
  command.query['id'] = id unless id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['part'] = part unless part.nil?
  command.query['playlistId'] = playlist_id unless playlist_id.nil?
  command.query['videoId'] = video_id unless video_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_playlists(part, channel_id: nil, hl: nil, id: nil, max_results: nil, mine: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::ListPlaylistResponse

Retrieves a list of resources, possibly filtered.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies a comma-separated list of one or more playlist resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlist resource, the snippet property contains properties like author, title, description, tags, and timeCreated. As such, if you set part=snippet, the API response will contain all of those properties.

  • channel_id (String) (defaults to: nil)

    Return the playlists owned by the specified channel ID.

  • hl (String) (defaults to: nil)

    Return content in specified language

  • id (Array<String>, String) (defaults to: nil)

    Return the playlists with the given IDs for Stubby or Apiary.

  • max_results (Fixnum) (defaults to: nil)

    The maxResults parameter specifies the maximum number of items that should be returned in the result set.

  • mine (Boolean) (defaults to: nil)

    Return the playlists owned by the authenticated user.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • on_behalf_of_content_owner_channel (String) (defaults to: nil)

    This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The * onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

  • page_token (String) (defaults to: nil)

    The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
# File 'lib/google/apis/youtube_v3/service.rb', line 2889

def list_playlists(part, channel_id: nil, hl: nil, id: nil, max_results: nil, mine: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/playlists', options)
  command.response_representation = Google::Apis::YoutubeV3::ListPlaylistResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::ListPlaylistResponse
  command.query['channelId'] = channel_id unless channel_id.nil?
  command.query['hl'] = hl unless hl.nil?
  command.query['id'] = id unless id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['mine'] = mine unless mine.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['onBehalfOfContentOwnerChannel'] = on_behalf_of_content_owner_channel unless on_behalf_of_content_owner_channel.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_searches(part, channel_id: nil, channel_type: nil, event_type: nil, for_content_owner: nil, for_developer: nil, for_mine: nil, location: nil, location_radius: nil, max_results: nil, on_behalf_of_content_owner: nil, order: nil, page_token: nil, published_after: nil, published_before: nil, q: nil, region_code: nil, relevance_language: nil, safe_search: nil, topic_id: nil, type: nil, video_caption: nil, video_category_id: nil, video_definition: nil, video_dimension: nil, video_duration: nil, video_embeddable: nil, video_license: nil, video_paid_product_placement: nil, video_syndicated: nil, video_type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::SearchListsResponse

Retrieves a list of search resources

Parameters:

  • part (Array<String>, String)

    The part parameter specifies a comma-separated list of one or more search resource properties that the API response will include. Set the parameter value to snippet.

  • channel_id (String) (defaults to: nil)

    Filter on resources belonging to this channelId.

  • channel_type (String) (defaults to: nil)

    Add a filter on the channel search.

  • event_type (String) (defaults to: nil)

    Filter on the livestream status of the videos.

  • for_content_owner (Boolean) (defaults to: nil)

    Search owned by a content owner.

  • for_developer (Boolean) (defaults to: nil)

    Restrict the search to only retrieve videos uploaded using the project id of the authenticated user.

  • for_mine (Boolean) (defaults to: nil)

    Search for the private videos of the authenticated user.

  • location (String) (defaults to: nil)

    Filter on location of the video

  • location_radius (String) (defaults to: nil)

    Filter on distance from the location (specified above).

  • max_results (Fixnum) (defaults to: nil)

    The maxResults parameter specifies the maximum number of items that should be returned in the result set.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • order (String) (defaults to: nil)

    Sort order of the results.

  • page_token (String) (defaults to: nil)

    The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

  • published_after (String) (defaults to: nil)

    Filter on resources published after this date.

  • published_before (String) (defaults to: nil)

    Filter on resources published before this date.

  • q (String) (defaults to: nil)

    Textual search terms to match.

  • region_code (String) (defaults to: nil)

    Display the content as seen by viewers in this country.

  • relevance_language (String) (defaults to: nil)

    Return results relevant to this language.

  • safe_search (String) (defaults to: nil)

    Indicates whether the search results should include restricted content as well as standard content.

  • topic_id (String) (defaults to: nil)

    Restrict results to a particular topic.

  • type (Array<String>, String) (defaults to: nil)

    Restrict results to a particular set of resource types from One Platform.

  • video_caption (String) (defaults to: nil)

    Filter on the presence of captions on the videos.

  • video_category_id (String) (defaults to: nil)

    Filter on videos in a specific category.

  • video_definition (String) (defaults to: nil)

    Filter on the definition of the videos.

  • video_dimension (String) (defaults to: nil)

    Filter on 3d videos.

  • video_duration (String) (defaults to: nil)

    Filter on the duration of the videos.

  • video_embeddable (String) (defaults to: nil)

    Filter on embeddable videos.

  • video_license (String) (defaults to: nil)

    Filter on the license of the videos.

  • video_paid_product_placement (String) (defaults to: nil)
  • video_syndicated (String) (defaults to: nil)

    Filter on syndicated videos.

  • video_type (String) (defaults to: nil)

    Filter on videos of a specific type.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
# File 'lib/google/apis/youtube_v3/service.rb', line 3052

def list_searches(part, channel_id: nil, channel_type: nil, event_type: nil, for_content_owner: nil, for_developer: nil, for_mine: nil, location: nil, location_radius: nil, max_results: nil, on_behalf_of_content_owner: nil, order: nil, page_token: nil, published_after: nil, published_before: nil, q: nil, region_code: nil, relevance_language: nil, safe_search: nil, topic_id: nil, type: nil, video_caption: nil, video_category_id: nil, video_definition: nil, video_dimension: nil, video_duration: nil, video_embeddable: nil, video_license: nil, video_paid_product_placement: nil, video_syndicated: nil, video_type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/search', options)
  command.response_representation = Google::Apis::YoutubeV3::SearchListsResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::SearchListsResponse
  command.query['channelId'] = channel_id unless channel_id.nil?
  command.query['channelType'] = channel_type unless channel_type.nil?
  command.query['eventType'] = event_type unless event_type.nil?
  command.query['forContentOwner'] = for_content_owner unless for_content_owner.nil?
  command.query['forDeveloper'] = for_developer unless for_developer.nil?
  command.query['forMine'] = for_mine unless for_mine.nil?
  command.query['location'] = location unless location.nil?
  command.query['locationRadius'] = location_radius unless location_radius.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['order'] = order unless order.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['part'] = part unless part.nil?
  command.query['publishedAfter'] = published_after unless published_after.nil?
  command.query['publishedBefore'] = published_before unless published_before.nil?
  command.query['q'] = q unless q.nil?
  command.query['regionCode'] = region_code unless region_code.nil?
  command.query['relevanceLanguage'] = relevance_language unless relevance_language.nil?
  command.query['safeSearch'] = safe_search unless safe_search.nil?
  command.query['topicId'] = topic_id unless topic_id.nil?
  command.query['type'] = type unless type.nil?
  command.query['videoCaption'] = video_caption unless video_caption.nil?
  command.query['videoCategoryId'] = video_category_id unless video_category_id.nil?
  command.query['videoDefinition'] = video_definition unless video_definition.nil?
  command.query['videoDimension'] = video_dimension unless video_dimension.nil?
  command.query['videoDuration'] = video_duration unless video_duration.nil?
  command.query['videoEmbeddable'] = video_embeddable unless video_embeddable.nil?
  command.query['videoLicense'] = video_license unless video_license.nil?
  command.query['videoPaidProductPlacement'] = video_paid_product_placement unless video_paid_product_placement.nil?
  command.query['videoSyndicated'] = video_syndicated unless video_syndicated.nil?
  command.query['videoType'] = video_type unless video_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_subscriptions(part, channel_id: nil, for_channel_id: nil, id: nil, max_results: nil, mine: nil, my_recent_subscribers: nil, my_subscribers: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, order: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::ListSubscriptionResponse

Retrieves a list of resources, possibly filtered.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies a comma-separated list of one or more subscription resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a subscription resource, the snippet property contains other properties, such as a display title for the subscription. If you set part=snippet, the API response will also contain all of those nested properties.

  • channel_id (String) (defaults to: nil)

    Return the subscriptions of the given channel owner.

  • for_channel_id (String) (defaults to: nil)

    Return the subscriptions to the subset of these channels that the authenticated user is subscribed to.

  • id (Array<String>, String) (defaults to: nil)

    Return the subscriptions with the given IDs for Stubby or Apiary.

  • max_results (Fixnum) (defaults to: nil)

    The maxResults parameter specifies the maximum number of items that should be returned in the result set.

  • mine (Boolean) (defaults to: nil)

    Flag for returning the subscriptions of the authenticated user.

  • my_recent_subscribers (Boolean) (defaults to: nil)
  • my_subscribers (Boolean) (defaults to: nil)

    Return the subscribers of the given channel owner.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • on_behalf_of_content_owner_channel (String) (defaults to: nil)

    This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The * onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

  • order (String) (defaults to: nil)

    The order of the returned subscriptions

  • page_token (String) (defaults to: nil)

    The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
# File 'lib/google/apis/youtube_v3/service.rb', line 3226

def list_subscriptions(part, channel_id: nil, for_channel_id: nil, id: nil, max_results: nil, mine: nil, my_recent_subscribers: nil, my_subscribers: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, order: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/subscriptions', options)
  command.response_representation = Google::Apis::YoutubeV3::ListSubscriptionResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::ListSubscriptionResponse
  command.query['channelId'] = channel_id unless channel_id.nil?
  command.query['forChannelId'] = for_channel_id unless for_channel_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['mine'] = mine unless mine.nil?
  command.query['myRecentSubscribers'] = my_recent_subscribers unless my_recent_subscribers.nil?
  command.query['mySubscribers'] = my_subscribers unless my_subscribers.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['onBehalfOfContentOwnerChannel'] = on_behalf_of_content_owner_channel unless on_behalf_of_content_owner_channel.nil?
  command.query['order'] = order unless order.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_super_chat_events(part, hl: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::SuperChatEventListResponse

Retrieves a list of resources, possibly filtered.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies the superChatEvent resource parts that the API response will include. This parameter is currently not supported.

  • hl (String) (defaults to: nil)

    Return rendered funding amounts in specified language.

  • max_results (Fixnum) (defaults to: nil)

    The maxResults parameter specifies the maximum number of items that should be returned in the result set.

  • page_token (String) (defaults to: nil)

    The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
# File 'lib/google/apis/youtube_v3/service.rb', line 3277

def list_super_chat_events(part, hl: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/superChatEvents', options)
  command.response_representation = Google::Apis::YoutubeV3::SuperChatEventListResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::SuperChatEventListResponse
  command.query['hl'] = hl unless hl.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

Retrieves a list of resources, possibly filtered.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies the thirdPartyLink resource parts that the API response will include. Supported values are linkingToken, status, and snippet.

  • external_channel_id (String) (defaults to: nil)

    Channel ID to which changes should be applied, for delegation.

  • linking_token (String) (defaults to: nil)

    Get a third party link with the given linking token.

  • type (String) (defaults to: nil)

    Get a third party link of the given type.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
# File 'lib/google/apis/youtube_v3/service.rb', line 3426

def list_third_party_links(part, external_channel_id: nil, linking_token: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/thirdPartyLinks', options)
  command.response_representation = Google::Apis::YoutubeV3::ThirdPartyLinkListResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::ThirdPartyLinkListResponse
  command.query['externalChannelId'] = external_channel_id unless external_channel_id.nil?
  command.query['linkingToken'] = linking_token unless linking_token.nil?
  command.query['part'] = part unless part.nil?
  command.query['type'] = type unless type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_video_abuse_report_reasons(part, hl: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::ListVideoAbuseReportReasonResponse

Retrieves a list of resources, possibly filtered.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies the videoCategory resource parts that the API response will include. Supported values are id and snippet.

  • hl (String) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
# File 'lib/google/apis/youtube_v3/service.rb', line 3552

def list_video_abuse_report_reasons(part, hl: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/videoAbuseReportReasons', options)
  command.response_representation = Google::Apis::YoutubeV3::ListVideoAbuseReportReasonResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::ListVideoAbuseReportReasonResponse
  command.query['hl'] = hl unless hl.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_video_categories(part, hl: nil, id: nil, region_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::ListVideoCategoryResponse

Retrieves a list of resources, possibly filtered.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies the videoCategory resource properties that the API response will include. Set the parameter value to snippet.

  • hl (String) (defaults to: nil)
  • id (Array<String>, String) (defaults to: nil)

    Returns the video categories with the given IDs for Stubby or Apiary.

  • region_code (String) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
# File 'lib/google/apis/youtube_v3/service.rb', line 3588

def list_video_categories(part, hl: nil, id: nil, region_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/videoCategories', options)
  command.response_representation = Google::Apis::YoutubeV3::ListVideoCategoryResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::ListVideoCategoryResponse
  command.query['hl'] = hl unless hl.nil?
  command.query['id'] = id unless id.nil?
  command.query['part'] = part unless part.nil?
  command.query['regionCode'] = region_code unless region_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_videos(part, chart: nil, hl: nil, id: nil, locale: nil, max_height: nil, max_results: nil, max_width: nil, my_rating: nil, on_behalf_of_content_owner: nil, page_token: nil, region_code: nil, video_category_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::ListVideosResponse

Retrieves a list of resources, possibly filtered.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies a comma-separated list of one or more video resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a video resource, the snippet property contains the channelId, title, description, tags, and categoryId properties. As such, if you set part=snippet, the API response will contain all of those properties.

  • chart (String) (defaults to: nil)

    Return the videos that are in the specified chart.

  • hl (String) (defaults to: nil)

    Stands for "host language". Specifies the localization language of the metadata to be filled into snippet.localized. The field is filled with the default metadata if there is no localization in the specified language. The parameter value must be a language code included in the list returned by the i18nLanguages.list method (e.g. en_US, es_MX).

  • id (Array<String>, String) (defaults to: nil)

    Return videos with the given ids.

  • locale (String) (defaults to: nil)
  • max_height (Fixnum) (defaults to: nil)
  • max_results (Fixnum) (defaults to: nil)

    The maxResults parameter specifies the maximum number of items that should be returned in the result set. Note: This parameter is supported for use in conjunction with the myRating and chart parameters, but it is not supported for use in conjunction with the id parameter.

  • max_width (Fixnum) (defaults to: nil)

    Return the player with maximum height specified in

  • my_rating (String) (defaults to: nil)

    Return videos liked/disliked by the authenticated user. Does not support RateType.RATED_TYPE_NONE.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • page_token (String) (defaults to: nil)

    The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. Note: This parameter is supported for use in conjunction with the myRating and chart parameters, but it is not supported for use in conjunction with the id parameter.

  • region_code (String) (defaults to: nil)

    Use a chart that is specific to the specified region

  • video_category_id (String) (defaults to: nil)

    Use chart that is specific to the specified video category

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
# File 'lib/google/apis/youtube_v3/service.rb', line 3836

def list_videos(part, chart: nil, hl: nil, id: nil, locale: nil, max_height: nil, max_results: nil, max_width: nil, my_rating: nil, on_behalf_of_content_owner: nil, page_token: nil, region_code: nil, video_category_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/v3/videos', options)
  command.response_representation = Google::Apis::YoutubeV3::ListVideosResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::ListVideosResponse
  command.query['chart'] = chart unless chart.nil?
  command.query['hl'] = hl unless hl.nil?
  command.query['id'] = id unless id.nil?
  command.query['locale'] = locale unless locale.nil?
  command.query['maxHeight'] = max_height unless max_height.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['maxWidth'] = max_width unless max_width.nil?
  command.query['myRating'] = my_rating unless my_rating.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['part'] = part unless part.nil?
  command.query['regionCode'] = region_code unless region_code.nil?
  command.query['videoCategoryId'] = video_category_id unless video_category_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#mark_comment_as_spam(id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Expresses the caller's opinion that one or more comments should be flagged as spam.

Parameters:

  • id (Array<String>, String)

    Flags the comments with the given IDs as spam in the caller's opinion.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1069
1070
1071
1072
1073
1074
1075
# File 'lib/google/apis/youtube_v3/service.rb', line 1069

def mark_comment_as_spam(id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/comments/markAsSpam', options)
  command.query['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#rate_video(id, rating, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Adds a like or dislike rating to a video or removes a rating from a video.

Parameters:

  • id (String)
  • rating (String)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3878
3879
3880
3881
3882
3883
3884
3885
# File 'lib/google/apis/youtube_v3/service.rb', line 3878

def rate_video(id, rating, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/videos/rate', options)
  command.query['id'] = id unless id.nil?
  command.query['rating'] = rating unless rating.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#report_video_abuse(video_abuse_report_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Report abuse for a video.

Parameters:

  • video_abuse_report_object (Google::Apis::YoutubeV3::VideoAbuseReport) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3916
3917
3918
3919
3920
3921
3922
3923
3924
# File 'lib/google/apis/youtube_v3/service.rb', line 3916

def report_video_abuse(video_abuse_report_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/videos/reportAbuse', options)
  command.request_representation = Google::Apis::YoutubeV3::VideoAbuseReport::Representation
  command.request_object = video_abuse_report_object
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_comment_moderation_status(id, moderation_status, ban_author: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Sets the moderation status of one or more comments.

Parameters:

  • id (Array<String>, String)

    Modifies the moderation status of the comments with the given IDs

  • moderation_status (String)

    Specifies the requested moderation status. Note, comments can be in statuses, which are not available through this call. For example, this call does not allow to mark a comment as 'likely spam'. Valid values: 'heldForReview', ' published' or 'rejected'.

  • ban_author (Boolean) (defaults to: nil)

    If set to true the author of the comment gets added to the ban list. This means all future comments of the author will autmomatically be rejected. Only valid in combination with STATUS_REJECTED.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1106
1107
1108
1109
1110
1111
1112
1113
1114
# File 'lib/google/apis/youtube_v3/service.rb', line 1106

def set_comment_moderation_status(id, moderation_status, ban_author: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/comments/setModerationStatus', options)
  command.query['banAuthor'] = ban_author unless ban_author.nil?
  command.query['id'] = id unless id.nil?
  command.query['moderationStatus'] = moderation_status unless moderation_status.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_thumbnail(video_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::SetThumbnailResponse

As this is not an insert in a strict sense (it supports uploading/setting of a thumbnail for multiple videos, which doesn't result in creation of a single resource), I use a custom verb here.

Parameters:

  • video_id (String)

    Returns the Thumbnail with the given video IDs for Stubby or Apiary.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • upload_source (IO, String) (defaults to: nil)

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil)

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
# File 'lib/google/apis/youtube_v3/service.rb', line 3513

def set_thumbnail(video_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'youtube/v3/thumbnails/set', options)
  else
    command = make_upload_command(:post, 'youtube/v3/thumbnails/set', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.response_representation = Google::Apis::YoutubeV3::SetThumbnailResponse::Representation
  command.response_class = Google::Apis::YoutubeV3::SetThumbnailResponse
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['videoId'] = video_id unless video_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_watermark(channel_id, invideo_branding_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Allows upload of watermark image and setting it for a channel.

Parameters:

  • channel_id (String)
  • invideo_branding_object (Google::Apis::YoutubeV3::InvideoBranding) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • upload_source (IO, String) (defaults to: nil)

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil)

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
# File 'lib/google/apis/youtube_v3/service.rb', line 4019

def set_watermark(channel_id, invideo_branding_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'youtube/v3/watermarks/set', options)
  else
    command = make_upload_command(:post, 'youtube/v3/watermarks/set', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::YoutubeV3::InvideoBranding::Representation
  command.request_object = invideo_branding_object
  command.query['channelId'] = channel_id unless channel_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#transition_live_broadcast(broadcast_status, id, part, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::LiveBroadcast

Transition a broadcast to a given status.

Parameters:

  • broadcast_status (String)

    The status to which the broadcast is going to transition.

  • id (String)

    Broadcast to transition.

  • part (Array<String>, String)

    The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • on_behalf_of_content_owner_channel (String) (defaults to: nil)

    This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The * onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
# File 'lib/google/apis/youtube_v3/service.rb', line 1600

def transition_live_broadcast(broadcast_status, id, part, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/liveBroadcasts/transition', options)
  command.response_representation = Google::Apis::YoutubeV3::LiveBroadcast::Representation
  command.response_class = Google::Apis::YoutubeV3::LiveBroadcast
  command.query['broadcastStatus'] = broadcast_status unless broadcast_status.nil?
  command.query['id'] = id unless id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['onBehalfOfContentOwnerChannel'] = on_behalf_of_content_owner_channel unless on_behalf_of_content_owner_channel.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#unset_watermark(channel_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Allows removal of channel watermark.

Parameters:

  • channel_id (String)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4065
4066
4067
4068
4069
4070
4071
4072
# File 'lib/google/apis/youtube_v3/service.rb', line 4065

def unset_watermark(channel_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/v3/watermarks/unset', options)
  command.query['channelId'] = channel_id unless channel_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_caption(part, caption_object = nil, on_behalf_of: nil, on_behalf_of_content_owner: nil, sync: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::Caption

Updates an existing resource.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet.

  • caption_object (Google::Apis::YoutubeV3::Caption) (defaults to: nil)
  • on_behalf_of (String) (defaults to: nil)

    ID of the Google+ Page for the channel that the request is on behalf of.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • sync (Boolean) (defaults to: nil)

    Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • upload_source (IO, String) (defaults to: nil)

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil)

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
# File 'lib/google/apis/youtube_v3/service.rb', line 399

def update_caption(part, caption_object = nil, on_behalf_of: nil, on_behalf_of_content_owner: nil, sync: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:put, 'youtube/v3/captions', options)
  else
    command = make_upload_command(:put, 'youtube/v3/captions', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::YoutubeV3::Caption::Representation
  command.request_object = caption_object
  command.response_representation = Google::Apis::YoutubeV3::Caption::Representation
  command.response_class = Google::Apis::YoutubeV3::Caption
  command.query['onBehalfOf'] = on_behalf_of unless on_behalf_of.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['part'] = part unless part.nil?
  command.query['sync'] = sync unless sync.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_channel(part, channel_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::Channel

Updates an existing resource.

Parameters:

  • part (Array<String>, String)

    The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The API currently only allows the parameter value to be set to either brandingSettings or invideoPromotion. (You cannot update both of those parts with a single request.) Note that this method overrides the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies.

  • channel_object (Google::Apis::YoutubeV3::Channel) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



819
820
821
822
823
824
825
826
827
828
829
830
# File 'lib/google/apis/youtube_v3/service.rb', line 819

def update_channel(part, channel_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'youtube/v3/channels', options)
  command.request_representation = Google::Apis::YoutubeV3::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::YoutubeV3::Channel::Representation
  command.response_class = Google::Apis::YoutubeV3::Channel
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_channel_section(part, channel_section_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::ChannelSection

Updates an existing resource.

Parameters:

  • part (Array<String>, String)

    The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and contentDetails.

  • channel_section_object (Google::Apis::YoutubeV3::ChannelSection) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



686
687
688
689
690
691
692
693
694
695
696
697
# File 'lib/google/apis/youtube_v3/service.rb', line 686

def update_channel_section(part, channel_section_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'youtube/v3/channelSections', options)
  command.request_representation = Google::Apis::YoutubeV3::ChannelSection::Representation
  command.request_object = channel_section_object
  command.response_representation = Google::Apis::YoutubeV3::ChannelSection::Representation
  command.response_class = Google::Apis::YoutubeV3::ChannelSection
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_comment(part, comment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::Comment

Updates an existing resource.

Parameters:

  • part (Array<String>, String)

    The part parameter identifies the properties that the API response will include. You must at least include the snippet part in the parameter value since that part contains all of the properties that the API request can update.

  • comment_object (Google::Apis::YoutubeV3::Comment) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
# File 'lib/google/apis/youtube_v3/service.rb', line 1139

def update_comment(part, comment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'youtube/v3/comments', options)
  command.request_representation = Google::Apis::YoutubeV3::Comment::Representation
  command.request_object = comment_object
  command.response_representation = Google::Apis::YoutubeV3::Comment::Representation
  command.response_class = Google::Apis::YoutubeV3::Comment
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_live_broadcast(part, live_broadcast_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::LiveBroadcast

Updates an existing broadcast for the authenticated user.

Parameters:

  • part (Array<String>, String)

    The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, contentDetails, and status. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a broadcast's privacy status is defined in the status part. As such, if your request is updating a private or unlisted broadcast, and the request's part parameter value includes the status part, the broadcast's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the broadcast will revert to the default privacy setting.

  • live_broadcast_object (Google::Apis::YoutubeV3::LiveBroadcast) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • on_behalf_of_content_owner_channel (String) (defaults to: nil)

    This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The * onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
# File 'lib/google/apis/youtube_v3/service.rb', line 1671

def update_live_broadcast(part, live_broadcast_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'youtube/v3/liveBroadcasts', options)
  command.request_representation = Google::Apis::YoutubeV3::LiveBroadcast::Representation
  command.request_object = live_broadcast_object
  command.response_representation = Google::Apis::YoutubeV3::LiveBroadcast::Representation
  command.response_class = Google::Apis::YoutubeV3::LiveBroadcast
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['onBehalfOfContentOwnerChannel'] = on_behalf_of_content_owner_channel unless on_behalf_of_content_owner_channel.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_live_stream(part, live_stream_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::LiveStream

Updates an existing stream for the authenticated user.

Parameters:

  • part (Array<String>, String)

    The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, cdn, and status. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. If the request body does not specify a value for a mutable property, the existing value for that property will be removed.

  • live_stream_object (Google::Apis::YoutubeV3::LiveStream) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • on_behalf_of_content_owner_channel (String) (defaults to: nil)

    This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The * onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
# File 'lib/google/apis/youtube_v3/service.rb', line 2208

def update_live_stream(part, live_stream_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'youtube/v3/liveStreams', options)
  command.request_representation = Google::Apis::YoutubeV3::LiveStream::Representation
  command.request_object = live_stream_object
  command.response_representation = Google::Apis::YoutubeV3::LiveStream::Representation
  command.response_class = Google::Apis::YoutubeV3::LiveStream
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['onBehalfOfContentOwnerChannel'] = on_behalf_of_content_owner_channel unless on_behalf_of_content_owner_channel.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_playlist(part, playlist_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::Playlist

Updates an existing resource.

Parameters:

  • part (Array<String>, String)

    The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that this method will override the existing values for mutable properties that are contained in any parts that the request body specifies. For example, a playlist's description is contained in the snippet part, which must be included in the request body. If the request does not specify a value for the snippet.description property, the playlist's existing description will be deleted.

  • playlist_object (Google::Apis::YoutubeV3::Playlist) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
# File 'lib/google/apis/youtube_v3/service.rb', line 2945

def update_playlist(part, playlist_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'youtube/v3/playlists', options)
  command.request_representation = Google::Apis::YoutubeV3::Playlist::Representation
  command.request_object = playlist_object
  command.response_representation = Google::Apis::YoutubeV3::Playlist::Representation
  command.response_class = Google::Apis::YoutubeV3::Playlist
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_playlist_image(playlist_image_object = nil, on_behalf_of_content_owner: nil, part: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::PlaylistImage

Updates an existing resource.

Parameters:

  • playlist_image_object (Google::Apis::YoutubeV3::PlaylistImage) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • part (Array<String>, String) (defaults to: nil)

    The part parameter specifies the properties that the API response will include.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
# File 'lib/google/apis/youtube_v3/service.rb', line 2507

def update_playlist_image(playlist_image_object = nil, on_behalf_of_content_owner: nil, part: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'youtube/v3/playlistImages', options)
  command.request_representation = Google::Apis::YoutubeV3::PlaylistImage::Representation
  command.request_object = playlist_image_object
  command.response_representation = Google::Apis::YoutubeV3::PlaylistImage::Representation
  command.response_class = Google::Apis::YoutubeV3::PlaylistImage
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_playlist_item(part, playlist_item_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::PlaylistItem

Updates an existing resource.

Parameters:

  • part (Array<String>, String)

    The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a playlist item can specify a start time and end time, which identify the times portion of the video that should play when users watch the video in the playlist. If your request is updating a playlist item that sets these values, and the request's part parameter value includes the contentDetails part, the playlist item's start and end times will be updated to whatever value the request body specifies. If the request body does not specify values, the existing start and end times will be removed and replaced with the default settings.

  • playlist_item_object (Google::Apis::YoutubeV3::PlaylistItem) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
# File 'lib/google/apis/youtube_v3/service.rb', line 2710

def update_playlist_item(part, playlist_item_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'youtube/v3/playlistItems', options)
  command.request_representation = Google::Apis::YoutubeV3::PlaylistItem::Representation
  command.request_object = playlist_item_object
  command.response_representation = Google::Apis::YoutubeV3::PlaylistItem::Representation
  command.response_class = Google::Apis::YoutubeV3::PlaylistItem
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

Updates an existing resource.

Parameters:

  • part (Array<String>, String)

    The part parameter specifies the thirdPartyLink resource parts that the API request and response will include. Supported values are linkingToken, status, and snippet.

  • third_party_link_object (Google::Apis::YoutubeV3::ThirdPartyLink) (defaults to: nil)
  • external_channel_id (String) (defaults to: nil)

    Channel ID to which changes should be applied, for delegation.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
# File 'lib/google/apis/youtube_v3/service.rb', line 3464

def update_third_party_link(part, third_party_link_object = nil, external_channel_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'youtube/v3/thirdPartyLinks', options)
  command.request_representation = Google::Apis::YoutubeV3::ThirdPartyLink::Representation
  command.request_object = third_party_link_object
  command.response_representation = Google::Apis::YoutubeV3::ThirdPartyLink::Representation
  command.response_class = Google::Apis::YoutubeV3::ThirdPartyLink
  command.query['externalChannelId'] = external_channel_id unless external_channel_id.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_video(part, video_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::Video

Updates an existing resource.

Parameters:

  • part (Array<String>, String)

    The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a video's privacy setting is contained in the status part. As such, if your request is updating a private video, and the request's part parameter value includes the status part, the video's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the video will revert to the default privacy setting. In addition, not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.

  • video_object (Google::Apis::YoutubeV3::Video) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
# File 'lib/google/apis/youtube_v3/service.rb', line 3972

def update_video(part, video_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'youtube/v3/videos', options)
  command.request_representation = Google::Apis::YoutubeV3::Video::Representation
  command.request_object = video_object
  command.response_representation = Google::Apis::YoutubeV3::Video::Representation
  command.response_class = Google::Apis::YoutubeV3::Video
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_youtube_v3_comment_threads(comment_thread_object = nil, part: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeV3::CommentThread

Updates an existing resource.

Parameters:

  • comment_thread_object (Google::Apis::YoutubeV3::CommentThread) (defaults to: nil)
  • part (Array<String>, String) (defaults to: nil)

    The part parameter specifies a comma-separated list of commentThread resource properties that the API response will include. You must at least include the snippet part in the parameter value since that part contains all of the properties that the API request can update.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
# File 'lib/google/apis/youtube_v3/service.rb', line 4098

def update_youtube_v3_comment_threads(comment_thread_object = nil, part: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'youtube/v3/commentThreads', options)
  command.request_representation = Google::Apis::YoutubeV3::CommentThread::Representation
  command.request_object = comment_thread_object
  command.response_representation = Google::Apis::YoutubeV3::CommentThread::Representation
  command.response_class = Google::Apis::YoutubeV3::CommentThread
  command.query['part'] = part unless part.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end