Playlists: list

Restituisce una raccolta di playlist che corrispondono ai parametri della richiesta API. Ad esempio, puoi recuperare tutte le playlist di proprietà dell'utente autenticato oppure una o più playlist in base ai relativi ID univoci.

Impatto sulla quota: una chiamata a questo metodo ha un costo della quota di 1 unità.

Casi d'uso comuni

Richiesta

Richiesta HTTP

GET https://www.googleapis.com/youtube/v3/playlists

Parametri

La tabella seguente elenca i parametri supportati da questa query. Tutti i parametri elencati sono parametri di query.

Parametri
Parametri obbligatori
part string
Il parametro part specifica un elenco separato da virgole di una o più proprietà della risorsa playlist che verranno incluse nella risposta dell'API.

Se il parametro identifica una proprietà che contiene proprietà figlio, queste verranno incluse nella risposta. Ad esempio, in una risorsa playlist, la proprietà snippet contiene proprietà come author, title, description e timeCreated. Pertanto, se imposti part=snippet, la risposta dell'API conterrà tutte queste proprietà.

Il seguente elenco contiene i part nomi che puoi includere nel valore del parametro:
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
Filtri (specifica esattamente uno dei seguenti parametri)
channelId string
Questo valore indica che l'API deve restituire solo le playlist del canale specificato.
id string
Il parametro id specifica un elenco separato da virgole degli ID playlist di YouTube per le risorse che vengono recuperate. In una risorsa playlist, la proprietà id specifica l'ID playlist di YouTube.
mine boolean
Questo parametro può essere utilizzato solo in una richiesta autorizzata correttamente. Imposta il valore di questo parametro su true per indicare all'API di restituire solo le playlist di proprietà dell'utente autenticato.
Parametri facoltativi
hl string
Il parametro hl indica all'API di recuperare i metadati delle risorse localizzate per una lingua dell'applicazione specifica supportata dal sito web di YouTube. Il valore del parametro deve essere un codice lingua incluso nell'elenco restituito dal metodo i18nLanguages.list.

Se i dettagli delle risorse localizzate sono disponibili in quella lingua, l'oggetto snippet.localized della risorsa conterrà i valori localizzati. Tuttavia, se i dettagli localizzati non sono disponibili, l'oggetto snippet.localized conterrà i dettagli delle risorse nella lingua predefinita della risorsa.
maxResults unsigned integer
Il parametro maxResults specifica il numero massimo di elementi che devono essere restituiti nel set di risultati. I valori accettabili sono compresi tra 0 e 50, inclusi. Il valore predefinito è 5.
onBehalfOfContentOwner string
Questo parametro può essere utilizzato solo in una richiesta autorizzata correttamente. Nota: questo parametro è destinato esclusivamente ai partner di contenuti di YouTube.

Il parametro onBehalfOfContentOwner indica che le credenziali di autorizzazione della richiesta identificano un utente di YouTube CMS che agisce per conto del proprietario dei contenuti specificato nel valore del parametro. Questo parametro è destinato ai partner di contenuti di YouTube che possiedono e gestiscono molti canali YouTube diversi. Consente ai proprietari dei contenuti di autenticarsi una sola volta e di accedere a tutti i dati dei video e dei canali, senza dover fornire le credenziali di autenticazione per ogni singolo canale. L'account CMS con cui l'utente esegue l'autenticazione deve essere collegato al proprietario dei contenuti di YouTube specificato.
onBehalfOfContentOwnerChannel string
Questo parametro può essere utilizzato solo in una richiesta autorizzata correttamente. Nota: questo parametro è destinato esclusivamente ai partner di contenuti di YouTube.

Il parametro onBehalfOfContentOwnerChannel specifica l'ID del canale YouTube del canale a cui viene aggiunto un video. Questo parametro è obbligatorio quando una richiesta specifica un valore per il parametro onBehalfOfContentOwner e può essere utilizzato solo in combinazione con questo parametro. Inoltre, la richiesta deve essere autorizzata utilizzando un account CMS collegato al proprietario dei contenuti specificato dal parametro onBehalfOfContentOwner. Infine, il canale specificato dal valore del parametro onBehalfOfContentOwnerChannel deve essere collegato al proprietario dei contenuti specificato dal parametro onBehalfOfContentOwner.

Questo parametro è destinato ai partner di contenuti di YouTube che possiedono e gestiscono molti canali YouTube diversi. Consente ai proprietari dei contenuti di autenticarsi una sola volta ed eseguire azioni per conto del canale specificato nel valore del parametro, senza dover fornire le credenziali di autenticazione per ogni canale separato.
pageToken string
Il parametro pageToken identifica una pagina specifica nel set di risultati che deve essere restituita. In una risposta dell'API, le proprietà nextPageToken e prevPageToken identificano altre pagine che potrebbero essere recuperate.

Corpo della richiesta

Non fornire un corpo della richiesta quando chiami questo metodo.

Risposta

In caso di esito positivo, questo metodo restituisce un corpo della risposta con la seguente struttura:

{
  "kind": "youtube#playlistListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    playlist Resource
  ]
}

Proprietà

La tabella seguente definisce le proprietà che appaiono in questa risorsa:

Proprietà
kind string
Identifica il tipo di risorsa API. Il valore sarà youtube#playlistListResponse.
etag etag
L'ETag di questa risorsa.
nextPageToken string
Il token che può essere utilizzato come valore del parametro pageToken per recuperare la pagina successiva nel set di risultati.
prevPageToken string
Il token che può essere utilizzato come valore del parametro pageToken per recuperare la pagina precedente nel set di risultati.
pageInfo object
L'oggetto pageInfo incapsula le informazioni di paginazione per il set di risultati.
pageInfo.totalResults integer
Il numero totale di risultati nel set di risultati.
pageInfo.resultsPerPage integer
Il numero di risultati inclusi nella risposta dell'API.
items[] list
Un elenco di playlist che corrispondono ai criteri della richiesta.

Errori

La tabella seguente identifica i messaggi di errore che l'API potrebbe restituire in risposta a una chiamata a questo metodo. Per maggiori dettagli, consulta la documentazione sui messaggi di errore.

Tipo di errore Dettagli errore Descrizione
forbidden (403) channelClosed Il canale specificato nel parametro channelId è stato chiuso.
forbidden (403) channelSuspended Il canale specificato nel parametro channelId è stato sospeso.
forbidden (403) playlistForbidden La playlist identificata con il parametro id della richiesta non supporta la richiesta o la richiesta non è autorizzata correttamente.
notFound (404) channelNotFound Impossibile trovare il canale specificato nel parametro channelId.
notFound (404) playlistNotFound Impossibile trovare la playlist identificata con il parametro id della richiesta.
invalidValue (400) playlistOperationUnsupported L'API non supporta la possibilità di elencare la playlist specificata. Ad esempio, non puoi elencare la playlist Guarda più tardi.

Prova

Utilizza APIs Explorer per chiamare questa API e visualizzare la richiesta API e la risposta.