openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 330 kB
JSON
{"openapi":"3.0.0","info":{"contact":{"name":"Google","url":"https://google.com","x-twitter":"youtube"},"description":"Supports core YouTube features, such as uploading videos, creating and managing playlists, searching for content, and much more.","title":"YouTube Data","version":"v3","x-apiClientRegistration":{"url":"https://console.developers.google.com"},"x-apisguru-categories":["media"],"x-logo":{"url":"https://upload.wikimedia.org/wikipedia/commons/e/e1/YouTube_play_buttom_icon_%282013-2017%29.svg"},"x-origin":[{"converter":{"url":"https://github.com/lucybot/api-spec-converter","version":"2.7.18"},"format":"google","url":"https://www.googleapis.com/discovery/v1/apis/youtube/v3/rest","version":"v1"}],"x-preferred":true,"x-providerName":"googleapis.com","x-serviceName":"youtube"},"externalDocs":{"url":"https://developers.google.com/youtube/v3"},"tags":[{"name":"activities"},{"name":"captions"},{"name":"channelBanners"},{"name":"channelSections"},{"name":"channels"},{"name":"commentThreads"},{"name":"comments"},{"name":"guideCategories"},{"name":"i18nLanguages"},{"name":"i18nRegions"},{"name":"liveBroadcasts"},{"name":"liveChatBans"},{"name":"liveChatMessages"},{"name":"liveChatModerators"},{"name":"liveStreams"},{"name":"playlistItems"},{"name":"playlists"},{"name":"search"},{"name":"sponsors"},{"name":"subscriptions"},{"name":"superChatEvents"},{"name":"thumbnails"},{"name":"videoAbuseReportReasons"},{"name":"videoCategories"},{"name":"videos"},{"name":"watermarks"}],"paths":{"/activities":{"get":{"description":"Returns a list of channel activity events that match the request criteria. For example, you can retrieve events associated with a particular channel, events associated with the user's subscriptions and Google+ friends, or the YouTube home page feed, which is customized for each user.","operationId":"youtube.activities.list","parameters":[{"description":"The channelId parameter specifies a unique YouTube channel ID. The API will then return a list of that channel's activities.","in":"query","name":"channelId","schema":{"type":"string"}},{"description":"Set this parameter's value to true to retrieve the activity feed that displays on the YouTube home page for the currently authenticated user.","in":"query","name":"home","schema":{"type":"boolean"}},{"description":"The maxResults parameter specifies the maximum number of items that should be returned in the result set.","in":"query","name":"maxResults","schema":{"type":"integer","minimum":0,"maximum":50,"default":5}},{"description":"Set this parameter's value to true to retrieve a feed of the authenticated user's activities.","in":"query","name":"mine","schema":{"type":"boolean"}},{"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.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include.\n\nIf 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.","in":"query","name":"part","required":true,"schema":{"type":"string"}},{"description":"The publishedAfter parameter specifies the earliest date and time that an activity could have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be included in the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.","in":"query","name":"publishedAfter","schema":{"type":"string"}},{"description":"The publishedBefore parameter specifies the date and time before which an activity must have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be excluded from the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.","in":"query","name":"publishedBefore","schema":{"type":"string"}},{"description":"The regionCode parameter instructs the API to return results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. YouTube uses this value when the authorized user's previous activity on YouTube does not provide enough information to generate the activity feed.","in":"query","name":"regionCode","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ActivityListResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube"]},{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]},{"Oauth2":["https://www.googleapis.com/auth/youtube.readonly"]}],"tags":["activities"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Posts a bulletin for a specific channel. (The user submitting the request must be authorized to act on the channel's behalf.)\n\nNote: Even though an activity resource can contain information about actions like a user rating a video or marking a video as a favorite, you need to use other API methods to generate those activity resources. For example, you would use the API's videos.rate() method to rate a video and the playlistItems.insert() method to mark a video as a favorite.","operationId":"youtube.activities.insert","parameters":[{"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.","in":"query","name":"part","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Activity"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Activity"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube"]},{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"tags":["activities"]}},"/captions":{"delete":{"description":"Deletes a specified caption track.","operationId":"youtube.captions.delete","parameters":[{"description":"The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.","in":"query","name":"id","required":true,"schema":{"type":"string"}},{"description":"ID of the Google+ Page for the channel that the request is be on behalf of","in":"query","name":"onBehalfOf","schema":{"type":"string"}},{"description":"Note: This parameter is intended exclusively for YouTube content partners.\n\nThe 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.","in":"query","name":"onBehalfOfContentOwner","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]},{"Oauth2":["https://www.googleapis.com/auth/youtubepartner"]}],"tags":["captions"]},"get":{"description":"Returns a list of caption tracks that are associated with a specified video. Note that the API response does not contain the actual captions and that the captions.download method provides the ability to retrieve a caption track.","operationId":"youtube.captions.list","parameters":[{"description":"The id parameter specifies a comma-separated list of IDs that identify the caption resources that should be retrieved. Each ID must identify a caption track associated with the specified video.","in":"query","name":"id","schema":{"type":"string"}},{"description":"ID of the Google+ Page for the channel that the request is on behalf of.","in":"query","name":"onBehalfOf","schema":{"type":"string"}},{"description":"Note: This parameter is intended exclusively for YouTube content partners.\n\nThe 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.","in":"query","name":"onBehalfOfContentOwner","schema":{"type":"string"}},{"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.","in":"query","name":"part","required":true,"schema":{"type":"string"}},{"description":"The videoId parameter specifies the YouTube video ID of the video for which the API should return caption tracks.","in":"query","name":"videoId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CaptionListResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]},{"Oauth2":["https://www.googleapis.com/auth/youtubepartner"]}],"tags":["captions"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Uploads a caption track.","operationId":"youtube.captions.insert","parameters":[{"description":"ID of the Google+ Page for the channel that the request is be on behalf of","in":"query","name":"onBehalfOf","schema":{"type":"string"}},{"description":"Note: This parameter is intended exclusively for YouTube content partners.\n\nThe 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.","in":"query","name":"onBehalfOfContentOwner","schema":{"type":"string"}},{"description":"The part parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.","in":"query","name":"part","required":true,"schema":{"type":"string"}},{"description":"The sync parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video. If you set the value to true, YouTube will disregard any time codes that are in the uploaded caption file and generate new time codes for the captions.\n\nYou should set the sync parameter to true if you are uploading a transcript, which has no time codes, or if you suspect the time codes in your file are incorrect and want YouTube to try to fix them.","in":"query","name":"sync","schema":{"type":"boolean"}}],"requestBody":{"$ref":"#/components/requestBodies/Caption"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Caption"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]},{"Oauth2":["https://www.googleapis.com/auth/youtubepartner"]}],"tags":["captions"]},"put":{"description":"Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both.","operationId":"youtube.captions.update","parameters":[{"description":"ID of the Google+ Page for the channel that the request is be on behalf of","in":"query","name":"onBehalfOf","schema":{"type":"string"}},{"description":"Note: This parameter is intended exclusively for YouTube content partners.\n\nThe 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.","in":"query","name":"onBehalfOfContentOwner","schema":{"type":"string"}},{"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. Set the property value to snippet if you are updating the track's draft status. Otherwise, set the property value to id.","in":"query","name":"part","required":true,"schema":{"type":"string"}},{"description":"Note: The API server only processes the parameter value if the request contains an updated caption file.\n\nThe sync parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video. If you set the value to true, YouTube will automatically synchronize the caption track with the audio track.","in":"query","name":"sync","schema":{"type":"boolean"}}],"requestBody":{"$ref":"#/components/requestBodies/Caption"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Caption"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]},{"Oauth2":["https://www.googleapis.com/auth/youtubepartner"]}],"tags":["captions"]}},"/captions/{id}":{"get":{"description":"Downloads a caption track. The caption track is returned in its original format unless the request specifies a value for the tfmt parameter and in its original language unless the request specifies a value for the tlang parameter.","operationId":"youtube.captions.download","parameters":[{"description":"The id parameter identifies the caption track that is being retrieved. The value is a caption track ID as identified by the id property in a caption resource.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"ID of the Google+ Page for the channel that the request is be on behalf of","in":"query","name":"onBehalfOf","schema":{"type":"string"}},{"description":"Note: This parameter is intended exclusively for YouTube content partners.\n\nThe 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.","in":"query","name":"onBehalfOfContentOwner","schema":{"type":"string"}},{"description":"The tfmt parameter specifies that the caption track should be returned in a specific format. If the parameter is not included in the request, the track is returned in its original format.","in":"query","name":"tfmt","schema":{"type":"string","enum":["sbv","scc","srt","ttml","vtt"]}},{"description":"The tlang parameter specifies that the API response should return a translation of the specified caption track. The parameter value is an ISO 639-1 two-letter language code that identifies the desired caption language. The translation is generated by using machine translation, such as Google Translate.","in":"query","name":"tlang","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]},{"Oauth2":["https://www.googleapis.com/auth/youtubepartner"]}],"tags":["captions"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/channelBanners/insert":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Uploads a channel banner image to YouTube. This method represents the first two steps in a three-step process to update the banner image for a channel:\n\n- Call the channelBanners.insert method to upload the binary image data to YouTube. The image must have a 16:9 aspect ratio and be at least 2120x1192 pixels.\n- Extract the url property's value from the response that the API returns for step 1.\n- Call the channels.update method to update the channel's branding settings. Set the brandingSettings.image.bannerExternalUrl property's value to the URL obtained in step 2.","operationId":"youtube.channelBanners.insert","parameters":[{"description":"The channelId parameter identifies the YouTube channel to which the banner is uploaded. The channelId parameter was introduced as a required parameter in May 2017. As this was a backward-incompatible change, channelBanners.insert requests that do not specify this parameter will not return an error until six months have passed from the time that the parameter was introduced. Please see the API Terms of Service for the official policy regarding backward incompatible changes and the API revision history for the exact date that the parameter was introduced.","in":"query","name":"channelId","schema":{"type":"string"}},{"description":"Note: This parameter is intended exclusively for YouTube content partners.\n\nThe 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.","in":"query","name":"onBehalfOfContentOwner","schema":{"type":"string"}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ChannelBannerResource"}},"image/jpeg":{"schema":{"$ref":"#/components/schemas/ChannelBannerResource"}},"image/png":{"schema":{"$ref":"#/components/schemas/ChannelBannerResource"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ChannelBannerResource"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube"]},{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]},{"Oauth2":["https://www.googleapis.com/auth/youtube.upload"]}],"tags":["channelBanners"]}},"/channelSections":{"delete":{"description":"Deletes a channelSection.","operationId":"youtube.channelSections.delete","parameters":[{"description":"The id parameter specifies the YouTube channelSection ID for the resource that is being deleted. In a channelSection resource, the id property specifies the YouTube channelSection ID.","in":"query","name":"id","required":true,"schema":{"type":"string"}},{"description":"Note: This parameter is intended exclusively for YouTube content partners.\n\nThe 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.","in":"query","name":"onBehalfOfContentOwner","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube"]},{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]},{"Oauth2":["https://www.googleapis.com/auth/youtubepartner"]}],"tags":["channelSections"]},"get":{"description":"Returns channelSection resources that match the API request criteria.","operationId":"youtube.channelSections.list","parameters":[{"description":"The channelId parameter specifies a YouTube channel ID. The API will only return that channel's channelSections.","in":"query","name":"channelId","schema":{"type":"string"}},{"description":"The hl parameter indicates that the snippet.localized property values in the returned channelSection resources should be in the specified language if localized values for that language are available. For example, if the API request specifies hl=de, the snippet.localized properties in the API response will contain German titles if German titles are available. Channel owners can provide localized channel section titles using either the channelSections.insert or channelSections.update method.","in":"query","name":"hl","schema":{"type":"string"}},{"description":"The id parameter specifies a comma-separated list of the YouTube channelSection ID(s) for the resource(s) that are being retrieved. In a channelSection resource, the id property specifies the YouTube channelSection ID.","in":"query","name":"id","schema":{"type":"string"}},{"description":"Set this parameter's value to true to retrieve a feed of the authenticated user's channelSections.","in":"query","name":"mine","schema":{"type":"boolean"}},{"description":"Note: This parameter is intended exclusively for YouTube content partners.\n\nThe 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.","in":"query","name":"onBehalfOfContentOwner","schema":{"type":"string"}},{"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.\n\nIf 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.","in":"query","name":"part","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ChannelSectionListResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube"]},{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]},{"Oauth2":["https://www.googleapis.com/auth/youtube.readonly"]},{"Oauth2":["https://www.googleapis.com/auth/youtubepartner"]}],"tags":["channelSections"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Adds a channelSection for the authenticated user's channel.","operationId":"youtube.channelSections.insert","parameters":[{"description":"Note: This parameter is intended exclusively for YouTube content partners.\n\nThe 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.","in":"query","name":"onBehalfOfContentOwner","schema":{"type":"string"}},{"description":"This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.\n\nThe 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.\n\nThis 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.","in":"query","name":"onBehalfOfContentOwnerChannel","schema":{"type":"string"}},{"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.\n\nThe part names that you can include in the parameter value are snippet and contentDetails.","in":"query","name":"part","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/ChannelSection"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ChannelSection"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube"]},{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]},{"Oauth2":["https://www.googleapis.com/auth/youtubepartner"]}],"tags":["channelSections"]},"put":{"description":"Update a channelSection.","operationId":"youtube.channelSections.update","parameters":[{"description":"Note: This parameter is intended exclusively for YouTube content partners.\n\nThe 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.","in":"query","name":"onBehalfOfContentOwner","schema":{"type":"string"}},{"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.\n\nThe part names that you can include in the parameter value are snippet and contentDetails.","in":"query","name":"part","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/ChannelSection"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ChannelSection"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube"]},{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]},{"Oauth2":["https://www.googleapis.com/auth/youtubepartner"]}],"tags":["channelSections"]}},"/channels":{"get":{"description":"Returns a collection of zero or more channel resources that match the request criteria.","operationId":"youtube.channels.list","parameters":[{"description":"The categoryId parameter specifies a YouTube guide category, thereby requesting YouTube channels associated with that category.","in":"query","name":"categoryId","schema":{"type":"string"}},{"description":"The forUsername parameter specifies a YouTube username, thereby requesting the channel associated with that username.","in":"query","name":"forUsername","schema":{"type":"string"}},{"description":"The hl parameter should be used for filter out the properties that are not in the given language. Used for the brandingSettings part.","in":"query","name":"hl","schema":{"type":"string"}},{"description":"The id parameter specifies a comma-separated list of the YouTube channel ID(s) for the resource(s) that are being retrieved. In a channel resource, the id property specifies the channel's YouTube channel ID.","in":"query","name":"id","schema":{"type":"string"}},{"description":"Note: This parameter is intended exclusively for YouTube content partners.\n\nSet this parameter's value to true to instruct the API to only return channels managed by the content owner that the onBehalfOfContentOwner parameter specifies. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided.","in":"query","name":"managedByMe","schema":{"type":"boolean"}},{"description":"The maxResults parameter specifies the maximum number of items that should be returned in the result set.","in":"query","name":"maxResults","schema":{"type":"integer","minimum":0,"maximum":50,"default":5}},{"description":"Set this parameter's value to true to instruct the API to only return channels owned by the authenticated user.","in":"query","name":"mine","schema":{"type":"boolean"}},{"description":"Use the subscriptions.list method and its mySubscribers parameter to retrieve a list of subscribers to the authenticated user's channel.","in":"query","name":"mySubscribers","schema":{"type":"boolean"}},{"description":"Note: This parameter is intended exclusively for YouTube content partners.\n\nThe 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.","in":"query","name":"onBehalfOfContentOwner","schema":{"type":"string"}},{"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.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"The part parameter specifies a comma-separated list of one or more channel resource properties that the API response will include.\n\nIf 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.","in":"query","name":"part","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ChannelListResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube"]},{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]},{"Oauth2":["https://www.googleapis.com/auth/youtube.readonly"]},{"Oauth2":["https://www.googleapis.com/auth/youtubepartner"]},{"Oauth2":["https://www.googleapis.com/auth/youtubepartner-channel-audit"]}],"tags":["channels"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"put":{"description":"Updates a channel's metadata. Note that this method currently only supports updates to the channel resource's brandingSettings and invideoPromotion objects and their child properties.","operationId":"youtube.channels.update","parameters":[{"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.","in":"query","name":"onBehalfOfContentOwner","schema":{"type":"string"}},{"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.\n\nThe 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.)\n\nNote that this method overrides the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies.","in":"query","name":"part","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Channel"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube"]},{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]},{"Oauth2":["https://www.googleapis.com/auth/youtubepartner"]}],"tags":["channels"]}},"/commentThreads":{"get":{"description":"Returns a list of comment threads that match the API request parameters.","operationId":"youtube.commentThreads.list","parameters":[{"description":"The allThreadsRelatedToChannelId parameter instructs the API to return all comment threads associated with the specified channel. The response can include comments about the channel or about the channel's videos.","in":"query","name":"allThreadsRelatedToChannelId","schema":{"type":"string"}},{"description":"The channelId parameter instructs the API to return comment threads containing comments about the specified channel. (The response will not include comments left on videos that the channel uploaded.)","in":"query","name":"channelId","schema":{"type":"string"}},{"description":"The id parameter specifies a comma-separated list of comment thread IDs for the resources that should be retrieved.","in":"query","name":"id","schema":{"type":"string"}},{"description":"The maxResults parameter specifies the maximum number of items that should be returned in the result set.\n\nNote: This parameter is not supported for use in conjunction with the id parameter.","in":"query","name":"maxResults","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"description":"Set this parameter to limit the returned comment threads to a particular moderation state.\n\nNote: This parameter is not supported for use in conjunction with the id parameter.","in":"query","name":"moderationStatus","schema":{"type":"string","enum":["heldForReview","likelySpam","published"],"default":"published"}},{"description":"The order parameter specifies the order in which the API response should list comment threads. Valid values are: \n- time - Comment threads are ordered by time. This is the default behavior.\n- relevance - Comment threads are ordered by relevance.Note: This parameter is not supported for use in conjunction with the id parameter.","in":"query","name":"order","schema":{"type":"string","enum":["relevance","time"]}},{"description":"The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page of the result that can be retrieved.\n\nNote: This parameter is not supported for use in conjunction with the id parameter.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"The part parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include.","in":"query","name":"part","required":true,"schema":{"type":"string"}},{"description":"The searchTerms parameter instructs the API to limit the API response to only contain comments that contain the specified search terms.\n\nNote: This parameter is not supported for use in conjunction with the id parameter.","in":"query","name":"searchTerms","schema":{"type":"string"}},{"description":"Set this parameter's value to html or plainText to instruct the API to return the comments left by users in html formatted or in plain text.","in":"query","name":"textFormat","schema":{"type":"string","enum":["html","plainText"],"default":"html"}},{"description":"The videoId parameter instructs the API to return comment threads associated with the specified video ID.","in":"query","name":"videoId","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CommentThreadListResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"tags":["commentThreads"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Creates a new top-level comment. To add a reply to an existing comment, use the comments.insert method instead.","operationId":"youtube.commentThreads.insert","parameters":[{"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.","in":"query","name":"part","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/CommentThread"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CommentThread"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"tags":["commentThreads"]},"put":{"description":"Modifies the top-level comment in a comment thread.","operationId":"youtube.commentThreads.update","parameters":[{"description":"The part parameter specifies a comma-separated list of commentThread resource properties that the API response will include. You must at least include the snippet part in the parameter value since that part contains all of the properties that the API request can update.","in":"query","name":"part","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/CommentThread"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CommentThread"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"tags":["commentThreads"]}},"/comments":{"delete":{"description":"Deletes a comment.","operationId":"youtube.comments.delete","parameters":[{"description":"The id parameter specifies the comment ID for the resource that is being deleted.","in":"query","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"tags":["comments"]},"get":{"description":"Returns a list of comments that match the API request parameters.","operationId":"youtube.comments.list","parameters":[{"description":"The id parameter specifies a comma-separated list of comment IDs for the resources that are being retrieved. In a comment resource, the id property specifies the comment's ID.","in":"query","name":"id","schema":{"type":"string"}},{"description":"The maxResults parameter specifies the maximum number of items that should be returned in the result set.\n\nNote: This parameter is not supported for use in conjunction with the id parameter.","in":"query","name":"maxResults","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"description":"The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page of the result that can be retrieved.\n\nNote: This parameter is not supported for use in conjunction with the id parameter.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"The parentId parameter specifies the ID of the comment for which replies should be retrieved.\n\nNote: YouTube currently supports replies only for top-level comments. However, replies to replies may be supported in the future.","in":"query","name":"parentId","schema":{"type":"string"}},{"description":"The part parameter specifies a comma-separated list of one or more comment resource properties that the API response will include.","in":"query","name":"part","required":true,"schema":{"type":"string"}},{"description":"This parameter indicates whether the API should return comments formatted as HTML or as plain text.","in":"query","name":"textFormat","schema":{"type":"string","enum":["html","plainText"],"default":"html"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CommentListResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"tags":["comments"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Creates a reply to an existing comment. Note: To create a top-level comment, use the commentThreads.insert method.","operationId":"youtube.comments.insert","parameters":[{"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.","in":"query","name":"part","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Comment"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Comment"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"tags":["comments"]},"put":{"description":"Modifies a comment.","operationId":"youtube.comments.update","parameters":[{"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.","in":"query","name":"part","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Comment"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Comment"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"tags":["comments"]}},"/comments/markAsSpam":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Expresses the caller's opinion that one or more comments should be flagged as spam.","operationId":"youtube.comments.markAsSpam","parameters":[{"description":"The id parameter specifies a comma-separated list of IDs of comments that the caller believes should be classified as spam.","in":"query","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"tags":["comments"]}},"/comments/setModerationStatus":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Sets the moderation status of one or more comments. The API request must be authorized by the owner of the channel or video associated with the comments.","operationId":"youtube.comments.setModerationStatus","parameters":[{"description":"The banAuthor parameter lets you indicate that you want to automatically reject any additional comments written by the comment's author. Set the parameter value to true to ban the author.\n\nNote: This parameter is only valid if the moderationStatus parameter is also set to rejected.","in":"query","name":"banAuthor","schema":{"type":"boolean","default":false}},{"description":"The id parameter specifies a comma-separated list of IDs that identify the comments for which you are updating the moderation status.","in":"query","name":"id","required":true,"schema":{"type":"string"}},{"description":"Identifies the new moderation status of the specified comments.","in":"query","name":"moderationStatus","required":true,"schema":{"type":"string","enum":["heldForReview","published","rejected"]}}],"responses":{"200":{"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"tags":["comments"]}},"/guideCategories":{"get":{"description":"Returns a list of categories that can be associated with YouTube channels.","operationId":"youtube.guideCategories.list","parameters":[{"description":"The hl parameter specifies the language that will be used for text values in the API response.","in":"query","name":"hl","schema":{"type":"string","default":"en-US"}},{"description":"The id parameter specifies a comma-separated list of the YouTube channel category ID(s) for the resource(s) that are being retrieved. In a guideCategory resource, the id property specifies the YouTube channel category ID.","in":"query","name":"id","schema":{"type":"string"}},{"description":"The part parameter specifies the guideCategory resource properties that the API r