# Pinterest Export Integration

Pinterest is a visual discovery engine for finding ideas, such as recipes, home and style inspiration, and more. It provides features for data organization and configuration of access controls for your audience and customer list.

This TD export integration lets you write job results directly from Treasure Data to Pinterest.

## What can you do with this Integration?

- Add or remove users from an audience.
- Auto-create a new audience if the audience does not exist.
- Clear all users from an audience.
- Auto-detect and hash the user id (email, idfa, or maid) if the value is not hashed.
- Specify an option to skip or stop invalid values.


## Prerequisites

- Basic knowledge of Treasure Data, including the [TD Toolbelt](https://toolbelt.treasuredata.com/).


## Requirements and Limitations

- The default export format is SHA256; all data should be hashed or unhashed using SHA256 format.
- The query from TD should select only one column with the name: email, maid, or idfa in String format.
  - For email, it could be hash or unhashed.
  - For maid and idfa, they should be hashed before.
- It takes up to 24-48 hours to update the Audience and Audience size


## Use the TD Console to Create Your Connection

### Create a New Authentication

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.

1. Open TD Console.
2. Navigate to **Integrations Hub** > **Catalog**.
3. Search for Pinterest and select **Output**.


![](/assets/pinterest-export-integration-2024-03-19.53b79d03fbdbe27b0f5a0782394e008297b4d6ff47945fc72d87d03e6ac846e0.ef204196.png)

1. Select Create Authentication.
2. Connect to your Pinterest account.
3. You are redirected back to the Integrations Hub > Catalog. Repeat the step to connect to a new account to choose your new OAuth connection.
4. Type a name for your connection.
5. Select **Done**.


### Define your Query

1. Navigate to **Data Workbench > Queries**.
2. Select a query for which you would like to export data and run the query to validate the result set.
3. Select**Export Results**.


![](/assets/screen_shot_2023-05-18_at_11_04_47.eb70dde814e6c273bc452cb6de18ac0b9c415d0b47e02560c7984f7dd0f5037f.ef204196.png)

1. Select an existing integration authentication.


![](/assets/screen-shot-2023-05-18-at-11.06.58.f2d2b14b5880668c515c935be900ef3acb7dfde9cab09e768d6abb6f343bb324.ef204196.png)
5. Define any additional Export Results details. In your export integration content, review the integration parameters.

For example, your Export Results screen might be different, or you might not have additional details to complete.

![](/assets/screen-shot-2023-05-19-at-08.50.39.1040ee4a78a7d7084945628372b647152f471c370a6110b2b2420a2b2e3d89ce.ef204196.png)
6. Select **Done.**
7. Run your query
8. Validate that your data moved to the destination you specified.

### Integration Parameters for Pinterest

![](/assets/screen-shot-2023-05-19-at-08.50.47.9ed92919b7a56afbd0c490c64153043694e10bf0a7f6590d73f4be63c9f35a57.ef204196.png)

![](/assets/screen-shot-2023-05-18-at-11.20.01.e01e9a5fc7cf0a419d76411d664fb14ac62a912375d5e611564b086d49d3f75b.ef204196.png)

| Parameter  | Data Type  | Required?  | Description  |
|  --- | --- | --- | --- |
| Ad Account ID | String | Yes | Pinterest Ad account id |
| Audience Type | String | Yes | Audience type. Support values:- Customer List

 |
| Action | String | Yes | Audience action. Support values:- Create New Audience (default, and should not be scheduled to run recurrently)
- Replace Current Audience
- Delete Current Audience
- Add People To Current Audience
- Remove People From Current Audience

 |
| Audience ID | String |  | Audience ID. Required only if the action is:- Replace Current Audience
- Delete Current Audience
- Add People To Current Audience
- Remove People From Current Audience

 |
| Audience Name | String |  | Audience Name. Required only if the action is:- Create New Audience

 |
| Audience Description | String |  | Audience Description |
| Limit Records Per Request
 | Integer
 |  | The number of records sent in each batch
Default value: `10000`
 |
| Ignore Invalid Records | Boolean |  | If this check box is selected when the time data is sent to Pinterest, incorrect records or errors are skipped, and the remaining rows of data continue sending. If this checkbox is not selected, an exception is thrown when inaccurate records or errors are encountered. |
| Max Retries | Integer |  | Maximum retry times for each API request |
| Initial retry time wait in millis | Integer |  | Wait time for the first retry (in milliseconds) |
| Max retry wait in millis | Integer |  | Maximum wait time for an API call before it gives up |
| HTTP Connect Timeout in seconds | Integer |  | The amount of time before the connection times out when making API calls |
| HTTP Read Timeout | Integer |  | The amount of time waiting to read data into the request |
| HTTP Write Timeout | Integer |  | The amount of time waiting to write data into the request |


If the integration is configured in Create mode and scheduled to run recurrently, the second execution will fail because the target Audience already exists. To avoid this, after the first successful execution, change the setting to Update mode.

### (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.
![](/assets/image2021-1-15_17-28-51.f1b242f6ecc7666a0097fdf37edd1682786ec11ef80eff68c66f091bc405c371.0f87d8d4.png)
4. In the drop-down, select one of the following schedule options:
![](/assets/image2021-1-15_17-29-47.45289a1c99256f125f4d887e501e204ed61f02223fde0927af5f425a89ace0c0.0f87d8d4.png)
| Drop-down Value | Description |
|  --- | --- |
| Custom cron... | Review [Custom cron... details](#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

![](/assets/image2021-1-15_17-30-23.0f94a8aa5f75ea03e3fec0c25b0640cd59ee48d1804a83701e5f2372deae466c.0f87d8d4.png)

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


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.


![](/assets/ouput.b2c7f1d909c4f98ed10f5300df858a4b19f71a3b0834df952f5fb24018a5ea78.8ebdf569.png)

- 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 Columns**to 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**.


![](/assets/snippet-output-connector-on-audience-studio-2024-08-28.a99525173709da1eb537f839019fa7876ffae95045154c8f2941b030022f792c.8ebdf569.png)

- 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](/products/customer-data-platform/journey-orchestration/batch/creating-a-batch-journey-activation).

## (Optional) Configure Export Results in Workflow

You can specify using this data connector to export data within Treasure Workflow.

Learn more at [Exporting Data with Parameters](https://docs.treasuredata.com/display/PD/https://docs.treasuredata.com/display/public/PD/Exporting+Data+with+Parameters).

### Pinterest Configuration Keys

| Name  | Type  | Required  | Description  |
|  --- | --- | --- | --- |
| `type` | String | Yes | `pinterest` |
| `client_id` | String | Yes |  |
| `client_secret` | String | Yes |  |
| `refresh_token` | String | Yes |  |
| `ad_account_id` | String | Yes |  |
| `audience_type` | String | Yes | `customer_list` |
| `action` | String | Yes | Value could be:- `create_new_audience`
- `replace_current_audience`
- `delete_current_audience`
- `add_people_to_current_audience`
- `remove_people_to_current_audience`

 |
| `audience_id_replace` | String |  | Required if `action` is `replace_current_audience` |
| `audience_id_delete` | String |  | Required if `action` is `delete_current_audience` |
| `audience_id_add_people` | String |  | Required if `action` is `add_people_to_current_audience` |
| `audience_id_remove_people` | String |  | Required if `action` is `remove_people_to_current_audience` |
| `audience_name` | String |  | Required if `action` is `create_new_audience` |
| `audience_description` | String |  |  |
| `limit_records_per_request` | int |  |  |
| `ignore_error` | boolean |  |  |
| `retry_count` | int |  |  |
| `retry_initial_wait_millis` | int |  |  |
| `max_retry_wait_millis` | int |  |  |
| `connection_timeout_secs` | int |  |  |
| `write_timeout_secs` | int |  |  |
| `read_timeout_secs` | int |  |  |


### Example Workflow


```yaml
_export:
  td:
  database: td.database

+test_export_task:
  td>: export_pinterest_test.sql
  database: ${td.database}
  result_connection: pinterest_conn
  result_settings:    
	type: pinterest
  	client_id: xxx
  	client_secret: xxx
  	refresh_token: xxx
  	ad_account_id: xxx
  	audience_type: customer_list
  	action: ADD_PEOPLE_TO_CURRENT_AUDIENCE
  	audience_id_add_people: xxx
  	audience_name: xxx
  	audience_description: xxx
  	limit_records_per_request: 10000
  	ignore_invalid_records: true
    retry_count: 7
    retry_initial_wait_millis: 500
	  max_retry_wait_millis: 300000
	  connection_timeout_secs: 180
	  write_timeout_secs: 60
	  read_timeout_secs: 180
```