Members

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

As seguintes restrições de acesso são aplicadas:

  • O acesso aos members e membershipsLevels endpoints é limitado a criadores de conteúdo do YouTube que têm um gerente de parcerias dedicado do YouTube.
  • O acesso é concedido no nível do canal. Devido a essa lista de permissões no nível do canal, o escopo do OAuth youtube.channel-memberships.creator não passa pelo processo de verificação padrão do Google Cloud OAuth.

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 de API precisa ser autorizada por o 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 de recurso da API. O valor será youtube#member.
etag etag
O Etag desse 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 assinaturas.
snippet.memberDetails object
Esse 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 acontece com membros que excluíram os canais, mas ainda estão pagando pelas assinaturas. Observe que esses membros ainda podem acessar os benefícios da assinatura.

As respostas da API incluem recursos para esses membros, garantindo contagens precisas, mesmo que os detalhes do perfil dentro do objeto memberDetails não estejam definidos. Os membershipsDetails ainda são fornecidos 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 transmite 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 da 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 da assinatura mais alto que o canal do membro pode acessar no momento. O valor corresponde ao displayName valor da propriedade em um membershipsLevel recurso.
snippet.membershipsDetails.accessibleLevels[] list (of strings)
Uma lista de IDs de todos os níveis da assinatura que o usuário pode acessar no momento. A lista inclui o nível ativo 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ços. A propriedade snippet.membershipsDetails.membershipsDurationAtLevel[] contém uma lista de objetos com detalhes sobre um período da assinatura em que o membro teve acesso a um determinado nível da assinatura.

O exemplo a seguir mostra como essas propriedades funcionam: um membro compra uma nova assinatura em janeiro no nível 1 e tem essa assinatura até março. Em abril e maio, o membro não tem uma assinatura. Em junho, o membro reinicia a assinatura, novamente no nível 1. Em agosto, o membro faz upgrade da assinatura 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. Observe que diferentes períodos da assinatura podem ter sido gastos em diferentes níveis de assinatura.
snippet.membershipsDuration.memberTotalDurationMonths integer
O número de meses, arredondado para o inteiro mais próximo, em que o usuário foi 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 contínua por esse número de meses.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel[] list (of objects)
Uma lista de objetos em que cada objeto contém detalhes sobre um período da assinatura em que o membro teve acesso a um determinado nível de assinatura. A lista inclui um objeto para cada nível da assinatura que o membro pode acessar no momento.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.level string
O ID do nível da assinatura. O valor corresponde ao id valor da propriedade em um membershipsLevel recurso.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberSince datetime
A data e a hora a partir das quais o membro teve acesso ao nível da assinatura especificado. Em outras palavras, o membro tem acesso contínuo ao nível desde essa data e hora. Períodos diferentes da assinatura podem ter sido gastos em níveis de assinatura mais altos.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberTotalDurationMonths integer
O número de meses, arredondado para o 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 o número não implica que o membro teve uma assinatura contínua por esse número de meses.