Obtenha sua chave SDK da Singular

Em sua conta da Singular, vá para "Developer Tools > SDK Integration > SDK Keys" e copie sua SDK Key e Secret.

Adicione o Singular como uma saída do mParticle

1. Em sua conta do mParticle, vá para Setup > Outputs (Configuração > Saídas) e clique em Add Event Output (Adicionar saída de evento).
2. Selecione Singular na lista suspensa.
3. Na janela Event Configuration (Configuração de evento ), digite um nome para a configuração e digite a chave e o segredo do Singular que você copiou na etapa anterior.
4. Clique em Save (Salvar).

Instalar o SDK da Singular

Para instalar o SDK da Singular:

1. Em seu aplicativo, adicione AdServices.framework em Link Binary With Libraries e marque-o como Optional (disponível apenas para dispositivos com iOS 14.3 e superior).

2. Adicione o pod Singular MParticle ao podfile de seu aplicativo:

   pod 'mParticle-Singular'

3. No diretório do arquivo de pod, execute "pod install".

Importar a biblioteca do Singular

Para importar a biblioteca Singular, adicione a seguinte linha de código:

#import "MPKitSingular.h"

Inicializar o SDK do Singular

O código de inicialização do SDK deve ser chamado sempre que o aplicativo for aberto. Ele é um pré-requisito para todas as funcionalidades de atribuição do Singular e também envia uma nova sessão de usuário para o Singular (as sessões são usadas para calcular a retenção de usuários).

- (BOOL)application:(UIApplication *)application 
  didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    //inicializar mParticle 
    MParticleOptions *options = [MParticleOptions 
      optionsWithKey:@"<MPARTICLE_KEY>" 
      secret:@"<MPARTICLE_SECRET>"];
    [[MParticle sharedInstance] startWithOptions:options]; 
    return YES; 
}

[OPCIONAL] Rastrear eventos

A Singular pode coletar dados sobre eventos in-app para ajudar a analisar o desempenho de suas campanhas e medir KPIs.

Dependendo do seu aplicativo, talvez você queira rastrear eventos como logins de usuários, registros, conclusões de tutoriais ou aumento de nível em um jogo.

O código de exemplo a seguir relata um evento chamado "event_name" para a Singular, com dois atributos personalizados. Você poderá ver a contagem de ocorrências de "event_name" em seus relatórios do Singular.

MPEvent *event = [[MPEvent alloc] initWithName:@"event_name"
  type:MPEventTypeTransaction];
event.customAttributes = @{
  @"category":@"Destination Intro", 
  @"title":@"Paris"};
[[MParticle sharedInstance] logEvent:event];

[OPCIONAL] Rastrear receita

A Singular pode coletar dados sobre a receita obtida por meio do aplicativo para ajudar a analisar o desempenho e o ROI de suas campanhas.

A Singular disponibilizará os dados para você em relatórios, exportação de registros e postbacks.

Para rastrear a receita, informe os eventos de receita à Singular, como no exemplo a seguir. Esse exemplo relata uma compra in-app de um produto, fornecendo o nome do produto, a SKU, a quantidade e o preço.

// 1. Crie os produtos
MPProduct *product = [[MPProduct alloc] initWithName:@"product_name" 
  sku:@"product_sku" quantity:@10 price:@100.00];

// 2. Resuma a transação
MPTransactionAttributes *attributes = [[MPTransactionAttributes alloc] init];
attributes.transactionId = @"ransaction_id";
attributes.revenue = @400.00;
attributes.tax = @10.00;
  
// 3. Registrar o evento de compra
MPCommerceEventAction action = MPCommerceEventActionPurchase;
MPCommerceEvent *revenueEvent = [[MPCommerceEvent alloc] 
  initWithAction:action product:product];
revenueEvent.transactionAttributes = attributes;
[[MParticle sharedInstance] logEvent:revenueEvent];

[OPCIONAL] Adicionar suporte a SKAdNetwork

SKAdNetwork é a nova estrutura da Apple para determinar a atribuição de instalações móveis sem comprometer a privacidade do usuário final.

A SKAdNetwork permite medir o desempenho das suas campanhas de marketing de aplicativos sem compartilhar as informações de identificação pessoal do usuário.

A solução única de SKAdNetwork, SKAN, permite que você implemente SKAdNetwork com o mínimo de esforço de engenharia. Depois de inicializar a SKAN, cada evento relatado à Singular é automaticamente processado no lado do servidor para atualizar o valor de conversão com base em seu modelo de conversão predefinido. O novo valor de conversão é então enviado de volta ao aplicativo. Esse processo se repete até que o período de medição termine e o aplicativo envie o valor de conversão mais recente para a SKAdNetwork.

Para obter mais informações, consulte Introdução à solução SKAdNetwork da Singulare Como começar a usar a SKAdNetwork.

O código de exemplo a seguir ativa o SKAN após uma espera de 60 segundos pelo consentimento da ATT (consulte Singular iOS SDK: Manipulação do consentimento do AppTrackingTransparency).

[MPKitSingular setSKANOptions:YES isManualSkanConversionManagementMode:NO 
  withWaitForTrackingAuthorizationWithTimeoutInterval:@60.0 
  withConversionValueUpdatedHandler:^(NSInteger conversionValue) {
    NSLog(@"conversion value %ld", conversionValue);
}];

[OPCIONAL] Manipular links profundos

Deep links são links que levam a um conteúdo específico dentro de um aplicativo. Quando um usuário clica em um link profundo em um dispositivo que tem o aplicativo instalado, o aplicativo é aberto e mostra um produto ou uma experiência específica.

Os links de rastreamento singulares podem incluir links diretos, bem como links diretos diferidos (consulte nossas Perguntas frequentes sobre links diretose as Perguntas frequentes sobre links singulares para obter mais informações).

Observações:

• A Singular usa o iOS Universal Links para links diretos.
• Para ativar os Universal Links, siga as instruções em Pré-requisitos de Singular Links.
• Os destinos de deep link para seu aplicativo precisam ser configurados na página Apps no Singular (consulte Configurando URLs de deep link).

Manipulação de Deep Links usando AppDelegate:

Adicione uma chamada ao método de inicialização do SDK, incluindo onAttributionComplete:

- (BOOL)application:(UIApplication *)application 
  didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // inicializar mParticle
    MParticleOptions *options = [MParticleOptions 
      optionsWithKey:@"<MPARTICLE_KEY>" 
      secret:@"<MPARTICLE_SECRET>"];
    options.proxyAppDelegate = NO; 
    [[MParticle sharedInstance] startWithOptions:options]; 
    return YES; 
}

Adicione também uma chamada ao método continueUserActivity do mParticle no continueUserActivity do AppDelegate:

- (BOOL)application:(UIApplication *)application 
  continueUserActivity:(NSUserActivity *)userActivity
  restorationHandler:(void (^)(NSArray<id<UIUserActivityRestoring>> * _Nullable))
    restorationHandler {
    [[MParticle sharedInstance] continueUserActivity:userActivity 
      restorationHandler:restorationHandler];
    return YES;
}

Manipulação de Deep Links usando SceneDelegate:

Adicione uma chamada ao método continueUserActivity do mParticle em continueUserActivity e willConnectToSession do SceneDelegate:

- (void)scene:(UIScene *)scene willConnectToSession:(UISceneSession *)session 
  options:(UISceneConnectionOptions *)connectionOptions {
    NSUserActivity* userActivity =
      [[[connectionOptions userActivities] allObjects] firstObject];
    [[MParticle sharedInstance] continueUserActivity:userActivity 
      restorationHandler:nil];
}
  
- (void)scene:(UIScene *)scene
  continueUserActivity:(NSUserActivity *)userActivity{
    [[MParticle sharedInstance] continueUserActivity:userActivity 
      restorationHandler:nil];
}

Obtenha sua chave de SDK da Singular

Em sua conta da Singular, vá para "Developer Tools > SDK Integration > SDK Keys" e copie sua SDK Key e Secret.

Adicione o Singular como uma saída do mParticle

1. Em sua conta do mParticle, vá para Setup > Outputs (Configuração > Saídas) e clique em Add Event Output (Adicionar saída de evento).
2. Selecione Singular na lista suspensa.
3. Na janela Event Configuration (Configuração de evento ), digite um nome para a configuração e digite a chave e o segredo do Singular que você copiou na etapa anterior.
4. Clique em Save (Salvar).

Instalar o SDK

1. Adicione o servidor Maven da Singular ao seu buildscript da seguinte forma: esse é um requisito do kit da Singular.

   repositories {
     maven { url "http://maven.singular.net"}
     //...
   }

2. Adicione a dependência do kit ao build.gradle do seu aplicativo:

   dependencies {
     compile 'com.mparticle:android-singular-kit:5+'
   }

Inicializar o SDK

O código de inicialização do SDK deve ser chamado toda vez que o aplicativo for aberto. Ele é um pré-requisito para todas as funcionalidades de atribuição da Singular e também envia uma nova sessão de usuário para a Singular (as sessões são usadas para calcular a retenção de usuários). Você poderá rastrear as sessões no painel do mParticle, bem como nos relatórios do Singular.

// importar mParticle
import com.mparticle.MParticle;
import com.mparticle.MParticleOptions;
  
public class ExampleActivity extends Activity {
  @Override
  public void onCreate() {
    super.onCreate();
    MParticleOptions options = MParticleOptions.builder(this)
      .credentials("SUBSTITUA-ME PELA CHAVE", "SUBSTITUA-ME POR SEGREDO")
      .build();
    MParticle.start(options);
  }
}

[OPCIONAL] Definir o ID do usuário

O SDK da Singular pode enviar um ID de usuário do seu aplicativo para a Singular, que pode ser um nome de usuário, um endereço de e-mail, uma string gerada aleatoriamente ou qualquer outro identificador que você use como ID de usuário.

A Singular usa a ID de usuário nas exportações de dados no nível do usuário e nos postbacks internos do BI (se você configurar esses postbacks).

Depois que você define o ID do usuário, ele é enviado junto com qualquer sessão e evento. O ID do usuário persiste até que você o desfaça ou até que o aplicativo seja desinstalado.Fechar/reiniciar o aplicativo não desfaz a definição do ID do usuário.

IdentityApiRequest identityRequest = IdentityApiRequest.withEmptyUser()
  .email("foo@example.com")
  .customerId("123456")
  .build();
MParticle.getInstance().Identity().login(identityRequest);

[OPCIONAL] Rastrear eventos

A Singular pode coletar dados sobre eventos in-app para ajudar a analisar o desempenho de suas campanhas e medir KPIs.

Dependendo do seu aplicativo, talvez você queira rastrear eventos como logins de usuários, registros, conclusões de tutoriais ou aumento de nível em um jogo.

O código de exemplo a seguir relata um evento chamado "test_event" para a Singular com informações adicionais (customAttributes) no formato JSONObject.

Map<String, String> customAttributes = new HashMap<String, String>();
customAttributes.put("category", "event_category");
MPEvent event = new MPEvent.Builder("test_event", 
  MParticle.EventType.Navigation)
  .customAttributes(customAttributes)
  .build();
MParticle.getInstance().logEvent(event);

[OPCIONAL] Rastrear receita

A Singular pode coletar dados sobre a receita obtida por meio do aplicativo recebendo eventos Product.PURCHASE do mParticle.

A receita do evento é calculada como quantidade * product_cost.

Product product = new Product.Builder("extra life", "extra-life", 100.00)
  .quantity(4.0)
  .build();
TransactionAttributes attributes = new TransactionAttributes("123123")
  .setRevenue(430.00)
  .setTax(30.00);
  
CommerceEvent event = new CommerceEvent.Builder(Product.PURCHASE, product)
  .transactionAttributes(attributes)
  .currency("USD")
  .build();
  
MParticle.getInstance().logEvent(event);

[OPCIONAL] Manipular links profundos

Deep links são links que levam a um conteúdo específico dentro de um aplicativo. Quando um usuário clica em um link profundo em um dispositivo que tem o aplicativo instalado, o aplicativo é aberto e mostra um produto ou uma experiência específica.

Os links de rastreamento singulares podem incluir links diretos, bem como links diretos diferidos(consulte nossas Perguntas frequentes sobre links diretose as Perguntas frequentes sobre links singularespara obter mais informações).

Observações:

• Para habilitar links diretos para seu aplicativo, consulte Pré-requisitos do Singular Links.
• Os destinos de links diretos para seu aplicativo precisam ser configurados na página Aplicativos no Singular (consulte Configurando URLs de links diretos).

Para lidar com deep links, implemente AttributionListener como no exemplo a seguir. Observe que você precisa implementar o AttributionListener em cada atividade de entrada principal.

public class ActivityDeeplink extends AppCompatActivity 
  implements AttributionListener {
  
  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
  MParticleOptions options = MParticleOptions.builder(this)
    .credentials("SUBSTITUA-ME PELA CHAVE", "SUBSTITUA-ME POR SEGREDO")
    .attributionListener(this)
    .logLevel(MParticle.LogLevel.VERBOSE)
    .build();
  MParticle.start(options);
}
  
  @Override
  public void onResult(@NonNull @NotNull AttributionResult 
    attributionResult) {
    if (attributionResult.getServiceProviderId() == MParticle.ServiceProviders.SINGULAR) {
      String deeplink = attributionResult.getLink();
      JSONObject data = attributionResult.getParameters();
      String passthrough = data.optString("passthrough", null);
      
      // Lidar com link direto
      //...
    }
}
  
  @Override
  public void onError(@NonNull @NotNull AttributionError attributionError) {
  // Lidar com o erro
  //...
  }
}