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 dinâmica de anúncios. Essa classe expõe um subconjunto das propriedades ima.Ad.

getAdId()


Retornos string:

getAdPodInfo()


Retornos google.ima.dai.api.AdPodInfo:

getAdSystem()


Retornos string:

getAdvertiserName()


Retornos string:

getApiFramework()


Retornos string:

getCompanionAds()


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

getCreativeAdId()


Retornos string:

getCreativeId()


Retornos string:

getDealId()


Retornos string:

getDescription()


Retornos string:

getDuration()


Retornos number:

getTitle()


Retornos string:

getVastMediaHeight()


Retornos number:

getVastMediaWidth()


Retornos number:

getWrapperAdIds()


Retornos Array.<string>:

getWrapperAdSystems()


Retornos Array.<string>:

getWrapperCreativeIds()


Retornos Array.<string>:

Classe google.ima.dai.api.AdPodInfo

Métodos

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

getAdPosition()


Retornos number:

getMaxDuration()


Retornos number:

getPodIndex()


Retornos number:

getTimeOffset()


Retornos number:

getTotalAds()


Retornos number:

Classe google.ima.dai.api.AdProgressData

Campos

Uma 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()


Retornos string:

getContent()


Retornos string:

getContentType()


Retornos string:

getHeight()


Retornos number:

getWidth()


Retornos number:

Classe google.ima.dai.api.CuePoint

Campos

Uma classe para especificar propriedades de um ponto de gatilho, que representa um intervalo de anúncio em transmissões VOD de DAI.

Propriedades

Nome Tipo Descrição
end

O horário de término deste ponto de gatilho.
played

Se esse ponto de gatilho foi reproduzido.
start

O horário de início deste ponto de inserção.

Classe google.ima.dai.api.LiveStreamRequest

Campos

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

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

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

Propriedades

Nome Tipo Descrição
assetKey

Ele é usado para determinar qual transmissão 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 do anúncio que está sendo veiculado.
cuepoints

Os pontos de inserção de anúncios do stream sob demanda. Isso pode mudar à medida que a transmissão avança. Isso só será preenchido no listener de eventos para o 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 muda.

getAd()


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

getStreamData()


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

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

Campos

Lista de tipos de eventos 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 enquanto um anúncio está sendo reproduzido.
COMPLETE

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

Enviado para transmissões sob demanda quando os pontos de gatilho mudam.
ERROR

Disparado quando ocorre um erro.
FIRST_QUARTILE

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

Disparado quando o manifesto de transmissão está disponível.
MIDPOINT

Disparado quando um anúncio atinge o ponto médio.
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

Processa transmissões de inserção de anúncios dinâmicos. Ele gerencia interações com o back-end do DAI e processa pings de rastreamento, além de encaminhar eventos de stream e anúncios para o editor. Esse gerenciador não herda do BaseAdsManager, porque não é um gerenciador de um anúncio específico, mas de todo o stream.

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

O elemento do player de vídeo.

contentTimeForStreamTime(streamTime)

Retorna o tempo de conteúdo sem anúncios para um determinado tempo de transmissão. Retorna o tempo de transmissão fornecido para transmissões ao vivo.

Retorna number:o tempo de conteúdo que corresponde ao tempo de transmissão especificado após a remoção dos anúncios.

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 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 ponto de partida anterior para o tempo de transmissão especificado. Retorna nulo se nenhum cuepoint existir. Ele é usado para implementar recursos como o retorno automático e é chamado quando o editor detecta que o usuário procurou para retornar a um intervalo de anúncio.

Retorna google.ima.dai.api.CuePoint:o ponto de inserção anterior para o tempo de transmissão fornecido.

Parâmetro Tipo Descrição
streamTime number

o tempo do stream que foi procurado.

processMetadata(type, data, timestamp)

Processa metadados programados para transmissões ao vivo. Use 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

Digite os metadados. Precisa ser "ID3".
data Uint8Array

Dados brutos da tag. Para ID3, precisa 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 nos anúncios. Esse elemento é usado como o receptor de cliques ou toques enquanto um anúncio é reproduzido 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 de transmissão com anúncios para um determinado conteúdo. Retorna o tempo de conteúdo indicado para transmissões ao vivo.

Retorna number:o tempo de transmissão que corresponde ao tempo de conteúdo determinado 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 transmissão.

Propriedades

Nome Tipo Descrição
adTagParameters

É possível substituir um conjunto limitado de parâmetros de tag de anúncio na solicitação de stream. Consulte Fornecer parâmetros de segmentação ao stream para mais informações. Você pode usar os parâmetros dai-ot e dai-ov para a preferência de variante de transmissão. Consulte Modificar os parâmetros de variantes 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. Ele verifica os aplicativos que estão tentando acessar o conteúdo.
streamActivityMonitorId

O ID a ser usado para depurar o stream com o Monitoramento da atividade de streaming. Isso é usado para oferecer 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 de VOD.

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

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

Propriedades

Nome Tipo Descrição
contentSourceId

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

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

Constante google.ima.VERSION

Uma string que contém a versão completa do SDK.