Retorna um conjunto de playlists que correspondem aos parâmetros da solicitação de API. Por exemplo, você pode recuperar todas as playlists que o usuário autenticado possui ou recuperar uma ou mais playlists por seus IDs únicos.
Impacto na cota: uma chamada para esse método tem um custo de cota de uma unidade.
Casos de uso comuns
Solicitação
Solicitação HTTP
GET https://www.googleapis.com/youtube/v3/playlists
Parâmetros
A tabela a seguir lista os parâmetros compatíveis com essa consulta. Todos os parâmetros listados são os parâmetros de consulta.
Parâmetros | ||
---|---|---|
Parâmetros obrigatórios | ||
part |
string O parâmetro part especifica uma lista separada por vírgulas de uma ou mais propriedades de recurso playlist que a resposta da API incluirá.Se o parâmetro identificar uma propriedade que contenha propriedades filhas, elas serão incluídas na resposta. Por exemplo, em um recurso playlist , a propriedade snippet contém propriedades como author , title , description e timeCreated . Dessa forma, se você definir part=snippet , a resposta da API vai conter todas essas propriedades.A lista a seguir contém os nomes de part que podem ser incluídos no valor de parâmetro:
|
|
Filtros (especifique exatamente um dos seguintes parâmetros) | ||
channelId |
string Esse valor indica que a API precisa retornar apenas as playlists do canal especificado. |
|
id |
string O parâmetro id especifica uma lista separada por vírgulas dos IDs da playlist do YouTube para os recursos que estiverem sendo recuperados. Em um recurso playlist , a propriedade id especifica o ID da playlist do YouTube. |
|
mine |
boolean Esse parâmetro só pode ser usado em uma solicitação autorizada corretamente. Defina o valor deste parâmetro como true para instruir a API a retornar apenas playlists de propriedade do usuário autenticado. |
|
Parâmetros opcionais | ||
hl |
string O parâmetro hl instrui a API a recuperar metadados de recursos localizados para um idioma do aplicativo compatível com o site do YouTube. O valor do parâmetro precisa ser um código de idioma incluído na lista retornada pelo método i18nLanguages.list .Se os detalhes dos recursos localizados estiverem disponíveis nesse idioma, o objeto snippet.localized do recurso conterá os valores localizados. No entanto, se os detalhes localizados não estiverem disponíveis, o objeto snippet.localized conterá detalhes do recurso no idioma padrão do recurso. |
|
maxResults |
unsigned integer O parâmetro maxResults especifica o número máximo de itens que precisam ser retornados no conjunto de resultados. Os valores aceitos são de 0 a 50 , inclusive. O valor padrão é 5 . |
|
onBehalfOfContentOwner |
string Esse parâmetro só pode ser usado em uma solicitação autorizada corretamente. Observação: esse parâmetro é destinado exclusivamente a parceiros de conteúdo do YouTube. O parâmetro onBehalfOfContentOwner indica que as credenciais de autorização da solicitação identificam um usuário do CMS do YouTube que atua em nome do proprietário do conteúdo especificado no valor do parâmetro. Este parâmetro destina-se a parceiros de conteúdo do YouTube que possuem e gerenciam vários canais do YouTube diferentes. Ele permite que os proprietários de conteúdo autentiquem uma vez e tenham acesso a todos os dados de seu canal e de seus vídeos sem ter que fornecer credenciais de autenticação para cada canal. A conta do CMS com a qual o usuário autentica deve estar vinculada ao proprietário do conteúdo do YouTube especificado. |
|
onBehalfOfContentOwnerChannel |
string Esse parâmetro só pode ser usado em uma solicitação autorizada corretamente. Observação: esse parâmetro é destinado exclusivamente a parceiros de conteúdo do YouTube. O parâmetro onBehalfOfContentOwnerChannel especifica o ID do canal do YouTube ao qual um vídeo está sendo adicionado. Esse parâmetro é necessário quando uma solicitação especifica um valor para o parâmetro onBehalfOfContentOwner e só pode ser usado com ele. Além disso, a solicitação precisa ser autorizada usando uma conta do CMS vinculada ao proprietário do conteúdo especificado pelo parâmetro onBehalfOfContentOwner . Por fim, o canal especificado pelo valor do parâmetro onBehalfOfContentOwnerChannel precisa estar vinculado ao proprietário do conteúdo especificado pelo parâmetro onBehalfOfContentOwner .Este parâmetro é destinado a parceiros de conteúdo do YouTube que têm e gerenciam muitos canais diferentes. Ele permite que os proprietários do conteúdo autentiquem uma vez e executem ações em nome do canal especificado no valor do parâmetro sem ter que fornecer credenciais de autenticação para cada canal separado. |
|
pageToken |
string O parâmetro pageToken identifica uma página específica no conjunto de resultados que precisa ser retornada. Em uma resposta da API, as propriedades nextPageToken e prevPageToken identificam outras páginas que podem ser recuperadas. |
Corpo da solicitação
Não forneça um corpo de solicitação ao chamar este método.
Resposta
Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:
{ "kind": "youtube#playlistListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ playlist Resource ] }
Propriedades
A tabela a seguir define as propriedades que aparecem neste recurso:
Propriedades | |
---|---|
kind |
string Identifica o tipo do recurso da API. O valor será youtube#playlistListResponse . |
etag |
etag A ETag deste recurso. |
nextPageToken |
string O token que pode ser usado como o valor do parâmetro pageToken para recuperar a próxima página no conjunto de resultados. |
prevPageToken |
string O token que pode ser usado como o valor do parâmetro pageToken para recuperar a página anterior do conjunto de resultados. |
pageInfo |
object O objeto pageInfo encapsula informações de paginação para o conjunto de resultados. |
pageInfo.totalResults |
integer O número total de resultados no conjunto de resultados. |
pageInfo.resultsPerPage |
integer O número de resultados incluídos na resposta da API. |
items[] |
list Uma lista de playlists que correspondem aos critérios de solicitação. |
Erros
A tabela a seguir identifica mensagens de erro que a API pode retornar em resposta a uma chamada para esse método. Consulte a documentação mensagem de erro para mais detalhes.
Tipo de erro | Detalhe do erro | Descrição |
---|---|---|
forbidden (403) |
channelClosed |
O canal especificado no parâmetro channelId foi fechado. |
forbidden (403) |
channelSuspended |
O canal especificado no parâmetro channelId foi suspenso. |
forbidden (403) |
playlistForbidden |
A playlist identificada com o parâmetro id da solicitação não é compatível ou não foi autorizada corretamente. |
notFound (404) |
channelNotFound |
O canal especificado no parâmetro channelId não foi encontrado. |
notFound (404) |
playlistNotFound |
A playlist identificada com o parâmetro id da solicitação não pode ser encontrada. |
invalidValue (400) |
playlistOperationUnsupported |
A API não é compatível com a capacidade de listar a playlist especificada. Por exemplo, não é possível listar sua playlist "Assistir mais tarde". |
Confira!
Use o APIs Explorer para chamar a API e ver a solicitação e a resposta da API.