O SDK dos anúncios para dispositivos móveis do Google também é compatível com estilos de pesquisa personalizados. Se o app já usa o SDK dos anúncios para dispositivos móveis do Google, recomendamos utilizar a versão do SDK do AFSMA.
Se você estiver fazendo upgrade da versão 19.0.0 ou anterior para a versão 19.0.0 ou anterior, consulte nosso guia de migração.
Pré-requisitos
Para seguir este guia de implementação, é necessário ter familiaridade com:
- Anúncios personalizados de pesquisa do Google AdSense com estilos de pesquisa personalizados
- Desenvolvimento de apps Android
Importar o SDK nativo do AFS
Adicionar o SDK
Para adicionar o SDK nativo do AFS ao seu app, faça o seguinte:
Abra o arquivo build.gradle
dentro do diretório do módulo do aplicativo.
Adicione uma nova regra de build em dependencies
para a versão mais recente do SDK:
dependencies {
implementation 'com.google.android.gms:play-services-afs-native:19.1.0'
}
Verifique se o build.gradle
de nível superior contém uma referência ao repositório google()
ou ao maven { url "https://maven.google.com" }
.
Siga estas instruções
para incluir o plug-in de correspondência de versão independente do Google Play no seu projeto.
A aplicação desse plug-in causa um erro de build do Gradle quando o SDK nativo do AFS é usado com uma versão incompatível do Google Play Services, em vez de permitir que o app seja criado, o que pode causar falhas no ambiente de execução. Ou aplique a
ResolutionStrategy
failOnVersionConflict()
ao projeto para causar um erro de build quando versões incompatíveis do Google Play
Services forem usadas no projeto.
Salve as mudanças e clique em Sync Project with Gradle Files na
barra de ferramentas.
Usar o AndroidX em vez das Bibliotecas de Suporte do Android
A partir da versão 17.0.0
do SDK, seu app precisa usar as bibliotecas do Jetpack (AndroidX)
em vez das Bibliotecas de Suporte do Android. Requisitos de compatibilidade:
- Defina
com.android.tools.build:gradle
como v3.2.1 ou mais recente. - Defina
compileSdkVersion
como 28 ou mais recente. - Atualize o app para usar o Jetpack (AndroidX). Siga as instruções em Como migrar para o AndroidX.
Classes
Para veicular anúncios nativos do AFS no seu aplicativo, implemente as seguintes classes:
- Essa classe é responsável pela solicitação assíncrona de anúncios, armazenamento em cache, recuperação e renderização de anúncios.
- Cada contexto de anúncio precisa de um
SearchAdController
separado. Por exemplo, se você tem uma tela que mostra anúncios ao lado de uma lista de resultados da pesquisa e outra que mostra anúncios com detalhes de um produto específico, crie duas instâncias separadas deSearchAdController
, uma para cada caso. - O construtor precisa receber seu código de propriedade da Web (ID do editor), ID de estilo para aplicar aos anúncios retornados e
SearchAdOptions
. OContext
fornecido no construtor precisa ser oActivity
que contém oSearchAdController
e onde você colocará o anúncioView
. - Chame
loadAds
para indicar uma nova pesquisa de usuário e iniciar uma solicitação de anúncio assíncrona. Todos os anúncios carregados de chamadas anteriores paraloadAds
são apagados do cache interno de anúncios quando uma nova chamada é feita. - Crie uma
View
comcreateAdView
para mostrar criativos de anúncios. - Depois que os anúncios forem carregados, chame
populateAdView
com umaView
gerada anteriormente comcreateAdView
para renderizar um anúncio armazenado em cache nessaView
. Além doView
que será preenchido, forneça umadKey
, uma string arbitrária para identificar o anúncio de maneira exclusiva. Isso associa o criativo de anúncio específico retornado do cache a esseadKey
. Assim, quando o mesmoadKey
for transmitido para uma chamada futura parapopulateAdView
, o mesmo anúncio será retornado. Por exemplo, sepopulateAdView
for chamado pela primeira vez comadKey="keyA"
e renderizar um anúncio para botas para caminhada, cada chamada subsequente parapopulateAdView
comadKey="keyA"
preencherá o mesmo anúncio para botas para caminhada. Fazer uma nova chamada paraloadAds
limpa todos os anúncios em cache e as chaves de anúncio associadas.
- Transmita esse objeto ao construtor
SearchAdController
para personalizar como os anúncios são solicitados e mostrados. Chamebuild()
em umSearchAdOptions.Builder
para criar um objetoSearchAdOptions
.
View
- Crie um objeto
View
para reter anúncios chamandocreateAdView()
noSearchAdController
. É exibido no máximo um anúncio por vez, mas o mesmoView
pode ser reciclado para mostrar anúncios diferentes ao longo do tempo.
- Chame o método
loadAds
noSearchAdController
com umSearchAdRequest
para iniciar uma solicitação de anúncio assíncrona. Chamebuild()
em umSearchAdRequest.Builder
para criar um objetoSearchAdRequest
.
- Implemente essa interface e a transmita ao construtor
SearchAdController
para registrar callbacks para vários estados. - Observação: os callbacks
AdListener
não serão chamados em uma solicitação cancelada, ou seja, uma chamada paraloadAds
que foi interrompida por outra chamada paraloadAds
antes da resolução da primeira chamada.
Implementação de exemplo
O exemplo abaixo demonstra a criação de um SearchAdController
em uma
Activity
.
// MainActivity.java implementation
// (MainActivity is a subclass of Activity)
SearchAdController adController;
// adContainer where we will place our ads in this example.
ViewGroup adContainer;
protected void onCreate(Bundle bundle){
super.onCreate(bundle);
adContainer = (ViewGroup) findViewById(...);
// Specify ad options (not required).
SearchAdOptions.Builder adOptionsBuilder = new SearchAdOptions.Builder();
adOptionsBuilder.setAdType(SearchAdOptions.AD_TYPE_TEXT);
adOptionsBuilder.setPrefetch(true);
adOptionsBuilder.setNumAdsRequested(3);
// Provide a callback to trigger when ads are loaded.
AdListener adListener = new AdListener() {
public void onAdLoaded() {
createAndShowAd();
}
};
// Instantiate the SearchAdController.
adController = new SearchAdController(this, "your-client-id", "your-style-id",
adOptionsBuilder.build(), adListener);
}
Quando o usuário iniciar uma consulta, crie um SearchAdRequest
e chame loadAds
na SearchAdController
para iniciar uma solicitação de anúncio assíncrona.
// Create the request.
SearchAdRequest.Builder requestBuilder = new SearchAdRequest.Builder();
requestBuilder.setQuery("user query here");
// Load the ads.
adController.loadAds(requestBuilder.build());
Implemente o callback onAdLoaded
para preencher um anúncio carregado em uma visualização de anúncio.
private void createAndShowAd() {
// Create a new view that will contain the ad.
View adView = adController.createAdView();
// Attach the new view to the view hierarchy.
adContainer.addView(adView);
// Display the ad inside the adView. We need to provide an adKey to
// indicate which ad is to be displayed in the adView. In this example,
// since we only have one ad, we can provide any constant string. However,
// if you intend to display multiple ads, each ad you wish to display
// should be given a unique adKey of your choosing.
adController.populateAdView(adView, "demoAd");
}
Um anúncio relacionado à consulta específica vai aparecer no adView
.
Como investigar erros
O SearchAdController
requer um objeto AdListener
com o método onAdLoaded()
para notificar seu app de que os anúncios estão prontos para exibição. Você também precisa
implementar o método onAdFailedToLoad()
para detectar e corrigir erros.
Por exemplo, use o AdListener
abaixo para depurar a
implementação:
AdListener adListener = new AdListener() {
public void onAdLoaded() {
// Called when an ad is loaded.
Toast.makeText(MainActivity.this, "Ad Loaded",
Toast.LENGTH_SHORT).show();
Log.d(MainActivity.class.getSimpleName(), "Ad Loaded");
}
public void onAdLeftApplication() {
// Called when an ad leaves the application
// (to go to the browser for example).
Toast.makeText(MainActivity.this, "Ad Left Application",
Toast.LENGTH_SHORT).show();
Log.d(MainActivity.class.getSimpleName(), "Ad Left Application");
}
@Override
public void onAdFailedToLoad(int errorCode) {
// Called when an ad request failed.
Toast.makeText(MainActivity.this, "Ad Failed to Load: " + errorCode,
Toast.LENGTH_SHORT).show();
Log.e(MainActivity.class.getSimpleName(), "Ad Failed to Load: " +
errorCode);
}
};
Constantes usadas no método de callback onAdFailedToLoad()
são definidas no AdListener.