AppsFlyerLib
Visão Geral
AppsFlyerLib
é a principal classe do SDK do Android da AppsFlyer e encapsula a maioria dos métodos.
Volte para o índice de referência do SDK.
Importe a biblioteca
import com.appsflyer.AppsFlyerLib;
Acesse a instância do SDK
Acesse a instância singleton do SDK:
AppsFlyerLib appsflyer = AppsFlyerLib.getInstance();
Métodos
addPushNotificationDeepLinkPath
Assinatura do método
void addPushNotificationDeepLinkPath(java.lang.String... deepLinkPath)
Descrição
Configura como o SDK extrai valores de deep links de payloads de notificação push.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
String... | deepLinkPath | Uma matriz de String s que corresponde ao caminho JSON do deep link. |
Retorna
void
.
Exemplo de uso
Configuração básica:
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("af_push_link");
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("af_push_link")
Configuração avançada:
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("deeply", "nested", "deep_link");
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("deeply", "nested", "deep_link")
Esta chamada corresponde à seguinte estrutura de payload:
{
"deeply": {
"nested": {
"deep_link": "https://yourdeeplink2.onelink.me"
}
}
}
anonymizeUser
Assinatura do método
void anonymizeUser(boolean shouldAnonymize)
Descrição
Anonimizar as instalações, os eventos e as sessões de um usuário.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
boolean | shouldAnonymize | O padrão é false . |
Retorna
void
Exemplo de uso
AppsFlyerLib.getInstance().anonymizeUser(true);
AppsFlyerLib.getInstance().anonymizeUser(true)
appendParametersToDeepLinkingURL
Assinatura do método
void appendParametersToDeepLinkingURL(java.lang.String contains,
java.util.Map<java.lang.String,java.lang.String> parameters)
Descrição
Permite que os proprietários de aplicativos que usam links de aplicativos para deep linking (sem o OneLink) atribuam sessões iniciadas por meio de um domínio associado ao aplicativo.
Chame este método antes de chamar
start
Você deve fornecer os seguintes parâmetros no parameters
Map
:
pid
is_retargeting
deve ser definido comotrue
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
String | contains | Uma string contida no URL do deep link |
Map<String, String> | parameters | Parâmetros de atribuição a serem anexados às URLs correspondentes |
Retorna
void
Exemplo de uso
HashMap<String, String> urlParameters = new HashMap<>();
urlParameters.put("pid", "exampleDomain"); // Required
urlParameters.put("is_retargeting", "true"); // Required
AppsFlyerLib.getInstance().appendParametersToDeepLinkingURL("example.com", urlParameters);
AppsFlyerLib.getInstance().appendParametersToDeepLinkingURL("example.com",
mapOf("pid" to "exampleDomain", "is_retargeting" to "true")) // Required
No exemplo acima, a URL de atribuição resultante enviada aos servidores AppsFlyer é:
example.com?pid=exampleDomain&is_retargeting=true
enableFacebookDeferredApplinks
Assinatura do método
void enableFacebookDeferredApplinks(boolean isEnabled)
Descrição
Ative a coleção de AppLinks adiados do Facebook. Requer o SDK do Facebook e o aplicativo do Facebook no dispositivo do alvo/cliente.
Essa API deve ser chamada antes de inicializar o SDK da AppsFlyer para funcionar corretamente.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
boolean | isEnabled | Caso os links de aplicativos adiados do Facebook sejam processados pelo SDK da AppsFlyer. |
Retorna
void
enableLocationCollection
Removido na V6.8.0
Assinatura do método
AppsFlyerLib enableLocationCollection(boolean flag)
Descrição
Habilite o SDK da AppsFlyer para coletar o último local conhecido. Requer permissões de manifesto ACCESS_COARSE_LOCATION
and ACCESS_FINE_LOCATION
.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
boolean | flag |
Retorna
void
enableTCFDataCollection
Assinatura do método
AppsFlyerLib enableTCFDataCollection (boolean flag)
Descrição
Enables the collection of Transparency and Consent Framework (TCF) data from SharedPreferences
. The data was placed in SharedPreferences
by the device TCF v2.2 compatible Consent Management Platform (CMP).
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
Booleano | flag | A boolean value to enable (true ) or disable (false ) the collection of TCF data. The SDK collects TCF data when the flag is set to true . |
Retorna
void
getAppsFlyerUID
Assinatura do método
java.lang.String getAppsFlyerUID(Context context)
Descrição
Obter o ID do dispositivo exclusivo da AppsFlyer. O SDK gera um ID de dispositivo exclusivo da AppsFlyer na instalação do aplicativo. Quando o SDK é iniciado, esse ID é registrado como o ID da primeira instalação do aplicativo.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
Context | context | Contexto do aplicativo/atividade. |
Retorna
ID de dispositivo exclusivo da AppsFlyer.
Exemplo de uso
String appsFlyerId = AppsFlyerLib.getInstance().getAppsFlyerUID(this);
String appsFlyerId = AppsFlyerLib.getInstance().getAppsFlyerUID(this)
getAttributionId
Assinatura do método
java.lang.String getAttributionId(Context context)
Descrição
Obtenha a ID de atribuição do Facebook, se houver.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
Context | context | Contexto do aplicativo/atividade. |
Retorna
void
Exemplo de uso
String attributionId = AppsFlyerLib.getInstance().getAttributionId(this);
String attributionId = AppsFlyerLib.getInstance().getAttributionId(this)
getHostName
Assinatura do método
java.lang.String getHostName()
Descrição
Obtenha o nome do host.
O valor padrão é "appsflyer.com"
Argumentos de entrada
Esta função não usa parâmetros.
Retorna
Tipo | Descrição |
---|---|
String | Nome do host atualmente definido. |
Exemplo de uso
getHostPrefix
Assinatura do método
java.lang.String getHostPrefix()
Descrição
Obtenha o prefixo do host de conjunto personalizado.
Argumentos de entrada
Esta função não usa parâmetros.
Retorna
Prefixo do host.
getInstance
Assinatura do método
AppsFlyerLib getInstance()
Descrição
Retorna a instância do SDK, através da qual você pode acessar os métodos descritos neste documento.
Argumentos de entrada
Esta função não usa parâmetros.
Retorna
Instância singleton AppsFlyerLib.
getOutOfStore
Assinatura do método
java.lang.String getOutOfStore(Context context)
Descrição
Obtenha o valor do referenciador da loja de aplicativos de terceiros.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
Context | context | Contexto do aplicativo/atividade. |
Retorna
AF_Store
valor.
getSdkVersion
Assinatura do método
java.lang.String getSdkVersion()
Descrição
Obtenha a versão do SDK da AppsFlyer usada no aplicativo.
Argumentos de entrada
Esta função não usa parâmetros.
Retorna
Versão do SDK da AppsFlyer.
init
Assinatura do método
AppsFlyerLib init(java.lang.String key,
AppsFlyerConversionListener conversionDataListener,
Context context)
Descrição
Use esse método para inicializar o SDK da AppsFlyer. Esta API deve ser chamada dentro do aplicativo onCreate
método.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
String | key | Chave do desenvolvedor da AppsFlyer |
AppsFlyerConversionDataListener | conversionDataListener | (Opcional) implemente o AppsFlyerConversionDataListener para acessar os dados de conversão da AppsFlyer. Pode ser nulo. |
Context | context | Contexto do aplicativo. |
Retorna
void
Exemplo de uso
Consulte inicializando o SDK.
isPreInstalledApp
Assinatura do método
boolean isPreInstalledApp(Context context)
Descrição
Indicador booleano para pré-instalação pelo fabricante.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
Context | context | Contexto do aplicativo/atividade. |
Retorna
boolean
.
Exemplo de uso
isStopped
Assinatura do método
boolean isStopped()
Descrição
Verifique se o SDK foi interrompido.
Argumentos de entrada
Esta função não usa parâmetros.
Retorna
Tipo | Descrição |
---|---|
boolean | true se parado, false em caso contrário. |
Exemplo de uso
logAdRevenue
Added in v6.15.0
Assinatura do método
public abstract void logAdRevenue(
@NonNull AFAdRevenueData adRevenueData,
@Nullable Map<String, Object> additionalParameters
);
Descrição
The method sends an ad revenue event to AppsFlyer. See more information in Ad revenue.
Parâmetros de entrada
Nome | Tipo | Descrição |
---|---|---|
adRevenueData | AFAdRevenueData | An object that encapsulates all the mandatory parameters of the adRevenue event. The object is passed to the logAdRevenue method. |
additionalParameters | Map<String, Object> | An optional dictionary containing additional parameters to log with the adRevenue event. |
Retorna
void
.
AFAdRevenueData
An object that encapsulates all mandatory adRevenue
data received from the mediation network.
Definition
data class AFAdRevenueData(
val monetizationNetwork: String,
val mediationNetwork: MediationNetwork,
val currencyIso4217Code: String,
val revenue: Double
)
AFAdRevenueData parameters
Nome | Tipo | Descrição |
---|---|---|
monetizationNetwork | Sequência de caracteres | The monetization network name. |
mediationNetwork | MediationNetwork | The mediation network enum. |
currencyIso4217Code | Sequência de caracteres | The ad revenue event currency is a String validated against currencyIso4217Code |
revenue | Double | The ad revenue event amount. |
MediationNetwork
Nome | Tipo | Comments |
---|---|---|
ironsource | Sequência de caracteres | |
applovinmax | Sequência de caracteres | |
googleadmob | Sequência de caracteres | |
fyber | Sequência de caracteres | |
appodeal | Sequência de caracteres | |
admost | Sequência de caracteres | |
topon | Sequência de caracteres | |
tradplus | Sequência de caracteres | |
yandex | Sequência de caracteres | |
chartboost | Sequência de caracteres | |
unity | Sequência de caracteres | |
customMediation | Sequência de caracteres | A solução de mediação não está na lista de parceiros de mediação suportados. |
directMonetizationNetwork | Sequência de caracteres | O app se integra diretamente com redes de monetização sem mediação. |
logEvent
Assinatura do método
void logEvent(Context context,
java.lang.String eventName,
java.util.Map<java.lang.String,java.lang.Object> eventValues)
Descrição
Registre um evento in-app.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
Context | context | Contexto do aplicativo/atividade |
String | eventName | Nome do evento |
Map | eventValues | Valores do evento |
Retorna
void
Exemplo de uso
logEvent
Assinatura do método
void logEvent(Context context,
java.lang.String eventName,
java.util.Map<java.lang.String,java.lang.Object> eventValues,
AppsFlyerRequestListener listener)
Descrição
O mesmo que logEvent, com AppsFlyerRequestListener. HttpURLConnection.HTTP_OK
a partir de
o servidor invocará o método AppsFlyerRequestListener#onSuccess()
. AppsFlyerRequestListener#onError(int, String) retornará
o erro caso ocorra
Argumentos de entrada
Esta função não usa parâmetros.
Retorna
void
Exemplo de uso
logLocation
Assinatura do método
void logLocation(Context context,
double latitude,
double longitude)
Descrição
Registrar manualmente a localização do usuário.
Este método cria um evento in-app af_location_coordinates
, com os parâmetros af_lat
and af_long
.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
Context | context | Contexto do aplicativo/atividade |
double | latitude | LATITUDE |
double | longitude | LONGITUDE |
Retorna
void
Exemplo de uso
logSession
Assinatura do método
void logSession(Context ctx)
Descrição
Se o aplicativo for um aplicativo utilitário em segundo plano, você poderá usar essa API no onCreate() da atividade para registrar e enviar uma sessão manualmente.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
Context | ctx | Contexto do aplicativo/atividade |
Exemplo de uso
public void logSession(Context context);
public void logSession(Context context)
Retorna
void
onPause
Assinatura do método
void onPause(Context context)
Descrição
Para a plataforma CocoS2Dx, apenas o
CocoS2Dx tem seu próprio evento applicationDidEnterBackground.
Portanto, "onPause" será chamado de C++ pelo JNI
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
Context | context | Contexto do aplicativo/atividade |
Retorna
void
Exemplo de uso
performOnAppAttribution
Descontinuado desde a V6.3.2
Assinatura do método
void performOnAppAttribution(Context context,
java.net.URI link)
Descrição
Usado para resolver deep links manualmente.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
Context | context | Contexto do aplicativo/atividade |
java.net.URI | link | Link para resolver |
Retorna
void
Exemplo de uso
AppsFlyerLib.getInstance().performOnAppAttribution(context, uri);
AppsFlyerLib.getInstance().performOnAppAttribution(context, uri)
performOnDeepLinking
Adicionado na V6.3.1+
Assinatura do método
public void performOnDeepLinking(@NonNull Intent intent, @NonNull Context context);
Descrição
Permite gatilho manual da resolução de deep link. Esse método permite que aplicativos que estão atrasando a chamada comecem a resolver links diretos antes que o SDK seja iniciado.
- Se um
DeepLinkListener
é registrado, é compatível com deep links, tanto deferred quanto diretos - Se um
AppsFlyerConversionListener
é registrado, é compatível apenas deep links
É recomendável chamar isso de um Activity
's onResume
, para atividades que podem ser iniciadas por deep linking.
Observação: deep links processados por esta API não serão reportados ao servidor.
Exemplo de uso
@Override
protected void onResume() {
super.onResume();
AppsFlyerLib appsflyer = AppsFlyerLib.getInstance();
appsflyer.performOnDeepLinking(getIntent(),this);
}
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
Intent | intent | |
Context | context | Contexto do aplicativo/atividade. |
Retorna
void
registerConversionListener
Assinatura do método
void registerConversionListener(Context context,
AppsFlyerConversionListener conversionDataListener)
Descrição
Registre um ouvinte de dados de conversão. Você também pode usar init
para registrar o ouvinte.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
Context | context | Contexto do aplicativo/atividade. |
AppsFlyerConversionListener | conversionDataListener | The AppsFlyerConversionListener objeto de registro. |
Retorna
void
Exemplo de uso
// conversionDataListener is an object of type AppsFlyerConversionListener.
AppsFlyerLib.getInstance().registerConversionListener(getApplicationContext(), conversionDataListener);
// conversionDataListener is an object of type AppsFlyerConversionListener.
AppsFlyerLib.getInstance().registerConversionListener(getApplicationContext(), conversionDataListener)
Aqui está um exemplo de implementação de AppsFlyerConversionListener
.
registerValidatorListener (LEGACY)
Assinatura do método
void registerValidatorListener(Context context,
AppsFlyerInAppPurchaseValidatorListener validationListener)
Descrição
Registre um ouvinte de validação para a API validateAndLogInAppPurchase
.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
Context | context | Contexto do aplicativo/atividade. |
AppsFlyerInAppPurchaseValidatorListener | validationListener | The AppsFlyerInAppPurchaseValidatorListener objeto de registro. |
Retorna
void
Exemplo de uso
sendAdRevenue (LEGACY)
Deprecated in v6.15.0
(Supported until SDK v6.14.2 For versions including and above v6.15.0 use logAdRevenue
)
Assinatura do método
void sendAdRevenue(Context context,
java.util.Map<java.lang.String,java.lang.Object> eventValues)
Descrição
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
Context | context | Contexto do aplicativo/atividade. |
Map<String, Object> | validationListener |
Retorna
void
sendPushNotificationData
Assinatura do método
void sendPushNotificationData(Activity activity)
Descrição
Meça e obtenha dados de campanhas de notificação push. Chame este método dentro do método onCreate
das Activity
que são iniciadas a partir de notificações push.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
Activity | activity | The Activity que é iniciada por meio da notificação. |
Retorna
void
.
Exemplo de uso
setAdditionalData
Calling
setAddiotionalData
before first launch will have the additional data included in installs, sessions, as well as in-app events.
Assinatura do método
void setAdditionalData(java.util.Map<java.lang.String,java.lang.Object> customData)
Descrição
Use para adicionar dados personalizados ao payload dos eventos. Ele aparecerá nos relatórios de dados brutos.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
HashMap | customData |
Retorna
void
.
setAndroidIdData
Assinatura do método
void setAndroidIdData(java.lang.String aAndroidId)
Descrição
Por padrão, o IMEI e a ID do Android não serão coletados pelo SDK se a versão do Android for maior que o KitKat (4.4) e o dispositivo contiver o Google Play Services. Use esta API para enviar explicitamente a ID do Android para a AppsFlyer.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
String | aAndroidId | ID do dispositivo Android. |
Retorna
void
setAppId
Assinatura do método
void setAppId(java.lang.String id)
Descrição
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
String | id | ID do aplicativo Android. |
Retorna
void
setAppInviteOneLink
Assinatura do método
void setAppInviteOneLink(java.lang.String oneLinkId)
Descrição
Defina a ID do OneLink que deve ser usada para atribuir o convite do usuário. O link gerado para o convite do usuário usará esse OneLink como o link base. Consulte configurar o OneLink para atribuição de convite de usuário.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
String | oneLinkId | ID do OneLink obtida no Painel da AppsFlyer. |
Retorna
void
.
setCollectAndroidID
Assinatura do método
void setCollectAndroidID(boolean isCollect)
Descrição
Aceite a coleção de IDs do Android. Força o SDK a coletar a ID do Android.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
boolean | isCollect | Definido como true ao optar por participar. |
Retorna
void
.
setCollectIMEI
Assinatura do método
void setCollectIMEI(boolean isCollect)
Descrição
Optar pela coleção IMEI. Força o SDK a coletar IMEI.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
boolean | isCollect | Definido como true ao optar por participar. |
Retorna
void
.
setCollectOaid
Assinatura do método
void setCollectOaid(boolean isCollect)
Descrição
Optar por participar/optar por não participar da coleção OAID. Por padrão, o SDK tenta coletar o OAID.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
boolean | isCollect | O padrão é true . Definido como false ao optar por não participar. |
Retorna
void
.
setConsentData
Assinatura do método
AppsFlyerLib.getInstance().setConsentData(AppsFlyerConsent afConsent)
Descrição
Transfers consent data to the SDK.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
AppsFlyerConsent | afConsent | An object containing user consent data |
setCurrencyCode
Assinatura do método
void setCurrencyCode(java.lang.String currencyCode)
Descrição
Define a moeda para compras in-app. O código da moeda deve ser um código ISO 4217 de 3 caracteres.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
String | currencyCode | 3 character ISO 4217 code. Defaults to "USD" . |
Retorna
void
.
setCustomerIdAndLogSession
Before calling this method, the method
waitForCustomerUserId
must be called
Assinatura do método
void setCustomerIdAndLogSession(java.lang.String id,
Context context)
Descrição
Use para definir a ID de usuário cliente e iniciar o SDK.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
String | id | ID do cliente para o cliente. |
String | context | Contexto do aplicativo/atividade. |
Retorna
void
setCustomerUserId
Assinatura do método
void setCustomerUserId(java.lang.String id)
Descrição
Definir sua própria ID de cliente permite que você faça referência cruzada de sua própria ID exclusiva com a ID exclusiva da AppsFlyer e as IDs de outros dispositivos.
Essa ID está disponível em relatórios de dados brutos e nas APIs de postback para referência cruzada com suas IDs internas.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
String | id | ID do cliente para o cliente. |
Retorna
void
.
setDebugLog
Assinatura do método
void setDebugLog(boolean shouldEnable)
Descrição
Habilita logs de depuração para o SDK da AppsFlyer. Só deve ser definido como verdadeiro em ambientes de desenvolvimento.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
boolean | shouldEnable | O padrão é false . |
Retorna
void
.
Exemplo de uso
setDisableAdvertisingIdentifiers
Adicionado na V6.3.2
Assinatura do método
void setDisableAdvertisingIdentifiers(boolean disable);
Descrição
Desativa a coleção de várias IDs de publicidade pelo SDK. Isso inclui o Google Advertising ID (GAID), o OAID e o Amazon Advertising ID (AAID).
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
boolean | disable | O padrão é false . |
Retorna
void
.
setDisableNetworkData
Adicionado na V6.7.0
Assinatura do método
void setDisableNetworkData(boolean disable);
Descrição
Use para optar por não participar de coletar o nome do operador de rede (transportadora) e o nome do operador sim do dispositivo.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
boolean | disable | O padrão é false . |
Retorna
void
.
setExtension
Assinatura do método
void setExtension(java.lang.String extension)
Descrição
Os plugins e extensões do SDK definirão esse campo.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
String | extension | Nome da extensão. |
Retorna
void
.
setHost
Assinatura do método
void setHost(java.lang.String hostPrefixName,
java.lang.String hostName)
Descrição
Defina um host personalizado. Observação: a partir do SDK V6.10, se o host for enviado com um valor vazio ou nulo, a chamada da API será ignorada.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
String | hostPrefixName | Prefixo do host. |
String | hostName | Nome do host. |
Retorna
void
.
setImeiData
Assinatura do método
void setImeiData(java.lang.String aImei)
Descrição
Por padrão, o IMEI e o ID do Android não são coletados pelo SDK se a versão do sistema operacional for superior ao KitKat (4.4) e o dispositivo contiver o Google Play Services.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
String | aImei | Dispositivo IMEI. |
Retorna
void
.
setIsUpdate
Assinatura do método
void setIsUpdate(boolean isUpdate)
Descrição
Defina manualmente que o aplicativo foi atualizado.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
boolean | isUpdate |
Retorna
void
.
setLogLevel
Assinatura do método
void setLogLevel(AFLogger.LogLevel logLevel)
Descrição
Defina o nível de log do SDK.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
String | logLevel | Nível de log. |
Retorna
void
.
setMinTimeBetweenSessions
Assinatura do método
void setMinTimeBetweenSessions(int seconds)
Descrição
Defina um valor personalizado para o tempo mínimo necessário entre as sessões.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
int | seconds | Define o tempo mínimo que deve passar entre duas inicializações do aplicativo para contar como duas sessões separadas. Se não estiver definido, o tempo mínimo padrão entre as sessões é de 5 segundos. |
Retorna
void
.
setOaidData
Assinatura do método
void setOaidData(java.lang.String oaid)
Descrição
Por padrão, o OAID não é coletado pelo SDK. Use esta API para enviar explicitamente o OAID para a AppsFlyer.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
String | oaid | Dispositivo OAID. |
Retorna
void
.
setOneLinkCustomDomain
Assinatura do método
void setOneLinkCustomDomain(java.lang.String... domains)
Descrição
Para que o SDK da AppsFlyer resolva com êxito parâmetros de atribuição ocultos (decodificados na ID de link curto), qualquer domínio configurado como um domínio de marca no painel da AppsFlyer deve ser fornecido a esse método.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
String... | domains | Variedade de domínios que o SDK deve tratar como domínios de marca (o SDK tentará resolvê-los como OneLinks). |
Retorna
void
.
setOutOfStore
Assinatura do método
void setOutOfStore(java.lang.String sourceName)
Descrição
Especificar a loja de aplicativos alternativa da qual o aplicativo foi baixado.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
String | sourceName | Nome da loja de aplicativos de terceiros. |
Retorna
void
.
Exemplo de uso
AppsFlyerLib.getInstance().setOutOfStore("baidu");
AppsFlyerLib.getInstance().setOutOfStore("baidu")
setPartnerData
Assinatura do método
void setPartnerData(@NonNull String partnerId, Map<String, Object> data);
Descrição
Permite o envio de dados personalizados para fins de integração de parceiros.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
String | partnerId | ID do parceiro (geralmente com o sufixo "_int"). |
Map | data | Os dados do cliente dependem da configuração de integração com o parceiro específico. |
Retorna
void
.
Exemplo de uso
Map<String, Object> partnerData = new HashMap();
partnerData.put("puid", "123456789");
AppsFlyerLib.getInstance().setPartnerData("test_int", partnerData);
val partnerData = mapOf("puid" to "123456789")
AppsFlyerLib.getInstance().setPartnerData("test_int", partnerData)
setPhoneNumber
Assinatura do método
void setPhoneNumber(java.lang.String phoneNumber)
Descrição
Será enviado como uma string criptografada SHA-256.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
String | phoneNumber |
Retorna
void
.
setPreinstallAttribution
Assinatura do método
void setPreinstallAttribution(java.lang.String mediaSource,
java.lang.String campaign,
java.lang.String siteId)
Descrição
Especifique o nome do fabricante ou fonte de mídia ao qual a pré-instalação é atribuída.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
String | mediaSource | Nome da fonte do fabricante ou da mídia para atribuição de pré-instalação. |
String | campaign | Nome da campanha para atribuição de pré-instalação. |
String | siteId | ID do site para atribuição de pré-instalação. |
Retorna
void
.
setResolveDeepLinkURLs
Assinatura do método
void setResolveDeepLinkURLs(java.lang.String... urls)
Descrição
Os anunciantes podem encapsular um OneLink da AppsFlyer em outro Link universal. Este Link universal invocará o aplicativo, mas todos os dados de deep links não serão propagados para a AppsFlyer.
setResolveDeepLinkURLs
permite que você configure o SDK para resolver as URLs encapsuladas do OneLink, para que o deep linking possa ocorrer corretamente.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
String... | urls | Certifique-se de fornecer URLs explícitas. |
Retorna
void
Exemplo de uso
AppsFlyerLib.getInstance().setResolveDeepLinkURLs("clickdomain.com", "myclickdomain.com", "anotherclickdomain.com");
setSharingFilterForPartners
Adicionado na V6.4
Assinatura do método
void setSharingFilterForPartners(java.lang.String... partners)
This function replaces the deprecated setSharingFilter
and setSharingFilterForAllPartners
Descrição
Permite configurar como quais parceiros o SDK deve excluir do compartilhamento de dados.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
String... | partners | Um ou mais identificadores de parceiros que você deseja excluir. Deve incluir apenas letras/dígitos e sublinhados.Tamanho máximo da ID do parceiro: 45 |
Observação:
Make sure to use the exact partner ID (PID). Failing to do so may result in privacy-preservation breaches.
To find out the required partner IDs:
- Execute a API Obter integrações ativas para obter uma lista de todas as integrações ativas
- Use o
media_source_name
valores da resposta da API como valores de entrada para o método matrizpartners
.
Exceções:
- For Twitter, use
twitter
(e nãotwitter_int
)
Exemplo de uso
AppsFlyerLib.getInstance().setSharingFilterForPartners("partner1_int"); // Single partner
AppsFlyerLib.getInstance().setSharingFilterForPartners("partner1_int", "partner2_int"); // Multiple partners
AppsFlyerLib.getInstance().setSharingFilterForPartners("all"); // All partners
AppsFlyerLib.getInstance().setSharingFilterForPartners(); // Reset list (default)
AppsFlyerLib.getInstance().setSharingFilterForPartners("partner1_int") // Single partner
AppsFlyerLib.getInstance().setSharingFilterForPartners("partner1_int", "partner2_int") // Multiple partners
AppsFlyerLib.getInstance().setSharingFilterForPartners("all") // All partners
AppsFlyerLib.getInstance().setSharingFilterForPartners("") // Reset list (default)
setSharingFilter
Descontinuado na V6.4
Assinatura do método
void setSharingFilter(java.lang.String... partners)
This function is deprecated and has been replaced by setSharingFilterForPartners
Descrição
Stops events from propagating to the specified AppsFlyer partners.
(Deprecated and replaced by setSharingFilterForPartners)
Input arguments
Tipo | Nome | Descrição |
---|---|---|
String... | partners | Um ou mais identificadores de parceiros. Deve incluir apenas letras/dígitos e sublinhados. Comprimento máximo: 45 |
Retorna
void
setSharingFilterForAllPartners
Descontinuado na V6.4
Assinatura do método
void setSharingFilterForAllPartners()
This function is deprecated and has been replaced by setSharingFilterForPartners
Descrição
Impede a propagação de eventos para todos os parceiros da AppsFlyer. Substitui setSharingFilter
.
Argumentos de entrada
Esta função não usa parâmetros.
Retorna
void
setUserEmails
Assinatura do método
void setUserEmails(AppsFlyerProperties.EmailsCryptType cryptMethod,
java.lang.String... emails)
Descrição
Defina os e-mails do usuário e criptografe-os.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
AppsFlyerProperties.EmailsCryptType | cryptMethod | Métodos de criptografia:
|
String... | emails | Um ou mais e-mails de usuário. |
Retorna
void
.
start
Assinatura do método
void start(Context context,
java.lang.String key,
AppsFlyerRequestListener listener)
Descrição
Inicia o SDK.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
Context | context | Contexto do aplicativo se chamar no método do aplicativo onCreate , Activity Context se chamar após Activity's onResume método. |
String | key | Sua chave do desenvolvedor da AppsFlyer |
AppsFlyerRequestListener | listener | (Opcional) Ouvinte para obter o status da solicitação. |
Retorna
void
.
Exemplo de uso
Consulte Integração do SDK para obter um exemplo de implementação.
stop
Assinatura do método
void stop(boolean shouldStop,
Context context)
Descrição
Depois que essa API é invocada, nosso SDK não se comunica mais com nossos servidores e deixa de funcionar.
Útil ao implementar o optar por participar/optar por não participar do usuário.
Reinicialização do SDK
Depois de
stop(true)
foi chamado, você precisa chamarstop(false)
e só depois chamarstart()
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
boolean | shouldStop | se o registro for interrompido. |
Context | context | Contexto do aplicativo/atividade. |
Retorna
void
.
subscribeForDeepLink
Assinatura do método
void subscribeForDeepLink(DeepLinkListener deepLinkListener,
long timeout)
Descrição
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
DeepLinkListener | deepLinkListener | |
long | timeout | Opcional. Unidades em milissegundos |
Retorna
void
unregisterConversionListener
Assinatura do método
void unregisterConversionListener()
Descrição
Cancelar o registro de um registrado anteriormente AppsFlyerConversionListener
.
Argumentos de entrada
Esta função não usa parâmetros.
Retorna
void
updateServerUninstallToken
Assinatura do método
void updateServerUninstallToken(Context context,
java.lang.String token)
Descrição
Para desenvolvedores que usam o Firebase para outros fins que não sejam a métrica de desinstalação. Para obter mais informações, consulte a métrica de desinstalação.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
Context | context | Contexto do aplicativo/atividade. |
String | token | Token de dispositivo Firebase. |
Retorna
void
Exemplo de uso
AppsFlyerlib.getInstance().updateServerUninstallToken(getApplicationContext(), <TOKEN>);
AppsFlyerlib.getInstance().updateServerUninstallToken(getApplicationContext(), <TOKEN>);
validateAndLogInAppPurchase
Added in v6.14.0
Assinatura do método
public abstract void validateAndLogInAppPurchase(@NonNull AFPurchaseDetails purchaseDetails,
@Nullable Map<String, String> additionalParameters,
@Nullable AppsFlyerInAppPurchaseValidationCallback validationCallback);
Descrição
The method validates a purchase event with the store and if the validation is successful, the SDK sends an af_purchase
event to AppsFlyer.
See detailed instructions in Validate and log in-app purchase.
Argumentos de entrada
Nome | Tipo | Descrição |
---|---|---|
purchaseDetails * | AFPurchaseDetails | An object that encapsulates all data related to the purchase provided to the validateAndLogInAppPurchase method. |
additionalParameters | Map<String, String> | Additional parameters to log with the purchase. |
validationCallback * | AppsFlyerInAppPurchaseValidationCallback ` | A callback for delivering validation results. |
Retorna
void
AFPurchaseDetails
An object that encapsulates all data related to the purchase provided to the validateAndLogInAppPurchase method.
data class AFPurchaseDetails(
val purchaseType: AFPurchaseType,
val purchaseToken: String,
val productId: String,
val price: String,
val currency: String
)
AFPurchaseDetails parameters
Nome | Tipo | Descrição |
---|---|---|
purchaseType | AFPurchaseType | Field to distinguish between one-time purchases and subscriptions. The field can accept either subscription or one-time-purchase. |
purchaseToken | Sequência de caracteres | Token that uniquely identifies a purchase for a given item and user pair. Part of the Billing Library's Purchase class . To retrieve the token call the getPurchaseToken API |
productId | Sequência de caracteres | ID of the product item that has been purchased. Also part of the Billing Library's Purchase class . |
price | Sequência de caracteres | The full price of the one-time purchase or the subscription. Also part of the Billing Library's Purchase class . |
currency | Sequência de caracteres | Currency used to make the purchase. |
validateAndLogInAppPurchase (LEGACY)
Deprecated in v6.4
Assinatura do método
void validateAndLogInAppPurchase(Context context,
java.lang.String publicKey,
java.lang.String signature,
java.lang.String purchaseData,
java.lang.String price,
java.lang.String currency,
java.util.Map<java.lang.String,java.lang.String> additionalParameters)
Descrição
API para verificação do servidor de compras dentro do aplicativo. Um evento af_purchase
com os valores relevantes será registrado automaticamente se a validação for bem-sucedida.
Veja instruções detalhadas sobre como validar compras.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
Context | context | Contexto do aplicativo/atividade. |
String | publicKey | Chave de licença obtida no Google Play Console. |
String | signature | data.INAPP_DATA_SIGNATURE from onActivityResult(int requestCode, int resultCode, Intent data) |
String | purchaseData | data.INAPP_PURCHASE_DATA from onActivityResult(int requestCode, int resultCode, Intent data) |
String | price | Preço de compra, deve ser derivado de skuDetails.getStringArrayList("DETAILS_LIST") |
String | currency | Moeda de compra, deve ser derivada de skuDetails.getStringArrayList("DETAILS_LIST") |
Map<String, String> | additionalParameters | Parâmetros à mão livre a serem registrados com a compra (se validados). |
Retorna
void
.
waitForCustomerUserId
Assinatura do método
void waitForCustomerUserId(boolean wait)
Descrição
Este método adia a inicialização do SDK, até que um customerUserID
seja fornecido.
Todos os eventos in-app e quaisquer outras chamadas de API do SDK são descartados até que customerUserID
seja fornecido e registrado.
Argumentos de entrada
Tipo | Nome | Descrição |
---|---|---|
boolean | wait |
Retorna
void
.
Exemplo de uso
AppsFlyerLib.getInstance().waitForCustomerUserId(true);
AppsFlyerLib.getInstance().waitForCustomerUserId(true);
Atualizado 4 meses atrás