Taboola Output Connector is designed for this functionality is essential for exporting audience data from Taboola’s advertising platform. Specifically, the connector should support the following capabilities:
- Create a First Party Audience using user identifiers such as DEVICE_ID and EMAIL_ID (User ID Object).
- Manage audience membership by allowing Add/Remove User operations to update the audience dynamically.
- Basic knowledge of Treasure Data, including the TD Toolbelt.
- Basic knowledge of Taboola.
- The schema of the connector is a flattened type.
- Batch Size: Recommended ≤ 100,000 users per request (for Add/Remove Users).
- Availability Delay:
- Audience creation: ~1 hour to be available.
- Audience scaling: 1–3 days for
audience_sizeto stabilize.
If your security policy requires IP whitelisting, you must add Treasure Data's IP addresses to your allowlist to ensure a successful connection.
Please find the complete list of static IP addresses, organized by region, at the following link:
https://api-docs.treasuredata.com/en/overview/ip-addresses-integrations-result-workers/
In order to claim your Client ID and Client Secret please contact your Account Manager or contact the support@taboola.com regarding the API credentials.
Your first step is to create a new authentication with a set of credentials.
Select Integrations Hub.
Select Catalog.
Search for your Taboola in the Catalog; hover your mouse over the icon and select Create Authentication.
Ensure that the Credentials tab is selected and then enter credential information for the integration.
New Authentication FieldsParameter Description Authentication Method The dropdown method is used to authenticate. We will support 1 type of authorization: - OAuth Client ID The Client ID of the Taboola Account. Client Secret The Client Secret of the Taboola Account. Select Continue.
Enter a name for your authentication, and then select Done.
The TD Console supports multiple ways to export data. Please follow these steps to export data from the Data Workbench.
- Navigate to Data Workbench > Queries.
- Select New Query.
- In the database drop-down, enter the database you want to query. This example uses test_db.
- In the query pane, enter your SQL query.
- Select Run to validate the results of the query.
Example query:
SELECT 'test@treasure-data.com' as email, '0000000-0000000-01234567-89ABCDEF' as device FROM your_tableThe schema should be defined as flattern type. Each row is a cluster as the meaning defined by Taboola.
Data specification
| Field Name | Type | Required | Description |
|---|---|---|---|
| email_N or email | String | No |
|
device_N or device | String | No |
|
- Select Export Results.
- To export the results to an external service, you can use an existing authentication or create a new one. Choose either
- Use Existing Integration
- Create New Integration
- Select the existing integration/Create New Integration.
- Enter the information in the form.
| Field | Description |
|---|---|
| Account ID | The account ID of the Taboola Application. |
| Audience Name | A unique name for the audience. If an existing audience_name is used, the server returns the existing audience instead of creating a new one. |
| TTL in Hours | Time-to-live in hours for how long users stay in the audience. Defaults to 8,760 (1 year) if omitted. |
| Operation | The operation to export data. There are 2 options: - Add - Remove |
| Skip on invalid records | Enable skipping the invalid records. |
| Upload Batch Size | Batch size for sending users each batch. From 1 to 100000. |
- Select Done to save the configuration.
SELECT 'test@treasure-data.com' as email,
'0000000-0000000-01234567-89ABCDEF' as deviceYou 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.
Navigate to Data Workbench > Queries
Create a new query or select an existing query.
Next to Schedule, select None.
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.
| Cron Value | Description |
|---|---|
0 * * * * | Run once an hour. |
0 0 * * * | Run once a day at midnight. |
0 0 1 * * | Run once a month at midnight on the morning of the first day of the month. |
| "" | Create a job that has no scheduled run time. |
* * * * *
- - - - -
| | | | |
| | | | +----- 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:
| Field Value | Example | Example Description |
|---|---|---|
| A single value, within the limits displayed above for each field. | ||
A wildcard '*' to indicate no restriction based on the field. | '0 0 1 * *' | Configures the schedule to run at midnight (00:00) on the first day of each month. |
A range '2-5', indicating the range of accepted values for the field. | '0 0 1-10 * *' | Configures the schedule to run at midnight (00:00) on the first 10 days of each month. |
A list of comma-separated values '2,3,4,5', indicating the list of accepted values for the field. | 0 0 1,11,21 * *' | Configures the schedule to run at midnight (00:00) every 1st, 11th, and 21st day of each month. |
A periodicity indicator '*/5' to express how often based on the field's valid range of values a schedule is allowed to run. | '30 */2 1 * *' | Configures the schedule to run on the 1st of every month, every 2 hours starting at 00:30. '0 0 */5 * *' configures the schedule to run at midnight (00:00) every 5 days starting on the 5th of each month. |
A comma-separated list of any of the above except the '*' wildcard is also supported '2,*/5,8-10'. | '0 0 5,*/10,25 * *' | Configures the schedule to run at midnight (00:00) every 5th, 10th, 20th, and 25th day of each month. |
- (Optional) You can delay the start time of a query by enabling the Delay execution.
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.
Scheduled jobs that continuously fail due to configuration errors may be disabled on the system side after several notifications.
(Optional) You can delay the start time of a query by enabling the Delay execution.
You can also send segment data to the target platform by creating an activation in the Audience Studio.
- Navigate to Audience Studio.
- Select a parent segment.
- Open the target segment, right-mouse click, and then select Create Activation.
- In the Details panel, enter an Activation name and configure the activation according to the previous section on Configuration Parameters.
- Customize the activation output in the Output Mapping panel.
- Attribute Columns
- Select Export All Columns to export all columns without making any changes.
- Select + Add Columns to add specific columns for the export. The Output Column Name pre-populates with the same Source column name. You can update the Output Column Name. Continue to select + Add Columnsto add new columns for your activation output.
- String Builder
- + Add string to create strings for export. Select from the following values:
- String: Choose any value; use text to create a custom value.
- Timestamp: The date and time of the export.
- Segment Id: The segment ID number.
- Segment Name: The segment name.
- Audience Id: The parent segment number.
- + Add string to create strings for export. Select from the following values:
- Set a Schedule.
- Select the values to define your schedule and optionally include email notifications.
- Select Create.
If you need to create an activation for a batch journey, review Creating a Batch Journey Activation.
Within Treasure Workflow, you can specify using this data connector to export data.
Learn more about using workflows to export datawith the TD Toolbelt.
You can also use the CLI provided by TD Toolbelt to export query results to LINE messaging.
Using the td query command, you would specify the LINE messaging server URL with the --result RESULT_URL option. See td query for more information.
The format of the option is JSON, and the general structure is as follows.
Parameters
| Name | Description | Value | Default Value | Required |
|---|---|---|---|---|
| type | Describe the name of the service as the destination of export. | taboola | Yes | |
| auth_method | The authentication method can specify either an OAuth. | We will support 1 type of authorization: - oauth | oauth | Yes |
| client_id | Taboo Account Client ID | String | Yes | |
| client_secret | Taboo Account Client Secret | String | Yes | |
| account_id | The Account ID of the Taboola Application. | String | Yes | |
| audience_name | A unique name for the audience. If an existing audience_name is used, the server returns the existing audience instead of creating a new one. | String | Yes | |
| ttl_in_hours | Time-to-live in hours for how long users stay in the audience. Defaults to 8,760 (1 year) if omitted. | Integer | 8760 | No |
| operation | The operation to export data. There are 2 options Add / Remove. | String We support 2 operations: - add - remove | add | No |
| skip_invalid_records | Enable skipping the invalid records. | Boolean | true | No |
| batch_size | Batch size for sending users each batch. | Integer. From 1 - 100000 | 100000 | No |
Authentication with OAuth
out: type: taboola auth_method: oauth client_id: xxxxxxxx client_secret: xxxxxxxx ...Add Users to Audience
out: type: taboola auth_method: oauth client_id: xxxxxx client_secret: xxxxxx account_id: acount_id audience_name: audience_name operation: add skip_invalid_records: true batch_size: 100000Remove Users from Audience
out: type: taboola auth_method: oauth client_id: xxxxxx client_secret: xxxxxx account_id: acount_id audience_name: audience_name operation: remove skip_invalid_records: true batch_size: 100000- The Result Export can be scheduled to periodically upload data to a target destination. See Scheduling Jobs Using TD Console.
- All import and export integrations can be added to a TD Workflow. The td>: data operator can export a query result to a specified integration. For more information, see Reference for Treasure Workflow Operators.