Members: list

Nota: questo endpoint può essere utilizzato solo dai singoli creator per effettuare richieste per il proprio canale YouTube con abbonamenti al canale attivati. Per richiedere l'accesso, contatta il tuo rappresentante di Google o YouTube.

Elenca gli abbonati (precedentemente noti come "sponsor") di un canale. La richiesta API deve essere autorizzata da il proprietario del canale.

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

Richiesta

Richiesta HTTP

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

Autorizzazione

Questa richiesta richiede l'autorizzazione con il seguente ambito:

Ambito
https://www.googleapis.com/auth/youtube.channel-memberships.creator

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 proprietà della risorsa member che verranno incluse nella risposta dell'API. Imposta il valore del parametro su snippet.
Parametri facoltativi
mode string
Il parametro mode indica quali abbonati verranno inclusi nella risposta dell'API. Imposta il valore del parametro su uno dei seguenti valori:
  • all_current (valore predefinito): elenca gli abbonati attuali, dal più recente al più vecchio. Quando questo valore viene utilizzato, la fine dell'elenco viene raggiunta quando la risposta dell'API non contiene un nextPageToken.
  • updates - elenca solo gli abbonati che hanno effettuato l'iscrizione o l'upgrade dall'ultima chiamata API. Tieni presente che la prima chiamata avvia un nuovo flusso di aggiornamenti, ma non restituisce effettivamente abbonati. Per iniziare a recuperare gli aggiornamenti degli abbonamenti, devi eseguire il polling dell' endpoint utilizzando nextPageToken alla frequenza desiderata.

    Tieni presente che, quando viene utilizzato questo valore, la risposta dell'API contiene sempre un nextPageToken.
maxResults unsigned integer
Il parametro maxResults specifica il numero massimo di elementi da restituire nel set di risultati. I valori accettabili sono compresi tra 0 e 1000, inclusi. Il valore predefinito è 5.
pageToken string
Il parametro pageToken identifica una pagina specifica del set di risultati da restituire. Il token è specifico per la mode utilizzata con la richiesta API originale, pertanto non puoi utilizzare un token di pagina recuperato con una modalità per passare successivamente a una modalità diversa.
hasAccessToLevel string
Il valore parametro hasAccessToLevel è un ID di livello che specifica il livello minimo che i membri nel set di risultati devono avere.
filterByMemberChannelId string
Il parametro filterByMemberChannelId specifica un elenco di ID canale separati da virgole che possono essere utilizzati per controllare lo stato di abbonamento di utenti specifici. Ad esempio, UC_1,UC_2,UC_3. È possibile specificare un massimo di 100 canali per chiamata.

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#memberListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    member 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#memberListResponse.
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. I token di pagina possono scadere e la tua applicazione deve eliminare il token e chiamare l'API senza un pageToken per avviare una nuova richiesta.
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 abbonati 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 dei messaggi di errore.

Tipo di errore Dettagli errore Descrizione
badRequest (400) channelMembershipsNotEnabled Il canale del creator che autorizza la richiesta non ha gli abbonamenti al canale attivati.
badRequest (400) invalidMode Il valore del parametro mode non è valido. Questo errore potrebbe verificarsi se il pageToken parametro specifica un token recuperato utilizzando una modalità diversa da quella specificata.
badRequest (400) invalidPageToken Il valore del parametro pageToken non è valido. Questo errore può verificarsi se il token di pagina utilizzato nella richiesta è scaduto o non è riconosciuto.
badRequest (400) invalidHasAccessToLevel Il valore del parametro hasAccessToLevel non è valido. Non esiste un livello con l'`id` specificato id.
badRequest (400) invalidFilterByMemberChannelId Il valore del parametro filterByMemberChannelId non è valido. Questo errore si verifica se il filterByMemberChannelId valore parametro specifica più di 100 canali.