Members: list

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

Elenca i membri (precedentemente noti come "sponsor") per 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à.

Risorse richieste:

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

Nella tabella seguente sono elencati i parametri supportati dalla query. Tutti i parametri elencati sono parametri di ricerca.

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 membri saranno inclusi nella risposta dell'API. Imposta il valore del parametro su uno dei seguenti valori:
  • all_current (valore predefinito) - Elenca i membri attuali, dal più recente al meno recente. Se utilizzi questo valore, viene raggiunta la fine dell'elenco quando la risposta API non contiene un nextPageToken.
  • updates: elenca solo i membri che si sono abbonati o hanno eseguito l'upgrade dalla precedente chiamata API. Tieni presente che la prima chiamata avvia un nuovo flusso di aggiornamenti, ma in realtà non restituisce alcun membro. Per avviare il recupero degli aggiornamenti dell'appartenenza, devi eseguire il polling dell'endpoint utilizzando nextPageToken con la frequenza desiderata.

    Tieni presente che, quando viene utilizzato questo valore, la risposta dell'API contiene sempre nextPageToken.
maxResults unsigned integer
Il parametro maxResults specifica il numero massimo di elementi che devono essere restituiti nel set di risultati. I valori accettabili sono compresi tra 0 e 1000 compresi. Il valore predefinito è 5.
pageToken string
Il parametro pageToken identifica una pagina specifica nel set di risultati che deve essere restituita. Il token è specifico per il mode utilizzato 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 livello che specifica il livello minimo che dovrebbero avere i membri nel set di risultati.
filterByMemberChannelId string
Il parametro filterByMemberChannelId specifica un elenco separato da virgole di ID canale che possono essere utilizzati per verificare lo stato di appartenenza 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 di 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 vengono 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 dovrebbe rilasciare 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 dei 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 maggiori dettagli, consulta la documentazione sui messaggi di errore.

Tipo di errore Dettagli errore Descrizione
badRequest (400) channelMembershipsNotEnabled Sul canale del creator che autorizza la richiesta non sono abilitati gli abbonamenti al canale.
badRequest (400) invalidMode Il valore parametro mode non è valido. Questo errore potrebbe verificarsi se il parametro pageToken specifica un token recuperato con una modalità diversa da quella specificata.
badRequest (400) invalidPageToken Il valore 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 parametro hasAccessToLevel non è valido. Non è presente alcun livello con il valore id specificato.
badRequest (400) invalidFilterByMemberChannelId Il valore parametro filterByMemberChannelId non è valido. Questo errore si verifica se il valore parametro filterByMemberChannelId specifica più di 100 canali.