Channels: list

Nota: il valore della proprietà statistics.subscriberCount della risorsa channel è stato aggiornato in base a una modifica delle norme di YouTube che influisce sul modo in cui vengono visualizzati i conteggi degli iscritti. Per ulteriori informazioni, consulta la Cronologia delle revisioni o il Centro assistenza YouTube.

Restituisce una raccolta di zero o più risorse channel che corrispondono ai criteri di richiesta.

Impatto sulle quote: 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/channels

Autorizzazione

Una richiesta che recupera la parte auditDetails per una risorsa channel deve fornire un token di autorizzazione che contenga l'ambito https://www.googleapis.com/auth/youtubepartner-channel-audit. Inoltre, qualsiasi token che utilizza questo ambito deve essere revocato quando la Rete di creator decide di accettare o rifiutare il canale o entro due settimane dalla data di emissione del token.

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 channel che verranno incluse nella risposta dell'API.

Se il parametro identifica una proprietà che contiene proprietà secondarie, queste ultime verranno incluse nella risposta. Ad esempio, in una risorsa channel, la proprietà contentDetails contiene altre proprietà, come le proprietà uploads. Di conseguenza, se imposti part=contentDetails, la risposta dell'API conterrà anche tutte queste proprietà nidificate.

Il seguente elenco contiene i nomi part che puoi includere nel valore del parametro:
  • auditDetails
  • brandingSettings
  • contentDetails
  • contentOwnerDetails
  • id
  • localizations
  • snippet
  • statistics
  • status
  • topicDetails
Filtri (specifica esattamente uno dei seguenti parametri)
categoryId string
Questo parametro è stato ritirato. Il parametro categoryId specificava una categoria di guide di YouTube e poteva essere utilizzato per richiedere i canali YouTube associati a quella categoria.
forHandle string
Il parametro forHandle specifica un handle di YouTube, richiedendo quindi il canale associato a quell'handle. Al valore del parametro può essere anteposto un simbolo @. Ad esempio, per recuperare la risorsa per il canale "Google for Developers", imposta il valore del parametro forHandle su GoogleDevelopers o @GoogleDevelopers.
forUsername string
Il parametro forUsername specifica un nome utente di YouTube, richiedendo così il canale associato a quel nome utente.
id string
Il parametro id specifica un elenco separato da virgole degli ID canale YouTube delle risorse che vengono recuperate. In una risorsa channel, la proprietà id specifica l'ID canale YouTube del canale.
managedByMe boolean
Questo parametro può essere utilizzato solo in una richiesta autorizzata.

Nota: questo parametro è destinato esclusivamente ai partner di contenuti di YouTube.

Imposta il valore di questo parametro su true per indicare all'API di restituire solo i canali gestiti dal proprietario dei contenuti specificato dal parametro onBehalfOfContentOwner. L'utente deve essere autenticato come account CMS collegato al proprietario dei contenuti specificato e deve essere fornito onBehalfOfContentOwner.
mine boolean
Questo parametro può essere utilizzato solo in una richiesta autorizzata. Imposta il valore di questo parametro su true per indicare all'API di restituire solo i canali di proprietà dell'utente autenticato.
Parametri facoltativi
hl string
Il parametro hl indica all'API di recuperare i metadati delle risorse localizzati per una specifica lingua di applicazione 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 della risorsa localizzati 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 della risorsa nella lingua predefinita della risorsa.
maxResults unsigned integer
Il parametro maxResults specifica il numero massimo di elementi da restituire nel set di risultati. I valori accettabili sono compresi tra 0 e 50. Il valore predefinito è 5.
onBehalfOfContentOwner string
Questo parametro può essere utilizzato solo in una richiesta autorizzata.

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 di contenuti di autenticarsi una volta sola per 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.
pageToken string
Il parametro pageToken identifica una pagina specifica del set di risultati da restituire. 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#channelListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    channel Resource
  ]
}

Proprietà

La tabella seguente definisce le proprietà visualizzate in questa risorsa:

Proprietà
kind string
Identifica il tipo di risorsa API. Il valore sarà youtube#channelListResponse.
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. Tieni presente che questa proprietà non è inclusa nella risposta dell'API se la richiesta dell'API corrispondente ha impostato il parammetro managedByMe su true.
pageInfo object
L'oggetto pageInfo racchiude 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 canali che corrispondono ai criteri di richiesta.

Errori

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

Tipo di errore Dettaglio errore Descrizione
badRequest (400) invalidCriteria È possibile specificare al massimo uno dei seguenti filtri:id, categoryId, mine, managedByMe, forHandle, forUsername. In caso di autenticazione del proprietario dei contenuti tramite il parametro onBehalfOfContentOwner, è possibile specificare solo id o managedByMe.
forbidden (403) channelForbidden Il canale specificato dal parametro id non supporta la richiesta o la richiesta non è correttamente autorizzata.
notFound (404) categoryNotFound Impossibile trovare la categoria identificata dal parametro categoryId. Utilizza il metodo guideCategories.list per recuperare un elenco di valori validi.
notFound (404) channelNotFound Impossibile trovare il canale specificato nel parametro id.

Prova

Usa APIs Explorer per chiamare questa API e visualizzare la richiesta e la risposta dell'API.