Introdução ao Vungle (SDK v.1.0 - v.4.1) - Unity

Este guia explica a integração rápida do plugin Vungle Unity em um aplicativo de demonstração básico. O código fonte mencionado aqui está disponível em nosso repositório do GitHub público.

Conteúdo

  1. Antes de começar...
  2. Instalação do plugin Vungle Unity
  3. Adição do código.
  4. Execução do aplicativo de amostra do Vungle
  5. Como exportar um projeto Xcode no Windows

Antes de começar...

    1. O plugin Vungle Unity exige o Java 1.7 para Android e é compatível com iOS 7+.

      IMPORTANTE - Existe um bug nos Unity 5.3 e 5.3.1 que impede o Unity de compilar aplicativos para Windows 8.1. A Unity lançou um patch que resolve o problema e recomendamos utilizar as seguintes versões: 5.3.1p1, 5.3.1p2 e 5.3.1p3. NÃO USE O UNITY VERSÕES 5.3 OU 5.3.1!

    2. O plugin Vungle Unity:
      - para iOS é compatível com Unity 4 e Unity 5.4.1 ou superior.
      - para Android é compatível com Unity 5 e Unity 4. 
      - para Windows (Universal 8.1 ou Phone 8.1) é compatível com Unity 4 e superior.
      - para Windows (Windows 10 UWP) é compatível com Unity 5.2 e superior. 

    3. Para Windows, instale o SDK para Windows antes de seguir o restante das instruções para instalar o plugin Vungle Unity. O desenvolvimento para Windows só pode ser realizado em um PC com Windows. Tenha o SDK para Windows instalado para a versão da plataforma que utilizar no desenvolvimento:

      - Baixe o Windows SDK 8.1 - https://developer.microsoft.com/en-us/windows/downloads/windows-8-1-sdk

      - Baixe o Windows SDK 10 - https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk

    4. Anúncios Vungle em Windows N e KN Edition: Para usuários com a edição especial N ou KN do Windows, instale o "Media Feature Pack para as versões N e KN do Windows 10" para os anúncios do Vungle funcionarem.

    5. A integração exige uma conta Vungle, portanto, crie uma conta Vungle se você não tiver uma.

    6. Se ainda não o fez, abra nosso painel e adicione seu aplicativo à sua conta. Faça isso para obter sua ID de Aplicativo, que você adicionará a seu aplicativo com o SDK. Por exemplo, na imagem abaixo, a ID de Aplicativo está circulada em vermelhoe é encontrada na página do seu aplicativo.

      Em aplicativos mais recentes, a ID de Aplicativo pode corresponder à ID de API de Relatórios. Aplicativos já existentes, criados com o recurso 'pesquisar', podem ter ID de Aplicativo e ID de API de Relatórios diferentes uma da outra. (Para mediação a 'key' da API de Relatório está na página de detalhes da Conta de usuário.)

O plugin Vungle Unity não está incluído no código de amostra vinculado acima, então primeiro baixe-o do painel do Vungle.  Quando o download for concluído...

Instalação do plugin Vungle Unity

Com o Unity aberto e seu projeto apresentado, clique duas vezes no arquivo baixado VunglePlugin.unitypackage para adicionar o plugin Vungle Unity ao seu aplicativo.

Clique em Todos para selecionar todos antes de importar.

Confira se direcionou para a plataforma correta em Configurações de Versão.

Para evitar erros de compilação durante a próxima etapa, certifique-se de que as Configurações de Versão do seu projeto (cmd + Shift + B) estejam selecionando a plataforma iOS, Android ou Windows.

Para Windows

Se está usando o Unity 5 for Windows, nosso SDK tem um arquivo VungleSDK.winmd específico para cada plataforma Windows. Esses arquivos estão localizados em diretórios cujo nome indica a plataforma correspondente. Usando esta imagem, complete as configurações a seguir:

Na guia Projeto, selecione o SDK Vungle adequado. Confirme se os seguintes parâmetros na guia Inspetor, nas seções Selecionar plataformas para plugin e Configurações da plataforma estejam definidos corretamente:

  • Para Assets/Plugins/metro/VungleSDKProxy.winmd:
    Plataforma: WSAPlayer
    SDK: qualquer
    espaço reservado de SDK: Assets/Plugins/VungleSDKProxy.dll:

  • Para Assets/Plugins/metro/VungleSDK.winmd:
    Plataforma: WSAPlayer
    SDK: SDK81

  • Para Assets/Plugins/metro/UWP/VungleSDK.winmd:
    Plataforma: WSAPlayer
    SDK: UWP

  • Para Assets/Plugins/metro/WindowsPhone81/VungleSDK.winmd:
    Plataforma: WSAPlayer
    SDK: Phone SDK81

Importante! Se utiliza o Unity versão 5.3.1 ou superior para compilar o projeto Universal 8.1 ou Phone 8.1, você deve desativar o uso de Assets/Plugins/metro/UWP/VungleSDK.winmd de uma dessas formas:

  • Selecione Assets/Plugins/metro/UWP/VungleSDK.winmd e, na guia Inspetor, na seção Selecionar plataformas para plugin, desmarque a opção WSAPlayer
  • Ou exclua Assets/Plugins/metro/UWP/VungleSDK.winmd

Se utiliza o Unity 4, abra Configurações de Player --> Configurações de Publicação e altere estas opções:

  • Unprocessed Plugins: Size 1
  • Element 0: VungleSDKProxy.dll

Após publicar o projeto de Windows no Unity, verifique se seu projeto tem o recurso internetClient no ambiente do Unity. Abra as Configurações de Versão (shift + ctrl + b) --> Selecione Windows Store na Plataforma --> clique em Configurações de Player. Em Configurações de Publicação, no menu Recursos, marque a opção InternetClient, assim:

Adicione o código.

Neste passo a passo, vamos inicializar todo o nosso código relacionado ao Vungle em um script anexado ao principal Objeto de Jogo, mas não hesite em chamar o plugin Vungle Unity de qualquer script que você achar adequado.  É recomendável inicializar o plugin Vungle Unity o mais rápido possível para garantir que os SDKs da Vungle concluam a configuração a tempo de apresentar um anúncio ao usuário quando 'playAd' é chamado.

Inicialize

A inicialização é apenas uma linha. Basta chamar uma vez, e serve para preparar o plugin Vungle Unity para apresentar anúncios ao usuário *Tente inicializar o SDK Vungle logo que possível em seu aplicativo, porque o SDK precisa de 30 a 45 segundos para inicializar e armazenar um anúncio para a reprodução*:

//Suas IDs de Aplicativo estão no Painel de Controle do Vungle nas páginas do seu aplicativo
Vungle.init ("Test_Android", "Test_iOS", "Test_Windows");

Reprodução de anúncios

Reproduzir um anúncio também ocupa uma linha.

//Curto e simples!
Vungle.playAd();

O método playAd também pode aceitar um dicionário de opções para personalizar a experiência de reprodução de anúncios:

// Reproduz um anúncio com mais opções. Use Dictionary<string,object> para definir as opções.
public static void playAdWithOptions( Dictionary<string,object> options );

O dicionário de opções aceita as seguintes chaves:

Chave Descrição
incentivized

Você pode optar por uma notificação sempre que um usuário concluir um anúncio. Um exemplo típico é quando você oferece algum tipo de troca de valores ("assista a este vídeo e receba 100 créditos."). Se decidir que seus anúncios ofereçam um incentivo, enviaremos imediatamente uma mensagem ao seu servidor com uma ID de usuário (fornecida por você) para que possa recompensar seus usuários. Se esta chave for definida como "true", seu anúncio terá incentivo. Consulte nossas instruções para configurar anúncios incentivados.

Dictionary<string, object> options = new Dictionary<string, object> ();
options ["incentivized"] = true;
Vungle.playAdWithOptions (opções);
orientation

Define a orientação do anúncio.

  • Para iOS, use VungleAdOrientation:
public enum VungleAdOrientation
{
    Portrait = 1,
    LandscapeLeft = 2,
    LandscapeRight = 3,
    PortraitUpsideDown = 4,
    Landscape = 5,
    All = 6,
    AllButUpsideDown = 7
}
  • Para Android, use true para matchVideo e false para autoRotate.
  • Para Windows, use true para autoRotate e false para landscape. (O padrão é autoRotate.)
userTag O usuário da chave é aquele passado como usuário na chamada de servidor a servidor (se houver).
placement Metadados com detalhes de colocação de uma reprodução de anúncio individual.  Isso serve para filtrar diferentes experiências de anúncios ao recuperar dados de relatório de seu aplicativo.
alertTitle String usada como título da caixa de diálogo de alerta, apresentada quando um usuário fecha prematuramente um anúncio com incentivo.
alertText String usada como texto da caixa de diálogo de alerta, apresentada quando um usuário fecha prematuramente um anúncio com incentivo.
closeText String de título para o texto do botão de fechar da caixa de diálogo de alerta, apresentada quando um usuário fecha prematuramente um anúncio com incentivo.
continueText String de título para o texto do botão de fechar da caixa de diálogo de alerta, apresentada quando um usuário fecha prematuramente um anúncio com incentivo.
immersive

Immersive mode

key1..8 Nós temos 8 chaves integradas aqui

Recursos OnPause e OnResume

Adicione código para os recursos onPause e onResume que permitem a um anúncio pausado quando um aplicativo foi para segundo plano voltar a ser reproduzido:

void OnApplicationPause(bool pauseStatus) {
	if (pauseStatus) {
		Vungle.onPause();
	}
	else {
		Vungle.onResume();
	}
}

Tratamento de eventos

O plugin Vungle Unity permite que um aplicativo se inscreva para 4 eventos em torno da apresentação do anúncio:

// Ativado quando um anúncio do Vungle está pronto exibição
public static event Action<bool> adPlayableEvent;
// Ativado quando um anúncio do Vungle inicia
public static event Action onAdStartedEvent;
//Ativado quando um anúncio do Vungle termina e dá todas as informações sobre este evento
public static event Action<AdFinishedEventArgs> onAdFinishedEvent;

A classe AdFinishedEventArgs tem os seguintes parâmetros.

public class AdFinishedEventArgs : EventArgs
{
	// true Se um usuário clicou em Download para abrir a loja
	public bool WasCallToActionClicked;

	// true se assistiu pelo menos 80% do vídeo
	public bool IsCompletedView;

	// tempo que o anúncio do Vungle foi assistido
	public double TimeWatched;

	// tempo total do anúncio do Vungle
	public double TotalDuration;
}
// Ativado quando o SDK envia um evento de log
public static event Action<string> onLogEvent;

Nota: Estes três eventos estão obsoletos :

// OBSOLETO: use o evento adPlayableEvent.
public static event Action onCachedAdAvailableEvent;

// OBSOLETO: use o evento onAdFinishedEvent.
public static event Action onAdEndedEvent;
	
// OBSOLETO: use o evento onAdFinishedEvent.
public static event Action<double,double> onAdViewedEvent;

A inscrição nesses eventos é fácil e é feita pelo objeto VungleManager. Em C#, a adição de um ouvinte de evento seria assim:

// Funcionalidade encapsulada chamada de maneira assíncrona cada vez que um evento é acionado
Vungle.adPlayableEvent += (isAdAvailable) => {
	if (isAdAvailable) {
DebugLog ("Anúncio pronto para reprodução.");
} else {
DebugLog ("Nenhum anúncio disponível no momento.");
} };

E pronto! Para mais informações sobre plugins Vungle Unity veja outros artigos de plugin, ou pesquise no código-fonte o nosso aplicativo de amostra Unity

 

Nota ao testar seu aplicativo no Modo de teste: Com seu aplicativo em modo Test, não é 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 texto são usados somente para verificar se você integrou o SDK corretamente. Esta funcionalidade se torna disponível assim que seu aplicativo seja publicado no modo ativo.

Execução do aplicativo de amostra do Vungle

Para executar nosso aplicativo de amostra, abra a pasta Assets -->Plugins --> Vungle --> demo e clique duas vezes em VungleCombo.unity para carregar o aplicativo. Confirme que VungleCombo esteja visível sob a janela Hierarquia, e clique em Build and Run (Compilar e executar).

Como exportar um projeto Xcode no Windows

Para exportar um projeto Xcode do Unity em um computador com Windows, você deverá ter a linguagem de programação Python instalada nesse computador. Independentemente de estar instalando Python para esse fim ou enfrentando problemas com a exportação, instale a última versão de Python: https://www.python.org/.

 

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

Comentários