Referência

Atributos do botão "Inscrever-se"

Obrigatório

Esta seção explica como construir um elemento <div> para um botão de inscrição. A lista abaixo explica os atributos obrigatórios e opcionais do elemento. Os atributos opcionais permitem controlar o layout do botão e o tema, além de escolher se a contagem de inscritos no canal será exibida.

class – Definir o valor como g-ytsubscribe. Essa classe identifica o elemento <div> como um contêiner para um botão de inscrição e permite que o YouTube redimensione dinamicamente o botão incorporado conforme explicado na próxima seção.
Você deve especificar um valor para um dos dois atributos a seguir:
- data-channel – O nome do canal associado ao botão. Valor de amostra: GoogleDevelopers.
- data-channelid - O ID do canal associado ao botão. Valor de amostra: UC_x5XG1OV2P6uZZ5FSM9Ttw. Você pode recuperar o ID de seu canal nas Configurações da conta do YouTube ou com o APIs Explorer no final deste documento. Saiba mais sobre como trabalhar com IDs de canais.

Opcional

data-layout – O formato do botão. Os valores de atributos válidos são:
- default - Exibir um ícone do botão "reproduzir" e a palavra "inscrever-se" no idioma do usuário, selecionado ao usar configuração de idioma ou a localização do usuário.
- full - Exibir o avatar e o título do canal, além do botão padrão.
data-theme – Especificar o esquema de cores a ser usado para o botão. Os valores válidos são default e dark. O tema dark destina-se a aplicativos que colocam botões sobre um elemento de fundo mais escuro.
data-count – Indicar se o botão exibe o número de inscritos que o canal contém. O comportamento padrão do botão é exibir a contagem de inscritos. Entretanto, a contagem não é exibida em canais pagos. Os valores válidos são default e hidden.

Renderização dinâmica

Como alternativa ao uso do código de incorporação padrão da ferramenta de configuração, você pode renderizar dinamicamente o Subscribe Button. Esta abordagem impede que o JavaScript da API transfira todo o DOM para localizar botões, o que pode melhorar o tempo de renderização do botão.

Como parte da Google+ JavaScript API, o Subscribe Button aceita os métodos padrão go e render, que podem ser usados para renderizar dinamicamente os botões de inscrição. Você poderá, por exemplo, usar esses métodos para renderizar um botão que não estiver presente quando o evento ready do DOM for acionado, como em uma página que é atualizada com o AJAX.

Método Descrição

Método	Descrição
`gapi.ytsubscribe.go( opt_container )`	Renderiza todos os botões de inscrição no contêiner especificado. Use este método se os elementos do botão de inscrição que você deseja renderizar já existem. Por exemplo, se seu aplicativo envia uma solicitação AJAX que retorna o elemento `<div>` completo para uma chamada do Subscribe Button, chame o método `go()` para renderizar o botão. opt_container O elemento HTML que contém os botões de inscrição para renderização. Especifique o ID do elemento ou o próprio elemento do DOM. Se este parâmetro for omitido, todos os botões de inscrição na página serão renderizados.
`gapi.ytsubscribe.render( container, parameters )`	Renderiza o Subscribe Button dentro do contêiner especificado. Use este método se o elemento que conterá o Subscribe Button ainda não existe e precisa ser construído. container Identifica o elemento HTML vazio no qual o Subscribe Button será renderizado. Especifique o ID do elemento ou o próprio elemento do DOM. parameters Um objeto com atributos do botão de inscrição como pares `key:value`, por exemplo, `{"channel": "GoogleDevelopers", "layout": "full"}`.

gapi.ytsubscribe.go(
  opt_container
)

Renderiza todos os botões de inscrição no contêiner especificado. Use este método se os elementos do botão de inscrição que você deseja renderizar já existem. Por exemplo, se seu aplicativo envia uma solicitação AJAX que retorna o elemento <div> completo para uma chamada do Subscribe Button, chame o método go() para renderizar o botão.

opt_container: O elemento HTML que contém os botões de inscrição para renderização. Especifique o ID do elemento ou o próprio elemento do DOM. Se este parâmetro for omitido, todos os botões de inscrição na página serão renderizados.

gapi.ytsubscribe.render(
  container,
  parameters
)

Renderiza o Subscribe Button dentro do contêiner especificado. Use este método se o elemento que conterá o Subscribe Button ainda não existe e precisa ser construído.

container: Identifica o elemento HTML vazio no qual o Subscribe Button será renderizado. Especifique o ID do elemento ou o próprio elemento do DOM.
parameters: Um objeto com atributos do botão de inscrição como pares key:value, por exemplo, {"channel": "GoogleDevelopers", "layout": "full"}.

Renderização de um botão com gapi.ytsubscribe.go

O exemplo abaixo mostra o código que você usaria para chamar o método gapi.ytsubscribe.go para renderizar dinamicamente um botão quando o link fosse clicado.

Nota: A ferramenta de configuração acima também usa o método go para renderizar um novo botão quando você atualiza as opções ou o código do botão.

Renderização de um botão com gapi.ytsubscribe.render

O exemplo abaixo demonstra como chamar o método gapi.ytsubscribe.render para renderizar dinamicamente um botão quando o usuário clica no link.