Pinterest Ads is Pinterest’s advertising platform that enables businesses to promote their Pins to people who are searching for and saving ideas on Pinterest. It allows advertisers to organize their advertising into ad accounts, campaigns, and ad groups, promote Pins as ads, and measure ad performance through reporting.
Hevo uses the Pinterest REST API to replicate data from your Pinterest Ads account to the Destination of your choice. To ingest data, you must authorize Hevo to access your Pinterest Ads account using Open Authorization (OAuth) 2.0.
Supported Features
| Feature Name | Supported |
|---|---|
| Capture deletes | No |
| History mode | No |
| Custom data (user-configured tables & fields) | No |
| Data blocking (skip objects and fields) | Yes |
| Resync (objects and Pipelines) | Yes |
| API configurable | No |
Prerequisites
-
An active Pinterest Ads account from which data is to be ingested.
-
You have Admin access on the Pinterest ad account(s) you want to sync.
Configure Pinterest Ads as a Source in your Pipeline
Perform the following steps to configure your Pinterest Ads Source:
-
Click Pipelines in the Navigation Bar.
-
Click + Create Pipeline in the Pipelines List View.
-
On the Select Source Type page, select Pinterest Ads.
-
On the Select Destination Type page, select the type of Destination you want to use.
-
On the Select Pipeline Type page, click Edge, and then click Continue.
This page appears only if the selected Destination type is supported in Edge and your Team has an existing Pinterest Ads Pipeline with the same Destination type. Otherwise, you can proceed to create an Edge Pipeline.
-
In the Configure Source screen, specify the following:
-
Source Name: A unique name for your Source, not exceeding 255 characters. For example, Pinterest Ads Source.
-
In the Connect to your Pinterest Ads account section, click Authenticate Your Pinterest Ads Account, log in to your Pinterest account, and grant Hevo the requested permissions.
-
In the Sync Settings section, specify the following:
-
Ad account selection: From the drop-down, select whether you want Hevo to sync all ad accounts or only specific ones:
-
Sync all ad accounts: Syncs data for all ad accounts that Hevo has access to.
-
Sync specific ad accounts: Syncs data only for specific ad accounts you select. If you select this option, in the Ad accounts to sync section, select the specific Pinterest ad accounts whose data you want to sync.
-
-
-
In the Report settings section, specify the following:
-
Click Attribution Window: The number of days between a person clicking your ad and taking an action. Default value: 30 days.
-
View Attribution Window: The number of days between a person viewing your ad and taking an action. This value cannot exceed the click attribution window. A value of 0 days is allowed only when the click attribution window is set to 1 or 7 days. Default value: 1 day.
-
Conversion Report Time: The date to report a conversion based on when the person interacted with the ad or completed the conversion. Default value: Ad event.
-
Report Granularity: The frequency of report data. Hourly reports include data only for the last 8 days and do not include conversion metrics. Default value: Daily.
-
Historical Sync Duration: The duration for which you want to ingest existing data from the Source. Default value: 3 months.
-
-
-
Click Test & Continue to test the connection to your Pinterest Ads Source. Once the test is successful, you can proceed to set up your Destination.
Data Replication
Hevo replicates data for all the objects selected on the Configure Objects page during Pipeline creation. By default, all supported objects and their available fields are selected. However, you can modify this selection while creating or editing the Pipeline.
Hevo ingests the following types of data from your Source objects:
-
Historical Data: The first run of the Pipeline ingests historical data for the selected objects, based on the Historical Sync Duration specified when configuring the Source, and loads it into the Destination.
-
Incremental Data: Once the historical load is complete, new and updated records for objects are ingested as per the sync frequency.
For the following objects, Hevo ingests only the incremental data in subsequent Pipeline runs:
-
Advertiser Report
-
Ad Group Report
-
Campaign Report
-
Pin Promotion Report
For the report objects, Hevo also re-fetches the data every 24 hours. This captures any updates made to previously ingested data and keeps your Destination up to date.
For all other objects, Hevo ingests the entire data during each Pipeline run.
Pinterest enforces a rate limit on the number of requests that can be made to its API in a given period of time. If this limit is exceeded, a rate limit exception occurs. To understand how Hevo handles such scenarios, read Handling Rate Limit Exceptions.
Note: You can create a Pipeline with this Source only using the Merge load mode. The Append mode is not supported for this Source.
Schema and Primary Keys
Hevo uses the following schema to upload the records to the Destination. For a detailed view of the objects, fields, and relationships, click the ERD.
Data Model
The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:
| Object | Description |
|---|---|
| Advertiser History | Contains a record of changes made over time to each Pinterest ad account, which is used to create, manage, and pay for ads. Includes details such as the account’s name, country, currency, owner, and the permissions granted on it. |
| Advertiser Report | Contains daily or hourly performance metrics for each ad account, such as impressions, clicks, engagements, and spend, combined across all the ads it runs. |
| Ad Group History | Contains a record of changes made over time to each set of ads within a campaign that share the same budget, targeting, bidding, placement, and schedule settings. |
| Ad Group Report | Contains daily or hourly performance metrics, such as impressions, clicks, engagements, and spend, for each set of ads within a campaign. |
| Board History | Contains details about the boards that are available to your ad accounts, such as the board’s name, description, privacy setting, and owner. |
| Campaign History | Contains a record of changes made over time to each campaign, including its objective and the ads associated with it. |
| Campaign Report | Contains daily or hourly performance metrics, such as impressions, clicks, engagements, and spend, for each campaign and its ads. |
| Pin Promotion History | Contains a record of changes made over time to each ad, which is a paid Pin used to reach a wider audience. Includes details such as the advertised Pin, its status, and tracking information. |
| Pin Promotion Report | Contains daily or hourly performance metrics for each paid Pin, such as impressions, clicks, engagements, and spend. |
| Pin History | Contains details about the Pins that are available to your ad accounts, such as the Pin’s title, description, link, media type, and the board it belongs to. |
| User Account | Contains details of the Pinterest profile that owns the ad accounts, such as its username, whether it is a business or personal profile, and its business name. |
Additional Information
Read the detailed Hevo documentation for the following related topics:
Source Considerations
-
Pinterest retains up to 30 months of daily report data and up to 8 days of hourly report data.
-
Hourly reports do not include conversion metrics.