Send data to Criteo Audience API

Criteo is a commerce media platform that helps marketers and media owners manage and scale campaigns. Send audiences to Criteo, and then advertise to customers across paid media, including connected TV (CTV), banner ads, and video ads.

Note

This destination uses the Criteo API.

Your brand can send custom audiences and offline events to Criteo Audience API:

Custom audiences

Custom audiences

Use Custom audiences to help find who can be activated using Criteo Audience API.

Custom audiences

Transactions data

Use transactions data to help your brand track offline conversions from your marketing campaigns.

This topic describes the steps that are required to send audience lists to Criteo Audience API from Amperity:

  1. Get details

  2. Authorize Amperity access to the customer’s account

  3. Add destination

  4. Add data template

Get details

Criteo Audience API requires the following configuration details:

Detail one.

The advertiser ID.

Detail one.

Authorize Amperity to send data to the customer’s Criteo account.

Send transactions data

You can send transactions data (offline events) to Criteo Audience API as a CSV or TSV file using SFTP.

Review the requirements for using SFTP to send transactions data to Criteo, and then configure Amperity to connect to Criteo Audience API using the SFTP destination.

After the SFTP destination is configured, use a query to map a customer’s email address and transactions data to the fields that can be sent to Criteo Audience API. For example:

SELECT
  uit.amperity_id AS user_crmid
  ,mc.email AS user_email
  ,uit.order_id AS event_id
  ,uit.item_quantity AS event_item_quantity
  ,uit.product_id AS event_item_id
  ,uit.currency AS event_currency
  ,uit.item_revenue AS event_item_price
  ,uit.order_datetime AS event_timestamp
  ,uit.store_id AS store_id
  --,uit.purchase_brand AS event_item_brand --optional
  --,uit.product_category AS event_item_category --optional
FROM Merged_Customers mc
INNER JOIN Unified_Itemized_Transactions uit
ON mc.amperity_id = uit.amperity_id
WHERE mc.email IS NOT NULL
AND uit.is_return = false
AND uit.is_cancellation = false

Use an orchestration to send transactions to Criteo Audience API using the SFTP destination.

Configure OAuth

OAuth is an open standard for access delegation, commonly used to grant websites or applications access to information on other websites.

Use OAuth to configure Amperity to send audience lists to Criteo Audience API.

Important

When configuring OAuth for Criteo Audience API you must select the portfolios to which access will be granted.

Criteo will only create the credential if the account you are using has not already granted Amperity access. If you need to create a new credential, revoke access for Amperity, and then reconfigure OAuth using the newly-generated link.

To configure OAuth

Step 1.

Open the Destinations tab and click Add Destination. The Add Destination dialog box opens.

Select Criteo Audience API from the Plugin drop-down, and then from the Credential drop-down, select Create a new credential.

This opens the Create New Credential dialog box.

Step 2.

In the Create New Credential dialog box, click “Generate authorization URL”.

Copy the URL, and then provide the URL to a user who has credentials that allow access to Criteo Audience API. The user must log in and complete the steps required by the OAuth process for Criteo Audience API.

After this is completed, you will be redirected to the Credentials page in Amperity.

Verify the credential is on the page, and then return to the Destinations tab.

Step 3.

Open the Destinations tab and click Add Destination. The Add Destination dialog box opens.

Select Criteo Audience API from the Plugin drop-down, and then from the Credential drop-down, select the credential that is authorized to access Criteo Audience API.

Note

The value for the Refresh Token setting is updated automatically after you select the credential.

Reauthorize Amperity

You may need to reauthorize access to Criteo Audience API. This is necessary when an authorization token has expired or when it has been removed by someone with permission to manage access within Criteo Audience API. To reauthorize access to Criteo Audience API, follow the steps to configure OAuth and create a new credential.

Tip

You may need to revoke access for Amperity, and then re-authorize access.

Add destination

Configure Amperity to send audience lists directly to Criteo Audience API.

Warning

Amperity must be authorized to send data to your Criteo Audience API account prior to configuring the destination.

To add a destination

Step 1.

Open the Destinations tab to configure a destination for Criteo Audience API. Click the Add Destination button to open the Destination dialog box.

Name, description, choose plugin.

Enter a name for the destination and provide a description. For example: “Criteo Audience API” and “This sends audience lists to Criteo Audience API”.

From the Plugin drop-down, start typing “cri” to filter the list, and then select Criteo Audience API.

Step 2.

Credentials allow Amperity to connect to Criteo Audience API.

The credential type is set automatically. You may use an existing credential or you may add a new one.

Choose an existing credential or add credential.

Select an existing credential from the Credential drop-down.

– or –

Select Create a new credential from the Credential drop-down. This opens the Credential dialog box.

Choose an existing credential or add credential.

Enter the name for the credential, and then add a description.

Steps to configure OAuth

  1. Generate an authorization link, and then visit the URL that was generated to complete the authorization process.

  2. Log in to Criteo Audience API at the generated URL using credentials that allow access to your instance of Criteo Audience API.

    Note

    Send the URL to an individual who can provide these credentials, and then ask them to log into Criteo Audience API on your behalf.

  3. When complete, you will be redirected to the Credentials page in Amperity.

  4. Verify the credential is on the page, and then return to the Destinations tab. From the Plugin drop-down, select the Criteo Audience API, and then use the credential that was just created.

Step 3.

Each destination has settings that define how Amperity will deliver data to Criteo Audience API. These settings are listed under the Settings section of the Destination dialog box.

Settings for Criteo Audience API.

The following settings are specific to Criteo Audience API:

Setting

Description

Advertiser ID

The unique ID for the advertiser account in Criteo Audience API to which Amperity will send audiences.

Step 4.

Business users are assigned to the Amp360 User and/or AmpIQ User policies. (Amp360 User allows access to queries and orchestrations and AmpIQ User allows access to segments and campaigns.) A business user cannot select a destination that is not visible to them.

Business users – including users assigned to the DataGrid Operator policy – may have restricted access to PII.

What is restricted access to PII?

Restricted PII access is enabled when the Restrict PII access policy option that prevents users who are assigned to that option from viewing data that is marked as PII anywhere in Amperity and from sending that data to any downstream workflow.

You can make this destination visible to orchestrations and allow users with restricted access to PII to use this destination by enabling one (or both) of the following options:

Allow business users access to this destination.

Note

To allow business users to use this destination with campaigns, you must enable the Available to campaigns option within the data template. This allows users to send campaign results from Amperity to Criteo Audience API.

The other two settings may be configured within the data template instead of the destination.

Step 5.

Review all settings, and then click Save.

Save the destination.

Important

You must configure a data template for this destination before you can send data to Criteo Audience API.

Add data template

A data template defines how columns in Amperity data structures are sent to downstream workflows. A data template is part of the configuration for sending query and segment results from Amperity to an external location.

About paid media campaigns

Amperity provides the right set of data to support your brand’s paid media advertising with Criteo Audience API.

  1. Merged Customers vs. Unified Paid Media

    The Merged Customers table contains each of your customers’ best profiles.

    The Unified Paid Media table contains all your customer’s known profile data.

    Your brand will require additional data templates to use the Unified Paid Media table alongside the Merged Customers table to support paid media campaigns.

  2. Enable dedicated data templates for each table.

    Use a consistent naming pattern to label data templates that use data from the Merged Customers table. For example: “Best profile”.

    Use a consistent naming pattern to label data templates that use data from the Unified Paid Media table. For example: “Full profile”.

  3. After data templates are configured for both tables, use the default attributes component on the Campaigns page to configure which attributes will be associated with the destination, including the table from which those attributes will be pulled.

    The selected table will affect your brand’s downstream match rates and overall customer matches within your paid media campaigns. The decision behind which table to use depends on your brand’s downstream use case and the type and amount of customer profile data your brand wants to use to match customers.

    You brand should expect to see higher match rates when sending audiences from the Merged Customers table, but a higher number of matched customer profiles when sending audiences from the Unified Paid Media table. Use A/B testing to compare the results from each table, after which your brand can use the audience that works best for your campaigns.

To add a data template

Step 1.

From the Destinations tab, open the menu for a destination that is configured for Criteo Audience API, and then select Add data template.

This opens the Add Data Template dialog box.

Step 1

Enter the name of the data template and a description. For example: “Criteo Audience API” and “Send audience lists to Criteo Audience API.”.

Step 2.

Verify business user access to queries and orchestrations and access to segments and campaigns.

A business user may also have restricted access to PII, which prevents them from viewing and sending customer profile data.

Step 2.

If business user access was not configured as part of the destination, you may configure access from the data template.

Important

To allow business users to use this destination with campaigns, you must enable the Available to campaigns option. This allows users to send campaign results from Amperity to Criteo Audience API.

If you enable this option, the data extension settings require using campaign name and group name template variables to associate the name of the data extension to your campaign.

Step 3.

Verify all configuration settings.

Verify settings for the data template.

Note

When the advertiser ID setting was are not configured as part of the destination, you must configure it as part of the data template before making this destination available to campaigns.

Step 4.

Review all settings, and then click Save.

Save the data template.

After you have saved the data template, and depending on how you configured it, business users can send query results and/or send campaigns to Criteo Audience API.