API Reference

L'API di dati di YouTube ti consente di incorporare nel tuo sito web o nella tua applicazione funzioni eseguite normalmente sul sito web di YouTube. Gli elenchi riportati di seguito identificano i diversi tipi di risorse che puoi recuperare utilizzando l'API. L'API supporta anche metodi per inserire, aggiornare o eliminare molte di queste risorse.

Questa guida di riferimento spiega come utilizzare l'API per eseguire tutte queste operazioni. La guida è organizzata per tipo di risorsa. Una risorsa è un tipo di elemento che include parte dell'esperienza su YouTube, ad esempio un video, una playlist o un'iscrizione. Per ogni tipo di risorsa, la guida elenca una o più rappresentazioni dei dati e le risorse sono rappresentate come oggetti JSON. La guida elenca anche uno o più metodi supportati (LIST, POST, DELETE e così via) per ogni tipo di risorsa e spiega come utilizzarli nella tua applicazione.

Chiamata all'API

Per le richieste relative all'API di dati di YouTube si applicano i seguenti requisiti:

  1. Ogni richiesta deve specificare una chiave API (con il parametro key) o fornire un token OAuth 2.0. La chiave API è disponibile nel riquadro Accesso API di Developer Console per il tuo progetto.

  2. Devi inviare un token di autorizzazione per ogni richiesta di inserimento, aggiornamento ed eliminazione. Devi inoltre inviare un token di autorizzazione per qualsiasi richiesta che recuperi i dati privati dell'utente autenticato.

    Inoltre, alcuni metodi API per il recupero delle risorse potrebbero supportare parametri che richiedono l'autorizzazione o potrebbero contenere metadati aggiuntivi quando le richieste sono autorizzate. Ad esempio, una richiesta per recuperare i video caricati da un utente può contenere anche video privati, se è autorizzata da quell'utente specifico.

  3. L'API supporta il protocollo di autenticazione OAuth 2.0. Puoi fornire un token OAuth 2.0 in uno dei seguenti modi:

    • Utilizza il parametro di ricerca access_token come segue: ?access_token=oauth2-token
    • Utilizza l'intestazione HTTP Authorization come la seguente: Authorization: Bearer oauth2-token

    Puoi trovare le istruzioni complete per implementare l'autenticazione OAuth 2.0 nell'applicazione nella guida all'autenticazione.

Tipi di risorse

Attività

Una risorsa activity contiene informazioni su un'azione intrapresa da un determinato canale o utente su YouTube. Le azioni riportate nei feed attività includono la valutazione di un video, la condivisione di un video, l'aggiunta di un video ai preferiti, il caricamento di un video e così via. Ogni risorsa activity identifica il tipo di azione, il canale associato all'azione e le risorse associate all'azione, ad esempio il video che è stato valutato o caricato.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione e l'elenco delle proprietà.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
list GET /activities Restituisce un elenco di eventi di attività del canale che corrispondono ai criteri della richiesta. Ad esempio, puoi recuperare gli eventi associati a un determinato canale o al canale dell'utente.
insert POST /activities Nota: questo metodo è stato deprecato e non è più supportato.

Sottotitoli codificati

Una risorsa caption rappresenta una traccia di sottotitoli di YouTube. Una traccia di sottotitoli è associata esattamente a un video di YouTube.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione e l'elenco delle proprietà.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
delete DELETE /captions Consente di eliminare la traccia di sottotitoli specificata.
download GET /captions/id Scarica una traccia di sottotitoli codificati. La traccia dei sottotitoli viene restituita nel formato originale, a meno che la richiesta non specifichi un valore per il parametro tfmt e nella lingua originale, a meno che la richiesta non specifichi un valore per il parametro tlang.
insert POST /captions Carica una traccia di sottotitoli codificati.
list GET /captions Restituisce un elenco di tracce di sottotitoli codificati associate a un video specificato. Tieni presente che la risposta dell'API non contiene i sottotitoli effettivi e che il metodo captions.download consente di recuperare una traccia di sottotitoli codificati.
update PUT /captions Consente di aggiornare una traccia di sottotitoli codificati. Quando aggiorni una traccia di sottotitoli, puoi modificare lo stato di bozza della traccia, caricare un nuovo file di sottotitoli per la traccia o entrambe le cose.

Banner del canale

Una risorsa channelBanner contiene l'URL da utilizzare per impostare un'immagine appena caricata come immagine del banner per un canale.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione e l'elenco delle proprietà.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
insert POST /channelBanners/insert Carica un'immagine del banner del canale su YouTube. Questo metodo rappresenta i primi due passaggi di una procedura di tre passaggi per aggiornare l'immagine del banner per un canale:

  1. Richiama il metodo channelBanners.insert per caricare i dati delle immagini binarie su YouTube. L'immagine deve avere proporzioni pari a 16:9 ed essere di almeno 2048 x 1152 pixel. Ti consigliamo di caricare un'immagine da 2560 x 1440 px.
  2. Estrai il valore della proprietà url dalla risposta restituita dall'API per il passaggio 1.
  3. Richiama il metodo channels.update per aggiornare le impostazioni di branding del canale. Imposta il valore della proprietà brandingSettings.image.bannerExternalUrl sull'URL ottenuto nel passaggio 2.

Sezioni Canale

Una risorsa channelSection contiene informazioni su un insieme di video che un canale ha scelto di mostrare. Ad esempio, una sezione potrebbe includere gli ultimi caricamenti di un canale, i caricamenti più popolari o i video di una o più playlist.

Tieni presente che le sezioni di un canale sono visibili solo se il canale mostra i contenuti nella visualizzazione Sfoglia (anziché in una visualizzazione feed). Per consentire a un canale di mostrare i contenuti in una visualizzazione Sfoglia, imposta la proprietà brandingSettings.channel.showBrowseView su true per il canale specificato.

Un canale può creare un massimo di 10 sezioni.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione e l'elenco delle proprietà.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
delete DELETE /channelSections Elimina la sezione di un canale.
insert POST /channelSections Aggiunge una sezione al canale dell'utente autenticato. Un canale può creare un massimo di 10 sezioni.
list GET /channelSections Restituisce un elenco di risorse channelSection che corrispondono ai criteri della richiesta API.
update PUT /channelSections Aggiorna una sezione del canale.

Canali

Una risorsa channel contiene informazioni su un canale YouTube.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione e l'elenco delle proprietà.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
list GET /channels Restituisce una raccolta di zero o più risorse channel che corrispondono ai criteri della richiesta.
update PUT /channels Consente di aggiornare i metadati di un canale. Tieni presente che questo metodo al momento supporta solo gli aggiornamenti degli oggetti brandingSettings e invideoPromotion della risorsa channel e delle relative proprietà figlio.

Thread di commenti

Una risorsa commentThread contiene informazioni su un thread di commenti di YouTube, che comprende un commento di primo livello e le eventuali risposte al commento in questione. Una risorsa commentThread può rappresentare commenti su un video o su un canale.

Sia il commento di primo livello sia le risposte sono in realtà risorse comment nidificate all'interno della risorsa commentThread. La risorsa commentThread non contiene necessariamente tutte le risposte a un commento e devi utilizzare il metodo comments.list se vuoi recuperare tutte le risposte per un determinato commento. Inoltre, tieni presente che alcuni commenti non hanno risposte.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione e l'elenco delle proprietà.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
list GET /commentThreads Restituisce un elenco di thread di commenti che corrispondono ai parametri della richiesta API.
insert POST /commentThreads Crea un nuovo commento di primo livello. Per aggiungere una risposta a un commento esistente, usa il metodo comments.insert.

Commenti

Una risorsa comment contiene informazioni su un singolo commento su YouTube. Una risorsa comment può rappresentare un commento su un video o un canale. Inoltre, il commento può essere un commento di primo livello o una risposta a un commento di primo livello.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione e l'elenco delle proprietà.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
list GET /comments Restituisce un elenco di commenti che corrispondono ai parametri della richiesta API.
setModerationStatus POST /comments/setModerationStatus Imposta lo stato di moderazione di uno o più commenti. La richiesta API deve essere autorizzata dal proprietario del canale o del video associato ai commenti.
insert POST /comments Crea una risposta a un commento esistente. Nota:per creare un commento di primo livello, utilizza il metodo commentThreads.insert.
markAsSpam POST /comments/markAsSpam Nota: questo metodo è stato deprecato e non è più supportato.
delete DELETE /comments Elimina un commento.
update PUT /comments Modifica un commento.

Categorie Guida

Una risorsa guideCategory identifica una categoria che YouTube assegna in modo algoritmico in base ai contenuti di un canale o ad altri indicatori, come la popolarità del canale. L'elenco è simile alle categorie di video, con la differenza che l'utente che ha caricato un video può assegnare una categoria di video, ma solo YouTube può assegnare una categoria di canale.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione e l'elenco delle proprietà.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
list GET /guideCategories Restituisce un elenco di categorie che possono essere associate ai canali YouTube.

I18nLingue

Una risorsa i18nLanguage identifica una lingua dell'applicazione supportata dal sito web di YouTube. Il linguaggio dell'applicazione è anche noto come lingua dell'interfaccia utente. Per il sito web di YouTube, è possibile selezionare automaticamente una lingua per l'applicazione in base alle impostazioni dell'Account Google, alla lingua del browser o alla posizione dell'IP. Un utente potrebbe anche selezionare manualmente la lingua preferita dall'interfaccia utente dal piè di pagina del sito di YouTube.

Ogni risorsa i18nLanguage identifica un codice lingua e un nome. Il codice lingua può essere utilizzato come valore del parametro hl quando si chiamano metodi API come videoCategories.list e guideCategories.list.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione e l'elenco delle proprietà.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
list GET /i18nLanguages Restituisce un elenco delle lingue di richiesta supportate dal sito web di YouTube.

I18nRegioni

Una risorsa i18nRegion identifica un'area geografica che un utente di YouTube può selezionare come regione di contenuti preferita. L'area geografica di contenuti può essere detta anche impostazioni internazionali dei contenuti. Per il sito web di YouTube, potrebbe essere selezionata automaticamente una regione di contenuti in base a euristiche quali il dominio YouTube o la località IP dell'utente. Un utente potrebbe anche selezionare manualmente la regione di contenuti che ti interessa dal piè di pagina del sito di YouTube.

Ogni risorsa i18nRegion identifica un codice di regione e un nome. Il codice regione può essere utilizzato come valore del parametro regionCode quando si chiamano metodi API come search.list, videos.list, activities.list e videoCategories.list.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione e l'elenco delle proprietà.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
list GET /i18nRegions Restituisce un elenco delle regioni di contenuti supportate dal sito web di YouTube.

Gli abbonati

Una risorsa member rappresenta l'abbonamento a un canale YouTube. Un abbonato fornisce un sostegno monetario ricorrente a un creator e riceve vantaggi speciali. Ad esempio, gli abbonati possono chattare quando il creator attiva la modalità riservata agli abbonati per una chat.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione e l'elenco delle proprietà.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
list GET /members Elenca i membri (in precedenza "sponsor") di un canale. La richiesta API deve essere autorizzata dal proprietario del canale.

Livelli degli abbonamenti

Una risorsa membershipsLevel identifica un livello di prezzo per l'autore che ha autorizzato la richiesta API.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione e l'elenco delle proprietà.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
list GET /membershipsLevels Restituisce una raccolta di zero o più risorse membershipsLevel di proprietà del canale che ha autorizzato la richiesta API. I livelli vengono restituiti in ordine di visualizzazione implicito.

Elementi playlist

Una risorsa playlistItem identifica un'altra risorsa, ad esempio un video, inclusa in una playlist. Inoltre, la risorsa playlistItem contiene dettagli sulla risorsa inclusa che si riferiscono specificamente al modo in cui la risorsa viene utilizzata nella playlist.

YouTube utilizza una playlist anche per identificare l'elenco dei video caricati da un canale, dove ogni playlistItem in quell'elenco rappresenta un video caricato. Puoi recuperare l'ID della playlist per l'elenco dal channel resource di un determinato canale. Puoi quindi utilizzare il metodo playlistItems.list nell'elenco.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione e l'elenco delle proprietà.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
delete DELETE /playlistItems Consente di eliminare un elemento della playlist.
insert POST /playlistItems Aggiunge una risorsa a una playlist.
list GET /playlistItems Restituisce una raccolta di elementi della playlist che corrispondono ai parametri della richiesta API. Puoi recuperare tutti gli elementi della playlist in una playlist specificata o recuperare uno o più elementi della playlist tramite i relativi ID univoci.
update PUT /playlistItems Modifica un elemento della playlist. Ad esempio, potresti aggiornare la posizione dell'elemento nella playlist.

Playlist

Una risorsa playlist rappresenta una playlist di YouTube. Una playlist è una raccolta di video che possono essere visualizzati in sequenza e condivisi con altri utenti. Una playlist può contenere fino a 200 video e YouTube non limita il numero di playlist create da ogni utente. Per impostazione predefinita, le playlist sono visibili pubblicamente agli altri utenti, ma possono essere pubbliche o private.

YouTube utilizza le playlist anche per identificare raccolte speciali di video per un canale, ad esempio:

  • video caricati
  • video con valutazioni positive (Mi piace)
  • Cronologia visualizzazioni
  • guarda più tardi
Per essere più specifici, questi elenchi vengono associati a un canale, ovvero una raccolta di video, playlist e altre informazioni di YouTube di una persona, un gruppo o un'azienda. Puoi recuperare gli ID playlist di ciascuno di questi elenchi dal channel resource di un determinato canale.

Puoi quindi utilizzare il metodo playlistItems.list per recuperare uno di questi elenchi. Puoi anche aggiungere o rimuovere elementi da questi elenchi richiamando i metodi playlistItems.insert e playlistItems.delete.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione e l'elenco delle proprietà.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
delete DELETE /playlists Elimina una playlist.
list GET /playlists Restituisce una raccolta di playlist che corrispondono ai parametri di richiesta API. Ad esempio, puoi recuperare tutte le playlist di proprietà dell'utente autenticato oppure una o più playlist tramite i relativi ID univoci.
insert POST /playlists Crea una playlist.
update PUT /playlists Modifica una playlist. Ad esempio, puoi modificare il titolo, la descrizione o lo stato di privacy di una playlist.

Un risultato di ricerca contiene informazioni su un video, un canale o una playlist di YouTube che corrisponde ai parametri di ricerca specificati in una richiesta API. Anche se un risultato di ricerca rimanda a una risorsa identificabile in modo univoco, come un video, non ha dati propri permanenti.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione e l'elenco delle proprietà.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
list GET /search Restituisce una raccolta di risultati di ricerca che corrispondono ai parametri di ricerca specificati nella richiesta API. Per impostazione predefinita, un set di risultati di ricerca identifica le risorse video, channel e playlist corrispondenti, ma puoi anche configurare le query per recuperare solo un tipo specifico di risorsa.

Sottoscrizioni

Una risorsa subscription contiene informazioni su un'iscrizione di un utente di YouTube. Un'iscrizione notifica un utente quando vengono aggiunti nuovi video a un canale o quando un altro utente intraprende una delle varie azioni su YouTube, come caricare un video, votare o commentare un video.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione e l'elenco delle proprietà.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
delete DELETE /subscriptions Elimina una sottoscrizione.
insert POST /subscriptions Aggiunge un'iscrizione al canale dell'utente autenticato.
list GET /subscriptions Restituisce le risorse di sottoscrizione che corrispondono ai criteri di richiesta API.

Miniature

Una risorsa thumbnail identifica le diverse dimensioni delle miniature associate a una risorsa. Tieni presente le seguenti caratteristiche delle immagini in miniatura:

  • La proprietà snippet.thumbnails di una risorsa è un oggetto che identifica le immagini in miniatura disponibili per la risorsa.
  • Una risorsa thumbnail contiene una serie di oggetti. Il nome di ciascun oggetto (default, medium, high e così via) si riferisce alle dimensioni dell'immagine in miniatura.
  • Tipi di risorse diversi possono supportare dimensioni delle immagini in miniatura diverse.
  • Tipi di risorse diversi possono definire dimensioni diverse per le miniature con lo stesso nome. Ad esempio, l'immagine in miniatura default per una risorsa video in genere misura 120 x 90 px, mentre l'immagine in miniatura default per una risorsa channel misura in genere 88 x 88 px.
  • Risorse dello stesso tipo potrebbero comunque avere dimensioni in miniatura diverse per determinate immagini, a seconda della risoluzione dell'immagine originale o dei contenuti caricati su YouTube. Ad esempio, un video HD potrebbe supportare miniature con risoluzione più elevata rispetto ai video non HD.
  • Ogni oggetto che contiene informazioni sulle dimensioni di un'immagine in miniatura ha una proprietà width e una proprietà height. Tuttavia, le proprietà di larghezza e altezza potrebbero non essere restituite per l'immagine.
  • Se un'immagine in miniatura caricata non corrisponde alle dimensioni richieste, l'immagine viene ridimensionata in modo da corrispondere alle dimensioni corrette senza modificare le proporzioni. L'immagine non viene ritagliata, ma potrebbe includere delle barre nere per correggere le dimensioni.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione e l'elenco delle proprietà.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
set POST /thumbnails/set Carica una miniatura personalizzata per il video su YouTube e la imposta per un video.

Motivi del report sugli abusi video

Una risorsa videoAbuseReportReason contiene informazioni sul motivo per cui un video potrebbe essere segnalato per la presenza di contenuti offensivi. Quando la tua applicazione chiama il metodo videos.reportAbuse per segnalare un video illecito, la richiesta utilizza le informazioni di una risorsa videoAbuseReportReason per identificare il motivo per cui il video viene segnalato.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione e l'elenco delle proprietà.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
list GET /videoAbuseReportReasons Recupera un elenco delle motivazioni che possono essere utilizzate per segnalare video offensivi.

Categorie di video

Una risorsa videoCategory identifica una categoria che è stata o potrebbe essere associata ai video caricati.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione e l'elenco delle proprietà.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
list GET /videoCategories Restituisce un elenco di categorie che possono essere associate ai video di YouTube.

Video

Una risorsa video rappresenta un video di YouTube.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione e l'elenco delle proprietà.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
insert POST /videos Carica un video su YouTube e, se vuoi, imposta i metadati del video.
list GET /videos Restituisce un elenco di video che corrispondono ai parametri della richiesta API.
delete DELETE /videos Elimina un video di YouTube.
update PUT /videos Consente di aggiornare i metadati di un video.
rate POST /videos/rate Aggiungi una valutazione di Mi piace o Non mi piace a un video o rimuovi una valutazione da un video.
getRating GET /videos/getRating Recupera le valutazioni assegnate dall'utente autorizzato a un elenco di video specificati.
reportAbuse POST /videos/reportAbuse Segnalare un video perché include contenuti illeciti.

Filigrane

Una risorsa watermark identifica un'immagine che viene visualizzata durante le riproduzioni dei video di un canale specifico. Puoi anche specificare un canale di destinazione a cui verrà collegata l'immagine, nonché dettagli sui tempi che determinano quando verrà visualizzata la filigrana durante le riproduzioni del video e per quanto tempo sarà visibile.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione e l'elenco delle proprietà.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
set POST /watermarks/set Carica un'immagine filigrana su YouTube e la imposta per un canale.
unset POST /watermarks/unset Consente di eliminare l'immagine della filigrana di un canale.