| <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.playlistItems.html">playlistItems</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, 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, videoId=None, onBehalfOfContentOwner=None, maxResults=None, id=None, pageToken=None, playlistId=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, 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>playlistItem</strong></code> resource identifies |
| # another resource, such as a video, that is included in a playlist. In |
| # addition, the <code>playlistItem </code> resource contains details |
| # about the included resource that pertain specifically to how that |
| # resource is used in that playlist.<br/><br/> YouTube 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. |
| # <br/><br/> |
| # 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. 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. 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. |
| "etag": "A String", # Etag of this resource. |
| "status": { # Information about the playlist item's privacy status. # The <code>status</code> object contains information about the playlist |
| # item's privacy status. |
| "privacyStatus": "A String", # This resource's privacy status. |
| }, |
| "contentDetails": { # The <code>contentDetails</code> object is included in the resource if |
| # the included item is a YouTube video. The object contains additional |
| # information about the video. |
| "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 <code>0</code>. |
| "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 <code>video.endTime</code> is |
| # the end of the video. |
| "videoId": "A String", # The ID that YouTube uses to uniquely identify a video. To <a |
| # href="/youtube/v3/docs/video/list.html">retrieve the <code>video</code> |
| # resource</a>, set the <code>id</code> query parameter to this value in your |
| # API request. |
| "note": "A String", # A user-generated note for this item. |
| "videoPublishedAt": "A String", # The date and time that the video was published to YouTube. The value is |
| # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| }, |
| "id": "A String", # The ID that YouTube uses to uniquely identify the playlist item. |
| "snippet": { # Basic details about a playlist, including title, description and thumbnails. # The <code>snippet</code> object contains basic details about the |
| # playlist item, such as its title and position in the playlist. |
| # Basic details of a YouTube Playlist item provided by the author. |
| # Next ID: 13 |
| "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. |
| "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. |
| }, |
| }, |
| "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 <code>0</code>, |
| # the second item has a position of <code>1</code>, and so forth. |
| "playlistId": "A String", # The ID that YouTube uses to uniquely identify thGe playlist that the |
| # playlist item is in. |
| "title": "A String", # The item's title. |
| "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The <code>id</code> object contains information that can be used to |
| # uniquely identify the resource that is included in the playlist as |
| # the playlist item. |
| "kind": "A String", # The type of the API resource. |
| "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 |
| # <code>resourceId.kind</code> value is <code>youtube#video</code>. |
| "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 |
| # <code>resourceId.kind</code> value is <code>youtube#channel</code>. |
| "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 |
| # <code>resourceId.kind</code> value is <code>youtube#playlist</code>. |
| }, |
| "description": "A String", # The item's description. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the user that added |
| # the item to the playlist. |
| "channelTitle": "A String", # Channel title for the channel that the playlist item belongs to. |
| "publishedAt": "A String", # The date and time that the item was added to the playlist. The value is |
| # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| }, |
| "kind": "youtube#playlistItem", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#playlistItem"</code>. |
| } |
| |
| 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>playlistItem</strong></code> resource identifies |
| # another resource, such as a video, that is included in a playlist. In |
| # addition, the <code>playlistItem </code> resource contains details |
| # about the included resource that pertain specifically to how that |
| # resource is used in that playlist.<br/><br/> YouTube 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. |
| # <br/><br/> |
| # 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. 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. 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. |
| "etag": "A String", # Etag of this resource. |
| "status": { # Information about the playlist item's privacy status. # The <code>status</code> object contains information about the playlist |
| # item's privacy status. |
| "privacyStatus": "A String", # This resource's privacy status. |
| }, |
| "contentDetails": { # The <code>contentDetails</code> object is included in the resource if |
| # the included item is a YouTube video. The object contains additional |
| # information about the video. |
| "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 <code>0</code>. |
| "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 <code>video.endTime</code> is |
| # the end of the video. |
| "videoId": "A String", # The ID that YouTube uses to uniquely identify a video. To <a |
| # href="/youtube/v3/docs/video/list.html">retrieve the <code>video</code> |
| # resource</a>, set the <code>id</code> query parameter to this value in your |
| # API request. |
| "note": "A String", # A user-generated note for this item. |
| "videoPublishedAt": "A String", # The date and time that the video was published to YouTube. The value is |
| # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| }, |
| "id": "A String", # The ID that YouTube uses to uniquely identify the playlist item. |
| "snippet": { # Basic details about a playlist, including title, description and thumbnails. # The <code>snippet</code> object contains basic details about the |
| # playlist item, such as its title and position in the playlist. |
| # Basic details of a YouTube Playlist item provided by the author. |
| # Next ID: 13 |
| "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. |
| "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. |
| }, |
| }, |
| "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 <code>0</code>, |
| # the second item has a position of <code>1</code>, and so forth. |
| "playlistId": "A String", # The ID that YouTube uses to uniquely identify thGe playlist that the |
| # playlist item is in. |
| "title": "A String", # The item's title. |
| "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The <code>id</code> object contains information that can be used to |
| # uniquely identify the resource that is included in the playlist as |
| # the playlist item. |
| "kind": "A String", # The type of the API resource. |
| "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 |
| # <code>resourceId.kind</code> value is <code>youtube#video</code>. |
| "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 |
| # <code>resourceId.kind</code> value is <code>youtube#channel</code>. |
| "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 |
| # <code>resourceId.kind</code> value is <code>youtube#playlist</code>. |
| }, |
| "description": "A String", # The item's description. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the user that added |
| # the item to the playlist. |
| "channelTitle": "A String", # Channel title for the channel that the playlist item belongs to. |
| "publishedAt": "A String", # The date and time that the item was added to the playlist. The value is |
| # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| }, |
| "kind": "youtube#playlistItem", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#playlistItem"</code>. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(part, videoId=None, onBehalfOfContentOwner=None, maxResults=None, id=None, pageToken=None, playlistId=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>playlistItem</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>playlistItem</code> resource, the <code>snippet</code> property |
| contains numerous fields, including the <code>title</code>, |
| <code>description</code>, <code>position</code>, and |
| <code>resourceId</code> properties. As such, if you set |
| <code><strong>part=snippet</strong></code>, the API response will contain |
| all of those properties. (required) (repeated) |
| videoId: string, Return the playlist items associated with the given video ID. |
| 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. |
| 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, A parameter (repeated) |
| 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. |
| playlistId: string, Return the playlist items within the given playlist. |
| 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 playlist items that match the request criteria. |
| { # A <code><strong>playlistItem</strong></code> resource identifies |
| # another resource, such as a video, that is included in a playlist. In |
| # addition, the <code>playlistItem </code> resource contains details |
| # about the included resource that pertain specifically to how that |
| # resource is used in that playlist.<br/><br/> YouTube 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. |
| # <br/><br/> |
| # 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. 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. 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. |
| "etag": "A String", # Etag of this resource. |
| "status": { # Information about the playlist item's privacy status. # The <code>status</code> object contains information about the playlist |
| # item's privacy status. |
| "privacyStatus": "A String", # This resource's privacy status. |
| }, |
| "contentDetails": { # The <code>contentDetails</code> object is included in the resource if |
| # the included item is a YouTube video. The object contains additional |
| # information about the video. |
| "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 <code>0</code>. |
| "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 <code>video.endTime</code> is |
| # the end of the video. |
| "videoId": "A String", # The ID that YouTube uses to uniquely identify a video. To <a |
| # href="/youtube/v3/docs/video/list.html">retrieve the <code>video</code> |
| # resource</a>, set the <code>id</code> query parameter to this value in your |
| # API request. |
| "note": "A String", # A user-generated note for this item. |
| "videoPublishedAt": "A String", # The date and time that the video was published to YouTube. The value is |
| # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| }, |
| "id": "A String", # The ID that YouTube uses to uniquely identify the playlist item. |
| "snippet": { # Basic details about a playlist, including title, description and thumbnails. # The <code>snippet</code> object contains basic details about the |
| # playlist item, such as its title and position in the playlist. |
| # Basic details of a YouTube Playlist item provided by the author. |
| # Next ID: 13 |
| "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. |
| "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. |
| }, |
| }, |
| "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 <code>0</code>, |
| # the second item has a position of <code>1</code>, and so forth. |
| "playlistId": "A String", # The ID that YouTube uses to uniquely identify thGe playlist that the |
| # playlist item is in. |
| "title": "A String", # The item's title. |
| "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The <code>id</code> object contains information that can be used to |
| # uniquely identify the resource that is included in the playlist as |
| # the playlist item. |
| "kind": "A String", # The type of the API resource. |
| "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 |
| # <code>resourceId.kind</code> value is <code>youtube#video</code>. |
| "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 |
| # <code>resourceId.kind</code> value is <code>youtube#channel</code>. |
| "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 |
| # <code>resourceId.kind</code> value is <code>youtube#playlist</code>. |
| }, |
| "description": "A String", # The item's description. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the user that added |
| # the item to the playlist. |
| "channelTitle": "A String", # Channel title for the channel that the playlist item belongs to. |
| "publishedAt": "A String", # The date and time that the item was added to the playlist. The value is |
| # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| }, |
| "kind": "youtube#playlistItem", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#playlistItem"</code>. |
| }, |
| ], |
| "eventId": "A String", # Serialized EventId of the request which produced this response. |
| "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. |
| "kind": "youtube#playlistItemListResponse", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#playlistItemListResponse"</code>. |
| # Etag of this resource. |
| "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. |
| "etag": "A String", |
| "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. |
| }, |
| }</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 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 <code>part</code> parameter value includes the |
| <code>contentDetails</code> 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) (repeated) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A <code><strong>playlistItem</strong></code> resource identifies |
| # another resource, such as a video, that is included in a playlist. In |
| # addition, the <code>playlistItem </code> resource contains details |
| # about the included resource that pertain specifically to how that |
| # resource is used in that playlist.<br/><br/> YouTube 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. |
| # <br/><br/> |
| # 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. 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. 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. |
| "etag": "A String", # Etag of this resource. |
| "status": { # Information about the playlist item's privacy status. # The <code>status</code> object contains information about the playlist |
| # item's privacy status. |
| "privacyStatus": "A String", # This resource's privacy status. |
| }, |
| "contentDetails": { # The <code>contentDetails</code> object is included in the resource if |
| # the included item is a YouTube video. The object contains additional |
| # information about the video. |
| "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 <code>0</code>. |
| "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 <code>video.endTime</code> is |
| # the end of the video. |
| "videoId": "A String", # The ID that YouTube uses to uniquely identify a video. To <a |
| # href="/youtube/v3/docs/video/list.html">retrieve the <code>video</code> |
| # resource</a>, set the <code>id</code> query parameter to this value in your |
| # API request. |
| "note": "A String", # A user-generated note for this item. |
| "videoPublishedAt": "A String", # The date and time that the video was published to YouTube. The value is |
| # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| }, |
| "id": "A String", # The ID that YouTube uses to uniquely identify the playlist item. |
| "snippet": { # Basic details about a playlist, including title, description and thumbnails. # The <code>snippet</code> object contains basic details about the |
| # playlist item, such as its title and position in the playlist. |
| # Basic details of a YouTube Playlist item provided by the author. |
| # Next ID: 13 |
| "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. |
| "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. |
| }, |
| }, |
| "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 <code>0</code>, |
| # the second item has a position of <code>1</code>, and so forth. |
| "playlistId": "A String", # The ID that YouTube uses to uniquely identify thGe playlist that the |
| # playlist item is in. |
| "title": "A String", # The item's title. |
| "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The <code>id</code> object contains information that can be used to |
| # uniquely identify the resource that is included in the playlist as |
| # the playlist item. |
| "kind": "A String", # The type of the API resource. |
| "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 |
| # <code>resourceId.kind</code> value is <code>youtube#video</code>. |
| "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 |
| # <code>resourceId.kind</code> value is <code>youtube#channel</code>. |
| "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 |
| # <code>resourceId.kind</code> value is <code>youtube#playlist</code>. |
| }, |
| "description": "A String", # The item's description. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the user that added |
| # the item to the playlist. |
| "channelTitle": "A String", # Channel title for the channel that the playlist item belongs to. |
| "publishedAt": "A String", # The date and time that the item was added to the playlist. The value is |
| # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| }, |
| "kind": "youtube#playlistItem", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#playlistItem"</code>. |
| } |
| |
| 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>playlistItem</strong></code> resource identifies |
| # another resource, such as a video, that is included in a playlist. In |
| # addition, the <code>playlistItem </code> resource contains details |
| # about the included resource that pertain specifically to how that |
| # resource is used in that playlist.<br/><br/> YouTube 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. |
| # <br/><br/> |
| # 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. 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. 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. |
| "etag": "A String", # Etag of this resource. |
| "status": { # Information about the playlist item's privacy status. # The <code>status</code> object contains information about the playlist |
| # item's privacy status. |
| "privacyStatus": "A String", # This resource's privacy status. |
| }, |
| "contentDetails": { # The <code>contentDetails</code> object is included in the resource if |
| # the included item is a YouTube video. The object contains additional |
| # information about the video. |
| "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 <code>0</code>. |
| "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 <code>video.endTime</code> is |
| # the end of the video. |
| "videoId": "A String", # The ID that YouTube uses to uniquely identify a video. To <a |
| # href="/youtube/v3/docs/video/list.html">retrieve the <code>video</code> |
| # resource</a>, set the <code>id</code> query parameter to this value in your |
| # API request. |
| "note": "A String", # A user-generated note for this item. |
| "videoPublishedAt": "A String", # The date and time that the video was published to YouTube. The value is |
| # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| }, |
| "id": "A String", # The ID that YouTube uses to uniquely identify the playlist item. |
| "snippet": { # Basic details about a playlist, including title, description and thumbnails. # The <code>snippet</code> object contains basic details about the |
| # playlist item, such as its title and position in the playlist. |
| # Basic details of a YouTube Playlist item provided by the author. |
| # Next ID: 13 |
| "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. |
| "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. |
| }, |
| }, |
| "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 <code>0</code>, |
| # the second item has a position of <code>1</code>, and so forth. |
| "playlistId": "A String", # The ID that YouTube uses to uniquely identify thGe playlist that the |
| # playlist item is in. |
| "title": "A String", # The item's title. |
| "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The <code>id</code> object contains information that can be used to |
| # uniquely identify the resource that is included in the playlist as |
| # the playlist item. |
| "kind": "A String", # The type of the API resource. |
| "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 |
| # <code>resourceId.kind</code> value is <code>youtube#video</code>. |
| "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 |
| # <code>resourceId.kind</code> value is <code>youtube#channel</code>. |
| "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 |
| # <code>resourceId.kind</code> value is <code>youtube#playlist</code>. |
| }, |
| "description": "A String", # The item's description. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the user that added |
| # the item to the playlist. |
| "channelTitle": "A String", # Channel title for the channel that the playlist item belongs to. |
| "publishedAt": "A String", # The date and time that the item was added to the playlist. The value is |
| # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| }, |
| "kind": "youtube#playlistItem", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#playlistItem"</code>. |
| }</pre> |
| </div> |
| |
| </body></html> |
