LiveBroadcasts: list

Restituisce un elenco di trasmissioni di YouTube che corrispondono ai parametri di richiesta dell'API.

Casi d'uso comuni

Richiesta

Richiesta HTTP

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

Autorizzazione

Questa richiesta richiede l'autorizzazione con almeno uno degli ambiti seguenti. Per saperne di più su autenticazione e autorizzazione, consulta Implementazione dell'autenticazione OAuth 2.0.

Ambito
https://www.googleapis.com/auth/youtube.readonly
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Parametri

La seguente tabella 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 liveBroadcast che verranno incluse nella risposta dell'API. I nomi part che puoi includere nel valore del parametro sono id, snippet, contentDetails, monetizationDetails e status.
Filtri (specifica esattamente uno dei seguenti parametri)
broadcastStatus string
Il parametro broadcastStatus filtra la risposta dell'API in modo da includere solo le trasmissioni con lo stato specificato.

I valori accettati sono:
  • active - Restituire le trasmissioni live correnti.
  • all - Restituisce tutte le trasmissioni.
  • completed: restituisci le trasmissioni già terminate.
  • upcoming: restituisce le trasmissioni non ancora iniziate.
id string
Il parametro id specifica un elenco separato da virgole di ID trasmissione di YouTube che identificano le trasmissioni recuperate. In una risorsa liveBroadcast, la proprietà id specifica l'ID della trasmissione.
mine boolean
Il parametro mine può essere utilizzato per indicare all'API di restituire solo le trasmissioni di proprietà dell'utente autenticato. Imposta il valore del parametro su true per recuperare solo le tue trasmissioni.
Parametri facoltativi
broadcastType string
Il parametro broadcastType filtra la risposta dell'API per includere solo le trasmissioni con il tipo specificato. Il parametro deve essere utilizzato nelle richieste che impostano il parametro mine su true o che utilizzano il parametro broadcastStatus. Il valore predefinito è event.

I valori accettati sono:
    .
  • all - Restituisce tutte le trasmissioni.
  • event: restituisce solo le trasmissioni di eventi programmati.
  • persistent: restituisce solo gli annunci permanenti.
maxResults unsigned integer
Il parametro maxResults specifica il numero massimo di elementi che devono essere restituiti nel set di risultati. I valori accettati sono compresi tra 0 e 50 (inclusi). Il valore predefinito è 5.
onBehalfOfContentOwner string
Questo parametro può essere utilizzato solo in una richiesta autorizzata opportunamente.
Nota: questo parametro è destinato esclusivamente ai partner della rete di contenuti di YouTube.

Il parametro onBehalfOfContentOwner indica che le credenziali di autorizzazione della richiesta identificano un utente del sistema di gestione dei contenuti (CMS) di YouTube che agisce per conto del proprietario dei contenuti specificato nel valore del parametro. Questo parametro è destinato ai partner per i contenuti di YouTube che possiedono e gestiscono molti canali YouTube diversi. Consente ai proprietari dei contenuti di eseguire l'autenticazione una sola volta e di accedere a tutti i dati dei loro video e del loro canale, 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 opportunamente.
Nota: questo parametro è destinato esclusivamente ai partner della rete di contenuti di YouTube.

Il parametro onBehalfOfContentOwnerChannel specifica l'ID del canale YouTube 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 nel 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 della rete di contenuti di YouTube che possiedono e gestiscono molti canali YouTube diversi. Consente ai proprietari dei contenuti di eseguire l'autenticazione 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 è possibile recuperare.

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#liveBroadcastListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveBroadcast 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#liveBroadcastListResponse.
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 paging 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 trasmissioni che soddisfano i 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 il messaggio di errore.

Tipo di errore Dettagli dell'errore Descrizione
insufficientPermissions insufficientLivePermissions La richiesta non è autorizzata a recuperare la trasmissione live.
insufficientPermissions liveStreamingNotEnabled L'utente che ha autorizzato la richiesta non è abilitato a trasmettere video in live streaming su YouTube. Per ulteriori informazioni, vedi Idoneità alle funzionalità.

Prova

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