CData Sync App は、Salesforce Marketing Cloud Account Engagement データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Salesforce Marketing Cloud Account Engagement コネクタはCData Sync アプリケーションから使用可能で、Salesforce Marketing Cloud Account Engagement からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App はSalesforce Marketing Cloud Account Engagement API を使用して、Salesforce Marketing Cloud Account Engagement への双方向アクセスを実現します。Marketing Cloud Account Engagement API v3、v4、およびv5 をサポートしています。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
Pardot ビジネスユニットID は「0Uv」で始まる18 文字です。Pardot アカウント設定情報にアクセスできない場合は、Salesforce 管理者に問い合わせてPardot ビジネスユニットID を入手してください。
AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。
認証に関する2つの方法の違いは、カスタムOAuth アプリケーションを使用する場合に、2つの接続プロパティを追加で設定する必要があることだけです。
次の接続プロパティを設定して、接続してください。
初めに、次の接続プロパティを設定してOAuthAccessToken を取得します。
続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。
アクセストークンとリフレッシュトークンを取得した後、データに接続し、OAuth アクセストークンを自動または手動でリフレッシュすることが可能です。
OAuth アクセストークンの自動リフレッシュ
ドライバーがOAuth アクセストークンを自動的にリフレッシュするようにするには、最初のデータ接続で次のように設定します。
OAuth アクセストークンの手動リフレッシュ
データ接続時に手動でOAuth アクセストークンをリフレッシュするために必要な値は、OAuth リフレッシュトークンのみです。
GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後に、RefreshOAuthAccessToken ストアドプロシージャを使用し、手動でOAuthAccessToken をリフレッシュします。次の接続プロパティを設定します。
次に、RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを指定します。新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定し、新しい接続をオープンします。
最後に、OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。
オプション1:Verifier code を取得および交換
Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。
インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。
ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。
OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットする必要があります。
オプション2:OAuth 設定を転送
ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバとの接続をインストールし、作成する必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。
「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。
接続テストに成功したら、OAuth 設定ファイルをヘッドレスマシンにコピーします。
ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。
ユーザー名とパスワードで認証する場合は、以下の接続プロパティを設定します。
AuthScheme をOAuthJWT に設定します。
OAuth アプリケーション(カスタムOAuth アプリケーションの作成 参照)作成後、次の接続プロパティを設定します。
Note:このフローではリフレッシュトークンは発行されません。
このセクションでは、Salesforce Marketing Cloud Account Engagement Sync App の高度な機能を厳選して説明します。
Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
詳しくは、クエリ処理 を参照してください。
デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
このセクションでは、利用可能なAPI オブジェクトを示し、Salesforce Marketing Cloud Account Engagement API へのSQL の実行について詳しく説明します。
CData Sync App は、Salesforce Marketing Cloud Account Engagement エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。 このセクションでは、API の制限および要件について説明します。既定の SupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。
Sync App はSalesforce Marketing Cloud Account Engagement のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| Campaigns | Retrieve and modify campaigns. |
| CustomFields | Retrieve and modify custom fields. |
| ListMemberships | Retrieve and modify list memberships. |
| Lists | Retrieve and modify lists. |
| Opportunities | Retrieve and modify opportunities. |
| ProspectAccounts | Retrieve and modify prospect accounts. |
| Prospects | Retrieve and modify prospects. |
Retrieve and modify campaigns.
The Sync App will use the Salesforce Marketing Cloud Account Engagement 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.
For example, the following queries are processed server side:
SELECT * FROM Campaigns WHERE Id = 43 SELECT * FROM Campaigns WHERE Name = 'Website Tracking'
This table does not have any required attributes when performing an insert.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
Pardot ID for this campaign. | |
| Name | String | False |
Campaign's name. | |
| Cost | Integer | False |
Cost associated to the campaign. | |
| CrmFId | String | True |
The CRM FID associated to the campaign. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| CreatedAt | Datetime |
Filter by the creation time. |
| UpdatedAt | Datetime |
Filter by the modification time. |
Retrieve and modify custom fields.
The Sync App will use the Salesforce Marketing Cloud Account Engagement 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.
For example, the following queries are processed server side:
SELECT * FROM CustomFields WHERE Id = 50 SELECT * FROM CustomFields WHERE CreatedAt > '01/01/2019'
The following attributes are required when performing an insert: FieldId, Name.
INSERT INTO CustomFields (FieldId, Name) VALUES (100, 'Example')
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
Pardot ID for this custom field. | |
| Name | String | False |
Custom field's name. | |
| FieldId | String | True |
API ID for custom field. | |
| Type | String | False |
type of field. | |
| TypeId | Int64 | True |
Pardot ID for custom field's type. | |
| CreatedAt | Datetime | True |
Time custom field was created in Pardot. | |
| UpdatedAt | Datetime | True |
Last time custom field was updated. | |
| IsRecordMultipleResponses | Boolean | False |
If true, this custom field will record multiple responses. | |
| CrmId | String | False |
The CRM ID of the field you would like to map to this custom field. | |
| IsUseValues | Boolean | False |
If true, this custom field will use predefined values. |
Retrieve and modify list memberships.
The Sync App will use the Salesforce Marketing Cloud Account Engagement 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.
For example, the following queries are processed server side:
SELECT * FROM ListMemberships WHERE Id = 26 SELECT * FROM ListMemberships WHERE ListId = 44 SELECT * FROM ListMemberships WHERE CreatedAt > '01/01/2019'
The following attributes are required when performing an insert: ListId, ProspectId.
INSERT INTO ListMemberships (ListId, ProspectId) VALUES (20104, 3457990)
To retrieve deleted records, a GETDELETED statement can be executed.
The GETDELETED statement supports the same server side filters that are supported by the SELECT statement (except ID when using the equality(=) operator), but does not perform any client side filtering.
GETDELETED FROM ListMemberships WHERE ID = 231
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
Pardot ID for this list membership. | |
| ListId | Int64 | True |
Lists.Id |
Pardot ID of the list for this membership. |
| ProspectId | Int64 | True |
Prospects.Id |
Pardot ID of the prospect for this membership. |
| OptedOut | Integer | False |
If value is 1, the prospect is unsubscribed from receiving emails from this list. | |
| CreatedAt | Datetime | True |
Time that this membership was created in Pardot. | |
| UpdatedAt | Datetime | True |
Last time that this membership was updated. |
Retrieve and modify lists.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
Pardot ID of this list. | |
| Name | String | False |
List's name (internal to Pardot). | |
| IsPublic | Boolean | False |
If true, list will show on EPC pages to prospects. | |
| IsDynamic | Boolean | True |
If true, list has prospects dynamically added to it via a set of chosen rules. | |
| Title | String | False |
List's title (visible to subscribers). | |
| Description | String | False |
List's description. | |
| IsCrmVisible | Boolean | False |
If true, list will be visible in CRM to add or remove from. | |
| CreatedAt | Datetime | True |
Time list was created in Pardot. | |
| UpdatedAt | Datetime | True |
Last time list was updated. |
Retrieve and modify opportunities.
The Sync App will use the Salesforce Marketing Cloud Account Engagement 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.
For example, the following queries are processed server side:
SELECT * FROM Opportunities WHERE Id = 14 SELECT * FROM Opportunities WHERE ProspectId = 34 SELECT * FROM Opportunities WHERE ProspectEmail = '[email protected]'
The following attributes are required when performing an insert: CampaignId, Name, Value, Probability, ProspectEmail, ProspectId.
INSERT INTO Opportunities (CampaignId, Name, Value, Probability, ProspectEmail, ProspectId) VALUES (1, 'Example', 3, 75, '[email protected]', 2)
Note: This table cannot be updated if a Salesforce connector is present.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
Pardot ID for this opportunity. | |
| CampaignId | Int64 | False |
Campaigns.Id |
Pardot ID of the campaign associated with this opportunity Note: Information about an opportunity's campaign association is returned in a campaign node in the XML response. However, updates to campaign associations are done by providing campaign_id during an UPDATE> request. See XML Response Formats in Using Opportunities for more details. |
| Name | String | False |
Opportunity's name. | |
| Value | Double | False |
Opportunity's value Restrictions: value must be a positive numeric value. | |
| Probability | Integer | False |
Opportunity's probability Restrictions: value must be a positive numeric value between 0 and 100 inclusive. | |
| Type | String | False |
Opportunity's type. | |
| Stage | String | False |
Opportunity's stage. | |
| Status | String | False |
Opportunity's status Restrictions: status must be either won, lost, or open. | |
| ClosedAt | Datetime | False |
Opportunity's closed date Note: if this is left blank, the closed_at datetime (Closed Date within the app) will not be set, even when the Opportunity's stage, status or probability are set to indicate opportunity closure. | |
| CreatedAt | Datetime | True |
Time opportunity was created in Pardot. | |
| UpdatedAt | Datetime | True |
Last time opportunity was updated in Pardot. | |
| ProspectEmail | String | False |
Email of the prospect. | |
| ProspectId | Int64 | False |
Id of the prospect. |
Retrieve and modify prospect accounts.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
Pardot ID of the prospect account. | |
| CreatedAt | Datetime | False |
Filter by the creation time. | |
| UpdatedAt | Datetime | False |
Filter by the modification time. |
Retrieve and modify prospects.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Int63 | True |
Pardot ID for this prospect. | |
| CampaignId | Int63 | False |
Campaigns.Id |
Pardot ID of the campaign associated with this prospect Note: Information about a prospect's campaign association is returned in a campaign node in the XML response. However, updates to campaign associations are done by providing campaign_id during an UPDATE> request. See XML Response Formats in Using Prospects for more details. |
| Salutation | String | False |
Prospect's formal prefix. | |
| FirstName | String | False |
Prospect's first name. | |
| LastName | String | False |
Prospect's last name. | |
| String | False |
Prospect's email address. | ||
| Password | String | False |
Prospect's password. | |
| Company | String | False |
Prospect's company. | |
| ProspectAccountId | Int63 | False |
Prospect's account ID. | |
| Website | String | False |
Prospect's website URL. | |
| JobTitle | String | False |
Prospect's job title. | |
| Department | String | False |
Prospect's department. | |
| Country | String | False |
Prospect's country. | |
| AddressOne | String | False |
Prospect's address, line 1. | |
| AddressTwo | String | False |
Prospect's address, line 2. | |
| City | String | False |
Prospect's city. | |
| State | String | False |
Prospect's US state. | |
| Territory | String | False |
Prospect's territory. | |
| Zip | String | False |
Prospect's postal code. | |
| Phone | String | False |
Prospect's phone number. | |
| Fax | String | False |
Prospect's fax number. | |
| Source | String | False |
Prospect's source. | |
| AnnualRevenue | String | False |
Prospect's annual revenue. | |
| Employees | String | False |
Prospect's number of employees. | |
| Industry | String | False |
Prospect's industry. | |
| YearsInBusiness | String | False |
Prospect's number of years in business. | |
| Comments | String | False |
Comments about this prospect. | |
| Notes | String | False |
Notes about this prospect. | |
| Score | Integer | False |
Prospect's score. | |
| Grade | String | True |
Prospect's letter grade. | |
| LastActivityAt | Datetime | True |
Time stamp of this prospect's latest visitor activity. | |
| RecentInteraction | String | True |
Describes the prospect's most recent interaction with Pardot. | |
| CrmLeadFid | String | True |
Prospect's lead ID in a supported CRM system. | |
| CrmContactFid | String | True |
Prospect's contact ID in a supported CRM system. | |
| CrmOwnerFid | String | True |
Prospect's owner ID in a supported CRM system. | |
| CrmAccountFid | String | True |
Account ID in a supported CRM system. | |
| CrmLastSync | Datetime | True |
Last time this prospect was synced with a supported CRM system. | |
| CrmUrl | String | True |
URL to view the prospect within the CRM system. | |
| IsDoNotEmail | Boolean | False |
If value is 1, prospect prefers not to be emailed. | |
| IsDoNotCall | Boolean | False |
If value is 1, prospect prefers not to be called. | |
| OptedOut | Boolean | True |
If value is 1, prospect has opted out of marketing communications. | |
| IsReviewed | Boolean | False |
If value is 1, prospect has been reviewed. | |
| IsStarred | Boolean | False |
If value is 1, prospect has been starred. | |
| CreatedAt | Datetime | True |
Time prospect was created in Pardot. | |
| UpdatedAt | Datetime | True |
Last time prospect was updated in Pardot. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| Account | Retrieve account info. |
| CustomRedirects | Retrieve and modify custom redirects. |
| DynamicContents | Retrieve dynamic contents. |
| EmailClicks | Retrieve email clicks. |
| Emails | Retrieve emails. |
| EmailStats | Retrieve email stats. |
| EmailTemplates | Retrieve email templates. |
| Forms | Retrieve forms. |
| LifecycleHistories | Retrieve lifecycle histories. |
| LifecycleStages | Retrieve lifecycle stages. |
| OneToOneEmails | Retrieve one to one emails. |
| TagObjects | Retrieve tag objects. |
| Tags | Retrieve tags. |
| Users | Retrieve users. |
| VisitorActivities | Retrieve visitor activities. |
| Visitors | Retrieve visitors. |
| VisitorsPageViews | Retrieve visitors page views. |
| Visits | Retrieve visits. |
Retrieve account info.
The Sync App will process all filters client side.
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this account. | |
| Level | String | The level of product for the account. | |
| Website | String | Account website. | |
| VanityDomain | String | Custom vanity domain name. | |
| PluginCampaignId | Int64 | Plugin ID for account campaign. | |
| TrackingCodeTemplate | String | Markup and code for use in tracking templates. | |
| Address1 | String | Account contact address, line 1. | |
| Address2 | String | Account contact address, line 2. | |
| City | String | Account contact city. | |
| State | String | Account contact state. | |
| Territory | String | Account contact territory. | |
| Zip | String | Account contact zip code. | |
| Country | String | Account contact country. | |
| Phone | String | Account contact phone number. | |
| Fax | String | Account contact fax number. |
Retrieve and modify custom redirects.
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this custom redirect. | |
| Name | String | Custom redirect's name. | |
| Url | String | URL for the custom redirect. | |
| Destination | String | URL the custom redirect leads to. | |
| CampaignId | Int64 |
Campaigns.Id | The campaign associated with this custom redirect. |
| CampaignName | String |
Campaigns.Name | The campaign associated with this custom redirect. |
| CreatedAt | Datetime | Time custom redirect was created in Pardot. | |
| UpdatedAt | Datetime | Last time custom redirect was updated. |
Retrieve dynamic contents.
The Sync App will use the Salesforce Marketing Cloud Account Engagement 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.
For example, the following queries are processed server side:
SELECT * FROM DynamicContents WHERE Id = 32 SELECT * FROM DynamicContents WHERE CreatedAt > '02/03/2019 23:11:33' SELECT * FROM DynamicContents WHERE UpdatedAt > '01/03/2018 23:11:33' AND UpdatedAt <= '02/03/2019 23:11:33'
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this dynamic content. | |
| Name | String | Dynamic content's name. | |
| EmbedCode | String | Code to embed this dynamic content onto your webpage. | |
| EmbedUrl | String | URL to embed this dynamic content. | |
| BaseContent | String | The default dynamic content. | |
| BasedOn | String | Field that this dynamic content is based on. | |
| Variation | String | The variation of content prospect will see based on the field's value Note: Information about a variation is returned in a variation node in the XML response. It contains the value of the field in the comparison tag and the content of the variation in the content tag. | |
| CreatedAt | Datetime | Time dynamic content was created in Pardot. | |
| UpdatedAt | Datetime | Last time dynamic content was updated. |
Retrieve email clicks.
The Sync App will use the Salesforce Marketing Cloud Account Engagement 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.
For example, the following queries are processed server side:
SELECT * FROM EmailClicks WHERE ListEmailId = 20 SELECT * FROM EmailClicks WHERE DripProgramActionId = 42 SELECT * FROM EmailClicks WHERE EmailTemplateId = 26 AND TrackerRedirectId = 31 AND CreatedAt > '02/03/2019 23:11:33'
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this email click. | |
| ProspectId | Int64 |
Prospects.Id | Pardot ID for the associated prospect. |
| Url | String | URL of the email click. | |
| ListEmailId | Int64 | Pardot ID for the associated list email. Value not present if null. | |
| DripProgramActionId | Integer | Pardot ID for the associated drip program action. Value not present if null. | |
| EmailTemplateId | Int64 | Pardot ID for the associated email template. Value not present if null. | |
| TrackerRedirectId | Int64 | Pardot ID for the associated tracker redirect. Value not present if null. | |
| CreatedAt | Datetime | Time that email click occurred. |
Retrieve emails.
The Sync App will use the Salesforce Marketing Cloud Account Engagement 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.
For example, the following query is processed server side:
SELECT * FROM Emails WHERE Id = 10
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this email. | |
| Name | String | Name of this email. | |
| Subject | String | Email Subject. | |
| Message | String | Contains the text of email. | |
| HTMLContent | String | Contains text and html elements of different formats. | |
| CreatedAt | Datetime | Time the Email Was Created. |
Retrieve email stats.
The Sync App will use the Salesforce Marketing Cloud Account Engagement API to process WHERE clause conditions built with the following column and operator. To query this table, you need to specify the Id. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM EmailStats WHERE Id = 10
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this email. | |
| Sent | Integer | Sent status. | |
| Delivered | Integer | Delivered status. | |
| TotalClicks | Integer | Total clicks. | |
| UniqueClicks | Integer | Unique clicks. | |
| SoftBounced | Integer | Soft bounces. | |
| HardBounced | Integer | Hard bounces. | |
| OptOuts | Integer | Opt count. | |
| SpamComplains | Integer | Spam complains. | |
| Opens | Integer | Opens. | |
| UniqueOpens | Integer | Unique opens. | |
| DeliveryRate | String | Delivery rate. | |
| OpensRate | String | Open rate. | |
| ClickThroughRate | String | Click through rate. | |
| UniqueClickThroughRate | String | Unique click through rate. | |
| ClickOpenRatio | String | Click to open ration. | |
| OptOutrate | String | Opt rate. | |
| SpamComplaintRate | String | Spam complaint rate. |
Retrieve email templates.
The Sync App will use the Salesforce Marketing Cloud Account Engagement 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.
For example, the following queries are processed server side:
SELECT * FROM EmailTemplates WHERE Id = 22
| Name | Type | References | Description |
| Id | Int64 | Identifier. | |
| EmailType | Integer | Email type. | |
| Error | Integer | Error. | |
| HtmlMessage | String | Html content. | |
| IsAutoResponderEmail | Integer | Whether it is an auto responder email. | |
| IsDripEmail | Integer | Whether it is a drip email. | |
| IsListEmail | Integer | Whether it is a lsit email. | |
| IsOneToOneEmail | Integer | Whether it is a one to one email. | |
| Name | String | Name | |
| SendOptionsReplyToAddressAggregate | String | Reply to addresses. | |
| SendOptionsSendFromDataAggregate | String | Send from information. | |
| Subject | String | Email subject. | |
| TextMessage | String | Email text. | |
| TrackedHtmlMessage | String | Tracked html message. | |
| TrackedTextMessage | String | Tracked text message. | |
| Type | Integer | Email type. |
Retrieve forms.
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this form. | |
| Name | String | Form's name. | |
| CampaignId | Int64 |
Campaigns.Id | Pardot ID of the campaign associated with this form. |
| EmbedCode | String | The code used to embed the form on your webpage. | |
| CreatedAt | Datetime | Time form was created in Pardot. | |
| UpdatedAt | Datetime | Last time form was updated. |
Retrieve lifecycle histories.
The Sync App will use the Salesforce Marketing Cloud Account Engagement 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.
For example, the following queries are processed server side:
SELECT * FROM LifecycleHistories WHERE Id = 49 SELECT * FROM LifecycleHistories WHERE Id >= 44 SELECT * FROM LifecycleHistories WHERE CreatedAt <= '02/03/2019 23:11:33'
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID of this lifecycle history. | |
| ProspectId | Int64 |
Prospects.Id | Pardot's ID for the prospect in this stage. |
| PreviousStageId | Int64 | Pardot ID of the stage this prospect was previously in. | |
| NextStageId | Int64 | Pardot ID of the stage this prospect will be in next. | |
| SecondsElapsed | Integer | Number of seconds for prospect to get to current stage. | |
| CreatedAt | Datetime | Time lifecycle history was created in Pardot. |
Retrieve lifecycle stages.
The Sync App will use the Salesforce Marketing Cloud Account Engagement 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.
For example, the following queries are processed server side:
SELECT * FROM LifecycleStages WHERE Id = 18
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID of this lifecycle stage. | |
| Name | String | Lifecycle stage's name. | |
| Position | Integer | Lifcycle stage's position in lifecycle. | |
| IsLocked | Boolean | If true, lifecycle stage is locked. |
Retrieve one to one emails.
The Sync App will use the Salesforce Marketing Cloud Account Engagement 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.
For example, the following queries are processed server side:
SELECT * FROM OneToOneEmails WHERE Id = 11
| Name | Type | References | Description |
| Id [KEY] | Int64 | Identifier. | |
| EmailType | Integer | Email type. | |
| IsAutoResponderEmail | Integer | Whether it is an auto responder email. | |
| IsDripEmail | Integer | Where it is a drip email. | |
| IsListEmail | Integer | Whether it is a list email. | |
| IsOneToOneEmail | Integer | Whether it is a one to one email. | |
| Name | String | Name. | |
| Subject | String | Email subject. | |
| Type | Integer | Email type. |
Retrieve tag objects.
The Sync App will use the Salesforce Marketing Cloud Account Engagement 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.
For example, the following queries are processed server side:
SELECT * FROM TagObjects WHERE Id <= 31 SELECT * FROM TagObjects WHERE TagId = 12 SELECT * FROM TagObjects WHERE CreatedAt <= '02/03/2019 23:11:33'
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID of the tag object. | |
| TagId | Int64 |
Tags.Id | The Pardot ID of the tag. |
| Type | String | The type of object associated with the tag. | |
| ObjectId | Int64 | The Pardot ID of the object. | |
| CreatedAt | Datetime | Time tag was associated with the object in Pardot. |
Retrieve tags.
The Sync App will use the Salesforce Marketing Cloud Account Engagement 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.
For example, the following queries are processed server side:
SELECT * FROM Tags WHERE Id >= 42 SELECT * FROM Tags WHERE Name = 'criteria' SELECT * FROM Tags WHERE CreatedAt >= '02/03/2019 23:11:33'
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this tag. | |
| Name | String | Tag's name. | |
| CreatedAt | Datetime | Time tag was created in Pardot. | |
| UpdatedAt | Datetime | Last time tag was updated. |
Retrieve users.
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID of the user. | |
| String | User's email address. | ||
| FirstName | String | User's first name. | |
| LastName | String | User's last name. | |
| JobTitle | String | User's job title. | |
| Role | String | User's role. | |
| CreatedAt | Datetime | Time user was created in Pardot; Time is reported in the API user's preferred timezone. | |
| UpdatedAt | Datetime | Last time user was updated in Pardot; Time is reported in the API user's preferred timezone. |
Retrieve visitor activities.
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this visitor activity. | |
| ProspectId | Int64 |
Prospects.Id | Pardot ID for the associated prospect. |
| VisitorId | Int64 |
Visitors.Id | Pardot ID for the associated visitor. |
| Type | Integer | Visitor activity's type number; See listing below. | |
| TypeName | String | Visitor activity's type name; See listing below. | |
| Details | String | Details about this visitor activity such as the name of the object associated with this activity, the search phrase used in a site search query, etc. | |
| EmailId | Int64 |
Emails.Id | Pardot ID of the email associated with this visitor activity Note: This node will only appear if this visitor activity has an email associated with it. |
| EmailTemplateId | Int64 | Pardot ID of the email template associated with this visitor activity Note: This node will only appear if this visitor activity has an email associated with it. | |
| ListEmailId | Int64 | Pardot ID of the list email associated with this visitor activity Note: This node will only appear if this visitor activity has an email associated with it. | |
| FormId | Int64 |
Forms.Id | Pardot ID of the form associated with this visitor activity Note: This node will only appear if this visitor activity has a form associated with it. |
| FormHandlerId | Int64 | Pardot ID of the form handler associated with this visitor activity Note: This node will only appear if this visitor activity has a form handler associated with it. | |
| SiteSearchQueryId | Int64 | Pardot ID of the site search query associated with this visitor activity Note: This node will only appear if this visitor activity has a site search query associated with it. | |
| LandingPageId | Int64 | Pardot ID of the landing page associated with this visitor activity Note: This node will only appear if this visitor activity has a landing page associated with it. | |
| PaidSearchIdId | Int64 | Pardot ID of the paid search ad associated with this visitor activity Note: This node will only appear if this visitor activity has a paid search ad associated with it. | |
| MultivariateTestVariationId | Int64 | Pardot ID of the multivariate test variation associated with this visitor activity Note: This node will only appear if this visitor activity has a multivariate test variation associated with it. | |
| VisitorPageViewId | Int64 | Pardot ID of the visitor page view associated with this visitor activity Note: This node will only appear if this visitor activity has a visitor page view associated with it. | |
| FileId | Int64 | Pardot ID of the file associated with this visitor activity Note: This node will only appear if this visitor activity has a file associated with it. | |
| CampaignId | Int64 |
Campaigns.Id | Campaign id. |
| CampaignName | String | Campaign name. | |
| CampaignCost | Integer | Campaign cost. | |
| CreatedAt | Datetime | Time that visitor activity occurred. |
Retrieve visitors.
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this visitor. | |
| PageViewCount | Integer | Number of page views by this visitor. | |
| IpAddress | String | Visitor's IP address. | |
| Hostname | String | Visitor's hostname. | |
| CampaignParameter | String | Visitor's campaign parameter utm_campaign from Google Analytics. | |
| MediumParameter | String | Visitor's medium parameter utm_medium from Google Analytics. | |
| SourceParameter | String | Visitor's source parameter utm_source from Google Analytics. | |
| ContentParameter | String | Visitor's content parameter utm_content from Google Analytics. | |
| TermParameter | String | Visitor's term parameter utm_term from Google Analytics. | |
| CreatedAt | Datetime | Time visitor was created in Pardot. | |
| UpdatedAt | Datetime | Last time visitor was updated in Pardot. | |
| ProspectId | Int64 | Selects visits with the given Prospect IDs. |
Retrieve visitors page views.
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this visitor page view. | |
| VisitId | Int64 |
Visits.Id | Pardot ID for this visit. |
| VisitorId | Int64 |
Visitors.Id | Pardot ID for the associated visitor. |
| ProspectId | Int64 |
Prospects.Id | Pardot ID for the associated prospect. |
| Url | String | The Url of the page. | |
| Title | String | The Title column of the VisitorsPageViews object. | |
| CreatedAt | Datetime | The CreatedAt column of the VisitorsPageViews object. |
Retrieve visits.
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this visit. | |
| VisitorId | Int64 |
Visitors.Id | Pardot ID for the associated visitor. |
| ProspectId | Int64 |
Prospects.Id | Pardot ID for the associated prospect. |
| VisitorPageViewCount | Integer | Number of page views for this visit. | |
| FirstVisitorPageViewAt | Datetime | Time of first page view for this visit. | |
| LastVisitorPageViewAt | Datetime | Time of last page view for this visit. | |
| DurationInSeconds | Integer | Length of this visit. | |
| CampaignParameter | String | Visit's campaign parameter utm_campaign from Google Analytics. | |
| MediumParameter | String | Visit's medium parameter utm_medium from Google Analytics. | |
| SourceParameter | String | Visit's source parameter utm_source from Google Analytics. | |
| ContentParameter | String | Visit's content parameter utm_content from Google Analytics. | |
| TermParameter | String | Visit's term parameter utm_term from Google Analytics. | |
| CreatedAt | Datetime | Time visit was created in Pardot. | |
| UpdatedAt | Datetime | Last time visit was updated in Pardot. |
CData Sync App は、Salesforce Marketing Cloud Account Engagement Pardot API v5 オブジェクトをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。 このセクションでは、API の制限および要件について説明します。既定の SupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。
テーブル では、利用可能な標準テーブルの例について説明します。
Sync App はSalesforce Marketing Cloud Account Engagement のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| CustomRedirects | Track links on your website or third-party site with Pardot custom redirects. |
| DynamicContent | Retrieve a collection of dynamic content |
| EmailTemplates | Query email templates. |
| Files | Upload images and other files to use in your Pardot emails, forms, and landing pages. |
| FormHandlers | Retrieve,Create,Updata,Delete a collection of Form Handlers |
| FormHandlersFields | Retrieve,Create,Update,Delete a collection of Form Handler Stages |
| LayoutTemplates | Retrieve and modify layout templates. |
| ListMemberships | Retrieve,Create,Update,Delete a collection of list memberships |
| Lists | Retrieve and modify lists. |
| Prospects | Retrieve and modify prospects. |
Track links on your website or third-party site with Pardot custom redirects.
Sync App はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM CustomRedirects WHERE Id = 40 SELECT * FROM CustomRedirects WHERE IsDeleted = 'true'
挿入を実行する際は、次の属性が必須です:Name、CampaignId、DestinationUrl。
INSERT INTO CustomRedirects (Name, CampaignId, DestinationUrl) VALUES ('name', '1', 'https://example.com/content.html')
CustomRedirects 属性を更新します。
UPDATE CustomRedirects SET Name = 'newName', FolderId = '527425' WHERE Id = 24143
すべてのCustomRedirects オブジェクト、またはCustomRedirect ID を指定することで1つのオブジェクトを削除します。
DELETE FROM CustomRedirects WHERE Id = 10003
Pardot のごみ箱にあるカスタムリダイレクトを取得する場合、次の操作がサポートされています。
GETDELETED FROM CustomRedirects
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
Pardot ID for this campaign. | |
| Name | String | False |
Name of the object for identification in Pardot. | |
| CampaignId | Int64 | False |
Pardot Campaign related to this object. | |
| DestinationUrl | String | False |
A fully qualified URL. The visitor who clicks the custom redirect is directed to this location. | |
| FolderId | Int64 | False |
ID of the folder containing this object. Uses the asset type's uncategorized folder if not specified on create. | |
| TrackerDomainId | Int64 | False |
ID of the tracker domain to use in the URL for this object. Uses the primary tracker domain for the account if not specified on create. | |
| VanityUrl | String | True |
Fully qualified vanity URL. Includes tracker domain and vanityUrlPath. | |
| VanityUrlPath | String | False |
Vanity URL path (excluding protocol and host). Must be unique for each tracker domain. | |
| GASource | String | False |
Google Analytics Campaign source. | |
| GAMedium | String | False |
Google Analytics Campaign medium. | |
| GATerm | String | False |
Google Analytics Campaign keyword. | |
| GAContent | String | False |
Google Analytics Campaign content. | |
| GACampaign | String | False |
Google Analytics Campaign ID. | |
| SalesforceId | String | True |
ID of the Salesforce object representing this object. | |
| TrackedUrl | String | True |
Fully qualified tracked URL. Does not include Vanity URL. | |
| BitlyIsPersonalized | String | True |
True if a custom Bitly URL was set. | |
| BitlyShortUrl | String | True |
If set, a fully qualified Bitly URL. | |
| IsDeleted | Boolean | True |
True if the object is in the Pardot recycle bin. | |
| CreatedAt | Datetime | True |
The object creation timestamp. | |
| UpdatedAt | Datetime | True |
The timestamp of the last update of the object. | |
| CreatedById | Int64 | True |
ID of the individual who created this object. | |
| UpdatedById | Int64 | True |
ID of the individual who last updated this object. |
Retrieve a collection of dynamic content
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
Pardot ID for this dynamic content. | |
| Name | String | True |
Dynamic content's name. | |
| EmbedCode | String | True |
The code used to embed the dynamic content into a web page. | |
| EmbedUrl | String | True |
The URL to embed this dynamic content. | |
| BaseContent | String | True |
The default content that shows when the prospect doesn't meet the criteria for a variation. | |
| BasedOn | String | True |
The kind field that dynamic content is based on. Values are 'default', 'custom', 'grade', and 'score'. | |
| CreatedAt | Datetime | True |
Time the dynamic content was created; reported in API user's timezone. | |
| UpdatedAt | Datetime | True |
Time the dynamic content was last updated; reporting in API user's timezone. | |
| IsDeleted | Boolean | True |
When true, the object is in the recycle bin in Pardot. | |
| CreatedByID | Int64 | True |
ID of the user who created this object. | |
| UpdatedById | Int64 | True |
ID of the user who last updated this object. | |
| FolderId | Int64 | True |
ID of the folder containing this object. | |
| TrackerDomainId | Int64 | True |
The ID of the tracker domain associated with this object. |
Query email templates.
The Sync App will use the Salesforce Marketing Cloud Account Engagement API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM EmailTemplates WHERE Id = 50 SELECT * FROM EmailTemplates WHERE UpdatedAt > '01/01/2022' SELECT * FROM EmailTemplates WHERE CreatedAt > '01/01/2022'
To insert EmailTemplates the following fields are required:
For inserting into this table specifying the SenderOptionsAggregate is required. The input for this field follows CData principles of deep Inserts. In Deep Insert, you simultaneously create a base object and link it to the related field in the main table.
You may either submit JSON data, or you may create a temporary table for the child table(in this case SenderOptions) and then reference the temporary table in the insert to the base table.
To submit JSON data, simply supply the values for the child table in JSON format.
For example, the following JSON adds two sender options in the email template.
[
{
"address": "[email protected]",
"name": "CDataTest",
"type": "general_user"
},
{
"address": "[email protected]",
"name": "CDataTest2",
"type": "general_user"
}
]
In order to execute the insert, simply reference or include as string literals the complete JSON. For example:
INSERT INTO EmailTemplates (..., SenderOptionsAggregate) VALUES (..., '[{"address":"[email protected]","name":"CDataTest","type":"general_user"},{"address":"[email protected]","name":"CDataTest2","type":"general_user"}]')
If using temporary tables, they must be defined and inserted within the same connection. Closing the connection will clear out any temporary tables in memory.
Insert the child table fields into temporary table.
INSERT INTO SenderOptions#TEMP (Type, Address) VALUES ('general_user', 'address1')
INSERT INTO SenderOptions#TEMP (Type, Address) VALUES ('general_user', 'address2')
In the INSERT statement for the EmailTemplates table, reference the temporary tables in the SenderOptionsAggregate input.
INSERT INTO EmailTemplates (..., SenderOptionsAggregate) VALUES (..., 'SenderOptions#TEMP')
Updating EmailTemplates:
UPDATE EmailTemplates SET TextMessage = 'newMessage' WHERE Id = 24143
Remove all email templates or a email template by specifying the Id of the template.
DELETE FROM EmailTemplates WHERE Id = 10003
To retrieve email templates that are in the recycle bin in Pardot the following operation is supported:
GETDELETED FROM EmailTemplates
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
ID of the email. | |
| Name | String | False |
Name of the object for identification in Pardot. | |
| Subject | String | False |
Subject line for the email template. | |
| TextMessage | String | False |
The text content of the email. This field is retrieved only when filtering with email id. | |
| HtmlMessage | String | False |
The HTML content of the email. This field is retrieved only when filtering with email id. | |
| IsOneToOneEmail | Boolean | False |
If True, the template is available for one-to-one emails. | |
| IsAutoResponderEmail | Boolean | False |
If True, the template is available for autoresponder emails. | |
| IsDripEmail | Boolean | False |
If True, the template is available for Engagement Programs. | |
| IsListEmail | Boolean | False |
If True, the template is available for list emails. | |
| TrackerDomainId | Int64 | False |
ID of the tracker domain used for the list email. | |
| FolderId | Int64 | False |
ID of the folder containing this object. | |
| Type | String | False |
'html', 'text', and 'htmlAndText' values. | |
| CampaignId | Int64 | False |
Pardot campaign related to this object. | |
| IsDeleted | Boolean | True |
True if the object is in the recycle bin in Pardot. | |
| CreatedById | Int64 | True |
ID of the individual who created this object. | |
| UpdatedById | Int64 | True |
ID of the individual who last updated this object. | |
| CreatedAt | Datetime | True |
The timestamp of when this object was created. | |
| UpdatedAt | Datetime | True |
The timestamp of when this object was last updated. | |
| SenderOptionsType | String | True |
The sending user type(s). | |
| SenderOptionsAddress | String | True |
The sending email address(s). | |
| SenderOptionsName | String | True |
The name(s) of the sender. | |
| SenderOptionsUserId | String | True |
The user ID(s) of the sender. | |
| SenderOptionsProspectCustomFieldId | String | True |
The ID of the prospect custom field that contains the sender value. Only available on read and query. | |
| SenderOptionsAccountCustomFieldId | String | True |
The ID of the account custom field that contains the sender value. Only available on read and query. | |
| ReplyToOptionsType | String | True |
The reply to user type(s). | |
| ReplyToOptionsAddress | String | True |
The sending email address(s). | |
| ReplyToOptionsUserId | String | True |
The user ID(s) of the sender. | |
| ReplyToOptionsProspectCustomFieldId | String | True |
The ID of the prospect custom field that contains the sender value. Only available on read and query. | |
| ReplyToOptionsAccountCustomFieldId | String | True |
The ID of the account custom field that contains the sender value. Only available on read and query. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| SenderOptionsAggregate | String |
This input is used for INSERT/UPDATE statements. Set this to SenderOptions#TEMP temporary table, whose rows contain inputs for inserting/updating the sender options. Or simply reference or include as string literals the complete JSON. |
| ReplyToOptionsAggregate | String |
This input is used for INSERT/UPDATE statements. Set this to ReplyToOptions#TEMP temporary table, whose rows contain inputs for inserting/updating the replyTo options. Or simply reference or include as string literals the complete JSON. |
Upload images and other files to use in your Pardot emails, forms, and landing pages.
Sync App はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM Files WHERE Id = 40 SELECT * FROM Files WHERE UpdatedAt < '2021-12-30T03:16:27-08:00' AND CreatedAt >= '2021-11-12T07:18:56-08:00'
挿入を実行する際は、次の属性が必須です:Name、FilePath
INSERT INTO Files (Name, FilePath) VALUES ('file1', 'C:\\file1.txt')
Files の更新:
UPDATE Files SET Name = 'testingUpdate', FolderId = '33609' WHERE id = '804969'
すべてのファイル、またはファイルId を指定して特定のファイルを削除します。
DELETE FROM Files WHERE Id = 10003
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
Pardot ID of this file. | |
| Name | String | False |
Name of the object for identification in Pardot. Uses the name of the file being uploaded if not specified on create. | |
| FolderId | Int64 | False |
ID of the folder containing this object. Uses the asset type's uncategorized folder if not specified on create. | |
| CampaignId | Int64 | False |
Pardot campaign related to this object. Uses null if not specified on create. | |
| VanityUrlPath | String | False |
Vanity URL path (excluding protocol and host). Must be unique for each tracker domain. | |
| TrackerDomainId | Int64 | False |
ID of the TrackerDomain to use in the URL for this object. Uses the primary tracker domain for the account if not specified on create. | |
| SalesforceId | String | True |
ID of the Salesforce object representing this object. | |
| Url | String | True |
URL where the downloadable file can be accessed. | |
| Size | Integer | True |
Size (in bytes) of the downloadable file. | |
| BitlyIsPersonalized | Boolean | True |
True if the object has a bitly URL that is personalized. | |
| BitlyShortUrl | String | True |
Bitly URL if present. | |
| VanityUrl | String | True |
Vanity URL if present. | |
| IsTracked | Boolean | True |
True if downloads of this file are recorded as visitor activity. | |
| CreatedAt | Datetime | True |
The timestamp of when this object was created. | |
| UpdatedAt | Datetime | True |
The timestamp of when this object was last updated. | |
| CreatedById | Int64 | True |
ID of the individual who created this object. | |
| UpdatedById | Int64 | True |
ID of the individual who last updated this object. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| FilePath | String |
This parameter is used only in INSERT operations to upload the content of a file. It should be set to the path of the file including the name. Ex: C:\Users\User\Desktop\test.txt or to the BASE64 encoded content of the file. |
Retrieve,Create,Updata,Delete a collection of Form Handlers
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
ID of this object. | |
| Name | String | False |
Name of the object for identification in Pardot. | |
| FolderId | Int64 | False |
ID of the folder containing this object. | |
| CampaignId | Int64 | False |
The ID of the campaign associated with this object. | |
| TrackerDomainId | Int64 | False |
The ID of the tracker domain associated with this object. | |
| IsDataForwarded | Boolean | False |
When true, enables data forwarding to the success location. | |
| SucessLocation | String | False |
The URL the user is forwarded to if the submission is successful. | |
| ErrorLocation | String | False |
The URL the user is forwarded to if the submission has an error. | |
| IsAlwaysEmail | Boolean | False |
When true, disables visitor activity throttling and sends autoresponder emails after every submission. Learn more about throttling in Salesforce Help. | |
| IsCookieless | Boolean | False |
When true, the form handler is in Kiosk/Data Entry Mode, and does not cookie browser as a submitted prospect. | |
| SalesforceId | String | True |
Salesforce Id of the object. | |
| EmbedCode | String | True |
Code to embed this form handler in a webpage. | |
| CreatedAt | Datetime | True |
Creation time of this object. | |
| UpdatedAt | Datetime | True |
Last updated time for the object. | |
| CreatedById | Int64 | True |
ID of the user who created the object. | |
| IsDeleted | Boolean | True |
True if the object is in the Pardot recycle bin. | |
| UpdatedById | Int64 | True |
ID of the user who last updated the object. |
Retrieve,Create,Update,Delete a collection of Form Handler Stages
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
ID of this object. | |
| Name | String | False |
Name of the object for identification in Pardot. | |
| FormHandlerId | Int64 | False |
The ID of the form handler this field belongs to. | |
| IsRequired | Boolean | False |
When true, the field is required. | |
| DataFormat | String | False |
The field's data format. Values are 'text', 'number','email', 'email not from isps and free email providers', and 'email with valid mail server'. | |
| ProspectApiFieldId | String | False |
The name of the Pardot prospect field that the form handler field is mapped to. On standard fields the value is the name of the field. For example, 'firstName'. If mapping to a custom field, the value is the field name followed by __c. For example, the custom field 'foodChoice' becomes 'foodChoice__c'. | |
| IsMaintainInitialValue | Boolean | False |
When true, the field maintains the initial value upon subsequent form submissions. | |
| ErrorMessage | String | False |
Error message for the field. | |
| CreatedAt | Datetime | True |
Creation time of this object. | |
| CreatedById | Int64 | True |
ID of the user who created the object. |
Retrieve and modify layout templates.
Sync App はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM LayoutTemplates WHERE Id = 40 SELECT * FROM LayoutTemplates WHERE IsDeleted = 'true'
挿入を実行する際は、次の属性が必須です:Name、LayoutContent
INSERT INTO LayoutTemplates (Name, IsIncludeDefaultCss, LayoutContent, FolderId) VALUES ('name', 'true', 'content', 33621)
LayoutTemplates の更新:
UPDATE LayoutTemplates SET Name = 'newName' WHERE Id = 24143
すべてのレイアウトテンプレート、またはテンプレートId を指定して特定のレイアウトテンプレートを削除します。
DELETE FROM LayoutTemplates WHERE Id = 10003
Pardot のごみ箱にあるレイアウトテンプレートを取得する場合、次の操作がサポートされています。
GETDELETED FROM LayoutTemplates
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
ID of this object. | |
| Name | String | False |
Name of the object for identification in Pardot. Uses the name of the file being uploaded if not specified on create. | |
| LayoutContent | String | False |
HTML content of this layout template encoded as JSON string. | |
| FormContent | String | False |
HTML content encoded as JSON string that controls form display logic. Uses default values if not provided. | |
| SiteSearchContent | String | False |
HTML content encoded as JSON string that controls the site search content. | |
| IsIncludeDefaultCss | Boolean | False |
True if not supplying custom CSS styling. | |
| FolderId | Int64 | False |
ID of the folder containing this object. Uses the asset type's uncategorized folder if not specified on create. | |
| IsDeleted | Boolean | True |
True if the object is in the recycle bin in Pardot. | |
| CreatedAt | Datetime | True |
The timestamp of when this object was created. | |
| UpdatedAt | Datetime | True |
The timestamp of when this object was last updated. | |
| CreatedById | Int64 | True |
ID of the individual who created this object. | |
| UpdatedById | Int64 | True |
ID of the individual who last updated this object. |
Retrieve,Create,Update,Delete a collection of list memberships
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
Pardot ID for this list membership. | |
| IsDeleted | Boolean | True |
When true, the list membership is in the Pardot recycle bin. | |
| CreatedById | Int64 | True |
ID of the user who created this list membership. | |
| CreatedAt | Datetime | True |
The time that this list membership was created. Reported in API user's preferred timezone. | |
| UpdatedAt | Datetime | True |
The time that this list membership was last updated. Reported in API user's timezone. | |
| UpdatedById | Int64 | True |
ID of the user who last updated this list membership. | |
| OptedOut | Boolean | False |
When true, the prospect is unsubscribed from receiving emails from this list. | |
| ListId | Int64 | False |
Pardot ID of the list for this membership | |
| ProspectID | Int64 | False |
Pardot ID of the prospect for this membership |
Retrieve and modify lists.
Sync App はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM Lists WHERE Id = 40 SELECT * FROM Lists WHERE IsDeleted = 'true' SELECT * FROM Lists WHERE CreatedAt > '01/01/2022'
挿入を実行する際は、次の属性が必須です:Name
INSERT INTO Lists (Name) VALUES ('name')
Lists 属性を更新します。
UPDATE Lists SET Name = 'newName' WHERE Id = 24143
すべてのリスト、またはリストId を指定して特定のリストを削除します。
DELETE FROM Lists WHERE Id = 10003
Pardot のごみ箱にあるリストを取得する場合、次の操作がサポートされています。
GETDELETED FROM Lists
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
Pardot ID of this list. | |
| Name | String | False |
List's name (internal to Pardot). | |
| FolderId | Int64 | False |
ID of the folder containing this object. | |
| CampaignId | Int64 | False |
Campaigns.Id |
Pardot campaign related to this object. Uses null if not specified on create. |
| IsDeleted | Boolean | True |
True if the object is in the recycle bin in Pardot. | |
| IsDynamic | Boolean | True |
True if the list is dynamic. | |
| IsPublic | Boolean | False |
True if the list is public. | |
| Title | String | False |
Title of the list object. | |
| Description | String | False |
List's description. | |
| CreatedAt | Datetime | True |
The timestamp of when this object was created. | |
| UpdatedAt | Datetime | True |
The timestamp of when this object was last updated. | |
| CreatedById | Int64 | True |
ID of the individual who created this object. | |
| UpdatedById | Int64 | True |
ID of the individual who last updated this object. |
Retrieve and modify prospects.
Sync App はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM Prospects WHERE Id = 3457992 SELECT * FROM Prospects WHERE UserId = 14 SELECT * FROM Prospects WHERE UpdatedAt < '2021-12-30T03:16:27-08:00' AND CreatedAt >= '2021-11-12T07:18:56-08:00'
削除されたプロスペクトを取得するには、GETDELETED 文を実行します。
GETDELETED FROM Prospects
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
Pardot ID for this prospect. | |
| AddressOne | String | False |
Prospect's address, line 1. | |
| AddressTwo | String | False |
Prospect's address, line 2. | |
| AnnualRevenue | String | False |
Prospect's annual revenue. | |
| CampaignId | Int64 | False |
Pardot campaign related to this object. | |
| CampaignParameter | String | True |
Prospect's campaign parameter utm_campaign from Google Analytics. | |
| SalesforceCampaignId | String | True |
The alpha-numeric Id of the associated campaign in the Salesforce Org. | |
| City | String | False |
Prospect's city. | |
| Comments | String | False |
Comments about this prospect. | |
| Company | String | False |
Prospect's company. | |
| ContentParameter | String | True |
Prospect's content parameter utm_content from Google Analytics. | |
| ConvertedAt | Datetime | True |
Time when prospect was converted from visitor. | |
| ConvertedFromObjectName | String | True |
Name of object associated with visitor activity that resulted in prospect being converted from visitor. | |
| ConvertedFromObjectType | String | True |
ype of object associated with visitor activity that resulted in prospect being converted from visitor. Supported values include 'Form', 'FormHandler', 'LandingPage', 'MultivariateTestVariation', and 'Video'. | |
| Country | String | False |
Prospect's country. | |
| SalesforceAccountId | String | True |
Account ID in a supported Salesforce system. | |
| SalesforceContactId | String | True |
Prospect's contact ID in a supported Salesforce system. | |
| SalesforceLastSync | Datetime | True |
Last time this prospect was synced with a supported Salesforce system. | |
| SalesforceLeadId | String | True |
Prospect's lead ID in a supported Salesforce system. | |
| SalesforceOwnerId | String | False |
Prospect's owner ID in a supported Salesforce system. | |
| SalesforceId | String | False |
The alpha-numeric Id of the Salesforce Org. | |
| Department | String | False |
Prospect's department. | |
| String | False |
Prospect's email address. | ||
| EmailBouncedAt | Datetime | True |
Time | |
| EmailBouncedReason | String | True |
Reason why prospect email address hard bounced. | |
| Employees | String | False |
Prospect's number of employees. | |
| Fax | String | False |
Prospect's fax number. | |
| FirstActivityAt | Datetime | True |
Time when first visitor activity occurred for this prospect. | |
| FirstAssignedAt | Datetime | True |
Time prospect was first assigned to a user. | |
| FirstName | String | False |
Prospect's first name. | |
| FirstReferrerQuery | String | True |
First referrer's search query. | |
| FirstReferrerType | String | True |
First referrer's vendor and type (such as 'Google Natural Search'). | |
| FirstReferrerUrl | String | True |
First referrer's URL. | |
| Grade | String | True |
Prospect's letter grade. | |
| Industry | String | False |
Prospect's industry. | |
| IsDeleted | Boolean | True |
True if the object is in the recycle bin in Pardot. | |
| IsDoNotCall | Boolean | False |
If value is 1, prospect prefers not to be called. | |
| IsDoNotEmail | Boolean | False |
If value is 1, prospect prefers not to be emailed. | |
| isEmailHardBounced | Boolean | True |
If true, prospect email address has hard bounced. | |
| IsReviewed | Boolean | False |
If value is 1, prospect has been reviewed. | |
| IsStarred | Boolean | False |
If value is 1, prospect has been starred. | |
| JobTitle | String | False |
Prospect's job title. | |
| LastActivityAt | Datetime | True |
Time stamp of this prospect's latest visitor activity. | |
| LastName | String | False |
Prospect's last name. | |
| MediumParameter | String | True |
Prospect's medium parameter utm_medium from Google Analytics. | |
| Notes | String | False |
Notes about this prospect. | |
| OptedOut | Boolean | False |
If value is 1, prospect has opted out of marketing communications. | |
| Password | String | True |
Prospect's password. | |
| Phone | String | False |
Prospect's phone number. | |
| ProspectAccountId | Int64 | False |
Prospect's account ID. | |
| Salutation | String | False |
Prospect's formal prefix. | |
| Score | Integer | False |
Prospect's score. | |
| Source | String | False |
Prospect's source. | |
| SourceParameter | String | True |
Prospect's source parameter utm_source from Google Analytics. | |
| State | String | False |
Prospect's US state. | |
| TermParameter | String | True |
Prospect's term parameter utm_term from Google Analytics. | |
| Territory | String | False |
Prospect's territory. | |
| Website | String | False |
Prospect's website URL. | |
| YearsInBusiness | String | False |
Prospect's number of years in business. | |
| Zip | String | False |
Prospect's postal code. | |
| AssignedToId | Int64 | True |
ID of the user who the object record is assigned to. | |
| ProfileId | Int64 | False |
Pardot profile related to this object. | |
| SalesforceUrl | String | True |
URL to view the prospect within the Salesforce system. | |
| LifecycleStageId | Int64 | True |
Pardot lifecycle stage related to this object. | |
| UserId | Int64 | False |
User the prospect is assigned to. | |
| RecentInteraction | String | True |
Describes the prospect's most recent interaction with Pardot. | |
| CreatedAt | Datetime | True |
Time prospect was created in Pardot. | |
| UpdatedAt | Datetime | True |
Last time prospect was updated in Pardot. | |
| CreatedById | Int64 | True |
ID of the individual who created this object. | |
| UpdatedById | Int64 | True |
ID of the individual who last updated this object. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| Account | Use the account resource to learn about the current user's Pardot account. |
| Campaigns | Retrieve and modify campaigns. |
| CustomFields | Retrieve custom fields metadata. |
| DynamicContentVariations | Retrieve a collection of Dynamic Content Variations |
| Emails | Query emails to learn how prospects responded to the emails. |
| EmailSuppressionList | A Lists used as suppression lists for the list email. |
| EngagementStudioProgram | Query EngagementStudioProgram to retrieve data related to the programs. |
| FolderContents | View all objects contained within Folders. |
| Folders | Retrieve folders or organize and nest your content and marketing assets in a way that makes sense for your team. |
| Forms | Retrieve forms. |
| LandingPages | Retrieving a collection of landing pages |
| LifecycleHistories | Use lifecycle history resources to learn how a prospect is moving through their sales journey, from visitor to won opportunity. |
| LifecycleStages | Retrieving a collection of lifecycle stages |
| ListEmail | A list email is a single email sent to a recipient list. |
| ListEmailRecipients | RecipientLists used by an email |
| Opportunities | Retrieve a collection of opportunities |
| ProspectAccounts | Retrieve and modify prospect accounts. |
| ReplyToOptions | Query the replyTo options of email templates. |
| SenderOptions | Query the sender options of email templates. |
| TrackerDomains | Query the available tracker domains. |
| Users | Query the available users. |
| VisitorActivities | Retrieve visitor activities. |
| Visitors | Retrieve visitors. |
| VisitorsPageViews | Retrieve visitors page views. |
| Visits | Retrieve visits. |
Use the account resource to learn about the current user's Pardot account.
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this account. | |
| Company | String | Account company. | |
| Level | String | The level of product for the account. | |
| Website | String | Account website. | |
| PluginCampaignId | Int64 | Plugin ID for account campaign. | |
| AddressOne | String | Account's address, line 1. | |
| AddressTwo | String | Account's address, line 2. | |
| City | String | Account's city. | |
| State | String | Account's state. | |
| Zip | String | Account's postal code. | |
| Territory | String | Account's territory. | |
| Country | String | Account's country. | |
| Phone | String | Account's phone number. | |
| Fax | String | Account's fax number. | |
| AdminId | Int64 | ID of the individual who is the admin for this account. | |
| CreatedAt | Datetime | The timestamp of when this object was created. | |
| UpdatedAt | Datetime | The timestamp of when this object was last updated. | |
| MaximumDailyApiCalls | Integer | Maximum daily API requests based on the timezone for this account. | |
| ApiCallsUsed | Integer | Total daily API requests based on the timezone for this account. | |
| CreatedById | Int64 | ID of the individual who created this object. | |
| UpdatedById | Int64 | ID of the individual who last updated this object. |
Retrieve and modify campaigns.
Sync App はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM Campaigns WHERE Id = 50 SELECT * FROM Campaigns WHERE Name = 'campaignName' SELECT * FROM Campaigns WHERE CreatedAt > '01/01/2022'
Pardot のごみ箱にあるキャンペーンを取得する場合、次の操作がサポートされています。
GETDELETED FROM Campaings
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this campaign. | |
| Name | String | Campaign's name. | |
| Cost | Integer | Cost associated to the campaign. | |
| IsDeleted | Boolean | True if the object is in the recycle bin in Pardot. | |
| FolderId | Int64 | ID of the folder containing this object. | |
| ParentCampaignId | Int64 | The ID of the parent campaign. | |
| CreatedAt | Datetime | The timestamp of when this object was created. | |
| UpdatedAt | Datetime | The timestamp of when this object was last updated. | |
| CreatedById | Int64 | ID of the individual who created this object. | |
| UpdatedById | Int64 | ID of the individual who last updated this object. | |
| SalesforceId | String | The alphanumeric Id of the Salesforce Org. |
Retrieve custom fields metadata.
Sync App は Salesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM CustomFields WHERE Id = 50 SELECT * FROM CustomFields WHERE CreatedAt > '01/01/2022' SELECT * FROM CustomFields WHERE UpdatedAt < '01/01/2022'
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this custom field. | |
| Name | String | Custom field's name. | |
| FieldId | String | API ID for custom field. | |
| Type | String | The type of field. | |
| CreatedAt | Datetime | Time custom field was created in Pardot. | |
| UpdatedAt | Datetime | Last time custom field was updated. | |
| CreatedById | Int64 | ID of the individual who created this object. | |
| UpdatedById | Int64 | ID of the individual who last updated this object. | |
| IsRecordMultipleResponses | Boolean | If true, this custom field will record multiple responses. | |
| IsUseValues | Boolean | If true, this custom field will use predefined values. | |
| SalesforceId | String | The alpha-numeric Id of the Salesforce Org. | |
| IsRequired | String | True if the custom field is required. | |
| isAnalyticsSynced | Boolean | True if the object is synced to Analytics. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ValuesPrefill | String | Write-Only field on create operation. Possible values: Countries, |
Retrieve a collection of Dynamic Content Variations
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this dynamic content variation. | |
| Comparison | String | The logic used to set the criteria for a variation. This field works together with the Dynamic Content basedOn field to determine which variation a prospect is served. | |
| Content | String | The text content of the variation. | |
| DynamicContentId | String | ID of the dynamic content this variation is associated with. |
Query emails to learn how prospects responded to the emails.
Sync App はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM Emails WHERE Id = 50 SELECT * FROM Emails WHERE ProspectId = 23 SELECT * FROM Emails WHERE SentAt > '01/01/2022'
| Name | Type | References | Description |
| Id [KEY] | Int64 | ID of the email. | |
| ProspectId | Int64 | Pardot prospect id related to this email. | |
| CampaignId | Int64 | Pardot campaign related to this object. | |
| CreatedById | Int64 | ID of the individual who created this object. | |
| ClientType | String | Value is 'Builder' if the email was sent via the Lightning Email Builder. Value is 'Web' if it was sent via the legacy Pardot email builder. | |
| TextMessage | String | The text content of the email. This field is retrieved only when filtering with email id. | |
| HtmlMessage | String | The HTML content of the email. This field is retrieved only when filtering with email id. | |
| ListId | Int64 | ID of the list associated with this email. | |
| listEmailId | Int64 | ID of the list email associated with this email. | |
| Name | String | Name of the email for identification in Pardot. | |
| SentAt | Datetime | Time the email was sent. | |
| Subject | String | The email subject. |
A Lists used as suppression lists for the list email.
To retrieve a single suppressed email address, specify its ID:
SELECT * FROM EmailSuppressionList WHERE Id = '55555555'
To retrieve multiple suppressed email addresses, issue a nested SELECT statement to the ListEmail table.
SELECT * FROM EmailSuppressionList WHERE ListEmailId IN (SELECT Id FROM ListEmail)
| Name | Type | References | Description |
| Id [KEY] | Int64 | ID of the SuppressionList | |
| ListEmailId [KEY] | Int64 | The ListEmail id | |
| ListEmailName | String | ListEmail's name (internal to Pardot). | |
| ListEmailCampaignId | Int64 | Pardot ListEmail campaign related to this object. Uses null if not specified on create. | |
| Name | String | List's name (internal to Pardot). | |
| FolderId | Int64 | ID of the folder containing this object. | |
| IsDynamic | Boolean | True if the list is dynamic. | |
| IsPublic | Boolean | True if the list is public. | |
| Title | String | Title of the list object. | |
| Description | String | List's description. |
Query EngagementStudioProgram to retrieve data related to the programs.
| Name | Type | References | Description |
| Id [KEY] | Int64 | ID of the object. | |
| BusinessHoursDays | String | Array containing the business days of the week. | |
| BusinessHoursEndTime | Time | The start time of the business day. | |
| BusinessHoursStartTime | Time | The end time of the business day. | |
| BusinessHoursTimezone | String | The timezone of the business hours. | |
| CreatedAt | Datetime | Creation time of the object. | |
| CreatedById | Int64 | ID of the user who created this object. | |
| Description | String | Description of the object. | |
| FolderId | Int64 | ID of the folder containing this object. Uses the asset type's uncategorized folder if not specified on create. | |
| IsDeleted | Boolean | True if the object is in the recycle bin in Account Engagement. | |
| Name | String | Name of the object for identification in Account Engagement. | |
| ProspectsMultipleEntryMaximumEntries | Int64 | The maximum amount of times a prospect can reenter the program. Unlimited entries are represented as null. | |
| ProspectsMultipleEntryMinimumDurationInDays | Int64 | The minimum amount of days before a prospect can reenter the program. | |
| RecipientListIds | String | Array containing the program's Recipient List IDs. | |
| SalesforceId | Int64 | SalesforceID of the object. | |
| ScheduleCreatedAt | Datetime | Creation time of the program schedule. | |
| ScheduleStartOn | Datetime | Start time of the program schedule. If the program was started with the Now option startOn reflects the time the program started. If the program was started at some date in the future startOn reflects the user's selection. | |
| ScheduleStopOn | Datetime | Stop time of the program schedule. A null value in this field represents the Never stop option. | |
| ScheduleCreatedById | Int64 | ID of the user who created the program's schedule. | |
| Status | String | The status of the program. draft: The program has never been run and can be edited;running: The program is currently running and can't be edited.;paused: The program isn't running and is eligible for edits (not supported at this time).;starting: The program is in the process of starting and can't be edited.;scheduled: The program is scheduled to start. | |
| SuppressionListIds | String | Array containing the program's Suppression List IDs. | |
| UpdatedAt | Datetime | Last update time of the object. | |
| UpdatedById | Int64 | ID of the user who last updated this object. |
View all objects contained within Folders.
| Name | Type | References | Description |
| Id [KEY] | Int64 | ID of the folder content storing the folder-to-object relationship. | |
| FolderId | Int64 | ID of the folder containing the object with ObjectId. | |
| FolderRef | String | The URL for reading the specific folder with FolderId. | |
| ObjectType | String | Type of object referenced by ObjectId. | |
| ObjectId | Int64 | ID of the object contained in the folder. | |
| ObjectName | String | Name of the object contained in the folder. | |
| ObjectRef | String | The URL for reading the specific object with ObjectId. | |
| CreatedAt | Datetime | Creation time of the object. | |
| UpdatedAt | Datetime | Last update time of the object. | |
| CreatedById | Int64 | ID of the user who created this object. | |
| UpdatedById | Int64 | ID of the user who last updated this object. |
Retrieve folders or organize and nest your content and marketing assets in a way that makes sense for your team.
Sync App はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM Folders WHERE Id = 50 SELECT * FROM Folders WHERE ParentFolderId = 2
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID of this file. | |
| Name | String | Name of the folder. | |
| ParentFolderId | Int64 | ID of the folder containing this folder. This value is null when the folder is a root folder and doesn't have a parent. | |
| Path | String | The names of each folder from the root folder separated with forward slashes. | |
| UsePermissions | Boolean | True if the folder is configured to use permissions. | |
| CreatedAt | Datetime | The timestamp of when this object was created. | |
| UpdatedAt | Datetime | The timestamp of when this object was last updated. | |
| CreatedById | Int64 | ID of the individual who created this object. | |
| UpdatedById | Int64 | ID of the individual who last updated this object. |
Retrieve forms.
Sync App はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM Forms WHERE Id <= 17 SELECT * FROM Forms WHERE IsDeleted = 'true'
Pardot のごみ箱にあるフォームを取得する場合、次の操作がサポートされています。
GETDELETED FROM Forms
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this form. | |
| Name | String | Form's name. | |
| CampaignId | Int64 |
Campaigns.Id | Pardot ID of the campaign associated with this form. |
| EmbedCode | String | The code used to embed the form on your webpage. | |
| SalesforceId | String | The alpha-numeric Id of the Salesforce Org. | |
| LayoutTemplateId | Int64 | The ID of the layout template associated with this object | |
| SubmitButtonText | String | The label used for the submit button | |
| BeforeFormContent | String | The HTML text displayed above the form | |
| AfterFormContent | String | The HTML text displayed below the form | |
| ThankYouContent | String | The HTML text displayed after the form is submitted | |
| ThankYouCode | String | Thank you code is typically Javascript used to call other systems like Google Conversion Tracking | |
| IsAlwaysDisplay | Boolean | Always display form after submission. Disable the 10 minute waiting period after submitting a form | |
| RedirectLocation | String | Redirect to this URL instead of showing the | |
| IsUseRedirectLocation | Boolean | When redirect location is valid and enabled. | |
| FontSize | String | Possible values: default, 8pt, 10pt, 12pt, 14pt , 18pt, 24pt, 36pt. | |
| FontFamily | String | Possible values: default, | |
| FontColor | String | 6 digit number in hexadecimal format such as #123456 | |
| LabelAlignment | String | Possible values: default, above, left | |
| RadioAlignment | String | Possible values: default, horizontal, stacked | |
| CheckboxAlignment | String | Possible values: default, horizontal, stacked | |
| RequiredCharacter | String | Possible values: default , * | |
| IsCookieless | String | Kiosk/Data Entry Mode: Do not cookie browser as submitted prospect | |
| ShowNotProspect | Boolean | Include | |
| IsCaptchaEnabled | Boolean | Enable explicit bot protecting using reCAPTCHA | |
| IsDeleted | Boolean | True if the object is in the recycle bin in Pardot. | |
| TrackerDomainId | Int64 | The ID of the tracker domain associated with this object. | |
| FolderId | Int64 | ID of the folder containing this object. | |
| CreatedAt | Datetime | The timestamp of when this object was created. | |
| UpdatedAt | Datetime | The timestamp of when this object was last updated. | |
| CreatedById | Int64 | ID of the individual who created this object. | |
| UpdatedById | Int64 | ID of the individual who last updated this object. |
Retrieving a collection of landing pages
The Sync App will use the Salesforce Marketing Cloud Account Engagement API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM LandingPages WHERE Id = 50 SELECT * FROM LandingPages WHERE IsDeleted = 'true' SELECT * FROM LandingPages WHERE CreatedAt > '01/01/2022'
To retrieve LandingPages that are in the recycle bin in Pardot the following operation is supported:
GETDELETED FROM LandingPages
| Name | Type | References | Description |
| Id [KEY] | Int64 | ID of the object. | |
| Name | String | Name of the object for identification in Pardot. | |
| SalesforceId | String | ID of the Salesforce object representing this object. | |
| IsDeleted | Boolean | True if the object is in the recycle bin in Pardot. | |
| CreatedById | Int64 | ID of the user who created this object. | |
| CreatedAt | Datetime | Creation time of the object. | |
| UpdatedAt | Datetime | Last update time of the object. | |
| UpdatedById | Int64 | ID of the user who last updated this object. | |
| CampaignId | Int64 | Pardot Campaign related to this object. | |
| FormId | Int64 | ID of the form related to this object. | |
| LayoutTemplateId | Int64 | ID of the layout template related to this object. | |
| Title | String | The landing page's title. | |
| Description | String | The landing page's meta description. Used for SEO. | |
| IsDoNotIndex | Boolean | True if the landing page is hidden from search engine indexing. | |
| LayoutType | String | Specifies where the landing page was created. Possible values are Layout Template, Landing Page Builder, Legacy Page Builder, Salesforce Builder. | |
| ScriptFragment | String | Script specified for the landing page. Available only on read requests. | |
| LayoutCss | LayoutCss | CSS code for the layout template. Available only on read requests. | |
| LayoutCssGenerated | String | Generated CSS code for the layout template. Available only on read requests. | |
| LayoutTableBorder | Int | Specifies the layout table border width. | |
| RedirectLocation | String | The redirect URL used if the prospect is redirected instead of showing the thank you content. | |
| IsUseRedirectLocation | Boolean | True if the prospect is redirected instead of showing the form thank you content. | |
| BitlyIsPersonalized | Boolean | True if the object has a bitly URL that is personalized. | |
| BitlyShortUrl | String | Bitly URL if present. | |
| Url | String | Link for the landing page. | |
| VanityUrl | String | Vanity URL if present. | |
| VanityUrlPath | String | The unique path for the asset, used to create the vanity URL. | |
| TrackerDomainId | Int64 | The ID of the tracker domain associated with this object. | |
| FolderId | Int64 | The ID of the folder associated with this object. |
Use lifecycle history resources to learn how a prospect is moving through their sales journey, from visitor to won opportunity.
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID of this lifecycle history. | |
| ProspectId | Int64 |
Prospects.Id | Pardot ID for the prospect in this stage. |
| PreviousStageId | Int64 | Pardot ID of the stage this prospect previously was in. | |
| NextStageId | Int64 | Pardot ID of the stage this prospect is in next. | |
| SecondsElapsed | Integer | Number of seconds for prospect to get to current stage. | |
| CreatedAt | Datetime | The timestamp of when this object was created. |
Retrieving a collection of lifecycle stages
The Sync App will use the Salesforce Marketing Cloud Account Engagement API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM LifecycleStages WHERE Id = 50 SELECT * FROM LifecycleStages WHERE IsDeleted = 'true' SELECT * FROM LifecycleStages WHERE CreatedAt > '01/01/2022'
To retrieve LifecycleStages that are in the recycle bin in Pardot the following operation is supported:
GETDELETED FROM LifecycleStages
| Name | Type | References | Description |
| Id [KEY] | Int64 | ID of the lifecycle stage. | |
| Name | String | Pardot ID of this lifecycle stage. | |
| IsDeleted | Boolean | True if the lifecycle stage is in the recycle bin in Pardot. | |
| CreatedAt | Datetime | Creation time of the lifecycle stage. | |
| UpdatedAt | Datetime | Last updated time for the lifecycle stage. | |
| IsLocked | Boolean | When true, lifecycle stage is locked. | |
| Position | Int | Lifcycle stage's position in lifecycle. | |
| MatchType | String | Match all is returned when a prospect must match all rules in order to be in this stage. Match any is returned when a prospect can match 1 or more rules |
A list email is a single email sent to a recipient list.
Sync App はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM ListEmail WHERE Id = 50 SELECT * FROM ListEmail WHERE SentAt > '01/01/2022' SELECT * FROM ListEmail WHERE CreatedAt > '01/01/2022'
Pardot のごみ箱にあるリストメールを取得する場合、次の操作がサポートされています。
GETDELETED FROM ListEmail
| Name | Type | References | Description |
| Id [KEY] | Int64 | ID of the email. | |
| Name | String | Name of the object for identification in Pardot. | |
| Subject | String | The email subject. | |
| TextMessage | String | The text content of the email. This field is retrieved only when filtering with email id. | |
| HtmlMessage | String | The HTML content of the email. This field is retrieved only when filtering with email id. | |
| CampaignId | Int64 | Pardot campaign related to this object. | |
| IsPaused | Boolean | True if the email send is paused. | |
| IsSent | Boolean | True if the email has been sent. | |
| IsDeleted | Boolean | True if the object is in the recycle bin in Pardot. | |
| CreatedById | Int64 | ID of the individual who created this object. | |
| UpdatedById | Int64 | ID of the individual who last updated this object. | |
| CreatedAt | Datetime | The timestamp of when this object was created. | |
| UpdatedAt | Datetime | The timestamp of when this object was last updated. | |
| ClientType | String | Value is 'Builder' if the email was sent via the Lightning Email Builder. Value is 'Web' if it was sent via the legacy Pardot email builder. | |
| SentAt | Datetime | Time the email was sent. | |
| OperationalEmail | Boolean | True if the email is operational. | |
| EmailTemplateId | Int64 | ID of the email template used for the list email. | |
| TrackerDomainId | Int64 | ID of the tracker domain used for the list email. | |
| SenderOptionsType | String | The sending user type(s). | |
| SenderOptionsAddress | String | The sending email address(s). | |
| SenderOptionsName | String | The name(s) of the sender. | |
| SenderOptionsUserId | String | The user ID(s) of the sender. | |
| ReplyToOptionsType | String | The reply to user type(s). | |
| ReplyToOptionsAddress | String | The sending email address(s). | |
| ReplyToOptionsUserId | String | The user ID(s) of the sender. |
RecipientLists used by an email
To retrieve a single email recipient, specify its ID:
SELECT * FROM ListEmailRecipients WHERE Id = '55555555'
To retrieve multiple email recipient, issue a nested SELECT statement to the ListEmail table.
SELECT * FROM ListEmailRecipients WHERE ListEmailId IN (SELECT Id FROM ListEmail)
| Name | Type | References | Description |
| Id [KEY] | Int64 | ID of the RecipientList. | |
| ListEmailId [KEY] | Int64 | The ListEmail id | |
| ListEmailName | String | ListEmail's name (internal to Pardot). | |
| ListEmailCampaignId | Int64 | Pardot ListEmail campaign related to this object. Uses null if not specified on create. | |
| Name | String | List's name (internal to Pardot). | |
| FolderId | Int64 | ID of the folder containing this object. | |
| IsDynamic | Boolean | True if the list is dynamic. | |
| IsPublic | Boolean | True if the list is public. | |
| Title | String | Title of the list object. | |
| Description | String | List's description. |
Retrieve a collection of opportunities
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this opportunity. | |
| CampaignId | Int64 | Pardot ID of the campaign associated with this opportunity. Information about an opportunity's campaign association can be returned using the Campaign relationship. | |
| ClosedAt | Datetime | The opportunity's closed date. When left blank, the Closed Date field in Pardot isn't set, even when the opportunity's stage, status, or probability are set to indicate that the opportunity is closed. | |
| CreatedAt | Datetime | Time opportunity is created in Pardot; Time is reported in API user's preferred timezone. | |
| CreatedById | Int64 | ID of the user who created this object. | |
| Name | String | The opportunity's name. | |
| Probability | Int | The opportunity's probability. Must be a positive numeric value from 0 through 100, inclusive. | |
| SalesforceId | String | The ID of the associated opportunity in Salesforce. | |
| Stage | String | The opportunity's stage. | |
| Status | String | The opportunity's status. Status must be either won, lost, or open. | |
| Type | String | The opportunity's type. | |
| UpdatedAt | Datetime | Last time opportunity was updated in Pardot; Time is reported in API user's preferred timezone. | |
| UpdatedById | Int64 | ID of the user who last updated this object. | |
| Value | Double | The opportunity's value. Must be a positive numeric value. |
Retrieve and modify prospect accounts.
Sync App はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM ProspectAccounts WHERE Id > 31
削除されたプロスペクトのアカウントを取得するには、GETDELETED 文を実行します。
GETDELETED FROM ProspectAccounts
| Name | Type | References | Description |
| Id [KEY] | Int64 | ID of the object. | |
| Name | String | Name of the object. | |
| SalesforceId | String | ID of the Salesforce object representing this object. | |
| IsDeleted | Boolean | True if the object is in the recycle bin in Pardot. | |
| AnnualRevenue | String | Annual Revenue of the object. | |
| BillingAddressOne | String | Billing Address of the object. | |
| BillingAddressTwo | String | Second Billing Address of the object. | |
| BillingCity | String | City of the object. | |
| BillingCountry | String | County of the object. | |
| BillingState | String | State of the object. | |
| BillingZip | String | Zip of the object. | |
| Description | String | Description of the object. | |
| Employees | String | Employees of the object. | |
| Fax | String | Fax of the object. | |
| Industry | String | Industry of the object. | |
| Number | String | Number of the object. | |
| Ownership | String | Ownership of the object. | |
| Phone | String | Phone Number of the object. | |
| Rating | String | Rating of the object. | |
| ShippingAddressOne | String | Shipping Address of the object. | |
| ShippingAddressTwo | String | Second Shipping Address of the object. | |
| ShippingCity | String | Shipping Address city of the object. | |
| ShippingCountry | String | Shipping Address country of the object. | |
| ShippingState | String | Shipping Address state of the object. | |
| ShippingZip | String | Shipping Address zip of the object. | |
| Sic | String | SIC of the object. | |
| Site | String | Site of the object. | |
| TickerSymbol | String | Ticker Symbol of the object. | |
| Type | String | Type of the object. | |
| Website | String | Website of the object. | |
| CreatedAt | Datetime | Creation time of the object. | |
| UpdatedAt | Datetime | Last update time of the object. | |
| AssignedToId | Int64 | ID of the user who the object record is assigned to. | |
| CreatedById | Int64 | ID of the individual who created this object. | |
| UpdatedById | Int64 | ID of the individual who last updated this object. |
Query the replyTo options of email templates.
| Name | Type | References | Description |
| EmailId [KEY] | Int64 | ID of the email template. | |
| Type | String | The sending user type. Can be general_user, specific_user, assigned_user, or account_owner. | |
| Address | String | The sending email address(s). | |
| UserId | String | The user ID(s) of the sender. | |
| ProspectCustomFieldId | String | The ID of the prospect custom field that contains the sender value. Only available on read and query. | |
| AccountCustomFieldId | String | The ID of the account custom field that contains the sender value. Only available on read and query. |
Query the sender options of email templates.
| Name | Type | References | Description |
| EmailId [KEY] | Int64 | ID of the email template. | |
| Address | String | The sending email address. | |
| Name | String | The name of the sender. | |
| Type | String | The sending user type. Can be general_user, specific_user, assigned_user, or account_owner. | |
| UserId | String | The user ID of the sender. | |
| ProspectCustomFieldId | String | The ID of the prospect custom field that contains the sender value. Only available on read and query. | |
| AccountCustomFieldId | String | The ID of the account custom field that contains the sender value. Only available on read and query. |
Query the available tracker domains.
Sync App はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM TrackerDomains WHERE Id = 50
削除されたレコードを取得するには、GETDELETED 文を実行します。
GETDELETED FROM TrackerDomains
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this object. | |
| Domain | String | Hostname to which links using this tracker domain are resolved. | |
| IsPrimary | Boolean | True if the tracker domain is primary tracker domain for the account. Only one tracker domain can be designated as the primary and must be unique across all Pardot accounts. | |
| IsDeleted | Boolean | True if the object is in the recycle bin in Pardot. | |
| DefaultCampaignId | Int64 | The ID of the default campaign for this tracker domain. | |
| HttpsStatus | String | Identify if this tracker domain is using http or https. | |
| SslStatus | String | Status of SSL for this vanity tracker domain. | |
| SslStatusDetails | String | Extra information for the status of SSL for this vanity tracker domain. | |
| SslRequestedById | Int64 | ID of the User who manually requested enabling SSL for this tracker domain. | |
| ValidationStatus | String | The status can be default, validated or not validated | |
| ValidatedAt | Datetime | Time when this tracker domain validation became validated. | |
| VanityUrlStatus | String | Indicates whether this tracker domain can serve vanity urls. | |
| TrackingCode | String | The tracking code for this object encoded as JSON string. A default campaign is required before generating tracking codes as well as enabling first party tracking in account settings. | |
| CreatedAt | Datetime | The timestamp of when this object was created. | |
| UpdatedAt | Datetime | The timestamp of when this object was last updated. | |
| CreatedById | Int64 | ID of the individual who created this object. | |
| UpdatedById | Int64 | ID of the individual who last updated this object. |
Query the available users.
Sync App はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM Users WHERE Id = 32 SELECT * FROM Users WHERE CreatedAt < '02/03/2019 23:11:33' AND CreatedAt > '02/03/2018 23:11:33'
削除されたユーザーを取得するには、GETDELETED 文を実行します。
GETDELETED FROM Users
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this object. | |
| String | Email address of the user. | ||
| FirstName | String | First name of the user. | |
| Username | String | Formatted as an email address, though distinct from the email field on the user object. | |
| JobTitle | String | Job title of the user. | |
| Role | String | Role of the user. | |
| SalesforceId | String | Salesforce Id of the object. | |
| IsDeleted | Boolean | True if the object is in the recycle bin in Pardot. | |
| CreatedAt | Datetime | The timestamp of when this object was created. | |
| UpdatedAt | Datetime | The timestamp of when this object was last updated. | |
| CreatedById | Int64 | ID of the individual who created this object. | |
| UpdatedById | Int64 | ID of the individual who last updated this object. |
Retrieve visitor activities.
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this campaign. | |
| CampaignId | Int64 |
Campaigns.Id | Pardot ID for the associated campaign. |
| CustomRedirectId | Int64 | Pardot ID of the custom redirect associated with this visitor activity Note: Appears only if this visitor activity has a custom redirect associated with it. | |
| EmailId | Int64 |
Emails.Id | Pardot ID of the email associated with this visitor activity. Appears only if this visitor activity has an email associated with it. |
| EmailTemplateId | Int64 | Pardot ID of the email template associated with this visitor activity Note: This node will only appear if this visitor activity has an email associated with it. | |
| FileId | Int64 |
Files.Id | Pardot ID of the file associated with this visitor activity Note: This node will only appear if this visitor activity has a file associated with it. |
| FormHandlerId | Int64 |
FormHandlers.Id | Pardot ID of the form handler associated with this visitor activity Note: This node will only appear if this visitor activity has a form handler associated with it. |
| FormId | Int64 |
Forms.Id | Pardot ID of the form associated with this visitor activity Note: This node will only appear if this visitor activity has a form associated with it. |
| LandingPageId | Int64 |
LandingPages.Id | Pardot ID of the landing page associated with this visitor activity Note: This node will only appear if this visitor activity has a landing page associated with it. |
| ListEmailId | Int64 |
ListEmail.Id | Pardot ID of the list email associated with this visitor activity Note: This node will only appear if this visitor activity has an email associated with it. |
| VisitId | Int64 |
Visits.Id | Pardot ID for the associated visit. |
| VisitorId | Int64 |
Visitors.Id | Pardot ID for the associated visitor. |
| VisitorPageViewId | Int64 | Pardot ID of the visitor page view associated with this visitor activity Note: This node will only appear if this visitor activity has a visitor page view associated with it. | |
| OpportunityId | Int64 | Pardot ID for the associated opportunity. | |
| ProspectId | Int64 |
Prospects.Id | Pardot ID for the associated prospect. |
| Details | String | Details about this visitor activity such as the name of the object associated with this activity, the search phrase used in a site search query, etc. | |
| MultivariateTestVariationId | Int64 | Pardot ID of the multivariate test variation associated with this visitor activity Note: This node will only appear if this visitor activity has a multivariate test variation associated with it. | |
| PaidSearchAdId | Int64 | Pardot ID of the paid search ad associated with this visitor activity. Appears only if this visitor activity has a paid search ad associated with it. | |
| SiteSearchQueryId | Int64 | Pardot ID of the site search query associated with this visitor activity Note: This node will only appear if this visitor activity has a site search query associated with it. | |
| Type | Integer | Visitor activity's type number. | |
| TypeName | String | Visitor activity's type name. | |
| CreatedAt | Datetime | The timestamp of when this object was created. | |
| UpdatedAt | Datetime | The timestamp of when this object was last updated. |
Retrieve visitors.
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this visitor. | |
| DoNotSell | Boolean | Number of page views by this visitor. | |
| CampaignId | String | Number of page views by this visitor. | |
| IsIdentified | String | Number of page views by this visitor. | |
| PageViewCount | Integer | Number of page views by this visitor. | |
| IpAddress | String | Visitor's IP address. | |
| Hostname | String | Visitor's hostname. | |
| CampaignParameter | String | Visitor's campaign parameter utm_campaign from Google Analytics. | |
| MediumParameter | String | Visitor's medium parameter utm_medium from Google Analytics. | |
| SourceParameter | String | Visitor's source parameter utm_source from Google Analytics. | |
| ContentParameter | String | Visitor's content parameter utm_content from Google Analytics. | |
| TermParameter | String | Visitor's term parameter utm_term from Google Analytics. | |
| CreatedAt | Datetime | The timestamp of when this object was created. | |
| UpdatedAt | Datetime | The timestamp of when this object was last updated. | |
| ProspectId | Int64 |
Prospects.Id | Pardot ID for the associated prospect. |
Retrieve visitors page views.
Sync App はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM VisitorPageViews WHERE VisitId = 22 SELECT * FROM VisitorPageViews WHERE Id >= 22 AND VisitorId = 1234
To retrieve VisitorPageViews that are in the recycle bin in Pardot the following operation is supported:
GETDELETED FROM VisitorPageViews
| Name | Type | References | Description |
| Id [KEY] | Int64 | Pardot ID for this visitor page view. | |
| Url | String | The Url of the page. | |
| Title | String | The Title column of the VisitorsPageViews object. | |
| VisitId | Int64 | Pardot ID for this visit. | |
| VisitorId | Int64 | Pardot ID for the associated visitor. | |
| CampaignId | Int64 | Pardot campaign related to this object. | |
| SalesforceId | String | Salesforce Id of the object. | |
| DurationInSeconds | Integer | Length of this page view. | |
| CreatedAt | Datetime | The timestamp of when this object was created. |
Retrieve visits.
Sync App はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM Visits WHERE Id = 22 SELECT * FROM Visits WHERE VisitorId > 234
To retrieve Visits that are in the recycle bin in Pardot the following operation is supported:
GETDELETED FROM Visits
| Name | Type | References | Description |
| Id [KEY] | Int64 | ID of the object. | |
| VisitorId | Int64 |
Visitors.Id | Pardot ID for the associated visitor. |
| ProspectId | Int64 |
Prospects.Id | Pardot ID for the associated prospect. |
| VisitorPageViewCount | Integer | Number of page views for this visit. | |
| FirstVisitorPageViewAt | Datetime | Time of first page view for this visit. | |
| LastVisitorPageViewAt | Datetime | Time of last page view for this visit. | |
| DurationInSeconds | Integer | Length of this visit. | |
| CampaignParameter | String | Visit's campaign parameter utm_campaign from Google Analytics. | |
| MediumParameter | String | Visit's medium parameter utm_medium from Google Analytics. | |
| SourceParameter | String | Visit's source parameter utm_source from Google Analytics. | |
| ContentParameter | String | Visit's content parameter utm_content from Google Analytics. | |
| TermParameter | String | Visit's term parameter utm_term from Google Analytics. | |
| CreatedAt | Datetime | The timestamp of when this object was created. | |
| UpdatedAt | Datetime | The timestamp of when this object was last updated. |
| プロパティ | 説明 |
| AuthScheme | The type of authentication to use when connecting to Salesforce Marketing Cloud Account Engagement. |
| Schema | Specify the Salesforce Marketing Cloud Account Engagement API version to use. SalesforcePardotV5 is the rebuilt API. |
| BusinessUnitID | Your Salesforce Marketing Cloud Account Engagement Business Unit ID (BU). Required when connecting via OAuth 2.0. |
| IsDemoAccount | Whether the provided account is a demo account or not. |
| UseSalesforceSandbox | A boolean determining if the connection should be made to a Salesforce sandbox account. |
| User | The user that is SSO-enabled. |
| Password | The password of the user that is SSO-enabled. |
| SecurityToken | The security token used to authenticate access to the Salesforce Marketing Cloud Account Engagement account. |
| プロパティ | 説明 |
| BulkMode | Determines if Bulk APIs will be used and if the driver should wait for the results. |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthGrantType | 選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。 |
| プロパティ | 説明 |
| OAuthJWTCert | JWT 証明書のストア。 |
| OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
| OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。 |
| OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。 |
| OAuthJWTIssuer | Java Web Token の発行者。 |
| OAuthJWTSubject | アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| Archived | Specify whether to get archived or unarchived records. |
| IncludeMessage | Valid only for SalesforcePardotV3 and SalesforcePardotV4. Set this property when querying Emails table. If false, the response does not include the html or text body of the email message. Default value is true. |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| MaxThreads | Specifies the number of concurrent requests. |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| Pagesize | Salesforce Marketing Cloud Account Engagement から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| ResponseMode | The Pardot API supports several output formats, each of which returns different levels of detail in the response. Supported output formats include: full - Returns all supported data for the Pardot object and all objects associated with it. simple - Returns all supported data for for the Pardot object. bulk -- Returns basic data for an object. Does not provide object associations and total object count. The default value is simple. Not applicable for SalesforcePardotV5 schema. |
| ServerTimeZone | Relevant to V3/V4 schema. Specifies the timezone in which the server returns datetime fields. |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
| ValueDelimiter | The delimiter used for multi-select fields values. |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AuthScheme | The type of authentication to use when connecting to Salesforce Marketing Cloud Account Engagement. |
| Schema | Specify the Salesforce Marketing Cloud Account Engagement API version to use. SalesforcePardotV5 is the rebuilt API. |
| BusinessUnitID | Your Salesforce Marketing Cloud Account Engagement Business Unit ID (BU). Required when connecting via OAuth 2.0. |
| IsDemoAccount | Whether the provided account is a demo account or not. |
| UseSalesforceSandbox | A boolean determining if the connection should be made to a Salesforce sandbox account. |
| User | The user that is SSO-enabled. |
| Password | The password of the user that is SSO-enabled. |
| SecurityToken | The security token used to authenticate access to the Salesforce Marketing Cloud Account Engagement account. |
The type of authentication to use when connecting to Salesforce Marketing Cloud Account Engagement.
Specify the Salesforce Marketing Cloud Account Engagement API version to use. SalesforcePardotV5 is the rebuilt API.
Specify the Salesforce Marketing Cloud Account Engagement API version to use. SalesforcePardotV5 is the rebuilt API.
Your Salesforce Marketing Cloud Account Engagement Business Unit ID (BU). Required when connecting via OAuth 2.0.
Whether the provided account is a demo account or not.
If set to true, all the requests will be made to the Pardot demo endpoints.
A boolean determining if the connection should be made to a Salesforce sandbox account.
To connect to a Salesforce sandbox account, set UseSalesforceSandbox = true and append the sandbox name to the end of the user name. For example, if your user name is "user", and sandbox name in Salesforce is "sandbox", the specified User should appear as "user.sandbox".
The user that is SSO-enabled.
An SSO-enabled user is one who can log in to the Pardot user interface (https://pi.pardot.com) using "Log In with Salesforce" or who can access Pardot using the Pardot Lightning App. Together with Password, this field is used for OAuth flow with PASSWORD grant type.
The password of the user that is SSO-enabled.
An SSO-enabled user is one who can log in to the Pardot user interface (https://pi.pardot.com) using "Log In with Salesforce" or who can access Pardot using the Pardot Lightning App. Together with User, this field is used for OAuth flow with PASSWORD grant type.
The security token used to authenticate access to the Salesforce Marketing Cloud Account Engagement account.
Together with User and Password, this field can be used to authenticate against the Salesforce server. This is only required if your organization is setup to require it. A security token can be obtained by going to your profile information and resetting your security token. If your password is reset, you will also need to reset the security token.
このセクションでは、本プロバイダーの接続文字列で設定可能なBulkAPI プロパティの全リストを提供します。
| プロパティ | 説明 |
| BulkMode | Determines if Bulk APIs will be used and if the driver should wait for the results. |
Determines if Bulk APIs will be used and if the driver should wait for the results.
This property can have the following values:
Use BulkMode=BulkWaitForResults if you want to know if a job failed or not, and get more information about the rows that failed by querying LastResultInfo#TEMP table. Since a bulk job may take some initial time until it starts getting processed, this will cause some delays. If you do not want to wait until the job is finished, you can use BulkMode=Bulk
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthGrantType | 選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。 |
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。
ほとんどの場合、デフォルトのグラント種別は変更すべきではありません。 最も一般的なOAuth グラント種別とそれぞれのメリット・デメリットについては、https://oauth.net/2/grant-types/ を参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthJWTCert | JWT 証明書のストア。 |
| OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
| OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。 |
| OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。 |
| OAuthJWTIssuer | Java Web Token の発行者。 |
| OAuthJWTSubject | アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。 |
JWT 証明書のストア。
クライアント証明書のための証明書ストア名。
OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword でパスワードを指定します。
OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。 詳しくは、OAuthJWTCertSubject フィールドを参照してください。
証明書ストアの指定はプラットフォームに依存します。
Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。
| MY | 個人証明書と関連付けられた秘密キーを格納している証明書ストア。 |
| CA | 証明機関の証明書。 |
| ROOT | ルート証明書。 |
| SPC | ソフトウェア発行元証明書。 |
Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。
証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ(例えば、PKCS12証明書ストア)に設定する必要があります。
JWT 証明書を格納するキーストアの種類。
このプロパティには次の値の一つを設定できます。
| USER | Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。 Note:この種類はJava では利用できません。 |
| MACHINE | Windows の場合、この証明書ストアがシステムストアであることを指定します。 Note:この種類はJava では利用できません。 |
| PFXFILE | この証明書ストアは、証明書を含むPFX(PKCS12)ファイルの名前です。 |
| PFXBLOB | この証明書ストアは、PFX(PKCS12)形式の証明書ストアを表すBase-64でエンコードされた文字列です。 |
| JKSFILE | この証明書ストアは、証明書を含むJava key store(JKS)ファイルの名前です。 Note:この種類はJava のみで利用できます。 |
| JKSBLOB | この証明書ストアは、Java key store(JKS)形式の証明書ストアを表すBase-64でエンコードされた文字列です。 Note:この種類はJava のみで利用できます。 |
| PEMKEY_FILE | この証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。 |
| PEMKEY_BLOB | この証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。 |
| PUBLIC_KEY_FILE | この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。 |
| PUBLIC_KEY_BLOB | この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。 |
| SSHPUBLIC_KEY_FILE | この証明書ストアは、SSH 公開キーを含むファイルの名前です。 |
| SSHPUBLIC_KEY_BLOB | この証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。 |
| P7BFILE | この証明書ストアは、証明書を含むPKCS7 ファイルの名前です。 |
| PPKFILE | この証明書ストアは、PuTTY 秘密キー(PPK)を含むファイルの名前です。 |
| XMLFILE | この証明書ストアは、XML 形式の証明書を含むファイルの名前です。 |
| XMLBLOB | この証明書ストアは、XML 形式の証明書を含む文字列の名前です。 |
| BCFKSFILE | この証明書ストアは、Bouncy Castle キーストアを含むファイルの名前です。 |
| BCFKSBLOB | この証明書ストアは、Bouncy Castle キーストアを含む文字列(Base-64エンコード)です。 |
OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
このプロパティは、証明書ストアを開くために必要なパスワードを指定します。ただし、ストアの種類がパスワードを必要とする場合に限ります。 パスワードが必要かどうかを判断するには、ご利用の証明書ストアのドキュメントまたは設定を参照してください。
OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。
このプロパティの値は、ストアで一致する証明書を検索するために使用されます。検索プロセスは以下のように動作します。
値を '*' に設定すると、ストアの先頭の証明書が自動的に選択されます。 証明書のサブジェクトは識別名フィールドおよび値のカンマ区切りのリストです。 例:CN=www.server.com, OU=test, C=US, [email protected]。一般的なフィールドには以下のものが含まれます。
| フィールド | 説明 |
| CN | 共通名。一般的には、www.server.com のようなホスト名です。 |
| O | 法人名 |
| OU | 法人の部署名 |
| L | 法人の住所(市町村名) |
| S | 法人の住所(都道府県) |
| C | 国名 |
| E | E メールアドレス |
フィールド値にカンマが含まれる場合は、引用符で囲んでください。例:"O=ACME, Inc."。
Java Web Token の発行者。
Java Web Token の発行者。 通常は、OAuth アプリケーションのクライアントId またはE メールアドレスとなります。
アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。
アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクトです。通常は、ユーザーのアカウント名またはE メールアドレスとなります。
このセクションでは、本プロバイダーの接続文字列で設定可能な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 | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
Note:デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。
次の表は、サポートされている各プロトコルのポート番号情報です。
| プロトコル | デフォルトポート | 説明 |
| TUNNEL | 80 | Sync App がSalesforce Marketing Cloud Account Engagement への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。 |
| SOCKS4 | 1080 | Sync App がSalesforce Marketing Cloud Account Engagement への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | Sync App がSalesforce Marketing Cloud Account Engagement にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで使用するTCP ポートを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。
この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。
クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。
その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
認証タイプは次のいずれかです。
"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyUser に設定する値 |
| BASIC | プロキシサーバーに登録されているユーザーのユーザー名。 |
| DIGEST | プロキシサーバーに登録されているユーザーのユーザー名。 |
| NEGOTIATE | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NTLM | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。
ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyPassword に設定する値 |
| BASIC | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| DIGEST | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| NEGOTIATE | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NTLM | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。
ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。
| AUTO | デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。
例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります:INFO;EXEC;SSL。
Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。
利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は%APPDATA%\\CData\\SalesforcePardot Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます:
| プラットフォーム | %APPDATA% |
| Windows | APPDATA 環境変数の値 |
| Linux | ~/.config |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。
レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| Archived | Specify whether to get archived or unarchived records. |
| IncludeMessage | Valid only for SalesforcePardotV3 and SalesforcePardotV4. Set this property when querying Emails table. If false, the response does not include the html or text body of the email message. Default value is true. |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| MaxThreads | Specifies the number of concurrent requests. |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| Pagesize | Salesforce Marketing Cloud Account Engagement から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| ResponseMode | The Pardot API supports several output formats, each of which returns different levels of detail in the response. Supported output formats include: full - Returns all supported data for the Pardot object and all objects associated with it. simple - Returns all supported data for for the Pardot object. bulk -- Returns basic data for an object. Does not provide object associations and total object count. The default value is simple. Not applicable for SalesforcePardotV5 schema. |
| ServerTimeZone | Relevant to V3/V4 schema. Specifies the timezone in which the server returns datetime fields. |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
| ValueDelimiter | The delimiter used for multi-select fields values. |
Specify whether to get archived or unarchived records.
This property is only valid for tables OneToOneEmails and EmailTemplates of SalesforcePardot.
Valid only for SalesforcePardotV3 and SalesforcePardotV4. Set this property when querying Emails table. If false, the response does not include the html or text body of the email message. Default value is true.
Set this property when querying Emails table. If false, the response does not include the html or text body of the email message. Default value is true.
集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。
Specifies the number of concurrent requests.
This property allows you to issue multiple requests simultaneously, thereby improving performance. However, the number of concurrent requests should be reduced to avoid the following error "You have exceeded your concurrent request limit".
特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。
Note: 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
複数のプロパティをセミコロン区切りリストで指定します。
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
Salesforce Marketing Cloud Account Engagement から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。 ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。
テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"
すべてのテーブルのすべての擬似カラムを含めるには、次のようにします:"*=*"
The Pardot API supports several output formats, each of which returns different levels of detail in the response. Supported output formats include: full - Returns all supported data for the Pardot object and all objects associated with it. simple - Returns all supported data for for the Pardot object. bulk -- Returns basic data for an object. Does not provide object associations and total object count. The default value is simple. Not applicable for SalesforcePardotV5 schema.
The Pardot API supports several output formats, each of which returns different levels of detail in the response. The default value is simple. Not applicable for SalesforcePardotV5 schema.
Relevant to V3/V4 schema. Specifies the timezone in which the server returns datetime fields.
Applicable to the V3/V4 schema. The Account Engagement Server returns datetime values based on the user's configured timezone. To find the timezone, go to Account Engagement User Management > Users, select the authenticated user, and locate the Timezone field. For instance, if the Timezone is listed as (GMT-08:00) America - Los Angeles, use this information to specify the timezone in IANA format, such as America/Los_Angeles.
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。
{
"MyView": {
"query": "SELECT * FROM Prospects WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 例:UserDefinedViews=C:\Path\To\UserDefinedViews.json。 このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
詳しくは、ユーザー定義ビュー を参照してください。
The delimiter used for multi-select fields values.
The delimiter used for multi-select fields values.