API Reference

L'API di dati di YouTube ti consente di incorporare funzioni eseguite normalmente sul sito web di YouTube nel tuo sito web o nella tua applicazione. I seguenti elenchi identificano i diversi tipi di risorse che puoi recuperare utilizzando l'API. L'API supporta anche i 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 rappresenta un tipo di elemento che comprende parte dell'esperienza su YouTube, ad esempio un video, una playlist o un abbonamento. Per ogni tipo di risorsa, la guida elenca una o più rappresentazioni di 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

I seguenti requisiti si applicano alle richieste relative all'API di dati di YouTube:

  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 dell'API per il recupero delle risorse potrebbero supportare parametri che richiedono l'autorizzazione o contenere metadati aggiuntivi quando le richieste sono autorizzate. Ad esempio, una richiesta per recuperare i video caricati da un utente potrebbe 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 query access_token come questo: ?access_token=oauth2-token
    • Utilizza l'intestazione HTTP Authorization come segue: Authorization: Bearer oauth2-token

    Le istruzioni complete per l'implementazione dell'autenticazione OAuth 2.0 nella tua applicazione sono disponibili 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 delle risorse 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 di 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 codificati di YouTube. Una traccia di sottotitoli codificati è associata esattamente a un video di YouTube.

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

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
delete DELETE /captions Elimina la traccia di sottotitoli specificata.
download GET /captions/id Scarica una traccia di sottotitoli codificati. La traccia dei sottotitoli codificati viene restituita nel formato originale, a meno che la richiesta non specifichi un valore per il parametro tfmt e nella sua 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 Aggiorna una traccia di sottotitoli codificati. Durante l'aggiornamento di una traccia di sottotitoli codificati, puoi modificarne lo stato di bozza, caricare un nuovo file di sottotitoli codificati per la traccia o eseguire entrambe le operazioni.

ChannelBanners

Una risorsa channelBanner contiene l'URL che useresti per impostare un'immagine appena caricata come immagine banner per un canale.

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

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
insert POST /channelBanners/insert Carica l'immagine del banner di un 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 dell'immagine binaria su YouTube. L'immagine deve avere proporzioni 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.

ChannelSections

Una risorsa channelSection contiene informazioni su un insieme di video che un canale ha scelto di mettere in primo piano. Ad esempio, una sezione potrebbe includere gli ultimi caricamenti, 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 in una visualizzazione Sfoglia e non in una visualizzazione feed. Per consentire a un canale di mostrare 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 delle risorse 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 di canale al canale dell'utente autenticato. Un canale può creare un massimo di 10 sezioni.
list GET /channelSections Restituisce un elenco di channelSection risorse che corrispondono ai criteri della richiesta API.
update PUT /channelSections Aggiorna la sezione di un canale.

Canali

Una risorsa channel contiene informazioni su un canale YouTube.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione delle risorse 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 al momento questo metodo supporta solo gli aggiornamenti degli oggetti brandingSettings e invideoPromotion della risorsa channel e delle relative proprietà figlio.

CommentThreads

Una risorsa commentThread contiene informazioni su un thread di commenti di YouTube, composto da un commento di primo livello e delle eventuali risposte a quel commento. Una risorsa commentThread può rappresentare commenti su un video o 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. Devi utilizzare il metodo comments.list se vuoi recuperare tutte le risposte a un commento specifico. Inoltre, tieni presente che alcuni commenti non hanno risposte.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione delle risorse 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 invece il metodo comments.insert.

Commenti

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

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione delle risorse 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.

GuideCategories

Una risorsa guideCategory identifica una categoria che YouTube assegna tramite un algoritmo 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ò assegnarle una categoria di canale.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione delle risorse 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 è possibile associare ai canali YouTube.

I18nLanguages

Una risorsa i18nLanguage identifica una lingua dell'applicazione supportata dal sito web di YouTube. La lingua dell'applicazione è detta anche lingua UI. Per il sito web di YouTube, la lingua dell'applicazione potrebbe essere selezionata automaticamente in base alle impostazioni dell'Account Google, alla lingua del browser o alla posizione dell'IP. Un utente può anche selezionare manualmente la lingua desiderata per l'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 delle risorse e l'elenco delle proprietà.

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

I18nRegions

Una risorsa i18nRegion identifica un'area geografica che un utente di YouTube può selezionare come regione di contenuti preferita. La regione di contenuti può essere definita anche impostazione internazionale 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à dell'IP dell'utente. Un utente può anche selezionare manualmente la regione di contenuti desiderata dal piè di pagina del sito di YouTube.

Ogni risorsa i18nRegion identifica un codice 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 delle risorse 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.

Membri

Una risorsa member rappresenta l'abbonamento a un canale YouTube. Un abbonato fornisce un sostegno economico 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 maggiori informazioni su questa risorsa, consulta la relativa rappresentazione delle risorse 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.

MembershipsLevels

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

Per maggiori informazioni su questa risorsa, consulta la relativa rappresentazione delle risorse 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.

PlaylistItems

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 riguardano specificamente il modo in cui la risorsa viene utilizzata nella playlist.

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

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

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
delete DELETE /playlistItems Elimina 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 può essere visualizzata in sequenza e condivisa 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.

Inoltre, YouTube utilizza le playlist 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 sono associati a un canale, ovvero una raccolta di video, playlist e altre informazioni di YouTube relativi a una persona, un gruppo o una società. 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 chiamando i metodi playlistItems.insert e playlistItems.delete.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione delle risorse 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 della richiesta API. Ad esempio, puoi recuperare tutte le playlist di proprietà dell'utente autenticato oppure puoi recuperare una o più playlist in base ai relativi ID univoci.
insert POST /playlists Crea una playlist.
update PUT /playlists Modifica una playlist. Ad esempio, potresti 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 dispone di dati permanenti propri.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione delle risorse 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 query 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.

Abbonamenti

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 esegue una delle varie azioni su YouTube, ad esempio carica un video, vota un video o commenta un video.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione delle risorse 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 abbonamento che corrispondono ai criteri della richiesta API.

Miniature

Una risorsa thumbnail identifica le diverse dimensioni delle immagini in miniatura 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 in questione.
  • Una risorsa thumbnail contiene una serie di oggetti. Il nome di ciascun oggetto (default, medium, high e così via) fa riferimento alle dimensioni dell'immagine in miniatura.
  • I diversi tipi di risorse 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 di solito 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 diverse in miniatura per determinate immagini, a seconda della risoluzione dell'immagine originale o dei contenuti caricati su YouTube. Ad esempio, un video HD potrebbe supportare miniature a risoluzione più elevata rispetto ai video non HD.
  • Ogni oggetto che contiene informazioni sulle dimensioni di una miniatura ha una proprietà width e una proprietà height. Tuttavia, le proprietà di larghezza e altezza potrebbero non essere restituite per l'immagine in questione.
  • Se un'immagine in miniatura caricata non corrisponde alle dimensioni richieste, l'immagine viene ridimensionata in modo da corrispondere alle dimensioni corrette senza modificarne le proporzioni. L'immagine non viene ritagliata, ma potrebbe includere barre nere per cui le dimensioni sono corrette.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione delle risorse 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 un video su YouTube e la imposta come video.

VideoAbuseReportReasons

Una risorsa videoAbuseReportReason contiene informazioni su un motivo per cui un video viene segnalato per contenuti illeciti. Quando l'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 delle risorse e l'elenco delle proprietà.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/youtube/v3
list GET /videoAbuseReportReasons Recupera un elenco dei motivi che è possibile utilizzare per segnalare i video illeciti.

VideoCategories

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 delle risorse 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 è possibile associare ai video di YouTube.

Video

Una risorsa video rappresenta un video di YouTube.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione delle risorse 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 relativi metadati.
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 che l'utente autorizzato ha dato a un elenco di video specificati.
reportAbuse POST /videos/reportAbuse Segnalare un video in quanto 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 il momento in cui la filigrana verrà visualizzata durante le riproduzioni video e la durata della sua visibilità.

Per ulteriori informazioni su questa risorsa, consulta la relativa rappresentazione delle risorse 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 della filigrana su YouTube e la imposta per un canale.
unset POST /watermarks/unset Elimina l'immagine della filigrana di un canale.