Facebook App Events Reference

Android

Standard Events

Nome do evento: Valor de AppEventsConstants Parâmetros Descrição

Nível de conquista: EVENT_NAME_ACHIEVED_LEVEL

LEVEL

A conquista de níveis específicos que você define em seu aplicativo, empresa ou organização.

Ativar o aplicativo: EVENT_NAME_ACTIVATED_APP

O lançamento do seu aplicativo.

Clique em anúncios no aplicativo: EVENT_NAME_AD_CLICK

AD_TYPE

Um anúncio de uma plataforma de terceiros é clicado no seu aplicativo.

Impressão de anúncios no aplicativo: EVENT_NAME_AD_IMPRESSION

AD_TYPE

Um anúncio de uma plataforma de terceiros é exibido na tela no seu aplicativo.

Adição de informações de pagamento: EVENT_NAME_ADDED_PAYMENT_INFO

SUCCESS

A adição de dados de pagamento do cliente durante um processo de finalização da compra.

Adição ao carrinho: EVENT_NAME_ADDED_TO_CART

valueToSum: Preço do item adicionado

CONTENT_TYPE, CONTENT_ID ou CONTENT e CURRENCY

A adição de um item a um carrinho de compras ou cesta. Por exemplo, ao clicar em um botão Adicionar ao carrinho em um site.

Adicionar à lista de desejos: EVENT_NAME_ADDED_TO_WISHLIST

valueToSum: Preço do item adicionado

CONTENT_TYPE, CONTENT_ID ou CONTENT e CURRENCY

A adição de itens a uma lista de desejos. Por exemplo, ao clicar em um botão Adicionar à lista de desejos em um site.

Cadastro concluído: EVENT_NAME_COMPLETED_REGISTRATION

REGISTRATION_METHOD

Um envio de informações por um cliente em troca de um serviço fornecido pela sua empresa. Por exemplo, assinar o informativo por email.

Tutorial concluído: EVENT_NAME_COMPLETED_TUTORIAL

SUCCESS e CONTENT_ID ou CONTENT

A conclusão de um tutorial no seu aplicativo.

Contato: EVENT_NAME_CONTACT

Um telefone ou SMS, email, bate-papo ou outro tipo de contato entre um cliente e sua empresa.

Personalizar produto: EVENT_NAME_CUSTOMIZE_PRODUCT

A personalização de produtos por meio de uma ferramenta de configuração ou outro aplicativo de sua empresa.

Doar: EVENT_NAME_DONATE

A doação de fundos para sua organização ou causa.

Encontrar localização: EVENT_NAME_FIND_LOCATION

Quando uma pessoa encontra um dos seus locais pela Web ou pelo aplicativo com a intenção de visitar. Por exemplo, procurar por um produto e encontrar em uma de suas lojas locais.

Iniciar finalização da compra: EVENT_NAME_INITIATED_CHECKOUT

valueToSum: Preço total dos itens no carrinho de compras

CONTENT_TYPE, CONTENT_ID ou CONTENT,NUM_ITEMS, PAYMENT_INFO_AVAILABLE e CURRENCY

O início de um processo de finalização da compra.

Comprar: EVENT_NAME_PURCHASED

valueToSum: Preço de compra

NUM_ITEMS, CONTENT_TYPE, CONTENT_ID ou CONTENT e CURRENCY

A conclusão de uma compra, geralmente representada por recebimento de confirmação de pedido ou compra, ou um recibo de transação.

Classificar: EVENT_NAME_RATED

valueToSum: Classificação atribuída

CONTENT_TYPE, CONTENT_ID ou CONTENT e MAX_RATING_VALUE

Uma classificação de algo no seu aplicativo, empresa ou organização. Por exemplo, classifica um restaurante em um aplicativo de avaliação de restaurantes.

Programação: EVENT_NAME_SCHEDULE

A reserva de um horário para visitar uma de suas localizações.

Pesquisa: EVENT_NAME_SEARCHED

CONTENT_TYPE, SEARCH_STRING e SUCCESS

Uma pesquisa executada em seu site, aplicativo ou outra propriedade, como pesquisas de produtos, pesquisas de viagens etc.

Créditos gastos: EVENT_NAME_SPENT_CREDITS

valueToSum: Valor total de créditos gastos

CONTENT_TYPE e CONTENT_ID ou CONTENT

A conclusão de uma transação em que as pessoas gastam créditos específicos para sua empresa ou aplicativo, como uma moeda no aplicativo.

Começar um teste: EVENT_NAME_START_TRIAL

valueToSum: Preço da assinatura

ORDER_ID e CURRENCY

O início de uma avaliação gratuita de um produto ou serviço que você oferece, como uma assinatura de avaliação.

Enviar uma solicitação: EVENT_NAME_SUBMIT_APPLICATION

A apresentação de um pedido de um produto, serviço ou programa que você oferece, como um cartão de crédito, programa educacional ou trabalho.

Inscrever-se: EVENT_NAME_SUBSCRIBE

valueToSum: Preço da assinatura

ORDER_ID e CURRENCY

O início de uma assinatura paga para um produto ou serviço que você oferece.

Desbloquear conquista: EVENT_NAME_UNLOCKED_ACHIEVEMENT

DESCRIPTION

A conclusão de atividades ou ações específicas que você deseja premiar em seu aplicativo, empresa ou organização. Por exemplo, indicar um amigo, completar seu perfil etc.

Exibir conteúdo: EVENT_NAME_VIEWED_CONTENT

Preço do item visualizado (se aplicável)

CONTENT_TYPE, CONTENT_ID ou CONTENT e CURRENCY

Uma visita a uma página de conteúdo de seu interesse, como uma página de produto, uma página de destino ou um artigo. As informações sobre a página visualizada podem ser passadas para o Facebook para uso em anúncios dinâmicos.

Standard Event Parameters

AppEventConstants::EVENT_PARAM_* Possible Values Description

Ad Type:
EVENT_PARAM_AD_TYPE

string

Type of ad: banner, interstitial, rewarded_video, native

Content ID:

EVENT_PARAM_CONTENT_ID

string

International Article Number (EAN) when applicable, or other product or content identifier

Content:

EVENT_PARAM_CONTENT

string

A list of JSON object that contains the International Article Number (EAN) when applicable, or other product or content identifier(s) as well as additional information about the products. id and quantity are the available fields. e.g. "[{\"id\": \"1234\", \"quantity\": 2}, {\"id\": \"5678\", \"quantity\": 1}]"

Content Type:

EVENT_PARAM_CONTENT_TYPE

string

'product' or 'product_group'

Currency:

EVENT_PARAM_CURRENCY

string

ISO 4217 code, e.g., "EUR", "USD", "JPY"

Description:

EVENT_PARAM_DESCRIPTION

string

A string description

Level:

EVENT_PARAM_LEVEL

string

Level of a game

Max. Rating Value:

EVENT_PARAM_MAX_RATING_VALUE

int

Upper bounds of a rating scale, for example 5 on a 5 star scale

Number of Items:

EVENT_PARAM_NUM_ITEMS

int

Number of items

Order ID:

EVENT_PARAM_ORDER_ID

string

The unique ID for all events within a subscription

Payment Info Available:

EVENT_PARAM_PAYMENT_INFO_AVAILABLE

1 or 0

1 for yes, 0 for no

Registration Method:

EVENT_PARAM_REGISTRATION_METHOD

string

Facebook, Email, Twitter, etc.

Search String:

EVENT_PARAM_SEARCH_STRING

string

The text string that was searched for

Success:

EVENT_PARAM_SUCCESS

1 or 0

1 for yes, 0 for no

iOS

App Store Connect para iOS 14

Os eventos que seu app coleta e envia para o Facebook podem exigir que você divulgue esses tipos de dados no questionário do App Store Connect. É sua responsabilidade informar isso na política de privacidade do aplicativo. Consulte App privacy details on the App Store para saber os tipos de dados que você precisará divulgar.

Standard Events

Event Name: FBSDKAppEventName Parameters Description

Achieve Level: FBSDKAppEventNameAchievedLevel

Level

The achievement of specific levels you define within your application, business or organization.

Activate App: FBSDKAppEventNameActivatedApp

The launch of your app.

In-App Ad Click: FBSDKAppEventNameAdClick

AdType

An ad from a third-party platform is clicked within your app.

In-App Ad Impression: FBSDKAppEventNameAdImpression

AdType

An ad from a third-party platform appears on-screen within your app.

Add Payment Info: FBSDKAppEventNameAddedPaymentInfo

Success

The addition of customer payment information during a checkout process.

Add to Cart: FBSDKAppEventNameAddedToCart

valueToSum: Price of item added

ContentType, ContentID or Content, and Currency

The addition of an item to a shopping cart or basket. For example, clicking an Add to Cart button on a website.

Add to Wishlist: FBSDKAppEventNameAddedToWishlist

valueToSum: Price of item added

ContentType, ContentID or Content, and Currency

The addition of items to a wishlist. For example, clicking an Add to Wishlist button on a website.

Complete Registration: FBSDKAppEventNameCompletedRegistration

RegistrationMethod

A submission of information by a customer in exchange for a service provided by your business. For example, sign up for an email subscription.

Complete Tutorial: FBSDKAppEventNameCompletedTutorial

Success, and ContentID or Content

A completion of a tutorial on your app.

Contact: FBSDKAppEventNameContact

A telephone or SMS, email, chat or other type of contact between a customer and your business.

Customize Product: FBSDKAppEventNameCustomizeProduct

The customization of products through a configuration tool or other application your business owns.

Donate: FBSDKAppEventNameDonate

The donation of funds to your organization or cause.

Find Location: FBSDKAppEventNameFindLocation

When a person finds one of your locations via web or app, with an intention to visit. For example, searching for a product and finding it at one of your local stores.

Initiate Checkout: FBSDKAppEventNameInitiatedCheckout

valueToSum: Total price of items in cart

ContentType, ContentID or Content, NumItems, PaymentInfoAvailable, and Currency

The start of a checkout process.

Purchase: FBSDKAppEventNamePurchased

Use the logPurchase method instead.

valueToSum: Purchase price

NumItems, ContentType, ContentID or Content, and Currency

The completion of a purchase, usually signified by receiving order or purchase confirmation or a transaction receipt.

Rate: FBSDKAppEventNameRated

valueToSum: Rating given

ContentType, ContentID or Content, and MaxRatingValue

A rating of something within your app, business or organization. For example, rates a restaurant within a restaurant review app

Schedule: FBventNameSchedule

The booking of an appointment to visit one of your locations.

Search: FBSDKAppEventNameSearched

ContentType, SearchString, and Success

A search performed on your website, app or other property, such as product searches, travel searches, etc.

Spent Credits: FBSDKAppEventNameSpentCredits

valueToSum: Total value of credits spent

ContentType, and ContentID or Content

The completion of a transaction where people spend credits specific to your business or application, such as in-app currency.

Start Trial: FBSDKAppEventNameStartTrial

valueToSum: Total value of credits spent

OrderID

and

Currency

The start of a free trial of a product or service you offer, such as a trial subscription.

Schedule

See App Events Schema

Submit Application: FBSDKAppEventNameSubmitApplication

The submission of an application for a product, service or program you offer, such as a credit card, educational program or job.

Subscribe

See App Events Schema

Subscription: FBSDKAppEventNameSubscription

valueToSum: Price of Subscription

OrderID

and

Currency

The start of a paid subscription for a product or service you offer.

Unlock Achievement: FBSDKAppEventNameUnlockedAchievement

Description

The completion of specific activities or actions you want to reward within your application, business or organization. For example, refer a friend, complete your profile, etc.

View Content: FBSDKAppEventNameViewedContent

valueToSum: Price of item viewed (if applicable)

ContentType, ContentID or Content, and Currency

A visit to a content page you care about, such as a product page, landing page or article. Information about the page viewed can be passed to Facebook for use in Advantage+ catalog ads.

Standard Event Parameters

Parameter: FBSDKAppEventParameterName Possible Values Description

Ad Type:

FBSDKAppEventParameterNameAdType

string

Type of ad: banner, interstitial, reward_video, native

Content:

FBSDKAppEventParameterNameContent

string

A list of JSON object that contains the International Article Number (EAN) when applicable, or other product or content identifiers and additional information about the products. id and quantity are the available fields. e.g. "[{\"id\": \"1234\", \"quantity\": 2}, {\"id\": \"5678\", \"quantity\": 1}]"

Content ID:

FBSDKAppEventParameterNameContentID

string

International Article Number (EAN) when applicable, or other product or content identifier

Content Type:

FBSDKAppEventParameterNameContentType

string

product or product_group

Currency:

FBSDKAppEventParameterNameCurrency

string

ISO 4217 code, for example, EUR, USD, JPY

Description:

FBSDKAppEventParameterNameDescription

string

A string description

Level:

FBSDKAppEventParameterNameLevel

string

Level of a player

Max. Rating Value:

FBSDKAppEventParameterNameMaxRatingValue

int

Upper bounds of a rating scale, for example 5 on a 5 star scale

Number of Items:

FBSDKAppEventParameterNameNumItems

int

Number of items

Order ID:

FBSDKAppEventParameterNameOrderID

string

The unique ID for all events within a subscription

Payment Info Available:

FBSDKAppEventParameterNamePaymentInfoAvailable

1 or 0

1 for yes, 0 for no

Registration Method:

FBSDKAppEventParameterNameRegistrationMethod

string

Facebook, Email, Twitter, etc.

Search String:

FBSDKAppEventParameterNameSearchString

string

The string that was searched for

Success:

FBSDKAppEventParameterNameSuccess

1 or 0

1 for yes, 0 for no

Web

Standard Events

Nome do evento: Valor de AppEventsConstants Parâmetros Descrição

Nível de conquista: EVENT_NAME_ACHIEVED_LEVEL

LEVEL

A conquista de níveis específicos que você define em seu aplicativo, empresa ou organização.

Ativar o aplicativo: EVENT_NAME_ACTIVATED_APP

O lançamento do seu aplicativo.

Clique em anúncios no aplicativo: EVENT_NAME_AD_CLICK

AD_TYPE

Um anúncio de uma plataforma de terceiros é clicado no seu aplicativo.

Impressão de anúncios no aplicativo: EVENT_NAME_AD_IMPRESSION

AD_TYPE

Um anúncio de uma plataforma de terceiros é exibido na tela no seu aplicativo.

Adição de informações de pagamento: EVENT_NAME_ADDED_PAYMENT_INFO

SUCCESS

A adição de dados de pagamento do cliente durante um processo de finalização da compra.

Adição ao carrinho: EVENT_NAME_ADDED_TO_CART

valueToSum: Preço do item adicionado

CONTENT_TYPE, CONTENT_ID ou CONTENT e CURRENCY

A adição de um item a um carrinho de compras ou cesta. Por exemplo, ao clicar em um botão Adicionar ao carrinho em um site.

Adicionar à lista de desejos: EVENT_NAME_ADDED_TO_WISHLIST

valueToSum: Preço do item adicionado

CONTENT_TYPE, CONTENT_ID ou CONTENT e CURRENCY

A adição de itens a uma lista de desejos. Por exemplo, ao clicar em um botão Adicionar à lista de desejos em um site.

Cadastro concluído: EVENT_NAME_COMPLETED_REGISTRATION

REGISTRATION_METHOD

Um envio de informações por um cliente em troca de um serviço fornecido pela sua empresa. Por exemplo, assinar o informativo por email.

Tutorial concluído: EVENT_NAME_COMPLETED_TUTORIAL

SUCCESS e CONTENT_ID ou CONTENT

A conclusão de um tutorial no seu aplicativo.

Contato: EVENT_NAME_CONTACT

Um telefone ou SMS, email, bate-papo ou outro tipo de contato entre um cliente e sua empresa.

Personalizar produto: EVENT_NAME_CUSTOMIZE_PRODUCT

A personalização de produtos por meio de uma ferramenta de configuração ou outro aplicativo de sua empresa.

Doar: EVENT_NAME_DONATE

A doação de fundos para sua organização ou causa.

Encontrar localização: EVENT_NAME_FIND_LOCATION

Quando uma pessoa encontra um dos seus locais pela Web ou pelo aplicativo com a intenção de visitar. Por exemplo, procurar por um produto e encontrar em uma de suas lojas locais.

Iniciar finalização da compra: EVENT_NAME_INITIATED_CHECKOUT

valueToSum: Preço total dos itens no carrinho de compras

CONTENT_TYPE, CONTENT_ID ou CONTENT,NUM_ITEMS, PAYMENT_INFO_AVAILABLE e CURRENCY

O início de um processo de finalização da compra.

Comprar: EVENT_NAME_PURCHASED

valueToSum: Preço de compra

NUM_ITEMS, CONTENT_TYPE, CONTENT_ID ou CONTENT e CURRENCY

A conclusão de uma compra, geralmente representada por recebimento de confirmação de pedido ou compra, ou um recibo de transação.

Classificar: EVENT_NAME_RATED

valueToSum: Classificação atribuída

CONTENT_TYPE, CONTENT_ID ou CONTENT e MAX_RATING_VALUE

Uma classificação de algo no seu aplicativo, empresa ou organização. Por exemplo, classifica um restaurante em um aplicativo de avaliação de restaurantes.

Programação: EVENT_NAME_SCHEDULE

A reserva de um horário para visitar uma de suas localizações.

Pesquisa: EVENT_NAME_SEARCHED

CONTENT_TYPE, SEARCH_STRING e SUCCESS

Uma pesquisa executada em seu site, aplicativo ou outra propriedade, como pesquisas de produtos, pesquisas de viagens etc.

Créditos gastos: EVENT_NAME_SPENT_CREDITS

valueToSum: Valor total de créditos gastos

CONTENT_TYPE e CONTENT_ID ou CONTENT

A conclusão de uma transação em que as pessoas gastam créditos específicos para sua empresa ou aplicativo, como uma moeda no aplicativo.

Começar um teste: EVENT_NAME_START_TRIAL

valueToSum: Preço da assinatura

ORDER_ID e CURRENCY

O início de uma avaliação gratuita de um produto ou serviço que você oferece, como uma assinatura de avaliação.

Enviar uma solicitação: EVENT_NAME_SUBMIT_APPLICATION

A apresentação de um pedido de um produto, serviço ou programa que você oferece, como um cartão de crédito, programa educacional ou trabalho.

Inscrever-se: EVENT_NAME_SUBSCRIBE

valueToSum: Preço da assinatura

ORDER_ID e CURRENCY

O início de uma assinatura paga para um produto ou serviço que você oferece.

Desbloquear conquista: EVENT_NAME_UNLOCKED_ACHIEVEMENT

DESCRIPTION

A conclusão de atividades ou ações específicas que você deseja premiar em seu aplicativo, empresa ou organização. Por exemplo, indicar um amigo, completar seu perfil etc.

Exibir conteúdo: EVENT_NAME_VIEWED_CONTENT

Preço do item visualizado (se aplicável)

CONTENT_TYPE, CONTENT_ID ou CONTENT e CURRENCY

Uma visita a uma página de conteúdo de seu interesse, como uma página de produto, uma página de destino ou um artigo. As informações sobre a página visualizada podem ser passadas para o Facebook para uso em anúncios dinâmicos.

Standard Event Parameters

AppEventConstants::EVENT_PARAM_* Possible Values Description

Ad Type:

EVENT_PARAM_AD_TYPE

string

Type of ad: banner, interstitial, rewarded_video, native

Content:

EVENT_PARAM_CONTENT

string

A list of JSON object that contains the International Article Number (EAN) when applicable, or other product or content identifier(s) as well as additional information about the products. id, quantity, and item_price are the available fields. e.g. "[{\"id\": \"1234\", \"quantity\": 2, \"item_price\": 5.99}, {\"id\": \"5678\", \"quantity\": 1, \"item_price\": 9.99}]"

Content ID:

EVENT_PARAM_CONTENT_ID

string

International Article Number (EAN) when applicable, or other product or content identifier

Content Type:

EVENT_PARAM_CONTENT_TYPE

string

'product' or 'product_group'

Currency:

EVENT_PARAM_CURRENCY

string

ISO 4217 code, e.g., "EUR", "USD", "JPY"

Description:

EVENT_PARAM_DESCRIPTION

string

A string description

Level:

EVENT_PARAM_LEVEL

string

Level of a game

Max. Rating Value:

EVENT_PARAM_MAX_RATING_VALUE

int

Upper bounds of a rating scale, for example 5 on a 5 star scale

Number of Items:

EVENT_PARAM_NUM_ITEMS

int

Number of items

Order ID:

EVENT_PARAM_ORDER_ID

string

The unique ID for all events within a subscription

Payment Info Available:

EVENT_PARAM_PAYMENT_INFO_AVAILABLE

1 or 0

1 for yes, 0 for no

Registration Method:

EVENT_PARAM_REGISTRATION_METHOD

string

Facebook, Email, Twitter, etc.

Search String:

EVENT_PARAM_SEARCH_STRING

string

The text string that was searched for

Success:

EVENT_PARAM_SUCCESS

1 or 0

1 for yes, 0 for no