Cloud

Build 25.0.9434
  • Salesforce Marketing Cloud Account Engagement
    • はじめに
      • 接続の確立
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • Salesforce Pardot V3 & V4 データモデル
        • テーブル
          • Campaigns
          • CustomFields
          • ListMemberships
          • Lists
          • Opportunities
          • ProspectAccounts
          • Prospects
        • ビュー
          • Account
          • CustomRedirects
          • DynamicContents
          • EmailClicks
          • Emails
          • EmailStats
          • EmailTemplates
          • Forms
          • LifecycleHistories
          • LifecycleStages
          • OneToOneEmails
          • TagObjects
          • Tags
          • Users
          • VisitorActivities
          • Visitors
          • VisitorsPageViews
          • Visits
        • ストアドプロシージャ
          • AssignProspect
          • AssignProspectAccount
          • SendEmail
          • UnAssignProspect
          • UnDeleteOpportunity
      • Salesforce Pardot V5 データモデル
        • テーブル
          • CustomFields
          • CustomRedirects
          • DynamicContent
          • DynamicContentVariations
          • EmailTemplates
          • Files
          • FormFields
          • FormHandlers
          • FormHandlersFields
          • Forms
          • LandingPages
          • LayoutTemplates
          • ListMemberships
          • Lists
          • ProspectAccounts
          • Prospects
          • Tags
        • ビュー
          • Account
          • Campaigns
          • Emails
          • EmailSuppressionList
          • EngagementStudioProgram
          • FolderContents
          • Folders
          • LifecycleHistories
          • LifecycleStages
          • ListEmail
          • ListEmailRecipients
          • ListEmailStats
          • Opportunities
          • ReplyToOptions
          • SenderOptions
          • TaggedObjects
          • TrackerDomains
          • Users
          • VisitorActivities
          • Visitors
          • VisitorsPageViews
          • Visits
        • ストアドプロシージャ
          • CreateStudioProgram
          • SendEmail
          • UpdateBulkActionStatus
      • システムテーブル
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • 接続文字列オプション
      • Authentication
        • AuthScheme
        • Schema
        • BusinessUnitID
        • IsDemoAccount
        • UseSalesforceSandbox
        • User
        • Password
        • SecurityToken
      • BulkAPI
        • BulkMode
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
      • JWT OAuth
        • OAuthJWTCert
        • OAuthJWTCertType
        • OAuthJWTCertPassword
        • OAuthJWTCertSubject
        • OAuthJWTIssuer
        • OAuthJWTSubject
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • Archived
        • IncludeCustomFields
        • IncludeMessage
        • MaxRows
        • MaxThreads
        • Pagesize
        • PseudoColumns
        • ResponseMode
        • ServerTimeZone
        • Timeout
        • ValueDelimiter
    • Third Party Copyrights

Salesforce Marketing Cloud Account Engagement - CData Cloud

概要

CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるSalesforce Marketing Cloud Account Engagement へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してSalesforce Marketing Cloud Account Engagement に接続できます。

CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、Salesforce Marketing Cloud Account Engagement への接続を標準化し、構成することができます。

主要機能

  • SQL をフルサポート:Salesforce Marketing Cloud Account Engagement は、標準のリレーショナルデータベースとして表示され、Filter、Group、Join などの操作を実行できます。これらの操作は基盤となるAPI でサポートされているかどうかに関わらず、標準SQL を使用します。
  • CRUD サポート:読み取りと書き込みの両方の操作がサポートされており、Cloud またはデータソースのダウンストリームで設定できるセキュリティ設定によってのみ制限されます。
  • セキュアアクセス:管理者は、ユーザーを作成し、特定のデータベースへのアクセス、読み取り専用操作、または完全な読み書きの権限を定義することができます。
  • 包括的なデータモデルとダイナミックディスカバリー:CData Cloud は、動的データや検索可能なメタデータへのフルアクセスなど、基盤となるデータソースで公開されるすべてのデータへの包括的なアクセスを提供します。

CData Cloud

はじめに

このページでは、CData Cloud でのSalesforce Marketing Cloud Account Engagement への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Salesforce Marketing Cloud Account Engagement への接続

接続の確立 は、CData Cloud にデータベースを作成するためのSalesforce Marketing Cloud Account Engagement への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してSalesforce Marketing Cloud Account Engagement からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

CData Cloud

接続の確立

Database タブで対応するアイコンを選択して、Salesforce Marketing Cloud Account Engagement に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Salesforce Marketing Cloud Account Engagement への接続

Salesforce Marketing Cloud Account Engagement に接続するには、Pardot のビジネスユニットID を取得する必要があります。これを行うには、Salesforce の[設定]を使用します。[設定]の[クイック検索]フィールドに「Pardot アカウントの設定」と入力します。

Pardot ビジネスユニットID は「0Uv」で始まる18 文字です。Pardot アカウント設定情報にアクセスできない場合は、Salesforce 管理者に問い合わせてPardot ビジネスユニットID を入手してください。

Salesforce Marketing Cloud Account Engagement への認証

OAuth

AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。

デスクトップアプリケーション

CData は、OAuth デスクトップ認証を簡略化する埋め込みOAuth アプリケーションを提供します。代わりに、カスタムアプリケーションを作成することも可能です。カスタムアプリケーションの作成およびその理由については、カスタムOAuth アプリケーションの作成 を参照してください。

認証に関する2つの方法の違いは、カスタムOAuth アプリケーションを使用する場合に、2つの接続プロパティを追加で設定する必要があることだけです。

次の接続プロパティを設定して、接続してください。

  • OAuthClientId:(カスタムアプリケーションのみ)アプリケーション設定のクライアントID に設定。
  • OAuthClientSecret:(カスタムアプリケーションのみ)アプリケーション設定のクライアントシークレットに設定。

Web アプリケーション

Web アプリケーション経由で接続する場合は、Salesforce Marketing Cloud Account Engagement にカスタムOAuth アプリケーションを登録する必要があります。詳しくは、カスタムOAuth アプリケーションの作成 を参照してください。その後、ドライバーを使用してOAuth トークンの値を取得および管理します。

初めに、次の接続プロパティを設定してOAuthAccessToken を取得します。

  • OAuthClientId:アプリケーション設定のクライアントId に設定。
  • OAuthClientSecret:アプリケーション設定のクライアントシークレットに設定。

続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。

  1. GetOAuthAuthorizationUrl ストアドプロシージャを呼び出します。CallbackURL インプットをアプリケーション設定で指定したコールバックURL に設定します。必要に応じて、Scope パラメータを設定してカスタム権限をリクエストします。ストアドプロシージャがOAuth エンドポイントのURL を返します。
  2. URL を開き、ログインして、アプリケーションを認可します。コールバックURL にリダイレクトされます。
  3. GetOAuthAccessToken ストアドプロシージャを呼び出します。Authmode インプットをWEB に設定します。Verifier インプットを、コールバックURL のクエリ文字列の"code" パラメータに設定します。必要に応じて、Scope パラメータを設定してカスタム権限をリクエストします。

アクセストークンとリフレッシュトークンを取得した後、データに接続し、OAuth アクセストークンを自動または手動でリフレッシュすることが可能です。

OAuth アクセストークンの自動リフレッシュ

ドライバーがOAuth アクセストークンを自動的にリフレッシュするようにするには、最初のデータ接続で次のように設定します。

  • InitiateOAuth:REFRESH に設定。
  • OAuthClientId:アプリケーション設定のクライアントId に設定。
  • OAuthClientSecret:アプリケーション設定のクライアントシークレットに設定。
  • OAuthAccessToken:GetOAuthAccessToken によって返されたアクセストークンに設定。
  • RefreshOAuthAccessToken:GetOAuthAccessToken によって返されたリフレッシュトークンに設定。
  • OAuthSettingsLocation:Cloud がOAuth トークン値を保存する場所に設定。これは接続間で維持されます。
次回のデータ接続では、OAuthAccessToken およびOAuthRefreshToken の値は、OAuthSettingsLocation から取得されます。

OAuth アクセストークンの手動リフレッシュ

データ接続時に手動でOAuth アクセストークンをリフレッシュするために必要な値は、OAuth リフレッシュトークンのみです。

GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後に、RefreshOAuthAccessToken ストアドプロシージャを使用し、手動でOAuthAccessToken をリフレッシュします。次の接続プロパティを設定します。

  • OAuthClientId:アプリケーション設定のクライアントId に設定。
  • OAuthClientSecret:アプリケーション設定のクライアントシークレットに設定。

次に、RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを指定します。新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定し、新しい接続をオープンします。

最後に、OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

ヘッドレスマシン

ヘッドレスマシンのユーザーアカウントでOAuth を使用するようにドライバーを設定するには、インターネットブラウザに対応した別の端末で認証する必要があります。

  1. 以下のオプションから選択します。

    • オプション1:後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
    • オプション2:ブラウザに対応したマシンにCloud をインストールし、後述の「OAuth 設定を転送」の説明に従い、通常のブラウザベースのフローで認証後にOAuth 認証値を転送します。

  2. 次に、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするようにCloud を設定します。

オプション1:Verifier code を取得および交換

Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。

インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。

  1. 以下のオプションから選択します。

    • 埋め込みOAuth アプリケーションを使用する場合は、Salesforce Marketing Cloud Account Engagement OAuth endpoint をクリックし、ブラウザでエンドポイントを開きます。
    • カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定し、認証URL を作成します。
      • InitiateOAuth:OFF に設定。
      • OAuthClientId:アプリケーションの登録時に割り当てられたクライアントId に設定。
      • OAuthClientSecret:アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
      次に、適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。

  2. ログインして、Cloud にアクセス許可を与えます。すると、verifier code を含むコールバックURL にリダイレクトされます。
  3. verifier code の値を保存します。後ほどこれをOAuthVerifier 接続プロパティに設定します。
次に、OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。次のプロパティを設定します。

ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。

  • InitiateOAuth:REFRESH に設定。
  • OAuthVerifier:verifier code に設定。
  • OAuthClientId:(カスタムアプリのみ)カスタムOAuth アプリケーション設定のクライアントId に設定。
  • OAuthClientSecret:(カスタムアプリのみ)カスタムOAuth アプリケーション設定のクライアントシークレットに設定。
  • OAuthSettingsLocation:これを設定すると、暗号化されたOAuth 認証値が指定された場所に永続化されます。

OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットする必要があります。

  • InitiateOAuth:REFRESH に設定。
  • OAuthClientId:(カスタムアプリのみ)アプリケーションの登録時に割り当てられたクライアントId に設定。
  • OAuthClientSecret:(カスタムアプリのみ)アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
  • OAuthSettingsLocation:暗号化されたOAuth 認証値を含む場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所がCloud に読み書きのアクセス許可を与えることを確認してください。

オプション2:OAuth 設定を転送

ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバとの接続をインストールし、作成する必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。

接続テストに成功したら、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。

  • InitiateOAuth:REFRESH に設定。
  • OAuthClientId:(カスタムアプリのみ)アプリケーションの登録時に割り当てられたクライアントId に設定。
  • OAuthClientSecret:(カスタムアプリのみ)アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
  • OAuthSettingsLocation:OAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所がCloud に読み書きのアクセス許可を与えることを確認してください。

OAuthPassword

ユーザー名とパスワードで認証する場合は、以下の接続プロパティを設定します。

  • AuthScheme:OAuthPassword に設定。
  • User:ユーザーネームに設定。
  • Password:ユーザーパスワードに設定。
  • InitiateOAuth:GETANDREFRESH に設定。InitiateOAuth を使って、OAuth 交換や、手動でのOAuthAccessToken 接続プロパティの設定の繰り返しを避けられます。

OAuthJWT

AuthScheme をOAuthJWT に設定します。

OAuth アプリケーション(カスタムOAuth アプリケーションの作成 参照)作成後、次の接続プロパティを設定します。

  • AuthScheme:OAuthJWT。
  • InitiateOAuth:GETANDREFRESH。
  • OAuthJWTCert:JWT 証明書のストア。
  • OAuthJWTPassword:JWT 証明書ストアのパスワード。
  • OAuthJWTIssuer:OAuth クライアントID。
  • OAuthJWTCertType:OAuthJWTCert で指定された証明書ストアの種類。

Note:このフローではリフレッシュトークンは発行されません。

CData Cloud

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

CData Cloud

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

  • ProxyServer:HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
  • ProxyPort:プロキシサーバーが起動しているTCP ポート。
  • ProxyAuthScheme:プロキシサーバーに対して認証する際にCloud が使用する認証方法。
  • ProxyUser:プロキシサーバーに登録されているユーザーアカウントのユーザー名。
  • ProxyPassword:ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

  • プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
  • 接続をトンネルするには、FirewallType をTUNNEL に設定します。
  • 認証するには、FirewallUser とFirewallPassword を設定します。
  • SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

CData Cloud

データモデル

概要

このセクションでは、利用可能なAPI オブジェクトを示し、Salesforce Marketing Cloud Account Engagement API へのSQL の実行について詳しく説明します。

主要機能

  • Cloud はドキュメント、フォルダ、およびグループなどのSalesforce Marketing Cloud Account Engagement エンティティをリレーショナルビューとしてモデル化し、SQL を記述してSalesforce Marketing Cloud Account Engagement データをクエリできるようにします。
  • ストアドプロシージャを使用すると、アクセストークンの取得やOAuth 2.0でのリフレッシュの維持など、Salesforce Marketing Cloud Account Engagement の操作を実行できます。
  • これらのオブジェクトへのライブ接続により、Cloud を使用するとSalesforce Marketing Cloud Account Engagement アカウントへのあらゆる変更が即座に反映されます。

CData Cloud

Salesforce Pardot V3 & V4 データモデル

CData Cloud は、Salesforce Marketing Cloud Account Engagement エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。 Cloud は、Salesforce Marketing Cloud Account Engagement API を使用してサポートされているフィルタを処理します。その他のフィルタは、Cloud 内でクライアント側で処理されます。

CData Cloud

テーブル

Cloud はSalesforce Marketing Cloud Account Engagement のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - Salesforce Marketing Cloud Account Engagement テーブル

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.

CData Cloud

Campaigns

Retrieve and modify campaigns.

Table Specific Information

Select

The Cloud 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 Cloud.

  • Id supports '=', '<', '<=', '>', '>='.
  • Name supports '='.
  • CreatedAt supports '=', '<', '<=', '>', '>='.
  • UpdatedAt supports '=', '<', '<=', '>', '>='.

For example, the following queries are processed server side:

SELECT * FROM Campaigns WHERE Id = 43
SELECT * FROM Campaigns WHERE Name = 'Website Tracking'

Insert

This table does not have any required attributes when performing an insert.

Columns

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.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
CreatedAt Datetime

Filter by the creation time.

UpdatedAt Datetime

Filter by the modification time.

CData Cloud

CustomFields

Retrieve and modify custom fields.

Table Specific Information

Select

The Cloud 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 Cloud.

  • Id supports '=', '<', '<=', '>', '>='.
  • CreatedAt supports '=', '<', '<=', '>', '>='.

For example, the following queries are processed server side:

SELECT * FROM CustomFields WHERE Id = 50
SELECT * FROM CustomFields WHERE CreatedAt > '01/01/2019'

Insert

The following attributes are required when performing an insert: FieldId, Name.

INSERT INTO CustomFields (FieldId, Name) VALUES (100, 'Example')

Columns

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.

CData Cloud

ListMemberships

Retrieve and modify list memberships.

Table Specific Information

Select

The Cloud 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 Cloud.

  • Id supports '=', '<', '<=', '>', '>='.
  • ListId supports '='.
  • CreatedAt supports '=', '<', '<=', '>', '>='.
  • UpdatedAt supports '=', '<', '<=', '>', '>='.

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'

Insert

The following attributes are required when performing an insert: ListId, ProspectId.

INSERT INTO ListMemberships (ListId, ProspectId) VALUES (20104, 3457990)

Get Deleted

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

Columns

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.

CData Cloud

Lists

Retrieve and modify lists.

Columns

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.

CData Cloud

Opportunities

Retrieve and modify opportunities.

Table Specific Information

Select

The Cloud 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 Cloud.

  • Id supports '=', '<', '<=', '>', '>='.
  • Probability supports '=', '<', '<=', '>', '>='.
  • CreatedAt supports '=', '<', '<=', '>', '>='.
  • ProspectEmail supports '='.
  • ProspectId supports '='.

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]'

Insert

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.

Columns

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.

CData Cloud

ProspectAccounts

Retrieve and modify prospect accounts.

Columns

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.

CData Cloud

Prospects

Retrieve and modify prospects.

Columns

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.

Email String False

Prospect's email address.

Password String False

Prospect's password.

Company String False

Prospect's company.

ProspectAccountId Int63 False

ProspectAccounts.Id

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.

CData Cloud

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - Salesforce Marketing Cloud Account Engagement ビュー

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.

CData Cloud

Account

Retrieve account info.

Table Specific Information

Select

The Cloud will process all filters client side.

Columns

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.

CData Cloud

CustomRedirects

Retrieve and modify custom redirects.

Columns

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.

CData Cloud

DynamicContents

Retrieve dynamic contents.

Table Specific Information

Select

The Cloud 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 Cloud.

  • Id supports '=', '<', '<=', '>', '>='.
  • CreatedAt supports '=', '<', '<=', '>', '>='.
  • UpdatedAt supports '=', '<', '<=', '>', '>='.

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'

Columns

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.

CData Cloud

EmailClicks

Retrieve email clicks.

Table Specific Information

Select

The Cloud 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 Cloud.

  • Id supports '>', '>='.
  • ListEmailId supports '='.
  • DripProgramActionId supports '='.
  • EmailTemplateId supports '='.
  • TrackerRedirectId supports '='.
  • CreatedAt supports '=', '<', '<=', '>', '>='.

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'

Columns

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

EmailTemplates.Id

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.

CData Cloud

Emails

Retrieve emails.

Table Specific Information

Select

The Cloud 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 Cloud.

  • Id supports '='.

For example, the following query is processed server side:

SELECT * FROM Emails WHERE Id = 10

Columns

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.

CData Cloud

EmailStats

Retrieve email stats.

Table Specific Information

The Cloud 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 Cloud.

  • Id supports '='.

For example, the following query is processed server side:

SELECT * FROM EmailStats WHERE Id = 10

Columns

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.

CData Cloud

EmailTemplates

Retrieve email templates.

Table Specific Information

Select

By default only templates connected to OneToOneEmails will be returned.

The Cloud 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 Cloud.

  • Id supports '='.

For example, the following queries are processed server side:

SELECT * FROM EmailTemplates WHERE Id = 22

Columns

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.

CData Cloud

Forms

Retrieve forms.

Columns

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.

CData Cloud

LifecycleHistories

Retrieve lifecycle histories.

Table Specific Information

Select

The Cloud 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 Cloud.

  • Id supports '=', '<', '<=', '>', '>='.
  • CreatedAt supports '=', '<', '<=', '>', '>='.

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'

Columns

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.

CData Cloud

LifecycleStages

Retrieve lifecycle stages.

Table Specific Information

Select

The Cloud 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 Cloud.

  • Id supports '=', '<', '<=', '>', '>='.

For example, the following queries are processed server side:

SELECT * FROM LifecycleStages WHERE Id = 18

Columns

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.

CData Cloud

OneToOneEmails

Retrieve one to one emails.

Table Specific Information

Select

The Cloud 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 Cloud.

  • Id supports '='.

For example, the following queries are processed server side:

SELECT * FROM OneToOneEmails WHERE Id = 11

Columns

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.

CData Cloud

TagObjects

Retrieve tag objects.

Table Specific Information

Select

The Cloud 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 Cloud.

  • Id supports '=', '<', '<=', '>', '>='.
  • TagId supports '='.
  • Type supports '='.
  • ObjectId supports '='.
  • CreatedAt supports '=', '<', '<=', '>', '>='.

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'

Columns

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.

CData Cloud

Tags

Retrieve tags.

Table Specific Information

Select

The Cloud 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 Cloud.

  • Id supports '=', '<', '<=', '>', '>='.
  • Name supports '='.
  • CreatedAt supports '=', '<', '<=', '>', '>='.

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'

Columns

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.

CData Cloud

Users

Retrieve users.

Columns

Name Type References Description
Id [KEY] Int64 Pardot ID of the user.
Email 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.

CData Cloud

VisitorActivities

Retrieve visitor activities.

Columns

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

EmailTemplates.Id

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.

CData Cloud

Visitors

Retrieve visitors.

Columns

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.

CData Cloud

VisitorsPageViews

Retrieve visitors page views.

Columns

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.

CData Cloud

Visits

Retrieve visits.

Columns

Name Type References Description
Id [KEY] Int64 Pardot ID for this visit.
VisitorId Int64

Visitors.Id

Pardot ID for the associated visitor.
ProspectId Int64

Prospects.Id

Pardot ID for the associated prospect.
VisitorPageViewCount Integer Number of page views for this visit.
FirstVisitorPageViewAt Datetime Time of first page view for this visit.
LastVisitorPageViewAt Datetime Time of last page view for this visit.
DurationInSeconds Integer Length of this visit.
CampaignParameter String Visit's campaign parameter utm_campaign from Google Analytics.
MediumParameter String Visit's medium parameter utm_medium from Google Analytics.
SourceParameter String Visit's source parameter utm_source from Google Analytics.
ContentParameter String Visit's content parameter utm_content from Google Analytics.
TermParameter String Visit's term parameter utm_term from Google Analytics.
CreatedAt Datetime Time visit was created in Pardot.
UpdatedAt Datetime Last time visit was updated in Pardot.

CData Cloud

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、Salesforce Marketing Cloud Account Engagement の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにSalesforce Marketing Cloud Account Engagement から関連するレスポンスデータを返します。

CData Cloud - 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.

CData Cloud

AssignProspect

Update the locations for a shipping zone.

Execute


EXEC AssignProspect ProspectId = 432, AssignmentType = 'user', AssignTo = 101
EXEC AssignProspect ProspectId = 432, AssignmentType = 'email', AssignTo = '[email protected]'

Input

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.

Result Set Columns

Name Type Description
Success String This value shows a boolean indication of whether the operation was successful or not.

CData Cloud

AssignProspectAccount

Update the locations for a shipping zone.

Execute


EXEC AssignProspectAccount UserId = 432, ProspectAccountId = 501

Input

Name Type Required Description
ProspectAccountId String False The ID of the prospect account.
UserId String False The ID of the user.

Result Set Columns

Name Type Description
Success String This value shows a boolean indication of whether the operation was successful or not.

CData Cloud

SendEmail

Update the locations for a shipping zone.

Execute

This procedure requires any of the following input combinations:

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'

Input

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.

Result Set Columns

Name Type Description
Success String This value shows a boolean indication of whether the operation was successful or not.

CData Cloud

UnAssignProspect

Update the locations for a shipping zone.

Execute


EXEC UnAssignProspect ProspectId = 432

Input

Name Type Required Description
ProspectId String False The ID of the prospect.

Result Set Columns

Name Type Description
Success String This value shows a boolean indication of whether the operation was successful or not.

CData Cloud

UnDeleteOpportunity

Update the locations for a shipping zone.

Execute


EXEC UnDeleteOpportunity Id = 600

Input

Name Type Required Description
Id String False The ID of the opportunity.

Result Set Columns

Name Type Description
Success String This value shows a boolean indication of whether the operation was successful or not.

CData Cloud

Salesforce Pardot V5 データモデル

CData Cloud は、Salesforce Marketing Cloud Account Engagement Pardot API v5 オブジェクトをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。 Cloud は、Salesforce Marketing Cloud Account Engagement API を使用してサポートされているフィルタを処理します。その他のフィルタは、Cloud 内でクライアント側で処理されます。

テーブル

テーブル では、利用可能な標準テーブルの例について説明します。

CData Cloud

テーブル

Cloud はSalesforce Marketing Cloud Account Engagement のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - Salesforce Marketing Cloud Account Engagement テーブル

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.

CData Cloud

CustomFields

Retrieve custom fields metadata.

テーブル固有の情報

Select

Cloud は Salesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • Id は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • CreatedAt は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • UpdatedAt は '='、'<'、'<='、'>'、'>=' をサポートしています。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM CustomFields WHERE Id = 50
SELECT * FROM CustomFields WHERE CreatedAt > '01/01/2022'
SELECT * FROM CustomFields WHERE UpdatedAt < '01/01/2022'

Columns

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.

Pseudo-Columns

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

CData Cloud

CustomRedirects

Track links on your website or third-party site with Pardot custom redirects.

テーブル固有の情報

Select

Cloud はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • Id は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • IsDeleted は'=' をサポートしています。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM CustomRedirects WHERE Id = 40
SELECT * FROM CustomRedirects WHERE IsDeleted = 'true'

Insert

挿入を実行する際は、次の属性が必須です:Name、CampaignId、DestinationUrl。

INSERT INTO CustomRedirects (Name, CampaignId, DestinationUrl) VALUES ('name', '1', 'https://example.com/content.html')

Update

CustomRedirects 属性を更新します。

UPDATE CustomRedirects SET Name = 'newName', FolderId = '527425' WHERE Id = 24143

Delete

すべてのCustomRedirects オブジェクト、またはCustomRedirect ID を指定することで1つのオブジェクトを削除します。

DELETE FROM CustomRedirects WHERE Id = 10003

GetDeleted

Pardot のごみ箱にあるカスタムリダイレクトを取得する場合、次の操作がサポートされています。

GETDELETED FROM CustomRedirects 

Columns

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.

CData Cloud

DynamicContent

Retrieve a collection of dynamic content

Columns

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'.

CData Cloud

DynamicContentVariations

Retrieve a collection of Dynamic Content Variations

Columns

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.

CData Cloud

EmailTemplates

Query email templates.

Table Specific Information

Select

The Cloud 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 Cloud.

  • Id supports '=', '<', '<=', '>', '>='.
  • IsOneToOneEmail supports '='.
  • IsDeleted supports '='.
  • CreatedAt supports '=', '<', '<=', '>', '>='.
  • UpdatedAt supports '=', '<', '<=', '>', '>='.

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'

Insert

To insert EmailTemplates the following fields are required:

  • CampaignId
  • IsAutoResponderEmail
  • IsDripEmail
  • IsListEmail
  • IsOneToOneEmail
  • Name
  • Subject
  • TextMessage
  • HtmlMessage
  • SenderOptionsAggregate
  • TrackerDomainId
  • Type

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.

Example: Deep Inserts using JSON

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"}]')

Example: Deep Inserts using Temporary Tables

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.

Creating Temporary Tables

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')

Inserting the email template

In the INSERT statement for the EmailTemplates table, reference the temporary tables in the SenderOptionsAggregate input.


INSERT INTO EmailTemplates (..., SenderOptionsAggregate) VALUES (..., 'SenderOptions#TEMP')

Update

Updating EmailTemplates:

UPDATE EmailTemplates SET TextMessage = 'newMessage' WHERE Id = 24143

Delete

Remove all email templates or a email template by specifying the Id of the template.

DELETE FROM EmailTemplates WHERE Id = 10003

GetDeleted

To retrieve email templates that are in the recycle bin in Pardot the following operation is supported:

GETDELETED FROM EmailTemplates

Columns

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.

Pseudo-Columns

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.

CData Cloud

Files

Upload images and other files to use in your Pardot emails, forms, and landing pages.

テーブル固有の情報

Select

Cloud はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • Id は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • CreatedAt は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • UpdatedAt は '='、'<'、'<='、'>'、'>=' をサポートしています。

例えば、次のクエリはサーバーサイドで処理されます。

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'

Insert

挿入を実行する際は、次の属性が必須です:Name、FilePath

INSERT INTO Files (Name, FilePath) VALUES ('file1', 'C:\\file1.txt')

Update

Files の更新:

UPDATE Files SET Name = 'testingUpdate', FolderId = '33609' WHERE id = '804969'

Delete

すべてのファイル、またはファイルId を指定して特定のファイルを削除します。

DELETE FROM Files WHERE Id = 10003

Columns

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.

Pseudo-Columns

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.

CData Cloud

FormFields

Retrieve form fields to capture and store data related to leads, contacts, accounts, and other objects within the system.

Columns

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.

CData Cloud

FormHandlers

Retrieve,Create,Updata,Delete a collection of Form Handlers

Columns

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.

CData Cloud

FormHandlersFields

Retrieve,Create,Update,Delete a collection of Form Handler Stages

Columns

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.

CData Cloud

Forms

Retrieve forms.

テーブル固有の情報

Select

Cloud はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • Id は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • IsDeleted は'=' をサポートしています。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM Forms WHERE Id <= 17
SELECT * FROM Forms WHERE IsDeleted = 'true'

GetDeleted

Pardot のごみ箱にあるフォームを取得する場合、次の操作がサポートされています。

GETDELETED FROM Forms 

Columns

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.

CData Cloud

LandingPages

Retrieving a collection of landing pages

Table Specific Information

Select

The Cloud 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 Cloud.

  • Id supports '=', '<', '<=', '>', '>=', 'IN'.
  • IsDeleted supports '='.
  • CreatedAt supports '=', '<', '<=', '>', '>='.
  • UpdatedAt supports '=', '<', '<=', '>', '>='.

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'

GetDeleted

To retrieve LandingPages that are in the recycle bin in Pardot the following operation is supported:

GETDELETED FROM LandingPages

Columns

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.

CData Cloud

LayoutTemplates

Retrieve and modify layout templates.

テーブル固有の情報

Select

Cloud はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • Id は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • IsDeleted は'=' をサポートしています。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM LayoutTemplates WHERE Id = 40
SELECT * FROM LayoutTemplates WHERE IsDeleted = 'true'

Insert

挿入を実行する際は、次の属性が必須です:Name、LayoutContent

INSERT INTO LayoutTemplates (Name, IsIncludeDefaultCss, LayoutContent, FolderId) VALUES ('name', 'true', 'content', 33621)

Update

LayoutTemplates の更新:

UPDATE LayoutTemplates SET Name = 'newName' WHERE Id = 24143

Delete

すべてのレイアウトテンプレート、またはテンプレートId を指定して特定のレイアウトテンプレートを削除します。

DELETE FROM LayoutTemplates WHERE Id = 10003

GetDeleted

Pardot のごみ箱にあるレイアウトテンプレートを取得する場合、次の操作がサポートされています。

GETDELETED FROM LayoutTemplates 

Columns

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.

CData Cloud

ListMemberships

Retrieve,Create,Update,Delete a collection of list memberships

Columns

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

CData Cloud

Lists

Retrieve and modify lists.

テーブル固有の情報

Select

Cloud はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • Id は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • CreatedAt は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • UpdatedAt は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • IsDeleted は'=' をサポートしています。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM Lists WHERE Id = 40
SELECT * FROM Lists WHERE IsDeleted = 'true'
SELECT * FROM Lists WHERE CreatedAt > '01/01/2022'

Insert

挿入を実行する際は、次の属性が必須です:Name

INSERT INTO Lists (Name) VALUES ('name')

Update

Lists 属性を更新します。

UPDATE Lists SET Name = 'newName' WHERE Id = 24143

Delete

すべてのリスト、またはリストId を指定して特定のリストを削除します。

DELETE FROM Lists WHERE Id = 10003

GetDeleted

Pardot のごみ箱にあるリストを取得する場合、次の操作がサポートされています。

GETDELETED FROM Lists

Columns

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.

CData Cloud

ProspectAccounts

Query the available prospect accounts.

テーブル固有の情報

Select

Cloud はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • Id は '='、'<'、'<='、'>'、'>=' をサポートしています。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM ProspectAccounts WHERE Id > 31

Get Deleted

削除されたプロスペクトのアカウントを取得するには、GETDELETED 文を実行します。

GETDELETED FROM ProspectAccounts

Columns

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.

CData Cloud

Prospects

Retrieve and modify prospects.

テーブル固有の情報

Select

Cloud はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • Id は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • UserId は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • AssignedToId は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • LastActivityAt は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • IsDeleted は'=' をサポートしています。
  • CreatedAt は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • UpdatedAt は '='、'<'、'<='、'>'、'>=' をサポートしています。

例えば、次のクエリはサーバーサイドで処理されます。

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'

Get Deleted

削除されたプロスペクトを取得するには、GETDELETED 文を実行します。

GETDELETED FROM Prospects

Columns

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.

Email 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.

CData Cloud

Tags

Retrieve tags.

Columns

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.

CData Cloud

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - Salesforce Marketing Cloud Account Engagement ビュー

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.

CData Cloud

Account

Use the account resource to learn about the current user's Pardot account.

Columns

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.

CData Cloud

Campaigns

Retrieve and modify campaigns.

テーブル固有の情報

Select

Cloud はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • Id は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • Name は'=' をサポートしています。
  • CreatedAt は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • UpdatedAt は '='、'<'、'<='、'>'、'>=' をサポートしています。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM Campaigns WHERE Id = 50
SELECT * FROM Campaigns WHERE Name = 'campaignName'
SELECT * FROM Campaigns WHERE CreatedAt > '01/01/2022'

GetDeleted

Pardot のごみ箱にあるキャンペーンを取得する場合、次の操作がサポートされています。

GETDELETED FROM Campaings

Columns

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.

CData Cloud

Emails

Query emails to learn how prospects responded to the emails.

テーブル固有の情報

Select

Cloud はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • Id は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • ProspectId は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • ListEmailId は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • SentAt は '='、'<'、'<='、'>'、'>=' をサポートしています。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM Emails WHERE Id = 50
SELECT * FROM Emails WHERE ProspectId = 23
SELECT * FROM Emails WHERE SentAt > '01/01/2022'

Columns

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.

CData Cloud

EmailSuppressionList

A Lists used as suppression lists for the list email.

Retrieve a Single Suppressed Email Address

To retrieve a single suppressed email address, specify its ID:

SELECT * FROM EmailSuppressionList WHERE Id = '55555555'

Retrieve Multiple Suppressed Email Addresses

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)

Columns

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.

CData Cloud

EngagementStudioProgram

Query EngagementStudioProgram to retrieve data related to the programs.

Table Specific Information

Select

The Cloud 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'

Columns

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.

CData Cloud

FolderContents

View all objects contained within Folders.

Columns

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.

CData Cloud

Folders

Retrieve folders or organize and nest your content and marketing assets in a way that makes sense for your team.

テーブル固有の情報

Select

Cloud はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • Id は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • ParentFolderId は '='、'<'、'<='、'>'、'>=' をサポートしています。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM Folders WHERE Id = 50
SELECT * FROM Folders WHERE ParentFolderId = 2

Columns

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.

CData Cloud

LifecycleHistories

Use lifecycle history resources to learn how a prospect is moving through their sales journey, from visitor to won opportunity.

Columns

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.

CData Cloud

LifecycleStages

Retrieving a collection of lifecycle stages

Table Specific Information

Select

The Cloud 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 Cloud.

  • Id supports '=', '<', '<=', '>', '>=', 'IN'.
  • IsDeleted supports '='.
  • CreatedAt supports '=', '<', '<=', '>', '>='.
  • UpdatedAt supports '=', '<', '<=', '>', '>='.

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'

GetDeleted

To retrieve LifecycleStages that are in the recycle bin in Pardot the following operation is supported:

GETDELETED FROM LifecycleStages

Columns

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

CData Cloud

ListEmail

A list email is a single email sent to a recipient list.

テーブル固有の情報

Select

Cloud はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • Id は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • IsDeleted は'=' をサポートしています。
  • CreatedAt は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • UpdatedAt は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • SentAt は '='、'<'、'<='、'>'、'>=' をサポートしています。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM ListEmail WHERE Id = 50
SELECT * FROM ListEmail WHERE SentAt > '01/01/2022'
SELECT * FROM ListEmail WHERE CreatedAt > '01/01/2022'

GetDeleted

Pardot のごみ箱にあるリストメールを取得する場合、次の操作がサポートされています。

GETDELETED FROM ListEmail

Columns

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.

CData Cloud

ListEmailRecipients

RecipientLists used by an email

Retrieve a Single Email Recipient

To retrieve a single email recipient, specify its ID:

SELECT * FROM ListEmailRecipients WHERE Id = '55555555'

Retrieve Multiple Email Recipients

To retrieve multiple email recipient, issue a nested SELECT statement to the ListEmail table.

SELECT * FROM ListEmailRecipients WHERE ListEmailId IN (SELECT Id FROM ListEmail)

Columns

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.

CData Cloud

ListEmailStats

Query statistical information for a list email, such as the number of clicks, opens, and opt-outs.

Columns

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.

CData Cloud

Opportunities

Retrieve a collection of opportunities

Columns

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.

CData Cloud

ReplyToOptions

Query the replyTo options of email templates.

Columns

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.

CData Cloud

SenderOptions

Query the sender options of email templates.

Columns

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.

CData Cloud

TaggedObjects

Retrieve tagged objects.

Columns

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.

CData Cloud

TrackerDomains

Query the available tracker domains.

テーブル固有の情報

Select

Cloud はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • Id は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • IsDeleted は'=' をサポートしています。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM TrackerDomains WHERE Id = 50

GetDeleted

削除されたレコードを取得するには、GETDELETED 文を実行します。

GETDELETED FROM TrackerDomains 

Columns

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.

CData Cloud

Users

Query the available users.

テーブル固有の情報

Select

Cloud はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • Id は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • IsDeleted は'=' をサポートしています。
  • UpdatedAt は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • CreatedAt は '='、'<'、'<='、'>'、'>=' をサポートしています。

例えば、次のクエリはサーバーサイドで処理されます。

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'

Get Deleted

削除されたユーザーを取得するには、GETDELETED 文を実行します。

GETDELETED FROM Users

Columns

Name Type References Description
Id [KEY] Int64 Pardot ID for this object.
Email 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.

CData Cloud

VisitorActivities

Retrieve visitor activities.

Columns

Name Type References Description
Id [KEY] Int64 Pardot ID for this campaign.
CampaignId Int64

Campaigns.Id

Pardot ID for the associated campaign.
CustomRedirectId Int64

CustomRedirects.Id

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

EmailTemplates.Id

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

VisitorsPageViews.Id

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

Opportunities.Id

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.

CData Cloud

Visitors

Retrieve visitors.

Columns

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.

CData Cloud

VisitorsPageViews

Retrieve visitors page views.

テーブル固有の情報

Select

Cloud はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • Id は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • VisitId は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • VisitorId は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • CreatedAt は '='、'<'、'<='、'>'、'>=' をサポートしています。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM VisitorPageViews WHERE VisitId = 22
SELECT * FROM VisitorPageViews WHERE Id >= 22 AND VisitorId = 1234

GetDeleted

To retrieve VisitorPageViews that are in the recycle bin in Pardot the following operation is supported:

GETDELETED FROM VisitorPageViews

Columns

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.

CData Cloud

Visits

Retrieve visits.

テーブル固有の情報

Select

Cloud はSalesforce Marketing Cloud Account Engagement API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • Id は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • VisitorId は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • ProspectId は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • CreatedAt は '='、'<'、'<='、'>'、'>=' をサポートしています。
  • UpdatedAt は '='、'<'、'<='、'>'、'>=' をサポートしています。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM Visits WHERE Id = 22
SELECT * FROM Visits WHERE VisitorId > 234

GetDeleted

To retrieve Visits that are in the recycle bin in Pardot the following operation is supported:

GETDELETED FROM Visits

Columns

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.

CData Cloud

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、Salesforce Marketing Cloud Account Engagement の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにSalesforce Marketing Cloud Account Engagement から関連するレスポンスデータを返します。

CData Cloud - 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.

CData Cloud

CreateStudioProgram

Create an Engagement Studio Program using an Engagement Studio Program structure.

Table Specific Information

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';

Input

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.

Result Set Columns

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.

CData Cloud

SendEmail

Send an email to a list of prospects or a single prospect.

Input

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.

Result Set Columns

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.

CData Cloud

UpdateBulkActionStatus

Update the status of a bulk action.

Input

Name Type Required Description
Id Int64 True The ID of the bulk action job.
Status String True The new status. Ex: Paused, Ready, Cancelled.

Result Set Columns

Name Type Description
Success Boolean Shows whether the batch was added successfully.

CData Cloud

システムテーブル

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、Salesforce Marketing Cloud Account Engagement のデータベースメタデータを返します。

  • sys_catalogs:利用可能なデータベースをリスト。
  • sys_schemas:利用可能なスキーマをリスト。
  • sys_tables:利用可能なテーブルおよびビューをリスト。
  • sys_tablecolumns:利用可能なテーブルおよびビューのカラムについて説明。
  • sys_procedures:利用可能なストアドプロシージャについて説明。
  • sys_procedureparameters:ストアドプロシージャパラメータについて説明。
  • sys_keycolumns:主キーおよび外部キーについて説明。
  • sys_indexes:利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

  • sys_connection_props:利用可能な接続プロパティについての情報を返す。
  • sys_sqlinfo:Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

  • sys_identity:バッチ処理または単一の更新に関する情報を返す。

CData Cloud

sys_catalogs

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String データベース名。

CData Cloud

sys_schemas

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

Name Type Description
CatalogName String データベース名。
SchemaName String スキーマ名。

CData Cloud

sys_tables

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベース。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String テーブル名またはビュー名。
TableType String テーブルの種類(テーブルまたはビュー)。
Description String テーブルまたはビューの説明。
IsUpdateable Boolean テーブルが更新可能かどうか。

CData Cloud

sys_tablecolumns

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、Prospects テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Prospects' 

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベースの名前。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String カラムを含むテーブルまたはビューの名前。
ColumnName String カラム名。
DataTypeName String データ型の名前。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length Int32 カラムのストレージサイズ。
DisplaySize Int32 指定されたカラムの通常の最大幅(文字数)。
NumericPrecision Int32 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。
NumericScale Int32 カラムのスケール(小数点以下の桁数)。
IsNullable Boolean カラムがNull を含められるかどうか。
Description String カラムの簡単な説明。
Ordinal Int32 カラムのシーケンスナンバー。
IsAutoIncrement String カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn String 生成されたカラムであるかどうか。
IsHidden Boolean カラムが非表示かどうか。
IsArray Boolean カラムが配列かどうか。
IsReadOnly Boolean カラムが読み取り専用かどうか。
IsKey Boolean sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。
ColumnType String スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。

CData Cloud

sys_procedures

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベース。
SchemaName String ストアドプロシージャを含むスキーマ。
ProcedureName String ストアドプロシージャの名前。
Description String ストアドプロシージャの説明。
ProcedureType String PROCEDURE やFUNCTION などのプロシージャのタイプ。

CData Cloud

sys_procedureparameters

ストアドプロシージャパラメータについて説明します。

次のクエリは、UnAssignProspect ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'UnAssignProspect' AND Direction = 1 OR Direction = 2

パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'UnAssignProspect' AND IncludeResultColumns='True'

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベースの名前。
SchemaName String ストアドプロシージャを含むスキーマの名前。
ProcedureName String パラメータを含むストアドプロシージャの名前。
ColumnName String ストアドプロシージャパラメータの名前。
Direction Int32 パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
DataTypeName String データ型の名前。
NumericPrecision Int32 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。
Length Int32 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericScale Int32 数値データの小数点以下の桁数。
IsNullable Boolean パラメータがNull を含められるかどうか。
IsRequired Boolean プロシージャの実行にパラメータが必要かどうか。
IsArray Boolean パラメータが配列かどうか。
Description String パラメータの説明。
Ordinal Int32 パラメータのインデックス。
Values String このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。
SupportsStreams Boolean パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。
IsPath Boolean パラメータがスキーマ作成操作のターゲットパスかどうか。
Default String 何も値が指定されていない場合に、このパラメータで使用される値。
SpecificName String 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。
IsCDataProvided Boolean プロシージャがネイティブのSalesforce Marketing Cloud Account Engagement プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。

CData Cloud

sys_keycolumns

主キーおよび外部キーについて説明します。

次のクエリは、Prospects テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Prospects' 
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
IsKey Boolean カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey Boolean カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。

CData Cloud

sys_foreignkeys

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

名前 タイプ 説明
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。
ForeignKeyType String 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。

CData Cloud

sys_primarykeys

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前。
KeySeq String 主キーのシーケンス番号。
KeyName String 主キーの名前。

CData Cloud

sys_indexes

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name Type Description
CatalogName String インデックスを含むデータベースの名前。
SchemaName String インデックスを含むスキーマの名前。
TableName String インデックスを含むテーブルの名前。
IndexName String インデックス名。
ColumnName String インデックスに関連付けられたカラムの名前。
IsUnique Boolean インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary Boolean インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type Int16 インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder String 並べ替え順序:A が昇順、D が降順。
OrdinalPosition Int16 インデックスのカラムのシーケンスナンバー。

CData Cloud

sys_connection_props

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name Type Description
Name String 接続プロパティ名。
ShortDescription String 簡単な説明。
Type String 接続プロパティのデータ型。
Default String 明示的に設定されていない場合のデフォルト値。
Values String 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value String 設定した値またはあらかじめ設定されたデフォルト。
Required Boolean プロパティが接続に必要かどうか。
Category String 接続プロパティのカテゴリ。
IsSessionProperty String プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity String プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName String キャメルケースの短縮形の接続プロパティ名。
Ordinal Int32 パラメータのインデックス。
CatOrdinal Int32 パラメータカテゴリのインデックス。
Hierarchy String このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible Boolean プロパティが接続UI に表示されるかどうかを通知します。
ETC String プロパティに関するその他のさまざまな情報。

CData Cloud

sys_sqlinfo

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

名前説明有効な値
AGGREGATE_FUNCTIONSサポートされている集計関数。AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTCOUNT 関数がサポートされているかどうか。YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR識別子をエスケープするための開始文字。[
IDENTIFIER_QUOTE_CLOSE_CHAR識別子をエスケープするための終了文字。]
SUPPORTED_OPERATORSサポートされているSQL 演算子。=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYGROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESサポートされている外部結合の種類。NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS外部結合がサポートされているかどうか。YES, NO
SUBQUERIESサブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSサポートされている文字列関数。LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONSサポートされている数値関数。ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONSサポートされている日付および時刻関数。NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLESレプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNSレプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTIONプロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。YES, NO
DIALECT使用するSQL ダイアレクトを示します。
KEY_PROPERTIESUniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMASプロバイダー用に複数のスキームが存在するかどうかを示します。YES, NO
SUPPORTS_MULTIPLE_CATALOGSプロバイダー用に複数のカタログが存在するかどうかを示します。YES, NO
DATASYNCVERSIONこのドライバーにアクセスするために必要な、CData Sync のバージョン。Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYこのドライバーのCData Sync カテゴリ。Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLAPI で提供されている以上の、追加SQL 機能がサポートされているかどうか。TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSバッチ操作がサポートされているかどうか。YES, NO
SQL_CAPこのドライバーでサポートされているすべてのSQL 機能。SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERYドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。YES, NO
PSEUDO_COLUMNS利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。TRUE, FALSE
REPLICATION_MIN_DATE_QUERYレプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTIONサーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATEレプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERYレプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTIONサーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTIDCheckCache 構文を親キーカラムに対して実行するかどうかを示します。TRUE, FALSE
CREATE_SCHEMA_PROCEDURESスキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。

Columns

Name Type Description
NAME String SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE String サポートされるSQL またはSQL 構文の詳細。

CData Cloud

sys_identity

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

Name Type Description
Id String データ変更処理から返された、データベース生成Id。
Batch String バッチの識別子。1 は単一処理。
Operation String バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。
Message String SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

CData Cloud

sys_information

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductString製品名。
VersionString製品のバージョン番号。
DatasourceString製品が接続するデータソースの名前。
NodeIdString製品がインストールされているマシンの固有識別子。
HelpURLString製品のヘルプドキュメントのURL。
LicenseString製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。)
LocationString製品のライブラリが格納されているファイルパスの場所。
EnvironmentString製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersionString本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategoryStringCData Sync 機能のカテゴリ(例:Source、Destination)。

CData Cloud

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Authentication


プロパティ説明
AuthSchemeThe type of authentication to use when connecting to Salesforce Marketing Cloud Account Engagement.
SchemaSpecify the Salesforce Marketing Cloud Account Engagement API version to use. SalesforcePardotV5 is the rebuilt API.
BusinessUnitIDYour Salesforce Marketing Cloud Account Engagement Business Unit ID (BU). Required when connecting via OAuth 2.0.
IsDemoAccountWhether the provided account is a demo account or not.
UseSalesforceSandboxA boolean determining if the connection should be made to a Salesforce sandbox account.
UserThe user that is SSO-enabled.
PasswordThe password of the user that is SSO-enabled.
SecurityTokenThe security token used to authenticate access to the Salesforce Marketing Cloud Account Engagement account.

BulkAPI


プロパティ説明
BulkModeDetermines if Bulk APIs will be used and if the driver should wait for the results.

OAuth


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)

JWT OAuth


プロパティ説明
OAuthJWTCertクライアント証明書のJWT 証明書ストアの名前を指定します。
OAuthJWTCertTypeJWT 証明書を格納しているキーストアの種類を指定します。
OAuthJWTCertPasswordパスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTCertSubjectストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。
OAuthJWTIssuerJava Web Token の発行者。
OAuthJWTSubjectアプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

SSL


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Logging


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

Miscellaneous


プロパティ説明
ArchivedSpecify whether to get archived or unarchived records.
IncludeCustomFieldsSpecifies whether to include custom fields in the metadata for tables that support them.
IncludeMessageValid 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 を含まないクエリで返される最大行数を指定します。
MaxThreadsSpecifies the number of concurrent requests.
Pagesizeprovider がSalesforce Marketing Cloud Account Engagement にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
ResponseModeThe 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.
ServerTimeZoneSpecifies 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.
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
ValueDelimiterThe delimiter used for multi-select fields values.
CData Cloud

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。


プロパティ説明
AuthSchemeThe type of authentication to use when connecting to Salesforce Marketing Cloud Account Engagement.
SchemaSpecify the Salesforce Marketing Cloud Account Engagement API version to use. SalesforcePardotV5 is the rebuilt API.
BusinessUnitIDYour Salesforce Marketing Cloud Account Engagement Business Unit ID (BU). Required when connecting via OAuth 2.0.
IsDemoAccountWhether the provided account is a demo account or not.
UseSalesforceSandboxA boolean determining if the connection should be made to a Salesforce sandbox account.
UserThe user that is SSO-enabled.
PasswordThe password of the user that is SSO-enabled.
SecurityTokenThe security token used to authenticate access to the Salesforce Marketing Cloud Account Engagement account.
CData Cloud

AuthScheme

The type of authentication to use when connecting to Salesforce Marketing Cloud Account Engagement.

Possible Values

OAuth, OAuthPassword, OAuthJWT

データ型

string

デフォルト値

"OAuth"

解説

  • OAuth: Set this to perform OAuth with the code grant type.
  • OAuthPassword: Set this to perform OAuth with the password grant type.
  • OAuthJWT: Set this to perform OAuth authentication with a JWT certificate. Requires the following additional connection properties. [OAuthJWTCert,/OAuthJWTCertType/OAuthJWTCertPassword/OAuthJWTCertSubject/OAuthJWTIssuer/OAuthJWTSubject]

CData Cloud

Schema

Specify the Salesforce Marketing Cloud Account Engagement API version to use. SalesforcePardotV5 is the rebuilt API.

Possible Values

SalesforcePardotV3, SalesforcePardotV4, SalesforcePardotV5

データ型

string

デフォルト値

"SalesforcePardotV5"

解説

Specify the Salesforce Marketing Cloud Account Engagement API version to use. SalesforcePardotV5 is the rebuilt API.

CData Cloud

BusinessUnitID

Your Salesforce Marketing Cloud Account Engagement Business Unit ID (BU). Required when connecting via OAuth 2.0.

データ型

string

デフォルト値

""

解説

CData Cloud

IsDemoAccount

Whether the provided account is a demo account or not.

データ型

bool

デフォルト値

false

解説

If set to true, all the requests will be made to the Pardot demo endpoints.

CData Cloud

UseSalesforceSandbox

A boolean determining if the connection should be made to a Salesforce sandbox account.

データ型

bool

デフォルト値

false

解説

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".

CData Cloud

User

The user that is SSO-enabled.

データ型

string

デフォルト値

""

解説

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.

CData Cloud

Password

The password of the user that is SSO-enabled.

データ型

string

デフォルト値

""

解説

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.

CData Cloud

SecurityToken

The security token used to authenticate access to the Salesforce Marketing Cloud Account Engagement account.

データ型

string

デフォルト値

""

解説

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.

CData Cloud

BulkAPI

このセクションでは、本プロバイダーの接続文字列で設定可能なBulkAPI プロパティの全リストを提供します。


プロパティ説明
BulkModeDetermines if Bulk APIs will be used and if the driver should wait for the results.
CData Cloud

BulkMode

Determines if Bulk APIs will be used and if the driver should wait for the results.

Possible Values

None, Bulk, BulkWaitForResults

データ型

string

デフォルト値

"None"

解説

This property can have the following values:

  1. None - Bulk APIs will not be used
  2. Bulk - UPSERT/UPDATE/INSERT and DELETE will use Import and BulkActions API respectively, but it does not wait for the results of the operations.
  3. BulkWaitForResults - UPSERT/UPDATE/INSERT and DELETE will use Import and BulkActions API respectively

Use BulkMode=BulkWaitForResults if you want to know if a job failed or not, and get more information about the rows that failed by querying LastResultInfo#TEMP table. Since a bulk job may take some initial time until it starts getting processed, this will cause some delays. If you do not want to wait until the job is finished, you can use BulkMode=Bulk

CData Cloud

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
CData Cloud

OAuthClientId

カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

データ型

string

デフォルト値

""

解説

このプロパティは2つのケースで必要となります:

  • カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
  • ドライバーが埋め込みOAuth 資格情報を提供しない場合。

(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。)

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

OAuthClientSecret

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)

データ型

string

デフォルト値

""

解説

このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes:

  • この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
  • クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

JWT OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。


プロパティ説明
OAuthJWTCertクライアント証明書のJWT 証明書ストアの名前を指定します。
OAuthJWTCertTypeJWT 証明書を格納しているキーストアの種類を指定します。
OAuthJWTCertPasswordパスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTCertSubjectストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。
OAuthJWTIssuerJava Web Token の発行者。
OAuthJWTSubjectアプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。
CData Cloud

OAuthJWTCert

クライアント証明書のJWT 証明書ストアの名前を指定します。

データ型

string

デフォルト値

""

解説

OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword を使用してパスワードを指定します。

OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値が設定され、かつOAuthJWTCertSubject が設定されている場合、CData Cloud は証明書の検索を開始します。 詳しくは、OAuthJWTCertSubject を参照してください。

証明書ストアの指定はプラットフォームに依存します。

注記

  • Windows の共通のユーザーとシステム証明書ストアは以下のとおりです。
    • MY:個人証明書と関連付けられた秘密キーを 格納している証明書ストア。
    • CA:証明機関の証明書。
    • ROOT:ルート証明書。
    • SPC:ソフトウェア発行元証明書。
  • Javaでは、証明書ストアは通常、証明書および 任意の秘密キーを含むファイルです。
  • 証明書ストアの種類がPFXFile の場合は、 このプロパティにファイル名を設定します。
  • PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ(例えば、PKCS12証明書ストア)に設定する必要があります。

CData Cloud

OAuthJWTCertType

JWT 証明書を格納しているキーストアの種類を指定します。

Possible Values

PFXBLOB, JKSBLOB, PEMKEY_BLOB, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_BLOB, XMLBLOB, BCFKSBLOB

データ型

string

デフォルト値

"PEMKEY_BLOB"

解説

値説明注記
USER現在のユーザーが所有する証明書ストア。 Windows のみ使用可能です。
MACHINEマシンストア。Java やその他の非Windows 環境では使用できません。
PFXFILE証明書を含むPFX(PKCS12)ファイル。
PFXBLOBPFX(PKCS12)形式の証明書ストアをbase-64 でエンコードした文字列。
JKSFILE証明書を含むJava キーストア(JKS)ファイル。Java 専用。
JKSBLOBJava キーストア(JKS)形式の証明書ストアをbase-64 でエンコードした文字列。 Java 専用。
PEMKEY_FILE秘密鍵とオプションの証明書を含むPEM でエンコードされたファイル。
PEMKEY_BLOB秘密鍵とオプションの証明書をbase-64 でエンコードした文字列。
PUBLIC_KEY_FILEPEM またはDER でエンコードされた公開鍵証明書を含むファイル。
PUBLIC_KEY_BLOBPEM またはDER でエンコードされた公開鍵証明書をbase-64 でエンコードした文字列。
SSHPUBLIC_KEY_FILESSH 形式の公開鍵を含むファイル。
SSHPUBLIC_KEY_BLOBSSH 形式の公開鍵ををbase-64 でエンコードした文字列。
P7BFILE証明書を含むPKCS7 ファイル。
PPKFILEPuTTY 秘密キー(PPK)を含むファイル。
XMLFILEXML 形式の証明書を含むファイル。
XMLBLOBXML 形式の証明書を含む文字列。
BCFKSFILEBouncy Castle キーストアを含むファイル。
BCFKSBLOBBouncy Castle キーストアを含む文字列(base-64エンコード)。

CData Cloud

OAuthJWTCertPassword

パスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。

データ型

string

デフォルト値

""

解説

このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 パスワードが必要かどうかを判断するには、ご利用の証明書ストアのドキュメントまたは設定を参照してください。

CData Cloud

OAuthJWTCertSubject

ストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。

データ型

string

デフォルト値

"*"

解説

このプロパティの値は、ストアで一致する証明書を検索するために使用されます。検索プロセスは以下のように動作します。

  • サブジェクトに完全に一致する証明書が見つかれば、該当する証明書が選択されます。
  • 完全に一致するものがない場合、ストアは、サブジェクトがプロパティ値を含む証明書を検索します。
  • 一致する証明書がない場合、証明書は選択されません。

値を '*' に設定すると、ストアの先頭の証明書が自動的に選択されます。 証明書のサブジェクトは識別名フィールドおよび値のカンマ区切りのリストです。 例:CN=www.server.com, OU=test, C=US, [email protected]。

一般的なフィールドには以下のものが含まれます。

フィールド説明
CN共通名。一般的には、www.server.com のようなホスト名です。
O法人名
OU法人の部署名
L法人の住所(市町村名)
S法人の住所(都道府県)
C国名
EE メールアドレス

フィールド値にカンマが含まれる場合は、引用符で囲んでください。例:"O=ACME, Inc."。

CData Cloud

OAuthJWTIssuer

Java Web Token の発行者。

データ型

string

デフォルト値

""

解説

Java Web Token の発行者。 通常は、OAuth アプリケーションのクライアントId またはE メールアドレスとなります。

CData Cloud

OAuthJWTSubject

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

データ型

string

デフォルト値

""

解説

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクトです。通常は、ユーザーのアカウント名またはE メールアドレスとなります。

CData Cloud

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
CData Cloud

SSLServerCert

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

データ型

string

デフォルト値

""

解説

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:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

CData Cloud

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
CData Cloud

Verbosity

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

CData Cloud

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
CData Cloud

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

CData Cloud

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。


プロパティ説明
ArchivedSpecify whether to get archived or unarchived records.
IncludeCustomFieldsSpecifies whether to include custom fields in the metadata for tables that support them.
IncludeMessageValid 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 を含まないクエリで返される最大行数を指定します。
MaxThreadsSpecifies the number of concurrent requests.
Pagesizeprovider がSalesforce Marketing Cloud Account Engagement にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
ResponseModeThe 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.
ServerTimeZoneSpecifies 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.
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
ValueDelimiterThe delimiter used for multi-select fields values.
CData Cloud

Archived

Specify whether to get archived or unarchived records.

データ型

bool

デフォルト値

false

解説

This property is only valid for tables OneToOneEmails and EmailTemplates of SalesforcePardot.

CData Cloud

IncludeCustomFields

Specifies whether to include custom fields in the metadata for tables that support them.

データ型

bool

デフォルト値

true

解説

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.

CData Cloud

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.

データ型

bool

デフォルト値

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.

CData Cloud

MaxRows

集計やGROUP BY を含まないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。

CData Cloud

MaxThreads

Specifies the number of concurrent requests.

データ型

string

デフォルト値

"5"

解説

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".

CData Cloud

Pagesize

provider がSalesforce Marketing Cloud Account Engagement にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。

データ型

int

デフォルト値

1000

解説

クエリを処理する際、Salesforce Marketing Cloud Account Engagement でクエリされたデータすべてを一度にリクエストする代わりに、Cloud はクエリされたデータをページと呼ばれる部分ごとにリクエストすることができます。

この接続プロパティは、Cloud がページごとにリクエストする結果の最大数を決定します。

Note:大きなページサイズを設定すると全体的なクエリ実行時間が短縮される可能性がありますが、その場合、クエリ実行時にCloud がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあります。

CData Cloud

PseudoColumns

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

データ型

string

デフォルト値

""

解説

このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:

*=*

CData Cloud

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.

Possible Values

full, simple, bulk

データ型

string

デフォルト値

"simple"

解説

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.

CData Cloud

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.

データ型

string

デフォルト値

"AUTO"

解説

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:

  1. Log in to Account Engagement.
  2. Go to User Management > Users.
  3. Select the authenticated user.
  4. Locate the Timezone field.

Use the corresponding IANA timezone name (for example, America/Los_Angeles) as the value of this property.

If set to AUTO, the Cloud attempts to detect the correct timezone automatically. If autodetection fails or the wrong timezone is used, datetime values may be offset or misinterpreted.

CData Cloud

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

データ型

int

デフォルト値

60

解説

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

CData Cloud

ValueDelimiter

The delimiter used for multi-select fields values.

データ型

string

デフォルト値

","

解説

The delimiter used for multi-select fields values.

CData Cloud

Third Party Copyrights

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.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434