FanFundingEvents

Observação: este é um anúncio de descontinuação.

O recurso de financiamento por fãs foi descontinuado, e a API Fan Funding será desativada em 28 de fevereiro de 2017. Esse anúncio de suspensão de uso coincide com o lançamento do novo recurso Super Chat do YouTube.

Um recurso fanFundingEvent representa um evento do financiamento por fãs em um canal do YouTube. O financiamento por fãs oferece uma forma de apoiar os criadores de conteúdo do YouTube de maneira monetária. Um evento de financiamento por fãs ocorre quando um usuário faz um pagamento voluntário único em um canal. Consulte a Central de Ajuda do YouTube para saber mais sobre o financiamento por fãs.

Métodos

A API é compatível com os seguintes métodos para recursos fanFundingEvents:

list
Lista os eventos de financiamento por fãs para um canal. A solicitação da API precisa ser autorizada pelo proprietário do canal. Faça um teste agora.

Representação de recurso

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

{
  "kind": "youtube#fanFundingEvent",
  "etag": etag,
  "id": string,
  "snippet": {
    "channelId": string,
    "supporterDetails": {
      "channelId": string,
      "channelUrl": string,
      "displayName": string,
      "profileImageUrl": string
    },
    "commentText": string,
    "createdAt": datetime,
    "amountMicros": unsigned long,
    "currency": string,
    "displayString": string
  }
}

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#fanFundingEvent.
etag etag
A ETag deste recurso.
id string
O ID que o YouTube atribui para identificar exclusivamente o evento de financiamento por fãs.
snippet object
O objeto snippet contém informações sobre o evento de financiamento por fãs.
snippet.channelId string
ID do canal que recebeu o financiamento.
snippet.supporterDetails object
Detalhes sobre o canal do apoiador. Esse objeto só estará presente se o apoiador tornar o evento de financiamento público.
snippet.supporterDetails.channelId string
O ID do canal do YouTube do apoiador.
snippet.supporterDetails.channelUrl string
O URL do canal do apoiador.
snippet.supporterDetails.displayName string
O nome de exibição do canal do apoiador.
snippet.supporterDetails.profileImageUrl string
O URL do avatar do canal do apoiador.
snippet.commentText string
O conteúdo de texto do comentário do apoiador.
snippet.createdAt datetime
A data e a hora em que o financiamento ocorreu. O valor é especificado no formato ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
snippet.amountMicros unsigned long
O valor da contribuição no evento de financiamento. O valor está em micros da moeda financiada. Por exemplo, se o financiador contribuiu com um dólar (US$ 1), o valor da propriedade snippet.amountMicros será 1000000.
snippet.currency string
Moeda associada ao valor do financiamento. O valor é um código de moeda ISO 4217.
snippet.displayString string
Uma string, mostrada para exibição, que mostra o valor e a moeda do fundo. Se a solicitação fanFundingEvents.list especificar um idioma de aplicativo com o parâmetro hl, a string de exibição será localizada para exibição nesse idioma. Por exemplo, em inglês, a moeda seria exibida como $1.50, mas em francês, como 1,50$.