CData Sync App は、Pinterest データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Pinterest コネクタはCData Sync アプリケーションから使用可能で、Pinterest からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App アプリケーションの接続 ページに移動し、接続の追加 パネルで対応するアイコンを選択して、Pinterest への接続を作成します。Pinterest アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからPinterest コネクタをダウンロードおよびインストールします。
必須プロパティは[設定]タブにリストされています。[Advanced]タブには、通常は必要ない接続プロパティが表示されます。
Pinterest 認証は標準のOAuth フローに基づいています。認証するには、最初にOAuthClientId、OAuthClientSecret、およびCallbackURL を取得できるPinterest 開発者プラットフォームでアプリを作成する必要があります。
InitiateOAuth をGETANDREFRESH に設定します。OAuthClientId、OAuthClientSecret、およびCallbackURL パラメータは、ドライバーの接続プロパティとして設定されます。
他のOAuth 認証フローについては、Pinterest への接続 を参照してください。
このセクションでは、利用可能なAPI オブジェクトを示し、Pinterest API へのSQL の実行について詳しく説明します。
ビュー では、利用可能なビューを説明します。ビューは、ボード、フォロワー、ピンなどを静的にモデル化するように定義されています。
ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます(その機能がデータソースに適用できる場合)。
ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。
ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。
Name | Description |
AdAccountAnalytics | Get analytics for the specified AdAccountId |
AdAccounts | Get a list of the ad_accounts that the User has access to. |
AdAnalytics | Get analytics for the ads in the specified AdAccountId |
AdCampaignAnalytics | Get analytics for the specified campaigns in the specified AdAccountId |
AdGroupAnalytics | Get analytics for the ad groups in the specified AdAccountId |
AdGroups | Get a list of the ad_accounts that the User has access to. |
AdGroupTargetingAnalytics | Get targeting analytics for one or more ad groups. |
Ads | Get a list of the ad_accounts that the User has access to. |
Boards | Get a list of the boards owned by the User |
BoardSections | Get a list of the boards owned by the User |
Campaigns | Get account information for the operation user_account |
Pins | Get a Pin owned by the owned by the User or on a group board that has been shared with this account |
TargetingTypeAgeBucket | Get a list of the age bucket which are available inside the targets. |
TargetingTypeAppType | Get a list of the app type which are available inside the targets. |
TargetingTypeGender | Get a list of the gender which are available inside the targets. |
TargetingTypeGeo | Get a list of the geo which are available inside the targets. |
TargetingTypeInterests | Get a list of the interest which are available inside the targets. |
TargetingtypeLocale | Get a list of the locale which are available inside the targets. |
TargetingTypeLocations | Get a list of the location which are available inside the targets. |
UserAccount | Get account information for the operation User Account |
UserAccountDailyMetrics | Get Daily Metric of User Account |
UserAccountSummaryMetrics | Get Summary Metric of User Account |
Get analytics for the specified AdAccountId
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.
SELECT * FROM AdAccountAnalytics WHERE AdAccountId = '3457832451'
Name | Type | References | Description |
AdAccountId | String |
AdAccounts.Id | Id of the ad account |
Date | Date | Current metrics date. Only returned when granularity is a time-based value. | |
CampaignEntityStatus | String | Status of the campaign. | |
AdGroupEntityStatus | String | Status of the ad group. | |
SpendInDollar | Double | Total spend in dollars. | |
EcpcInDollar | Double | Ecpc in dollars. | |
Ctr | Double | Ctr. | |
Ectr | Double | Ectr. | |
EcpeInDollar | Double | Ecpe in Dollars. | |
EngagementRate | Double | The engagement rate. | |
EengagementRate | Double | E Engagement rate. | |
RepinRate | Double | The repin rate. | |
Ctr2 | Double | Ctr2 | |
CpmInDollar | Double | Cpm in Dollars. | |
WebCheckoutCostPerAction | Double | Web checkout cost per action. | |
WebCheckoutRoas | Double | Web checkout roas | |
PageVisitCostPerAction | Double | Page visit cost per action. | |
PageVisitRoas | Double | Page visit roas. | |
CheckoutRoas | Double | Checkout roas. | |
Video3secViews2 | Integer | Videos with at least 3 seconds of viewing. | |
VideoP100Complete2 | Integer | Videos 100 percent complete | |
VideoP0Combined2 | Integer | Videos 0 percent combined viewed. | |
VideoP25Combined2 | Integer | Videos 25 percent combined viewed. | |
VideoP50Combined2 | Integer | Video 50 percent combined viewed. | |
VideoP75Combined2 | Integer | Video 75 percent combined viewed. | |
VideoP95Combined2 | Integer | Video 95 percent combined viewed. | |
VideoMrcViews2 | Integer | Video Mrc Views. | |
EcpvInDollar | Double | Ecpv in dollars. | |
EcpcvInDollar | Double | E Cpcv in Dollars | |
EcpcvP95InDollar | Double | E Cpcv 95 percent in Dollars. | |
TotalClickthrough | Integer | Total Clickthrough. | |
TotalImpressionFrequency | Double | Total Impression Frequency. | |
TotalEngagementSignup | Integer | Total Engagement Signup. | |
TotalEngagementCheckout | Integer | Total Engagement Checkout. | |
TotalClickSignup | Integer | Total Click Signup. | |
TotalClickCheckout | Integer | Total Click Checkout. | |
TotalViewSignup | Integer | Total View Signup. | |
TotalViewCheckout | Integer | Total View Checkout. | |
TotalConversions | Integer | Total Conversions. | |
TotalEngagementSignupValueInMicroDollar | Double | Total Engagement Signup Value In Micro Dollar. | |
TotalEngagementCheckoutValueInMicroDollar | Double | Total Engagement Checkout Value In Micro Dollar. | |
TotalClickSignupValueInMicroDollar | Double | Total Click Signup Value In Micro Dollar. | |
TotalClickCheckoutValueInMicroDollar | Double | Total Click Checkout Value In Micro Dollar. | |
TotalViewSignupValueInMicroDollar | Double | Total View Signup Value In Micro Dollar. | |
TotalViewCheckoutValueInMicroDollar | Double | Total View Checkout Value In Micro Dollar. | |
TotalPageVisit | Integer | Total Page Visit. | |
TotalSignup | Integer | Total Signup. | |
TotalCheckout | Integer | Total Checkout. | |
TotalSignupValueInMicroDollar | Double | Total Signup Value In Micro Dollar. | |
TotalCheckoutValueInMicroDollar | Double | Total Checkout Value In Micro Dollar. | |
TotalVideo3secViews | Integer | Total Video 3 second Views. | |
TotalVideoP100Complete | Integer | Total Video 100 percent Complete. | |
TotalVideoP0Combined | Integer | Total Video 0 percent Combined. | |
TotalVideoP25Combined | Integer | Total Video 25 percent Combined. | |
TotalVideoP50Combined | Integer | Total Video 50 percent Combined. | |
TotalVideoP75Combined | Integer | Total Video 75 percent Combined. | |
TotalVideoP95Combined | Integer | Total Video 95 percent Combined. | |
TotalVideoMrcViews | Integer | Total Video Mrc Views. | |
TotalVideoAvgWatchtimeInSecond | Integer | Total Video Avg Watchtime In Seconds. | |
TotalRepinRate | Double | Total Repin Rate. | |
TotalWebCheckout | Integer | Total Web Checkout. | |
TotalWebCheckoutValueInMicroDollar | Double | Total Web Checkout Value In Micro Dollar. | |
TotalWebClickCheckout | Integer | Total Web Click Checkout. | |
TotalWebClickCheckoutValueInMicroDollar | Double | Total Web Click Checkout Value In Micro Dollar. | |
TotalWebEngagementCheckout | Integer | Total Web Engagement Checkout. | |
TotalWebEngagementCheckoutValueInMicroDollar | Double | Total Web Engagement Checkout Value In Micro Dollar. | |
TotalWebViewCheckout | Integer | Total Web View Checkout. | |
TotalWebViewCheckoutValueInMicroDollar | Double | Total Web View Checkout Value In Micro Dollar. | |
Clickthrough1 | Integer | Clickthrough1. | |
Clickthrough1Gross | Integer | Clickthrough1 Gross. | |
Impression1 | Integer | Impression1. | |
Impression1Gross | Integer | Impression1 Gross. | |
AdId | String |
Ads.Id | Id of the Ad. |
CampaignId | String |
Campaigns.Id | Id of the Campaign. |
StartDate | Date | Metric report start date. | |
EndDate | Date | Metric report end date. | |
Granularity | String | Granularity
使用できる値は次のとおりです。TOTAL, DAY, HOUR, WEEK, MONTH |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ClickWindowDays | Integer | Number of days to use as the conversion attribution window for a pin click action.
使用できる値は次のとおりです。1, 7, 30, 60 | |
EngagementWindowDays | Integer | Number of days to use as the conversion attribution window for an engagement action.
使用できる値は次のとおりです。1, 7, 30, 60 | |
ViewWindowDays | Integer | Number of days to use as the conversion attribution window for a view action.
使用できる値は次のとおりです。1, 7, 30, 60 | |
ConversionReportTime | String | The date by which the conversion metrics returned from this endpoint will be reported.
使用できる値は次のとおりです。TIME_OF_AD_ACTION, TIME_OF_CONVERSION |
Get a list of the ad_accounts that the User has access to.
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.
SELECT * FROM AdAccounts
Name | Type | References | Description |
Id [KEY] | String | Id of the Ad Account. | |
Name | String | Name of the Ad Account. | |
OwnerUsername | String | Owner Usernameof the Ad Account. | |
Country | String | Country of the ad account. | |
Currency | String | Currency of the ad account. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
IncludeSharedAccounts | Boolean | Include shared ad accounts |
Get analytics for the ads in the specified AdAccountId
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.
SELECT * FROM AdAnalytics WHERE AdAccountId = '3457832451' AND AdId = '3457862457'
Name | Type | References | Description |
AdId | String |
Ads.Id | Id of the ad |
AdAccountId | String |
AdAccounts.Id | Id of the ad account |
Date | Date | Current metrics date. Only returned when granularity is a time-based value. | |
CampaignEntityStatus | String | Status of the campaign. | |
AdGroupEntityStatus | String | Status of the ad group. | |
SpendInDollar | Double | Total spend in dollars. | |
EcpcInDollar | Double | Ecpc in dollars. | |
Ctr | Double | Ctr. | |
Ectr | Double | Ectr. | |
EcpeInDollar | Double | Ecpe in Dollars. | |
EngagementRate | Double | The engagement rate. | |
EengagementRate | Double | E Engagement rate. | |
RepinRate | Double | The repin rate. | |
Ctr2 | Double | Ctr2 | |
CpmInDollar | Double | Cpm in Dollars. | |
WebCheckoutCostPerAction | Double | Web checkout cost per action. | |
WebCheckoutRoas | Double | Web checkout roas | |
PageVisitCostPerAction | Double | Page visit cost per action. | |
PageVisitRoas | Double | Page visit roas. | |
CheckoutRoas | Double | Checkout roas. | |
Video3secViews2 | Integer | Videos with at least 3 seconds of viewing. | |
VideoP100Complete2 | Integer | Videos 100 percent complete | |
VideoP0Combined2 | Integer | Videos 0 percent combined viewed. | |
VideoP25Combined2 | Integer | Videos 25 percent combined viewed. | |
VideoP50Combined2 | Integer | Video 50 percent combined viewed. | |
VideoP75Combined2 | Integer | Video 75 percent combined viewed. | |
VideoP95Combined2 | Integer | Video 95 percent combined viewed. | |
VideoMrcViews2 | Integer | Video Mrc Views. | |
EcpvInDollar | Double | Ecpv in dollars. | |
EcpcvInDollar | Double | E Cpcv in Dollars | |
EcpcvP95InDollar | Double | E Cpcv 95 percent in Dollars. | |
TotalClickthrough | Integer | Total Clickthrough. | |
TotalImpressionFrequency | Double | Total Impression Frequency. | |
TotalEngagementSignup | Integer | Total Engagement Signup. | |
TotalEngagementCheckout | Integer | Total Engagement Checkout. | |
TotalClickSignup | Integer | Total Click Signup. | |
TotalClickCheckout | Integer | Total Click Checkout. | |
TotalViewSignup | Integer | Total View Signup. | |
TotalViewCheckout | Integer | Total View Checkout. | |
TotalConversions | Integer | Total Conversions. | |
TotalEngagementSignupValueInMicroDollar | Double | Total Engagement Signup Value In Micro Dollar. | |
TotalEngagementCheckoutValueInMicroDollar | Double | Total Engagement Checkout Value In Micro Dollar. | |
TotalClickSignupValueInMicroDollar | Double | Total Click Signup Value In Micro Dollar. | |
TotalClickCheckoutValueInMicroDollar | Double | Total Click Checkout Value In Micro Dollar. | |
TotalViewSignupValueInMicroDollar | Double | Total View Signup Value In Micro Dollar. | |
TotalViewCheckoutValueInMicroDollar | Double | Total View Checkout Value In Micro Dollar. | |
TotalPageVisit | Integer | Total Page Visit. | |
TotalSignup | Integer | Total Signup. | |
TotalCheckout | Integer | Total Checkout. | |
TotalSignupValueInMicroDollar | Double | Total Signup Value In Micro Dollar. | |
TotalCheckoutValueInMicroDollar | Double | Total Checkout Value In Micro Dollar. | |
TotalVideo3secViews | Integer | Total Video 3 second Views. | |
TotalVideoP100Complete | Integer | Total Video 100 percent Complete. | |
TotalVideoP0Combined | Integer | Total Video 0 percent Combined. | |
TotalVideoP25Combined | Integer | Total Video 25 percent Combined. | |
TotalVideoP50Combined | Integer | Total Video 50 percent Combined. | |
TotalVideoP75Combined | Integer | Total Video 75 percent Combined. | |
TotalVideoP95Combined | Integer | Total Video 95 percent Combined. | |
TotalVideoMrcViews | Integer | Total Video Mrc Views. | |
TotalVideoAvgWatchtimeInSecond | Integer | Total Video Avg Watchtime In Seconds. | |
TotalRepinRate | Double | Total Repin Rate. | |
TotalWebCheckout | Integer | Total Web Checkout. | |
TotalWebCheckoutValueInMicroDollar | Double | Total Web Checkout Value In Micro Dollar. | |
TotalWebClickCheckout | Integer | Total Web Click Checkout. | |
TotalWebClickCheckoutValueInMicroDollar | Double | Total Web Click Checkout Value In Micro Dollar. | |
TotalWebEngagementCheckout | Integer | Total Web Engagement Checkout. | |
TotalWebEngagementCheckoutValueInMicroDollar | Double | Total Web Engagement Checkout Value In Micro Dollar. | |
TotalWebViewCheckout | Integer | Total Web View Checkout. | |
TotalWebViewCheckoutValueInMicroDollar | Double | Total Web View Checkout Value In Micro Dollar. | |
Clickthrough1 | Integer | Clickthrough1. | |
Clickthrough1Gross | Integer | Clickthrough1 Gross. | |
Impression1 | Integer | Impression1. | |
Impression1Gross | Integer | Impression1 Gross. | |
CampaignId | String |
Campaigns.Id | Id of the Campaign. |
AdvertiserId | String | Id of the ad account | |
AdGroupId | String |
AdGroups.Id | Id of the ad group. |
CampaignDailySpendCap | Integer | Campaign daily spend cap. | |
CampaignLifetimeSpendCap | Integer | Campaign Lifetime Spend Cap. | |
CampaignName | String | Name of the Campaign | |
Clickthrough2 | Integer | Clickthrough2. | |
CpcInMicroDollar | Decimal | Cpc In MicroDollar. | |
CpmInMicroDollar | Decimal | Cpm In MicroDollar. | |
EcpcInMicroDollar | Decimal | Ecpc In MicroDollar. | |
EcpmInMicroDollar | Decimal | Ecpm In MicroDollar. | |
Engagement1 | Integer | Engagement1. | |
Engagement2 | Integer | Engagement2. | |
IdeaPinProductTagVisit1 | Integer | Idea Pin Product Tag Visit1. | |
IdeaPinProductTagVisit2 | Integer | Idea Pin Product Tag Visit2. | |
Impression2 | Integer | Impression2. | |
InAppCheckoutCostPerAction | Double | In App Checkout Cost Per Action. | |
OutboundClick1 | Integer | Outboundclick1. | |
OutboundClick2 | Integer | Outboundclick2. | |
PaidImpression | Integer | PaidImpression. | |
PinId | String |
Pins.Id | Id of the Pins. |
Repin1 | Integer | Repin1. | |
Repin2 | Integer | Repin2. | |
SpendInMicroDollar | Decimal | Total spend in dollars. | |
TotalClickAddToCart | Integer | Total click add to cart. | |
TotalClickLead | Integer | Total click lead. | |
TotalCustom | Integer | Total custom. | |
TotalEngagement | Integer | Total Engagement. | |
TotalEngagementLead | Integer | Total Engagement Lead. | |
TotalIdeaPinProductTagVisit | Integer | Total Idea Pin Product Tag Visit. | |
TotalImpressionUser | Integer | Total Impression User. | |
TotalLead | Integer | Total Lead. | |
TotalOfflineCheckout | Integer | Total offline checkout. | |
TotalViewAddToCart | Integer | Total view add to cart. | |
TotalViewLead | Integer | Total view Lead. | |
TotalWebSessions | Integer | Total web sessions. | |
VideoLength | Integer | VideoLength. | |
WebSessions1 | Integer | WebSessions1. | |
WebSessions2 | Integer | WebSessions2. | |
StartDate | Date | Metric report start date. | |
EndDate | Date | Metric report end date. | |
Granularity | String | Granularity
使用できる値は次のとおりです。TOTAL, DAY, HOUR, WEEK, MONTH |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ClickWindowDays | Integer | Number of days to use as the conversion attribution window for a pin click action.
使用できる値は次のとおりです。1, 7, 30, 60 | |
EngagementWindowDays | Integer | Number of days to use as the conversion attribution window for an engagement action.
使用できる値は次のとおりです。1, 7, 30, 60 | |
ViewWindowDays | Integer | Number of days to use as the conversion attribution window for a view action.
使用できる値は次のとおりです。1, 7, 30, 60 | |
ConversionReportTime | String | The date by which the conversion metrics returned from this endpoint will be reported.
使用できる値は次のとおりです。TIME_OF_AD_ACTION, TIME_OF_CONVERSION |
Get analytics for the specified campaigns in the specified AdAccountId
Name | Type | References | Description |
CampaignId | String |
Campaigns.Id | Id of the campaign. |
AdAccountId | String |
AdAccounts.Id | Id of the ad account. |
Date | Date | Date the analytics row covers. | |
CampaignEntityStatus | String | Status of the campaign. | |
AdGroupEntityStatus | String | Status of the ad group. | |
SpendInDollar | Double | Total spend in dollars. | |
EcpcInDollar | Double | Ecpc in dollars. | |
Ctr | Double | Ctr. | |
Ectr | Double | Ectr. | |
EcpeInDollar | Double | Ecpe in Dollars. | |
EngagementRate | Double | The engagement rate. | |
EengagementRate | Double | E Engagement rate. | |
RepinRate | Double | The repin rate. | |
Ctr2 | Double | Ctr2 | |
CpmInDollar | Double | Cpm in Dollars. | |
WebCheckoutCostPerAction | Double | Web checkout cost per action. | |
WebCheckoutRoas | Double | Web checkout roas | |
PageVisitCostPerAction | Double | Page visit cost per action. | |
PageVisitRoas | Double | Page visit roas. | |
CheckoutRoas | Double | Checkout roas. | |
Video3secViews2 | Integer | Videos with at least 3 seconds of viewing. | |
VideoP100Complete2 | Integer | Videos 100 percent complete | |
VideoP0Combined2 | Integer | Videos 0 percent combined viewed. | |
VideoP25Combined2 | Integer | Videos 25 percent combined viewed. | |
VideoP50Combined2 | Integer | Video 50 percent combined viewed. | |
VideoP75Combined2 | Integer | Video 75 percent combined viewed. | |
VideoP95Combined2 | Integer | Video 95 percent combined viewed. | |
VideoMrcViews2 | Integer | Video Mrc Views. | |
EcpvInDollar | Double | Ecpv in dollars. | |
EcpcvInDollar | Double | E Cpcv in Dollars | |
EcpcvP95InDollar | Double | E Cpcv 95 percent in Dollars. | |
TotalClickthrough | Integer | Total Clickthrough. | |
TotalImpressionFrequency | Double | Total Impression Frequency. | |
TotalEngagementSignup | Integer | Total Engagement Signup. | |
TotalEngagementCheckout | Integer | Total Engagement Checkout. | |
TotalClickSignup | Integer | Total Click Signup. | |
TotalClickCheckout | Integer | Total Click Checkout. | |
TotalViewSignup | Integer | Total View Signup. | |
TotalViewCheckout | Integer | Total View Checkout. | |
TotalConversions | Integer | Total Conversions. | |
TotalEngagementSignupValueInMicroDollar | Double | Total Engagement Signup Value In Micro Dollar. | |
TotalEngagementCheckoutValueInMicroDollar | Double | Total Engagement Checkout Value In Micro Dollar. | |
TotalClickSignupValueInMicroDollar | Double | Total Click Signup Value In Micro Dollar. | |
TotalClickCheckoutValueInMicroDollar | Double | Total Click Checkout Value In Micro Dollar. | |
TotalViewSignupValueInMicroDollar | Double | Total View Signup Value In Micro Dollar. | |
TotalViewCheckoutValueInMicroDollar | Double | Total View Checkout Value In Micro Dollar. | |
TotalPageVisit | Integer | Total Page Visit. | |
TotalSignup | Integer | Total Signup. | |
TotalCheckout | Integer | Total Checkout. | |
TotalSignupValueInMicroDollar | Double | Total Signup Value In Micro Dollar. | |
TotalCheckoutValueInMicroDollar | Double | Total Checkout Value In Micro Dollar. | |
TotalVideo3secViews | Integer | Total Video 3 second Views. | |
TotalVideoP100Complete | Integer | Total Video 100 percent Complete. | |
TotalVideoP0Combined | Integer | Total Video 0 percent Combined. | |
TotalVideoP25Combined | Integer | Total Video 25 percent Combined. | |
TotalVideoP50Combined | Integer | Total Video 50 percent Combined. | |
TotalVideoP75Combined | Integer | Total Video 75 percent Combined. | |
TotalVideoP95Combined | Integer | Total Video 95 percent Combined. | |
TotalVideoMrcViews | Integer | Total Video Mrc Views. | |
TotalVideoAvgWatchtimeInSecond | Integer | Total Video Avg Watchtime In Seconds. | |
TotalRepinRate | Double | Total Repin Rate. | |
TotalWebCheckout | Integer | Total Web Checkout. | |
TotalWebCheckoutValueInMicroDollar | Double | Total Web Checkout Value In Micro Dollar. | |
TotalWebClickCheckout | Integer | Total Web Click Checkout. | |
TotalWebClickCheckoutValueInMicroDollar | Double | Total Web Click Checkout Value In Micro Dollar. | |
TotalWebEngagementCheckout | Integer | Total Web Engagement Checkout. | |
TotalWebEngagementCheckoutValueInMicroDollar | Double | Total Web Engagement Checkout Value In Micro Dollar. | |
TotalWebViewCheckout | Integer | Total Web View Checkout. | |
TotalWebViewCheckoutValueInMicroDollar | Double | Total Web View Checkout Value In Micro Dollar. | |
Clickthrough1 | Integer | Clickthrough1. | |
Clickthrough1Gross | Integer | Clickthrough1 Gross. | |
Impression1 | Integer | Impression1. | |
Impression1Gross | Integer | Impression1 Gross. | |
AdId | String |
Ads.Id | Id of the Ad. |
StartDate | Date | Metric report start date. | |
EndDate | Date | Metric report end date. | |
Granularity | String | Granularity
使用できる値は次のとおりです。TOTAL, DAY, HOUR, WEEK, MONTH |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ClickWindowDays | Integer | Number of days to use as the conversion attribution window for a pin click action.
使用できる値は次のとおりです。1, 7, 30, 60 | |
EngagementWindowDays | Integer | Number of days to use as the conversion attribution window for an engagement action.
使用できる値は次のとおりです。1, 7, 30, 60 | |
ViewWindowDays | Integer | Number of days to use as the conversion attribution window for a view action.
使用できる値は次のとおりです。1, 7, 30, 60 | |
ConversionReportTime | String | The date by which the conversion metrics returned from this endpoint will be reported.
使用できる値は次のとおりです。TIME_OF_AD_ACTION, TIME_OF_CONVERSION |
Get analytics for the ad groups in the specified AdAccountId
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.
SELECT * FROM AdGroupAnalytics WHERE AdAccountId = '3457832451' AND AdGroupId = '3457862457'
Name | Type | References | Description |
AdGroupId | String |
AdGroups.Id | Id of the ad group. |
AdAccountId | String |
AdAccounts.Id | Id of the ad account. |
Date | Date | Date the analytics row covers. | |
CampaignEntityStatus | String | Status of the campaign. | |
AdGroupEntityStatus | String | Status of the ad group. | |
SpendInDollar | Double | Total spend in dollars. | |
EcpcInDollar | Double | Ecpc in dollars. | |
Ctr | Double | Ctr. | |
Ectr | Double | Ectr. | |
EcpeInDollar | Double | Ecpe in Dollars. | |
EngagementRate | Double | The engagement rate. | |
EengagementRate | Double | E Engagement rate. | |
RepinRate | Double | The repin rate. | |
Ctr2 | Double | Ctr2 | |
CpmInDollar | Double | Cpm in Dollars. | |
WebCheckoutCostPerAction | Double | Web checkout cost per action. | |
WebCheckoutRoas | Double | Web checkout roas | |
PageVisitCostPerAction | Double | Page visit cost per action. | |
PageVisitRoas | Double | Page visit roas. | |
CheckoutRoas | Double | Checkout roas. | |
Video3secViews2 | Integer | Videos with at least 3 seconds of viewing. | |
VideoP100Complete2 | Integer | Videos 100 percent complete | |
VideoP0Combined2 | Integer | Videos 0 percent combined viewed. | |
VideoP25Combined2 | Integer | Videos 25 percent combined viewed. | |
VideoP50Combined2 | Integer | Video 50 percent combined viewed. | |
VideoP75Combined2 | Integer | Video 75 percent combined viewed. | |
VideoP95Combined2 | Integer | Video 95 percent combined viewed. | |
VideoMrcViews2 | Integer | Video Mrc Views. | |
EcpvInDollar | Double | Ecpv in dollars. | |
EcpcvInDollar | Double | E Cpcv in Dollars | |
EcpcvP95InDollar | Double | E Cpcv 95 percent in Dollars. | |
TotalClickthrough | Integer | Total Clickthrough. | |
TotalImpressionFrequency | Double | Total Impression Frequency. | |
TotalEngagementSignup | Integer | Total Engagement Signup. | |
TotalEngagementCheckout | Integer | Total Engagement Checkout. | |
TotalClickSignup | Integer | Total Click Signup. | |
TotalClickCheckout | Integer | Total Click Checkout. | |
TotalViewSignup | Integer | Total View Signup. | |
TotalViewCheckout | Integer | Total View Checkout. | |
TotalConversions | Integer | Total Conversions. | |
TotalEngagementSignupValueInMicroDollar | Double | Total Engagement Signup Value In Micro Dollar. | |
TotalEngagementCheckoutValueInMicroDollar | Double | Total Engagement Checkout Value In Micro Dollar. | |
TotalClickSignupValueInMicroDollar | Double | Total Click Signup Value In Micro Dollar. | |
TotalClickCheckoutValueInMicroDollar | Double | Total Click Checkout Value In Micro Dollar. | |
TotalViewSignupValueInMicroDollar | Double | Total View Signup Value In Micro Dollar. | |
TotalViewCheckoutValueInMicroDollar | Double | Total View Checkout Value In Micro Dollar. | |
TotalPageVisit | Integer | Total Page Visit. | |
TotalSignup | Integer | Total Signup. | |
TotalCheckout | Integer | Total Checkout. | |
TotalSignupValueInMicroDollar | Double | Total Signup Value In Micro Dollar. | |
TotalCheckoutValueInMicroDollar | Double | Total Checkout Value In Micro Dollar. | |
TotalVideo3secViews | Integer | Total Video 3 second Views. | |
TotalVideoP100Complete | Integer | Total Video 100 percent Complete. | |
TotalVideoP0Combined | Integer | Total Video 0 percent Combined. | |
TotalVideoP25Combined | Integer | Total Video 25 percent Combined. | |
TotalVideoP50Combined | Integer | Total Video 50 percent Combined. | |
TotalVideoP75Combined | Integer | Total Video 75 percent Combined. | |
TotalVideoP95Combined | Integer | Total Video 95 percent Combined. | |
TotalVideoMrcViews | Integer | Total Video Mrc Views. | |
TotalVideoAvgWatchtimeInSecond | Integer | Total Video Avg Watchtime In Seconds. | |
TotalRepinRate | Double | Total Repin Rate. | |
TotalWebCheckout | Integer | Total Web Checkout. | |
TotalWebCheckoutValueInMicroDollar | Double | Total Web Checkout Value In Micro Dollar. | |
TotalWebClickCheckout | Integer | Total Web Click Checkout. | |
TotalWebClickCheckoutValueInMicroDollar | Double | Total Web Click Checkout Value In Micro Dollar. | |
TotalWebEngagementCheckout | Integer | Total Web Engagement Checkout. | |
TotalWebEngagementCheckoutValueInMicroDollar | Double | Total Web Engagement Checkout Value In Micro Dollar. | |
TotalWebViewCheckout | Integer | Total Web View Checkout. | |
TotalWebViewCheckoutValueInMicroDollar | Double | Total Web View Checkout Value In Micro Dollar. | |
Clickthrough1 | Integer | Clickthrough1. | |
Clickthrough1Gross | Integer | Clickthrough1 Gross. | |
Impression1 | Integer | Impression1. | |
Impression1Gross | Integer | Impression1 Gross. | |
Impression2 | Integer | Impression2. | |
TotalImpressionUser | Integer | Total ImpressionUser. | |
CampaignDailySpendCap | Integer | Campaign Daily Spend Cap. | |
CampaignLifetimeSpendCap | Integer | Campaign Lifetime Spend Cap. | |
Clickthrough2 | Integer | Clickthrough2. | |
CpcInMicroDollar | Double | Cpc In MicroDollar. | |
CpmInMicroDollar | Double | Cpm In MicroDollar. | |
EcpcInMicroDollar | Double | Ecpc In MicroDollar. | |
EcpmInMicroDollar | Double | Ecpm In MicroDollar. | |
Engagement1 | Integer | Engagement1. | |
Engagement2 | Integer | Engagement2. | |
IdeaPinProductTagVisit1 | Integer | Idea Pin Product Tag Visit1. | |
IdeaPinProductTagVisit2 | Integer | Idea Pin Product Tag Visit2. | |
InAppCheckoutCostPerAction | Double | In App Checkout Cost Per Action. | |
OutboundClick1 | Integer | Outboundclick1. | |
OutboundClick2 | Integer | Outboundclick2. | |
PaidImpression | Integer | PaidImpression. | |
Repin1 | Integer | Repin1. | |
Repin2 | Integer | Repin2. | |
SpendInMicroDollar | Double | Spend In MicroDollar. | |
TotalClickAddToCart | Integer | Total Click Add To Cart. | |
TotalClickLead | Integer | Total ClickLead. | |
TotalCustom | Integer | Total Custom. | |
TotalEngagement | Integer | Total Engagement. | |
TotalEngagementLead | Integer | Total Engagement Lead. | |
TotalIdeaPinProductTagVisit | Integer | Total Idea Pin Product Tag Visit. | |
TotalLead | Integer | Total Lead. | |
TotalOfflineCheckout | Integer | Total Offline Checkout. | |
TotalViewAddToCart | Integer | Total View Add To Cart. | |
TotalViewLead | Integer | Total View Lead. | |
TotalWebSessions | Integer | Total Web Sessions. | |
VideoLength | Integer | VideoLength. | |
WebSessions1 | Integer | WebSessions1. | |
WebSessions2 | Integer | WebSessions2. | |
AdId | String |
Ads.Id | Id of the Ad. |
CampaignId | String |
Campaigns.Id | Id of the Campaign. |
StartDate | Date | Metric report start date. | |
EndDate | Date | Metric report end date. | |
Granularity | String | Granularity
使用できる値は次のとおりです。TOTAL, DAY, HOUR, WEEK, MONTH |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ClickWindowDays | Integer | Number of days to use as the conversion attribution window for a pin click action.
使用できる値は次のとおりです。1, 7, 30, 60 | |
EngagementWindowDays | Integer | Number of days to use as the conversion attribution window for an engagement action.
使用できる値は次のとおりです。1, 7, 30, 60 | |
ViewWindowDays | Integer | Number of days to use as the conversion attribution window for a view action.
使用できる値は次のとおりです。1, 7, 30, 60 | |
ConversionReportTime | Integer | The date by which the conversion metrics returned from this endpoint will be reported.
使用できる値は次のとおりです。TIME_OF_AD_ACTION, TIME_OF_CONVERSION |
Get a list of the ad_accounts that the User has access to.
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.
SELECT * FROM AdGroups WHERE AdAccountId = '3457832451'
Name | Type | References | Description |
Id [KEY] | String | Advertiser ID. | |
AdAccountId | String |
AdAccounts.Id | Ad Account ID. |
CampaignId | String |
Campaigns.Id | Campaign ID of the ad group. |
FeedProfileId | String | Feed Profile ID associated to the adgroup. | |
AutoTargetingEnabled | Boolean | Enable auto-targeting for ad group. | |
BidInMicroCurrency | Integer | Bid price in micro currency. | |
BillableEvent | String | Ad group billable event type. | |
BudgetInMicroCurrency | Integer | Budget in micro currency. | |
BudgetType | String | Budget type | |
ConversionLearningModeType | String | oCPM learn mode | |
CreatedTime | Datetime | Ad group creation time. | |
EndTime | Datetime | Ad group end time. | |
LifetimeFrequencyCap | Integer | Set a limit to the number of times a promoted pin from this campaign can be impressed by a pinner within the past rolling 30 days. | |
Name | String | Ad group name. | |
PacingDeliveryType | String | PacingDeliveryType | |
PlacementGroup | String | PlacementGroup | |
StartTime | Datetime | Ad group start time | |
Status | String | Ad group/entity status.
使用できる値は次のとおりです。ACTIVE, PAUSED, ARCHIVED | |
SummaryStatus | String | Ad group summary status. | |
TargetingSpec | String | Ad group targeting specification defining the ad group target audience. | |
TrackingUrlsAudienceVerification | String | Third-party tracking URLs. | |
TrackingUrlsBuyableButton | String | Third-party tracking URLs. | |
TrackingUrlsClick | String | Third-party tracking URLs. | |
TrackingUrlsEngagement | String | Third-party tracking URLs. | |
TrackingUrlsImpression | String | Third-party tracking URLs. | |
Type | String | Type of ad group. | |
UpdatedTime | Datetime | Ad group last update time. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
TranslateInterestsToNames | Boolean | Return interests as text names and not topic IDs? |
Get targeting analytics for one or more ad groups.
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.
SELECT * FROM AdGroupTargetingAnalytics WHERE TargetingType = 'LOCATION'
Name | Type | References | Description |
AdAccountId | String |
AdAccounts.Id | Unique identifier of an ad account. |
AdGroupId | String |
AdGroups.Id | Id of the ad group. |
TargetingType | String | Targeting type.
使用できる値は次のとおりです。KEYWORD, APPTYPE, GENDER, LOCATION, PLACEMENT, COUNTRY, TARGETED_INTEREST, PINNER_INTEREST, AUDIENCE_INCLUDE, AUDIENCE_EXCLUDE, GEO, AGE_BUCKET, REGION | |
TargetingValues | String | Targeting type value. | |
Date | Date | Date the analytics row covers. | |
SpendInDollar | Decimal | Total spend in dollars. | |
AdvertiserId | Double | Id of the advertiser. | |
AdGroupEntityStatus | Double | Id of the advertiser. | |
AdId | Double | Id of the advertiser. | |
CampaignId | String |
Campaigns.Id | Id of the Campaign. |
CampaignDailySpendCap | String | Campaign daily spend cap. | |
CampaignEntityStatus | String | Campaign entity status. | |
CampaignLifetimeSpendCap | Integer | Campaign Lifetime Spend Cap. | |
Ctr | Double | Ctr. | |
Ctr2 | Double | Ctr2. | |
CheckoutRoas | Double | Checkout roas. | |
Clickthrough1 | Integer | Clickthrough1. | |
Clickthrough2 | Integer | Clickthrough2. | |
Clickthrough1Gross | Integer | Clickthrough1 Gross. | |
CpcInMicroDollar | Decimal | Cpc In MicroDollar. | |
CpmInMicroDollar | Decimal | Cpm In MicroDollar. | |
Ectr | Decimal | Ectr. | |
EcpeInDollar | Decimal | Ecpe in Dollars. | |
EngagementRate | Double | The engagement rate. | |
EengagementRate | Double | E Engagement rate. | |
EcpvInDollar | Decimal | Ecpv in dollars. | |
EcpcvInDollar | Decimal | E Cpcv in Dollars. | |
EcpcvP95InDollar | Decimal | E Cpcv 95 percent in Dollars. | |
EcpcInMicroDollar | Decimal | Ecpc In MicroDollar. | |
EcpmInMicroDollar | Decimal | Ecpm In MicroDollar. | |
Engagement1 | Integer | Engagement1. | |
Engagement2 | Integer | Engagement2. | |
Impression1 | Integer | Impression1. | |
Impression1Gross | Integer | Impression1 Gross. | |
Impression2 | Integer | Impression2. | |
IdeaPinProductTagVisit1 | Integer | Idea Pin Product Tag Visit1. | |
IdeaPinProductTagVisit2 | Integer | Idea Pin Product Tag Visit2. | |
InAppCheckoutCostPerAction | Double | In App Checkout Cost Per Action. | |
OutboundClick1 | Integer | Outboundclick1. | |
OutboundClick2 | Integer | Outboundclick2. | |
PinId | String |
Pins.Id | Id of the Pins. |
PageVisitCostPerAction | Double | Page visit cost per action. | |
PageVisitRoas | Double | Page visit roas. | |
PaidImpression | Integer | PaidImpression. | |
Repin1 | Integer | Repin1. | |
Repin2 | Integer | Repin2. | |
RepinRate | Double | The repin rate. | |
TotalClickthrough | Integer | Total Clickthrough. | |
TotalEngagementSignup | Integer | Total Engagement Signup. | |
TotalEngagementCheckout | Integer | Total Engagement Checkout. | |
TotalClickSignup | Integer | Total Click Signup. | |
TotalClickCheckout | Integer | Total Click Checkout. | |
TotalViewSignup | Integer | Total View Signup. | |
TotalViewCheckout | Integer | Total View Checkout. | |
TotalConversions | Integer | Total Conversions. | |
TotalEngagementSignupValueInMicroDollar | Decimal | Total Engagement Signup Value In Micro Dollar. | |
TotalEngagementCheckoutValueInMicroDollar | Decimal | Total Engagement Checkout Value In Micro Dollar. | |
TotalClickSignupValueInMicroDollar | Decimal | Total Click Signup Value In Micro Dollar. | |
TotalClickCheckoutValueInMicroDollar | Decimal | Total Click Checkout Value In Micro Dollar. | |
TotalViewSignupValueInMicroDollar | Decimal | Total View Signup Value In Micro Dollar. | |
TotalViewCheckoutValueInMicroDollar | Decimal | Total View Checkout Value In Micro Dollar. | |
TotalPageVisit | Integer | Total Page Visit. | |
TotalSignup | Integer | Total Signup. | |
TotalCheckout | Integer | Total Checkout. | |
TotalSignupValueInMicroDollar | Decimal | Total Signup Value In Micro Dollar. | |
TotalCheckoutValueInMicroDollar | Decimal | Total Checkout Value In Micro Dollar. | |
TotalVideo3secViews | Integer | Total Video 3 second Views. | |
TotalVideoP100Complete | Integer | Total Video 100 percent Complete. | |
TotalVideoP0Combined | Integer | Total Video 0 percent Combined. | |
TotalVideoP25Combined | Integer | Total Video 25 percent Combined. | |
TotalVideoP50Combined | Integer | Total Video 50 percent Combined. | |
TotalVideoP75Combined | Integer | Total Video 75 percent Combined. | |
TotalVideoP95Combined | Integer | Total Video 95 percent Combined. | |
TotalVideoMrcViews | Integer | Total Video Mrc Views. | |
TotalVideoAvgWatchtimeInSecond | Integer | Total Video Avg Watchtime In Seconds. | |
TotalRepinRate | Double | Total Repin Rate. | |
TotalWebCheckout | Integer | Total Web Checkout. | |
TotalWebCheckoutValueInMicroDollar | Decimal | Total Web Checkout Value In Micro Dollar. | |
TotalWebClickCheckout | Integer | Total Web Click Checkout. | |
TotalWebClickCheckoutValueInMicroDollar | Decimal | Total Web Click Checkout Value In Micro Dollar. | |
TotalWebEngagementCheckout | Integer | Total Web Engagement Checkout. | |
TotalWebEngagementCheckoutValueInMicroDollar | Decimal | Total Web Engagement Checkout Value In Micro Dollar. | |
TotalWebViewCheckout | Integer | Total Web View Checkout. | |
TotalWebViewCheckoutValueInMicroDollar | Decimal | Total Web View Checkout Value In Micro Dollar. | |
Video3secViews2 | Integer | Video 3 second Views. | |
VideoLength | Integer | VideoLength. | |
VideoMrcViews2 | Integer | Video 2 second Views. | |
VideoP0Combined2 | Integer | Video 0 percent Combined Views. | |
VideoP100Complete2 | Integer | Video 100 percent Complete Views. | |
VideoP25Combined2 | Integer | Video 25 percent Complete Views. | |
VideoP50Combined2 | Integer | Video 50 percent Complete Views. | |
VideoP75Combined2 | Integer | Video 75 percent Complete Views. | |
VideoP95Combined2 | Integer | Video 95 percent Complete Views. | |
WebCheckoutCostPerAction | Double | Web checkout cost per action. | |
WebCheckoutRoas | Double | Web checkout roas. | |
WebSessions1 | Integer | WebSessions1. | |
WebSessions2 | Integer | WebSessions2. | |
StartDate | Date | Metric report start date. | |
EndDate | Date | Metric report end date. | |
Granularity | String | Granularity.
使用できる値は次のとおりです。TOTAL, DAY, HOUR, WEEK, MONTH |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
AttributionTypes | String | List of types of attribution for the conversion report.
使用できる値は次のとおりです。INDIVIDUAL, HOUSEHOLD | |
ClickWindowDays | Integer | Number of days to use as the conversion attribution window for a pin click action.
使用できる値は次のとおりです。1, 7, 30, 60 | |
EngagementWindowDays | Integer | Number of days to use as the conversion attribution window for an engagement action.
使用できる値は次のとおりです。1, 7, 30, 60 | |
ViewWindowDays | Integer | Number of days to use as the conversion attribution window for a view action.
使用できる値は次のとおりです。1, 7, 30, 60 | |
ConversionReportTime | Integer | The date by which the conversion metrics returned from this endpoint will be reported.
使用できる値は次のとおりです。TIME_OF_AD_ACTION, TIME_OF_CONVERSION |
Get a list of the ad_accounts that the User has access to.
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.
SELECT * FROM Ads WHERE AdAccountId = '3457832451'
Name | Type | References | Description |
Id [KEY] | String | The ID of this ad. | |
AdAccountId | String |
AdAccounts.Id | Unique identifier of an ad account. |
AdGroupId | String |
AdGroups.Id | ID of the ad group that contains the ad. |
AndroidDeepLink | String | Deep link URL for Android devices. Not currently available. Using this field will generate an error. | |
CampaignId | String |
Campaigns.Id | ID of the ad campaign that contains this ad. |
CarouselAndroidDeepLinks | String | Comma-separated deep links for the carousel pin on Android. | |
CarouselDestinationUrls | String | Comma-separated destination URLs for the carousel pin to promote. | |
CarouselIosDeepLinks | String | Comma-separated deep links for the carousel pin on iOS. | |
ClickTrackingUrl | String | Tracking url for the ad clicks. | |
CollectionItemsDestinationUrlTemplate | String | Destination URL template for all items within a collections drawer. | |
CreatedTime | Datetime | Pin creation time. | |
CreativeType | String | Ad creative type | |
DestinationUrl | String | Destination URL. | |
IosDeepLink | String | Deep link URL for iOS devices. | |
IsPinDeleted | Boolean | Is original pin deleted? | |
IsRemovable | Boolean | Is pin repinnable? | |
Name | String | Name of the ad. | |
PinId | String | Pin ID. | |
RejectedReasons | String | Reason why the pin was rejected. | |
RejectionLabels | String | Text reason why the pin was rejected. | |
ReviewStatus | String | Ad review status | |
Status | String | Entity status
使用できる値は次のとおりです。ACTIVE, PAUSED, ARCHIVED | |
SummaryStatus | String | Ad summary status. | |
TrackingUrlsAudienceVerification | String | Tracking Urls Audience Verification. | |
TrackingUrlsBuyableButton | String | Tracking Urls Buyable Button. | |
TrackingUrlsClick | String | Tracking Urls Click. | |
TrackingUrlsEngagement | String | Tracking Urls Engagement. | |
TrackingUrlsImpression | String | Tracking Urls Impression. | |
Type | String | Type of ad. | |
UpdatedTime | Datetime | Last update time. | |
ViewTrackingUrl | String | Tracking URL for ad impressions. |
Get a list of the boards owned by the User
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.
SELECT * FROM Boards SELECT * FROM Boards WHERE Id = '345787634451'
Name | Type | References | Description |
Id [KEY] | String | Id of the Board | |
Name | String | Name of the Board | |
Description | String | Description of the Board | |
OwnerUsername | String | UserName of the Owner. | |
Privacy | String | Privacy setting for the board.
使用できる値は次のとおりです。PUBLIC, PROTECTED, SECRET |
Get a list of the boards owned by the User
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.
SELECT * FROM BoardSections WHERE BoardId = '345787634451'
Name | Type | References | Description |
Id [KEY] | String | Id of the Section. | |
Name | String | Name of the Section. | |
BoardId | String |
Boards.Id | Id of the Board. |
Get account information for the operation user_account
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.
SELECT * FROM Campaigns WHERE AdAccountId = '3457832451'
Name | Type | References | Description |
Id [KEY] | String | Campaign ID. | |
AdAccountId | String |
AdAccounts.Id | Campaign's Advertiser ID. |
CreatedTime | Datetime | Campaign creation time. | |
DailySpendCap | Integer | Campaign total spending cap. | |
LifetimeSpendCap | Integer | Campaign daily spending cap. | |
Name | String | Campaign name. | |
ObjectiveType | String | Campaign objective type. | |
OrderLineId | String | Order line ID that appears on the invoice. | |
Status | String | Entity status.
使用できる値は次のとおりです。ACTIVE, PAUSED, ARCHIVED | |
TrackingUrlsAudienceVerification | String | Tracking Urls Audience Verification. | |
TrackingUrlsBuyableButton | String | Tracking Urls Buyable Button. | |
TrackingUrlsClick | String | Tracking Urls Click. | |
TrackingUrlsEngagement | String | Tracking Urls Engagement | |
TrackingUrlsImpression | String | Tracking Urls Impression. | |
Type | String | Type of campaign. | |
UpdatedTime | Datetime | Last update time. |
Get a Pin owned by the owned by the User or on a group board that has been shared with this account
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.
SELECT * FROM Pins WHERE Id = '3457832451' SELECT * FROM Pins WHERE BoardId = '3457832451'
Name | Type | References | Description |
Id [KEY] | String | Id of the Pin | |
BoardId | String |
Boards.Id | Id of the Board |
SectionId | String | Id of the Section | |
AltText | String | AltText | |
BoardOwnerUsername | String | UserName of the BoardOwner. | |
CreatedAt | Datetime | Created At Date Time | |
Description | String | Description of the Pin. | |
Link | String | Link to the Pin. | |
MediaType | String | MediaType of the Pin. | |
Media | String | Media for the Pin. | |
Title | String | Title of the Pin. |
Get a list of the age bucket which are available inside the targets.
Name | Type | References | Description |
AgeBucketKey | String | It contains the key of the age bucket. | |
AgeBucketValue | String | It contains the value of the age bucket. |
Get a list of the app type which are available inside the targets.
Name | Type | References | Description |
AppKey | String | It contains the key of the apptype. | |
AppValue | String | It contains the value of the apptype. |
Get a list of the gender which are available inside the targets.
Name | Type | References | Description |
GenderKey | String | It contains the key of the gender. | |
GenderValue | String | It contains the value of the gender. |
Get a list of the geo which are available inside the targets.
Name | Type | References | Description |
GeoKey | String | It contains the key of the Geo. | |
GeoValue | String | It contains the value of the Geo. |
Get a list of the interest which are available inside the targets.
Name | Type | References | Description |
InterestId | String | It contains the id of the interest. | |
InterestLevel | String | It contains the level of the interest. | |
InterestName | String | It contains the name of the interest. | |
InterestAggregate | String | It contains the data inside the particular level of the interest. |
Get a list of the locale which are available inside the targets.
Name | Type | References | Description |
LocaleKey | String | It contains the key of the locale | |
LocaleValue | String | It contains the value of the locale |
Get a list of the location which are available inside the targets.
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
Name | Type | References | Description |
LocationKey | String | It contains the key of the Location | |
LocationValue | String | It contains the value of the Location |
Get account information for the operation User Account
No filters are supported server side for this table. All criteria will be handled client side within the Sync App.
Name | Type | References | Description |
AccountType | String | Type of account. | |
ProfileImage | String | Profile Image. | |
Username | String | Username. | |
WebsiteURL | String | Website URL. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
AdAccountID | String | Specify an ad_account_id to use the owner of that ad_account as the operation user_account. |
Get Daily Metric of User Account
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.
SELECT * FROM UserAccountDailyMetrics WHERE AppTypes = 'MOBILE'
Name | Type | References | Description |
OutboundClick | Integer | Total outbound click. | |
OutboundClickRate | Decimal | Outbound Click Rate. | |
Engagement | Integer | Total engagements. | |
EngagementRate | Decimal | Engagement Rate. | |
PinClick | Integer | Total pin clicks. | |
PinClickRate | Decimal | Pin Click Rate. | |
Impression | Integer | Total impressions. | |
Save | Integer | Total saves. | |
SaveRate | Decimal | Save Rate. | |
DataStatus | String | Metrics Availablity. | |
Date | Date | Metrics Date. | |
StartDate | Date | Metric report start date. | |
EndDate | Date | Metric report end date. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
FromClaimedContent | String | Filter on Pins that match your claimed domain.
使用できる値は次のとおりです。OTHER, CLAIMED, BOTH デフォルト値はBOTHです。 | |
PinFormat | String | Pin formats to get data for, default is all.
使用できる値は次のとおりです。ALL, PRODUCT, REGULAR, VIDEO デフォルト値はALLです。 | |
AppTypes | String | Apps or devices to get data for, default is all.
使用できる値は次のとおりです。ALL, MOBILE, TABLET, WEB デフォルト値はALLです。 | |
MetricTypes | String | Metric types to get data for, default is all.
使用できる値は次のとおりです。ENGAGEMENT, ENGAGEMENT_RATE, IMPRESSION, OUTBOUND_CLICK, OUTBOUND_CLICK_RATE, PIN_CLICK, PIN_CLICK_RATE, SAVE, SAVE_RATE, ALL デフォルト値はALLです。 | |
SplitField | String | How to split the data into groups. Not including this param means data won't be split.
使用できる値は次のとおりです。NO_SPLIT, APP_TYPE, CONTENT_TYPE, OWNED_CONTENT, SOURCE, PIN_FORMAT, CONVERSION_TYPE, ATTRIBUTION_EVENT デフォルト値はNO_SPLITです。 | |
AdAccountID | String | Unique identifier of an ad account. |
Get Summary Metric of User Account
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.
SELECT * FROM UserAccountSummaryMetrics WHERE AppTypes = 'MOBILE'
Name | Type | References | Description |
OutboundClick | Integer | Total outbound click. | |
OutboundClickRate | Decimal | Outbound Click Rate. | |
Engagement | Integer | Total engagements. | |
EngagementRate | Decimal | Engagement Rate. | |
PinClick | Integer | Total pin clicks. | |
PinClickRate | Decimal | Pin Click Rate. | |
Impression | Integer | Total impressions. | |
Save | Integer | Total saves. | |
SaveRate | Decimal | Save Rate. | |
StartDate | Date | Metric report start date. | |
EndDate | Date | Metric report end date. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
FromClaimedContent | String | Filter on Pins that match your claimed domain.
使用できる値は次のとおりです。OTHER, CLAIMED, BOTH デフォルト値はBOTHです。 | |
PinFormat | String | Pin formats to get data for, default is all.
使用できる値は次のとおりです。ALL, PRODUCT, REGULAR, VIDEO デフォルト値はALLです。 | |
AppTypes | String | Apps or devices to get data for, default is all.
使用できる値は次のとおりです。ALL, MOBILE, TABLET, WEB デフォルト値はALLです。 | |
MetricTypes | String | Metric types to get data for, default is all.
使用できる値は次のとおりです。ENGAGEMENT, ENGAGEMENT_RATE, IMPRESSION, OUTBOUND_CLICK, OUTBOUND_CLICK_RATE, PIN_CLICK, PIN_CLICK_RATE, SAVE, SAVE_RATE, ALL デフォルト値はALLです。 | |
SplitField | String | How to split the data into groups. Not including this param means data won't be split.
使用できる値は次のとおりです。NO_SPLIT, APP_TYPE, CONTENT_TYPE, OWNED_CONTENT, SOURCE, PIN_FORMAT, CONVERSION_TYPE, ATTRIBUTION_EVENT デフォルト値はNO_SPLITです。 | |
AdAccountID | String | Unique identifier of an ad account. |
プロパティ | 説明 |
AdAccountId | Unique identifier of an Ad Account. |
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
プロパティ | 説明 |
LogModules | ログファイルに含めるコアモジュール。 |
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
プロパティ | 説明 |
MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。
プロパティ | 説明 |
AdAccountId | Unique identifier of an Ad Account. |
Unique identifier of an Ad Account.
Driver will use this Account where required. If not fed, it will pick the first Ad Account configured for the Account.
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
説明 | 例 |
フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロキシベースのファイアウォールで使われるプロトコル。
このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
タイプ | デフォルトポート | 説明 |
TUNNEL | 80 | これが設定されている場合、Sync App はPinterest への接続を開き、プロキシを経由して通信が行われます。 |
SOCKS4 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。 |
SOCKS5 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
プロキシベースのファイアウォールの名前もしくはIP アドレス。
ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。
Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。
プロキシベースのファイアウォールのTCP ポート。
ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。
プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。
プロキシベースのファイアウォールへの認証に使われるパスワード。
このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。
SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。
ProxyServer プロキシが起動しているTCP ポート。
HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer プロキシへの認証で使われる認証タイプ。
この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。
Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
認証タイプは、次のどれかになります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer プロキシへの認証に使われるユーザー名。
ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。
ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。
user@domain domain\user
ProxyServer プロキシへの認証に使われるパスワード。
このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。
HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。
NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。
ProxyServer プロキシへの接続時に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。
AUTO | デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。 |
ALWAYS | 接続は、常にSSL 有効となります。 |
NEVER | 接続は、SSL 有効になりません。 |
TUNNEL | 接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
ログファイルに含めるコアモジュール。
指定された(';' で区切られた)モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル(テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル)を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\Pinterest Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます:
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{ "MyView": { "query": "SELECT * FROM AdAccounts WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"