Guia de integração do Unity plugin V6 para desenvolvedores

Descrição

Assinatura do método

void initSDK(string devKey, string appID, MonoBehaviour gameObject)

Exemplo

AppsFlyer.initSDK("dev_key", "app_id"); // without deeplinking
            AppsFlyer.initSDK("dev_key", "app_id", this); // with deeplinking

Descrição

Uma vez que essa API é chamada, o SDK será iniciado, as sessões serão enviadas imediatamente e todas as transições de primeiro plano em segundo plano registrarão uma sessão.

Assinatura do método

void startSDK()

Exemplo

AppsFlyer.startSDK();

Descrição

O registro de eventos in-app é realizado através da chamada sendEvent com os parâmetros de nome e valor do evento.

Assinatura do método

void sendEvent(string eventName, Dictionary<string, string> eventValues)

Exemplo

Dictionary<string, string> 
            eventValues = new Dictionary<string, string>();
            eventValues.Add(AFInAppEvents.CURRENCY, "USD");
            eventValues.Add(AFInAppEvents.REVENUE, "0.99");
            eventValues.Add("af_quantity", "1");
            AppsFlyer.sendEvent(AFInAppEvents.PURCHASE, eventValues);

Descrição

Em alguns casos extremos, convém desativar todas as funções do SDK para reguladores e requisitos de compliance com a privacidade. Para fazer isso, use a API StopSDK. Uma vez chamado, o SDK não se comunica mais com os servidores da AppsFlyer e para de funcionar.

Assinatura do método

void stopSDK(bool isSDKStopped)

Exemplo

AppsFlyer.stopSDK(true);

Descrição

A API StopSDK (booleano) estava definida como true?

Assinatura do método

bool isSDKStopped()

Exemplo

if (!AppsFlyer.isSDKStopped())
{

}

Descrição

Obtenha a versão do SDK da AppsFlyer

Assinatura do método

string getSdkVersion()

Exemplo

string version = AppsFlyer.getSdkVersion();

Descrição

Habilita logs de depuração

Assinatura do método

void setIsDebug(bool shouldEnable)

Exemplo

AppsFlyer.setIsDebug(true);

Descrição

Assinatura do método

void setCustomerUserId(string id)

Exemplo

AppsFlyer.setCustomerUserId("custom_user_id");

Descrição

Assinatura do método

setAppInviteOneLinkID(string oneLinkId)

Exemplo

AppsFlyer.setAppInviteOneLinkID("abcd");

Descrição

Assinatura do método

setAdditionalData(Dictionary<string, string> customData)

Exemplo

Dictionary<string, string> customData = new Dictionary<string, string>();
customData.Add("custom1", "someData");
AppsFlyer.setAdditionalData(customData);

Descrição

Assinatura do método

setResolveDeepLinkURLs(params string[] urls)

Exemplo

AppsFlyer.setResolveDeepLinkURLs("example.com", "click.example.com");

Descrição

Os anunciantes podem usar esse método para definir domínios do OneLink.

Assinatura do método

void setOneLinkCustomDomain(params string[] domains)

Exemplo

AppsFlyer.setOneLinkCustomDomain("test.domain", "test2.domain");

Descrição

Grava manualmente a localização do usuário

Assinatura do método

void recordLocation(double latitude, double longitude)

Exemplo

AppsFlyer.recordLocation(40.7128, 74.0060);

Descrição

Use durante a inicialização para explicitamente tornar anônima a instalação do usuário, os eventos e as sessões. Para torná-la visível novamente, mais uma vez faça a chamada AnonymizeUser, defina como false.

Assinatura do método

void anonymizeUser(bool shouldAnonymizeUser)

Exemplo

AppsFlyer.anonymizeUser(true);

Descrição

Para obter o ID exclusivo da AppsFlyer para uma nova instalação.

Assinatura do método

string getAppsFlyerId()

Exemplo

string uid = AppsFlyer.getAppsFlyerId();

Descrição

Por padrão, pelo menos 5 segundos devem decorrer entre 2 inicializações do aplicativo para que contem como sessões separadas. Defina um valor personalizado para o tempo mínimo necessário entre as sessões.

Assinatura do método

void setMinTimeBetweenSessions(int seconds)

Exemplo

AppsFlyer.setMinTimeBetweenSessions(4);

Descrição

Defina e-mails do usuário e os criptografe.

Assinatura do método

void setUserEmails(EmailCryptType cryptMethod, params string[] emails)

Exemplo

AppsFlyer.setUserEmails(EmailCryptType.EmailCryptTypeSHA256, "test1@test1.com", "test2@test2.com");

Descrição

Defina um host personalizado

Assinatura do método

void setHost(string hostPrefixName, string hostName)

Exemplo

AppsFlyer.setHost("hostPrefixName","hostName");

Descrição

Registre um listener de dados de conversão para permitir o acesso aos dados de atribuição do usuário em tempo real para cada nova instalação, diretamente no nível do SDK. Ao fazê-lo, ofereça aos usuários conteúdo personalizado ou envie-os para atividades específicas dentro do aplicativo, o que pode melhorar significativamente o engajamento deles com seu aplicativo.

Assinatura do método

void getConversionData(string objectName);

Exemplo

AppsFlyer.getConversionData(gameObject.name);

Descrição

Para atribuir o clique e iniciar a página do aplicativo na app store.

Assinatura do método

void attributeAndOpenStore
(string appID, string campaign, 
Dictionary<string, string> userParams, MonoBehaviour gameObject)

Exemplo

Dictionary<string, string> parameters = new Dictionary<string, string>();
parameters.Add("af_sub1", "val");
parameters.Add("custom_param", "val2");
AppsFlyer.attributeAndOpenStore("123456789", "test campaign", parameters, this);            

Descrição

Para atribuir uma impressão, use a seguinte chamada de API. Certifique-se de usar o ID do aplicativo promovido da maneira como aparece no painel da AppsFlyer.

Assinatura do método

void recordCrossPromoteImpression(string appID, string campaign);

Exemplo

Dictionary<string, string> parameters = new Dictionary<string, string>();
parameters.Add("af_sub1", "val");
parameters.Add("custom_param", "val2");
AppsFlyer.recordCrossPromoteImpression("appID", "campaign", parameters);

Descrição

A classe LinkGenerator cria a URL de convite de acordo com vários métodos setter, que permitem passar informações adicionais no clique.

Assinatura do método

void generateUserInviteLink
(Dictionary<string, string> parameters, MonoBehaviour gameObject)

Exemplo

AppsFlyer.generateUserInviteLink(params, this);

Descrição

Assinatura do método

public void onAppOpenAttribution(string validateResult)

Exemplo

public void onAppOpenAttribution(string attributionData)
            { AppsFlyer.AFLog("onAppOpenAttribution", attributionData);
            Dictionary<string, object> attributionDataDictionary = AppsFlyer.CallbackStringToDictionary(attributionData);
            // add direct deeplink logic here }

Descrição

Assinatura do método

public void onAppOpenAttributionFailure (string error)

Exemplo

public void onAppOpenAttributionFailure(string error)
            {AppsFlyer.AFLog("onAppOpenAttributionFailure", error); }

Descrição

Método usado para obter dados de conversão. É útil para ligação direta adiada. Saiba mais.

• Da versão 5 do SDK: onConversionDataSuccess
• SDK com versão anterior a 5: onConversionDataReceived Melhores práticas!

Assinatura do método

public void didReceiveConversionData(string conversionData)

Exemplo

public void onConversionDataSuccess(string conversionData)
            {
            AppsFlyer.AFLog("onConversionDataSuccess", conversionData);
            Dictionary<string, object> conversionDataDictionary = AppsFlyer.CallbackStringToDictionary(conversionData);
            // add deferred deeplink logic here
            }

Descrição

Assinatura do método

public void didReceiveConversionDataWithError(string error)

Exemplo

public void onConversionDataFail(string error)
            {
            AppsFlyer.AFLog("onConversionDataFail", error);
            }

Descrição

Callback de sucesso para gerar URLs do OneLink.

Assinatura do método

public void onInviteLinkGenerated(string link)

Exemplo

public void onInviteLinkGenerated(string link)
            {
            }

Descrição

Callback de erro para gerar URLs do OneLink.

Assinatura do método

public void onInviteLinkGeneratedFailure(string error)

Exemplo

public void onInviteLinkGeneratedFailure(string error)
            {
            AppsFlyer.AFLog("onInviteLinkGeneratedFailure", error);
            }

Descrição

Callback de sucesso para a API validateAndSendInAppPurchase.

Para Android: callback retorna "Validar sucesso".
Para iOS: callback retorna uma string JSON da API verifyReceive da Apple.

Assinatura do método

public void didFinishValidateReceipt(string result)

Exemplo

public void didFinishValidateReceipt(string result)
            {
            }

Descrição

Callback de erro para validar recebimentos.

Assinatura do método

public void didFinishValidateReceiptWithError(string error)

Exemplo

public void didFinishValidateReceiptWithError(string error)
            {
            }

Descrição

Usado para definir o número de telefone do usuário.

Assinatura do método

void setPhoneNumber(string phoneNumber)

Exemplo

AppsFlyer.setPhoneNumber("4166358181");

Descrição

Usado por anunciantes para excluir todas as redes/parceiros integrados da obtenção de dados. Saiba mais

Assinatura do método

void setSharingFilterForAllPartners()

Exemplo

AppsFlyer.setSharingFilterForAllPartners();

Descrição

Assinatura do método

void setSharingFilter(params string[] partners)

Exemplo

AppsFlyer.setSharingFilter
("googleadwords_int","snapchat_int","doubleclick_int");

Descrição

Transfira manualmente o Firebase Device Token para a mensuração de desinstalação.

Assinatura do método

void updateServerUninstallToken(string token)

Exemplo

#if UNITY_ANDROID && !UNITY_EDITOR
            AppsFlyerAndroid.updateServerUninstallToken("token");
            #endif

Descrição

Para enviar explicitamente o IMEI para a AppsFlyer.

Assinatura do método

void setImeiData(string imei)

Exemplo

#if UNITY_ANDROID && !UNITY_EDITOR
            AppsFlyerAndroid.setImeiData("imei");
            #endif

Descrição

 Para enviar explicitamente a ID do Android para a AppsFlyer.

Assinatura do método

void setAndroidIdData(string androidId)

Exemplo

#if UNITY_ANDROID && !UNITY_EDITOR
            AppsFlyerAndroid.setAndroidIdData("androidId");
            #endif

Descrição

Esse recurso garante que o SDK não comece a funcionar até que o customerUserID seja fornecido.

Assinatura do método

void waitForCustomerUserId(bool wait)

Exemplo

#if UNITY_ANDROID && !UNITY_EDITOR
            AppsFlyerAndroid.waitForCustomerUserId(true);
            #endif

Descrição

Para disponibilizar ao SDK o ID de usuário do cliente relevante e acionar o SDK para iniciar sua atividade normal.

Assinatura do método

void setCustomerIdAndStartSDK(string id)

Exemplo

#if UNITY_ANDROID && !UNITY_EDITOR
            AppsFlyerAndroid.setCustomerIdStartSDK("id");
            #endif

Descrição

Obtenha o valor AF_STORE atual.

Assinatura do método

string getOutOfStore()

Exemplo

#if UNITY_ANDROID && !UNITY_EDITOR
            string af_store = AppsFlyerAndroid.getOutOfStore();
            #endif

Descrição

Defina manualmente o valor AF_STORE.

Assinatura do método

void setOutOfStore(string sourceName)

Exemplo

#if UNITY_ANDROID && !UNITY_EDITOR
            AppsFlyerAndroid.setOutOfStore("sourceName");
            #endif

Descrição

Optar por não participar da coleta de ID do Android. Se o aplicativo NÃO tiver o Google Play Services, o ID do Android será coletado pelo SDK. No entanto, os aplicativos com os serviços do Google Play devem evitar a coleta de ID do Android, pois isso viola a política do Google Play.

Assinatura do método

void setCollectAndroidID(bool isCollect)

Exemplo

#if UNITY_ANDROID && !UNITY_EDITOR
            AppsFlyerAndroid.setCollectAndroidID(true);
            #endif

Descrição

Optar por não participar da coleta de IMEI. Se o aplicativo NÃO tiver o Google Play Services, o IMEI do dispositivo será coletado pelo plugin. No entanto, os aplicativos com os serviços do Google Play devem evitar a coleta de IMEI, pois isso viola a política do Google Play.

Assinatura do método

void setCollectIMEI(bool isCollect)

Exemplo

#if UNITY_ANDROID && !UNITY_EDITOR
            AppsFlyerAndroid.setCollectIMEI(true);
            #endif

Descrição

Defina manualmente que o aplicativo foi atualizado.

Assinatura do método

void setIsUpdate(bool isUpdate)

Exemplo

#if UNITY_ANDROID && !UNITY_EDITOR
            AppsFlyerAndroid.setIsUpdate(true);
            #endif

Descrição

Especifique o nome do fabricante ou da fonte de mídia ao qual a pré-instalação é atribuída.

Assinatura do método

void setPreinstallAttribution
(string mediaSource, string campaign, string siteId)

Exemplo

#if UNITY_ANDROID && !UNITY_EDITOR
            AppsFlyerAndroid.setPreinstallAttribution("mediaSource", "campaign", "siteId");
            #endif

Descrição

Indicador booleano para pré-instalação pelo fabricante.

Assinatura do método

bool isPreInstalledApp()

Exemplo

#if UNITY_ANDROID && !UNITY_EDITOR
            if (AppsFlyerAndroid.isPreInstalledApp())
            {
            }
            #endif

Descrição

Obtenha a ID de atribuição do Facebook, se houver.

Assinatura do método

string getAttributionId()

Exemplo

#if UNITY_ANDROID && !UNITY_EDITOR
            string attributionId = AppsFlyerAndroid.getAttributionId();
            #endif

Descrição

Receba notificações push registradas.

Assinatura do método

void handlePushNotifications()

Exemplo

#if UNITY_ANDROID && !UNITY_EDITOR
 AppsFlyerAndroid.handlePushNotifications();
            #endif

Descrição

API para verificação do servidor de compras dentro do aplicativo. Um evento af_purchase com os valores relevantes será enviado automaticamente se a validação for bem-sucedida.

Assinatura do método

void validateAndSendInAppPurchase
(string publicKey, string signature, string purchaseData, 
string price, string currency, Dictionary<string, string> additionalParameters, 
MonoBehaviour gameObject)

Exemplo

#if UNITY_ANDROID && !UNITY_EDITOR
            AppsFlyerAndroid.validateAndSendInAppPurchase(
            "publicKey", 
            "signature", 
            "purchaseData", 
            "price", 
            "currency", 
            null, 
            this);
            #endif

Descrição

Defina esse sinalizador como 'true' para coletar o nome do dispositivo atual (por exemplo, "Meu iPhone"). O valor padrão é false.

Assinatura do método

void setShouldCollectDeviceName(bool shouldCollectDeviceName)

Exemplo

#if UNITY_IOS && !UNITY_EDITOR
            AppsFlyeriOS.setShouldCollectDeviceName(true);
            #endif

Descrição

Opte por não participar das atribuições do Apple Search Ads.

Assinatura do método

void setDisableCollectIAd(bool disableCollectIAd)

Exemplo

#if UNITY_IOS && !UNITY_EDITOR
            AppsFlyeriOS.setDisableCollectIAd(true);
            #endif

Descrição

Validação de recebimento de compra in-app no ambiente Apple (produção ou sandbox). O valor padrão é false.

Assinatura do método

void setUseReceiptValidationSandbox(bool useReceiptValidationSandbox)

Exemplo

#if UNITY_IOS && !UNITY_EDITOR
            AppsFlyeriOS.setUseReceiptValidationSandbox(true);
            #endif

Descrição

Defina esse sinalizador para testar a desinstalação no ambiente Apple (produção ou sandbox). O valor padrão é false.

Assinatura do método

void setUseUninstallSandbox(bool useUninstallSandbox)

Exemplo

#if UNITY_IOS && !UNITY_EDITOR
            AppsFlyeriOS.setUseUninstallSandbox(true);
            #endif

Descrição

Para enviar e validar compras in-app, faça a chamada para esse método a partir do método processPurchase.

Assinatura do método

void validateAndSendInAppPurchase
(string productIdentifier, string price, string currency, string tranactionId, 
Dictionary<string, string> additionalParameters, MonoBehaviour gameObject)

Exemplo

#if UNITY_IOS && !UNITY_EDITOR
            AppsFlyeriOS.validateAndSendInAppPurchase(
            "productIdentifier", 
            "price", 
            "currency", 
            "tranactionId", 
            null, 
            this);
            #endif

Descrição

Registre-se para notificação remota e forneça à AppsFlyer o token do dispositivo push.

Assinatura do método

void registerUninstall(byte[] deviceToken)

Exemplo

private bool tokenSent;
            void Update()
            {
            #if UNITY_IOS && !UNITY_EDITOR
            if (!tokenSent)
            {
            byte[] token = UnityEngine.iOS.NotificationServices.deviceToken;
            if (token != null)
            {
            AppsFlyeriOS.registerUninstall(token);
            tokenSent = true;
            }
            }
            #endif
            }

Descrição

Usado para rastrear manualmente o deep linking.

Assinatura do método

void handleOpenUrl(string url, string sourceApplication, string annotation)

Exemplo

#if UNITY_IOS && !UNITY_EDITOR
            AppsFlyeriOS.handleOpenUrl(string url, string sourceApplication, string annotation);
            #endif

Descrição

Permite que você utilize o componente StoreKit para abrir a App Store enquanto permanece no contexto do seu aplicativo. Saiba mais.

Assinatura do método

public void onOpenStoreLinkGenerated(string link)

Exemplo

public void onOpenStoreLinkGenerated(string link)
            {
            }

Descrição

Permite desativar a atribuição de SkadNetwork. Defina como "true" para desabilitar.

Assinatura do método

bools disableSKAdNetwork(int isDisabled)

Exemplo

#if UNITY_IOS && !UNITY_EDITOR
    AppsFlyeriOS.disableSKAdNetwork(true);
#endif

Descrição

Usado se você quiser solicitar autorização do usuário por meio de um pop-up antes de acessar dados relacionados ao aplicativo para gravar o usuário ou o dispositivo (por exemplo, IDFA). Se o usuário aceitar, o IDFA será passado para o SDK. O intervalo de tempo limite dá ao usuário um determinado período de tempo para optar pela coleta IDFA. Depois que o temporizador expira, o IDFA não é coletado.

Assinatura do método

void waitForATTUserAuthorizationWithTimeoutInterval(int timeoutInterval)

Exemplo

#if UNITY_IOS && !UNITY_EDITOR
    AppsFlyeriOS.waitForATTUserAuthorizationWithTimeoutInterval(60);
#endif