1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.playlists.html">playlists</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(id, onBehalfOfContentOwner=None)</a></code></p>
<p class="firstline">Deletes a playlist.</p>
<p class="toc_element">
<code><a href="#insert">insert(part, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</a></code></p>
<p class="firstline">Creates a playlist.</p>
<p class="toc_element">
<code><a href="#list">list(part=None, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, hl=None, channelId=None, mine=None, maxResults=None, id=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(part=None, body, onBehalfOfContentOwner=None)</a></code></p>
<p class="firstline">Modifies a playlist. For example, you could change a playlist's title, description, or privacy status.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(id, onBehalfOfContentOwner=None)</code>
<pre>Deletes a playlist.
Args:
id: string, 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)
onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(part, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</code>
<pre>Creates a playlist.
Args:
part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. (required)
body: object, The request body. (required)
The object takes the form of:
{ # 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.
#
# YouTube also uses playlists to identify special collections of videos for a channel, such as:
# - uploaded videos
# - favorite videos
# - positively rated (liked) videos
# - watch history
# - 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.
#
# 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.
"status": { # The status object contains status information for the playlist.
"privacyStatus": "A String", # The playlist's privacy status.
},
"kind": "youtube#playlist", # Identifies what kind of resource this is. Value: the fixed string "youtube#playlist".
"contentDetails": { # The contentDetails object contains information like video count.
"itemCount": 42, # The number of videos in the playlist.
},
"snippet": { # Basic details about a playlist, including title, description and thumbnails. # The snippet object contains basic details about the playlist, such as its title and description.
"description": "A String", # The playlist's description.
"tags": [ # Keyword tags associated with the playlist.
"A String",
],
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the playlist.
"publishedAt": "A String", # The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"channelTitle": "A String", # The channel title of the channel that the video belongs to.
"title": "A String", # The playlist's title.
"defaultLanguage": "A String", # The language of the playlist's default title and description.
"localized": { # Playlist localization setting # Localized title and description, read-only.
"description": "A String", # The localized strings for playlist's description.
"title": "A String", # The localized strings for playlist's title.
},
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # 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.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
},
},
"player": { # The player object contains information that you would use to play the playlist in an embedded player.
"embedHtml": "A String", # An <iframe> tag that embeds a player that will play the playlist.
},
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the playlist.
"localizations": { # Localizations for different languages
"a_key": { # Playlist localization setting # The language tag, using string since map_key require simple types.
"description": "A String", # The localized strings for playlist's description.
"title": "A String", # The localized strings for playlist's title.
},
},
}
onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.
This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
Returns:
An object of the form:
{ # 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.
#
# YouTube also uses playlists to identify special collections of videos for a channel, such as:
# - uploaded videos
# - favorite videos
# - positively rated (liked) videos
# - watch history
# - 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.
#
# 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.
"status": { # The status object contains status information for the playlist.
"privacyStatus": "A String", # The playlist's privacy status.
},
"kind": "youtube#playlist", # Identifies what kind of resource this is. Value: the fixed string "youtube#playlist".
"contentDetails": { # The contentDetails object contains information like video count.
"itemCount": 42, # The number of videos in the playlist.
},
"snippet": { # Basic details about a playlist, including title, description and thumbnails. # The snippet object contains basic details about the playlist, such as its title and description.
"description": "A String", # The playlist's description.
"tags": [ # Keyword tags associated with the playlist.
"A String",
],
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the playlist.
"publishedAt": "A String", # The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"channelTitle": "A String", # The channel title of the channel that the video belongs to.
"title": "A String", # The playlist's title.
"defaultLanguage": "A String", # The language of the playlist's default title and description.
"localized": { # Playlist localization setting # Localized title and description, read-only.
"description": "A String", # The localized strings for playlist's description.
"title": "A String", # The localized strings for playlist's title.
},
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # 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.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
},
},
"player": { # The player object contains information that you would use to play the playlist in an embedded player.
"embedHtml": "A String", # An <iframe> tag that embeds a player that will play the playlist.
},
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the playlist.
"localizations": { # Localizations for different languages
"a_key": { # Playlist localization setting # The language tag, using string since map_key require simple types.
"description": "A String", # The localized strings for playlist's description.
"title": "A String", # The localized strings for playlist's title.
},
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(part=None, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, hl=None, channelId=None, mine=None, maxResults=None, id=None)</code>
<pre>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.
Args:
part: string, The part parameter specifies a comma-separated list of one or more playlist resource properties that the API response will include.
If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlist resource, the snippet property contains properties like author, title, description, tags, and timeCreated. As such, if you set part=snippet, the API response will contain all of those properties. (required)
onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
pageToken: string, 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.
onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.
This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
hl: string, The hl parameter should be used for filter out the properties that are not in the given language. Used for the snippet part.
channelId: string, This value indicates that the API should only return the specified channel's playlists.
mine: boolean, Set this parameter's value to true to instruct the API to only return playlists owned by the authenticated user.
maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
id: string, 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.
Returns:
An object of the form:
{
"eventId": "A String", # Serialized EventId of the request which produced this response.
"nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
"kind": "youtube#playlistListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#playlistListResponse".
"visitorId": "A String", # The visitorId identifies the visitor.
"items": [ # A list of playlists that match the request criteria.
{ # 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.
#
# YouTube also uses playlists to identify special collections of videos for a channel, such as:
# - uploaded videos
# - favorite videos
# - positively rated (liked) videos
# - watch history
# - 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.
#
# 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.
"status": { # The status object contains status information for the playlist.
"privacyStatus": "A String", # The playlist's privacy status.
},
"kind": "youtube#playlist", # Identifies what kind of resource this is. Value: the fixed string "youtube#playlist".
"contentDetails": { # The contentDetails object contains information like video count.
"itemCount": 42, # The number of videos in the playlist.
},
"snippet": { # Basic details about a playlist, including title, description and thumbnails. # The snippet object contains basic details about the playlist, such as its title and description.
"description": "A String", # The playlist's description.
"tags": [ # Keyword tags associated with the playlist.
"A String",
],
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the playlist.
"publishedAt": "A String", # The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"channelTitle": "A String", # The channel title of the channel that the video belongs to.
"title": "A String", # The playlist's title.
"defaultLanguage": "A String", # The language of the playlist's default title and description.
"localized": { # Playlist localization setting # Localized title and description, read-only.
"description": "A String", # The localized strings for playlist's description.
"title": "A String", # The localized strings for playlist's title.
},
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # 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.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
},
},
"player": { # The player object contains information that you would use to play the playlist in an embedded player.
"embedHtml": "A String", # An <iframe> tag that embeds a player that will play the playlist.
},
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the playlist.
"localizations": { # Localizations for different languages
"a_key": { # Playlist localization setting # The language tag, using string since map_key require simple types.
"description": "A String", # The localized strings for playlist's description.
"title": "A String", # The localized strings for playlist's title.
},
},
},
],
"tokenPagination": { # Stub token pagination template to suppress results.
},
"etag": "A String", # Etag of this resource.
"prevPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
"pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
"totalResults": 42, # The total number of results in the result set.
"resultsPerPage": 42, # The number of results included in the API response.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="update">update(part=None, body, onBehalfOfContentOwner=None)</code>
<pre>Modifies a playlist. For example, you could change a playlist's title, description, or privacy status.
Args:
part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.
Note that this method will override the existing values for mutable properties that are contained in any parts that the request body specifies. For example, a playlist's description is contained in the snippet part, which must be included in the request body. If the request does not specify a value for the snippet.description property, the playlist's existing description will be deleted. (required)
body: object, The request body. (required)
The object takes the form of:
{ # 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.
#
# YouTube also uses playlists to identify special collections of videos for a channel, such as:
# - uploaded videos
# - favorite videos
# - positively rated (liked) videos
# - watch history
# - 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.
#
# 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.
"status": { # The status object contains status information for the playlist.
"privacyStatus": "A String", # The playlist's privacy status.
},
"kind": "youtube#playlist", # Identifies what kind of resource this is. Value: the fixed string "youtube#playlist".
"contentDetails": { # The contentDetails object contains information like video count.
"itemCount": 42, # The number of videos in the playlist.
},
"snippet": { # Basic details about a playlist, including title, description and thumbnails. # The snippet object contains basic details about the playlist, such as its title and description.
"description": "A String", # The playlist's description.
"tags": [ # Keyword tags associated with the playlist.
"A String",
],
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the playlist.
"publishedAt": "A String", # The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"channelTitle": "A String", # The channel title of the channel that the video belongs to.
"title": "A String", # The playlist's title.
"defaultLanguage": "A String", # The language of the playlist's default title and description.
"localized": { # Playlist localization setting # Localized title and description, read-only.
"description": "A String", # The localized strings for playlist's description.
"title": "A String", # The localized strings for playlist's title.
},
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # 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.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
},
},
"player": { # The player object contains information that you would use to play the playlist in an embedded player.
"embedHtml": "A String", # An <iframe> tag that embeds a player that will play the playlist.
},
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the playlist.
"localizations": { # Localizations for different languages
"a_key": { # Playlist localization setting # The language tag, using string since map_key require simple types.
"description": "A String", # The localized strings for playlist's description.
"title": "A String", # The localized strings for playlist's title.
},
},
}
onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
Returns:
An object of the form:
{ # 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.
#
# YouTube also uses playlists to identify special collections of videos for a channel, such as:
# - uploaded videos
# - favorite videos
# - positively rated (liked) videos
# - watch history
# - 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.
#
# 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.
"status": { # The status object contains status information for the playlist.
"privacyStatus": "A String", # The playlist's privacy status.
},
"kind": "youtube#playlist", # Identifies what kind of resource this is. Value: the fixed string "youtube#playlist".
"contentDetails": { # The contentDetails object contains information like video count.
"itemCount": 42, # The number of videos in the playlist.
},
"snippet": { # Basic details about a playlist, including title, description and thumbnails. # The snippet object contains basic details about the playlist, such as its title and description.
"description": "A String", # The playlist's description.
"tags": [ # Keyword tags associated with the playlist.
"A String",
],
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the playlist.
"publishedAt": "A String", # The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"channelTitle": "A String", # The channel title of the channel that the video belongs to.
"title": "A String", # The playlist's title.
"defaultLanguage": "A String", # The language of the playlist's default title and description.
"localized": { # Playlist localization setting # Localized title and description, read-only.
"description": "A String", # The localized strings for playlist's description.
"title": "A String", # The localized strings for playlist's title.
},
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # 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.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
},
},
"player": { # The player object contains information that you would use to play the playlist in an embedded player.
"embedHtml": "A String", # An <iframe> tag that embeds a player that will play the playlist.
},
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the playlist.
"localizations": { # Localizations for different languages
"a_key": { # Playlist localization setting # The language tag, using string since map_key require simple types.
"description": "A String", # The localized strings for playlist's description.
"title": "A String", # The localized strings for playlist's title.
},
},
}</pre>
</div>
</body></html>
|