Create a connection to Pinterest by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the Pinterest icon is not available, click the Add More icon to download and install the Pinterest connector from the CData site.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

Connecting to Pinterest

Pinterest authentication is based on the standard OAuth flow. To authenticate, you must initially create an app via the Pinterest developer's platform where you can obtain an OAuthClientId, OAuthClientSecret, and CallbackURL.

InitiateOAuth to GETANDREFRESH, OAuthClientId, OAuthClientSecret, and CallbackURL parameters will be set as connection properties to your driver.

See Connecting to Pinterest for other OAuth authentication flows.

Overview

This section shows the available API objects and provides more information on executing SQL to Pinterest APIs.

Key Features

• The Sync App models Pinterest entities like documents, folders, and groups as relational views, allowing you to write SQL to query Pinterest data.
• Stored procedures allow you to execute operations to Pinterest
• Live connectivity to these objects means any changes to your Pinterest account are immediately reflected when using the Sync App.

Views

Views describes the available views. Views are statically defined to model ... here will go view names.

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

Pinterest Connector for CData Sync Views

Get analytics for the specified AdAccountId

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• AdAccountId supports the '=' operator.
• StartDate supports the '=' operator.
• EndDate supports the '=' operator.
• Granularity supports the '=' operator.
• ClickWindowDays supports the '=' operator.
• EngagementWindowDays supports the '=' operator.
• ViewWindowDays supports the '=' operator.
• ConversionReportTime supports the '=' operator.

	
	SELECT * FROM AdAccountAnalytics WHERE AdAccountId = '3457832451'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Get a list of the ad_accounts that the User has access to.

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• IncludeSharedAccounts supports the '=' operator.

	
	SELECT * FROM AdAccounts

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Get analytics for the ads in the specified AdAccountId

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• AdAccountId supports the '=' operator.
• AdId supports the '=,IN' operator.
• StartDate supports the '=' operator.
• EndDate supports the '=' operator.
• Granularity supports the '=' operator.
• ClickWindowDays supports the '=' operator.
• EngagementWindowDays supports the '=' operator.
• ViewWindowDays supports the '=' operator.
• ConversionReportTime supports the '=' operator.

	
	SELECT * FROM AdAnalytics WHERE AdAccountId = '3457832451' AND AdId = '3457862457'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Get analytics for the specified campaigns in the specified AdAccountId

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Get analytics for the ad groups in the specified AdAccountId

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• AdAccountId supports the '=' operator.
• AdGroupId supports the '=,IN' operator.
• StartDate supports the '=' operator.
• EndDate supports the '=' operator.
• Granularity supports the '=' operator.
• ClickWindowDays supports the '=' operator.
• EngagementWindowDays supports the '=' operator.
• ViewWindowDays supports the '=' operator.
• ConversionReportTime supports the '=' operator.

	
	SELECT * FROM AdGroupAnalytics WHERE AdAccountId = '3457832451' AND AdGroupId = '3457862457'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Get a list of the ad_accounts that the User has access to.

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• AdAccountId supports the '=' operator.
• Id supports the '=,IN' operator.
• Status supports the '=' operator.
• TranslateInterestsToNames supports the '=' operator.

	
	SELECT * FROM AdGroups WHERE AdAccountId = '3457832451'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Get targeting analytics for one or more ad groups.

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• AdAccountId supports the '=' operator.
• AdGroupId supports the '=,IN' operators.
• TargetingType supports the '=' operator.
• StartDate supports the '=' operator.
• EndDate supports the '=' operator.
• Granularity supports the '=' operator.
• ClickWindowDays supports the '=' operator.
• EngagementWindowDays supports the '=' operator.
• ViewWindowDays supports the '=' operator.
• ConversionReportTime supports the '=' operator.

	
	SELECT * FROM AdGroupTargetingAnalytics WHERE TargetingType = 'LOCATION'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Get a list of the ad_accounts that the User has access to.

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• AdAccountId supports the '=' operator.
• Id supports the '=,IN' operator.
• AdGroupId supports the '=,IN' operator.
• CampaignId supports the '=,IN' operator.
• Status supports the '=' operator.

	
	SELECT * FROM Ads WHERE AdAccountId = '3457832451'

Columns

Get a list of the boards owned by the User

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• Id supports the '=' operator.
• Privacy supports the '=' operator.

	
	SELECT * FROM Boards
	SELECT * FROM Boards WHERE Id = '345787634451'

Columns

Get a list of the boards owned by the User

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• BoardId supports the '=' operator.

	
	SELECT * FROM BoardSections WHERE BoardId = '345787634451'

Columns

Get account information for the operation user_account

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• AdAccountId supports the '=' operator.
• Id supports the '=,IN' operator.
• Status supports the '=' operator.

	
	SELECT * FROM Campaigns WHERE AdAccountId = '3457832451'

Columns

Get a Pin owned by the owned by the User or on a group board that has been shared with this account

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• Id supports the '=' operator.
• BoardId supports the '=' operator.
• SectionId supports the '=' operator.

	
	SELECT * FROM Pins WHERE Id = '3457832451'
	SELECT * FROM Pins WHERE BoardId = '3457832451'

Columns

Get a list of the age bucket which are available inside the targets.

Columns

Get a list of the app type which are available inside the targets.

Columns

Get a list of the gender which are available inside the targets.

Columns

Get a list of the geo which are available inside the targets.

Columns

Get a list of the interest which are available inside the targets.

Columns

Get a list of the locale which are available inside the targets.

Columns

Get a list of the location which are available inside the targets.

Table Specific Information

Select

No filters are supported server side for this table. All criteria will be handled client side within the Sync App.

For example, the following queries are processed server side:

	
	SELECT * FROM TargetingTypeLocations

Columns

Get account information for the operation User Account

Table Specific Information

Select

No filters are supported server side for this table. All criteria will be handled client side within the Sync App.

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Get Daily Metric of User Account

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• StartDate supports the '=' operator.
• EndDate supports the '=' operator.
• FromClaimedContent supports the '=' operator.
• PinFormat supports the '=' operator.
• AppTypes supports the '=' operator.
• MetricTypes supports the '=' operator.
• SplitFields supports the '=' operator.
• AdAccountID supports the '=' operator.

	
	SELECT * FROM UserAccountDailyMetrics WHERE AppTypes = 'MOBILE'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Get Summary Metric of User Account

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• StartDate supports the '=' operator.
• EndDate supports the '=' operator.
• FromClaimedContent supports the '=' operator.
• PinFormat supports the '=' operator.
• AppTypes supports the '=' operator.
• MetricTypes supports the '=' operator.
• SplitFields supports the '=' operator.
• AdAccountID supports the '=' operator.

	
	SELECT * FROM UserAccountSummaryMetrics WHERE AppTypes = 'MOBILE'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

Connection

OAuth

SSL

Firewall

Proxy

Logging

Schema

Miscellaneous

This section provides a complete list of the Connection properties you can configure in the connection string for this provider.

Unique identifier of an Ad Account.

Remarks

Driver will use this Account where required. If not fed, it will pick the first Ad Account configured for the Account.

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

The certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\Pinterest Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM AdAccounts WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"