{"openapi":"3.0.0","info":{"description":"The YouTube Data API v3 is an API that provides access to YouTube data, such as videos, playlists, and channels.","version":[{"name":"v3","value":"v3"}]},"servers":[{"description":"The YouTube Data API v3 is an API that provides access to YouTube data, such as videos, playlists, and channels.","url":"https://api.apirails.com/googleyoutube"}],"paths":{"/youtube/v3/activities":{"get":{"tags":["Activities"],"parameters":[{"name":"channelId","in":"query","description":"Channel Id","required":false,"schema":{"type":"string","example":""}},{"name":"home","in":"query","description":"Home","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"maxResults","in":"query","description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","required":false,"schema":{"type":"number","example":""}},{"name":"mine","in":"query","description":"Mine","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"pageToken","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}},{"name":"publishedAfter","in":"query","description":"Published After","required":false,"schema":{"type":"string","example":""}},{"name":"publishedBefore","in":"query","description":"Published Before","required":false,"schema":{"type":"string","example":""}},{"name":"regionCode","in":"query","description":"Region Code","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/activities/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/activities"},"summary":"Retrieves a list of resources, possibly filtered. (Activities list)","description":"Retrieves a list of resources, possibly filtered.","security":[{"bearerAuth":[]}]}},"/youtube/v3/captions":{"get":{"tags":["Captions"],"parameters":[{"name":"id","in":"query","description":"Returns the captions with the given IDs for Stubby or Apiary.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOf","in":"query","description":"ID of the Google+ Page for the channel that the request is on behalf of.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}},{"name":"videoId","in":"query","description":"Returns the captions for the specified video.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/captions/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/captions"},"summary":"Retrieves a list of resources, possibly filtered. (Captions list)","description":"Retrieves a list of resources, possibly filtered.","security":[{"bearerAuth":[]}]},"post":{"tags":["Captions"],"parameters":[{"name":"onBehalfOf","in":"query","description":"ID of the Google+ Page for the channel that the request is be on behalf of","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"The *part* parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.","required":true,"schema":{"type":"string","example":""}},{"name":"sync","in":"query","description":"Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/captions/insert","api_endpoint":"https://youtube.googleapis.com/youtube/v3/captions"},"summary":"Inserts a new resource into this collection. (Captions insert)","description":"Inserts a new resource into this collection.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"etag":{"type":"string","description":"Etag of this resource."},"id":{"type":"string","description":"The ID that YouTube uses to uniquely identify the caption track."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#caption\"."},"snippet":{"type":"object","description":"The snippet object contains basic details about the caption.","properties":{"audioTrackType":{"type":"string","description":"The type of audio track associated with the caption track.","enum":["unknown","primary","commentary","descriptive"]},"failureReason":{"type":"string","description":"The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.","enum":["unknownFormat","unsupportedFormat","processingFailed"]},"isAutoSynced":{"type":"boolean","description":"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.","enum":[true,false]},"isCC":{"type":"boolean","description":"Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.","enum":[true,false]},"isDraft":{"type":"boolean","description":"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","enum":[true,false]},"isEasyReader":{"type":"boolean","description":"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.","enum":[true,false]},"isLarge":{"type":"boolean","description":"Indicates whether the caption track uses large text for the vision-impaired. The default value is false.","enum":[true,false]},"language":{"type":"string","description":"The language of the caption track. The property value is a BCP-47 language tag."},"lastUpdated":{"type":"string","description":"The date and time when the caption track was last updated."},"name":{"type":"string","description":"The name of the caption track. The name is intended to be visible to the user as an option during playback."},"status":{"type":"string","description":"The caption track's status.","enum":["serving","syncing","failed"]},"trackKind":{"type":"string","description":"The caption track's type.","enum":["standard","ASR","forced"]},"videoId":{"type":"string","description":"The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert"}}}}},"example":{"etag":"example-etag","id":"resource-id","kind":"example-kind","snippet":"example-snippet"}}}}},"delete":{"tags":["Captions"],"parameters":[{"name":"id","in":"query","description":"Id","required":true,"schema":{"type":"string","example":""}},{"name":"onBehalfOf","in":"query","description":"ID of the Google+ Page for the channel that the request is be on behalf of","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/captions/delete","api_endpoint":"https://youtube.googleapis.com/youtube/v3/captions"},"summary":"Deletes a resource. (Captions delete)","description":"Deletes a resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"put":{"tags":["Captions"],"parameters":[{"name":"onBehalfOf","in":"query","description":"ID of the Google+ Page for the channel that the request is on behalf of.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}},{"name":"sync","in":"query","description":"Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/captions/update","api_endpoint":"https://youtube.googleapis.com/youtube/v3/captions"},"summary":"Updates an existing resource. (Captions update)","description":"Updates an existing resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"etag":{"type":"string","description":"Etag of this resource."},"id":{"type":"string","description":"The ID that YouTube uses to uniquely identify the caption track."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#caption\"."},"snippet":{"type":"object","description":"The snippet object contains basic details about the caption.","properties":{"audioTrackType":{"type":"string","description":"The type of audio track associated with the caption track.","enum":["unknown","primary","commentary","descriptive"]},"failureReason":{"type":"string","description":"The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.","enum":["unknownFormat","unsupportedFormat","processingFailed"]},"isAutoSynced":{"type":"boolean","description":"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.","enum":[true,false]},"isCC":{"type":"boolean","description":"Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.","enum":[true,false]},"isDraft":{"type":"boolean","description":"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","enum":[true,false]},"isEasyReader":{"type":"boolean","description":"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.","enum":[true,false]},"isLarge":{"type":"boolean","description":"Indicates whether the caption track uses large text for the vision-impaired. The default value is false.","enum":[true,false]},"language":{"type":"string","description":"The language of the caption track. The property value is a BCP-47 language tag."},"lastUpdated":{"type":"string","description":"The date and time when the caption track was last updated."},"name":{"type":"string","description":"The name of the caption track. The name is intended to be visible to the user as an option during playback."},"status":{"type":"string","description":"The caption track's status.","enum":["serving","syncing","failed"]},"trackKind":{"type":"string","description":"The caption track's type.","enum":["standard","ASR","forced"]},"videoId":{"type":"string","description":"The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert"}}}}},"example":{"etag":"example-etag","id":"resource-id","kind":"example-kind","snippet":"example-snippet"}}}}}},"/youtube/v3/captions/{id}":{"get":{"tags":["Captions"],"parameters":[{"name":"id","in":"path","description":"The ID of the caption track to download, required for One Platform.","required":true,"schema":{"type":"string","example":""}},{"name":"onBehalfOf","in":"query","description":"ID of the Google+ Page for the channel that the request is be on behalf of","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"tfmt","in":"query","description":"Convert the captions into this format. Supported options are sbv, srt, and vtt.","required":false,"schema":{"type":"string","example":""}},{"name":"tlang","in":"query","description":"tlang is the language code; machine translate the captions into this language.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/captions/download","api_endpoint":"https://youtube.googleapis.com/youtube/v3/captions/{id}"},"summary":"Downloads a caption track.","description":"Downloads a caption track.","security":[{"bearerAuth":[]}]}},"/youtube/v3/channelSections":{"get":{"tags":["Channel Sections"],"parameters":[{"name":"channelId","in":"query","description":"Return the ChannelSections owned by the specified channel ID.","required":false,"schema":{"type":"string","example":""}},{"name":"hl","in":"query","description":"Return content in specified language","required":false,"schema":{"type":"string","example":""}},{"name":"id","in":"query","description":"Return the ChannelSections with the given IDs for Stubby or Apiary.","required":false,"schema":{"type":"string","example":""}},{"name":"mine","in":"query","description":"Return the ChannelSections owned by the authenticated user.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/channelSections/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/channelSections"},"summary":"Retrieves a list of resources, possibly filtered. (Channel Sections list)","description":"Retrieves a list of resources, possibly filtered.","security":[{"bearerAuth":[]}]},"post":{"tags":["Channel Sections"],"parameters":[{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwnerChannel","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/channelSections/insert","api_endpoint":"https://youtube.googleapis.com/youtube/v3/channelSections"},"summary":"Inserts a new resource into this collection. (Channel Sections insert)","description":"Inserts a new resource into this collection.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contentDetails":{"type":"object","description":"The contentDetails object contains details about the channel section content, such as a list of playlists or channels featured in the section.","properties":{"channels":{"type":"array","description":"The channel ids for type multiple_channels."},"playlists":{"type":"array","description":"The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed."}}},"etag":{"type":"string","description":"Etag of this resource."},"id":{"type":"string","description":"The ID that YouTube uses to uniquely identify the channel section."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#channelSection\"."},"localizations":{"type":"object","description":"Localizations for different languages (map keyed by string, values are ChannelSectionLocalization objects)","properties":{"title":{"type":"string","description":"The localized strings for channel section's title."}}},"snippet":{"type":"object","description":"The snippet object contains basic details about the channel section, such as its type, style and title.","properties":{"type":{"type":"string","description":"The type of the channel section.","enum":["channelsectionTypeUndefined","singlePlaylist","multiplePlaylists","popularUploads","recentUploads","likes","allPlaylists","likedPlaylists","recentPosts","recentActivity","liveEvents","upcomingEvents","completedEvents","multipleChannels","postedVideos","postedPlaylists","subscriptions"]},"channelId":{"type":"string","description":"The ID that YouTube uses to uniquely identify the channel that published the channel section."},"defaultLanguage":{"type":"string","description":"The language of the channel section's default title and description."},"localized":{"type":"object","description":"Localized title, read-only."},"position":{"type":"number","description":"The position of the channel section in the channel."},"style":{"type":"string","description":"The style of the channel section.","enum":["channelsectionStyleUnspecified","horizontalRow","verticalList"]},"title":{"type":"string","description":"The channel section's title for multiple_playlists and multiple_channels."}}},"targeting":{"type":"object","description":"The targeting object contains basic targeting settings about the channel section.","properties":{"countries":{"type":"array","description":"The country the channel section is targeting."},"languages":{"type":"array","description":"The language the channel section is targeting."},"regions":{"type":"array","description":"The region the channel section is targeting."}}}}},"example":{"contentDetails":"example-contentdetails","etag":"example-etag","id":"resource-id","kind":"example-kind","localizations":"example-localizations","snippet":"example-snippet","targeting":"example-targeting"}}}}},"delete":{"tags":["Channel Sections"],"parameters":[{"name":"id","in":"query","description":"Id","required":true,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/channelSections/delete","api_endpoint":"https://youtube.googleapis.com/youtube/v3/channelSections"},"summary":"Deletes a resource. (Channel Sections delete)","description":"Deletes a resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"put":{"tags":["Channel Sections"],"parameters":[{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/channelSections/update","api_endpoint":"https://youtube.googleapis.com/youtube/v3/channelSections"},"summary":"Updates an existing resource. (Channel Sections update)","description":"Updates an existing resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contentDetails":{"type":"object","description":"The contentDetails object contains details about the channel section content, such as a list of playlists or channels featured in the section.","properties":{"channels":{"type":"array","description":"The channel ids for type multiple_channels."},"playlists":{"type":"array","description":"The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed."}}},"etag":{"type":"string","description":"Etag of this resource."},"id":{"type":"string","description":"The ID that YouTube uses to uniquely identify the channel section."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#channelSection\"."},"localizations":{"type":"object","description":"Localizations for different languages (map keyed by string, values are ChannelSectionLocalization objects)","properties":{"title":{"type":"string","description":"The localized strings for channel section's title."}}},"snippet":{"type":"object","description":"The snippet object contains basic details about the channel section, such as its type, style and title.","properties":{"type":{"type":"string","description":"The type of the channel section.","enum":["channelsectionTypeUndefined","singlePlaylist","multiplePlaylists","popularUploads","recentUploads","likes","allPlaylists","likedPlaylists","recentPosts","recentActivity","liveEvents","upcomingEvents","completedEvents","multipleChannels","postedVideos","postedPlaylists","subscriptions"]},"channelId":{"type":"string","description":"The ID that YouTube uses to uniquely identify the channel that published the channel section."},"defaultLanguage":{"type":"string","description":"The language of the channel section's default title and description."},"localized":{"type":"object","description":"Localized title, read-only."},"position":{"type":"number","description":"The position of the channel section in the channel."},"style":{"type":"string","description":"The style of the channel section.","enum":["channelsectionStyleUnspecified","horizontalRow","verticalList"]},"title":{"type":"string","description":"The channel section's title for multiple_playlists and multiple_channels."}}},"targeting":{"type":"object","description":"The targeting object contains basic targeting settings about the channel section.","properties":{"countries":{"type":"array","description":"The country the channel section is targeting."},"languages":{"type":"array","description":"The language the channel section is targeting."},"regions":{"type":"array","description":"The region the channel section is targeting."}}}}},"example":{"contentDetails":"example-contentdetails","etag":"example-etag","id":"resource-id","kind":"example-kind","localizations":"example-localizations","snippet":"example-snippet","targeting":"example-targeting"}}}}}},"/youtube/v3/channels":{"get":{"tags":["Channels"],"parameters":[{"name":"categoryId","in":"query","description":"Return the channels within the specified guide category ID.","required":false,"schema":{"type":"string","example":""}},{"name":"forHandle","in":"query","description":"Return the channel associated with a YouTube handle.","required":false,"schema":{"type":"string","example":""}},{"name":"forUsername","in":"query","description":"Return the channel associated with a YouTube username.","required":false,"schema":{"type":"string","example":""}},{"name":"hl","in":"query","description":"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).","required":false,"schema":{"type":"string","example":""}},{"name":"id","in":"query","description":"Return the channels with the specified IDs.","required":false,"schema":{"type":"string","example":""}},{"name":"managedByMe","in":"query","description":"Return the channels managed by the authenticated user.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"maxResults","in":"query","description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","required":false,"schema":{"type":"number","example":""}},{"name":"mine","in":"query","description":"Return the ids of channels owned by the authenticated user.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"mySubscribers","in":"query","description":"Return the channels subscribed to the authenticated user","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"pageToken","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/channels/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/channels"},"summary":"Retrieves a list of resources, possibly filtered. (Channels list)","description":"Retrieves a list of resources, possibly filtered.","security":[{"bearerAuth":[]}]},"put":{"tags":["Channels"],"parameters":[{"name":"onBehalfOfContentOwner","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/channels/update","api_endpoint":"https://youtube.googleapis.com/youtube/v3/channels"},"summary":"Updates an existing resource. (Channels update)","description":"Updates an existing resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"auditDetails":{"type":"object","description":"The auditionDetails object encapsulates channel data that is relevant for YouTube Partners during the audition process.","properties":{"communityGuidelinesGoodStanding":{"type":"boolean","description":"Whether or not the channel respects the community guidelines.","enum":[true,false]},"contentIdClaimsGoodStanding":{"type":"boolean","description":"Whether or not the channel has any unresolved claims.","enum":[true,false]},"copyrightStrikesGoodStanding":{"type":"boolean","description":"Whether or not the channel has any copyright strikes.","enum":[true,false]}}},"brandingSettings":{"type":"object","description":"The brandingSettings object encapsulates information about the branding of the channel.","properties":{"channel":{"type":"object","description":"Branding properties for the channel view."},"hints":{"type":"array","description":"Additional experimental branding properties. (array of objects)"},"image":{"type":"object","description":"Branding properties for branding images."},"watch":{"type":"object","description":"Branding properties for the watch page."}}},"contentDetails":{"type":"object","description":"The contentDetails object encapsulates information about the channel's content.","properties":{"relatedPlaylists":{"type":"object","description":"relatedPlaylists field"}}},"contentOwnerDetails":{"type":"object","description":"The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel.","properties":{"contentOwner":{"type":"string","description":"The ID of the content owner linked to the channel."},"timeLinked":{"type":"string","description":"The date and time when the channel was linked to the content owner."}}},"conversionPings":{"type":"object","description":"The conversionPings object encapsulates information about conversion pings that need to be respected by the channel.","properties":{"pings":{"type":"array","description":"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. (array of objects)"}}},"etag":{"type":"string","description":"Etag of this resource."},"id":{"type":"string","description":"The ID that YouTube uses to uniquely identify the channel."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#channel\"."},"localizations":{"type":"object","description":"Localizations for different languages (map keyed by string, values are ChannelLocalization objects)","properties":{"description":{"type":"string","description":"The localized strings for channel's description."},"title":{"type":"string","description":"The localized strings for channel's title."}}},"snippet":{"type":"object","description":"The snippet object contains basic details about the channel, such as its title, description, and thumbnail images.","properties":{"country":{"type":"string","description":"The country of the channel."},"customUrl":{"type":"string","description":"The custom url of the channel."},"defaultLanguage":{"type":"string","description":"The language of the channel's default title and description."},"description":{"type":"string","description":"The description of the channel."},"localized":{"type":"object","description":"Localized title and description, read-only."},"publishedAt":{"type":"string","description":"The date and time that the channel was created."},"thumbnails":{"type":"object","description":"A map of thumbnail images associated with the channel. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. When displaying thumbnails in your application, make sure that your code uses the image URLs exactly as they are returned in API responses. For example, your application should not use the http domain instead of the https domain in a URL returned in an API response. Beginning in July 2018, channel thumbnail URLs will only be available in the https domain, which is how the URLs appear in API responses. After that time, you might see broken images in your application if it tries to load YouTube images from the http domain. Thumbnail images might be empty for newly created channels and might take up to one day to populate."},"title":{"type":"string","description":"The channel's title."}}},"statistics":{"type":"object","description":"The statistics object encapsulates statistics for the channel.","properties":{"commentCount":{"type":"string","description":"The number of comments for the channel."},"hiddenSubscriberCount":{"type":"boolean","description":"Whether or not the number of subscribers is shown for this user.","enum":[true,false]},"subscriberCount":{"type":"string","description":"The number of subscribers that the channel has."},"videoCount":{"type":"string","description":"The number of videos uploaded to the channel."},"viewCount":{"type":"string","description":"The number of times the channel has been viewed."}}},"status":{"type":"object","description":"The status object encapsulates information about the privacy status of the channel.","properties":{"isChannelMonetizationEnabled":{"type":"boolean","description":"Whether the channel is considered ypp monetization enabled. See go/yppornot for more details.","enum":[true,false]},"isLinked":{"type":"boolean","description":"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.","enum":[true,false]},"longUploadsStatus":{"type":"string","description":"The long uploads status of this channel. See https://support.google.com/youtube/answer/71673 for more information.","enum":["longUploadsUnspecified","allowed","eligible","disallowed"]},"madeForKids":{"type":"boolean","description":"madeForKids field","enum":[true,false]},"privacyStatus":{"type":"string","description":"Privacy status of the channel.","enum":["public","unlisted","private"]},"selfDeclaredMadeForKids":{"type":"boolean","description":"selfDeclaredMadeForKids field","enum":[true,false]}}},"topicDetails":{"type":"object","description":"The topicDetails object encapsulates information about Freebase topics associated with the channel.","properties":{"topicCategories":{"type":"array","description":"A list of Wikipedia URLs that describe the channel's content."},"topicIds":{"type":"array","description":"A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API."}}}}},"example":{"auditDetails":"example-auditdetails","brandingSettings":"example-brandingsettings","contentDetails":"example-contentdetails","contentOwnerDetails":"example-contentownerdetails","conversionPings":"example-conversionpings","etag":"example-etag","id":"resource-id","kind":"example-kind","localizations":"example-localizations","snippet":"example-snippet","statistics":"example-statistics","status":"example-status","topicDetails":"example-topicdetails"}}}}}},"/youtube/v3/commentThreads":{"get":{"tags":["Comment Threads"],"parameters":[{"name":"allThreadsRelatedToChannelId","in":"query","description":"Returns the comment threads of all videos of the channel and the channel comments as well.","required":false,"schema":{"type":"string","example":""}},{"name":"channelId","in":"query","description":"Returns the comment threads for all the channel comments (ie does not include comments left on videos).","required":false,"schema":{"type":"string","example":""}},{"name":"id","in":"query","description":"Returns the comment threads with the given IDs for Stubby or Apiary.","required":false,"schema":{"type":"string","example":""}},{"name":"maxResults","in":"query","description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","required":false,"schema":{"type":"number","example":""}},{"name":"moderationStatus","in":"query","description":"Limits the returned comment threads to those with the specified moderation status. Not compatible with the 'id' filter. Valid values: published, heldForReview, likelySpam.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["published","heldForReview","likelySpam","rejected"]}}},{"name":"order","in":"query","description":"Order","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["orderUnspecified","time","relevance"]}}},{"name":"pageToken","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"The *part* parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include.","required":true,"schema":{"type":"string","example":""}},{"name":"postId","in":"query","description":"Returns the comment threads of the specified post.","required":false,"schema":{"type":"string","example":""}},{"name":"searchTerms","in":"query","description":"Limits the returned comment threads to those matching the specified key words. Not compatible with the 'id' filter.","required":false,"schema":{"type":"string","example":""}},{"name":"textFormat","in":"query","description":"The requested text format for the returned comments.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["textFormatUnspecified","html","plainText"]}}},{"name":"videoId","in":"query","description":"Returns the comment threads of the specified video.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/commentThreads/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/commentThreads"},"summary":"Retrieves a list of resources, possibly filtered. (Comment Threads list)","description":"Retrieves a list of resources, possibly filtered.","security":[{"bearerAuth":[]}]},"post":{"tags":["Comment Threads"],"parameters":[{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/commentThreads/insert","api_endpoint":"https://youtube.googleapis.com/youtube/v3/commentThreads"},"summary":"Inserts a new resource into this collection. (Comment Threads insert)","description":"Inserts a new resource into this collection.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"etag":{"type":"string","description":"Etag of this resource."},"id":{"type":"string","description":"The ID that YouTube uses to uniquely identify the comment thread."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#commentThread\"."},"replies":{"type":"object","description":"The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.","properties":{"comments":{"type":"array","description":"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. (array of objects)"}}},"snippet":{"type":"object","description":"The snippet object contains basic details about the comment thread and also the top level comment.","properties":{"canReply":{"type":"boolean","description":"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.","enum":[true,false]},"channelId":{"type":"string","description":"The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If neither video_id nor post_id is set the comments refer to the channel itself."},"isPublic":{"type":"boolean","description":"Whether the thread (and therefore all its comments) is visible to all YouTube users.","enum":[true,false]},"postId":{"type":"string","description":"The ID of the post the comments refer to, if any."},"topLevelComment":{"type":"object","description":"The top level comment of this thread."},"totalReplyCount":{"type":"number","description":"The total number of replies (not including the top level comment)."},"videoId":{"type":"string","description":"The ID of the video the comments refer to, if any."}}}}},"example":{"etag":"example-etag","id":"resource-id","kind":"example-kind","replies":"example-replies","snippet":"example-snippet"}}}}}},"/youtube/v3/comments":{"get":{"tags":["Comments"],"parameters":[{"name":"id","in":"query","description":"Returns the comments with the given IDs for One Platform.","required":false,"schema":{"type":"string","example":""}},{"name":"maxResults","in":"query","description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","required":false,"schema":{"type":"number","example":""}},{"name":"pageToken","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"parentId","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"The *part* parameter specifies a comma-separated list of one or more comment resource properties that the API response will include.","required":true,"schema":{"type":"string","example":""}},{"name":"textFormat","in":"query","description":"The requested text format for the returned comments.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["textFormatUnspecified","html","plainText"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/comments/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/comments"},"summary":"Retrieves a list of resources, possibly filtered. (Comments list)","description":"Retrieves a list of resources, possibly filtered.","security":[{"bearerAuth":[]}]},"post":{"tags":["Comments"],"parameters":[{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/comments/insert","api_endpoint":"https://youtube.googleapis.com/youtube/v3/comments"},"summary":"Inserts a new resource into this collection. (Comments insert)","description":"Inserts a new resource into this collection.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"etag":{"type":"string","description":"Etag of this resource."},"id":{"type":"string","description":"The ID that YouTube uses to uniquely identify the comment."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#comment\"."},"snippet":{"type":"object","description":"The snippet object contains basic details about the comment.","properties":{"authorChannelId":{"type":"object","description":"authorChannelId field"},"authorChannelUrl":{"type":"string","description":"Link to the author's YouTube channel, if any."},"authorDisplayName":{"type":"string","description":"The name of the user who posted the comment."},"authorProfileImageUrl":{"type":"string","description":"The URL for the avatar of the user who posted the comment."},"canRate":{"type":"boolean","description":"Whether the current viewer can rate this comment.","enum":[true,false]},"channelId":{"type":"string","description":"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 or post comment it's the video/post's channel."},"likeCount":{"type":"number","description":"The total number of likes this comment has received."},"moderationStatus":{"type":"string","description":"The comment's moderation status. Will not be set if the comments were requested through the id filter.","enum":["published","heldForReview","likelySpam","rejected"]},"parentId":{"type":"string","description":"The unique id of the top-level comment, only set for replies."},"postId":{"type":"string","description":"The ID of the post the comment refers to, if any."},"publishedAt":{"type":"string","description":"The date and time when the comment was originally published."},"textDisplay":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The date and time when the comment was last updated."},"videoId":{"type":"string","description":"The ID of the video the comment refers to, if any."},"viewerRating":{"type":"string","description":"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.","enum":["none","like","dislike"]}}}}},"example":{"etag":"example-etag","id":"resource-id","kind":"example-kind","snippet":"example-snippet"}}}}},"delete":{"tags":["Comments"],"parameters":[{"name":"id","in":"query","description":"Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/comments/delete","api_endpoint":"https://youtube.googleapis.com/youtube/v3/comments"},"summary":"Deletes a resource. (Comments delete)","description":"Deletes a resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"put":{"tags":["Comments"],"parameters":[{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/comments/update","api_endpoint":"https://youtube.googleapis.com/youtube/v3/comments"},"summary":"Updates an existing resource. (Comments update)","description":"Updates an existing resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"etag":{"type":"string","description":"Etag of this resource."},"id":{"type":"string","description":"The ID that YouTube uses to uniquely identify the comment."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#comment\"."},"snippet":{"type":"object","description":"The snippet object contains basic details about the comment.","properties":{"authorChannelId":{"type":"object","description":"authorChannelId field"},"authorChannelUrl":{"type":"string","description":"Link to the author's YouTube channel, if any."},"authorDisplayName":{"type":"string","description":"The name of the user who posted the comment."},"authorProfileImageUrl":{"type":"string","description":"The URL for the avatar of the user who posted the comment."},"canRate":{"type":"boolean","description":"Whether the current viewer can rate this comment.","enum":[true,false]},"channelId":{"type":"string","description":"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 or post comment it's the video/post's channel."},"likeCount":{"type":"number","description":"The total number of likes this comment has received."},"moderationStatus":{"type":"string","description":"The comment's moderation status. Will not be set if the comments were requested through the id filter.","enum":["published","heldForReview","likelySpam","rejected"]},"parentId":{"type":"string","description":"The unique id of the top-level comment, only set for replies."},"postId":{"type":"string","description":"The ID of the post the comment refers to, if any."},"publishedAt":{"type":"string","description":"The date and time when the comment was originally published."},"textDisplay":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The date and time when the comment was last updated."},"videoId":{"type":"string","description":"The ID of the video the comment refers to, if any."},"viewerRating":{"type":"string","description":"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.","enum":["none","like","dislike"]}}}}},"example":{"etag":"example-etag","id":"resource-id","kind":"example-kind","snippet":"example-snippet"}}}}}},"/youtube/v3/i18nLanguages":{"get":{"tags":["I18N Languages"],"parameters":[{"name":"hl","in":"query","description":"Hl","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"The *part* parameter specifies the i18nLanguage resource properties that the API response will include. Set the parameter value to snippet.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/i18nLanguages/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/i18nLanguages"},"summary":"Retrieves a list of resources, possibly filtered. (I18N Languages list)","description":"Retrieves a list of resources, possibly filtered.","security":[{"bearerAuth":[]}]}},"/youtube/v3/i18nRegions":{"get":{"tags":["I18N Regions"],"parameters":[{"name":"hl","in":"query","description":"Hl","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"The *part* parameter specifies the i18nRegion resource properties that the API response will include. Set the parameter value to snippet.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/i18nRegions/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/i18nRegions"},"summary":"Retrieves a list of resources, possibly filtered. (I18N Regions list)","description":"Retrieves a list of resources, possibly filtered.","security":[{"bearerAuth":[]}]}},"/youtube/v3/liveBroadcasts":{"get":{"tags":["Live Broadcasts"],"parameters":[{"name":"broadcastStatus","in":"query","description":"Return broadcasts with a certain status, e.g. active broadcasts.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["broadcastStatusFilterUnspecified","all","active","upcoming","completed"]}}},{"name":"broadcastType","in":"query","description":"Return only broadcasts with the selected type.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["broadcastTypeFilterUnspecified","all","event","persistent"]}}},{"name":"id","in":"query","description":"Return broadcasts with the given ids from Stubby or Apiary.","required":false,"schema":{"type":"string","example":""}},{"name":"maxResults","in":"query","description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","required":false,"schema":{"type":"number","example":""}},{"name":"mine","in":"query","description":"Mine","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwnerChannel","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"pageToken","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/live/docs/liveBroadcasts/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/liveBroadcasts"},"summary":"Retrieve the list of broadcasts associated with the given channel.","description":"Retrieve the list of broadcasts associated with the given channel.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Live Broadcasts"],"parameters":[{"name":"id","in":"query","description":"Broadcast to delete.","required":true,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwnerChannel","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/live/docs/liveBroadcasts/delete","api_endpoint":"https://youtube.googleapis.com/youtube/v3/liveBroadcasts"},"summary":"Delete a given broadcast.","description":"Delete a given broadcast.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"put":{"tags":["Live Broadcasts"],"parameters":[{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwnerChannel","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, contentDetails, and status. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a broadcast's privacy status is defined in the status part. As such, if your request is updating a private or unlisted broadcast, and the request's part parameter value includes the status part, the broadcast's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the broadcast will revert to the default privacy setting.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/live/docs/liveBroadcasts/update","api_endpoint":"https://youtube.googleapis.com/youtube/v3/liveBroadcasts"},"summary":"Updates an existing broadcast for the authenticated user.","description":"Updates an existing broadcast for the authenticated user.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contentDetails":{"type":"object","description":"The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.","properties":{"availabilityConfig":{"type":"object","description":"Optional. The broadcast's availability config. Used to set specific region availability or block specific regions It is optional - if not set, it is not enforced."},"boundStreamId":{"type":"string","description":"This value uniquely identifies the live stream bound to the broadcast."},"boundStreamLastUpdateTimeMs":{"type":"string","description":"The date and time that the live stream referenced by boundStreamId was last updated."},"closedCaptionsType":{"type":"string","description":"closedCaptionsType field","enum":["closedCaptionsTypeUnspecified","closedCaptionsDisabled","closedCaptionsHttpPost","closedCaptionsEmbedded"]},"enableAutoStart":{"type":"boolean","description":"This setting indicates whether auto start is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.","enum":[true,false]},"enableAutoStop":{"type":"boolean","description":"This setting indicates whether auto stop is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.","enum":[true,false]},"enableClosedCaptions":{"type":"boolean","description":"This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.","enum":[true,false]},"enableContentEncryption":{"type":"boolean","description":"This setting indicates whether YouTube should enable content encryption for the broadcast.","enum":[true,false]},"enableDvr":{"type":"boolean","description":"This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true. *Important:* You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.","enum":[true,false]},"enableEmbed":{"type":"boolean","description":"This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.","enum":[true,false]},"enableLowLatency":{"type":"boolean","description":"Indicates whether this broadcast has low latency enabled.","enum":[true,false]},"latencyPreference":{"type":"string","description":"If both this and enable_low_latency are set, they must match. LATENCY_NORMAL should match enable_low_latency=false LATENCY_LOW should match enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency omitted.","enum":["latencyPreferenceUnspecified","normal","low","ultraLow"]},"mesh":{"type":"string","description":"The mesh for projecting the video if projection is mesh. The mesh value must be a UTF-8 string containing the base-64 encoding of 3D mesh data that follows the Spherical Video V2 RFC specification for an mshp box, excluding the box size and type but including the following four reserved zero bytes for the version and flags."},"monitorStream":{"type":"object","description":"The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly."},"projection":{"type":"string","description":"The projection format of this broadcast. This defaults to rectangular.","enum":["projectionUnspecified","rectangular","360","mesh"]},"recordFromStart":{"type":"boolean","description":"Automatically start recording after the event goes live. The default value for this property is true. *Important:* You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.","enum":[true,false]},"startWithSlate":{"type":"boolean","description":"This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.","enum":[true,false]},"stereoLayout":{"type":"string","description":"The 3D stereo layout of this broadcast. This defaults to mono.","enum":["stereoLayoutUnspecified","mono","leftRight","topBottom"]}}},"etag":{"type":"string","description":"Etag of this resource."},"id":{"type":"string","description":"The ID that YouTube assigns to uniquely identify the broadcast."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#liveBroadcast\"."},"monetizationDetails":{"type":"object","description":"The monetizationDetails object contains information about the event's monetization details.","properties":{"cuepointSchedule":{"type":"object","description":"cuepointSchedule field"}}},"snippet":{"type":"object","description":"The snippet object contains basic details about the event, including its title, description, start time, and end time.","properties":{"actualEndTime":{"type":"string","description":"The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete."},"actualStartTime":{"type":"string","description":"The date and time that the broadcast actually started. This information is only available once the broadcast's state is live."},"categoryId":{"type":"string","description":"The YouTube video category associated with the video broadcast."},"channelId":{"type":"string","description":"The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast."},"description":{"type":"string","description":"The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource."},"isDefaultBroadcast":{"type":"boolean","description":"Indicates whether this broadcast is the default broadcast. Internal only.","enum":[true,false]},"liveChatId":{"type":"string","description":"The id of the live chat for this broadcast."},"publishedAt":{"type":"string","description":"The date and time that the broadcast was added to YouTube's live broadcast schedule."},"scheduledEndTime":{"type":"string","description":"The date and time that the broadcast is scheduled to end."},"scheduledStartTime":{"type":"string","description":"The date and time that the broadcast is scheduled to start."},"thumbnails":{"type":"object","description":"A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail."},"title":{"type":"string","description":"The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource."}}},"statistics":{"type":"object","description":"The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.","properties":{"concurrentViewers":{"type":"string","description":"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":{"type":"object","description":"The status object contains information about the event's status.","properties":{"lifeCycleStatus":{"type":"string","description":"The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.","enum":["lifeCycleStatusUnspecified","created","ready","testing","live","complete","revoked","testStarting","liveStarting"]},"liveBroadcastPriority":{"type":"string","description":"Priority of the live broadcast event (internal state).","enum":["liveBroadcastPriorityUnspecified","low","normal","high"]},"madeForKids":{"type":"boolean","description":"Whether the broadcast is made for kids or not, decided by YouTube instead of the creator. This field is read only.","enum":[true,false]},"privacyStatus":{"type":"string","description":"The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.","enum":["public","unlisted","private"]},"recordingStatus":{"type":"string","description":"The broadcast's recording status.","enum":["liveBroadcastRecordingStatusUnspecified","notRecording","recording","recorded"]},"selfDeclaredMadeForKids":{"type":"boolean","description":"This field will be set to True if the creator declares the broadcast to be kids only: go/live-cw-work.","enum":[true,false]}}}}},"example":{"contentDetails":"example-contentdetails","etag":"example-etag","id":"resource-id","kind":"example-kind","monetizationDetails":"example-monetizationdetails","snippet":"example-snippet","statistics":"example-statistics","status":"example-status"}}}}},"post":{"tags":["Live Broadcasts"],"parameters":[{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwnerChannel","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/live/docs/liveBroadcasts/insert","api_endpoint":"https://youtube.googleapis.com/youtube/v3/liveBroadcasts"},"summary":"Inserts a new stream for the authenticated user. (Live Broadcasts insert)","description":"Inserts a new stream for the authenticated user.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contentDetails":{"type":"object","description":"The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.","properties":{}},"etag":{"type":"string","description":"Etag of this resource."},"id":{"type":"string","description":"The ID that YouTube assigns to uniquely identify the broadcast."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#liveBroadcast\"."},"monetizationDetails":{"type":"object","description":"The monetizationDetails object contains information about the event's monetization details.","properties":{}},"snippet":{"type":"object","description":"The snippet object contains basic details about the event, including its title, description, start time, and end time.","properties":{"actualEndTime":{"type":"string","description":"The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete."},"actualStartTime":{"type":"string","description":"The date and time that the broadcast actually started. This information is only available once the broadcast's state is live."},"categoryId":{"type":"string","description":"The YouTube video category associated with the video broadcast."},"channelId":{"type":"string","description":"The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast."},"description":{"type":"string","description":"The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource."},"isDefaultBroadcast":{"type":"boolean","description":"Indicates whether this broadcast is the default broadcast. Internal only.","enum":[true,false]},"liveChatId":{"type":"string","description":"The id of the live chat for this broadcast."},"publishedAt":{"type":"string","description":"The date and time that the broadcast was added to YouTube's live broadcast schedule."},"scheduledEndTime":{"type":"string","description":"The date and time that the broadcast is scheduled to end."},"scheduledStartTime":{"type":"string","description":"The date and time that the broadcast is scheduled to start."},"thumbnails":{"type":"object","description":"A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail."},"title":{"type":"string","description":"The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource."}}},"statistics":{"type":"object","description":"The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.","properties":{}},"status":{"type":"object","description":"The status object contains information about the event's status.","properties":{}}}},"example":{"contentDetails":"example-contentdetails","etag":"example-etag","id":"resource-id","kind":"example-kind","monetizationDetails":"example-monetizationdetails","snippet":"example-snippet","statistics":"example-statistics","status":"example-status"}}}}}},"/youtube/v3/liveChat/messages":{"get":{"tags":["Live Chat Messages"],"parameters":[{"name":"hl","in":"query","description":"Specifies the localization language in which the system messages should be returned.","required":false,"schema":{"type":"string","example":""}},{"name":"liveChatId","in":"query","description":"The id of the live chat for which comments should be returned.","required":true,"schema":{"type":"string","example":""}},{"name":"maxResults","in":"query","description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. Not used in the streaming RPC.","required":false,"schema":{"type":"number","example":""}},{"name":"pageToken","in":"query","description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identify other pages that could be retrieved.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"The *part* parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id, snippet, and authorDetails.","required":true,"schema":{"type":"string","example":""}},{"name":"profileImageSize","in":"query","description":"Specifies the size of the profile image that should be returned for each user.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/live/docs/liveChatMessages/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/liveChat/messages"},"summary":"Retrieves a list of resources, possibly filtered. (Live Chat Messages list)","description":"Retrieves a list of resources, possibly filtered.","security":[{"bearerAuth":[]}]},"post":{"tags":["Live Chat Messages"],"parameters":[{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/live/docs/liveChatMessages/insert","api_endpoint":"https://youtube.googleapis.com/youtube/v3/liveChat/messages"},"summary":"Inserts a new resource into this collection. (Live Chat Messages insert)","description":"Inserts a new resource into this collection.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"authorDetails":{"type":"object","description":"The authorDetails object contains basic details about the user that posted this message.","properties":{"channelId":{"type":"string","description":"The YouTube channel ID."},"channelUrl":{"type":"string","description":"The channel's URL."},"displayName":{"type":"string","description":"The channel's display name."},"isChatModerator":{"type":"boolean","description":"Whether the author is a moderator of the live chat.","enum":[true,false]},"isChatOwner":{"type":"boolean","description":"Whether the author is the owner of the live chat.","enum":[true,false]},"isChatSponsor":{"type":"boolean","description":"Whether the author is a sponsor of the live chat.","enum":[true,false]},"isVerified":{"type":"boolean","description":"Whether the author's identity has been verified by YouTube.","enum":[true,false]},"profileImageUrl":{"type":"string","description":"The channels's avatar URL."}}},"etag":{"type":"string","description":"Etag of this resource."},"id":{"type":"string","description":"The ID that YouTube assigns to uniquely identify the message."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#liveChatMessage\"."},"snippet":{"type":"object","description":"The snippet object contains basic details about the message.","properties":{"type":{"type":"string","description":"The type of message, this will always be present, it determines the contents of the message as well as which fields will be present.","enum":["invalidType","textMessageEvent","tombstone","fanFundingEvent","chatEndedEvent","sponsorOnlyModeStartedEvent","sponsorOnlyModeEndedEvent","newSponsorEvent","memberMilestoneChatEvent","membershipGiftingEvent","giftMembershipReceivedEvent","messageDeletedEvent","messageRetractedEvent","userBannedEvent","superChatEvent","superStickerEvent","pollEvent","giftEvent"]},"authorChannelId":{"type":"string","description":"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. Unused. messageRetractedEvent - the author that retracted their message. Unused. 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"},"displayMessage":{"type":"string","description":"Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent."},"fanFundingEventDetails":{"type":"object","description":"Details about the funding event, this is only set if the type is 'fanFundingEvent'."},"giftDetails":{"type":"object","description":"Details about the gift event, this is only set if the type is 'giftEvent'."},"giftMembershipReceivedDetails":{"type":"object","description":"Details about the Gift Membership Received event, this is only set if the type is 'giftMembershipReceivedEvent'."},"hasDisplayContent":{"type":"boolean","description":"Whether the message has display content that should be displayed to users.","enum":[true,false]},"liveChatId":{"type":"string","description":"liveChatId field"},"memberMilestoneChatDetails":{"type":"object","description":"Details about the Member Milestone Chat event, this is only set if the type is 'memberMilestoneChatEvent'."},"membershipGiftingDetails":{"type":"object","description":"Details about the Membership Gifting event, this is only set if the type is 'membershipGiftingEvent'."},"messageDeletedDetails":{"type":"object","description":"messageDeletedDetails field"},"messageRetractedDetails":{"type":"object","description":"messageRetractedDetails field"},"newSponsorDetails":{"type":"object","description":"Details about the New Member Announcement event, this is only set if the type is 'newSponsorEvent'. Please note that \"member\" is the new term for \"sponsor\"."},"pollDetails":{"type":"object","description":"Details about the poll event, this is only set if the type is 'pollEvent'."},"publishedAt":{"type":"string","description":"The date and time when the message was orignally published."},"superChatDetails":{"type":"object","description":"Details about the Super Chat event, this is only set if the type is 'superChatEvent'."},"superStickerDetails":{"type":"object","description":"Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'."},"textMessageDetails":{"type":"object","description":"Details about the text message, this is only set if the type is 'textMessageEvent'."},"userBannedDetails":{"type":"object","description":"userBannedDetails field"}}}}},"example":{"authorDetails":"example-authordetails","etag":"example-etag","id":"resource-id","kind":"example-kind","snippet":"example-snippet"}}}}},"delete":{"tags":["Live Chat Messages"],"parameters":[{"name":"id","in":"query","description":"Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/live/docs/liveChatMessages/delete","api_endpoint":"https://youtube.googleapis.com/youtube/v3/liveChat/messages"},"summary":"Deletes a chat message.","description":"Deletes a chat message.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/youtube/v3/liveChat/messages/stream":{"get":{"tags":["Messages"],"parameters":[{"name":"hl","in":"query","description":"Specifies the localization language in which the system messages should be returned.","required":false,"schema":{"type":"string","example":""}},{"name":"liveChatId","in":"query","description":"The id of the live chat for which comments should be returned.","required":false,"schema":{"type":"string","example":""}},{"name":"maxResults","in":"query","description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. Not used in the streaming RPC.","required":false,"schema":{"type":"number","example":""}},{"name":"pageToken","in":"query","description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identify other pages that could be retrieved.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"The *part* parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id, snippet, and authorDetails.","required":false,"schema":{"type":"string","example":""}},{"name":"profileImageSize","in":"query","description":"Specifies the size of the profile image that should be returned for each user.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://youtube.googleapis.com/$discovery/rest?version=v3","api_endpoint":"https://youtube.googleapis.com/youtube/v3/liveChat/messages/stream"},"summary":"Allows a user to load live chat through a server-streamed RPC.","description":"Allows a user to load live chat through a server-streamed RPC.","security":[{"bearerAuth":[]}]}},"/youtube/v3/liveChat/moderators":{"get":{"tags":["Live Chat Moderators"],"parameters":[{"name":"liveChatId","in":"query","description":"The id of the live chat for which moderators should be returned.","required":true,"schema":{"type":"string","example":""}},{"name":"maxResults","in":"query","description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","required":false,"schema":{"type":"number","example":""}},{"name":"pageToken","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"The *part* parameter specifies the liveChatModerator resource parts that the API response will include. Supported values are id and snippet.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/live/docs/liveChatModerators/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/liveChat/moderators"},"summary":"Retrieves a list of resources, possibly filtered. (Live Chat Moderators list)","description":"Retrieves a list of resources, possibly filtered.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Live Chat Moderators"],"parameters":[{"name":"id","in":"query","description":"Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/live/docs/liveChatModerators/delete","api_endpoint":"https://youtube.googleapis.com/youtube/v3/liveChat/moderators"},"summary":"Deletes a chat moderator.","description":"Deletes a chat moderator.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"post":{"tags":["Live Chat Moderators"],"parameters":[{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/live/docs/liveChatModerators/insert","api_endpoint":"https://youtube.googleapis.com/youtube/v3/liveChat/moderators"},"summary":"Inserts a new resource into this collection. (Live Chat Moderators insert)","description":"Inserts a new resource into this collection.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"etag":{"type":"string","description":"Etag of this resource."},"id":{"type":"string","description":"The ID that YouTube assigns to uniquely identify the moderator."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#liveChatModerator\"."},"snippet":{"type":"object","description":"The snippet object contains basic details about the moderator.","properties":{"liveChatId":{"type":"string","description":"The ID of the live chat this moderator can act on."},"moderatorDetails":{"type":"object","description":"Details about the moderator."}}}}},"example":{"etag":"example-etag","id":"resource-id","kind":"example-kind","snippet":"example-snippet"}}}}}},"/youtube/v3/liveStreams":{"get":{"tags":["Live Streams"],"parameters":[{"name":"id","in":"query","description":"Return LiveStreams with the given ids from Stubby or Apiary.","required":false,"schema":{"type":"string","example":""}},{"name":"maxResults","in":"query","description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","required":false,"schema":{"type":"number","example":""}},{"name":"mine","in":"query","description":"Mine","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwnerChannel","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"pageToken","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/live/docs/liveStreams/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/liveStreams"},"summary":"Retrieve the list of streams associated with the given channel.","description":"Retrieve the list of streams associated with the given channel. --","security":[{"bearerAuth":[]}]},"post":{"tags":["Live Streams"],"parameters":[{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwnerChannel","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/live/docs/liveStreams/insert","api_endpoint":"https://youtube.googleapis.com/youtube/v3/liveStreams"},"summary":"Inserts a new stream for the authenticated user.","description":"Inserts a new stream for the authenticated user.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cdn":{"type":"object","description":"The cdn object defines the live stream's content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.","properties":{"format":{"type":"string","description":"The format of the video stream that you are sending to Youtube."},"frameRate":{"type":"string","description":"The frame rate of the inbound video data.","enum":["30fps","60fps","variable"]},"ingestionInfo":{"type":"object","description":"The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube."},"ingestionType":{"type":"string","description":"The method or protocol used to transmit the video stream.","enum":["rtmp","dash","webrtc","hls"]},"resolution":{"type":"string","description":"The resolution of the inbound video data.","enum":["240p","360p","480p","720p","1080p","1440p","2160p","variable"]}}},"contentDetails":{"type":"object","description":"The content_details object contains information about the stream, including the closed captions ingestion URL.","properties":{"closedCaptionsIngestionUrl":{"type":"string","description":"The ingestion URL where the closed captions of this stream are sent."},"isReusable":{"type":"boolean","description":"Indicates whether the stream is reusable, which means that it can be bound to multiple broadcasts. It is common for broadcasters to reuse the same stream for many different broadcasts if those broadcasts occur at different times. If you set this value to false, then the stream will not be reusable, which means that it can only be bound to one broadcast. Non-reusable streams differ from reusable streams in the following ways: - A non-reusable stream can only be bound to one broadcast. - A non-reusable stream might be deleted by an automated process after the broadcast ends. - The liveStreams.list method does not list non-reusable streams if you call the method and set the mine parameter to true. The only way to use that method to retrieve the resource for a non-reusable stream is to use the id parameter to identify the stream.","enum":[true,false]}}},"etag":{"type":"string","description":"Etag of this resource."},"id":{"type":"string","description":"The ID that YouTube assigns to uniquely identify the stream."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#liveStream\"."},"snippet":{"type":"object","description":"The snippet object contains basic details about the stream, including its channel, title, and description.","properties":{"channelId":{"type":"string","description":"The ID that YouTube uses to uniquely identify the channel that is transmitting the stream."},"description":{"type":"string","description":"The stream's description. The value cannot be longer than 10000 characters."},"isDefaultStream":{"type":"boolean","description":"isDefaultStream field","enum":[true,false]},"publishedAt":{"type":"string","description":"The date and time that the stream was created."},"title":{"type":"string","description":"The stream's title. The value must be between 1 and 128 characters long."}}},"status":{"type":"object","description":"The status object contains information about live stream's status.","properties":{"healthStatus":{"type":"object","description":"The health status of the stream."},"streamStatus":{"type":"string","description":"streamStatus field","enum":["created","ready","active","inactive","error"]}}}}},"example":{"cdn":"example-cdn","contentDetails":"example-contentdetails","etag":"example-etag","id":"resource-id","kind":"example-kind","snippet":"example-snippet","status":"example-status"}}}}},"delete":{"tags":["Live Streams"],"parameters":[{"name":"id","in":"query","description":"Id","required":true,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwnerChannel","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/live/docs/liveStreams/delete","api_endpoint":"https://youtube.googleapis.com/youtube/v3/liveStreams"},"summary":"Deletes an existing stream for the authenticated user.","description":"Deletes an existing stream for the authenticated user.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"put":{"tags":["Live Streams"],"parameters":[{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwnerChannel","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, cdn, and status. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. If the request body does not specify a value for a mutable property, the existing value for that property will be removed.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/live/docs/liveStreams/update","api_endpoint":"https://youtube.googleapis.com/youtube/v3/liveStreams"},"summary":"Updates an existing stream for the authenticated user.","description":"Updates an existing stream for the authenticated user.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cdn":{"type":"object","description":"The cdn object defines the live stream's content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.","properties":{"format":{"type":"string","description":"The format of the video stream that you are sending to Youtube."},"frameRate":{"type":"string","description":"The frame rate of the inbound video data.","enum":["30fps","60fps","variable"]},"ingestionInfo":{"type":"object","description":"The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube."},"ingestionType":{"type":"string","description":"The method or protocol used to transmit the video stream.","enum":["rtmp","dash","webrtc","hls"]},"resolution":{"type":"string","description":"The resolution of the inbound video data.","enum":["240p","360p","480p","720p","1080p","1440p","2160p","variable"]}}},"contentDetails":{"type":"object","description":"The content_details object contains information about the stream, including the closed captions ingestion URL.","properties":{"closedCaptionsIngestionUrl":{"type":"string","description":"The ingestion URL where the closed captions of this stream are sent."},"isReusable":{"type":"boolean","description":"Indicates whether the stream is reusable, which means that it can be bound to multiple broadcasts. It is common for broadcasters to reuse the same stream for many different broadcasts if those broadcasts occur at different times. If you set this value to false, then the stream will not be reusable, which means that it can only be bound to one broadcast. Non-reusable streams differ from reusable streams in the following ways: - A non-reusable stream can only be bound to one broadcast. - A non-reusable stream might be deleted by an automated process after the broadcast ends. - The liveStreams.list method does not list non-reusable streams if you call the method and set the mine parameter to true. The only way to use that method to retrieve the resource for a non-reusable stream is to use the id parameter to identify the stream.","enum":[true,false]}}},"etag":{"type":"string","description":"Etag of this resource."},"id":{"type":"string","description":"The ID that YouTube assigns to uniquely identify the stream."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#liveStream\"."},"snippet":{"type":"object","description":"The snippet object contains basic details about the stream, including its channel, title, and description.","properties":{"channelId":{"type":"string","description":"The ID that YouTube uses to uniquely identify the channel that is transmitting the stream."},"description":{"type":"string","description":"The stream's description. The value cannot be longer than 10000 characters."},"isDefaultStream":{"type":"boolean","description":"isDefaultStream field","enum":[true,false]},"publishedAt":{"type":"string","description":"The date and time that the stream was created."},"title":{"type":"string","description":"The stream's title. The value must be between 1 and 128 characters long."}}},"status":{"type":"object","description":"The status object contains information about live stream's status.","properties":{"healthStatus":{"type":"object","description":"The health status of the stream."},"streamStatus":{"type":"string","description":"streamStatus field","enum":["created","ready","active","inactive","error"]}}}}},"example":{"cdn":"example-cdn","contentDetails":"example-contentdetails","etag":"example-etag","id":"resource-id","kind":"example-kind","snippet":"example-snippet","status":"example-status"}}}}}},"/youtube/v3/members":{"get":{"tags":["Members"],"parameters":[{"name":"filterByMemberChannelId","in":"query","description":"Comma separated list of channel IDs. Only data about members that are part of this list will be included in the response.","required":false,"schema":{"type":"string","example":""}},{"name":"hasAccessToLevel","in":"query","description":"Filter members in the results set to the ones that have access to a level.","required":false,"schema":{"type":"string","example":""}},{"name":"maxResults","in":"query","description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","required":false,"schema":{"type":"number","example":""}},{"name":"mode","in":"query","description":"Parameter that specifies which channel members to return.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["listMembersModeUnknown","updates","all_current"]}}},{"name":"pageToken","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"The *part* parameter specifies the member resource parts that the API response will include. Set the parameter value to snippet.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/members/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/members"},"summary":"Retrieves a list of members that match the request criteria for a channel.","description":"Retrieves a list of members that match the request criteria for a channel.","security":[{"bearerAuth":[]}]}},"/youtube/v3/membershipsLevels":{"get":{"tags":["Memberships Levels"],"parameters":[{"name":"part","in":"query","description":"The *part* parameter specifies the membershipsLevel resource parts that the API response will include. Supported values are id and snippet.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/membershipsLevels/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/membershipsLevels"},"summary":"Retrieves a list of all pricing levels offered by a creator to the fans.","description":"Retrieves a list of all pricing levels offered by a creator to the fans.","security":[{"bearerAuth":[]}]}},"/youtube/v3/playlistImages":{"get":{"tags":["Playlist Images"],"parameters":[{"name":"maxResults","in":"query","description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","required":false,"schema":{"type":"number","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwnerChannel","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"pageToken","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"parent","in":"query","description":"Return PlaylistImages for this playlist id.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/playlistImages/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/playlistImages"},"summary":"Retrieves a list of resources, possibly filtered. (Playlist Images list)","description":"Retrieves a list of resources, possibly filtered.","security":[{"bearerAuth":[]}]},"post":{"tags":["Playlist Images"],"parameters":[{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwnerChannel","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"The *part* parameter specifies the properties that the API response will include.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/playlistImages/insert","api_endpoint":"https://youtube.googleapis.com/youtube/v3/playlistImages"},"summary":"Inserts a new resource into this collection. (Playlist Images insert)","description":"Inserts a new resource into this collection.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"string","description":"Identifies this resource (playlist id and image type)."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#playlistImages\"."},"snippet":{"type":"object","description":"snippet field","properties":{"type":{"type":"string","description":"The image type.","enum":["hero"]},"height":{"type":"number","description":"The image height."},"playlistId":{"type":"string","description":"The Playlist ID of the playlist this image is associated with."},"width":{"type":"number","description":"The image width."}}}}},"example":{"id":"resource-id","kind":"example-kind","snippet":"example-snippet"}}}}},"put":{"tags":["Playlist Images"],"parameters":[{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"The *part* parameter specifies the properties that the API response will include.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/playlistImages/update","api_endpoint":"https://youtube.googleapis.com/youtube/v3/playlistImages"},"summary":"Updates an existing resource. (Playlist Images update)","description":"Updates an existing resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"string","description":"Identifies this resource (playlist id and image type)."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#playlistImages\"."},"snippet":{"type":"object","description":"snippet field","properties":{"type":{"type":"string","description":"The image type.","enum":["hero"]},"height":{"type":"number","description":"The image height."},"playlistId":{"type":"string","description":"The Playlist ID of the playlist this image is associated with."},"width":{"type":"number","description":"The image width."}}}}},"example":{"id":"resource-id","kind":"example-kind","snippet":"example-snippet"}}}}},"delete":{"tags":["Playlist Images"],"parameters":[{"name":"id","in":"query","description":"Id to identify this image. This is returned from by the List method.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/playlistImages/delete","api_endpoint":"https://youtube.googleapis.com/youtube/v3/playlistImages"},"summary":"Deletes a resource. (Playlist Images delete)","description":"Deletes a resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/youtube/v3/playlistItems":{"get":{"tags":["Playlist Items"],"parameters":[{"name":"id","in":"query","description":"Id","required":false,"schema":{"type":"string","example":""}},{"name":"maxResults","in":"query","description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","required":false,"schema":{"type":"number","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"pageToken","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}},{"name":"playlistId","in":"query","description":"Return the playlist items within the given playlist.","required":false,"schema":{"type":"string","example":""}},{"name":"videoId","in":"query","description":"Return the playlist items associated with the given video ID.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/playlistItems/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/playlistItems"},"summary":"Retrieves a list of resources, possibly filtered.","description":"Retrieves a list of resources, possibly filtered.","security":[{"bearerAuth":[]}]},"put":{"tags":["Playlist Items"],"parameters":[{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/playlistItems/update","api_endpoint":"https://youtube.googleapis.com/youtube/v3/playlistItems"},"summary":"Updates an existing resource.","description":"Updates an existing resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contentDetails":{"type":"object","description":"The contentDetails object is included in the resource if the included item is a YouTube video. The object contains additional information about the video.","properties":{"endAt":{"type":"string","description":"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":{"type":"string","description":"A user-generated note for this item."},"startAt":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The date and time that the video was published to YouTube."}}},"etag":{"type":"string","description":"Etag of this resource."},"id":{"type":"string","description":"The ID that YouTube uses to uniquely identify the playlist item."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#playlistItem\"."},"snippet":{"type":"object","description":"The snippet object contains basic details about the playlist item, such as its title and position in the playlist.","properties":{"channelId":{"type":"string","description":"The ID that YouTube uses to uniquely identify the user that added the item to the playlist."},"channelTitle":{"type":"string","description":"Channel title for the channel that the playlist item belongs to."},"description":{"type":"string","description":"The item's description."},"playlistId":{"type":"string","description":"The ID that YouTube uses to uniquely identify thGe playlist that the playlist item is in."},"position":{"type":"number","description":"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":{"type":"string","description":"The date and time that the item was added to the playlist."},"resourceId":{"type":"object","description":"The id object contains information that can be used to uniquely identify the resource that is included in the playlist as the playlist item."},"thumbnails":{"type":"object","description":"A map of thumbnail images associated with the playlist item. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail."},"title":{"type":"string","description":"The item's title."},"videoOwnerChannelId":{"type":"string","description":"Channel id for the channel this video belongs to."},"videoOwnerChannelTitle":{"type":"string","description":"Channel title for the channel this video belongs to."}}},"status":{"type":"object","description":"The status object contains information about the playlist item's privacy status.","properties":{"privacyStatus":{"type":"string","description":"This resource's privacy status.","enum":["public","unlisted","private"]}}}}},"example":{"contentDetails":"example-contentdetails","etag":"example-etag","id":"resource-id","kind":"example-kind","snippet":"example-snippet","status":"example-status"}}}}},"delete":{"tags":["Playlist Items"],"parameters":[{"name":"id","in":"query","description":"Id","required":true,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/playlistItems/delete","api_endpoint":"https://youtube.googleapis.com/youtube/v3/playlistItems"},"summary":"Deletes a resource.","description":"Deletes a resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"post":{"tags":["Playlist Items"],"parameters":[{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/playlistItems/insert","api_endpoint":"https://youtube.googleapis.com/youtube/v3/playlistItems"},"summary":"Inserts a new resource into this collection. (Playlist Items insert)","description":"Inserts a new resource into this collection.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contentDetails":{"type":"object","description":"The contentDetails object is included in the resource if the included item is a YouTube video. The object contains additional information about the video.","properties":{"endAt":{"type":"string","description":"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":{"type":"string","description":"A user-generated note for this item."},"startAt":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The date and time that the video was published to YouTube."}}},"etag":{"type":"string","description":"Etag of this resource."},"id":{"type":"string","description":"The ID that YouTube uses to uniquely identify the playlist item."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#playlistItem\"."},"snippet":{"type":"object","description":"The snippet object contains basic details about the playlist item, such as its title and position in the playlist.","properties":{"channelId":{"type":"string","description":"The ID that YouTube uses to uniquely identify the user that added the item to the playlist."},"channelTitle":{"type":"string","description":"Channel title for the channel that the playlist item belongs to."},"description":{"type":"string","description":"The item's description."},"playlistId":{"type":"string","description":"The ID that YouTube uses to uniquely identify thGe playlist that the playlist item is in."},"position":{"type":"number","description":"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":{"type":"string","description":"The date and time that the item was added to the playlist."},"resourceId":{"type":"object","description":"The id object contains information that can be used to uniquely identify the resource that is included in the playlist as the playlist item."},"thumbnails":{"type":"object","description":"A map of thumbnail images associated with the playlist item. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail."},"title":{"type":"string","description":"The item's title."},"videoOwnerChannelId":{"type":"string","description":"Channel id for the channel this video belongs to."},"videoOwnerChannelTitle":{"type":"string","description":"Channel title for the channel this video belongs to."}}},"status":{"type":"object","description":"The status object contains information about the playlist item's privacy status.","properties":{"privacyStatus":{"type":"string","description":"This resource's privacy status.","enum":["public","unlisted","private"]}}}}},"example":{"contentDetails":"example-contentdetails","etag":"example-etag","id":"resource-id","kind":"example-kind","snippet":"example-snippet","status":"example-status"}}}}}},"/youtube/v3/playlists":{"get":{"tags":["Playlists"],"parameters":[{"name":"channelId","in":"query","description":"Return the playlists owned by the specified channel ID.","required":false,"schema":{"type":"string","example":""}},{"name":"hl","in":"query","description":"Return content in specified language","required":false,"schema":{"type":"string","example":""}},{"name":"id","in":"query","description":"Return the playlists with the given IDs for Stubby or Apiary.","required":false,"schema":{"type":"string","example":""}},{"name":"maxResults","in":"query","description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","required":false,"schema":{"type":"number","example":""}},{"name":"mine","in":"query","description":"Return the playlists owned by the authenticated user.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwnerChannel","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"pageToken","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/playlists/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/playlists"},"summary":"Retrieves a list of resources, possibly filtered. (Playlists list)","description":"Retrieves a list of resources, possibly filtered.","security":[{"bearerAuth":[]}]},"put":{"tags":["Playlists"],"parameters":[{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/playlists/update","api_endpoint":"https://youtube.googleapis.com/youtube/v3/playlists"},"summary":"Updates an existing resource. (Playlists update)","description":"Updates an existing resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contentDetails":{"type":"object","description":"The contentDetails object contains information like video count.","properties":{"itemCount":{"type":"number","description":"The number of videos in the playlist."}}},"etag":{"type":"string","description":"Etag of this resource."},"id":{"type":"string","description":"The ID that YouTube uses to uniquely identify the playlist."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#playlist\"."},"localizations":{"type":"object","description":"Localizations for different languages (map keyed by string, values are PlaylistLocalization objects)","properties":{"description":{"type":"string","description":"The localized strings for playlist's description."},"title":{"type":"string","description":"The localized strings for playlist's title."}}},"player":{"type":"object","description":"The player object contains information that you would use to play the playlist in an embedded player.","properties":{"embedHtml":{"type":"string","description":"An <iframe> tag that embeds a player that will play the playlist."}}},"snippet":{"type":"object","description":"The snippet object contains basic details about the playlist, such as its title and description.","properties":{"channelId":{"type":"string","description":"The ID that YouTube uses to uniquely identify the channel that published the playlist."},"channelTitle":{"type":"string","description":"The channel title of the channel that the video belongs to."},"defaultLanguage":{"type":"string","description":"The language of the playlist's default title and description."},"description":{"type":"string","description":"The playlist's description."},"localized":{"type":"object","description":"Localized title and description, read-only."},"publishedAt":{"type":"string","description":"The date and time that the playlist was created."},"tags":{"type":"array","description":"Keyword tags associated with the playlist."},"thumbnailVideoId":{"type":"string","description":"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":{"type":"object","description":"A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail."},"title":{"type":"string","description":"The playlist's title."}}},"status":{"type":"object","description":"The status object contains status information for the playlist.","properties":{"podcastStatus":{"type":"string","description":"The playlist's podcast status.","enum":["enabled","disabled"]},"privacyStatus":{"type":"string","description":"The playlist's privacy status.","enum":["public","unlisted","private"]}}}}},"example":{"contentDetails":"example-contentdetails","etag":"example-etag","id":"resource-id","kind":"example-kind","localizations":"example-localizations","player":"example-player","snippet":"example-snippet","status":"example-status"}}}}},"delete":{"tags":["Playlists"],"parameters":[{"name":"id","in":"query","description":"Id","required":true,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/playlists/delete","api_endpoint":"https://youtube.googleapis.com/youtube/v3/playlists"},"summary":"Deletes a resource. (Playlists delete)","description":"Deletes a resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"post":{"tags":["Playlists"],"parameters":[{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwnerChannel","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/playlists/insert","api_endpoint":"https://youtube.googleapis.com/youtube/v3/playlists"},"summary":"Inserts a new resource into this collection. (Playlists insert)","description":"Inserts a new resource into this collection.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contentDetails":{"type":"object","description":"The contentDetails object contains information like video count.","properties":{"itemCount":{"type":"number","description":"The number of videos in the playlist."}}},"etag":{"type":"string","description":"Etag of this resource."},"id":{"type":"string","description":"The ID that YouTube uses to uniquely identify the playlist."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#playlist\"."},"localizations":{"type":"object","description":"Localizations for different languages (map keyed by string, values are PlaylistLocalization objects)","properties":{"description":{"type":"string","description":"The localized strings for playlist's description."},"title":{"type":"string","description":"The localized strings for playlist's title."}}},"player":{"type":"object","description":"The player object contains information that you would use to play the playlist in an embedded player.","properties":{"embedHtml":{"type":"string","description":"An <iframe> tag that embeds a player that will play the playlist."}}},"snippet":{"type":"object","description":"The snippet object contains basic details about the playlist, such as its title and description.","properties":{"channelId":{"type":"string","description":"The ID that YouTube uses to uniquely identify the channel that published the playlist."},"channelTitle":{"type":"string","description":"The channel title of the channel that the video belongs to."},"defaultLanguage":{"type":"string","description":"The language of the playlist's default title and description."},"description":{"type":"string","description":"The playlist's description."},"localized":{"type":"object","description":"Localized title and description, read-only."},"publishedAt":{"type":"string","description":"The date and time that the playlist was created."},"tags":{"type":"array","description":"Keyword tags associated with the playlist."},"thumbnailVideoId":{"type":"string","description":"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":{"type":"object","description":"A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail."},"title":{"type":"string","description":"The playlist's title."}}},"status":{"type":"object","description":"The status object contains status information for the playlist.","properties":{"podcastStatus":{"type":"string","description":"The playlist's podcast status.","enum":["enabled","disabled"]},"privacyStatus":{"type":"string","description":"The playlist's privacy status.","enum":["public","unlisted","private"]}}}}},"example":{"contentDetails":"example-contentdetails","etag":"example-etag","id":"resource-id","kind":"example-kind","localizations":"example-localizations","player":"example-player","snippet":"example-snippet","status":"example-status"}}}}}},"/youtube/v3/search":{"get":{"tags":["Search"],"parameters":[{"name":"type","in":"query","description":"Restrict results to a particular set of resource types from One Platform.","required":false,"schema":{"type":"string","example":""}},{"name":"channelId","in":"query","description":"Filter on resources belonging to this channelId. (Force TAP rebuild)","required":false,"schema":{"type":"string","example":""}},{"name":"channelType","in":"query","description":"Add a filter on the channel search.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["channelTypeUnspecified","any","show"]}}},{"name":"eventType","in":"query","description":"Filter on the livestream status of the videos.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["none","upcoming","live","completed"]}}},{"name":"forContentOwner","in":"query","description":"Search owned by a content owner.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"forDeveloper","in":"query","description":"Restrict the search to only retrieve videos uploaded using the project id of the authenticated user.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"forMine","in":"query","description":"Search for the private videos of the authenticated user.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"location","in":"query","description":"Filter on location of the video","required":false,"schema":{"type":"string","example":""}},{"name":"locationRadius","in":"query","description":"Filter on distance from the location (specified above).","required":false,"schema":{"type":"string","example":""}},{"name":"maxResults","in":"query","description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","required":false,"schema":{"type":"number","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"Sort order of the results.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["searchSortUnspecified","date","rating","viewCount","relevance","title","videoCount"]}}},{"name":"pageToken","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}},{"name":"publishedAfter","in":"query","description":"Filter on resources published after this date.","required":false,"schema":{"type":"string","example":""}},{"name":"publishedBefore","in":"query","description":"Filter on resources published before this date.","required":false,"schema":{"type":"string","example":""}},{"name":"q","in":"query","description":"Textual search terms to match.","required":false,"schema":{"type":"string","example":""}},{"name":"regionCode","in":"query","description":"Display the content as seen by viewers in this country.","required":false,"schema":{"type":"string","example":""}},{"name":"relevanceLanguage","in":"query","description":"Return results relevant to this language.","required":false,"schema":{"type":"string","example":""}},{"name":"safeSearch","in":"query","description":"Indicates whether the search results should include restricted content as well as standard content.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["safeSearchSettingUnspecified","none","moderate","strict"]}}},{"name":"topicId","in":"query","description":"Restrict results to a particular topic.","required":false,"schema":{"type":"string","example":""}},{"name":"videoCaption","in":"query","description":"Filter on the presence of captions on the videos.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["videoCaptionUnspecified","any","closedCaption","none"]}}},{"name":"videoCategoryId","in":"query","description":"Filter on videos in a specific category.","required":false,"schema":{"type":"string","example":""}},{"name":"videoDefinition","in":"query","description":"Filter on the definition of the videos.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["any","standard","high"]}}},{"name":"videoDimension","in":"query","description":"Filter on 3d videos.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["any","2d","3d"]}}},{"name":"videoDuration","in":"query","description":"Filter on the duration of the videos.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["videoDurationUnspecified","any","short","medium","long"]}}},{"name":"videoEmbeddable","in":"query","description":"Filter on embeddable videos.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["videoEmbeddableUnspecified","any","true"]}}},{"name":"videoLicense","in":"query","description":"Filter on the license of the videos.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["any","youtube","creativeCommon"]}}},{"name":"videoPaidProductPlacement","in":"query","description":"Video Paid Product Placement","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["videoPaidProductPlacementUnspecified","any","true"]}}},{"name":"videoSyndicated","in":"query","description":"Filter on syndicated videos.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["videoSyndicatedUnspecified","any","true"]}}},{"name":"videoType","in":"query","description":"Filter on videos of a specific type.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["videoTypeUnspecified","any","movie","episode"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/search/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/search"},"summary":"Retrieves a list of search resources","description":"Retrieves a list of search resources","security":[{"bearerAuth":[]}]}},"/youtube/v3/subscriptions":{"get":{"tags":["Subscriptions"],"parameters":[{"name":"channelId","in":"query","description":"Return the subscriptions of the given channel owner.","required":false,"schema":{"type":"string","example":""}},{"name":"forChannelId","in":"query","description":"Return the subscriptions to the subset of these channels that the authenticated user is subscribed to.","required":false,"schema":{"type":"string","example":""}},{"name":"id","in":"query","description":"Return the subscriptions with the given IDs for Stubby or Apiary.","required":false,"schema":{"type":"string","example":""}},{"name":"maxResults","in":"query","description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","required":false,"schema":{"type":"number","example":""}},{"name":"mine","in":"query","description":"Flag for returning the subscriptions of the authenticated user.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"myRecentSubscribers","in":"query","description":"My Recent Subscribers","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"mySubscribers","in":"query","description":"Return the subscribers of the given channel owner.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwnerChannel","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"The order of the returned subscriptions","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["subscriptionOrderUnspecified","relevance","unread","alphabetical"]}}},{"name":"pageToken","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/subscriptions/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/subscriptions"},"summary":"Retrieves a list of resources, possibly filtered. (Subscriptions list)","description":"Retrieves a list of resources, possibly filtered.","security":[{"bearerAuth":[]}]},"post":{"tags":["Subscriptions"],"parameters":[{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/subscriptions/insert","api_endpoint":"https://youtube.googleapis.com/youtube/v3/subscriptions"},"summary":"Inserts a new resource into this collection. (Subscriptions insert)","description":"Inserts a new resource into this collection.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contentDetails":{"type":"object","description":"The contentDetails object contains basic statistics about the subscription.","properties":{"activityType":{"type":"string","description":"The type of activity this subscription is for (only uploads, everything).","enum":["subscriptionActivityTypeUnspecified","all","uploads"]},"newItemCount":{"type":"number","description":"The number of new items in the subscription since its content was last read."},"totalItemCount":{"type":"number","description":"The approximate number of items that the subscription points to."}}},"etag":{"type":"string","description":"Etag of this resource."},"id":{"type":"string","description":"The ID that YouTube uses to uniquely identify the subscription."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#subscription\"."},"snippet":{"type":"object","description":"The snippet object contains basic details about the subscription, including its title and the channel that the user subscribed to.","properties":{"channelId":{"type":"string","description":"The ID that YouTube uses to uniquely identify the subscriber's channel."},"description":{"type":"string","description":"The subscription's details."},"publishedAt":{"type":"string","description":"The date and time that the subscription was created."},"resourceId":{"type":"object","description":"The id object contains information about the channel that the user subscribed to."},"thumbnails":{"type":"object","description":"A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail."},"title":{"type":"string","description":"The subscription's title."}}},"subscriberSnippet":{"type":"object","description":"The subscriberSnippet object contains basic details about the subscriber.","properties":{"channelId":{"type":"string","description":"The channel ID of the subscriber."},"description":{"type":"string","description":"The description of the subscriber."},"thumbnails":{"type":"object","description":"Thumbnails for this subscriber."},"title":{"type":"string","description":"The title of the subscriber."}}}}},"example":{"contentDetails":"example-contentdetails","etag":"example-etag","id":"resource-id","kind":"example-kind","snippet":"example-snippet","subscriberSnippet":"example-subscribersnippet"}}}}},"delete":{"tags":["Subscriptions"],"parameters":[{"name":"id","in":"query","description":"Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/subscriptions/delete","api_endpoint":"https://youtube.googleapis.com/youtube/v3/subscriptions"},"summary":"Deletes a resource. (Subscriptions delete)","description":"Deletes a resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/youtube/v3/superChatEvents":{"get":{"tags":["Super Chat Events"],"parameters":[{"name":"hl","in":"query","description":"Return rendered funding amounts in specified language.","required":false,"schema":{"type":"string","example":""}},{"name":"maxResults","in":"query","description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","required":false,"schema":{"type":"number","example":""}},{"name":"pageToken","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"The *part* parameter specifies the superChatEvent resource parts that the API response will include. This parameter is currently not supported.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/live/docs/superChatEvents/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/superChatEvents"},"summary":"Retrieves a list of resources, possibly filtered. (Super Chat Events list)","description":"Retrieves a list of resources, possibly filtered.","security":[{"bearerAuth":[]}]}},"/youtube/v3/thirdPartyLinks":{"get":{"tags":["Third Party Links"],"parameters":[{"name":"type","in":"query","description":"Get a third party link of the given type.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["linkUnspecified","channelToStoreLink","channelToAffiliateProgramLink"]}}},{"name":"externalChannelId","in":"query","description":"Channel ID to which changes should be applied, for delegation.","required":false,"schema":{"type":"string","example":""}},{"name":"linkingToken","in":"query","description":"Get a third party link with the given linking token.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"The *part* parameter specifies the thirdPartyLink resource parts that the API response will include. Supported values are linkingToken, status, and snippet.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://youtube.googleapis.com/$discovery/rest?version=v3","api_endpoint":"https://youtube.googleapis.com/youtube/v3/thirdPartyLinks"},"summary":"Retrieves a list of resources, possibly filtered. (Third Party Links list)","description":"Retrieves a list of resources, possibly filtered.","security":[{"bearerAuth":[]}]},"post":{"tags":["Third Party Links"],"parameters":[{"name":"externalChannelId","in":"query","description":"Channel ID to which changes should be applied, for delegation.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"The *part* parameter specifies the thirdPartyLink resource parts that the API request and response will include. Supported values are linkingToken, status, and snippet.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://youtube.googleapis.com/$discovery/rest?version=v3","api_endpoint":"https://youtube.googleapis.com/youtube/v3/thirdPartyLinks"},"summary":"Inserts a new resource into this collection. (Third Party Links insert)","description":"Inserts a new resource into this collection.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"etag":{"type":"string","description":"Etag of this resource"},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#thirdPartyLink\"."},"linkingToken":{"type":"string","description":"The linking_token identifies a YouTube account and channel with which the third party account is linked."},"snippet":{"type":"object","description":"The snippet object contains basic details about the third- party account link.","properties":{"type":{"type":"string","description":"Type of the link named after the entities that are being linked.","enum":["linkUnspecified","channelToStoreLink","channelToAffiliateProgramLink"]},"channelToAffiliateProgramLink":{"type":"object","description":"Information specific to a link between a channel and an affiliate program of a partner."},"channelToStoreLink":{"type":"object","description":"Information specific to a link between a channel and a store on a merchandising platform."}}},"status":{"type":"object","description":"The status object contains information about the status of the link.","properties":{"linkStatus":{"type":"string","description":"linkStatus field","enum":["unknown","failed","pending","linked"]}}}}},"example":{"etag":"example-etag","kind":"example-kind","linkingToken":"page-token","snippet":"example-snippet","status":"example-status"}}}}},"put":{"tags":["Third Party Links"],"parameters":[{"name":"externalChannelId","in":"query","description":"Channel ID to which changes should be applied, for delegation.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"The *part* parameter specifies the thirdPartyLink resource parts that the API request and response will include. Supported values are linkingToken, status, and snippet.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://youtube.googleapis.com/$discovery/rest?version=v3","api_endpoint":"https://youtube.googleapis.com/youtube/v3/thirdPartyLinks"},"summary":"Updates an existing resource. (Third Party Links update)","description":"Updates an existing resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"etag":{"type":"string","description":"Etag of this resource"},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#thirdPartyLink\"."},"linkingToken":{"type":"string","description":"The linking_token identifies a YouTube account and channel with which the third party account is linked."},"snippet":{"type":"object","description":"The snippet object contains basic details about the third- party account link.","properties":{"type":{"type":"string","description":"Type of the link named after the entities that are being linked.","enum":["linkUnspecified","channelToStoreLink","channelToAffiliateProgramLink"]},"channelToAffiliateProgramLink":{"type":"object","description":"Information specific to a link between a channel and an affiliate program of a partner."},"channelToStoreLink":{"type":"object","description":"Information specific to a link between a channel and a store on a merchandising platform."}}},"status":{"type":"object","description":"The status object contains information about the status of the link.","properties":{"linkStatus":{"type":"string","description":"linkStatus field","enum":["unknown","failed","pending","linked"]}}}}},"example":{"etag":"example-etag","kind":"example-kind","linkingToken":"page-token","snippet":"example-snippet","status":"example-status"}}}}},"delete":{"tags":["Third Party Links"],"parameters":[{"name":"type","in":"query","description":"Type of the link to be deleted.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["linkUnspecified","channelToStoreLink","channelToAffiliateProgramLink"]}}},{"name":"externalChannelId","in":"query","description":"Channel ID to which changes should be applied, for delegation.","required":false,"schema":{"type":"string","example":""}},{"name":"linkingToken","in":"query","description":"Delete the partner links with the given linking token.","required":true,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"Do not use. Required for compatibility.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://youtube.googleapis.com/$discovery/rest?version=v3","api_endpoint":"https://youtube.googleapis.com/youtube/v3/thirdPartyLinks"},"summary":"Deletes a resource. (Third Party Links delete)","description":"Deletes a resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/youtube/v3/videoAbuseReportReasons":{"get":{"tags":["Video Abuse Report Reasons"],"parameters":[{"name":"hl","in":"query","description":"Hl","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"The *part* parameter specifies the videoCategory resource parts that the API response will include. Supported values are id and snippet.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/videoAbuseReportReasons/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/videoAbuseReportReasons"},"summary":"Retrieves a list of resources, possibly filtered. (Video Abuse Report Reasons list)","description":"Retrieves a list of resources, possibly filtered.","security":[{"bearerAuth":[]}]}},"/youtube/v3/videoCategories":{"get":{"tags":["Video Categories"],"parameters":[{"name":"hl","in":"query","description":"Hl","required":false,"schema":{"type":"string","example":""}},{"name":"id","in":"query","description":"Returns the video categories with the given IDs for Stubby or Apiary.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"The *part* parameter specifies the videoCategory resource properties that the API response will include. Set the parameter value to snippet.","required":true,"schema":{"type":"string","example":""}},{"name":"regionCode","in":"query","description":"Region Code","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/videoCategories/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/videoCategories"},"summary":"Retrieves a list of resources, possibly filtered. (Video Categories list)","description":"Retrieves a list of resources, possibly filtered.","security":[{"bearerAuth":[]}]}},"/youtube/v3/videoTrainability":{"get":{"tags":["Video Trainability"],"parameters":[{"name":"id","in":"query","description":"The ID of the video to retrieve.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://youtube.googleapis.com/$discovery/rest?version=v3","api_endpoint":"https://youtube.googleapis.com/youtube/v3/videoTrainability"},"summary":"Returns the trainability status of a video.","description":"Returns the trainability status of a video.","security":[{"bearerAuth":[]}]}},"/youtube/v3/videos":{"get":{"tags":["Videos"],"parameters":[{"name":"chart","in":"query","description":"Return the videos that are in the specified chart.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["chartUnspecified","mostPopular"]}}},{"name":"hl","in":"query","description":"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).","required":false,"schema":{"type":"string","example":""}},{"name":"id","in":"query","description":"Return videos with the given ids.","required":false,"schema":{"type":"string","example":""}},{"name":"locale","in":"query","description":"Locale","required":false,"schema":{"type":"string","example":""}},{"name":"maxHeight","in":"query","description":"Max Height","required":false,"schema":{"type":"number","example":""}},{"name":"maxResults","in":"query","description":"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.","required":false,"schema":{"type":"number","example":""}},{"name":"maxWidth","in":"query","description":"Return the player with maximum height specified in","required":false,"schema":{"type":"number","example":""}},{"name":"myRating","in":"query","description":"Return videos liked/disliked by the authenticated user. Does not support RateType.RATED_TYPE_NONE.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["none","like","dislike"]}}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"pageToken","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}},{"name":"regionCode","in":"query","description":"Use a chart that is specific to the specified region","required":false,"schema":{"type":"string","example":""}},{"name":"videoCategoryId","in":"query","description":"Use chart that is specific to the specified video category","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/videos/list","api_endpoint":"https://youtube.googleapis.com/youtube/v3/videos"},"summary":"Retrieves a list of resources, possibly filtered. (Videos list)","description":"Retrieves a list of resources, possibly filtered.","security":[{"bearerAuth":[]}]},"post":{"tags":["Videos"],"parameters":[{"name":"autoLevels","in":"query","description":"Should auto-levels be applied to the upload.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"notifySubscribers","in":"query","description":"Notify the channel subscribers about the new video. As default, the notification is enabled.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwnerChannel","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}},{"name":"stabilize","in":"query","description":"Should stabilize be applied to the upload.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/videos/insert","api_endpoint":"https://youtube.googleapis.com/youtube/v3/videos"},"summary":"Inserts a new resource into this collection. (Videos insert)","description":"Inserts a new resource into this collection.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"ageGating":{"type":"object","description":"Age restriction details related to a video. This data can only be retrieved by the video owner.","properties":{"alcoholContent":{"type":"boolean","description":"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.","enum":[true,false]},"restricted":{"type":"boolean","description":"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.","enum":[true,false]},"videoGameRating":{"type":"string","description":"Video game rating, if any.","enum":["anyone","m15Plus","m16Plus","m17Plus"]}}},"brandPartner":{"type":"object","description":"brandPartner field","properties":{"channelHandle":{"type":"string","description":"Required. Channel handle, must begin with \"@\""},"channelId":{"type":"string","description":"Required. External Channel ID, must begin with \"UC\""}}},"contentDetails":{"type":"object","description":"The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.","properties":{"caption":{"type":"string","description":"The value of captions indicates whether the video has captions or not.","enum":["true","false"]},"contentRating":{"type":"object","description":"Specifies the ratings that the video received under various rating schemes."},"countryRestriction":{"type":"object","description":"The countryRestriction object contains information about the countries where a video is (or is not) viewable."},"definition":{"type":"string","description":"The value of definition indicates whether the video is available in high definition or only in standard definition.","enum":["sd","hd"]},"dimension":{"type":"string","description":"The value of dimension indicates whether the video is available in 3D or in 2D."},"duration":{"type":"string","description":"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":{"type":"boolean","description":"Indicates whether the video uploader has provided a custom thumbnail image for the video. This property is only visible to the video uploader.","enum":[true,false]},"licensedContent":{"type":"boolean","description":"The value of is_license_content indicates whether the video is licensed content.","enum":[true,false]},"projection":{"type":"string","description":"Specifies the projection format of the video.","enum":["rectangular","360"]},"regionRestriction":{"type":"object","description":"The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property."}}},"etag":{"type":"string","description":"Etag of this resource."},"fileDetails":{"type":"object","description":"The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the file's resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner.","properties":{"audioStreams":{"type":"array","description":"A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream. (array of objects)"},"bitrateBps":{"type":"string","description":"The uploaded video file's combined (video and audio) bitrate in bits per second."},"container":{"type":"string","description":"The uploaded video file's container format."},"creationTime":{"type":"string","description":"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":{"type":"string","description":"The length of the uploaded video in milliseconds."},"fileName":{"type":"string","description":"The uploaded file's name. This field is present whether a video file or another type of file was uploaded."},"fileSize":{"type":"string","description":"The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded."},"fileType":{"type":"string","description":"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.","enum":["video","audio","image","archive","document","project","other"]},"videoStreams":{"type":"array","description":"A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream. (array of objects)"}}},"id":{"type":"string","description":"The ID that YouTube uses to uniquely identify the video."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#video\"."},"liveStreamingDetails":{"type":"object","description":"The liveStreamingDetails object contains metadata about a live video broadcast. The object will only be present in a video resource if the video is an upcoming, live, or completed live broadcast.","properties":{"activeLiveChatId":{"type":"string","description":"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":{"type":"string","description":"The time that the broadcast actually ended. This value will not be available until the broadcast is over."},"actualStartTime":{"type":"string","description":"The time that the broadcast actually started. This value will not be available until the broadcast begins."},"concurrentViewers":{"type":"string","description":"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":{"type":"string","description":"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 continue indefinitely."},"scheduledStartTime":{"type":"string","description":"The time that the broadcast is scheduled to begin."}}},"localizations":{"type":"object","description":"The localizations object contains localized versions of the basic details about the video, such as its title and description. (map keyed by string, values are VideoLocalization objects)","properties":{"description":{"type":"string","description":"Localized version of the video's description."},"title":{"type":"string","description":"Localized version of the video's title."}}},"monetizationDetails":{"type":"object","description":"The monetizationDetails object encapsulates information about the monetization status of the video.","properties":{"access":{"type":"object","description":"The value of access indicates whether the video can be monetized or not."}}},"paidProductPlacementDetails":{"type":"object","description":"paidProductPlacementDetails field","properties":{"hasPaidProductPlacement":{"type":"boolean","description":"This boolean represents whether the video contains Paid Product Placement, Studio equivalent: https://screenshot.googleplex.com/4Me79DE6AfT2ktp.png","enum":[true,false]}}},"player":{"type":"object","description":"The player object contains information that you would use to play the video in an embedded player.","properties":{"embedHeight":{"type":"string","description":"embedHeight field"},"embedHtml":{"type":"string","description":"An <iframe> tag that embeds a player that will play the video."},"embedWidth":{"type":"string","description":"The embed width"}}},"processingDetails":{"type":"object","description":"The processingDetails object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video. The processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner.","properties":{"editorSuggestionsAvailability":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed.","enum":["uploadFailed","transcodeFailed","streamingFailed","other"]},"processingIssuesAvailability":{"type":"string","description":"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."},"processingProgress":{"type":"object","description":"The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing."},"processingStatus":{"type":"string","description":"The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed.","enum":["processing","succeeded","failed","terminated"]},"tagSuggestionsAvailability":{"type":"string","description":"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":{"type":"string","description":"This value indicates whether thumbnail images have been generated for the video."}}},"projectDetails":{"type":"object","description":"The projectDetails object contains information about the project specific video metadata. 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","properties":{}},"recordingDetails":{"type":"object","description":"The recordingDetails object encapsulates information about the location, date and address where the video was recorded.","properties":{"location":{"type":"object","description":"The geolocation information associated with the video."},"locationDescription":{"type":"string","description":"The text description of the location where the video was recorded."},"recordingDate":{"type":"string","description":"The date and time when the video was recorded."}}},"snippet":{"type":"object","description":"The snippet object contains basic details about the video, such as its title, description, and category.","properties":{"categoryId":{"type":"string","description":"The YouTube video category associated with the video."},"channelId":{"type":"string","description":"The ID that YouTube uses to uniquely identify the channel that the video was uploaded to."},"channelTitle":{"type":"string","description":"Channel title for the channel that the video belongs to."},"defaultAudioLanguage":{"type":"string","description":"The default_audio_language property specifies the language spoken in the video's default audio track."},"defaultLanguage":{"type":"string","description":"The language of the videos's default snippet."},"description":{"type":"string","description":"The video's description. @mutable youtube.videos.insert youtube.videos.update"},"liveBroadcastContent":{"type":"string","description":"Indicates if the video is an upcoming/active live broadcast. Or it's \"none\" if the video is not an upcoming/active live broadcast.","enum":["none","upcoming","live","completed"]},"localized":{"type":"object","description":"Localized snippet selected with the hl parameter. If no such localization exists, this field is populated with the default snippet. (Read-only)"},"publishedAt":{"type":"string","description":"The date and time when the video was uploaded."},"tags":{"type":"array","description":"A list of keyword tags associated with the video. Tags may contain spaces."},"thumbnails":{"type":"object","description":"A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail."},"title":{"type":"string","description":"The video's title. @mutable youtube.videos.insert youtube.videos.update"}}},"statistics":{"type":"object","description":"The statistics object contains statistics about the video.","properties":{"commentCount":{"type":"string","description":"The number of comments for the video."},"dislikeCount":{"type":"string","description":"The number of users who have indicated that they disliked the video by giving it a negative rating."},"favoriteCount":{"type":"string","description":"The number of users who currently have the video marked as a favorite video."},"likeCount":{"type":"string","description":"The number of users who have indicated that they liked the video by giving it a positive rating."},"viewCount":{"type":"string","description":"The number of times the video has been viewed."}}},"status":{"type":"object","description":"The status object contains information about the video's uploading, processing, and privacy statuses.","properties":{"containsSyntheticMedia":{"type":"boolean","description":"Indicates if the video contains altered or synthetic media.","enum":[true,false]},"embeddable":{"type":"boolean","description":"This value indicates if the video can be embedded on another website. @mutable youtube.videos.insert youtube.videos.update","enum":[true,false]},"failureReason":{"type":"string","description":"This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.","enum":["conversion","invalidFile","emptyFile","tooSmall","codec","uploadAborted"]},"license":{"type":"string","description":"The video's license. @mutable youtube.videos.insert youtube.videos.update","enum":["youtube","creativeCommon"]},"madeForKids":{"type":"boolean","description":"madeForKids field","enum":[true,false]},"privacyStatus":{"type":"string","description":"The video's privacy status.","enum":["public","unlisted","private"]},"publicStatsViewable":{"type":"boolean","description":"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","enum":[true,false]},"publishAt":{"type":"string","description":"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":{"type":"string","description":"This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.","enum":["copyright","inappropriate","duplicate","termsOfUse","uploaderAccountSuspended","length","claim","uploaderAccountClosed","trademark","legal"]},"selfDeclaredMadeForKids":{"type":"boolean","description":"selfDeclaredMadeForKids field","enum":[true,false]},"uploadStatus":{"type":"string","description":"The status of the uploaded video.","enum":["uploaded","processed","failed","rejected","deleted"]}}},"suggestions":{"type":"object","description":"The suggestions object encapsulates suggestions that identify opportunities to improve the video quality or the metadata for the uploaded video. This data can only be retrieved by the video owner.","properties":{"editorSuggestions":{"type":"array","description":"A list of video editing operations that might improve the video quality or playback experience of the uploaded video."},"processingErrors":{"type":"array","description":"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":{"type":"array","description":"A list of suggestions that may improve YouTube's ability to process the video."},"processingWarnings":{"type":"array","description":"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":{"type":"array","description":"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. (array of objects)"}}},"topicDetails":{"type":"object","description":"The topicDetails object encapsulates information about Freebase topics associated with the video.","properties":{"relevantTopicIds":{"type":"array","description":"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":{"type":"array","description":"A list of Wikipedia URLs that provide a high-level description of the video's content."},"topicIds":{"type":"array","description":"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."}}}}},"example":{"ageGating":"example-agegating","brandPartner":"example-brandpartner","contentDetails":"example-contentdetails","etag":"example-etag","fileDetails":"example-filedetails","id":"resource-id","kind":"example-kind","liveStreamingDetails":"example-livestreamingdetails","localizations":"example-localizations","monetizationDetails":"example-monetizationdetails","paidProductPlacementDetails":"resource-id","player":"example-player","processingDetails":"example-processingdetails","projectDetails":"my-gcp-project","recordingDetails":"example-recordingdetails","snippet":"example-snippet","statistics":"example-statistics","status":"example-status","suggestions":"example-suggestions","topicDetails":"example-topicdetails"}}}}},"put":{"tags":["Videos"],"parameters":[{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/videos/update","api_endpoint":"https://youtube.googleapis.com/youtube/v3/videos"},"summary":"Updates an existing resource. (Videos update)","description":"Updates an existing resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ageGating":{"type":"object","description":"Age restriction details related to a video. This data can only be retrieved by the video owner.","properties":{"alcoholContent":{"type":"boolean","description":"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.","enum":[true,false]},"restricted":{"type":"boolean","description":"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.","enum":[true,false]},"videoGameRating":{"type":"string","description":"Video game rating, if any.","enum":["anyone","m15Plus","m16Plus","m17Plus"]}}},"brandPartner":{"type":"object","description":"brandPartner field","properties":{"channelHandle":{"type":"string","description":"Required. Channel handle, must begin with \"@\""},"channelId":{"type":"string","description":"Required. External Channel ID, must begin with \"UC\""}}},"contentDetails":{"type":"object","description":"The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.","properties":{"caption":{"type":"string","description":"The value of captions indicates whether the video has captions or not.","enum":["true","false"]},"contentRating":{"type":"object","description":"Specifies the ratings that the video received under various rating schemes."},"countryRestriction":{"type":"object","description":"The countryRestriction object contains information about the countries where a video is (or is not) viewable."},"definition":{"type":"string","description":"The value of definition indicates whether the video is available in high definition or only in standard definition.","enum":["sd","hd"]},"dimension":{"type":"string","description":"The value of dimension indicates whether the video is available in 3D or in 2D."},"duration":{"type":"string","description":"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":{"type":"boolean","description":"Indicates whether the video uploader has provided a custom thumbnail image for the video. This property is only visible to the video uploader.","enum":[true,false]},"licensedContent":{"type":"boolean","description":"The value of is_license_content indicates whether the video is licensed content.","enum":[true,false]},"projection":{"type":"string","description":"Specifies the projection format of the video.","enum":["rectangular","360"]},"regionRestriction":{"type":"object","description":"The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property."}}},"etag":{"type":"string","description":"Etag of this resource."},"fileDetails":{"type":"object","description":"The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the file's resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner.","properties":{"audioStreams":{"type":"array","description":"A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream. (array of objects)"},"bitrateBps":{"type":"string","description":"The uploaded video file's combined (video and audio) bitrate in bits per second."},"container":{"type":"string","description":"The uploaded video file's container format."},"creationTime":{"type":"string","description":"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":{"type":"string","description":"The length of the uploaded video in milliseconds."},"fileName":{"type":"string","description":"The uploaded file's name. This field is present whether a video file or another type of file was uploaded."},"fileSize":{"type":"string","description":"The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded."},"fileType":{"type":"string","description":"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.","enum":["video","audio","image","archive","document","project","other"]},"videoStreams":{"type":"array","description":"A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream. (array of objects)"}}},"id":{"type":"string","description":"The ID that YouTube uses to uniquely identify the video."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#video\"."},"liveStreamingDetails":{"type":"object","description":"The liveStreamingDetails object contains metadata about a live video broadcast. The object will only be present in a video resource if the video is an upcoming, live, or completed live broadcast.","properties":{"activeLiveChatId":{"type":"string","description":"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":{"type":"string","description":"The time that the broadcast actually ended. This value will not be available until the broadcast is over."},"actualStartTime":{"type":"string","description":"The time that the broadcast actually started. This value will not be available until the broadcast begins."},"concurrentViewers":{"type":"string","description":"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":{"type":"string","description":"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 continue indefinitely."},"scheduledStartTime":{"type":"string","description":"The time that the broadcast is scheduled to begin."}}},"localizations":{"type":"object","description":"The localizations object contains localized versions of the basic details about the video, such as its title and description. (map keyed by string, values are VideoLocalization objects)","properties":{"description":{"type":"string","description":"Localized version of the video's description."},"title":{"type":"string","description":"Localized version of the video's title."}}},"monetizationDetails":{"type":"object","description":"The monetizationDetails object encapsulates information about the monetization status of the video.","properties":{"access":{"type":"object","description":"The value of access indicates whether the video can be monetized or not."}}},"paidProductPlacementDetails":{"type":"object","description":"paidProductPlacementDetails field","properties":{"hasPaidProductPlacement":{"type":"boolean","description":"This boolean represents whether the video contains Paid Product Placement, Studio equivalent: https://screenshot.googleplex.com/4Me79DE6AfT2ktp.png","enum":[true,false]}}},"player":{"type":"object","description":"The player object contains information that you would use to play the video in an embedded player.","properties":{"embedHeight":{"type":"string","description":"embedHeight field"},"embedHtml":{"type":"string","description":"An <iframe> tag that embeds a player that will play the video."},"embedWidth":{"type":"string","description":"The embed width"}}},"processingDetails":{"type":"object","description":"The processingDetails object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video. The processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner.","properties":{"editorSuggestionsAvailability":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed.","enum":["uploadFailed","transcodeFailed","streamingFailed","other"]},"processingIssuesAvailability":{"type":"string","description":"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."},"processingProgress":{"type":"object","description":"The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing."},"processingStatus":{"type":"string","description":"The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed.","enum":["processing","succeeded","failed","terminated"]},"tagSuggestionsAvailability":{"type":"string","description":"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":{"type":"string","description":"This value indicates whether thumbnail images have been generated for the video."}}},"projectDetails":{"type":"object","description":"The projectDetails object contains information about the project specific video metadata. 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","properties":{}},"recordingDetails":{"type":"object","description":"The recordingDetails object encapsulates information about the location, date and address where the video was recorded.","properties":{"location":{"type":"object","description":"The geolocation information associated with the video."},"locationDescription":{"type":"string","description":"The text description of the location where the video was recorded."},"recordingDate":{"type":"string","description":"The date and time when the video was recorded."}}},"snippet":{"type":"object","description":"The snippet object contains basic details about the video, such as its title, description, and category.","properties":{"categoryId":{"type":"string","description":"The YouTube video category associated with the video."},"channelId":{"type":"string","description":"The ID that YouTube uses to uniquely identify the channel that the video was uploaded to."},"channelTitle":{"type":"string","description":"Channel title for the channel that the video belongs to."},"defaultAudioLanguage":{"type":"string","description":"The default_audio_language property specifies the language spoken in the video's default audio track."},"defaultLanguage":{"type":"string","description":"The language of the videos's default snippet."},"description":{"type":"string","description":"The video's description. @mutable youtube.videos.insert youtube.videos.update"},"liveBroadcastContent":{"type":"string","description":"Indicates if the video is an upcoming/active live broadcast. Or it's \"none\" if the video is not an upcoming/active live broadcast.","enum":["none","upcoming","live","completed"]},"localized":{"type":"object","description":"Localized snippet selected with the hl parameter. If no such localization exists, this field is populated with the default snippet. (Read-only)"},"publishedAt":{"type":"string","description":"The date and time when the video was uploaded."},"tags":{"type":"array","description":"A list of keyword tags associated with the video. Tags may contain spaces."},"thumbnails":{"type":"object","description":"A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail."},"title":{"type":"string","description":"The video's title. @mutable youtube.videos.insert youtube.videos.update"}}},"statistics":{"type":"object","description":"The statistics object contains statistics about the video.","properties":{"commentCount":{"type":"string","description":"The number of comments for the video."},"dislikeCount":{"type":"string","description":"The number of users who have indicated that they disliked the video by giving it a negative rating."},"favoriteCount":{"type":"string","description":"The number of users who currently have the video marked as a favorite video."},"likeCount":{"type":"string","description":"The number of users who have indicated that they liked the video by giving it a positive rating."},"viewCount":{"type":"string","description":"The number of times the video has been viewed."}}},"status":{"type":"object","description":"The status object contains information about the video's uploading, processing, and privacy statuses.","properties":{"containsSyntheticMedia":{"type":"boolean","description":"Indicates if the video contains altered or synthetic media.","enum":[true,false]},"embeddable":{"type":"boolean","description":"This value indicates if the video can be embedded on another website. @mutable youtube.videos.insert youtube.videos.update","enum":[true,false]},"failureReason":{"type":"string","description":"This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.","enum":["conversion","invalidFile","emptyFile","tooSmall","codec","uploadAborted"]},"license":{"type":"string","description":"The video's license. @mutable youtube.videos.insert youtube.videos.update","enum":["youtube","creativeCommon"]},"madeForKids":{"type":"boolean","description":"madeForKids field","enum":[true,false]},"privacyStatus":{"type":"string","description":"The video's privacy status.","enum":["public","unlisted","private"]},"publicStatsViewable":{"type":"boolean","description":"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","enum":[true,false]},"publishAt":{"type":"string","description":"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":{"type":"string","description":"This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.","enum":["copyright","inappropriate","duplicate","termsOfUse","uploaderAccountSuspended","length","claim","uploaderAccountClosed","trademark","legal"]},"selfDeclaredMadeForKids":{"type":"boolean","description":"selfDeclaredMadeForKids field","enum":[true,false]},"uploadStatus":{"type":"string","description":"The status of the uploaded video.","enum":["uploaded","processed","failed","rejected","deleted"]}}},"suggestions":{"type":"object","description":"The suggestions object encapsulates suggestions that identify opportunities to improve the video quality or the metadata for the uploaded video. This data can only be retrieved by the video owner.","properties":{"editorSuggestions":{"type":"array","description":"A list of video editing operations that might improve the video quality or playback experience of the uploaded video."},"processingErrors":{"type":"array","description":"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":{"type":"array","description":"A list of suggestions that may improve YouTube's ability to process the video."},"processingWarnings":{"type":"array","description":"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":{"type":"array","description":"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. (array of objects)"}}},"topicDetails":{"type":"object","description":"The topicDetails object encapsulates information about Freebase topics associated with the video.","properties":{"relevantTopicIds":{"type":"array","description":"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":{"type":"array","description":"A list of Wikipedia URLs that provide a high-level description of the video's content."},"topicIds":{"type":"array","description":"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."}}}}},"example":{"ageGating":"example-agegating","brandPartner":"example-brandpartner","contentDetails":"example-contentdetails","etag":"example-etag","fileDetails":"example-filedetails","id":"resource-id","kind":"example-kind","liveStreamingDetails":"example-livestreamingdetails","localizations":"example-localizations","monetizationDetails":"example-monetizationdetails","paidProductPlacementDetails":"resource-id","player":"example-player","processingDetails":"example-processingdetails","projectDetails":"my-gcp-project","recordingDetails":"example-recordingdetails","snippet":"example-snippet","statistics":"example-statistics","status":"example-status","suggestions":"example-suggestions","topicDetails":"example-topicdetails"}}}}},"delete":{"tags":["Videos"],"parameters":[{"name":"id","in":"query","description":"Id","required":true,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/videos/delete","api_endpoint":"https://youtube.googleapis.com/youtube/v3/videos"},"summary":"Deletes a resource. (Videos delete)","description":"Deletes a resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/youtube/v3/videos/batchGetStats":{"get":{"tags":["Videos"],"parameters":[{"name":"id","in":"query","description":"Required. Return videos with the given ids. The number of IDs specified cannot exceed 50.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"Optional. **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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"Required. The **part** parameter specifies a comma-separated list of one or more videoStat 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 videoStat resource, the statistics property contains view_count and like_count. As such, if you set **part=snippet**, the API response will contain all of those properties.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/videos/batchGetStats","api_endpoint":"https://youtube.googleapis.com/youtube/v3/videos:batchGetStats"},"summary":"Retrieves a batch of VideoStat resources, possibly filtered.","description":"Retrieves a batch of VideoStat resources, possibly filtered. BatchGetStats is intentionally not atomic to provide a better user experience.","security":[{"bearerAuth":[]}]}},"/youtube/v3/videos/getRating":{"get":{"tags":["Videos"],"parameters":[{"name":"id","in":"query","description":"Id","required":true,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/videos/getRating","api_endpoint":"https://youtube.googleapis.com/youtube/v3/videos/getRating"},"summary":"Retrieves the ratings that the authorized user gave to a list of specified videos.","description":"Retrieves the ratings that the authorized user gave to a list of specified videos.","security":[{"bearerAuth":[]}]}},"/youtube/v3/abuseReports":{"post":{"tags":["Abuse Reports"],"parameters":[{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://youtube.googleapis.com/$discovery/rest?version=v3","api_endpoint":"https://youtube.googleapis.com/youtube/v3/abuseReports"},"summary":"Inserts a new resource into this collection. (Abuse Reports insert)","description":"Inserts a new resource into this collection.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"abuseTypes":{"type":"array","description":"abuseTypes field (array of objects)","items":{"type":"object","properties":{"id":{"type":"string","description":"id field"}}}},"description":{"type":"string","description":"description field"},"relatedEntities":{"type":"array","description":"relatedEntities field (array of objects)","items":{"type":"object","properties":{"entity":{"type":"object","description":"entity field"}}}},"subject":{"type":"object","description":"subject field","properties":{"id":{"type":"string","description":"id field"},"typeId":{"type":"string","description":"typeId field"},"url":{"type":"string","description":"url field"}}}}},"example":{"abuseTypes":"example-abusetypes","description":"example-description","relatedEntities":"example-relatedentities","subject":"example-subject"}}}}}},"/youtube/v3/channelBanners/insert":{"post":{"tags":["Channel Banners"],"parameters":[{"name":"channelId","in":"query","description":"Unused, channel_id is currently derived from the security context of the requestor.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwnerChannel","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/channelBanners/insert","api_endpoint":"https://youtube.googleapis.com/youtube/v3/channelBanners/insert"},"summary":"Inserts a new resource into this collection.","description":"Inserts a new resource into this collection.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"etag":{"type":"string","description":"etag field"},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#channelBannerResource\"."},"url":{"type":"string","description":"The URL of this banner image."}}},"example":{"etag":"example-etag","kind":"example-kind","url":"example-url"}}}}}},"/youtube/v3/comments/markAsSpam":{"post":{"tags":["Comments"],"parameters":[{"name":"id","in":"query","description":"Flags the comments with the given IDs as spam in the caller's opinion.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://youtube.googleapis.com/$discovery/rest?version=v3","api_endpoint":"https://youtube.googleapis.com/youtube/v3/comments/markAsSpam"},"summary":"Expresses the caller's opinion that one or more comments should be flagged as spam.","description":"Expresses the caller's opinion that one or more comments should be flagged as spam.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/youtube/v3/comments/setModerationStatus":{"post":{"tags":["Comments"],"parameters":[{"name":"banAuthor","in":"query","description":"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.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"id","in":"query","description":"Modifies the moderation status of the comments with the given IDs","required":true,"schema":{"type":"string","example":""}},{"name":"moderationStatus","in":"query","description":"Specifies the requested moderation status. Note, comments can be in statuses, which are not available through this call. For example, this call does not allow to mark a comment as 'likely spam'. Valid values: 'heldForReview', 'published' or 'rejected'.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["published","heldForReview","likelySpam","rejected"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/comments/setModerationStatus","api_endpoint":"https://youtube.googleapis.com/youtube/v3/comments/setModerationStatus"},"summary":"Sets the moderation status of one or more comments.","description":"Sets the moderation status of one or more comments.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/youtube/v3/liveBroadcasts/bind":{"post":{"tags":["Live Broadcasts"],"parameters":[{"name":"id","in":"query","description":"Broadcast to bind to the stream","required":true,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwnerChannel","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.","required":true,"schema":{"type":"string","example":""}},{"name":"streamId","in":"query","description":"Stream to bind, if not set unbind the current one.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/live/docs/liveBroadcasts/bind","api_endpoint":"https://youtube.googleapis.com/youtube/v3/liveBroadcasts/bind"},"summary":"Bind a broadcast to a stream.","description":"Bind a broadcast to a stream.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/youtube/v3/liveBroadcasts/cuepoint":{"post":{"tags":["Live Broadcasts"],"parameters":[{"name":"id","in":"query","description":"Broadcast to insert ads to, or equivalently external_video_id for internal use.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwnerChannel","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/live/docs/liveBroadcasts/cuepoint","api_endpoint":"https://youtube.googleapis.com/youtube/v3/liveBroadcasts/cuepoint"},"summary":"Insert cuepoints in a broadcast","description":"Insert cuepoints in a broadcast","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cueType":{"type":"string","description":"cueType field","enum":["cueTypeUnspecified","cueTypeAd"]},"durationSecs":{"type":"number","description":"The duration of this cuepoint."},"etag":{"type":"string","description":"etag field"},"id":{"type":"string","description":"The identifier for cuepoint resource."},"insertionOffsetTimeMs":{"type":"string","description":"The time when the cuepoint should be inserted by offset to the broadcast actual start time."},"walltimeMs":{"type":"string","description":"The wall clock time at which the cuepoint should be inserted. Only one of insertion_offset_time_ms and walltime_ms may be set at a time."}}},"example":{"cueType":"cueTypeUnspecified","durationSecs":1,"etag":"example-etag","id":"resource-id","insertionOffsetTimeMs":"2026-01-01T00:00:00Z","walltimeMs":"2026-01-01T00:00:00Z"}}}}}},"/youtube/v3/liveBroadcasts/transition":{"post":{"tags":["Live Broadcasts"],"parameters":[{"name":"broadcastStatus","in":"query","description":"The status to which the broadcast is going to transition.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["statusUnspecified","testing","live","complete"]}}},{"name":"id","in":"query","description":"Broadcast to transition.","required":true,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwnerChannel","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/live/docs/liveBroadcasts/transition","api_endpoint":"https://youtube.googleapis.com/youtube/v3/liveBroadcasts/transition"},"summary":"Transition a broadcast to a given status.","description":"Transition a broadcast to a given status.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/youtube/v3/liveChat/bans":{"delete":{"tags":["Live Chat Bans"],"parameters":[{"name":"id","in":"query","description":"Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/live/docs/liveChatBans/delete","api_endpoint":"https://youtube.googleapis.com/youtube/v3/liveChat/bans"},"summary":"Deletes a chat ban.","description":"Deletes a chat ban.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"post":{"tags":["Live Chat Bans"],"parameters":[{"name":"part","in":"query","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/live/docs/liveChatBans/insert","api_endpoint":"https://youtube.googleapis.com/youtube/v3/liveChat/bans"},"summary":"Inserts a new resource into this collection. (Live Chat Bans insert)","description":"Inserts a new resource into this collection.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"etag":{"type":"string","description":"Etag of this resource."},"id":{"type":"string","description":"The ID that YouTube assigns to uniquely identify the ban."},"kind":{"type":"string","description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#liveChatBan\"."},"snippet":{"type":"object","description":"The snippet object contains basic details about the ban.","properties":{"type":{"type":"string","description":"The type of ban.","enum":["liveChatBanTypeUnspecified","permanent","temporary"]},"banDurationSeconds":{"type":"string","description":"The duration of a ban, only filled if the ban has type TEMPORARY."},"bannedUserDetails":{"type":"object","description":"bannedUserDetails field"},"liveChatId":{"type":"string","description":"The chat this ban is pertinent to."}}}}},"example":{"etag":"example-etag","id":"resource-id","kind":"example-kind","snippet":"example-snippet"}}}}}},"/youtube/v3/liveChat/messages/transition":{"post":{"tags":["Live Chat Messages"],"parameters":[{"name":"id","in":"query","description":"The ID that uniquely identify the chat message event to transition.","required":false,"schema":{"type":"string","example":""}},{"name":"status","in":"query","description":"The status to which the chat event is going to transition.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["statusUnspecified","closed"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/live/docs/liveChatMessages/transition","api_endpoint":"https://youtube.googleapis.com/youtube/v3/liveChat/messages/transition"},"summary":"Transition a durable chat event.","description":"Transition a durable chat event.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/youtube/v3/tests":{"post":{"tags":["Tests"],"parameters":[{"name":"externalChannelId","in":"query","description":"External Channel Id","required":false,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwnerChannel","in":"query","description":"On Behalf Of Content Owner Channel","required":false,"schema":{"type":"string","example":""}},{"name":"part","in":"query","description":"Part","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://youtube.googleapis.com/$discovery/rest?version=v3","api_endpoint":"https://youtube.googleapis.com/youtube/v3/tests"},"summary":"POST method.","description":"POST method.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"etag":{"type":"string","description":"Etag for the resource. See https://en.wikipedia.org/wiki/HTTP_ETag."},"featuredPart":{"type":"boolean","description":"featuredPart field","enum":[true,false]},"gaia":{"type":"string","description":"gaia field"},"id":{"type":"string","description":"id field"},"snippet":{"type":"object","description":"snippet field","properties":{}}}},"example":{"etag":"example-etag","featuredPart":"","gaia":"example-gaia","id":"resource-id","snippet":"example-snippet"}}}}}},"/youtube/v3/thumbnails/set":{"post":{"tags":["Thumbnails"],"parameters":[{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}},{"name":"videoId","in":"query","description":"Returns the Thumbnail with the given video IDs for Stubby or Apiary.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/thumbnails/set","api_endpoint":"https://youtube.googleapis.com/youtube/v3/thumbnails/set"},"summary":"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.","description":"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/youtube/v3/videos/rate":{"post":{"tags":["Videos"],"parameters":[{"name":"id","in":"query","description":"Id","required":true,"schema":{"type":"string","example":""}},{"name":"rating","in":"query","description":"Rating","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["none","like","dislike"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/videos/rate","api_endpoint":"https://youtube.googleapis.com/youtube/v3/videos/rate"},"summary":"Adds a like or dislike rating to a video or removes a rating from a video.","description":"Adds a like or dislike rating to a video or removes a rating from a video.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/youtube/v3/videos/reportAbuse":{"post":{"tags":["Videos"],"parameters":[{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/videos/reportAbuse","api_endpoint":"https://youtube.googleapis.com/youtube/v3/videos/reportAbuse"},"summary":"Report abuse for a video.","description":"Report abuse for a video.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comments":{"type":"string","description":"Additional comments regarding the abuse report."},"language":{"type":"string","description":"The language that the content was viewed in."},"reasonId":{"type":"string","description":"The high-level, or primary, reason that the content is abusive. The value is an abuse report reason ID."},"secondaryReasonId":{"type":"string","description":"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":{"type":"string","description":"The ID that YouTube uses to uniquely identify the video."}}},"example":{"comments":"example-comments","language":"example-language","reasonId":"resource-id","secondaryReasonId":"resource-id","videoId":"resource-id"}}}}}},"/youtube/v3/watermarks/set":{"post":{"tags":["Watermarks"],"parameters":[{"name":"channelId","in":"query","description":"Channel Id","required":true,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/watermarks/set","api_endpoint":"https://youtube.googleapis.com/youtube/v3/watermarks/set"},"summary":"Allows upload of watermark image and setting it for a channel.","description":"Allows upload of watermark image and setting it for a channel.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"imageBytes":{"type":"string","description":"The bytes the uploaded image. Only used in api to youtube communication."},"imageUrl":{"type":"string","description":"The url of the uploaded image. Only used in apiary to api communication."},"position":{"type":"object","description":"The spatial position within the video where the branding watermark will be displayed.","properties":{"type":{"type":"string","description":"Defines the position type.","enum":["corner"]},"cornerPosition":{"type":"string","description":"Describes in which corner of the video the visual widget will appear.","enum":["topLeft","topRight","bottomLeft","bottomRight"]}}},"targetChannelId":{"type":"string","description":"The channel to which this branding links. If not present it defaults to the current channel."},"timing":{"type":"object","description":"The temporal position within the video where watermark will be displayed.","properties":{"type":{"type":"string","description":"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.","enum":["offsetFromStart","offsetFromEnd"]},"durationMs":{"type":"string","description":"Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default."},"offsetMs":{"type":"string","description":"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."}}}}},"example":{"imageBytes":"example-imagebytes","imageUrl":"example-imageurl","position":"example-position","targetChannelId":"resource-id","timing":"example-timing"}}}}}},"/youtube/v3/watermarks/unset":{"post":{"tags":["Watermarks"],"parameters":[{"name":"channelId","in":"query","description":"Channel Id","required":true,"schema":{"type":"string","example":""}},{"name":"onBehalfOfContentOwner","in":"query","description":"*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.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/youtube/v3/docs/watermarks/unset","api_endpoint":"https://youtube.googleapis.com/youtube/v3/watermarks/unset"},"summary":"Allows removal of channel watermark.","description":"Allows removal of channel watermark.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}