| <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 v3</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, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a resource.</p> |
| <p class="toc_element"> |
| <code><a href="#insert">insert(part, body=None, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Inserts a new resource into this collection.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(part, maxResults=None, id=None, hl=None, channelId=None, mine=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves a list of resources, possibly filtered.</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, body=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates an existing resource.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
| <pre>Deletes a resource. |
| |
| Args: |
| id: string, A parameter (required) |
| onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwner</strong></code> 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. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="insert">insert(part, body=None, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
| <pre>Inserts a new resource into this collection. |
| |
| Args: |
| part: string, The <code><strong>part</strong></code> 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) (repeated) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A <code><strong>playlist</strong></code> 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. <br/><br/> YouTube |
| # also uses playlists to identify special collections of videos for a |
| # channel, such as: |
| # <ul> |
| # <li>uploaded videos</li> |
| # <li>favorite videos</li> |
| # <li>positively rated (liked) videos</li> |
| # <li>watch history</li> |
| # <li>watch later</li> |
| # </ul> |
| # 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 <code><a |
| # href=\"/youtube/v3/docs/channels\"> channel resource</a></code> for a |
| # given channel.<br/><br/> You can then use the <code> <a |
| # href=\"/youtube/v3/docs/playlistItems/list\"> |
| # playlistItems.list</a></code> method to retrieve any of those |
| # lists. You can also add or remove items from those lists by calling |
| # the <code> <a href=\"/youtube/v3/docs/playlistItems/insert\"> |
| # playlistItems.insert</a></code> and <code> <a |
| # href=\"/youtube/v3/docs/playlistItems/delete\"> |
| # playlistItems.delete</a></code> methods. |
| "id": "A String", # The ID that YouTube uses to uniquely identify the playlist. |
| "etag": "A String", # Etag of this resource. |
| "snippet": { # Basic details about a playlist, including title, description and thumbnails. # The <code>snippet</code> object contains basic details about the |
| # playlist, such as its title and description. |
| "publishedAt": "A String", # The date and time that the playlist was created. The value is specified |
| # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| # published the playlist. |
| "defaultLanguage": "A String", # The language of the playlist's default title and description. |
| "localized": { # Playlist localization setting # Localized title and description, read-only. |
| "title": "A String", # The localized strings for playlist's title. |
| "description": "A String", # The localized strings for playlist's description. |
| }, |
| "title": "A String", # The 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. |
| "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "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. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "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. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "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. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| }, |
| "description": "A String", # The playlist's description. |
| "channelTitle": "A String", # The channel title of the channel that the video belongs to. |
| "tags": [ # Keyword tags associated with the playlist. |
| "A String", |
| ], |
| }, |
| "kind": "youtube#playlist", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#playlist"</code>. |
| "localizations": { # Localizations for different languages |
| "a_key": { # Playlist localization setting |
| "title": "A String", # The localized strings for playlist's title. |
| "description": "A String", # The localized strings for playlist's description. |
| }, |
| }, |
| "contentDetails": { # The <code>contentDetails</code> object contains information like |
| # video count. |
| "itemCount": 42, # The number of videos in the playlist. |
| }, |
| "player": { # The <code>player</code> object contains information that you would use |
| # to play the playlist in an embedded player. |
| "embedHtml": "A String", # An <code>&lt;iframe&gt;</code> tag that embeds a player that will |
| # play the playlist. |
| }, |
| "status": { # The <code>status</code> object contains status information for the |
| # playlist. |
| "privacyStatus": "A String", # The playlist's privacy status. |
| }, |
| } |
| |
| onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a |
| href="/youtube/v3/guides/authentication">authorized request</a>. |
| <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwnerChannel</strong></code> 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 |
| <code>onBehalfOfContentOwner</code> 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 |
| <code>onBehalfOfContentOwner</code> parameter specifies. Finally, the |
| channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value |
| specifies must be linked to the content owner that the |
| <code>onBehalfOfContentOwner</code> parameter specifies.<br><br>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. |
| onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwner</strong></code> 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. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A <code><strong>playlist</strong></code> 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. <br/><br/> YouTube |
| # also uses playlists to identify special collections of videos for a |
| # channel, such as: |
| # <ul> |
| # <li>uploaded videos</li> |
| # <li>favorite videos</li> |
| # <li>positively rated (liked) videos</li> |
| # <li>watch history</li> |
| # <li>watch later</li> |
| # </ul> |
| # 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 <code><a |
| # href=\"/youtube/v3/docs/channels\"> channel resource</a></code> for a |
| # given channel.<br/><br/> You can then use the <code> <a |
| # href=\"/youtube/v3/docs/playlistItems/list\"> |
| # playlistItems.list</a></code> method to retrieve any of those |
| # lists. You can also add or remove items from those lists by calling |
| # the <code> <a href=\"/youtube/v3/docs/playlistItems/insert\"> |
| # playlistItems.insert</a></code> and <code> <a |
| # href=\"/youtube/v3/docs/playlistItems/delete\"> |
| # playlistItems.delete</a></code> methods. |
| "id": "A String", # The ID that YouTube uses to uniquely identify the playlist. |
| "etag": "A String", # Etag of this resource. |
| "snippet": { # Basic details about a playlist, including title, description and thumbnails. # The <code>snippet</code> object contains basic details about the |
| # playlist, such as its title and description. |
| "publishedAt": "A String", # The date and time that the playlist was created. The value is specified |
| # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| # published the playlist. |
| "defaultLanguage": "A String", # The language of the playlist's default title and description. |
| "localized": { # Playlist localization setting # Localized title and description, read-only. |
| "title": "A String", # The localized strings for playlist's title. |
| "description": "A String", # The localized strings for playlist's description. |
| }, |
| "title": "A String", # The 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. |
| "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "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. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "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. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "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. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| }, |
| "description": "A String", # The playlist's description. |
| "channelTitle": "A String", # The channel title of the channel that the video belongs to. |
| "tags": [ # Keyword tags associated with the playlist. |
| "A String", |
| ], |
| }, |
| "kind": "youtube#playlist", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#playlist"</code>. |
| "localizations": { # Localizations for different languages |
| "a_key": { # Playlist localization setting |
| "title": "A String", # The localized strings for playlist's title. |
| "description": "A String", # The localized strings for playlist's description. |
| }, |
| }, |
| "contentDetails": { # The <code>contentDetails</code> object contains information like |
| # video count. |
| "itemCount": 42, # The number of videos in the playlist. |
| }, |
| "player": { # The <code>player</code> object contains information that you would use |
| # to play the playlist in an embedded player. |
| "embedHtml": "A String", # An <code>&lt;iframe&gt;</code> tag that embeds a player that will |
| # play the playlist. |
| }, |
| "status": { # The <code>status</code> object contains status information for the |
| # playlist. |
| "privacyStatus": "A String", # The playlist's privacy status. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(part, maxResults=None, id=None, hl=None, channelId=None, mine=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Retrieves a list of resources, possibly filtered. |
| |
| Args: |
| part: string, The <code><strong>part</strong></code> parameter specifies a |
| comma-separated list of one or more <code>playlist</code> resource |
| properties that the API response will include.<br><br>If the parameter |
| identifies a property that contains child properties, the child properties |
| will be included in the response. For example, in a <code>playlist</code> |
| resource, the <code>snippet</code> property contains properties like |
| <code>author</code>, <code>title</code>, <code>description</code>, |
| <code>tags</code>, and <code>timeCreated</code>. As such, if you set |
| <code><strong>part=snippet</strong></code>, the API response will contain |
| all of those properties. (required) (repeated) |
| maxResults: integer, The <code><strong>maxResults</strong></code> parameter specifies the |
| maximum number of items that should be returned in the result set. |
| id: string, Return the playlists with the given IDs for Stubby or Apiary. (repeated) |
| hl: string, Returen content in specified language |
| channelId: string, Return the playlists owned by the specified channel ID. |
| mine: boolean, Return the playlists owned by the authenticated user. |
| onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwner</strong></code> 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 <a |
| href="/youtube/v3/guides/authentication">authorized request</a>. |
| <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwnerChannel</strong></code> 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 |
| <code>onBehalfOfContentOwner</code> 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 |
| <code>onBehalfOfContentOwner</code> parameter specifies. Finally, the |
| channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value |
| specifies must be linked to the content owner that the |
| <code>onBehalfOfContentOwner</code> parameter specifies.<br><br>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. |
| pageToken: string, The <code><strong>pageToken</strong></code> parameter identifies a specific |
| page in the result set that should be returned. In an API response, the |
| <code>nextPageToken</code> and <code>prevPageToken</code> properties |
| identify other pages that could be retrieved. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "items": [ # A list of playlists that match the request criteria |
| { # A <code><strong>playlist</strong></code> 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. <br/><br/> YouTube |
| # also uses playlists to identify special collections of videos for a |
| # channel, such as: |
| # <ul> |
| # <li>uploaded videos</li> |
| # <li>favorite videos</li> |
| # <li>positively rated (liked) videos</li> |
| # <li>watch history</li> |
| # <li>watch later</li> |
| # </ul> |
| # 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 <code><a |
| # href=\"/youtube/v3/docs/channels\"> channel resource</a></code> for a |
| # given channel.<br/><br/> You can then use the <code> <a |
| # href=\"/youtube/v3/docs/playlistItems/list\"> |
| # playlistItems.list</a></code> method to retrieve any of those |
| # lists. You can also add or remove items from those lists by calling |
| # the <code> <a href=\"/youtube/v3/docs/playlistItems/insert\"> |
| # playlistItems.insert</a></code> and <code> <a |
| # href=\"/youtube/v3/docs/playlistItems/delete\"> |
| # playlistItems.delete</a></code> methods. |
| "id": "A String", # The ID that YouTube uses to uniquely identify the playlist. |
| "etag": "A String", # Etag of this resource. |
| "snippet": { # Basic details about a playlist, including title, description and thumbnails. # The <code>snippet</code> object contains basic details about the |
| # playlist, such as its title and description. |
| "publishedAt": "A String", # The date and time that the playlist was created. The value is specified |
| # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| # published the playlist. |
| "defaultLanguage": "A String", # The language of the playlist's default title and description. |
| "localized": { # Playlist localization setting # Localized title and description, read-only. |
| "title": "A String", # The localized strings for playlist's title. |
| "description": "A String", # The localized strings for playlist's description. |
| }, |
| "title": "A String", # The 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. |
| "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "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. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "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. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "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. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| }, |
| "description": "A String", # The playlist's description. |
| "channelTitle": "A String", # The channel title of the channel that the video belongs to. |
| "tags": [ # Keyword tags associated with the playlist. |
| "A String", |
| ], |
| }, |
| "kind": "youtube#playlist", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#playlist"</code>. |
| "localizations": { # Localizations for different languages |
| "a_key": { # Playlist localization setting |
| "title": "A String", # The localized strings for playlist's title. |
| "description": "A String", # The localized strings for playlist's description. |
| }, |
| }, |
| "contentDetails": { # The <code>contentDetails</code> object contains information like |
| # video count. |
| "itemCount": 42, # The number of videos in the playlist. |
| }, |
| "player": { # The <code>player</code> object contains information that you would use |
| # to play the playlist in an embedded player. |
| "embedHtml": "A String", # An <code>&lt;iframe&gt;</code> tag that embeds a player that will |
| # play the playlist. |
| }, |
| "status": { # The <code>status</code> object contains status information for the |
| # playlist. |
| "privacyStatus": "A String", # The playlist's privacy status. |
| }, |
| }, |
| ], |
| "tokenPagination": { # Stub token pagination template to suppress results. |
| }, |
| "nextPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code> |
| # parameter to retrieve the next page in the result set. |
| "eventId": "A String", # Serialized EventId of the request which produced this response. |
| "etag": "A String", # Etag of this resource. |
| "kind": "youtube#playlistListResponse", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#playlistListResponse"</code>. |
| "pageInfo": { # Paging details for lists of resources, including total number of items # General pagination information. |
| # available and number of resources returned in a single page. |
| "resultsPerPage": 42, # The number of results included in the API response. |
| "totalResults": 42, # The total number of results in the result set. |
| }, |
| "visitorId": "A String", # The <code>visitorId</code> identifies the visitor. |
| "prevPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code> |
| # parameter to retrieve the previous page in the result set. |
| }</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, body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
| <pre>Updates an existing resource. |
| |
| Args: |
| part: string, The <code><strong>part</strong></code> 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.<br/><br/>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 <code>snippet</code> part, which |
| must be included in the request body. If the request does not specify a |
| value for the <code>snippet.description</code> property, the playlist's |
| existing description will be deleted. (required) (repeated) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A <code><strong>playlist</strong></code> 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. <br/><br/> YouTube |
| # also uses playlists to identify special collections of videos for a |
| # channel, such as: |
| # <ul> |
| # <li>uploaded videos</li> |
| # <li>favorite videos</li> |
| # <li>positively rated (liked) videos</li> |
| # <li>watch history</li> |
| # <li>watch later</li> |
| # </ul> |
| # 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 <code><a |
| # href=\"/youtube/v3/docs/channels\"> channel resource</a></code> for a |
| # given channel.<br/><br/> You can then use the <code> <a |
| # href=\"/youtube/v3/docs/playlistItems/list\"> |
| # playlistItems.list</a></code> method to retrieve any of those |
| # lists. You can also add or remove items from those lists by calling |
| # the <code> <a href=\"/youtube/v3/docs/playlistItems/insert\"> |
| # playlistItems.insert</a></code> and <code> <a |
| # href=\"/youtube/v3/docs/playlistItems/delete\"> |
| # playlistItems.delete</a></code> methods. |
| "id": "A String", # The ID that YouTube uses to uniquely identify the playlist. |
| "etag": "A String", # Etag of this resource. |
| "snippet": { # Basic details about a playlist, including title, description and thumbnails. # The <code>snippet</code> object contains basic details about the |
| # playlist, such as its title and description. |
| "publishedAt": "A String", # The date and time that the playlist was created. The value is specified |
| # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| # published the playlist. |
| "defaultLanguage": "A String", # The language of the playlist's default title and description. |
| "localized": { # Playlist localization setting # Localized title and description, read-only. |
| "title": "A String", # The localized strings for playlist's title. |
| "description": "A String", # The localized strings for playlist's description. |
| }, |
| "title": "A String", # The 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. |
| "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "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. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "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. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "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. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| }, |
| "description": "A String", # The playlist's description. |
| "channelTitle": "A String", # The channel title of the channel that the video belongs to. |
| "tags": [ # Keyword tags associated with the playlist. |
| "A String", |
| ], |
| }, |
| "kind": "youtube#playlist", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#playlist"</code>. |
| "localizations": { # Localizations for different languages |
| "a_key": { # Playlist localization setting |
| "title": "A String", # The localized strings for playlist's title. |
| "description": "A String", # The localized strings for playlist's description. |
| }, |
| }, |
| "contentDetails": { # The <code>contentDetails</code> object contains information like |
| # video count. |
| "itemCount": 42, # The number of videos in the playlist. |
| }, |
| "player": { # The <code>player</code> object contains information that you would use |
| # to play the playlist in an embedded player. |
| "embedHtml": "A String", # An <code>&lt;iframe&gt;</code> tag that embeds a player that will |
| # play the playlist. |
| }, |
| "status": { # The <code>status</code> object contains status information for the |
| # playlist. |
| "privacyStatus": "A String", # The playlist's privacy status. |
| }, |
| } |
| |
| onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwner</strong></code> 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. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A <code><strong>playlist</strong></code> 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. <br/><br/> YouTube |
| # also uses playlists to identify special collections of videos for a |
| # channel, such as: |
| # <ul> |
| # <li>uploaded videos</li> |
| # <li>favorite videos</li> |
| # <li>positively rated (liked) videos</li> |
| # <li>watch history</li> |
| # <li>watch later</li> |
| # </ul> |
| # 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 <code><a |
| # href=\"/youtube/v3/docs/channels\"> channel resource</a></code> for a |
| # given channel.<br/><br/> You can then use the <code> <a |
| # href=\"/youtube/v3/docs/playlistItems/list\"> |
| # playlistItems.list</a></code> method to retrieve any of those |
| # lists. You can also add or remove items from those lists by calling |
| # the <code> <a href=\"/youtube/v3/docs/playlistItems/insert\"> |
| # playlistItems.insert</a></code> and <code> <a |
| # href=\"/youtube/v3/docs/playlistItems/delete\"> |
| # playlistItems.delete</a></code> methods. |
| "id": "A String", # The ID that YouTube uses to uniquely identify the playlist. |
| "etag": "A String", # Etag of this resource. |
| "snippet": { # Basic details about a playlist, including title, description and thumbnails. # The <code>snippet</code> object contains basic details about the |
| # playlist, such as its title and description. |
| "publishedAt": "A String", # The date and time that the playlist was created. The value is specified |
| # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| # published the playlist. |
| "defaultLanguage": "A String", # The language of the playlist's default title and description. |
| "localized": { # Playlist localization setting # Localized title and description, read-only. |
| "title": "A String", # The localized strings for playlist's title. |
| "description": "A String", # The localized strings for playlist's description. |
| }, |
| "title": "A String", # The 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. |
| "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "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. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "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. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "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. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| }, |
| "description": "A String", # The playlist's description. |
| "channelTitle": "A String", # The channel title of the channel that the video belongs to. |
| "tags": [ # Keyword tags associated with the playlist. |
| "A String", |
| ], |
| }, |
| "kind": "youtube#playlist", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#playlist"</code>. |
| "localizations": { # Localizations for different languages |
| "a_key": { # Playlist localization setting |
| "title": "A String", # The localized strings for playlist's title. |
| "description": "A String", # The localized strings for playlist's description. |
| }, |
| }, |
| "contentDetails": { # The <code>contentDetails</code> object contains information like |
| # video count. |
| "itemCount": 42, # The number of videos in the playlist. |
| }, |
| "player": { # The <code>player</code> object contains information that you would use |
| # to play the playlist in an embedded player. |
| "embedHtml": "A String", # An <code>&lt;iframe&gt;</code> tag that embeds a player that will |
| # play the playlist. |
| }, |
| "status": { # The <code>status</code> object contains status information for the |
| # playlist. |
| "privacyStatus": "A String", # The playlist's privacy status. |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
