Skip to content
Last updated

Reddit Custom Audience Integration

The Reddit Custom Audience Output connector will enable users to integrate and export audience data from Treasure Data to Reddit Ads. This connector will facilitate the management of custom audiences and campaign targeting within the Reddit Ads platform.

Prerequisites

As Reddit’s API requirements, any data sent to Reddit Ads must be traceable and deletable upon Reddit’s request. Therefore, you must obtain explicit acknowledgment before enabling this connector. For enabling this connector on your account, contact your customer success manager or Treasure Data support.

  • Basic knowledge of Treasure Data.

  • Basic knowledge of Reddit Ads.

  • Able to retrieve the Reddit Ads Account ID

  • Query columns must be specified with the exact column names and data type.

  • The query columns must present at least one of the columns: email or maid

Static IP Address of Treasure Data Integration

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/

Use the TD Console to Create a Connection

You must create and configure the data connection in Treasure Data before running your query. As part of the data connection, you provide authentication to access the integration.

Create Authentication

Your first step is to create a new authentication with a set of credentials.

  1. Select Integrations Hub.
  2. Select Catalog.

  1. Search for your Integration in the Catalog; hover your mouse over the icon and select Create Authentication.

  1. Click on the Click here link to start OAuth authentication flow
  2. Select OAuth connection and click continue.
  3. Enter a name for your authentication, and select Done.

Define your Query

  1. Navigate to Data Workbench > Queries.
  2. Select New Query.
  3. Run the query to validate the result set.

Specify the Result Export Target

  1. Select Export Results.

  1. Input export parameters.

Parameter configuration

FieldDescription
Add Account IDThe Reddit Add Account ID. User can obtain it at the Audience Manager screen.
Custom Audience NameThe Reddit custom audience name. If the input name has already existed in the Reddit Ads. The connector will use this custom audience name, otherwise create a new audience name in the Reddit Ads. Notes: If the Reddit Ads have multiple custom audience names. The connector will use the first one.
Action TypeSupport 2 action type: - ADD: Add the custom audience users to this list. - REMOVE: Remove custom audience users from this list.
Skip on Invalid RecordIf enabled, the job will continue to run on invalid records; otherwise, it will stop.

Example Query

Query columns must be specified with the exact column names and data type. The query columns must present at least one of the columns: email or maid.

SELECT
 email,
 maid
FROM
 reddit_custom_audiences

Column name and data type

Column NameData TypeValidate?Hashed (SHA-256)?
emailStringYes. Validate the email format for un-hashed value (raw)If the value is already SHA-256 hashed, keep it as is, otherwise hashed it with SHA-256.
maidStringNoIf the value is already SHA-256 hashed, keep it as is, otherwise hashed it with SHA-256.

(Optional) Export Integration Using the CLI

You can also use CLI(Toolbelt) to export results to Reddit Custom Audience.

The format of the option is JSON and the general structure is as follows.

type: reddit_custom_audiencetd_authentication_id: 12345ad_account_id: a2_abcdefcustom_audience_name: audience nameaction_type: ADDskip_invalid_record: true

Parameters

NameDescriptionValueDefault ValueRequired
typeDescribe the name of the service as the destination of export.reddit_custom_audienceN/AYes
td_authentication_idAuthentication id that created in the console.Yes
ad_account_idReddit Ads's Add Account IDN/AN/AYes
custom_audience_nameCustom audience name. If it does not exist, connector will request Reddit Ads to create it.Yes
action_typeThe mode of upload custom audience users.Supported values:- ADD - REMOVEADDYes
skip_invalid_recordThe flag to continue or stop the job when handling the invalid record.true/falsetrueNo

Example for Usage

$ td query --result '{"type":"reddit_custom_audience","td_authentication_id": 1234,"ad_account_id":"a2_abcdef","custom_audience_name":"test","action_type":"ADD","skip_invalid_record":false}' \
-d sample_datasets "select email, maid from www_access" -T presto

(Optional) Schedule Query Export Jobs

You 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.

Scheduling your Job Using TD Console

  1. Navigate to Data Workbench > Queries

  2. Create a new query or select an existing query.

  3. Next to Schedule, select None.

  4. In the drop-down, select one of the following schedule options:

    Drop-down ValueDescription
    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.
    NoneNo schedule.

Custom cron... Details

Cron ValueDescription
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 ValueExampleExample 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.
  1. (Optional) You can delay the start time of a query by enabling the Delay execution.

Execute the Query

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.

Activate a Segment in Audience Studio

You can also send segment data to the target platform by creating an activation in the Audience Studio.

  1. Navigate to Audience Studio.
  2. Select a parent segment.
  3. Open the target segment, right-mouse click, and then select Create Activation.
  4. In the Details panel, enter an Activation name and configure the activation according to the previous section on Configuration Parameters.
  5. 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.
  1. Set a Schedule.

  • Select the values to define your schedule and optionally include email notifications.
  1. Select Create.

If you need to create an activation for a batch journey, review Creating a Batch Journey Activation.

Retrieving Required Parameter Values from Reddit Ads

You may need to get the Add Account ID from Reddit Ads. Following below step to fetch it.

  1. Login to Reddit Ads
  2. Go to Audience Manager
  3. Scroll down to find Data Import Using Cohort Import.
  4. Copy the value that start with a2_xyz