SDK de DAI do IMA para Roku

1. 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

Classe ima

Métodos

disableLogging, getStreamManager, initSdk, requestStream

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

disableLogging()

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

getStreamManager()

Retorna um gerenciador de stream, se disponível. Se o gerenciador de transmissão ainda não estiver disponível, a mensagem "Inválido" será retornada. Se ocorrer um erro na criação do gerenciador de stream, 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 opcional de configurações do IMA.

requestStream(streamRequest)

Inicia uma solicitação de stream assíncrona. O controle retorna imediatamente ao player depois de chamar esse método.

Retorna object: um erro ou inválido se nenhum erro

Parâmetro	Tipo	Descrição
streamRequest	object

Voltar ao início

Classe ima.AdBreakInfo

Campos

adPosition, duration, podIndex, timeOffset, totalAds

Métodos

createAdBreakInfo

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

Propriedades

Nome	Tipo	Descrição
adPosition		O índice do anúncio no intervalo comercial. Será 1 para anúncios independentes.
duration		A duração máxima do intervalo em segundos, ou -1 se for desconhecido.
podIndex		Para transmissões ao vivo, sempre retorna -1. Para vídeo on demand (VOD), retorna o índice do conjunto de anúncios. Para um conjunto de anúncios precedentes, retorna 0. Para anúncios intermediários, retorna 1, 2, ..., n. Para um conjunto de anúncio final, retorna n+1...n+x. O padrão é 0 se esse anúncio não fizer parte de um conjunto ou se esse conjunto não fizer parte de uma playlist.
timeOffset		A posição do conjunto no conteúdo em segundos. O anúncio precedente retorna 0, o anúncio final retorna -1, e os anúncios intermediários retornam o horário programado do conjunto.
totalAds		O número total de anúncios contidos neste intervalo. Será 1 para anúncios independentes.

createAdBreakInfo()

Retorna ima.AdBreakInfo:

Voltar ao início

Classe ima.AdEvent

Campos

AD_PERIOD_ENDED, AD_PERIOD_STARTED, COMPLETE, ERRO, FIRST_QUARTILE, ICON_FALLBACK_IMAGE_CLOSED, ICON_FALLBACK_IMAGE_SHOWN, MIDPOINT, MIDPOINT, MIDPOINT, MIDABLEPOINT, MIDABLEPOINTSKIPPABLE_STATE_CHANGEDTHIRD_QUARTILE

Eventos disparados pelo gerenciador de anúncios.

Propriedades

Nome	Tipo	Descrição
AD_PERIOD_ENDED		Disparado sempre que o stream muda de publicidade ou barreira para conteúdo. Isso será acionado mesmo quando um anúncio for reproduzido pela segunda vez ou ao buscar um anúncio.
AD_PERIOD_STARTED		Disparado sempre que o stream muda de conteúdo para publicidade ou barreira. Isso será acionado mesmo quando um anúncio for reproduzido pela segunda vez ou ao buscar 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 marcador do anúncio cruza o primeiro quartil.
ICON_FALLBACK_IMAGE_CLOSED		Disparado quando o usuário fecha a caixa de diálogo da imagem substituta do ícone.
ICON_FALLBACK_IMAGE_SHOWN		Disparado quando a imagem substituta do ícone é exibida.
MIDPOINT		Disparado quando o marcador 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 um estado pulável é alterado.
SKIPPED		Disparado quando um anúncio é ignorado.
START		Disparado quando a reprodução de um anúncio é iniciada.
THIRD_QUARTILE		Disparado quando o marcador do anúncio cruza o terceiro quartil.

Voltar ao início

Classe ima.AdInfo

Campos

adBreakInfo, adDescription, adId, adSystem, adTitle, advertiserName, companions, currentTime, duração, skipOffsetuniversalAdIDRegistryuniversalAdIDValue

Métodos

createAdInfo

Contém informações sobre um anúncio. São transmitidos aos callbacks de eventos pelo SDK.

Propriedades

Nome	Tipo	Descrição
adBreakInfo		Informações relacionadas ao intervalo completo em que este anúncio está.
adDescription		Descrição do anúncio.
adId		O ID do anúncio ou uma string vazia se for desconhecida.
adSystem		O sistema de anúncios que fornece o criativo.
adTitle		O título do anúncio.
advertiserName		O nome do anunciante, conforme definido pela parte veiculada.
companions		Os anúncios complementares especificados na resposta VAST.
currentTime		O tempo atual em um anúncio em segundos ou -1 se for desconhecido.
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 do anúncio universal 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

apiFramework, creativeType, height, trackingEvents, url, largura

Métodos

createCompanion

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

Propriedades

Nome	Tipo	Descrição
apiFramework		A API necessária para executar o anúncio. Se não estiver disponível, ela será inválida.
creativeType		Representa o tipo de criativo, normalmente um tipo MIME.
height		A altura do complementar em pixels. 0 se não estiver disponível.
trackingEvents		Um mapa de eventos de acompanhamento em que a chave é o evento e o valor é uma lista de URLs para dar um ping nesse evento.
url		O URL do recurso estático do complementar.
width		A largura do complementar em pixels. 0 se não estiver disponível.

createCompanion()

Retorna ima.Companion:

Voltar ao início

Classe ima.CuePoint

Campos

end, hasPlayed, start

Métodos

createCuePoint

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

Propriedades

Nome	Tipo	Descrição
end		É o horário de término de um marcador em segundos. Isso corresponde a um intervalo de anúncio.
hasPlayed		É um booleano indicando que o marcador já foi reproduzido.
start		É o horário de início de um marcador em segundos. Isso corresponde a um intervalo de anúncio.

createCuePoint()

Retorna ima.CuePoint:

Voltar ao início

Classe ima.Error

Campos

id, informações, tipo

Métodos

createError

Objeto transmitido ao gerenciador de erros em caso de 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		Outras informações sobre o erro.
type		Sempre defina como erro para indicar o tipo desse objeto.

createError()

Retorna ima.Error:

Voltar ao início

Classe ima.ErrorEvent

Campos

BAD_STREAM_REQUEST, COULD_NOT_LOAD_STREAM, ERROR, INVALID_RESPONSE, STREAM_API_KEY_NOT_VALID

Todos os erros que o SDK pode retornar.

Propriedades

Nome	Tipo	Descrição
BAD_STREAM_REQUEST		A solicitação de stream não foi preenchida corretamente.
COULD_NOT_LOAD_STREAM		Não foi possível carregar o stream.
ERROR		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

Classe ima.Player

Métodos

adBreakEnded, adBreakStarted, allVideoComplete, createPlayer, loadUrl

adBreakEnded(adBreakInfo)

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

Parâmetro	Tipo	Descrição
adBreakInfo	ima.AdBreakInfo	Contém informações sobre o intervalo de anúncio.

adBreakStarted(adBreakInfo)

Opcional. Chamado quando um intervalo de anúncio começa.

Parâmetro	Tipo	Descrição
adBreakInfo	ima.AdBreakInfo	Contém informações sobre o intervalo de anúncio.

allVideoComplete()

Opcional. Chamado quando todo o vídeo está concluído.

createPlayer()

Cria um objeto Player do IMA vazio. É necessário implementar a função loadUrl para exibir anúncios. Outras funções são opcionais.

Retorna ima.Player:

loadUrl(streamInfo)

Chamado quando o player deve começar a reproduzir um URL. Implemente esse método para carregar o stream.

Parâmetro	Tipo	Descrição
streamInfo	ima.StreamInfo	Contém informações necessárias para reproduzir conteúdo.

Voltar ao início

Classe ima.StreamFormat

Campos

DASH e HLS

Define o formato do stream.

Propriedades

Nome	Tipo	Descrição
DASH
HLS

Voltar ao início

Classe ima.StreamInfo

Campos

format, manifest, streamId, streamType, captions

Métodos

createStreamInfo

Informações transmitidas do SDK para o jogador sobre a transmissão.

Propriedades

Nome	Tipo	Descrição
format		O formato do vídeo: hls ou traço. Definida em ima.StreamFormat.
manifest		URL do fluxo.
streamId		Um ID exclusivo para o fluxo.
streamType		Tipo de vídeo: ao vivo ou sob demanda. Definido em ima.StreamType.
subtitles		Legendas, se disponíveis. Se não for, será inválido.

createStreamInfo()

Retorna ima.StreamInfo:

Voltar ao início

Classe ima.StreamManager

Métodos

addEventListener, createStreamManager, enableInteractiveAds, getContentTime, getCuePoints, getPreviousCuePoint, getStreamTime, loadThirdPartyStream, onMessage, replaceAdTagParameters

Objeto para gerenciar a reprodução do 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()

Incompatível. Em vez disso, passe os dados do anúncio complementar diretamente para o RAF. Agora esse sistema não é operacional.

getContentTime(streamTime)

Recebe um tempo em milissegundos para um stream de VOD, representando o tempo no conteúdo sem anúncios. Acesse: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq Para acessar o horário do conteúdo do stream atual em -1.

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

Parâmetro	Tipo	Descrição
streamTime	Integer	O horário no stream.

getCuePoints()

Retorna todos os pontos de inserção correspondentes a todos os intervalos de anúncio. Isso só é válido para conteúdo de vídeo on demand em que todos os intervalos de anúncio são conhecidos com antecedência. Todos os tempos representam o tempo de stream em segundos.

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

getPreviousCuePoint(time)

Retorna o ponto de inserção que precede esse ponto. O ponto de inserção indica um intervalo comercial. Todos os tempos representam o tempo de stream em segundos.

Retorna ima.CuePoint: um objeto com início, fim e hasPlayed. Retorna "Inválido" se nenhum ponto de inserção estiver disponível.

Parâmetro	Tipo	Descrição
time	Float	O tempo a ser pesquisado, -1 indica o horário atual.

getStreamTime(contentTime)

Recebe o tempo para o stream de um horário do conteúdo para VOD em milissegundos. Consulte: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq

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 de 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 stream com anúncios integrados.
streamSubtitle	ifArray>|Invalid	As legendas são associadas à transmissão ou Invalid se não houver nenhuma.

onMessage(msg)

Processa todas as mensagens vindas do objeto de vídeo. Precisa ser chamado para cada mensagem recebida no 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 é um ambiente autônomo para transmissões 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

Classe ima.StreamRequest

Campos

adTagParameters, adUiNode, apiKey, assetKey, authToken, contentSourceId, customAssetKey, format, networkCode, player, player, ppidvideoIdvideoObjectvideoStitcherSessionOptions

Métodos

createLiveStreamRequest, createPodLiveStreamRequest, createPodVodStreamRequest, createStreamRequest, createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest, CreateVideoStitcherVodStreamRequestWithVodConfig, createVodStreamRequest

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

Propriedades

Nome	Tipo	Descrição
adTagParameters		Opcional. É possível modificar um conjunto limitado de parâmetros de tag de anúncio na solicitação de stream. Forneça os parâmetros de segmentação ao stream para ver mais informações. Também é possível usar os parâmetros dai-ot e dai-ov para a preferência de variantes de stream. Consulte Modificar os parâmetros de variantes do stream para mais informações.
adUiNode		Um nó de gráfico de cena onde a interface do anúncio é exibida. O IMA coloca elementos como os botões Por que este anúncio e Pular nesse elemento durante a publicidade. O elemento precisa se sobrepor a todo o elemento de vídeo.
apiKey		Opcional. Essas chaves podem ser usadas para autenticar solicitações de stream. As chaves de autenticação da DAI precisam ser configuradas na IU do DFP.
assetKey		Obrigatório para transmissões ao vivo. Isso é usado para determinar qual stream deve ser tocado. 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 de solicitação de stream. Usado no lugar da chave de API para autorização de conteúdo mais rigorosa. O editor pode controlar autorizações de streams de conteúdo individuais com base nesse token.
contentSourceId		Obrigatório para transmissões on demand. O cmsid vem da origem do conteúdo de vídeo do DFP na IU do DFP.
customAssetKey		A chave de recurso personalizada é usada para determinar qual stream deve ser reproduzido. As chaves de recursos personalizadas são necessárias para solicitações de stream de veiculação de conjuntos.
format		O formato do stream. O valor padrão é ima.StreamFormat.HLS.
networkCode		O código de rede do editor que fez a solicitação de stream. Os códigos de rede são necessários para solicitações de stream de veiculação de pods.
player		Uma implementação da interface do player.
ppid		Obsoleto. Usar adTagParameters. Opcional. Um identificador fornecido pelo editor do DFP Audience.
streamActivityMonitorId		O ID a ser usado para depurar o stream com o monitor de atividade de stream. Isso é usado para fornecer uma maneira conveniente de permitir que os editores encontrem um registro de stream na ferramenta de monitoramento de atividade de stream.
videoId		Obrigatório para transmissões on demand. Identificador da origem do conteúdo em vídeo.
videoObject		O objeto de vídeo (como o roSGNode de vídeo) responsável pela reprodução de vídeo no app cliente. Esse objeto será pesquisado em busca de vários dados que serão usados no momento adequado dos eventos de HLS ID3 ao vivo.
videoStitcherSessionOptions		As opções de sessão são usadas para definir parâmetros específicos do sticher de vídeo para streamRequests do VideoStitcher.

createLiveStreamRequest(assetKey, apiKey)

Inicializa as propriedades necessárias de um StreamRequest ativo. O uso dessa API faz com que todas as outras propriedades específicas do StreamType sejam ignoradas. Se algum dos parâmetros obrigatórios for strings vazias, a geração de registros de erros ocorrerá e a API retornará um StreamRequest genérico, sem propriedades ignoradas.

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

Parâmetro	Tipo	Descrição
assetKey	string
apiKey	string	Parâmetro opcional que será atribuído à propriedade apiKey de StreamRequest retornada. O padrão é uma string vazia.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Inicializa as propriedades necessárias de um ima.StreamRequest do Pod Live. O uso dessa API faz com que todas as outras propriedades específicas do ima.StreamType sejam ignoradas. Se algum dos parâmetros obrigatórios for strings vazias, a geração de registros de erros ocorrerá e a API retornará um StreamRequest genérico, sem propriedades ignoradas.

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

Parâmetro	Tipo	Descrição
customAssetKey	string
networkCode	string
apiKey	string	Parâmetro opcional que será atribuído à propriedade ima.StreamRequest.apiKey de ima.StreamRequest retornada. 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 DAI com um integrador de vídeos de terceiros. Essa função define o tipo de solicitação como ima.StreamType.POD_VOD e valida todas as propriedades necessárias para dados ausentes. Validações com falha registram 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 da rede do Google Ad Manager

createStreamRequest()

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

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

Inicializa as propriedades necessárias de um StreamRequest de editor de vídeo ao vivo. O uso dessa API faz com que todas as outras propriedades específicas de StreamType sejam ignoradas. Se algum dos parâmetros obrigatórios for strings vazias, a geração de registros de erros ocorrerá e a API retornará um StreamRequest genérico, sem propriedades ignoradas.

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

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 necessárias de um VOD de um editor de vídeo StreamRequest. O uso dessa API faz com que todas as outras propriedades específicas de StreamType sejam ignoradas. Se algum dos parâmetros obrigatórios for strings vazias, a geração de registros de erros ocorrerá e a API retornará um StreamRequest genérico, sem propriedades ignoradas.

Retorna ima.StreamRequest: objeto ima.StreamRequest com as propriedades VideoStitcherVod necessá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 necessárias de um VOD do editor de vídeo StreamRequest usando vodConfigId criado a partir do integrador de vídeos da nuvem. O uso dessa API faz com que todas as outras propriedades específicas do StreamType sejam ignoradas. Se algum dos parâmetros obrigatórios for strings vazias, a geração de registros de erros ocorrerá e a API retornará um StreamRequest genérico, sem propriedades ignoradas.

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

Parâmetro	Tipo	Descrição
vodConfigId	string
networkCode	string
region	string
projectNumber	string
oAuthToken	string

createVodStreamRequest(contentSourceId, videoId, apiKey)

Inicializa as propriedades necessárias de um ima.StreamRequest de VOD. O uso dessa API faz com que todas as outras propriedades específicas do ima.StreamType sejam ignoradas. Se algum dos parâmetros obrigatórios for strings vazias, a geração de registros de erros ocorrerá e a API retornará um StreamRequest genérico, sem propriedades ignoradas.

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

Parâmetro	Tipo	Descrição
contentSourceId	string
videoId	string
apiKey	string	Parâmetro opcional que será atribuído à propriedade ima.StreamRequest.apiKey de ima.StreamRequest retornada. O padrão é uma string vazia.

Voltar ao início

Classe ima.StreamType

Campos

AO VIVO, VOD

Define o tipo de transmissão que o player deve reproduzir. Anúncios precedentes e VOD devem ser reproduzidos desde o início da transmissão.

Propriedades

Nome	Tipo	Descrição
LIVE		O vídeo foi publicado.
VOD		O vídeo é on demand.

Voltar ao início

Classe ima.WrapperInfo

Campos

adId, adSystem, creativeAdId, creativeId, dealId

Métodos

createWrapperInfo

Contém informações sobre um wrapper.

Propriedades

Nome	Tipo	Descrição
adId		O ID do anúncio ou uma string vazia se for desconhecida.
adSystem		O nome declarado do sistema de anúncios ou uma string vazia se for desconhecida.
creativeAdId		O ID do anúncio no criativo ou uma string vazia se for desconhecida.
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