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 エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。 Sync App は、Salesforce Marketing Cloud Account Engagement API を使用してサポートされているフィルタを処理します。その他のフィルタは、Sync App 内でクライアント側で処理されます。
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. |
ストアドプロシージャはファンクションライクなインターフェースで、Salesforce Marketing Cloud Account Engagement の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずSync App の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにSalesforce Marketing Cloud Account Engagement から関連するレスポンスデータを返します。
| Name | Description |
| AssignProspect | Update the locations for a shipping zone. |
| AssignProspectAccount | Update the locations for a shipping zone. |
| SendEmail | Update the locations for a shipping zone. |
| UnAssignProspect | Update the locations for a shipping zone. |
| UnDeleteOpportunity | Update the locations for a shipping zone. |
Update the locations for a shipping zone.
EXEC AssignProspect ProspectId = 432, AssignmentType = 'user', AssignTo = 101 EXEC AssignProspect ProspectId = 432, AssignmentType = 'email', AssignTo = '[email protected]'
| Name | Type | Required | Description |
| ProspectId | String | False | The ID of the prospect. |
| AssignmentType | String | False | The type of the assignment. Can be one of: email, user, group. |
| AssignTo | String | False | The value to assign to. If the type is user or group the value should be the respective id. |
| Name | Type | Description |
| Success | String | This value shows a boolean indication of whether the operation was successful or not. |
Update the locations for a shipping zone.
EXEC AssignProspectAccount UserId = 432, ProspectAccountId = 501
| Name | Type | Required | Description |
| ProspectAccountId | String | False | The ID of the prospect account. |
| UserId | String | False | The ID of the user. |
| Name | Type | Description |
| Success | String | This value shows a boolean indication of whether the operation was successful or not. |
If using a Windows application, set Authmode to App. If using a Web app, set Authmode to Web and specify the Verifier obtained by GetOAuthAuthorizationUrl.
| Name | Type | Required | Description |
| Authmode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.
使用できる値は次のとおりです。APP, WEB デフォルト値はAPPです。 |
| Verifier | String | False | The verifier token returned by Salesforce after using the URL obtained with GetOAuthAuthorizationUrl. |
| Scope | String | False | A space-separated scope of permissions you need the app to have access to. The available values are api, chatter_api, full, id, refresh_token, visualforce, and web. For details, refer to: http://help.salesforce.com/help/doc/en/remoteaccess_oauth_scopes.htm. |
| CallbackUrl | String | False | The page to return the Salesforce app after authentication has been completed. |
| Api_Version | String | False | The API version you would like to authenticate to.
デフォルト値は49.0です。 |
| State | String | False | Any value that you wish to be sent with the callback. |
| GrantType | String | False | Authorization grant type. Only available for OAuth 2.0. If left unspecified, the default value is the value of the OAuthGrantType connection property.
使用できる値は次のとおりです。CODE, PASSWORD |
| Name | Type | Description |
| Scope | String | The scope of permissions for the app. |
| Instance_Url | String | The instance URL being used by the app. |
| Id | String | The Id associated with the OAuth token. |
| Issued_At | String | When the token was issued at. |
| Signature | String | A signature for the OAuth token. |
| OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
| OAuthAccessToken | String | The OAuth access token. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps.
| Name | Type | Required | Description |
| CallbackUrl | String | False | The page to return the user after authorization is complete. |
| Scope | String | False | A space-separated scope of permissions you need the app to have access to. The available values are api, chatter_api, full, id, refresh_token, visualforce, web. For more details, refer to: http://help.salesforce.com/help/doc/en/remoteaccess_oauth_scopes.htm. |
| Grant_Type | String | False | The type of authorization to be granted for your app. If this is set to code, the stored procedure will return an authorization URL containing the verifier code in a query string parameter, which you will need to submit back with the GetOAuthAccessToken stored procedure. Implicit will cause the OAuth access token to be returned directly in the URL.
使用できる値は次のとおりです。Implicit, Code |
| State | String | False | Any value that you wish to be sent with the callback. |
| Name | Type | Description |
| Url | String | The authorization url. |
Refreshes the OAuth token or session id after the session has expired. Your OAuth application must have the refresh_token scope enabled.
| Name | Type | Required | Description |
| OAuthRefreshToken | String | True | The refresh token returned when the OAuth Token was first created. |
| Name | Type | Description |
| Instance_Url | String | Instance of Salesforce the OAuth token is valid for. |
| OAuthAccessToken | String | The OAuth token. |
| Id | String | Id associated with the OAuth Token. |
| Issued_At | String | When the OAuth Token was issued. |
| Signature | String | Signature of the OAuth Token. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
Update the locations for a shipping zone.
One of: ProspectId, ProspectEmail or ListId.
One of: TemplateId or (TextContent, Name, Subject and (FromEmail, FromName or FromUserId))
Examples:
EXEC SendEmail CampaignId = 20006, ProspectId = 1807618, TemplateId = 13598 EXEC SendEmail CampaignId = 20006, ProspectEmail = '[email protected]', TextContent = 'content', Name = 'email name', Subject = 'email subject', FromUserId = 24486 EXEC SendEmail CampaignId = 20006, ListId = 20104, TextContent = 'content', Name = 'email name', Subject = 'email subject', FromEmail = '[email protected]', FromName = 'Name Surname'
| Name | Type | Required | Description |
| CampaignId | String | False | The ID of the campaign. |
| ProspectId | String | False | The ID of the prospect. |
| ProspectEmail | String | False | The email of the prospect. |
| ListId | String | False | The ID of the lists to send to. |
| TemplateId | String | False | The ID of the prospect. |
| TextContent | String | False | The ID of the prospect. |
| Name | String | False | The ID of the prospect. |
| Subject | String | False | The ID of the prospect. |
| FromEmail | String | False | The ID of the prospect. |
| FromName | String | False | The ID of the prospect. |
| FromUserId | String | False | The ID of the prospect. |
| ReplyToEmail | String | False | The ID of the prospect. |
| OperationalEmail | String | False | The ID of the prospect. |
| HTMLContent | String | False | The ID of the prospect. |
| Name | Type | Description |
| Success | String | This value shows a boolean indication of whether the operation was successful or not. |
Update the locations for a shipping zone.
EXEC UnAssignProspect ProspectId = 432
| Name | Type | Required | Description |
| ProspectId | String | False | The ID of the prospect. |
| Name | Type | Description |
| Success | String | This value shows a boolean indication of whether the operation was successful or not. |
Update the locations for a shipping zone.
EXEC UnDeleteOpportunity Id = 600
| Name | Type | Required | Description |
| Id | String | False | The ID of the opportunity. |
| Name | Type | Description |
| Success | String | This value shows a boolean indication of whether the operation was successful or not. |
CData Sync App は、Salesforce Marketing Cloud Account Engagement Pardot API v5 オブジェクトをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。 Sync App は、Salesforce Marketing Cloud Account Engagement API を使用してサポートされているフィルタを処理します。その他のフィルタは、Sync App 内でクライアント側で処理されます。
テーブル では、利用可能な標準テーブルの例について説明します。
Sync App はSalesforce Marketing Cloud Account Engagement のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| CustomFields | Retrieve custom fields metadata. |
| CustomRedirects | Track links on your website or third-party site with Pardot custom redirects. |
| DynamicContent | Retrieve a collection of dynamic content |
| DynamicContentVariations | Retrieve a collection of Dynamic Content Variations |
| EmailTemplates | Query email templates. |
| Files | Upload images and other files to use in your Pardot emails, forms, and landing pages. |
| FormFields | Retrieve form fields to capture and store data related to leads, contacts, accounts, and other objects within the system. |
| FormHandlers | Retrieve,Create,Updata,Delete a collection of Form Handlers |
| FormHandlersFields | Retrieve,Create,Update,Delete a collection of Form Handler Stages |
| Forms | Retrieve forms. |
| LandingPages | Retrieving a collection of landing pages |
| LayoutTemplates | Retrieve and modify layout templates. |
| ListMemberships | Retrieve,Create,Update,Delete a collection of list memberships |
| Lists | Retrieve and modify lists. |
| ProspectAccounts | Query the available prospect accounts. |
| Prospects | Retrieve and modify prospects. |
| Tags | Retrieve tags. |
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 | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
Pardot ID for this custom field. | |
| Name | String | False |
Custom field's name. | |
| FieldId | String | False |
User-defined ID for the custom field. | |
| Type | String | False |
The type of custom field. Possible values: Text, Radio Button, Checkbox, Dropdown, Textarea, Multi-Select, Hidden, Number, Date, CRM User | |
| CreatedAt | Datetime | True |
Time custom field was created in Pardot. | |
| UpdatedAt | Datetime | True |
Last time custom field was updated. | |
| CreatedById | Int64 | True |
ID of the individual who created this object. | |
| UpdatedById | Int64 | True |
ID of the individual who last updated this object. | |
| IsRecordMultipleResponses | Boolean | False |
If true, this custom field will record multiple responses. | |
| IsUseValues | Boolean | False |
If true, this custom field will use predefined values. | |
| SalesforceId | String | False |
The alpha-numeric Id of the Salesforce Org. | |
| IsRequired | Boolean | False |
True if the custom field is required. | |
| isAnalyticsSynced | Boolean | True |
True if the object is synced to Analytics. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| ValuesPrefill | String |
Write-Only field on create operation. Possible values: Countries, Country Codes, US States, US State Codes, Canadian Provinces, Canadian Province Codes, US States and Canadian Provinces, US State and Canadian Province Codes, Japanese Prefectures, Japanese Prefecture Codes |
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 | False |
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 | False |
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'. | |
| TagReplacementLanguage | String | True |
Merge language of the dynamic content. Can be 'pml', 'hml', or 'undetermined'. | |
| 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 | False |
ID of the folder containing this object. | |
| TrackerDomainId | Int64 | False |
The ID of the tracker domain associated with this object. | |
| BasedOnProspectApiFieldId | String | False |
The name of the Account Engagement prospect field that the Dynamic Content is mapped to. On standard fields the value is the name of the field. For example, 'firstName'. |
Retrieve a collection of Dynamic Content Variations
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
Pardot ID for this dynamic content variation. | |
| Comparison | String | True |
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. | |
| Operator | String | False |
The operator found in the logic used to set the criteria for a variation. Possible values: is, contains, between, less-than, less-than-or-equal, greater-than, greater-than-or-equal | |
| Content | String | False |
The text content of the variation. | |
| DynamicContentId | Int64 | False |
ID of the dynamic content this variation is associated with. | |
| Value1 | String | False |
The value found in the logic used to set the criteria for a variation. All operators except between require one value. | |
| Value2 | String | False |
The value found in the logic used to set the criteria for a variation when using the between operator. All other operators don't support two values. |
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 form fields to capture and store data related to leads, contacts, accounts, and other objects within the system.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
ID of the form field. | |
| FormId | Int64 | False |
The ID of the form the Form Field belongs to. | |
| Type | String | False |
Data type of the object. Data Type can be: text, radio button, checkbox, dropdown, textarea, hidden, date, multi-select. | |
| DataFormat | String | False |
The field's data format. Data Format can be: text, number, email, email with valid mail server, email not from isps and free email providers. Default 'text'. | |
| ProspectApiFieldId | String | False |
The name of the Pardot prospect field that the form field is mapped to. For example, | |
| Label | String | False |
Label of the form field. | |
| Description | String | False |
User-assigned description for the field. This field isn't queryable. | |
| ErrorMessage | String | False |
Error to display when the field isn't submitted correctly. | |
| CssClasses | String | False |
CSS class to apply to the paragraph element that wraps the form input and label. | |
| IsRequired | Boolean | False |
Set to true to make populating this field required for form submission. Default false. | |
| IsAlwaysDisplay | Boolean | False |
Set to true to always display this field, even if a value has already been collected for the prospect. Default false. | |
| isMaintainInitialValue | Boolean | False |
Set to true to maintain the prospect field value of the initial form submission. Subsequent submissions with new values will be ignored. Default false. | |
| isDoNotPrefill | Boolean | False |
Set to true to prevent prospect data from being pre-filled into the field. Default false. | |
| SortOrder | Int64 | True |
Each field in a given form will be assigned a number that indicates the display order. | |
| HasDependents | Boolean | True |
Set to true if this field has Dependents. | |
| HasProgressives | Boolean | True |
Set to true if this field has Progressives. | |
| HasValues | Boolean | True |
Set to true if this field has Values. | |
| CreatedAt | Datetime | True |
Creation time of the object. | |
| UpdatedAt | Datetime | True |
Last update time of the object. | |
| CreatedById | Int64 | True |
ID of the user who created this object. | |
| UpdatedById | Int64 | True |
ID of the user who updated this object. |
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 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 | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
Pardot ID for this form. | |
| Name | String | False |
Form's name. | |
| CampaignId | Int64 | False |
Campaigns.Id |
Pardot ID of the campaign associated with this form. |
| EmbedCode | String | True |
The code used to embed the form on your webpage. | |
| SalesforceId | String | True |
The alpha-numeric Id of the Salesforce Org. | |
| LayoutTemplateId | Int64 | False |
The ID of the layout template associated with this object | |
| SubmitButtonText | String | False |
The label used for the submit button | |
| BeforeFormContent | String | False |
The HTML text displayed above the form | |
| AfterFormContent | String | False |
The HTML text displayed below the form | |
| ThankYouContent | String | False |
The HTML text displayed after the form is submitted | |
| ThankYouCode | String | False |
Thank you code is typically Javascript used to call other systems like Google Conversion Tracking | |
| IsAlwaysDisplay | Boolean | False |
Always display form after submission. Disable the 10 minute waiting period after submitting a form | |
| RedirectLocation | String | False |
Redirect to this URL instead of showing the | |
| IsUseRedirectLocation | Boolean | True |
When redirect location is valid and enabled. | |
| FontSize | String | False |
Possible values: default, 8pt, 10pt, 12pt, 14pt , 18pt, 24pt, 36pt. | |
| FontFamily | String | False |
Possible values: default, | |
| FontColor | String | False |
6 digit number in hexadecimal format such as #123456 | |
| LabelAlignment | String | False |
Possible values: default, above, left | |
| RadioAlignment | String | False |
Possible values: default, horizontal, stacked | |
| CheckboxAlignment | String | False |
Possible values: default, horizontal, stacked | |
| RequiredCharacter | String | False |
Possible values: default , * | |
| IsCookieless | String | False |
Kiosk/Data Entry Mode: Do not cookie browser as submitted prospect | |
| ShowNotProspect | Boolean | False |
Include | |
| IsCaptchaEnabled | Boolean | False |
Enable explicit bot protecting using reCAPTCHA | |
| IsDeleted | Boolean | True |
True if the object is in the recycle bin in Pardot. | |
| TrackerDomainId | Int64 | False |
The ID of the tracker domain associated with this object. | |
| FolderId | Int64 | False |
ID of the folder containing 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. | |
| CreatedById | Int64 | True |
ID of the individual who created this object. | |
| UpdatedById | Int64 | True |
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 | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
ID of the object. | |
| Name | String | False |
Name of the object for identification in Pardot. | |
| SalesforceId | String | True |
ID of the Salesforce object representing this object. | |
| IsDeleted | Boolean | True |
True if the object is in the recycle bin in Pardot. | |
| CreatedById | Int64 | True |
ID of the user who created this object. | |
| CreatedAt | Datetime | True |
Creation time of the object. | |
| UpdatedAt | Datetime | True |
Last update time of the object. | |
| UpdatedById | Int64 | True |
ID of the user who last updated this object. | |
| CampaignId | Int64 | False |
Pardot Campaign related to this object. | |
| FormId | Int64 | False |
ID of the form related to this object. | |
| LayoutTemplateId | Int64 | False |
ID of the layout template related to this object. | |
| Title | String | False |
The landing page's title. | |
| Description | String | False |
The landing page's meta description. Used for SEO. | |
| IsDoNotIndex | Boolean | False |
True if the landing page is hidden from search engine indexing. | |
| LayoutType | String | True |
Specifies where the landing page was created. Possible values are Layout Template, Landing Page Builder, Legacy Page Builder, Salesforce Builder. | |
| ScriptFragment | String | False |
Script specified for the landing page. Available only on read requests. | |
| LayoutCss | LayoutCss | True |
CSS code for the layout template. Available only on read requests. | |
| LayoutCssGenerated | String | True |
Generated CSS code for the layout template. Available only on read requests. | |
| LayoutTableBorder | Int | True |
Specifies the layout table border width. | |
| RedirectLocation | String | False |
The redirect URL used if the prospect is redirected instead of showing the thank you content. | |
| IsUseRedirectLocation | Boolean | True |
True if the prospect is redirected instead of showing the form thank you content. | |
| BitlyIsPersonalized | Boolean | True |
True if the object has a bitly URL that is personalized. | |
| BitlyShortUrl | String | True |
Bitly URL if present. | |
| Url | String | True |
Link for the landing page. | |
| VanityUrl | String | True |
Vanity URL if present. | |
| VanityUrlPath | String | False |
The unique path for the asset, used to create the vanity URL. | |
| TrackerDomainId | Int64 | False |
The ID of the tracker domain associated with this object. | |
| FolderId | Int64 | False |
ID of the folder containing this object. | |
| ArchiveDate | Date | False |
The landing page's archive date('yyyy-mm-dd'). | |
| Content | String | False |
The editable content if using a stock template. This field isn’t queryable. | |
| OpeningGeneralContent | String | False |
If using a layout template without pardot-region attributes, this value is displayed in the %%form-opening-general-content%% tag. This field isn’t queryable. | |
| RegionContent | String | False |
If using a layout template that contains pardot-region attributes, the values here override the default values in the layout template. This field isn’t queryable. |
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. |
Query the available 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 | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
ID of the object. | |
| Name | String | True |
Name of the object. | |
| SalesforceId | String | True |
ID of the Salesforce object representing this object. | |
| IsDeleted | Boolean | True |
True if the object is in the recycle bin in Pardot. | |
| AnnualRevenue | String | True |
Annual Revenue of the object. | |
| BillingAddressOne | String | True |
Billing Address of the object. | |
| BillingAddressTwo | String | True |
Second Billing Address of the object. | |
| BillingCity | String | True |
City of the object. | |
| BillingCountry | String | True |
County of the object. | |
| BillingState | String | True |
State of the object. | |
| BillingZip | String | True |
Zip of the object. | |
| Description | String | True |
Description of the object. | |
| Employees | String | True |
Employees of the object. | |
| Fax | String | True |
Fax of the object. | |
| Industry | String | True |
Industry of the object. | |
| Number | String | True |
Number of the object. | |
| Ownership | String | True |
Ownership of the object. | |
| Phone | String | True |
Phone Number of the object. | |
| Rating | String | True |
Rating of the object. | |
| ShippingAddressOne | String | True |
Shipping Address of the object. | |
| ShippingAddressTwo | String | True |
Second Shipping Address of the object. | |
| ShippingCity | String | True |
Shipping Address city of the object. | |
| ShippingCountry | String | True |
Shipping Address country of the object. | |
| ShippingState | String | True |
Shipping Address state of the object. | |
| ShippingZip | String | True |
Shipping Address zip of the object. | |
| Sic | String | True |
SIC of the object. | |
| Site | String | True |
Site of the object. | |
| TickerSymbol | String | True |
Ticker Symbol of the object. | |
| Type | String | True |
Type of the object. | |
| Website | String | True |
Website of the object. | |
| CreatedAt | Datetime | True |
Creation time of the object. | |
| UpdatedAt | Datetime | True |
Last update time of the object. | |
| AssignedToId | Int64 | True |
ID of the user who the object record is assigned to. | |
| 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
To perform UPSERT operations on the Prospects table, you must enable either Bulk or BulkWaitForResults in the BulkMode property. You must also provide the name of the column which serves as a record identifier in the UpsertKeyColumn column, as shown in the following query:
INSERT INTO Prospects#TEMP (FirstName, Email, CampaignId, UpsertKeyColumn) VALUES (‘John', '[email protected]', '16201', 'email') INSERT INTO Prospects#TEMP (FirstName, Email, CampaignId, UpsertKeyColumn) VALUES (‘Jane’, '[email protected]', '16201', 'email') UPSERT INTO Prospects (FirstName, Email, CampaignId, UpsertKeyColumn) SELECT FirstName, Email, CampaignId, UpsertKeyColumn FROM Prospects#TEMPThe identifier column can be Id, Email, or SalesforceId. If the UpsertKeyColumn is not specified, by default, Id is required or used as an identifier column, as shown in the following query:
INSERT INTO Prospects#TEMP (FirstName, Email, CampaignId, Id) VALUES (‘John', '[email protected]', '16201', 55187773) INSERT INTO Prospects#TEMP (FirstName, Email, CampaignId,Id) VALUES (Jane’, '[email protected]', '16201', 55187771) UPSERT INTO Prospects (FirstName, Email, CampaignId, Id) SELECT FirstName, Email, CampaignId, Id FROM Prospects#TEMP
| 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. |
Retrieve tags.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Int64 | True |
Pardot ID for this tag. | |
| Name | String | False |
The name of the tag. | |
| ObjectCount | Int64 | True |
Number of objects tagged with the tag. | |
| CreatedAt | Datetime | True |
Creation time of the tag. | |
| UpdatedAt | Datetime | True |
Last update time of the tag. | |
| CreatedById | Int64 | True |
ID of the user who created this tag. | |
| UpdatedById | Int64 | True |
ID of the user who last updated this tag. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| Account | Use the account resource to learn about the current user's Pardot account. |
| Campaigns | Retrieve and modify campaigns. |
| 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. |
| 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 |
| ListEmailStats | Query statistical information for a list email, such as the number of clicks, opens, and opt-outs. |
| Opportunities | Retrieve a collection of opportunities |
| ReplyToOptions | Query the replyTo options of email templates. |
| SenderOptions | Query the sender options of email templates. |
| TaggedObjects | Retrieve tagged objects. |
| 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. |
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.
The Sync App uses the Salesforce Marketing Cloud Account Engagement API to process filters that refer to Id, CreatedAt, and UpdatedAt.
For example, the following queries are processed server side:
SELECT * FROM EngagementStudioProgram; SELECT * FROM EngagementStudioProgram WHERE Id = 239309; SELECT * FROM EngagementStudioProgram WHERE Id IN (239309, 239637, 239643); SELECT Id, Name, CreatedAt FROM EngagementStudioProgram WHERE CreatedAt > '2024-03-25 06:18:22.0'; SELECT Id, Name, CreatedAt FROM EngagementStudioProgram WHERE CreatedAt >= '2024-03-25 06:18:22.0'; SELECT Id, Name, UpdatedAt FROM EngagementStudioProgram WHERE UpdatedAt < '2024-03-21 09:46:27.0'; SELECT Id, Name, UpdatedAt FROM EngagementStudioProgram WHERE UpdatedAt <= '2024-03-21 09:46:27.0'
| 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. |
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. |
Query statistical information for a list email, such as the number of clicks, opens, and opt-outs.
| Name | Type | References | Description |
| ListEmailId [KEY] | Int64 | Pardot ID for this list email. | |
| Sent | Integer | Sent status. | |
| Delivered | Integer | Delivered status. | |
| TotalClicks | Integer | Number of total clicks. | |
| UniqueClicks | Integer | Number of 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 | Float | Delivery rate. | |
| OpensRate | Float | Open rate. | |
| ClickThroughRate | Float | Click through rate. | |
| UniqueClickThroughRate | Float | Unique click through rate. | |
| ClickOpenRatio | Float | Click to open ration. | |
| OptOutrate | Float | Opt rate. | |
| SpamComplaintRate | Float | Spam complaint rate. |
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. |
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. |
Retrieve tagged objects.
| Name | Type | References | Description |
| Id [KEY] | Int64 | The Pardot ID of the tagged object. | |
| TagId | Int64 |
Tags.Id | The Pardot ID of the tag. |
| ObjectType | String | The type of object associated with the tag. Object type might be: campaign,custom-field,custom-redirect,dynamic-content,email,email=template,file,form-field,form-handler,form,landing-page,layout-template,prospect,user
使用できる値は次のとおりです。campaign, custom-field, custom-redirect, dynamic-content, email, email-template, file, form-field, form-handler, form, landing-page, layout-template, prospect, user | |
| ObjectId | Int64 | The Pardot ID of the object. | |
| ObjectName | String | The name of the tagged object. | |
| CreatedAt | Datetime | The date and time when the tag was added to the object. | |
| CreatedById | Int64 | The ID of the user who added the tag to the object. |
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. |
ストアドプロシージャはファンクションライクなインターフェースで、Salesforce Marketing Cloud Account Engagement の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずSync App の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにSalesforce Marketing Cloud Account Engagement から関連するレスポンスデータを返します。
| Name | Description |
| CreateStudioProgram | Create an Engagement Studio Program using an Engagement Studio Program structure. |
| SendEmail | Send an email to a list of prospects or a single prospect. |
| UpdateBulkActionStatus | Update the status of a bulk action. |
Create an Engagement Studio Program using an Engagement Studio Program structure.
To create an engagement studio program, start by executing a query, for example:
EXECUTE CreateStudioProgram Name='EngagementStudioProgram_Custom', FolderId='33599', FilePath='C:\Users\User\Documents\structure.txt';
| Name | Type | Required | Description |
| Name | String | True | The name of the Engagement Studio Program. |
| FolderId | String | False | The ID of the Folder to store Engagement Studio Program. |
| FilePath | String | False | The path of the Engagement Studio Program Structure. |
| Base64Data | String | False | A string of data that will be used as the full contents of the file. Can be obtained from the output of the DownloadStudioProgram stored procedure. Required if FullPath is not specified. |
| Name | Type | Description |
| Success | String | This value shows whether the operation was successful or not. |
| Id | Int64 | ID of the object. |
| FailureMessage | String | The failure message of unsuccessful operation. |
Download an encrypted and base64 encoded Engagement Studio Program Structure.
To download a studio program, start by executing a query, for example:
EXECUTE DownloadStudioProgram Id='239309';
| Name | Type | Required | Description |
| Id | String | True | The ID of the Engagement Studio Program. |
| FilePath | String | False | The path of the file where you want the results to be written to. |
| Name | Type | Description |
| Success | String | Shows if the download finished successfully. |
| FileData | String | File data that will be outputted if the FileLocation and FileStream inputs are not set. |
| FailureMessage | String | The failure message of unsuccessful operation. |
If using a Windows application, set Authmode to App. If using a Web app, set Authmode to Web and specify the Verifier obtained by GetOAuthAuthorizationUrl.
| Name | Type | Required | Description |
| Authmode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.
使用できる値は次のとおりです。APP, WEB デフォルト値はAPPです。 |
| Verifier | String | False | The verifier token returned by Salesforce after using the URL obtained with GetOAuthAuthorizationUrl. |
| Scope | String | False | A space-separated scope of permissions you need the app to have access to. The available values are api, chatter_api, full, id, refresh_token, visualforce, and web. For details, refer to: http://help.salesforce.com/help/doc/en/remoteaccess_oauth_scopes.htm. |
| CallbackUrl | String | False | The page to return the Salesforce app after authentication has been completed. |
| Api_Version | String | False | The API version you would like to authenticate to.
デフォルト値は49.0です。 |
| State | String | False | Any value that you wish to be sent with the callback. |
| GrantType | String | False | Authorization grant type. Only available for OAuth 2.0. If left unspecified, the default value is the value of the OAuthGrantType connection property.
使用できる値は次のとおりです。CODE, PASSWORD |
| Name | Type | Description |
| Scope | String | The scope of permissions for the app. |
| Instance_Url | String | The instance URL being used by the app. |
| Id | String | The Id associated with the OAuth token. |
| Issued_At | String | When the token was issued at. |
| Signature | String | A signature for the OAuth token. |
| OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
| OAuthAccessToken | String | The OAuth access token. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps.
| Name | Type | Required | Description |
| CallbackUrl | String | False | The page to return the user after authorization is complete. |
| Scope | String | False | A space-separated scope of permissions you need the app to have access to. The available values are api, chatter_api, full, id, refresh_token, visualforce, web. For more details, refer to: http://help.salesforce.com/help/doc/en/remoteaccess_oauth_scopes.htm. |
| Grant_Type | String | False | The type of authorization to be granted for your app. If this is set to code, the stored procedure will return an authorization URL containing the verifier code in a query string parameter, which you will need to submit back with the GetOAuthAccessToken stored procedure. Implicit will cause the OAuth access token to be returned directly in the URL.
使用できる値は次のとおりです。Implicit, Code |
| State | String | False | Any value that you wish to be sent with the callback. |
| Name | Type | Description |
| Url | String | The authorization url. |
Refreshes the OAuth token or session id after the session has expired. Your OAuth application must have the refresh_token scope enabled.
| Name | Type | Required | Description |
| OAuthRefreshToken | String | True | The refresh token returned when the OAuth Token was first created. |
| Name | Type | Description |
| Instance_Url | String | Instance of Salesforce the OAuth token is valid for. |
| OAuthAccessToken | String | The OAuth token. |
| Id | String | Id associated with the OAuth Token. |
| Issued_At | String | When the OAuth Token was issued. |
| Signature | String | Signature of the OAuth Token. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
Send an email to a list of prospects or a single prospect.
| Name | Type | Required | Description |
| CampaignId | Int64 | True | The ID of the campaign. |
| ProspectId | Int64 | False | The ID of the prospect you're sending the email to. |
| Name | String | True | The name of the object for identification in Account Engagement. |
| RecipientListIds | String | False | An array of IDs of the recipient lists. The email is sent to all users on the specified lists. |
| SuppressionListIds | String | False | An array of IDs of the suppression lists. The email isn’t sent to any user on the suppression lists. |
| EmailTemplateId | Int64 | False | The ID of the email template used for the email. |
| Subject | String | False | The subject of the email. |
| TextMessage | String | False | The text content of the email's message. |
| HtmlMessage | String | False | The HTML content of the email's message. |
| FolderId | Int64 | False | The ID of the folder containing this object. |
| TrackerDomainId | Int64 | False | The ID of the tracker domain used for the email. |
| ScheduledTime | Datetime | False | The ISO 8601 date and time to send the email. |
| IsOperational | Boolean | False | When true, the email is sent to the prospect regardless of opt-out status. Your account must have Operational Email Sending enabled to use this setting. |
| SenderOptions | String | False | An array of the sender options. |
| ReplyToOptions | String | False | An array of the reply to address options. |
| Name | Type | Description |
| Success | Boolean | This value shows a boolean indication of whether the operation was successful or not. |
| Id | Int64 | The ID of the email or list email that was sent. |
Update the status of a bulk action.
| Name | Type | Required | Description |
| Id | Int64 | True | The ID of the bulk action job. |
| Status | String | True | The new status. Ex: Paused, Ready, Cancelled. |
| Name | Type | Description |
| Success | Boolean | Shows whether the batch was added successfully. |
| プロパティ | 説明 |
| 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. |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、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 トラフィックをルーティングするために予約された、指定されたプロキシサーバーの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. |
| IncludeCustomFields | Specifies whether to include custom fields in the metadata for tables that support them. |
| 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 | 特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。 |
| Pagesize | provider がSalesforce Marketing Cloud Account Engagement にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。 |
| 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 | Specifies the timezone used to interpret datetime values returned by the Salesforce Marketing Cloud Account Engagement server. Set this to match the user's configured timezone in Account Engagement. |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| 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.
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ) |
カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
このプロパティは2つのケースで必要となります:
(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにSync App によって設定されており、手動で入力する必要がないことがあります。)
OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。
クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。
クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。
Notes:
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能な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 が設定されている場合、CData Sync App は証明書の検索を開始します。 詳しくは、OAuthJWTCertSubject を参照してください。
証明書ストアの指定はプラットフォームに依存します。
注記
JWT 証明書を格納しているキーストアの種類を指定します。
| 値 | 説明 | 注記 |
| USER | 現在のユーザーが所有する証明書ストア。 | Windows のみ使用可能です。 |
| MACHINE | マシンストア。 | Java やその他の非Windows 環境では使用できません。 |
| PFXFILE | 証明書を含むPFX(PKCS12)ファイル。 | |
| PFXBLOB | PFX(PKCS12)形式の証明書ストアをbase-64 でエンコードした文字列。 | |
| JKSFILE | 証明書を含むJava キーストア(JKS)ファイル。 | Java 専用。 |
| JKSBLOB | Java キーストア(JKS)形式の証明書ストアをbase-64 でエンコードした文字列。 | 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 |
Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。
このセクションでは、本プロバイダーの接続文字列で設定可能な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 トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。 |
provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。
この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を構成する場合は、ProxyAutoDetect をFalse に設定します。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。
ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。
クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたProxyServer ポートを通じてのみ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 接続プロパティは設定しないでください。 |
Note: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 を参照してください。
Note: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 は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Note:Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。 この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
Sync App は、実行する各操作の詳細を Logfile 接続プロパティで指定されたログファイルに書き込みます。
ログに記録される各操作は、モジュールと呼ばれるカテゴリに分類されます。各モジュールには対応する短いコードがあり、個々の Sync App の操作がどのモジュールに属するかを示すラベルとして使用されます。
この接続プロパティにモジュールコードをセミコロン区切りのリストで設定すると、指定したモジュールに属する操作のみがログファイルに書き込まれます。この設定は今後のログ記録にのみ適用され、既存のログファイルの内容には影響しません。例: INFO;EXEC;SSL;META;
デフォルトでは、すべてのモジュールの操作がログに含まれます。
モジュールを明示的に除外するには、先頭に「-」を付けます。例: -HTTP
サブモジュールにフィルターを適用するには、<モジュール名>.<サブモジュール名> の構文で指定します。たとえば、次の値を設定すると、Sync App は HTTP モジュールに属するアクションのみをログに記録し、さらに HTTP モジュールの Res サブモジュールに属するアクションを除外します: HTTP;-HTTP.Res
Verbosity 接続プロパティによるログファイルのフィルタリングは、この接続プロパティによるフィルタリングよりも優先されます。そのため、Verbosity 接続プロパティで指定したレベルよりも高い詳細レベルの操作は、この接続プロパティで指定したモジュールに属していても、ログファイルには出力されません。
使用可能なモジュールとサブモジュールは次のとおりです。
| モジュール名 | モジュールの説明 | サブモジュール |
| INFO | 一般情報。接続文字列、製品バージョン(ビルド番号)、および初期接続メッセージが含まれます。 |
|
| EXEC | クエリ実行。ユーザーが記述した SQL クエリ、解析済み SQL クエリ、正規化済み SQL クエリの実行メッセージが含まれます。クエリおよびクエリページの成功/失敗メッセージもここに表示されます。 |
|
| HTTP | HTTP プロトコルメッセージ。HTTP リクエスト/レスポンス(POST メッセージを含む)、および Kerberos 関連のメッセージが含まれます。 |
|
| WSDL | WSDL/XSD ファイルの生成に関するメッセージ。 | — |
| SSL | SSL 証明書メッセージ。 |
|
| AUTH | 認証関連の失敗/成功メッセージ。 |
|
| SQL | SQL トランザクション、SQL 一括転送メッセージ、および SQL 結果セットメッセージが含まれます。 |
|
| META | メタデータキャッシュとスキーマメッセージ。 |
|
| FUNC | SQL 関数の実行に関連する情報。 |
|
| TCP | TCP トランスポートレイヤーメッセージでの送受信生バイト。 |
|
| FTP | File Transfer Protocol に関するメッセージ。 |
|
| SFTP | Secure File Transfer Protocol に関するメッセージ。 |
|
| POP | Post Office Protocol 経由で転送されるデータに関するメッセージ。 |
|
| SMTP | Simple Mail Transfer Protocol 経由で転送されるデータに関するメッセージ。 |
|
| CORE | 他のモジュールでカバーされていない、さまざまな製品内部操作に関連するメッセージ。 | — |
| DEMN | SQL リモーティングに関連するメッセージ。 | — |
| CLJB | 一括データアップロード(クラウドジョブ)に関するメッセージ。 |
|
| SRCE | 他のモジュールに属さない、製品が生成するその他のメッセージ。 | — |
| TRANCE | 低レベルの製品操作に関する高度なメッセージ。 | — |
このセクションでは、本プロバイダーの接続文字列で設定可能な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. |
| IncludeCustomFields | Specifies whether to include custom fields in the metadata for tables that support them. |
| 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 | 特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。 |
| Pagesize | provider がSalesforce Marketing Cloud Account Engagement にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。 |
| 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 | Specifies the timezone used to interpret datetime values returned by the Salesforce Marketing Cloud Account Engagement server. Set this to match the user's configured timezone in Account Engagement. |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| 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.
Specifies whether to include custom fields in the metadata for tables that support them.
When set to true (default), custom fields are included in the metadata for tables that support them. Currently, in the SalesforcePardotV5 schema, only primitive custom fields are supported. Custom fields of the following types are not returned: Multi-select, Checkbox, and fields with Records and display multiple responses checked.
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 を含まないクエリで返される最大行数を指定します。
このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)
MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。
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".
特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
このプロパティにより、シニアユーザーはサポートチームのアドバイスに基づいて、特定の状況に対応する隠しプロパティを設定できます。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Note:特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
| プロパティ | 説明 |
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT=True | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換します。デフォルト値はFalse(ローカルタイムを使用)です。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
provider がSalesforce Marketing Cloud Account Engagement にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
クエリを処理する際、Salesforce Marketing Cloud Account Engagement でクエリされたデータすべてを一度にリクエストする代わりに、Sync App はクエリされたデータをページと呼ばれる部分ごとにリクエストすることができます。
この接続プロパティは、Sync App がページごとにリクエストする結果の最大数を決定します。
Note:大きなページサイズを設定すると全体的なクエリ実行時間が短縮される可能性がありますが、その場合、クエリ実行時にSync App がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあります。
テーブルカラムとして公開する擬似カラムを、'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.
Specifies the timezone used to interpret datetime values returned by the Salesforce Marketing Cloud Account Engagement server. Set this to match the user's configured timezone in Account Engagement.
This property applies to the V3 and V4 schemas of Salesforce Marketing Cloud Account Engagement. The Account Engagement server returns datetime fields based on the timezone configured for the authenticated user.
To find this value:
Use the corresponding IANA timezone name (for example, America/Los_Angeles) as the value of this property.
If set to AUTO, the Sync App attempts to detect the correct timezone automatically. If autodetection fails or the wrong timezone is used, datetime values may be offset or misinterpreted.
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。
タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。
Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
UserDefinedViews を使用すると、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.jsonUserDefinedViews でビューを指定すると、Sync App はそのビューだけを参照します。
詳しくは、ユーザー定義ビュー を参照してください。
The delimiter used for multi-select fields values.
The delimiter used for multi-select fields values.
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.