Classe 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 vai ficar ativada por padrão.
getStreamManager()
Retorna um gerenciador de fluxo, se disponível.
Se o gerenciador de stream ainda não estiver disponível, o valor "Invalid" será retornado.
Se houver um erro ao criar o 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 de configurações IMA opcional. |
requestStream(streamRequest)
Inicia uma solicitação de transmissão 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 |
Classe ima.AdBreakInfo
Campos
Métodos
Contém informações sobre um intervalo de anúncio. Transmitido para callbacks de evento pelo SDK.
Propriedades
Nome | Tipo | Descrição |
---|---|---|
adPosition |
|
O índice do anúncio no intervalo. O índice é |
duration |
|
A duração máxima do intervalo em segundos ou |
podIndex |
|
Para transmissões ao vivo, retorna o ID do intervalo como o índice do pod ou |
timeOffset |
|
A posição do conjunto no conteúdo em segundos.
O anúncio precedente retorna |
totalAds |
|
O número total de anúncios contidos neste intervalo.
O valor é |
createAdBreakInfo()
Retornos ima.AdBreakInfo
:
Classe ima.AdEvent
Campos
Eventos acionados pelo Ad Manager.
Propriedades
Nome | Tipo | Descrição |
---|---|---|
AD_PERIOD_ENDED |
|
É acionado sempre que o stream muda de publicidade ou aviso para conteúdo. Ele será disparado mesmo quando um anúncio for reproduzido pela segunda vez ou quando for procurado em um anúncio. |
AD_PERIOD_STARTED |
|
É acionado sempre que o stream muda de conteúdo para publicidade ou aviso. Ele será disparado mesmo quando um anúncio for reproduzido pela segunda vez ou quando for procurado em 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 de fallback do ícone. |
ICON_FALLBACK_IMAGE_SHOWN |
|
É acionado quando a imagem de reserva do ícone é mostrada. |
MIDPOINT |
|
Disparado quando o indicador 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 de um anúncio pulável muda. |
SKIPPED |
|
Disparado quando um anúncio é ignorado. |
START |
|
Disparado quando um anúncio começa a ser reproduzido. |
THIRD_QUARTILE |
|
Disparado quando o indicador de reprodução do anúncio cruza o terceiro quartil. |
Classe ima.AdInfo
Campos
Métodos
Contém informações sobre um anúncio. Transmitido para callbacks de evento 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 ele for desconhecido. |
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 que veicula. |
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 de um anúncio em segundos ou -1 se desconhecido. |
dealId |
|
Retorna o primeiro ID de negócio presente na cadeia de wrapper do anúncio atual, começando do topo. |
duration |
|
A duração desse único anúncio em segundos ou -1 se desconhecida. |
skipOffset |
|
O tempo que o anúncio leva para se tornar opcional ou -1 se 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 do wrapper para este anúncio. A ordem será do wrapper externo para o interno. |
createAdInfo()
Retornos ima.AdInfo
:
Classe ima.Companion
Campos
Métodos
Contém informações sobre os anúncios complementares de um anúncio.
Propriedades
Nome | Tipo | Descrição |
---|---|---|
apiFramework |
|
A API necessária para executar esse anúncio ou "Invalid" se ela não estiver disponível. |
creativeType |
|
Representa o tipo de criativo, geralmente um tipo MIME. |
height |
|
A altura do companheiro 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 fazer ping nesse evento. |
url |
|
O URL do recurso estático desse complementar. |
width |
|
A largura do companheiro em pixels. 0 se não estiver disponível. |
createCompanion()
Retornos ima.Companion
:
Classe ima.CuePoint
Campos
Métodos
Contém informações sobre um ponto de referência.
Propriedades
Nome | Tipo | Descrição |
---|---|---|
end |
|
O tempo de término de um ponto de gatilho em segundos. Isso corresponde a um intervalo comercial. |
hasPlayed |
|
Um booleano que indica que o ponto de referência já foi reproduzido. |
start |
|
O horário de início de um ponto de inserção em segundos. Isso corresponde a um intervalo comercial. |
createCuePoint()
Retornos ima.CuePoint
:
Classe ima.Error
Campos
Métodos
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 conferir 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()
Retornos ima.Error
:
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 foi válida. |
STREAM_API_KEY_NOT_VALID |
|
A chave de API fornecida não foi aceita pelo servidor. |
Classe 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 a interrupção do 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 a interrupção do anúncio. |
allVideoComplete()
Opcional. Chamado quando todo o vídeo é concluído.
createPlayer()
Cria um objeto Player
IMA vazio. Você precisa implementar a
função loadUrl
para veicular anúncios. Outras funções são opcionais.
Retorna ima.Player
:
loadUrl(streamInfo)
Chamada 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 informações necessárias para reproduzir conteúdo. |
Classe ima.StreamFormat
Campos
Define o formato da transmissão.
Propriedades
Nome | Tipo | Descrição |
---|---|---|
DASH |
|
|
HLS |
|
Classe 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 do stream. |
streamId |
|
Um ID exclusivo para a transmissão. |
streamType |
|
O tipo de vídeo: ao vivo ou sob demanda. Definido em ima.StreamType. |
subtitles |
|
Legendas, se disponíveis. Inválido se não for. |
createStreamInfo()
Retornos ima.StreamInfo
:
Classe ima.StreamManager
Métodos
Objeto para gerenciar a reprodução do stream.
addEventListener(event, callback)
Adiciona um listener para o evento especificado. Consulte a constante AdEvents para
eventos com suporte.
Parâmetro | Tipo | Descrição |
---|---|---|
event |
string |
|
callback |
function |
createStreamManager(streamRequest, streamInitResponse)
Retornos ima.StreamManager
:
Parâmetro | Tipo | Descrição |
---|---|---|
streamRequest |
ima.StreamRequest |
|
streamInitResponse |
ima.StreamInitResponse |
enableInteractiveAds()
Sem suporte. Em vez disso, transmita os dados do anúncio complementar diretamente para o RAF.
Agora isso não é mais possível.
getContentTime(streamTime)
Recebe um tempo em milissegundos para um stream VOD, representando o tempo no
conteúdo sem anúncios.
Para mais detalhes, consulte as
Perguntas frequentes.
Para saber o tempo do conteúdo do stream atual, use -1
.
Retorna Integer
:o tempo de conteúdo correspondente ao tempo de transmissão fornecido.
Parâmetro | Tipo | Descrição |
---|---|---|
streamTime |
Integer |
O tempo no stream. |
getCuePoints()
Retorna todos os pontos de sinalização correspondentes a todos os intervalos de anúncios. Isso é válido apenas para conteúdo sob demanda em vídeo em que todos os intervalos de anúncio são conhecidos com antecedência. Todos os tempos representam o tempo de transmissão em segundos.
Para transmissões da API Cloud Stitching, a propriedade hasPlayed
de cada ima.CuePoint
é sempre falsa.
Retorna Object
: uma matriz com todos os pontos de gatilho.
getPreviousCuePoint(time)
Retorna o ponto de sinalização anterior a esse tempo. O ponto de referência indica um intervalo de
anúncio. Todos os tempos representam o tempo de transmissão em segundos.
Retorna ima.CuePoint
:um objeto com início, fim e hasPlayed. Retorna
"Invalid" se nenhum ponto de sinalização estiver disponível.
Parâmetro | Tipo | Descrição |
---|---|---|
time |
Float |
O tempo de pesquisa, |
getStreamTime(contentTime)
Recebe o tempo da transmissão de um 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 |
O horário 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 unidos. |
streamSubtitle |
ifArray |
Os subtítulos
são associados ao stream ou |
onMessage(msg)
Processa todas as mensagens vindas do objeto "Video".
Precisa ser chamada 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 tags de anúncio que serão usados nas próximas solicitações de anúncios para uma transmissão ao vivo. Essa chamada não tem efeito 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.
Classe 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 solicitação de stream. Fornecer parâmetros de segmentação ao stream oferece mais informações. Também é possível 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. |
adUiNode |
|
Um nó da cena em que a interface do anúncio é mostrada. O IMA coloca elementos como os botões Por que esse anúncio e Pular nesse elemento durante os anúncios. O elemento precisa sobrepor 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 interface do DFP. |
assetKey |
|
Obrigatório para transmissões ao vivo. Ele é usado para determinar qual fluxo 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. |
authToken |
|
O token de autorização da solicitação de fluxo. Usado no lugar da chave de API para uma autorização de conteúdo mais rigorosa. O editor pode controlar autorizações de fluxos de conteúdo individuais 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 será reproduzido. As chaves de recurso personalizadas são necessárias para solicitações de transmissão de veiculação de pods. |
format |
|
O formato do stream. O valor padrão é |
networkCode |
|
O código de rede do editor que fez a solicitação de transmissão. Os códigos de rede são necessários para as solicitações de transmissão de veiculação de pods feitas com createPodLiveStreamRequest ou createPodVodStreamRequest. Esses códigos também são necessários para solicitações de stream de combinação do Cloud feitas com createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest ou createVideoStitcherVodStreamRequestWithVodConfig. Esses códigos são opcionais e recomendados para solicitações de transmissão 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 limitados programáticos. Para veiculação de pods e junção de nuvens, a adição do código de rede localiza e reproduz o fluxo. Para encontrar o código da rede, consulte este artigo. |
player |
|
Uma implementação da interface do player. |
ppid |
|
Obsoleto. Use adTagParameters. Opcional. Um identificador fornecido pelo editor do DFP Audience. |
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. |
videoId |
|
Obrigatório para transmissões sob demanda. Identificador da origem do conteúdo do 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á consultado para vários dados a serem usados no cronometramento adequado de eventos ID3 do HLS ao vivo. |
videoStitcherSessionOptions |
|
As opções de sessão são usadas para definir parâmetros específicos do Video Stitcher para streamRequests do VideoStitcher. |
createLiveStreamRequest(assetKey, apiKey, networkCode)
Inicializa as propriedades necessárias de um StreamRequest
ao vivo. 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 ativas obrigatórias.
Parâmetro | Tipo | Descrição |
---|---|---|
assetKey |
string |
|
apiKey |
string |
Parâmetro atribuído à propriedade
|
networkCode |
string |
Código de rede do editor que faz a solicitação de stream. A inclusão do código de rede é opcional, mas recomendada. |
createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)
Inicializa as propriedades necessárias de um ima.StreamRequest
do Pod ao vivo.
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
: 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 |
createPodVodStreamRequest(networkCode)
Inicializa as propriedades necessárias de um ima.StreamRequest
para
registrar um stream VOD ao usar a veiculação de conjunto DAI com um
editor de vídeo 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. As validações com falhas 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 necessárias de um editor de vídeo ao vivo
StreamRequest
. 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
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 necessárias de um editor de vídeo VOD
StreamRequest
. 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
as propriedades obrigatórias do VideoStitcherVod.
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 StreamRequest
VOD
do editor de vídeo usando vodConfigId
criado pelo 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
as propriedades obrigatórias do VideoStitcherVod.
Parâmetro | Tipo | Descrição |
---|---|---|
vodConfigId |
string |
|
networkCode |
string |
|
region |
string |
|
projectNumber |
string |
|
oAuthToken |
string |
createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)
Inicializa as propriedades necessá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
:objeto ima.StreamRequest
com
as propriedades de VOD obrigatórias.
Parâmetro | Tipo | Descrição |
---|---|---|
contentSourceId |
string |
|
videoId |
string |
|
apiKey |
string |
Parâmetro atribuído à propriedade
|
networkCode |
string |
Código de rede do editor que faz a solicitação de stream. A inclusão do código de rede é opcional, mas recomendada. |
Classe ima.StreamType
Campos
Define o tipo de transmissão que o player precisa reproduzir. Os pré-rolagens e VODs precisam ser reproduzidos desde o início do stream.
Propriedades
Nome | Tipo | Descrição |
---|---|---|
LIVE |
|
O vídeo foi publicado. |
VOD |
|
O vídeo é on demand. |
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 desconhecido. |
adSystem |
|
O nome declarado do sistema de anúncios ou uma string vazia se ele 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 ele for desconhecido. |
dealId |
|
O ID da transação ou uma string vazia se não for conhecido. |
createWrapperInfo()
Retornos ima.WrapperInfo
: