Gcp/youtube
@swamp/gcp/youtubev2026.05.27.1
01README
Google Cloud youtube infrastructure models
02Release Notes
- Updated: search
03Models
activities.tsv2026.05.26.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a activities
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the activities |
fn sync()
Sync activities state from GCP
fn list(channelId?: string, maxResults?: number, mine?: boolean, part?: string, publishedAfter?: string, publishedBefore?: string, regionCode?: string, maxPages?: number)
List activities resources
| Argument | Type | Description |
|---|---|---|
| channelId? | string | |
| maxResults? | number | The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. |
| mine? | boolean | |
| part? | string | The *part* parameter specifies a comma-separated list of one or more activity resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set *part=snippet*, the API response will also contain all of those nested properties. |
| publishedAfter? | string | |
| publishedBefore? | string | |
| regionCode? | string | |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
captions.tsv2026.05.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| id? | string | The ID that YouTube uses to uniquely identify the caption track. |
| snippet? | object | The type of audio track associated with the caption track. |
| part | string | The *part* parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet. |
| onBehalfOf? | string | ID of the Google+ Page for the channel that the request is be on behalf of |
| onBehalfOfContentOwner? | string | *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? | string | Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio. |
fn create()
Create a captions
fn get(identifier: string)
Get a captions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the captions |
fn update()
Update captions attributes
fn delete(identifier: string)
Delete the captions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the captions |
fn sync()
Sync captions state from GCP
fn list(id?: string, onBehalfOf?: string, onBehalfOfContentOwner?: string, part?: string, videoId?: string, maxPages?: number)
List captions resources
| Argument | Type | Description |
|---|---|---|
| id? | string | Returns the captions with the given IDs for Stubby or Apiary. |
| onBehalfOf? | string | ID of the Google+ Page for the channel that the request is on behalf of. |
| onBehalfOfContentOwner? | string | *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. |
| 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. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn download()
download
channels.tsv2026.05.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auditDetails? | object | Whether or not the channel respects the community guidelines. |
| brandingSettings? | object | The country of the channel. |
| contentDetails? | object | 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. |
| contentOwnerDetails? | object | The ID of the content owner linked to the channel. |
| conversionPings? | object | Defines the context of the ping. |
| 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 | The localized strings for channel's description. |
| snippet? | object | The country of the channel. |
| statistics? | object | The number of comments for the channel. |
| status? | object | Whether the channel is considered ypp monetization enabled. See go/yppornot for more details. |
| topicDetails? | object | A list of Wikipedia URLs that describe the channel's content. |
fn get(identifier: string)
Get a channels
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the channels |
fn update()
Update channels attributes
fn sync()
Sync channels state from GCP
fn list(categoryId?: string, forHandle?: string, forUsername?: string, hl?: string, id?: string, managedByMe?: boolean, maxResults?: number, mine?: boolean, mySubscribers?: boolean, onBehalfOfContentOwner?: string, part?: string, maxPages?: number)
List channels resources
| Argument | Type | Description |
|---|---|---|
| categoryId? | string | Return the channels within the specified guide category ID. |
| forHandle? | string | Return the channel associated with a YouTube handle. |
| forUsername? | string | Return the channel associated with a YouTube username. |
| hl? | string | 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 | Return the channels with the specified IDs. |
| managedByMe? | boolean | Return the channels managed by the authenticated user. |
| maxResults? | number | The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. |
| mine? | boolean | Return the ids of channels owned by the authenticated user. |
| mySubscribers? | boolean | Return the channels subscribed to the authenticated user |
| onBehalfOfContentOwner? | string | *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. |
| part? | 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. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
channelsections.tsv2026.05.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| contentDetails? | object | The channel ids for type multiple_channels. |
| id? | string | The ID that YouTube uses to uniquely identify the channel section. |
| snippet? | object | The ID that YouTube uses to uniquely identify the channel that published the channel section. |
| targeting? | object | The country the channel section is targeting. |
| 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. |
| onBehalfOfContentOwner? | string | *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 | 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. |
fn create()
Create a channelSections
fn get(identifier: string)
Get a channelSections
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the channelSections |
fn update()
Update channelSections attributes
fn delete(identifier: string)
Delete the channelSections
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the channelSections |
fn sync()
Sync channelSections state from GCP
fn list(channelId?: string, id?: string, mine?: boolean, onBehalfOfContentOwner?: string, part?: string, maxPages?: number)
List channelSections resources
| Argument | Type | Description |
|---|---|---|
| channelId? | string | Return the ChannelSections owned by the specified channel ID. |
| id? | string | Return the ChannelSections with the given IDs for Stubby or Apiary. |
| mine? | boolean | Return the ChannelSections owned by the authenticated user. |
| onBehalfOfContentOwner? | string | *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. |
| part? | 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. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
comments.tsv2026.05.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| id? | string | The ID that YouTube uses to uniquely identify the comment. |
| snippet? | object | The id of the author's YouTube channel. |
| 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. |
fn create()
Create a comments
fn get(identifier: string)
Get a comments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the comments |
fn update()
Update comments attributes
fn delete(identifier: string)
Delete the comments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the comments |
fn sync()
Sync comments state from GCP
fn list(id?: string, maxResults?: number, parentId?: string, part?: string, textFormat?: string, maxPages?: number)
List comments resources
| Argument | Type | Description |
|---|---|---|
| id? | string | Returns the comments with the given IDs for One Platform. |
| maxResults? | number | The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. |
| parentId? | string | 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. |
| part? | string | The *part* parameter specifies a comma-separated list of one or more comment resource properties that the API response will include. |
| textFormat? | string | The requested text format for the returned comments. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn mark_as_spam()
mark as spam
fn set_moderation_status()
set moderation status
commentthreads.tsv2026.05.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| id? | string | The ID that YouTube uses to uniquely identify the comment thread. |
| replies? | object | Etag of this resource. |
| snippet? | object | 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. |
| 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. |
fn create()
Create a commentThreads
fn get(identifier: string)
Get a commentThreads
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the commentThreads |
fn sync()
Sync commentThreads state from GCP
fn list(allThreadsRelatedToChannelId?: string, channelId?: string, id?: string, maxResults?: number, moderationStatus?: string, order?: string, part?: string, postId?: string, searchTerms?: string, textFormat?: string, videoId?: string, maxPages?: number)
List commentThreads resources
| Argument | Type | Description |
|---|---|---|
| allThreadsRelatedToChannelId? | string | Returns the comment threads of all videos of the channel and the channel comments as well. |
| channelId? | string | Returns the comment threads for all the channel comments (ie does not include comments left on videos). |
| id? | string | Returns the comment threads with the given IDs for Stubby or Apiary. |
| maxResults? | number | The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. |
| moderationStatus? | string | 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 | |
| part? | string | The *part* parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include. |
| postId? | string | Returns the comment threads of the specified post. |
| searchTerms? | string | Limits the returned comment threads to those matching the specified key words. Not compatible with the 'id' filter. |
| textFormat? | string | The requested text format for the returned comments. |
| videoId? | string | Returns the comment threads of the specified video. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
i18nlanguages.tsv2026.05.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a i18nLanguages
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the i18nLanguages |
fn sync()
Sync i18nLanguages state from GCP
fn list(hl?: string, part?: string, maxPages?: number)
List i18nLanguages resources
| Argument | Type | Description |
|---|---|---|
| hl? | string | |
| part? | string | The *part* parameter specifies the i18nLanguage resource properties that the API response will include. Set the parameter value to snippet. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
i18nregions.tsv2026.05.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a i18nRegions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the i18nRegions |
fn sync()
Sync i18nRegions state from GCP
fn list(hl?: string, part?: string, maxPages?: number)
List i18nRegions resources
| Argument | Type | Description |
|---|---|---|
| hl? | string | |
| part? | string | The *part* parameter specifies the i18nRegion resource properties that the API response will include. Set the parameter value to snippet. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
livebroadcasts.tsv2026.05.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| contentDetails? | object | This value uniquely identifies the live stream bound to the broadcast. |
| id? | string | The ID that YouTube assigns to uniquely identify the broadcast. |
| monetizationDetails? | object | This field is semantically required. If it is set false or not set, other fields in this message will be ignored. |
| snippet? | object | The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. |
| statistics? | object | 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. |
| status? | object | The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method. |
| 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 properties that you can include in the parameter value are id, snippet, contentDetails, and status. |
| onBehalfOfContentOwner? | string | *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 | 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. |
fn create()
Create a liveBroadcasts
fn get(identifier: string)
Get a liveBroadcasts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the liveBroadcasts |
fn update()
Update liveBroadcasts attributes
fn delete(identifier: string)
Delete the liveBroadcasts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the liveBroadcasts |
fn sync()
Sync liveBroadcasts state from GCP
fn list(broadcastStatus?: string, broadcastType?: string, id?: string, maxResults?: number, mine?: boolean, onBehalfOfContentOwner?: string, onBehalfOfContentOwnerChannel?: string, part?: string, maxPages?: number)
List liveBroadcasts resources
| Argument | Type | Description |
|---|---|---|
| broadcastStatus? | string | Return broadcasts with a certain status, e.g. active broadcasts. |
| broadcastType? | string | Return only broadcasts with the selected type. |
| id? | string | Return broadcasts with the given ids from Stubby or Apiary. |
| maxResults? | number | The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. |
| mine? | boolean | |
| onBehalfOfContentOwner? | string | *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 | This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. |
| part? | string | The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, status and statistics. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn bind()
bind
fn insert_cuepoint(cueType?: any, durationSecs?: any, etag?: any, id?: any, insertionOffsetTimeMs?: any, walltimeMs?: any)
insert cuepoint
| Argument | Type | Description |
|---|---|---|
| cueType? | any | |
| durationSecs? | any | |
| etag? | any | |
| id? | any | |
| insertionOffsetTimeMs? | any | |
| walltimeMs? | any |
fn transition()
transition
livechatmessages.tsv2026.05.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| authorDetails? | object | The YouTube channel ID. |
| id? | string | The ID that YouTube assigns to uniquely identify the message. |
| snippet? | object | The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership messageDeletedEvent - the moderator that took the action messageRetractedEvent - the author that retracted their message userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase superStickerEvent - the user that made the purchase pollEvent - the user that created the poll |
| part | string | The *part* parameter serves two purposes. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the parameter value to snippet. |
fn create()
Create a liveChatMessages
fn get(identifier: string)
Get a liveChatMessages
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the liveChatMessages |
fn delete(identifier: string)
Delete the liveChatMessages
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the liveChatMessages |
fn sync()
Sync liveChatMessages state from GCP
fn list(hl?: string, liveChatId?: string, maxResults?: number, part?: string, profileImageSize?: number, maxPages?: number)
List liveChatMessages resources
| Argument | Type | Description |
|---|---|---|
| hl? | string | Specifies the localization language in which the system messages should be returned. |
| liveChatId? | string | The id of the live chat for which comments should be returned. |
| maxResults? | number | The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. Not used in the streaming RPC. |
| part? | string | The *part* parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id, snippet, and authorDetails. |
| profileImageSize? | number | Specifies the size of the profile image that should be returned for each user. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn transition()
transition
livechatmoderators.tsv2026.05.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| id? | string | The ID that YouTube assigns to uniquely identify the moderator. |
| snippet? | object | The ID of the live chat this moderator can act on. |
| 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 returns. Set the parameter value to snippet. |
fn create()
Create a liveChatModerators
fn get(identifier: string)
Get a liveChatModerators
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the liveChatModerators |
fn delete(identifier: string)
Delete the liveChatModerators
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the liveChatModerators |
fn sync()
Sync liveChatModerators state from GCP
fn list(liveChatId?: string, maxResults?: number, part?: string, maxPages?: number)
List liveChatModerators resources
| Argument | Type | Description |
|---|---|---|
| liveChatId? | string | The id of the live chat for which moderators should be returned. |
| maxResults? | number | The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. |
| part? | string | The *part* parameter specifies the liveChatModerator resource parts that the API response will include. Supported values are id and snippet. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
livestreams.tsv2026.05.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| cdn? | object | The format of the video stream that you are sending to Youtube. |
| contentDetails? | object | The ingestion URL where the closed captions of this stream are sent. |
| id? | string | The ID that YouTube assigns to uniquely identify the stream. |
| snippet? | object | The ID that YouTube uses to uniquely identify the channel that is transmitting the stream. |
| status? | object | The long-form description of the issue and how to resolve it. |
| 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 properties that you can include in the parameter value are id, snippet, cdn, content_details, and status. |
| onBehalfOfContentOwner? | string | *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 | 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. |
fn create()
Create a liveStreams
fn get(identifier: string)
Get a liveStreams
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the liveStreams |
fn update()
Update liveStreams attributes
fn delete(identifier: string)
Delete the liveStreams
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the liveStreams |
fn sync()
Sync liveStreams state from GCP
fn list(id?: string, maxResults?: number, mine?: boolean, onBehalfOfContentOwner?: string, onBehalfOfContentOwnerChannel?: string, part?: string, maxPages?: number)
List liveStreams resources
| Argument | Type | Description |
|---|---|---|
| id? | string | Return LiveStreams with the given ids from Stubby or Apiary. |
| maxResults? | number | The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. |
| mine? | boolean | |
| onBehalfOfContentOwner? | string | *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 | This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. |
| part? | string | The *part* parameter specifies a comma-separated list of one or more liveStream resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, cdn, and status. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
members.tsv2026.05.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a members
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the members |
fn sync()
Sync members state from GCP
fn list(filterByMemberChannelId?: string, hasAccessToLevel?: string, maxResults?: number, mode?: string, part?: string, maxPages?: number)
List members resources
| Argument | Type | Description |
|---|---|---|
| filterByMemberChannelId? | string | Comma separated list of channel IDs. Only data about members that are part of this list will be included in the response. |
| hasAccessToLevel? | string | Filter members in the results set to the ones that have access to a level. |
| maxResults? | number | The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. |
| mode? | string | Parameter that specifies which channel members to return. |
| part? | string | The *part* parameter specifies the member resource parts that the API response will include. Set the parameter value to snippet. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
membershipslevels.tsv2026.05.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a membershipsLevels
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the membershipsLevels |
fn sync()
Sync membershipsLevels state from GCP
fn list(part?: string, maxPages?: number)
List membershipsLevels resources
| Argument | Type | Description |
|---|---|---|
| part? | string | The *part* parameter specifies the membershipsLevel resource parts that the API response will include. Supported values are id and snippet. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
playlistimages.tsv2026.05.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| id? | string | Identifies this resource (playlist id and image type). |
| snippet? | object | The image height. |
| onBehalfOfContentOwner? | string | *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 | This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. |
| part? | string | The *part* parameter specifies the properties that the API response will include. |
fn create()
Create a playlistImages
fn get(identifier: string)
Get a playlistImages
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the playlistImages |
fn update()
Update playlistImages attributes
fn delete(identifier: string)
Delete the playlistImages
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the playlistImages |
fn sync()
Sync playlistImages state from GCP
fn list(maxResults?: number, onBehalfOfContentOwner?: string, onBehalfOfContentOwnerChannel?: string, parent?: string, part?: string, maxPages?: number)
List playlistImages resources
| Argument | Type | Description |
|---|---|---|
| maxResults? | number | The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. |
| onBehalfOfContentOwner? | string | *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 | 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. |
| parent? | string | Return PlaylistImages for this playlist id. |
| part? | string | The *part* parameter specifies a comma-separated list of one or more playlistImage resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
playlistitems.tsv2026.05.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| contentDetails? | object | 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. |
| id? | string | The ID that YouTube uses to uniquely identify the playlist item. |
| snippet? | object | The ID that YouTube uses to uniquely identify the user that added the item to the playlist. |
| status? | object | This resource's privacy status. |
| 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. |
| onBehalfOfContentOwner? | string | *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. |
fn create()
Create a playlistItems
fn get(identifier: string)
Get a playlistItems
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the playlistItems |
fn update()
Update playlistItems attributes
fn delete(identifier: string)
Delete the playlistItems
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the playlistItems |
fn sync()
Sync playlistItems state from GCP
fn list(id?: string, maxResults?: number, onBehalfOfContentOwner?: string, part?: string, playlistId?: string, videoId?: string, maxPages?: number)
List playlistItems resources
| Argument | Type | Description |
|---|---|---|
| id? | string | |
| maxResults? | number | The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. |
| onBehalfOfContentOwner? | string | *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. |
| part? | 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. |
| playlistId? | string | Return the playlist items within the given playlist. |
| videoId? | string | Return the playlist items associated with the given video ID. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
playlists.tsv2026.05.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| contentDetails? | object | The number of videos in the playlist. |
| id? | string | The ID that YouTube uses to uniquely identify the playlist. |
| localizations? | record | The localized strings for playlist's description. |
| player? | object | An tag that embeds a player that will play the playlist. |
| snippet? | object | The ID that YouTube uses to uniquely identify the channel that published the playlist. |
| status? | object | The playlist's podcast status. |
| 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. |
| onBehalfOfContentOwner? | string | *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 | 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. |
fn create()
Create a playlists
fn get(identifier: string)
Get a playlists
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the playlists |
fn update()
Update playlists attributes
fn delete(identifier: string)
Delete the playlists
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the playlists |
fn sync()
Sync playlists state from GCP
fn list(channelId?: string, hl?: string, id?: string, maxResults?: number, mine?: boolean, onBehalfOfContentOwner?: string, onBehalfOfContentOwnerChannel?: string, part?: string, maxPages?: number)
List playlists resources
| Argument | Type | Description |
|---|---|---|
| channelId? | string | Return the playlists owned by the specified channel ID. |
| hl? | string | Return content in specified language |
| id? | string | Return the playlists with the given IDs for Stubby or Apiary. |
| maxResults? | number | The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. |
| mine? | boolean | Return the playlists owned by the authenticated user. |
| onBehalfOfContentOwner? | string | *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 | This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. |
| part? | 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. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
search.tsv2026.05.27.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a search
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the search |
fn sync()
Sync search state from GCP
fn list(channelId?: string, channelType?: string, eventType?: string, forContentOwner?: boolean, forDeveloper?: boolean, forMine?: boolean, location?: string, locationRadius?: string, maxResults?: number, onBehalfOfContentOwner?: string, order?: string, part?: string, publishedAfter?: string, publishedBefore?: string, q?: string, regionCode?: string, relevanceLanguage?: string, safeSearch?: string, topicId?: string, type?: string, videoCaption?: string, videoCategoryId?: string, videoDefinition?: string, videoDimension?: string, videoDuration?: string, videoEmbeddable?: string, videoLicense?: string, videoPaidProductPlacement?: string, videoSyndicated?: string, videoType?: string, maxPages?: number)
List search resources
| Argument | Type | Description |
|---|---|---|
| channelId? | string | Filter on resources belonging to this channelId. (Force TAP rebuild) |
| channelType? | string | Add a filter on the channel search. |
| eventType? | string | Filter on the livestream status of the videos. |
| forContentOwner? | boolean | Search owned by a content owner. |
| forDeveloper? | boolean | Restrict the search to only retrieve videos uploaded using the project id of the authenticated user. |
| forMine? | boolean | Search for the private videos of the authenticated user. |
| location? | string | Filter on location of the video |
| locationRadius? | string | Filter on distance from the location (specified above). |
| maxResults? | number | The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. |
| onBehalfOfContentOwner? | string | *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 | Sort order of the results. |
| 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. |
| publishedAfter? | string | Filter on resources published after this date. |
| publishedBefore? | string | Filter on resources published before this date. |
| q? | string | Textual search terms to match. |
| regionCode? | string | Display the content as seen by viewers in this country. |
| relevanceLanguage? | string | Return results relevant to this language. |
| safeSearch? | string | Indicates whether the search results should include restricted content as well as standard content. |
| topicId? | string | Restrict results to a particular topic. |
| type? | string | Restrict results to a particular set of resource types from One Platform. |
| videoCaption? | string | Filter on the presence of captions on the videos. |
| videoCategoryId? | string | Filter on videos in a specific category. |
| videoDefinition? | string | Filter on the definition of the videos. |
| videoDimension? | string | Filter on 3d videos. |
| videoDuration? | string | Filter on the duration of the videos. |
| videoEmbeddable? | string | Filter on embeddable videos. |
| videoLicense? | string | Filter on the license of the videos. |
| videoPaidProductPlacement? | string | |
| videoSyndicated? | string | Filter on syndicated videos. |
| videoType? | string | Filter on videos of a specific type. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
subscriptions.tsv2026.05.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| contentDetails? | object | The type of activity this subscription is for (only uploads, everything). |
| id? | string | The ID that YouTube uses to uniquely identify the subscription. |
| snippet? | object | The ID that YouTube uses to uniquely identify the subscriber's channel. |
| subscriberSnippet? | object | The channel ID of the subscriber. |
| 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. |
fn create()
Create a subscriptions
fn get(identifier: string)
Get a subscriptions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the subscriptions |
fn delete(identifier: string)
Delete the subscriptions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the subscriptions |
fn sync()
Sync subscriptions state from GCP
fn list(channelId?: string, forChannelId?: string, id?: string, maxResults?: number, mine?: boolean, myRecentSubscribers?: boolean, mySubscribers?: boolean, onBehalfOfContentOwner?: string, onBehalfOfContentOwnerChannel?: string, order?: string, part?: string, maxPages?: number)
List subscriptions resources
| Argument | Type | Description |
|---|---|---|
| channelId? | string | Return the subscriptions of the given channel owner. |
| forChannelId? | string | Return the subscriptions to the subset of these channels that the authenticated user is subscribed to. |
| id? | string | Return the subscriptions with the given IDs for Stubby or Apiary. |
| maxResults? | number | The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. |
| mine? | boolean | Flag for returning the subscriptions of the authenticated user. |
| myRecentSubscribers? | boolean | |
| mySubscribers? | boolean | Return the subscribers of the given channel owner. |
| onBehalfOfContentOwner? | string | *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 | 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 | The order of the returned subscriptions |
| 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. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
superchatevents.tsv2026.05.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a superChatEvents
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the superChatEvents |
fn sync()
Sync superChatEvents state from GCP
fn list(hl?: string, maxResults?: number, part?: string, maxPages?: number)
List superChatEvents resources
| Argument | Type | Description |
|---|---|---|
| hl? | string | Return rendered funding amounts in specified language. |
| maxResults? | number | The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. |
| part? | string | The *part* parameter specifies the superChatEvent resource parts that the API response will include. This parameter is currently not supported. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
thirdpartylinks.tsv2026.05.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| linkingToken? | string | The linking_token identifies a YouTube account and channel with which the third party account is linked. |
| snippet? | object | The current billing profile status. |
| status? | object | The third-party link status object contains information about the status of the link. |
| part | string | The *part* parameter specifies the thirdPartyLink resource parts that the API request and response will include. Supported values are linkingToken, status, and snippet. |
| externalChannelId? | string | Channel ID to which changes should be applied, for delegation. |
fn create()
Create a thirdPartyLinks
fn get(identifier: string)
Get a thirdPartyLinks
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the thirdPartyLinks |
fn update()
Update thirdPartyLinks attributes
fn delete(identifier: string)
Delete the thirdPartyLinks
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the thirdPartyLinks |
fn sync()
Sync thirdPartyLinks state from GCP
fn list(externalChannelId?: string, linkingToken?: string, part?: string, type?: string, maxPages?: number)
List thirdPartyLinks resources
| Argument | Type | Description |
|---|---|---|
| externalChannelId? | string | Channel ID to which changes should be applied, for delegation. |
| linkingToken? | string | Get a third party link with the given linking token. |
| part? | string | The *part* parameter specifies the thirdPartyLink resource parts that the API response will include. Supported values are linkingToken, status, and snippet. |
| type? | string | Get a third party link of the given type. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
videoabusereportreasons.tsv2026.05.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a videoAbuseReportReasons
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the videoAbuseReportReasons |
fn sync()
Sync videoAbuseReportReasons state from GCP
fn list(hl?: string, part?: string, maxPages?: number)
List videoAbuseReportReasons resources
| Argument | Type | Description |
|---|---|---|
| hl? | string | |
| part? | string | The *part* parameter specifies the videoCategory resource parts that the API response will include. Supported values are id and snippet. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
videocategories.tsv2026.05.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a videoCategories
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the videoCategories |
fn sync()
Sync videoCategories state from GCP
fn list(hl?: string, id?: string, part?: string, regionCode?: string, maxPages?: number)
List videoCategories resources
| Argument | Type | Description |
|---|---|---|
| hl? | string | |
| id? | string | Returns the video categories with the given IDs for Stubby or Apiary. |
| part? | string | The *part* parameter specifies the videoCategory resource properties that the API response will include. Set the parameter value to snippet. |
| regionCode? | string | |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
videos.tsv2026.05.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| ageGating? | object | 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. |
| contentDetails? | object | The value of captions indicates whether the video has captions or not. |
| fileDetails? | object | The audio stream's bitrate, in bits per second. |
| id? | string | The ID that YouTube uses to uniquely identify the video. |
| liveStreamingDetails? | object | 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. |
| localizations? | record | Localized version of the video's description. |
| monetizationDetails? | object | The value of allowed indicates whether the access to the policy is allowed or denied by default. |
| paidProductPlacementDetails? | object | This boolean represents whether the video contains Paid Product Placement, Studio equivalent: https://screenshot.googleplex.com/4Me79DE6AfT2ktp.png |
| player? | object | An tag that embeds a player that will play the video. |
| processingDetails? | object | 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. |
| projectDetails? | object | 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 |
| recordingDetails? | object | Altitude above the reference ellipsoid, in meters. |
| snippet? | object | The YouTube video category associated with the video. |
| statistics? | object | The number of comments for the video. |
| status? | object | Indicates if the video contains altered or synthetic media. |
| suggestions? | object | A list of video editing operations that might improve the video quality or playback experience of the uploaded video. |
| topicDetails? | object | 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. |
| 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. |
| autoLevels? | string | Should auto-levels be applied to the upload. |
| notifySubscribers? | string | Notify the channel subscribers about the new video. As default, the notification is enabled. |
| onBehalfOfContentOwner? | string | *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 | 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? | string | Should stabilize be applied to the upload. |
fn create()
Create a videos
fn get(identifier: string)
Get a videos
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the videos |
fn update()
Update videos attributes
fn delete(identifier: string)
Delete the videos
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the videos |
fn sync()
Sync videos state from GCP
fn list(chart?: string, hl?: string, id?: string, maxHeight?: number, maxResults?: number, maxWidth?: number, myRating?: string, onBehalfOfContentOwner?: string, part?: string, regionCode?: string, videoCategoryId?: string, maxPages?: number)
List videos resources
| Argument | Type | Description |
|---|---|---|
| chart? | string | Return the videos that are in the specified chart. |
| hl? | string | 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 | Return videos with the given ids. |
| maxHeight? | number | |
| maxResults? | number | 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? | number | Return the player with maximum height specified in |
| myRating? | string | Return videos liked/disliked by the authenticated user. Does not support RateType.RATED_TYPE_NONE. |
| onBehalfOfContentOwner? | string | *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. |
| part? | 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. |
| regionCode? | string | Use a chart that is specific to the specified region |
| videoCategoryId? | string | Use chart that is specific to the specified video category |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_rating()
get rating
fn rate()
rate
fn report_abuse(comments?: any, language?: any, reasonId?: any, secondaryReasonId?: any, videoId?: any)
report abuse
| Argument | Type | Description |
|---|---|---|
| comments? | any | |
| language? | any | |
| reasonId? | any | |
| secondaryReasonId? | any | |
| videoId? | any |
videotrainability.tsv2026.05.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a videoTrainability
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the videoTrainability |
fn sync()
Sync videoTrainability state from GCP
04Previous Versions
2026.05.26.1May 26, 2026
- Updated: activities
2026.05.25.2May 25, 2026
- Updated: playlistimages
Added 1, removed 25 models
2026.05.24.1May 24, 2026
- Updated: activities, captions, channelsections, channels, commentthreads, comments, i18nlanguages, i18nregions, livebroadcasts, livechatmessages, livechatmoderators, livestreams, members, membershipslevels, playlistimages, playlistitems, playlists, search, subscriptions, superchatevents, thirdpartylinks, videoabusereportreasons, videocategories, videotrainability, videos
2026.05.21.2May 21, 2026
- Updated: activities, captions, channelsections, channels, commentthreads, comments, i18nlanguages, i18nregions, livebroadcasts, livechatmessages, livechatmoderators, livestreams, members, membershipslevels, playlistimages, playlistitems, playlists, search, subscriptions, superchatevents, thirdpartylinks, videoabusereportreasons, videocategories, videotrainability, videos
2026.05.21.1May 21, 2026
2026.05.19.2May 19, 2026
2026.05.19.1May 19, 2026
2026.04.23.1Apr 23, 2026
2026.04.04.1Apr 4, 2026
- Updated: channels, commentthreads, livechatmessages
2026.04.03.3Apr 3, 2026
- Updated: activities, captions, channelsections, channels, commentthreads, comments, i18nlanguages, i18nregions, livebroadcasts, livechatmessages, livechatmoderators, livestreams, members, membershipslevels, playlistimages, playlistitems, playlists, search, subscriptions, superchatevents, thirdpartylinks, videoabusereportreasons, videocategories, videotrainability, videos
2026.04.03.1Apr 3, 2026
- Updated: activities, captions, channelsections, channels, commentthreads, comments, i18nlanguages, i18nregions, livebroadcasts, livechatmessages, livechatmoderators, livestreams, members, membershipslevels, playlistimages, playlistitems, playlists, search, subscriptions, superchatevents, thirdpartylinks, videoabusereportreasons, videocategories, videotrainability, videos
2026.04.02.2Apr 2, 2026
2026.03.27.1Mar 27, 2026
- Added: activities, captions, channelsections, channels, commentthreads, comments, i18nlanguages, i18nregions, livebroadcasts, livechatmessages, livechatmoderators, livestreams, members, membershipslevels, playlistimages, playlistitems, playlists, search, subscriptions, superchatevents, thirdpartylinks, videoabusereportreasons, videocategories, videotrainability, videos
05Stats
A
100 / 100
Downloads
0
Archive size
299.7 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels