Skip to content

Instantly share code, notes, and snippets.

@JustinBeckwith

JustinBeckwith/youtube-v3.json

Created July 8, 2020 18:44
Show Gist options
  • Save JustinBeckwith/382e540e6342b9c68f12f6f7b7bd38f3 to your computer and use it in GitHub Desktop.
Save JustinBeckwith/382e540e6342b9c68f12f6f7b7bd38f3 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
youtube-v3.json
{
"rootUrl": "https://www.googleapis.com/",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"revision": "20200706",
"fullyEncodeReservedExpansion": true,
"resources": {
"videoCategories": {
"methods": {
"list": {
"id": "youtube.videoCategories.list",
"path": "youtube/v3/videoCategories",
"parameterOrder": [
"part"
],
"httpMethod": "GET",
"response": {
"$ref": "VideoCategoryListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner"
],
"flatPath": "youtube/v3/videoCategories",
"parameters": {
"id": {
"description": "Returns the video categories with the given IDs for Stubby or Apiary.",
"type": "string",
"location": "query",
"repeated": true
},
"hl": {
"default": "en_US",
"location": "query",
"type": "string"
},
"part": {
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies the\n\u003ccode\u003evideoCategory\u003c/code\u003e resource properties that the API response will\ninclude. Set the parameter value to \u003ccode\u003esnippet\u003c/code\u003e.",
"required": true,
"repeated": true,
"type": "string"
},
"regionCode": {
"type": "string",
"location": "query"
}
},
"description": "Retrieves a list of resources, possibly filtered."
}
}
},
"search": {
"methods": {
"list": {
"parameters": {
"eventType": {
"enum": [
"none",
"upcoming",
"live",
"completed"
],
"location": "query",
"type": "string",
"description": "Filter on the livestream status of the videos."
},
"locationRadius": {
"type": "string",
"description": "Filter on distance from the location (specified above).",
"location": "query"
},
"videoSyndicated": {
"description": "Filter on syndicated videos.",
"type": "string",
"location": "query",
"enum": [
"videoSyndicatedUnspecified",
"any",
"true"
]
},
"relevanceLanguage": {
"description": "Return results relevant to this language.",
"type": "string",
"location": "query"
},
"topicId": {
"location": "query",
"description": "Restrict results to a particular topic.",
"type": "string"
},
"q": {
"description": "Textual search terms to match.",
"type": "string",
"location": "query"
},
"videoCaption": {
"location": "query",
"enum": [
"videoCaptionUnspecified",
"any",
"closedCaption",
"none"
],
"description": "Filter on the presence of captions on the videos.",
"type": "string"
},
"forDeveloper": {
"location": "query",
"description": "Restrict the search to only retrieve videos uploaded using the project id\nof the authenticated user.",
"type": "boolean"
},
"order": {
"location": "query",
"enum": [
"searchSortUnspecified",
"date",
"rating",
"viewCount",
"relevance",
"title",
"videoCount"
],
"description": "Sort order of the results.",
"default": "relevance",
"type": "string"
},
"videoType": {
"type": "string",
"description": "Filter on videos of a specific type.",
"location": "query",
"enum": [
"videoTypeUnspecified",
"any",
"movie",
"episode"
]
},
"forMine": {
"type": "boolean",
"description": "Search for the private videos of the authenticated user.",
"location": "query"
},
"videoDuration": {
"type": "string",
"description": "Filter on the duration of the videos.",
"location": "query",
"enum": [
"videoDurationUnspecified",
"any",
"short",
"medium",
"long"
]
},
"maxResults": {
"description": "The \u003ccode\u003e\u003cstrong\u003emaxResults\u003c/strong\u003e\u003c/code\u003e parameter specifies the\nmaximum number of items that should be returned in the result set.",
"format": "uint32",
"type": "integer",
"default": "5",
"location": "query"
},
"pageToken": {
"location": "query",
"type": "string",
"description": "The \u003ccode\u003e\u003cstrong\u003epageToken\u003c/strong\u003e\u003c/code\u003e parameter identifies a specific\npage in the result set that should be returned. In an API response, the\n\u003ccode\u003enextPageToken\u003c/code\u003e and \u003ccode\u003eprevPageToken\u003c/code\u003e properties\nidentify other pages that could be retrieved."
},
"videoDefinition": {
"enum": [
"any",
"standard",
"high"
],
"location": "query",
"type": "string",
"description": "Filter on the definition of the videos."
},
"publishedBefore": {
"location": "query",
"type": "string",
"description": "Filter on resources published before this date.",
"format": "google-datetime"
},
"videoCategoryId": {
"description": "Filter on videos in a specific category.",
"location": "query",
"type": "string"
},
"forContentOwner": {
"location": "query",
"type": "boolean",
"description": "Search owned by a content owner."
},
"type": {
"default": "video,channel,playlist",
"type": "string",
"description": "Restrict results to a particular set of resource types from One Platform.",
"repeated": true,
"location": "query"
},
"relatedToVideoId": {
"location": "query",
"type": "string",
"description": "Search related to a resource."
},
"channelType": {
"type": "string",
"location": "query",
"enum": [
"channelTypeUnspecified",
"any",
"show"
],
"description": "Add a filter on the channel search."
},
"onBehalfOfContentOwner": {
"location": "query",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner.",
"type": "string"
},
"regionCode": {
"description": "Display the content as seen by viewers in this country.",
"type": "string",
"location": "query"
},
"publishedAfter": {
"location": "query",
"format": "google-datetime",
"type": "string",
"description": "Filter on resources published after this date."
},
"part": {
"type": "string",
"required": true,
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies a\ncomma-separated list of one or more \u003ccode\u003esearch\u003c/code\u003e resource properties\nthat the API response will include. Set the parameter value to\n\u003ccode\u003esnippet\u003c/code\u003e.",
"repeated": true,
"location": "query"
},
"videoEmbeddable": {
"enum": [
"videoEmbeddableUnspecified",
"any",
"true"
],
"type": "string",
"description": "Filter on embeddable videos.",
"location": "query"
},
"safeSearch": {
"enum": [
"safeSearchSettingUnspecified",
"none",
"moderate",
"strict"
],
"default": "moderate",
"type": "string",
"location": "query",
"description": "Indicates whether the search results should include restricted content as\nwell as standard content."
},
"videoDimension": {
"description": "Filter on 3d videos.",
"type": "string",
"enum": [
"any",
"2d",
"3d"
],
"location": "query"
},
"location": {
"type": "string",
"description": "Filter on location of the video",
"location": "query"
},
"channelId": {
"description": "Filter on resources belonging to this channelId.",
"location": "query",
"type": "string"
},
"videoLicense": {
"location": "query",
"description": "Filter on the license of the videos.",
"enum": [
"any",
"youtube",
"creativeCommon"
],
"type": "string"
}
},
"path": "youtube/v3/search",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner"
],
"httpMethod": "GET",
"parameterOrder": [
"part"
],
"response": {
"$ref": "SearchListResponse"
},
"description": "Retrieves a list of search resources",
"flatPath": "youtube/v3/search",
"id": "youtube.search.list"
}
}
},
"i18nRegions": {
"methods": {
"list": {
"description": "Retrieves a list of resources, possibly filtered.",
"flatPath": "youtube/v3/i18nRegions",
"parameterOrder": [
"part"
],
"httpMethod": "GET",
"id": "youtube.i18nRegions.list",
"parameters": {
"part": {
"repeated": true,
"type": "string",
"required": true,
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies the\n\u003ccode\u003ei18nRegion\u003c/code\u003e resource properties that the API response will\ninclude. Set the parameter value to \u003ccode\u003esnippet\u003c/code\u003e."
},
"hl": {
"default": "en_US",
"type": "string",
"location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner"
],
"path": "youtube/v3/i18nRegions",
"response": {
"$ref": "I18nRegionListResponse"
}
}
}
},
"liveBroadcasts": {
"methods": {
"delete": {
"description": "Delete a given broadcast.",
"id": "youtube.liveBroadcasts.delete",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"parameterOrder": [
"id"
],
"parameters": {
"onBehalfOfContentOwner": {
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner.",
"type": "string",
"location": "query"
},
"onBehalfOfContentOwnerChannel": {
"type": "string",
"description": "This parameter can only be used in a properly \u003ca\nhref=\"/youtube/v3/guides/authentication\"\u003eauthorized request\u003c/a\u003e.\n\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwnerChannel\u003c/strong\u003e\u003c/code\u003e parameter\nspecifies the YouTube channel ID of the channel to which a video is being\nadded. This parameter is required when a request specifies a value for the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter, and it can only be used in\nconjunction with that parameter. In addition, the request must be\nauthorized using a CMS account that is linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies. Finally, the\nchannel that the \u003ccode\u003eonBehalfOfContentOwnerChannel\u003c/code\u003e parameter value\nspecifies must be linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies.\u003cbr\u003e\u003cbr\u003eThis\nparameter is intended for YouTube content partners that own and manage many\ndifferent YouTube channels. It allows content owners to authenticate once\nand perform actions on behalf of the channel specified in the parameter\nvalue, without having to provide authentication credentials for each\nseparate channel.",
"location": "query"
},
"id": {
"location": "query",
"type": "string",
"required": true
}
},
"httpMethod": "DELETE",
"flatPath": "youtube/v3/liveBroadcasts",
"path": "youtube/v3/liveBroadcasts"
},
"update": {
"parameterOrder": [
"part"
],
"id": "youtube.liveBroadcasts.update",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"description": "Updates an existing broadcast for the authenticated user.",
"path": "youtube/v3/liveBroadcasts",
"parameters": {
"onBehalfOfContentOwner": {
"type": "string",
"location": "query",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner."
},
"part": {
"required": true,
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter serves two purposes in\nthis operation. It identifies the properties that the write operation will\nset as well as the properties that the API response will\ninclude.\u003cbr\u003e\u003cbr\u003eThe \u003ccode\u003epart\u003c/code\u003e properties that you can include in\nthe parameter value are \u003ccode\u003eid\u003c/code\u003e, \u003ccode\u003esnippet\u003c/code\u003e,\n\u003ccode\u003econtentDetails\u003c/code\u003e, and \u003ccode\u003estatus\u003c/code\u003e.\u003cbr\u003e\u003cbr\u003eNote that this\nmethod will override the existing values for all of the mutable properties\nthat are contained in any parts that the parameter value specifies. For\nexample, a\nbroadcast's privacy status is defined in the \u003ccode\u003estatus\u003c/code\u003e part. As\nsuch, if your request is updating a private or unlisted broadcast, and the\nrequest's \u003ccode\u003epart\u003c/code\u003e parameter value includes the\n\u003ccode\u003estatus\u003c/code\u003e part, the broadcast's privacy setting will be updated\nto whatever value the request body specifies. If the request body does not\nspecify a value, the existing privacy setting will be removed and the\nbroadcast will revert to the default privacy setting.",
"type": "string",
"repeated": true,
"location": "query"
},
"onBehalfOfContentOwnerChannel": {
"type": "string",
"description": "This parameter can only be used in a properly \u003ca\nhref=\"/youtube/v3/guides/authentication\"\u003eauthorized request\u003c/a\u003e.\n\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwnerChannel\u003c/strong\u003e\u003c/code\u003e parameter\nspecifies the YouTube channel ID of the channel to which a video is being\nadded. This parameter is required when a request specifies a value for the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter, and it can only be used in\nconjunction with that parameter. In addition, the request must be\nauthorized using a CMS account that is linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies. Finally, the\nchannel that the \u003ccode\u003eonBehalfOfContentOwnerChannel\u003c/code\u003e parameter value\nspecifies must be linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies.\u003cbr\u003e\u003cbr\u003eThis\nparameter is intended for YouTube content partners that own and manage many\ndifferent YouTube channels. It allows content owners to authenticate once\nand perform actions on behalf of the channel specified in the parameter\nvalue, without having to provide authentication credentials for each\nseparate channel.",
"location": "query"
}
},
"response": {
"$ref": "LiveBroadcast"
},
"request": {
"$ref": "LiveBroadcast"
},
"httpMethod": "PUT",
"flatPath": "youtube/v3/liveBroadcasts"
},
"transition": {
"response": {
"$ref": "LiveBroadcast"
},
"description": "Transition a broadcast to a given status.",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"parameterOrder": [
"id",
"broadcastStatus",
"part"
],
"path": "youtube/v3/liveBroadcasts/transition",
"parameters": {
"onBehalfOfContentOwner": {
"location": "query",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner.",
"type": "string"
},
"id": {
"location": "query",
"description": "Broadcast to transition.",
"required": true,
"type": "string"
},
"onBehalfOfContentOwnerChannel": {
"location": "query",
"description": "This parameter can only be used in a properly \u003ca\nhref=\"/youtube/v3/guides/authentication\"\u003eauthorized request\u003c/a\u003e.\n\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwnerChannel\u003c/strong\u003e\u003c/code\u003e parameter\nspecifies the YouTube channel ID of the channel to which a video is being\nadded. This parameter is required when a request specifies a value for the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter, and it can only be used in\nconjunction with that parameter. In addition, the request must be\nauthorized using a CMS account that is linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies. Finally, the\nchannel that the \u003ccode\u003eonBehalfOfContentOwnerChannel\u003c/code\u003e parameter value\nspecifies must be linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies.\u003cbr\u003e\u003cbr\u003eThis\nparameter is intended for YouTube content partners that own and manage many\ndifferent YouTube channels. It allows content owners to authenticate once\nand perform actions on behalf of the channel specified in the parameter\nvalue, without having to provide authentication credentials for each\nseparate channel.",
"type": "string"
},
"broadcastStatus": {
"enum": [
"statusUnspecified",
"testing",
"live",
"complete"
],
"location": "query",
"description": "The status to which the broadcast is going to transition.",
"type": "string",
"required": true
},
"part": {
"type": "string",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies a\ncomma-separated list of one or more \u003ccode\u003eliveBroadcast\u003c/code\u003e resource\nproperties that the API response will include. The \u003ccode\u003epart\u003c/code\u003e names\nthat you can include in the parameter value are \u003ccode\u003eid\u003c/code\u003e,\n\u003ccode\u003esnippet\u003c/code\u003e, \u003ccode\u003econtentDetails\u003c/code\u003e, and \u003ccode\u003estatus\u003c/code\u003e.",
"location": "query",
"repeated": true,
"required": true
}
},
"id": "youtube.liveBroadcasts.transition",
"flatPath": "youtube/v3/liveBroadcasts/transition",
"httpMethod": "POST"
},
"insert": {
"response": {
"$ref": "LiveBroadcast"
},
"id": "youtube.liveBroadcasts.insert",
"parameterOrder": [
"part"
],
"parameters": {
"onBehalfOfContentOwner": {
"location": "query",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner.",
"type": "string"
},
"onBehalfOfContentOwnerChannel": {
"type": "string",
"description": "This parameter can only be used in a properly \u003ca\nhref=\"/youtube/v3/guides/authentication\"\u003eauthorized request\u003c/a\u003e.\n\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwnerChannel\u003c/strong\u003e\u003c/code\u003e parameter\nspecifies the YouTube channel ID of the channel to which a video is being\nadded. This parameter is required when a request specifies a value for the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter, and it can only be used in\nconjunction with that parameter. In addition, the request must be\nauthorized using a CMS account that is linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies. Finally, the\nchannel that the \u003ccode\u003eonBehalfOfContentOwnerChannel\u003c/code\u003e parameter value\nspecifies must be linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies.\u003cbr\u003e\u003cbr\u003eThis\nparameter is intended for YouTube content partners that own and manage many\ndifferent YouTube channels. It allows content owners to authenticate once\nand perform actions on behalf of the channel specified in the parameter\nvalue, without having to provide authentication credentials for each\nseparate channel.",
"location": "query"
},
"part": {
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter serves two purposes in\nthis operation. It identifies the properties that the write operation will\nset as well as the properties that the API response will\ninclude.\u003cbr\u003e\u003cbr\u003eThe \u003ccode\u003epart\u003c/code\u003e properties that you can include in\nthe parameter value are \u003ccode\u003eid\u003c/code\u003e, \u003ccode\u003esnippet\u003c/code\u003e,\n\u003ccode\u003econtentDetails\u003c/code\u003e, and \u003ccode\u003estatus\u003c/code\u003e.",
"type": "string",
"required": true,
"repeated": true,
"location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"request": {
"$ref": "LiveBroadcast"
},
"httpMethod": "POST",
"path": "youtube/v3/liveBroadcasts",
"description": "Inserts a new stream for the authenticated user.",
"flatPath": "youtube/v3/liveBroadcasts"
},
"list": {
"parameterOrder": [
"part"
],
"response": {
"$ref": "LiveBroadcastListResponse"
},
"description": "Retrieve the list of broadcasts associated with the given channel.",
"httpMethod": "GET",
"flatPath": "youtube/v3/liveBroadcasts",
"path": "youtube/v3/liveBroadcasts",
"id": "youtube.liveBroadcasts.list",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly"
],
"parameters": {
"broadcastType": {
"enum": [
"broadcastTypeFilterUnspecified",
"all",
"event",
"persistent"
],
"location": "query",
"description": "Return only broadcasts with the selected type.",
"default": "event",
"type": "string"
},
"onBehalfOfContentOwner": {
"location": "query",
"type": "string",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner."
},
"maxResults": {
"type": "integer",
"format": "uint32",
"location": "query",
"default": "5",
"description": "The \u003ccode\u003e\u003cstrong\u003emaxResults\u003c/strong\u003e\u003c/code\u003e parameter specifies the\nmaximum number of items that should be returned in the result set."
},
"broadcastStatus": {
"description": "Return broadcasts with a certain status, e.g. active broadcasts.",
"type": "string",
"location": "query",
"enum": [
"broadcastStatusFilterUnspecified",
"all",
"active",
"upcoming",
"completed"
]
},
"pageToken": {
"type": "string",
"description": "The \u003ccode\u003e\u003cstrong\u003epageToken\u003c/strong\u003e\u003c/code\u003e parameter identifies a specific\npage in the result set that should be returned. In an API response, the\n\u003ccode\u003enextPageToken\u003c/code\u003e and \u003ccode\u003eprevPageToken\u003c/code\u003e properties\nidentify other pages that could be retrieved.",
"location": "query"
},
"mine": {
"location": "query",
"type": "boolean"
},
"part": {
"required": true,
"type": "string",
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies a\ncomma-separated list of one or more \u003ccode\u003eliveBroadcast\u003c/code\u003e resource\nproperties that the API response will include. The \u003ccode\u003epart\u003c/code\u003e names\nthat you can include in the parameter value are \u003ccode\u003eid\u003c/code\u003e,\n\u003ccode\u003esnippet\u003c/code\u003e, \u003ccode\u003econtentDetails\u003c/code\u003e, and \u003ccode\u003estatus\u003c/code\u003e.",
"repeated": true
},
"id": {
"type": "string",
"description": "Return broadcasts with the given ids from Stubby or Apiary.",
"repeated": true,
"location": "query"
},
"onBehalfOfContentOwnerChannel": {
"location": "query",
"description": "This parameter can only be used in a properly \u003ca\nhref=\"/youtube/v3/guides/authentication\"\u003eauthorized request\u003c/a\u003e.\n\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwnerChannel\u003c/strong\u003e\u003c/code\u003e parameter\nspecifies the YouTube channel ID of the channel to which a video is being\nadded. This parameter is required when a request specifies a value for the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter, and it can only be used in\nconjunction with that parameter. In addition, the request must be\nauthorized using a CMS account that is linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies. Finally, the\nchannel that the \u003ccode\u003eonBehalfOfContentOwnerChannel\u003c/code\u003e parameter value\nspecifies must be linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies.\u003cbr\u003e\u003cbr\u003eThis\nparameter is intended for YouTube content partners that own and manage many\ndifferent YouTube channels. It allows content owners to authenticate once\nand perform actions on behalf of the channel specified in the parameter\nvalue, without having to provide authentication credentials for each\nseparate channel.",
"type": "string"
}
}
},
"bind": {
"httpMethod": "POST",
"description": "Bind a broadcast to a stream.",
"path": "youtube/v3/liveBroadcasts/bind",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"id": "youtube.liveBroadcasts.bind",
"parameterOrder": [
"id",
"part"
],
"flatPath": "youtube/v3/liveBroadcasts/bind",
"parameters": {
"onBehalfOfContentOwnerChannel": {
"location": "query",
"description": "This parameter can only be used in a properly \u003ca\nhref=\"/youtube/v3/guides/authentication\"\u003eauthorized request\u003c/a\u003e.\n\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwnerChannel\u003c/strong\u003e\u003c/code\u003e parameter\nspecifies the YouTube channel ID of the channel to which a video is being\nadded. This parameter is required when a request specifies a value for the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter, and it can only be used in\nconjunction with that parameter. In addition, the request must be\nauthorized using a CMS account that is linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies. Finally, the\nchannel that the \u003ccode\u003eonBehalfOfContentOwnerChannel\u003c/code\u003e parameter value\nspecifies must be linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies.\u003cbr\u003e\u003cbr\u003eThis\nparameter is intended for YouTube content partners that own and manage many\ndifferent YouTube channels. It allows content owners to authenticate once\nand perform actions on behalf of the channel specified in the parameter\nvalue, without having to provide authentication credentials for each\nseparate channel.",
"type": "string"
},
"onBehalfOfContentOwner": {
"type": "string",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner.",
"location": "query"
},
"part": {
"required": true,
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies a\ncomma-separated list of one or more \u003ccode\u003eliveBroadcast\u003c/code\u003e resource\nproperties that the API response will include. The \u003ccode\u003epart\u003c/code\u003e names\nthat you can include in the parameter value are \u003ccode\u003eid\u003c/code\u003e,\n\u003ccode\u003esnippet\u003c/code\u003e, \u003ccode\u003econtentDetails\u003c/code\u003e, and \u003ccode\u003estatus\u003c/code\u003e.",
"location": "query",
"repeated": true,
"type": "string"
},
"streamId": {
"description": "Stream to bind, if not set unbind the current one.",
"location": "query",
"type": "string"
},
"id": {
"type": "string",
"location": "query",
"description": "Broadcast to bind to the stream",
"required": true
}
},
"response": {
"$ref": "LiveBroadcast"
}
},
"control": {
"description": "Slate and recording control of the live broadcast.\nSupport actions: slate on/off, recording start/stop/pause/resume.\nDesign doc: goto/yt-api-liveBroadcast-control",
"parameterOrder": [
"id",
"part"
],
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"path": "youtube/v3/liveBroadcasts/control",
"parameters": {
"onBehalfOfContentOwnerChannel": {
"location": "query",
"type": "string",
"description": "This parameter can only be used in a properly \u003ca\nhref=\"/youtube/v3/guides/authentication\"\u003eauthorized request\u003c/a\u003e.\n\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwnerChannel\u003c/strong\u003e\u003c/code\u003e parameter\nspecifies the YouTube channel ID of the channel to which a video is being\nadded. This parameter is required when a request specifies a value for the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter, and it can only be used in\nconjunction with that parameter. In addition, the request must be\nauthorized using a CMS account that is linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies. Finally, the\nchannel that the \u003ccode\u003eonBehalfOfContentOwnerChannel\u003c/code\u003e parameter value\nspecifies must be linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies.\u003cbr\u003e\u003cbr\u003eThis\nparameter is intended for YouTube content partners that own and manage many\ndifferent YouTube channels. It allows content owners to authenticate once\nand perform actions on behalf of the channel specified in the parameter\nvalue, without having to provide authentication credentials for each\nseparate channel."
},
"id": {
"description": "Broadcast to operate.",
"location": "query",
"type": "string",
"required": true
},
"part": {
"required": true,
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies a\ncomma-separated list of one or more \u003ccode\u003eliveBroadcast\u003c/code\u003e resource\nproperties that the API response will include. The \u003ccode\u003epart\u003c/code\u003e names\nthat you can include in the parameter value are \u003ccode\u003eid\u003c/code\u003e,\n\u003ccode\u003esnippet\u003c/code\u003e, \u003ccode\u003econtentDetails\u003c/code\u003e, and \u003ccode\u003estatus\u003c/code\u003e.",
"repeated": true,
"type": "string",
"location": "query"
},
"displaySlate": {
"type": "boolean",
"location": "query",
"description": "Whether display or hide slate."
},
"onBehalfOfContentOwner": {
"type": "string",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner.",
"location": "query"
},
"offsetTimeMs": {
"description": "The exact time when the actions (e.g. slate on) are executed.\nIt is an offset from the first frame of the monitor stream.\nIf not set, it means \"now\" or ASAP.\nThis field should not be set if the monitor stream is disabled,\notherwise an error will be returned.",
"format": "uint64",
"location": "query",
"type": "string"
},
"walltime": {
"description": "The wall clock time at which the action should be executed.\nOnly one of offset_time_ms and walltime may be set at a time.",
"type": "string",
"location": "query",
"format": "google-datetime"
}
},
"response": {
"$ref": "LiveBroadcast"
},
"httpMethod": "POST",
"id": "youtube.liveBroadcasts.control",
"flatPath": "youtube/v3/liveBroadcasts/control"
}
}
},
"watermarks": {
"methods": {
"unset": {
"id": "youtube.watermarks.unset",
"httpMethod": "POST",
"path": "youtube/v3/watermarks/unset",
"parameters": {
"onBehalfOfContentOwner": {
"location": "query",
"type": "string",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner."
},
"channelId": {
"type": "string",
"location": "query",
"required": true
}
},
"parameterOrder": [
"channelId"
],
"description": "Allows removal of channel watermark.",
"flatPath": "youtube/v3/watermarks/unset",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
]
},
"set": {
"flatPath": "youtube/v3/watermarks/set",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.upload",
"https://www.googleapis.com/auth/youtubepartner"
],
"parameters": {
"onBehalfOfContentOwner": {
"type": "string",
"location": "query",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner."
},
"channelId": {
"required": true,
"location": "query",
"type": "string"
}
},
"parameterOrder": [
"channelId"
],
"request": {
"$ref": "InvideoBranding"
},
"supportsMediaUpload": true,
"description": "Allows upload of watermark image and setting it for a channel.",
"httpMethod": "POST",
"mediaUpload": {
"maxSize": "10485760",
"accept": [
"image/jpeg",
"image/png",
"application/octet-stream"
],
"protocols": {
"simple": {
"multipart": true,
"path": "/upload/youtube/v3/watermarks/set"
}
}
},
"path": "youtube/v3/watermarks/set",
"id": "youtube.watermarks.set"
}
}
},
"playlists": {
"methods": {
"insert": {
"parameters": {
"onBehalfOfContentOwnerChannel": {
"location": "query",
"description": "This parameter can only be used in a properly \u003ca\nhref=\"/youtube/v3/guides/authentication\"\u003eauthorized request\u003c/a\u003e.\n\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwnerChannel\u003c/strong\u003e\u003c/code\u003e parameter\nspecifies the YouTube channel ID of the channel to which a video is being\nadded. This parameter is required when a request specifies a value for the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter, and it can only be used in\nconjunction with that parameter. In addition, the request must be\nauthorized using a CMS account that is linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies. Finally, the\nchannel that the \u003ccode\u003eonBehalfOfContentOwnerChannel\u003c/code\u003e parameter value\nspecifies must be linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies.\u003cbr\u003e\u003cbr\u003eThis\nparameter is intended for YouTube content partners that own and manage many\ndifferent YouTube channels. It allows content owners to authenticate once\nand perform actions on behalf of the channel specified in the parameter\nvalue, without having to provide authentication credentials for each\nseparate channel.",
"type": "string"
},
"part": {
"repeated": true,
"type": "string",
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter serves two purposes in\nthis operation. It identifies the properties that the write operation will\nset as well as the properties that the API response will include.",
"required": true
},
"onBehalfOfContentOwner": {
"location": "query",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner.",
"type": "string"
}
},
"flatPath": "youtube/v3/playlists",
"id": "youtube.playlists.insert",
"parameterOrder": [
"part"
],
"httpMethod": "POST",
"description": "Inserts a new resource into this collection.",
"response": {
"$ref": "Playlist"
},
"request": {
"$ref": "Playlist"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"path": "youtube/v3/playlists"
},
"delete": {
"path": "youtube/v3/playlists",
"parameterOrder": [
"id"
],
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"parameters": {
"id": {
"type": "string",
"location": "query",
"required": true
},
"onBehalfOfContentOwner": {
"type": "string",
"location": "query",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner."
}
},
"httpMethod": "DELETE",
"id": "youtube.playlists.delete",
"flatPath": "youtube/v3/playlists",
"description": "Deletes a resource."
},
"list": {
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner"
],
"description": "Retrieves a list of resources, possibly filtered.",
"response": {
"$ref": "PlaylistListResponse"
},
"path": "youtube/v3/playlists",
"id": "youtube.playlists.list",
"parameters": {
"maxResults": {
"description": "The \u003ccode\u003e\u003cstrong\u003emaxResults\u003c/strong\u003e\u003c/code\u003e parameter specifies the\nmaximum number of items that should be returned in the result set.",
"default": "5",
"type": "integer",
"format": "uint32",
"location": "query"
},
"id": {
"location": "query",
"description": "Return the playlists with the given IDs for Stubby or Apiary.",
"repeated": true,
"type": "string"
},
"hl": {
"description": "Returen content in specified language",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "The \u003ccode\u003e\u003cstrong\u003epageToken\u003c/strong\u003e\u003c/code\u003e parameter identifies a specific\npage in the result set that should be returned. In an API response, the\n\u003ccode\u003enextPageToken\u003c/code\u003e and \u003ccode\u003eprevPageToken\u003c/code\u003e properties\nidentify other pages that could be retrieved.",
"type": "string",
"location": "query"
},
"part": {
"location": "query",
"repeated": true,
"required": true,
"type": "string",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies a\ncomma-separated list of one or more \u003ccode\u003eplaylist\u003c/code\u003e resource\nproperties that the API response will include.\u003cbr\u003e\u003cbr\u003eIf the parameter\nidentifies a property that contains child properties, the child properties\nwill be included in the response. For example, in a \u003ccode\u003eplaylist\u003c/code\u003e\nresource, the \u003ccode\u003esnippet\u003c/code\u003e property contains properties like\n\u003ccode\u003eauthor\u003c/code\u003e, \u003ccode\u003etitle\u003c/code\u003e, \u003ccode\u003edescription\u003c/code\u003e,\n\u003ccode\u003etags\u003c/code\u003e, and \u003ccode\u003etimeCreated\u003c/code\u003e. As such, if you set\n\u003ccode\u003e\u003cstrong\u003epart=snippet\u003c/strong\u003e\u003c/code\u003e, the API response will contain\nall of those properties."
},
"mine": {
"description": "Return the playlists owned by the authenticated user.",
"location": "query",
"type": "boolean"
},
"onBehalfOfContentOwner": {
"type": "string",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner.",
"location": "query"
},
"channelId": {
"location": "query",
"description": "Return the playlists owned by the specified channel ID.",
"type": "string"
},
"onBehalfOfContentOwnerChannel": {
"location": "query",
"description": "This parameter can only be used in a properly \u003ca\nhref=\"/youtube/v3/guides/authentication\"\u003eauthorized request\u003c/a\u003e.\n\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwnerChannel\u003c/strong\u003e\u003c/code\u003e parameter\nspecifies the YouTube channel ID of the channel to which a video is being\nadded. This parameter is required when a request specifies a value for the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter, and it can only be used in\nconjunction with that parameter. In addition, the request must be\nauthorized using a CMS account that is linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies. Finally, the\nchannel that the \u003ccode\u003eonBehalfOfContentOwnerChannel\u003c/code\u003e parameter value\nspecifies must be linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies.\u003cbr\u003e\u003cbr\u003eThis\nparameter is intended for YouTube content partners that own and manage many\ndifferent YouTube channels. It allows content owners to authenticate once\nand perform actions on behalf of the channel specified in the parameter\nvalue, without having to provide authentication credentials for each\nseparate channel.",
"type": "string"
}
},
"parameterOrder": [
"part"
],
"flatPath": "youtube/v3/playlists",
"httpMethod": "GET"
},
"update": {
"httpMethod": "PUT",
"flatPath": "youtube/v3/playlists",
"request": {
"$ref": "Playlist"
},
"id": "youtube.playlists.update",
"description": "Updates an existing resource.",
"path": "youtube/v3/playlists",
"parameterOrder": [
"part"
],
"parameters": {
"part": {
"required": true,
"type": "string",
"location": "query",
"repeated": true,
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter serves two purposes in\nthis operation. It identifies the properties that the write operation will\nset as well as the properties that the API response will\ninclude.\u003cbr/\u003e\u003cbr/\u003eNote that this method will override the existing values\nfor mutable properties that are contained in any parts that the request\nbody specifies. For example, a\nplaylist's description is contained in the \u003ccode\u003esnippet\u003c/code\u003e part, which\nmust be included in the request body. If the request does not specify a\nvalue for the \u003ccode\u003esnippet.description\u003c/code\u003e property, the playlist's\nexisting description will be deleted."
},
"onBehalfOfContentOwner": {
"type": "string",
"location": "query",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner."
}
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"response": {
"$ref": "Playlist"
}
}
}
},
"youtube": {
"resources": {
"v3": {
"methods": {
"infocards": {
"description": "Updates infocards for a given video.\nNote:\n* If the card id is not provided, a new card will be created.\n* If the card id is provided, that card will be updated.\n* Existing cards will be discarded if they're not included in the request.",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"flatPath": "youtube/v3/infocards",
"parameters": {
"part": {
"type": "string",
"location": "query",
"description": "The properties to update.",
"required": true,
"repeated": true
},
"videoId": {
"location": "query",
"type": "string",
"description": "Encrypted id of the video."
},
"onBehalfOfContentOwner": {
"type": "string",
"location": "query",
"description": "Content owner of the video."
}
},
"response": {
"$ref": "InfoCards"
},
"request": {
"$ref": "InfoCards"
},
"httpMethod": "POST",
"parameterOrder": [
"part"
],
"path": "youtube/v3/infocards",
"id": "youtube.youtube.v3.infocards"
}
},
"resources": {
"tests": {
"methods": {
"create": {
"httpMethod": "POST",
"path": "youtube/v3/tests",
"response": {
"$ref": "TestItem"
},
"flatPath": "youtube/v3/tests",
"parameterOrder": [],
"request": {
"$ref": "TestItem"
},
"id": "youtube.youtube.v3.tests.create",
"description": "POST method.",
"parameters": {
"part": {
"location": "query",
"repeated": true,
"type": "string"
}
}
}
}
},
"infocards": {
"methods": {
"list": {
"path": "youtube/v3/infocards",
"flatPath": "youtube/v3/infocards",
"httpMethod": "GET",
"description": "Retrieves all infocards for a given video.",
"id": "youtube.youtube.v3.infocards.list",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"response": {
"$ref": "InfocardListResponse"
},
"parameterOrder": [
"part"
],
"parameters": {
"videoId": {
"type": "string",
"description": "Encrypted id of the video.",
"location": "query"
},
"onBehalfOfContentOwner": {
"description": "Content owner of the video.",
"location": "query",
"type": "string"
},
"part": {
"description": "The properties to return.",
"type": "string",
"required": true,
"location": "query",
"repeated": true
}
}
}
}
}
}
}
}
},
"thirdPartyLinks": {
"methods": {
"update": {
"response": {
"$ref": "ThirdPartyLink"
},
"httpMethod": "PUT",
"flatPath": "youtube/v3/thirdPartyLinks",
"path": "youtube/v3/thirdPartyLinks",
"parameters": {
"part": {
"location": "query",
"type": "string",
"repeated": true,
"required": true,
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies the\n\u003ccode\u003ethirdPartyLink\u003c/code\u003e resource parts that the API request and\nresponse will include. Supported values are \u003ccode\u003elinkingToken\u003c/code\u003e,\n\u003ccode\u003estatus\u003c/code\u003e, and \u003ccode\u003esnippet\u003c/code\u003e."
}
},
"parameterOrder": [
"part"
],
"description": "Updates an existing resource.",
"id": "youtube.thirdPartyLinks.update",
"request": {
"$ref": "ThirdPartyLink"
}
},
"insert": {
"parameters": {
"part": {
"required": true,
"location": "query",
"type": "string",
"repeated": true,
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies the\n\u003ccode\u003ethirdPartyLink\u003c/code\u003e resource parts that the API request and\nresponse will include. Supported values are \u003ccode\u003elinkingToken\u003c/code\u003e,\n\u003ccode\u003estatus\u003c/code\u003e, and \u003ccode\u003esnippet\u003c/code\u003e."
}
},
"parameterOrder": [
"part"
],
"id": "youtube.thirdPartyLinks.insert",
"httpMethod": "POST",
"flatPath": "youtube/v3/thirdPartyLinks",
"path": "youtube/v3/thirdPartyLinks",
"request": {
"$ref": "ThirdPartyLink"
},
"response": {
"$ref": "ThirdPartyLink"
},
"description": "Inserts a new resource into this collection."
},
"delete": {
"description": "Deletes a resource.",
"parameters": {
"type": {
"required": true,
"description": "Type of the link to be deleted.",
"location": "query",
"enum": [
"linkUnspecified",
"channelToStoreLink"
],
"type": "string"
},
"part": {
"type": "string",
"location": "query",
"description": "Do not use. Required for compatibility.",
"repeated": true
},
"linkingToken": {
"type": "string",
"description": "Delete the partner links with the given linking token.",
"required": true,
"location": "query"
},
"resourceId": {
"type": "string",
"location": "query"
}
},
"flatPath": "youtube/v3/thirdPartyLinks",
"path": "youtube/v3/thirdPartyLinks",
"id": "youtube.thirdPartyLinks.delete",
"parameterOrder": [
"linkingToken",
"type"
],
"httpMethod": "DELETE"
},
"list": {
"path": "youtube/v3/thirdPartyLinks",
"parameterOrder": [
"part"
],
"id": "youtube.thirdPartyLinks.list",
"parameters": {
"linkingToken": {
"type": "string",
"location": "query",
"description": "Get a third party link with the given linking token."
},
"part": {
"location": "query",
"required": true,
"type": "string",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies the\n\u003ccode\u003ethirdPartyLink\u003c/code\u003e resource parts that the API response will\ninclude. Supported values are \u003ccode\u003elinkingToken\u003c/code\u003e,\n\u003ccode\u003estatus\u003c/code\u003e, and \u003ccode\u003esnippet\u003c/code\u003e.",
"repeated": true
},
"type": {
"description": "Get a third party link of the given type.",
"enum": [
"linkUnspecified",
"channelToStoreLink"
],
"type": "string",
"location": "query"
}
},
"httpMethod": "GET",
"flatPath": "youtube/v3/thirdPartyLinks",
"response": {
"$ref": "ThirdPartyLink"
},
"description": "Retrieves a list of resources, possibly filtered."
}
}
},
"guideCategories": {
"methods": {
"list": {
"response": {
"$ref": "GuideCategoryListResponse"
},
"parameterOrder": [
"part"
],
"httpMethod": "GET",
"id": "youtube.guideCategories.list",
"description": "Retrieves a list of guide categories.",
"path": "youtube/v3/guideCategories",
"parameters": {
"regionCode": {
"location": "query",
"type": "string",
"description": "Return all categories in the given region code."
},
"hl": {
"location": "query",
"default": "en-US",
"type": "string"
},
"part": {
"repeated": true,
"required": true,
"type": "string",
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies the\n\u003ccode\u003eguideCategory\u003c/code\u003e resource properties that the API response will\ninclude. Set the parameter value to \u003ccode\u003esnippet\u003c/code\u003e."
},
"id": {
"type": "string",
"repeated": true,
"location": "query",
"description": "Return the guide categories with the given IDs."
}
},
"flatPath": "youtube/v3/guideCategories",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner"
]
}
}
},
"superChatEvents": {
"methods": {
"list": {
"httpMethod": "GET",
"path": "youtube/v3/superChatEvents",
"id": "youtube.superChatEvents.list",
"response": {
"$ref": "SuperChatEventListResponse"
},
"description": "Retrieves a list of resources, possibly filtered.",
"flatPath": "youtube/v3/superChatEvents",
"parameters": {
"hl": {
"type": "string",
"location": "query",
"description": "Return rendered funding amounts in specified language."
},
"pageToken": {
"description": "The \u003ccode\u003e\u003cstrong\u003epageToken\u003c/strong\u003e\u003c/code\u003e parameter identifies a specific\npage in the result set that should be returned. In an API response, the\n\u003ccode\u003enextPageToken\u003c/code\u003e and \u003ccode\u003eprevPageToken\u003c/code\u003e properties\nidentify other pages that could be retrieved.",
"location": "query",
"type": "string"
},
"part": {
"type": "string",
"location": "query",
"required": true,
"repeated": true,
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies the\n\u003ccode\u003esuperChatEvent\u003c/code\u003e resource parts that the API response will\ninclude. Supported values are \u003ccode\u003eid\u003c/code\u003e and \u003ccode\u003esnippet\u003c/code\u003e."
},
"maxResults": {
"location": "query",
"format": "uint32",
"default": "5",
"description": "The \u003ccode\u003e\u003cstrong\u003emaxResults\u003c/strong\u003e\u003c/code\u003e parameter specifies the\nmaximum number of items that should be returned in the result set.",
"type": "integer"
}
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly"
],
"parameterOrder": [
"part"
]
}
}
},
"comments": {
"methods": {
"list": {
"response": {
"$ref": "CommentListResponse"
},
"path": "youtube/v3/comments",
"id": "youtube.comments.list",
"parameterOrder": [
"part"
],
"flatPath": "youtube/v3/comments",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"description": "Retrieves a list of resources, possibly filtered.",
"parameters": {
"id": {
"description": "Returns the comments with the given IDs for One Platform.",
"repeated": true,
"type": "string",
"location": "query"
},
"part": {
"repeated": true,
"type": "string",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies a\ncomma-separated list of one or more \u003ccode\u003ecomment\u003c/code\u003e resource\nproperties that the API response will include.",
"required": true,
"location": "query"
},
"maxResults": {
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003emaxResults\u003c/strong\u003e\u003c/code\u003e parameter specifies the\nmaximum number of items that should be returned in the result set.",
"default": "20",
"format": "uint32",
"type": "integer"
},
"parentId": {
"location": "query",
"description": "Returns replies to the specified comment.\nNote, currently YouTube features only one level of replies (ie replies\nto top level comments). However replies to replies may be supported in\nthe future.",
"type": "string"
},
"pageToken": {
"description": "The \u003ccode\u003e\u003cstrong\u003epageToken\u003c/strong\u003e\u003c/code\u003e parameter identifies a specific\npage in the result set that should be returned. In an API response, the\n\u003ccode\u003enextPageToken\u003c/code\u003e and \u003ccode\u003eprevPageToken\u003c/code\u003e properties\nidentify other pages that could be retrieved.",
"type": "string",
"location": "query"
},
"textFormat": {
"description": "The requested text format for the returned comments.",
"enum": [
"textFormatUnspecified",
"html",
"plainText"
],
"type": "string",
"location": "query",
"default": "html"
}
}
},
"delete": {
"description": "Deletes a resource.",
"httpMethod": "DELETE",
"id": "youtube.comments.delete",
"scopes": [
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"parameterOrder": [
"id"
],
"flatPath": "youtube/v3/comments",
"path": "youtube/v3/comments",
"parameters": {
"id": {
"location": "query",
"type": "string",
"required": true
}
}
},
"markAsSpam": {
"description": "Expresses the caller's opinion that one or more comments should be flagged\nas spam.",
"parameters": {
"id": {
"type": "string",
"location": "query",
"description": "Flags the comments with the given IDs as spam in the caller's opinion.",
"required": true,
"repeated": true
}
},
"httpMethod": "POST",
"parameterOrder": [
"id"
],
"flatPath": "youtube/v3/comments/markAsSpam",
"scopes": [
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"id": "youtube.comments.markAsSpam",
"path": "youtube/v3/comments/markAsSpam"
},
"setModerationStatus": {
"scopes": [
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"flatPath": "youtube/v3/comments/setModerationStatus",
"id": "youtube.comments.setModerationStatus",
"parameterOrder": [
"id",
"moderationStatus"
],
"httpMethod": "POST",
"description": "Sets the moderation status of one or more comments.",
"path": "youtube/v3/comments/setModerationStatus",
"parameters": {
"banAuthor": {
"type": "boolean",
"default": "false",
"description": "If set to true the author of the comment gets added to the ban list.\nThis means all future comments of the author will autmomatically be\nrejected.\nOnly valid in combination with STATUS_REJECTED.",
"location": "query"
},
"moderationStatus": {
"location": "query",
"description": "Specifies the requested moderation status. Note, comments can be in\nstatuses, which are not available through this call. For example, this\ncall does not allow to mark a comment as 'likely spam'.\nValid values: MODERATION_STATUS_PUBLISHED,\nMODERATION_STATUS_HELD_FOR_REVIEW, MODERATION_STATUS_REJECTED.",
"required": true,
"type": "string",
"enum": [
"published",
"heldForReview",
"likelySpam",
"rejected"
]
},
"id": {
"type": "string",
"repeated": true,
"required": true,
"location": "query",
"description": "Modifies the moderation status of the comments with the given IDs"
}
}
},
"insert": {
"scopes": [
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"request": {
"$ref": "Comment"
},
"path": "youtube/v3/comments",
"id": "youtube.comments.insert",
"parameters": {
"part": {
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter identifies the properties\nthat the API response will include. Set the parameter value to\n\u003ccode\u003esnippet\u003c/code\u003e. The \u003ccode\u003esnippet\u003c/code\u003e part has a quota cost of 2\nunits.",
"required": true,
"type": "string",
"repeated": true,
"location": "query"
}
},
"description": "Inserts a new resource into this collection.",
"httpMethod": "POST",
"parameterOrder": [
"part"
],
"flatPath": "youtube/v3/comments",
"response": {
"$ref": "Comment"
}
},
"update": {
"request": {
"$ref": "Comment"
},
"flatPath": "youtube/v3/comments",
"scopes": [
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"response": {
"$ref": "Comment"
},
"httpMethod": "PUT",
"description": "Updates an existing resource.",
"parameters": {
"part": {
"repeated": true,
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter identifies the properties\nthat the API response will include. You must at least include the\n\u003ccode\u003esnippet\u003c/code\u003e part in the parameter value since that part contains\nall of the properties that the API request can update.",
"location": "query",
"type": "string",
"required": true
}
},
"parameterOrder": [
"part"
],
"path": "youtube/v3/comments",
"id": "youtube.comments.update"
}
}
},
"activities": {
"methods": {
"list": {
"path": "youtube/v3/activities",
"httpMethod": "GET",
"response": {
"$ref": "ActivityListResponse"
},
"flatPath": "youtube/v3/activities",
"description": "Retrieves a list of resources, possibly filtered.",
"parameterOrder": [
"part"
],
"id": "youtube.activities.list",
"parameters": {
"regionCode": {
"type": "string",
"location": "query"
},
"mine": {
"location": "query",
"type": "boolean"
},
"publishedBefore": {
"type": "string",
"location": "query",
"format": "google-datetime"
},
"part": {
"repeated": true,
"type": "string",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies a\ncomma-separated list of one or more \u003ccode\u003eactivity\u003c/code\u003e resource\nproperties that the API response will include.\u003cbr\u003e\u003cbr\u003eIf the parameter\nidentifies a property that contains child properties, the child properties\nwill be included in the response. For example, in an \u003ccode\u003eactivity\u003c/code\u003e\nresource, the \u003ccode\u003esnippet\u003c/code\u003e property contains other properties that\nidentify the type of activity, a display title for the activity, and so\nforth. If you set \u003ccode\u003e\u003cstrong\u003epart=snippet\u003c/strong\u003e\u003c/code\u003e, the API\nresponse will also contain all of those nested properties.",
"required": true,
"location": "query"
},
"channelId": {
"type": "string",
"location": "query"
},
"maxResults": {
"type": "integer",
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003emaxResults\u003c/strong\u003e\u003c/code\u003e parameter specifies the\nmaximum number of items that should be returned in the result set.",
"default": "5",
"format": "uint32"
},
"home": {
"location": "query",
"type": "boolean"
},
"publishedAfter": {
"location": "query",
"format": "google-datetime",
"type": "string"
},
"pageToken": {
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003epageToken\u003c/strong\u003e\u003c/code\u003e parameter identifies a specific\npage in the result set that should be returned. In an API response, the\n\u003ccode\u003enextPageToken\u003c/code\u003e and \u003ccode\u003eprevPageToken\u003c/code\u003e properties\nidentify other pages that could be retrieved.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly"
]
}
}
},
"captions": {
"methods": {
"download": {
"flatPath": "youtube/v3/captions/{id}",
"useMediaDownloadService": true,
"supportsMediaDownload": true,
"path": "youtube/v3/captions/{id}",
"parameterOrder": [
"id"
],
"parameters": {
"tlang": {
"location": "query",
"type": "string",
"description": "tlang is the language code; machine translate the captions into\nthis language."
},
"onBehalfOfContentOwner": {
"type": "string",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the request's authorization credentials identify a YouTube CMS user\nwho is acting on behalf of the content owner specified in the parameter\nvalue. This parameter is intended for YouTube content partners that own and\nmanage many different YouTube channels. It allows content owners to\nauthenticate once and get access to all their video and channel data,\nwithout having to provide authentication credentials for each individual\nchannel. The actual CMS account that the user authenticates with must be\nlinked to the specified YouTube content owner.",
"location": "query"
},
"id": {
"description": "The ID of the caption track to download, required for One Platform.",
"type": "string",
"required": true,
"location": "path"
},
"tfmt": {
"description": "Convert the captions into this format. Supported options are\nsbv, srt, and vtt.",
"location": "query",
"type": "string"
},
"onBehalfOf": {
"location": "query",
"type": "string",
"description": "ID of the Google+ Page for the channel that the request is be on behalf of"
}
},
"httpMethod": "GET",
"id": "youtube.captions.download",
"description": "Downloads a caption track.",
"scopes": [
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
]
},
"update": {
"scopes": [
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"path": "youtube/v3/captions",
"parameterOrder": [
"part"
],
"description": "Updates an existing resource.",
"httpMethod": "PUT",
"response": {
"$ref": "Caption"
},
"supportsMediaUpload": true,
"id": "youtube.captions.update",
"mediaUpload": {
"accept": [
"text/xml",
"application/octet-stream",
"*/*"
],
"protocols": {
"simple": {
"multipart": true,
"path": "/upload/youtube/v3/captions"
}
},
"maxSize": "104857600"
},
"flatPath": "youtube/v3/captions",
"request": {
"$ref": "Caption"
},
"parameters": {
"onBehalfOfContentOwner": {
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the request's authorization credentials identify a YouTube CMS user\nwho is acting on behalf of the content owner specified in the parameter\nvalue. This parameter is intended for YouTube content partners that own and\nmanage many different YouTube channels. It allows content owners to\nauthenticate once and get access to all their video and channel data,\nwithout having to provide authentication credentials for each individual\nchannel. The actual CMS account that the user authenticates with must be\nlinked to the specified YouTube content owner.",
"location": "query",
"type": "string"
},
"sync": {
"description": "Extra parameter to allow automatically syncing the uploaded\ncaption/transcript with the audio.",
"type": "boolean",
"location": "query"
},
"part": {
"required": true,
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies a\ncomma-separated list of one or more \u003ccode\u003ecaption\u003c/code\u003e resource parts\nthat the API response will include. The \u003ccode\u003epart\u003c/code\u003e names that you\ncan include in the parameter value are \u003ccode\u003eid\u003c/code\u003e and\n\u003ccode\u003esnippet\u003c/code\u003e.",
"repeated": true,
"type": "string",
"location": "query"
},
"onBehalfOf": {
"description": "ID of the Google+ Page for the channel that the request is on behalf of.",
"location": "query",
"type": "string"
}
}
},
"insert": {
"flatPath": "youtube/v3/captions",
"parameterOrder": [
"part"
],
"response": {
"$ref": "Caption"
},
"parameters": {
"onBehalfOf": {
"type": "string",
"location": "query",
"description": "ID of the Google+ Page for the channel that the request is be on behalf of"
},
"onBehalfOfContentOwner": {
"location": "query",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the request's authorization credentials identify a YouTube CMS user\nwho is acting on behalf of the content owner specified in the parameter\nvalue. This parameter is intended for YouTube content partners that own and\nmanage many different YouTube channels. It allows content owners to\nauthenticate once and get access to all their video and channel data,\nwithout having to provide authentication credentials for each individual\nchannel. The actual CMS account that the user authenticates with must be\nlinked to the specified YouTube content owner.",
"type": "string"
},
"part": {
"type": "string",
"required": true,
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies the\n\u003ccode\u003ecaption\u003c/code\u003e resource parts that the API response will include. Set\nthe parameter value to \u003ccode\u003esnippet\u003c/code\u003e.",
"repeated": true
},
"sync": {
"type": "boolean",
"location": "query",
"description": "Extra parameter to allow automatically syncing the uploaded\ncaption/transcript with the audio."
}
},
"id": "youtube.captions.insert",
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"request": {
"$ref": "Caption"
},
"path": "youtube/v3/captions",
"mediaUpload": {
"maxSize": "104857600",
"accept": [
"text/xml",
"application/octet-stream",
"*/*"
],
"protocols": {
"simple": {
"path": "/upload/youtube/v3/captions",
"multipart": true
}
}
},
"description": "Inserts a new resource into this collection.",
"supportsMediaUpload": true
},
"delete": {
"parameterOrder": [
"id"
],
"parameters": {
"id": {
"location": "query",
"type": "string",
"required": true
},
"onBehalfOf": {
"type": "string",
"location": "query",
"description": "ID of the Google+ Page for the channel that the request is be on behalf of"
},
"onBehalfOfContentOwner": {
"type": "string",
"location": "query",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the request's authorization credentials identify a YouTube CMS user\nwho is acting on behalf of the content owner specified in the parameter\nvalue. This parameter is intended for YouTube content partners that own and\nmanage many different YouTube channels. It allows content owners to\nauthenticate once and get access to all their video and channel data,\nwithout having to provide authentication credentials for each individual\nchannel. The actual CMS account that the user authenticates with must be\nlinked to the specified YouTube content owner."
}
},
"flatPath": "youtube/v3/captions",
"path": "youtube/v3/captions",
"scopes": [
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"httpMethod": "DELETE",
"id": "youtube.captions.delete",
"description": "Deletes a resource."
},
"list": {
"parameters": {
"part": {
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies a\ncomma-separated list of one or more \u003ccode\u003ecaption\u003c/code\u003e resource parts\nthat the API response will include. The \u003ccode\u003epart\u003c/code\u003e names that you\ncan include in the parameter value are \u003ccode\u003eid\u003c/code\u003e and\n\u003ccode\u003esnippet\u003c/code\u003e.",
"required": true,
"location": "query",
"repeated": true,
"type": "string"
},
"videoId": {
"location": "query",
"type": "string",
"description": "Returns the captions for the specified video.",
"required": true
},
"onBehalfOf": {
"type": "string",
"description": "ID of the Google+ Page for the channel that the request is on behalf of.",
"location": "query"
},
"id": {
"location": "query",
"description": "Returns the captions with the given IDs for Stubby or Apiary.",
"type": "string",
"repeated": true
},
"onBehalfOfContentOwner": {
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the request's authorization credentials identify a YouTube CMS user\nwho is acting on behalf of the content owner specified in the parameter\nvalue. This parameter is intended for YouTube content partners that own and\nmanage many different YouTube channels. It allows content owners to\nauthenticate once and get access to all their video and channel data,\nwithout having to provide authentication credentials for each individual\nchannel. The actual CMS account that the user authenticates with must be\nlinked to the specified YouTube content owner.",
"type": "string",
"location": "query"
}
},
"id": "youtube.captions.list",
"response": {
"$ref": "CaptionListResponse"
},
"flatPath": "youtube/v3/captions",
"scopes": [
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"path": "youtube/v3/captions",
"parameterOrder": [
"videoId",
"part"
],
"httpMethod": "GET",
"description": "Retrieves a list of resources, possibly filtered."
}
}
},
"liveChatMessages": {
"methods": {
"delete": {
"description": "Deletes a chat message.",
"flatPath": "youtube/v3/liveChat/messages",
"parameters": {
"id": {
"required": true,
"location": "query",
"type": "string"
}
},
"httpMethod": "DELETE",
"path": "youtube/v3/liveChat/messages",
"parameterOrder": [
"id"
],
"id": "youtube.liveChatMessages.delete",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl"
]
},
"list": {
"id": "youtube.liveChatMessages.list",
"path": "youtube/v3/liveChat/messages",
"parameterOrder": [
"liveChatId",
"part"
],
"parameters": {
"profileImageSize": {
"description": "Specifies the size of the profile image that should be\nreturned for each user.",
"format": "uint32",
"type": "integer",
"location": "query"
},
"maxResults": {
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003emaxResults\u003c/strong\u003e\u003c/code\u003e parameter specifies the\nmaximum number of items that should be returned in the result set.",
"default": "500",
"type": "integer",
"format": "uint32"
},
"liveChatId": {
"type": "string",
"location": "query",
"required": true,
"description": "The id of the live chat for which comments should be returned."
},
"part": {
"location": "query",
"required": true,
"repeated": true,
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies the\n\u003ccode\u003eliveChatComment\u003c/code\u003e resource parts that the API response will\ninclude. Supported values are \u003ccode\u003eid\u003c/code\u003e and \u003ccode\u003esnippet\u003c/code\u003e.",
"type": "string"
},
"pageToken": {
"description": "The \u003ccode\u003e\u003cstrong\u003epageToken\u003c/strong\u003e\u003c/code\u003e parameter identifies a specific\npage in the result set that should be returned. In an API response, the\n\u003ccode\u003enextPageToken\u003c/code\u003e property identify other pages that could be\nretrieved.",
"location": "query",
"type": "string"
},
"hl": {
"location": "query",
"type": "string",
"description": "Specifies the localization language in which the system messages\nshould be returned."
}
},
"description": "Retrieves a list of resources, possibly filtered.",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly"
],
"httpMethod": "GET",
"flatPath": "youtube/v3/liveChat/messages",
"response": {
"$ref": "LiveChatMessageListResponse"
}
},
"insert": {
"parameters": {
"part": {
"type": "string",
"repeated": true,
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter serves two purposes. It\nidentifies the properties that the write operation will set as well as the\nproperties that the API response will include. Set the parameter value to\n\u003ccode\u003esnippet\u003c/code\u003e.",
"required": true
}
},
"request": {
"$ref": "LiveChatMessage"
},
"flatPath": "youtube/v3/liveChat/messages",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"description": "Inserts a new resource into this collection.",
"response": {
"$ref": "LiveChatMessage"
},
"httpMethod": "POST",
"id": "youtube.liveChatMessages.insert",
"parameterOrder": [
"part"
],
"path": "youtube/v3/liveChat/messages"
}
}
},
"channelBanners": {
"methods": {
"insert": {
"request": {
"$ref": "ChannelBannerResource"
},
"httpMethod": "POST",
"mediaUpload": {
"maxSize": "6291456",
"accept": [
"image/jpeg",
"image/png",
"application/octet-stream"
],
"protocols": {
"simple": {
"multipart": true,
"path": "/upload/youtube/v3/channelBanners/insert"
}
}
},
"id": "youtube.channelBanners.insert",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.upload"
],
"description": "Inserts a new resource into this collection.",
"parameterOrder": [],
"path": "youtube/v3/channelBanners/insert",
"flatPath": "youtube/v3/channelBanners/insert",
"response": {
"$ref": "ChannelBannerResource"
},
"supportsMediaUpload": true,
"parameters": {
"channelId": {
"description": "Unused, channel_id is currently derived from the security context of the\nrequestor.",
"type": "string",
"location": "query"
},
"onBehalfOfContentOwnerChannel": {
"location": "query",
"type": "string",
"description": "This parameter can only be used in a properly \u003ca\nhref=\"/youtube/v3/guides/authentication\"\u003eauthorized request\u003c/a\u003e.\n\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwnerChannel\u003c/strong\u003e\u003c/code\u003e parameter\nspecifies the YouTube channel ID of the channel to which a video is being\nadded. This parameter is required when a request specifies a value for the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter, and it can only be used in\nconjunction with that parameter. In addition, the request must be\nauthorized using a CMS account that is linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies. Finally, the\nchannel that the \u003ccode\u003eonBehalfOfContentOwnerChannel\u003c/code\u003e parameter value\nspecifies must be linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies.\u003cbr\u003e\u003cbr\u003eThis\nparameter is intended for YouTube content partners that own and manage many\ndifferent YouTube channels. It allows content owners to authenticate once\nand perform actions on behalf of the channel specified in the parameter\nvalue, without having to provide authentication credentials for each\nseparate channel."
},
"onBehalfOfContentOwner": {
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the request's authorization credentials identify a YouTube CMS user\nwho is acting on behalf of the content owner specified in the parameter\nvalue. This parameter is intended for YouTube content partners that own and\nmanage many different YouTube channels. It allows content owners to\nauthenticate once and get access to all their video and channel data,\nwithout having to provide authentication credentials for each individual\nchannel. The actual CMS account that the user authenticates with must be\nlinked to the specified YouTube content owner.",
"type": "string",
"location": "query"
}
}
}
}
},
"subscriptions": {
"methods": {
"insert": {
"description": "Inserts a new resource into this collection.",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"parameterOrder": [
"part"
],
"httpMethod": "POST",
"parameters": {
"part": {
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter serves two purposes in\nthis operation. It identifies the properties that the write operation will\nset as well as the properties that the API response will include.",
"repeated": true,
"location": "query",
"required": true,
"type": "string"
}
},
"response": {
"$ref": "Subscription"
},
"id": "youtube.subscriptions.insert",
"flatPath": "youtube/v3/subscriptions",
"request": {
"$ref": "Subscription"
},
"path": "youtube/v3/subscriptions"
},
"list": {
"response": {
"$ref": "SubscriptionListResponse"
},
"description": "Retrieves a list of resources, possibly filtered.",
"flatPath": "youtube/v3/subscriptions",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner"
],
"parameterOrder": [
"part"
],
"httpMethod": "GET",
"path": "youtube/v3/subscriptions",
"parameters": {
"maxResults": {
"format": "uint32",
"type": "integer",
"location": "query",
"default": "5",
"description": "The \u003ccode\u003e\u003cstrong\u003emaxResults\u003c/strong\u003e\u003c/code\u003e parameter specifies the\nmaximum number of items that should be returned in the result set."
},
"part": {
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies a\ncomma-separated list of one or more \u003ccode\u003esubscription\u003c/code\u003e resource\nproperties that the API response will include.\u003cbr\u003e\u003cbr\u003eIf the parameter\nidentifies a property that contains child properties, the child properties\nwill be included in the response. For example, in a\n\u003ccode\u003esubscription\u003c/code\u003e resource, the \u003ccode\u003esnippet\u003c/code\u003e property\ncontains other properties, such as a display title for the subscription. If\nyou set \u003ccode\u003e\u003cstrong\u003epart=snippet\u003c/strong\u003e\u003c/code\u003e, the API response will\nalso contain all of those nested properties.",
"repeated": true,
"required": true,
"type": "string",
"location": "query"
},
"forChannelId": {
"description": "Return the subscriptions to the subset of these channels that the\nauthenticated user is subscribed to.",
"location": "query",
"type": "string"
},
"mine": {
"location": "query",
"description": "Flag for returning the subscriptions of the authenticated user.",
"type": "boolean"
},
"pageToken": {
"description": "The \u003ccode\u003e\u003cstrong\u003epageToken\u003c/strong\u003e\u003c/code\u003e parameter identifies a specific\npage in the result set that should be returned. In an API response, the\n\u003ccode\u003enextPageToken\u003c/code\u003e and \u003ccode\u003eprevPageToken\u003c/code\u003e properties\nidentify other pages that could be retrieved.",
"type": "string",
"location": "query"
},
"onBehalfOfContentOwner": {
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner.",
"type": "string",
"location": "query"
},
"myRecentSubscribers": {
"location": "query",
"type": "boolean"
},
"onBehalfOfContentOwnerChannel": {
"type": "string",
"description": "This parameter can only be used in a properly \u003ca\nhref=\"/youtube/v3/guides/authentication\"\u003eauthorized request\u003c/a\u003e.\n\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwnerChannel\u003c/strong\u003e\u003c/code\u003e parameter\nspecifies the YouTube channel ID of the channel to which a video is being\nadded. This parameter is required when a request specifies a value for the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter, and it can only be used in\nconjunction with that parameter. In addition, the request must be\nauthorized using a CMS account that is linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies. Finally, the\nchannel that the \u003ccode\u003eonBehalfOfContentOwnerChannel\u003c/code\u003e parameter value\nspecifies must be linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies.\u003cbr\u003e\u003cbr\u003eThis\nparameter is intended for YouTube content partners that own and manage many\ndifferent YouTube channels. It allows content owners to authenticate once\nand perform actions on behalf of the channel specified in the parameter\nvalue, without having to provide authentication credentials for each\nseparate channel.",
"location": "query"
},
"order": {
"description": "The order of the returned subscriptions",
"location": "query",
"enum": [
"subscriptionOrderUnspecified",
"relevance",
"unread",
"alphabetical"
],
"type": "string",
"default": "relevance"
},
"id": {
"type": "string",
"repeated": true,
"location": "query",
"description": "Return the subscriptions with the given IDs for Stubby or Apiary."
},
"channelId": {
"location": "query",
"description": "Return the subscriptions of the given channel owner.",
"type": "string"
},
"mySubscribers": {
"description": "Return the subscribers of the given channel owner.",
"type": "boolean",
"location": "query"
}
},
"id": "youtube.subscriptions.list"
},
"delete": {
"id": "youtube.subscriptions.delete",
"description": "Deletes a resource.",
"httpMethod": "DELETE",
"parameters": {
"id": {
"required": true,
"location": "query",
"type": "string"
}
},
"parameterOrder": [
"id"
],
"flatPath": "youtube/v3/subscriptions",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"path": "youtube/v3/subscriptions"
}
}
},
"playlistItems": {
"methods": {
"delete": {
"httpMethod": "DELETE",
"parameters": {
"id": {
"type": "string",
"location": "query",
"required": true
},
"onBehalfOfContentOwner": {
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner.",
"type": "string",
"location": "query"
}
},
"description": "Deletes a resource.",
"id": "youtube.playlistItems.delete",
"parameterOrder": [
"id"
],
"path": "youtube/v3/playlistItems",
"flatPath": "youtube/v3/playlistItems",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
]
},
"insert": {
"id": "youtube.playlistItems.insert",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"path": "youtube/v3/playlistItems",
"parameterOrder": [
"part"
],
"flatPath": "youtube/v3/playlistItems",
"parameters": {
"onBehalfOfContentOwner": {
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner.",
"type": "string",
"location": "query"
},
"part": {
"required": true,
"type": "string",
"repeated": true,
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter serves two purposes in\nthis operation. It identifies the properties that the write operation will\nset as well as the properties that the API response will include.",
"location": "query"
}
},
"description": "Inserts a new resource into this collection.",
"request": {
"$ref": "PlaylistItem"
},
"response": {
"$ref": "PlaylistItem"
},
"httpMethod": "POST"
},
"update": {
"id": "youtube.playlistItems.update",
"httpMethod": "PUT",
"parameters": {
"part": {
"repeated": true,
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter serves two purposes in\nthis operation. It identifies the properties that the write operation will\nset as well as the properties that the API response will\ninclude.\u003cbr/\u003e\u003cbr/\u003eNote that this method will override the existing values\nfor all of the mutable properties that are contained in any parts that the\nparameter value specifies. For example, a playlist item can specify a start\ntime and end time, which identify the times portion of the video that\nshould play when users watch the video in the playlist. If your request is\nupdating a playlist item that sets these values, and the\nrequest's \u003ccode\u003epart\u003c/code\u003e parameter value includes the\n\u003ccode\u003econtentDetails\u003c/code\u003e part, the playlist item's start and end times\nwill be updated to whatever value the request body specifies. If the\nrequest body does not specify values, the existing start and end times will\nbe removed and replaced with the default settings.",
"required": true,
"type": "string",
"location": "query"
},
"onBehalfOfContentOwner": {
"type": "string",
"location": "query",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner."
}
},
"parameterOrder": [
"part"
],
"request": {
"$ref": "PlaylistItem"
},
"response": {
"$ref": "PlaylistItem"
},
"description": "Updates an existing resource.",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"path": "youtube/v3/playlistItems",
"flatPath": "youtube/v3/playlistItems"
},
"list": {
"id": "youtube.playlistItems.list",
"response": {
"$ref": "PlaylistItemListResponse"
},
"flatPath": "youtube/v3/playlistItems",
"description": "Retrieves a list of resources, possibly filtered.",
"path": "youtube/v3/playlistItems",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner"
],
"parameterOrder": [
"part"
],
"parameters": {
"onBehalfOfContentOwner": {
"location": "query",
"type": "string",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner."
},
"playlistId": {
"description": "Return the playlist items within the given playlist.",
"location": "query",
"type": "string"
},
"maxResults": {
"description": "The \u003ccode\u003e\u003cstrong\u003emaxResults\u003c/strong\u003e\u003c/code\u003e parameter specifies the\nmaximum number of items that should be returned in the result set.",
"type": "integer",
"format": "uint32",
"default": "5",
"location": "query"
},
"part": {
"required": true,
"type": "string",
"location": "query",
"repeated": true,
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies a\ncomma-separated list of one or more \u003ccode\u003eplaylistItem\u003c/code\u003e resource\nproperties that the API response will include.\u003cbr\u003e\u003cbr\u003eIf the parameter\nidentifies a property that contains child properties, the child properties\nwill be included in the response. For example, in a\n\u003ccode\u003eplaylistItem\u003c/code\u003e resource, the \u003ccode\u003esnippet\u003c/code\u003e property\ncontains numerous fields, including the \u003ccode\u003etitle\u003c/code\u003e,\n\u003ccode\u003edescription\u003c/code\u003e, \u003ccode\u003eposition\u003c/code\u003e, and\n\u003ccode\u003eresourceId\u003c/code\u003e properties. As such, if you set\n\u003ccode\u003e\u003cstrong\u003epart=snippet\u003c/strong\u003e\u003c/code\u003e, the API response will contain\nall of those properties."
},
"pageToken": {
"description": "The \u003ccode\u003e\u003cstrong\u003epageToken\u003c/strong\u003e\u003c/code\u003e parameter identifies a specific\npage in the result set that should be returned. In an API response, the\n\u003ccode\u003enextPageToken\u003c/code\u003e and \u003ccode\u003eprevPageToken\u003c/code\u003e properties\nidentify other pages that could be retrieved.",
"type": "string",
"location": "query"
},
"videoId": {
"type": "string",
"location": "query",
"description": "Return the playlist items associated with the given video ID."
},
"id": {
"type": "string",
"repeated": true,
"location": "query"
}
},
"httpMethod": "GET"
}
}
},
"liveChatModerators": {
"methods": {
"insert": {
"request": {
"$ref": "LiveChatModerator"
},
"id": "youtube.liveChatModerators.insert",
"description": "Inserts a new resource into this collection.",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"parameters": {
"part": {
"type": "string",
"repeated": true,
"location": "query",
"required": true,
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter serves two purposes in\nthis operation. It identifies the properties that the write operation will\nset as well as the properties that the API response returns. Set the\nparameter value to \u003ccode\u003esnippet\u003c/code\u003e."
}
},
"flatPath": "youtube/v3/liveChat/moderators",
"response": {
"$ref": "LiveChatModerator"
},
"httpMethod": "POST",
"path": "youtube/v3/liveChat/moderators",
"parameterOrder": [
"part"
]
},
"delete": {
"path": "youtube/v3/liveChat/moderators",
"description": "Deletes a chat moderator.",
"parameterOrder": [
"id"
],
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"parameters": {
"id": {
"location": "query",
"required": true,
"type": "string"
}
},
"flatPath": "youtube/v3/liveChat/moderators",
"id": "youtube.liveChatModerators.delete"
},
"list": {
"flatPath": "youtube/v3/liveChat/moderators",
"parameterOrder": [
"liveChatId",
"part"
],
"path": "youtube/v3/liveChat/moderators",
"httpMethod": "GET",
"id": "youtube.liveChatModerators.list",
"description": "Retrieves a list of resources, possibly filtered.",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly"
],
"response": {
"$ref": "LiveChatModeratorListResponse"
},
"parameters": {
"pageToken": {
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003epageToken\u003c/strong\u003e\u003c/code\u003e parameter identifies a specific\npage in the result set that should be returned. In an API response, the\n\u003ccode\u003enextPageToken\u003c/code\u003e and \u003ccode\u003eprevPageToken\u003c/code\u003e properties\nidentify other pages that could be retrieved.",
"type": "string"
},
"maxResults": {
"type": "integer",
"default": "5",
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003emaxResults\u003c/strong\u003e\u003c/code\u003e parameter specifies the\nmaximum number of items that should be returned in the result set.",
"format": "uint32"
},
"part": {
"type": "string",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies the\n\u003ccode\u003eliveChatModerator\u003c/code\u003e resource parts that the API response will\ninclude. Supported values are \u003ccode\u003eid\u003c/code\u003e and \u003ccode\u003esnippet\u003c/code\u003e.",
"location": "query",
"required": true,
"repeated": true
},
"liveChatId": {
"required": true,
"type": "string",
"description": "The id of the live chat for which moderators should be returned.",
"location": "query"
}
}
}
}
},
"liveChatBans": {
"methods": {
"insert": {
"flatPath": "youtube/v3/liveChat/bans",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"description": "Inserts a new resource into this collection.",
"path": "youtube/v3/liveChat/bans",
"response": {
"$ref": "LiveChatBan"
},
"parameterOrder": [
"part"
],
"parameters": {
"part": {
"repeated": true,
"type": "string",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter serves two purposes in\nthis operation. It identifies the properties that the write operation will\nset as well as the properties that the API response returns. Set the\nparameter value to \u003ccode\u003esnippet\u003c/code\u003e.",
"required": true,
"location": "query"
}
},
"id": "youtube.liveChatBans.insert",
"request": {
"$ref": "LiveChatBan"
},
"httpMethod": "POST"
},
"delete": {
"description": "Deletes a chat ban.",
"id": "youtube.liveChatBans.delete",
"path": "youtube/v3/liveChat/bans",
"parameters": {
"id": {
"type": "string",
"location": "query",
"required": true
}
},
"parameterOrder": [
"id"
],
"flatPath": "youtube/v3/liveChat/bans",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"httpMethod": "DELETE"
}
}
},
"thumbnails": {
"methods": {
"set": {
"mediaUpload": {
"protocols": {
"simple": {
"path": "/upload/youtube/v3/thumbnails/set",
"multipart": true
}
},
"accept": [
"image/jpeg",
"image/png",
"application/octet-stream"
],
"maxSize": "2097152"
},
"supportsMediaUpload": true,
"parameters": {
"videoId": {
"location": "query",
"type": "string",
"description": "Returns the Thumbnail with the given video IDs for Stubby or Apiary.",
"required": true
},
"onBehalfOfContentOwner": {
"location": "query",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The actual\nCMS account that the user authenticates with must be linked to the\nspecified YouTube content owner.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.upload",
"https://www.googleapis.com/auth/youtubepartner"
],
"response": {
"$ref": "ThumbnailSetResponse"
},
"id": "youtube.thumbnails.set",
"path": "youtube/v3/thumbnails/set",
"parameterOrder": [
"videoId"
],
"flatPath": "youtube/v3/thumbnails/set",
"description": "As this is not an insert in a strict sense (it supports uploading/setting\nof a thumbnail for multiple videos, which doesn't result in creation of a\nsingle resource), I use a custom verb here.",
"httpMethod": "POST"
}
}
},
"channels": {
"methods": {
"update": {
"id": "youtube.channels.update",
"parameterOrder": [
"part"
],
"description": "Updates an existing resource.",
"response": {
"$ref": "Channel"
},
"flatPath": "youtube/v3/channels",
"request": {
"$ref": "Channel"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"parameters": {
"part": {
"required": true,
"repeated": true,
"type": "string",
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter serves two purposes in\nthis operation. It identifies the properties that the write operation will\nset as well as the properties that the API response will\ninclude.\u003cbr/\u003e\u003cbr/\u003eThe API currently only allows the parameter value to be\nset to either \u003ccode\u003ebrandingSettings\u003c/code\u003e or\n\u003ccode\u003einvideoPromotion\u003c/code\u003e. (You cannot update both of those parts with\na single request.)\u003cbr/\u003e\u003cbr/\u003eNote that this method overrides the existing\nvalues for all of the mutable properties that are contained in any parts\nthat the parameter value specifies."
},
"onBehalfOfContentOwner": {
"location": "query",
"type": "string",
"description": "The \u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter\nindicates that the authenticated user is acting on behalf of the content\nowner specified in the parameter value. This parameter is intended for\nYouTube content partners that own and manage many different YouTube\nchannels. It allows content owners to authenticate once and get access to\nall their video and channel data, without having to provide authentication\ncredentials for each individual channel. The actual CMS account that the\nuser authenticates with needs to be linked to the specified YouTube content\nowner."
}
},
"path": "youtube/v3/channels",
"httpMethod": "PUT"
},
"list": {
"parameters": {
"categoryId": {
"location": "query",
"type": "string",
"description": "Return the channels within the specified guide category ID."
},
"mySubscribers": {
"description": "Return the channels subscribed to the authenticated user",
"type": "boolean",
"location": "query"
},
"onBehalfOfContentOwner": {
"type": "string",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner.",
"location": "query"
},
"mine": {
"description": "Return the ids of channels owned by the authenticated user.",
"location": "query",
"type": "boolean"
},
"forUsername": {
"description": "Return the channel associated with a YouTube username.",
"type": "string",
"location": "query"
},
"part": {
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies a\ncomma-separated list of one or more \u003ccode\u003echannel\u003c/code\u003e resource\nproperties that the API response will include.\u003cbr\u003e\u003cbr\u003eIf the parameter\nidentifies a property that contains child properties, the child properties\nwill be included in the response. For example, in a \u003ccode\u003echannel\u003c/code\u003e\nresource, the \u003ccode\u003econtentDetails\u003c/code\u003e property contains other\nproperties, such as the \u003ccode\u003euploads\u003c/code\u003e properties. As such, if you\nset \u003ccode\u003e\u003cstrong\u003epart=contentDetails\u003c/strong\u003e\u003c/code\u003e, the API response\nwill also contain all of those nested properties.",
"required": true,
"repeated": true,
"type": "string"
},
"managedByMe": {
"description": "Return the channels managed by the authenticated user.",
"location": "query",
"type": "boolean"
},
"pageToken": {
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003epageToken\u003c/strong\u003e\u003c/code\u003e parameter identifies a specific\npage in the result set that should be returned. In an API response, the\n\u003ccode\u003enextPageToken\u003c/code\u003e and \u003ccode\u003eprevPageToken\u003c/code\u003e properties\nidentify other pages that could be retrieved.",
"type": "string"
},
"id": {
"type": "string",
"repeated": true,
"location": "query",
"description": "Return the channels with the specified IDs."
},
"maxResults": {
"location": "query",
"format": "uint32",
"type": "integer",
"default": "5",
"description": "The \u003ccode\u003e\u003cstrong\u003emaxResults\u003c/strong\u003e\u003c/code\u003e parameter specifies the\nmaximum number of items that should be returned in the result set."
},
"hl": {
"type": "string",
"location": "query",
"description": "Stands for \"host language\". Specifies the localization language of the\nmetadata to be filled into snippet.localized. The field is filled with the\ndefault metadata if there is no localization in the specified language.\nThe parameter value must be a language code included in the list returned\nby the i18nLanguages.list method (e.g. en_US, es_MX)."
}
},
"path": "youtube/v3/channels",
"flatPath": "youtube/v3/channels",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner",
"https://www.googleapis.com/auth/youtubepartner-channel-audit"
],
"description": "Retrieves a list of resources, possibly filtered.",
"parameterOrder": [
"part"
],
"id": "youtube.channels.list",
"response": {
"$ref": "ChannelListResponse"
}
}
}
},
"commentThreads": {
"methods": {
"list": {
"path": "youtube/v3/commentThreads",
"description": "Retrieves a list of resources, possibly filtered.",
"id": "youtube.commentThreads.list",
"httpMethod": "GET",
"parameterOrder": [
"part"
],
"flatPath": "youtube/v3/commentThreads",
"parameters": {
"id": {
"description": "Returns the comment threads with the given IDs for Stubby or Apiary.",
"type": "string",
"repeated": true,
"location": "query"
},
"videoId": {
"description": "Returns the comment threads of the specified video.",
"location": "query",
"type": "string"
},
"allThreadsRelatedToChannelId": {
"type": "string",
"location": "query",
"description": "Returns the comment threads of all videos of the channel and the\nchannel comments as well."
},
"searchTerms": {
"type": "string",
"description": "Limits the returned comment threads to those matching the specified\nkey words. Not compatible with the 'id' filter.",
"location": "query"
},
"order": {
"default": "time",
"location": "query",
"enum": [
"orderUnspecified",
"time",
"relevance"
],
"type": "string"
},
"channelId": {
"type": "string",
"location": "query",
"description": "Returns the comment threads for all the channel comments (ie does not\ninclude comments left on videos)."
},
"pageToken": {
"type": "string",
"description": "The \u003ccode\u003e\u003cstrong\u003epageToken\u003c/strong\u003e\u003c/code\u003e parameter identifies a specific\npage in the result set that should be returned. In an API response, the\n\u003ccode\u003enextPageToken\u003c/code\u003e and \u003ccode\u003eprevPageToken\u003c/code\u003e properties\nidentify other pages that could be retrieved.",
"location": "query"
},
"moderationStatus": {
"enum": [
"published",
"heldForReview",
"likelySpam",
"rejected"
],
"type": "string",
"default": "published",
"description": "Limits the returned comment threads to those with the specified\nmoderation status. Not compatible with the 'id' filter.\nValid values: published, heldForReview, likelySpam.",
"location": "query"
},
"part": {
"repeated": true,
"required": true,
"location": "query",
"type": "string",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies a\ncomma-separated list of one or more \u003ccode\u003ecommentThread\u003c/code\u003e resource\nproperties that the API response will include."
},
"textFormat": {
"description": "The requested text format for the returned comments.",
"default": "html",
"type": "string",
"enum": [
"textFormatUnspecified",
"html",
"plainText"
],
"location": "query"
},
"maxResults": {
"type": "integer",
"default": "20",
"description": "The \u003ccode\u003e\u003cstrong\u003emaxResults\u003c/strong\u003e\u003c/code\u003e parameter specifies the\nmaximum number of items that should be returned in the result set.",
"format": "uint32",
"location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"response": {
"$ref": "CommentThreadListResponse"
}
},
"insert": {
"id": "youtube.commentThreads.insert",
"description": "Inserts a new resource into this collection.",
"request": {
"$ref": "CommentThread"
},
"httpMethod": "POST",
"response": {
"$ref": "CommentThread"
},
"scopes": [
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"parameterOrder": [
"part"
],
"path": "youtube/v3/commentThreads",
"parameters": {
"part": {
"repeated": true,
"type": "string",
"required": true,
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter identifies the properties\nthat the API response will include. Set the parameter value to\n\u003ccode\u003esnippet\u003c/code\u003e. The \u003ccode\u003esnippet\u003c/code\u003e part has a quota cost of 2\nunits."
}
},
"flatPath": "youtube/v3/commentThreads"
},
"update": {
"id": "youtube.commentThreads.update",
"path": "youtube/v3/commentThreads",
"flatPath": "youtube/v3/commentThreads",
"httpMethod": "PUT",
"parameterOrder": [
"part"
],
"request": {
"$ref": "CommentThread"
},
"description": "Updates an existing resource.",
"scopes": [
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"parameters": {
"part": {
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies a\ncomma-separated list of \u003ccode\u003ecommentThread\u003c/code\u003e resource properties that\nthe API response will include. You must at least include the\n\u003ccode\u003esnippet\u003c/code\u003e part in the parameter value since that part contains\nall of the properties that the API request can update.",
"location": "query",
"required": true,
"type": "string",
"repeated": true
}
},
"response": {
"$ref": "CommentThread"
}
}
}
},
"abuseReports": {
"methods": {
"insert": {
"flatPath": "youtube/v3/abuseReports",
"description": "Inserts a new resource into this collection.",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"parameters": {
"part": {
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter serves two purposes in\nthis operation. It identifies the properties that the write operation will\nset as well as the properties that the API response will include.",
"required": true,
"repeated": true,
"type": "string"
}
},
"path": "youtube/v3/abuseReports",
"response": {
"$ref": "AbuseReport"
},
"request": {
"$ref": "AbuseReport"
},
"httpMethod": "POST",
"id": "youtube.abuseReports.insert",
"parameterOrder": [
"part"
]
}
}
},
"channelSections": {
"methods": {
"delete": {
"path": "youtube/v3/channelSections",
"id": "youtube.channelSections.delete",
"parameters": {
"onBehalfOfContentOwner": {
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner.",
"type": "string",
"location": "query"
},
"id": {
"type": "string",
"required": true,
"location": "query"
}
},
"flatPath": "youtube/v3/channelSections",
"httpMethod": "DELETE",
"description": "Deletes a resource.",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"parameterOrder": [
"id"
]
},
"list": {
"flatPath": "youtube/v3/channelSections",
"parameters": {
"onBehalfOfContentOwner": {
"location": "query",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner.",
"type": "string"
},
"part": {
"type": "string",
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies a\ncomma-separated list of one or more \u003ccode\u003echannelSection\u003c/code\u003e resource\nproperties that the API response will include. The \u003ccode\u003epart\u003c/code\u003e names\nthat you can include in the parameter value are \u003ccode\u003eid\u003c/code\u003e,\n\u003ccode\u003esnippet\u003c/code\u003e, and \u003ccode\u003econtentDetails\u003c/code\u003e.\u003cbr\u003e\u003cbr\u003eIf the\nparameter identifies a property that contains child properties, the child\nproperties will be included in the response. For example, in a\n\u003ccode\u003echannelSection\u003c/code\u003e resource, the \u003ccode\u003esnippet\u003c/code\u003e property\ncontains other properties, such as a display title for the channelSection.\nIf you set \u003ccode\u003e\u003cstrong\u003epart=snippet\u003c/strong\u003e\u003c/code\u003e, the API response\nwill also contain all of those nested properties.",
"required": true,
"repeated": true
},
"mine": {
"description": "Return the ChannelSections owned by the authenticated user.",
"type": "boolean",
"location": "query"
},
"id": {
"description": "Return the ChannelSections with the given IDs for Stubby or Apiary.",
"repeated": true,
"type": "string",
"location": "query"
},
"hl": {
"description": "Return content in specified language",
"location": "query",
"type": "string"
},
"channelId": {
"location": "query",
"type": "string",
"description": "Return the ChannelSections owned by the specified channel ID."
}
},
"parameterOrder": [
"part"
],
"httpMethod": "GET",
"id": "youtube.channelSections.list",
"response": {
"$ref": "ChannelSectionListResponse"
},
"description": "Retrieves a list of resources, possibly filtered.",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner"
],
"path": "youtube/v3/channelSections"
},
"update": {
"id": "youtube.channelSections.update",
"response": {
"$ref": "ChannelSection"
},
"httpMethod": "PUT",
"parameterOrder": [
"part"
],
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"request": {
"$ref": "ChannelSection"
},
"flatPath": "youtube/v3/channelSections",
"parameters": {
"onBehalfOfContentOwner": {
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner.",
"type": "string",
"location": "query"
},
"part": {
"type": "string",
"location": "query",
"repeated": true,
"required": true,
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter serves two purposes in\nthis operation. It identifies the properties that the write operation will\nset as well as the properties that the API response will\ninclude.\u003cbr/\u003e\u003cbr/\u003eThe \u003ccode\u003epart\u003c/code\u003e names that you can include in the\nparameter value are \u003ccode\u003esnippet\u003c/code\u003e and \u003ccode\u003econtentDetails\u003c/code\u003e."
}
},
"path": "youtube/v3/channelSections",
"description": "Updates an existing resource."
},
"insert": {
"response": {
"$ref": "ChannelSection"
},
"flatPath": "youtube/v3/channelSections",
"httpMethod": "POST",
"description": "Inserts a new resource into this collection.",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"id": "youtube.channelSections.insert",
"request": {
"$ref": "ChannelSection"
},
"path": "youtube/v3/channelSections",
"parameters": {
"onBehalfOfContentOwnerChannel": {
"description": "This parameter can only be used in a properly \u003ca\nhref=\"/youtube/v3/guides/authentication\"\u003eauthorized request\u003c/a\u003e.\n\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwnerChannel\u003c/strong\u003e\u003c/code\u003e parameter\nspecifies the YouTube channel ID of the channel to which a video is being\nadded. This parameter is required when a request specifies a value for the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter, and it can only be used in\nconjunction with that parameter. In addition, the request must be\nauthorized using a CMS account that is linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies. Finally, the\nchannel that the \u003ccode\u003eonBehalfOfContentOwnerChannel\u003c/code\u003e parameter value\nspecifies must be linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies.\u003cbr\u003e\u003cbr\u003eThis\nparameter is intended for YouTube content partners that own and manage many\ndifferent YouTube channels. It allows content owners to authenticate once\nand perform actions on behalf of the channel specified in the parameter\nvalue, without having to provide authentication credentials for each\nseparate channel.",
"type": "string",
"location": "query"
},
"onBehalfOfContentOwner": {
"type": "string",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner.",
"location": "query"
},
"part": {
"required": true,
"repeated": true,
"type": "string",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter serves two purposes in\nthis operation. It identifies the properties that the write operation will\nset as well as the properties that the API response will\ninclude.\u003cbr/\u003e\u003cbr/\u003eThe \u003ccode\u003epart\u003c/code\u003e names that you can include in the\nparameter value are \u003ccode\u003esnippet\u003c/code\u003e and \u003ccode\u003econtentDetails\u003c/code\u003e.",
"location": "query"
}
},
"parameterOrder": [
"part"
]
}
}
},
"i18nLanguages": {
"methods": {
"list": {
"id": "youtube.i18nLanguages.list",
"description": "Retrieves a list of resources, possibly filtered.",
"response": {
"$ref": "I18nLanguageListResponse"
},
"parameterOrder": [
"part"
],
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner"
],
"httpMethod": "GET",
"path": "youtube/v3/i18nLanguages",
"parameters": {
"part": {
"repeated": true,
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies the\n\u003ccode\u003ei18nLanguage\u003c/code\u003e resource properties that the API response will\ninclude. Set the parameter value to \u003ccode\u003esnippet\u003c/code\u003e.",
"required": true,
"type": "string",
"location": "query"
},
"hl": {
"type": "string",
"default": "en_US",
"location": "query"
}
},
"flatPath": "youtube/v3/i18nLanguages"
}
}
},
"membershipsLevels": {
"methods": {
"list": {
"response": {
"$ref": "MembershipsLevelListResponse"
},
"httpMethod": "GET",
"id": "youtube.membershipsLevels.list",
"flatPath": "youtube/v3/membershipsLevels",
"parameters": {
"part": {
"required": true,
"type": "string",
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies the\n\u003ccode\u003emembershipsLevel\u003c/code\u003e resource parts that the API response will\ninclude. Supported values are \u003ccode\u003eid\u003c/code\u003e and \u003ccode\u003esnippet\u003c/code\u003e.",
"repeated": true
}
},
"path": "youtube/v3/membershipsLevels",
"description": "Retrieves a list of all pricing levels offered by a creator to the fans.",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.channel-memberships.creator",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner"
],
"parameterOrder": [
"part"
]
}
}
},
"videos": {
"methods": {
"insert": {
"path": "youtube/v3/videos",
"parameters": {
"autoLevels": {
"location": "query",
"description": "Should auto-levels be applied to the upload.",
"type": "boolean"
},
"notifySubscribers": {
"type": "boolean",
"default": "true",
"location": "query",
"description": "Notify the channel subscribers about the new video. As default, the\nnotification is enabled."
},
"onBehalfOfContentOwnerChannel": {
"type": "string",
"location": "query",
"description": "This parameter can only be used in a properly \u003ca\nhref=\"/youtube/v3/guides/authentication\"\u003eauthorized request\u003c/a\u003e.\n\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwnerChannel\u003c/strong\u003e\u003c/code\u003e parameter\nspecifies the YouTube channel ID of the channel to which a video is being\nadded. This parameter is required when a request specifies a value for the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter, and it can only be used in\nconjunction with that parameter. In addition, the request must be\nauthorized using a CMS account that is linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies. Finally, the\nchannel that the \u003ccode\u003eonBehalfOfContentOwnerChannel\u003c/code\u003e parameter value\nspecifies must be linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies.\u003cbr\u003e\u003cbr\u003eThis\nparameter is intended for YouTube content partners that own and manage many\ndifferent YouTube channels. It allows content owners to authenticate once\nand perform actions on behalf of the channel specified in the parameter\nvalue, without having to provide authentication credentials for each\nseparate channel."
},
"part": {
"repeated": true,
"location": "query",
"required": true,
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter serves two purposes in\nthis operation. It identifies the properties that the write operation will\nset as well as the properties that the API response will\ninclude.\u003cbr/\u003e\u003cbr/\u003eNote that not all parts contain properties that can be\nset when inserting or updating a video. For example, the\n\u003ccode\u003estatistics\u003c/code\u003e object encapsulates statistics that YouTube\ncalculates for a video and does not contain values that you can set or\nmodify. If the parameter value specifies a \u003ccode\u003epart\u003c/code\u003e that does not\ncontain mutable values, that \u003ccode\u003epart\u003c/code\u003e will still be included in\nthe API response.",
"type": "string"
},
"onBehalfOfContentOwner": {
"type": "string",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner.",
"location": "query"
},
"stabilize": {
"type": "boolean",
"location": "query",
"description": "Should stabilize be applied to the upload."
}
},
"response": {
"$ref": "Video"
},
"mediaUpload": {
"accept": [
"video/*",
"application/octet-stream"
],
"maxSize": "137438953472",
"protocols": {
"simple": {
"path": "/upload/youtube/v3/videos",
"multipart": true
}
}
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.upload",
"https://www.googleapis.com/auth/youtubepartner"
],
"description": "Inserts a new resource into this collection.",
"supportsMediaUpload": true,
"parameterOrder": [
"part"
],
"id": "youtube.videos.insert",
"flatPath": "youtube/v3/videos",
"request": {
"$ref": "Video"
},
"httpMethod": "POST"
},
"rate": {
"id": "youtube.videos.rate",
"description": "Adds a like or dislike rating to a video or removes a rating from a video.",
"parameters": {
"id": {
"required": true,
"location": "query",
"type": "string"
},
"rating": {
"type": "string",
"enum": [
"none",
"like",
"dislike"
],
"location": "query",
"required": true
}
},
"httpMethod": "POST",
"path": "youtube/v3/videos/rate",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"parameterOrder": [
"id",
"rating"
],
"flatPath": "youtube/v3/videos/rate"
},
"reportAbuse": {
"parameterOrder": [],
"path": "youtube/v3/videos/reportAbuse",
"parameters": {
"onBehalfOfContentOwner": {
"type": "string",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner.",
"location": "query"
}
},
"request": {
"$ref": "VideoAbuseReport"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"flatPath": "youtube/v3/videos/reportAbuse",
"httpMethod": "POST",
"description": "Report abuse for a video.",
"id": "youtube.videos.reportAbuse"
},
"list": {
"parameterOrder": [
"part"
],
"parameters": {
"maxResults": {
"location": "query",
"default": "5",
"description": "The \u003ccode\u003e\u003cstrong\u003emaxResults\u003c/strong\u003e\u003c/code\u003e parameter specifies the\nmaximum number of items that should be returned in the result\nset.\u003cbr\u003e\u003cbr\u003e\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is supported for use in\nconjunction with the \u003ccode\u003e\u003ca href=\"#myRating\"\u003emyRating\u003c/a\u003e\u003c/code\u003e and\n\u003ccode\u003e\u003ca href=\"#chart\"\u003echart\u003c/a\u003e\u003c/code\u003e parameters, but it is not supported\nfor use in conjunction with the \u003ccode\u003e\u003ca href=\"#id\"\u003eid\u003c/a\u003e\u003c/code\u003e\nparameter.",
"format": "uint32",
"type": "integer"
},
"videoCategoryId": {
"type": "string",
"location": "query",
"default": "0",
"description": "Use chart that is specific to the specified video category"
},
"id": {
"location": "query",
"type": "string",
"repeated": true,
"description": "Return videos with the given ids."
},
"locale": {
"location": "query",
"type": "string"
},
"regionCode": {
"location": "query",
"type": "string",
"description": "Use a chart that is specific to the specified region"
},
"chart": {
"enum": [
"chartUnspecified",
"mostPopular"
],
"type": "string",
"location": "query",
"description": "Return the videos that are in the specified chart."
},
"hl": {
"type": "string",
"location": "query",
"description": "Stands for \"host language\". Specifies the localization language of the\nmetadata to be filled into snippet.localized. The field is filled with the\ndefault metadata if there is no localization in the specified language.\nThe parameter value must be a language code included in the list returned\nby the i18nLanguages.list method (e.g. en_US, es_MX)."
},
"part": {
"repeated": true,
"type": "string",
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies a\ncomma-separated list of one or more \u003ccode\u003evideo\u003c/code\u003e resource properties\nthat the API response will include.\u003cbr\u003e\u003cbr\u003eIf the parameter identifies a\nproperty that contains child properties, the child properties will be\nincluded in the response. For example, in a \u003ccode\u003evideo\u003c/code\u003e resource,\nthe \u003ccode\u003esnippet\u003c/code\u003e property contains the \u003ccode\u003echannelId\u003c/code\u003e,\n\u003ccode\u003etitle\u003c/code\u003e, \u003ccode\u003edescription\u003c/code\u003e, \u003ccode\u003etags\u003c/code\u003e, and\n\u003ccode\u003ecategoryId\u003c/code\u003e properties. As such, if you set\n\u003ccode\u003e\u003cstrong\u003epart=snippet\u003c/strong\u003e\u003c/code\u003e, the API response will contain\nall of those properties.",
"required": true
},
"maxHeight": {
"type": "integer",
"location": "query",
"format": "int32"
},
"pageToken": {
"type": "string",
"description": "The \u003ccode\u003e\u003cstrong\u003epageToken\u003c/strong\u003e\u003c/code\u003e parameter identifies a specific\npage in the result set that should be returned. In an API response, the\n\u003ccode\u003enextPageToken\u003c/code\u003e and \u003ccode\u003eprevPageToken\u003c/code\u003e properties\nidentify other pages that could be retrieved.\u003cbr\u003e\u003cbr\u003e\u003cstrong\u003eNote:\u003c/strong\u003e\nThis parameter is supported for use in conjunction with the \u003ccode\u003e\u003ca\nhref=\"#myRating\"\u003emyRating\u003c/a\u003e\u003c/code\u003e and \u003ccode\u003e\u003ca\nhref=\"#chart\"\u003echart\u003c/a\u003e\u003c/code\u003e parameters, but it is not supported for use\nin conjunction with the \u003ccode\u003e\u003ca href=\"#id\"\u003eid\u003c/a\u003e\u003c/code\u003e parameter.",
"location": "query"
},
"maxWidth": {
"format": "int32",
"description": "Return the player with maximum height specified in",
"location": "query",
"type": "integer"
},
"myRating": {
"location": "query",
"description": "Return videos liked/disliked by the authenticated user.\nDoes not support RateType.RATED_TYPE_NONE.",
"enum": [
"none",
"like",
"dislike"
],
"type": "string"
},
"onBehalfOfContentOwner": {
"type": "string",
"location": "query",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner."
}
},
"httpMethod": "GET",
"flatPath": "youtube/v3/videos",
"description": "Retrieves a list of resources, possibly filtered.",
"path": "youtube/v3/videos",
"id": "youtube.videos.list",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner"
],
"response": {
"$ref": "VideoListResponse"
}
},
"delete": {
"description": "Deletes a resource.",
"id": "youtube.videos.delete",
"parameters": {
"onBehalfOfContentOwner": {
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The actual\nCMS account that the user authenticates with must be linked to the\nspecified YouTube content owner.",
"type": "string",
"location": "query"
},
"id": {
"required": true,
"location": "query",
"type": "string"
}
},
"httpMethod": "DELETE",
"flatPath": "youtube/v3/videos",
"path": "youtube/v3/videos",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"parameterOrder": [
"id"
]
},
"getRating": {
"parameters": {
"onBehalfOfContentOwner": {
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner.",
"location": "query",
"type": "string"
},
"id": {
"required": true,
"location": "query",
"type": "string",
"repeated": true
}
},
"path": "youtube/v3/videos/getRating",
"id": "youtube.videos.getRating",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"description": "Retrieves the ratings that the authorized user gave to a list of specified\nvideos.",
"response": {
"$ref": "VideoRatingListResponse"
},
"flatPath": "youtube/v3/videos/getRating",
"httpMethod": "GET",
"parameterOrder": [
"id"
]
},
"update": {
"id": "youtube.videos.update",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"parameterOrder": [
"part"
],
"parameters": {
"onBehalfOfContentOwner": {
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The actual\nCMS account that the user authenticates with must be linked to the\nspecified YouTube content owner.",
"type": "string",
"location": "query"
},
"part": {
"required": true,
"repeated": true,
"type": "string",
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter serves two purposes in\nthis operation. It identifies the properties that the write operation will\nset as well as the properties that the API response will\ninclude.\u003cbr/\u003e\u003cbr/\u003eNote that this method will override the existing values\nfor all of the mutable properties that are contained in any parts that the\nparameter value specifies. For example, a\nvideo's privacy setting is contained in the \u003ccode\u003estatus\u003c/code\u003e part. As\nsuch, if your request is updating a private video, and the request's\n\u003ccode\u003epart\u003c/code\u003e parameter value includes the \u003ccode\u003estatus\u003c/code\u003e part,\nthe\nvideo's privacy setting will be updated to whatever value the request body\nspecifies. If the request body does not specify a value, the existing\nprivacy setting will be removed and the video will revert to the default\nprivacy setting.\u003cbr/\u003e\u003cbr/\u003eIn addition, not all parts contain properties\nthat can be set when inserting or updating a video. For example, the\n\u003ccode\u003estatistics\u003c/code\u003e object encapsulates statistics that YouTube\ncalculates for a video and does not contain values that you can set or\nmodify. If the parameter value specifies a \u003ccode\u003epart\u003c/code\u003e that does not\ncontain mutable values, that \u003ccode\u003epart\u003c/code\u003e will still be included in\nthe API response."
}
},
"httpMethod": "PUT",
"response": {
"$ref": "Video"
},
"path": "youtube/v3/videos",
"flatPath": "youtube/v3/videos",
"request": {
"$ref": "Video"
},
"description": "Updates an existing resource."
}
}
},
"liveStreams": {
"methods": {
"list": {
"description": "Retrieve the list of streams associated with the given channel. --",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly"
],
"httpMethod": "GET",
"id": "youtube.liveStreams.list",
"flatPath": "youtube/v3/liveStreams",
"parameters": {
"onBehalfOfContentOwner": {
"type": "string",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner.",
"location": "query"
},
"onBehalfOfContentOwnerChannel": {
"description": "This parameter can only be used in a properly \u003ca\nhref=\"/youtube/v3/guides/authentication\"\u003eauthorized request\u003c/a\u003e.\n\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwnerChannel\u003c/strong\u003e\u003c/code\u003e parameter\nspecifies the YouTube channel ID of the channel to which a video is being\nadded. This parameter is required when a request specifies a value for the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter, and it can only be used in\nconjunction with that parameter. In addition, the request must be\nauthorized using a CMS account that is linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies. Finally, the\nchannel that the \u003ccode\u003eonBehalfOfContentOwnerChannel\u003c/code\u003e parameter value\nspecifies must be linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies.\u003cbr\u003e\u003cbr\u003eThis\nparameter is intended for YouTube content partners that own and manage many\ndifferent YouTube channels. It allows content owners to authenticate once\nand perform actions on behalf of the channel specified in the parameter\nvalue, without having to provide authentication credentials for each\nseparate channel.",
"location": "query",
"type": "string"
},
"maxResults": {
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003emaxResults\u003c/strong\u003e\u003c/code\u003e parameter specifies the\nmaximum number of items that should be returned in the result set.",
"format": "uint32",
"type": "integer",
"default": "5"
},
"part": {
"location": "query",
"required": true,
"type": "string",
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies a\ncomma-separated list of one or more \u003ccode\u003eliveStream\u003c/code\u003e resource\nproperties that the API response will include. The \u003ccode\u003epart\u003c/code\u003e names\nthat you can include in the parameter value are \u003ccode\u003eid\u003c/code\u003e,\n\u003ccode\u003esnippet\u003c/code\u003e, \u003ccode\u003ecdn\u003c/code\u003e, and \u003ccode\u003estatus\u003c/code\u003e.",
"repeated": true
},
"mine": {
"type": "boolean",
"location": "query"
},
"id": {
"location": "query",
"repeated": true,
"description": "Return LiveStreams with the given ids from Stubby or Apiary.",
"type": "string"
},
"pageToken": {
"type": "string",
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003epageToken\u003c/strong\u003e\u003c/code\u003e parameter identifies a specific\npage in the result set that should be returned. In an API response, the\n\u003ccode\u003enextPageToken\u003c/code\u003e and \u003ccode\u003eprevPageToken\u003c/code\u003e properties\nidentify other pages that could be retrieved."
}
},
"parameterOrder": [
"part"
],
"path": "youtube/v3/liveStreams",
"response": {
"$ref": "LiveStreamListResponse"
}
},
"delete": {
"description": "Deletes an existing stream for the authenticated user.",
"id": "youtube.liveStreams.delete",
"httpMethod": "DELETE",
"parameterOrder": [
"id"
],
"flatPath": "youtube/v3/liveStreams",
"path": "youtube/v3/liveStreams",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"parameters": {
"onBehalfOfContentOwnerChannel": {
"description": "This parameter can only be used in a properly \u003ca\nhref=\"/youtube/v3/guides/authentication\"\u003eauthorized request\u003c/a\u003e.\n\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwnerChannel\u003c/strong\u003e\u003c/code\u003e parameter\nspecifies the YouTube channel ID of the channel to which a video is being\nadded. This parameter is required when a request specifies a value for the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter, and it can only be used in\nconjunction with that parameter. In addition, the request must be\nauthorized using a CMS account that is linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies. Finally, the\nchannel that the \u003ccode\u003eonBehalfOfContentOwnerChannel\u003c/code\u003e parameter value\nspecifies must be linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies.\u003cbr\u003e\u003cbr\u003eThis\nparameter is intended for YouTube content partners that own and manage many\ndifferent YouTube channels. It allows content owners to authenticate once\nand perform actions on behalf of the channel specified in the parameter\nvalue, without having to provide authentication credentials for each\nseparate channel.",
"location": "query",
"type": "string"
},
"onBehalfOfContentOwner": {
"type": "string",
"location": "query",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner."
},
"id": {
"required": true,
"location": "query",
"type": "string"
}
}
},
"update": {
"id": "youtube.liveStreams.update",
"request": {
"$ref": "LiveStream"
},
"parameters": {
"part": {
"type": "string",
"repeated": true,
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter serves two purposes in\nthis operation. It identifies the properties that the write operation will\nset as well as the properties that the API response will\ninclude.\u003cbr\u003e\u003cbr\u003eThe \u003ccode\u003epart\u003c/code\u003e properties that you can include in\nthe parameter value are \u003ccode\u003eid\u003c/code\u003e, \u003ccode\u003esnippet\u003c/code\u003e,\n\u003ccode\u003ecdn\u003c/code\u003e, and \u003ccode\u003estatus\u003c/code\u003e.\u003cbr\u003e\u003cbr\u003eNote that this method\nwill override the existing values for all of the mutable properties that\nare contained in any parts that the parameter value specifies. If the\nrequest body does not specify a value for a mutable property, the existing\nvalue for that property will be removed.",
"required": true,
"location": "query"
},
"onBehalfOfContentOwnerChannel": {
"location": "query",
"description": "This parameter can only be used in a properly \u003ca\nhref=\"/youtube/v3/guides/authentication\"\u003eauthorized request\u003c/a\u003e.\n\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwnerChannel\u003c/strong\u003e\u003c/code\u003e parameter\nspecifies the YouTube channel ID of the channel to which a video is being\nadded. This parameter is required when a request specifies a value for the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter, and it can only be used in\nconjunction with that parameter. In addition, the request must be\nauthorized using a CMS account that is linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies. Finally, the\nchannel that the \u003ccode\u003eonBehalfOfContentOwnerChannel\u003c/code\u003e parameter value\nspecifies must be linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies.\u003cbr\u003e\u003cbr\u003eThis\nparameter is intended for YouTube content partners that own and manage many\ndifferent YouTube channels. It allows content owners to authenticate once\nand perform actions on behalf of the channel specified in the parameter\nvalue, without having to provide authentication credentials for each\nseparate channel.",
"type": "string"
},
"onBehalfOfContentOwner": {
"type": "string",
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner.",
"location": "query"
}
},
"response": {
"$ref": "LiveStream"
},
"parameterOrder": [
"part"
],
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"path": "youtube/v3/liveStreams",
"description": "Updates an existing stream for the authenticated user.",
"flatPath": "youtube/v3/liveStreams",
"httpMethod": "PUT"
},
"insert": {
"request": {
"$ref": "LiveStream"
},
"parameterOrder": [
"part"
],
"response": {
"$ref": "LiveStream"
},
"path": "youtube/v3/liveStreams",
"id": "youtube.liveStreams.insert",
"description": "Inserts a new stream for the authenticated user.",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl"
],
"parameters": {
"part": {
"repeated": true,
"required": true,
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter serves two purposes in\nthis operation. It identifies the properties that the write operation will\nset as well as the properties that the API response will\ninclude.\u003cbr\u003e\u003cbr\u003eThe \u003ccode\u003epart\u003c/code\u003e properties that you can include in\nthe parameter value are \u003ccode\u003eid\u003c/code\u003e, \u003ccode\u003esnippet\u003c/code\u003e,\n\u003ccode\u003ecdn\u003c/code\u003e, and \u003ccode\u003estatus\u003c/code\u003e.",
"location": "query",
"type": "string"
},
"onBehalfOfContentOwnerChannel": {
"type": "string",
"location": "query",
"description": "This parameter can only be used in a properly \u003ca\nhref=\"/youtube/v3/guides/authentication\"\u003eauthorized request\u003c/a\u003e.\n\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwnerChannel\u003c/strong\u003e\u003c/code\u003e parameter\nspecifies the YouTube channel ID of the channel to which a video is being\nadded. This parameter is required when a request specifies a value for the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter, and it can only be used in\nconjunction with that parameter. In addition, the request must be\nauthorized using a CMS account that is linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies. Finally, the\nchannel that the \u003ccode\u003eonBehalfOfContentOwnerChannel\u003c/code\u003e parameter value\nspecifies must be linked to the content owner that the\n\u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter specifies.\u003cbr\u003e\u003cbr\u003eThis\nparameter is intended for YouTube content partners that own and manage many\ndifferent YouTube channels. It allows content owners to authenticate once\nand perform actions on behalf of the channel specified in the parameter\nvalue, without having to provide authentication credentials for each\nseparate channel."
},
"onBehalfOfContentOwner": {
"description": "\u003cstrong\u003eNote:\u003c/strong\u003e This parameter is intended exclusively for YouTube\ncontent partners.\u003cbr\u003e\u003cbr\u003eThe\n\u003ccode\u003e\u003cstrong\u003eonBehalfOfContentOwner\u003c/strong\u003e\u003c/code\u003e parameter indicates\nthat the\nrequest's authorization credentials identify a YouTube CMS user who is\nacting on behalf of the content owner specified in the parameter value.\nThis parameter is intended for YouTube content partners that own and manage\nmany different YouTube channels. It allows content owners to authenticate\nonce and get access to all their video and channel data, without having to\nprovide authentication credentials for each individual channel. The CMS\naccount that the user authenticates with must be linked to the specified\nYouTube content owner.",
"location": "query",
"type": "string"
}
},
"flatPath": "youtube/v3/liveStreams",
"httpMethod": "POST"
}
}
},
"sponsors": {
"methods": {
"list": {
"path": "youtube/v3/sponsors",
"description": "Retrieves a list of sponsors that match the request criteria for a\nchannel.",
"id": "youtube.sponsors.list",
"parameterOrder": [
"part"
],
"response": {
"$ref": "SponsorListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly"
],
"flatPath": "youtube/v3/sponsors",
"parameters": {
"filter": {
"default": "newest",
"type": "string",
"location": "query",
"enum": [
"sponsorFilterUnknown",
"newest",
"all"
],
"description": "Parameter that specifies which channel sponsors to return."
},
"maxResults": {
"format": "uint32",
"description": "The \u003ccode\u003e\u003cstrong\u003emaxResults\u003c/strong\u003e\u003c/code\u003e parameter specifies the\nmaximum number of items that should be returned in the result set.",
"type": "integer",
"location": "query",
"default": "5"
},
"pageToken": {
"type": "string",
"location": "query",
"description": "The \u003ccode\u003e\u003cstrong\u003epageToken\u003c/strong\u003e\u003c/code\u003e parameter identifies a specific\npage in the result set that should be returned. In an API response, the\n\u003ccode\u003enextPageToken\u003c/code\u003e and \u003ccode\u003eprevPageToken\u003c/code\u003e properties\nidentify other pages that could be retrieved."
},
"part": {
"required": true,
"type": "string",
"location": "query",
"repeated": true,
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies the\n\u003ccode\u003esponsor\u003c/code\u003e resource parts that the API response will include.\nSupported values are \u003ccode\u003eid\u003c/code\u003e and \u003ccode\u003esnippet\u003c/code\u003e."
}
},
"httpMethod": "GET"
}
}
},
"videoAbuseReportReasons": {
"methods": {
"list": {
"path": "youtube/v3/videoAbuseReportReasons",
"parameterOrder": [
"part"
],
"httpMethod": "GET",
"id": "youtube.videoAbuseReportReasons.list",
"response": {
"$ref": "VideoAbuseReportReasonListResponse"
},
"parameters": {
"hl": {
"location": "query",
"default": "en_US",
"type": "string"
},
"part": {
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies the\n\u003ccode\u003evideoCategory\u003c/code\u003e resource parts that the API response will\ninclude. Supported values are \u003ccode\u003eid\u003c/code\u003e and \u003ccode\u003esnippet\u003c/code\u003e.",
"type": "string",
"required": true,
"location": "query",
"repeated": true
}
},
"description": "Retrieves a list of resources, possibly filtered.",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly"
],
"flatPath": "youtube/v3/videoAbuseReportReasons"
}
}
},
"members": {
"methods": {
"list": {
"flatPath": "youtube/v3/members",
"parameterOrder": [
"part"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.channel-memberships.creator",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner"
],
"description": "Retrieves a list of members that match the request criteria for a channel.",
"parameters": {
"maxResults": {
"format": "uint32",
"default": "5",
"location": "query",
"type": "integer",
"description": "The \u003ccode\u003e\u003cstrong\u003emaxResults\u003c/strong\u003e\u003c/code\u003e parameter specifies the\nmaximum number of items that should be returned in the result set."
},
"hasAccessToLevel": {
"location": "query",
"type": "string",
"description": "Filter members in the results set to the ones that have access to a level."
},
"filterByMemberChannelId": {
"description": "Comma separated list of channel IDs. Only data about members that are part\nof this list will be included in the response.",
"location": "query",
"type": "string"
},
"mode": {
"location": "query",
"description": "Parameter that specifies which channel members to return.",
"type": "string",
"enum": [
"listMembersModeUnknown",
"updates",
"all_current"
],
"default": "all_current"
},
"part": {
"type": "string",
"location": "query",
"required": true,
"repeated": true,
"description": "The \u003ccode\u003e\u003cstrong\u003epart\u003c/strong\u003e\u003c/code\u003e parameter specifies the\n\u003ccode\u003emember\u003c/code\u003e resource parts that the API response will include. Set\nthe parameter value to \u003ccode\u003esnippet\u003c/code\u003e."
},
"pageToken": {
"type": "string",
"description": "The \u003ccode\u003e\u003cstrong\u003epageToken\u003c/strong\u003e\u003c/code\u003e parameter identifies a specific\npage in the result set that should be returned. In an API response, the\n\u003ccode\u003enextPageToken\u003c/code\u003e and \u003ccode\u003eprevPageToken\u003c/code\u003e properties\nidentify other pages that could be retrieved.",
"location": "query"
}
},
"response": {
"$ref": "MemberListResponse"
},
"id": "youtube.members.list",
"path": "youtube/v3/members"
}
}
}
},
"canonicalName": "YouTube",
"parameters": {
"quotaUser": {
"type": "string",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query"
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response.",
"location": "query"
},
"uploadType": {
"location": "query",
"type": "string",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean"
},
"callback": {
"location": "query",
"description": "JSONP",
"type": "string"
},
"alt": {
"enum": [
"json",
"media",
"proto"
],
"location": "query",
"description": "Data format for response.",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"default": "json",
"type": "string"
},
"oauth_token": {
"type": "string",
"location": "query",
"description": "OAuth 2.0 token for the current user."
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"$.xgafv": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"type": "string",
"location": "query"
},
"upload_protocol": {
"type": "string",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query"
}
},
"protocol": "rest",
"documentationLink": "https://developers.google.com/youtube/",
"batchPath": "batch/youtube",
"title": "YouTube Data API v3",
"id": "youtube:v3",
"version": "v3",
"discoveryVersion": "v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://www.mtls.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/youtube.channel-memberships.creator": {
"description": "See a list of your current active channel members, their current level, and when they became a member"
},
"https://www.googleapis.com/auth/youtube.readonly": {
"description": "View your YouTube account"
},
"https://www.googleapis.com/auth/youtubepartner-channel-audit": {
"description": "View private information of your YouTube channel relevant during the audit process with a YouTube partner"
},
"https://www.googleapis.com/auth/youtube.force-ssl": {
"description": "See, edit, and permanently delete your YouTube videos, ratings, comments and captions"
},
"https://www.googleapis.com/auth/youtube.upload": {
"description": "Manage your YouTube videos"
},
"https://www.googleapis.com/auth/youtube": {
"description": "Manage your YouTube account"
},
"https://www.googleapis.com/auth/youtubepartner": {
"description": "View and manage your assets and associated content on YouTube"
}
}
}
},
"basePath": "",
"schemas": {
"VideoFileDetailsAudioStream": {
"id": "VideoFileDetailsAudioStream",
"description": "Information about an audio stream.",
"properties": {
"vendor": {
"description": "A value that uniquely identifies a video vendor. Typically, the value\nis a four-letter vendor code.",
"type": "string"
},
"codec": {
"description": "The audio codec that the stream uses.",
"type": "string"
},
"channelCount": {
"type": "integer",
"description": "The number of audio channels that the stream contains.",
"format": "uint32"
},
"bitrateBps": {
"description": "The audio stream's bitrate, in bits per second.",
"type": "string",
"format": "uint64"
}
},
"type": "object"
},
"LiveChatModeratorListResponse": {
"properties": {
"tokenPagination": {
"$ref": "TokenPagination"
},
"etag": {
"type": "string",
"description": "Etag of this resource."
},
"pageInfo": {
"description": "General pagination information.",
"$ref": "PageInfo"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#liveChatModeratorListResponse\"\u003c/code\u003e.",
"type": "string",
"default": "youtube#liveChatModeratorListResponse"
},
"items": {
"description": "A list of moderators that match the request criteria.",
"type": "array",
"items": {
"$ref": "LiveChatModerator"
}
},
"nextPageToken": {
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the next page in the result set.",
"type": "string"
},
"eventId": {
"description": "Serialized EventId of the request which produced this response.",
"type": "string"
},
"visitorId": {
"type": "string",
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor."
},
"prevPageToken": {
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the previous page in the result set.",
"type": "string"
}
},
"id": "LiveChatModeratorListResponse",
"type": "object"
},
"PageInfo": {
"type": "object",
"id": "PageInfo",
"properties": {
"totalResults": {
"format": "int32",
"type": "integer",
"description": "The total number of results in the result set."
},
"resultsPerPage": {
"format": "int32",
"type": "integer",
"description": "The number of results included in the API response."
}
},
"description": "Paging details for lists of resources, including total number of items\navailable and number of resources returned in a single page."
},
"ActivityContentDetailsComment": {
"id": "ActivityContentDetailsComment",
"description": "Information about a resource that received a comment.",
"properties": {
"resourceId": {
"description": "The \u003ccode\u003eresourceId\u003c/code\u003e object contains information that\nidentifies the resource associated with the comment.",
"$ref": "ResourceId"
}
},
"type": "object"
},
"PlaylistItemListResponse": {
"type": "object",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#playlistItemListResponse\"\u003c/code\u003e.\nEtag of this resource.",
"default": "youtube#playlistItemListResponse",
"type": "string"
},
"etag": {
"type": "string"
},
"eventId": {
"description": "Serialized EventId of the request which produced this response.",
"type": "string"
},
"pageInfo": {
"description": "General pagination information.",
"$ref": "PageInfo"
},
"items": {
"description": "A list of playlist items that match the request criteria.",
"type": "array",
"items": {
"$ref": "PlaylistItem"
}
},
"visitorId": {
"type": "string",
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor."
},
"tokenPagination": {
"$ref": "TokenPagination"
},
"prevPageToken": {
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the previous page in the result set.",
"type": "string"
},
"nextPageToken": {
"type": "string",
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the next page in the result set."
}
},
"id": "PlaylistItemListResponse"
},
"I18nLanguageSnippet": {
"id": "I18nLanguageSnippet",
"description": "Basic details about an i18n language, such as language code and\nhuman-readable name.",
"type": "object",
"properties": {
"name": {
"description": "The human-readable name of the language in the language itself.",
"type": "string"
},
"hl": {
"description": "A short BCP-47 code that uniquely identifies a language.",
"type": "string"
}
}
},
"VideoMonetizationDetails": {
"properties": {
"access": {
"description": "The value of \u003ccode\u003eaccess\u003c/code\u003e indicates whether the video can be\nmonetized or not.",
"$ref": "AccessPolicy"
}
},
"type": "object",
"id": "VideoMonetizationDetails",
"description": "Details about monetization of a YouTube Video."
},
"Thumbnail": {
"properties": {
"width": {
"format": "uint32",
"description": "(Optional) Width of the thumbnail image.",
"type": "integer"
},
"url": {
"type": "string",
"description": "The thumbnail image's URL."
},
"height": {
"type": "integer",
"description": "(Optional) Height of the thumbnail image.",
"format": "uint32"
}
},
"type": "object",
"id": "Thumbnail",
"description": "A thumbnail is an image representing a YouTube resource."
},
"LiveBroadcastSnippet": {
"id": "LiveBroadcastSnippet",
"description": "Basic broadcast information.",
"type": "object",
"properties": {
"description": {
"description": "The broadcast's description. As with the \u003ccode\u003etitle\u003c/code\u003e, you can set\nthis field by modifying the broadcast resource or by setting the\n\u003ccode\u003e\u003ca\nhref=\"/youtube/v3/docs/videos#snippet.description\"\u003edescription\u003c/a\u003e\u003c/code\u003e\nfield of the corresponding video resource.",
"type": "string"
},
"actualEndTime": {
"type": "string",
"description": "The date and time that the broadcast actually ended. This information is\nonly available once the broadcast's state is \u003ccode\u003ecomplete\u003c/code\u003e. The\nvalue is specified in \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat."
},
"liveChatId": {
"description": "The id of the live chat for this broadcast.",
"type": "string"
},
"publishedAt": {
"type": "string",
"description": "The date and time that the broadcast was added to YouTube's live broadcast\nschedule. The value is specified in\n\u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat."
},
"actualStartTime": {
"description": "The date and time that the broadcast actually started. This information is\nonly available once the broadcast's state is \u003ccode\u003elive\u003c/code\u003e. The\nvalue is specified in \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat.",
"type": "string"
},
"isDefaultBroadcast": {
"type": "boolean",
"description": "Indicates whether this broadcast is the default broadcast.\nInternal only."
},
"title": {
"description": "The broadcast's title. Note that the broadcast represents exactly one\nYouTube video. You can set this field by modifying the broadcast resource\nor by setting the\n\u003ccode\u003e\u003ca href=\"/youtube/v3/docs/videos#snippet.title\"\u003etitle\u003c/a\u003e\u003c/code\u003e\nfield of the corresponding video resource.",
"type": "string"
},
"scheduledEndTime": {
"description": "The date and time that the broadcast is scheduled to end. The value\nis specified in \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat.",
"type": "string"
},
"thumbnails": {
"description": "A map of thumbnail images associated with the broadcast. For each nested\nobject in this object, the key is the name of the thumbnail image, and\nthe value is an object that contains other information about the\nthumbnail.",
"$ref": "ThumbnailDetails"
},
"scheduledStartTime": {
"type": "string",
"description": "The date and time that the broadcast is scheduled to start. The value\nis specified in \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat."
},
"channelId": {
"description": "The ID that YouTube uses to uniquely identify the channel that\nis publishing the broadcast.",
"type": "string"
}
}
},
"SearchListResponse": {
"id": "SearchListResponse",
"type": "object",
"properties": {
"prevPageToken": {
"type": "string",
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the previous page in the result set."
},
"kind": {
"type": "string",
"default": "youtube#searchListResponse",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#searchListResponse\"\u003c/code\u003e."
},
"nextPageToken": {
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the next page in the result set.",
"type": "string"
},
"eventId": {
"type": "string",
"description": "Serialized EventId of the request which produced this response."
},
"regionCode": {
"type": "string"
},
"etag": {
"type": "string",
"description": "Etag of this resource."
},
"tokenPagination": {
"$ref": "TokenPagination"
},
"items": {
"type": "array",
"items": {
"$ref": "SearchResult"
},
"description": "Pagination information for token pagination."
},
"visitorId": {
"type": "string",
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor."
},
"pageInfo": {
"description": "General pagination information.",
"$ref": "PageInfo"
}
}
},
"ThirdPartyLinkStatus": {
"description": "The \u003ccode\u003ethird-party link status\u003c/code\u003e object contains information about\nthe status of the link.",
"type": "object",
"id": "ThirdPartyLinkStatus",
"properties": {
"linkStatus": {
"enum": [
"unknown",
"failed",
"pending",
"linked"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
}
}
},
"I18nRegionListResponse": {
"properties": {
"kind": {
"default": "youtube#i18nRegionListResponse",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#i18nRegionListResponse\"\u003c/code\u003e.",
"type": "string"
},
"items": {
"type": "array",
"description": "A list of regions where YouTube is available. In this map, the i18n region\nID is the map key, and its value is the corresponding\n\u003ccode\u003ei18nRegion\u003c/code\u003e resource.",
"items": {
"$ref": "I18nRegion"
}
},
"visitorId": {
"type": "string",
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor."
},
"eventId": {
"type": "string",
"description": "Serialized EventId of the request which produced this response."
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
}
},
"type": "object",
"id": "I18nRegionListResponse"
},
"ChannelContentDetails": {
"type": "object",
"description": "Details about the content of a channel.",
"id": "ChannelContentDetails",
"properties": {
"relatedPlaylists": {
"type": "object",
"properties": {
"likes": {
"description": "The ID of the playlist that contains the channel\"s liked videos. Use the\n\u003ccode\u003e \u003ca href=\"/youtube/v3/docs/playlistItems/insert\"\u003e\nplaylistItems.insert\u003c/a\u003e\u003c/code\u003e and \u003ccode\u003e \u003ca\nhref=\"/youtube/v3/docs/playlistItems/delete\"\u003eplaylistItems.delete\u003c/a\u003e\u003c/code\u003e\nto add or remove items from that list.",
"type": "string"
},
"watchHistory": {
"description": "The ID of the playlist that contains the channel\"s watch history. Use the\n\u003ccode\u003e \u003ca\nhref=\"/youtube/v3/docs/playlistItems/insert\"\u003eplaylistItems.insert\u003c/a\u003e\u003c/code\u003e\nand \u003ccode\u003e \u003ca\nhref=\"/youtube/v3/docs/playlistItems/delete\"\u003eplaylistItems.delete\u003c/a\u003e\u003c/code\u003e\nto add or remove items from that list.",
"type": "string"
},
"uploads": {
"description": "The ID of the playlist that contains the channel\"s uploaded videos. Use\nthe \u003ccode\u003e \u003ca\nhref=\"/youtube/v3/docs/videos/insert\"\u003evideos.insert\u003c/a\u003e\u003c/code\u003e method to\nupload new videos and the \u003ccode\u003e\u003ca\nhref=\"/youtube/v3/docs/videos/delete\"\u003evideos.delete\u003c/a\u003e\u003c/code\u003e method to\ndelete previously uploaded videos.",
"type": "string"
},
"favorites": {
"description": "The ID of the playlist that contains the channel\"s favorite videos. Use\nthe \u003ccode\u003e \u003ca\nhref=\"/youtube/v3/docs/playlistItems/insert\"\u003eplaylistItems.insert\u003c/a\u003e\u003c/code\u003e\nand \u003ccode\u003e \u003ca\nhref=\"/youtube/v3/docs/playlistItems/delete\"\u003eplaylistItems.delete\u003c/a\u003e\u003c/code\u003e\nto add or remove items from that list.",
"type": "string"
},
"watchLater": {
"description": "The ID of the playlist that contains the channel\"s watch later playlist.\nUse the \u003ccode\u003e\u003ca\nhref=\"/youtube/v3/docs/playlistItems/insert\"\u003eplaylistItems.insert\u003c/a\u003e\u003c/code\u003e\nand \u003ccode\u003e \u003ca\nhref=\"/youtube/v3/docs/playlistItems/delete\"\u003eplaylistItems.delete\u003c/a\u003e\u003c/code\u003e\nto add or remove items from that list.",
"type": "string"
}
}
}
}
},
"ActivityContentDetailsSocial": {
"properties": {
"type": {
"enum": [
"typeUnspecified",
"googlePlus",
"facebook",
"twitter"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string",
"description": "The name of the social network."
},
"imageUrl": {
"type": "string",
"description": "An image of the post's author."
},
"resourceId": {
"$ref": "ResourceId",
"description": "The \u003ccode\u003eresourceId\u003c/code\u003e object encapsulates information that\nidentifies the resource associated with a social network post."
},
"referenceUrl": {
"type": "string",
"description": "The URL of the social network post."
},
"author": {
"description": "The author of the social network post.",
"type": "string"
}
},
"description": "Details about a social network post.",
"type": "object",
"id": "ActivityContentDetailsSocial"
},
"VideoStatistics": {
"description": "Statistics about the video, such as the number of times the video was viewed\nor liked.",
"type": "object",
"id": "VideoStatistics",
"properties": {
"favoriteCount": {
"format": "uint64",
"type": "string",
"description": "The number of users who currently have the video marked as a favorite\nvideo."
},
"likeCount": {
"format": "uint64",
"type": "string",
"description": "The number of users who have indicated that they liked the video by\ngiving it a positive rating."
},
"commentCount": {
"format": "uint64",
"description": "The number of comments for the video.",
"type": "string"
},
"dislikeCount": {
"description": "The number of users who have indicated that they disliked the video by\ngiving it a negative rating.",
"format": "uint64",
"type": "string"
},
"viewCount": {
"type": "string",
"description": "The number of times the video has been viewed.",
"format": "uint64"
}
}
},
"Video": {
"description": "A \u003ccode\u003e\u003cstrong\u003evideo\u003c/strong\u003e\u003c/code\u003e resource represents a YouTube video.",
"id": "Video",
"properties": {
"contentDetails": {
"description": "The \u003ccode\u003econtentDetails\u003c/code\u003e object contains information about the video\ncontent, including the length of the video and its aspect ratio.",
"$ref": "VideoContentDetails"
},
"player": {
"$ref": "VideoPlayer",
"description": "The \u003ccode\u003eplayer\u003c/code\u003e object contains information that you would use to\nplay the video in an embedded player."
},
"projectDetails": {
"$ref": "VideoProjectDetails",
"description": "The \u003ccode\u003eprojectDetails\u003c/code\u003e object contains information about the\nproject specific video metadata."
},
"kind": {
"type": "string",
"default": "youtube#video",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#video\"\u003c/code\u003e."
},
"id": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the video."
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"liveStreamingDetails": {
"description": "The \u003ccode\u003eliveStreamingDetails\u003c/code\u003e object contains metadata about a live\nvideo broadcast. The object will only be present in a \u003ccode\u003evideo\u003c/code\u003e\nresource if the video is an upcoming, live, or completed live broadcast.",
"$ref": "VideoLiveStreamingDetails"
},
"statistics": {
"$ref": "VideoStatistics",
"description": "The \u003ccode\u003estatistics\u003c/code\u003e object contains statistics about the video."
},
"fileDetails": {
"$ref": "VideoFileDetails",
"description": "The \u003ccode\u003efileDetails\u003c/code\u003e object encapsulates information about the\nvideo file that was uploaded to YouTube, including the file's resolution,\nduration, audio and video codecs, stream bitrates, and more. This data can\nonly be retrieved by the video owner."
},
"ageGating": {
"description": "Age restriction details related to a video. This data can only be retrieved\nby the video owner.",
"$ref": "VideoAgeGating"
},
"status": {
"description": "The \u003ccode\u003estatus\u003c/code\u003e object contains information about the video's\nuploading, processing, and privacy statuses.",
"$ref": "VideoStatus"
},
"localizations": {
"type": "object",
"description": "The \u003ccode\u003elocalizations\u003c/code\u003e object contains localized versions of the\nbasic details about the video, such as its title and description.",
"additionalProperties": {
"$ref": "VideoLocalization"
}
},
"suggestions": {
"description": "The \u003ccode\u003esuggestions\u003c/code\u003e object encapsulates suggestions that identify\nopportunities to improve the video quality or the metadata for the uploaded\nvideo. This data can only be retrieved by the video owner.",
"$ref": "VideoSuggestions"
},
"recordingDetails": {
"description": "The \u003ccode\u003erecordingDetails\u003c/code\u003e object encapsulates information about the\nlocation, date and address where the video was recorded.",
"$ref": "VideoRecordingDetails"
},
"topicDetails": {
"$ref": "VideoTopicDetails",
"description": "The \u003ccode\u003etopicDetails\u003c/code\u003e object encapsulates information about \u003ca\nhref=\"http://www.freebase.com\"\u003eFreebase\u003c/a\u003e topics associated with the\nvideo."
},
"processingDetails": {
"$ref": "VideoProcessingDetails",
"description": "The \u003ccode\u003eprocessingDetails\u003c/code\u003e object encapsulates information about\nYouTube's progress in processing the uploaded video file. The properties\nin the object identify the current processing status and an estimate of\nthe time remaining until YouTube finishes processing the video. This part\nalso indicates whether different types of data or content, such as file\ndetails or thumbnail images, are available for the video.\u003cbr\u003e\u003cbr\u003e\nThe \u003ccode\u003eprocessingProgress\u003c/code\u003e object is designed to be polled so\nthat the video uploaded can track the progress that YouTube has made in\nprocessing the uploaded video file. This data can only be retrieved by\nthe video owner."
},
"monetizationDetails": {
"$ref": "VideoMonetizationDetails",
"description": "The \u003ccode\u003emonetizationDetails\u003c/code\u003e object encapsulates information\nabout the monetization status of the video."
},
"snippet": {
"description": "The \u003ccode\u003esnippet\u003c/code\u003e object contains basic details about the video,\nsuch as its title, description, and category.",
"$ref": "VideoSnippet"
}
},
"type": "object"
},
"ChannelSectionContentDetails": {
"id": "ChannelSectionContentDetails",
"type": "object",
"properties": {
"channels": {
"items": {
"type": "string"
},
"description": "The channel ids for type multiple_channels.",
"type": "array"
},
"playlists": {
"description": "The playlist ids for type single_playlist and multiple_playlists. For\nsinglePlaylist, only one playlistId is allowed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"description": "Details about a channelsection, including playlists and channels."
},
"SuperChatEventListResponse": {
"type": "object",
"properties": {
"pageInfo": {
"$ref": "PageInfo"
},
"kind": {
"default": "youtube#superChatEventListResponse",
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#superChatEventListResponse\"\u003c/code\u003e."
},
"visitorId": {
"type": "string",
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor."
},
"eventId": {
"description": "Serialized EventId of the request which produced this response.",
"type": "string"
},
"items": {
"type": "array",
"items": {
"$ref": "SuperChatEvent"
},
"description": "A list of Super Chat purchases that match the request criteria."
},
"nextPageToken": {
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the next page in the result set.",
"type": "string"
},
"tokenPagination": {
"$ref": "TokenPagination"
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
}
},
"id": "SuperChatEventListResponse"
},
"VideoAbuseReportReason": {
"type": "object",
"id": "VideoAbuseReportReason",
"description": "A `__videoAbuseReportReason__` resource identifies a reason that a video\ncould be reported as abusive. Video abuse report reasons are used with\n`video.ReportAbuse`.",
"properties": {
"snippet": {
"$ref": "VideoAbuseReportReasonSnippet",
"description": "The `snippet` object contains basic details about the abuse report reason."
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"id": {
"description": "The ID of this abuse report reason.",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string\n`\"youtube#videoAbuseReportReason\"`.",
"default": "youtube#videoAbuseReportReason",
"type": "string"
}
}
},
"I18nRegionSnippet": {
"properties": {
"gl": {
"type": "string",
"description": "The region code as a 2-letter ISO country code."
},
"name": {
"description": "The human-readable name of the region.",
"type": "string"
}
},
"description": "Basic details about an i18n region, such as region code and human-readable\nname.",
"type": "object",
"id": "I18nRegionSnippet"
},
"VideoCard": {
"type": "object",
"id": "VideoCard",
"properties": {
"customMessage": {
"type": "string",
"description": "Each card can have a custom message.\nOptional."
},
"videoId": {
"description": "Encrypted Video ID.\nRequired.",
"type": "string"
},
"playbackStartOffset": {
"description": "Playback start time offset in milliseconds.\nOptional.",
"type": "string",
"format": "google-duration"
}
}
},
"ChannelAuditDetails": {
"properties": {
"copyrightStrikesGoodStanding": {
"type": "boolean",
"description": "Whether or not the channel has any copyright strikes."
},
"contentIdClaimsGoodStanding": {
"description": "Whether or not the channel has any unresolved claims.",
"type": "boolean"
},
"communityGuidelinesGoodStanding": {
"type": "boolean",
"description": "Whether or not the channel respects the community guidelines."
}
},
"type": "object",
"description": "The \u003ccode\u003eauditDetails\u003c/code\u003e object encapsulates channel data that is\nrelevant for YouTube Partners during the audit process.",
"id": "ChannelAuditDetails"
},
"ChannelBrandingSettings": {
"properties": {
"hints": {
"items": {
"$ref": "PropertyValue"
},
"type": "array",
"description": "Additional experimental branding properties."
},
"channel": {
"$ref": "ChannelSettings",
"description": "Branding properties for the channel view."
},
"watch": {
"$ref": "WatchSettings",
"description": "Branding properties for the watch page."
},
"image": {
"$ref": "ImageSettings",
"description": "Branding properties for branding images."
}
},
"description": "Branding properties of a YouTube channel.",
"type": "object",
"id": "ChannelBrandingSettings"
},
"ThumbnailSetResponse": {
"id": "ThumbnailSetResponse",
"type": "object",
"properties": {
"kind": {
"default": "youtube#thumbnailSetResponse",
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#thumbnailSetResponse\"\u003c/code\u003e."
},
"eventId": {
"description": "Serialized EventId of the request which produced this response.",
"type": "string"
},
"visitorId": {
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor.",
"type": "string"
},
"items": {
"description": "A list of thumbnails.",
"items": {
"$ref": "ThumbnailDetails"
},
"type": "array"
},
"etag": {
"type": "string",
"description": "Etag of this resource."
}
}
},
"InfoCards": {
"id": "InfoCards",
"properties": {
"items": {
"description": "A list of infocards.",
"type": "array",
"items": {
"$ref": "InfoCard"
}
}
},
"type": "object"
},
"VideoCategorySnippet": {
"id": "VideoCategorySnippet",
"description": "Basic details about a video category, such as its localized title.",
"properties": {
"channelId": {
"type": "string",
"description": "The YouTube channel that created the video category."
},
"title": {
"description": "The video category's title.",
"type": "string"
},
"assignable": {
"type": "boolean"
}
},
"type": "object"
},
"ActivityContentDetailsBulletin": {
"description": "Details about a channel bulletin post.",
"type": "object",
"properties": {
"resourceId": {
"$ref": "ResourceId",
"description": "The \u003ccode\u003eresourceId\u003c/code\u003e object contains information that\nidentifies the resource associated with a bulletin post.\n@mutable youtube.activities.insert"
}
},
"id": "ActivityContentDetailsBulletin"
},
"ChannelSettings": {
"properties": {
"profileColor": {
"type": "string",
"description": "A prominent color that can be rendered on this channel page."
},
"country": {
"type": "string",
"description": "The country of the channel."
},
"showBrowseView": {
"type": "boolean",
"description": "Whether the tab to browse the videos should be displayed."
},
"showRelatedChannels": {
"description": "Whether related channels should be proposed.",
"type": "boolean"
},
"unsubscribedTrailer": {
"type": "string",
"description": "The trailer of the channel, for users that are not subscribers."
},
"keywords": {
"description": "Lists keywords associated with the channel, comma-separated.",
"type": "string"
},
"featuredChannelsUrls": {
"type": "array",
"description": "The list of featured channels.",
"items": {
"type": "string"
}
},
"trackingAnalyticsAccountId": {
"type": "string",
"description": "The ID for a Google Analytics account to track and measure traffic to the\nchannels."
},
"description": {
"description": "Specifies the channel description.",
"type": "string"
},
"title": {
"type": "string",
"description": "Specifies the channel title."
},
"moderateComments": {
"type": "boolean",
"description": "Whether user-submitted comments left on the channel page need to be\napproved by the channel owner to be publicly visible."
},
"defaultTab": {
"type": "string",
"description": "Which content tab users should see when viewing the channel."
},
"featuredChannelsTitle": {
"type": "string",
"description": "Title for the featured channels tab."
},
"defaultLanguage": {
"type": "string"
}
},
"description": "Branding properties for the channel view.",
"type": "object",
"id": "ChannelSettings"
},
"VideoProcessingDetails": {
"properties": {
"processingProgress": {
"description": "The \u003ccode\u003eprocessingProgress\u003c/code\u003e object contains information about the\nprogress YouTube has made in processing the video. The values are really\nonly relevant if the video's processing status is \u003ccode\u003eprocessing\u003c/code\u003e.",
"$ref": "VideoProcessingDetailsProcessingProgress"
},
"thumbnailsAvailability": {
"description": "This value indicates whether thumbnail images have been generated for\nthe video.",
"type": "string"
},
"editorSuggestionsAvailability": {
"description": "This value indicates whether video editing suggestions, which might\nimprove video quality or the playback experience, are available for\nthe video. You can retrieve these suggestions by requesting the\n\u003ccode\u003esuggestions\u003c/code\u003e part in your \u003ccode\u003evideos.list()\u003c/code\u003e request.",
"type": "string"
},
"fileDetailsAvailability": {
"description": "This value indicates whether file details are available for the uploaded\nvideo. You can retrieve a video's file details by requesting the\n\u003ccode\u003efileDetails\u003c/code\u003e part in your \u003ccode\u003evideos.list()\u003c/code\u003e request.",
"type": "string"
},
"processingStatus": {
"description": "The video's processing status. This value indicates whether YouTube was\nable to process the video or if the video is still being processed.",
"type": "string",
"enum": [
"processing",
"succeeded",
"failed",
"terminated"
],
"enumDescriptions": [
"",
"",
"",
""
]
},
"processingFailureReason": {
"enumDescriptions": [
"",
"",
"",
""
],
"description": "The reason that YouTube failed to process the video. This property will\nonly have a value if the \u003ccode\u003eprocessingStatus\u003c/code\u003e\nproperty's value is \u003ccode\u003efailed\u003c/code\u003e.",
"type": "string",
"enum": [
"uploadFailed",
"transcodeFailed",
"streamingFailed",
"other"
]
},
"tagSuggestionsAvailability": {
"description": "This value indicates whether keyword (tag) suggestions are available for\nthe video. Tags can be added to a video's metadata to make it easier for\nother users to find the video. You can retrieve these suggestions by\nrequesting the \u003ccode\u003esuggestions\u003c/code\u003e part in your\n\u003ccode\u003evideos.list()\u003c/code\u003e request.",
"type": "string"
},
"processingIssuesAvailability": {
"type": "string",
"description": "This value indicates whether the video processing engine has generated\nsuggestions that might improve YouTube's ability to process the\nthe video, warnings that explain video processing problems, or\nerrors that cause video processing problems. You can retrieve these\nsuggestions by requesting the \u003ccode\u003esuggestions\u003c/code\u003e part in your\n\u003ccode\u003evideos.list()\u003c/code\u003e request."
}
},
"type": "object",
"description": "Describes processing status and progress and availability of some other Video\nresource parts.",
"id": "VideoProcessingDetails"
},
"AccessPolicy": {
"type": "object",
"id": "AccessPolicy",
"properties": {
"exception": {
"description": "A list of region codes that identify countries where the default policy do\nnot apply.",
"type": "array",
"items": {
"type": "string"
}
},
"allowed": {
"type": "boolean",
"description": "The value of \u003ccode\u003eallowed\u003c/code\u003e indicates whether the access to the\npolicy is allowed or denied by default."
}
},
"description": "Rights management policy for YouTube resources."
},
"LiveBroadcastContentDetails": {
"properties": {
"monitorStream": {
"description": "The \u003ccode\u003emonitorStream\u003c/code\u003e object contains information about the\nmonitor stream, which the broadcaster can use to review the event\ncontent before the broadcast stream is shown publicly.",
"$ref": "MonitorStreamInfo"
},
"enableClosedCaptions": {
"type": "boolean",
"description": "This setting indicates whether HTTP POST closed captioning is enabled for\nthis broadcast. The ingestion URL of the closed captions is returned\nthrough the liveStreams API. This is mutually exclusive with using the\n\u003ccode\u003eclosed_captions_type\u003c/code\u003e property, and is equivalent to setting\n\u003ccode\u003eclosed_captions_type\u003c/code\u003e to CLOSED_CAPTIONS_HTTP_POST."
},
"enableAutoStop": {
"description": "This setting indicates whether auto stop is enabled for this broadcast.\nThe default value for this property is \u003ccode\u003efalse\u003c/code\u003e.\u003cbr\u003e\u003cbr\u003e\nThis setting can only be used by Events.",
"type": "boolean"
},
"boundStreamId": {
"description": "This value uniquely identifies the\n\u003ccode\u003e\u003ca href=\"/youtube/v3/live/docs/liveStreams\"\u003elive stream\u003c/a\u003e\u003c/code\u003e\nbound to the broadcast.",
"type": "string"
},
"recordFromStart": {
"annotations": {
"required": [
"youtube.liveBroadcasts.update"
]
},
"description": "Automatically start recording after the event goes live.\nThe default value for this property is \u003ccode\u003etrue\u003c/code\u003e.\u003cbr\u003e\u003cbr\u003e\n\n\u003cstrong\u003eImportant:\u003c/strong\u003e You must also set the \u003ccode\u003eenableDvr\u003c/code\u003e\nproperty's value to\n\u003ccode\u003etrue\u003c/code\u003e if you want the playback to be available immediately\nafter the broadcast ends. If you set this property's value to\n\u003ccode\u003etrue\u003c/code\u003e but do not also set the \u003ccode\u003eenableDvr\u003c/code\u003e property\nto \u003ccode\u003etrue\u003c/code\u003e, there may be a delay of around one day before the\narchived video will be available for playback.",
"type": "boolean"
},
"boundStreamLastUpdateTimeMs": {
"type": "string",
"description": "The date and time that the live stream referenced by\n\u003ccode\u003eboundStreamId\u003c/code\u003e was last updated."
},
"mesh": {
"format": "byte",
"description": "The mesh for projecting the video if \u003ccode\u003eprojection\u003c/code\u003e is\n\u003ccode\u003emesh\u003c/code\u003e. The mesh value must be a UTF-8 string containing the\nbase-64 encoding of 3D mesh data that follows the \u003ca\nhref=\"https://github.com/google/spatial-media/blob/master/docs/spherical-video-v2-rfc.md\"\u003e\nSpherical Video V2 RFC specification\u003c/a\u003e for an mshp box, excluding the box\nsize and type but including the following four reserved zero bytes for the\nversion and flags.",
"type": "string"
},
"enableContentEncryption": {
"type": "boolean",
"description": "This setting indicates whether YouTube should enable content encryption\nfor the broadcast.",
"annotations": {
"required": [
"youtube.liveBroadcasts.update"
]
}
},
"closedCaptionsType": {
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string",
"enum": [
"closedCaptionsTypeUnspecified",
"closedCaptionsDisabled",
"closedCaptionsHttpPost",
"closedCaptionsEmbedded"
]
},
"startWithSlate": {
"type": "boolean",
"description": "This setting indicates whether the broadcast should automatically begin\nwith an \u003ca\nhref=\"/youtube/v3/live/getting-started#Displaying_Slates\"\u003ein-stream\nslate\u003c/a\u003e when you update the broadcast's status to \u003ccode\u003elive\u003c/code\u003e.\nAfter updating the status, you then need to send a\n\u003ccode\u003e\u003ca\nhref=\"/youtube/v3/live/docs/liveCuepoints/insert\"\u003eliveCuepoints.insert\u003c/a\u003e\u003c/code\u003e\nrequest that sets the cuepoint's \u003ccode\u003eeventState\u003c/code\u003e to\n\u003ccode\u003eend\u003c/code\u003e to remove the in-stream slate and make your broadcast\nstream visible to viewers.",
"annotations": {
"required": [
"youtube.liveBroadcasts.update"
]
}
},
"projection": {
"description": "The projection format of this broadcast. This defaults to\n\u003ccode\u003erectangular\u003c/code\u003e.",
"enum": [
"projectionUnspecified",
"rectangular",
"360",
"mesh"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"enableLowLatency": {
"description": "Indicates whether this broadcast has low latency enabled.",
"type": "boolean"
},
"enableDvr": {
"annotations": {
"required": [
"youtube.liveBroadcasts.update"
]
},
"description": "This setting determines whether viewers can access DVR controls while\nwatching the video. DVR controls enable the viewer to control the video\nplayback experience by pausing, rewinding, or fast forwarding content.\nThe default value for this property is \u003ccode\u003etrue\u003c/code\u003e.\u003cbr\u003e\u003cbr\u003e\n\n\u003cstrong\u003eImportant:\u003c/strong\u003e You must set the value to \u003ccode\u003etrue\u003c/code\u003e\nand also set the \u003ccode\u003eenableArchive\u003c/code\u003e property's value to\n\u003ccode\u003etrue\u003c/code\u003e if you want to make playback available immediately\nafter the broadcast ends.",
"type": "boolean"
},
"enableAutoStart": {
"type": "boolean",
"description": "This setting indicates whether auto start is enabled for this broadcast.\n The default value for this property is \u003ccode\u003efalse\u003c/code\u003e.\u003cbr\u003e\u003cbr\u003e\n This setting can only be used by Events."
},
"latencyPreference": {
"enumDescriptions": [
"",
"Best for: highest quality viewer playbacks and higher resolutions.",
"Best for: near real-time interaction, with minimal playback buffering.",
"Best for: real-time interaction\nDoes not support: Closed captions, 1440p, and 4k resolutions"
],
"description": "If both this and enable_low_latency are set, they must match.\nLATENCY_NORMAL should match enable_low_latency=false\nLATENCY_LOW should match enable_low_latency=true\nLATENCY_ULTRA_LOW should have enable_low_latency omitted.",
"enum": [
"latencyPreferenceUnspecified",
"normal",
"low",
"ultraLow"
],
"type": "string"
},
"enableEmbed": {
"annotations": {
"required": [
"youtube.liveBroadcasts.update"
]
},
"type": "boolean",
"description": "This setting indicates whether the broadcast video can be played in an\nembedded player. If you choose to archive the video (using the\n\u003ccode\u003eenableArchive\u003c/code\u003e property), this setting will also apply to\nthe archived video."
}
},
"description": "Detailed settings of a broadcast.",
"type": "object",
"id": "LiveBroadcastContentDetails"
},
"PlaylistListResponse": {
"id": "PlaylistListResponse",
"type": "object",
"properties": {
"etag": {
"type": "string",
"description": "Etag of this resource."
},
"kind": {
"default": "youtube#playlistListResponse",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#playlistListResponse\"\u003c/code\u003e.",
"type": "string"
},
"visitorId": {
"type": "string",
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor."
},
"pageInfo": {
"description": "General pagination information.",
"$ref": "PageInfo"
},
"items": {
"description": "A list of playlists that match the request criteria",
"type": "array",
"items": {
"$ref": "Playlist"
}
},
"prevPageToken": {
"type": "string",
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the previous page in the result set."
},
"nextPageToken": {
"type": "string",
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the next page in the result set."
},
"eventId": {
"description": "Serialized EventId of the request which produced this response.",
"type": "string"
},
"tokenPagination": {
"$ref": "TokenPagination"
}
}
},
"LiveChatMessageRetractedDetails": {
"type": "object",
"id": "LiveChatMessageRetractedDetails",
"properties": {
"retractedMessageId": {
"type": "string"
}
}
},
"VideoSuggestions": {
"id": "VideoSuggestions",
"type": "object",
"description": "Specifies suggestions on how to improve video content,\nincluding encoding hints, tag suggestions, and editor suggestions.",
"properties": {
"editorSuggestions": {
"items": {
"enum": [
"videoAutoLevels",
"videoStabilize",
"videoCrop",
"audioQuietAudioSwap"
],
"type": "string"
},
"description": "A list of video editing operations that might improve the video quality\nor playback experience of the uploaded video.",
"enumDescriptions": [
"Picture brightness levels seem off and could be corrected.",
"The video appears shaky and could be stabilized.",
"Margins (mattes) detected around the picture could be cropped.",
"The audio track appears silent and could be swapped with a\nbetter quality one."
],
"type": "array"
},
"processingErrors": {
"description": "A list of errors that will prevent YouTube from successfully processing\nthe uploaded video video. These errors indicate that, regardless of the\nvideo's current \u003ca href=\"#processingProgress.processingStatus\"\u003eprocessing\nstatus\u003c/a\u003e, eventually, that status will almost certainly be\n\u003ccode\u003efailed\u003c/code\u003e.",
"items": {
"type": "string",
"enum": [
"audioFile",
"imageFile",
"projectFile",
"notAVideoFile",
"docFile",
"archiveFile",
"unsupportedSpatialAudioLayout"
]
},
"enumDescriptions": [
"File contains audio only (e.g., an MP3 file).",
"Image file (e.g., a JPEG image).",
"Movie project file (e.g., Microsoft Windows Movie Maker project).",
"Other non-video file.",
"Document or text file (e.g., MS Word document).",
"An archive file (e.g., a ZIP archive).",
"Unsupported spatial audio layout type."
],
"type": "array"
},
"tagSuggestions": {
"items": {
"$ref": "VideoSuggestionsTagSuggestion"
},
"description": "A list of keyword tags that could be added to the video's metadata to\nincrease the likelihood that users will locate your video when searching\nor browsing on YouTube.",
"type": "array"
},
"processingHints": {
"description": "A list of suggestions that may improve YouTube's ability to process the\nvideo.",
"items": {
"enum": [
"nonStreamableMov",
"sendBestQualityVideo",
"sphericalVideo",
"spatialAudio",
"vrVideo",
"hdrVideo"
],
"type": "string"
},
"enumDescriptions": [
"The MP4 file is not streamable, this will slow down the processing.\n MOOV atom was not found at the beginning of the file.",
"Probably a better quality version of the video exists.\n The video has wide screen aspect ratio, but is not an HD video.",
"Uploaded video is spherical video.",
"Uploaded video has spatial audio.",
"Uploaded video is VR video.",
"Uploaded video is HDR video."
],
"type": "array"
},
"processingWarnings": {
"description": "A list of reasons why YouTube may have difficulty transcoding the\nuploaded video or that might result in an erroneous transcoding.\nThese warnings are generated before YouTube actually processes the\nuploaded video file. In addition, they identify issues that are unlikely\nto cause the video processing to fail but that might cause problems\nsuch as sync issues, video artifacts, or a missing audio track.",
"items": {
"type": "string",
"enum": [
"unknownContainer",
"unknownVideoCodec",
"unknownAudioCodec",
"inconsistentResolution",
"hasEditlist",
"problematicVideoCodec",
"problematicAudioCodec",
"unsupportedVrStereoMode",
"unsupportedSphericalProjectionType",
"unsupportedHdrPixelFormat",
"unsupportedHdrColorMetadata",
"problematicHdrLookupTable"
]
},
"enumDescriptions": [
"Unrecognized file format, transcoding is likely to fail.",
"Unrecognized video codec, transcoding is likely to fail.",
"Unrecognized audio codec, transcoding is likely to fail.",
"Conflicting container and stream resolutions.",
"Edit lists are not currently supported.",
"Video codec that is known to cause problems was used.",
"Audio codec that is known to cause problems was used.",
"Unsupported VR video stereo mode.",
"Unsupported spherical video projection type.",
"Unsupported HDR pixel format.",
"Unspecified HDR color metadata.",
"Problematic HDR lookup table attached."
],
"type": "array"
}
}
},
"ActivityContentDetails": {
"description": "Details about the content of an activity: the video that was shared, the\nchannel that was subscribed to, etc.",
"properties": {
"favorite": {
"$ref": "ActivityContentDetailsFavorite",
"description": "The \u003ccode\u003efavorite\u003c/code\u003e object contains information about a video that\nwas marked as a favorite video. This property is only present if the\n\u003ccode\u003esnippet.type\u003c/code\u003e is \u003ccode\u003efavorite\u003c/code\u003e."
},
"bulletin": {
"description": "The \u003ccode\u003ebulletin\u003c/code\u003e object contains details about a channel\nbulletin post. This object is only present if the\n\u003ccode\u003esnippet.type\u003c/code\u003e is \u003ccode\u003ebulletin\u003c/code\u003e.",
"$ref": "ActivityContentDetailsBulletin"
},
"promotedItem": {
"description": "The \u003ccode\u003epromotedItem\u003c/code\u003e object contains details about a resource\nwhich is being promoted. This property is only present if the\n\u003ccode\u003esnippet.type\u003c/code\u003e is \u003ccode\u003epromotedItem\u003c/code\u003e.",
"$ref": "ActivityContentDetailsPromotedItem"
},
"playlistItem": {
"description": "The \u003ccode\u003eplaylistItem\u003c/code\u003e object contains information about a\nnew playlist item. This property is only present if the\n\u003ccode\u003esnippet.type\u003c/code\u003e is \u003ccode\u003eplaylistItem\u003c/code\u003e.",
"$ref": "ActivityContentDetailsPlaylistItem"
},
"subscription": {
"description": "The \u003ccode\u003esubscription\u003c/code\u003e object contains information about a\nchannel that a user subscribed to. This property is only\npresent if the \u003ccode\u003esnippet.type\u003c/code\u003e is \u003ccode\u003esubscription\u003c/code\u003e.",
"$ref": "ActivityContentDetailsSubscription"
},
"social": {
"description": "The \u003ccode\u003esocial\u003c/code\u003e object contains details about a social network\npost. This property is only present if the \u003ccode\u003esnippet.type\u003c/code\u003e\nis \u003ccode\u003esocial\u003c/code\u003e.",
"$ref": "ActivityContentDetailsSocial"
},
"upload": {
"description": "The \u003ccode\u003eupload\u003c/code\u003e object contains information about the uploaded\nvideo. This property is only present if the \u003ccode\u003esnippet.type\u003c/code\u003e\nis \u003ccode\u003eupload\u003c/code\u003e.",
"$ref": "ActivityContentDetailsUpload"
},
"recommendation": {
"description": "The \u003ccode\u003erecommendation\u003c/code\u003e object contains information about a\nrecommended resource. This property is only present if the\n\u003ccode\u003esnippet.type\u003c/code\u003e is \u003ccode\u003erecommendation\u003c/code\u003e.",
"$ref": "ActivityContentDetailsRecommendation"
},
"comment": {
"$ref": "ActivityContentDetailsComment",
"description": "The \u003ccode\u003ecomment\u003c/code\u003e object contains information about a resource\nthat received a comment. This property is only present if the\n\u003ccode\u003esnippet.type\u003c/code\u003e is \u003ccode\u003ecomment\u003c/code\u003e."
},
"channelItem": {
"description": "The \u003ccode\u003echannelItem\u003c/code\u003e object contains details about a resource\nwhich was added to a channel. This property is only present if the\n\u003ccode\u003esnippet.type\u003c/code\u003e is \u003ccode\u003echannelItem\u003c/code\u003e.",
"$ref": "ActivityContentDetailsChannelItem"
},
"like": {
"description": "The \u003ccode\u003elike\u003c/code\u003e object contains information about a resource that\nreceived a positive (like) rating. This property is only present if\nthe \u003ccode\u003esnippet.type\u003c/code\u003e is \u003ccode\u003elike\u003c/code\u003e.",
"$ref": "ActivityContentDetailsLike"
}
},
"type": "object",
"id": "ActivityContentDetails"
},
"ChannelListResponse": {
"type": "object",
"id": "ChannelListResponse",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#channelListResponse\"\u003c/code\u003e.",
"default": "youtube#channelListResponse"
},
"visitorId": {
"type": "string",
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor."
},
"eventId": {
"type": "string",
"description": "Serialized EventId of the request which produced this response."
},
"tokenPagination": {
"$ref": "TokenPagination"
},
"items": {
"type": "array",
"items": {
"$ref": "Channel"
}
},
"pageInfo": {
"description": "General pagination information.",
"$ref": "PageInfo"
},
"nextPageToken": {
"type": "string",
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the next page in the result set."
},
"prevPageToken": {
"type": "string",
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the previous page in the result set."
},
"etag": {
"type": "string",
"description": "Etag of this resource."
}
}
},
"PropertyValue": {
"type": "object",
"properties": {
"value": {
"description": "The property's value.",
"type": "string"
},
"property": {
"type": "string",
"description": "A property."
}
},
"id": "PropertyValue",
"description": "A pair Property / Value."
},
"VideoLocalization": {
"description": "Localized versions of certain video properties (e.g. title).",
"properties": {
"title": {
"description": "Localized version of the video's title.",
"type": "string"
},
"description": {
"type": "string",
"description": "Localized version of the video's description."
}
},
"type": "object",
"id": "VideoLocalization"
},
"CommentSnippetAuthorChannelId": {
"description": "The id of the author's YouTube channel, if any.",
"properties": {
"value": {
"type": "string"
}
},
"id": "CommentSnippetAuthorChannelId",
"type": "object"
},
"LiveBroadcastStatistics": {
"properties": {
"totalChatCount": {
"description": "The total number of live chat messages currently on the broadcast. The\nproperty and its value will be present if the broadcast is public, has\nthe live chat feature enabled, and has at least one message. Note that\nthis field will not be filled after the broadcast ends. So this property\nwould not identify the number of chat messages for an archived video of a\ncompleted live broadcast.",
"type": "string",
"format": "uint64"
}
},
"description": "Statistics about the live broadcast. These represent a snapshot of the values\nat the time of the request. Statistics are only returned for live broadcasts.",
"id": "LiveBroadcastStatistics",
"type": "object"
},
"Subscription": {
"id": "Subscription",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#subscription\"\u003c/code\u003e.",
"type": "string",
"default": "youtube#subscription"
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"contentDetails": {
"$ref": "SubscriptionContentDetails",
"description": "The \u003ccode\u003econtentDetails\u003c/code\u003e object contains basic statistics about the\nsubscription."
},
"id": {
"description": "The ID that YouTube uses to uniquely identify the subscription.",
"type": "string"
},
"subscriberSnippet": {
"description": "The \u003ccode\u003esubscriberSnippet\u003c/code\u003e object contains basic details about the\nsubscriber.",
"$ref": "SubscriptionSubscriberSnippet"
},
"snippet": {
"description": "The \u003ccode\u003esnippet\u003c/code\u003e object contains basic details about the\nsubscription, including its title and the channel that the user subscribed\nto.",
"$ref": "SubscriptionSnippet"
}
},
"type": "object",
"description": "A \u003ccode\u003e\u003cstrong\u003esubscription\u003c/strong\u003e\u003c/code\u003e resource contains information\nabout a YouTube user subscription. A subscription notifies a user when new\nvideos are added to a channel or when another user takes one of several\nactions on YouTube, such as uploading a video, rating a video, or commenting\non a video."
},
"Sponsor": {
"type": "object",
"description": "A `__sponsor__` resource represents a sponsor for a YouTube channel. A\nsponsor provides recurring monetary support to a creator and receives special\nbenefits.",
"id": "Sponsor",
"properties": {
"kind": {
"type": "string",
"default": "youtube#sponsor",
"description": "Identifies what kind of resource this is. Value: the fixed string\n`\"youtube#sponsor\"`."
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"snippet": {
"$ref": "SponsorSnippet",
"description": "The `snippet` object contains basic details about the sponsor."
}
}
},
"CaptionListResponse": {
"type": "object",
"properties": {
"visitorId": {
"type": "string",
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor."
},
"items": {
"items": {
"$ref": "Caption"
},
"description": "A list of captions that match the request criteria.",
"type": "array"
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"kind": {
"default": "youtube#captionListResponse",
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#captionListResponse\"\u003c/code\u003e."
},
"eventId": {
"description": "Serialized EventId of the request which produced this response.",
"type": "string"
}
},
"id": "CaptionListResponse"
},
"VideoContentDetails": {
"properties": {
"dimension": {
"description": "The value of \u003ccode\u003edimension\u003c/code\u003e indicates whether the video is\navailable in 3D or in 2D.",
"type": "string"
},
"caption": {
"description": "The value of \u003ccode\u003ecaptions\u003c/code\u003e indicates whether the video\nhas captions or not.",
"enumDescriptions": [
"",
""
],
"enum": [
"true",
"false"
],
"type": "string"
},
"regionRestriction": {
"$ref": "VideoContentDetailsRegionRestriction",
"description": "The \u003ccode\u003eregionRestriction\u003c/code\u003e object contains information about the\ncountries where a video is (or is not) viewable. The object will contain\neither the \u003ccode\u003econtentDetails.regionRestriction.allowed\u003c/code\u003e property\nor the \u003ccode\u003econtentDetails.regionRestriction.blocked\u003c/code\u003e property."
},
"duration": {
"type": "string",
"description": "The length of the video. The tag value is an \u003ca\nhref=\"//en.wikipedia.org/wiki/ISO_8601#Durations\"\u003eISO 8601\u003c/a\u003e duration in\nthe format \u003ccode\u003ePT#M#S\u003c/code\u003e, in which the letters \u003ccode\u003ePT\u003c/code\u003e\nindicate that the value specifies a period of time, and the letters\n\u003ccode\u003eM\u003c/code\u003e and \u003ccode\u003eS\u003c/code\u003e refer to length in minutes and seconds,\nrespectively. The \u003ccode\u003e#\u003c/code\u003e characters preceding the \u003ccode\u003eM\u003c/code\u003e\nand \u003ccode\u003eS\u003c/code\u003e letters are both integers that specify the number of\nminutes (or seconds) of the video. For example, a value of\n\u003ccode\u003ePT15M51S\u003c/code\u003e indicates that the video is 15 minutes and 51 seconds\nlong."
},
"countryRestriction": {
"description": "The \u003ccode\u003ecountryRestriction\u003c/code\u003e object contains information about the\ncountries where a video is (or is not) viewable.",
"$ref": "AccessPolicy"
},
"hasCustomThumbnail": {
"type": "boolean",
"description": "Indicates whether the video uploader has provided a custom\nthumbnail image for the video.\nThis property is only visible to the video uploader."
},
"licensedContent": {
"description": "The value of \u003ccode\u003eis_license_content\u003c/code\u003e indicates whether the video is\nlicensed content.",
"type": "boolean"
},
"contentRating": {
"$ref": "ContentRating",
"description": "Specifies the ratings that the video received under various rating schemes."
},
"projection": {
"enumDescriptions": [
"",
""
],
"type": "string",
"description": "Specifies the projection format of the video.",
"enum": [
"rectangular",
"360"
]
},
"definition": {
"enumDescriptions": [
"sd",
"hd"
],
"enum": [
"sd",
"hd"
],
"description": "The value of \u003ccode\u003edefinition\u003c/code\u003e indicates whether the video is\navailable in high definition or only in standard definition.",
"type": "string"
}
},
"type": "object",
"id": "VideoContentDetails",
"description": "Details about the content of a YouTube Video."
},
"PlaylistPlayer": {
"id": "PlaylistPlayer",
"properties": {
"embedHtml": {
"description": "An \u003ccode\u003e<iframe>\u003c/code\u003e tag that embeds a player that will\nplay the playlist.",
"type": "string"
}
},
"type": "object"
},
"ChannelSectionTargeting": {
"properties": {
"regions": {
"description": "The region the channel section is targeting.",
"type": "array",
"items": {
"type": "string"
}
},
"languages": {
"type": "array",
"items": {
"type": "string"
},
"description": "The language the channel section is targeting."
},
"countries": {
"items": {
"type": "string"
},
"description": "The country the channel section is targeting.",
"type": "array"
}
},
"description": "ChannelSection targeting setting.",
"type": "object",
"id": "ChannelSectionTargeting"
},
"VideoLiveStreamingDetails": {
"type": "object",
"properties": {
"concurrentViewers": {
"type": "string",
"description": "The number of viewers currently watching the broadcast. The property and\nits value will be present if the broadcast has current viewers and the\nbroadcast owner has not hidden the viewcount for the video. Note that\nYouTube stops tracking the number of concurrent viewers for a broadcast\nwhen the broadcast ends. So, this property would not identify the number\nof viewers watching an archived video of a live broadcast that already\nended.",
"format": "uint64"
},
"activeLiveChatId": {
"type": "string",
"description": "The ID of the currently active live chat attached to this video. This\nfield is filled only if the video is a currently live broadcast that has\nlive chat. Once the broadcast transitions to complete this field will be\nremoved and the live chat closed down. For persistent broadcasts that live\nchat id will no longer be tied to this video but rather to the new video\nbeing displayed at the persistent page."
},
"actualEndTime": {
"description": "The time that the broadcast actually ended. The value is specified\nin \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat. This value will not be\navailable until the broadcast is over.",
"type": "string"
},
"actualStartTime": {
"description": "The time that the broadcast actually started. The value is specified\nin \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat. This value will not be\navailable until the broadcast begins.",
"type": "string"
},
"scheduledStartTime": {
"description": "The time that the broadcast is scheduled to begin. The value is specified\nin \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat.",
"type": "string"
},
"scheduledEndTime": {
"type": "string",
"description": "The time that the broadcast is scheduled to end. The value is specified\nin \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat. If the value is empty or\nthe property is not present, then the broadcast is scheduled to continue\nindefinitely."
}
},
"description": "Details about the live streaming metadata.",
"id": "VideoLiveStreamingDetails"
},
"ActivityContentDetailsFavorite": {
"id": "ActivityContentDetailsFavorite",
"type": "object",
"description": "Information about a video that was marked as a favorite video.",
"properties": {
"resourceId": {
"description": "The \u003ccode\u003eresourceId\u003c/code\u003e object contains information that\nidentifies the resource that was marked as a favorite.",
"$ref": "ResourceId"
}
}
},
"InfoCardSnippetTeaser": {
"id": "InfoCardSnippetTeaser",
"properties": {
"teaserStartOffset": {
"format": "google-duration",
"type": "string",
"description": "The offset from the video start at which the teaser should be displayed\n(activated), in milliseconds.\nRequired."
},
"teaserText": {
"type": "string",
"description": "The teaser text to show at the top of the player for the info-card.\nRequired for channel and link type cards.\nOptional for video and playlist type cards."
}
},
"type": "object"
},
"ChannelContentOwnerDetails": {
"type": "object",
"description": "The \u003ccode\u003econtentOwnerDetails\u003c/code\u003e object encapsulates channel data that\nis relevant for YouTube Partners linked with the channel.",
"id": "ChannelContentOwnerDetails",
"properties": {
"timeLinked": {
"description": "The date and time of when the channel was linked to the content owner.\nThe value is specified in \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO\n8601\u003c/a\u003e\nformat.",
"type": "string"
},
"contentOwner": {
"type": "string",
"description": "The ID of the content owner linked to the channel."
}
}
},
"InfoCard": {
"type": "object",
"id": "InfoCard",
"properties": {
"id": {
"type": "string",
"description": "UUID for this infocard."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is.",
"default": "youtube#infocard"
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"snippet": {
"description": "The snippet object contains basic details about the infocard.",
"$ref": "InfoCardSnippet"
}
}
},
"LevelDetails": {
"properties": {
"displayName": {
"type": "string",
"description": "The name that should be used when referring to this level."
}
},
"type": "object",
"id": "LevelDetails"
},
"MonitorStreamInfo": {
"id": "MonitorStreamInfo",
"description": "Settings and Info of the monitor stream",
"properties": {
"embedHtml": {
"description": "HTML code that embeds a player that plays the monitor stream.",
"type": "string"
},
"enableMonitorStream": {
"annotations": {
"required": [
"youtube.liveBroadcasts.update"
]
},
"description": "This value determines whether the monitor stream is enabled for the\nbroadcast. If the monitor stream is enabled, then YouTube will\nbroadcast the event content on a special stream intended only for\nthe broadcaster's consumption. The broadcaster can use the stream\nto review the event content and also to identify the optimal times\nto insert cuepoints.\u003cbr\u003e\u003cbr\u003e\nYou need to set this value to \u003ccode\u003etrue\u003c/code\u003e if you intend to have\na broadcast delay for your event.\u003cbr\u003e\u003cbr\u003e\n\u003cstrong\u003eNote:\u003c/strong\u003e This property cannot be updated once the\nbroadcast is in the \u003ccode\u003etesting\u003c/code\u003e or \u003ccode\u003elive\u003c/code\u003e state.",
"type": "boolean"
},
"broadcastStreamDelayMs": {
"type": "integer",
"description": "If you have set the\n\u003ccode\u003e\u003ca href=\"#enableMonitorStream\"\u003eenableMonitorStream\u003c/a\u003e\u003c/code\u003e\nproperty to \u003ccode\u003etrue\u003c/code\u003e, then this property determines the\nlength of the live broadcast delay.",
"annotations": {
"required": [
"youtube.liveBroadcasts.update"
]
},
"format": "uint32"
}
},
"type": "object"
},
"VideoCategory": {
"type": "object",
"properties": {
"id": {
"description": "The ID that YouTube uses to uniquely identify the video category.",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#videoCategory\"\u003c/code\u003e.",
"type": "string",
"default": "youtube#videoCategory"
},
"snippet": {
"$ref": "VideoCategorySnippet",
"description": "The \u003ccode\u003esnippet\u003c/code\u003e object contains basic details about the video\ncategory, including its title."
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
}
},
"id": "VideoCategory",
"description": "A \u003ccode\u003e\u003cstrong\u003evideoCategory\u003c/strong\u003e\u003c/code\u003e resource identifies a\ncategory that has been or could be associated with uploaded videos."
},
"LinkCardUploadedImage": {
"properties": {
"version": {
"type": "string",
"description": "The version in the thumbnail service.",
"format": "int64"
},
"imageFile": {
"description": "Image reference on the thumbnail service.",
"type": "string"
}
},
"type": "object",
"id": "LinkCardUploadedImage"
},
"LiveChatMessageDeletedDetails": {
"id": "LiveChatMessageDeletedDetails",
"type": "object",
"properties": {
"deletedMessageId": {
"type": "string"
}
}
},
"LiveChatTextMessageDetails": {
"id": "LiveChatTextMessageDetails",
"properties": {
"messageText": {
"description": "The user's message.",
"type": "string"
}
},
"type": "object"
},
"ActivityListResponse": {
"id": "ActivityListResponse",
"type": "object",
"properties": {
"tokenPagination": {
"$ref": "TokenPagination"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#activityListResponse\"\u003c/code\u003e.",
"default": "youtube#activityListResponse",
"type": "string"
},
"etag": {
"type": "string",
"description": "Etag of this resource."
},
"visitorId": {
"type": "string",
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor."
},
"items": {
"items": {
"$ref": "Activity"
},
"type": "array"
},
"eventId": {
"type": "string",
"description": "Serialized EventId of the request which produced this response."
},
"prevPageToken": {
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the previous page in the result set.",
"type": "string"
},
"pageInfo": {
"description": "General pagination information.",
"$ref": "PageInfo"
},
"nextPageToken": {
"type": "string",
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the next page in the result set."
}
}
},
"InfoCardSnippet": {
"type": "object",
"properties": {
"channelInfocard": {
"$ref": "ChannelCard"
},
"playlistInfocard": {
"$ref": "PlaylistCard"
},
"teaser": {
"description": "Each card can have a teaser.\nRequired.",
"$ref": "InfoCardSnippetTeaser"
},
"linkInfocard": {
"$ref": "LinkCard"
},
"videoInfocard": {
"$ref": "VideoCard"
}
},
"id": "InfoCardSnippet"
},
"VideoRecordingDetails": {
"id": "VideoRecordingDetails",
"type": "object",
"description": "Recording information associated with the video.",
"properties": {
"recordingDate": {
"type": "string",
"description": "The date and time when the video was recorded. The value is specified in \u003ca\nhref=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\n(\u003ccode\u003eYYYY-MM-DDThh:mm:ss.sssZ\u003c/code\u003e) format."
},
"location": {
"$ref": "GeoPoint",
"description": "The geolocation information associated with the video."
},
"locationDescription": {
"type": "string",
"description": "The text description of the location where the video was recorded."
}
}
},
"TestItemTestItemSnippet": {
"properties": {},
"id": "TestItemTestItemSnippet",
"type": "object"
},
"LinkCard": {
"type": "object",
"properties": {
"targetUrl": {
"description": "The URL to which this card points.\nRequired.",
"type": "string"
},
"customLinkText": {
"description": "Custom text to show as the website link.\nRequired.",
"type": "string"
},
"externalImageUrl": {
"type": "string",
"description": "URL to an externally hosted image."
},
"title": {
"description": "The title to show on the card.\nRequired.",
"type": "string"
},
"uploadedImage": {
"description": "Previously uploaded image.",
"$ref": "LinkCardUploadedImage"
}
},
"id": "LinkCard"
},
"ChannelCard": {
"id": "ChannelCard",
"properties": {
"channelId": {
"type": "string",
"description": "External channel ID.\nRequired."
},
"customMessage": {
"description": "Each card can have a custom message.\nRequired.",
"type": "string"
}
},
"type": "object"
},
"MembershipsDuration": {
"type": "object",
"id": "MembershipsDuration",
"properties": {
"memberSince": {
"type": "string",
"description": "The date and time when the user became a continuous member across all\nlevels."
},
"memberTotalDurationMonths": {
"description": "The cumulative time the user has been a member across all levels in\ncomplete months (the time is rounded down to the nearest integer).",
"format": "int32",
"type": "integer"
}
}
},
"VideoProcessingDetailsProcessingProgress": {
"id": "VideoProcessingDetailsProcessingProgress",
"type": "object",
"description": "Video processing progress and completion time estimate.",
"properties": {
"partsProcessed": {
"description": "The number of parts of the video that YouTube has already processed.\nYou can estimate the percentage of the video that YouTube has already\nprocessed by calculating:\u003cbr\u003e\n\u003ccode\u003e100 * parts_processed / parts_total\u003c/code\u003e\u003cbr\u003e\u003cbr\u003e\nNote that since the estimated number of parts could increase without\na corresponding increase in the number of parts that have already been\nprocessed, it is possible that the calculated progress could\nperiodically decrease while YouTube processes a video.",
"type": "string",
"format": "uint64"
},
"timeLeftMs": {
"format": "uint64",
"type": "string",
"description": "An estimate of the amount of time, in millseconds, that YouTube needs\nto finish processing the video."
},
"partsTotal": {
"description": "An estimate of the total number of parts that need to be processed\nfor the video. The number may be updated with more precise estimates\nwhile YouTube processes the video.",
"format": "uint64",
"type": "string"
}
}
},
"VideoFileDetails": {
"type": "object",
"properties": {
"audioStreams": {
"items": {
"$ref": "VideoFileDetailsAudioStream"
},
"description": "A list of audio streams contained in the uploaded video file. Each item\nin the list contains detailed metadata about an audio stream.",
"type": "array"
},
"durationMs": {
"type": "string",
"format": "uint64",
"description": "The length of the uploaded video in milliseconds."
},
"fileSize": {
"type": "string",
"format": "uint64",
"description": "The uploaded file's size in bytes. This field is present whether\na video file or another type of file was uploaded."
},
"container": {
"description": "The uploaded video file's container format.",
"type": "string"
},
"videoStreams": {
"items": {
"$ref": "VideoFileDetailsVideoStream"
},
"description": "A list of video streams contained in the uploaded video file. Each item\nin the list contains detailed metadata about a video stream.",
"type": "array"
},
"fileName": {
"description": "The uploaded file's name. This field is present whether a video file or\nanother type of file was uploaded.",
"type": "string"
},
"bitrateBps": {
"description": "The uploaded video file's combined (video and audio) bitrate in bits\nper second.",
"format": "uint64",
"type": "string"
},
"creationTime": {
"description": "The date and time when the uploaded video file was created. The value is\nspecified in \u003ca href=\"http://www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat. Currently, the following ISO 8601 formats are supported:\n\u003cul\u003e\n\u003cli\u003eDate only: \u003ccode\u003eYYYY-MM-DD\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eNaive time: \u003ccode\u003eYYYY-MM-DDTHH:MM:SS\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eTime with timezone: \u003ccode\u003eYYYY-MM-DDTHH:MM:SS+HH:MM\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e",
"type": "string"
},
"fileType": {
"description": "The uploaded file's type as detected by YouTube's video processing\nengine. Currently, YouTube only processes video files, but this field\nis present whether a video file or another type of file was uploaded.",
"enumDescriptions": [
"Known video file (e.g., an MP4 file).",
"Audio only file (e.g., an MP3 file).",
"Image file (e.g., a JPEG image).",
"Archive file (e.g., a ZIP archive).",
"Document or text file (e.g., MS Word document).",
"Movie project file (e.g., Microsoft Windows Movie Maker project).",
"Other non-video file type."
],
"type": "string",
"enum": [
"video",
"audio",
"image",
"archive",
"document",
"project",
"other"
]
}
},
"description": "Describes original video file properties, including technical details about\naudio and video streams, but also metadata information like content length,\ndigitization time, or geotagging information.",
"id": "VideoFileDetails"
},
"PlaylistCard": {
"id": "PlaylistCard",
"properties": {
"startVideoId": {
"type": "string",
"description": "Starting video, if not the first.\nOptional."
},
"playlistId": {
"description": "External playlist ID.\nRequired.",
"type": "string"
},
"customMessage": {
"type": "string",
"description": "Each card can have a custom message.\nOptional."
}
},
"type": "object"
},
"VideoProjectDetails": {
"id": "VideoProjectDetails",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of project tags associated with the video during the upload."
}
},
"description": "Project specific details about the content of a YouTube Video.",
"type": "object"
},
"PlaylistItemSnippet": {
"properties": {
"description": {
"type": "string",
"description": "The item's description."
},
"thumbnails": {
"description": "A map of thumbnail images associated with the playlist item. For each\nobject in the map, the key is the name of the thumbnail image, and the\nvalue is an object that contains other information about the thumbnail.",
"$ref": "ThumbnailDetails"
},
"channelTitle": {
"type": "string",
"description": "Channel title for the channel that the playlist item belongs to."
},
"position": {
"type": "integer",
"format": "uint32",
"description": "The order in which the item appears in the playlist. The value uses a\nzero-based index, so the first item has a position of \u003ccode\u003e0\u003c/code\u003e,\nthe second item has a position of \u003ccode\u003e1\u003c/code\u003e, and so forth."
},
"playlistId": {
"description": "The ID that YouTube uses to uniquely identify thGe playlist that the\nplaylist item is in.",
"type": "string"
},
"publishedAt": {
"description": "The date and time that the item was added to the playlist. The value is\nspecified in \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat.",
"type": "string"
},
"channelId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the user that added\nthe item to the playlist."
},
"title": {
"type": "string",
"description": "The item's title."
},
"resourceId": {
"$ref": "ResourceId",
"description": "The \u003ccode\u003eid\u003c/code\u003e object contains information that can be used to\nuniquely identify the resource that is included in the playlist as\nthe playlist item."
}
},
"id": "PlaylistItemSnippet",
"type": "object",
"description": "Basic details about a playlist, including title, description and thumbnails.\nBasic details of a YouTube Playlist item provided by the author.\nNext ID: 13"
},
"LiveChatMessage": {
"properties": {
"id": {
"type": "string",
"description": "The ID that YouTube assigns to uniquely identify the message."
},
"snippet": {
"$ref": "LiveChatMessageSnippet",
"description": "The \u003ccode\u003esnippet\u003c/code\u003e object contains basic details about the message."
},
"authorDetails": {
"description": "The \u003ccode\u003eauthorDetails\u003c/code\u003e object contains basic details about the\nuser that posted this message.",
"$ref": "LiveChatMessageAuthorDetails"
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#liveChatMessage\"\u003c/code\u003e.",
"type": "string",
"default": "youtube#liveChatMessage"
}
},
"description": "A \u003ccode\u003e\u003cstrong\u003eliveChatMessage\u003c/strong\u003e\u003c/code\u003e resource represents a chat\nmessage in a YouTube Live Chat.",
"type": "object",
"id": "LiveChatMessage"
},
"ChannelProfileDetails": {
"properties": {
"profileImageUrl": {
"description": "The channels's avatar URL.",
"type": "string"
},
"channelId": {
"description": "The YouTube channel ID.",
"type": "string"
},
"channelUrl": {
"type": "string",
"description": "The channel's URL."
},
"displayName": {
"description": "The channel's display name.",
"type": "string"
}
},
"type": "object",
"id": "ChannelProfileDetails"
},
"LiveChatBan": {
"type": "object",
"properties": {
"snippet": {
"description": "The `snippet` object contains basic details about the ban.",
"$ref": "LiveChatBanSnippet"
},
"etag": {
"type": "string",
"description": "Etag of this resource."
},
"kind": {
"default": "youtube#liveChatBan",
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string\n`\"youtube#liveChatBan\"`."
},
"id": {
"description": "The ID that YouTube assigns to uniquely identify the ban.",
"type": "string"
}
},
"id": "LiveChatBan",
"description": "A `__liveChatBan__` resource represents a ban for a YouTube live chat."
},
"LiveChatUserBannedMessageDetails": {
"properties": {
"banType": {
"type": "string",
"enum": [
"permanent",
"temporary"
],
"enumDescriptions": [
"",
""
],
"description": "The type of ban."
},
"bannedUserDetails": {
"description": "The details of the user that was banned.",
"$ref": "ChannelProfileDetails"
},
"banDurationSeconds": {
"format": "uint64",
"type": "string",
"description": "The duration of the ban. This property is only present if the\n\u003ccode\u003ebanType\u003c/code\u003e is \u003ccode\u003etemporary\u003c/code\u003e."
}
},
"type": "object",
"id": "LiveChatUserBannedMessageDetails"
},
"MemberSnippet": {
"type": "object",
"properties": {
"membershipsDetails": {
"description": "Details about the user's membership.",
"$ref": "MembershipsDetails"
},
"memberDetails": {
"$ref": "ChannelProfileDetails",
"description": "Details about the member."
},
"creatorChannelId": {
"description": "The id of the channel that's offering memberships.",
"type": "string"
}
},
"id": "MemberSnippet"
},
"SponsorSnippet": {
"id": "SponsorSnippet",
"properties": {
"sponsorDetails": {
"$ref": "ChannelProfileDetails",
"description": "Details about the sponsor."
},
"cumulativeDurationMonths": {
"description": "The cumulative time a user has been a sponsor in months.",
"type": "integer",
"format": "int32"
},
"channelId": {
"type": "string",
"description": "The id of the channel being sponsored."
},
"sponsorSince": {
"description": "The date and time when the user became a sponsor. The value is\nspecified in \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\n(`YYYY-MM-DDThh:mm:ss.sZ`) format.",
"type": "string"
}
},
"type": "object"
},
"SubscriptionSnippet": {
"id": "SubscriptionSnippet",
"description": "Basic details about a subscription, including title, description and\nthumbnails of the subscribed item.",
"type": "object",
"properties": {
"thumbnails": {
"description": "A map of thumbnail images associated with the video. For each object\nin the map, the key is the name of the thumbnail image, and the value\nis an object that contains other information about the thumbnail.",
"$ref": "ThumbnailDetails"
},
"channelId": {
"description": "The ID that YouTube uses to uniquely identify the subscriber's channel.",
"type": "string"
},
"resourceId": {
"$ref": "ResourceId",
"description": "The \u003ccode\u003eid\u003c/code\u003e object contains information about the channel that\nthe user subscribed to.",
"annotations": {
"required": [
"youtube.subscriptions.insert"
]
}
},
"description": {
"type": "string",
"description": "The subscription's details."
},
"channelTitle": {
"type": "string",
"description": "Channel title for the channel that the subscription belongs to."
},
"publishedAt": {
"type": "string",
"description": "The date and time that the subscription was created. The value is\nspecified in \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat."
},
"title": {
"description": "The subscription's title.",
"type": "string"
}
}
},
"I18nRegion": {
"properties": {
"kind": {
"type": "string",
"default": "youtube#i18nRegion",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#i18nRegion\"\u003c/code\u003e."
},
"snippet": {
"description": "The \u003ccode\u003esnippet\u003c/code\u003e object contains basic details about the i18n\nregion, such as region code and human-readable name.",
"$ref": "I18nRegionSnippet"
},
"id": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the i18n region."
},
"etag": {
"type": "string",
"description": "Etag of this resource."
}
},
"description": "A \u003ccode\u003e\u003cstrong\u003ei18nRegion\u003c/strong\u003e\u003c/code\u003e resource identifies a region where\nYouTube is available.",
"type": "object",
"id": "I18nRegion"
},
"GeoPoint": {
"description": "Geographical coordinates of a point, in WGS84.",
"properties": {
"altitude": {
"description": "Altitude above the reference ellipsoid, in meters.",
"format": "double",
"type": "number"
},
"longitude": {
"format": "double",
"description": "Longitude in degrees.",
"type": "number"
},
"latitude": {
"type": "number",
"description": "Latitude in degrees.",
"format": "double"
}
},
"type": "object",
"id": "GeoPoint"
},
"LiveStreamContentDetails": {
"description": "Detailed settings of a stream.",
"properties": {
"isReusable": {
"type": "boolean",
"description": "Indicates whether the stream is reusable, which means that it\ncan be bound to multiple broadcasts. It is common for\nbroadcasters to reuse the same stream for many different\nbroadcasts if those broadcasts occur at different times.\u003cbr\u003e\u003cbr\u003e\nIf you set this value to \u003ccode\u003efalse\u003c/code\u003e, then the stream\nwill not be reusable, which means that it can only be bound to\none broadcast. Non-reusable streams differ from reusable streams in the\nfollowing ways:\n\u003cul\u003e\n \u003cli\u003eA non-reusable stream can only be bound to one broadcast.\u003c/li\u003e\n \u003cli\u003eA non-reusable stream might be deleted by an automated process\n after the broadcast ends.\u003c/li\u003e\n \u003cli\u003eThe \u003ccode\u003e\u003ca href=\"/youtube/v3/live/docs/liveStreams/list\"\u003e\n liveStreams.list\u003c/a\u003e\u003c/code\u003e method does not list non-reusable streams\n if you call the method and set the \u003ccode\u003emine\u003c/code\u003e parameter to\n \u003ccode\u003etrue\u003c/code\u003e. The only way to use that method to retrieve the\n resource for a non-reusable stream is to use the \u003ccode\u003eid\u003c/code\u003e\n parameter to identify the stream.\u003c/li\u003e\n\u003c/ul\u003e"
},
"closedCaptionsIngestionUrl": {
"type": "string",
"description": "The ingestion URL where the closed captions of this stream are sent."
}
},
"type": "object",
"id": "LiveStreamContentDetails"
},
"LiveChatModeratorSnippet": {
"id": "LiveChatModeratorSnippet",
"type": "object",
"properties": {
"liveChatId": {
"description": "The ID of the live chat this moderator can act on.",
"type": "string"
},
"moderatorDetails": {
"$ref": "ChannelProfileDetails",
"description": "Details about the moderator."
}
}
},
"SubscriptionListResponse": {
"type": "object",
"id": "SubscriptionListResponse",
"properties": {
"nextPageToken": {
"type": "string",
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the next page in the result set."
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"pageInfo": {
"$ref": "PageInfo"
},
"eventId": {
"description": "Serialized EventId of the request which produced this response.",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#subscriptionListResponse\"\u003c/code\u003e.",
"type": "string",
"default": "youtube#subscriptionListResponse"
},
"items": {
"type": "array",
"items": {
"$ref": "Subscription"
},
"description": "A list of subscriptions that match the request criteria."
},
"visitorId": {
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor.",
"type": "string"
},
"prevPageToken": {
"type": "string",
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the previous page in the result set."
},
"tokenPagination": {
"$ref": "TokenPagination"
}
}
},
"VideoSuggestionsTagSuggestion": {
"id": "VideoSuggestionsTagSuggestion",
"description": "A single tag suggestion with it's relevance information.",
"properties": {
"categoryRestricts": {
"type": "array",
"description": "A set of video categories for which the tag is relevant. You can use this\ninformation to display appropriate tag suggestions based on the video\ncategory that the video uploader associates with the video. By default,\ntag suggestions are relevant for all categories if there are no restricts\ndefined for the keyword.",
"items": {
"type": "string"
}
},
"tag": {
"type": "string",
"description": "The keyword tag suggested for the video."
}
},
"type": "object"
},
"LiveChatModerator": {
"type": "object",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#liveChatModerator\"\u003c/code\u003e.",
"type": "string",
"default": "youtube#liveChatModerator"
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"id": {
"type": "string",
"description": "The ID that YouTube assigns to uniquely identify the moderator."
},
"snippet": {
"description": "The \u003ccode\u003esnippet\u003c/code\u003e object contains basic details about the\nmoderator.",
"$ref": "LiveChatModeratorSnippet"
}
},
"description": "A \u003ccode\u003e\u003cstrong\u003eliveChatModerator\u003c/strong\u003e\u003c/code\u003e resource represents a\nmoderator for a YouTube live chat. A chat moderator has the ability to\nban/unban users from a chat, remove message, etc.",
"id": "LiveChatModerator"
},
"LiveStreamConfigurationIssue": {
"id": "LiveStreamConfigurationIssue",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The kind of error happening.",
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"enum": [
"gopSizeOver",
"gopSizeLong",
"gopSizeShort",
"openGop",
"badContainer",
"audioBitrateHigh",
"audioBitrateLow",
"audioSampleRate",
"bitrateHigh",
"bitrateLow",
"audioCodec",
"videoCodec",
"noAudioStream",
"noVideoStream",
"multipleVideoStreams",
"multipleAudioStreams",
"audioTooManyChannels",
"interlacedVideo",
"frameRateHigh",
"resolutionMismatch",
"videoCodecMismatch",
"videoInterlaceMismatch",
"videoProfileMismatch",
"videoBitrateMismatch",
"framerateMismatch",
"gopMismatch",
"audioSampleRateMismatch",
"audioStereoMismatch",
"audioCodecMismatch",
"audioBitrateMismatch",
"videoResolutionSuboptimal",
"videoResolutionUnsupported",
"videoIngestionStarved",
"videoIngestionFasterThanRealtime"
]
},
"reason": {
"type": "string",
"description": "The short-form reason for this issue."
},
"severity": {
"type": "string",
"description": "How severe this issue is to the stream.",
"enum": [
"info",
"warning",
"error"
],
"enumDescriptions": [
"",
"",
""
]
},
"description": {
"type": "string",
"description": "The long-form description of the issue and how to resolve it."
}
}
},
"VideoRatingListResponse": {
"id": "VideoRatingListResponse",
"properties": {
"kind": {
"default": "youtube#videoGetRatingResponse",
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#videoGetRatingResponse\"\u003c/code\u003e."
},
"eventId": {
"description": "Serialized EventId of the request which produced this response.",
"type": "string"
},
"items": {
"type": "array",
"description": "A list of ratings that match the request criteria.",
"items": {
"$ref": "VideoRating"
}
},
"visitorId": {
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor.",
"type": "string"
},
"etag": {
"type": "string",
"description": "Etag of this resource."
}
},
"type": "object"
},
"VideoAbuseReport": {
"properties": {
"language": {
"description": "The language that the content was viewed in.",
"type": "string"
},
"secondaryReasonId": {
"type": "string",
"description": "The specific, or secondary, reason that this content is abusive (if\navailable). The value is an abuse report reason ID that is a valid\nsecondary reason for the primary reason."
},
"comments": {
"description": "Additional comments regarding the abuse report.",
"type": "string"
},
"reasonId": {
"description": "The high-level, or primary, reason that the content is abusive. The value\nis an abuse report reason ID.",
"type": "string"
},
"videoId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the video."
}
},
"id": "VideoAbuseReport",
"type": "object"
},
"SearchResultSnippet": {
"id": "SearchResultSnippet",
"properties": {
"description": {
"type": "string",
"description": "A description of the search result."
},
"thumbnails": {
"$ref": "ThumbnailDetails",
"description": "A map of thumbnail images associated with the search result. For each\nobject in the map, the key is the name of the thumbnail image, and the\nvalue is an object that contains other information about the thumbnail."
},
"title": {
"description": "The title of the search result.",
"type": "string"
},
"publishedAt": {
"type": "string",
"description": "The creation date and time of the resource that the search result\nidentifies. The value is specified in \u003ca\nhref=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat."
},
"liveBroadcastContent": {
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string",
"enum": [
"none",
"upcoming",
"live",
"completed"
],
"description": "It indicates if the resource (video or channel) has upcoming/active live\nbroadcast content. Or it's \"none\" if there is not any upcoming/active\nlive broadcasts."
},
"channelTitle": {
"type": "string",
"description": "The title of the channel that published the resource that the search result\nidentifies."
},
"channelId": {
"type": "string",
"description": "The value that YouTube uses to uniquely identify the channel that\npublished the resource that the search result identifies."
}
},
"type": "object",
"description": "Basic details about a search result, including title, description and\nthumbnails of the item referenced by the search result."
},
"VideoAbuseReportReasonSnippet": {
"description": "Basic details about a video category, such as its localized title.",
"properties": {
"secondaryReasons": {
"items": {
"$ref": "VideoAbuseReportSecondaryReason"
},
"description": "The secondary reasons associated with this reason, if any are available.\n(There might be 0 or more.)",
"type": "array"
},
"label": {
"type": "string",
"description": "The localized label belonging to this abuse report reason."
}
},
"type": "object",
"id": "VideoAbuseReportReasonSnippet"
},
"ThirdPartyLinkSnippet": {
"properties": {
"type": {
"enumDescriptions": [
"",
"A link that is connecting (or about to connect) a channel with a store on a\nmerchandising platform in order to enable retail commerce capabilities for\nthat channel on YouTube."
],
"type": "string",
"description": "Type of the link named after the entities that are being linked.",
"enum": [
"linkUnspecified",
"channelToStoreLink"
]
},
"channelToStoreLink": {
"$ref": "ChannelToStoreLinkDetails",
"description": "Information specific to a link between a channel and a store on a\nmerchandising platform."
}
},
"type": "object",
"description": "Basic information about a third party account link, including its type and\ntype-specific information.",
"id": "ThirdPartyLinkSnippet"
},
"PlaylistItemStatus": {
"properties": {
"privacyStatus": {
"enumDescriptions": [
"",
"",
""
],
"type": "string",
"description": "This resource's privacy status.",
"enum": [
"public",
"unlisted",
"private"
]
}
},
"type": "object",
"id": "PlaylistItemStatus",
"description": "Information about the playlist item's privacy status."
},
"GuideCategory": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#guideCategory\"\u003c/code\u003e.",
"type": "string",
"default": "youtube#guideCategory"
},
"snippet": {
"$ref": "GuideCategorySnippet",
"description": "The \u003ccode\u003esnippet\u003c/code\u003e object contains basic details about the category,\nsuch as its title."
},
"id": {
"description": "The ID that YouTube uses to uniquely identify the guide category.",
"type": "string"
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
}
},
"description": "A \u003ccode\u003e\u003cstrong\u003eguideCategory\u003c/strong\u003e\u003c/code\u003e resource identifies a category\nthat YouTube algorithmically assigns based on a\nchannel's content or other indicators, such as the channel's popularity. The\nlist is similar to \u003ca\nhref=\\\"/youtube/v3/docs/videocategory.html\\\"\u003evideo categories\u003c/a\u003e, with the\ndifference being that a video's uploader can assign a video category but only\nYouTube can assign a channel category.",
"id": "GuideCategory",
"type": "object"
},
"WatchSettings": {
"properties": {
"featuredPlaylistId": {
"description": "An ID that uniquely identifies a playlist that displays next to the video\nplayer.",
"type": "string"
},
"textColor": {
"description": "The background color for the video watch page's branded area.",
"type": "string"
},
"backgroundColor": {
"description": "The text color for the video watch page's branded area.",
"type": "string"
}
},
"type": "object",
"id": "WatchSettings",
"description": "Branding properties for the watch. All deprecated."
},
"InvideoPosition": {
"properties": {
"type": {
"description": "Defines the position type.",
"enum": [
"corner"
],
"type": "string",
"enumDescriptions": [
""
]
},
"cornerPosition": {
"enum": [
"topLeft",
"topRight",
"bottomLeft",
"bottomRight"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string",
"description": "Describes in which corner of the video the visual widget will appear."
}
},
"id": "InvideoPosition",
"description": "Describes the spatial position of a visual widget inside a video. It is a\nunion of various position types, out of which only will be set one.",
"type": "object"
},
"LiveBroadcast": {
"id": "LiveBroadcast",
"description": "A \u003ccode\u003e\u003cstrong\u003eliveBroadcast\u003c/strong\u003e\u003c/code\u003e resource represents an event\nthat will be streamed, via live video, on YouTube.",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID that YouTube assigns to uniquely identify the broadcast."
},
"snippet": {
"description": "The \u003ccode\u003esnippet\u003c/code\u003e object contains basic details about the event,\nincluding its title, description, start time, and end time.",
"$ref": "LiveBroadcastSnippet"
},
"contentDetails": {
"$ref": "LiveBroadcastContentDetails",
"description": "The \u003ccode\u003econtentDetails\u003c/code\u003e object contains information about the\nevent's video content, such as whether the content can be shown in an\nembedded video player or if it will be archived and therefore available\nfor viewing after the event has concluded."
},
"status": {
"description": "The \u003ccode\u003estatus\u003c/code\u003e object contains information about the event's\nstatus.",
"$ref": "LiveBroadcastStatus"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#liveBroadcast\"\u003c/code\u003e.",
"type": "string",
"default": "youtube#liveBroadcast"
},
"statistics": {
"description": "The \u003ccode\u003estatistics\u003c/code\u003e object contains info about the event's current\nstats. These include concurrent viewers and total chat count. Statistics\ncan change (in either direction) during the lifetime of an event.\nStatistics are only returned while the event is live.",
"$ref": "LiveBroadcastStatistics"
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
}
}
},
"I18nLanguage": {
"id": "I18nLanguage",
"properties": {
"kind": {
"default": "youtube#i18nLanguage",
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#i18nLanguage\"\u003c/code\u003e."
},
"snippet": {
"description": "The \u003ccode\u003esnippet\u003c/code\u003e object contains basic details about the i18n\nlanguage, such as language code and human-readable name.",
"$ref": "I18nLanguageSnippet"
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"id": {
"description": "The ID that YouTube uses to uniquely identify the i18n language.",
"type": "string"
}
},
"type": "object",
"description": "An \u003ccode\u003e\u003cstrong\u003ei18nLanguage\u003c/strong\u003e\u003c/code\u003e resource identifies a UI\nlanguage currently supported by YouTube."
},
"TokenPagination": {
"description": "Stub token pagination template to suppress results.",
"id": "TokenPagination",
"properties": {},
"type": "object"
},
"LocalizedString": {
"properties": {
"language": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object",
"id": "LocalizedString"
},
"InvideoTiming": {
"properties": {
"type": {
"enumDescriptions": [
"",
""
],
"description": "Describes a timing type. If the value is \u003ccode\u003eoffsetFromStart\u003c/code\u003e, then\nthe \u003ccode\u003eoffsetMs\u003c/code\u003e field represents an offset from the start of the\nvideo. If the value is \u003ccode\u003eoffsetFromEnd\u003c/code\u003e, then the\n\u003ccode\u003eoffsetMs\u003c/code\u003e field represents an offset from the end of the video.",
"enum": [
"offsetFromStart",
"offsetFromEnd"
],
"type": "string"
},
"durationMs": {
"type": "string",
"description": "Defines the duration in milliseconds for which the promotion should be\ndisplayed. If missing, the client should use the default.",
"format": "uint64"
},
"offsetMs": {
"description": "Defines the time at which the promotion will appear. Depending on the value\nof \u003ccode\u003etype\u003c/code\u003e the value of the \u003ccode\u003eoffsetMs\u003c/code\u003e field will\nrepresent a time offset from the start or from the end of the video,\nexpressed in milliseconds.",
"format": "uint64",
"type": "string"
}
},
"type": "object",
"id": "InvideoTiming",
"description": "Describes a temporal position of a visual widget inside a video."
},
"LiveBroadcastStatus": {
"properties": {
"recordingStatus": {
"type": "string",
"enumDescriptions": [
"No value or the value is unknown.",
"The recording has not yet been started.",
"The recording is currently on.",
"The recording is completed, and cannot be started again."
],
"enum": [
"liveBroadcastRecordingStatusUnspecified",
"notRecording",
"recording",
"recorded"
],
"description": "The broadcast's recording status."
},
"selfDeclaredMadeForKids": {
"description": "This field will be set to True if the creator declares the broadcast to be\nkids only: go/live-cw-work.",
"type": "boolean"
},
"lifeCycleStatus": {
"type": "string",
"description": "The broadcast's status. The status can be updated using the API's\n\u003ccode\u003e\u003ca\nhref=\"/youtube/v3/live/docs/liveBroadcasts/transition\"\n\u003eliveBroadcasts.transition\u003c/a\u003e\u003c/code\u003e method.",
"enumDescriptions": [
"No value or the value is unknown.",
"Incomplete settings, but otherwise valid",
"Complete settings",
"Visible only to partner, may need special UI treatment",
"Viper is recording; this means the \"clock\" is running",
"The broadcast is finished.",
"This broadcast was removed by admin action",
"Transition into TESTING has been requested",
"Transition into LIVE has been requested"
],
"enum": [
"lifeCycleStatusUnspecified",
"created",
"ready",
"testing",
"live",
"complete",
"revoked",
"testStarting",
"liveStarting"
]
},
"privacyStatus": {
"enumDescriptions": [
"",
"",
""
],
"description": "The broadcast's privacy status. Note that the broadcast represents\nexactly one YouTube video, so the privacy settings are identical to\nthose supported for videos. In addition, you can set this field by\nmodifying the broadcast resource or by setting the\n\u003ccode\u003e\u003ca\nhref=\"/youtube/v3/docs/videos#status.privacyStatus\"\n\u003eprivacyStatus\u003c/a\u003e\u003c/code\u003e\nfield of the corresponding video resource.",
"type": "string",
"enum": [
"public",
"unlisted",
"private"
]
},
"liveBroadcastPriority": {
"description": "Priority of the live broadcast event (internal state).",
"type": "string",
"enumDescriptions": [
"",
"Low priority broadcast: for low view count HoAs or other\nlow priority broadcasts.",
"Normal priority broadcast: for regular HoAs and broadcasts.",
"High priority broadcast: for high profile HoAs, like PixelCorp ones."
],
"enum": [
"liveBroadcastPriorityUnspecified",
"low",
"normal",
"high"
]
},
"madeForKids": {
"type": "boolean",
"description": "Whether the broadcast is made for kids or not, decided by YouTube instead\nof the creator. This field is read only."
}
},
"type": "object",
"id": "LiveBroadcastStatus",
"description": "Live broadcast state."
},
"ChannelSectionSnippet": {
"type": "object",
"id": "ChannelSectionSnippet",
"properties": {
"channelId": {
"description": "The ID that YouTube uses to uniquely identify the channel that published\nthe channel section.",
"type": "string"
},
"defaultLanguage": {
"description": "The language of the channel section's default title and description.",
"type": "string"
},
"type": {
"description": "The type of the channel section.",
"type": "string",
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"enum": [
"channelsectionTypeUnspecified",
"singlePlaylist",
"multiplePlaylists",
"popularUploads",
"recentUploads",
"likes",
"allPlaylists",
"likedPlaylists",
"recentPosts",
"recentActivity",
"liveEvents",
"upcomingEvents",
"completedEvents",
"multipleChannels",
"postedVideos",
"postedPlaylists",
"subscriptions"
]
},
"position": {
"format": "uint32",
"type": "integer",
"description": "The position of the channel section in the channel."
},
"title": {
"description": "The channel section's title for multiple_playlists and multiple_channels.",
"type": "string"
},
"localized": {
"description": "Localized title, read-only.",
"$ref": "ChannelSectionLocalization"
},
"style": {
"type": "string",
"enumDescriptions": [
"",
"",
""
],
"description": "The style of the channel section.",
"enum": [
"channelsectionStyleUnspecified",
"horizontalRow",
"verticalList"
]
}
},
"description": "Basic details about a channel section, including title, style and position."
},
"VideoAbuseReportReasonListResponse": {
"properties": {
"items": {
"description": "A list of valid abuse reasons that are used with `video.ReportAbuse`.",
"items": {
"$ref": "VideoAbuseReportReason"
},
"type": "array"
},
"visitorId": {
"type": "string",
"description": "The `visitorId` identifies the visitor."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string\n`\"youtube#videoAbuseReportReasonListResponse\"`.",
"type": "string",
"default": "youtube#videoAbuseReportReasonListResponse"
},
"etag": {
"type": "string",
"description": "Etag of this resource."
},
"eventId": {
"type": "string",
"description": "Serialized EventId of the request which produced this response."
}
},
"id": "VideoAbuseReportReasonListResponse",
"type": "object"
},
"ResourceId": {
"description": "A resource id is a generic reference that points to another YouTube resource.",
"id": "ResourceId",
"properties": {
"playlistId": {
"description": "The ID that YouTube uses to uniquely identify the referred resource, if\nthat resource is a playlist. This property is only present if the\n\u003ccode\u003eresourceId.kind\u003c/code\u003e value is \u003ccode\u003eyoutube#playlist\u003c/code\u003e.",
"type": "string"
},
"channelId": {
"description": "The ID that YouTube uses to uniquely identify the referred resource, if\nthat resource is a channel. This property is only present if the\n\u003ccode\u003eresourceId.kind\u003c/code\u003e value is \u003ccode\u003eyoutube#channel\u003c/code\u003e.",
"type": "string"
},
"kind": {
"description": "The type of the API resource.",
"type": "string"
},
"videoId": {
"description": "The ID that YouTube uses to uniquely identify the referred resource, if\nthat resource is a video. This property is only present if the\n\u003ccode\u003eresourceId.kind\u003c/code\u003e value is \u003ccode\u003eyoutube#video\u003c/code\u003e.",
"type": "string"
}
},
"type": "object"
},
"VideoAbuseReportSecondaryReason": {
"id": "VideoAbuseReportSecondaryReason",
"type": "object",
"properties": {
"id": {
"description": "The ID of this abuse report secondary reason.",
"type": "string"
},
"label": {
"type": "string",
"description": "The localized label for this abuse report secondary reason."
}
}
},
"LiveStream": {
"type": "object",
"id": "LiveStream",
"properties": {
"snippet": {
"$ref": "LiveStreamSnippet",
"description": "The \u003ccode\u003esnippet\u003c/code\u003e object contains basic details about the\nstream, including its channel, title, and description."
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"status": {
"$ref": "LiveStreamStatus",
"description": "The \u003ccode\u003estatus\u003c/code\u003e object contains information about\nlive stream's status."
},
"contentDetails": {
"$ref": "LiveStreamContentDetails",
"description": "The \u003ccode\u003econtent_details\u003c/code\u003e object contains information about the\nstream, including the closed captions ingestion URL."
},
"id": {
"description": "The ID that YouTube assigns to uniquely identify the stream.",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#liveStream\"\u003c/code\u003e.",
"default": "youtube#liveStream",
"type": "string"
},
"cdn": {
"description": "The \u003ccode\u003ecdn\u003c/code\u003e object defines the live stream's content delivery\nnetwork (CDN) settings. These settings provide details about the manner\nin which you stream your content to YouTube.",
"$ref": "CdnSettings"
}
},
"description": "A live stream describes a live ingestion point."
},
"LiveBroadcastListResponse": {
"id": "LiveBroadcastListResponse",
"properties": {
"eventId": {
"description": "Serialized EventId of the request which produced this response.",
"type": "string"
},
"pageInfo": {
"$ref": "PageInfo",
"description": "General pagination information."
},
"nextPageToken": {
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the next page in the result set.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#liveBroadcastListResponse\"\u003c/code\u003e.",
"default": "youtube#liveBroadcastListResponse"
},
"prevPageToken": {
"type": "string",
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the previous page in the result set."
},
"visitorId": {
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor.",
"type": "string"
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"tokenPagination": {
"$ref": "TokenPagination"
},
"items": {
"description": "A list of broadcasts that match the request criteria.",
"type": "array",
"items": {
"$ref": "LiveBroadcast"
}
}
},
"type": "object"
},
"PlaylistContentDetails": {
"properties": {
"itemCount": {
"description": "The number of videos in the playlist.",
"type": "integer",
"format": "uint32"
}
},
"id": "PlaylistContentDetails",
"type": "object"
},
"SuperStickerMetadata": {
"properties": {
"altText": {
"type": "string",
"description": "Internationalized alt text that describes the sticker image and any\nanimation associated with it."
},
"stickerId": {
"description": "Unique identifier of the Super Sticker. This is a shorter form of the\nalt_text that includes pack name and a recognizable characteristic of the\nsticker.",
"type": "string"
},
"altTextLanguage": {
"description": "Specifies the localization language in which the alt text is returned.",
"type": "string"
}
},
"type": "object",
"id": "SuperStickerMetadata"
},
"MemberListResponse": {
"id": "MemberListResponse",
"properties": {
"nextPageToken": {
"type": "string",
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the next page in the result set."
},
"tokenPagination": {
"$ref": "TokenPagination"
},
"eventId": {
"description": "Serialized EventId of the request which produced this response.",
"type": "string"
},
"items": {
"items": {
"$ref": "Member"
},
"description": "A list of members that match the request criteria.",
"type": "array"
},
"kind": {
"default": "youtube#memberListResponse",
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#memberListResponse\"\u003c/code\u003e."
},
"pageInfo": {
"$ref": "PageInfo"
},
"visitorId": {
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor.",
"type": "string"
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
}
},
"type": "object"
},
"VideoCategoryListResponse": {
"id": "VideoCategoryListResponse",
"properties": {
"pageInfo": {
"$ref": "PageInfo",
"description": "General pagination information."
},
"kind": {
"default": "youtube#videoCategoryListResponse",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#videoCategoryListResponse\"\u003c/code\u003e.",
"type": "string"
},
"etag": {
"type": "string",
"description": "Etag of this resource."
},
"tokenPagination": {
"$ref": "TokenPagination"
},
"eventId": {
"description": "Serialized EventId of the request which produced this response.",
"type": "string"
},
"nextPageToken": {
"type": "string",
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the next page in the result set."
},
"items": {
"description": "A list of video categories that can be associated with YouTube videos. In\nthis map, the video category ID is the map key, and its value is the\ncorresponding \u003ccode\u003evideoCategory\u003c/code\u003e resource.",
"type": "array",
"items": {
"$ref": "VideoCategory"
}
},
"visitorId": {
"type": "string",
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor."
},
"prevPageToken": {
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the previous page in the result set.",
"type": "string"
}
},
"type": "object"
},
"CommentSnippet": {
"id": "CommentSnippet",
"properties": {
"moderationStatus": {
"description": "The comment's moderation status. Will not be set if the comments were\nrequested through the id filter.",
"type": "string",
"enum": [
"published",
"heldForReview",
"likelySpam",
"rejected"
],
"enumDescriptions": [
"",
"",
"",
""
]
},
"updatedAt": {
"description": "The date and time when was last updated . The value is\nspecified in \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat.",
"type": "string"
},
"authorChannelUrl": {
"description": "Link to the author's YouTube channel, if any.",
"type": "string"
},
"parentId": {
"type": "string",
"description": "The unique id of the parent comment, only set for replies."
},
"channelId": {
"description": "The id of the corresponding YouTube channel. In case of a channel comment\nthis is the channel the comment refers to. In case of a video comment\nit's the video's channel.",
"type": "string"
},
"textDisplay": {
"description": "The comment's text. The format is either plain text or HTML dependent on\nwhat has been requested. Even the plain text representation may differ\nfrom the text originally posted in that it may replace video links with\nvideo titles etc.",
"type": "string"
},
"viewerRating": {
"type": "string",
"description": "The rating the viewer has given to this comment. For the time being this\nwill never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.\nThis may change in the future.",
"enum": [
"none",
"like",
"dislike"
],
"enumDescriptions": [
"",
"",
""
]
},
"videoId": {
"description": "The ID of the video the comment refers to, if any.",
"type": "string"
},
"authorDisplayName": {
"description": "The name of the user who posted the comment.",
"type": "string"
},
"authorChannelId": {
"$ref": "CommentSnippetAuthorChannelId"
},
"likeCount": {
"description": "The total number of likes this comment has received.",
"type": "integer",
"format": "uint32"
},
"publishedAt": {
"type": "string",
"description": "The date and time when the comment was orignally published. The value is\nspecified in \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat."
},
"textOriginal": {
"type": "string",
"description": "The comment's original raw text as initially posted or last updated. The\noriginal text will only be returned if it is accessible to the viewer,\nwhich is only guaranteed if the viewer is the comment's author."
},
"canRate": {
"description": "Whether the current viewer can rate this comment.",
"type": "boolean"
},
"authorProfileImageUrl": {
"description": "The URL for the avatar of the user who posted the comment.",
"type": "string"
}
},
"type": "object",
"description": "Basic details about a comment, such as its author and text."
},
"LiveChatMessageSnippet": {
"type": "object",
"properties": {
"messageRetractedDetails": {
"$ref": "LiveChatMessageRetractedDetails"
},
"hasDisplayContent": {
"type": "boolean",
"description": "Whether the message has display content that should be displayed to users."
},
"liveChatId": {
"type": "string"
},
"userBannedDetails": {
"$ref": "LiveChatUserBannedMessageDetails"
},
"messageDeletedDetails": {
"$ref": "LiveChatMessageDeletedDetails"
},
"fanFundingEventDetails": {
"description": "Details about the funding event, this is only set if the type is\n'fanFundingEvent'.",
"$ref": "LiveChatFanFundingEventDetails"
},
"type": {
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string",
"enum": [
"invalidType",
"textMessageEvent",
"tombstone",
"fanFundingEvent",
"chatEndedEvent",
"sponsorOnlyModeStartedEvent",
"sponsorOnlyModeEndedEvent",
"newSponsorEvent",
"messageDeletedEvent",
"messageRetractedEvent",
"userBannedEvent",
"superChatEvent",
"superStickerEvent"
],
"description": "The type of message, this will always be present, it determines the\ncontents of the message as well as which fields will be present."
},
"textMessageDetails": {
"description": "Details about the text message, this is only set if the type is\n'textMessageEvent'.",
"$ref": "LiveChatTextMessageDetails"
},
"authorChannelId": {
"type": "string",
"description": "The ID of the user that authored this message, this field is not always\nfilled.\ntextMessageEvent - the user that wrote the message\nfanFundingEvent - the user that funded the broadcast\nnewSponsorEvent - the user that just became a sponsor\nmessageDeletedEvent - the moderator that took the action\nmessageRetractedEvent - the author that retracted their message\nuserBannedEvent - the moderator that took the action\nsuperChatEvent - the user that made the purchase"
},
"superChatDetails": {
"description": "Details about the Super Chat event, this is only set if the type is\n'superChatEvent'.",
"$ref": "LiveChatSuperChatDetails"
},
"publishedAt": {
"description": "The date and time when the message was orignally published. The value is\nspecified in \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat.",
"type": "string"
},
"superStickerDetails": {
"$ref": "LiveChatSuperStickerDetails",
"description": "Details about the Super Sticker event, this is only set if the type is\n'superStickerEvent'."
},
"displayMessage": {
"description": "Contains a string that can be displayed to the user.\nIf this field is not present the message is silent, at the moment only\nmessages of type TOMBSTONE and CHAT_ENDED_EVENT are silent.",
"type": "string"
}
},
"id": "LiveChatMessageSnippet"
},
"ChannelBannerResource": {
"properties": {
"etag": {
"type": "string"
},
"url": {
"type": "string",
"description": "The URL of this banner image."
},
"kind": {
"default": "youtube#channelBannerResource",
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#channelBannerResource\"\u003c/code\u003e."
}
},
"type": "object",
"description": "A channel banner returned as the response to a channel_banner.insert call.",
"id": "ChannelBannerResource"
},
"SearchResult": {
"type": "object",
"properties": {
"snippet": {
"description": "The \u003ccode\u003esnippet\u003c/code\u003e object contains basic details about a search\nresult, such as its title or description. For example, if the search result\nis a video, then the title will be the\nvideo's title and the description will be the video's description.",
"$ref": "SearchResultSnippet"
},
"id": {
"description": "The \u003ccode\u003eid\u003c/code\u003e object contains information that can be used to\nuniquely identify the resource that matches the search request.",
"$ref": "ResourceId"
},
"kind": {
"default": "youtube#searchResult",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#searchResult\"\u003c/code\u003e.",
"type": "string"
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
}
},
"id": "SearchResult",
"description": "A search result contains information about a YouTube video, channel, or\nplaylist that matches the search parameters specified in an API request.\nWhile a search result points to a uniquely identifiable resource, like a\nvideo, it does not have its own persistent data."
},
"AbuseType": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"id": "AbuseType"
},
"MembershipsLevelSnippet": {
"id": "MembershipsLevelSnippet",
"type": "object",
"properties": {
"levelDetails": {
"description": "Details about the pricing level.",
"$ref": "LevelDetails"
},
"creatorChannelId": {
"description": "The id of the channel that's offering channel memberships.",
"type": "string"
}
}
},
"PlaylistItemContentDetails": {
"type": "object",
"properties": {
"endAt": {
"description": "The time, measured in seconds from the start of the video, when the video\nshould stop playing. (The playlist owner can specify the times when the\nvideo should start and stop playing when the video is played in the context\nof the playlist.) By default, assume that the \u003ccode\u003evideo.endTime\u003c/code\u003e is\nthe end of the video.",
"type": "string"
},
"videoPublishedAt": {
"type": "string",
"description": "The date and time that the video was published to YouTube. The value is\nspecified in \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat."
},
"startAt": {
"type": "string",
"description": "The time, measured in seconds from the start of the video, when the video\nshould start playing. (The playlist owner can specify the times when the\nvideo should start and stop playing when the video is played in the context\nof the playlist.) The default value is \u003ccode\u003e0\u003c/code\u003e."
},
"note": {
"description": "A user-generated note for this item.",
"type": "string"
},
"videoId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify a video. To \u003ca\nhref=\"/youtube/v3/docs/video/list.html\"\u003eretrieve the \u003ccode\u003evideo\u003c/code\u003e\nresource\u003c/a\u003e, set the \u003ccode\u003eid\u003c/code\u003e query parameter to this value in your\nAPI request."
}
},
"id": "PlaylistItemContentDetails"
},
"PromotedItem": {
"properties": {
"promotedByContentOwner": {
"description": "If true, the content owner's name will be used when displaying the\npromotion. This field can only be set when the update is made on behalf of\nthe content owner.",
"type": "boolean"
},
"customMessage": {
"description": "A custom message to display for this promotion. This field is currently\nignored unless the promoted item is a website.",
"type": "string"
},
"timing": {
"description": "The temporal position within the video where the promoted item will be\ndisplayed. If present, it overrides the default timing.",
"$ref": "InvideoTiming"
},
"id": {
"description": "Identifies the promoted item.",
"$ref": "PromotedItemId"
}
},
"type": "object",
"id": "PromotedItem",
"description": "Describes a single promoted item."
},
"VideoAgeGating": {
"properties": {
"videoGameRating": {
"enumDescriptions": [
"",
"",
"",
""
],
"enum": [
"anyone",
"m15Plus",
"m16Plus",
"m17Plus"
],
"type": "string",
"description": "Video game rating, if any."
},
"restricted": {
"description": "Age-restricted trailers. For redband trailers and adult-rated video-games.\nOnly users aged 18+ can view the content. The the field is\n\u003ccode\u003etrue\u003c/code\u003e the content is restricted to viewers aged 18+. Otherwise\nThe field won't be present.",
"type": "boolean"
},
"alcoholContent": {
"description": "Indicates whether or not the video has alcoholic beverage content. Only\nusers of legal purchasing age in a particular country, as identified by\nICAP, can view the content.",
"type": "boolean"
}
},
"type": "object",
"id": "VideoAgeGating"
},
"LocalizedProperty": {
"type": "object",
"properties": {
"default": {
"type": "string"
},
"localized": {
"type": "array",
"items": {
"$ref": "LocalizedString"
}
},
"defaultLanguage": {
"$ref": "LanguageTag",
"description": "The language of the default property."
}
},
"id": "LocalizedProperty"
},
"ChannelTopicDetails": {
"properties": {
"topicIds": {
"description": "A list of Freebase topic IDs associated with the channel. You can retrieve\ninformation about each topic using the \u003ca\nhref=\"http://wiki.freebase.com/wiki/Topic_API\"\u003eFreebase Topic API\u003c/a\u003e.",
"items": {
"type": "string"
},
"type": "array"
},
"topicCategories": {
"type": "array",
"description": "A list of Wikipedia URLs that describe the channel's content.",
"items": {
"type": "string"
}
}
},
"description": "Freebase topic information related to the channel.",
"type": "object",
"id": "ChannelTopicDetails"
},
"SuperChatEventSnippet": {
"id": "SuperChatEventSnippet",
"type": "object",
"properties": {
"supporterDetails": {
"$ref": "ChannelProfileDetails",
"description": "Details about the supporter."
},
"amountMicros": {
"format": "uint64",
"description": "The purchase amount, in micros of the purchase currency. e.g., 1 is\nrepresented as 1000000.",
"type": "string"
},
"currency": {
"type": "string",
"description": "The currency in which the purchase was made. ISO 4217."
},
"superStickerMetadata": {
"description": "If this event is a Super Sticker event, this field will contain metadata\nabout the Super Sticker.",
"$ref": "SuperStickerMetadata"
},
"createdAt": {
"description": "The date and time when the event occurred. The value is\nspecified in \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat.",
"type": "string"
},
"commentText": {
"type": "string",
"description": "The text contents of the comment left by the user."
},
"channelId": {
"type": "string",
"description": "Channel id where the event occurred."
},
"messageType": {
"type": "integer",
"format": "uint32",
"description": "The tier for the paid message, which is based on the amount of money spent\nto purchase the message."
},
"isSuperStickerEvent": {
"type": "boolean",
"description": "True if this event is a Super Sticker event."
},
"displayString": {
"type": "string",
"description": "A rendered string that displays the purchase amount and currency\n(e.g., \"$1.00\"). The string is rendered for the given language."
}
}
},
"InvideoPromotion": {
"description": "Describes an invideo promotion campaign consisting of multiple promoted\nitems. A campaign belongs to a single channel_id.",
"type": "object",
"properties": {
"defaultTiming": {
"$ref": "InvideoTiming",
"description": "The default temporal position within the video where the promoted item will\nbe displayed. Can be overridden by more specific timing in the item."
},
"items": {
"description": "List of promoted items in decreasing priority.",
"items": {
"$ref": "PromotedItem"
},
"type": "array"
},
"useSmartTiming": {
"type": "boolean",
"description": "Indicates whether the channel's promotional campaign uses \"smart timing.\"\nThis feature attempts to show promotions at a point in the video when they\nare more likely to be clicked and less likely to disrupt the viewing\nexperience. This feature also picks up a single promotion to show on each\nvideo."
},
"position": {
"$ref": "InvideoPosition",
"description": "The spatial position within the video where the promoted item will be\ndisplayed."
}
},
"id": "InvideoPromotion"
},
"ThumbnailDetails": {
"type": "object",
"properties": {
"default": {
"description": "The default image for this resource.",
"$ref": "Thumbnail"
},
"medium": {
"$ref": "Thumbnail",
"description": "The medium quality image for this resource."
},
"standard": {
"$ref": "Thumbnail",
"description": "The standard quality image for this resource."
},
"high": {
"$ref": "Thumbnail",
"description": "The high quality image for this resource."
},
"maxres": {
"description": "The maximum resolution quality image for this resource.",
"$ref": "Thumbnail"
}
},
"id": "ThumbnailDetails",
"description": "Internal representation of thumbnails for a YouTube resource."
},
"ChannelSnippet": {
"properties": {
"localized": {
"description": "Localized title and description, read-only.",
"$ref": "ChannelLocalization"
},
"publishedAt": {
"type": "string",
"description": "The date and time that the channel was created. The value is specified in\n\u003c a href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat."
},
"title": {
"description": "The channel's title.",
"type": "string"
},
"customUrl": {
"type": "string",
"description": "The custom url of the channel."
},
"defaultLanguage": {
"type": "string",
"description": "The language of the channel's default title and description."
},
"country": {
"description": "The country of the channel.",
"type": "string"
},
"thumbnails": {
"$ref": "ThumbnailDetails",
"description": "A map of thumbnail images associated with the channel. For each object in\nthe map, the key is the name of the thumbnail image, and the value is an\nobject that contains other information about the thumbnail.\u003cbr\u003e\u003cbr\u003e When\ndisplaying thumbnails in your application, make sure that your code uses\nthe image URLs exactly as they are returned in API responses. For example,\nyour application should not use the \u003ccode\u003ehttp\u003c/code\u003e domain instead of the\n\u003ccode\u003ehttps\u003c/code\u003e domain in a URL returned in an API response.\u003cbr\u003e\u003cbr\u003e\nBeginning in July 2018, channel thumbnail URLs will only be available in\nthe \u003ccode\u003ehttps\u003c/code\u003e domain, which is how the URLs appear in API\nresponses. After that time, you might see broken images in your application\nif it tries to load YouTube images from the \u003ccode\u003ehttp\u003c/code\u003e domain."
},
"description": {
"description": "The description of the channel.",
"type": "string"
}
},
"type": "object",
"id": "ChannelSnippet",
"description": "Basic details about a channel, including title, description and thumbnails."
},
"Activity": {
"id": "Activity",
"description": "An \u003ccode\u003e\u003cstrong\u003eactivity\u003c/strong\u003e\u003c/code\u003e resource contains\ninformation about an action that a particular channel, or user, has\ntaken on YouTube.The actions reported in activity feeds include rating\na video, sharing a video, marking a video as a favorite, commenting on\na video, uploading a video, and so forth. Each \u003ccode\u003eactivity\u003c/code\u003e\nresource identifies the type of action, the channel associated with\nthe action, and the resource(s) associated with the action, such as\nthe video that was rated or uploaded.",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#activity\"\u003c/code\u003e.",
"type": "string",
"default": "youtube#activity"
},
"contentDetails": {
"$ref": "ActivityContentDetails",
"description": "The \u003ccode\u003econtentDetails\u003c/code\u003e object contains information about the\ncontent associated with the activity. For example, if the\n\u003ccode\u003esnippet.type\u003c/code\u003e value is \u003ccode\u003evideoRated\u003c/code\u003e, then the\n\u003ccode\u003econtentDetails\u003c/code\u003e object's content identifies the rated video."
},
"etag": {
"description": "Etag of this resource",
"type": "string"
},
"snippet": {
"description": "The \u003ccode\u003esnippet\u003c/code\u003e object contains basic details about the\nactivity, including the activity's type and group ID.",
"$ref": "ActivitySnippet"
},
"id": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the activity."
}
},
"type": "object"
},
"Caption": {
"properties": {
"id": {
"type": "string",
"annotations": {
"required": [
"youtube.captions.update"
]
},
"description": "The ID that YouTube uses to uniquely identify the caption track."
},
"snippet": {
"$ref": "CaptionSnippet",
"description": "The \u003ccode\u003esnippet\u003c/code\u003e object contains basic details about the caption."
},
"kind": {
"type": "string",
"default": "youtube#caption",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#caption\"\u003c/code\u003e."
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
}
},
"type": "object",
"id": "Caption",
"description": "A \u003ccode\u003e\u003cstrong\u003ecaption\u003c/strong\u003e\u003c/code\u003e resource represents a YouTube\ncaption track. A caption track is associated with exactly one YouTube\nvideo."
},
"VideoContentDetailsRegionRestriction": {
"properties": {
"allowed": {
"items": {
"type": "string"
},
"description": "A list of region codes that identify countries where the video is\nviewable. If this property is present and a country is not listed\nin its value, then the video is blocked from appearing in that\ncountry. If this property is present and contains an empty list,\nthe video is blocked in all countries.",
"type": "array"
},
"blocked": {
"description": "A list of region codes that identify countries where the video is\nblocked. If this property is present and a country is not listed in\nits value, then the video is viewable in that country. If this\nproperty is present and contains an empty list, the video is\nviewable in all countries.",
"items": {
"type": "string"
},
"type": "array"
}
},
"description": "DEPRECATED Region restriction of the video.",
"type": "object",
"id": "VideoContentDetailsRegionRestriction"
},
"ChannelConversionPing": {
"description": "Pings that the app shall fire (authenticated by biscotti cookie). Each ping\nhas a context, in which the app must fire the ping, and a url identifying the\nping.",
"type": "object",
"properties": {
"conversionUrl": {
"type": "string",
"description": "The url (without the schema) that the player shall send the ping to.\nIt's at caller's descretion to decide which schema to use (http vs https)\nExample of a returned url: //googleads.g.doubleclick.net/pagead/\nviewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D\ncview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default\nThe caller must append biscotti authentication (ms param in case of\nmobile, for example) to this ping."
},
"context": {
"enum": [
"subscribe",
"unsubscribe",
"cview"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string",
"description": "Defines the context of the ping."
}
},
"id": "ChannelConversionPing"
},
"PlaylistStatus": {
"id": "PlaylistStatus",
"properties": {
"privacyStatus": {
"enumDescriptions": [
"",
"",
""
],
"type": "string",
"enum": [
"public",
"unlisted",
"private"
],
"description": "The playlist's privacy status."
}
},
"type": "object"
},
"RelatedEntity": {
"properties": {
"entity": {
"$ref": "Entity"
}
},
"type": "object",
"id": "RelatedEntity"
},
"ChannelSectionLocalization": {
"type": "object",
"id": "ChannelSectionLocalization",
"properties": {
"title": {
"type": "string",
"description": "The localized strings for channel section's title."
}
},
"description": "ChannelSection localization setting"
},
"LiveChatSuperChatDetails": {
"id": "LiveChatSuperChatDetails",
"type": "object",
"properties": {
"amountDisplayString": {
"description": "A rendered string that displays the fund amount and currency to the user.",
"type": "string"
},
"currency": {
"description": "The currency in which the purchase was made.",
"type": "string"
},
"amountMicros": {
"type": "string",
"format": "uint64",
"description": "The amount purchased by the user, in micros (1,750,000 micros = 1.75)."
},
"tier": {
"description": "The tier in which the amount belongs. Lower amounts belong to lower\ntiers. The lowest tier is \u003ccode\u003e1\u003c/code\u003e.",
"format": "uint32",
"type": "integer"
},
"userComment": {
"type": "string",
"description": "The comment added by the user to this Super Chat event."
}
}
},
"Playlist": {
"type": "object",
"description": "A \u003ccode\u003e\u003cstrong\u003eplaylist\u003c/strong\u003e\u003c/code\u003e resource represents a YouTube\nplaylist. A playlist is a collection of videos that can be viewed\nsequentially and shared with other users. A playlist can contain up to\n200 videos, and YouTube does not limit the number of playlists that\neach user creates. By default, playlists are publicly visible to other\nusers, but playlists can be public or private. \u003cbr/\u003e\u003cbr/\u003e YouTube\nalso uses playlists to identify special collections of videos for a\nchannel, such as:\n \u003cul\u003e\n \u003cli\u003euploaded videos\u003c/li\u003e\n \u003cli\u003efavorite videos\u003c/li\u003e\n \u003cli\u003epositively rated (liked) videos\u003c/li\u003e\n \u003cli\u003ewatch history\u003c/li\u003e\n \u003cli\u003ewatch later\u003c/li\u003e\n \u003c/ul\u003e\nTo be more specific, these lists are associated with a channel, which\nis a collection of a person, group, or company's videos, playlists,\nand other YouTube information. You can retrieve the playlist IDs for\neach of these lists from the \u003ccode\u003e\u003ca\nhref=\\\"/youtube/v3/docs/channels\\\"\u003e channel resource\u003c/a\u003e\u003c/code\u003e for a\ngiven channel.\u003cbr/\u003e\u003cbr/\u003e You can then use the \u003ccode\u003e \u003ca\nhref=\\\"/youtube/v3/docs/playlistItems/list\\\"\u003e\nplaylistItems.list\u003c/a\u003e\u003c/code\u003e method to retrieve any of those\nlists. You can also add or remove items from those lists by calling\nthe \u003ccode\u003e \u003ca href=\\\"/youtube/v3/docs/playlistItems/insert\\\"\u003e\nplaylistItems.insert\u003c/a\u003e\u003c/code\u003e and \u003ccode\u003e \u003ca\nhref=\\\"/youtube/v3/docs/playlistItems/delete\\\"\u003e\nplaylistItems.delete\u003c/a\u003e\u003c/code\u003e methods.",
"id": "Playlist",
"properties": {
"contentDetails": {
"description": "The \u003ccode\u003econtentDetails\u003c/code\u003e object contains information like\nvideo count.",
"$ref": "PlaylistContentDetails"
},
"localizations": {
"type": "object",
"additionalProperties": {
"$ref": "PlaylistLocalization"
},
"description": "Localizations for different languages"
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"status": {
"$ref": "PlaylistStatus",
"description": "The \u003ccode\u003estatus\u003c/code\u003e object contains status information for the\nplaylist."
},
"player": {
"$ref": "PlaylistPlayer",
"description": "The \u003ccode\u003eplayer\u003c/code\u003e object contains information that you would use\nto play the playlist in an embedded player."
},
"id": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the playlist."
},
"snippet": {
"$ref": "PlaylistSnippet",
"description": "The \u003ccode\u003esnippet\u003c/code\u003e object contains basic details about the\nplaylist, such as its title and description."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#playlist\"\u003c/code\u003e.",
"default": "youtube#playlist"
}
}
},
"CaptionSnippet": {
"properties": {
"failureReason": {
"type": "string",
"description": "The reason that YouTube failed to process the caption track. This\nproperty is only present if the \u003ccode\u003e\u003ca href=\"#state\"\u003estate\u003c/a\u003e\u003c/code\u003e\nproperty's value is \u003ccode\u003efailed\u003c/code\u003e.",
"enum": [
"unknownFormat",
"unsupportedFormat",
"processingFailed"
],
"enumDescriptions": [
"",
"",
""
]
},
"isDraft": {
"type": "boolean",
"description": "Indicates whether the caption track is a draft. If the value is\n\u003ccode\u003etrue\u003c/code\u003e, then the track is not publicly visible.\nThe default value is \u003ccode\u003efalse\u003c/code\u003e.\n@mutable youtube.captions.insert youtube.captions.update"
},
"isEasyReader": {
"type": "boolean",
"description": "Indicates whether caption track is formatted for \"easy reader,\"\nmeaning it is at a third-grade level for language learners.\nThe default value is \u003ccode\u003efalse\u003c/code\u003e."
},
"audioTrackType": {
"type": "string",
"description": "The type of audio track associated with the caption track.",
"enum": [
"unknown",
"primary",
"commentary",
"descriptive"
],
"enumDescriptions": [
"",
"",
"",
""
]
},
"trackKind": {
"description": "The caption track's type.",
"enumDescriptions": [
"",
"",
""
],
"type": "string",
"enum": [
"standard",
"ASR",
"forced"
]
},
"status": {
"description": "The caption track's status.",
"enum": [
"serving",
"syncing",
"failed"
],
"type": "string",
"enumDescriptions": [
"",
"",
""
]
},
"isCC": {
"type": "boolean",
"description": "Indicates whether the track contains closed captions for the deaf\nand hard of hearing. The default value is \u003ccode\u003efalse\u003c/code\u003e."
},
"language": {
"description": "The language of the caption track. The property value is a\n\u003ca href=\"http://www.rfc-editor.org/rfc/bcp/bcp47.txt\"\u003eBCP-47\u003c/a\u003e\n language tag.",
"type": "string"
},
"videoId": {
"annotations": {
"required": [
"youtube.captions.insert"
]
},
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the video associated\nwith the caption track.\n@mutable youtube.captions.insert"
},
"isLarge": {
"type": "boolean",
"description": "Indicates whether the caption track uses large text for the\nvision-impaired. The default value is \u003ccode\u003efalse\u003c/code\u003e."
},
"lastUpdated": {
"type": "string",
"description": "The date and time when the caption track was last updated. The value is\nspecified in \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat."
},
"isAutoSynced": {
"type": "boolean",
"description": "Indicates whether YouTube synchronized the caption track to the audio\ntrack in the video. The value will be \u003ccode\u003etrue\u003c/code\u003e if a sync was\nexplicitly requested when the caption track was uploaded. For example,\nwhen calling the \u003ccode\u003ecaptions.insert\u003c/code\u003e or\n\u003ccode\u003ecaptions.update\u003c/code\u003e methods, you can set the \u003ccode\u003esync\u003c/code\u003e\nparameter to \u003ccode\u003etrue\u003c/code\u003e to instruct YouTube to sync the uploaded\ntrack to the video. If the value is \u003ccode\u003efalse\u003c/code\u003e, YouTube uses\nthe time codes in the uploaded caption track to determine when to display\ncaptions."
},
"name": {
"type": "string",
"description": "The name of the caption track. The name is intended to be visible\nto the user as an option during playback."
}
},
"type": "object",
"id": "CaptionSnippet",
"description": "Basic details about a caption track, such as its language and name."
},
"SponsorListResponse": {
"properties": {
"nextPageToken": {
"description": "The token that can be used as the value of the `pageToken` parameter to\nretrieve the next page in the result set.",
"type": "string"
},
"tokenPagination": {
"$ref": "TokenPagination"
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"pageInfo": {
"$ref": "PageInfo"
},
"eventId": {
"type": "string",
"description": "Serialized EventId of the request which produced this response."
},
"visitorId": {
"description": "The `visitorId` identifies the visitor.",
"type": "string"
},
"items": {
"items": {
"$ref": "Sponsor"
},
"type": "array",
"description": "A list of sponsors that match the request criteria."
},
"kind": {
"default": "youtube#sponsorListResponse",
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string\n`\"youtube#sponsorListResponse\"."
}
},
"id": "SponsorListResponse",
"type": "object"
},
"ChannelConversionPings": {
"id": "ChannelConversionPings",
"description": "The \u003ccode\u003econversionPings\u003c/code\u003e object encapsulates information about\nconversion pings that need to be respected by the channel.",
"type": "object",
"properties": {
"pings": {
"description": "Pings that the app shall fire (authenticated by biscotti cookie). Each ping\nhas a context, in which the app must fire the ping, and a url identifying\nthe ping.",
"items": {
"$ref": "ChannelConversionPing"
},
"type": "array"
}
}
},
"LiveChatSuperStickerDetails": {
"id": "LiveChatSuperStickerDetails",
"type": "object",
"properties": {
"tier": {
"description": "The tier in which the amount belongs. Lower amounts belong to lower\ntiers. The lowest tier is \u003ccode\u003e1\u003c/code\u003e.",
"type": "integer",
"format": "uint32"
},
"amountDisplayString": {
"description": "A rendered string that displays the fund amount and currency to the user.",
"type": "string"
},
"superStickerMetadata": {
"$ref": "SuperStickerMetadata",
"description": "Information about the Super Sticker."
},
"currency": {
"type": "string",
"description": "The currency in which the purchase was made."
},
"amountMicros": {
"description": "The amount purchased by the user, in micros (1,750,000 micros = 1.75).",
"type": "string",
"format": "uint64"
}
}
},
"PlaylistLocalization": {
"description": "Playlist localization setting",
"id": "PlaylistLocalization",
"properties": {
"description": {
"description": "The localized strings for playlist's description.",
"type": "string"
},
"title": {
"type": "string",
"description": "The localized strings for playlist's title."
}
},
"type": "object"
},
"LiveStreamHealthStatus": {
"id": "LiveStreamHealthStatus",
"properties": {
"lastUpdateTimeSeconds": {
"description": "The last time this status was updated (in seconds)",
"type": "string",
"format": "uint64"
},
"status": {
"enum": [
"good",
"ok",
"bad",
"noData",
"revoked"
],
"description": "The status code of this stream",
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
},
"configurationIssues": {
"type": "array",
"description": "The configurations issues on this stream",
"items": {
"$ref": "LiveStreamConfigurationIssue"
}
}
},
"type": "object"
},
"ChannelSection": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#channelSection\"\u003c/code\u003e.",
"type": "string",
"default": "youtube#channelSection"
},
"localizations": {
"additionalProperties": {
"$ref": "ChannelSectionLocalization"
},
"type": "object",
"description": "Localizations for different languages"
},
"targeting": {
"description": "The \u003ccode\u003etargeting\u003c/code\u003e object contains basic targeting settings about\nthe channel section.",
"$ref": "ChannelSectionTargeting"
},
"snippet": {
"description": "The \u003ccode\u003esnippet\u003c/code\u003e object contains basic details about the channel\nsection, such as its type, style and title.",
"$ref": "ChannelSectionSnippet"
},
"contentDetails": {
"description": "The \u003ccode\u003econtentDetails\u003c/code\u003e object contains details about the channel\nsection content, such as a list of playlists or channels featured in the\nsection.",
"$ref": "ChannelSectionContentDetails"
},
"etag": {
"type": "string",
"description": "Etag of this resource."
},
"id": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the channel section."
}
},
"type": "object",
"id": "ChannelSection"
},
"ContentRating": {
"description": "Ratings schemes. The country-specific ratings are mostly for\nmovies and shows.\nLINT.IfChange",
"properties": {
"mcstRating": {
"type": "string",
"enum": [
"mcstUnspecified",
"mcstP",
"mcst0",
"mcstC13",
"mcstC16",
"mcst16plus",
"mcstC18",
"mcstGPg",
"mcstUnrated"
],
"enumDescriptions": [
"",
"P",
"0",
"C13",
"C16",
"16+",
"C18",
"MCST_G_PG",
""
],
"description": "The video's rating system for Vietnam - MCST"
},
"lsfRating": {
"enumDescriptions": [
"",
"SU",
"A",
"BO",
"13",
"R",
"17",
"D",
"21",
""
],
"type": "string",
"description": "The video's rating from Indonesia's Lembaga Sensor Film.",
"enum": [
"lsfUnspecified",
"lsfSu",
"lsfA",
"lsfBo",
"lsf13",
"lsfR",
"lsf17",
"lsfD",
"lsf21",
"lsfUnrated"
]
},
"cnaRating": {
"type": "string",
"description": "The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI\n(CNA).",
"enumDescriptions": [
"",
"AP",
"12",
"15",
"18",
"18+",
""
],
"enum": [
"cnaUnspecified",
"cnaAp",
"cna12",
"cna15",
"cna18",
"cna18plus",
"cnaUnrated"
]
},
"rteRating": {
"enum": [
"rteUnspecified",
"rteGa",
"rteCh",
"rtePs",
"rteMa",
"rteUnrated"
],
"enumDescriptions": [
"",
"GA",
"CH",
"PS",
"MA",
""
],
"description": "The video's rating from Ireland's Raidió Teilifís\nÉireann.",
"type": "string"
},
"smsaRating": {
"description": "The video's rating from Statens medieråd (Sweden's National Media\nCouncil).",
"type": "string",
"enum": [
"smsaUnspecified",
"smsaA",
"smsa7",
"smsa11",
"smsa15",
"smsaUnrated"
],
"enumDescriptions": [
"",
"All ages",
"7",
"11",
"15",
""
]
},
"catvfrRating": {
"enumDescriptions": [
"",
"G",
"8+",
"13+",
"16+",
"18+",
"",
""
],
"type": "string",
"description": "The video's rating from the Canadian Radio-Television and\nTelecommunications Commission (CRTC) for Canadian French-language\nbroadcasts. For more information, see the\n\u003ca href=\"http://www.cbsc.ca/english/agvot/frenchsystem.php\"\u003eCanadian\nBroadcast Standards Council\u003c/a\u003e website.",
"enum": [
"catvfrUnspecified",
"catvfrG",
"catvfr8plus",
"catvfr13plus",
"catvfr16plus",
"catvfr18plus",
"catvfrUnrated",
"catvfrE"
]
},
"djctqRatingReasons": {
"items": {
"enum": [
"djctqRatingReasonUnspecified",
"djctqViolence",
"djctqExtremeViolence",
"djctqSexualContent",
"djctqNudity",
"djctqSex",
"djctqExplicitSex",
"djctqDrugs",
"djctqLegalDrugs",
"djctqIllegalDrugs",
"djctqInappropriateLanguage",
"djctqCriminalActs",
"djctqImpactingContent"
],
"type": "string"
},
"description": "Reasons that explain why the video received its DJCQT (Brazil) rating.",
"type": "array",
"enumDescriptions": [
"",
"Brazil rating content descriptors. See http://go/brazilratings section F.\nViolência (Violence)",
"Violência extrema (Extreme violence)",
"Conteúdo sexual (Sexual content)",
"Nudez (Nudity)",
"Sexo (Sex)",
"Sexo Explícito (Explicit sex)",
"Drogas (Drugs)",
"Drogas Lícitas (Legal drugs)",
"Drogas Ilícitas (Illegal drugs)",
"Linguagem Imprópria (Inappropriate language)",
"Atos Criminosos (Criminal Acts)",
"Conteúdo Impactante (Impacting content)"
]
},
"skfilmRating": {
"enum": [
"skfilmUnspecified",
"skfilmG",
"skfilmP2",
"skfilmP5",
"skfilmP8",
"skfilmUnrated"
],
"description": "The video's rating in Slovakia.",
"enumDescriptions": [
"",
"G",
"P2",
"P5",
"P8",
""
],
"type": "string"
},
"bfvcRating": {
"enum": [
"bfvcUnspecified",
"bfvcG",
"bfvcE",
"bfvc13",
"bfvc15",
"bfvc18",
"bfvc20",
"bfvcB",
"bfvcUnrated"
],
"enumDescriptions": [
"",
"G",
"E",
"13",
"15",
"18",
"20",
"B",
""
],
"type": "string",
"description": "The video's rating from Thailand's Board of Film and Video Censors."
},
"fpbRating": {
"enumDescriptions": [
"",
"A",
"PG",
"7-9PG",
"10-12PG",
"13",
"16",
"18",
"X18",
"XX",
"",
"10"
],
"type": "string",
"description": "The video's rating from South Africa's Film and Publication Board.",
"enum": [
"fpbUnspecified",
"fpbA",
"fpbPg",
"fpb79Pg",
"fpb1012Pg",
"fpb13",
"fpb16",
"fpb18",
"fpbX18",
"fpbXx",
"fpbUnrated",
"fpb10"
]
},
"resorteviolenciaRating": {
"description": "The video's rating in Venezuela.",
"enumDescriptions": [
"",
"A",
"B",
"C",
"D",
"E",
""
],
"type": "string",
"enum": [
"resorteviolenciaUnspecified",
"resorteviolenciaA",
"resorteviolenciaB",
"resorteviolenciaC",
"resorteviolenciaD",
"resorteviolenciaE",
"resorteviolenciaUnrated"
]
},
"chfilmRating": {
"enumDescriptions": [
"",
"0",
"6",
"12",
"16",
"18",
""
],
"description": "The video's rating in Switzerland.",
"enum": [
"chfilmUnspecified",
"chfilm0",
"chfilm6",
"chfilm12",
"chfilm16",
"chfilm18",
"chfilmUnrated"
],
"type": "string"
},
"smaisRating": {
"enumDescriptions": [
"",
"L",
"7",
"12",
"14",
"16",
"18",
""
],
"description": "The video's rating in Iceland.",
"enum": [
"smaisUnspecified",
"smaisL",
"smais7",
"smais12",
"smais14",
"smais16",
"smais18",
"smaisUnrated"
],
"type": "string"
},
"bmukkRating": {
"description": "The video's rating from the Austrian Board of Media Classification\n(Bundesministerium für Unterricht, Kunst und Kultur).",
"type": "string",
"enum": [
"bmukkUnspecified",
"bmukkAa",
"bmukk6",
"bmukk8",
"bmukk10",
"bmukk12",
"bmukk14",
"bmukk16",
"bmukkUnrated"
],
"enumDescriptions": [
"",
"Unrestricted",
"6+",
"8+",
"10+",
"12+",
"14+",
"16+",
""
]
},
"mtrcbRating": {
"type": "string",
"description": "The video's rating from the Movie and Television Review and\nClassification Board (Philippines).",
"enum": [
"mtrcbUnspecified",
"mtrcbG",
"mtrcbPg",
"mtrcbR13",
"mtrcbR16",
"mtrcbR18",
"mtrcbX",
"mtrcbUnrated"
],
"enumDescriptions": [
"",
"G",
"PG",
"R-13",
"R-16",
"R-18",
"X",
""
]
},
"czfilmRating": {
"description": "The video's rating in the Czech Republic.",
"type": "string",
"enum": [
"czfilmUnspecified",
"czfilmU",
"czfilm12",
"czfilm14",
"czfilm18",
"czfilmUnrated"
],
"enumDescriptions": [
"",
"U",
"12",
"14",
"18",
""
]
},
"nkclvRating": {
"description": "The video's rating from the Nacionãlais Kino centrs (National Film\nCentre of Latvia).",
"enumDescriptions": [
"",
"U",
"7+",
"12+",
"! 16+",
"18+",
""
],
"enum": [
"nkclvUnspecified",
"nkclvU",
"nkclv7plus",
"nkclv12plus",
"nkclv16plus",
"nkclv18plus",
"nkclvUnrated"
],
"type": "string"
},
"fpbRatingReasons": {
"enumDescriptions": [
"",
"South Africa rating content descriptors.",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"description": "Reasons that explain why the video received its FPB (South Africa) rating.",
"type": "array",
"items": {
"type": "string",
"enum": [
"fpbRatingReasonUnspecified",
"fpbBlasphemy",
"fpbLanguage",
"fpbNudity",
"fpbPrejudice",
"fpbSex",
"fpbViolence",
"fpbDrugs",
"fpbSexualViolence",
"fpbHorror",
"fpbCriminalTechniques",
"fpbImitativeActsTechniques"
]
}
},
"nfvcbRating": {
"description": "The video's rating from Nigeria's National Film and Video Censors Board.",
"enum": [
"nfvcbUnspecified",
"nfvcbG",
"nfvcbPg",
"nfvcb12",
"nfvcb12a",
"nfvcb15",
"nfvcb18",
"nfvcbRe",
"nfvcbUnrated"
],
"type": "string",
"enumDescriptions": [
"",
"G",
"PG",
"12",
"12A",
"15",
"18",
"RE",
""
]
},
"cncRating": {
"enumDescriptions": [
"",
"T",
"10",
"12",
"16",
"18",
"E",
"interdiction",
""
],
"type": "string",
"description": "Rating system in France - Commission de classification cinematographique",
"enum": [
"cncUnspecified",
"cncT",
"cnc10",
"cnc12",
"cnc16",
"cnc18",
"cncE",
"cncInterdiction",
"cncUnrated"
]
},
"rcnofRating": {
"type": "string",
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
""
],
"enum": [
"rcnofUnspecified",
"rcnofI",
"rcnofIi",
"rcnofIii",
"rcnofIv",
"rcnofV",
"rcnofVi",
"rcnofUnrated"
],
"description": "The video's rating from the Hungarian Nemzeti Filmiroda, the Rating\nCommittee of the National Office of Film."
},
"nbcplRating": {
"type": "string",
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
],
"description": "The video's rating in Poland.",
"enum": [
"nbcplUnspecified",
"nbcplI",
"nbcplIi",
"nbcplIii",
"nbcplIv",
"nbcpl18plus",
"nbcplUnrated"
]
},
"incaaRating": {
"enum": [
"incaaUnspecified",
"incaaAtp",
"incaaSam13",
"incaaSam16",
"incaaSam18",
"incaaC",
"incaaUnrated"
],
"description": "The video's INCAA (Instituto Nacional de Cine y Artes Audiovisuales -\nArgentina) rating.",
"type": "string",
"enumDescriptions": [
"",
"ATP (Apta para todo publico)",
"13 (Solo apta para mayores de 13 años)",
"16 (Solo apta para mayores de 16 años)",
"18 (Solo apta para mayores de 18 años)",
"X (Solo apta para mayores de 18 años, de exhibición condicionada)",
""
]
},
"csaRating": {
"description": "The video's rating from France's Conseil supérieur de\nl’audiovisuel, which rates broadcast content.",
"type": "string",
"enum": [
"csaUnspecified",
"csaT",
"csa10",
"csa12",
"csa16",
"csa18",
"csaInterdiction",
"csaUnrated"
],
"enumDescriptions": [
"",
"T",
"10",
"12",
"16",
"18",
"Interdiction",
""
]
},
"cceRating": {
"type": "string",
"description": "The video's rating from Portugal's Comissão de\nClassificação de Espect´culos.",
"enumDescriptions": [
"",
"4",
"6",
"12",
"16",
"18",
"",
"14"
],
"enum": [
"cceUnspecified",
"cceM4",
"cceM6",
"cceM12",
"cceM16",
"cceM18",
"cceUnrated",
"cceM14"
]
},
"oflcRating": {
"type": "string",
"description": "The video's Office of Film and Literature Classification\n(OFLC - New Zealand) rating.",
"enum": [
"oflcUnspecified",
"oflcG",
"oflcPg",
"oflcM",
"oflcR13",
"oflcR15",
"oflcR16",
"oflcR18",
"oflcUnrated",
"oflcRp13",
"oflcRp16",
"oflcRp18"
],
"enumDescriptions": [
"",
"G",
"PG",
"M",
"R13",
"R15",
"R16",
"R18",
"",
"RP13",
"RP16",
"RP18"
]
},
"grfilmRating": {
"description": "The video's rating in Greece.",
"enumDescriptions": [
"",
"K",
"E",
"K-12",
"K-13",
"K-15",
"K-17",
"K-18",
""
],
"type": "string",
"enum": [
"grfilmUnspecified",
"grfilmK",
"grfilmE",
"grfilmK12",
"grfilmK13",
"grfilmK15",
"grfilmK17",
"grfilmK18",
"grfilmUnrated"
]
},
"mccaaRating": {
"enum": [
"mccaaUnspecified",
"mccaaU",
"mccaaPg",
"mccaa12a",
"mccaa12",
"mccaa14",
"mccaa15",
"mccaa16",
"mccaa18",
"mccaaUnrated"
],
"description": "The video's rating from Malta's Film Age-Classification Board.",
"type": "string",
"enumDescriptions": [
"",
"U",
"PG",
"12A",
"12",
"14 - this rating was removed from the new classification structure\nintroduced in 2013.",
"15",
"16 - this rating was removed from the new classification structure\nintroduced in 2013.",
"18",
""
]
},
"ilfilmRating": {
"enumDescriptions": [
"",
"AA",
"12",
"14",
"16",
"18",
""
],
"type": "string",
"description": "The video's rating in Israel.",
"enum": [
"ilfilmUnspecified",
"ilfilmAa",
"ilfilm12",
"ilfilm14",
"ilfilm16",
"ilfilm18",
"ilfilmUnrated"
]
},
"egfilmRating": {
"type": "string",
"description": "The video's rating in Egypt.",
"enumDescriptions": [
"",
"GN",
"18",
"BN",
""
],
"enum": [
"egfilmUnspecified",
"egfilmGn",
"egfilm18",
"egfilmBn",
"egfilmUnrated"
]
},
"chvrsRating": {
"enum": [
"chvrsUnspecified",
"chvrsG",
"chvrsPg",
"chvrs14a",
"chvrs18a",
"chvrsR",
"chvrsE",
"chvrsUnrated"
],
"type": "string",
"description": "The video's Canadian Home Video Rating System (CHVRS) rating.",
"enumDescriptions": [
"",
"G",
"PG",
"14A",
"18A",
"R",
"E",
""
]
},
"menaMpaaRating": {
"enumDescriptions": [
"",
"G",
"PG",
"PG-13",
"R",
"To keep the same enum values as MPAA's items have, skip NC_17."
],
"description": "The rating system for MENA countries, a clone of MPAA. It is needed to\nprevent titles go live w/o additional QC check, since some of them can be\ninappropriate for the countries at all. See b/33408548 for more details.",
"type": "string",
"enum": [
"menaMpaaUnspecified",
"menaMpaaG",
"menaMpaaPg",
"menaMpaaPg13",
"menaMpaaR",
"menaMpaaUnrated"
]
},
"fcoRating": {
"type": "string",
"description": "The video's rating from Hong Kong's Office for Film, Newspaper\nand Article Administration.",
"enum": [
"fcoUnspecified",
"fcoI",
"fcoIia",
"fcoIib",
"fcoIi",
"fcoIii",
"fcoUnrated"
],
"enumDescriptions": [
"",
"I",
"IIA",
"IIB",
"II",
"III",
""
]
},
"kijkwijzerRating": {
"description": "The video's NICAM/Kijkwijzer rating from the Nederlands Instituut\nvoor de Classificatie van Audiovisuele Media (Netherlands).",
"enum": [
"kijkwijzerUnspecified",
"kijkwijzerAl",
"kijkwijzer6",
"kijkwijzer9",
"kijkwijzer12",
"kijkwijzer16",
"kijkwijzer18",
"kijkwijzerUnrated"
],
"enumDescriptions": [
"",
"AL",
"6",
"9",
"12",
"16",
"",
""
],
"type": "string"
},
"nbcRating": {
"description": "The video's rating from the Maldives National Bureau of Classification.",
"enum": [
"nbcUnspecified",
"nbcG",
"nbcPg",
"nbc12plus",
"nbc15plus",
"nbc18plus",
"nbc18plusr",
"nbcPu",
"nbcUnrated"
],
"enumDescriptions": [
"",
"G",
"PG",
"12+",
"15+",
"18+",
"18+R",
"PU",
""
],
"type": "string"
},
"eefilmRating": {
"description": "The video's rating in Estonia.",
"enum": [
"eefilmUnspecified",
"eefilmPere",
"eefilmL",
"eefilmMs6",
"eefilmK6",
"eefilmMs12",
"eefilmK12",
"eefilmK14",
"eefilmK16",
"eefilmUnrated"
],
"enumDescriptions": [
"",
"Pere",
"L",
"MS-6",
"K-6",
"MS-12",
"K-12",
"K-14",
"K-16",
""
],
"type": "string"
},
"bbfcRating": {
"enumDescriptions": [
"",
"U",
"PG",
"12A",
"12",
"15",
"18",
"R18",
""
],
"enum": [
"bbfcUnspecified",
"bbfcU",
"bbfcPg",
"bbfc12a",
"bbfc12",
"bbfc15",
"bbfc18",
"bbfcR18",
"bbfcUnrated"
],
"type": "string",
"description": "The video's British Board of Film Classification (BBFC) rating."
},
"fcbmRating": {
"type": "string",
"enum": [
"fcbmUnspecified",
"fcbmU",
"fcbmPg13",
"fcbmP13",
"fcbm18",
"fcbm18sx",
"fcbm18pa",
"fcbm18sg",
"fcbm18pl",
"fcbmUnrated"
],
"description": "The video's rating from Malaysia's Film Censorship Board.",
"enumDescriptions": [
"",
"U",
"PG13",
"P13",
"18",
"18SX",
"18PA",
"18SG",
"18PL",
""
]
},
"nmcRating": {
"type": "string",
"description": "The National Media Council ratings system for United Arab Emirates.",
"enum": [
"nmcUnspecified",
"nmcG",
"nmcPg",
"nmcPg13",
"nmcPg15",
"nmc15plus",
"nmc18plus",
"nmc18tc",
"nmcUnrated"
],
"enumDescriptions": [
"",
"G",
"PG",
"PG-13",
"PG-15",
"15+",
"18+",
"18TC",
""
]
},
"mdaRating": {
"enumDescriptions": [
"",
"G",
"PG",
"PG13",
"NC16",
"M18",
"R21",
""
],
"enum": [
"mdaUnspecified",
"mdaG",
"mdaPg",
"mdaPg13",
"mdaNc16",
"mdaM18",
"mdaR21",
"mdaUnrated"
],
"description": "The video's rating from Singapore's Media Development Authority (MDA) and,\nspecifically, it's Board of Film Censors (BFC).",
"type": "string"
},
"catvRating": {
"type": "string",
"enumDescriptions": [
"",
"C",
"C8",
"G",
"PG",
"14+",
"18+",
"",
""
],
"description": "Rating system for Canadian TV - Canadian TV Classification System\nThe video's rating from the Canadian Radio-Television and\nTelecommunications Commission (CRTC) for Canadian English-language\nbroadcasts. For more information, see the\n\u003ca href=\"http://www.cbsc.ca/english/agvot/englishsystem.php\"\u003eCanadian\nBroadcast Standards Council\u003c/a\u003e website.",
"enum": [
"catvUnspecified",
"catvC",
"catvC8",
"catvG",
"catvPg",
"catv14plus",
"catv18plus",
"catvUnrated",
"catvE"
]
},
"tvpgRating": {
"description": "The video's TV Parental Guidelines (TVPG) rating.",
"enumDescriptions": [
"",
"TV-Y",
"TV-Y7",
"TV-Y7-FV",
"TV-G",
"TV-PG",
"TV-14",
"TV-MA",
""
],
"type": "string",
"enum": [
"tvpgUnspecified",
"tvpgY",
"tvpgY7",
"tvpgY7Fv",
"tvpgG",
"tvpgPg",
"pg14",
"tvpgMa",
"tvpgUnrated"
]
},
"cicfRating": {
"enumDescriptions": [
"",
"E",
"KT/EA",
"KNT/ENA",
""
],
"enum": [
"cicfUnspecified",
"cicfE",
"cicfKtEa",
"cicfKntEna",
"cicfUnrated"
],
"type": "string",
"description": "The video's rating from the Commission de Contrôle des Films\n(Belgium)."
},
"russiaRating": {
"enum": [
"russiaUnspecified",
"russia0",
"russia6",
"russia12",
"russia16",
"russia18",
"russiaUnrated"
],
"description": "The video's National Film Registry of the Russian Federation\n(MKRF - Russia) rating.",
"type": "string",
"enumDescriptions": [
"",
"0+",
"6+",
"12+",
"16+",
"18+",
""
]
},
"pefilmRating": {
"enumDescriptions": [
"",
"PT",
"PG",
"14",
"18",
""
],
"enum": [
"pefilmUnspecified",
"pefilmPt",
"pefilmPg",
"pefilm14",
"pefilm18",
"pefilmUnrated"
],
"type": "string",
"description": "The video's rating in Peru."
},
"fskRating": {
"description": "The video's Freiwillige Selbstkontrolle der Filmwirtschaft\n(FSK - Germany) rating.",
"enumDescriptions": [
"",
"FSK 0",
"FSK 6",
"FSK 12",
"FSK 16",
"FSK 18",
""
],
"type": "string",
"enum": [
"fskUnspecified",
"fsk0",
"fsk6",
"fsk12",
"fsk16",
"fsk18",
"fskUnrated"
]
},
"nfrcRating": {
"enum": [
"nfrcUnspecified",
"nfrcA",
"nfrcB",
"nfrcC",
"nfrcD",
"nfrcX",
"nfrcUnrated"
],
"enumDescriptions": [
"",
"A",
"B",
"C",
"D",
"X",
""
],
"description": "The video's rating from the \u003ca href=\"http://www.nfc.bg/\"\u003eBulgarian\nNational Film Center\u003c/a\u003e.",
"type": "string"
},
"acbRating": {
"enumDescriptions": [
"",
"E",
"Programs that have been given a \u003ccode\u003eP\u003c/code\u003e classification by the\nAustralian Communications and Media Authority. These programs are\nintended for preschool children.",
"Programs that have been given a \u003ccode\u003eC\u003c/code\u003e classification by the\nAustralian Communications and Media Authority. These programs are\nintended for children (other than preschool children) who are younger\nthan 14 years of age.",
"G",
"PG",
"M",
"MA15+",
"R18+",
""
],
"description": "The video's Australian Classification Board (ACB) or Australian\nCommunications and Media Authority (ACMA) rating. ACMA ratings are used\nto classify children's television programming.",
"type": "string",
"enum": [
"acbUnspecified",
"acbE",
"acbP",
"acbC",
"acbG",
"acbPg",
"acbM",
"acbMa15plus",
"acbR18plus",
"acbUnrated"
]
},
"mpaaRating": {
"enum": [
"mpaaUnspecified",
"mpaaG",
"mpaaPg",
"mpaaPg13",
"mpaaR",
"mpaaNc17",
"mpaaX",
"mpaaUnrated"
],
"enumDescriptions": [
"",
"G",
"PG",
"PG-13",
"R",
"NC-17",
"! X",
""
],
"type": "string",
"description": "The video's Motion Picture Association of America (MPAA) rating."
},
"agcomRating": {
"enumDescriptions": [
"",
"T",
"VM14",
"VM18",
""
],
"type": "string",
"description": "The video's rating from Italy's Autorità per le Garanzie nelle\nComunicazioni (AGCOM).",
"enum": [
"agcomUnspecified",
"agcomT",
"agcomVm14",
"agcomVm18",
"agcomUnrated"
]
},
"djctqRating": {
"enumDescriptions": [
"",
"L",
"10",
"12",
"14",
"16",
"18",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string",
"enum": [
"djctqUnspecified",
"djctqL",
"djctq10",
"djctq12",
"djctq14",
"djctq16",
"djctq18",
"djctqEr",
"djctqL10",
"djctqL12",
"djctqL14",
"djctqL16",
"djctqL18",
"djctq1012",
"djctq1014",
"djctq1016",
"djctq1018",
"djctq1214",
"djctq1216",
"djctq1218",
"djctq1416",
"djctq1418",
"djctq1618",
"djctqUnrated"
],
"description": "The video's Departamento de Justiça, Classificação,\nQualificação e Títulos (DJCQT - Brazil) rating."
},
"kfcbRating": {
"description": "The video's rating from the Kenya Film Classification Board.",
"enum": [
"kfcbUnspecified",
"kfcbG",
"kfcbPg",
"kfcb16plus",
"kfcbR",
"kfcbUnrated"
],
"enumDescriptions": [
"",
"GE",
"PG",
"16",
"18",
""
],
"type": "string"
},
"mekuRating": {
"enum": [
"mekuUnspecified",
"mekuS",
"meku7",
"meku12",
"meku16",
"meku18",
"mekuUnrated"
],
"enumDescriptions": [
"",
"S",
"7",
"12",
"16",
"18",
""
],
"type": "string",
"description": "The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti\n(National Audiovisual Institute)."
},
"kmrbRating": {
"description": "The video's Korea Media Rating Board\n(영상물등급위원회) rating.\nThe KMRB rates videos in South Korea.",
"enum": [
"kmrbUnspecified",
"kmrbAll",
"kmrb12plus",
"kmrb15plus",
"kmrbTeenr",
"kmrbR",
"kmrbUnrated"
],
"enumDescriptions": [
"",
"전체관람가",
"12세 이상 관람가",
"15세 이상 관람가",
"",
"청소년 관람불가",
""
],
"type": "string"
},
"moctwRating": {
"enum": [
"moctwUnspecified",
"moctwG",
"moctwP",
"moctwPg",
"moctwR",
"moctwUnrated",
"moctwR12",
"moctwR15"
],
"enumDescriptions": [
"",
"G",
"P",
"PG",
"R",
"",
"R-12",
"R-15"
],
"type": "string",
"description": "The video's rating from Taiwan's Ministry of Culture\n(文化部)."
},
"rtcRating": {
"enum": [
"rtcUnspecified",
"rtcAa",
"rtcA",
"rtcB",
"rtcB15",
"rtcC",
"rtcD",
"rtcUnrated"
],
"type": "string",
"enumDescriptions": [
"",
"AA",
"A",
"B",
"B15",
"C",
"D",
""
],
"description": "The video's General Directorate of Radio, Television and Cinematography\n(Mexico) rating."
},
"medietilsynetRating": {
"enumDescriptions": [
"",
"A",
"6",
"7",
"9",
"11",
"12",
"15",
"18",
""
],
"type": "string",
"enum": [
"medietilsynetUnspecified",
"medietilsynetA",
"medietilsynet6",
"medietilsynet7",
"medietilsynet9",
"medietilsynet11",
"medietilsynet12",
"medietilsynet15",
"medietilsynet18",
"medietilsynetUnrated"
],
"description": "The video's rating from Medietilsynet, the Norwegian Media Authority."
},
"mpaatRating": {
"type": "string",
"enumDescriptions": [
"",
"GB",
"RB"
],
"enum": [
"mpaatUnspecified",
"mpaatGb",
"mpaatRb"
],
"description": "The rating system for trailer, DVD, and Ad in the US. See\nhttp://movielabs.com/md/ratings/v2.3/html/US_MPAAT_Ratings.html."
},
"eirinRating": {
"enum": [
"eirinUnspecified",
"eirinG",
"eirinPg12",
"eirinR15plus",
"eirinR18plus",
"eirinUnrated"
],
"enumDescriptions": [
"",
"G",
"PG-12",
"R15+",
"R18+",
""
],
"type": "string",
"description": "The video's Eirin (映倫) rating.\nEirin is the Japanese rating system."
},
"icaaRating": {
"enum": [
"icaaUnspecified",
"icaaApta",
"icaa7",
"icaa12",
"icaa13",
"icaa16",
"icaa18",
"icaaX",
"icaaUnrated"
],
"description": "The video's Instituto de la Cinematografía y de las Artes\nAudiovisuales (ICAA - Spain) rating.",
"type": "string",
"enumDescriptions": [
"",
"APTA",
"7",
"12",
"13",
"16",
"18",
"X",
""
]
},
"mccypRating": {
"enum": [
"mccypUnspecified",
"mccypA",
"mccyp7",
"mccyp11",
"mccyp15",
"mccypUnrated"
],
"type": "string",
"description": "The video's rating from the Danish Film Institute's (Det Danske\nFilminstitut) Media Council for Children and Young People.",
"enumDescriptions": [
"",
"A",
"7",
"11",
"15",
""
]
},
"mocRating": {
"enum": [
"mocUnspecified",
"mocE",
"mocT",
"moc7",
"moc12",
"moc15",
"moc18",
"mocX",
"mocBanned",
"mocUnrated"
],
"enumDescriptions": [
"",
"E",
"T",
"7",
"12",
"15",
"18",
"X",
"Banned",
""
],
"description": "The video's Ministerio de Cultura (Colombia) rating.",
"type": "string"
},
"ifcoRating": {
"description": "The video's Irish Film Classification Office (IFCO - Ireland) rating.\nSee the \u003ca\nhref=\"http://www.ifco.ie/website/ifco/ifcoweb.nsf/web/classcatintro\"\u003eIFCO\u003c/a\u003e\nwebsite for more information.",
"enum": [
"ifcoUnspecified",
"ifcoG",
"ifcoPg",
"ifco12",
"ifco12a",
"ifco15",
"ifco15a",
"ifco16",
"ifco18",
"ifcoUnrated"
],
"type": "string",
"enumDescriptions": [
"",
"G",
"PG",
"12",
"12A",
"15",
"15A",
"16",
"18",
""
]
},
"mibacRating": {
"enum": [
"mibacUnspecified",
"mibacT",
"mibacVap",
"mibacVm12",
"mibacVm14",
"mibacVm18",
"mibacUnrated"
],
"description": "The video's rating from the Ministero dei Beni e delle Attività\nCulturali e del Turismo (Italy).",
"type": "string",
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
]
},
"cccRating": {
"enumDescriptions": [
"",
"Todo espectador",
"6+ - Inconveniente para menores de 7 años",
"14+",
"18+",
"18+ - contenido excesivamente violento",
"18+ - contenido pornográfico",
""
],
"type": "string",
"description": "The video's Consejo de Calificación Cinematográfica (Chile)\nrating.",
"enum": [
"cccUnspecified",
"cccTe",
"ccc6",
"ccc14",
"ccc18",
"ccc18v",
"ccc18s",
"cccUnrated"
]
},
"cscfRating": {
"enumDescriptions": [
"",
"AL",
"A",
"6",
"9",
"12",
"16",
"18",
""
],
"description": "The video's rating from Luxembourg's Commission de surveillance\nde la classification des films (CSCF).",
"enum": [
"cscfUnspecified",
"cscfAl",
"cscfA",
"cscf6",
"cscf9",
"cscf12",
"cscf16",
"cscf18",
"cscfUnrated"
],
"type": "string"
},
"cbfcRating": {
"description": "The video's Central Board of Film Certification (CBFC - India) rating.",
"enum": [
"cbfcUnspecified",
"cbfcU",
"cbfcUA",
"cbfcA",
"cbfcS",
"cbfcUnrated"
],
"type": "string",
"enumDescriptions": [
"",
"U",
"U/A",
"A",
"S",
""
]
},
"ytRating": {
"description": "A rating that YouTube uses to identify age-restricted content.",
"enumDescriptions": [
"",
""
],
"enum": [
"ytUnspecified",
"ytAgeRestricted"
],
"type": "string"
},
"fmocRating": {
"description": "\u003cspan class=\"deprecated\"\u003eThis property has been deprecated. Use the\n\u003ccode\u003e\u003ca\nhref=\"#contentDetails.contentRating.cncRating\"\u003econtentDetails.contentRating.cncRating\u003c/a\u003e\u003c/code\u003e\ninstead.\u003c/span\u003e",
"type": "string",
"enumDescriptions": [
"",
"U",
"10",
"12",
"16",
"18",
"E",
""
],
"enum": [
"fmocUnspecified",
"fmocU",
"fmoc10",
"fmoc12",
"fmoc16",
"fmoc18",
"fmocE",
"fmocUnrated"
]
},
"ecbmctRating": {
"enum": [
"ecbmctUnspecified",
"ecbmctG",
"ecbmct7a",
"ecbmct7plus",
"ecbmct13a",
"ecbmct13plus",
"ecbmct15a",
"ecbmct15plus",
"ecbmct18plus",
"ecbmctUnrated"
],
"description": "Rating system in Turkey - Evaluation and Classification Board of the\nMinistry of Culture and Tourism",
"enumDescriptions": [
"",
"G",
"7A",
"7+",
"13A",
"13+",
"15A",
"15+",
"18+",
""
],
"type": "string"
},
"anatelRating": {
"enum": [
"anatelUnspecified",
"anatelF",
"anatelI",
"anatelI7",
"anatelI10",
"anatelI12",
"anatelR",
"anatelA",
"anatelUnrated"
],
"description": "The video's Anatel (Asociación Nacional de Televisión)\nrating for Chilean television.",
"enumDescriptions": [
"",
"F",
"I",
"I-7",
"I-10",
"I-12",
"R",
"A",
""
],
"type": "string"
}
},
"type": "object",
"id": "ContentRating"
},
"Channel": {
"type": "object",
"description": "A \u003ccode\u003e\u003cstrong\u003echannel\u003c/strong\u003e\u003c/code\u003e resource contains\ninformation about a YouTube channel.",
"properties": {
"statistics": {
"$ref": "ChannelStatistics",
"description": "The \u003ccode\u003estatistics\u003c/code\u003e object encapsulates statistics for the channel."
},
"brandingSettings": {
"description": "The \u003ccode\u003ebrandingSettings\u003c/code\u003e object encapsulates information about\nthe branding of the channel.",
"$ref": "ChannelBrandingSettings"
},
"etag": {
"type": "string",
"description": "Etag of this resource."
},
"kind": {
"default": "youtube#channel",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#channel\"\u003c/code\u003e.",
"type": "string"
},
"conversionPings": {
"$ref": "ChannelConversionPings",
"description": "The \u003ccode\u003econversionPings\u003c/code\u003e object encapsulates information about\nconversion pings that need to be respected by the channel."
},
"contentDetails": {
"$ref": "ChannelContentDetails",
"description": "The \u003ccode\u003econtentDetails\u003c/code\u003e object encapsulates information about the\nchannel's content."
},
"snippet": {
"$ref": "ChannelSnippet",
"description": "The \u003ccode\u003esnippet\u003c/code\u003e object contains basic details about the channel,\nsuch as its title, description, and thumbnail images."
},
"invideoPromotion": {
"$ref": "InvideoPromotion",
"description": "The \u003ccode\u003einvideoPromotion\u003c/code\u003e object encapsulates information about\npromotion campaign associated with the channel."
},
"status": {
"$ref": "ChannelStatus",
"description": "The \u003ccode\u003estatus\u003c/code\u003e object encapsulates information about the privacy\nstatus of the channel."
},
"auditDetails": {
"description": "The \u003ccode\u003eauditionDetails\u003c/code\u003e object encapsulates channel data\nthat is relevant for YouTube Partners during the audition process.",
"$ref": "ChannelAuditDetails"
},
"localizations": {
"type": "object",
"additionalProperties": {
"$ref": "ChannelLocalization"
},
"description": "Localizations for different languages"
},
"contentOwnerDetails": {
"$ref": "ChannelContentOwnerDetails",
"description": "The \u003ccode\u003econtentOwnerDetails\u003c/code\u003e object encapsulates channel data\nthat is relevant for YouTube Partners linked with the channel."
},
"topicDetails": {
"description": "The \u003ccode\u003etopicDetails\u003c/code\u003e object encapsulates information about\n\u003ca href=\"http://www.freebase.com\"\u003eFreebase\u003c/a\u003e topics associated with the\nchannel.",
"$ref": "ChannelTopicDetails"
},
"id": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the channel."
}
},
"id": "Channel"
},
"LiveChatFanFundingEventDetails": {
"id": "LiveChatFanFundingEventDetails",
"type": "object",
"properties": {
"currency": {
"description": "The currency in which the fund was made.",
"type": "string"
},
"userComment": {
"description": "The comment added by the user to this fan funding event.",
"type": "string"
},
"amountDisplayString": {
"description": "A rendered string that displays the fund amount and currency to the user.",
"type": "string"
},
"amountMicros": {
"type": "string",
"format": "uint64",
"description": "The amount of the fund."
}
}
},
"ActivityContentDetailsSubscription": {
"description": "Information about a channel that a user subscribed to.",
"id": "ActivityContentDetailsSubscription",
"type": "object",
"properties": {
"resourceId": {
"description": "The \u003ccode\u003eresourceId\u003c/code\u003e object contains information that\nidentifies the resource that the user subscribed to.",
"$ref": "ResourceId"
}
}
},
"MembershipsDetails": {
"properties": {
"membershipsDuration": {
"description": "Data about memberships duration without taking into consideration pricing\nlevels.",
"$ref": "MembershipsDuration"
},
"highestAccessibleLevel": {
"description": "Id of the highest level that the user has access to at the moment.",
"type": "string"
},
"highestAccessibleLevelDisplayName": {
"description": "Display name for the highest level that the user has access to at the\nmoment.",
"type": "string"
},
"membershipsDurationAtLevels": {
"items": {
"$ref": "MembershipsDurationAtLevel"
},
"type": "array",
"description": "Data about memberships duration on particular pricing levels."
},
"accessibleLevels": {
"type": "array",
"description": "Ids of all levels that the user has access to. This includes the currently\nactive level and all other levels that are included because of a higher\npurchase.",
"items": {
"type": "string"
}
}
},
"id": "MembershipsDetails",
"type": "object"
},
"LiveChatMessageListResponse": {
"id": "LiveChatMessageListResponse",
"type": "object",
"properties": {
"kind": {
"type": "string",
"default": "youtube#liveChatMessageListResponse",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#liveChatMessageListResponse\"\u003c/code\u003e."
},
"items": {
"type": "array",
"items": {
"$ref": "LiveChatMessage"
}
},
"offlineAt": {
"type": "string",
"description": "The date and time when the underlying stream went offline. The value is\nspecified in \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat."
},
"nextPageToken": {
"type": "string"
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"pollingIntervalMillis": {
"type": "integer",
"description": "The amount of time the client should wait before polling again.",
"format": "uint32"
},
"visitorId": {
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor.",
"type": "string"
},
"eventId": {
"type": "string",
"description": "Serialized EventId of the request which produced this response."
},
"pageInfo": {
"description": "General pagination information.",
"$ref": "PageInfo"
},
"tokenPagination": {
"$ref": "TokenPagination"
}
}
},
"CdnSettings": {
"description": "Brief description of the live stream cdn settings.",
"id": "CdnSettings",
"type": "object",
"properties": {
"format": {
"type": "string",
"description": "The format of the video stream that you are sending to Youtube. \u003cbr\u003e\u003cbr\u003e"
},
"resolution": {
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string",
"description": "The resolution of the inbound video data.",
"enum": [
"240p",
"360p",
"480p",
"720p",
"1080p",
"1440p",
"2160p",
"variable"
]
},
"ingestionInfo": {
"$ref": "IngestionInfo",
"description": "The \u003ccode\u003eingestionInfo\u003c/code\u003e object contains information that YouTube\nprovides that you need to transmit your RTMP or HTTP stream to YouTube."
},
"frameRate": {
"enum": [
"30fps",
"60fps",
"variable"
],
"description": "The frame rate of the inbound video data.",
"type": "string",
"enumDescriptions": [
"",
"",
""
]
},
"ingestionType": {
"enum": [
"rtmp",
"dash",
"webrtc",
"hls"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string",
"description": " The method or protocol used to transmit the video stream."
}
}
},
"SubscriptionContentDetails": {
"id": "SubscriptionContentDetails",
"description": "Details about the content to witch a subscription refers.",
"type": "object",
"properties": {
"newItemCount": {
"description": "The number of new items in the subscription since its content was last\nread.",
"format": "uint32",
"type": "integer"
},
"activityType": {
"enumDescriptions": [
"",
"",
""
],
"enum": [
"subscriptionActivityTypeUnspecified",
"all",
"uploads"
],
"description": "The type of activity this subscription is for\n(only uploads, everything).",
"type": "string"
},
"totalItemCount": {
"type": "integer",
"format": "uint32",
"description": "The approximate number of items that the subscription points to."
}
}
},
"ActivityContentDetailsUpload": {
"type": "object",
"id": "ActivityContentDetailsUpload",
"properties": {
"videoId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the uploaded video."
}
},
"description": "Information about the uploaded video."
},
"ChannelSectionListResponse": {
"type": "object",
"id": "ChannelSectionListResponse",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#channelSectionListResponse\"\u003c/code\u003e.",
"default": "youtube#channelSectionListResponse"
},
"eventId": {
"type": "string",
"description": "Serialized EventId of the request which produced this response."
},
"items": {
"items": {
"$ref": "ChannelSection"
},
"type": "array",
"description": "A list of ChannelSections that match the request criteria."
},
"visitorId": {
"type": "string",
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor."
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
}
}
},
"PlaylistSnippet": {
"type": "object",
"id": "PlaylistSnippet",
"description": "Basic details about a playlist, including title, description and thumbnails.",
"properties": {
"title": {
"description": "The playlist's title.",
"type": "string"
},
"publishedAt": {
"type": "string",
"description": "The date and time that the playlist was created. The value is specified\nin \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat."
},
"tags": {
"description": "Keyword tags associated with the playlist.",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string",
"description": "The playlist's description."
},
"channelTitle": {
"description": "The channel title of the channel that the video belongs to.",
"type": "string"
},
"thumbnails": {
"$ref": "ThumbnailDetails",
"description": "A map of thumbnail images associated with the playlist. For each object\nin the map, the key is the name of the thumbnail image, and the value\nis an object that contains other information about the thumbnail."
},
"channelId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the channel that\npublished the playlist."
},
"localized": {
"description": "Localized title and description, read-only.",
"$ref": "PlaylistLocalization"
},
"defaultLanguage": {
"description": "The language of the playlist's default title and description.",
"type": "string"
}
}
},
"I18nLanguageListResponse": {
"id": "I18nLanguageListResponse",
"properties": {
"kind": {
"type": "string",
"default": "youtube#i18nLanguageListResponse",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#i18nLanguageListResponse\"\u003c/code\u003e."
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"eventId": {
"description": "Serialized EventId of the request which produced this response.",
"type": "string"
},
"visitorId": {
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor.",
"type": "string"
},
"items": {
"type": "array",
"description": "A list of supported i18n languages. In this map, the i18n language ID is\nthe map key, and its value is the corresponding \u003ccode\u003ei18nLanguage\u003c/code\u003e\nresource.",
"items": {
"$ref": "I18nLanguage"
}
}
},
"type": "object"
},
"VideoStatus": {
"properties": {
"madeForKids": {
"type": "boolean"
},
"license": {
"enum": [
"youtube",
"creativeCommon"
],
"enumDescriptions": [
"",
""
],
"description": "The video's license.\n@mutable youtube.videos.insert youtube.videos.update",
"type": "string"
},
"publicStatsViewable": {
"type": "boolean",
"description": "This value indicates if the extended video statistics on the watch page\ncan be viewed by everyone. Note that the view count, likes, etc will still\nbe visible if this is disabled.\n@mutable youtube.videos.insert youtube.videos.update"
},
"rejectionReason": {
"type": "string",
"enum": [
"copyright",
"inappropriate",
"duplicate",
"termsOfUse",
"uploaderAccountSuspended",
"length",
"claim",
"uploaderAccountClosed",
"trademark",
"legal"
],
"description": "This value explains why YouTube rejected an uploaded video. This\nproperty is only present if the \u003ccode\u003euploadStatus\u003c/code\u003e property\nindicates that the upload was rejected.",
"enumDescriptions": [
"Copyright infringement.",
"Inappropriate video content.",
"Duplicate upload in the same channel.",
"Terms of use violation.",
"Uploader account was suspended.",
"Video duration was too long.",
"Blocked by content owner.",
"Uploader closed his/her account.",
"Trademark infringement.",
"An unspecified legal reason."
]
},
"selfDeclaredMadeForKids": {
"type": "boolean"
},
"publishAt": {
"type": "string",
"description": "The date and time when the video is scheduled to publish. It can be set\nonly if the privacy status of the video is private. The value is specified\nin \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat."
},
"failureReason": {
"type": "string",
"enumDescriptions": [
"Unable to convert video content.",
"Invalid file format.",
"Empty file.",
"File was too small.",
"Unsupported codec.",
"Upload wasn't finished."
],
"description": "This value explains why a video failed to upload. This property is\nonly present if the \u003ccode\u003euploadStatus\u003c/code\u003e property indicates that\nthe upload failed.",
"enum": [
"conversion",
"invalidFile",
"emptyFile",
"tooSmall",
"codec",
"uploadAborted"
]
},
"uploadStatus": {
"description": "The status of the uploaded video.",
"enumDescriptions": [
"Video has been uploaded but not processed yet.",
"Video has been successfully processed.",
"Processing has failed. See FailureReason.",
"Video has been rejected. See RejectionReason.",
"Video has been deleted."
],
"enum": [
"uploaded",
"processed",
"failed",
"rejected",
"deleted"
],
"type": "string"
},
"embeddable": {
"description": "This value indicates if the video can be embedded on another website.\n@mutable youtube.videos.insert youtube.videos.update",
"type": "boolean"
},
"privacyStatus": {
"description": "The video's privacy status.",
"enum": [
"public",
"unlisted",
"private"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"id": "VideoStatus",
"type": "object",
"description": "Basic details about a video category, such as its localized title.\nNext Id: 16"
},
"ImageSettings": {
"properties": {
"bannerMobileExtraHdImageUrl": {
"description": "Banner image. Mobile size high resolution (1440x395).",
"type": "string"
},
"smallBrandedBannerImageImapScript": {
"description": "The image map script for the small banner image.",
"$ref": "LocalizedProperty"
},
"bannerExternalUrl": {
"description": "This is used only in update requests; if it's set, we use this URL to\ngenerate all of the above banner URLs.",
"type": "string"
},
"largeBrandedBannerImageUrl": {
"$ref": "LocalizedProperty",
"description": "The URL for the 854px by 70px image that appears below the video player in\nthe expanded video view of the video watch page."
},
"bannerTabletExtraHdImageUrl": {
"type": "string",
"description": "Banner image. Tablet size extra high resolution (2560x424)."
},
"bannerImageUrl": {
"description": "Banner image. Desktop size (1060x175).",
"type": "string"
},
"bannerMobileImageUrl": {
"description": "Banner image. Mobile size (640x175).",
"type": "string"
},
"bannerMobileHdImageUrl": {
"type": "string",
"description": "Banner image. Mobile size high resolution (1280x360)."
},
"bannerTvMediumImageUrl": {
"type": "string",
"description": "Banner image. TV size medium resolution (1280x720)."
},
"bannerTvHighImageUrl": {
"type": "string",
"description": "Banner image. TV size high resolution (1920x1080)."
},
"trackingImageUrl": {
"description": "The URL for a 1px by 1px tracking pixel that can be used to collect\nstatistics for views of the channel or video pages.",
"type": "string"
},
"backgroundImageUrl": {
"description": "The URL for the background image shown on the video watch page. The image\nshould be 1200px by 615px, with a maximum file size of 128k.",
"$ref": "LocalizedProperty"
},
"bannerMobileLowImageUrl": {
"description": "Banner image. Mobile size low resolution (320x88).",
"type": "string"
},
"bannerTabletLowImageUrl": {
"description": "Banner image. Tablet size low resolution (1138x188).",
"type": "string"
},
"smallBrandedBannerImageUrl": {
"$ref": "LocalizedProperty",
"description": "The URL for the 640px by 70px banner image that appears below the video\nplayer in the default view of the video watch page.\nThe URL for the image that appears above the top-left corner of the video\nplayer. This is a 25-pixel-high image with a flexible width that cannot\nexceed 170 pixels."
},
"largeBrandedBannerImageImapScript": {
"$ref": "LocalizedProperty",
"description": "The image map script for the large banner image."
},
"bannerTvImageUrl": {
"type": "string",
"description": "Banner image. TV size extra high resolution (2120x1192)."
},
"bannerTabletImageUrl": {
"type": "string",
"description": "Banner image. Tablet size (1707x283)."
},
"bannerTabletHdImageUrl": {
"type": "string",
"description": "Banner image. Tablet size high resolution (2276x377)."
},
"watchIconImageUrl": {
"type": "string"
},
"bannerMobileMediumHdImageUrl": {
"type": "string",
"description": "Banner image. Mobile size medium/high resolution (960x263)."
},
"bannerTvLowImageUrl": {
"description": "Banner image. TV size low resolution (854x480).",
"type": "string"
}
},
"id": "ImageSettings",
"description": "Branding properties for images associated with the channel.",
"type": "object"
},
"CommentThreadListResponse": {
"type": "object",
"id": "CommentThreadListResponse",
"properties": {
"pageInfo": {
"$ref": "PageInfo",
"description": "General pagination information."
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"kind": {
"default": "youtube#commentThreadListResponse",
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#commentThreadListResponse\"\u003c/code\u003e."
},
"tokenPagination": {
"$ref": "TokenPagination"
},
"nextPageToken": {
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the next page in the result set.",
"type": "string"
},
"eventId": {
"description": "Serialized EventId of the request which produced this response.",
"type": "string"
},
"items": {
"description": "A list of comment threads that match the request criteria.",
"items": {
"$ref": "CommentThread"
},
"type": "array"
},
"visitorId": {
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor.",
"type": "string"
}
}
},
"Member": {
"id": "Member",
"description": "A \u003ccode\u003e\u003cstrong\u003emember\u003c/strong\u003e\u003c/code\u003e resource represents a member for a\nYouTube channel. A member provides recurring monetary support to a creator\nand receives special benefits.",
"type": "object",
"properties": {
"kind": {
"default": "youtube#member",
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#member\"\u003c/code\u003e."
},
"etag": {
"type": "string",
"description": "Etag of this resource."
},
"snippet": {
"description": "The \u003ccode\u003esnippet\u003c/code\u003e object contains basic details about the member.",
"$ref": "MemberSnippet"
}
}
},
"PromotedItemId": {
"description": "Describes a single promoted item id. It is a union of various possible types.",
"properties": {
"videoId": {
"type": "string",
"description": "If the promoted item represents a video, this field represents the unique\nYouTube ID identifying it. This field will be present only if\n\u003ccode\u003etype\u003c/code\u003e has the value \u003ccode\u003evideo\u003c/code\u003e."
},
"type": {
"enumDescriptions": [
"",
"",
""
],
"enum": [
"video",
"website",
"recentUpload"
],
"type": "string",
"description": "Describes the type of the promoted item."
},
"recentlyUploadedBy": {
"type": "string",
"description": "If type is recentUpload, this field identifies the channel from which to\ntake the recent upload. If missing, the channel is assumed to be the same\nchannel for which the invideoPromotion is set."
},
"websiteUrl": {
"type": "string",
"description": "If the promoted item represents a website, this field represents the url\npointing to the website. This field will be present only if\n\u003ccode\u003etype\u003c/code\u003e has the value \u003ccode\u003ewebsite\u003c/code\u003e."
}
},
"type": "object",
"id": "PromotedItemId"
},
"ThirdPartyLink": {
"type": "object",
"description": "A \u003ccode\u003e\u003cstrong\u003ethird party account link\u003c/strong\u003e\u003c/code\u003e resource represents\na link between a YouTube account or a channel and an account on a\nthird-party service.",
"id": "ThirdPartyLink",
"properties": {
"linkingToken": {
"type": "string",
"description": "The \u003ccode\u003elinking_token\u003c/code\u003e identifies a YouTube account and\nchannel with which the third party account is linked."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#thirdPartyLink\"\u003c/code\u003e.",
"default": "youtube#thirdPartyLink"
},
"etag": {
"type": "string",
"description": "Etag of this resource"
},
"snippet": {
"description": "The \u003ccode\u003esnippet\u003c/code\u003e object contains basic details about the third-\nparty account link.",
"$ref": "ThirdPartyLinkSnippet"
},
"status": {
"$ref": "ThirdPartyLinkStatus",
"description": "The \u003ccode\u003estatus\u003c/code\u003e object contains information about the status\nof the link."
}
}
},
"LiveChatMessageAuthorDetails": {
"id": "LiveChatMessageAuthorDetails",
"properties": {
"channelId": {
"type": "string",
"description": "The YouTube channel ID."
},
"channelUrl": {
"type": "string",
"description": "The channel's URL."
},
"displayName": {
"description": "The channel's display name.",
"type": "string"
},
"isChatOwner": {
"description": "Whether the author is the owner of the live chat.",
"type": "boolean"
},
"isChatSponsor": {
"description": "Whether the author is a sponsor of the live chat.",
"type": "boolean"
},
"isVerified": {
"description": "Whether the author's identity has been verified by YouTube.",
"type": "boolean"
},
"isChatModerator": {
"description": "Whether the author is a moderator of the live chat.",
"type": "boolean"
},
"profileImageUrl": {
"description": "The channels's avatar URL.",
"type": "string"
}
},
"type": "object"
},
"ActivityContentDetailsPlaylistItem": {
"type": "object",
"properties": {
"playlistId": {
"description": "The value that YouTube uses to uniquely identify the playlist.",
"type": "string"
},
"resourceId": {
"description": "The \u003ccode\u003eresourceId\u003c/code\u003e object contains information about the\nresource that was added to the playlist.",
"$ref": "ResourceId"
},
"playlistItemId": {
"type": "string",
"description": "ID of the item within the playlist."
}
},
"id": "ActivityContentDetailsPlaylistItem",
"description": "Information about a new playlist item."
},
"VideoPlayer": {
"type": "object",
"properties": {
"embedWidth": {
"description": "The embed width",
"type": "string",
"format": "int64"
},
"embedHtml": {
"description": "An \u003ccode\u003e<iframe>\u003c/code\u003e tag that embeds a player that will\nplay the video.",
"type": "string"
},
"embedHeight": {
"format": "int64",
"type": "string"
}
},
"description": "Player to be used for a video playback.",
"id": "VideoPlayer"
},
"LanguageTag": {
"type": "object",
"id": "LanguageTag",
"properties": {
"value": {
"type": "string"
}
}
},
"ActivitySnippet": {
"type": "object",
"id": "ActivitySnippet",
"description": "Basic details about an activity, including title, description, thumbnails,\nactivity type and group.\nNext ID: 12",
"properties": {
"type": {
"type": "string",
"description": "The type of activity that the resource describes.",
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"enum": [
"typeUnspecified",
"upload",
"like",
"favorite",
"comment",
"subscription",
"playlistItem",
"recommendation",
"bulletin",
"social",
"channelItem",
"promotedItem"
]
},
"thumbnails": {
"$ref": "ThumbnailDetails",
"description": "A map of thumbnail images associated with the resource that is primarily\nassociated with the activity. For each object in the map, the key is the\nname of the thumbnail image, and the value is an object that contains\nother information about the thumbnail."
},
"description": {
"description": "The description of the resource primarily associated with the activity.\n@mutable youtube.activities.insert",
"type": "string"
},
"channelId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the channel associated\nwith the activity."
},
"title": {
"type": "string",
"description": "The title of the resource primarily associated with the activity."
},
"channelTitle": {
"type": "string",
"description": "Channel title for the channel responsible for this activity"
},
"publishedAt": {
"type": "string",
"description": "The date and time that the video was uploaded. The value is specified\nin \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat."
},
"groupId": {
"type": "string",
"description": "The group ID associated with the activity. A group ID identifies user\nevents that are associated with the same user and resource. For example,\nif a user rates a video and marks the same video as a favorite, the\nentries for those events would have the same group ID in the user's\nactivity feed. In your user interface, you can avoid repetition by\ngrouping events with the same \u003ccode\u003egroupId\u003c/code\u003e value."
}
}
},
"VideoFileDetailsVideoStream": {
"properties": {
"heightPixels": {
"type": "integer",
"format": "uint32",
"description": "The encoded video content's height in pixels."
},
"rotation": {
"enum": [
"none",
"clockwise",
"upsideDown",
"counterClockwise",
"other"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"description": "The amount that YouTube needs to rotate the original source content\nto properly display the video.",
"type": "string"
},
"widthPixels": {
"type": "integer",
"format": "uint32",
"description": "The encoded video content's width in pixels. You can calculate the\nvideo's encoding aspect ratio as\n\u003ccode\u003ewidth_pixels\u003c/code\u003e / \u003ccode\u003eheight_pixels\u003c/code\u003e."
},
"vendor": {
"type": "string",
"description": "A value that uniquely identifies a video vendor. Typically, the value is\na four-letter vendor code."
},
"frameRateFps": {
"type": "number",
"format": "double",
"description": "The video stream's frame rate, in frames per second."
},
"bitrateBps": {
"description": "The video stream's bitrate, in bits per second.",
"type": "string",
"format": "uint64"
},
"codec": {
"type": "string",
"description": "The video codec that the stream uses."
},
"aspectRatio": {
"type": "number",
"format": "double",
"description": "The video content's display aspect ratio, which specifies the aspect\nratio in which the video should be displayed."
}
},
"type": "object",
"description": "Information about a video stream.",
"id": "VideoFileDetailsVideoStream"
},
"LiveChatBanSnippet": {
"properties": {
"bannedUserDetails": {
"$ref": "ChannelProfileDetails"
},
"banDurationSeconds": {
"description": "The duration of a ban, only filled if the ban has type TEMPORARY.",
"type": "string",
"format": "uint64"
},
"liveChatId": {
"description": "The chat this ban is pertinent to.",
"type": "string"
},
"type": {
"enum": [
"liveChatBanTypeUnspecified",
"permanent",
"temporary"
],
"enumDescriptions": [
"An invalid ban type.",
"A permanent ban.",
"A temporary ban."
],
"type": "string",
"description": "The type of ban."
}
},
"type": "object",
"id": "LiveChatBanSnippet"
},
"MembershipsDurationAtLevel": {
"id": "MembershipsDurationAtLevel",
"properties": {
"level": {
"description": "Pricing level ID.",
"type": "string"
},
"memberSince": {
"description": "The date and time when the user became a continuous member for the given\nlevel.",
"type": "string"
},
"memberTotalDurationMonths": {
"description": "The cumulative time the user has been a member for the given level in\ncomplete months (the time is rounded down to the nearest integer).",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"TestItem": {
"id": "TestItem",
"properties": {
"id": {
"type": "string"
},
"snippet": {
"$ref": "TestItemTestItemSnippet"
}
},
"type": "object"
},
"GuideCategorySnippet": {
"type": "object",
"id": "GuideCategorySnippet",
"properties": {
"title": {
"description": "Description of the guide category.",
"type": "string"
},
"channelId": {
"type": "string"
}
},
"description": "Basic details about a guide category."
},
"ActivityContentDetailsPromotedItem": {
"type": "object",
"properties": {
"creativeViewUrl": {
"description": "The URL the client should ping to indicate that the user was shown this\npromoted item.",
"type": "string"
},
"forecastingUrl": {
"type": "array",
"description": "The list of forecasting URLs. The client should ping all of these URLs\nwhen a promoted item is not available, to indicate that a promoted item\ncould have been shown.",
"items": {
"type": "string"
}
},
"customCtaButtonText": {
"type": "string",
"description": "The custom call-to-action button text. If specified, it will override\nthe default button text for the cta_type."
},
"clickTrackingUrl": {
"type": "string",
"description": "The URL the client should ping to indicate that the user clicked through\non this promoted item."
},
"descriptionText": {
"type": "string",
"description": "The text description to accompany the promoted item."
},
"destinationUrl": {
"description": "The URL the client should direct the user to, if the user chooses to\nvisit the advertiser's website.",
"type": "string"
},
"ctaType": {
"enumDescriptions": [
"",
""
],
"description": "The type of call-to-action, a message to the user indicating action that\ncan be taken.",
"type": "string",
"enum": [
"ctaTypeUnspecified",
"visitAdvertiserSite"
]
},
"adTag": {
"type": "string",
"description": "The URL the client should fetch to request a promoted item."
},
"videoId": {
"description": "The ID that YouTube uses to uniquely identify the promoted video.",
"type": "string"
},
"impressionUrl": {
"type": "array",
"description": "The list of impression URLs. The client should ping all of these URLs to\nindicate that the user was shown this promoted item.",
"items": {
"type": "string"
}
}
},
"id": "ActivityContentDetailsPromotedItem",
"description": "Details about a resource which is being promoted."
},
"CommentListResponse": {
"type": "object",
"properties": {
"tokenPagination": {
"$ref": "TokenPagination"
},
"nextPageToken": {
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the next page in the result set.",
"type": "string"
},
"visitorId": {
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor.",
"type": "string"
},
"eventId": {
"type": "string",
"description": "Serialized EventId of the request which produced this response."
},
"items": {
"description": "A list of comments that match the request criteria.",
"items": {
"$ref": "Comment"
},
"type": "array"
},
"pageInfo": {
"description": "General pagination information.",
"$ref": "PageInfo"
},
"etag": {
"type": "string",
"description": "Etag of this resource."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#commentListResponse\"\u003c/code\u003e.",
"default": "youtube#commentListResponse",
"type": "string"
}
},
"id": "CommentListResponse"
},
"ActivityContentDetailsRecommendation": {
"type": "object",
"properties": {
"resourceId": {
"$ref": "ResourceId",
"description": "The \u003ccode\u003eresourceId\u003c/code\u003e object contains information that\nidentifies the recommended resource."
},
"reason": {
"type": "string",
"enumDescriptions": [
"",
"",
"",
""
],
"description": "The reason that the resource is recommended to the user.",
"enum": [
"reasonUnspecified",
"videoFavorited",
"videoLiked",
"videoWatched"
]
},
"seedResourceId": {
"$ref": "ResourceId",
"description": "The \u003ccode\u003eseedResourceId\u003c/code\u003e object contains information about\nthe resource that caused the recommendation."
}
},
"description": "Information that identifies the recommended resource.",
"id": "ActivityContentDetailsRecommendation"
},
"ChannelStatistics": {
"description": "Statistics about a channel: number of subscribers, number of videos in the\nchannel, etc.",
"type": "object",
"id": "ChannelStatistics",
"properties": {
"videoCount": {
"type": "string",
"description": "The number of videos uploaded to the channel.",
"format": "uint64"
},
"commentCount": {
"description": "The number of comments for the channel.",
"type": "string",
"format": "uint64"
},
"viewCount": {
"type": "string",
"format": "uint64",
"description": "The number of times the channel has been viewed."
},
"hiddenSubscriberCount": {
"type": "boolean",
"description": "Whether or not the number of subscribers is shown for this user."
},
"subscriberCount": {
"description": "The number of subscribers that the channel has.",
"type": "string",
"format": "uint64"
}
}
},
"VideoRating": {
"id": "VideoRating",
"properties": {
"videoId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the video."
},
"rating": {
"enum": [
"none",
"like",
"dislike"
],
"description": "Rating of a video.",
"type": "string",
"enumDescriptions": [
"",
"",
""
]
}
},
"description": "Basic details about rating of a video.",
"type": "object"
},
"ChannelLocalization": {
"properties": {
"title": {
"type": "string",
"description": "The localized strings for channel's title."
},
"description": {
"description": "The localized strings for channel's description.",
"type": "string"
}
},
"type": "object",
"description": "Channel localization setting",
"id": "ChannelLocalization"
},
"GuideCategoryListResponse": {
"properties": {
"nextPageToken": {
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the next page in the result set.",
"type": "string"
},
"eventId": {
"description": "Serialized EventId of the request which produced this response.",
"type": "string"
},
"kind": {
"type": "string",
"default": "youtube#guideCategoryListResponse",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#guideCategoryListResponse\"\u003c/code\u003e."
},
"items": {
"type": "array",
"description": "A list of categories that can be associated with YouTube channels. In this\nmap, the category ID is the map key, and its value is the corresponding\n\u003ccode\u003eguideCategory\u003c/code\u003e resource.",
"items": {
"$ref": "GuideCategory"
}
},
"prevPageToken": {
"type": "string",
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the previous page in the result set."
},
"etag": {
"type": "string",
"description": "Etag of this resource."
},
"pageInfo": {
"$ref": "PageInfo"
},
"tokenPagination": {
"$ref": "TokenPagination"
},
"visitorId": {
"type": "string",
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor."
}
},
"type": "object",
"id": "GuideCategoryListResponse"
},
"PlaylistItem": {
"properties": {
"id": {
"description": "The ID that YouTube uses to uniquely identify the playlist item.",
"type": "string"
},
"snippet": {
"$ref": "PlaylistItemSnippet",
"description": "The \u003ccode\u003esnippet\u003c/code\u003e object contains basic details about the\nplaylist item, such as its title and position in the playlist."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#playlistItem\"\u003c/code\u003e.",
"default": "youtube#playlistItem",
"type": "string"
},
"etag": {
"type": "string",
"description": "Etag of this resource."
},
"status": {
"$ref": "PlaylistItemStatus",
"description": "The \u003ccode\u003estatus\u003c/code\u003e object contains information about the playlist\nitem's privacy status."
},
"contentDetails": {
"$ref": "PlaylistItemContentDetails",
"description": "The \u003ccode\u003econtentDetails\u003c/code\u003e object is included in the resource if\nthe included item is a YouTube video. The object contains additional\ninformation about the video."
}
},
"type": "object",
"description": "A \u003ccode\u003e\u003cstrong\u003eplaylistItem\u003c/strong\u003e\u003c/code\u003e resource identifies\nanother resource, such as a video, that is included in a playlist. In\naddition, the \u003ccode\u003eplaylistItem \u003c/code\u003e resource contains details\nabout the included resource that pertain specifically to how that\nresource is used in that playlist.\u003cbr/\u003e\u003cbr/\u003e YouTube uses playlists to\nidentify special collections of videos for a channel, such as:\n \u003cul\u003e\n \u003cli\u003euploaded videos\u003c/li\u003e\n \u003cli\u003efavorite videos\u003c/li\u003e\n \u003cli\u003epositively rated (liked) videos\u003c/li\u003e\n \u003cli\u003ewatch history\u003c/li\u003e\n \u003cli\u003ewatch later\u003c/li\u003e\n \u003c/ul\u003e\n To be more specific, these lists are associated with a channel, which\nis a collection of a person, group, or company's videos, playlists,\nand other YouTube information.\n\u003cbr/\u003e\u003cbr/\u003e\n You can retrieve the playlist IDs for each of these lists from the\n\u003ccode\u003e \u003ca href=\\\"/youtube/v3/docs/channels\\\"\u003echannel resource\u003c/a\u003e\n\u003c/code\u003e for a given channel. You can then use the \u003ccode\u003e \u003ca\nhref=\\\"/youtube/v3/docs/playlistItems/list\\\"\u003e\nplaylistItems.list\u003c/a\u003e\u003c/code\u003e method to retrieve any of those\nlists. You can also add or remove items from those lists by calling\nthe \u003ccode\u003e \u003ca href=\\\"/youtube/v3/docs/playlistItems/insert\\\"\u003e\nplaylistItems.insert\u003c/a\u003e\u003c/code\u003e and \u003ccode\u003e \u003ca\nhref=\\\"/youtube/v3/docs/playlistItems/delete\\\"\u003e\nplaylistItems.delete\u003c/a\u003e\u003c/code\u003e methods. For example, if a user gives\na positive rating to a video, you would insert that video into the\nliked videos playlist for that user's channel.",
"id": "PlaylistItem"
},
"MembershipsLevel": {
"properties": {
"id": {
"type": "string",
"description": "The ID that YouTube assigns to uniquely identify the memberships level."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#membershipsLevelListResponse\"\u003c/code\u003e.",
"default": "youtube#membershipsLevel"
},
"etag": {
"type": "string",
"description": "Etag of this resource."
},
"snippet": {
"description": "The \u003ccode\u003esnippet\u003c/code\u003e object contains basic details about the level.",
"$ref": "MembershipsLevelSnippet"
}
},
"id": "MembershipsLevel",
"type": "object",
"description": "A \u003ccode\u003e\u003cstrong\u003emembershipsLevel\u003c/strong\u003e\u003c/code\u003e resource represents an offer\nmade by YouTube creators for their fans. Users can become members of the\nchannel by joining one of the available levels. They will provide recurring\nmonetary support and receives special benefits."
},
"VideoSnippet": {
"type": "object",
"id": "VideoSnippet",
"description": "Basic details about a video, including title, description, uploader,\nthumbnails and category.",
"properties": {
"liveBroadcastContent": {
"description": "Indicates if the video is an upcoming/active live broadcast.\nOr it's \"none\" if the video is not an upcoming/active live broadcast.",
"type": "string",
"enum": [
"none",
"upcoming",
"live",
"completed"
],
"enumDescriptions": [
"",
"",
"",
""
]
},
"title": {
"type": "string",
"description": "The video's title.\n@mutable youtube.videos.insert youtube.videos.update"
},
"categoryId": {
"description": "The YouTube \u003ca href=\"/youtube/v3/docs/videoCategories/list\"\u003evideo\ncategory\u003c/a\u003e associated with the video.",
"type": "string"
},
"localized": {
"$ref": "VideoLocalization",
"description": "Localized snippet selected with the hl parameter. If no such localization\nexists, this field is populated with the default snippet. (Read-only)"
},
"description": {
"description": "The video's description.\n@mutable youtube.videos.insert youtube.videos.update",
"type": "string"
},
"thumbnails": {
"$ref": "ThumbnailDetails",
"description": "A map of thumbnail images associated with the video. For each object in the\nmap, the key is the name of the thumbnail image, and the value is an object\nthat contains other information about the thumbnail."
},
"publishedAt": {
"type": "string",
"description": "The date and time that the video was uploaded. The value is specified\nin \u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat."
},
"defaultLanguage": {
"description": "The language of the videos's default snippet.",
"type": "string"
},
"channelId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the channel that the\nvideo was uploaded to."
},
"defaultAudioLanguage": {
"description": "The \u003ccode\u003edefault_audio_language\u003c/code\u003e property specifies the language\nspoken in the video's default audio track.",
"type": "string"
},
"tags": {
"type": "array",
"description": "A list of keyword tags associated with the video. Tags may contain spaces.",
"items": {
"type": "string"
}
},
"channelTitle": {
"type": "string",
"description": "Channel title for the channel that the video belongs to."
}
}
},
"Entity": {
"type": "object",
"properties": {
"typeId": {
"type": "string"
},
"url": {
"type": "string"
},
"id": {
"type": "string"
}
},
"id": "Entity"
},
"CommentThreadSnippet": {
"type": "object",
"description": "Basic details about a comment thread.",
"properties": {
"totalReplyCount": {
"format": "uint32",
"type": "integer",
"description": "The total number of replies (not including the top level comment)."
},
"topLevelComment": {
"$ref": "Comment",
"description": "The top level comment of this thread."
},
"isPublic": {
"description": "Whether the thread (and therefore all its comments) is visible to all\nYouTube users.",
"type": "boolean"
},
"videoId": {
"type": "string",
"description": "The ID of the video the comments refer to, if any. No video_id implies a\nchannel discussion comment."
},
"canReply": {
"type": "boolean",
"description": "Whether the current viewer of the thread can reply to it. This is viewer\nspecific - other viewers may see a different value for this field."
},
"channelId": {
"description": "The YouTube channel the comments in the thread refer to or the channel\nwith the video the comments refer to. If video_id isn't set the comments\nrefer to the channel itself.",
"type": "string"
}
},
"id": "CommentThreadSnippet"
},
"ActivityContentDetailsLike": {
"id": "ActivityContentDetailsLike",
"type": "object",
"description": "Information about a resource that received a positive (like) rating.",
"properties": {
"resourceId": {
"description": "The \u003ccode\u003eresourceId\u003c/code\u003e object contains information that identifies\nthe rated resource.",
"$ref": "ResourceId"
}
}
},
"AbuseReport": {
"type": "object",
"id": "AbuseReport",
"properties": {
"relatedEntities": {
"type": "array",
"items": {
"$ref": "RelatedEntity"
}
},
"description": {
"type": "string"
},
"abuseTypes": {
"type": "array",
"items": {
"$ref": "AbuseType"
}
},
"subject": {
"$ref": "Entity"
}
}
},
"CommentThread": {
"properties": {
"id": {
"description": "The ID that YouTube uses to uniquely identify the comment thread.",
"type": "string"
},
"kind": {
"default": "youtube#commentThread",
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#commentThread\"\u003c/code\u003e."
},
"snippet": {
"$ref": "CommentThreadSnippet",
"description": "The \u003ccode\u003esnippet\u003c/code\u003e object contains basic details about the comment\nthread and also the top level comment."
},
"replies": {
"description": "The \u003ccode\u003ereplies\u003c/code\u003e object contains a limited number of replies (if\nany) to the top level comment found in the snippet.",
"$ref": "CommentThreadReplies"
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
}
},
"description": "A \u003ccode\u003e\u003cstrong\u003ecomment thread\u003c/strong\u003e\u003c/code\u003e represents information that\napplies to a top level comment and all its replies. It can also include the\ntop level comment itself and some of the replies.",
"type": "object",
"id": "CommentThread"
},
"SuperChatEvent": {
"properties": {
"snippet": {
"description": "The `snippet` object contains basic details about the Super Chat event.",
"$ref": "SuperChatEventSnippet"
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string\n`\"youtube#superChatEvent\"`.",
"type": "string",
"default": "youtube#superChatEvent"
},
"id": {
"type": "string",
"description": "The ID that YouTube assigns to uniquely identify the Super Chat event."
}
},
"type": "object",
"description": "A `__superChatEvent__` resource represents a Super Chat purchase on a YouTube\nchannel.",
"id": "SuperChatEvent"
},
"LiveStreamStatus": {
"type": "object",
"description": "Brief description of the live stream status.",
"properties": {
"healthStatus": {
"$ref": "LiveStreamHealthStatus",
"description": "The health status of the stream."
},
"streamStatus": {
"enum": [
"created",
"ready",
"active",
"inactive",
"error"
],
"type": "string",
"enumDescriptions": [
"",
"",
"",
"",
""
]
}
},
"id": "LiveStreamStatus"
},
"InvideoBranding": {
"id": "InvideoBranding",
"properties": {
"targetChannelId": {
"description": "The channel to which this branding links. If not present it defaults to\nthe current channel.",
"type": "string"
},
"imageBytes": {
"type": "string",
"format": "byte",
"description": "The bytes the uploaded image. Only used in api to youtube communication."
},
"imageUrl": {
"description": "The url of the uploaded image. Only used in apiary to api communication.",
"type": "string"
},
"timing": {
"description": "The temporal position within the video where watermark will be displayed.",
"$ref": "InvideoTiming"
},
"position": {
"description": "The spatial position within the video where the branding watermark will be\ndisplayed.",
"$ref": "InvideoPosition"
}
},
"type": "object",
"description": "LINT.IfChange\nDescribes an invideo branding."
},
"ActivityContentDetailsChannelItem": {
"id": "ActivityContentDetailsChannelItem",
"properties": {
"resourceId": {
"description": "The \u003ccode\u003eresourceId\u003c/code\u003e object contains information that\nidentifies the resource that was added to the channel.",
"$ref": "ResourceId"
}
},
"type": "object",
"description": "Details about a resource which was added to a channel."
},
"ChannelStatus": {
"description": "JSON template for the status part of a channel.",
"type": "object",
"id": "ChannelStatus",
"properties": {
"longUploadsStatus": {
"enumDescriptions": [
"",
"",
"",
""
],
"description": "The long uploads status of this channel. See\nhttps://support.google.com/youtube/answer/71673 for more information.",
"enum": [
"longUploadsUnspecified",
"allowed",
"eligible",
"disallowed"
],
"type": "string"
},
"selfDeclaredMadeForKids": {
"type": "boolean"
},
"madeForKids": {
"type": "boolean"
},
"privacyStatus": {
"type": "string",
"enumDescriptions": [
"",
"",
""
],
"enum": [
"public",
"unlisted",
"private"
],
"description": "Privacy status of the channel."
},
"isLinked": {
"description": "If true, then the user is linked to either a YouTube username or G+\naccount. Otherwise, the user doesn't have a public YouTube identity.",
"type": "boolean"
}
}
},
"LiveStreamListResponse": {
"type": "object",
"properties": {
"nextPageToken": {
"type": "string",
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the next page in the result set."
},
"etag": {
"type": "string",
"description": "Etag of this resource."
},
"prevPageToken": {
"type": "string",
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the previous page in the result set."
},
"pageInfo": {
"$ref": "PageInfo"
},
"tokenPagination": {
"$ref": "TokenPagination"
},
"visitorId": {
"type": "string",
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor."
},
"kind": {
"default": "youtube#liveStreamListResponse",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#liveStreamListResponse\"\u003c/code\u003e.",
"type": "string"
},
"eventId": {
"type": "string",
"description": "Serialized EventId of the request which produced this response."
},
"items": {
"type": "array",
"description": "A list of live streams that match the request criteria.",
"items": {
"$ref": "LiveStream"
}
}
},
"id": "LiveStreamListResponse"
},
"Comment": {
"id": "Comment",
"description": "A \u003ccode\u003e\u003cstrong\u003ecomment\u003c/strong\u003e\u003c/code\u003e represents a single YouTube comment.",
"properties": {
"snippet": {
"description": "The \u003ccode\u003esnippet\u003c/code\u003e object contains basic details about the comment.",
"$ref": "CommentSnippet"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#comment\"\u003c/code\u003e.",
"default": "youtube#comment",
"type": "string"
},
"id": {
"description": "The ID that YouTube uses to uniquely identify the comment.",
"type": "string"
},
"etag": {
"type": "string",
"description": "Etag of this resource."
}
},
"type": "object"
},
"MembershipsLevelListResponse": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#membershipsLevelListResponse\"\u003c/code\u003e.",
"default": "youtube#membershipsLevelListResponse",
"type": "string"
},
"etag": {
"type": "string",
"description": "Etag of this resource."
},
"visitorId": {
"type": "string",
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor."
},
"eventId": {
"description": "Serialized EventId of the request which produced this response.",
"type": "string"
},
"items": {
"description": "A list of pricing levels offered by a creator to the fans.",
"items": {
"$ref": "MembershipsLevel"
},
"type": "array"
}
},
"type": "object",
"id": "MembershipsLevelListResponse"
},
"VideoListResponse": {
"type": "object",
"properties": {
"visitorId": {
"description": "The \u003ccode\u003evisitorId\u003c/code\u003e identifies the visitor.",
"type": "string"
},
"prevPageToken": {
"type": "string",
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the previous page in the result set."
},
"items": {
"items": {
"$ref": "Video"
},
"type": "array"
},
"pageInfo": {
"description": "General pagination information.",
"$ref": "PageInfo"
},
"nextPageToken": {
"type": "string",
"description": "The token that can be used as the value of the \u003ccode\u003epageToken\u003c/code\u003e\nparameter to retrieve the next page in the result set."
},
"kind": {
"default": "youtube#videoListResponse",
"description": "Identifies what kind of resource this is. Value: the fixed string\n\u003ccode\u003e\"youtube#videoListResponse\"\u003c/code\u003e.",
"type": "string"
},
"eventId": {
"description": "Serialized EventId of the request which produced this response.",
"type": "string"
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"tokenPagination": {
"$ref": "TokenPagination"
}
},
"id": "VideoListResponse"
},
"IngestionInfo": {
"description": "Describes information necessary for ingesting an RTMP or an HTTP stream.",
"id": "IngestionInfo",
"properties": {
"rtmpsIngestionAddress": {
"description": "This ingestion url may be used instead of\n\u003ccode\u003eingestionAddress\u003c/code\u003e in order to stream via RTMPS. Not applicable\nto non-RTMP streams.",
"type": "string"
},
"ingestionAddress": {
"type": "string",
"description": "The primary ingestion URL that you should use to stream video to\nYouTube. You must stream video to this URL.\u003cbr\u003e\u003cbr\u003e\nDepending on which application or tool you use to encode\nyour video stream, you may need to enter the stream URL and stream\nname separately or you may need to concatenate them in the following\nformat:\u003cbr\u003e\u003cpre\u003e\u003cstrong\u003eSTREAM_URL/STREAM_NAME\u003c/strong\u003e\u003c/pre\u003e"
},
"rtmpsBackupIngestionAddress": {
"description": "This ingestion url may be used instead of\n\u003ccode\u003ebackupIngestionAddress\u003c/code\u003e in order to stream via RTMPS. Not\napplicable to non-RTMP streams.",
"type": "string"
},
"streamName": {
"type": "string",
"description": "The HTTP or RTMP stream name that YouTube assigns to the video stream."
},
"backupIngestionAddress": {
"type": "string",
"description": "The backup ingestion URL that you should use to stream video to\nYouTube. You have the option of simultaneously streaming the content\nthat you are sending to the \u003ccode\u003eingestionAddress\u003c/code\u003e to this URL."
}
},
"type": "object"
},
"SubscriptionSubscriberSnippet": {
"type": "object",
"id": "SubscriptionSubscriberSnippet",
"description": "Basic details about a subscription's subscriber including title,\ndescription, channel ID and thumbnails.",
"properties": {
"channelId": {
"description": "The channel ID of the subscriber.",
"type": "string"
},
"title": {
"type": "string",
"description": "The title of the subscriber."
},
"description": {
"description": "The description of the subscriber.",
"type": "string"
},
"thumbnails": {
"description": "Thumbnails for this subscriber.",
"$ref": "ThumbnailDetails"
}
}
},
"VideoTopicDetails": {
"properties": {
"topicIds": {
"description": "A list of Freebase topic IDs that are centrally associated with the video.\nThese are topics that are centrally featured in the video, and it can be\nsaid that the video is mainly about each of these. You can retrieve\ninformation about each topic using the \u003c a\nhref=\"http://wiki.freebase.com/wiki/Topic_API\"\u003eFreebase Topic API\u003c/a\u003e.",
"items": {
"type": "string"
},
"type": "array"
},
"relevantTopicIds": {
"type": "array",
"description": "Similar to topic_id, except that these topics are merely relevant to the\nvideo. These are topics that may be mentioned in, or appear in the video.\nYou can retrieve information about each topic using \u003ca\nhref=\"http://wiki.freebase.com/wiki/Topic_API\"\u003eFreebase Topic API\u003c/a\u003e.",
"items": {
"type": "string"
}
},
"topicCategories": {
"description": "A list of Wikipedia URLs that provide a high-level description of the\nvideo's content.",
"items": {
"type": "string"
},
"type": "array"
}
},
"description": "Freebase topic information related to the video.",
"id": "VideoTopicDetails",
"type": "object"
},
"LiveStreamSnippet": {
"type": "object",
"properties": {
"publishedAt": {
"description": "The date and time that the stream was created. The value is specified in\n\u003ca href=\"//www.w3.org/TR/NOTE-datetime\"\u003eISO 8601\u003c/a\u003e\nformat.",
"type": "string"
},
"description": {
"description": "The stream's description. The value cannot be longer than 10000\ncharacters.",
"type": "string"
},
"title": {
"description": "The stream's title. The value must be between 1 and 128 characters long.",
"type": "string"
},
"isDefaultStream": {
"type": "boolean"
},
"channelId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the channel that\nis transmitting the stream."
}
},
"id": "LiveStreamSnippet"
},
"CommentThreadReplies": {
"description": "Comments written in (direct or indirect) reply to the top level comment.",
"properties": {
"comments": {
"items": {
"$ref": "Comment"
},
"description": "A limited number of replies. Unless the number of replies returned equals\ntotal_reply_count in the snippet the returned replies are only a subset\nof the total number of replies.",
"type": "array"
}
},
"type": "object",
"id": "CommentThreadReplies"
},
"ChannelToStoreLinkDetails": {
"properties": {
"storeUrl": {
"description": "Landing page of the store.",
"type": "string"
},
"storeName": {
"type": "string",
"description": "Name of the store."
}
},
"type": "object",
"description": "Information specific to a store on a merchandising platform linked to a\nYouTube channel.",
"id": "ChannelToStoreLinkDetails"
},
"InfocardListResponse": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is.",
"default": "youtube#infocardListResponse",
"type": "string"
},
"items": {
"description": "A list of infocards.",
"items": {
"$ref": "InfoCard"
},
"type": "array"
},
"etag": {
"type": "string",
"description": "Etag of this resource."
}
},
"type": "object",
"id": "InfocardListResponse"
}
},
"servicePath": "",
"ownerName": "Google",
"description": "The YouTube Data API v3 is an API that provides access to YouTube data, such as videos, playlists, and channels.",
"baseUrl": "https://www.googleapis.com/",
"name": "youtube",
"ownerDomain": "google.com"
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment