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 de 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 de um bloco de anúncios durante a inserção dinâmica de anúncios. Essa classe expõe um subconjunto das propriedades de ima.AdPodInfo.

getAdPosition()


Retorna number:

getMaxDuration()


Retorna number:

getPodIndex()


Retorna number:

getTimeOffset()


Retorna number:

getTotalAds()


Retorna 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 dinâmica de anúncios. 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 propriedades de um ponto de sinalização, que representa uma pausa para anúncio em streams de VOD da DAI.

Propriedades

Nome Tipo Descrição
end

O horário de término do ponto de sinalização.
played

Indica se o ponto de sinalização foi reproduzido.
start

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

Classe google.ima.dai.api.LiveStreamRequest

Campos

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

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

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

Propriedades

Nome Tipo Descrição
assetKey

Isso é usado para determinar qual stream deve ser reproduzido. 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 em exibição.
cuepoints

Os pontos de inserção de anúncios para o stream sob demanda. Esses valores podem mudar à medida que o stream avança. 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 streams como uma notificação quando o estado do stream muda.

getAd()


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

getStreamData()


Retorna google.ima.dai.api.StreamData: objeto de retorno com informações de stream.

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

Campos

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

Valores

Valor Descrição
AD_BREAK_ENDED

Disparado quando um intervalo de anúncio termina.
AD_BREAK_STARTED

Disparado quando uma pausa para 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 sinalização mudam.
ERROR

Disparado quando ocorre um erro.
FIRST_QUARTILE

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

Disparado quando o manifesto de stream 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 fluxos 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 eventos de stream e anúncios ao publisher. Esse gerenciador não herda de BaseAdsManager porque não é um gerenciador de um anúncio específico, mas de todo o stream.

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

O elemento real do player de vídeo.

contentTimeForStreamTime(streamTime)

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

Retorna number:o tempo de conteúdo que corresponde ao tempo de stream especificado 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 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 sinalização anterior para o tempo de stream especificado. Retorna nulo se não houver um ponto de sinalização. Usado para implementar recursos como o snap back e chamado quando o editor detecta que o usuário buscou para retornar o usuário a um intervalo de anúncio.

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

Parâmetro Tipo Descrição
streamTime number

o tempo do stream para o qual a busca foi feita.

processMetadata(type, data, timestamp)

Processa metadados com carimbo de data/hora 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

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

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

Horário em que os dados devem ser processados.

requestStream(streamRequest)

Solicita o carregamento de um fluxo usando os parâmetros 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 do anúncio. Esse elemento é usado como o receptor de clique ou toque enquanto um anúncio está sendo veiculado 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 stream com anúncios para um determinado tempo de conteúdo. Retorna o tempo de conteúdo especificado para transmissões ao vivo.

Retorna number: o tempo de stream que corresponde ao tempo de conteúdo especificado depois que os anúncios são inseridos.

Parâmetro Tipo Descrição
contentTime number

o tempo de 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 substituir um conjunto limitado de parâmetros de tag de anúncio na solicitação de stream. Fornecer parâmetros de segmentação ao stream oferece mais informações. Você pode usar os parâmetros dai-ot e dai-ov para preferência de variantes de stream. Consulte Substituir parâmetros de variantes do stream para mais informações.
apiKey

A chave de API de solicitação de stream. Ele é configurado na interface de 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 de atividade de streaming. 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.

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

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

Propriedades

Nome Tipo Descrição
contentSourceId

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

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

Constante google.ima.VERSION

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