Members: list

Nota: questo endpoint può essere utilizzato solo dai singoli creator per effettuare richieste per il proprio canale YouTube in cui sono abilitati gli abbonamenti al canale. Contatta il tuo rappresentante di Google o YouTube per richiedere l'accesso.

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

Impatto della 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 saranno incluse nella risposta dell'API. Imposta il valore del parametro su snippet.
Parametri facoltativi
mode string
Il parametro mode indica quali membri saranno inclusi nella risposta dell'API. Imposta il valore del parametro su uno dei seguenti valori:
  • all_current (predefinito): elenca i membri attuali, dal più recente al meno recente. Quando viene utilizzato questo valore, la fine dell'elenco viene raggiunta quando la risposta dell'API non contiene un nextPageToken.
  • updates: elenca solo i membri che si sono uniti o hanno eseguito l'upgrade dopo la chiamata API precedente. Tieni presente che la prima chiamata avvia un nuovo flusso di aggiornamenti, ma in realtà non restituisce alcun membro. Per iniziare a recuperare gli aggiornamenti delle iscrizioni, 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 articoli che devono essere restituiti nel set di risultati. I valori accettati sono compresi tra 0 e 1000. Il valore predefinito è 5.
pageToken string
Il parametro pageToken identifica una pagina specifica che deve essere restituita nel set di risultati. Il token è specifico per mode utilizzato con la richiesta API originale, quindi non puoi utilizzare un token di pagina recuperato con una modalità per passare successivamente a un'altra modalità.
hasAccessToLevel string
Il valore parametro hasAccessToLevel è un ID livello che specifica il livello minimo che deve avere i membri del set di risultati.
filterByMemberChannelId string
Il parametro filterByMemberChannelId specifica un elenco separato da virgole di ID canale che possono essere utilizzati per controllare lo stato dell'iscrizione 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 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#memberListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    member 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#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 l'applicazione deve eliminare il token e chiamare l'API senza pageToken per avviare una nuova richiesta.
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 membri 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
badRequest (400) channelMembershipsNotEnabled Gli abbonamenti al canale non sono attivi per il canale del creator che autorizza la richiesta.
badRequest (400) invalidMode Il valore del parametro mode non è valido. Questo errore può verificarsi se il parametro pageToken specifica un token che è stato 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 viene riconosciuto.
badRequest (400) invalidHasAccessToLevel Il valore del parametro hasAccessToLevel non è valido. Non esiste alcun livello con il valore id specificato.
badRequest (400) invalidFilterByMemberChannelId Il valore del parametro filterByMemberChannelId non è valido. Questo errore si verifica se il valore del parametro filterByMemberChannelId specifica più di 100 canali.