SDK de DAI do IMA para Roku

    1. ima
    2. ima.AdBreakInfo
    3. ima.AdEvent
    4. ima.AdInfo
    5. ima.Companion
    6. ima.CuePoint
    7. ima.Error
    8. ima.ErrorEvent
    9. ima.Player
    10. ima.StreamFormat
    11. ima.StreamInfo
    12. ima.StreamManager
    13. ima.StreamRequest
    14. ima.StreamType
    15. ima.WrapperInfo

Class ima

Métodos

Funções globais que controlam o SDK do IMA.

disableLogging()

Desativa a geração de registros do SDK. A geração de registros fica ativada por padrão.

getStreamManager()

Retorna um gerenciador de streams, se disponível. Se o gerenciador de stream ainda não estiver disponível, "Invalid" será retornado. Se houver um erro ao criar o gerenciador de streams, um objeto de erro será retornado.

Retorna object:o gerenciador de stream ou o objeto de erro.

initSdk(settings)

Inicializa o SDK.

Parâmetro Tipo Descrição
settings object

Objeto de configurações opcionais da IMA.

requestStream(streamRequest)

Inicia uma solicitação de stream assíncrona. O controle retorna imediatamente ao player após a chamada desse método.

Retorna object:um erro ou inválido se não houver erro

Parâmetro Tipo Descrição
streamRequest object

Voltar ao início

Class ima.AdBreakInfo

Campos

Métodos

Contém informações sobre um intervalo de anúncio. Transmitido aos callbacks de eventos pelo SDK.

Propriedades

Nome Tipo Descrição
adPosition

O índice do anúncio no intervalo. O índice é 1 para anúncios independentes.

duration

A duração máxima do intervalo em segundos ou -1 se for desconhecida.

podIndex

Para transmissões ao vivo, retorna o ID do intervalo como o índice do pod ou 0 para um pré-vídeo. Não há postrolls em transmissões ao vivo. O padrão é -2. Para vídeo on demand (VOD), retorna o índice do conjunto de anúncios. Para um pod de pré-roll, retorna 0. Para intermediários, retorna 1, 2, ..., n. Para um pod de postroll, retorna n+1...n+x. O padrão é 0 se o anúncio não fizer parte de um conjunto ou se o conjunto não fizer parte de uma playlist.

timeOffset

A posição do conjunto no conteúdo em segundos. Os anúncios precedentes retornam 0, os anúncios finais retornam -1 e os anúncios intermediários retornam o horário programado do podcast.

totalAds

O número total de anúncios contidos nesse intervalo comercial. O valor é 1 para anúncios independentes.

createAdBreakInfo()


Retorna ima.AdBreakInfo:

Voltar ao início

Classe ima.AdEvent

Campos

Eventos disparados pelo gerenciador de anúncios.

Propriedades

Nome Tipo Descrição
AD_PERIOD_ENDED

Disparado sempre que o stream muda de publicidade ou barreiras para conteúdo. Esse evento é disparado mesmo quando um anúncio é reproduzido pela segunda vez ou quando se busca um anúncio.

AD_PERIOD_STARTED

Disparado sempre que o stream muda de conteúdo para publicidade ou barreiras. Esse evento é disparado mesmo quando um anúncio é reproduzido pela segunda vez ou quando se busca um anúncio.

COMPLETE

Disparado quando a reprodução do anúncio é concluída.

ERROR

Disparado quando ocorre um erro.

FIRST_QUARTILE

Disparado quando o indicador de reprodução do anúncio cruza o primeiro quartil.

ICON_FALLBACK_IMAGE_CLOSED

Disparado quando o usuário fecha a caixa de diálogo de imagem substituta do ícone.

ICON_FALLBACK_IMAGE_SHOWN

Disparado quando a imagem de substituição do ícone é exibida.

MIDPOINT

Disparado quando o marcador de reprodução do anúncio cruza o ponto médio.

PROGRESS

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

SKIPPABLE_STATE_CHANGED

Disparado quando o estado pulável de um anúncio muda.

SKIPPED

Disparado quando um anúncio é ignorado.

START

Disparado quando um anúncio começa a ser veiculado.

THIRD_QUARTILE

Disparado quando o indicador de reprodução do anúncio cruza o terceiro quartil.

Voltar ao início

Class ima.AdInfo

Campos

Métodos

Contém informações sobre um anúncio. Transmitido aos callbacks de eventos pelo SDK.

Propriedades

Nome Tipo Descrição
adBreakInfo

Informações relacionadas a todo o intervalo em que o anúncio está.

adDescription

Descrição do anúncio.

adId

O ID do anúncio ou uma string vazia se for desconhecido.

adSystem

O sistema de publicidade que fornece o criativo.

adTitle

O título do anúncio.

advertiserName

O nome do anunciante, conforme definido pelo veiculador.

companions

Os anúncios complementares especificados na resposta VAST.

creativeAdId

O código ISCI (identificador comercial padrão do setor) de um anúncio. É o ID do anúncio do criativo selecionado na resposta VAST.

creativeId

O ID do criativo selecionado para o anúncio.

currentTime

O tempo atual em um anúncio, em segundos, ou -1 se for desconhecido.

dealId

Retorna o primeiro ID de negócio presente na cadeia de wrappers do anúncio atual, começando de cima.

duration

A duração deste único anúncio em segundos ou -1 se for desconhecida.

skipOffset

O tempo que leva para o anúncio se tornar pulável ou -1 se for desconhecido.

universalAdIDRegistry

Uma string usada para identificar o URL do site de registro em que o ID universal do anúncio do criativo selecionado está catalogado.

universalAdIDValue

O ID universal do anúncio do criativo selecionado para o anúncio.

wrappers

Uma matriz de ima.WrapperInfo com informações de wrapper para este anúncio. A ordem será do wrapper externo para o interno.

createAdInfo()


Retorna ima.AdInfo:

Voltar ao início

Classe ima.Companion

Campos

Métodos

Contém informações sobre os complementares de um anúncio.

Propriedades

Nome Tipo Descrição
adSlotId

O ID do espaço do anúncio complementar. Vazio se não estiver disponível.

apiFramework

A API necessária para executar este anúncio ou "Invalid" (Inválido) se não estiver disponível.

companionClickThrough

URL de clique do complemento.

creativeType

Representa o tipo de criativo, geralmente um tipo MIME.

height

A altura do complemento em pixels. 0 se indisponível.

trackingEvents

Um mapa de eventos de rastreamento em que a chave é o evento e o valor é uma lista de URLs a serem pingados nesse evento.

url

O URL do recurso estático deste complemento.

width

A largura do complemento em pixels. 0 se indisponível.

createCompanion()


Retorna ima.Companion:

Voltar ao início

Class ima.CuePoint

Campos

Métodos

Contém informações sobre um ponto de sinalização.

Propriedades

Nome Tipo Descrição
end

O tempo de término de um ponto de sinalização em segundos. Isso corresponde a um intervalo comercial.

hasPlayed

Um booleano que indica se o ponto de sinalização já foi reproduzido.

start

O tempo de início de um ponto de sinalização em segundos. Isso corresponde a um intervalo comercial.

createCuePoint()


Retorna ima.CuePoint:

Voltar ao início

Class ima.Error

Campos

Métodos

Objeto transmitido ao gerenciador de erros se houver um erro.

Propriedades

Nome Tipo Descrição
id

O ID do erro. Consulte a constante ErrorEvent para ver uma lista de códigos de erro.

info

Mais informações sobre o erro.

type

Sempre definido como "error" para indicar o tipo desse objeto.

createError()


Retorna ima.Error:

Voltar ao início

Classe ima.ErrorEvent

Campos

Todos os erros que o SDK pode enviar de volta.

Propriedades

Nome Tipo Descrição
BAD_STREAM_REQUEST

A solicitação de transmissão não foi preenchida corretamente.

COULD_NOT_LOAD_STREAM

Não foi possível carregar a transmissão.

ERROR

Um erro desconhecido.

INVALID_RESPONSE

A resposta do servidor não era válida.

STREAM_API_KEY_NOT_VALID

A chave de API fornecida não foi aceita pelo servidor.

Voltar ao início

Class ima.Player

Métodos

adBreakEnded(adBreakInfo)

Opcional. Chamado quando um intervalo de anúncio termina.

Parâmetro Tipo Descrição
adBreakInfo ima.AdBreakInfo

Contém informações sobre o intervalo publicitário.

adBreakStarted(adBreakInfo)

Opcional. Chamado quando um intervalo de anúncio é iniciado.

Parâmetro Tipo Descrição
adBreakInfo ima.AdBreakInfo

Contém informações sobre o intervalo publicitário.

allVideoComplete()

Opcional. Chamado quando todo o vídeo é concluído.

createPlayer()

Cria um objeto Player da IMA vazio. Você precisa implementar a função loadUrl para veicular anúncios. Outras funções são opcionais.

Retorna ima.Player:

loadUrl(streamInfo)

Chamado quando o player precisa começar a reproduzir um URL. É necessário implementar esse método para carregar o stream.

Parâmetro Tipo Descrição
streamInfo ima.StreamInfo

Contém as informações necessárias para reproduzir conteúdo.

streamInitialized(streamInfo)

Chamado quando um fluxo é inicializado.

Parâmetro Tipo Descrição
streamInfo ima.StreamInfo

Contém as informações necessárias para reproduzir conteúdo.

Voltar ao início

Class ima.StreamFormat

Campos

Define o formato da transmissão.

Propriedades

Nome Tipo Descrição
DASH

HLS

Voltar ao início

Class ima.StreamInfo

Campos

Métodos

Informações transmitidas do SDK para o player sobre o stream.

Propriedades

Nome Tipo Descrição
format

O formato do vídeo: hls ou dash. Definido em ima.StreamFormat.

manifest

URL da transmissão.

streamId

Um ID exclusivo para o stream.

streamType

O tipo de vídeo: ao vivo ou on demand. Definido em ima.StreamType.

subtitles

Legendas, se disponíveis. Inválido se não for.

createStreamInfo()


Retorna ima.StreamInfo:

Voltar ao início

Class ima.StreamManager

Métodos

Objeto para gerenciar a reprodução de stream.

addEventListener(event, callback)

Adiciona um listener para o evento especificado. Consulte a constante AdEvents para eventos compatíveis.

Parâmetro Tipo Descrição
event string

callback function

createStreamManager(streamRequest, streamInitResponse)


Retorna ima.StreamManager:

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

streamInitResponse ima.StreamInitResponse

enableInteractiveAds()

Sem suporte. Em vez disso, transmita dados do anúncio complementar diretamente para o RAF. Agora, isso é uma operação nula.

getContentTime(streamTime)

Recebe um tempo em milissegundos para um stream de VOD, representando o tempo no conteúdo sem anúncios. Para mais detalhes, consulte as Perguntas frequentes. Para receber o tempo de conteúdo da passagem de tempo do stream atual em -1.

Retorna Integer:o tempo de conteúdo correspondente ao tempo de stream especificado.

Parâmetro Tipo Descrição
streamTime Integer

O tempo na transmissão.

getCuePoints()

Retorna todos os pontos de sinalização correspondentes a todos os intervalos de anúncios. Isso só é válido para conteúdo de vídeo sob demanda em que todos os intervalos de anúncio são conhecidos com antecedência. Todos os horários representam o tempo de transmissão em segundos. Para streams da API Cloud Stitching, a propriedade hasPlayed de cada ima.CuePoint é sempre "false".

Retorna Object:uma matriz com todos os pontos de sinalização.

getPreviousCuePoint(time)

Retorna o ponto de sinalização anterior a esse horário. O ponto de sinalização indica um intervalo de anúncio. Todos os horários representam o tempo de transmissão em segundos.

Retorna ima.CuePoint:um objeto com start, end e hasPlayed. Retorna Invalid se nenhum ponto de cue estiver disponível.

Parâmetro Tipo Descrição
time Float

O tempo de pesquisa, -1, indica a hora atual e retorna Invalid para todas as outras transmissões.

getStreamTime(contentTime)

Recebe o tempo da transmissão de um tempo de conteúdo para VOD em milissegundos. Para mais detalhes, consulte as Perguntas frequentes.

Retorna Integer: o tempo de transmissão correspondente ao tempo de conteúdo especificado.

Parâmetro Tipo Descrição
contentTime Integer

A hora do conteúdo.

loadThirdPartyStream(streamManifest, streamSubtitle)

Carrega os metadados do anúncio e chama a função loadUrl com os dados streamManifestUrl e streamSubtitle fornecidos. Essa função só funciona quando o tipo de solicitação de stream é ima.StreamType.POD_VOD.

Parâmetro Tipo Descrição
streamManifest string

O URL do manifesto de transmissão com anúncios combinados.

streamSubtitle ifArray>|Invalid

As legendas associadas ao stream ou Invalid se não houver.

onMessage(msg)

Processa todas as mensagens do objeto de vídeo. Precisa ser chamado para cada mensagem recebida na roMessagePort.

Parâmetro Tipo Descrição
msg object

A mensagem da porta roVideo.

replaceAdTagParameters(adTagParameters)

Substitui todos os parâmetros de tag de anúncio que serão usados nas próximas solicitações de anúncios de uma transmissão ao vivo. Essa chamada não faz nada para transmissões de VOD.

Parâmetro Tipo Descrição
adTagParameters string

Os novos parâmetros da tag de anúncio.

start()

Inicia a reprodução do stream.

Voltar ao início

Class ima.StreamRequest

Campos

Métodos

Usado para especificar propriedades da solicitação de stream.

Propriedades

Nome Tipo Descrição
adTagParameters

Opcional. É possível substituir um conjunto limitado de parâmetros de tag de anúncio na sua solicitação de stream. Fornecer parâmetros de segmentação ao stream oferece mais informações. Você também pode usar os parâmetros dai-ot e dai-ov para preferência de variante de stream. Consulte Substituir parâmetros de variantes do stream para mais informações.

adUiNode

Um nó de gráfico de cena em que a interface do anúncio é mostrada. O IMA coloca elementos como os botões Por que este anúncio? e Pular nesse elemento durante os anúncios. O elemento precisa ficar sobre todo o elemento de vídeo.

apiKey

Opcional. Elas podem ser usadas para autenticar solicitações de stream. As chaves de autenticação da DAI precisam ser configuradas na interface do DFP.

assetKey

Necessário para transmissões ao vivo. Isso é usado para determinar qual stream 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.

authToken

O token de autorização da solicitação de transmissão. Usado no lugar da chave de API para uma autorização de conteúdo mais restrita. O editor pode controlar as autorizações individuais de fluxos de conteúdo com base nesse token.

contentSourceId

Obrigatório para transmissões sob demanda. O cmsid vem da origem de conteúdo de vídeo do DFP na interface do DFP.

customAssetKey

A chave de recurso personalizada é usada para determinar qual stream deve ser reproduzido. As chaves de recurso personalizadas são necessárias para solicitações de stream de disponibilização de pods.

format

O formato do stream. O valor padrão é ima.StreamFormat.HLS.

networkCode

O código de rede do publisher que faz a solicitação de stream. Os códigos de rede são necessários para solicitações de stream de veiculação de conjunto feitas com createPodLiveStreamRequest ou createPodVodStreamRequest. Esses códigos também são necessários para solicitações de stream de junção do Cloud feitas com createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest ou createVideoStitcherVodStreamRequestWithVodConfig. Esses códigos são opcionais e recomendados para solicitações de stream de serviço completo feitas com createLiveStreamRequest ou createVodStreamRequest. A adição do código de rede aplica as configurações selecionadas na interface do Ad Manager, como a ativação de anúncios programáticos limitados. Para veiculação de pods e junção de nuvem, a adição do código de rede localiza e reproduz o stream. Para encontrar o código de rede, consulte este artigo.

player

Uma implementação da interface do player.

ppid

Obsoleto. Use adTagParameters. Opcional. Um identificador fornecido pelo publisher de público-alvo do DFP.

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.

videoId

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

videoObject

O objeto de vídeo (como o Video roSGNode) responsável pela reprodução de vídeo no app cliente. Esse objeto será pesquisado para vários dados a serem usados no tempo adequado dos eventos ID3 HLS ao vivo.

videoStitcherSessionOptions

As opções de sessão são usadas para definir parâmetros específicos do VideoStitcher para VideoStitcher streamRequests.

createLiveStreamRequest(assetKey, apiKey, networkCode)

Inicializa as propriedades obrigatórias de um StreamRequest ativo. O uso dessa API faz com que todas as outras propriedades específicas de StreamType sejam ignoradas. Se algum parâmetro obrigatório for uma string vazia, o registro de erros vai ocorrer e a API vai retornar um StreamRequest genérico, sem propriedades ignoradas.

Retorna um objeto ima.StreamRequest: ima.StreamRequest com propriedades ativas obrigatórias.

Parâmetro Tipo Descrição
assetKey string

apiKey string

Parâmetro atribuído à propriedade ima.StreamRequest.apiKey do ima.StreamRequest retornado. Se não houver uma chave de API, transmita uma string vazia.

networkCode string

Código de rede do publisher que faz a solicitação de transmissão. A inclusão do código de rede é opcional, mas recomendada.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Inicializa as propriedades obrigatórias de um ima.StreamRequest do Pod Live. O uso dessa API faz com que todas as outras propriedades específicas de ima.StreamType sejam ignoradas. Se algum parâmetro obrigatório for uma string vazia, o registro de erros vai ocorrer e a API vai retornar um StreamRequest genérico, sem propriedades ignoradas.

Retorna StreamRequest:um objeto ima.StreamRequest com as propriedades PodLive necessárias.

Parâmetro Tipo Descrição
customAssetKey string

networkCode string

apiKey string

Parâmetro opcional atribuído à propriedade ima.StreamRequest.apiKey do ima.StreamRequest retornado. O padrão é uma string vazia.

createPodVodStreamRequest(networkCode)

Inicializa as propriedades necessárias de um ima.StreamRequest para registrar um stream de VOD ao usar a veiculação de pod de DAI com um junção de vídeo de terceiros. Essa função define o tipo de solicitação como ima.StreamType.POD_VOD e valida todas as propriedades obrigatórias para dados ausentes. As validações com falha vão registrar um erro no console de depuração.

Retorna StreamRequest:um objeto ima.StreamRequest. Se todas as propriedades obrigatórias forem especificadas, o tipo de solicitação será definido como ima.StreamType.POD_VOD.

Parâmetro Tipo Descrição
networkCode string

o código de rede do Google Ad Manager;

createStreamRequest()


Retorna ima.StreamRequest:um objeto ima.StreamRequest vazio.

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)

Inicializa as propriedades obrigatórias de um StreamRequest ao vivo do Video Stitcher. O uso dessa API faz com que todas as outras propriedades específicas de StreamType sejam ignoradas. Se algum parâmetro obrigatório for uma string vazia, o registro de erros vai ocorrer e a API vai retornar um StreamRequest genérico, sem propriedades ignoradas.

Retorna ima.StreamRequest: um objeto ima.StreamRequest com as propriedades necessárias do VideoStitcherLive.

Parâmetro Tipo Descrição
customAssetKey string

networkCode string

liveConfigId string

region string

projectNumber string

oAuthToken string

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)

Inicializa as propriedades obrigatórias de um StreamRequest de VOD do Video Stitcher. O uso dessa API faz com que todas as outras propriedades específicas de StreamType sejam ignoradas. Se algum parâmetro obrigatório for uma string vazia, o registro de erros vai ocorrer e a API vai retornar um StreamRequest genérico, sem propriedades ignoradas.

Retorna ima.StreamRequest:objeto ima.StreamRequest com propriedades VideoStitcherVod obrigatórias.

Parâmetro Tipo Descrição
adTagUrl string

networkCode string

contentSourceUrl string

region string

projectNumber string

oAuthToken string

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)

Inicializa as propriedades obrigatórias de um editor de vídeo sob demanda StreamRequest usando vodConfigId criado com o editor de vídeo na nuvem. O uso dessa API faz com que todas as outras propriedades específicas de StreamType sejam ignoradas. Se algum parâmetro obrigatório for uma string vazia, o registro de erros vai ocorrer e a API vai retornar um StreamRequest genérico, sem propriedades ignoradas.

Retorna ima.StreamRequest:objeto ima.StreamRequest com propriedades VideoStitcherVod obrigatórias.

Parâmetro Tipo Descrição
vodConfigId string

networkCode string

region string

projectNumber string

oAuthToken string

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

Inicializa as propriedades obrigatórias de um ima.StreamRequest de VOD. O uso dessa API faz com que todas as outras propriedades específicas de ima.StreamType sejam ignoradas. Se algum parâmetro obrigatório for uma string vazia, o registro de erros vai ocorrer e a API vai retornar um StreamRequest genérico, sem propriedades ignoradas.

Retorna ima.StreamRequest:um objeto ima.StreamRequest com propriedades obrigatórias de VOD.

Parâmetro Tipo Descrição
contentSourceId string

videoId string

apiKey string

Parâmetro atribuído à propriedade ima.StreamRequest.apiKey do ima.StreamRequest retornado. Se não houver uma chave de API, transmita uma string vazia.

networkCode string

Código de rede do publisher que faz a solicitação de transmissão. A inclusão do código de rede é opcional, mas recomendada.

Voltar ao início

Class ima.StreamType

Campos

Define o tipo de stream que o player precisa reproduzir. Os prerolls e o VOD precisam ser reproduzidos desde o início do stream.

Propriedades

Nome Tipo Descrição
LIVE

O vídeo foi publicado.

VOD

O vídeo está disponível on demand.

Voltar ao início

Classe ima.WrapperInfo

Campos

Métodos

Contém informações sobre um wrapper.

Propriedades

Nome Tipo Descrição
adId

O ID do anúncio ou uma string vazia se for desconhecido.

adSystem

O nome declarado do sistema de publicidade ou uma string vazia se for desconhecido.

creativeAdId

O ID do anúncio no criativo ou uma string vazia se for desconhecido.

creativeId

O ID do criativo ou uma string vazia se for desconhecido.

dealId

O ID da transação ou uma string vazia se for desconhecido.

createWrapperInfo()


Retorna ima.WrapperInfo:

Voltar ao início