Introdução ao Vungle (SDK v. 5.1 e superior) - Adobe AIR

Siga estas instruções para integrar nosso Vungle Adobe Air Plugin em um aplicativo básico de exemplo. O código fonte mencionado aqui está disponível em nosso repositório GitHub público.

Conteúdo

Antes de começar

  • A extensão Vungle requer o SDK Adobe AIR 4.0 ou superior. Para instruções sobre atualização do SDK AIR em Flash Builder ou Flash Professional, consulte a seção “Notas adicionais”.

  • Se você está trabalhando com Android, a extensão Vungle AIR requer JDK 6 ou JDK 7 (dependendo da versão de Flash que você está usando) a ser instalado no sistema de desenvolvimento. Android 3.0 (Honeycomb - API versão 11) ou superior é requerido para a execução do aplicativo.

  • Você pode consultar ActionScript 3 Documentação de classe.

  • Revise example/VungleExample.as para ver um exemplo de classe do aplicativo. Se você for usuário do Flash Professional e não tiver certeza de como usar uma Classe de documentos, consulte "Uso da classe de documento VungleExample.as em Animate ou Flash Professional CS6?” no final deste article.)

Passo 1. Inclua a biblioteca de extensão

Comece criando um novo AIR para projetos de dispositivos móveis e adicionando a extensão nativa.

Para Android, você pode também precisar adicionar a biblioteca Google Play Services ao seu projeto. Uma vez que muitas outras extensões já incluem esta biblioteca, ela pode já estar presente. Para adicionar a extensão, repita os passos abaixo, mas use com.vungle.extensions.android.GooglePlayServices.ane em vez de com.vungle.extensions.Vungle.ane.

Para Animate e Flash Professional CS6 ou superior

  1. Crie um novo projeto AIR para Android ou AIR para iOS.
  2. Selecione Arquivo → Settings... de publicação
  3. Selecione o ícone de engrenagem ao lado de Script para 'Configurações ActionScript'.
  4. Na guia Caminho da biblioteca, clique em Navegue para o arquivo de extensão nativa (ANE) e selecione o arquivo vungle.extensions.Vungle.ane. Clique em OK.
  5. Selecione o ícone de engrenagem ao lado de Destino para 'Configurações de reprodutor'.
  6. Para Android: Na guia Permissões, habilite 'INTERNET', 'WRITE_EXTERNAL_STORAGE' e 'ACCESS_NETWORK_STATE'.
  7. Selecione a opção Gerenciar manualmente permissões e adições de manifesto deste aplicativo e clique em OK.

Para Flash Builder 4.6 ou superior

  1. Em Propriedades do projeto, em Caminho do build Actionscript, selecione Extensões nativas.
  2. Escolha Adicionar ANE... e navegue para o arquivo vungle.extensions.Vungle.ane.
  3. Selecione Pacote de build Actionscript → Google Android.
  4. Na guia Extensões nativas, selecione a opção Pacote ao lado da extensão.
  5. Para iOS, repita as etapas 3 e 4 para o destino 'Apple iOS'.

Passo 2. Atualize seu descritor do aplicativo

Para que o Vungle funcione, modificações são necessárias no arquivo XML do seu aplicativo. Modifique o arquivo XML criado pelo seu IDE com as seguintes alterações.

Nota: Se você é um usuário do Flash Professional user, certifique-se de ter seguido os passos acima para inclusão da biblioteca de extensão “Para Animate e Flash Professional CS6 ou superior''; caso contrário, o Flash pode desfazer suas alterações à medida em que você as fizer.

  1. Defina o SDK AIR como 4.0 (ou superior) no arquivo do descritor do aplicativo:
    <application xmlns="http://ns.adobe.com/air/application/4.0">
  2. Inclua um link para a extensão no descritor:
    <extensions>
    <extensionID>com.vungle.extensions.Vungle</extensionID>
    </extensions>
  3. Para Android: você talvez precise incluir a extensão Google Play Services. Adicione seu ID de extensão aqui também.
    <extensions>
    <extensionID>com.vungle.extensions.Vungle</extensionID>
    <extensionID>com.vungle.extensions.android.GooglePlayServices</extensionID>
    </extensions>

Para aplicativos AIR para Android

Para Android, atualize suas adições de manifesto Android no elemento XML Android para:

  • incluir as permissões INTERNET, WRITE_EXTERNAL_STORAGE e ACCESS_NETWORK_STATE
  • adicione VideoFullScreenAdActivity,definições de atividade MraidFullScreenAdActivity, e MraidFullScreenAdActivity
  • adicionar a tag de metadados da versão google-play-services:
    
    <android>
    <manifestAdditions><![CDATA[
    
    <manifest android:installLocation="auto">
    
    <uses-permission android:name="android.permission.INTERNET"/>
     <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" android:maxSdkVersion="18" />
     <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
     <application>
       <meta-data android:name="com.google.android.gms.version" android:value="@integer/google_play_services_version"/>
       <activity android:name="com.vungle.publisher.VideoFullScreenAdActivity"
         android:configChanges="keyboardHidden|orientation|screenSize|screenLayout|smallestScreenSize"
         android:theme="@android:style/Theme.NoTitleBar.Fullscreen"/>
       <activity android:name="com.vungle.publisher.MraidFullScreenAdActivity"
         android:configChanges="keyboardHidden|orientation|screenSize|screenLayout|smallestScreenSize"
         android:theme="@android:style/Theme.Translucent.NoTitleBar.Fullscreen"/>
       <activity android:name="com.vungle.publisher.FlexViewAdActivity"
         android:configChanges="keyboardHidden|orientation|screenSize|screenLayout|smallestScreenSize"
         android:theme="@android:style/Theme.Translucent.NoTitleBar.Fullscreen"/>
     </application>
    
    </manifest>
    ]]></manifestAdditions>
    </android>

Passo 3. Integre a API Vungle

A API Vungle pode ser adicionada ao seu aplicativo em apenas algumas linhas do ActionScript.

Inicialize a extensão Vungle

Nota: Um posicionamento padrão é automaticamente criado para cada aplicativo. Você deve fornecer seu ID de referência de posicionamento neste passo de inicialização independente de se você planeja ou não aproveitar a funcionalidade de posicionamentos. Se você criar múltiplos posicionamentos, forneça todos os IDs de referência.

Inicialize a API quando o aplicativo iniciar.

  • Se usar ActionScript puro, faça o seguinte no construtor da sua classe de documento.
  • Se usar o Flex, chame isso no evento initialize() da classe principal.
  • Se usar código de linha do tempo no Flash, faça isso no Quadro 1.
  1. Importe as classes da API:
    importe com.vungle.extensions.*; 
    importe com.vungle.extensions.events.*;
  2. Inicialize a API chamando create() e passando em uma string do ID do seu aplicativo e uma array que contenha o ID de referência de posicionamento do aplicativo a partir do painel Vungle. Para iOS e para Android do mesmo projeto, forneça um ID de aplicativo diferente e sua array de posicionamento por plataforma ao método create().

    Empacote sua chamada para Vungle.create() em um try/catch porque o Vungle pode emitir um erro durante o processo de criação (por exemplo, a extensão emite um erro se estiver rodando no desktop):
    try
    {
        // inicializar com o ID de aplicativo
        Vungle.create("your_vungle_id", [“placement1”, “placement2”, “placement3”]);
     
    } catch (error:Error) {
        // não foi possível criar extensão. Você está executando em algo que não seja iOS/Android?
    }

Carregue um anúncio de posicionamento

Para reproduzir um anúncio de posicionamento, você deve carregar um anúncio para aquele posicionamento. Observe que seu posicionamento armazenado em cache automaticamente não requer que você chame este método. O SDK tentará carregar internamente o posicionamento armazenado em cache automaticamente.

Vungle.vungle.loadAd(“non_auto_cached_placement”);

Reproduza um anúncio de posicionamento

Você saberá quando o anúncio estiver pronto para ser reproduzido através dos listeners de evento. Uma vez que o posicionamento estiver disponível para ser reproduzido, você pode reproduzir um anúncio.

If (Vungle.vungle.isAdAvailable(“placement_id”)) {
    Vungle.vungle.playAd(“placement_id”);
}

Adicionar listeners de evento

A extensão Vungle emite quatro eventos: VungleEvent.AD_PLAYABLE, VungleEvent.AD_STARTED, VungleEvent.AD_FINISHED, VungleEvent.AD_FAILED, VungleEvent.AD_INIT e VungleEvent.AD_LOG.

  1. O AD_PLAYABLE é emitido quando um anúncio está pronto para ser reproduzido.
    Vungle.vungle.addEventListener(VungleEvent.AD_PLAYABLE, onAdPlayable);
    function onAdPlayable(e:VungleEvent):void
    {
        if (e.isAdPlayable) {
            trace(“ad is playable for placement: “ + e.placement);
            Vungle.vungle.playAd(e.placement);
        } else {
    	trace(“ad not playable for placement: “ + e.placement);
        }
    }
  2. Os eventos AD_STARTED e AD_FINISHED são emitidos quando um anúncio é exibido e descartado, respectivamente: 
    Vungle.vungle.addEventListener(VungleEvent.AD_STARTED, onAdStarted);
    Vungle.vungle.addEventListener(VungleEvent.AD_FINISHED, onAdFinished);
    
    function onAdStarted(e:VungleEvent):void
    {
        trace("ad displayed for placement: " + e.placement);
    }
    
    function onAdFinished(e:VungleEvent):void
    {
        trace("ad dismissed for placement: “ + e.placement + “, CTA = " + e.wasCallToActionClicked);
    
        if (e.wasSuccessfulView) {	
            trace("counts a completed view - present reward.");
        }
    }
  3. O AD_INIT é emitido quando o SDK Vungle finalizou a inicialização. 
    function onAdInit(e:VungleEvent):void
    {
        trace(“Vungle SDK is initialized: “ + e.isInitialized”);
    }
  4. O AD_LOG é emitido quando uma mensagem de log é enviada pelo SDK Vungle. Você pode usá-la para depuração. O log é implementado somente no SDK Vungle para iOS, de modo que este evento é específico por plataforma. 
    Vungle.vungle.setLoggingEnabled(true);
    Vungle.vungle.addEventListener(VungleEvent.AD_LOG, onAdLog);
    
    private function onAdLog(e:VungleEvent):void
    {
        log("ad log: " + e.message);
    }

Mais opções

Como você já viu antes, é possível passar um objeto com as opções de configuração ao chamar o método playAd(). Estas são as propriedades disponíveis em VungleAdConfig:

Opção

Valor

Descrição

orientação

VungleOrientation

Android

●      VungleOrientation.AUTO_ROTATE

●      VungleOrientation.ANDROID_MATCH_VIDEO

iOS

●      VungleOrientation.IOS_LANDSCAPE

●      VungleOrientation.IOS_PORTRAIT

soundEnabled

Booleano

Se for true (padrão), o som é ativado durante a reprodução do anúncio de vídeo, conforme as configurações de som do dispositivo. Se for false, a reprodução do vídeo começa muda. O usuário pode silenciar ou ativar o som durante a reprodução.

backButtonImmediatelyEnabled

Booleano

Para Android apenas, se definido como verdadeiro, permite que o usuário saia imediatamente de um anúncio através do botão de voltar. Se definida como falso (padrão), o usuário não poderá usar o botão Voltar para sair do anúncio enquanto o botão Fechar for exibido na tela.

immersiveMode

Booleano

Para Android apenas, se definido como verdadeiro, habilita modo imersivo em KitKat+ dispositivos. É definido como falso por padrão)

incentivizedUserId

String

Você pode definir o ID de usuário exclusivo, que será passado ao seu aplicativo, para verificar se esse usuário deve ser premiado por assistir a um anúncio com incentivo.

incentivizedCancelDialogTitle

String

Você pode personalizar uma mensagem para ser exibida aos usuários quando tentarem fechar o vídeo antes da sua conclusão.

 

Nota: Esta opção aplica-se apenas ao tipo padrão de anúncio Vungle e não a anúncios de modelo dinâmico. A opção que aplica-se a anúncios de modelo dinâmico está disponível no painel para especificação e tem as mesmas opções.

incentivizedCancelDialogBodyText

incentivizedCancelDialogCloseButtonText

incentivizedCancelDialogKeepWatchingButtonText

Exemplo de código:

var adConfig:VungleAdConfig = new VungleAdConfig();
            
adConfig.orientation = VungleOrientation.ANDROID_MATCH_VIDEO | VungleOrientation.IOS_LANDSCAPE;
adConfig.soundEnabled = false;

android: {
    adConfig.backButtonImmediatelyEnabled = true;
    adConfig.immersiveMode = true;
};

adConfig.incentivizedUserId = "vungle_test_user";
adConfig.incentivizedCancelDialogBodyText = "body_text";
adConfig.incentivizedCancelDialogCloseButtonText = "close_button_text";
adConfig.incentivizedCancelDialogKeepWatchingButtonText = "continue_button_text";
adConfig.incentivizedCancelDialogTitle = "title_text";

Vungle.vungle.playAd(placement, adConfig);

Padrões globais

Você pode usar o objeto de configuração global para definir valores padrão para estas opções:

// set any configuration options you like
VungleAdConfig.globalConfig.orientation = VungleOrientation.ANDROID_MATCH_VIDEO;
VungleAdConfig.globalConfig.soundEnabled = false;

Depois, cada novo objeto VungleAdConfig é criado com esses valores definidos por padrão. playAd() sem opções sempre usa a configuração global.

Nota: Enquanto seu aplicativo estiver em modo de teste, não será possível baixar nenhum dos aplicativos anunciados. Além disso, o Painel de Controle não informará o número de impressões. Isso acontece porque os anúncios de teste são usados somente para verificar se você integrou o SDK corretamente. Essa funcionalidade se torna disponível depois que seu aplicativo for publicado em modo ativo.

Notas adicionais

Uso do VungleExample.as Classe de documento em Animate ou Flash Professional CS6

  1. Primeiro, crie o aplicativo e adicione a extensão seguindo os passos 1-3 deste artigo de integração.
  2. Copie e cole os anúncios na mesma pasta do seu .fla. Não copie e cole o conteúdo na linha do tempo.
  3. Altere os ids de posicionamento do aplicativo na linha 20 para serem os seus próprios Ids Vungle.
  4. Em propriedades Flash, em Classe de documento, digite VungleExample e clique em OK.
  5. Faça o build e instale o aplicativo.

Instalação de uma nova versão do SDK AIR (4.0 ou superior) em Flash Professional CS6

Siga este link para encontrar o último SDK AIR. Se você já instalou o AIR 4.0 ou superior, pode pular essa etapa. Caso contrário, siga as instruções abaixo:

  1. Descompacte o pacote SDK AIR 4.0, ou superior, em um local do seu disco rígido.
  2. Inicie o Flash Professional CS6.
  3. Selecione Ajuda → Gerenciar AIR SDK...
  4. Clique no botão + (adição) e navegue até o local do SDK AIR descompactado.
  5. Clique em OK.
  6. Selecione Arquivo → Configurações de publicação.
  7. Selecione o SDK AIR para iOS mais recente no menu suspenso Destino.

Instalação de uma nova versão do SDK AIR (4.0 ou superior) em Flash Builder

Siga este link para encontrar o último SDK AIR. Se você já instalou o AIR 4.0 ou superior, pode pular essa etapa. Você pode também usar as últimas instruções da Adobe para atualização de SDKs do Flash Builder AIR.

Resolução do erro 'Adobe Animate Invalid Input'

Se você está recebendo um erro como o que aparece na imagem abaixo, consulte este artigo.

image2.png

Tem mais dúvidas? Envie uma solicitação

Comentários