Amazon Ads Export Integration

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

Amazon Ads is an advertising service that enables users to promote their products and services on Amazon's platforms.

The Amazon Ads Export integration supports TD users as they manage their audience and audience records on Amazon Ads platforms like Amazon Marketing Cloud (AMC) and Amazon Demand-Side Platform (DSP).

Prerequisites

• Basic Knowledge of Treasure Data
• Basic knowledge of the Amazon Ad platforms AMC and DSP

Requirements and Limitations

• The Audience ID used in the Amazon Ads API is not the Audience ID displayed under DSP Advertiser account. The Audience ID that you need for the API is displayed when a new audience is created, and it should stored in a secure location.

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

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

Create a New Authentication

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

1. Select Integrations Hub.
2. Select Catalog.

3. Search for your Amazon Ads in the Catalog; hover your mouse over the icon and select Create Authentication.

The New Authentication modal displays. 4. Below the OAuth connection field, select the Click here link. 5. Log in to your Amazon account to approve OAuth access. 6. On the New Authentication modal, provide this information and select Continue. 7. Enter a name for the authentication, and select Done.

Getting the Authentication ID

If you want to use this authentication with TD APIs or with the TD Toolbelt, you will need to get it's Authentication ID. To get the Authentication ID:

1. Navigate to Integrations Hub > Authentications.
2. Select the integration you want to use. The Edit Authentication modal displays.
3. In the browser address bar, at the end of the URL, note the Authentication ID. In this example the ID is 2881.

Define your Query

1. Navigate to Data Workbench > Queries.
   
2. Select New Query.
3. From the table drop-down menu, select the database you want to query.
4. Enter your query.

Here is a sample query:

SELECT   
  usr_firstname  AS firstname,   
  usr_address    AS address,   
  usr_phone      AS phone,   
  usr_city       AS city,   
  usr_state      AS state,   
  usr_postalcode AS postal,   
  usr_email      AS email,          -- required   
  usr_lastname   AS lastname,   
  usr_country    AS countrycode,   
  ext_id         AS externaluserid  -- required   
FROM   
  mytable

Here are the required fields for the query:

Specify the Result Export Target

There are two ways to export data to Amazon Ads:

• Create a new audience
• Update existing audience

Create a New Audience and Export Hashed Records.

This is an example of how to create an audience on AMC and DSP and then add users to that audience.

1. Using the TD Console, perform steps 1-4 from the "Define your Query" section above.
2. Select Export Results.
3. Select the integration you created for Amazon Ads.

The Export Results modal displays.

4. In the Action field, ensure that Create is selected. 5. Enter your information into the remaining fields.

6. Select Done.

Example Result

************* REPORT *************2024-05-29 04:40:12.080 +0000 [INFO] (0035:task-0000): Total records: 382024-05-29 04:40:12.080 +0000 [INFO] (0035:task-0000): Total batches: 12024-05-29 04:40:12.080 +0000 [INFO] (0035:task-0000): Total skipped records: 02024-05-29 04:40:12.080 +0000 [INFO] (0035:task-0000): ************* UPLOAD STATUS 
*************2024-05-29 04:40:12.080 +0000 [INFO] (0035:task-0000): Total completed batches: 1/12024-05-29 04:40:12.080 +0000 [INFO] (0035:task-0000): Total uploaded records but invalid: 02024-05-29 04:40:12.080 +0000 [INFO] (0035:task-0000): ************* AUDIENCE INFO *************
2024-05-29 04:40:12.080 +0000 [INFO] (0035:task-0000): Audience ID: 361054992504331xxx2024-05-29 04:40:12.081 +0000 [INFO] (0001:transaction): {done:  1 / 1, running: 0}2024-05-29 04:40:12.082 +0000 [INFO] (0001:transaction): Incremental job, setting last_path to [job_2167618832_result]2024-05-29 04:40:12.280 +0000 [INFO] (pool-10-thread-1): Saving all buffers2024-05-29 04:40:12.280 +0000 [INFO] (pool-10-thread-1): Closing buffers2024-05-29 04:40:14.281 +0000 [INFO] (main): Stopped sending metrics

Tip: If the audience has been created under "AMC and DSP" and the wish is continuously upload new records to that audience. You can schedule the job in this use case to run repeatedly. No need any modifications. Otherwise, follow next use case. |

Update an Existing Audience

This is an example of how to update an audience on AMC and DSP.

1. Using the TD Console, perform steps 1-4 from the "Define your Query" section above.
2. Select Export Results.
3. Select the integration you created for Amazon Ads.

The Export Results modal displays.

4. In the Action field, ensure that Updateis selected. 5. Enter your information into the remaining fields.

6. Select Done.

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.

6. Set a Schedule.

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

7. Select Create.

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

Custom cron... Details

 *    *    *    *    *
 -    -    -    -    -
 |    |    |    |    |
 |    |    |    |    +----- 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:

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.

(Optional) You can delay the start time of a query by enabling the Delay execution.

(Optional) Configure Export Results in Workflow

Within Treasure Workflow, you can specify the use of this integration to export data.

_export:
  td:
    database: td.database
   
+amazon_ads_export_task:
  td>: export_amazon_ads.sql
  database: ${td.database}
  result_connection: new_amazon_ads_auth
  result_settings:
    type: amazon_ads
    td_authentication_id: td_authentication_id
    amc_instance_id: amc_instance_id
    amc_account_id: amc_account_id
    dsp_region: NA
    action: CREATE
    upload_mode: APPEND
    target: AMC_AND_DSP
    dsp_advertiser_id: dsp_advertiser_id
    external_audience_id: external_audience_id
    audience_name: audience_name
    time_to_live: 34300800
    country_code: US
    wait_until_finish: true
    max_wait_time: 5

(Optional) Export Integration Using the CLI

You can also use the TD Toolbelt to export results to Amazon Ads using the  td query command with the --result option. For additional information see TD Query.

The data specified in with the --result option is in JSON format, and the general structure is as follows.

{
  "type": "amazon_ads",
  "td_authentication_id": ${authentication_id_from_td_console},
  "amc_instance_id": "amc_instance_id",
  "amc_account_id": "amc_account_id",
  "region": "NA",
  "action": "CREATE",
  "upload_mode": "APPEND",
  "target": "AMC_AND_DSP",
  "dsp_advertiser_id": "dsp_advertiser_id",
  "external_audience_id": "external_audience_id",
  "audience_name": "audience_name",
  "time_to_live": 34300800,
  "country_code": "US",
  "wait_until_finish": false,
  "max_wait_time": 1
}

Parameters

Usage Examples

This example executes a single manual export.

td query \
--database ${database_name} \
--wait "SELECT * FROM ${table_name}" \
--type presto \
--result '{"type":"amazon_ads","td_authentication_id":"${authentication_id_from_td_console}","amc_instance_id":"amc_instance_id","amc_account_id":"amc_account_id","region":"NA","action":"CREATE","upload_mode":"APPEND","target":"AMC_AND_DSP","dsp_advertiser_id":"dsp_advertiser_id","external_audience_id":"external_audience_id","audience_name":"audience_name","time_to_live":34300800,"country_code":"US","wait_until_finish":false,"max_wait_time":1}'

This example executes at a scheduled time.

td sched:create \
result_to_amazon_ads '0 0 * * *' \
--database ${database_name} 'SELECT * FROM ${table_name}' \
--result '{"type":"amazon_ads","td_authentication_id":"${authentication_id_from_td_console}","amc_instance_id":"amc_instance_id","amc_account_id":"amc_account_id","region":"NA","action":"CREATE","upload_mode":"APPEND","target":"AMC_AND_DSP","dsp_advertiser_id":"dsp_advertiser_id","external_audience_id":"external_audience_id","audience_name":"audience_name","time_to_live":34300800,"country_code":"US","wait_until_finish":false,"max_wait_time":1}'

External References

See Amazon Advertiser Audience APIs for additional information.