Facebook Conversions API Export Integration

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

You can use the Facebook Conversions API to send job results (in the form of event data) from Treasure Data directly to Facebook to measure how much your Facebook ads lead to real-world outcomes, such as purchases, registrations, applications, or some other web conversions.

You can upload 1st party data as conversion data in addition to the conversion data that is ingested by Facebook Pixel as 3rd party data.

You can also upload CV logs extracted from your web server logs to the Facebook conversion API.

Prerequisites

• Basic Knowledge of Treasure Data.

• Basic knowledge of Facebook Conversions and Facebook Event

• To upload event data, you need access to one of the following on Facebook:

  • Business Manager admin
  • Admin system user who created the event set

• Admin on the ad_account connected to the event set

• Facebook Pixel ID

• Facebook Access Token

Obtain Facebook Pixel ID and Access Token

1. Open the Business Manager dashboard and select Event Manager.

2. Select an Event Set. Select Settings, and the Pixel ID will be displayed.

3. Select Create Access Token.

4. Select your Pixel.
5. Select Next.

6. Select Generate Access Token.

7. Copy and save the access token. For security, we have obscured the token in our sample.
8. Select Next.

Validate an Upload

To try an upload test, check the test code on the Test Events tab.

Use TD Console to Create Your Connection

Create a New Connection

In Treasure Data, you must create and configure the data connection to be used during export prior to running your query. As part of the data connection, you provide authentication to access the integration.

1. Open TD Console.
2. Navigate to Integrations Hub > Catalog.
3. Search for and select Facebook Conversion API.

1. Select Create Authentication.

Complete these fields:

• Pixel ID

• Access Token

  

2. Select Continue.  Type a name for your connection and select Done.

Define your Query

You need to define the column mapping in the query. The columns in the query represent Event data to be uploaded into Facebook.

Any website events shared using Conversions API require the following data parameters:

• client_user_agent
• action_source
• event_source_url

However, non-web events require only the parameter action_source.

These parameters help improve the quality of events used for ad delivery and may improve campaign performance. Additionally, the data is hashed and normalized for some columns before being sent to Facebook.

You need at least one customer information column to configure export results. Learn more about hashing and normalization requirements and Facebook Conversions API.

Integration Parameters for Facebook Conversions API

Example Query

If you want to export data like currency that belongs to custom_data, you must set data in JSON format.

For example, the query should look similar to:

WITH sample_data AS(
  SELECT 
     *
  FROM
    (
    VALUES(
      1,
      'USD',
      104.2
    ),
    (
      2,
      'JPY',
      10000.2
    ),
    (
      3,
      'USD',
      103.4
    )
    ) AS t(
      id,
      currency,
      VALUE
    )
) SELECT 
  CAST(
    MAP(
      ARRAY['currency',
      'value'],
      ARRAY[currency,
      CAST(
        VALUE AS VARCHAR
      ) ]
    ) AS JSON
  ) AS custom_data,
  id
FROM
  sample_data

To query multiple values with the same name, you specify the name multiple times in the query.

Example of a Query to Populate Events Data

From Treasure Data, run the following query with export results into a connection for Facebook Conversions:

• Regular SELECT query from a table

SELECT
  an_event_name_column AS event_name,
  an_event_time_column AS event_time,
  an_email_column AS em,
  a_country_column AS country
FROM your_table;

• Query custom_data column

SELECT
  'PageView' as event_name,
  1598531676 as event_time,
  'elizabetho@fb.com' as em,
  '{"a":12, "b":"c"}' as custom_data

Example App Data Event query

SELECT 
  event_name,
  event_time,
  em,
  action_source,
  advertiser_tracking_enabled,
  application_tracking_enabled,
  campaign_ids,
  install_referrer,
  installer_package,
  url_schemes,
  vendor_id,
  windows_attribution_id,
  extinfo_version,
  app_package_name,
  short_version,
  long_version,
  os_version,
  device_model_name,
  locale,
  timezone_abbr,
  carrier,
  screen_width,
  screen_height,
  screen_density,
  cpu_core,
  external_storage_size,
  free_space_in_external_storage_size,
  device_time_zone,
  anon_id,
  madid,
  client_ip_address,
  client_user_agent
FROM
  conversion_table

Integration Parameters for Facebook Conversions API

Treasure Data handles data normalization and hashing based on the Facebook side data requirement in our integration before sending.

See more on Facebook's content pages.

(Optional) Schedule Query Export Jobs

You can use Scheduled Jobs with Result Export to periodically write the output result to a target destination that you specify.

Treasure Data's scheduler feature supports periodic query execution to achieve high availability.

When two specifications provide conflicting schedule specifications, the specification requesting to execute more often is followed while the other schedule specification is ignored.

For example, if the cron schedule is '0 0 1 * 1', then the 'day of month' specification and 'day of week' are discordant because the former specification requires it to run every first day of each month at midnight (00:00), while the latter specification requires it to run every Monday at midnight (00:00). The latter specification is followed.

Scheduling your Job Using TD Console

1. Navigate to Data Workbench > Queries

2. Create a new query or select an existing query.

3. Next to Schedule, select None.

4. In the drop-down, select one of the following schedule options:

   Drop-down Value	Description
   Custom cron...	Review Custom cron... details.
   @daily (midnight)	Run once a day at midnight (00:00 am) in the specified time zone.
   @hourly (:00)	Run every hour at 00 minutes.
   None	No schedule.

Custom cron... Details

 *    *    *    *    *
 -    -    -    -    -
 |    |    |    |    |
 |    |    |    |    +----- day of week (0 - 6) (Sunday=0)
 |    |    |    +---------- month (1 - 12)
 |    |    +--------------- day of month (1 - 31)
 |    +-------------------- hour (0 - 23)
 +------------------------- min (0 - 59)

The following named entries can be used:

• Day of Week: sun, mon, tue, wed, thu, fri, sat.
• Month: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec.

A single space is required between each field. The values for each field can be composed of:

1. (Optional) You can delay the start time of a query by enabling the Delay execution.

Execute the Query

Save the query with a name and run, or just run the query. Upon successful completion of the query, the query result is automatically exported to the specified destination.

(Optional) You can delay the start time of a query by enabling the Delay execution.

Optionally Configure Export Results in Workflow

Within Treasure Workflow, you can specify the use of this integration to export data.

Learn more at Exporting Data with Parameters.

timezone: UTC

_export:
  td:
    database: sample_datasets

+td-result-into-target:
  td>: queries/sample.sql
  result_connection: facebook_conversions
  result_settings:
    test_event_code: 361738844830373
    skip_invalid: false