Configure Pinterest Ads as a Source in your Pipeline

Perform the following steps to configure your Pinterest Ads Source:

1. Click Pipelines in the Navigation Bar.

2. Click + Create Pipeline in the Pipelines List View.

3. On the Select Source Type page, select Pinterest Ads.

4. On the Select Destination Type page, select the type of Destination you want to use.

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

6. 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: 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. Ad accounts that you add to Pinterest later are synced only after you select them here.

         

   • 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. Default value: 1 day.

     • Conversion Report Time: The date on which conversions are reported, based on when the person interacted with the ad or when the conversion happened. Default value: Ad event.

     • Report Granularity: The time period that each row in the report tables covers. You cannot change this setting after the Pipeline is created. Default value: Daily. Select one of the following options:

       • Daily: Creates one row per entity for each day.

       • Hourly: Creates one row per entity for each hour. Hourly reports include data only for the last 8 days and do not include conversion metrics.

       • Weekly: Creates one row per entity for each week, from Monday to Sunday. Each row is identified by the first day of the week, and the current week’s row is updated as new data arrives.

       • Monthly: Creates one row per entity for each month. Each row is identified by the first day of the month, and the current month’s row is updated as new data arrives.

       • Total (last 30 days): Creates one row per entity that holds its totals for the last 30 days. Hevo updates the row in each sync if the entity had activity in that period. Otherwise, the entity keeps its last row.

       Note: The MMM Ad Group Targeting Daily Report and MMM Campaign Targeting Daily Report objects always contain daily data, irrespective of the granularity you select.

     • Historical Sync Duration: The duration for which you want to ingest existing data for the report objects from the Source. You cannot change this setting after the Pipeline is created. Default value: 3 months.

   • (Optional) In the Custom Reports section, click + Custom Report to define a report. Each report you define is ingested into its own table in the Destination. For each report, specify the following:

     

     • Report name: A name for the report, which is used as the name of its Destination table. The name must be unique across your custom reports, contain only letters, numbers, and underscores, and must not start with a number. It also cannot be the same as the name of an existing Pinterest Ads object, such as campaign_report.

       Note: If you rename a report after the Pipeline is created, you must resync the report’s object. Hevo then creates a table with the new name in the Destination. The table with the earlier name remains in the Destination with its existing data.

     • Breakdown: From the drop-down, select the level at which the report data is broken down, for example, one row per campaign or per ad group. Select one of Advertiser, Campaign, Ad group, Pin promotion, Pin promotion targeting, Product group, Product group targeting, Keyword, Campaign targeting, Ad group targeting, or Advertiser targeting. The targeting breakdowns add one row for each targeting value, such as age, gender, or location.

     • Granularity: From the drop-down, select the time period that each row of the report covers. Select one of Daily, Hourly, Weekly, Monthly, or Total (last 30 days). This value applies only to this report and is used instead of the Report Granularity setting. Hourly reports include data only for the last 8 days and do not include conversion metrics.

     • (Optional) Click Attribution Window: The number of days between a person clicking the ad and taking an action. Select one of 1 day, 7 days, 30 days, or 60 days. If you leave this field blank, Hevo uses the value of the Click Attribution Window field in the Report Settings section.

     • (Optional) View Attribution Window: The number of days between a person viewing the ad and taking an action. This value cannot exceed the click attribution window. Select one of 1 day, 7 days, 30 days, or 60 days. If you leave this field blank, Hevo uses the value of the View Attribution Window field in the Report Settings section.

     • (Optional) Conversion Report Time: The date on which conversions are reported. Select Ad event to report a conversion on the day of the ad interaction, or Conversion event to report it on the day of the conversion. If you leave this field blank, Hevo uses the value of the Conversion Report Time field in the Report Settings section.

     • Metrics: The metrics to include as columns in the report’s table. You can browse the metrics by category, such as Spend & impressions and Conversion rates, or search for them by name. The conversion metrics are calculated based on the attribution windows and conversion report time of the report.

     Note:

     • Click Save to add each report. Any report that is not saved before you click Test & Continue is not included in the Pipeline.

     • If you change a custom report after the Pipeline is created, such as its name, breakdown, granularity, attribution windows, or metrics, you must resync the report’s object for the changes to take effect.

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

   Note: If any custom report is configured incorrectly, such as with a duplicate report name or no metrics selected, clicking Test & Continue fails the Source configuration. Hevo lists all configuration issues in your custom reports. You can fix these issues by editing the reports before retrying.

---

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.

Selecting a parent object automatically includes all its associated child objects for replication. However, you can select or deselect the child objects individually, and you can select a child object without selecting its parent object.

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

• Keyword Report

• MMM Ad Group Targeting Daily Report

• MMM Campaign Targeting Daily Report

• Pin Promotion Report

• Pin Promotion Targeting Report

• Product Group Report

• Product Group Targeting Report

• Product Item Report

Custom report objects are also ingested this way. If you add a custom report after the Pipeline is created, Hevo ingests its historical data based on the Historical Sync Duration specified when configuring the Source.

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 custom report objects, Hevo re-fetches the data of the last 7 days, or of the report’s click attribution window if it is longer, once every 24 hours. This captures conversions that Pinterest reports with a delay. For reports with the Hourly granularity, Hevo re-fetches at most the last 8 days. For reports with the Weekly or Monthly granularity, Hevo re-fetches the data from the start of the week or month in which this period begins. For reports with the Total (last 30 days) granularity, Hevo ingests the data of the last 30 days during each sync.

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:

In addition to the objects listed above, you can define custom reports in the Source configuration. Each custom report you create is ingested into its own table, named after the report, containing the metrics you select.

---