Google Git
Sign in
code / google-api-go-client / 319486aa423671012a4c70a5d93cf16a11acc25a / . / youtube / v3 / youtube-api.json
blob: d61a7c0d9a88771eb63ff631a44a7f73aecb10f0 [file] [log] [blame]
{
"kind": "discovery#restDescription",
"etag": "\"0kaFfN0xfjZjASExv-gUnrWhdto/-1uCDEEeXh5XSWC8RZwLjaFjouE\"",
"discoveryVersion": "v1",
"id": "youtube:v3",
"name": "youtube",
"canonicalName": "YouTube",
"version": "v3",
"revision": "20130613",
"title": "YouTube Data API",
"description": "Programmatic access to YouTube features.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
"x16": "http://www.google.com/images/icons/product/youtube-16.png",
"x32": "http://www.google.com/images/icons/product/youtube-32.png"
},
"documentationLink": "https://developers.google.com/youtube/v3",
"protocol": "rest",
"baseUrl": "https://www.googleapis.com/youtube/v3/",
"basePath": "/youtube/v3/",
"rootUrl": "https://www.googleapis.com/",
"servicePath": "youtube/v3/",
"batchPath": "batch",
"parameters": {
"alt": {
"type": "string",
"description": "Data format for the response.",
"default": "json",
"enum": [
"json"
],
"enumDescriptions": [
"Responses with Content-Type of application/json"
],
"location": "query"
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response.",
"location": "query"
},
"key": {
"type": "string",
"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"
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user.",
"location": "query"
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"location": "query"
},
"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. Overrides userIp if both are provided.",
"location": "query"
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
"location": "query"
}
},
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/youtube": {
"description": "Manage your YouTube account"
},
"https://www.googleapis.com/auth/youtube.readonly": {
"description": "View your YouTube account"
},
"https://www.googleapis.com/auth/youtube.upload": {
"description": "Manage your YouTube videos"
},
"https://www.googleapis.com/auth/youtubepartner": {
"description": "View and manage your assets and associated content on YouTube"
}
}
}
},
"schemas": {
"AccessPolicy": {
"id": "AccessPolicy",
"type": "object",
"description": "Rights management policy for YouTube resources.",
"properties": {
"allowed": {
"type": "boolean",
"description": "The value of allowed indicates whether the access to the policy is allowed or denied by default."
},
"exception": {
"type": "array",
"description": "A list of region codes that identify countries where the default policy do not apply.",
"items": {
"type": "string"
}
}
}
},
"Activity": {
"id": "Activity",
"type": "object",
"description": "An activity resource contains information about an action that a particular channel, or user, has taken on YouTube. The actions reported in activity feeds include rating a video, sharing a video, marking a video as a favorite, commenting on a video, uploading a video, and so forth. Each activity resource identifies the type of action, the channel associated with the action, and the resource(s) associated with the action, such as the video that was rated or uploaded.",
"properties": {
"contentDetails": {
"$ref": "ActivityContentDetails",
"description": "The contentDetails object contains information about the content associated with the activity. For example, if the snippet.type value is videoRated, then the contentDetails object's content identifies the rated video."
},
"etag": {
"type": "string",
"description": "The ETag of the activity resource."
},
"id": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the activity."
},
"kind": {
"type": "string",
"description": "The type of the API resource. For activity resources, the value will be youtube#activity.",
"default": "youtube#activity"
},
"snippet": {
"$ref": "ActivitySnippet",
"description": "The snippet object contains basic details about the activity, including the activity's type and group ID."
}
}
},
"ActivityContentDetails": {
"id": "ActivityContentDetails",
"type": "object",
"description": "Details about the content of an activity: the video that was shared, the channel that was subscribed to, etc.",
"properties": {
"bulletin": {
"type": "object",
"description": "The bulletin object contains details about a channel bulletin post. This object is only present if the snippet.type is bulletin.",
"properties": {
"resourceId": {
"$ref": "ResourceId",
"description": "The resourceId object contains information that identifies the resource associated with a bulletin post."
}
}
},
"channelItem": {
"type": "object",
"description": "The channelItem object contains details about a resource which was added to a channel. This property is only present if the snippet.type is channelItem.",
"properties": {
"resourceId": {
"$ref": "ResourceId",
"description": "The resourceId object contains information that identifies the resource that was added to the channel."
}
}
},
"comment": {
"type": "object",
"description": "The comment object contains information about a resource that received a comment. This property is only present if the snippet.type is comment.",
"properties": {
"resourceId": {
"$ref": "ResourceId",
"description": "The resourceId object contains information that identifies the resource associated with the comment."
}
}
},
"favorite": {
"type": "object",
"description": "The favorite object contains information about a video that was marked as a favorite video. This property is only present if the snippet.type is favorite.",
"properties": {
"resourceId": {
"$ref": "ResourceId",
"description": "The resourceId object contains information that identifies the resource that was marked as a favorite."
}
}
},
"like": {
"type": "object",
"description": "The like object contains information about a resource that received a positive (like) rating. This property is only present if the snippet.type is like.",
"properties": {
"resourceId": {
"$ref": "ResourceId",
"description": "The resourceId object contains information that identifies the rated resource."
}
}
},
"playlistItem": {
"type": "object",
"description": "The playlistItem object contains information about a new playlist item. This property is only present if the snippet.type is playlistItem.",
"properties": {
"playlistId": {
"type": "string",
"description": "The value that YouTube uses to uniquely identify the playlist."
},
"playlistItemId": {
"type": "string",
"description": "ID of the item within the playlist."
},
"resourceId": {
"$ref": "ResourceId",
"description": "The resourceId object contains information about the resource that was added to the playlist."
}
}
},
"promotedItem": {
"type": "object",
"description": "The promotedItem object contains details about a resource which is being promoted. This property is only present if the snippet.type is promotedItem.",
"properties": {
"adTag": {
"type": "string",
"description": "The URL the client should fetch to request a promoted item."
},
"clickTrackingUrl": {
"type": "string",
"description": "The URL the client should ping to indicate that the user clicked through on this promoted item."
},
"creativeViewUrl": {
"type": "string",
"description": "The URL the client should ping to indicate that the user was shown this promoted item."
},
"ctaType": {
"type": "string",
"description": "The type of call-to-action, a message to the user indicating action that can be taken.",
"enum": [
"unspecified",
"visitAdvertiserSite"
],
"enumDescriptions": [
"",
""
]
},
"descriptionText": {
"type": "string",
"description": "The text description to accompany the promoted item."
},
"destinationUrl": {
"type": "string",
"description": "The URL the client should direct the user to, if the user chooses to visit the advertiser's website."
},
"videoId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the promoted video."
}
}
},
"recommendation": {
"type": "object",
"description": "The recommendation object contains information about a recommended resource. This property is only present if the snippet.type is recommendation.",
"properties": {
"reason": {
"type": "string",
"description": "The reason that the resource is recommended to the user.",
"enum": [
"unspecified",
"videoFavorited",
"videoLiked",
"videoWatched"
],
"enumDescriptions": [
"",
"",
"",
""
]
},
"resourceId": {
"$ref": "ResourceId",
"description": "The resourceId object contains information that identifies the recommended resource."
},
"seedResourceId": {
"$ref": "ResourceId",
"description": "The seedResourceId object contains information about the resource that caused the recommendation."
}
}
},
"social": {
"type": "object",
"description": "The social object contains details about a social network post. This property is only present if the snippet.type is social.",
"properties": {
"author": {
"type": "string",
"description": "The author of the social network post."
},
"imageUrl": {
"type": "string",
"description": "An image of the post's author."
},
"referenceUrl": {
"type": "string",
"description": "The URL of the social network post."
},
"resourceId": {
"$ref": "ResourceId",
"description": "The resourceId object encapsulates information that identifies the resource associated with a social network post."
},
"type": {
"type": "string",
"description": "The name of the social network.",
"enum": [
"facebook",
"googlePlus",
"twitter",
"unspecified"
],
"enumDescriptions": [
"",
"",
"",
""
]
}
}
},
"subscription": {
"type": "object",
"description": "The subscription object contains information about a channel that a user subscribed to. This property is only present if the snippet.type is subscription.",
"properties": {
"resourceId": {
"$ref": "ResourceId",
"description": "The resourceId object contains information that identifies the resource that the user subscribed to."
}
}
},
"upload": {
"type": "object",
"description": "The upload object contains information about the uploaded video. This property is only present if the snippet.type is upload.",
"properties": {
"videoId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the uploaded video."
}
}
}
}
},
"ActivityListResponse": {
"id": "ActivityListResponse",
"type": "object",
"description": "A paginated list of activities returned as a response to youtube.activities.list calls.",
"properties": {
"etag": {
"type": "string",
"description": "The ETag of the response."
},
"eventId": {
"type": "string",
"description": "Serialized EventId of the request which produced this response."
},
"items": {
"type": "array",
"description": "A list of activities, or events, that match the request criteria.",
"items": {
"$ref": "Activity"
}
},
"kind": {
"type": "string",
"description": "The type of the API response. For this operation, the value will be youtube#activityListResponse.",
"default": "youtube#activityListResponse"
},
"nextPageToken": {
"type": "string",
"description": "The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set."
},
"pageInfo": {
"$ref": "PageInfo",
"description": "The pageInfo object encapsulates paging information for the result set."
},
"prevPageToken": {
"type": "string",
"description": "The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set."
},
"visitorId": {
"type": "string",
"description": "The visitorId identifies the visitor."
}
}
},
"ActivitySnippet": {
"id": "ActivitySnippet",
"type": "object",
"description": "Basic details about an activity, including title, description, thumbnails, activity type and group.",
"properties": {
"channelId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the channel associated with the activity."
},
"channelTitle": {
"type": "string",
"description": "Channel title for the channel responsible for this activity"
},
"description": {
"type": "string",
"description": "The description of the resource primarily associated with the activity.",
"annotations": {
"required": [
"youtube.activities.insert"
]
}
},
"groupId": {
"type": "string",
"description": "The group ID associated with the activity. A group ID identifies user events that are associated with the same user and resource. For example, if a user rates a video and marks the same video as a favorite, the entries for those events would have the same group ID in the user's activity feed. In your user interface, you can avoid repetition by grouping events with the same groupId value."
},
"publishedAt": {
"type": "string",
"description": "The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.",
"format": "date-time"
},
"thumbnails": {
"$ref": "ThumbnailDetails",
"description": "A map of thumbnail images associated with the resource that is primarily associated with the activity. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail."
},
"title": {
"type": "string",
"description": "The title of the resource primarily associated with the activity."
},
"type": {
"type": "string",
"description": "The type of activity that the resource describes.",
"enum": [
"bulletin",
"channelItem",
"comment",
"favorite",
"like",
"playlistItem",
"promotedItem",
"recommendation",
"social",
"subscription",
"upload"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
}
}
},
"Channel": {
"id": "Channel",
"type": "object",
"description": "A channel resource contains information about a YouTube channel.",
"properties": {
"brandingSettings": {
"$ref": "ChannelBrandingSettings",
"description": "The brandingSettings object encapsulates information about the branding of the channel."
},
"contentDetails": {
"$ref": "ChannelContentDetails",
"description": "The contentDetails object encapsulates information about the channel's content."
},
"conversionPings": {
"$ref": "ChannelConversionPings",
"description": "The conversionPings object encapsulates information about conversion pings that need to be respected by the channel."
},
"etag": {
"type": "string",
"description": "The ETag for the channel resource."
},
"id": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the channel."
},
"invideoPromotion": {
"$ref": "InvideoPromotion",
"description": "The invideoPromotion object encapsulates information about promotion campaign associated with the channel."
},
"kind": {
"type": "string",
"description": "The type of the API resource. For channel resources, the value will be youtube#channel.",
"default": "youtube#channel"
},
"snippet": {
"$ref": "ChannelSnippet",
"description": "The snippet object contains basic details about the channel, such as its title, description, and thumbnail images."
},
"statistics": {
"$ref": "ChannelStatistics",
"description": "The statistics object encapsulates statistics for the channel."
},
"status": {
"$ref": "ChannelStatus",
"description": "The status object encapsulates information about the privacy status of the channel."
},
"topicDetails": {
"$ref": "ChannelTopicDetails",
"description": "The topicDetails object encapsulates information about Freebase topics associated with the channel."
}
}
},
"ChannelBannerInsertResponse": {
"id": "ChannelBannerInsertResponse",
"type": "object",
"description": "A channel banner returned as the response to a channel_banner.insert call.",
"properties": {
"etag": {
"type": "string",
"description": "The ETag of the response."
},
"kind": {
"type": "string",
"description": "The type of the API response. For this operation, the value will be youtube#channelBannerInsertResponse.",
"default": "youtube#channelBannerInsertResponse"
},
"url": {
"type": "string",
"description": "The URL of this banner image."
}
}
},
"ChannelBrandingSettings": {
"id": "ChannelBrandingSettings",
"type": "object",
"description": "Branding properties of a YouTube channel.",
"properties": {
"channel": {
"$ref": "ChannelSettings",
"description": "Branding properties for the channel view."
},
"hints": {
"type": "array",
"description": "Additional experimental branding properties.",
"items": {
"$ref": "PropertyValue"
}
},
"image": {
"$ref": "ImageSettings",
"description": "Branding properties for branding images."
},
"watch": {
"$ref": "WatchSettings",
"description": "Branding properties for the watch page."
}
}
},
"ChannelContentDetails": {
"id": "ChannelContentDetails",
"type": "object",
"description": "Details about the content of a channel.",
"properties": {
"googlePlusUserId": {
"type": "string",
"description": "The googlePlusUserId object identifies the Google+ profile ID associated with this channel."
},
"relatedPlaylists": {
"type": "object",
"description": "The relatedPlaylists object is a map that identifies playlists associated with the channel, such as the channel's uploaded videos or favorite videos. You can retrieve any of these playlists using the playlists.list method.",
"properties": {
"favorites": {
"type": "string",
"description": "The ID of the playlist that contains the channel's favorite videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list."
},
"likes": {
"type": "string",
"description": "The ID of the playlist that contains the channel's liked videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list."
},
"uploads": {
"type": "string",
"description": "The ID of the playlist that contains the channel's uploaded videos. Use the videos.insert method to upload new videos and the videos.delete method to delete previously uploaded videos."
},
"watchHistory": {
"type": "string",
"description": "The ID of the playlist that contains the channel's watch history. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list."
},
"watchLater": {
"type": "string",
"description": "The ID of the channel's watch later playlist. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list."
}
}
}
}
},
"ChannelConversionPing": {
"id": "ChannelConversionPing",
"type": "object",
"description": "Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.",
"properties": {
"context": {
"type": "string",
"description": "Defines the context of the ping.",
"enum": [
"cview",
"subscribe",
"unsubscribe"
],
"enumDescriptions": [
"",
"",
""
]
},
"conversionUrl": {
"type": "string",
"description": "The url (without the schema) that the player shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping."
}
}
},
"ChannelConversionPings": {
"id": "ChannelConversionPings",
"type": "object",
"description": "The conversionPings object encapsulates information about conversion pings that need to be respected by the channel.",
"properties": {
"pings": {
"type": "array",
"description": "Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.",
"items": {
"$ref": "ChannelConversionPing"
}
}
}
},
"ChannelListResponse": {
"id": "ChannelListResponse",
"type": "object",
"description": "A paginated list of channels returned as the response to a youtube.channels.list call.",
"properties": {
"etag": {
"type": "string",
"description": "The ETag for the response."
},
"eventId": {
"type": "string",
"description": "Serialized EventId of the request which produced this response."
},
"items": {
"type": "array",
"description": "A list of channels that match the request criteria.",
"items": {
"$ref": "Channel"
}
},
"kind": {
"type": "string",
"description": "The type of the API response. For this operation, the value will be youtube#channelListResponse.",
"default": "youtube#channelListResponse"
},
"nextPageToken": {
"type": "string",
"description": "The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set."
},
"pageInfo": {
"$ref": "PageInfo",
"description": "The pageInfo object encapsulates paging information for the result set."
},
"prevPageToken": {
"type": "string",
"description": "The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set."
},
"visitorId": {
"type": "string",
"description": "The visitorId identifies the visitor."
}
}
},
"ChannelSettings": {
"id": "ChannelSettings",
"type": "object",
"description": "Branding properties for the channel view.",
"properties": {
"defaultTab": {
"type": "string",
"description": "Which content tab users should see when viewing the channel."
},
"description": {
"type": "string",
"description": "Specifies the channel description."
},
"featuredChannelsTitle": {
"type": "string",
"description": "Title for the featured channels tab."
},
"featuredChannelsUrls": {
"type": "array",
"description": "The list of featured channels.",
"items": {
"type": "string"
}
},
"keywords": {
"type": "string",
"description": "Lists keywords associated with the channel, comma-separated."
},
"moderateComments": {
"type": "boolean",
"description": "Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible."
},
"profileColor": {
"type": "string",
"description": "A prominent color that can be rendered on this channel page."
},
"showBrowseView": {
"type": "boolean",
"description": "Whether the tab to browse the videos should be displayed."
},
"showRelatedChannels": {
"type": "boolean",
"description": "Whether related channels should be proposed."
},
"title": {
"type": "string",
"description": "Specifies the channel title."
},
"trackingAnalyticsAccountId": {
"type": "string",
"description": "The ID for a Google Analytics account to track and measure traffic to the channels."
},
"unsubscribedTrailer": {
"type": "string",
"description": "The trailer of the channel, for users that are not subscribers."
}
}
},
"ChannelSnippet": {
"id": "ChannelSnippet",
"type": "object",
"description": "Basic details about a channel, including title, description and thumbnails.",
"properties": {
"description": {
"type": "string",
"description": "The description of the channel."
},
"publishedAt": {
"type": "string",
"description": "The date and time that the channel was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.",
"format": "date-time"
},
"thumbnails": {
"$ref": "ThumbnailDetails",
"description": "A map of thumbnail images associated with the channel. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail."
},
"title": {
"type": "string",
"description": "The channel's title."
}
}
},
"ChannelStatistics": {
"id": "ChannelStatistics",
"type": "object",
"description": "Statistics about a channel: number of subscribers, number of videos in the channel, etc.",
"properties": {
"commentCount": {
"type": "string",
"description": "The number of comments for the channel.",
"format": "uint64"
},
"subscriberCount": {
"type": "string",
"description": "The number of subscribers that the channel has.",
"format": "uint64"
},
"videoCount": {
"type": "string",
"description": "The number of videos uploaded to the channel.",
"format": "uint64"
},
"viewCount": {
"type": "string",
"description": "The number of times the channel has been viewed.",
"format": "uint64"
}
}
},
"ChannelStatus": {
"id": "ChannelStatus",
"type": "object",
"description": "JSON template for the status part of a channel.",
"properties": {
"isLinked": {
"type": "boolean",
"description": "If true, then the user is linked to either a YouTube username or G+ account. Otherwise, the user doesn't have a public YouTube identity."
},
"privacyStatus": {
"type": "string",
"description": "Privacy status of the channel.",
"enum": [
"private",
"public"
],
"enumDescriptions": [
"",
""
]
}
}
},
"ChannelTopicDetails": {
"id": "ChannelTopicDetails",
"type": "object",
"description": "Freebase topic information related to the channel.",
"properties": {
"topicIds": {
"type": "array",
"description": "A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API.",
"items": {
"type": "string"
}
}
}
},
"ContentRating": {
"id": "ContentRating",
"type": "object",
"description": "Ratings schemes. The country-specific ratings are mostly for movies and shows.",
"properties": {
"acbRating": {
"type": "string",
"description": "Rating system in Australia - Australian Classification Board",
"enum": [
"acbE",
"acbG",
"acbM",
"acbMa15plus",
"acbPg",
"acbR18plus"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
""
]
},
"bbfcRating": {
"type": "string",
"description": "British Board of Film Classification",
"enum": [
"bbfc12",
"bbfc12a",
"bbfc15",
"bbfc18",
"bbfcPg",
"bbfcR18",
"bbfcU"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
]
},
"cbfcRating": {
"type": "string",
"description": "Rating system in India - Central Board of Film Certification",
"enum": [
"cbfcA",
"cbfcS",
"cbfcU",
"cbfcUA"
],
"enumDescriptions": [
"",
"",
"",
""
]
},
"chvrsRating": {
"type": "string",
"description": "Canadian Home Video Rating System",
"enum": [
"chvrs14a",
"chvrs18a",
"chvrsE",
"chvrsG",
"chvrsPg",
"chvrsR"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
""
]
},
"djctqRating": {
"type": "string",
"description": "Rating system in Brazil - Department of Justice, Rating, Titles and Qualification",
"enum": [
"djctq10",
"djctq12",
"djctq14",
"djctq16",
"djctq18",
"djctqL"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
""
]
},
"eirinRating": {
"type": "string",
"description": "Rating system in Japan - Eiga Rinri Kanri Iinkai",
"enum": [
"eirinG",
"eirinPg12",
"eirinR15plus",
"eirinR18plus"
],
"enumDescriptions": [
"",
"",
"",
""
]
},
"fmocRating": {
"type": "string",
"description": "Rating system in France - French Minister of Culture",
"enum": [
"fmoc10",
"fmoc12",
"fmoc16",
"fmoc18",
"fmocE",
"fmocU"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
""
]
},
"fskRating": {
"type": "string",
"description": "Rating system in Germany - Voluntary Self Regulation of the Movie Industry",
"enum": [
"fsk0",
"fsk12",
"fsk16",
"fsk18",
"fsk6"
],
"enumDescriptions": [
"",
"",
"",
"",
""
]
},
"icaaRating": {
"type": "string",
"description": "Rating system in Spain - Instituto de Cinematografia y de las Artes Audiovisuales",
"enum": [
"icaa12",
"icaa13",
"icaa16",
"icaa18",
"icaa7",
"icaaApta",
"icaaX"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
]
},
"kmrbRating": {
"type": "string",
"description": "Rating system in South Korea - Korea Media Rating Board",
"enum": [
"kmrb12plus",
"kmrb15plus",
"kmrbAll",
"kmrbR",
"kmrbTeenr"
],
"enumDescriptions": [
"",
"",
"",
"",
""
]
},
"mpaaRating": {
"type": "string",
"description": "Motion Picture Association of America rating for the content.",
"enum": [
"mpaaG",
"mpaaNc17",
"mpaaPg",
"mpaaPg13",
"mpaaR"
],
"enumDescriptions": [
"",
"",
"",
"",
""
]
},
"oflcRating": {
"type": "string",
"description": "Rating system in New Zealand - Office of Film and Literature Classification",
"enum": [
"oflcG",
"oflcM",
"oflcPg",
"oflcR13",
"oflcR15",
"oflcR16",
"oflcR18"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
]
},
"rtcRating": {
"type": "string",
"description": "Rating system in Mexico - General Directorate of Radio, Television and Cinematography",
"enum": [
"rtcA",
"rtcAa",
"rtcB",
"rtcB15",
"rtcC",
"rtcD"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
""
]
},
"russiaRating": {
"type": "string",
"description": "Rating system in Russia",
"enum": [
"russia0",
"russia12",
"russia16",
"russia18",
"russia6"
],
"enumDescriptions": [
"",
"",
"",
"",
""
]
},
"tvpgRating": {
"type": "string",
"description": "TV Parental Guidelines rating of the content.",
"enum": [
"tvpg14",
"tvpgG",
"tvpgMa",
"tvpgPg",
"tvpgY",
"tvpgY7",
"tvpgY7Fv"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
]
},
"ytRating": {
"type": "string",
"description": "Internal YouTube rating.",
"enum": [
"yt17Plus",
"ytAllAudiences",
"ytRestricted"
],
"enumDescriptions": [
"",
"",
""
]
}
}
},
"GeoPoint": {
"id": "GeoPoint",
"type": "object",
"description": "A geoPoint holds geo location information associated with a YouTube resource.",
"properties": {
"elevation": {
"type": "number",
"description": "Altitude above the Earth, in meters.",
"format": "double"
},
"latitude": {
"type": "number",
"description": "Latitude in degrees.",
"format": "double"
},
"longitude": {
"type": "number",
"description": "Longitude in degrees.",
"format": "double"
}
}
},
"GuideCategory": {
"id": "GuideCategory",
"type": "object",
"description": "A guideCategory resource identifies a category that YouTube algorithmically assigns based on a channel's content or other indicators, such as the channel's popularity. The list is similar to video categories, with the difference being that a video's uploader can assign a video category but only YouTube can assign a channel category.",
"properties": {
"etag": {
"type": "string",
"description": "The ETag of the guideCategory resource."
},
"id": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the guide category."
},
"kind": {
"type": "string",
"description": "The type of the API resource. For guideCategory resources, the value will be youtube#guideCategory/code\u003e.",
"default": "youtube#guideCategory"
},
"snippet": {
"$ref": "GuideCategorySnippet",
"description": "The snippet object contains basic details about the category, such as its title."
}
}
},
"GuideCategoryListResponse": {
"id": "GuideCategoryListResponse",
"type": "object",
"description": "A paginated list of guide categories returned as the response to a youtube.guideCategories.list call.",
"properties": {
"etag": {
"type": "string",
"description": "The ETag of the response."
},
"eventId": {
"type": "string",
"description": "Serialized EventId of the request which produced this response."
},
"items": {
"type": "array",
"description": "A list of categories that can be associated with YouTube channels. In this map, the category ID is the map key, and its value is the corresponding guideCategory resource.",
"items": {
"$ref": "GuideCategory"
}
},
"kind": {
"type": "string",
"description": "The type of the API response. For this operation, the value will be youtube#guideCategoryListResponse.",
"default": "youtube#guideCategoryListResponse"
},
"visitorId": {
"type": "string",
"description": "The visitorId identifies the visitor."
}
}
},
"GuideCategorySnippet": {
"id": "GuideCategorySnippet",
"type": "object",
"description": "Basic details about a guide category.",
"properties": {
"channelId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the channel publishing the guide category.",
"default": "UCBR8-60-B28hp2BmDPdntcQ"
},
"title": {
"type": "string",
"description": "The category's title."
}
}
},
"ImageSettings": {
"id": "ImageSettings",
"type": "object",
"description": "Branding properties for images associated with the channel.",
"properties": {
"backgroundImageUrl": {
"$ref": "LocalizedProperty",
"description": "The URL for the background image shown on the video watch page. The image should be 1200px by 615px, with a maximum file size of 128k."
},
"bannerExternalUrl": {
"type": "string",
"description": "This is used only in update requests; if it's set, we use this URL to generate all of the above banner URLs."
},
"bannerImageUrl": {
"type": "string",
"description": "Banner image. Desktop size (1060x175)."
},
"bannerMobileExtraHdImageUrl": {
"type": "string",
"description": "Banner image. Mobile size high resolution (1440x395)."
},
"bannerMobileHdImageUrl": {
"type": "string",
"description": "Banner image. Mobile size high resolution (1280x360)."
},
"bannerMobileImageUrl": {
"type": "string",
"description": "Banner image. Mobile size (640x175)."
},
"bannerMobileLowImageUrl": {
"type": "string",
"description": "Banner image. Mobile size low resolution (320x88)."
},
"bannerMobileMediumHdImageUrl": {
"type": "string",
"description": "Banner image. Mobile size medium/high resolution (960x263)."
},
"bannerTabletExtraHdImageUrl": {
"type": "string",
"description": "Banner image. Tablet size extra high resolution (2560x424)."
},
"bannerTabletHdImageUrl": {
"type": "string",
"description": "Banner image. Tablet size high resolution (2276x377)."
},
"bannerTabletImageUrl": {
"type": "string",
"description": "Banner image. Tablet size (1707x283)."
},
"bannerTabletLowImageUrl": {
"type": "string",
"description": "Banner image. Tablet size low resolution (1138x188)."
},
"bannerTvImageUrl": {
"type": "string",
"description": "Banner image. TV size (2120x1192)."
},
"largeBrandedBannerImageImapScript": {
"$ref": "LocalizedProperty",
"description": "The image map script for the large banner image."
},
"largeBrandedBannerImageUrl": {
"$ref": "LocalizedProperty",
"description": "The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page."
},
"smallBrandedBannerImageImapScript": {
"$ref": "LocalizedProperty",
"description": "The image map script for the small banner image."
},
"smallBrandedBannerImageUrl": {
"$ref": "LocalizedProperty",
"description": "The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page."
},
"trackingImageUrl": {
"type": "string",
"description": "The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages."
},
"watchIconImageUrl": {
"type": "string",
"description": "The URL for the image that appears above the top-left corner of the video player. This is a 25-pixel-high image with a flexible width that cannot exceed 170 pixels."
}
}
},
"InvideoPosition": {
"id": "InvideoPosition",
"type": "object",
"description": "Describes the spatial position of a visual widget inside a video. It is a union of various position types, out of which only will be set one.",
"properties": {
"cornerPosition": {
"type": "string",
"description": "Describes in which corner of the video the visual widget will appear.",
"enum": [
"bottomLeft",
"bottomRight",
"topLeft",
"topRight"
],
"enumDescriptions": [
"",
"",
"",
""
]
},
"type": {
"type": "string",
"description": "Defines the position type.",
"enum": [
"corner"
],
"enumDescriptions": [
""
]
}
}
},
"InvideoPromotion": {
"id": "InvideoPromotion",
"type": "object",
"description": "Describes an invideo promotion campaign consisting of multiple promoted items. A campaign belongs to a single channel_id.",
"properties": {
"items": {
"type": "array",
"description": "List of promoted items in decreasing priority.",
"items": {
"$ref": "PromotedItemId"
}
},
"position": {
"$ref": "InvideoPosition",
"description": "The spatial position within the video where the promoted item will be displayed."
},
"timing": {
"$ref": "InvideoTiming",
"description": "The temporal position within the video where the promoted item will be displayed."
}
}
},
"InvideoTiming": {
"id": "InvideoTiming",
"type": "object",
"description": "Describes a temporal position of a visual widget inside a video.",
"properties": {
"offsetMs": {
"type": "string",
"description": "Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds.",
"format": "uint64"
},
"type": {
"type": "string",
"description": "Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video.",
"enum": [
"offsetFromEnd",
"offsetFromStart"
],
"enumDescriptions": [
"",
""
]
}
}
},
"LiveBroadcast": {
"id": "LiveBroadcast",
"type": "object",
"description": "A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.",
"properties": {
"contentDetails": {
"$ref": "LiveBroadcastContentDetails",
"description": "The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded."
},
"etag": {
"type": "string",
"description": "The ETag of the broadcast."
},
"id": {
"type": "string",
"description": "The ID that YouTube assigns to uniquely identify the broadcast.",
"annotations": {
"required": [
"youtube.liveBroadcasts.update"
]
}
},
"kind": {
"type": "string",
"description": "The type of the API resource. For live broadcast resources, the value will be youtube#liveBroadcast.",
"default": "youtube#liveBroadcast"
},
"snippet": {
"$ref": "LiveBroadcastSnippet",
"description": "The snippet object contains basic details about the event, including its title, description, start time, and end time."
},
"status": {
"$ref": "LiveBroadcastStatus",
"description": "The status object contains information about the event's status."
}
}
},
"LiveBroadcastContentDetails": {
"id": "LiveBroadcastContentDetails",
"type": "object",
"description": "Slate settings of a broadcast.",
"properties": {
"boundStreamId": {
"type": "string",
"description": "This value uniquely identifies the live stream bound to the broadcast."
},
"enableContentEncryption": {
"type": "boolean",
"description": "This setting indicates whether YouTube should enable content encryption for the broadcast.",
"annotations": {
"required": [
"youtube.liveBroadcasts.update"
]
}
},
"enableDvr": {
"type": "boolean",
"description": "This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true.\n\nImportant: You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.",
"annotations": {
"required": [
"youtube.liveBroadcasts.update"
]
}
},
"enableEmbed": {
"type": "boolean",
"description": "This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.",
"annotations": {
"required": [
"youtube.liveBroadcasts.update"
]
}
},
"monitorStream": {
"type": "object",
"description": "The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly.",
"properties": {
"broadcastStreamDelayMs": {
"type": "integer",
"description": "If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.",
"format": "uint32",
"annotations": {
"required": [
"youtube.liveBroadcasts.update"
]
}
},
"embedHtml": {
"type": "string",
"description": "HTML code that embeds a player that plays the monitor stream."
},
"enableMonitorStream": {
"type": "boolean",
"description": "This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints.\n\nYou need to set this value to true if you intend to have a broadcast delay for your event.\n\nNote: This property cannot be updated once the broadcast is in the testing or live state.",
"annotations": {
"required": [
"youtube.liveBroadcasts.update"
]
}
}
}
},
"recordFromStart": {
"type": "boolean",
"description": "Automatically start recording after the event goes live. The default value for this property is true.\n\nImportant: You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.",
"annotations": {
"required": [
"youtube.liveBroadcasts.update"
]
}
},
"startWithSlate": {
"type": "boolean",
"description": "This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.",
"annotations": {
"required": [
"youtube.liveBroadcasts.update"
]
}
}
}
},
"LiveBroadcastList": {
"id": "LiveBroadcastList",
"type": "object",
"description": "JSON template for list of broadcasts.",
"properties": {
"etag": {
"type": "string",
"description": "The ETag of the response."
},
"eventId": {
"type": "string",
"description": "Serialized EventId of the request which produced this response."
},
"items": {
"type": "array",
"description": "A list of broadcasts that match the request criteria.",
"items": {
"$ref": "LiveBroadcast"
}
},
"kind": {
"type": "string",
"description": "The type of the API response. For this operation, the value will be youtube#liveBroadcastList.",
"default": "youtube#liveBroadcastList"
},
"nextPageToken": {
"type": "string",
"description": "The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set."
},
"pageInfo": {
"$ref": "PageInfo",
"description": "The pageInfo object encapsulates paging information for the result set."
},
"prevPageToken": {
"type": "string",
"description": "The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set."
},
"visitorId": {
"type": "string",
"description": "The visitorId identifies the visitor."
}
}
},
"LiveBroadcastSnippet": {
"id": "LiveBroadcastSnippet",
"type": "object",
"description": "Basic details about a live broadcast, including title, description and thumbnails.",
"properties": {
"actualEndTime": {
"type": "string",
"description": "The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.",
"format": "date-time"
},
"actualStartTime": {
"type": "string",
"description": "The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.",
"format": "date-time"
},
"channelId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast."
},
"description": {
"type": "string",
"description": "The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource."
},
"publishedAt": {
"type": "string",
"description": "The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.",
"format": "date-time"
},
"scheduledEndTime": {
"type": "string",
"description": "The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.",
"format": "date-time",
"annotations": {
"required": [
"youtube.liveBroadcasts.insert",
"youtube.liveBroadcasts.update"
]
}
},
"scheduledStartTime": {
"type": "string",
"description": "The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.",
"format": "date-time",
"annotations": {
"required": [
"youtube.liveBroadcasts.insert",
"youtube.liveBroadcasts.update"
]
}
},
"thumbnails": {
"$ref": "ThumbnailDetails",
"description": "A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail."
},
"title": {
"type": "string",
"description": "The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.",
"annotations": {
"required": [
"youtube.liveBroadcasts.insert",
"youtube.liveBroadcasts.update"
]
}
}
}
},
"LiveBroadcastStatus": {
"id": "LiveBroadcastStatus",
"type": "object",
"description": "The status of a live broadcast.",
"properties": {
"lifeCycleStatus": {
"type": "string",
"description": "The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.",
"enum": [
"abandoned",
"complete",
"completeStarting",
"created",
"live",
"liveStarting",
"ready",
"reclaimed",
"revoked",
"testStarting",
"testing"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"privacyStatus": {
"type": "string",
"description": "The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.",
"enum": [
"private",
"public",
"unlisted"
],
"enumDescriptions": [
"",
"",
""
],
"annotations": {
"required": [
"youtube.liveBroadcasts.insert",
"youtube.liveBroadcasts.update"
]
}
},
"recordingStatus": {
"type": "string",
"description": "The broadcast's recording status.",
"enum": [
"",
"not_recording",
"recorded",
"recording"
],
"enumDescriptions": [
"",
"",
"",
""
]
}
}
},
"LiveStream": {
"id": "LiveStream",
"type": "object",
"description": "A live stream describes a live ingestion point.",
"properties": {
"cdn": {
"$ref": "LiveStreamCdn",
"description": "The cdn object defines the live stream's content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube."
},
"etag": {
"type": "string",
"description": "The ETag of the stream resource."
},
"id": {
"type": "string",
"description": "The ID that YouTube assigns to uniquely identify the stream.",
"annotations": {
"required": [
"youtube.liveStreams.update"
]
}
},
"kind": {
"type": "string",
"description": "The type of the API resource. For live stream resources, the value will be youtube#liveStream.",
"default": "youtube#liveStream"
},
"snippet": {
"$ref": "LiveStreamSnippet",
"description": "The snippet object contains basic details about the stream, including its channel, title, and description."
},
"status": {
"$ref": "LiveStreamStatus",
"description": "The status object contains information about live stream's status."
}
}
},
"LiveStreamCdn": {
"id": "LiveStreamCdn",
"type": "object",
"description": "Brief description of the live stream cdn settings.",
"properties": {
"format": {
"type": "string",
"description": "The format of the video stream that you are sending to YouTube.",
"annotations": {
"required": [
"youtube.liveStreams.insert",
"youtube.liveStreams.update"
]
}
},
"ingestionInfo": {
"$ref": "LiveStreamCdnIngestionInfo",
"description": "The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube."
},
"ingestionType": {
"type": "string",
"description": "The method or protocol used to transmit the video stream.",
"enum": [
"rtmp"
],
"enumDescriptions": [
""
],
"annotations": {
"required": [
"youtube.liveStreams.insert",
"youtube.liveStreams.update"
]
}
}
}
},
"LiveStreamCdnIngestionInfo": {
"id": "LiveStreamCdnIngestionInfo",
"type": "object",
"description": "Brief description of the live stream cdn settings.",
"properties": {
"backupIngestionAddress": {
"type": "string",
"description": "The backup ingestion URL that you should use to stream video to YouTube. You have the option of simultaneously streaming the content that you are sending to the ingestionAddress to this URL."
},
"ingestionAddress": {
"type": "string",
"description": "The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.\n\nDepending on which application or tool you use to encode your video stream, you may need to enter the stream URL and stream name separately or you may need to concatenate them in the following format:\n\nSTREAM_URL/STREAM_NAME"
},
"streamName": {
"type": "string",
"description": "The HTTP or RTMP stream name that YouTube assigns to the video stream."
}
}
},
"LiveStreamList": {
"id": "LiveStreamList",
"type": "object",
"description": "List of live streams.",
"properties": {
"etag": {
"type": "string",
"description": "The ETag of the response."
},
"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"
}
},
"kind": {
"type": "string",
"description": "The type of the API response. For this operation, the value will be youtube#liveStreamList.",
"default": "youtube#liveStreamList"
},
"nextPageToken": {
"type": "string",
"description": "The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set."
},
"pageInfo": {
"$ref": "PageInfo",
"description": "The pageInfo object encapsulates paging information for the result set."
},
"prevPageToken": {
"type": "string",
"description": "The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set."
},
"visitorId": {
"type": "string",
"description": "The visitorId identifies the visitor."
}
}
},
"LiveStreamSnippet": {
"id": "LiveStreamSnippet",
"type": "object",
"description": "Basic details about a live stream, including title and description.",
"properties": {
"channelId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the channel that is transmitting the stream."
},
"description": {
"type": "string",
"description": "The stream's description. The value cannot be longer than 10000 characters."
},
"publishedAt": {
"type": "string",
"description": "The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.",
"format": "date-time"
},
"title": {
"type": "string",
"description": "The stream's title. The value must be between 1 and 128 characters long.",
"annotations": {
"required": [
"youtube.liveStreams.insert",
"youtube.liveStreams.update"
]
}
}
}
},
"LiveStreamStatus": {
"id": "LiveStreamStatus",
"type": "object",
"description": "Brief description of the live stream status.",
"properties": {
"streamStatus": {
"type": "string",
"description": "The stream's status.",
"enum": [
"active",
"created",
"error",
"inactive",
"ready"
],
"enumDescriptions": [
"",
"",
"",
"",
""
]
}
}
},
"LocalizedProperty": {
"id": "LocalizedProperty",
"type": "object",
"description": "Represent a property available in different languages.",
"properties": {
"default": {
"type": "string",
"description": "Default value for the localized property."
},
"localized": {
"type": "array",
"description": "The localized values.",
"items": {
"$ref": "LocalizedString"
}
}
}
},
"LocalizedString": {
"id": "LocalizedString",
"type": "object",
"description": "A localized string.",
"properties": {
"language": {
"type": "string",
"description": "Language associated to this value."
},
"value": {
"type": "string",
"description": "Value of the property."
}
}
},
"PageInfo": {
"id": "PageInfo",
"type": "object",
"description": "Paging details for lists of resources, including total number of items available and number of resources returned in a single page.",
"properties": {
"resultsPerPage": {
"type": "integer",
"description": "The number of results included in the API response.",
"format": "int32"
},
"totalResults": {
"type": "integer",
"description": "The total number of results in the result set.",
"format": "int32"
}
}
},
"Playlist": {
"id": "Playlist",
"type": "object",
"description": "A playlist resource represents a YouTube playlist. A playlist is a collection of videos that can be viewed sequentially and shared with other users. A playlist can contain up to 200 videos, and YouTube does not limit the number of playlists that each user creates. By default, playlists are publicly visible to other users, but playlists can be public or private.\n\nYouTube also uses playlists to identify special collections of videos for a channel, such as: \n- uploaded videos \n- favorite videos \n- positively rated (liked) videos \n- watch history \n- watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel.\n\nYou can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods.",
"properties": {
"contentDetails": {
"$ref": "PlaylistContentDetails",
"description": "The contentDetails object contains information like video count."
},
"etag": {
"type": "string",
"description": "The ETag for the playlist resource."
},
"id": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the playlist."
},
"kind": {
"type": "string",
"description": "The type of the API resource. For video resources, the value will be youtube#playlist.",
"default": "youtube#playlist"
},
"player": {
"$ref": "PlaylistPlayer",
"description": "The player object contains information that you would use to play the playlist in an embedded player."
},
"snippet": {
"$ref": "PlaylistSnippet",
"description": "The snippet object contains basic details about the playlist, such as its title and description."
},
"status": {
"$ref": "PlaylistStatus",
"description": "The status object contains status information for the playlist."
}
}
},
"PlaylistContentDetails": {
"id": "PlaylistContentDetails",
"type": "object",
"description": "Details about the content of a playlist, such as the video count.",
"properties": {
"itemCount": {
"type": "integer",
"description": "The number of videos in the playlist.",
"format": "uint32"
}
}
},
"PlaylistItem": {
"id": "PlaylistItem",
"type": "object",
"description": "A playlistItem resource identifies another resource, such as a video, that is included in a playlist. In addition, the playlistItem resource contains details about the included resource that pertain specifically to how that resource is used in that playlist.\n\nYouTube uses playlists to identify special collections of videos for a channel, such as: \n- uploaded videos \n- favorite videos \n- positively rated (liked) videos \n- watch history \n- watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information.\n\nYou can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods. For example, if a user gives a positive rating to a video, you would insert that video into the liked videos playlist for that user's channel.",
"properties": {
"contentDetails": {
"$ref": "PlaylistItemContentDetails",
"description": "The contentDetails object is included in the resource if the included item is a YouTube video. The object contains additional information about the video."
},
"etag": {
"type": "string",
"description": "The ETag for the playlist item resource."
},
"id": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the playlist item."
},
"kind": {
"type": "string",
"description": "The type of the API resource. For playlist item resources, the value will be youtube#playlistItem.",
"default": "youtube#playlistItem"
},
"snippet": {
"$ref": "PlaylistItemSnippet",
"description": "The snippet object contains basic details about the playlist item, such as its title and position in the playlist."
},
"status": {
"$ref": "PlaylistItemStatus",
"description": "The status object contains information about the playlist item's privacy status."
}
}
},
"PlaylistItemContentDetails": {
"id": "PlaylistItemContentDetails",
"type": "object",
"description": "Details about the content of a playlist item, such as the video or the video fragment start and end time included in the playlist.",
"properties": {
"endAt": {
"type": "string",
"description": "The time, measured in seconds from the start of the video, when the video should stop playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) By default, assume that the video.endTime is the end of the video."
},
"note": {
"type": "string",
"description": "A user-generated note for this item."
},
"startAt": {
"type": "string",
"description": "The time, measured in seconds from the start of the video, when the video should start playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) The default value is 0."
},
"videoId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify a video. To retrieve the video resource, set the id query parameter to this value in your API request."
}
}
},
"PlaylistItemListResponse": {
"id": "PlaylistItemListResponse",
"type": "object",
"description": "A paginated list of playlist items returned as the response to a youtube.playlistItems.list call.",
"properties": {
"etag": {
"type": "string",
"description": "The ETag for the response."
},
"eventId": {
"type": "string",
"description": "Serialized EventId of the request which produced this response."
},
"items": {
"type": "array",
"description": "A list of playlist items that match the request criteria.",
"items": {
"$ref": "PlaylistItem"
}
},
"kind": {
"type": "string",
"description": "The type of the API response. For this operation, the value will be youtube#playlistItemListResponse.",
"default": "youtube#playlistItemListResponse"
},
"nextPageToken": {
"type": "string",
"description": "A token that can be used as the value of the pageToken parameter to retrieve the next page in the result set."
},
"pageInfo": {
"$ref": "PageInfo",
"description": "The pageInfo object encapsulates paging information for the result set."
},
"prevPageToken": {
"type": "string",
"description": "A token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set."
},
"visitorId": {
"type": "string",
"description": "The visitorId identifies the visitor."
}
}
},
"PlaylistItemSnippet": {
"id": "PlaylistItemSnippet",
"type": "object",
"description": "Basic details about a playlist, including title, description and thumbnails.",
"properties": {
"channelId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the user that added the item to the playlist."
},
"channelTitle": {
"type": "string",
"description": "Channel title for the channel that the playlist item belongs to."
},
"description": {
"type": "string",
"description": "The item's description."
},
"playlistId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the playlist that the playlist item is in.",
"annotations": {
"required": [
"youtube.playlistItems.insert",
"youtube.playlistItems.update"
]
}
},
"position": {
"type": "integer",
"description": "The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth.",
"format": "uint32"
},
"publishedAt": {
"type": "string",
"description": "The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.",
"format": "date-time"
},
"resourceId": {
"$ref": "ResourceId",
"description": "The id object contains information that can be used to uniquely identify the resource that is included in the playlist as the playlist item.",
"annotations": {
"required": [
"youtube.playlistItems.insert",
"youtube.playlistItems.update"
]
}
},
"thumbnails": {
"$ref": "ThumbnailDetails",
"description": "A map of thumbnail images associated with the playlist item. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail."
},
"title": {
"type": "string",
"description": "The item's title."
}
}
},
"PlaylistItemStatus": {
"id": "PlaylistItemStatus",
"type": "object",
"description": "Information about the playlist item's privacy status.",
"properties": {
"privacyStatus": {
"type": "string",
"description": "This resource's privacy status.",
"enum": [
"private",
"public",
"unlisted"
],
"enumDescriptions": [
"",
"",
""
]
}
}
},
"PlaylistListResponse": {
"id": "PlaylistListResponse",
"type": "object",
"description": "A paginated list of playlists returned as the response to a youtube.playlists.list call.",
"properties": {
"etag": {
"type": "string",
"description": "The ETag of the response."
},
"eventId": {
"type": "string",
"description": "Serialized EventId of the request which produced this response."
},
"items": {
"type": "array",
"description": "A list of playlists that match the request criteria.",
"items": {
"$ref": "Playlist"
}
},
"kind": {
"type": "string",
"description": "The type of the API response. For this operation, the value will be youtube#playlistListResponse.",
"default": "youtube#playlistListResponse"
},
"nextPageToken": {
"type": "string",
"description": "The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set."
},
"pageInfo": {
"$ref": "PageInfo",
"description": "The pageInfo object encapsulates paging information for the result set."
},
"prevPageToken": {
"type": "string",
"description": "The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set."
},
"visitorId": {
"type": "string",
"description": "The visitorId identifies the visitor."
}
}
},
"PlaylistPlayer": {
"id": "PlaylistPlayer",
"type": "object",
"description": "Player to be used for a playlist playback.",
"properties": {
"embedHtml": {
"type": "string",
"description": "An \u003ciframe\u003e tag that embeds a player that will play the playlist."
}
}
},
"PlaylistSnippet": {
"id": "PlaylistSnippet",
"type": "object",
"description": "Basic details about a playlist, including title, description and thumbnails.",
"properties": {
"channelId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the channel that published the playlist."
},
"channelTitle": {
"type": "string",
"description": "Channel title for the channel that the video belongs to."
},
"description": {
"type": "string",
"description": "The playlist's description."
},
"publishedAt": {
"type": "string",
"description": "The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.",
"format": "date-time"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"thumbnails": {
"$ref": "ThumbnailDetails",
"description": "A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail."
},
"title": {
"type": "string",
"description": "The playlist's title.",
"annotations": {
"required": [
"youtube.playlists.insert",
"youtube.playlists.update"
]
}
}
}
},
"PlaylistStatus": {
"id": "PlaylistStatus",
"type": "object",
"description": "The status details of a playlist describes whether the playlist is private.",
"properties": {
"privacyStatus": {
"type": "string",
"description": "The playlist's privacy status.",
"enum": [
"private",
"public"
],
"enumDescriptions": [
"",
""
]
}
}
},
"PromotedItemId": {
"id": "PromotedItemId",
"type": "object",
"description": "Describes a single promoted item. It is a union of various possible types.",
"properties": {
"type": {
"type": "string",
"description": "Describes the type of the promoted item.",
"enum": [
"video"
],
"enumDescriptions": [
""
]
},
"videoId": {
"type": "string",
"description": "If the promoted item represents a video, this field represents the unique YouTube ID identifying it. This field will be present only if type has the value video."
}
}
},
"PropertyValue": {
"id": "PropertyValue",
"type": "object",
"description": "A pair Property / Value.",
"properties": {
"property": {
"type": "string",
"description": "A property."
},
"value": {
"type": "string",
"description": "The property's value."
}
}
},
"ResourceId": {
"id": "ResourceId",
"type": "object",
"description": "A resource id is a generic reference that points to another YouTube resource.",
"properties": {
"channelId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel."
},
"kind": {
"type": "string",
"description": "The type of the API resource."
},
"playlistId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist."
},
"videoId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video."
}
}
},
"SearchListResponse": {
"id": "SearchListResponse",
"type": "object",
"description": "A paginated list of search results returned as the response to a youtube.search.list call.",
"properties": {
"etag": {
"type": "string",
"description": "The ETag for the response."
},
"eventId": {
"type": "string",
"description": "Serialized EventId of the request which produced this response."
},
"items": {
"type": "array",
"description": "A list of results that match the search criteria.",
"items": {
"$ref": "SearchResult"
}
},
"kind": {
"type": "string",
"description": "The type of the API response. For this operation, the value will be youtube#searchListResponse.",
"default": "youtube#searchListResponse"
},
"nextPageToken": {
"type": "string",
"description": "The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set."
},
"pageInfo": {
"$ref": "PageInfo",
"description": "The pageInfo object encapsulates paging information for the search result set."
},
"prevPageToken": {
"type": "string",
"description": "The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set."
},
"visitorId": {
"type": "string",
"description": "The visitorId identifies the visitor."
}
}
},
"SearchResult": {
"id": "SearchResult",
"type": "object",
"description": "A search result contains information about a YouTube video, channel, or playlist that matches the search parameters specified in an API request. While a search result points to a uniquely identifiable resource, like a video, it does not have its own persistent data.",
"properties": {
"etag": {
"type": "string",
"description": "Etag of this resource."
},
"id": {
"$ref": "ResourceId",
"description": "The id object contains information that can be used to uniquely identify the resource that matches the search request."
},
"kind": {
"type": "string",
"description": "The kind, fixed to \"youtube#searchResult\".",
"default": "youtube#searchResult"
},
"snippet": {
"$ref": "SearchResultSnippet",
"description": "The snippet object contains basic details about a search result, such as its title or description. For example, if the search result is a video, then the title will be the video's title and the description will be the video's description."
}
}
},
"SearchResultSnippet": {
"id": "SearchResultSnippet",
"type": "object",
"description": "Basic details about a search result, including title, description and thumbnails of the item referenced by the search result.",
"properties": {
"channelId": {
"type": "string",
"description": "The value that YouTube uses to uniquely identify the channel that published the resource that the search result identifies."
},
"channelTitle": {
"type": "string",
"description": "The title of the channel that published the resource that the search result identifies."
},
"description": {
"type": "string",
"description": "A description of the search result."
},
"publishedAt": {
"type": "string",
"description": "The creation date and time of the resource that the search result identifies. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.",
"format": "date-time"
},
"thumbnails": {
"$ref": "ThumbnailDetails",
"description": "A map of thumbnail images associated with the search result. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail."
},
"title": {
"type": "string",
"description": "The title of the search result."
}
}
},
"Subscription": {
"id": "Subscription",
"type": "object",
"description": "A subscription resource contains information about a YouTube user subscription. A subscription notifies a user when new videos are added to a channel or when another user takes one of several actions on YouTube, such as uploading a video, rating a video, or commenting on a video.",
"properties": {
"contentDetails": {
"$ref": "SubscriptionContentDetails",
"description": "The contentDetails object contains basic statistics about the subscription."
},
"etag": {
"type": "string",
"description": "The ETag of the subscription resource."
},
"id": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the subscription."
},
"kind": {
"type": "string",
"description": "The type of the API resource. For subscription resources, the value will be youtube#subscription.",
"default": "youtube#subscription"
},
"snippet": {
"$ref": "SubscriptionSnippet",
"description": "The snippet object contains basic details about the subscription, including its title and the channel that the user subscribed to."
},
"subscriberSnippet": {
"$ref": "SubscriptionSubscriberSnippet",
"description": "The subscriberSnippet object contains basic details about the subscriber."
}
}
},
"SubscriptionContentDetails": {
"id": "SubscriptionContentDetails",
"type": "object",
"description": "Details about the content to witch a subscription refers.",
"properties": {
"newItemCount": {
"type": "integer",
"description": "The number of new items in the subscription since its content was last read.",
"format": "uint32"
},
"totalItemCount": {
"type": "integer",
"description": "The approximate number of items that the subscription points to.",
"format": "uint32"
}
}
},
"SubscriptionListResponse": {
"id": "SubscriptionListResponse",
"type": "object",
"description": "A paginated list of subscriptions returned as the response to a youtube.subscriptions.list call.",
"properties": {
"etag": {
"type": "string",
"description": "The ETag of the response."
},
"eventId": {
"type": "string",
"description": "Serialized EventId of the request which produced this response."
},
"items": {
"type": "array",
"description": "A list of subscriptions that match the request criteria.",
"items": {
"$ref": "Subscription"
}
},
"kind": {
"type": "string",
"description": "The type of the API response. For this operation, the value will be youtube#subscriptionListResponse.",
"default": "youtube#subscriptionListResponse"
},
"nextPageToken": {
"type": "string",
"description": "The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set."
},
"pageInfo": {
"$ref": "PageInfo",
"description": "The pageInfo object encapsulates paging information for the result set."
},
"prevPageToken": {
"type": "string",
"description": "The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set."
},
"visitorId": {
"type": "string",
"description": "The visitorId identifies the visitor."
}
}
},
"SubscriptionSnippet": {
"id": "SubscriptionSnippet",
"type": "object",
"description": "Basic details about a subscription, including title, description and thumbnails of the subscribed item.",
"properties": {
"channelId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the subscriber's channel."
},
"channelTitle": {
"type": "string",
"description": "Channel title for the channel that the subscription belongs to."
},
"description": {
"type": "string",
"description": "The subscription's details."
},
"publishedAt": {
"type": "string",
"description": "The date and time that the subscription was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.",
"format": "date-time"
},
"resourceId": {
"$ref": "ResourceId",
"description": "The id object contains information about the channel that the user subscribed to.",
"annotations": {
"required": [
"youtube.subscriptions.insert"
]
}
},
"thumbnails": {
"$ref": "ThumbnailDetails",
"description": "A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail."
},
"title": {
"type": "string",
"description": "The subscription's title."
}
}
},
"SubscriptionSubscriberSnippet": {
"id": "SubscriptionSubscriberSnippet",
"type": "object",
"description": "Basic details about a subscription's subscriber including title, description, channel ID and thumbnails.",
"properties": {
"channelId": {
"type": "string",
"description": "The channel ID of the subscriber."
},
"description": {
"type": "string",
"description": "The description of the subscriber."
},
"thumbnails": {
"$ref": "ThumbnailDetails",
"description": "Thumbnails for this subscriber."
},
"title": {
"type": "string",
"description": "The title of the subscriber."
}
}
},
"Thumbnail": {
"id": "Thumbnail",
"type": "object",
"description": "A thumbnail is an image representing a YouTube resource.",
"properties": {
"height": {
"type": "integer",
"description": "(Optional) Height of the thumbnail image.",
"format": "uint32"
},
"url": {
"type": "string",
"description": "The thumbnail image's URL."
},
"width": {
"type": "integer",
"description": "(Optional) Width of the thumbnail image.",
"format": "uint32"
}
}
},
"ThumbnailDetails": {
"id": "ThumbnailDetails",
"type": "object",
"description": "Internal representation of thumbnails for a YouTube resource.",
"properties": {
"default": {
"$ref": "Thumbnail",
"description": "The default image for this resource."
},
"high": {
"$ref": "Thumbnail",
"description": "The high quality image for this resource."
},
"maxres": {
"$ref": "Thumbnail",
"description": "The maximum resolution quality image for this resource."
},
"medium": {
"$ref": "Thumbnail",
"description": "The medium quality image for this resource."
},
"standard": {
"$ref": "Thumbnail",
"description": "The standard quality image for this resource."
}
}
},
"ThumbnailListResponse": {
"id": "ThumbnailListResponse",
"type": "object",
"description": "A list of thumbnails returned as the response to a thumbnails.set call.",
"properties": {
"etag": {
"type": "string",
"description": "The ETag of the response."
},
"items": {
"type": "array",
"description": "A list of thumbnails.",
"items": {
"$ref": "ThumbnailDetails"
}
},
"kind": {
"type": "string",
"description": "The type of the API response. For this operation, the value will be youtube#thumbnailListResponse.",
"default": "youtube#thumbnailListResponse"
},
"visitorId": {
"type": "string",
"description": "The visitorId identifies the visitor."
}
}
},
"Video": {
"id": "Video",
"type": "object",
"description": "A video resource represents a YouTube video.",
"properties": {
"ageGatingDetails": {
"$ref": "VideoAgeGating",
"description": "Age restriction details related to a video."
},
"contentDetails": {
"$ref": "VideoContentDetails",
"description": "The contentDetails object contains information about the video content, including the length of the video and its aspect ratio."
},
"conversionPings": {
"$ref": "VideoConversionPings",
"description": "The conversionPings object encapsulates information about url pings that need to be respected by the App in different video contexts."
},
"etag": {
"type": "string",
"description": "The ETag of the video resource."
},
"fileDetails": {
"$ref": "VideoFileDetails",
"description": "The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the file's resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner."
},
"id": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the video."
},
"kind": {
"type": "string",
"description": "The type of the API resource. For video resources, the value will be youtube#video.",
"default": "youtube#video"
},
"monetizationDetails": {
"$ref": "VideoMonetizationDetails",
"description": "The monetizationDetails object encapsulates information about the monetization status of the video."
},
"player": {
"$ref": "VideoPlayer",
"description": "The player object contains information that you would use to play the video in an embedded player."
},
"processingDetails": {
"$ref": "VideoProcessingDetails",
"description": "The processingProgress object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video.\n\nThe processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner."
},
"projectDetails": {
"$ref": "VideoProjectDetails",
"description": "The projectDetails object contains information about the project specific video metadata."
},
"recordingDetails": {
"$ref": "VideoRecordingDetails",
"description": "The recordingDetails object encapsulates information about the location, date and address where the video was recorded."
},
"snippet": {
"$ref": "VideoSnippet",
"description": "The snippet object contains basic details about the video, such as its title, description, and category."
},
"statistics": {
"$ref": "VideoStatistics",
"description": "The statistics object contains statistics about the video."
},
"status": {
"$ref": "VideoStatus",
"description": "The status object contains information about the video's uploading, processing, and privacy statuses."
},
"suggestions": {
"$ref": "VideoSuggestions",
"description": "The suggestions object encapsulates suggestions that identify opportunities to improve the video quality or the metadata for the uploaded video. This data can only be retrieved by the video owner."
},
"topicDetails": {
"$ref": "VideoTopicDetails",
"description": "The topicDetails object encapsulates information about Freebase topics associated with the video."
}
}
},
"VideoAgeGating": {
"id": "VideoAgeGating",
"type": "object",
"properties": {
"alcoholContent": {
"type": "boolean",
"description": "Indicates whether or not the video has alcoholic beverage content. Only users of legal purchasing age in a particular country, as identified by ICAP, can view the content."
},
"restricted": {
"type": "boolean",
"description": "Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present."
},
"videoGameRating": {
"type": "string",
"description": "Video game rating, if any.",
"enum": [
"anyone",
"m15Plus",
"m16Plus",
"m17Plus"
],
"enumDescriptions": [
"",
"",
"",
""
]
}
}
},
"VideoCategory": {
"id": "VideoCategory",
"type": "object",
"description": "A videoCategory resource identifies a category that has been or could be associated with uploaded videos.",
"properties": {
"etag": {
"type": "string",
"description": "The ETag of the videoCategory resource."
},
"id": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the video category."
},
"kind": {
"type": "string",
"description": "The type of the API resource. For video category resources, the value will be youtube#videoCategory.",
"default": "youtube#videoCategory"
},
"snippet": {
"$ref": "VideoCategorySnippet",
"description": "The snippet object contains basic details about the video category, including its title."
}
}
},
"VideoCategoryListResponse": {
"id": "VideoCategoryListResponse",
"type": "object",
"description": "A paginated list of video categories returned as the response to a youtube.videoCategory.list call.",
"properties": {
"etag": {
"type": "string",
"description": "The ETag of the response."
},
"eventId": {
"type": "string",
"description": "Serialized EventId of the request which produced this response."
},
"items": {
"type": "array",
"description": "A list of video categories that can be associated with YouTube videos. In this map, the video category ID is the map key, and its value is the corresponding videoCategory resource.",
"items": {
"$ref": "VideoCategory"
}
},
"kind": {
"type": "string",
"description": "The type of the API response. For this operation, the value will be youtube#videoCategoryListResponse.",
"default": "youtube#videoCategoryListResponse"
},
"visitorId": {
"type": "string",
"description": "The visitorId identifies the visitor."
}
}
},
"VideoCategorySnippet": {
"id": "VideoCategorySnippet",
"type": "object",
"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.",
"default": "UCBR8-60-B28hp2BmDPdntcQ"
},
"title": {
"type": "string",
"description": "The video category's title."
}
}
},
"VideoContentDetails": {
"id": "VideoContentDetails",
"type": "object",
"description": "Details about the content of a YouTube Video.",
"properties": {
"caption": {
"type": "string",
"description": "The value of captions indicates whether the video has captions or not.",
"enum": [
"false",
"true"
],
"enumDescriptions": [
"",
""
]
},
"contentRating": {
"$ref": "ContentRating",
"description": "Specifies the ratings that the video received under various rating schemes."
},
"countryRestriction": {
"$ref": "AccessPolicy",
"description": "The countryRestriction object contains information about the countries where a video is (or is not) viewable."
},
"definition": {
"type": "string",
"description": "The value of definition indicates whether the video is available in high definition or only in standard definition.",
"enum": [
"hd",
"sd"
],
"enumDescriptions": [
"",
""
]
},
"dimension": {
"type": "string",
"description": "The value of dimension indicates whether the video is available in 3D or in 2D."
},
"duration": {
"type": "string",
"description": "The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long."
},
"licensedContent": {
"type": "boolean",
"description": "The value of is_license_content indicates whether the video is licensed content."
},
"regionRestriction": {
"$ref": "VideoContentDetailsRegionRestriction",
"description": "The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property."
}
}
},
"VideoContentDetailsRegionRestriction": {
"id": "VideoContentDetailsRegionRestriction",
"type": "object",
"description": "DEPRECATED Region restriction of the video.",
"properties": {
"allowed": {
"type": "array",
"description": "A list of region codes that identify countries where the video is viewable. If this property is present and a country is not listed in its value, then the video is blocked from appearing in that country. If this property is present and contains an empty list, the video is blocked in all countries.",
"items": {
"type": "string"
}
},
"blocked": {
"type": "array",
"description": "A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries.",
"items": {
"type": "string"
}
}
}
},
"VideoConversionPing": {
"id": "VideoConversionPing",
"type": "object",
"properties": {
"context": {
"type": "string",
"description": "Defines the context of the ping.",
"enum": [
"comment",
"dislike",
"like",
"share"
],
"enumDescriptions": [
"",
"",
"",
""
]
},
"conversionUrl": {
"type": "string",
"description": "The url (without the schema) that the app shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D like%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA%3Bytvid%3DUrIaJUvIQDg&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping."
}
}
},
"VideoConversionPings": {
"id": "VideoConversionPings",
"type": "object",
"properties": {
"pings": {
"type": "array",
"description": "Pings that the app shall fire for a video (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.",
"items": {
"$ref": "VideoConversionPing"
}
}
}
},
"VideoFileDetails": {
"id": "VideoFileDetails",
"type": "object",
"description": "Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information.",
"properties": {
"audioStreams": {
"type": "array",
"description": "A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream.",
"items": {
"$ref": "VideoFileDetailsAudioStream"
}
},
"bitrateBps": {
"type": "string",
"description": "The uploaded video file's combined (video and audio) bitrate in bits per second.",
"format": "uint64"
},
"container": {
"type": "string",
"description": "The uploaded video file's container format."
},
"creationTime": {
"type": "string",
"description": "The date and time when the uploaded video file was created. The value is specified in ISO 8601 format. Currently, the following ISO 8601 formats are supported: \n- Date only: YYYY-MM-DD \n- Naive time: YYYY-MM-DDTHH:MM:SS \n- Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM"
},
"durationMs": {
"type": "string",
"description": "The length of the uploaded video in milliseconds.",
"format": "uint64"
},
"fileName": {
"type": "string",
"description": "The uploaded file's name. This field is present whether a video file or another type of file was uploaded."
},
"fileSize": {
"type": "string",
"description": "The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded.",
"format": "uint64"
},
"fileType": {
"type": "string",
"description": "The uploaded file's type as detected by YouTube's video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded.",
"enum": [
"archive",
"audio",
"document",
"image",
"other",
"project",
"video"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
]
},
"recordingLocation": {
"$ref": "GeoPoint",
"description": "Geographic coordinates that identify the place where the uploaded video was recorded. Coordinates are defined using WGS 84."
},
"videoStreams": {
"type": "array",
"description": "A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream.",
"items": {
"$ref": "VideoFileDetailsVideoStream"
}
}
}
},
"VideoFileDetailsAudioStream": {
"id": "VideoFileDetailsAudioStream",
"type": "object",
"description": "Information about an audio stream.",
"properties": {
"bitrateBps": {
"type": "string",
"description": "The audio stream's bitrate, in bits per second.",
"format": "uint64"
},
"channelCount": {
"type": "integer",
"description": "The number of audio channels that the stream contains.",
"format": "uint32"
},
"codec": {
"type": "string",
"description": "The audio codec that the stream uses."
},
"vendor": {
"type": "string",
"description": "A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code."
}
}
},
"VideoFileDetailsVideoStream": {
"id": "VideoFileDetailsVideoStream",
"type": "object",
"description": "Information about a video stream.",
"properties": {
"aspectRatio": {
"type": "number",
"description": "The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed.",
"format": "double"
},
"bitrateBps": {
"type": "string",
"description": "The video stream's bitrate, in bits per second.",
"format": "uint64"
},
"codec": {
"type": "string",
"description": "The video codec that the stream uses."
},
"frameRateFps": {
"type": "number",
"description": "The video stream's frame rate, in frames per second.",
"format": "double"
},
"heightPixels": {
"type": "integer",
"description": "The encoded video content's height in pixels.",
"format": "uint32"
},
"rotation": {
"type": "string",
"description": "The amount that YouTube needs to rotate the original source content to properly display the video.",
"enum": [
"clockwise",
"counterClockwise",
"none",
"other",
"upsideDown"
],
"enumDescriptions": [
"",
"",
"",
"",
""
]
},
"vendor": {
"type": "string",
"description": "A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code."
},
"widthPixels": {
"type": "integer",
"description": "The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels.",
"format": "uint32"
}
}
},
"VideoGetRatingResponse": {
"id": "VideoGetRatingResponse",
"type": "object",
"description": "A list of video ratings returned as the response to a youtube.videos.getRating call.",
"properties": {
"etag": {
"type": "string",
"description": "The ETag of the response."
},
"items": {
"type": "array",
"description": "A list of ratings that match the request criteria.",
"items": {
"$ref": "VideoRating"
}
},
"kind": {
"type": "string",
"description": "The type of the API response. For this operation, the value will be youtube#videoGetRatingResponse.",
"default": "youtube#videoGetRatingResponse"
}
}
},
"VideoListResponse": {
"id": "VideoListResponse",
"type": "object",
"description": "A paginated list of videos returned as the response to a youtube.videos.list call.",
"properties": {
"etag": {
"type": "string",
"description": "The ETag of the response."
},
"eventId": {
"type": "string",
"description": "Serialized EventId of the request which produced this response."
},
"items": {
"type": "array",
"description": "A list of videos that match the request criteria.",
"items": {
"$ref": "Video"
}
},
"kind": {
"type": "string",
"description": "The type of the API response. For this operation, the value will be youtube#videoListResponse.",
"default": "youtube#videoListResponse"
},
"nextPageToken": {
"type": "string",
"description": "The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set."
},
"pageInfo": {
"$ref": "PageInfo",
"description": "The pageInfo object encapsulates paging information for the result set."
},
"prevPageToken": {
"type": "string",
"description": "The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set."
},
"visitorId": {
"type": "string",
"description": "The visitorId identifies the visitor."
}
}
},
"VideoMonetizationDetails": {
"id": "VideoMonetizationDetails",
"type": "object",
"description": "Details about monetization of a YouTube Video.",
"properties": {
"access": {
"$ref": "AccessPolicy",
"description": "The value of access indicates whether the video can be monetized or not."
}
}
},
"VideoPlayer": {
"id": "VideoPlayer",
"type": "object",
"description": "Player to be used for a video playback.",
"properties": {
"embedHtml": {
"type": "string",
"description": "An \u003ciframe\u003e tag that embeds a player that will play the video."
}
}
},
"VideoProcessingDetails": {
"id": "VideoProcessingDetails",
"type": "object",
"description": "Describes processing status and progress and availability of some other Video resource parts.",
"properties": {
"editorSuggestionsAvailability": {
"type": "string",
"description": "This value indicates whether video editing suggestions, which might improve video quality or the playback experience, are available for the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request."
},
"fileDetailsAvailability": {
"type": "string",
"description": "This value indicates whether file details are available for the uploaded video. You can retrieve a video's file details by requesting the fileDetails part in your videos.list() request."
},
"processingFailureReason": {
"type": "string",
"description": "The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed.",
"enum": [
"other",
"streamingFailed",
"transcodeFailed",
"uploadFailed"
],
"enumDescriptions": [
"",
"",
"",
""
]
},
"processingIssuesAvailability": {
"type": "string",
"description": "This value indicates whether the video processing engine has generated suggestions that might improve YouTube's ability to process the the video, warnings that explain video processing problems, or errors that cause video processing problems. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request."
},
"processingProgress": {
"$ref": "VideoProcessingDetailsProcessingProgress",
"description": "The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing."
},
"processingStatus": {
"type": "string",
"description": "The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed.",
"enum": [
"failed",
"processing",
"succeeded",
"terminated"
],
"enumDescriptions": [
"",
"",
"",
""
]
},
"tagSuggestionsAvailability": {
"type": "string",
"description": "This value indicates whether keyword (tag) suggestions are available for the video. Tags can be added to a video's metadata to make it easier for other users to find the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request."
},
"thumbnailsAvailability": {
"type": "string",
"description": "This value indicates whether thumbnail images have been generated for the video."
}
}
},
"VideoProcessingDetailsProcessingProgress": {
"id": "VideoProcessingDetailsProcessingProgress",
"type": "object",
"description": "Video processing progress and completion time estimate.",
"properties": {
"partsProcessed": {
"type": "string",
"description": "The number of parts of the video that YouTube has already processed. You can estimate the percentage of the video that YouTube has already processed by calculating:\n100 * parts_processed / parts_total\n\nNote that since the estimated number of parts could increase without a corresponding increase in the number of parts that have already been processed, it is possible that the calculated progress could periodically decrease while YouTube processes a video.",
"format": "uint64"
},
"partsTotal": {
"type": "string",
"description": "An estimate of the total number of parts that need to be processed for the video. The number may be updated with more precise estimates while YouTube processes the video.",
"format": "uint64"
},
"timeLeftMs": {
"type": "string",
"description": "An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video.",
"format": "uint64"
}
}
},
"VideoProjectDetails": {
"id": "VideoProjectDetails",
"type": "object",
"description": "Project specific details about the content of a YouTube Video.",
"properties": {
"tags": {
"type": "array",
"description": "A list of project tags associated with the video during the upload.",
"items": {
"type": "string"
}
}
}
},
"VideoRating": {
"id": "VideoRating",
"type": "object",
"description": "Basic details about rating of a video.",
"properties": {
"rating": {
"type": "string",
"description": "Rating of a video.",
"enum": [
"dislike",
"like",
"none",
"unspecified"
],
"enumDescriptions": [
"",
"",
"",
""
]
},
"videoId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the video."
}
}
},
"VideoRecordingDetails": {
"id": "VideoRecordingDetails",
"type": "object",
"description": "Recording information associated with the video.",
"properties": {
"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."
},
"recordingDate": {
"type": "string",
"description": "The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.",
"format": "date-time"
}
}
},
"VideoSnippet": {
"id": "VideoSnippet",
"type": "object",
"description": "Basic details about a video, including title, description, uploader, thumbnails and category.",
"properties": {
"categoryId": {
"type": "string",
"description": "The YouTube video category associated with the video."
},
"channelId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the channel that the video was uploaded to."
},
"channelTitle": {
"type": "string",
"description": "Channel title for the channel that the video belongs to."
},
"description": {
"type": "string",
"description": "The video's description."
},
"publishedAt": {
"type": "string",
"description": "The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.",
"format": "date-time"
},
"tags": {
"type": "array",
"description": "A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.",
"items": {
"type": "string"
}
},
"thumbnails": {
"$ref": "ThumbnailDetails",
"description": "A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail."
},
"title": {
"type": "string",
"description": "The video's title."
}
}
},
"VideoStatistics": {
"id": "VideoStatistics",
"type": "object",
"description": "Statistics about the video, such as the number of times the video was viewed or liked.",
"properties": {
"commentCount": {
"type": "string",
"description": "The number of comments for the video.",
"format": "uint64"
},
"dislikeCount": {
"type": "string",
"description": "The number of users who have indicated that they disliked the video by giving it a negative rating.",
"format": "uint64"
},
"favoriteCount": {
"type": "string",
"description": "The number of users who currently have the video marked as a favorite video.",
"format": "uint64"
},
"likeCount": {
"type": "string",
"description": "The number of users who have indicated that they liked the video by giving it a positive rating.",
"format": "uint64"
},
"viewCount": {
"type": "string",
"description": "The number of times the video has been viewed.",
"format": "uint64"
}
}
},
"VideoStatus": {
"id": "VideoStatus",
"type": "object",
"description": "Basic details about a video category, such as its localized title.",
"properties": {
"embeddable": {
"type": "boolean",
"description": "This value indicates if the video can be embedded on another website."
},
"failureReason": {
"type": "string",
"description": "This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.",
"enum": [
"codec",
"conversion",
"emptyFile",
"invalidFile",
"tooSmall",
"uploadAborted"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
""
]
},
"license": {
"type": "string",
"description": "The video's license.",
"enum": [
"creativeCommon",
"youtube"
],
"enumDescriptions": [
"",
""
]
},
"privacyStatus": {
"type": "string",
"description": "The video's privacy status.",
"enum": [
"private",
"public",
"unlisted"
],
"enumDescriptions": [
"",
"",
""
]
},
"publicStatsViewable": {
"type": "boolean",
"description": "This value indicates if the extended video statistics on the watch page can be viewed by everyone. Note that the view count, likes, etc will still be visible if this is disabled."
},
"rejectionReason": {
"type": "string",
"description": "This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.",
"enum": [
"claim",
"copyright",
"duplicate",
"inappropriate",
"length",
"termsOfUse",
"trademark",
"uploaderAccountClosed",
"uploaderAccountSuspended"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"uploadStatus": {
"type": "string",
"description": "The status of the uploaded video.",
"enum": [
"deleted",
"failed",
"processed",
"rejected",
"uploaded"
],
"enumDescriptions": [
"",
"",
"",
"",
""
]
}
}
},
"VideoSuggestions": {
"id": "VideoSuggestions",
"type": "object",
"description": "Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions.",
"properties": {
"editorSuggestions": {
"type": "array",
"description": "A list of video editing operations that might improve the video quality or playback experience of the uploaded video.",
"items": {
"type": "string",
"enum": [
"audioQuietAudioSwap",
"videoAutoLevels",
"videoCrop",
"videoStabilize"
],
"enumDescriptions": [
"",
"",
"",
""
]
}
},
"processingErrors": {
"type": "array",
"description": "A list of errors that will prevent YouTube from successfully processing the uploaded video video. These errors indicate that, regardless of the video's current processing status, eventually, that status will almost certainly be failed.",
"items": {
"type": "string",
"enum": [
"archiveFile",
"audioFile",
"docFile",
"imageFile",
"notAVideoFile",
"projectFile"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
""
]
}
},
"processingHints": {
"type": "array",
"description": "A list of suggestions that may improve YouTube's ability to process the video.",
"items": {
"type": "string",
"enum": [
"nonStreamableMov",
"sendBestQualityVideo"
],
"enumDescriptions": [
"",
""
]
}
},
"processingWarnings": {
"type": "array",
"description": "A list of reasons why YouTube may have difficulty transcoding the uploaded video or that might result in an erroneous transcoding. These warnings are generated before YouTube actually processes the uploaded video file. In addition, they identify issues that are unlikely to cause the video processing to fail but that might cause problems such as sync issues, video artifacts, or a missing audio track.",
"items": {
"type": "string",
"enum": [
"hasEditlist",
"inconsistentResolution",
"problematicAudioCodec",
"problematicVideoCodec",
"unknownAudioCodec",
"unknownContainer",
"unknownVideoCodec"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
]
}
},
"tagSuggestions": {
"type": "array",
"description": "A list of keyword tags that could be added to the video's metadata to increase the likelihood that users will locate your video when searching or browsing on YouTube.",
"items": {
"$ref": "VideoSuggestionsTagSuggestion"
}
}
}
},
"VideoSuggestionsTagSuggestion": {
"id": "VideoSuggestionsTagSuggestion",
"type": "object",
"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 information to display appropriate tag suggestions based on the video category that the video uploader associates with the video. By default, tag suggestions are relevant for all categories if there are no restricts defined for the keyword.",
"items": {
"type": "string"
}
},
"tag": {
"type": "string",
"description": "The keyword tag suggested for the video."
}
}
},
"VideoTopicDetails": {
"id": "VideoTopicDetails",
"type": "object",
"description": "Freebase topic information related to the video.",
"properties": {
"topicIds": {
"type": "array",
"description": "A list of Freebase topic IDs associated with the video. You can retrieve information about each topic using the Freebase Topic API.",
"items": {
"type": "string"
}
}
}
},
"WatchSettings": {
"id": "WatchSettings",
"type": "object",
"description": "Branding properties for the watch.",
"properties": {
"backgroundColor": {
"type": "string",
"description": "The text color for the video watch page's branded area."
},
"featuredPlaylistId": {
"type": "string",
"description": "An ID that uniquely identifies a playlist that displays next to the video player."
},
"textColor": {
"type": "string",
"description": "The background color for the video watch page's branded area."
}
}
}
},
"resources": {
"activities": {
"methods": {
"insert": {
"id": "youtube.activities.insert",
"path": "activities",
"httpMethod": "POST",
"description": "Posts a bulletin for a specific channel. (The user submitting the request must be authorized to act on the channel's behalf.)",
"parameters": {
"part": {
"type": "string",
"description": "The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.\n\nThe part names that you can include in the parameter value are snippet and contentDetails.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"part"
],
"request": {
"$ref": "Activity"
},
"response": {
"$ref": "Activity"
},
"scopes": [
"https://www.googleapis.com/auth/youtube"
]
},
"list": {
"id": "youtube.activities.list",
"path": "activities",
"httpMethod": "GET",
"description": "Returns a list of channel activity events that match the request criteria. For example, you can retrieve events associated with a particular channel, events associated with the user's subscriptions and Google+ friends, or the YouTube home page feed, which is customized for each user.",
"parameters": {
"channelId": {
"type": "string",
"description": "The channelId parameter specifies a unique YouTube channel ID. The API will then return a list of that channel's activities.",
"location": "query"
},
"home": {
"type": "boolean",
"description": "Set this parameter's value to true to retrieve the activity feed that displays on the YouTube home page for the currently authenticated user.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "USE_DESCRIPTION --- channels:list:maxResults",
"default": "5",
"format": "uint32",
"minimum": "0",
"maximum": "50",
"location": "query"
},
"mine": {
"type": "boolean",
"description": "Set this parameter's value to true to retrieve a feed of the authenticated user's activities.",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "USE_DESCRIPTION --- channels:list:pageToken",
"location": "query"
},
"part": {
"type": "string",
"description": "The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails.\n\nIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those nested properties.",
"required": true,
"location": "query"
},
"publishedAfter": {
"type": "string",
"description": "The publishedAfter parameter specifies the earliest date and time that an activity could have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be included in the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.",
"format": "date-time",
"location": "query"
},
"publishedBefore": {
"type": "string",
"description": "The publishedBefore parameter specifies the date and time before which an activity must have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be excluded from the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.",
"format": "date-time",
"location": "query"
},
"regionCode": {
"type": "string",
"description": "The regionCode parameter instructs the API to return results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code.",
"location": "query"
}
},
"parameterOrder": [
"part"
],
"response": {
"$ref": "ActivityListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.readonly"
]
}
}
},
"channelBanners": {
"methods": {
"insert": {
"id": "youtube.channelBanners.insert",
"path": "channelBanners/insert",
"httpMethod": "POST",
"description": "Uploads a channel banner to YouTube.",
"parameters": {
"onBehalfOfContentOwner": {
"type": "string",
"description": "USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner",
"location": "query"
}
},
"request": {
"$ref": "ChannelBannerInsertResponse"
},
"response": {
"$ref": "ChannelBannerInsertResponse"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.upload"
],
"supportsMediaUpload": true,
"mediaUpload": {
"accept": [
"application/octet-stream",
"image/jpeg",
"image/png"
],
"maxSize": "6MB",
"protocols": {
"simple": {
"multipart": true,
"path": "/upload/youtube/v3/channelBanners/insert"
},
"resumable": {
"multipart": true,
"path": "/resumable/upload/youtube/v3/channelBanners/insert"
}
}
}
}
}
},
"channels": {
"methods": {
"list": {
"id": "youtube.channels.list",
"path": "channels",
"httpMethod": "GET",
"description": "Returns a collection of zero or more channel resources that match the request criteria.",
"parameters": {
"categoryId": {
"type": "string",
"description": "The categoryId parameter specifies a YouTube guide category, thereby requesting YouTube channels associated with that category.",
"location": "query"
},
"forUsername": {
"type": "string",
"description": "The forUsername parameter specifies a YouTube username, thereby requesting the channel associated with that username.",
"location": "query"
},
"id": {
"type": "string",
"description": "The id parameter specifies a comma-separated list of the YouTube channel ID(s) for the resource(s) that are being retrieved. In a channel resource, the id property specifies the channel's YouTube channel ID.",
"location": "query"
},
"managedByMe": {
"type": "boolean",
"description": "Set this parameter's value to true to instruct the API to only return channels managed by the content owner that the onBehalfOfContentOwner parameter specifies. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maxResults parameter specifies the maximum number of items that should be returned in the result set.",
"default": "5",
"format": "uint32",
"minimum": "0",
"maximum": "50",
"location": "query"
},
"mine": {
"type": "boolean",
"description": "Set this parameter's value to true to instruct the API to only return channels owned by the authenticated user.",
"location": "query"
},
"mySubscribers": {
"type": "boolean",
"description": "Set this parameter's value to true to retrieve a list of channels that subscribed to the authenticated user's channel.",
"location": "query"
},
"onBehalfOfContentOwner": {
"type": "string",
"description": "The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner.",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.",
"location": "query"
},
"part": {
"type": "string",
"description": "The part parameter specifies a comma-separated list of one or more channel resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, statistics, topicDetails, and invideoPromotion.\n\nIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set part=contentDetails, the API response will also contain all of those nested properties.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"part"
],
"response": {
"$ref": "ChannelListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner"
]
},
"update": {
"id": "youtube.channels.update",
"path": "channels",
"httpMethod": "PUT",
"description": "Updates a channel's metadata.",
"parameters": {
"part": {
"type": "string",
"description": "The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.\n\nThe part names that you can include in the parameter value are id and invideoPromotion.\n\nNote that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"part"
],
"request": {
"$ref": "Channel"
},
"response": {
"$ref": "Channel"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtubepartner"
]
}
}
},
"guideCategories": {
"methods": {
"list": {
"id": "youtube.guideCategories.list",
"path": "guideCategories",
"httpMethod": "GET",
"description": "Returns a list of categories that can be associated with YouTube channels.",
"parameters": {
"hl": {
"type": "string",
"description": "The hl parameter specifies the language that will be used for text values in the API response.",
"default": "en-US",
"location": "query"
},
"id": {
"type": "string",
"description": "The id parameter specifies a comma-separated list of the YouTube channel category ID(s) for the resource(s) that are being retrieved. In a guideCategory resource, the id property specifies the YouTube channel category ID.",
"location": "query"
},
"part": {
"type": "string",
"description": "The part parameter specifies a comma-separated list of one or more guideCategory resource properties that the API response will include. The part names that you can include in the parameter value are id and snippet.\n\nIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a guideCategory resource, the snippet property contains other properties, such as the category's title. If you set part=snippet, the API response will also contain all of those nested properties.",
"required": true,
"location": "query"
},
"regionCode": {
"type": "string",
"description": "The regionCode parameter instructs the API to return the list of guide categories available in the specified country. The parameter value is an ISO 3166-1 alpha-2 country code.",
"location": "query"
}
},
"parameterOrder": [
"part"
],
"response": {
"$ref": "GuideCategoryListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner"
]
}
}
},
"liveBroadcasts": {
"methods": {
"bind": {
"id": "youtube.liveBroadcasts.bind",
"path": "liveBroadcasts/bind",
"httpMethod": "POST",
"description": "Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream.",
"parameters": {
"id": {
"type": "string",
"description": "The id parameter specifies the unique ID of the broadcast that is being bound to a video stream.",
"required": true,
"location": "query"
},
"onBehalfOfContentOwner": {
"type": "string",
"description": "USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner",
"location": "query"
},
"part": {
"type": "string",
"description": "The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.",
"required": true,
"location": "query"
},
"streamId": {
"type": "string",
"description": "The streamId parameter specifies the unique ID of the video stream that is being bound to a broadcast. If this parameter is omitted, the API will remove any existing binding between the broadcast and a video stream.",
"location": "query"
}
},
"parameterOrder": [
"id",
"part"
],
"response": {
"$ref": "LiveBroadcast"
},
"scopes": [
"https://www.googleapis.com/auth/youtube"
]
},
"control": {
"id": "youtube.liveBroadcasts.control",
"path": "liveBroadcasts/control",
"httpMethod": "POST",
"description": "Control the slate of the broadacast.",
"parameters": {
"displaySlate": {
"type": "boolean",
"description": "The displaySlate parameter specifies whether to enable or disable the slate.",
"location": "query"
},
"id": {
"type": "string",
"description": "The id parameter specifies the YouTube live broadcast ID for the resource that is being deleted.",
"required": true,
"location": "query"
},
"offsetTimeMs": {
"type": "string",
"description": "The offsetTimeMs parameter specifies a point in time in the video when the specified action (e.g. display a slate) is executed. The property value identifies a positive time offset, in milliseconds, from the beginning of the monitor stream. Though measured in milliseconds, the value is actually an approximation, and YouTube will act as closely as possible to that time. If not specified, it indicates that the action should be performed as soon as possible. If your broadcast stream is not delayed, then it should not be specified. However, if your broadcast stream is delayed, then the parameter can specify the time when the operation should be executed. See the Getting started guide for more details. Note: The offset is measured from the time that the testing phase began.",
"format": "uint64",
"location": "query"
},
"onBehalfOfContentOwner": {
"type": "string",
"description": "USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner",
"location": "query"
},
"part": {
"type": "string",
"description": "The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"id",
"part"
],
"response": {
"$ref": "LiveBroadcast"
},
"scopes": [
"https://www.googleapis.com/auth/youtube"
]
},
"delete": {
"id": "youtube.liveBroadcasts.delete",
"path": "liveBroadcasts",
"httpMethod": "DELETE",
"description": "Deletes a broadcast.",
"parameters": {
"id": {
"type": "string",
"description": "The id parameter specifies the YouTube live broadcast ID for the resource that is being deleted.",
"required": true,
"location": "query"
},
"onBehalfOfContentOwner": {
"type": "string",
"description": "USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner",
"location": "query"
}
},
"parameterOrder": [
"id"
],
"scopes": [
"https://www.googleapis.com/auth/youtube"
]
},
"insert": {
"id": "youtube.liveBroadcasts.insert",
"path": "liveBroadcasts",
"httpMethod": "POST",
"description": "Creates a broadcast.",
"parameters": {
"onBehalfOfContentOwner": {
"type": "string",
"description": "USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner",
"location": "query"
},
"part": {
"type": "string",
"description": "The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.\n\nThe part properties that you can include in the parameter value are id, snippet, contentDetails, and status.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"part"
],
"request": {
"$ref": "LiveBroadcast"
},
"response": {
"$ref": "LiveBroadcast"
},
"scopes": [
"https://www.googleapis.com/auth/youtube"
]
},
"list": {
"id": "youtube.liveBroadcasts.list",
"path": "liveBroadcasts",
"httpMethod": "GET",
"description": "Returns a list of YouTube broadcasts that match the API request parameters.",
"parameters": {
"broadcastStatus": {
"type": "string",
"description": "The broadcastStatus parameter filters the API response to only include broadcasts with the specified status.",
"enum": [
"active",
"all",
"completed",
"upcoming"
],
"enumDescriptions": [
"Return current live broadcasts.",
"Return all broadcasts.",
"Return broadcasts that have already ended.",
"Return broadcasts that have not yet started."
],
"location": "query"
},
"id": {
"type": "string",
"description": "The id parameter specifies a comma-separated list of YouTube broadcast IDs that identify the broadcasts being retrieved. In a liveBroadcast resource, the id property specifies the broadcast's ID.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maxResults parameter specifies the maximum number of items that should be returned in the result set. Acceptable values are 0 to 50, inclusive. The default value is 5.",
"default": "5",
"format": "uint32",
"minimum": "0",
"maximum": "50",
"location": "query"
},
"mine": {
"type": "boolean",
"description": "The mine parameter can be used to instruct the API to only return broadcasts owned by the authenticated user. Set the parameter value to true to only retrieve your own broadcasts.",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.",
"location": "query"
},
"part": {
"type": "string",
"description": "The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"part"
],
"response": {
"$ref": "LiveBroadcastList"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.readonly"
]
},
"transition": {
"id": "youtube.liveBroadcasts.transition",
"path": "liveBroadcasts/transition",
"httpMethod": "POST",
"description": "Changes the status of a YouTube live broadcast and initiates any processes associated with the new status. For example, when you transition a broadcast's status to testing, YouTube starts to transmit video to that broadcast's monitor stream.",
"parameters": {
"broadcastStatus": {
"type": "string",
"description": "The broadcastStatus parameter identifies the state to which the broadcast is changing.",
"required": true,
"enum": [
"complete",
"live",
"testing"
],
"enumDescriptions": [
"The broadcast is over. YouTube stops transmitting video.",
"The broadcast is visible to its audience. YouTube transmits video to the broadcast's monitor stream and its broadcast stream.",
"Start testing the broadcast. YouTube transmits video to the broadcast's monitor stream. Note that you can only transition a broadcast to the testing state if its contentDetails.monitorStream.enableMonitorStream property is set to true."
],
"location": "query"
},
"id": {
"type": "string",
"description": "The id parameter specifies the unique ID of the broadcast that is transitioning to another status.",
"required": true,
"location": "query"
},
"onBehalfOfContentOwner": {
"type": "string",
"description": "USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner",
"location": "query"
},
"part": {
"type": "string",
"description": "The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"broadcastStatus",
"id",
"part"
],
"response": {
"$ref": "LiveBroadcast"
},
"scopes": [
"https://www.googleapis.com/auth/youtube"
]
},
"update": {
"id": "youtube.liveBroadcasts.update",
"path": "liveBroadcasts",
"httpMethod": "PUT",
"description": "Updates a broadcast. For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object.",
"parameters": {
"onBehalfOfContentOwner": {
"type": "string",
"description": "USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner",
"location": "query"
},
"part": {
"type": "string",
"description": "The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.\n\nThe part properties that you can include in the parameter value are id, snippet, contentDetails, and status.\n\nNote that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a broadcast's privacy status is defined in the status part. As such, if your request is updating a private or unlisted broadcast, and the request's part parameter value includes the status part, the broadcast's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the broadcast will revert to the default privacy setting.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"part"
],
"request": {
"$ref": "LiveBroadcast"
},
"response": {
"$ref": "LiveBroadcast"
},
"scopes": [
"https://www.googleapis.com/auth/youtube"
]
}
}
},
"liveStreams": {
"methods": {
"delete": {
"id": "youtube.liveStreams.delete",
"path": "liveStreams",
"httpMethod": "DELETE",
"description": "Deletes a video stream.",
"parameters": {
"id": {
"type": "string",
"description": "The id parameter specifies the YouTube live stream ID for the resource that is being deleted.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"id"
],
"scopes": [
"https://www.googleapis.com/auth/youtube"
]
},
"insert": {
"id": "youtube.liveStreams.insert",
"path": "liveStreams",
"httpMethod": "POST",
"description": "Creates a video stream. The stream enables you to send your video to YouTube, which can then broadcast the video to your audience.",
"parameters": {
"part": {
"type": "string",
"description": "The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.\n\nThe part properties that you can include in the parameter value are id, snippet, cdn, and status.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"part"
],
"request": {
"$ref": "LiveStream"
},
"response": {
"$ref": "LiveStream"
},
"scopes": [
"https://www.googleapis.com/auth/youtube"
]
},
"list": {
"id": "youtube.liveStreams.list",
"path": "liveStreams",
"httpMethod": "GET",
"description": "Returns a list of video streams that match the API request parameters.",
"parameters": {
"id": {
"type": "string",
"description": "The id parameter specifies a comma-separated list of YouTube stream IDs that identify the streams being retrieved. In a liveStream resource, the id property specifies the stream's ID.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maxResults parameter specifies the maximum number of items that should be returned in the result set. Acceptable values are 0 to 50, inclusive. The default value is 5.",
"default": "5",
"format": "uint32",
"minimum": "0",
"maximum": "50",
"location": "query"
},
"mine": {
"type": "boolean",
"description": "The mine parameter can be used to instruct the API to only return streams owned by the authenticated user. Set the parameter value to true to only retrieve your own streams.",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.",
"location": "query"
},
"part": {
"type": "string",
"description": "The part parameter specifies a comma-separated list of one or more liveStream resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, cdn, and status.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"part"
],
"response": {
"$ref": "LiveStreamList"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.readonly"
]
},
"update": {
"id": "youtube.liveStreams.update",
"path": "liveStreams",
"httpMethod": "PUT",
"description": "Updates a video stream. If the properties that you want to change cannot be updated, then you need to create a new stream with the proper settings.",
"parameters": {
"part": {
"type": "string",
"description": "The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.\n\nThe part properties that you can include in the parameter value are id, snippet, cdn, and status.\n\nNote that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. If the request body does not specify a value for a mutable property, the existing value for that property will be removed.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"part"
],
"request": {
"$ref": "LiveStream"
},
"response": {
"$ref": "LiveStream"
},
"scopes": [
"https://www.googleapis.com/auth/youtube"
]
}
}
},
"playlistItems": {
"methods": {
"delete": {
"id": "youtube.playlistItems.delete",
"path": "playlistItems",
"httpMethod": "DELETE",
"description": "Deletes a playlist item.",
"parameters": {
"id": {
"type": "string",
"description": "The id parameter specifies the YouTube playlist item ID for the playlist item that is being deleted. In a playlistItem resource, the id property specifies the playlist item's ID.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"id"
],
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtubepartner"
]
},
"insert": {
"id": "youtube.playlistItems.insert",
"path": "playlistItems",
"httpMethod": "POST",
"description": "Adds a resource to a playlist.",
"parameters": {
"part": {
"type": "string",
"description": "The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.\n\nThe part names that you can include in the parameter value are snippet and contentDetails.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"part"
],
"request": {
"$ref": "PlaylistItem"
},
"response": {
"$ref": "PlaylistItem"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtubepartner"
]
},
"list": {
"id": "youtube.playlistItems.list",
"path": "playlistItems",
"httpMethod": "GET",
"description": "Returns a collection of playlist items that match the API request parameters. You can retrieve all of the playlist items in a specified playlist or retrieve one or more playlist items by their unique IDs.",
"parameters": {
"id": {
"type": "string",
"description": "The id parameter specifies a comma-separated list of one or more unique playlist item IDs.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "USE_DESCRIPTION --- channels:list:maxResults",
"default": "5",
"format": "uint32",
"minimum": "0",
"maximum": "50",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "USE_DESCRIPTION --- channels:list:pageToken",
"location": "query"
},
"part": {
"type": "string",
"description": "The part parameter specifies a comma-separated list of one or more playlistItem resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails.\n\nIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlistItem resource, the snippet property contains numerous fields, including the title, description, position, and resourceId properties. As such, if you set part=snippet, the API response will contain all of those properties.",
"required": true,
"location": "query"
},
"playlistId": {
"type": "string",
"description": "The playlistId parameter specifies the unique ID of the playlist for which you want to retrieve playlist items. Note that even though this is an optional parameter, every request to retrieve playlist items must specify a value for either the id parameter or the playlistId parameter.",
"location": "query"
},
"videoId": {
"type": "string",
"description": "The videoId parameter specifies that the request should return only the playlist items that contain the specified video.",
"location": "query"
}
},
"parameterOrder": [
"part"
],
"response": {
"$ref": "PlaylistItemListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner"
],
"supportsSubscription": true
},
"update": {
"id": "youtube.playlistItems.update",
"path": "playlistItems",
"httpMethod": "PUT",
"description": "Modifies a playlist item. For example, you could update the item's position in the playlist.",
"parameters": {
"part": {
"type": "string",
"description": "The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.\n\nThe part names that you can include in the parameter value are snippet and contentDetails.\n\nNote that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a playlist item can specify a start time and end time, which identify the times portion of the video that should play when users watch the video in the playlist. If your request is updating a playlist item that sets these values, and the request's part parameter value includes the contentDetails part, the playlist item's start and end times will be updated to whatever value the request body specifies. If the request body does not specify values, the existing start and end times will be removed and replaced with the default settings.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"part"
],
"request": {
"$ref": "PlaylistItem"
},
"response": {
"$ref": "PlaylistItem"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtubepartner"
]
}
}
},
"playlists": {
"methods": {
"delete": {
"id": "youtube.playlists.delete",
"path": "playlists",
"httpMethod": "DELETE",
"description": "Deletes a playlist.",
"parameters": {
"id": {
"type": "string",
"description": "The id parameter specifies the YouTube playlist ID for the playlist that is being deleted. In a playlist resource, the id property specifies the playlist's ID.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"id"
],
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtubepartner"
]
},
"insert": {
"id": "youtube.playlists.insert",
"path": "playlists",
"httpMethod": "POST",
"description": "Creates a playlist.",
"parameters": {
"part": {
"type": "string",
"description": "The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.\n\nThe part names that you can include in the parameter value are snippet and status.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"part"
],
"request": {
"$ref": "Playlist"
},
"response": {
"$ref": "Playlist"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtubepartner"
]
},
"list": {
"id": "youtube.playlists.list",
"path": "playlists",
"httpMethod": "GET",
"description": "Returns a collection of playlists that match the API request parameters. For example, you can retrieve all playlists that the authenticated user owns, or you can retrieve one or more playlists by their unique IDs.",
"parameters": {
"channelId": {
"type": "string",
"description": "This value indicates that the API should only return the specified channel's playlists.",
"location": "query"
},
"id": {
"type": "string",
"description": "The id parameter specifies a comma-separated list of the YouTube playlist ID(s) for the resource(s) that are being retrieved. In a playlist resource, the id property specifies the playlist's YouTube playlist ID.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "USE_DESCRIPTION --- channels:list:maxResults",
"default": "5",
"format": "uint32",
"minimum": "0",
"maximum": "50",
"location": "query"
},
"mine": {
"type": "boolean",
"description": "Set this parameter's value to true to instruct the API to only return playlists owned by the authenticated user.",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "USE_DESCRIPTION --- channels:list:pageToken",
"location": "query"
},
"part": {
"type": "string",
"description": "The part parameter specifies a comma-separated list of one or more playlist resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and status.\n\nIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlist resource, the snippet property contains properties like author, title, description, tags, and timeCreated. As such, if you set part=snippet, the API response will contain all of those properties.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"part"
],
"response": {
"$ref": "PlaylistListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner"
]
},
"update": {
"id": "youtube.playlists.update",
"path": "playlists",
"httpMethod": "PUT",
"description": "Modifies a playlist. For example, you could change a playlist's title, description, or privacy status.",
"parameters": {
"part": {
"type": "string",
"description": "The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.\n\nThe part names that you can include in the parameter value are snippet and status.\n\nNote that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a playlist's privacy setting is contained in the status part. As such, if your request is updating a private playlist, and the request's part parameter value includes the status part, the playlist's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the playlist will revert to the default privacy setting.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"part"
],
"request": {
"$ref": "Playlist"
},
"response": {
"$ref": "Playlist"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtubepartner"
]
}
}
},
"search": {
"methods": {
"list": {
"id": "youtube.search.list",
"path": "search",
"httpMethod": "GET",
"description": "Returns a collection of search results that match the query parameters specified in the API request. By default, a search result set identifies matching video, channel, and playlist resources, but you can also configure queries to only retrieve a specific type of resource.",
"parameters": {
"channelId": {
"type": "string",
"description": "The channelId parameter indicates that the API response should only contain resources created by the channel",
"location": "query"
},
"channelType": {
"type": "string",
"description": "The channelType parameter lets you restrict a search to a particular type of channel.",
"enum": [
"any",
"show"
],
"enumDescriptions": [
"Return all channels.",
"Only retrieve shows."
],
"location": "query"
},
"forContentOwner": {
"type": "boolean",
"description": "The forContentOwner parameter restricts the search to only retrieve resources owned by the content owner specified by the onBehalfOfContentOwner parameter. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided.",
"location": "query"
},
"forMine": {
"type": "boolean",
"description": "The forMine parameter restricts the search to only retrieve videos owned by the authenticated user.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "USE_DESCRIPTION --- channels:list:maxResults",
"default": "5",
"format": "uint32",
"minimum": "0",
"maximum": "50",
"location": "query"
},
"onBehalfOfContentOwner": {
"type": "string",
"description": "USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner",
"location": "query"
},
"order": {
"type": "string",
"description": "The order parameter specifies the method that will be used to order resources in the API response.",
"default": "SEARCH_SORT_RELEVANCE",
"enum": [
"date",
"rating",
"relevance",
"title",
"videoCount",
"viewCount"
],
"enumDescriptions": [
"Resources are sorted in reverse chronological order based on the date they were created.",
"Resources are sorted from highest to lowest rating.",
"Resources are sorted based on their relevance to the search query. This is the default value for this parameter.",
"Resources are sorted based on their title.",
"Channels are sorted from highest to lowest number of video uploaded.",
"Resources are sorted from highest to lowest number of views."
],
"location": "query"
},
"pageToken": {
"type": "string",
"description": "USE_DESCRIPTION --- channels:list:pageToken",
"location": "query"
},
"part": {
"type": "string",
"description": "The part parameter specifies a comma-separated list of one or more search resource properties that the API response will include. The part names that you can include in the parameter value are id and snippet.\n\nIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a search result, the snippet property contains other properties that identify the result's title, description, and so forth. If you set part=snippet, the API response will also contain all of those nested properties.",
"required": true,
"location": "query"
},
"publishedAfter": {
"type": "string",
"description": "The publishedAfter parameter indicates that the API response should only contain resources created after the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).",
"format": "date-time",
"location": "query"
},
"publishedBefore": {
"type": "string",
"description": "The publishedBefore parameter indicates that the API response should only contain resources created before the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).",
"format": "date-time",
"location": "query"
},
"q": {
"type": "string",
"description": "The q parameter specifies the query term to search for.",
"location": "query"
},
"regionCode": {
"type": "string",
"description": "The regionCode parameter instructs the API to return search results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code.",
"location": "query"
},
"relatedToVideoId": {
"type": "string",
"description": "The relatedToVideoId parameter retrieves a list of videos that are related to the video that the parameter value identifies. The parameter value must be set to a YouTube video ID and, if you are using this parameter, the type parameter must be set to video.",
"location": "query"
},
"safeSearch": {
"type": "string",
"description": "The safeSearch parameter indicates whether the search results should include restricted content as well as standard content.",
"enum": [
"moderate",
"none",
"strict"
],
"enumDescriptions": [
"YouTube will filter some content from search results and, at the least, will filter content that is restricted in your locale. Based on their content, search results could be removed from search results or demoted in search results. Note: The default value for the safeSearch parameter is moderate.",
"YouTube will not perform any filtering on the search result set.",
"YouTube will try to exclude all restricted content from the search result set. Based on their content, search results could be removed from search results or demoted in search results."
],
"location": "query"
},
"topicId": {
"type": "string",
"description": "The topicId parameter indicates that the API response should only contain resources associated with the specified topic. The value identifies a Freebase topic ID.",
"location": "query"
},
"type": {
"type": "string",
"description": "The type parameter restricts a search query to only retrieve a particular type of resource.",
"default": "video,channel,playlist",
"location": "query"
},
"videoCaption": {
"type": "string",
"description": "The videoCaption parameter indicates whether the API should filter video search results based on whether they have captions.",
"enum": [
"any",
"closedCaption",
"none"
],
"enumDescriptions": [
"Do not filter results based on caption availability.",
"Only include videos that have captions.",
"Only include videos that do not have captions."
],
"location": "query"
},
"videoCategoryId": {
"type": "string",
"description": "The videoCategoryId parameter filters video search results based on their category.",
"location": "query"
},
"videoDefinition": {
"type": "string",
"description": "The videoDefinition parameter lets you restrict a search to only include either high definition (HD) or standard definition (SD) videos. HD videos are available for playback in at least 720p, though higher resolutions, like 1080p, might also be available.",
"enum": [
"any",
"high",
"standard"
],
"enumDescriptions": [
"Return all videos, regardless of their resolution.",
"Only retrieve HD videos.",
"Only retrieve videos in standard definition."
],
"location": "query"
},
"videoDimension": {
"type": "string",
"description": "The videoDimension parameter lets you restrict a search to only retrieve 2D or 3D videos.",
"enum": [
"2d",
"3d",
"any"
],
"enumDescriptions": [
"Restrict search results to exclude 3D videos.",
"Restrict search results to only include 3D videos.",
"Include both 3D and non-3D videos in returned results. This is the default value."
],
"location": "query"
},
"videoDuration": {
"type": "string",
"description": "The videoDuration parameter filters video search results based on their duration.",
"enum": [
"any",
"long",
"medium",
"short"
],
"enumDescriptions": [
"Do not filter video search results based on their duration. This is the default value.",
"Only include videos longer than 20 minutes.",
"Only include videos that are between four and 20 minutes long (inclusive).",
"Only include videos that are less than four minutes long."
],
"location": "query"
},
"videoEmbeddable": {
"type": "string",
"description": "The videoEmbeddable parameter lets you to restrict a search to only videos that can be embedded into a webpage.",
"enum": [
"any",
"true"
],
"enumDescriptions": [
"Return all videos, embeddable or not.",
"Only retrieve embeddable videos."
],
"location": "query"
},
"videoLicense": {
"type": "string",
"description": "The videoLicense parameter filters search results to only include videos with a particular license. YouTube lets video uploaders choose to attach either the Creative Commons license or the standard YouTube license to each of their videos.",
"enum": [
"any",
"creativeCommon",
"youtube"
],
"enumDescriptions": [
"Return all videos, regardless of which license they have, that match the query parameters.",
"Only return videos that have a Creative Commons license. Users can reuse videos with this license in other videos that they create. Learn more.",
"Only return videos that have the standard YouTube license."
],
"location": "query"
},
"videoSyndicated": {
"type": "string",
"description": "The videoSyndicated parameter lets you to restrict a search to only videos that can be played outside youtube.com.",
"enum": [
"any",
"true"
],
"enumDescriptions": [
"Return all videos, syndicated or not.",
"Only retrieve syndicated videos."
],
"location": "query"
},
"videoType": {
"type": "string",
"description": "The videoType parameter lets you restrict a search to a particular type of videos.",
"enum": [
"any",
"episode",
"movie"
],
"enumDescriptions": [
"Return all videos.",
"Only retrieve episodes of shows.",
"Only retrieve movies."
],
"location": "query"
}
},
"parameterOrder": [
"part"
],
"response": {
"$ref": "SearchListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner"
]
}
}
},
"subscriptions": {
"methods": {
"delete": {
"id": "youtube.subscriptions.delete",
"path": "subscriptions",
"httpMethod": "DELETE",
"description": "Deletes a subscription.",
"parameters": {
"id": {
"type": "string",
"description": "The id parameter specifies the YouTube subscription ID for the resource that is being deleted. In a subscription resource, the id property specifies the YouTube subscription ID.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"id"
],
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtubepartner"
]
},
"insert": {
"id": "youtube.subscriptions.insert",
"path": "subscriptions",
"httpMethod": "POST",
"description": "Adds a subscription for the authenticated user's channel.",
"parameters": {
"part": {
"type": "string",
"description": "The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.\n\nThe part names that you can include in the parameter value are snippet and contentDetails.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"part"
],
"request": {
"$ref": "Subscription"
},
"response": {
"$ref": "Subscription"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtubepartner"
]
},
"list": {
"id": "youtube.subscriptions.list",
"path": "subscriptions",
"httpMethod": "GET",
"description": "Returns subscription resources that match the API request criteria.",
"parameters": {
"channelId": {
"type": "string",
"description": "The channelId parameter specifies a YouTube channel ID. The API will only return that channel's subscriptions.",
"location": "query"
},
"forChannelId": {
"type": "string",
"description": "The forChannelId parameter specifies a comma-separated list of channel IDs. The API response will then only contain subscriptions matching those channels.",
"location": "query"
},
"id": {
"type": "string",
"description": "The id parameter specifies a comma-separated list of the YouTube subscription ID(s) for the resource(s) that are being retrieved. In a subscription resource, the id property specifies the YouTube subscription ID.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "USE_DESCRIPTION --- channels:list:maxResults",
"default": "5",
"format": "uint32",
"minimum": "0",
"maximum": "50",
"location": "query"
},
"mine": {
"type": "boolean",
"description": "Set this parameter's value to true to retrieve a feed of the authenticated user's subscriptions.",
"location": "query"
},
"mySubscribers": {
"type": "boolean",
"description": "Set this parameter's value to true to retrieve a feed of the subscribers of the authenticated user.",
"location": "query"
},
"order": {
"type": "string",
"description": "The order parameter specifies the method that will be used to sort resources in the API response.",
"default": "SUBSCRIPTION_ORDER_RELEVANCE",
"enum": [
"alphabetical",
"relevance",
"unread"
],
"enumDescriptions": [
"Sort alphabetically.",
"Sort by relevance.",
"Sort by order of activity."
],
"location": "query"
},
"pageToken": {
"type": "string",
"description": "USE_DESCRIPTION --- channels:list:pageToken",
"location": "query"
},
"part": {
"type": "string",
"description": "The part parameter specifies a comma-separated list of one or more subscription resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails.\n\nIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a subscription resource, the snippet property contains other properties, such as a display title for the subscription. If you set part=snippet, the API response will also contain all of those nested properties.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"part"
],
"response": {
"$ref": "SubscriptionListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner"
]
}
}
},
"thumbnails": {
"methods": {
"set": {
"id": "youtube.thumbnails.set",
"path": "thumbnails/set",
"httpMethod": "POST",
"description": "Uploads a custom video thumbnail to YouTube and sets it for a video.",
"parameters": {
"videoId": {
"type": "string",
"description": "The videoId parameter specifies a YouTube video ID for which the custom video thumbnail is being provided.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"videoId"
],
"response": {
"$ref": "ThumbnailListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.upload",
"https://www.googleapis.com/auth/youtubepartner"
],
"supportsMediaUpload": true,
"mediaUpload": {
"accept": [
"application/octet-stream",
"image/jpeg",
"image/png"
],
"maxSize": "2MB",
"protocols": {
"simple": {
"multipart": true,
"path": "/upload/youtube/v3/thumbnails/set"
},
"resumable": {
"multipart": true,
"path": "/resumable/upload/youtube/v3/thumbnails/set"
}
}
}
}
}
},
"videoCategories": {
"methods": {
"list": {
"id": "youtube.videoCategories.list",
"path": "videoCategories",
"httpMethod": "GET",
"description": "Returns a list of categories that can be associated with YouTube videos.",
"parameters": {
"hl": {
"type": "string",
"description": "The hl parameter specifies the language that should be used for text values in the API response.",
"default": "en_US",
"location": "query"
},
"id": {
"type": "string",
"description": "The id parameter specifies a comma-separated list of video category IDs for the resources that you are retrieving.",
"location": "query"
},
"part": {
"type": "string",
"description": "The part parameter specifies the videoCategory resource parts that the API response will include. Supported values are id and snippet.",
"required": true,
"location": "query"
},
"regionCode": {
"type": "string",
"description": "The regionCode parameter instructs the API to return the list of video categories available in the specified country. The parameter value is an ISO 3166-1 alpha-2 country code.",
"location": "query"
}
},
"parameterOrder": [
"part"
],
"response": {
"$ref": "VideoCategoryListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner"
]
}
}
},
"videos": {
"methods": {
"delete": {
"id": "youtube.videos.delete",
"path": "videos",
"httpMethod": "DELETE",
"description": "Deletes a YouTube video.",
"parameters": {
"id": {
"type": "string",
"description": "The id parameter specifies the YouTube video ID for the resource that is being deleted. In a video resource, the id property specifies the video's ID.",
"required": true,
"location": "query"
},
"onBehalfOfContentOwner": {
"type": "string",
"description": "USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner",
"location": "query"
}
},
"parameterOrder": [
"id"
],
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtubepartner"
]
},
"getRating": {
"id": "youtube.videos.getRating",
"path": "videos/getRating",
"httpMethod": "GET",
"description": "Get user ratings for videos.",
"parameters": {
"id": {
"type": "string",
"description": "The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved. In a video resource, the id property specifies the video's ID.",
"required": true,
"location": "query"
},
"onBehalfOfContentOwner": {
"type": "string",
"description": "USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner",
"location": "query"
}
},
"parameterOrder": [
"id"
],
"response": {
"$ref": "VideoGetRatingResponse"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtubepartner"
]
},
"insert": {
"id": "youtube.videos.insert",
"path": "videos",
"httpMethod": "POST",
"description": "Uploads a video to YouTube and optionally sets the video's metadata.",
"parameters": {
"autoLevels": {
"type": "boolean",
"description": "The autoLevels parameter specifies whether the video should be auto-leveled by YouTube.",
"location": "query"
},
"onBehalfOfContentOwner": {
"type": "string",
"description": "USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner",
"location": "query"
},
"onBehalfOfContentOwnerChannel": {
"type": "string",
"description": "This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.\n\nThe onBehalfOfContentOwnerChannel parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the channel specified in the parameter value. This parameter must be used in conjunction with the onBehalfOfContentOwner parameter, and the user must be authenticated using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. In addition, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.\n\nThis parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.",
"location": "query"
},
"part": {
"type": "string",
"description": "The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.\n\nThe part names that you can include in the parameter value are snippet, contentDetails, player, statistics, status, and topicDetails. However, not all of those parts contain properties that can be set when setting or updating a video's metadata. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.",
"required": true,
"location": "query"
},
"stabilize": {
"type": "boolean",
"description": "The stabilize parameter specifies whether the video should be stabilized by YouTube.",
"location": "query"
}
},
"parameterOrder": [
"part"
],
"request": {
"$ref": "Video"
},
"response": {
"$ref": "Video"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.upload",
"https://www.googleapis.com/auth/youtubepartner"
],
"supportsMediaUpload": true,
"mediaUpload": {
"accept": [
"application/octet-stream",
"video/*"
],
"maxSize": "64GB",
"protocols": {
"simple": {
"multipart": true,
"path": "/upload/youtube/v3/videos"
},
"resumable": {
"multipart": true,
"path": "/resumable/upload/youtube/v3/videos"
}
}
}
},
"list": {
"id": "youtube.videos.list",
"path": "videos",
"httpMethod": "GET",
"description": "Returns a list of videos that match the API request parameters.",
"parameters": {
"id": {
"type": "string",
"description": "The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved. In a video resource, the id property specifies the video's ID.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "USE_DESCRIPTION --- channels:list:maxResults",
"default": "5",
"format": "uint32",
"minimum": "1",
"maximum": "50",
"location": "query"
},
"myRating": {
"type": "string",
"description": "Set this parameter's value to like or dislike to instruct the API to only return videos liked or disliked by the authenticated user.",
"enum": [
"dislike",
"like"
],
"enumDescriptions": [
"Returns only videos disliked by the authenticated user.",
"Returns only video liked by the authenticated user."
],
"location": "query"
},
"onBehalfOfContentOwner": {
"type": "string",
"description": "USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "USE_DESCRIPTION --- channels:list:pageToken",
"location": "query"
},
"part": {
"type": "string",
"description": "The part parameter specifies a comma-separated list of one or more video resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, player, statistics, status, and topicDetails.\n\nIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a video resource, the snippet property contains the channelId, title, description, tags, and categoryId properties. As such, if you set part=snippet, the API response will contain all of those properties.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"part"
],
"response": {
"$ref": "VideoListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner"
]
},
"rate": {
"id": "youtube.videos.rate",
"path": "videos/rate",
"httpMethod": "POST",
"description": "Like, dislike, or remove rating from a video.",
"parameters": {
"id": {
"type": "string",
"description": "The id parameter specifies the YouTube video ID.",
"required": true,
"location": "query"
},
"onBehalfOfContentOwner": {
"type": "string",
"description": "USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner",
"location": "query"
},
"rating": {
"type": "string",
"description": "Specifies the rating to record.",
"required": true,
"enum": [
"dislike",
"like",
"none"
],
"enumDescriptions": [
"Records that the authenticated user disliked the video.",
"Records that the authenticated user liked the video.",
"Removes any vote (like or dislike) the authenticated user had for the video."
],
"location": "query"
}
},
"parameterOrder": [
"id",
"rating"
],
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtubepartner"
]
},
"update": {
"id": "youtube.videos.update",
"path": "videos",
"httpMethod": "PUT",
"description": "Updates a video's metadata.",
"parameters": {
"onBehalfOfContentOwner": {
"type": "string",
"description": "USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner",
"location": "query"
},
"part": {
"type": "string",
"description": "The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.\n\nThe part names that you can include in the parameter value are snippet, contentDetails, player, statistics, status, and topicDetails.\n\nNote that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a video's privacy setting is contained in the status part. As such, if your request is updating a private video, and the request's part parameter value includes the status part, the video's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the video will revert to the default privacy setting.\n\nIn addition, not all of those parts contain properties that can be set when setting or updating a video's metadata. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.",
"required": true,
"location": "query"
}
},
"parameterOrder": [
"part"
],
"request": {
"$ref": "Video"
},
"response": {
"$ref": "Video"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtubepartner"
]
}
}
}
}
}