Esta página foi traduzida pela API Cloud Translation.

Classe: Ad

Métodos

getAdId.

getAdId() retorna uma string

O ID do anúncio é usado para sincronizar o anúncio principal e os complementares.

Retorna: string O ID do anúncio ou a string vazia se essa informação estiver indisponível.

getAdPodInfo

getAdPodInfo() retorna AdPodInfo.

Retorna as informações do conjunto de anúncios.

Retorna: non-null AdPodInfo As informações do conjunto de anúncios.

getAdSystem

getAdSystem() retorna uma string

As informações do servidor de anúncios de origem incluídas na resposta do anúncio.

Retorna: string O servidor de anúncios de origem do anúncio ou a string vazia se essa informação estiver indisponível.

getAdvertiserName

getAdvertiserName() retorna a string

O nome do anunciante, conforme definido pela parte que faz a veiculação.

Retorna: string O nome do anunciante, ou a string vazia se essa informação não estiver disponível.

getApiFramework

getApiFramework() retorna string

Identifica a API necessária para executar o anúncio. Isso corresponde ao apiFramework especificado em VAST.

Retorna: nullable string O framework da API precisa executar o anúncio ou ser nulo se essa informação não estiver disponível.

getCompanionAds

getCompanionAds(adSlotWidth, adSlotHeight, settings) retorna a matriz de CompanionAd não nulo

Obtém os anúncios complementares para este anúncio com base no tamanho do espaço de anúncio complementar. Opcionalmente, as configurações de seleção avançadas são aceitas. Esse método retornará apenas uma matriz não vazia para instâncias de anúncios adquiridas no evento STARTED ou após ele. Especificamente, os anúncios do evento LOADED retornarão uma matriz vazia.

Parâmetro
Largura do anúncio	number Largura do local do anúncio complementar.
Altura do anúncio	number Altura do local do anúncio complementar.
configurações	Opcional CompanionAdSelectionSettings As configurações de seleção de anúncios complementares. O valor não pode ser nulo.

Parâmetro

Largura do anúncio

number

Largura do local do anúncio complementar.

Altura do anúncio

number

Altura do local do anúncio complementar.

configurações

Opcional

CompanionAdSelectionSettings

As configurações de seleção de anúncios complementares.

O valor não pode ser nulo.

Retorna: non-null Array of non-null CompanionAd Matriz de anúncios complementares que corresponde às configurações e ao tamanho do local.

getContentType

getContentType() retorna uma string

Retorna o tipo de conteúdo do criativo atualmente selecionado ou uma string vazia se nenhum criativo for selecionado ou o tipo de conteúdo estiver indisponível. Para anúncios lineares, o tipo de conteúdo estará disponível somente após o evento START, quando o arquivo de mídia estiver selecionado.

Retorna: string O tipo de conteúdo, string vazia se não estiver disponível.

getCreativeAdId.

getCreativeAdId() retorna uma string

Retorna o código ISCI (Identificador padrão comercial do setor) de um anúncio ou uma string vazia se o código não estiver disponível. Este é o ID de anúncio do criativo na resposta VAST.

Retorna: string

getCreativeId.

getCreativeId() retorna uma string

Recupera o ID do creativo selecionado para o anúncio.

Retorna: string O ID do criativo selecionado para o anúncio ou a string vazia, se essa informação estiver indisponível.

getDealId

getDealId() retorna uma string

Retorna o primeiro código da transação presente na cadeia de wrappers do anúncio atual, começando de cima. Retorna a string vazia, se indisponível.

Retorna: string

getDescription

getDescription() retorna string.

Retorna a descrição deste anúncio da resposta VAST.

Retorna: string A descrição, vazia se não for especificada.

getDuration

getDuration() retorna o número.

Retorna a duração do criativo selecionado ou -1 para criativos não lineares.

Retorna: number A duração do criativo selecionado em segundos, ou -1 se não linear.

getHeight

getHeight() retorna o número

Retorna a altura do criativo não linear selecionado.

Retorna: number A altura do criativo não linear selecionado, ou 0 para um criativo linear.

getMediaUrl

getMediaUrl() retorna a string

Retorna o URL do arquivo de mídia escolhido a partir do anúncio com base nas configurações de seleção de mídia em uso no momento. Retorna nulo se essa informação não estiver disponível. Disponível no evento STARTED.

Retorna: nullable string

getMinSuggestedDuration

getMinSuggestedDuration() retorna o número

Retorna a duração mínima sugerida em segundos em que a peça criativa não linear deve ser exibida. Retorna -2 se a duração mínima sugerida for desconhecida. Para um criativo linear, ele retorna toda a duração do anúncio.

Retorna: numberA duração mínima sugerida em segundos em que um criativo deve ser exibido.

getSkipTimeOffset

getSkipTimeOffset() retorna o número.

O número de segundos de reprodução antes que o anúncio possa ser ignorado. -1 é retornado para anúncios não ignoráveis ou se este estiver indisponível.

Retorna: number O deslocamento em segundos ou -1.

URL da pesquisa de get

getSurveyUrl() retorna a string

Retorna o URL associado à pesquisa para o anúncio em questão. Retornará nulo se não disponível.

Retorna: nullable string

getTitle

getTitle() retorna string

Retorna o título deste anúncio da resposta VAST.

Retorna: string O título, vazio se não for especificado.

getTraffickingParameters

getTraffickingParameters() retorna Object com propriedades de string

Obtém parâmetros personalizados associados ao anúncio no momento da programação do anúncio.

Retorna: non-null Object with string properties Um mapeamento de chaves de tráfego para os valores deles ou o objeto vazio se essa informação não estiver disponível.

getTraffickingParametersString

getTraffickingParametersString() retorna string

Obtém parâmetros personalizados associados ao anúncio no momento da programação do anúncio. Retorna uma versão de string bruta dos parâmetros analisados do getTraffickingParameters.

Retorna: string Parâmetros de tráfego ou a string vazia se essa informação não estiver disponível.

getUiElements

getUiElements() retorna uma matriz de strings.

Retorna os elementos de IU que são exibidos quando este anúncio é reproduzido. Consulte UiElements para ver possíveis elementos da matriz retornada.

Retorna: non-null Array of string Os elementos da IU que estão sendo exibidos.

getUniversalAdIdRegistry.

getUniversalAdIdRegistry() retorna string.

O registro associado à catalogação do UniversalAdId da peça criativa selecionada para o anúncio.

Descontinuado: Em vez disso, use ad.getUniversalAdIds()
Retorna: string Retorna o valor de registro ou "unknown", se indisponível.

getUniversalAdIdValue.

getUniversalAdIdValue() retorna uma string

O UniversalAdId do criativo selecionado para o anúncio.

Descontinuado: Em vez disso, use ad.getUniversalAdIds()
Retorna: string Retorna o valor de ID ou "desconhecido", se não disponível.

getUniversalAdIds

getUniversalAdIds() retorna a matriz de UniversalAdIdInfo não nulo.

A lista de UniversalAdIds do anúncio selecionado para o anúncio.

Retorna: non-null Array of non-null UniversalAdIdInfo Retorna a lista de informações de ID do anúncio universal que se aplicam a esse anúncio.

getVastMediaBitrate

getVastMediaBitrate() retorna número

Quando o criativo e o arquivo de mídia forem selecionados pelo SDK, a taxa de bits do arquivo de mídia será retornada, conforme listado na vasta resposta.

Retorna: number A taxa de bits para o arquivo de mídia selecionado ou 0.

getVastMediaHeight

getVastMediaHeight() retorna um número

Retorna a altura da mídia VAST do criativo selecionado.

Retorna: number A altura da mídia VAST do criativo selecionado ou 0 se nenhum criativo estiver selecionado.

getVastMediaWidth

getVastMediaWidth() retorna o número

Retorna a largura da mídia VAST do criativo selecionado.

Retorna: number A largura da mídia VAST do criativo selecionado ou 0 se nenhuma estiver selecionada.

getWidth

getWidth() retorna o número

Retorna a largura do criativo selecionado.

Retorna: numberA largura do criativo não linear selecionado, ou 0 para um criativo linear.

getWrapperAdIds

getWrapperAdIds() retorna Array of string

IDs de anúncios usados para anúncios wrapper. Os IDs retornados começam no anúncio in-line (mais interno) e são transferidos para o anúncio wrapper mais externo. Uma matriz vazia será retornada se não houver anúncios wrapper.

Retorna: non-null Array of string Os IDs dos anúncios, começando pelo anúncio in-line, ou uma matriz vazia se não houver anúncios wrapper.

getWrapperAdSystems

getWrapperAdSystems() retorna uma matriz de strings

Sistemas de anúncios usados para anúncios wrapper. Os sistemas de anúncios retornados começam no anúncio in-line e são transferidos para o anúncio wrapper mais externo. Uma matriz vazia será retornada se não houver anúncios wrapper.

Retorna: non-null Array of string Os sistemas dos anúncios, começando pelo anúncio in-line, ou uma matriz vazia se não houver anúncios wrapper.

getWrapperCreativeIds

getWrapperCreativeIds() retorna Array of string

Os IDs dos criativos selecionados usados para anúncios wrapper. Os IDs dos criativos retornados começam no anúncio in-line e são transferidos para o anúncio wrapper externo. Uma matriz vazia será retornada se não houver anúncios wrapper.

Retorna: non-null Array of string Os IDs dos criativos dos anúncios, começando pelo anúncio in-line, ou uma matriz vazia, se não houver anúncios wrapper.

isLinear

isLinear() retorna booleanos

Indica se o modo de operação atual do anúncio é linear ou não linear. Se o valor for verdadeiro, indica que o anúncio está no modo de reprodução linear. Se for falso, indica o modo não linear. O player verifica a propriedade linear e atualiza o estado dela de acordo com os detalhes do canal do anúncio. Enquanto o anúncio está no modo linear, o player pausa o vídeo de conteúdo. Se o linear for verdadeiro inicialmente e o anúncio for precedente (definido externamente), o player poderá optar por atrasar o carregamento do vídeo de conteúdo até perto do final da reprodução do anúncio.

Retorna: boolean Verdadeiro se o anúncio for linear, caso contrário será falso.