Subscriptions: list

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

Impatto della quota: una chiamata a questo metodo ha un costo della 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à delle risorse subscription che verranno incluse nella risposta dell'API.

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

Il seguente elenco contiene i nomi part che puoi includere nel valore parametro:
  • contentDetails
  • id
  • snippet
  • subscriberSnippet
Filtri (specificare esattamente uno dei seguenti parametri)
channelId string
Il parametro channelId specifica un ID canale YouTube. L'API restituirà solo le iscrizioni del canale.
id string
Il parametro id specifica un elenco separato da virgole degli ID iscrizione di YouTube per le risorse recuperate. In una risorsa subscription, la proprietà id specifica l'ID iscrizione di 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 delle iscrizioni degli utenti autenticati.
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).

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 particolare. 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 di ID canale separati da virgole. La risposta dell'API conterrà solo le iscrizioni corrispondenti a quei canali.
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.
onBehalfOfContentOwner string
Nota:questo parametro è destinato esclusivamente ai partner dei 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 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 effettuare l'autenticazione una volta sola e ottenere l'accesso a tutti i dati relativi a video e canali, senza dover fornire 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 dei 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 dal parametro onBehalfOfContentOwner. Infine, il canale specificato dal valore parametro onBehalfOfContentOwnerChannel deve essere collegato al proprietario dei contenuti specificato dal parametro onBehalfOfContentOwner.

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 volta ed eseguire azioni per conto del canale specificato nel valore 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 accettati sono:
  • alphabetical – Ordina in ordine alfabetico.
  • relevance: ordina per pertinenza.
  • unread: ordina in base all'ordine delle attività.
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#subscriptionListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    subscription 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#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 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 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 ulteriori dettagli, consulta la documentazione relativa ai messaggi di errore.

Tipo di errore Dettagli errore Descrizione
forbidden (403) accountClosed Impossibile recuperare le iscrizioni perché l'account dell'abbonato è chiuso.
forbidden (403) accountSuspended Impossibile recuperare le iscrizioni 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.

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