Skip to main content

Pinterest Ads Reader

Note

This adapter is in preview and is available on Striim Developer only. See Striim Developer for more information.

Pinterest ads are paid posts, also known as Promoted Pins, that help businesses promote their products or services on the Pinterest platform. The Pinterest Ads Reader from Striim reads from Pinterest ads marketing platform and provides seamless data integration capabilities.

Feature summary

Feature

Supported?

Notes

Objects

Standard objects

Custom objects

Authentication

Basic authentication

Username and password

OAuth authentication

Manual configuration based

Custom authentication methods

Not all methods may be supported

Operations

Automated mode

Initial load

Pull-based incremental load

Push-based incremental load

Automated pipeline

Governance

Connection profile

Sherlock AI

Sentinel AI

Schema handling

Initial schema creation

Works with supported targets

Schema evolution

Setup

Wizard template

Flow Designer

Striim TQL

Runtime

Resilience/recovery

Parallel execution

Metrics

Standard metrics

Supported authentication

The Pinterest Ads Reader supports connecting using OAuth authentication. Configuring authentication for the Pinterest Ads Reader requires registering your app, choosing your permission scopes, and generating an access token.

For information on setting up OAuth authentication with Pinterest, see Connect app and Set up authentication and authorization. For information about the permissions required to access data in Pinterest by entity, see Available scopes.

Supported objects

The following are the supported tables for reading from Pinterest:

  • AdAccountAnalytics

  • AdAccountAnalyticsReport

  • AdAccountTargetingAnalytics

  • AdAnalytics

  • AdCampaignAnalytics

  • AdGroups

  • AdGroupTargetingAnalytics

  • Ads

  • AdsTargetingAnalytics

  • Audiences

  • Boards

  • BoardSections

  • Campaigns

  • CampaignTargetingAnalytics

  • Pins

  • ProductGroupAnalytics

  • TargetingTypeAgeBucket

  • TargetingTypeAppType

  • TargetingTypeAudienceExclude

  • TargetingTypeAudienceInclude

  • TargetingTypeGender

  • TargetingTypeGeo

  • TargetingTypeInterests

  • TargetingTypeKeyword

  • TargetingTypeLocale

  • TargetingTypeLocations

  • UserAccount

  • UserAccountDailyMetrics

  • UserAccountSummaryMetrics

  • UserAccountTopVideoPinAnalytics

  • UserTopPinAnalytics

Pinterest Reader properties

Property

Type

Default value

Notes

Access token

Password

An OAuth 2.0 access token.Use the value generated while creating the token.

Client ID

String

Client ID of the private app registered in Pinterest.

Client secret

Password

Client secret of the private app registered in Pinterest.

Connection pool size

Integer

20

Specifies the maximum number of active connections. You can configure the connection pool size to optimize the performance of the reader for multiple objects.

Exclude tables

String

A list of tables excluded from read operations. Typically used to create a list of exceptions when the Tables property includes wildcards. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors.

Incremental load marker

String

The incremental load marker is a unique incremental column in each object used for incremental load. When no marker is specified, tables are resynced at each polling interval.

Specify the name of the column that contains the start position value. This column must meet the following criteria:

  • It should have an integer or timestamp data type (for example, a creation timestamp or an employee ID).

  • The values must be unique and continuously increasing to ensure proper incremental reading.

Migrate schema

Boolean

False

Only available in Initial Load or Automated mode. Set to True to enable initial schema migration, which propagates the object schema from the source to the target.

Mode

Select list:

  • Initial load

  • Incremental load

Initial load

Supported values:

  • Initial load: Captures all the data for specified tables from the given start timestamp to the current timestamp. Stops after synchronizing with the current timestamp.

  • Incremental load: Captures ongoing data changes for the specified tables from the given start timestamp. By default, the start timestamp is the current timestamp. Continues to run based on the given poll interval.

Polling interval

Integer

5m

Specifies an interval as an integer followed by a unit. Supported units are days (d), hours (h), minutes (m), or seconds (s). The reader polls the source at the specified interval.

Start Position

String

%=-1

Value of the incremental load marker that defines the initial reading position.

Tables

String

A semicolon-delimited (;) list of objects to read from the source. Supports the % wildcard. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors. Do not modify this property when recovery is enabled for the application.

Thread pool count

Integer

10

The number of parallel running threads. The default value of zero specifies single-threaded operation.

When the value of the thread pool counter is higher than the connection pool size, large data ingestion operations can cause the app to halt. Since best performance is achieved when using one thread for each table being synced, increasing the size of the connection pool to match the number of threads in use is a performance best practice.