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