Skip to main content

Criteo

This connector captures data from Criteo's API.

It is available for use in the Flow web application. For local development or open-source workflows, ghcr.io/estuary/source-criteo:dev provides the latest version of the connector as a Docker image. You can also follow the link in your browser to see past image versions.

Supported data resources

The following data resources are supported through the Criteo APIs:

You may also configure multiple Report resources based on desired dimensions and metrics.

By default, each resource is mapped to a Flow collection through a separate binding.

Prerequisites

To set up a Criteo source connector in Flow, you will need:

  • A Criteo Client ID
  • A Criteo Client Secret
  • One or more Advertiser IDs

See Criteo's documentation for information on authentication and where to find your IDs.

Configuration

You configure connectors either in the Flow web app, or by directly editing the catalog specification file. See connectors to learn more about using connectors. The values and specification sample below provide configuration details specific to the Criteo source connector.

Properties

Endpoint

PropertyTitleDescriptionTypeRequired/Default
/client_idClient IDThe Criteo client ID used for authentication.stringRequired
/client_secretClient SecretThe Criteo client secret used for authentication.stringRequired
/advertiser_idsAdvertiser IDsOne or more Criteo advertiser IDs.string[]Required
/start_dateStart DateEarliest date to read data from. Uses UTC date-time format, ex. YYYY-MM-DDT00:00:00.000Z.stringRequired
/reportsReportsOptional configuration for additional report streams.object[]
/reports/-/nameReport NameThe report's name.string
/reports/-/dimensionsReport DimensionsAn array of dimensions. See Criteo's documentation for possible options.string
/reports/-/metricsReport MetricsAn array of metrics. See Criteo's documentation for possible options.string
/reports/-/currencyReport CurrencyThe report's currency.stringUSD

Bindings

PropertyTitleDescriptionTypeRequired/Default
/streamStreamCriteo resource from which collections are captured.stringRequired
/syncModeSync ModeConnection method.stringRequired

Sample


captures:
${PREFIX}/${CAPTURE_NAME}:
endpoint:
connector:
image: ghcr.io/estuary/source-criteo:dev
config:
client_id: {secret}
client_secret: {secret}
advertiser_ids:
- "12345"
- "67890"
start_date: 2025-01-01T00:00:00.000Z
bindings:
- resource:
stream: advertisers
syncMode: full_refresh
target: ${PREFIX}/advertisers
{...}