YouTube API . playlists

Instance Methods

delete(id, onBehalfOfContentOwner=None)

Deletes playlists by IDs.

insert(part, body, onBehalfOfContentOwner=None)

Create a playlist.

list(part, onBehalfOfContentOwner=None, pageToken=None, maxResults=None, mine=None, id=None)

Browse the YouTube playlist collection.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(part, body, onBehalfOfContentOwner=None)

Update a playlist.

Method Details

delete(id, onBehalfOfContentOwner=None)
Deletes playlists by IDs.

Args:
  id: string, YouTube IDs of the playlists to be deleted. (required)
  onBehalfOfContentOwner: string, The authenticated user acts on behalf of this content owner.
insert(part, body, onBehalfOfContentOwner=None)
Create a playlist.

Args:
  part: string, One or more parts to return on the current request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A playlist resource represents a single YouTube playlist.
    "snippet": { # Basic details about a playlist, including title, description and thumbnails. # Basic details about the playlist: title, description, thumbnails.
      "title": "A String", # Title of the playlist.
      "channelId": "A String", # Channel publishing the playlist.
      "description": "A String", # Description of the playlist.
      "publishedAt": "A String", # Date and time the playlist was published at.
      "thumbnails": { # Playlist thumbnails.
        "a_key": { # A thumbnail is an image representing a YouTube resource. # A map of thumbnails by their name.
          "url": "A String", # The URL for the thumbnail.
        },
      },
    },
    "status": { # The status details of a playlist describes whether the playlist is private. # Status of the playlist: only privacy_status for now.
      "privacyStatus": "A String", # Privacy of the playlist.
    },
    "kind": "youtube#playlist", # The type of this API resource.
    "etag": "A String", # The eTag of the playlist.
    "id": "A String", # The unique id of the playlist.
  }

  onBehalfOfContentOwner: string, The authenticated user acts on behalf of this content owner.

Returns:
  An object of the form:

    { # A playlist resource represents a single YouTube playlist.
      "snippet": { # Basic details about a playlist, including title, description and thumbnails. # Basic details about the playlist: title, description, thumbnails.
        "title": "A String", # Title of the playlist.
        "channelId": "A String", # Channel publishing the playlist.
        "description": "A String", # Description of the playlist.
        "publishedAt": "A String", # Date and time the playlist was published at.
        "thumbnails": { # Playlist thumbnails.
          "a_key": { # A thumbnail is an image representing a YouTube resource. # A map of thumbnails by their name.
            "url": "A String", # The URL for the thumbnail.
          },
        },
      },
      "status": { # The status details of a playlist describes whether the playlist is private. # Status of the playlist: only privacy_status for now.
        "privacyStatus": "A String", # Privacy of the playlist.
      },
      "kind": "youtube#playlist", # The type of this API resource.
      "etag": "A String", # The eTag of the playlist.
      "id": "A String", # The unique id of the playlist.
    }
list(part, onBehalfOfContentOwner=None, pageToken=None, maxResults=None, mine=None, id=None)
Browse the YouTube playlist collection.

Args:
  part: string, Playlist parts to include in the returned response. Valid values are: id, snippet and status. (required)
  onBehalfOfContentOwner: string, The authenticated user acts on behalf of this content owner.
  pageToken: string, Token for the page selection.
  maxResults: integer, Maximum number of results to return
  mine: string, Flag indicating only return the playlists of the authenticated user.
  id: string, Comma-separated YouTube IDs of the playlists to be returned.

Returns:
  An object of the form:

    { # A paginated list of playlists returned as the response to a youtube.playlists.list call.
    "nextPageToken": "A String", # Token to the next page.
    "kind": "youtube#playlistListResponse", # The type of this API response.
    "items": [ # List of playlists matching the request criteria.
      { # A playlist resource represents a single YouTube playlist.
          "snippet": { # Basic details about a playlist, including title, description and thumbnails. # Basic details about the playlist: title, description, thumbnails.
            "title": "A String", # Title of the playlist.
            "channelId": "A String", # Channel publishing the playlist.
            "description": "A String", # Description of the playlist.
            "publishedAt": "A String", # Date and time the playlist was published at.
            "thumbnails": { # Playlist thumbnails.
              "a_key": { # A thumbnail is an image representing a YouTube resource. # A map of thumbnails by their name.
                "url": "A String", # The URL for the thumbnail.
              },
            },
          },
          "status": { # The status details of a playlist describes whether the playlist is private. # Status of the playlist: only privacy_status for now.
            "privacyStatus": "A String", # Privacy of the playlist.
          },
          "kind": "youtube#playlist", # The type of this API resource.
          "etag": "A String", # The eTag of the playlist.
          "id": "A String", # The unique id of the playlist.
        },
    ],
    "etag": "A String", # The eTag of the response.
    "prevPageToken": "A String", # Token to the previous page.
    "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # Paging information for the list result.
      "totalResults": 42, # The total number of results.
      "resultsPerPage": 42, # The number of results to display for each page.
    },
  }
list_next(previous_request, previous_response)
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.
      
update(part, body, onBehalfOfContentOwner=None)
Update a playlist.

Args:
  part: string, One or more parts to return on the current request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A playlist resource represents a single YouTube playlist.
    "snippet": { # Basic details about a playlist, including title, description and thumbnails. # Basic details about the playlist: title, description, thumbnails.
      "title": "A String", # Title of the playlist.
      "channelId": "A String", # Channel publishing the playlist.
      "description": "A String", # Description of the playlist.
      "publishedAt": "A String", # Date and time the playlist was published at.
      "thumbnails": { # Playlist thumbnails.
        "a_key": { # A thumbnail is an image representing a YouTube resource. # A map of thumbnails by their name.
          "url": "A String", # The URL for the thumbnail.
        },
      },
    },
    "status": { # The status details of a playlist describes whether the playlist is private. # Status of the playlist: only privacy_status for now.
      "privacyStatus": "A String", # Privacy of the playlist.
    },
    "kind": "youtube#playlist", # The type of this API resource.
    "etag": "A String", # The eTag of the playlist.
    "id": "A String", # The unique id of the playlist.
  }

  onBehalfOfContentOwner: string, The authenticated user acts on behalf of this content owner.

Returns:
  An object of the form:

    { # A playlist resource represents a single YouTube playlist.
      "snippet": { # Basic details about a playlist, including title, description and thumbnails. # Basic details about the playlist: title, description, thumbnails.
        "title": "A String", # Title of the playlist.
        "channelId": "A String", # Channel publishing the playlist.
        "description": "A String", # Description of the playlist.
        "publishedAt": "A String", # Date and time the playlist was published at.
        "thumbnails": { # Playlist thumbnails.
          "a_key": { # A thumbnail is an image representing a YouTube resource. # A map of thumbnails by their name.
            "url": "A String", # The URL for the thumbnail.
          },
        },
      },
      "status": { # The status details of a playlist describes whether the playlist is private. # Status of the playlist: only privacy_status for now.
        "privacyStatus": "A String", # Privacy of the playlist.
      },
      "kind": "youtube#playlist", # The type of this API resource.
      "etag": "A String", # The eTag of the playlist.
      "id": "A String", # The unique id of the playlist.
    }