Members

Observação: a partir de 31 de março de 2020, o endpoint members substitui o endpoint sponsors, que foi descontinuado e não será mais compatível a partir de 30 de setembro de 2020. Os clientes da API precisam atualizar as chamadas para o método sponsors.list e usar o método members.list.

Esse endpoint só pode ser usado por criadores de conteúdo individuais para fazer solicitações para o próprio canal do YouTube com assinaturas ativas. Entre em contato com seu representante do Google ou do YouTube para solicitar acesso.

Um recurso member representa um membro de um canal do YouTube. Um membro oferece apoio financeiro recorrente a um criador de conteúdo e recebe benefícios especiais. Por exemplo, os membros podem participar de um chat quando o criador ativa o modo exclusivo para membros.

Métodos

A API oferece suporte aos seguintes métodos para recursos member:

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

Representação de recurso

A estrutura JSON a seguir mostra o formato de um recurso member:

{
  "kind": "youtube#member",
  "etag": etag,
  "snippet": {
    "creatorChannelId": string,
    "memberDetails": {
      "channelId": string,
      "channelUrl": string,
      "displayName": string,
      "profileImageUrl": string
    },
    "membershipsDetails": {
      "highestAccessibleLevel": string,
      "highestAccessibleLevelDisplayName": string,
      "accessibleLevels": [
        string
      ],
      "membershipsDuration": {
        "memberSince": datetime,
        "memberTotalDurationMonths": integer,
      },
      "membershipsDurationAtLevel": [
        {
          "level": string,
          "memberSince": datetime,
          "memberTotalDurationMonths": integer,
        }
      ]
    }
  }
}

Propriedades

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

Propriedades
kind string
Identifica o tipo do recurso da API. O valor será youtube#member.
etag etag
A Etag deste recurso.
snippet object
O objeto snippet contém detalhes sobre o membro.
snippet.creatorChannelId string
O ID do canal do YouTube do criador de conteúdo que oferece Clubes dos canais.
snippet.memberDetails object
Este objeto contém dados de perfil sobre o canal do YouTube que está pagando pela assinatura.

Um canal pode ter membros com dados de perfil indisponíveis. Por exemplo, isso ocorre com membros que excluíram os canais, mas ainda estão pagando pelas assinaturas. Esses membros ainda podem acessar os benefícios da assinatura.

As respostas da API incluem recursos para esses membros garantirem contagens precisas, mesmo que os detalhes do perfil no objeto memberDetails não estejam definidos. O membershipsDetails ainda é fornecido para esses membros.
snippet.memberDetails.channelId string
O ID do canal do YouTube do membro. Se estiver definido, o ID do canal também poderá ser tratado como um identificador exclusivo do membro. Se não estiver definido, o membro não poderá ser identificado de forma exclusiva, mas o recurso ainda transmitirá detalhes da assinatura, como os níveis que o membro pode acessar e a duração da assinatura.
snippet.memberDetails.channelUrl string
O URL do canal.
snippet.memberDetails.displayName string
O nome de exibição do canal.
snippet.memberDetails.profileImageUrl string
O URL do avatar do canal.
snippet.membershipsDetails object
Esse objeto contém detalhes de assinatura do canal do membro.
snippet.membershipsDetails.highestAccessibleLevel string
O ID do nível de assinatura mais alto que o canal do membro pode acessar no momento. O valor corresponde ao valor da propriedade id em um recurso membershipsLevel.
snippet.membershipsDetails.highestAccessibleLevelDisplayName string
O nome do nível de assinatura mais alto que o canal do membro pode acessar no momento. O valor corresponde ao valor da propriedade displayName em um recurso membershipsLevel.
snippet.membershipsDetails.accessibleLevels[] list (of strings)
Uma lista de IDs de todos os níveis de associação que o usuário pode acessar no momento. A lista inclui o nível ativo no momento e todos os níveis abaixo dele.
snippet.membershipsDuration object
Esse objeto contém informações sobre a duração geral da assinatura do membro atual, sem considerar os níveis de preço. A propriedade snippet.membershipsDetails.membershipsDurationAtLevel[] contém uma lista de objetos que contêm detalhes sobre um período de associação em que o membro teve acesso a um nível específico de associação.

O exemplo a seguir mostra como essas propriedades funcionam: um membro compra uma nova assinatura em janeiro no nível 1 e a mantém até março. Em abril e maio, o participante não tem uma assinatura. Em junho, o membro reinicia a assinatura, novamente no nível 1. Em agosto, o membro faz upgrade para o nível 2. Portanto, se uma chamada de API for feita em outubro, o recurso member vai conter o seguinte: 
"membershipsDetails": {
  "membershipsDuration": {
    "memberSince": "2020-06-01T12:00:00",
    "memberTotalDurationMonths": 7,
  },
  "membershipsDurationAtLevel": [
    {
      "level": "level_1_ID",
      "memberSince": "2020-06-01T12:00:00",
      "memberTotalDurationMonths": 7
    },
    {
      "level": "level_2_ID",
      "memberSince": "2020-08-01T12:00:00",
      "memberTotalDurationMonths": 2
    },
  ]
}
snippet.membershipsDuration.memberSince datetime
A data e a hora em que a assinatura atual do membro começou. Em outras palavras, o membro tem uma assinatura contínua desde essa data e hora. É possível que períodos diferentes da assinatura tenham sido gastos em níveis diferentes.
snippet.membershipsDuration.memberTotalDurationMonths integer
O número de meses, arredondado para o inteiro mais próximo, em que o usuário é membro. O valor reflete o número de meses completos em que o membro teve uma assinatura, mas o número não implica que o membro teve uma assinatura continuamente por tantos meses.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel[] list (of objects)
Uma lista de objetos, em que cada um contém detalhes sobre um período da associação em que o membro teve acesso a um nível específico de associação. A lista inclui um objeto para cada nível de associação que o membro pode acessar no momento.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.level string
O ID do nível de associação. O valor corresponde ao valor da propriedade id em um recurso membershipsLevel.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberSince datetime
A data e a hora em que o membro teve acesso ao nível de assinatura especificado. Em outras palavras, o membro tem acesso contínuo ao nível desde essa data e hora. É possível que diferentes períodos da assinatura tenham sido gastos em níveis mais altos.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberTotalDurationMonths integer
O número de meses, arredondado para o número inteiro mais próximo, em que o usuário teve acesso ao nível especificado. O valor reflete o número de meses completos em que o membro teve acesso ao nível, mas não implica que ele teve uma assinatura por esse período.