Integração do Vungle SDK para Android ou Amazon

David Kim

2 de setembro de 2021 00:02

Antes de começar

O Vungle SDK foi desenvolvido e testado até a versão 30 da API, Android 11.

Requisitos

A integração requer uma conta Vungle, portanto, crie uma conta Vungle se ainda não tiver uma e crie um novo aplicativo Android ou Amazon em sua conta. Consulte a seção Adicionar seus aplicativos e posicionamentos do nosso artigo Usando o painel do distribuidor para saber como configurar posicionamentos no painel Vungle.
Android 4.0 (Ice Cream Sandwich - API versão 14 ou superior)
Amazon OS 5.4 ou superior
Sua plataforma deve ser AndroidX no Android SDK 6.5.1 ou superior

Fazer download do SDK

Integração do Vungle SDK para Android ou Amazon: https://publisher.vungle.com/sdk/sdks/android

Referência: aplicativo de exemplo e documento Java

Aplicativo de exemplo: consulte o aplicativo de exemplo que fornecemos ao fazer a integração: https://github.com/Vungle/Android-SDK

JavaDoc: https://vungle.github.io/vungle-android-sdk/javadoc

Etapa 1. Incluir o Vungle SDK no seu projeto

Você pode integrar o Vungle SDK como uma dependência do Gradle ou manualmente usando uma integração JAR ou AAR.

// API version compatibility
minSdkVersion 14
compileSdkVersion 30
targetSdkVersion 30

Gradle

Abra o nível do projeto build.gradle e certifique-se de que os detalhes do JCenter sejam os mostrados aqui:

allprojects {
  repositories {
    jcenter()
  }
}

Abra o arquivo no nível do aplicativo build.gradle do seu projeto e adicione as dependências de compilação na seção dependencies.

buildscript {
  repositories {
    jcenter()
  }
}

dependencies { 
  // Vungle SDK
  implementation 'com.vungle:publisher-sdk-android:6.9.1'
 
  implementation 'androidx.core:core:1.3.2'
  implementation 'androidx.localbroadcastmanager:localbroadcastmanager:1.0.0'

  // When appcompat is being used, core and localbroadcastmanager are the dependencies
  // that is getting included
  // implementation 'androidx.appcompat:appcompat:1.2.0'

  // Recommended for SDK to be able to get Android Advertising ID
  implementation 'com.google.android.gms:play-services-basement:17.5.0'
  implementation 'com.google.android.gms:play-services-ads-identifier:17.0.0'
}

JAR

Download the Vungle SDK and unzip it. From the libs folder, copy all the .jar files, and add them to your project libs folder:
- vungle-android-sdk-6.9.1.jar
- gson-2.8.6.jar
- okhttp-3.12.12.jar
- okio-1.15.0.jar

Abra o arquivo do nível do aplicativo build.gradle do seu aplicativo e adicione outras dependências na seção dependencies.

dependencies {
  // Vungle SDK
  implementation files('libs/vungle-android-sdk-6.9.1.jar')

  // Required Third-party Dependencies
  implementation files('libs/gson-2.8.6.jar')
  implementation files('libs/okhttp-3.12.12.jar')
  implementation files('libs/okio-1.15.0.jar')

  implementation 'androidx.core:core:1.3.2'
  implementation 'androidx.localbroadcastmanager:localbroadcastmanager:1.0.0'

  // When appcompat is being used, core and localbroadcastmanager are the dependencies
  // that is getting included
  // implementation 'androidx.appcompat:appcompat:1.2.0'

  // Recommended for SDK to be able to get Android Advertising ID
  implementation 'com.google.android.gms:play-services-basement:17.5.0'
  implementation 'com.google.android.gms:play-services-ads-identifier:17.0.0'
}

Atualize AndroidManifest.xml adicionando as seguintes linhas e atribuindo o nome do item do aplicativo ao nome de classe do seu aplicativo:

<uses-sdk
    android:minSdkVersion="14"
    android:targetSdkVersion="30" />

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" android:maxSdkVersion="18" />

<application
    android:fullBackupContent="@xml/vungle_backup_rule"
    android:hardwareAccelerated="true"
    android:supportsRtl="true" >
    <activity
        android:name="com.vungle.warren.ui.VungleActivity"
        android:configChanges="keyboardHidden|orientation|screenSize|screenLayout|smallestScreenSize|uiMode"
        android:launchMode="singleTop"
        android:theme="@android:style/Theme.NoTitleBar.Fullscreen" />

    <receiver
        android:name="com.vungle.warren.NetworkProviderReceiver"
        android:enabled="false" >
        <intent-filter>
            <action android:name="android.net.conn.CONNECTIVITY_CHANGE" />
            <category android:name="android.intent.category.DEFAULT" />
        </intent-filter>
    </receiver>

    <provider
        android:name="com.vungle.warren.utility.VungleProvider"
        android:authorities="${applicationId}.vungle-provider"
        android:exported="false" />
</application>

Inclua as regras de exclusão do Vungle para permitir o fullBackupContent.

AAR

Download the Vungle SDK and unzip it. From the libs folder, copy SDK .aar and all .jar dependencies, and add them to your project libs folder:
- vungle-android-sdk-6.9.1.aar
- gson-2.8.6.jar
- okhttp-3.12.2.jar
- okio-1.15.0.jar

Abra o arquivo do nível do aplicativo build.gradle do seu aplicativo e adicione outras dependências na seção dependencies.

dependencies {
  // Vungle SDK
  implementation files('libs/vungle-android-sdk-6.9.1.aar')

  // Required Third-party Dependencies
  implementation files('libs/gson-2.8.6.jar')
  implementation files('libs/okhttp-3.12.12.jar')
  implementation files('libs/okio-1.15.0.jar')

  implementation 'androidx.core:core:1.3.2'
  implementation 'androidx.localbroadcastmanager:localbroadcastmanager:1.0.0'

  // When appcompat is being used, core and localbroadcastmanager are the dependencies
  // that is getting included
  // implementation 'androidx.appcompat:appcompat:1.2.0'

  // Recommended for SDK to be able to get Android Advertising ID
  implementation 'com.google.android.gms:play-services-basement:17.5.0'
  implementation 'com.google.android.gms:play-services-ads-identifier:17.0.0'
}

Etapa 2. Importar o Vungle SDK

import com.vungle.warren.Vungle;
import com.vungle.warren.AdConfig;              // Custom ad configurations
import com.vungle.warren.InitCallback;          // Initialization callback
import com.vungle.warren.LoadAdCallback;        // Load ad callback
import com.vungle.warren.PlayAdCallback;        // Play ad callback
import com.vungle.warren.VungleNativeAd;        // MREC ad
import com.vungle.warren.Banners;               // Banner ad
import com.vungle.warren.VungleBanner;          // Banner ad
import com.vungle.warren.Vungle.Consent;        // GDPR consent
import com.vungle.warren.VungleSettings         // Minimum disk space
import com.vungle.warren.error.VungleException  // onError message

Etapa 3. Adicionar código

Inicializar o SDK

public static void init(@NonNull final String appId,
                        @NonNull final Context context,
                        @NonNull final InitCallback callback)

public static void init(@NonNull final String appId,
                        @NonNull final Context context,
                        @NonNull final InitCallback callback,
                        @NonNull final VungleSettings settings)

O método de inicialização segue os seguintes parâmetros:

ID do aplicativo Vungle
Contexto do aplicativo
InitCallback
- onSuccess: notifica quando o SDK foi inicializado com êxito
- onError: notifica quando há falha na inicialização
  - Gera IllegalArgumentException se InitCallback for nulo.
- onAutoCacheAdAvailable: notifica quando o posicionamento com cache automático tem um anúncio disponível para ser reproduzido
VungleSettings (opcional)
- Espaço mínimo em disco - Configure o espaço mínimo disponível no dispositivo para inicialização e operação do SDK
- Restringir Android ID - Configurar a restrição de uso de ID de dispositivos Android

Vungle.init(appId, getApplicationContext(), new InitCallback() {
  @Override
  public void onSuccess() {
    // SDK has successfully initialized
  }

  @Override
  public void onError(VungleException exception) {
    // SDK has failed to initialize
  }

  @Override
  public void onAutoCacheAdAvailable(String placementId) {
    // Ad has become available to play for a cache optimized placement
  }
};

// 6.4.x & below
Vungle.init(appId, getApplicationContext(), new InitCallback() {
  @Override
  public void onSuccess() {
    // SDK has successfully initialized
  }

  @Override
  public void onError(Throwable throwable) {
    // SDK has failed to initialize
  }

  @Override
  public void onAutoCacheAdAvailable(String placementId) {
    // Ad has become available to play for a cache optimized placement
  }
};

Métodos substituíveis	Descrição
`onSuccess()`	Chamado quando o SDK foi inicializado com sucesso e está pronto para carregar um anúncio ou reproduzir um, se houver
`onError(VungleException exception)`	Chamado quando ocorre um erro ao tentar inicializar o SDK. Você poderá verificar a mensagem de erro de `getLocalizedMessage` de `VungleException`e usar `getExceptionCode` para depuração.
`onAutoCacheAdAvailable(String placementId)`	Chamado quando um anúncio se torna disponível para reprodução em canais otimizados para cache. O distribuidor ainda deve emitir `loadAd` explicitamente para posicionamentos otimizados em cache, conforme descrito em Carregar um anúncio para um posicionamento.

Você pode verificar a qualquer momento se o Vungle SDK está inicializado. Para isso, faça a chamada do método isInitialized:

public static boolean isInitialized()

Integrar formatos de anúncio

Conclua a integração do SDK para cada formato de anúncio que você planeja exibir em seu aplicativo. Consulte nossas instruções para cada formato de anúncio:

Personalize ainda mais seus anúncios

Siga as instruções em nosso artigo Configurações avançadas para ajustar a integração do seu aplicativo com opções de configuração adicionais, como RGPD, implementação de CCPA e muitas outras configurações.