Subscriptions: list

Restituisce le risorse di abbonamento che corrispondono ai criteri della richiesta API.

Impatto sulla quota: una chiamata a questo metodo ha un costo di quota di 1 unità.

Casi d'uso comuni

Richiesta

Richiesta HTTP

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

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 subscription che la risposta dell'API includerà.

Se il parametro identifica una proprietà che contiene proprietà secondarie, queste verranno incluse nella risposta. Ad esempio, in una risorsa subscription, la proprietà snippet contiene altre proprietà, come un titolo visualizzato per l'abbonamento. Se imposti part=snippet, la risposta dell'API conterrà anche tutte queste proprietà nidificate.

Il seguente elenco contiene i part nomi che puoi includere nel valore del parametro:
  • contentDetails
  • id
  • snippet
  • subscriberSnippet
Filtri (specifica esattamente uno dei seguenti parametri)
channelId string
Il parametro channelId specifica un ID canale YouTube. L'API restituirà solo gli abbonamenti di quel canale.
id string
Il parametro id specifica un elenco separato da virgole degli ID abbonamento YouTube per le risorse che vengono recuperate. In una risorsa subscription, la proprietà id specifica l'ID abbonamento YouTube.
mine boolean
Questo parametro può essere utilizzato solo in una richiesta autorizzata correttamente. Imposta il valore di questo parametro su true per recuperare un feed degli abbonamenti dell'utente autenticato.
myRecentSubscribers boolean
Questo parametro può essere utilizzato solo in una richiesta autorizzata correttamente. Imposta il valore di questo parametro su true per recuperare un feed degli abbonati dell'utente autenticato in ordine cronologico inverso (dal più recente al meno recente).

Tieni presente che il numero massimo di abbonati restituiti tramite questa API potrebbe essere limitato.
mySubscribers boolean
Questo parametro può essere utilizzato solo in una richiesta autorizzata correttamente. Imposta il valore di questo parametro su true per recuperare un feed degli abbonati dell'utente autenticato senza un ordine specifico. Tieni presente che il numero massimo di abbonati restituiti tramite questa API potrebbe essere limitato.
Parametri facoltativi
forChannelId string
Il parametro forChannelId specifica un elenco separato da virgole di ID canale. La risposta dell'API conterrà solo gli abbonamenti corrispondenti a questi canali.
maxResults unsigned integer
Il parametro maxResults specifica il numero massimo di elementi che devono essere restituiti nel set di risultati. I valori accettabili sono da 0 a 50, inclusi. Il valore predefinito è 5.
onBehalfOfContentOwner string
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 dei contenuti di autenticarsi una sola volta e di accedere a tutti i dati di video e 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.
onBehalfOfContentOwnerChannel string
Questo parametro può essere utilizzato solo in una richiesta autorizzata correttamente. Nota: questo parametro è destinato esclusivamente ai partner di contenuti di YouTube.

Il parametro onBehalfOfContentOwnerChannel specifica l'ID canale YouTube del canale 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 dal 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 di contenuti di YouTube che possiedono e gestiscono molti canali YouTube diversi. Consente ai proprietari dei contenuti di autenticarsi 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.
order string
Il parametro order specifica il metodo che verrà utilizzato per ordinare le risorse nella risposta dell'API. Il valore predefinito è SUBSCRIPTION_ORDER_RELEVANCE.

I valori accettabili sono:
  • alphabetical : ordina alfabeticamente.
  • relevance : ordina per pertinenza.
  • unread : ordina in base all'ordine delle attività.
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 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#subscriptionListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    subscription Resource
  ]
}

Proprietà

La tabella seguente definisce le proprietà che appaiono in questa risorsa:

Proprietà
kind string
Identifica il tipo di risorsa API. Il valore sarà youtube#subscriptionListResponse.
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 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 abbonamenti che corrispondono ai 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 la documentazione sui messaggi di errore.

Tipo di errore Dettagli errore Descrizione
forbidden (403) accountClosed Impossibile recuperare gli abbonamenti perché l'account dell'abbonato è chiuso.
forbidden (403) accountSuspended Impossibile recuperare gli abbonamenti perché l'account dell'abbonato è sospeso.
forbidden (403) subscriptionForbidden Il richiedente non è autorizzato ad accedere agli abbonamenti richiesti.
notFound (404) subscriberNotFound Impossibile trovare l'abbonato identificato con la richiesta.

Prova

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