APIs do SDK de DAI do Google IMA

    1. google.ima.dai.api.Ad
    2. google.ima.dai.api.AdPodInfo
    3. google.ima.dai.api.AdProgressData
    4. google.ima.dai.api.CompanionAd
    5. google.ima.dai.api.CuePoint
    6. google.ima.dai.api.LiveStreamRequest
    7. google.ima.dai.api.StreamData
    8. google.ima.dai.api.StreamEvent
    9. google.ima.dai.api.StreamEvent.Type
    10. google.ima.dai.api.StreamManager
    11. google.ima.dai.api.StreamRequest
    12. google.ima.dai.api.VODStreamRequest
    13. google.ima.VERSION

Classe google.ima.dai.api.Ad

Métodos

Uma classe que representa um objeto de anúncio durante a inserção de anúncios dinâmicos. Essa classe expõe um subconjunto das propriedades ima.Ad.

getAdId()


Retorna string:

getAdPodInfo()


Retorna google.ima.dai.api.AdPodInfo:

getAdSystem()


Retorna string:

getAdvertiserName()


Retorna string:

getApiFramework()


Retorna string:

getCompanionAds()


Retorna Array.<google.ima.dai.api.CompanionAd>:

getCreativeAdId()


Retorna string:

getCreativeId()


Retorna string:

getDealId()


Retorna string:

getDescription()


Retorna string:

getDuration()


Retorna number:

getTitle()


Retorna string:

getVastMediaHeight()


Retorna number:

getVastMediaWidth()


Retorna number:

getWrapperAdIds()


Retorna Array.<string>:

getWrapperAdSystems()


Retorna Array.<string>:

getWrapperCreativeIds()


Retorna Array.<string>:

Classe google.ima.dai.api.AdPodInfo

Métodos

Uma classe que representa um objeto de informações do conjunto de anúncios durante a Inserção de anúncios dinâmicos. Essa classe expõe um subconjunto das propriedades ima.AdPodInfo.

getAdPosition()


Retorna number:

getMaxDuration()


Retorna number:

getPodIndex()


Retorna number:

getTimeOffset()


Retorna number:

getTotalAds()


Retorna number:

Classe google.ima.dai.api.AdProgressData

Campos

Classe para especificar dados de progresso do anúncio.

Propriedades

Nome Tipo Descrição
adBreakDuration

adPosition

currentTime

duration

totalAds

Classe google.ima.dai.api.CompanionAd

Métodos

Uma classe que representa um objeto de anúncio complementar durante a inserção de anúncios dinâmicos. Essa classe expõe um subconjunto das propriedades ima.CompanionAd.

getAdSlotId()


Retorna string:

getContent()


Retorna string:

getContentType()


Retorna string:

getHeight()


Retorna number:

getWidth()


Retorna number:

Classe google.ima.dai.api.CuePoint

Campos

Uma classe para especificar as propriedades de um marcador, que representa um intervalo de anúncio em streams de VOD da DAI.

Propriedades

Nome Tipo Descrição
end

O horário de término deste marcador.
played

Se o marcador foi reproduzido.
start

O horário de início deste marcador.

Classe google.ima.dai.api.LiveStreamRequest

Campos

Uma classe para especificar as propriedades da solicitação de transmissão ao vivo.

Construtor:
Parâmetro Tipo Descrição
opt_liveStreamRequest Object

que já tem propriedades de solicitação de stream atribuídas.

Propriedades

Nome Tipo Descrição
assetKey

Isso é usado para determinar qual transmissão deve ser reproduzida. A chave de recurso da solicitação de transmissão ao vivo é um identificador que pode ser encontrado na interface do DFP.

Classe google.ima.dai.api.StreamData

Campos

Uma classe para especificar dados de fluxo.

Propriedades

Nome Tipo Descrição
adProgressData

Informações relacionadas ao tempo para o anúncio em exibição no momento.
cuepoints

Os pontos de inserção de anúncios para a transmissão sob demanda. Isso pode mudar conforme o stream progride. Isso só será preenchido no listener de eventos para CUEPOINTS_CHANGED AdEvent.
errorMessage

streamId

subtitles

url

Classe google.ima.dai.api.StreamEvent

Métodos

Esse tipo de evento é gerado pelo gerenciador de stream como uma notificação quando o estado do stream é alterado.

getAd()


Retorna google.ima.dai.api.Ad: retorna o objeto com informações do anúncio.

getStreamData()


Retorna google.ima.dai.api.StreamData: retorna o objeto com informações do fluxo.

Enum google.ima.dai.api.StreamEvent.Type

Campos

Lista de tipos de evento compatíveis com o SDK do IMA.

Valores

Valor Descrição
AD_BREAK_ENDED

Disparado quando um intervalo de anúncio termina.
AD_BREAK_STARTED

Disparado quando um intervalo de anúncio começa.
AD_PROGRESS

Disparado quando há uma atualização no progresso de um anúncio.
CLICK

Enviado quando o elemento de clique é clicado ou tocado durante a reprodução de um anúncio.
COMPLETE

Disparado quando um anúncio é concluído.
CUEPOINTS_CHANGED

Enviado para streams sob demanda quando os pontos de inserção são alterados.
ERROR

Disparado quando ocorre um erro.
FIRST_QUARTILE

Disparado quando um anúncio atinge o primeiro quartil.
LOADED

Disparado quando o manifesto do stream está disponível.
MIDPOINT

Disparado quando um anúncio atinge a metade.
STARTED

Disparado quando um anúncio começa.
STREAM_INITIALIZED

Disparado quando o stream é inicializado.
THIRD_QUARTILE

Disparado quando um anúncio atinge o terceiro quartil.

Classe google.ima.dai.api.StreamManager

Métodos

Processar streams de Inserção de anúncios dinâmicos. Ele gerencia as interações com o back-end da DAI e processa pings de rastreamento, além de encaminhar o stream e os eventos de anúncios para o editor. Este gerenciador não herda do BaseTreine, já que não é um gerente de um anúncio específico, mas de um para todo o stream

Construtor:
Parâmetro Tipo Descrição
videoElement HTMLVideoElement

O elemento real do player de vídeo.

contentTimeForStreamTime(streamTime)

Retorna o tempo do conteúdo sem anúncios em um determinado tempo de stream. Retorna o tempo especificado para as transmissões ao vivo.

Retorna number: o tempo do conteúdo correspondente ao tempo de stream específico depois que os anúncios são removidos.

Parâmetro Tipo Descrição
streamTime number

o tempo de transmissão com anúncios inseridos (em segundos).

onTimedMetadata(metadata)

Transmite um dicionário de metadados processados. O dicionário espera a chave "TXXX" com a string de metadados definida pelo usuário como o valor. Se o player fornecer metadados brutos, chame ima.dai.api.StreamManager.processMetadata.

Parâmetro Tipo Descrição
metadata Object

O dicionário de metadados.

previousCuePointForStreamTime(streamTime)

Retorna o marcador anterior para o tempo de stream especificado. Retornará nulo se esse ponto de indicação não existir. Ela é usada para implementar recursos como o ajuste e chamado quando o editor detecta que o usuário procurou para retornar o usuário a um intervalo de anúncio.

Retorna google.ima.dai.api.CuePoint: o marcador anterior para o tempo de stream especificado.

Parâmetro Tipo Descrição
streamTime number

o tempo de stream que foi buscado.

processMetadata(type, data, timestamp)

Processa metadados com marcação de tempo para transmissões ao vivo. Use esse recurso se o player de vídeo fornecer metadados não analisados com carimbos de data/hora. Caso contrário, chame ima.dai.api.StreamManager.onTimedMetadata.

Parâmetro Tipo Descrição
type string

Tipo de metadados. Precisa ser "ID3".
data Uint8Array

Dados brutos de tag Para ID3, deve ser a tag inteira.
timestamp number

Horário em que os dados precisam ser processados.

requestStream(streamRequest)

Solicita que um stream seja carregado usando os parâmetros de stream fornecidos.

Parâmetro Tipo Descrição
streamRequest google.ima.dai.api.StreamRequest

contém parâmetros para carregar os metadados do stream.

setClickElement(clickElement)

Define o elemento de clique no anúncio. Esse elemento é usado como o receptor de clique ou toque durante a reprodução de um anúncio e pode resultar na navegação para fora da página atual.

Parâmetro Tipo Descrição
clickElement Element

o elemento usado como clique no anúncio.

streamTimeForContentTime(contentTime)

Retorna o tempo do stream com anúncios em um determinado tempo de conteúdo. Retorna o tempo especificado do conteúdo para transmissões ao vivo.

Retorna number: o tempo de stream correspondente ao tempo do conteúdo específico depois que os anúncios são inseridos.

Parâmetro Tipo Descrição
contentTime number

o tempo do conteúdo sem anúncios (em segundos).

Classe google.ima.dai.api.StreamRequest

Campos

Uma classe para especificar propriedades da solicitação de stream.

Propriedades

Nome Tipo Descrição
adTagParameters

É possível modificar um conjunto limitado de parâmetros de tags de anúncio na sua solicitação de stream. Fornecer parâmetros de segmentação ao seu stream: fornece mais informações. Você pode usar os parâmetros dai-ot e dai-ov para ter preferência de variante de fluxo. Consulte Substituir os parâmetros de variante do stream para mais informações.
apiKey

A chave de API da solicitação de stream. Ele é configurado na interface do administrador do DFP e fornecido ao editor para desbloquear o conteúdo dele. Ele verifica os aplicativos que estão tentando acessar o conteúdo.
streamActivityMonitorId

O código que será usado para depurar o stream com o monitoramento de atividades de stream. Isso é usado para fornecer uma maneira conveniente de permitir que os editores encontrem um registro de stream na ferramenta de monitoramento da atividade de streaming.

Classe google.ima.dai.api.VODStreamRequest

Campos

Uma classe para especificar propriedades da solicitação de stream VOD.

Construtor:
Parâmetro Tipo Descrição
opt_VODStreamRequest Object

que já tem propriedades de solicitação de stream atribuídas.

Propriedades

Nome Tipo Descrição
contentSourceId

Identificador exclusivo do conteúdo do editor em um CMS. Obrigatório para transmissões sob demanda.
videoId

Identificador da origem do conteúdo em vídeo. Obrigatório para transmissões sob demanda.

Constante google.ima.VERSION

String com a versão completa do SDK.