Sponsors: list

Nota: questo metodo è stato ritirato il 31 marzo 2020. È stato sostituito dal metodo members.list. Puoi trovare informazioni su questo metodo nella documentazione dell'API di dati di YouTube.

Il metodo sponsors.list non sarà più supportato a partire dal 30 settembre 2020. I client API devono aggiornare le chiamate al metodo sponsors.list per utilizzare invece il metodo members.list.

Elenca i membri (in precedenza "sponsor") di un canale. La richiesta API deve essere autorizzata dal proprietario del canale.

Casi d'uso comuni

Richiesta

Richiesta HTTP

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

Autorizzazione

Questa richiesta richiede l'autorizzazione con almeno uno dei seguenti ambiti (scopri di più su autenticazione e autorizzazione).

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

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 le parti della risorsa sponsor che saranno incluse nella risposta dell'API. I valori supportati sono id e snippet.
Parametri facoltativi
filter string
Il parametro filter specifica gli sponsor del canale da restituire. Il valore predefinito è newest.

I valori accettati sono:
  • all – Restituisci tutti gli sponsor, dal più recente al meno recente.
  • newest - Restituisci una pagina degli sponsor più recenti. Le richieste successive utilizzando l'nextPageToken consentono di recuperare gli abbonati più recenti al momento della registrazione.
maxResults unsigned integer
Il parametro maxResults specifica il numero massimo di articoli che devono essere restituiti nel set di risultati. I valori accettati sono compresi tra 0 e 50. Il valore predefinito è 5.
pageToken string
Il parametro pageToken identifica una pagina specifica da restituire del set di risultati. In una risposta dell'API, le proprietà nextPageToken e prevPageToken identificano altre pagine che è possibile recuperare.

Corpo della richiesta

Non fornire il corpo della richiesta quando chiami questo metodo.

Risposta

Se l'esito è positivo, questo metodo restituisce un corpo della risposta con la seguente struttura:

{
  "kind": "youtube#sponsorListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    sponsor 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#sponsorListResponse.
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.
pageInfo object
L'oggetto pageInfo incapsula le informazioni sul 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 sponsor 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 ulteriori dettagli, consulta la documentazione relativa ai messaggi di errore.

Tipo di errore Dettagli errore Descrizione
forbidden (403) insufficientPermissions Non disponi delle autorizzazioni necessarie per visualizzare gli sponsor del canale.
invalidValue (400) invalidValueInRequest La richiesta contiene un valore non valido.
invalidValue (400) sponsorshipNotEnabledForChannelId Le sponsorizzazioni non sono attivate sul canale.

Prova.

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