The tap-criteo extractor pulls data from Criteo that can then be sent to a destination using a loader.
Alternate Implementations
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-criteo extractor to your
project using
:meltano add
-
Configure the tap-criteo
settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-criteo
meltano config tap-criteo set --interactive
meltano config tap-criteo test
Next steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-criteo
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this extractor. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this extractor.
This plugin has the following capabilities:
- about
- catalog
- discover
- schema-flattening
- state
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml
by adding the capabilities
key.
Settings
The
tap-criteo
settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
Expand To Show SDK Settings
You can also list these settings using
with the meltano config
list
subcommand:
meltano config tap-criteo list
You can
override these settings or specify additional ones
in your meltano.yml
by adding the settings
key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
Advertiser IDs (advertiser_ids)
-
Environment variable:
TAP_CRITEO_ADVERTISER_IDS
An array of advertiser IDs to extract data for.
Configure this setting directly using the following Meltano command:
meltano config tap-criteo set advertiser_ids [value]
Client ID (client_id)
-
Environment variable:
TAP_CRITEO_CLIENT_ID
Your Criteo client ID.
Configure this setting directly using the following Meltano command:
meltano config tap-criteo set client_id [value]
Client Secret (client_secret)
-
Environment variable:
TAP_CRITEO_CLIENT_SECRET
Your Criteo client secret.
Configure this setting directly using the following Meltano command:
meltano config tap-criteo set client_secret [value]
Reports (reports)
-
Environment variable:
TAP_CRITEO_REPORTS
An array of objects defining the stats reports to sync, each object should include:
name
- The report name.dimensions
- An array of dimensions.metrics
-An array of metrics.currency
- Default USD. Optional.
reports:
- name: daily_clicks
dimensions:
- CampaignId
- AdsetId
- AdvertiserId
- Day
metrics:
- Clicks
Configure this setting directly using the following Meltano command:
meltano config tap-criteo set reports [value]
Start Date (start_date)
-
Environment variable:
TAP_CRITEO_START_DATE
Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.
Configure this setting directly using the following Meltano command:
meltano config tap-criteo set start_date [value]
Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_CRITEO_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-criteo set flattening_enabled [value]
Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_CRITEO_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-criteo set flattening_max_depth [value]
Stream Map Config (stream_map_config)
-
Environment variable:
TAP_CRITEO_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config tap-criteo set stream_map_config [value]
Stream Maps (stream_maps)
-
Environment variable:
TAP_CRITEO_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config tap-criteo set stream_maps [value]
Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general
channel.