Members: list

Observação: esse endpoint só pode ser usado por criadores de conteúdo individuais para fazer solicitações do próprio canal do YouTube com Clubes dos Canais ativados. Entre em contato com seu representante do Google ou do YouTube para solicitar acesso.

Lista os membros (antes conhecidos como "patrocinadores") de um canal. A solicitação de API precisa ser autorizada por o proprietário do canal.

Impacto na cota: Uma chamada para esse método tem um custo de cota de 2 unidades.

Solicitação

Solicitação HTTP

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

Autorização

Esta solicitação requer autorização com o seguinte escopo:

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

Parâmetros

A tabela a seguir lista os parâmetros compatíveis com essa consulta. Todos os parâmetros listados são os parâmetros de consulta.

Parâmetros
Parâmetros obrigatórios
part string
O parâmetro part especifica as propriedades do recurso member que serão incluídas na resposta da API. Defina o valor do parâmetro como snippet.
Parâmetros opcionais
mode string
O parâmetro mode indica quais membros serão incluídos em a resposta da API. Defina o valor do parâmetro como um dos seguintes:
  • all_current (padrão) – lista os membros atuais, do mais recente ao mais antigo. Quando este valor é usado, o final da lista é atingido quando a resposta da API não contém um nextPageToken.
  • updates - lista apenas os membros que entraram ou fizeram upgrade desde a chamada de API anterior. A primeira chamada inicia um novo fluxo de atualizações, mas não retorna nenhum membro. Para começar a recuperar as atualizações de associação, é necessário consultar o endpoint usando o nextPageToken na frequência desejada.

    Quando esse valor é usado, a resposta da API sempre contém um nextPageToken.
maxResults unsigned integer
O parâmetro maxResults especifica o número máximo de itens que precisam ser retornados no conjunto de resultados. Os valores aceitáveis são 0 a 1000, inclusive. O valor padrão é 5.
pageToken string
O parâmetro pageToken identifica uma página específica no conjunto de resultados que precisa ser retornada. O token é específico para o mode usado com a solicitação de API original. Portanto, não é possível usar um token de página recuperado com um modo para mudar para outro.
hasAccessToLevel string
O valor do parâmetro hasAccessToLevel é um ID de nível que especifica o nível mínimo que os membros no conjunto de resultados precisam ter.
filterByMemberChannelId string
O parâmetro filterByMemberChannelId especifica uma lista de IDs de canais separados por vírgulas que podem ser usados para verificar o status de associação de usuários específicos. Por exemplo, UC_1,UC_2,UC_3. É possível especificar um máximo de 100 canais por chamada.

Corpo da solicitação

Não forneça um corpo de solicitação ao chamar este método.

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

{
  "kind": "youtube#memberListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    member Resource
  ]
}

Propriedades

A tabela a seguir define as propriedades que aparecem neste recurso:

Propriedades
kind string
Identifica o tipo de recurso da API. O valor será youtube#memberListResponse.
etag etag
O Etag desse recurso.
nextPageToken string
O token que pode ser usado como o valor do parâmetro pageToken para recuperar a próxima página no conjunto de resultados. Os tokens de página podem expirar, e o aplicativo precisa descartar o token e chamar a API sem um pageToken para iniciar uma nova solicitação.
pageInfo object
O objeto pageInfo encapsula informações de paginação para o conjunto de resultados.
pageInfo.totalResults integer
O número total de resultados no conjunto de resultados.
pageInfo.resultsPerPage integer
O número de resultados incluídos na resposta da API.
items[] list
Uma lista de membros que correspondem aos critérios da solicitação.

Erros

A tabela a seguir identifica as mensagens de erro que a API pode retornar em resposta a uma chamada para esse método. Consulte a documentação mensagem de erro para mais detalhes.

Tipo de erro Detalhe do erro Descrição
badRequest (400) channelMembershipsNotEnabled O canal do criador de conteúdo que autoriza a solicitação não tem os Clubes dos Canais ativados.
badRequest (400) invalidMode O valor do parâmetro mode é inválido. Esse erro pode ocorrer se o parâmetro pageToken especificar um token que foi recuperado usando um modo diferente do especificado.
badRequest (400) invalidPageToken O valor do parâmetro pageToken é inválido. Esse erro pode ocorrer se o token de página usado na solicitação tiver expirado ou não for reconhecido.
badRequest (400) invalidHasAccessToLevel O valor do parâmetro hasAccessToLevel é inválido. Não há nenhum nível com o especificado id.
badRequest (400) invalidFilterByMemberChannelId O valor do parâmetro filterByMemberChannelId é inválido. Esse erro ocorre se o filterByMemberChannelId valor do parâmetro especificar mais de 100 canais.