Introdução aos eventos do app no iOS

Este guia mostra como adicionar eventos do app ao app novo ou existente integrando o SDK do Facebook e registrando esses eventos.

Antes de começar

Você precisará do seguinte:

• Uma conta de desenvolvedor do Facebook
• Uma conta de anúncios do Facebook
• Um portfólio empresarial do Facebook (crie um portfólio empresarial caso ainda não tenha um)
• Um app do Facebook

Etapa 1: configurar o app do Facebook

Acesse o Painel de Apps, clique em Meus apps e, caso ainda não tenha um app, crie um. Acesse Configurações > Básico para visualizar o painel Detalhes do app com o ID, a chave secreta e outras informações.

Role a tela para baixo até o fim da página e clique em Adicionar plataforma. Selecione iOS, insira os detalhes do app e salve as alterações.

Para configurar o app para publicidade, adicione as seguintes informações:

• Domínios do app: forneça o URL do app na App Store da Apple.
• URL da Política de Privacidade: forneça um URL para a Política de Privacidade. Obrigatório para tornar seu app público.
• URL dos Termos de Serviço: forneça um URL para os Termos de Serviço.
• Plataforma: role a tela até a parte inferior do painel “Configurações” para adicionar a plataforma iOS.

Para mais informações sobre como adicionar detalhes ao app, como um ícone ou uma categoria, visite a documentação de desenvolvimento de apps.

Etapa 2: vincular os portfólios empresarial e de anúncios

Para veicular anúncios e mensurar instalações no Gerenciador de Anúncios, associe pelo menos uma conta de anúncios e um portfólio empresarial ao seu app.

1. No Painel de Apps, clique em Configurações > Avançado.
2. Em Identificações das contas de anúncios autorizadas, adicione as identificações das contas de anúncios. Encontre as identificações das contas de anúncios no Gerenciador de Anúncios.
3. No painel Contas de anúncios, clique em Começar e siga as instruções para conectar o app a uma empresa.

Etapa 3: configurar o ambiente de desenvolvedor

O procedimento a seguir usa o Gerenciador de Pacote do Swift para configurar seu ambiente de desenvolvimento no Xcode.

1. No Xcode, clique em File > Add Packages....
2. No campo de pesquisa exibido, insira o URL do repositório: https://github.com/facebook/facebook-ios-sdk.
3. Em Dependency Rule, selecione Up to Next Major Version e insira uma versão recente. A versão mais recente está listada em https://github.com/facebook/facebook-ios-sdk/releases/
4. Escolha as bibliotecas que você pretende usar e os direcionamentos para adicionar a elas.
5. Clique em Add Package para finalizar a configuração.

Etapa 4: registrar e configurar seu app com o Facebook

1. No Painel de Apps, em Configurações do app > Básico, role a tela para baixo e clique em + Adicionar plataforma.
2. Role a tela para baixo até ao cartão iOS e adicione a identificação do pacote. Encontre o identificador do pacote no destino do app para iOS do Projeto Xcode. É possível atualizar o ID do pacote a qualquer momento.

Etapa 5: configurar o projeto

Etapa 6: conectar o representante do app e o representante de cena

  
// AppDelegate.swift
import UIKit
import FBSDKCoreKit

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {    
    func application(
        _ application: UIApplication,
        didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
    ) -> Bool {          
        ApplicationDelegate.shared.application(
            application,
            didFinishLaunchingWithOptions: launchOptions
        )

        return true
    }
          
    func application(
        _ app: UIApplication,
        open url: URL,
        options: [UIApplication.OpenURLOptionsKey : Any] = [:]
    ) -> Bool {
        ApplicationDelegate.shared.application(
            app,
            open: url,
            sourceApplication: options[UIApplication.OpenURLOptionsKey.sourceApplication] as? String,
            annotation: options[UIApplication.OpenURLOptionsKey.annotation]
        )
    }  
}

 
// SceneDelegate.swift
import FBSDKCoreKit
  ...
func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
    guard let url = URLContexts.first?.url else {
        return
    }

    ApplicationDelegate.shared.application(
        UIApplication.shared,
        open: url,
        sourceApplication: nil,
        annotation: [UIApplication.OpenURLOptionsKey.annotation]
    )
}

Etapa 7: adicionar os eventos do app

Há três maneiras de rastrear eventos no app:

• Eventos registrados automaticamente: instalações, inicializações e compras no app são registradas automaticamente com o SDK do Facebook.
• Eventos do app sem código: use essa ferramenta para incluir eventos-padrão sem adicionar código ao app.
• Eventos registrados manualmente: adicione código ao app para rastrear eventos-padrão e personalizados.

Eventos registrados automaticamente

Eventos de compra no app registrados automaticamente

A Apple oferece quatro tipos diferentes de compra no app: consumível, não consumível, assinatura com renovação automática e assinatura não renovável. Se você implementar compras no app com o StoreKit 1, nós registraremos automaticamente cada um desses tipos de compra. Se você implementar compras no app com o StoreKit 2, nós registraremos automaticamente as compras não consumíveis, as assinaturas com renovação automática e as assinaturas não renováveis. Caso você também queira registrar automaticamente as compras consumíveis, será preciso adicionar a chave SKIncludeConsumableInAppPurchaseHistor a Info.plist:

<key>SKIncludeConsumableInAppPurchaseHistory</key>

<true/>

No StoreKit 1, registraremos automaticamente um evento quando o usuário comprar ou restaurar um produto ou quando tentar comprar um produto, mas a compra falhar. No StoreKit 2, registraremos automaticamente um evento quando o usuário comprar ou restaurar um produto. Para registrar um evento de falha na compra no Store Kit 2, basta chamar a API manual fornecida. Você pode chamar essa API no fluxo de compra do StoreKit 2 da seguinte forma:

do {
   let result = try await product.purchase()
   switch result {
   case .success(let verificationResult):
       // Handle success case
   case .pending:
       // Handle pending case
   default:
       AppEvents.shared.logFailedStoreKit2Purchase(product.id)
   }
} catch {
   AppEvents.shared.logFailedStoreKit2Purchase(product.id)
}

Receber consentimento do dispositivo

A partir do iOS 14.5, será preciso definir isAdvertiserTrackingEnabled e registrar todas as vezes que você conceder permissão a um dispositivo para compartilhar dados com o Facebook.

Defina Settings.shared.isAdvertiserTrackingEnabled = true se o dispositivo fornecer o consentimento.

Defina Settings.shared.isAdvertiserTrackingEnabled = false se o dispositivo não permitir o rastreamento.

<key>FacebookAutoLogAppEventsEnabled</key>
<false/>

<key>FacebookAdvertiserIDCollectionEnabled</key>
<false/>

Registrar eventos manualmente

Para registrar um evento personalizado, transmita o nome do evento como AppEvents.Name:

AppEvents.shared.logEvent(AppEvents.Name("battledAnOrc"))

Parâmetros dos eventos

O Facebook criou um conjunto de parâmetros úteis que podem ser incluídos em eventos-padrão ou personalizados. Você também pode fornecer seus próprios parâmetros.

Se quiser usar eventos do app para mensurar as conversões de anúncios dinâmicos, defina o parâmetro fb_content_id como o valor da identificação do produto usado no anúncio dinâmico associado.

Os parâmetros predefinidos servem para fornecer orientação sobre os padrões comuns de registro. Eles podem ter formato mais legível nos relatórios e em outras interfaces do usuário. Registre o conjunto de parâmetros que você quer detalhar. A descrição recomendada desses parâmetros é "somente para orientação". Você pode usar o recurso para o que fizer mais sentido para seu app.

Os parâmetros são passados por meio de um dicionário. Nele, a chave mantém o nome do parâmetro como AppEvents.ParameterName, e o valor deve ser uma String ou um número (Int, Double e assim por diante).

Etapa 8: testar os eventos

Com o Auxiliar para Anúncios de Aplicativo, é possível fazer testes para verificar se o app está enviando os eventos ao Facebook.

1. Abra o Auxiliar para Anúncios de Aplicativo.
2. Em Selecionar um aplicativo, escolha o app e selecione Enviar.
3. Role a tela até o fim e escolha Testar evento.
4. Inicie o app e envie um evento. O evento deve ser exibido na página.

Saiba mais

• Guia de boas práticas para eventos do app – veja diversos exemplos de apps e saiba como eles lidam com eventos do app.
• Perguntas frequentes – confira as perguntas frequentes.
• Curso do Meta Blueprint: Configure the SDK and App Events for iOS
• Curso do Meta Blueprint: Usar eventos do app para direcionar, otimizar e mensurar

Exemplos de apps

Criamos alguns exemplos de diferentes tipos de apps para que você possa ver com mais facilidade como usar os eventos do app. Cada um dos exemplos de apps fornece um detalhamento tela a tela dos diferentes eventos e parâmetros que podem ser coletados. No final de cada seção, há uma tabela que lista os eventos e parâmetros recomendados para cada app. Se necessário, você pode criar os próprios eventos e parâmetros.