(Conversion API) Meta Conversions API

Follow
Avatar
Jonathan Chen
Updated
Conversion Postbacks for web, PC, and console events are only available to Singular customers with access to Singular’s Web, PC, and Console game attribution.

Singular’s integration with the Meta Conversions API allows advertisers to send Singular attributed Meta click conversions to Meta. This integration is supported for Singular web, PC, and console measurement. For Singular’s mobile measurement integration with Meta, see our help center article on the topic.

How to Configure the Meta Conversions API Integration

  1. Ensure you have an integrated web, PC, or console app with Singular
  2. Go to Singular > Attribution > Partner Configuration
  3. Click “Add a Partner”, and type and choose “Meta Conversions API”
  4. In the dialog, choose your App and App site (platform) to configure. Note that only web, PC, and console apps are supported with this integration
  5. Paste in your app's "Access Token" and "Dataset ID" from your Meta Event Manager dashboard.


  6. Optionally configure any additional events to send to Meta and map it to a "Meta Event Name"


  7. Click "Save" to finish.

FAQ

Where can you find the Meta Dataset ID?
  1. Navigate to the Meta Event Manager.
  2. Under "Data Sources", select your web/PC/Console data source

    If this is a new data source, create a new Data Source via "Connect Data Sources" and follow Meta's step-by-step guide to create a "Web" data source. Read more about Meta data sources here.
  3. Under "Settings", copy your "Dataset ID"
Where can you find the Access Token?
  1. Navigate to the Meta Event Manager.
  2. Under "Data Sources", select your web/PC/Console data source. 


    If this is a new data source, create a new Data Source via "Connect Data Sources" and follow Meta's step-by-step guide to create a "Web" data source. Read more about Meta data sources here.
  3. Under "Settings", scroll down to "Conversions API" and under "Set up direct integration" generate and then copy the access token.

What data does Singular send via API?
Parameter Details
event_name
  • A standard event or custom event name. This field is automatically mapped to the Singular Event Name. This value is used to assist META in the deduplication of events. The event_id parameter is also used in deduplication.
fbc
  • Facebook click ID
  • automatically passed
hashed email
  • Optional
  • Hashed email may be passed as a Singular instrumented event attribute "ehash"
  • Hashed email value must be normalized and SHA 256 hashed
hashed phone number
  • Optional
  • Hashed phone number may be passed as a Singular instrumented event attribute "phash"
  • Hashed phone number must be E164 normalized and SHA 256 hashed
hashed first name
  • Optional
  • Hashed first name may be passed as a Singular instrumented event attribute "fnamehash"
  • Using Roman alphabet a-z characters is recommended. Lowercase only with no punctuation. If using special characters, the text must be encoded in UTF-8 format.
  • Hashed first name be SHA 256 hashed
hashed last name
  • Optional
  • Hashed last name may be passed as a Singular instrumented event attribute "fnamehash"
  • Using Roman alphabet a-z characters is recommended. Lowercase only with no punctuation. If using special characters, the text must be encoded in UTF-8 format.
  • Hashed last name be SHA 256 hashed
IP address
  • The Client IP Address
user agent
  • (For web only)The user agent for the browser corresponding to the event
For Deduplication of Events (Optional)  
event_id
  • Required Parameter for Deduplication
  • Pass the event_id value to Singular in the Event Arguments using an attribute name: "eventId".

Meta Requirements:

  • The event_id parameter must by added to your events from both the Conversions API and the browser Pixel.
  • The event_id parameter is an identifier that can uniquely distinguish between similar events. Read more about the event_id parameter.
What are the limitations of Meta Conversions API?
  • Meta recommends that the Meta Conversion API be used to augment an existing Meta pixel implementation.
  • For mobile integrations, Meta and Singular recommend passing mobile conversion data through Singular's dedicated mobile attribution integration with Meta. If you are interested in passing mobile conversion data through Meta Conversions API, reach out to your Singular customer success manager.