Ballerina library

googleapis.youtube.data

Module googleapis.youtube.data

OverviewPrerequisites

API

Client

Definitions

AbuseReport
AbuseType
AccessPolicy
Caption
CaptionListResponse
CaptionSnippet
Channel
ChannelAuditDetails
ChannelBannerResource
ChannelBrandingSettings
ChannelContentDetails
ChannelcontentdetailsRelatedplaylists
ChannelContentOwnerDetails
ChannelConversionPing
ChannelConversionPings
ChannelListResponse
ChannelLocalization
ChannelSection
ChannelSectionContentDetails
ChannelSectionListResponse
ChannelSectionLocalization
ChannelSectionSnippet
ChannelSectionTargeting
ChannelSettings
ChannelSnippet
ChannelStatistics
ChannelStatus
ChannelTopicDetails
ClientHttp1Settings
Comment
CommentListResponse
CommentSnippet
CommentSnippetAuthorChannelId
CommentThread
CommentThreadListResponse
CommentThreadReplies
CommentThreadSnippet
ConnectionConfig
ContentRating
Entity
GeoPoint
ImageSettings
InvideoBranding
InvideoPosition
InvideoTiming
LanguageTag
LocalizedProperty
LocalizedString
OAuth2RefreshTokenGrantConfig
PageInfo
Playlist
PlaylistContentDetails
PlaylistItem
PlaylistItemContentDetails
PlaylistItemListResponse
PlaylistItemSnippet
PlaylistItemStatus
PlaylistListResponse
PlaylistLocalization
PlaylistPlayer
PlaylistSnippet
PlaylistStatus
PropertyValue
ProxyConfig
RelatedEntity
ResourceId
SearchListResponse
SearchResult
SearchResultSnippet
Subscription
SubscriptionContentDetails
SubscriptionListResponse
SubscriptionSnippet
SubscriptionSubscriberSnippet
Thumbnail
ThumbnailDetails
ThumbnailSetResponse
TokenPagination
Video
VideoAbuseReport
VideoAbuseReportReason
VideoAbuseReportReasonListResponse
VideoAbuseReportReasonSnippet
VideoAbuseReportSecondaryReason
VideoAgeGating
VideoCategory
VideoCategoryListResponse
VideoCategorySnippet
VideoContentDetails
VideoContentDetailsRegionRestriction
VideoFileDetails
VideoFileDetailsAudioStream
VideoFileDetailsVideoStream
VideoGetRatingResponse
VideoListResponse
VideoLiveStreamingDetails
VideoLocalization
VideoMonetizationDetails
VideoPlayer
VideoProcessingDetails
VideoProcessingDetailsProcessingProgress
VideoProjectDetails
VideoRating
VideoRecordingDetails
VideoSnippet
VideoStatistics
VideoStatus
VideoSuggestions
VideoSuggestionsTagSuggestion
VideoTopicDetails
WatchSettings

ballerinax/googleapis.youtube.data Ballerina library

1.5.2

Overview

The Youtube Data API v3 connector(https://developers.google.com/youtube/v3/docs) OpenAPI specification. The Youtube Data API provides the capability to access YouTube data such as videos, playlists, and channels.

Key Features

  • Programmatic access to create and manage resources via REST API
  • Manage user accounts and profiles
  • Secure authentication with API key or OAuth support

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Clients

googleapis.youtube.data: Client

Isolated

This is a generated connector for Youtube Data API v3 OpenAPI specification. The Youtube Data API provides the capability to access YouTube data such as videos, playlists, and channels.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create a Google account and obtain tokens by following this guide.

init (ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig - The configurations to be used when initializing the connector
  • serviceUrl string "https://youtube.googleapis.com/" - URL of the target service

insertAbuseReport

Isolated FunctionRemote Function
function insertAbuseReport(string[] part, AbuseReport payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns AbuseReport|error

Inserts a new resource into this collection.

Parameters
  • part 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

listCaptions

Isolated FunctionRemote Function
function listCaptions(string[] part, string videoId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string[]? id, string? onBehalfOf, string? onBehalfOfContentOwner) returns CaptionListResponse|error

Retrieves a list of resources, possibly filtered.

Parameters
  • part 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.
  • videoId string - Returns the captions for the specified video.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • id string[]? (default ()) - Returns the captions with the given IDs for Stubby or Apiary.
  • onBehalfOf string? (default ()) - ID of the Google+ Page for the channel that the request is on behalf of.
  • onBehalfOfContentOwner string? (default ()) - 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.
Return Type

updateCaption

Isolated FunctionRemote Function
function updateCaption(string[] part, Caption payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? onBehalfOf, string? onBehalfOfContentOwner, boolean? sync) returns Caption|error

Updates an existing resource.

Parameters
  • part 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • onBehalfOf string? (default ()) - ID of the Google+ Page for the channel that the request is on behalf of.
  • onBehalfOfContentOwner string? (default ()) - 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? (default ()) - Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.
Return Type

insertCaption

Isolated FunctionRemote Function
function insertCaption(string[] part, Caption payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? onBehalfOf, string? onBehalfOfContentOwner, boolean? sync) returns Caption|error

Inserts a new resource into this collection.

Parameters
  • part string[] - The part parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • onBehalfOf string? (default ()) - ID of the Google+ Page for the channel that the request is be on behalf of
  • onBehalfOfContentOwner string? (default ()) - 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? (default ()) - Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.
Return Type

deleteCaption

Isolated FunctionRemote Function
function deleteCaption(string id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? onBehalfOf, string? onBehalfOfContentOwner) returns Response|error

Deletes a resource.

Parameters
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • onBehalfOf string? (default ()) - ID of the Google+ Page for the channel that the request is be on behalf of
  • onBehalfOfContentOwner string? (default ()) - 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.
Return Type

downloadCaption

Isolated FunctionRemote Function
function downloadCaption(string id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? onBehalfOf, string? onBehalfOfContentOwner, string? tfmt, string? tlang) returns Response|error

Downloads a caption track.

Parameters
  • id string - The ID of the caption track to download, required for One Platform.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • onBehalfOf string? (default ()) - ID of the Google+ Page for the channel that the request is be on behalf of
  • onBehalfOfContentOwner string? (default ()) - 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? (default ()) - Convert the captions into this format. Supported options are sbv, srt, and vtt.
  • tlang string? (default ()) - tlang is the language code; machine translate the captions into this language.
Return Type

insertChannelBanner

Isolated FunctionRemote Function
function insertChannelBanner(ChannelBannerResource payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? channelId, string? onBehalfOfContentOwner, string? onBehalfOfContentOwnerChannel) returns ChannelBannerResource|error

Inserts a new resource into this collection.

Parameters
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • channelId string? (default ()) - Unused, channel_id is currently derived from the security context of the requestor.
  • onBehalfOfContentOwner string? (default ()) - 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.
  • onBehalfOfContentOwnerChannel string? (default ()) - 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.
Return Type

listChannelSections

Isolated FunctionRemote Function
function listChannelSections(string[] part, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? channelId, string? hl, string[]? id, boolean? mine, string? onBehalfOfContentOwner) returns ChannelSectionListResponse|error

Retrieves a list of resources, possibly filtered.

Parameters
  • part 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • channelId string? (default ()) - Return the ChannelSections owned by the specified channel ID.
  • hl string? (default ()) - Return content in specified language
  • id string[]? (default ()) - Return the ChannelSections with the given IDs for Stubby or Apiary.
  • mine boolean? (default ()) - Return the ChannelSections owned by the authenticated user.
  • onBehalfOfContentOwner string? (default ()) - 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.
Return Type

updateChannelSection

Isolated FunctionRemote Function
function updateChannelSection(string[] part, ChannelSection payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? onBehalfOfContentOwner) returns ChannelSection|error

Updates an existing resource.

Parameters
  • part 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • onBehalfOfContentOwner string? (default ()) - 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.
Return Type

insertChannelSection

Isolated FunctionRemote Function
function insertChannelSection(string[] part, ChannelSection payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? onBehalfOfContentOwner, string? onBehalfOfContentOwnerChannel) returns ChannelSection|error

Inserts a new resource into this collection.

Parameters
  • part 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • onBehalfOfContentOwner string? (default ()) - 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.
  • onBehalfOfContentOwnerChannel string? (default ()) - 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.
Return Type

deleteChannelSection

Isolated FunctionRemote Function
function deleteChannelSection(string id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? onBehalfOfContentOwner) returns Response|error

Deletes a resource.

Parameters
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • onBehalfOfContentOwner string? (default ()) - 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.
Return Type

listChannels

Isolated FunctionRemote Function
function listChannels(string[] part, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? categoryId, string? forUsername, string? hl, string[]? id, boolean? managedByMe, int? maxResults, boolean? mine, boolean? mySubscribers, string? onBehalfOfContentOwner, string? pageToken) returns ChannelListResponse|error

Retrieves a list of resources, possibly filtered.

Parameters
  • part 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • categoryId string? (default ()) - Return the channels within the specified guide category ID.
  • forUsername string? (default ()) - Return the channel associated with a YouTube username.
  • hl string? (default ()) - 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 string[]? (default ()) - Return the channels with the specified IDs.
  • managedByMe boolean? (default ()) - Return the channels managed by the authenticated user.
  • maxResults int? (default ()) - The maxResults parameter specifies the maximum number of items that should be returned in the result set.
  • mine boolean? (default ()) - Return the ids of channels owned by the authenticated user.
  • mySubscribers boolean? (default ()) - Return the channels subscribed to the authenticated user
  • onBehalfOfContentOwner string? (default ()) - 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.
  • pageToken string? (default ()) - 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.
Return Type

updateChannel

Isolated FunctionRemote Function
function updateChannel(string[] part, Channel payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? onBehalfOfContentOwner) returns Channel|error

Updates an existing resource.

Parameters
  • part 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • onBehalfOfContentOwner string? (default ()) - 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.
Return Type

listCommentThreads

Isolated FunctionRemote Function
function listCommentThreads(string[] part, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? allThreadsRelatedToChannelId, string? channelId, string[]? id, int? maxResults, string? moderationStatus, string? 'order, string? pageToken, string? searchTerms, string? textFormat, string? videoId) returns CommentThreadListResponse|error

Retrieves a list of resources, possibly filtered.

Parameters
  • part string[] - The part parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • allThreadsRelatedToChannelId string? (default ()) - Returns the comment threads of all videos of the channel and the channel comments as well.
  • channelId string? (default ()) - Returns the comment threads for all the channel comments (ie does not include comments left on videos).
  • id string[]? (default ()) - Returns the comment threads with the given IDs for Stubby or Apiary.
  • maxResults int? (default ()) - The maxResults parameter specifies the maximum number of items that should be returned in the result set.
  • moderationStatus string? (default ()) - 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? (default ()) - 
  • pageToken string? (default ()) - 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.
  • searchTerms string? (default ()) - Limits the returned comment threads to those matching the specified key words. Not compatible with the 'id' filter.
  • textFormat string? (default ()) - The requested text format for the returned comments.
  • videoId string? (default ()) - Returns the comment threads of the specified video.
Return Type

updateCommentThread

Isolated FunctionRemote Function
function updateCommentThread(CommentThread payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string[]? part) returns CommentThread|error

Updates an existing resource.

Parameters
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • part string[]? (default ()) - 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.
Return Type

insertCommentThread

Isolated FunctionRemote Function
function insertCommentThread(string[] part, CommentThread payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns CommentThread|error

Inserts a new resource into this collection.

Parameters
  • part 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

listComments

Isolated FunctionRemote Function
function listComments(string[] part, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string[]? id, int? maxResults, string? pageToken, string? parentId, string? textFormat) returns CommentListResponse|error

Retrieves a list of resources, possibly filtered.

Parameters
  • part string[] - The part parameter specifies a comma-separated list of one or more comment resource properties that the API response will include.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • id string[]? (default ()) - Returns the comments with the given IDs for One Platform.
  • maxResults int? (default ()) - The maxResults parameter specifies the maximum number of items that should be returned in the result set.
  • pageToken string? (default ()) - 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.
  • parentId string? (default ()) - 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.
  • textFormat string? (default ()) - The requested text format for the returned comments.
Return Type

updateComment

Isolated FunctionRemote Function
function updateComment(string[] part, Comment payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Comment|error

Updates an existing resource.

Parameters
  • part 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

insertComment

Isolated FunctionRemote Function
function insertComment(string[] part, Comment payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Comment|error

Inserts a new resource into this collection.

Parameters
  • part 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

deleteComment

Isolated FunctionRemote Function
function deleteComment(string id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

Deletes a resource.

Parameters
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

markCommentsAsSpam

Isolated FunctionRemote Function
function markCommentsAsSpam(string[] id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

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

Parameters
  • id string[] - Flags the comments with the given IDs as spam in the caller's opinion.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

setmoderationstatusComments

Isolated FunctionRemote Function
function setmoderationstatusComments(string[] id, string moderationStatus, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, boolean? banAuthor) returns Response|error

Sets the moderation status of one or more comments.

Parameters
  • id string[] - Modifies the moderation status of the comments with the given IDs
  • moderationStatus 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: MODERATION_STATUS_PUBLISHED, MODERATION_STATUS_HELD_FOR_REVIEW, MODERATION_STATUS_REJECTED.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • banAuthor boolean? (default ()) - 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.
Return Type

listPlaylistItems

Isolated FunctionRemote Function
function listPlaylistItems(string[] part, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string[]? id, int? maxResults, string? onBehalfOfContentOwner, string? pageToken, string? playlistId, string? videoId) returns PlaylistItemListResponse|error

Retrieves a list of resources, possibly filtered.

Parameters
  • part 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • maxResults int? (default ()) - The maxResults parameter specifies the maximum number of items that should be returned in the result set.
  • onBehalfOfContentOwner string? (default ()) - 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.
  • pageToken string? (default ()) - 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.
  • playlistId string? (default ()) - Return the playlist items within the given playlist.
  • videoId string? (default ()) - Return the playlist items associated with the given video ID.
Return Type

updateplaylistItem

Isolated FunctionRemote Function
function updateplaylistItem(string[] part, PlaylistItem payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? onBehalfOfContentOwner) returns PlaylistItem|error

Updates an existing resource.

Parameters
  • part 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • onBehalfOfContentOwner string? (default ()) - 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.
Return Type

insertPlaylistItem

Isolated FunctionRemote Function
function insertPlaylistItem(string[] part, PlaylistItem payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? onBehalfOfContentOwner) returns PlaylistItem|error

Inserts a new resource into this collection.

Parameters
  • part 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • onBehalfOfContentOwner string? (default ()) - 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.
Return Type

deletePlaylistitems

Isolated FunctionRemote Function
function deletePlaylistitems(string id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? onBehalfOfContentOwner) returns Response|error

Deletes a resource.

Parameters
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • onBehalfOfContentOwner string? (default ()) - 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.
Return Type

listPlaylists

Isolated FunctionRemote Function
function listPlaylists(string[] part, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? channelId, string? hl, string[]? id, int? maxResults, boolean? mine, string? onBehalfOfContentOwner, string? onBehalfOfContentOwnerChannel, string? pageToken) returns PlaylistListResponse|error

Retrieves a list of resources, possibly filtered.

Parameters
  • part 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • channelId string? (default ()) - Return the playlists owned by the specified channel ID.
  • hl string? (default ()) - Returen content in specified language
  • id string[]? (default ()) - Return the playlists with the given IDs for Stubby or Apiary.
  • maxResults int? (default ()) - The maxResults parameter specifies the maximum number of items that should be returned in the result set.
  • mine boolean? (default ()) - Return the playlists owned by the authenticated user.
  • onBehalfOfContentOwner string? (default ()) - 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.
  • onBehalfOfContentOwnerChannel string? (default ()) - 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.
  • pageToken string? (default ()) - 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.
Return Type

updatePlaylist

Isolated FunctionRemote Function
function updatePlaylist(string[] part, Playlist payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? onBehalfOfContentOwner) returns Playlist|error

Updates an existing resource.

Parameters
  • part 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • onBehalfOfContentOwner string? (default ()) - 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.
Return Type

insertPlaylist

Isolated FunctionRemote Function
function insertPlaylist(string[] part, Playlist payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? onBehalfOfContentOwner, string? onBehalfOfContentOwnerChannel) returns Playlist|error

Inserts a new resource into this collection.

Parameters
  • part 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • onBehalfOfContentOwner string? (default ()) - 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.
  • onBehalfOfContentOwnerChannel string? (default ()) - 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.
Return Type

playlistsDelete

Isolated FunctionRemote Function
function playlistsDelete(string id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? onBehalfOfContentOwner) returns Response|error

Deletes a resource.

Parameters
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • onBehalfOfContentOwner string? (default ()) - 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.
Return Type

listSearch

Isolated FunctionRemote Function
function listSearch(string[] part, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? channelId, string? channelType, string? eventType, boolean? forContentOwner, boolean? forDeveloper, boolean? forMine, string? location, string? locationRadius, int? maxResults, string? onBehalfOfContentOwner, string? 'order, string? pageToken, string? publishedAfter, string? publishedBefore, string? q, string? regionCode, string? relatedToVideoId, string? relevanceLanguage, string? safeSearch, string? topicId, string[]? 'type, string? videoCaption, string? videoCategoryId, string? videoDefinition, string? videoDimension, string? videoDuration, string? videoEmbeddable, string? videoLicense, string? videoSyndicated, string? videoType) returns SearchListResponse|error

Retrieves a list of search resources

Parameters
  • part 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • channelId string? (default ()) - Filter on resources belonging to this channelId.
  • channelType string? (default ()) - Add a filter on the channel search.
  • eventType string? (default ()) - Filter on the livestream status of the videos.
  • forContentOwner boolean? (default ()) - Search owned by a content owner.
  • forDeveloper boolean? (default ()) - Restrict the search to only retrieve videos uploaded using the project id of the authenticated user.
  • forMine boolean? (default ()) - Search for the private videos of the authenticated user.
  • location string? (default ()) - Filter on location of the video
  • locationRadius string? (default ()) - Filter on distance from the location (specified above).
  • maxResults int? (default ()) - The maxResults parameter specifies the maximum number of items that should be returned in the result set.
  • onBehalfOfContentOwner string? (default ()) - 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? (default ()) - Sort order of the results.
  • pageToken string? (default ()) - 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.
  • publishedAfter string? (default ()) - Filter on resources published after this date.
  • publishedBefore string? (default ()) - Filter on resources published before this date.
  • q string? (default ()) - Textual search terms to match.
  • regionCode string? (default ()) - Display the content as seen by viewers in this country.
  • relatedToVideoId string? (default ()) - Search related to a resource.
  • relevanceLanguage string? (default ()) - Return results relevant to this language.
  • safeSearch string? (default ()) - Indicates whether the search results should include restricted content as well as standard content.
  • topicId string? (default ()) - Restrict results to a particular topic.
  • 'type string[]? (default ()) - Restrict results to a particular set of resource types from One Platform.
  • videoCaption string? (default ()) - Filter on the presence of captions on the videos.
  • videoCategoryId string? (default ()) - Filter on videos in a specific category.
  • videoDefinition string? (default ()) - Filter on the definition of the videos.
  • videoDimension string? (default ()) - Filter on 3d videos.
  • videoDuration string? (default ()) - Filter on the duration of the videos.
  • videoEmbeddable string? (default ()) - Filter on embeddable videos.
  • videoLicense string? (default ()) - Filter on the license of the videos.
  • videoSyndicated string? (default ()) - Filter on syndicated videos.
  • videoType string? (default ()) - Filter on videos of a specific type.
Return Type

listSubscriptions

Isolated FunctionRemote Function
function listSubscriptions(string[] part, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? channelId, string? forChannelId, string[]? id, int? maxResults, boolean? mine, boolean? myRecentSubscribers, boolean? mySubscribers, string? onBehalfOfContentOwner, string? onBehalfOfContentOwnerChannel, string? 'order, string? pageToken) returns SubscriptionListResponse|error

Retrieves a list of resources, possibly filtered.

Parameters
  • part 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • channelId string? (default ()) - Return the subscriptions of the given channel owner.
  • forChannelId string? (default ()) - Return the subscriptions to the subset of these channels that the authenticated user is subscribed to.
  • id string[]? (default ()) - Return the subscriptions with the given IDs for Stubby or Apiary.
  • maxResults int? (default ()) - The maxResults parameter specifies the maximum number of items that should be returned in the result set.
  • mine boolean? (default ()) - Flag for returning the subscriptions of the authenticated user.
  • myRecentSubscribers boolean? (default ()) - 
  • mySubscribers boolean? (default ()) - Return the subscribers of the given channel owner.
  • onBehalfOfContentOwner string? (default ()) - 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.
  • onBehalfOfContentOwnerChannel string? (default ()) - 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? (default ()) - The order of the returned subscriptions
  • pageToken string? (default ()) - 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.
Return Type

insertSubscription

Isolated FunctionRemote Function
function insertSubscription(string[] part, Subscription payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Subscription|error

Inserts a new resource into this collection.

Parameters
  • part 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

deleteSubscription

Isolated FunctionRemote Function
function deleteSubscription(string id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

Deletes a resource.

Parameters
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

setThubnail

Isolated FunctionRemote Function
function setThubnail(string videoId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? onBehalfOfContentOwner) returns ThumbnailSetResponse|error

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
  • videoId string - Returns the Thumbnail with the given video IDs for Stubby or Apiary.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • onBehalfOfContentOwner string? (default ()) - 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.
Return Type

listVideoAbuseReportReasons

Isolated FunctionRemote Function
function listVideoAbuseReportReasons(string[] part, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? hl) returns VideoAbuseReportReasonListResponse|error

Retrieves a list of resources, possibly filtered.

Parameters
  • part string[] - The part parameter specifies the videoCategory resource parts that the API response will include. Supported values are id and snippet.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

listVideoCategories

Isolated FunctionRemote Function
function listVideoCategories(string[] part, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? hl, string[]? id, string? regionCode) returns VideoCategoryListResponse|error

Retrieves a list of resources, possibly filtered.

Parameters
  • part string[] - The part parameter specifies the videoCategory resource properties that the API response will include. Set the parameter value to snippet.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • id string[]? (default ()) - Returns the video categories with the given IDs for Stubby or Apiary.
  • regionCode string? (default ()) - 
Return Type

listVideos

Isolated FunctionRemote Function
function listVideos(string[] part, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? chart, string? hl, string[]? id, string? locale, int? maxHeight, int? maxResults, int? maxWidth, string? myRating, string? onBehalfOfContentOwner, string? pageToken, string? regionCode, string? videoCategoryId) returns VideoListResponse|error

Retrieves a list of resources, possibly filtered.

Parameters
  • part 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • chart string? (default ()) - Return the videos that are in the specified chart.
  • hl string? (default ()) - 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 string[]? (default ()) - Return videos with the given ids.
  • locale string? (default ()) - 
  • maxHeight int? (default ()) - 
  • maxResults int? (default ()) - 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.
  • maxWidth int? (default ()) - Return the player with maximum height specified in
  • myRating string? (default ()) - Return videos liked/disliked by the authenticated user. Does not support RateType.RATED_TYPE_NONE.
  • onBehalfOfContentOwner string? (default ()) - 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.
  • pageToken string? (default ()) - 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.
  • regionCode string? (default ()) - Use a chart that is specific to the specified region
  • videoCategoryId string? (default ()) - Use chart that is specific to the specified video category
Return Type

updateVideo

Isolated FunctionRemote Function
function updateVideo(string[] part, Video payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? onBehalfOfContentOwner) returns Video|error

Updates an existing resource.

Parameters
  • part 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • onBehalfOfContentOwner string? (default ()) - 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.
Return Type

insertVideo

Isolated FunctionRemote Function
function insertVideo(string[] part, Video payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, boolean? autoLevels, boolean? notifySubscribers, string? onBehalfOfContentOwner, string? onBehalfOfContentOwnerChannel, boolean? stabilize) returns Video|error

Inserts a new resource into this collection.

Parameters
  • part 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • autoLevels boolean? (default ()) - Should auto-levels be applied to the upload.
  • notifySubscribers boolean? (default ()) - Notify the channel subscribers about the new video. As default, the notification is enabled.
  • onBehalfOfContentOwner string? (default ()) - 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.
  • onBehalfOfContentOwnerChannel string? (default ()) - 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? (default ()) - Should stabilize be applied to the upload.
Return Type

deleteVideo

Isolated FunctionRemote Function
function deleteVideo(string id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? onBehalfOfContentOwner) returns Response|error

Deletes a resource.

Parameters
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • onBehalfOfContentOwner string? (default ()) - 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.
Return Type

getVideoRating

Isolated FunctionRemote Function
function getVideoRating(string[] id, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? onBehalfOfContentOwner) returns VideoGetRatingResponse|error

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

Parameters
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • onBehalfOfContentOwner string? (default ()) - 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.
Return Type

rateVideo

Isolated FunctionRemote Function
function rateVideo(string id, string rating, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

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

Parameters
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

reportAbuseVideo

Isolated FunctionRemote Function
function reportAbuseVideo(VideoAbuseReport payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? onBehalfOfContentOwner) returns Response|error

Report abuse for a video.

Parameters
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • onBehalfOfContentOwner string? (default ()) - 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.
Return Type

setWatermark

Isolated FunctionRemote Function
function setWatermark(string channelId, InvideoBranding payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? onBehalfOfContentOwner) returns Response|error

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

Parameters
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • onBehalfOfContentOwner string? (default ()) - 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.
Return Type

unsetWatermark

Isolated FunctionRemote Function
function unsetWatermark(string channelId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? onBehalfOfContentOwner) returns Response|error

Allows removal of channel watermark.

Parameters
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • onBehalfOfContentOwner string? (default ()) - 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.
Return Type

Records

googleapis.youtube.data: AbuseReport

Fields

googleapis.youtube.data: AbuseType

Fields

googleapis.youtube.data: AccessPolicy

Rights management policy for YouTube resources.

Fields
  • allowed? boolean - The value of allowed indicates whether the access to the policy is allowed or denied by default.
  • exception? string[] - A list of region codes that identify countries where the default policy do not apply.

googleapis.youtube.data: Caption

A caption resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.

Fields
  • etag? string - Etag of this resource.
  • id? string - The ID that YouTube uses to uniquely identify the caption track.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
  • snippet? CaptionSnippet - Basic details about a caption track, such as its language and name.

googleapis.youtube.data: CaptionListResponse

Fields
  • etag? string - Etag of this resource.
  • eventId? string - Serialized EventId of the request which produced this response.
  • items? Caption[] - A list of captions that match the request criteria.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#captionListResponse".
  • visitorId? string - The visitorId identifies the visitor.

googleapis.youtube.data: CaptionSnippet

Basic details about a caption track, such as its language and name.

Fields
  • audioTrackType? string - The type of audio track associated with the caption track.
  • failureReason? string - The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
  • isAutoSynced? boolean - Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.
  • isCC? boolean - Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
  • isDraft? boolean - Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false. @mutable youtube.captions.insert youtube.captions.update
  • isEasyReader? boolean - Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
  • isLarge? boolean - Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
  • language? string - The language of the caption track. The property value is a BCP-47 language tag.
  • lastUpdated? string - The date and time when the caption track was last updated.
  • name? string - The name of the caption track. The name is intended to be visible to the user as an option during playback.
  • status? string - The caption track's status.
  • trackKind? string - The caption track's type.
  • videoId? string - The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert

googleapis.youtube.data: Channel

A channel resource contains information about a YouTube channel.

Fields
  • auditDetails? ChannelAuditDetails - The auditDetails object encapsulates channel data that is relevant for YouTube Partners during the audit process.
  • contentOwnerDetails? ChannelContentOwnerDetails - The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel.
  • conversionPings? ChannelConversionPings - The conversionPings object encapsulates information about conversion pings that need to be respected by the channel.
  • etag? string - Etag of this resource.
  • id? string - The ID that YouTube uses to uniquely identify the channel.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#channel".
  • localizations? record {} - Localizations for different languages
  • snippet? ChannelSnippet - Basic details about a channel, including title, description and thumbnails.
  • statistics? ChannelStatistics - Statistics about a channel: number of subscribers, number of videos in the channel, etc.
  • status? ChannelStatus - JSON template for the status part of a channel.

googleapis.youtube.data: ChannelAuditDetails

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

Fields
  • communityGuidelinesGoodStanding? boolean - Whether or not the channel respects the community guidelines.
  • contentIdClaimsGoodStanding? boolean - Whether or not the channel has any unresolved claims.
  • copyrightStrikesGoodStanding? boolean - Whether or not the channel has any copyright strikes.

googleapis.youtube.data: ChannelBannerResource

A channel banner returned as the response to a channel_banner.insert call.

Fields
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#channelBannerResource".
  • url? string - The URL of this banner image.

googleapis.youtube.data: ChannelBrandingSettings

Branding properties of a YouTube channel.

Fields
  • hints? PropertyValue[] - Additional experimental branding properties.
  • image? ImageSettings - Branding properties for images associated with the channel.
  • watch? WatchSettings - Branding properties for the watch. All deprecated.

googleapis.youtube.data: ChannelContentDetails

Details about the content of a channel.

Fields

googleapis.youtube.data: ChannelcontentdetailsRelatedplaylists

Fields
  • favorites? string - The ID of the playlist that contains the channel"s favorite videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
  • likes? string - The ID of the playlist that contains the channel"s liked videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
  • uploads? string - The ID of the playlist that contains the channel"s uploaded videos. Use the videos.insert method to upload new videos and the videos.delete method to delete previously uploaded videos.
  • watchHistory? string - The ID of the playlist that contains the channel"s watch history. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
  • watchLater? string - The ID of the playlist that contains the channel"s watch later playlist. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.

googleapis.youtube.data: ChannelContentOwnerDetails

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

Fields
  • contentOwner? string - The ID of the content owner linked to the channel.
  • timeLinked? string - The date and time when the channel was linked to the content owner.

googleapis.youtube.data: ChannelConversionPing

Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.

Fields
  • context? string - Defines the context of the ping.
  • conversionUrl? string - The url (without the schema) that the player shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping.

googleapis.youtube.data: ChannelConversionPings

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

Fields
  • pings? ChannelConversionPing[] - Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.

googleapis.youtube.data: ChannelListResponse

Fields
  • etag? string - Etag of this resource.
  • eventId? string - Serialized EventId of the request which produced this response.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#channelListResponse".
  • nextPageToken? string - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
  • pageInfo? PageInfo - Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
  • prevPageToken? string - The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
  • tokenPagination? TokenPagination - Stub token pagination template to suppress results.
  • visitorId? string - The visitorId identifies the visitor.

googleapis.youtube.data: ChannelLocalization

Channel localization setting

Fields
  • description? string - The localized strings for channel's description.
  • title? string - The localized strings for channel's title.

googleapis.youtube.data: ChannelSection

Fields
  • etag? string - Etag of this resource.
  • id? string - The ID that YouTube uses to uniquely identify the channel section.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".
  • localizations? record {} - Localizations for different languages
  • snippet? ChannelSectionSnippet - Basic details about a channel section, including title, style and position.

googleapis.youtube.data: ChannelSectionContentDetails

Details about a channelsection, including playlists and channels.

Fields
  • channels? string[] - The channel ids for type multiple_channels.
  • playlists? string[] - The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.

googleapis.youtube.data: ChannelSectionListResponse

Fields
  • etag? string - Etag of this resource.
  • eventId? string - Serialized EventId of the request which produced this response.
  • items? ChannelSection[] - A list of ChannelSections that match the request criteria.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#channelSectionListResponse".
  • visitorId? string - The visitorId identifies the visitor.

googleapis.youtube.data: ChannelSectionLocalization

ChannelSection localization setting

Fields
  • title? string - The localized strings for channel section's title.

googleapis.youtube.data: ChannelSectionSnippet

Basic details about a channel section, including title, style and position.

Fields
  • channelId? string - The ID that YouTube uses to uniquely identify the channel that published the channel section.
  • defaultLanguage? string - The language of the channel section's default title and description.
  • position? int - The position of the channel section in the channel.
  • style? string - The style of the channel section.
  • title? string - The channel section's title for multiple_playlists and multiple_channels.
  • 'type? string - The type of the channel section.

googleapis.youtube.data: ChannelSectionTargeting

ChannelSection targeting setting.

Fields
  • countries? string[] - The country the channel section is targeting.
  • languages? string[] - The language the channel section is targeting.
  • regions? string[] - The region the channel section is targeting.

googleapis.youtube.data: ChannelSettings

Branding properties for the channel view.

Fields
  • country? string - The country of the channel.
  • defaultTab? string - Which content tab users should see when viewing the channel.
  • description? string - Specifies the channel description.
  • featuredChannelsTitle? string - Title for the featured channels tab.
  • featuredChannelsUrls? string[] - The list of featured channels.
  • keywords? string - Lists keywords associated with the channel, comma-separated.
  • moderateComments? boolean - Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible.
  • profileColor? string - A prominent color that can be rendered on this channel page.
  • showBrowseView? boolean - Whether the tab to browse the videos should be displayed.
  • showRelatedChannels? boolean - Whether related channels should be proposed.
  • title? string - Specifies the channel title.
  • trackingAnalyticsAccountId? string - The ID for a Google Analytics account to track and measure traffic to the channels.
  • unsubscribedTrailer? string - The trailer of the channel, for users that are not subscribers.

googleapis.youtube.data: ChannelSnippet

Basic details about a channel, including title, description and thumbnails.

Fields
  • country? string - The country of the channel.
  • customUrl? string - The custom url of the channel.
  • defaultLanguage? string - The language of the channel's default title and description.
  • description? string - The description of the channel.
  • publishedAt? string - The date and time that the channel was created.
  • thumbnails? ThumbnailDetails - Internal representation of thumbnails for a YouTube resource.
  • title? string - The channel's title.

googleapis.youtube.data: ChannelStatistics

Statistics about a channel: number of subscribers, number of videos in the channel, etc.

Fields
  • commentCount? string - The number of comments for the channel.
  • hiddenSubscriberCount? boolean - Whether or not the number of subscribers is shown for this user.
  • subscriberCount? string - The number of subscribers that the channel has.
  • videoCount? string - The number of videos uploaded to the channel.
  • viewCount? string - The number of times the channel has been viewed.

googleapis.youtube.data: ChannelStatus

JSON template for the status part of a channel.

Fields
  • isLinked? boolean - If true, then the user is linked to either a YouTube username or G+ account. Otherwise, the user doesn't have a public YouTube identity.
  • longUploadsStatus? string - The long uploads status of this channel. See https://support.google.com/youtube/answer/71673 for more information.
  • privacyStatus? string - Privacy status of the channel.
  • selfDeclaredMadeForKids? boolean -

googleapis.youtube.data: ChannelTopicDetails

Freebase topic information related to the channel.

Fields
  • topicCategories? string[] - A list of Wikipedia URLs that describe the channel's content.
  • topicIds? string[] - A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API.

googleapis.youtube.data: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

googleapis.youtube.data: Comment

A comment represents a single YouTube comment.

Fields
  • etag? string - Etag of this resource.
  • id? string - The ID that YouTube uses to uniquely identify the comment.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
  • snippet? CommentSnippet - Basic details about a comment, such as its author and text.

googleapis.youtube.data: CommentListResponse

Fields
  • etag? string - Etag of this resource.
  • eventId? string - Serialized EventId of the request which produced this response.
  • items? Comment[] - A list of comments that match the request criteria.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#commentListResponse".
  • nextPageToken? string - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
  • pageInfo? PageInfo - Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
  • tokenPagination? TokenPagination - Stub token pagination template to suppress results.
  • visitorId? string - The visitorId identifies the visitor.

googleapis.youtube.data: CommentSnippet

Basic details about a comment, such as its author and text.

Fields
  • authorChannelUrl? string - Link to the author's YouTube channel, if any.
  • authorDisplayName? string - The name of the user who posted the comment.
  • authorProfileImageUrl? string - The URL for the avatar of the user who posted the comment.
  • canRate? boolean - Whether the current viewer can rate this comment.
  • channelId? string - The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
  • likeCount? int - The total number of likes this comment has received.
  • moderationStatus? string - The comment's moderation status. Will not be set if the comments were requested through the id filter.
  • parentId? string - The unique id of the parent comment, only set for replies.
  • publishedAt? string - The date and time when the comment was originally published.
  • textDisplay? string - The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
  • textOriginal? string - The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
  • updatedAt? string - The date and time when the comment was last updated.
  • videoId? string - The ID of the video the comment refers to, if any.
  • viewerRating? string - The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.

googleapis.youtube.data: CommentSnippetAuthorChannelId

The id of the author's YouTube channel, if any.

Fields

googleapis.youtube.data: CommentThread

A comment thread represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.

Fields
  • etag? string - Etag of this resource.
  • id? string - The ID that YouTube uses to uniquely identify the comment thread.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".
  • replies? CommentThreadReplies - Comments written in (direct or indirect) reply to the top level comment.

googleapis.youtube.data: CommentThreadListResponse

Fields
  • etag? string - Etag of this resource.
  • eventId? string - Serialized EventId of the request which produced this response.
  • items? CommentThread[] - A list of comment threads that match the request criteria.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#commentThreadListResponse".
  • nextPageToken? string - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
  • pageInfo? PageInfo - Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
  • tokenPagination? TokenPagination - Stub token pagination template to suppress results.
  • visitorId? string - The visitorId identifies the visitor.

googleapis.youtube.data: CommentThreadReplies

Comments written in (direct or indirect) reply to the top level comment.

Fields
  • comments? Comment[] - A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.

googleapis.youtube.data: CommentThreadSnippet

Basic details about a comment thread.

Fields
  • canReply? boolean - Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
  • channelId? string - The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself.
  • isPublic? boolean - Whether the thread (and therefore all its comments) is visible to all YouTube users.
  • topLevelComment? Comment - A comment represents a single YouTube comment.
  • totalReplyCount? int - The total number of replies (not including the top level comment).
  • videoId? string - The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.

googleapis.youtube.data: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache? CacheConfig - HTTP caching related configurations
  • compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header
  • circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
  • retryConfig? RetryConfig - Configurations associated with retrying
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

googleapis.youtube.data: ContentRating

Ratings schemes. The country-specific ratings are mostly for movies and shows. LINT.IfChange

Fields
  • acbRating? string - The video's Australian Classification Board (ACB) or Australian Communications and Media Authority (ACMA) rating. ACMA ratings are used to classify children's television programming.
  • agcomRating? string - The video's rating from Italy's Autorità per le Garanzie nelle Comunicazioni (AGCOM).
  • anatelRating? string - The video's Anatel (Asociación Nacional de Televisión) rating for Chilean television.
  • bbfcRating? string - The video's British Board of Film Classification (BBFC) rating.
  • bfvcRating? string - The video's rating from Thailand's Board of Film and Video Censors.
  • bmukkRating? string - The video's rating from the Austrian Board of Media Classification (Bundesministerium für Unterricht, Kunst und Kultur).
  • catvRating? string - Rating system for Canadian TV - Canadian TV Classification System The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian English-language broadcasts. For more information, see the Canadian Broadcast Standards Council website.
  • catvfrRating? string - The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian French-language broadcasts. For more information, see the Canadian Broadcast Standards Council website.
  • cbfcRating? string - The video's Central Board of Film Certification (CBFC - India) rating.
  • cccRating? string - The video's Consejo de Calificación Cinematográfica (Chile) rating.
  • cceRating? string - The video's rating from Portugal's Comissão de Classificação de Espect´culos.
  • chfilmRating? string - The video's rating in Switzerland.
  • chvrsRating? string - The video's Canadian Home Video Rating System (CHVRS) rating.
  • cicfRating? string - The video's rating from the Commission de Contrôle des Films (Belgium).
  • cnaRating? string - The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI (CNA).
  • cncRating? string - Rating system in France - Commission de classification cinematographique
  • csaRating? string - The video's rating from France's Conseil supérieur de l’audiovisuel, which rates broadcast content.
  • cscfRating? string - The video's rating from Luxembourg's Commission de surveillance de la classification des films (CSCF).
  • czfilmRating? string - The video's rating in the Czech Republic.
  • djctqRating? string - The video's Departamento de Justiça, Classificação, Qualificação e Títulos (DJCQT - Brazil) rating.
  • djctqRatingReasons? string[] - Reasons that explain why the video received its DJCQT (Brazil) rating.
  • ecbmctRating? string - Rating system in Turkey - Evaluation and Classification Board of the Ministry of Culture and Tourism
  • eefilmRating? string - The video's rating in Estonia.
  • egfilmRating? string - The video's rating in Egypt.
  • eirinRating? string - The video's Eirin (映倫) rating. Eirin is the Japanese rating system.
  • fcbmRating? string - The video's rating from Malaysia's Film Censorship Board.
  • fcoRating? string - The video's rating from Hong Kong's Office for Film, Newspaper and Article Administration.
  • fmocRating? string - This property has been deprecated. Use the contentDetails.contentRating.cncRating instead.
  • fpbRating? string - The video's rating from South Africa's Film and Publication Board.
  • fpbRatingReasons? string[] - Reasons that explain why the video received its FPB (South Africa) rating.
  • fskRating? string - The video's Freiwillige Selbstkontrolle der Filmwirtschaft (FSK - Germany) rating.
  • grfilmRating? string - The video's rating in Greece.
  • icaaRating? string - The video's Instituto de la Cinematografía y de las Artes Audiovisuales (ICAA - Spain) rating.
  • ifcoRating? string - The video's Irish Film Classification Office (IFCO - Ireland) rating. See the IFCO website for more information.
  • ilfilmRating? string - The video's rating in Israel.
  • incaaRating? string - The video's INCAA (Instituto Nacional de Cine y Artes Audiovisuales - Argentina) rating.
  • kfcbRating? string - The video's rating from the Kenya Film Classification Board.
  • kijkwijzerRating? string - The video's NICAM/Kijkwijzer rating from the Nederlands Instituut voor de Classificatie van Audiovisuele Media (Netherlands).
  • kmrbRating? string - The video's Korea Media Rating Board (영상물등급위원회) rating. The KMRB rates videos in South Korea.
  • lsfRating? string - The video's rating from Indonesia's Lembaga Sensor Film.
  • mccaaRating? string - The video's rating from Malta's Film Age-Classification Board.
  • mccypRating? string - The video's rating from the Danish Film Institute's (Det Danske Filminstitut) Media Council for Children and Young People.
  • mcstRating? string - The video's rating system for Vietnam - MCST
  • mdaRating? string - The video's rating from Singapore's Media Development Authority (MDA) and, specifically, it's Board of Film Censors (BFC).
  • medietilsynetRating? string - The video's rating from Medietilsynet, the Norwegian Media Authority.
  • mekuRating? string - The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti (National Audiovisual Institute).
  • menaMpaaRating? string - The rating system for MENA countries, a clone of MPAA. It is needed to prevent titles go live w/o additional QC check, since some of them can be inappropriate for the countries at all. See b/33408548 for more details.
  • mibacRating? string - The video's rating from the Ministero dei Beni e delle Attività Culturali e del Turismo (Italy).
  • mocRating? string - The video's Ministerio de Cultura (Colombia) rating.
  • moctwRating? string - The video's rating from Taiwan's Ministry of Culture (文化部).
  • mpaaRating? string - The video's Motion Picture Association of America (MPAA) rating.
  • mpaatRating? string - The rating system for trailer, DVD, and Ad in the US. See http://movielabs.com/md/ratings/v2.3/html/US_MPAAT_Ratings.html.
  • mtrcbRating? string - The video's rating from the Movie and Television Review and Classification Board (Philippines).
  • nbcRating? string - The video's rating from the Maldives National Bureau of Classification.
  • nbcplRating? string - The video's rating in Poland.
  • nfrcRating? string - The video's rating from the Bulgarian National Film Center.
  • nfvcbRating? string - The video's rating from Nigeria's National Film and Video Censors Board.
  • nkclvRating? string - The video's rating from the Nacionãlais Kino centrs (National Film Centre of Latvia).
  • nmcRating? string - The National Media Council ratings system for United Arab Emirates.
  • oflcRating? string - The video's Office of Film and Literature Classification (OFLC - New Zealand) rating.
  • pefilmRating? string - The video's rating in Peru.
  • rcnofRating? string - The video's rating from the Hungarian Nemzeti Filmiroda, the Rating Committee of the National Office of Film.
  • resorteviolenciaRating? string - The video's rating in Venezuela.
  • rtcRating? string - The video's General Directorate of Radio, Television and Cinematography (Mexico) rating.
  • rteRating? string - The video's rating from Ireland's Raidió Teilifís Éireann.
  • russiaRating? string - The video's National Film Registry of the Russian Federation (MKRF - Russia) rating.
  • skfilmRating? string - The video's rating in Slovakia.
  • smaisRating? string - The video's rating in Iceland.
  • smsaRating? string - The video's rating from Statens medieråd (Sweden's National Media Council).
  • tvpgRating? string - The video's TV Parental Guidelines (TVPG) rating.
  • ytRating? string - A rating that YouTube uses to identify age-restricted content.

googleapis.youtube.data: Entity

Fields

googleapis.youtube.data: GeoPoint

Geographical coordinates of a point, in WGS84.

Fields
  • altitude? float - Altitude above the reference ellipsoid, in meters.
  • latitude? float - Latitude in degrees.
  • longitude? float - Longitude in degrees.

googleapis.youtube.data: ImageSettings

Branding properties for images associated with the channel.

Fields
  • bannerExternalUrl? string - This is generated when a ChannelBanner.Insert request has succeeded for the given channel.
  • bannerImageUrl? string - Banner image. Desktop size (1060x175).
  • bannerMobileExtraHdImageUrl? string - Banner image. Mobile size high resolution (1440x395).
  • bannerMobileHdImageUrl? string - Banner image. Mobile size high resolution (1280x360).
  • bannerMobileImageUrl? string - Banner image. Mobile size (640x175).
  • bannerMobileLowImageUrl? string - Banner image. Mobile size low resolution (320x88).
  • bannerMobileMediumHdImageUrl? string - Banner image. Mobile size medium/high resolution (960x263).
  • bannerTabletExtraHdImageUrl? string - Banner image. Tablet size extra high resolution (2560x424).
  • bannerTabletHdImageUrl? string - Banner image. Tablet size high resolution (2276x377).
  • bannerTabletImageUrl? string - Banner image. Tablet size (1707x283).
  • bannerTabletLowImageUrl? string - Banner image. Tablet size low resolution (1138x188).
  • bannerTvHighImageUrl? string - Banner image. TV size high resolution (1920x1080).
  • bannerTvImageUrl? string - Banner image. TV size extra high resolution (2120x1192).
  • bannerTvLowImageUrl? string - Banner image. TV size low resolution (854x480).
  • bannerTvMediumImageUrl? string - Banner image. TV size medium resolution (1280x720).
  • trackingImageUrl? string - The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages.

googleapis.youtube.data: InvideoBranding

LINT.IfChange Describes an invideo branding.

Fields
  • imageBytes? string - The bytes the uploaded image. Only used in api to youtube communication.
  • imageUrl? string - The url of the uploaded image. Only used in apiary to api communication.
  • position? InvideoPosition - Describes the spatial position of a visual widget inside a video. It is a union of various position types, out of which only will be set one.
  • targetChannelId? string - The channel to which this branding links. If not present it defaults to the current channel.
  • timing? InvideoTiming - Describes a temporal position of a visual widget inside a video.

googleapis.youtube.data: InvideoPosition

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

Fields
  • cornerPosition? string - Describes in which corner of the video the visual widget will appear.
  • 'type? string - Defines the position type.

googleapis.youtube.data: InvideoTiming

Describes a temporal position of a visual widget inside a video.

Fields
  • durationMs? string - Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.
  • offsetMs? string - Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds.
  • 'type? string - Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video.

googleapis.youtube.data: LanguageTag

Fields

googleapis.youtube.data: LocalizedProperty

Fields

googleapis.youtube.data: LocalizedString

Fields

googleapis.youtube.data: OAuth2RefreshTokenGrantConfig

Closed record

OAuth2 Refresh Token Grant Configs

Fields
  • refreshUrl string(default "https://accounts.google.com/o/oauth2/token") - Refresh URL

googleapis.youtube.data: PageInfo

Paging details for lists of resources, including total number of items available and number of resources returned in a single page.

Fields
  • resultsPerPage? int - The number of results included in the API response.
  • totalResults? int - The total number of results in the result set.

googleapis.youtube.data: Playlist

A playlist resource represents a YouTube playlist. A playlist is a collection of videos that can be viewed sequentially and shared with other users. A playlist can contain up to 200 videos, and YouTube does not limit the number of playlists that each user creates. By default, playlists are publicly visible to other users, but playlists can be public or private. YouTube also uses playlists to identify special collections of videos for a channel, such as: - uploaded videos - favorite videos - positively rated (liked) videos - watch history - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods.

Fields
  • etag? string - Etag of this resource.
  • id? string - The ID that YouTube uses to uniquely identify the playlist.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#playlist".
  • localizations? record {} - Localizations for different languages
  • snippet? PlaylistSnippet - Basic details about a playlist, including title, description and thumbnails.

googleapis.youtube.data: PlaylistContentDetails

Fields
  • itemCount? int - The number of videos in the playlist.

googleapis.youtube.data: PlaylistItem

A playlistItem resource identifies another resource, such as a video, that is included in a playlist. In addition, the playlistItem resource contains details about the included resource that pertain specifically to how that resource is used in that playlist. YouTube uses playlists to identify special collections of videos for a channel, such as: - uploaded videos - favorite videos - positively rated (liked) videos - watch history - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods. For example, if a user gives a positive rating to a video, you would insert that video into the liked videos playlist for that user's channel.

Fields
  • etag? string - Etag of this resource.
  • id? string - The ID that YouTube uses to uniquely identify the playlist item.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#playlistItem".
  • snippet? PlaylistItemSnippet - Basic details about a playlist, including title, description and thumbnails. Basic details of a YouTube Playlist item provided by the author. Next ID: 15

googleapis.youtube.data: PlaylistItemContentDetails

Fields
  • endAt? string - The time, measured in seconds from the start of the video, when the video should stop playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) By default, assume that the video.endTime is the end of the video.
  • note? string - A user-generated note for this item.
  • startAt? string - The time, measured in seconds from the start of the video, when the video should start playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) The default value is 0.
  • videoId? string - The ID that YouTube uses to uniquely identify a video. To retrieve the video resource, set the id query parameter to this value in your API request.
  • videoPublishedAt? string - The date and time that the video was published to YouTube.

googleapis.youtube.data: PlaylistItemListResponse

Fields
  • eventId? string - Serialized EventId of the request which produced this response.
  • items? PlaylistItem[] - A list of playlist items that match the request criteria.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#playlistItemListResponse". Etag of this resource.
  • nextPageToken? string - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
  • pageInfo? PageInfo - Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
  • prevPageToken? string - The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
  • tokenPagination? TokenPagination - Stub token pagination template to suppress results.
  • visitorId? string - The visitorId identifies the visitor.

googleapis.youtube.data: PlaylistItemSnippet

Basic details about a playlist, including title, description and thumbnails. Basic details of a YouTube Playlist item provided by the author. Next ID: 15

Fields
  • channelId? string - The ID that YouTube uses to uniquely identify the user that added the item to the playlist.
  • channelTitle? string - Channel title for the channel that the playlist item belongs to.
  • description? string - The item's description.
  • playlistId? string - The ID that YouTube uses to uniquely identify thGe playlist that the playlist item is in.
  • position? int - The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth.
  • publishedAt? string - The date and time that the item was added to the playlist.
  • resourceId? ResourceId - A resource id is a generic reference that points to another YouTube resource.
  • thumbnails? ThumbnailDetails - Internal representation of thumbnails for a YouTube resource.
  • title? string - The item's title.
  • videoOwnerChannelId? string - Channel id for the channel this video belongs to.
  • videoOwnerChannelTitle? string - Channel title for the channel this video belongs to.

googleapis.youtube.data: PlaylistItemStatus

Information about the playlist item's privacy status.

Fields
  • privacyStatus? string - This resource's privacy status.

googleapis.youtube.data: PlaylistListResponse

Fields
  • etag? string - Etag of this resource.
  • eventId? string - Serialized EventId of the request which produced this response.
  • items? Playlist[] - A list of playlists that match the request criteria
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#playlistListResponse".
  • nextPageToken? string - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
  • pageInfo? PageInfo - Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
  • prevPageToken? string - The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
  • tokenPagination? TokenPagination - Stub token pagination template to suppress results.
  • visitorId? string - The visitorId identifies the visitor.

googleapis.youtube.data: PlaylistLocalization

Playlist localization setting

Fields
  • description? string - The localized strings for playlist's description.
  • title? string - The localized strings for playlist's title.

googleapis.youtube.data: PlaylistPlayer

Fields
  • embedHtml? string - An <iframe> tag that embeds a player that will play the playlist.

googleapis.youtube.data: PlaylistSnippet

Basic details about a playlist, including title, description and thumbnails.

Fields
  • channelId? string - The ID that YouTube uses to uniquely identify the channel that published the playlist.
  • channelTitle? string - The channel title of the channel that the video belongs to.
  • defaultLanguage? string - The language of the playlist's default title and description.
  • description? string - The playlist's description.
  • publishedAt? string - The date and time that the playlist was created.
  • tags? string[] - Keyword tags associated with the playlist.
  • thumbnailVideoId? string - Note: if the playlist has a custom thumbnail, this field will not be populated. The video id selected by the user that will be used as the thumbnail of this playlist. This field defaults to the first publicly viewable video in the playlist, if: 1. The user has never selected a video to be the thumbnail of the playlist. 2. The user selects a video to be the thumbnail, and then removes that video from the playlist. 3. The user selects a non-owned video to be the thumbnail, but that video becomes private, or gets deleted.
  • thumbnails? ThumbnailDetails - Internal representation of thumbnails for a YouTube resource.
  • title? string - The playlist's title.

googleapis.youtube.data: PlaylistStatus

Fields
  • privacyStatus? string - The playlist's privacy status.

googleapis.youtube.data: PropertyValue

A pair Property / Value.

Fields
  • property? string - A property.
  • value? string - The property's value.

googleapis.youtube.data: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

googleapis.youtube.data: RelatedEntity

Fields

googleapis.youtube.data: ResourceId

A resource id is a generic reference that points to another YouTube resource.

Fields
  • channelId? string - The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
  • kind? string - The type of the API resource.
  • playlistId? string - The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
  • videoId? string - The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.

googleapis.youtube.data: SearchListResponse

Fields
  • etag? string - Etag of this resource.
  • eventId? string - Serialized EventId of the request which produced this response.
  • items? SearchResult[] - Pagination information for token pagination.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#searchListResponse".
  • nextPageToken? string - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
  • pageInfo? PageInfo - Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
  • prevPageToken? string - The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
  • tokenPagination? TokenPagination - Stub token pagination template to suppress results.
  • visitorId? string - The visitorId identifies the visitor.

googleapis.youtube.data: SearchResult

A search result contains information about a YouTube video, channel, or playlist that matches the search parameters specified in an API request. While a search result points to a uniquely identifiable resource, like a video, it does not have its own persistent data.

Fields
  • etag? string - Etag of this resource.
  • id? ResourceId - A resource id is a generic reference that points to another YouTube resource.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#searchResult".
  • snippet? SearchResultSnippet - Basic details about a search result, including title, description and thumbnails of the item referenced by the search result.

googleapis.youtube.data: SearchResultSnippet

Basic details about a search result, including title, description and thumbnails of the item referenced by the search result.

Fields
  • channelId? string - The value that YouTube uses to uniquely identify the channel that published the resource that the search result identifies.
  • channelTitle? string - The title of the channel that published the resource that the search result identifies.
  • description? string - A description of the search result.
  • liveBroadcastContent? string - It indicates if the resource (video or channel) has upcoming/active live broadcast content. Or it's "none" if there is not any upcoming/active live broadcasts.
  • publishedAt? string - The creation date and time of the resource that the search result identifies.
  • thumbnails? ThumbnailDetails - Internal representation of thumbnails for a YouTube resource.
  • title? string - The title of the search result.

googleapis.youtube.data: Subscription

A subscription resource contains information about a YouTube user subscription. A subscription notifies a user when new videos are added to a channel or when another user takes one of several actions on YouTube, such as uploading a video, rating a video, or commenting on a video.

Fields
  • etag? string - Etag of this resource.
  • id? string - The ID that YouTube uses to uniquely identify the subscription.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#subscription".
  • snippet? SubscriptionSnippet - Basic details about a subscription, including title, description and thumbnails of the subscribed item.
  • subscriberSnippet? SubscriptionSubscriberSnippet - Basic details about a subscription's subscriber including title, description, channel ID and thumbnails.

googleapis.youtube.data: SubscriptionContentDetails

Details about the content to witch a subscription refers.

Fields
  • activityType? string - The type of activity this subscription is for (only uploads, everything).
  • newItemCount? int - The number of new items in the subscription since its content was last read.
  • totalItemCount? int - The approximate number of items that the subscription points to.

googleapis.youtube.data: SubscriptionListResponse

Fields
  • etag? string - Etag of this resource.
  • eventId? string - Serialized EventId of the request which produced this response.
  • items? Subscription[] - A list of subscriptions that match the request criteria.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#subscriptionListResponse".
  • nextPageToken? string - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
  • pageInfo? PageInfo - Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
  • prevPageToken? string - The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
  • tokenPagination? TokenPagination - Stub token pagination template to suppress results.
  • visitorId? string - The visitorId identifies the visitor.

googleapis.youtube.data: SubscriptionSnippet

Basic details about a subscription, including title, description and thumbnails of the subscribed item.

Fields
  • channelId? string - The ID that YouTube uses to uniquely identify the subscriber's channel.
  • channelTitle? string - Channel title for the channel that the subscription belongs to.
  • description? string - The subscription's details.
  • publishedAt? string - The date and time that the subscription was created.
  • resourceId? ResourceId - A resource id is a generic reference that points to another YouTube resource.
  • thumbnails? ThumbnailDetails - Internal representation of thumbnails for a YouTube resource.
  • title? string - The subscription's title.

googleapis.youtube.data: SubscriptionSubscriberSnippet

Basic details about a subscription's subscriber including title, description, channel ID and thumbnails.

Fields
  • channelId? string - The channel ID of the subscriber.
  • description? string - The description of the subscriber.
  • thumbnails? ThumbnailDetails - Internal representation of thumbnails for a YouTube resource.
  • title? string - The title of the subscriber.

googleapis.youtube.data: Thumbnail

A thumbnail is an image representing a YouTube resource.

Fields
  • height? int - (Optional) Height of the thumbnail image.
  • url? string - The thumbnail image's URL.
  • width? int - (Optional) Width of the thumbnail image.

googleapis.youtube.data: ThumbnailDetails

Internal representation of thumbnails for a YouTube resource.

Fields
  • high? Thumbnail - A thumbnail is an image representing a YouTube resource.
  • maxres? Thumbnail - A thumbnail is an image representing a YouTube resource.
  • medium? Thumbnail - A thumbnail is an image representing a YouTube resource.
  • standard? Thumbnail - A thumbnail is an image representing a YouTube resource.

googleapis.youtube.data: ThumbnailSetResponse

Fields
  • etag? string - Etag of this resource.
  • eventId? string - Serialized EventId of the request which produced this response.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#thumbnailSetResponse".
  • visitorId? string - The visitorId identifies the visitor.

googleapis.youtube.data: TokenPagination

Stub token pagination template to suppress results.

googleapis.youtube.data: Video

A video resource represents a YouTube video.

Fields
  • etag? string - Etag of this resource.
  • fileDetails? VideoFileDetails - Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information.
  • id? string - The ID that YouTube uses to uniquely identify the video.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#video".
  • localizations? record {} - The localizations object contains localized versions of the basic details about the video, such as its title and description.
  • player? VideoPlayer - Player to be used for a video playback.
  • processingDetails? VideoProcessingDetails - Describes processing status and progress and availability of some other Video resource parts.
  • projectDetails? VideoProjectDetails - DEPRECATED. b/157517979: This part was never populated after it was added. However, it sees non-zero traffic because there is generated client code in the wild that refers to it [1]. We keep this field and do NOT remove it because otherwise V3 would return an error when this part gets requested [2]. [1] https://developers.google.com/resources/api-libraries/documentation/youtube/v3/csharp/latest/classGoogle_1_1Apis_1_1YouTube_1_1v3_1_1Data_1_1VideoProjectDetails.html [2] http://google3/video/youtube/src/python/servers/data_api/common.py?l=1565-1569&rcl=344141677
  • snippet? VideoSnippet - Basic details about a video, including title, description, uploader, thumbnails and category.
  • statistics? VideoStatistics - Statistics about the video, such as the number of times the video was viewed or liked.
  • status? VideoStatus - Basic details about a video category, such as its localized title. Next Id: 17
  • suggestions? VideoSuggestions - Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions.

googleapis.youtube.data: VideoAbuseReport

Fields
  • comments? string - Additional comments regarding the abuse report.
  • language? string - The language that the content was viewed in.
  • reasonId? string - The high-level, or primary, reason that the content is abusive. The value is an abuse report reason ID.
  • secondaryReasonId? string - The specific, or secondary, reason that this content is abusive (if available). The value is an abuse report reason ID that is a valid secondary reason for the primary reason.
  • videoId? string - The ID that YouTube uses to uniquely identify the video.

googleapis.youtube.data: VideoAbuseReportReason

A __videoAbuseReportReason__ resource identifies a reason that a video could be reported as abusive. Video abuse report reasons are used with video.ReportAbuse.

Fields
  • etag? string - Etag of this resource.
  • id? string - The ID of this abuse report reason.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#videoAbuseReportReason".

googleapis.youtube.data: VideoAbuseReportReasonListResponse

Fields
  • etag? string - Etag of this resource.
  • eventId? string - Serialized EventId of the request which produced this response.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#videoAbuseReportReasonListResponse".
  • visitorId? string - The visitorId identifies the visitor.

googleapis.youtube.data: VideoAbuseReportReasonSnippet

Basic details about a video category, such as its localized title.

Fields
  • label? string - The localized label belonging to this abuse report reason.

googleapis.youtube.data: VideoAbuseReportSecondaryReason

Fields
  • id? string - The ID of this abuse report secondary reason.
  • label? string - The localized label for this abuse report secondary reason.

googleapis.youtube.data: VideoAgeGating

Fields
  • alcoholContent? boolean - Indicates whether or not the video has alcoholic beverage content. Only users of legal purchasing age in a particular country, as identified by ICAP, can view the content.
  • restricted? boolean - Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present.
  • videoGameRating? string - Video game rating, if any.

googleapis.youtube.data: VideoCategory

A videoCategory resource identifies a category that has been or could be associated with uploaded videos.

Fields
  • etag? string - Etag of this resource.
  • id? string - The ID that YouTube uses to uniquely identify the video category.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#videoCategory".

googleapis.youtube.data: VideoCategoryListResponse

Fields
  • etag? string - Etag of this resource.
  • eventId? string - Serialized EventId of the request which produced this response.
  • items? VideoCategory[] - A list of video categories that can be associated with YouTube videos. In this map, the video category ID is the map key, and its value is the corresponding videoCategory resource.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#videoCategoryListResponse".
  • nextPageToken? string - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
  • pageInfo? PageInfo - Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
  • prevPageToken? string - The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
  • tokenPagination? TokenPagination - Stub token pagination template to suppress results.
  • visitorId? string - The visitorId identifies the visitor.

googleapis.youtube.data: VideoCategorySnippet

Basic details about a video category, such as its localized title.

Fields
  • channelId? string - The YouTube channel that created the video category.
  • title? string - The video category's title.

googleapis.youtube.data: VideoContentDetails

Details about the content of a YouTube Video.

Fields
  • caption? string - The value of captions indicates whether the video has captions or not.
  • contentRating? ContentRating - Ratings schemes. The country-specific ratings are mostly for movies and shows. LINT.IfChange
  • countryRestriction? AccessPolicy - Rights management policy for YouTube resources.
  • definition? string - The value of definition indicates whether the video is available in high definition or only in standard definition.
  • dimension? string - The value of dimension indicates whether the video is available in 3D or in 2D.
  • duration? string - The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.
  • hasCustomThumbnail? boolean - Indicates whether the video uploader has provided a custom thumbnail image for the video. This property is only visible to the video uploader.
  • licensedContent? boolean - The value of is_license_content indicates whether the video is licensed content.
  • projection? string - Specifies the projection format of the video.

googleapis.youtube.data: VideoContentDetailsRegionRestriction

DEPRECATED Region restriction of the video.

Fields
  • allowed? string[] - A list of region codes that identify countries where the video is viewable. If this property is present and a country is not listed in its value, then the video is blocked from appearing in that country. If this property is present and contains an empty list, the video is blocked in all countries.
  • blocked? string[] - A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries.

googleapis.youtube.data: VideoFileDetails

Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information.

Fields
  • audioStreams? VideoFileDetailsAudioStream[] - A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream.
  • bitrateBps? string - The uploaded video file's combined (video and audio) bitrate in bits per second.
  • container? string - The uploaded video file's container format.
  • creationTime? string - The date and time when the uploaded video file was created. The value is specified in ISO 8601 format. Currently, the following ISO 8601 formats are supported: - Date only: YYYY-MM-DD - Naive time: YYYY-MM-DDTHH:MM:SS - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM
  • durationMs? string - The length of the uploaded video in milliseconds.
  • fileName? string - The uploaded file's name. This field is present whether a video file or another type of file was uploaded.
  • fileSize? string - The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded.
  • fileType? string - The uploaded file's type as detected by YouTube's video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded.
  • videoStreams? VideoFileDetailsVideoStream[] - A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream.

googleapis.youtube.data: VideoFileDetailsAudioStream

Information about an audio stream.

Fields
  • bitrateBps? string - The audio stream's bitrate, in bits per second.
  • channelCount? int - The number of audio channels that the stream contains.
  • codec? string - The audio codec that the stream uses.
  • vendor? string - A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.

googleapis.youtube.data: VideoFileDetailsVideoStream

Information about a video stream.

Fields
  • aspectRatio? float - The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed.
  • bitrateBps? string - The video stream's bitrate, in bits per second.
  • codec? string - The video codec that the stream uses.
  • frameRateFps? float - The video stream's frame rate, in frames per second.
  • heightPixels? int - The encoded video content's height in pixels.
  • rotation? string - The amount that YouTube needs to rotate the original source content to properly display the video.
  • vendor? string - A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
  • widthPixels? int - The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels.

googleapis.youtube.data: VideoGetRatingResponse

Fields
  • etag? string - Etag of this resource.
  • eventId? string - Serialized EventId of the request which produced this response.
  • items? VideoRating[] - A list of ratings that match the request criteria.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#videoGetRatingResponse".
  • visitorId? string - The visitorId identifies the visitor.

googleapis.youtube.data: VideoListResponse

Fields
  • etag? string - Etag of this resource.
  • eventId? string - Serialized EventId of the request which produced this response.
  • kind? string - Identifies what kind of resource this is. Value: the fixed string "youtube#videoListResponse".
  • nextPageToken? string - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
  • pageInfo? PageInfo - Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
  • prevPageToken? string - The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
  • tokenPagination? TokenPagination - Stub token pagination template to suppress results.
  • visitorId? string - The visitorId identifies the visitor.

googleapis.youtube.data: VideoLiveStreamingDetails

Details about the live streaming metadata.

Fields
  • activeLiveChatId? string - The ID of the currently active live chat attached to this video. This field is filled only if the video is a currently live broadcast that has live chat. Once the broadcast transitions to complete this field will be removed and the live chat closed down. For persistent broadcasts that live chat id will no longer be tied to this video but rather to the new video being displayed at the persistent page.
  • actualEndTime? string - The time that the broadcast actually ended. This value will not be available until the broadcast is over.
  • actualStartTime? string - The time that the broadcast actually started. This value will not be available until the broadcast begins.
  • concurrentViewers? string - The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
  • scheduledEndTime? string - The time that the broadcast is scheduled to end. If the value is empty or the property is not present, then the broadcast is scheduled to contiue indefinitely.
  • scheduledStartTime? string - The time that the broadcast is scheduled to begin.

googleapis.youtube.data: VideoLocalization

Localized versions of certain video properties (e.g. title).

Fields
  • description? string - Localized version of the video's description.
  • title? string - Localized version of the video's title.

googleapis.youtube.data: VideoMonetizationDetails

Details about monetization of a YouTube Video.

Fields
  • access? AccessPolicy - Rights management policy for YouTube resources.

googleapis.youtube.data: VideoPlayer

Player to be used for a video playback.

Fields
  • embedHtml? string - An <iframe> tag that embeds a player that will play the video.
  • embedWidth? string - The embed width

googleapis.youtube.data: VideoProcessingDetails

Describes processing status and progress and availability of some other Video resource parts.

Fields
  • editorSuggestionsAvailability? string - This value indicates whether video editing suggestions, which might improve video quality or the playback experience, are available for the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
  • fileDetailsAvailability? string - This value indicates whether file details are available for the uploaded video. You can retrieve a video's file details by requesting the fileDetails part in your videos.list() request.
  • processingFailureReason? string - The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed.
  • processingIssuesAvailability? string - This value indicates whether the video processing engine has generated suggestions that might improve YouTube's ability to process the the video, warnings that explain video processing problems, or errors that cause video processing problems. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
  • processingStatus? string - The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed.
  • tagSuggestionsAvailability? string - This value indicates whether keyword (tag) suggestions are available for the video. Tags can be added to a video's metadata to make it easier for other users to find the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
  • thumbnailsAvailability? string - This value indicates whether thumbnail images have been generated for the video.

googleapis.youtube.data: VideoProcessingDetailsProcessingProgress

Video processing progress and completion time estimate.

Fields
  • partsProcessed? string - The number of parts of the video that YouTube has already processed. You can estimate the percentage of the video that YouTube has already processed by calculating: 100 * parts_processed / parts_total Note that since the estimated number of parts could increase without a corresponding increase in the number of parts that have already been processed, it is possible that the calculated progress could periodically decrease while YouTube processes a video.
  • partsTotal? string - An estimate of the total number of parts that need to be processed for the video. The number may be updated with more precise estimates while YouTube processes the video.
  • timeLeftMs? string - An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video.

googleapis.youtube.data: VideoProjectDetails

DEPRECATED. b/157517979: This part was never populated after it was added. However, it sees non-zero traffic because there is generated client code in the wild that refers to it [1]. We keep this field and do NOT remove it because otherwise V3 would return an error when this part gets requested [2]. [1] https://developers.google.com/resources/api-libraries/documentation/youtube/v3/csharp/latest/classGoogle_1_1Apis_1_1YouTube_1_1v3_1_1Data_1_1VideoProjectDetails.html [2] http://google3/video/youtube/src/python/servers/data_api/common.py?l=1565-1569&rcl=344141677

googleapis.youtube.data: VideoRating

Basic details about rating of a video.

Fields
  • rating? string - Rating of a video.
  • videoId? string - The ID that YouTube uses to uniquely identify the video.

googleapis.youtube.data: VideoRecordingDetails

Recording information associated with the video.

Fields
  • location? GeoPoint - Geographical coordinates of a point, in WGS84.
  • locationDescription? string - The text description of the location where the video was recorded.
  • recordingDate? string - The date and time when the video was recorded.

googleapis.youtube.data: VideoSnippet

Basic details about a video, including title, description, uploader, thumbnails and category.

Fields
  • categoryId? string - The YouTube video category associated with the video.
  • channelId? string - The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
  • channelTitle? string - Channel title for the channel that the video belongs to.
  • defaultAudioLanguage? string - The default_audio_language property specifies the language spoken in the video's default audio track.
  • defaultLanguage? string - The language of the videos's default snippet.
  • description? string - The video's description. @mutable youtube.videos.insert youtube.videos.update
  • liveBroadcastContent? string - Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast.
  • localized? VideoLocalization - Localized versions of certain video properties (e.g. title).
  • publishedAt? string - The date and time when the video was uploaded.
  • tags? string[] - A list of keyword tags associated with the video. Tags may contain spaces.
  • thumbnails? ThumbnailDetails - Internal representation of thumbnails for a YouTube resource.
  • title? string - The video's title. @mutable youtube.videos.insert youtube.videos.update

googleapis.youtube.data: VideoStatistics

Statistics about the video, such as the number of times the video was viewed or liked.

Fields
  • commentCount? string - The number of comments for the video.
  • dislikeCount? string - The number of users who have indicated that they disliked the video by giving it a negative rating.
  • favoriteCount? string - The number of users who currently have the video marked as a favorite video.
  • likeCount? string - The number of users who have indicated that they liked the video by giving it a positive rating.
  • viewCount? string - The number of times the video has been viewed.

googleapis.youtube.data: VideoStatus

Basic details about a video category, such as its localized title. Next Id: 17

Fields
  • embeddable? boolean - This value indicates if the video can be embedded on another website. @mutable youtube.videos.insert youtube.videos.update
  • failureReason? string - This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.
  • license? string - The video's license. @mutable youtube.videos.insert youtube.videos.update
  • privacyStatus? string - The video's privacy status.
  • publicStatsViewable? boolean - This value indicates if the extended video statistics on the watch page can be viewed by everyone. Note that the view count, likes, etc will still be visible if this is disabled. @mutable youtube.videos.insert youtube.videos.update
  • publishAt? string - The date and time when the video is scheduled to publish. It can be set only if the privacy status of the video is private..
  • rejectionReason? string - This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.
  • selfDeclaredMadeForKids? boolean -
  • uploadStatus? string - The status of the uploaded video.

googleapis.youtube.data: VideoSuggestions

Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions.

Fields
  • editorSuggestions? string[] - A list of video editing operations that might improve the video quality or playback experience of the uploaded video.
  • processingErrors? string[] - A list of errors that will prevent YouTube from successfully processing the uploaded video video. These errors indicate that, regardless of the video's current processing status, eventually, that status will almost certainly be failed.
  • processingHints? string[] - A list of suggestions that may improve YouTube's ability to process the video.
  • processingWarnings? string[] - A list of reasons why YouTube may have difficulty transcoding the uploaded video or that might result in an erroneous transcoding. These warnings are generated before YouTube actually processes the uploaded video file. In addition, they identify issues that are unlikely to cause the video processing to fail but that might cause problems such as sync issues, video artifacts, or a missing audio track.
  • tagSuggestions? VideoSuggestionsTagSuggestion[] - A list of keyword tags that could be added to the video's metadata to increase the likelihood that users will locate your video when searching or browsing on YouTube.

googleapis.youtube.data: VideoSuggestionsTagSuggestion

A single tag suggestion with it's relevance information.

Fields
  • categoryRestricts? string[] - A set of video categories for which the tag is relevant. You can use this information to display appropriate tag suggestions based on the video category that the video uploader associates with the video. By default, tag suggestions are relevant for all categories if there are no restricts defined for the keyword.
  • tag? string - The keyword tag suggested for the video.

googleapis.youtube.data: VideoTopicDetails

Freebase topic information related to the video.

Fields
  • relevantTopicIds? string[] - Similar to topic_id, except that these topics are merely relevant to the video. These are topics that may be mentioned in, or appear in the video. You can retrieve information about each topic using Freebase Topic API.
  • topicCategories? string[] - A list of Wikipedia URLs that provide a high-level description of the video's content.
  • topicIds? string[] - A list of Freebase topic IDs that are centrally associated with the video. These are topics that are centrally featured in the video, and it can be said that the video is mainly about each of these. You can retrieve information about each topic using the < a href="http://wiki.freebase.com/wiki/Topic_API">Freebase Topic API.

googleapis.youtube.data: WatchSettings

Branding properties for the watch. All deprecated.

Fields
  • backgroundColor? string - The text color for the video watch page's branded area.
  • featuredPlaylistId? string - An ID that uniquely identifies a playlist that displays next to the video player.
  • textColor? string - The background color for the video watch page's branded area.

Import

import ballerinax/googleapis.youtube.data;Copy

Other versions

1.5.2

1.5.11.5.01.4.01.2.0
See more...

Metadata

Released date: 3 days ago

Version: 1.5.2

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.8.0

GraalVM compatible: Yes

Pull count

Total: 39

Current verison: 0

Weekly downloads

Source repository

Keywords

Type/Connector

Content & Files/Video & Audio

Cost/Free

Vendor/Google

Area/Storage & File Management

Contributors

Dependencies

ballerina/url/2.4.0ballerina/http/2.10.24

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2026 WSO2 LLC