CData Cloud offers access to Salesforce Pardot across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a MySQL or SQL Server database can connect to Salesforce Pardot through CData Cloud.
CData Cloud allows you to standardize and configure connections to Salesforce Pardot as though it were any other OData endpoint, or standard SQL Server/MySQL database.
This page provides a guide to 接続の確立 to Salesforce Pardot in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
接続の確立 shows how to authenticate to Salesforce Pardot and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Salesforce Pardot through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Salesforce Pardot by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
この方法で認証するには、AuthScheme をOAuth に設定します。
パスワードグラント種別で認証する場合は、次の接続プロパティを設定する必要があります。
Set the AuthScheme to OAuthJWT.
To obtain the OAuthJWT consumer key:
http://localhost:8019/src/oauthCallback.rstAfter creating your OAuth Application, set the following connection properties:
Note: This flow never issues a refresh token.
OAuth requires the authenticating user to interact with Salesforce Pardot using the browser. The Cloud facilitates this in various ways as described below.
To connect via OAuth2.0 you need to obtain the BusinessUnitId.
To find the Pardot Business Unit ID, use Setup in Salesforce.
Your Pardot Business Unit ID begins with "0Uv" and is 18 characters long. If you cannot access the Pardot Account Setup information, ask your Salesforce Administrator to provide you with the Pardot Business Unit ID.
Note:
The driver does not handle expired refresh tokens. To make sure the refresh token will not expire, check that the Refresh Token Policy of your app is "valid until revoked".
Otherwise, if your app has been configured to revoke refresh tokens after the first usage, or after some time, you need to reset the connection each time the refresh token has been revoked.
You need to register an app to obtain the OAuthClientId and OAuthClientSecret.
See カスタムOAuth アプリの作成 for the procedure.
You can connect without setting any connection properties for your user credentials. After setting the following, you are ready to connect:
This section describes desktop authentication using the credentials for your custom OAuth app. See カスタムOAuth アプリの作成 for more information.
After setting the following, you are ready to connect:
Set the AuthScheme to OAuthJWT.
After creating your OAuth Application, set the following connection properties:
Note: This flow never issues a refresh token.
To create Salesforce Pardot data sources on headless servers or other machines on which the Cloud cannot open a browser, you need to authenticate from another machine. Authentication is a two-step process.
You can follow the headless OAuth authentication flow using the Cloud's embedded OAuth credentials or using the OAuth credentials for your custom OAuth app.
See カスタムOAuth アプリの作成 for a procedure. This section describes the procedure to authenticate and connect to data.
First, set the following properties on the headless machine:
Next, authenticate from another machine and obtain the OAuthVerifier connection property:
Finally, on the headless machine, set the following connection properties to obtain the OAuth authentication values:
After the OAuth settings file is generated, set the following properties to connect to data:
To install the Cloud on another machine, authenticate, and then transfer the resulting OAuth values:
Set the AuthScheme to OAuthJWT.
After creating your OAuth Application, set the following connection properties:
Note: This flow never issues a refresh token.
If you do not have access to the user name and password or do not wish to require them, you can use OAuth authentication. Salesforce Pardot uses the OAuth authentication standard, which requires the authenticating user to interact with Salesforce Pardot via the browser. The Cloud facilitates the OAuth exchange in various ways, as described in this section.
To obtain the OAuth client credentials, consumer key, and consumer secret:
| Date | Build Number | Change Type | Description |
| 08/17/2022 | 8264 | General | Changed
|
| 05/19/2022 | 8174 | Salesforce Pardot | Deprecated
Replacements
|
| 04/15/2022 | 8133 | Salesforce Pardot | Added
Added
|
| 02/23/2022 | 8089 | Salesforce Pardot | Added
|
| 02/15/2022 | 8081 | Salesforce Pardot | Changed
|
| 01/17/2022 | 8052 | Salesforce Pardot | Added
|
| 01/11/2022 | 8046 | Salesforce Pardot | Added
|
| 12/22/2021 | 8026 | Salesforce Pardot | Removed
|
| 10/07/2021 | 7950 | Salesforce Pardot | Added
|
| 09/02/2021 | 7915 | General | Added
|
| 08/07/2021 | 7889 | General | Changed
|
| 08/06/2021 | 7888 | General | Changed
|
| 07/23/2021 | 7874 | General | Changed
|
| 07/08/2021 | 7859 | General | Added
|
| 06/25/2021 | 7846 | Salesforce Pardot | Added
|
| 06/17/2021 | 7838 | Salesforce Pardot | Removed
|
| 04/23/2021 | 7785 | General | Added
|
| 04/23/2021 | 7783 | General | Changed
|
| 04/16/2021 | 7776 | General | Added
Changed
|
| 04/15 /2021 | 7775 | General | Changed
|
このセクションでは、Salesforce Pardot Cloud の高度な機能を厳選して説明します。
Cloud を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Cloud が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようCloud を設定します。トンネル接続を設定することもできます。
Cloud は、Salesforce Pardot にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
CData Cloud を使用すると、事前設定されたクエリによって内容が決定される仮想テーブルを定義できます。これらはユーザー定義ビューと呼ばれ、ツール からドライバーを使用する場合など、ドライバーに発行されるクエリを直接制御できない場合に役立ちます。 ユーザー定義ビューを使用して、常に適用されるプレディケートを定義することができます。ビューへのクエリで追加のプレディケートを指定すると、それらはビューの一部としてすでに定義されているクエリと結合されます。
ユーザー定義ビューを作成する方法は2つあります。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがCloud によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{
"MyView": {
"query": "SELECT * FROM Prospects WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"
SELECT * FROM Customers WHERE City = 'Raleigh';ドライバーへのクエリは次のようになります。
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';ソースへの効果的なクエリは次のようになります。
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';これは、ビュークエリとビュー定義を効果的に組み合わせた、ユーザー定義ビューへのクエリの非常にシンプルな例です。これらのクエリをはるかに複雑なパターンで構成することが可能です。すべてのSQL 操作は両方のクエリでサポートされ、必要に応じて組み合わされます。
デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
SQL-92をサポートしないソースに対しては、Cloud はSalesforce Pardot にSQLステートメントの処理を可能な限りオフロードし、残りのクエリをクライアントサイドのインメモリで処理します。その結果、最適なパフォーマンスを得ることができます。
限られたクエリ能力のデータソースに対しては、Cloud はSQL クエリの変換をおこない、Cloud がより単純になるよう処理します。 目標はデータソースのクエリ能力に基づいて賢く判断し可能な限り計算を抑えることです。Salesforce Pardot のクエリ評価コンポーネントはSQL クエリを検証し、Cloud がネイティブに実行できないクエリ部分を示す情報を返します。
Salesforce Pardot のクエリスライサーコンポーネントはより具体的なケースにおいて1つのクエリを複数の独立したクエリに分割するために使用されます。クライアントサイドのクエリエンジンはクエリの簡素化、複数のクエリへの分割、結果セットのサイズを最小化しながらクライアントサイドで集約のプッシュダウンや計算をするなどの決定を行います。
クエリを部分的にでもクライアントサイドで評価するということには大きなトレードオフがあります。このモデルでは効果的に実行することが不可能なクエリは常に存在し、この方法で計算すると特にコストが高くなるものもあります。CData は可能な限り効率的なクエリを生成し、最も柔軟なクエリ機能を提供するために常にデータソースに対して実行可能な限りのクエリをプッシュダウンしています。
Cloud のログを取得しておくことで、エラーメッセージや想定外の振る舞いを診断する際に役立ちます。
2つの接続プロパティを設定するだけで、Cloud のログを取得できます。
このプロパティを設定すると、認証が実行されたときやクエリが実行されたときなど、さまざまなタスクを実行する際に、Cloud がログファイルを生成します。指定したファイルが存在しない場合は作成されます。
Verbosity レベルは、Cloud がLogfile にどの程度の詳細さで記載するかを決定します。1 から5 までのVerbosity レベルがサポートされています。次のリストで、これらについて説明します。
| 1 | Verbosity を1に設定すると、クエリ、返された行数、実行開始とかかった時間、エラーが記録されます。 |
| 2 | Verbosity を2に設定すると、Verbosity 1に含まれるすべておよびリクエストに関する追加の情報が記録されます。 |
| 3 | Verbosity を3に設定すると、2 に加えてHTTP ヘッダーおよびリクエストとレスポンスの本文が記録されます。 |
| 4 | Verbosity を4に設定すると、3 に加えてデータソースとのトランスポートレベルの通信が記録されます。これには、SSL ネゴシエーションが含まれます。 |
| 5 | Verbosity を5に設定すると、データソースとのやり取りおよび問題のトラブルシューティングに役立つ追加情報も記録されます。これには、インターフェースコマンドが含まれます。 |
通常の実行では、Verbosity を2以上に設定しないでください。高い詳細レベルでは、大量のデータが記録されて、実行に遅れが生じる恐れがあります。
特定の情報に関するカテゴリを表示または非表示にしてログ内容を調整するには、LogModules を参照してください。
データセキュリティのベストプラクティス
パスワードなどのセンシティブデータは、接続文字列やログ内のすべてのリクエストでマスクされますが、組織外で共有する前に機密情報がないかログを確認することをお勧めします。
ログファイルに記録される情報を、正確に絞り込みたい場合があるかもしれません。これは、LogModules プロパティを使用することで可能です。
このプロパティを使えば、セミコロン区切りでリスト化されたログモジュールを使用してログ内容をフィルタできます。
すべてのモジュール名は4文字です。注意点として、3文字のモジュール名は、必ず最後に空白文字を含みます。利用可能なモジュールは次のとおりです。
LogModules=INFO;EXEC;SSL ;SQL ;META;
これらのモジュールはVerbosity を考慮して、取得中の情報の詳細レベルを変更します。
CData Cloud はクエリ、削除、編集、および挿入を含む、データに対する複数の処理をサポートします。
構文のリファレンスと例については、SELECT ステートメント を参照してください。
Salesforce Pardot API 機能の詳細については、データモデル を参照してください。
構文のリファレンスと例については、INSERT ステートメント を参照してください。
レコードの更新には、主キーId が必要です。構文のリファレンスと例については、UPDATE ステートメント を参照してください。
レコードの削除には、主キーId が必要です。構文のリファレンスと例については、DELETE ステートメント を参照してください。
GETDELETED ステートメントは削除されたレコードのId を返します。構文のリファレンスと例については、GETDELETED ステートメント を参照してください。
EXECUTE またはEXEC ステートメントを使用して、ストアドプロシージャを実行します。構文のリファレンスと例については、EXECUTE ステートメント を参照してください。
SELECT ステートメントは次の基本的な句で構成できます。
次の構文ダイアグラムは、Cloud のSQL エンジン:
SELECT {
[ TOP <numeric_literal> | DISTINCT ]
{
*
| {
<expression> [ [ AS ] <column_reference> ]
| { <table_name> | <correlation_name> } .*
} [ , ... ]
}
[ INTO csv:// [ filename= ] <file_path> [ ;delimiter=tab ] ]
{
FROM <table_reference> [ [ AS ] <identifier> ]
} [ , ... ]
[ [
INNER | { { LEFT | RIGHT | FULL } [ OUTER ] }
] JOIN <table_reference> [ ON <search_condition> ] [ [ AS ] <identifier> ]
] [ ... ]
[ WHERE <search_condition> ]
[ GROUP BY <column_reference> [ , ... ]
[ HAVING <search_condition> ]
[ UNION [ ALL ] <select_statement> ]
[
ORDER BY
<column_reference> [ ASC | DESC ] [ NULLS FIRST | NULLS LAST ]
]
[
LIMIT <expression>
[
{ OFFSET | , }
<expression>
]
]
} | SCOPE_IDENTITY()
<expression> ::=
| <column_reference>
| @ <parameter>
| ?
| COUNT( * | { [ DISTINCT ] <expression> } )
| { AVG | MAX | MIN | SUM | COUNT } ( <expression> )
| NULLIF ( <expression> , <expression> )
| COALESCE ( <expression> , ... )
| CASE <expression>
WHEN { <expression> | <search_condition> } THEN { <expression> | NULL } [ ... ]
[ ELSE { <expression> | NULL } ]
END
| <literal>
| <sql_function>
<search_condition> ::=
{
<expression> { = | > | < | >= | <= | <> | != | LIKE | NOT LIKE | IN | NOT IN | IS NULL | IS NOT NULL | AND | OR | CONTAINS | BETWEEN } [ <expression> ]
} [ { AND | OR } ... ]
でサポートされている構文の概要を示します。
SELECT * FROM Prospects
SELECT [Email] AS MY_Email FROM Prospects
SELECT CAST(AnnualRevenue AS VARCHAR) AS Str_AnnualRevenue FROM Prospects
SELECT * FROM Prospects WHERE ProspectAccountId = '703'
SELECT COUNT(*) AS MyCount FROM Prospects
SELECT COUNT(DISTINCT Email) FROM Prospects
SELECT DISTINCT Email FROM Prospects
SELECT Email, MAX(AnnualRevenue) FROM Prospects GROUP BY Email詳しくは、集計関数 を参照してください。
SELECT p.CampaignId, p.Email, pa.CreatedAt FROM Prospects p INNER JOIN ProspectAccounts pa ON p.ProspectAccountId = pa.Id詳しくは、JOIN クエリ を参照してください。
SELECT Id, Email FROM Prospects ORDER BY Email ASC
SELECT Id, Email FROM Prospects LIMIT 10
SELECT * FROM Prospects WHERE ProspectAccountId = @param
SELECT ステートメントで入力専用フィールドを使用できます。これらのフィールド（疑似カラム）は、結果には
通常のカラムとして表示されることはありませんが、WHERE 句の一部として指定できます。疑似カラムを使用して、Salesforce Pardot から追加機能にアクセスできます。
SELECT * FROM Prospects WHERE Pseudo = '@Pseudo'
クエリ条件に一致する行の数を返します。
SELECT COUNT(*) FROM Prospects WHERE ProspectAccountId = '703'
クエリ条件に一致する、null 以外の個別のフィールド値の数を返します。
SELECT COUNT(DISTINCT Id) AS DistinctValues FROM Prospects WHERE ProspectAccountId = '703'
カラムの値の平均を返します。
SELECT Email, AVG(AnnualRevenue) FROM Prospects WHERE ProspectAccountId = '703' GROUP BY Email
カラムの値の最小値を返します。
SELECT MIN(AnnualRevenue), Email FROM Prospects WHERE ProspectAccountId = '703' GROUP BY Email
カラムの値の最大値を返します。
SELECT Email, MAX(AnnualRevenue) FROM Prospects WHERE ProspectAccountId = '703' GROUP BY Email
カラムの値の合計を返します。
SELECT SUM(AnnualRevenue) FROM Prospects WHERE ProspectAccountId = '703'
CData Cloud は次の例のような標準SQL の結合をサポートします。
内部結合は、結合条件に合う行のみを両テーブルから選択します。
SELECT p.CampaignId, p.Email, pa.CreatedAt FROM Prospects p INNER JOIN ProspectAccounts pa ON p.ProspectAccountId = pa.Id
左結合は、FROM テーブルのすべての行とJOIN テーブルの条件に合う行のみを選択します。
SELECT v.Id, v.ProspectId, v.CreatedAt, vs.PageViewCount, vs.IpAddress FROM Visits v LEFT JOIN Visitors vs ON v.VisitorId = vs.Id
次の日付リテラル関数を使用して、相対間隔を使って日付フィールドをフィルタできます。これらの関数では、<、>、および = 演算子がサポートされていますが、<= および >= はサポートされていないことに注意してください。
現在の日。
SELECT * FROM MyTable WHERE MyDateField = L_TODAY()
前の日。
SELECT * FROM MyTable WHERE MyDateField = L_YESTERDAY()
次の日。
SELECT * FROM MyTable WHERE MyDateField = L_TOMORROW()
前の週のすべての日。
SELECT * FROM MyTable WHERE MyDateField = L_LAST_WEEK()
現在の週のすべての日。
SELECT * FROM MyTable WHERE MyDateField = L_THIS_WEEK()
次の週のすべての日。
SELECT * FROM MyTable WHERE MyDateField = L_NEXT_WEEK()以下も利用可能です：
現在の日を除く過去n 日。
SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_DAYS(3)
現在の日を含む次のn 日。
SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_DAYS(3)以下も利用可能です：
現在の週のn 週前から始まり、前の週で終わる、すべての週のすべての日。
SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_WEEKS(3)
次の週から始まり、n 週後に終わる、すべての週のすべての日。
SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_WEEKS(3)以下も利用可能です：
SELECT INTO ステートメントを使って、書式付きデータをファイルにエクスポートできます。
次のクエリは、comma-separated values（CSV）ファイルフォーマットにデータをエクスポートします。
SELECT Id, Email INTO [csv://Prospects.txt] FROM [Prospects] WHERE ProspectAccountId = '703'ファイルURI で他のフォーマットを指定できます。利用可能な区切り文字はタブ、セミコロン、カンマです。デフォルトはカンマです。次の例は、tab-separated values（TSV）にエクスポートします。
SELECT Id, Email INTO [csv://Prospects.txt;delimiter=tab] FROM [Prospects] WHERE ProspectAccountId = '703'URI で他のファイルフォーマットを指定できます。以下の例は、tab-separated values（TSV）にエクスポートします。
Cloud には、ほとんどの標準的なデータベースで使用できる関数と同様の関数が用意されています。これらの関数は、CData プロバイダーエンジンで実装されるため、同じ一貫したAPI を使用してすべてのデータソースに渡って使用できます。関数にはstring、date、math の3つのカテゴリがあります。
Cloud はすべてのSQL 関数入力を文字列またはカラム識別子のいずれかとして解釈するため、すべてのリテラルを単一引用符で文字列としてエスケープする必要があります。例えば、DATENAME 関数のSQL Server 構文とCloud 構文を比較すると次のようになります。
SELECT DATENAME(yy,GETDATE())
SELECT DATENAME('yy',GETDATE())
これらの関数は、文字列操作を実行し、文字列値を返します。詳しくは、文字列関数 を参照してください。
SELECT CONCAT(firstname, space(4), lastname) FROM Prospects WHERE ProspectAccountId = '703'
これらの関数は、日付および日時操作を実行します。詳しくは、日付関数 を参照してください。
SELECT CURRENT_TIMESTAMP() FROM Prospects
これらの関数は、数値演算を提供します。詳しくは、算術関数 を参照してください。
SELECT RAND() FROM Prospects
SELECT CONCAT('Mr.', SPACE(2), firstname, SPACE(4), lastname) FROM Prospects
文字式の左端の文字のASCII コード値を返します。
SELECT ASCII('0');
-- Result: 48
整数のASCII コードを対応する文字に変換します。
SELECT CHAR(48);
-- Result: '0'
指定した文字列式の開始位置を返します。
SELECT CHARINDEX('456', '0123456');
-- Result: 4
SELECT CHARINDEX('456', '0123456', 5);
-- Result: -1
式内にあるUTF-8 文字の数を返します。
SELECT CHAR_LENGTH('sample text') FROM Account LIMIT 1
-- Result: 11
2つ以上の文字列値を連結した文字列を返します。
SELECT CONCAT('Hello, ', 'world!');
-- Result: 'Hello, world!'
expressionToSearch 中にexpressionToFind が見つかった場合は1を、それ以外は0を返します。
SELECT CONTAINS('0123456', '456');
-- Result: 1
SELECT CONTAINS('0123456', 'Not a number');
-- Result: 0
character_expression がcharacter_suffix で終わる場合は1を、それ以外は0を返します。
SELECT ENDSWITH('0123456', '456');
-- Result: 1
SELECT ENDSWITH('0123456', '012');
-- Result: 0
指定されたファイルパスのファイルに存在するバイト数を返します。
SELECT FILESIZE('C:/Users/User1/Desktop/myfile.txt');
-- Result: 23684
指定された書式で値をフォーマットして返します。
SELECT FORMAT(12.34, '#');
-- Result: 12
SELECT FORMAT(12.34, '#.###');
-- Result: 12.34
SELECT FORMAT(1234, '0.000E0');
-- Result: 1.234E3
SELECT FORMAT('2019/01/01', 'yyyy-MM-dd');
-- Result: 2019-01-01
SELECT FORMAT('20190101', 'yyyyMMdd', 'yyyy-MM-dd');
-- Result: '2019-01-01'
unix_timestamp 引数を、現在のタイムゾーンで表されたYYYY-MM-DD HH:MM:SS の値で返します。
SELECT FROM_UNIXTIME(1540495231, 1);
-- Result: 2018-10-25 19:20:31
SELECT FROM_UNIXTIME(1540495357385, 0);
-- Result: 2018-10-25 19:22:37
指定されたアルゴリズムを使用して、入力値のハッシュをバイト配列として返します。サポートされているアルゴリズムはMD5、SHA1、SHA2_256、SHA2_512、SHA3_224、SHA3_256、SHA3_384、およびSHA3_512 です。
SELECT HASHBYTES('MD5', 'Test');
-- Result (byte array): 0x0CBC6611F5540BD0809A388DC95A615B
指定した文字列式の開始位置を返します。
SELECT INDEXOF('0123456', '456');
-- Result: 4
SELECT INDEXOF('0123456', '456', 5);
-- Result: -1
null を指定した置換値に置き換えます。
SELECT ISNULL(42, 'Was NULL');
-- Result: 42
SELECT ISNULL(NULL, 'Was NULL');
-- Result: 'Was NULL'
JSON オブジェクト内のJSON 配列の平均値を計算します。配列へのパスはjsonpath 引数で指定します。戻り値は数値またはnull です。
SELECT JSON_AVG('[1,2,3,4,5]', '$[x]');
-- Result: 3
SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
-- Result: 3
SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
-- Result: 4.5
JSON オブジェクト内のJSON 配列のエレメント数を返します。配列へのパスはjsonpath 引数で指定します。戻り値は数値またはnull です。
SELECT JSON_COUNT('[1,2,3,4,5]', '$[x]');
-- Result: 5
SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
-- Result: 5
SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
-- Result: 2
JSON 配列またはオブジェクトのあらゆる値を選択します。配列へのパスはjsonpath 引数で指定します。戻り値は数値またはnull です。
SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test');
-- Result: '{"data":1}'
SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test.data');
-- Result: 1
SELECT JSON_EXTRACT('{"test": {"data": [1, 2, 3]}}', '$.test.data[1]');
-- Result: 2
JSON オブジェクト内のJSON 配列の最大値を取得します。配列へのパスはjsonpath 引数で指定します。戻り値は数値またはnull です。
SELECT JSON_MAX('[1,2,3,4,5]', '$[x]');
-- Result: 5
SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
-- Result: 5
SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[..3]');
-- Result: 4
JSON オブジェクト内のJSON 配列の最小値を取得します。配列へのパスはjsonpath 引数で指定します。戻り値は数値またはnull です。
SELECT JSON_MIN('[1,2,3,4,5]', '$[x]');
-- Result: 1
SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
-- Result: 1
SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
-- Result: 4
JSONPath 式に応じたJSON のサマリー値を計算します。戻り値は数値またはnull です。
SELECT JSON_SUM('[1,2,3,4,5]', '$[x]');
-- Result: 15
SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
-- Result: 15
SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
-- Result: 9
指定された文字列の左端から指定された数の文字を返します。
SELECT LEFT('1234567890', 3);
-- Result: '123'
指定された文字列式の文字数を返します。
SELECT LEN('12345');
-- Result: 5
部分文字列が表示される文字列の文字数を表す整数を返します。
SELECT LOCATE('sample','XXXXXsampleXXXXX');
-- Result: 6
大文字データを小文字に変換した文字式を返します。
SELECT LOWER('MIXED case');
-- Result: 'mixed case'
先頭の空白を除いた文字式を返します。
SELECT LTRIM(' trimmed');
-- Result: 'trimmed'
start_index とend_index の間の文字を文字列内のmask_character に置き換えます。
SELECT MASK('1234567890','*',);
-- Result: '**********'
SELECT MASK('1234567890','*', 4);
-- Result: '1234******'
SELECT MASK('1234567890','*', 4, 2);
-- Result: '1234****90'
Unicode 標準の定義に従って、指定された整数コードのUnicode 文字を返します。
式内にあるバイト数を返します。
SELECT OCTET_LENGTH('text') FROM Account LIMIT 1
-- Result: 4
式内に最初に見つかったパターンの開始位置を返します。パターンが見つからなかった場合は0を返します。
SELECT PATINDEX('123%', '1234567890');
-- Result: 1
SELECT PATINDEX('%890', '1234567890');
-- Result: 8
SELECT PATINDEX('%456%', '1234567890');
-- Result: 4
指定した文字列式の開始位置を返します。
SELECT POSITION('456' IN '123456');
-- Result: 4
SELECT POSITION('x' IN '123456');
-- Result: 0
指定されたUnicode 文字列に必要な区切り記号を追加することで、有効なSQL Server の区切り付き識別子を返します。
SELECT QUOTENAME('table_name');
-- Result: '[table_name]'
SELECT QUOTENAME('table_name', '"');
-- Result: '"table_name"'
SELECT QUOTENAME('table_name', '[');
-- Result: '[table_name]'
見つかった文字列をすべて別の文字列に置換します。
SELECT REPLACE('1234567890', '456', '|');
-- Result: '123|7890'
SELECT REPLACE('123123123', '123', '.');
-- Result: '...'
SELECT REPLACE('1234567890', 'a', 'b');
-- Result: '1234567890'
文字列値を指定された回数だけ繰り返します。
SELECT REPLACE('x', 5);
-- Result: 'xxxxx'
文字列式を逆順序で返します。
SELECT REVERSE('1234567890');
-- Result: '0987654321'
文字列の右側から指定された数の文字を返します。
SELECT RIGHT('1234567890', 3);
-- Result: '890'
末尾の空白を削除した後の文字式を返します。
SELECT RTRIM('trimmed ');
-- Result: 'trimmed'
文字列の音声表現に基づいて、4文字のSoundex コードを返します。
SELECT SOUNDEX('smith');
-- Result: 'S530'
空白の繰り返しで構成される文字列を返します。
SELECT SPACE(5);
-- Result: ' '
区切り文字の間の文字列のセクションを返します。
SELECT SPLIT('a/b/c/d', '/', 1);
-- Result: 'a'
SELECT SPLIT('a/b/c/d', '/', -2);
-- Result: 'c'
character_expression がcharacter_prefix で始まる場合は1を、それ以外は0を返します。
SELECT STARTSWITH('0123456', '012');
-- Result: 1
SELECT STARTSWITH('0123456', '456');
-- Result: 0
数値データから変換された文字データを返します。例えば、STR(123.45, 6, 1) は123.5 を返します。
SELECT STR('123.456');
-- Result: '123'
SELECT STR('123.456', 2);
-- Result: '**'
SELECT STR('123.456', 10, 2);
-- Result: '123.46'
文字列を別の文字列内に挿入します。まず、最初の文字列の指定された開始位置から指定された長さの文字を削除し、次に、2番目の文字列を最初の文字列の指定された開始位置に挿入します。
SELECT STUFF('1234567890', 3, 2, 'xx');
-- Result: '12xx567890'
文字列のうち、指定されたインデックスから始まる指定された長さの部分を返します。
SELECT SUBSTRING('1234567890' FROM 3 FOR 2);
-- Result: '34'
SELECT SUBSTRING('1234567890' FROM 3);
-- Result: '34567890'
インスタンスの値を同様の文字列表現に変換します。
SELECT TOSTRING(123);
-- Result: '123'
SELECT TOSTRING(123.456);
-- Result: '123.456'
SELECT TOSTRING(null);
-- Result: ''
左および/または右の空白を除いた文字式を返します。
SELECT TRIM(' trimmed ');
-- Result: 'trimmed'
SELECT TRIM(LEADING FROM ' trimmed ');
-- Result: 'trimmed '
SELECT TRIM('-' FROM '-----trimmed-----');
-- Result: 'trimmed'
SELECT TRIM(BOTH '-' FROM '-----trimmed-----');
-- Result: 'trimmed'
SELECT TRIM(TRAILING '-' FROM '-----trimmed-----');
-- Result: '-----trimmed'
インプット式の最初の文字のUnicode 標準で定義された整数の値を返します。
文字式の小文字データを大文字に変換して返します。
SELECT UPPER('MIXED case');
-- Result: 'MIXED CASE'
指定されたXPath を使ってXML ドキュメントを抽出して、XML をフラット化します。デフォルトでは、出力の区切りにはカンマが使用されますが、これは3番目のパラメータを指定することで変更できます。
SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch');
-- Result: 'a,e,i,o,u'
SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch', ';');
-- Result: 'a;e;i;o;u'
現在のdate 値を返します。
SELECT CURRENT_DATE();
-- Result: 2018-02-01
現在のデータベースシステムのタイムスタンプをdatetime 値で返します。この値はGETDATE およびSYSDATETIME と等しく、常にローカルタイムゾーンになります。
SELECT CURRENT_TIMESTAMP();
-- Result: 2018-02-01 03:04:05
date の指定されたdatepart に、指定されたnumber（符号付き整数）を加算したdatetime 値を返します。
SELECT DATEADD('d', 5, '2018-02-01');
-- Result: 2018-02-06
SELECT DATEADD('hh', 5, '2018-02-01 00:00:00');
-- Result: 2018-02-01 05:00:00
指定されたstartdate とenddate の差（符号付き整数）を返します。
SELECT DATEDIFF('d', '2018-02-01', '2018-02-10');
-- Result: 9
SELECT DATEDIFF('hh', '2018-02-01 00:00:00', '2018-02-01 12:00:00');
-- Result: 12
指定された年、月、および日のdatetime 値を返します。
SELECT DATEFROMPARTS(2018, 2, 1);
-- Result: 2018-02-01
指定されたdate の指定されたdatepart を表す文字列を返します。
SELECT DATENAME('yy', '2018-02-01');
-- Result: '2018'
SELECT DATENAME('dw', '2018-02-01');
-- Result: 'Thursday'
指定されたdate の指定されたdatepart を表す文字列を返します。
SELECT DATEPART('yy', '2018-02-01');
-- Result: 2018
SELECT DATEPART('dw', '2018-02-01');
-- Result: 5
指定されたdatepart のdatetime 値を返します。
SELECT DATETIME2FROMPARTS(2018, 2, 1, 1, 2, 3, 456, 3);
-- Result: 2018-02-01 01:02:03.456
指定されたdatepart のdatetime 値を返します。
SELECT DATETIMEFROMPARTS(2018, 2, 1, 1, 2, 3, 456);
-- Result: 2018-02-01 01:02:03.456
指定されたdatepart の精度に日付を切り捨てます。Oracle TRUNC 関数をモデルにしています。
SELECT DATE_TRUNC('05-04-2005', 'YY');
-- Result: '1/1/2005'
SELECT DATE_TRUNC('05-04-2005', 'MM');
-- Result: '5/1/2005'
指定されたdatepart の精度に日付を切り捨てます。PostgreSQL date_trunc 関数をモデルにしています。
SELECT DATE_TRUNC2('year', '2020-02-04');
-- Result: '2020-01-01'
SELECT DATE_TRUNC2('week', '2020-02-04', 'monday');
-- Result: '2020-02-02', which is the previous Monday
指定されたdate の日コンポーネントを指定する整数を返します。
SELECT DAY('2018-02-01');
-- Result: 1
SELECT DAYOFMONTH('04/15/2000');
-- Result: 15
SELECT DAYOFWEEK('04/15/2000');
-- Result: 7
SELECT DAYOFYEAR('04/15/2000');
-- Result: 106
指定されたdate を含む月、またはオプションでその月からオフセットされた月の最終日を返します。
SELECT EOMONTH('2018-02-01');
-- Result: 2018-02-28
SELECT LAST_DAY('2018-02-01');
-- Result: 2018-02-28
SELECT EOMONTH('2018-02-01', 2);
-- Result: 2018-04-30
SELECT FDWEEK('02-08-2018');
-- Result: 2/4/2018
SELECT FDMONTH('02-08-2018');
-- Result: 2/1/2018
SELECT FDQUARTER('05-08-2018');
-- Result: 4/1/2018
関連ファイルの変更日に関連付けられたタイムスタンプを返します。
SELECT FILEMODIFIEDTIME('C:/Documents/myfile.txt');
-- Result: 6/25/2019 10:06:58 AM
1582-10-15以降の日数から派生した日付を返します（グレゴリオ暦に基づく）。これはMYSQL FROM_DAYS 関数と同等です。
SELECT FROM_DAYS(736000); -- Result: 2/6/2015
現在のデータベースシステムのタイムスタンプをdatetime 値で返します。この値はCURRENT_TIMESTAMP およびSYSDATETIME と等しく、常にローカルタイムゾーンになります。
SELECT GETDATE();
-- Result: 2018-02-01 03:04:05
UTC datetime 値としてフォーマットされた現在のデータベースシステムのタイムスタンプを返します。SYSUTCDATETIME と同じです。
SELECT GETUTCDATE();
-- For example, if the local timezone is Eastern European Time (GMT+2)
-- Result: 2018-02-01 05:04:05
指定されたdatetime から時間コンポーネントを返します。
SELECT HOUR('02-02-2020 11:30:00');
-- Result: 11
この値が有効なdate、time、またはdatetime 値である場合は1を返します。それ以外の場合は0を返します。
SELECT ISDATE('2018-02-01', 'yyyy-MM-dd');
-- Result: 1
SELECT ISDATE('Not a date');
-- Result: 0
現在の日付のちょうど一週間前のタイムスタンプを返します。
SELECT LAST_WEEK(); //Assume the date is 3/17/2020 -- Result: 3/10/2020
現在の日付のちょうど一ヶ月前のタイムスタンプを返します。
SELECT LAST_MONTH(); //Assume the date is 3/17/2020 -- Result: 2/17/2020
現在の日付のちょうど一年前のタイムスタンプを返します。
SELECT LAST_YEAR(); //Assume the date is 3/17/2020 -- Result: 3/10/2019
指定された週の最終日を返します。
SELECT LDWEEK('02-02-2020');
-- Result: 2/8/2020
指定された月の最終日を返します。
SELECT LDMONTH('02-02-2020');
-- Result: 2/29/2020
指定された四半期の最終日を返します。
SELECT LDQUARTER('02-02-2020');
-- Result: 3/31/2020
年と日数から日付値を返します。
SELECT MAKEDATE(2020, 1);
-- Result: 2020-01-01
指定されたdatetime から分コンポーネントを返します。
SELECT MINUTE('02-02-2020 11:15:00');
-- Result: 15
指定されたdatetime から月コンポーネントを返します。
SELECT MONTH('02-02-2020');
-- Result: 2
指定されたdatetime に関連付けられた四半期を返します。
SELECT QUARTER('02-02-2020');
-- Result: 1
指定されたdatetime から秒コンポーネントを返します。
SELECT SECOND('02-02-2020 11:15:23');
-- Result: 23
指定された日時のdatetime 値を返します。
SELECT SMALLDATETIMEFROMPARTS(2018, 2, 1, 1, 2);
-- Result: 2018-02-01 01:02:00
指定された文字列値をパースし、対応する日時を返します。
SELECT STRTODATE('03*04*2020','dd*MM*yyyy');
-- Result: 4/3/2020
現在のタイムスタンプをデータベースシステムのdatetime 値として返します。この値はGETDATE およびCURRENT_TIMESTAMP と等しく、常にローカルタイムゾーンになります。
SELECT SYSDATETIME();
-- Result: 2018-02-01 03:04:05
現在のシステム日時をUTC datetime 値として返します。GETUTCDATE と同じです。
SELECT SYSUTCDATETIME();
-- For example, if the local timezone is Eastern European Time (GMT+2)
-- Result: 2018-02-01 05:04:05
指定されたhour、minute、およびsecond のtime 値を指定した有効桁数で返します。
SELECT TIMEFROMPARTS(1, 2, 3, 456, 3);
-- Result: 01:02:03.456
0000-00-01以降の日数を返します。1582-10-15以降の日付に対してのみ値を返します（グレゴリオ暦に基づく）。これはMYSQL TO_DAYS 関数と同等です。
SELECT TO_DAYS('02-06-2015');
-- Result: 736000
指定されたdatetime に関連付けられた（その年の）週を返します。
SELECT WEEK('02-17-2020 11:15:23');
-- Result: 8
指定されたdate の年を表す整数を返します。
SELECT YEAR('2018-02-01');
-- Result: 2018
指定された数値の絶対値（正の値）を返します。
SELECT ABS(15);
-- Result: 15
SELECT ABS(-15);
-- Result: 15
指定された浮動小数点式がコサインの値となる角度をラジアン単位で返します。これは、アークコサインとも呼ばれます。
SELECT ACOS(0.5);
-- Result: 1.0471975511966
指定された浮動小数点式がサインの値となる角度をラジアン単位で返します。これは、アークサインとも呼ばれます。
SELECT ASIN(0.5);
-- Result: 0.523598775598299
指定された浮動小数点式がタンジェントの値となる角度をラジアン単位で返します。これは、アークタンジェントとも呼ばれます。
SELECT ATAN(10);
-- Result: 1.47112767430373
正のx 軸と原点から点(y, x) までの線との間の角度をラジアン単位で返します。x とy は、指定された2つの浮動小数点式です。
SELECT ATN2(1, 1);
-- Result: 0.785398163397448
指定された数値式以上で最小の整数を返します。
SELECT CEILING(1.3);
-- Result: 2
SELECT CEILING(1.5);
-- Result: 2
SELECT CEILING(1.7);
-- Result: 2
指定された式で示されるラジアン単位の角度の三角関数コサインを返します。
SELECT COS(1);
-- Result: 0.54030230586814
指定された浮動小数点式で示されるラジアン単位の角度の三角関数コタンジェントを返します。
SELECT COT(1);
-- Result: 0.642092615934331
ラジアン単位で指定された角度に相当する度単位の角度を返します。
SELECT DEGREES(3.1415926);
-- Result: 179.999996929531
指定された浮動小数点値の指数値を返します。例えば、EXP(LOG(20)) は20です。
SELECT EXP(2);
-- Result: 7.38905609893065
式を評価します。
SELECT EXPR('1 + 2 * 3');
-- Result: 7
SELECT EXPR('1 + 2 * 3 == 7');
-- Result: true
指定された数値式以下で最大の整数を返します。
SELECT FLOOR(1.3);
-- Result: 1
SELECT FLOOR(1.5);
-- Result: 1
SELECT FLOOR(1.7);
-- Result: 1
指定された整数の最大値を返します。
SELECT GREATEST(3,5,8,10,1) -- Result: 10
入力値に相当する16進数を返します。
SELECT HEX(866849198);
-- Result: 33AB11AE
SELECT HEX('Sample Text');
-- Result: 53616D706C652054657874
指定された整数の最小値を返します。
SELECT LEAST(3,5,8,10,1) -- Result: 1
指定された浮動小数点式の自然対数を返します。
SELECT LOG(7.3890560);
-- Result: 1.99999998661119
指定された浮動小数点式の10を底とする対数を返します。
SELECT LOG10(10000);
-- Result: 4
被除数を除数で除算したときの余剰に関連付けられた整数値を返します。
SELECT MOD(10,3); -- Result: 1
実数入力のopposite を返します。
SELECT NEGATE(10); -- Result: -10 SELECT NEGATE(-12.4) --Result: 12.4
PI の定数値を返します。
SELECT PI()
-- Result: 3.14159265358979
指定された式の指定されたべき乗値を返します。
SELECT POWER(2, 10);
-- Result: 1024
SELECT POWER(2, -2);
-- Result: 0.25
数値式が度単位で入力されたときのラジアン値を返します。
SELECT RADIANS(180);
-- Result: 3.14159265358979
0と1の間の（0と1は除く）の疑似乱数（浮動小数点値）を返します。
SELECT RAND();
-- This result may be different, since the seed is randomized
-- Result: 0.873159630165044
SELECT RAND(1);
-- This result will always be the same, since the seed is constant
-- Result: 0.248668584157093
指定された長さまたは有効桁数に丸められた数値を返します。
SELECT ROUND(1.3, 0);
-- Result: 1
SELECT ROUND(1.55, 1);
-- Result: 1.6
SELECT ROUND(1.7, 0, 0);
-- Result: 2
SELECT ROUND(1.7, 0, 1);
-- Result: 1
SELECT ROUND (1.24);
-- Result: 1.0
指定された式の符号を、正（+1）、ゼロ（0）、または負（-1）で返します。
SELECT SIGN(0);
-- Result: 0
SELECT SIGN(10);
-- Result: 1
SELECT SIGN(-10);
-- Result: -1
指定された角度の三角関数のサイン値をラジアン単位で返します。
SELECT SIN(1);
-- Result: 0.841470984807897
指定された浮動小数点値の平方根を返します。
SELECT SQRT(100);
-- Result: 10
指定された浮動小数点値の2乗を返します。
SELECT SQUARE(10);
-- Result: 100
SELECT SQUARE(-10);
-- Result: 100
入力式のタンジェントを返します。
SELECT TAN(1);
-- Result: 1.5574077246549
指定された小数精度に切り捨てられた、指定された10進数を返します。
SELECT TRUNC(10.3423,2); -- Result: 10.34
新しいレコードを作成するには、INSERT ステートメントを使用します。
INSERT ステートメントは、挿入するカラムと新しいカラム値を指定します。複数のカラム値は、次の例に示すように、VALUES 句のカンマ区切りリストで指定できます。
INSERT INTO <table_name>
( <column_reference> [ , ... ] )
VALUES
( { <expression> | NULL } [ , ... ] )
<expression> ::=
| @ <parameter>
| ?
| <literal>
次にクエリの例を示します。
INSERT INTO Prospects (Email) VALUES ('John')
既存のレコードを変更するには、UPDATE ステートメントを使用します。
UPDATE 構文はカンマ区切りのカラムをインプットとして取り、SET 句のname-value ペアを新しいカラム値として取ります。
UPDATE <table_name> SET { <column_reference> = <expression> } [ , ... ] WHERE { Id = <expression> } [ { AND | OR } ... ]
<expression> ::=
| @ <parameter>
| ?
| <literal>
クエリの例：
UPDATE Prospects SET Email='John' WHERE Id = @myId
テーブルから情報を削除するには、DELETE ステートメントを使用します。
DELETE ステートメントには、次の例に示すように、FROM 句のテーブル名とWHERE 句の行の主キーが必要です。
<delete_statement> ::= DELETE FROM <table_name> WHERE { Id = <expression> } [ { AND | OR } ... ]
<expression> ::=
| @ <parameter>
| ?
| <literal>
次にクエリの例を示します。
DELETE FROM Prospects WHERE Id = @myId
GETDELETED クエリを発行して、指定した期間内にライブデータから削除されたすべてのレコードを取得できます。このクエリは、次の例に示すように、フィルタとしてdatetime 値を許容します。
GETDELETED FROM <table_name> WHERE <search_condition>
<search_condition> ::=
{
<expression> { = | < | <= | > | >= } [ <expression> ]
} [ { AND | OR } ... ]
<expression> ::=
| @ <parameter>
| ?
| <literal>
次にクエリの例を示します。
GETDELETED FROM Prospects WHERE TimeModified >='2013-01-01' AND TimeModified <='2013-02-01'
ストアドプロシージャを実行するには、EXECUTE またはEXEC ステートメントを使用できます。
EXEC およびEXECUTE は、名前で参照されたストアドプロシージャのインプットを値またはパラメータ名に割当てます。
ストアドプロシージャをSQL ステートメントとして実行するには、次の構文を使用します。
{ EXECUTE | EXEC } <stored_proc_name>
{
[ @ ] <input_name> = <expression>
} [ , ... ]
<expression> ::=
| @ <parameter>
| ?
| <literal>
名前によるストアドプロシージャのインプットの参照：
EXECUTE my_proc @second = 2, @first = 1, @third = 3;
パラメータ化されたストアドプロシージャ構文の実行：
EXECUTE my_proc second = @p1, first = @p2, third = @p3;
PIVOT and UNPIVOT can be used to change a table-valued expression into another table.
"SELECT 'AverageCost' AS Cost_Sorted_By_Production_Days, [0], [1], [2], [3], [4]
FROM
(
SELECT DaysToManufacture, StandardCost
FROM Production.Product
) AS SourceTable
PIVOT
(
AVG(StandardCost)
FOR DaysToManufacture IN ([0], [1], [2], [3], [4])
) AS PivotTable;"
"SELECT VendorID, Employee, Orders
FROM
(SELECT VendorID, Emp1, Emp2, Emp3, Emp4, Emp5
FROM pvt) p
UNPIVOT
(Orders FOR Employee IN
(Emp1, Emp2, Emp3, Emp4, Emp5)
)AS unpvt;"
For further information on PIVOT and UNPIVOT, see FROM clause plus JOIN, APPLY, PIVOT (Transact-SQL)
This section shows the available API objects and provides more information on executing SQL to Salesforce Pardot APIs.
The CData Cloud models Salesforce Pardot entities as relational Tables, Views, and Stored Procedures. API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.
Cloud はSalesforce Pardot のデータを、標準のSQL ステートメントを使用してクエリできるテーブルのリストにモデル化します。
一般的には、Salesforce Pardot テーブルのクエリは、リレーショナルデータベースのテーブルのクエリと同じです。時には特別なケースもあります。例えば、テーブルの特定のカラムデータを取得するために特定のカラムをWHERE 句に含める必要がある場合などです。これは通常、特定のカラムを取得するために行ごとに個別のリクエストを行う必要がある場合に必要です。これらの特別な状況は、以下にリンクされているテーブルページの上部に明確に文書化されています。
| Name | Description |
| Campaigns | Retrieve and modify campaigns. |
| CustomFields | Retrieve and modify custom fields. |
| ListMemberships | Retrieve and modify list memberships. |
| Lists | Retrieve and modify lists. |
| Opportunities | Retrieve and modify opportunities. |
| ProspectAccounts | Retrieve and modify prospect accounts. |
| Prospects | Retrieve and modify prospects. |
Retrieve and modify campaigns.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM Campaigns WHERE Id = 43 SELECT * FROM Campaigns WHERE Name = 'Website Tracking'
This table does not have any required attributes when performing an insert.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Pardot ID for this campaign. | |
| Name | String | False |
Campaign's name. | |
| Cost | Integer | False |
Cost associated to the campaign. | |
| CrmFId | String | True |
The CRM FID associated to the campaign. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| CreatedAt | Datetime |
Filter by the creation time. |
| UpdatedAt | Datetime |
Filter by the modification time. |
Retrieve and modify custom fields.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM CustomFields WHERE Id = 50 SELECT * FROM CustomFields WHERE CreatedAt > '01/01/2019'
The following attributes are required when performing an insert: FieldId, Name.
INSERT INTO CustomFields(FieldId, Name) VALUES(100, 'Example')
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | 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 | Integer | True |
Pardot ID for custom field's type. | |
| CreatedAt | Datetime | True |
Time custom field was created in Pardot. | |
| UpdatedAt | Datetime | True |
Last time custom field was updated. | |
| IsRecordMultipleResponses | Boolean | False |
If true, this custom field will record multiple responses. | |
| CrmId | String | False |
The CRM ID of the field you would like to map to this custom field. | |
| IsUseValues | Boolean | False |
If true, this custom field will use predefined values. |
Retrieve and modify list memberships.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM ListMemberships WHERE Id = 26 SELECT * FROM ListMemberships WHERE ListId = 44 SELECT * FROM ListMemberships WHERE CreatedAt > '01/01/2019'
The following attributes are required when performing an insert: ListId, ProspectId.
INSERT INTO ListMemberships(ListId, ProspectId) VALUES(20104, 3457990)
To retrieve deleted records, a GETDELETED statement can be executed.
The GETDELETED statement supports the same server side filters that are supported by the SELECT statement (except ID when using the equality(=) operator), but does not perform any client side filtering.
GETDELETED FROM ListMemberships WHERE ID = 231
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Pardot ID for this list membership. | |
| ListId | Integer | True |
Lists.Id |
Pardot ID of the list for this membership. |
| ProspectId | Integer | True |
Prospects.Id |
Pardot ID of the prospect for this membership. |
| OptedOut | Integer | False |
If value is 1, the prospect is unsubscribed from receiving emails from this list. | |
| CreatedAt | Datetime | True |
Time that this membership was created in Pardot. | |
| UpdatedAt | Datetime | True |
Last time that this membership was updated. |
Retrieve and modify lists.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Pardot ID of this list. | |
| Name | String | False |
List's name (internal to Pardot). | |
| IsPublic | Boolean | False |
If true, list will show on EPC pages to prospects. | |
| IsDynamic | Boolean | True |
If true, list has prospects dynamically added to it via a set of chosen rules. | |
| Title | String | False |
List's title (visible to subscribers). | |
| Description | String | False |
List's description. | |
| IsCrmVisible | Boolean | False |
If true, list will be visible in CRM to add or remove from. | |
| CreatedAt | Datetime | True |
Time list was created in Pardot. | |
| UpdatedAt | Datetime | True |
Last time list was updated. |
Retrieve and modify opportunities.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM Opportunities WHERE Id = 14 SELECT * FROM Opportunities WHERE ProspectId = 34 SELECT * FROM Opportunities WHERE ProspectEmail = '[email protected]'
The following attributes are required when performing an insert: CampaignId, Name, Value, Probability, ProspectEmail, ProspectId.
INSERT INTO Opportunities(CampaignId, Name, Value, Probability, ProspectEmail, ProspectId) VALUES(1, 'Example', 3, 75, '[email protected]', 2)
Note: This table cannot be updated if a Salesforce connector is present.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Pardot ID for this opportunity. | |
| CampaignId | Integer | 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 | Integer | False |
Id of the prospect. |
Retrieve and modify prospect accounts.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Pardot ID of the prospect account. | |
| CreatedAt | Datetime | False |
Filter by the creation time. | |
| UpdatedAt | Datetime | False |
Filter by the modification time. |
Retrieve and modify prospects.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Pardot ID for this prospect. | |
| CampaignId | Integer | False |
Campaigns.Id |
Pardot ID of the campaign associated with this prospect Note: Information about a prospect's campaign association is returned in a campaign node in the XML response. However, updates to campaign associations are done by providing campaign_id during an UPDATE> request. See XML Response Formats in Using Prospects for more details. |
| Salutation | String | False |
Prospect's formal prefix. | |
| FirstName | String | False |
Prospect's first name. | |
| LastName | String | False |
Prospect's last name. | |
| String | False |
Prospect's email address. | ||
| Password | String | False |
Prospect's password. | |
| Company | String | False |
Prospect's company. | |
| ProspectAccountId | Integer | False |
Prospect's account ID. | |
| Website | String | False |
Prospect's website URL. | |
| JobTitle | String | False |
Prospect's job title. | |
| Department | String | False |
Prospect's department. | |
| Country | String | False |
Prospect's country. | |
| AddressOne | String | False |
Prospect's address, line 1. | |
| AddressTwo | String | False |
Prospect's address, line 2. | |
| City | String | False |
Prospect's city. | |
| State | String | False |
Prospect's US state. | |
| Territory | String | False |
Prospect's territory. | |
| Zip | String | False |
Prospect's postal code. | |
| Phone | String | False |
Prospect's phone number. | |
| Fax | String | False |
Prospect's fax number. | |
| Source | String | False |
Prospect's source. | |
| AnnualRevenue | String | False |
Prospect's annual revenue. | |
| Employees | String | False |
Prospect's number of employees. | |
| Industry | String | False |
Prospect's industry. | |
| YearsInBusiness | String | False |
Prospect's number of years in business. | |
| Comments | String | False |
Comments about this prospect. | |
| Notes | String | False |
Notes about this prospect. | |
| Score | Integer | False |
Prospect's score. | |
| Grade | String | True |
Prospect's letter grade. | |
| LastActivityAt | Datetime | True |
Time stamp of this prospect's latest visitor activity. | |
| RecentInteraction | String | True |
Describes the prospect's most recent interaction with Pardot. | |
| CrmLeadFid | String | True |
Prospect's lead ID in a supported CRM system. | |
| CrmContactFid | String | True |
Prospect's contact ID in a supported CRM system. | |
| CrmOwnerFid | String | True |
Prospect's owner ID in a supported CRM system. | |
| CrmAccountFid | String | True |
Account ID in a supported CRM system. | |
| CrmLastSync | Datetime | True |
Last time this prospect was synced with a supported CRM system. | |
| CrmUrl | String | True |
URL to view the prospect within the CRM system. | |
| IsDoNotEmail | Boolean | False |
If value is 1, prospect prefers not to be emailed. | |
| IsDoNotCall | Boolean | False |
If value is 1, prospect prefers not to be called. | |
| OptedOut | Boolean | True |
If value is 1, prospect has opted out of marketing communications. | |
| IsReviewed | Boolean | False |
If value is 1, prospect has been reviewed. | |
| IsStarred | Boolean | False |
If value is 1, prospect has been starred. | |
| CreatedAt | Datetime | True |
Time prospect was created in Pardot. | |
| UpdatedAt | Datetime | True |
Last time prospect was updated in Pardot. |
ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。
ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。
ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。
| Name | Description |
| Account | Retrieve account info. |
| CustomRedirects | Retrieve and modify custom redirects. |
| DynamicContents | Retrieve dynamic contents. |
| EmailClicks | Retrieve email clicks. |
| Emails | Retrieve emails. |
| EmailStats | Retrieve email stats. |
| EmailTemplates | Retrieve email templates. |
| Forms | Retrieve forms. |
| LifecycleHistories | Retrieve lifecycle histories. |
| LifecycleStages | Retrieve lifecycle stages. |
| OneToOneEmails | Retrieve one to one emails. |
| TagObjects | Retrieve tag objects. |
| Tags | Retrieve tags. |
| Users | Retrieve users. |
| VisitorActivities | Retrieve visitor activities. |
| Visitors | Retrieve visitors. |
| VisitorsPageViews | Retrieve visitors page views. |
| Visits | Retrieve visits. |
Retrieve account info.
The Cloud will process all filters client side.
| Name | Type | References | Description |
| Id [KEY] | Integer | 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 | Integer | Plugin ID for account campaign. | |
| TrackingCodeTemplate | String | Markup and code for use in tracking templates. | |
| Address1 | String | Account contact address, line 1. | |
| Address2 | String | Account contact address, line 2. | |
| City | String | Account contact city. | |
| State | String | Account contact state. | |
| Territory | String | Account contact territory. | |
| Zip | String | Account contact zip code. | |
| Country | String | Account contact country. | |
| Phone | String | Account contact phone number. | |
| Fax | String | Account contact fax number. |
Retrieve and modify custom redirects.
| Name | Type | References | Description |
| Id [KEY] | Integer | 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 | Integer |
Campaigns.Id | The campaign associated with this custom redirect. |
| CampaignName | String |
Campaigns.Name | The campaign associated with this custom redirect. |
| CreatedAt | Datetime | Time custom redirect was created in Pardot. | |
| UpdatedAt | Datetime | Last time custom redirect was updated. |
Retrieve dynamic contents.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM DynamicContents WHERE Id = 32 SELECT * FROM DynamicContents WHERE CreatedAt > '02/03/2019 23:11:33' SELECT * FROM DynamicContents WHERE UpdatedAt > '01/03/2018 23:11:33' AND UpdatedAt <= '02/03/2019 23:11:33'
| Name | Type | References | Description |
| Id [KEY] | Integer | Pardot ID for this dynamic content. | |
| Name | String | Dynamic content's name. | |
| EmbedCode | String | Code to embed this dynamic content onto your webpage. | |
| EmbedUrl | String | URL to embed this dynamic content. | |
| BaseContent | String | The default dynamic content. | |
| BasedOn | String | Field that this dynamic content is based on. | |
| Variation | String | The variation of content prospect will see based on the field's value Note: Information about a variation is returned in a variation node in the XML response. It contains the value of the field in the comparison tag and the content of the variation in the content tag. | |
| CreatedAt | Datetime | Time dynamic content was created in Pardot. | |
| UpdatedAt | Datetime | Last time dynamic content was updated. |
Retrieve email clicks.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM EmailClicks WHERE ListEmailId = 20 SELECT * FROM EmailClicks WHERE DripProgramActionId = 42 SELECT * FROM EmailClicks WHERE EmailTemplateId = 26 AND TrackerRedirectId = 31 AND CreatedAt > '02/03/2019 23:11:33'
| Name | Type | References | Description |
| Id [KEY] | Integer | Pardot ID for this email click. | |
| ProspectId | Integer |
Prospects.Id | Pardot ID for the associated prospect. |
| Url | String | URL of the email click. | |
| ListEmailId | Integer | 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 | Integer | Pardot ID for the associated email template. Value not present if null. | |
| TrackerRedirectId | Integer | Pardot ID for the associated tracker redirect. Value not present if null. | |
| CreatedAt | Datetime | Time that email click occurred. |
Retrieve emails.
The Cloud will use the Salesforce Pardot 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.
For example, the following query is processed server side:
SELECT * FROM Emails WHERE Id = 10
| Name | Type | References | Description |
| Id [KEY] | Integer | Pardot ID for this email. | |
| Name | String | Name of this email. | |
| Subject | String | Email Subject. | |
| Message | String | Contains text and html elements of different formats. | |
| CreatedAt | Datetime | Time the Email Was Created. |
Retrieve email stats.
The Cloud will use the Salesforce Pardot 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.
For example, the following query is processed server side:
SELECT * FROM EmailStats WHERE Id = 10
| Name | Type | References | Description |
| Id [KEY] | Integer | Pardot ID for this email. | |
| Sent | Integer | Sent status. | |
| Delivered | Integer | Delivered status. | |
| TotalClicks | Integer | Total clicks. | |
| UniqueClicks | Integer | Unique clicks. | |
| SoftBounced | Integer | Soft bounces. | |
| HardBounced | Integer | Hard bounces. | |
| OptOuts | Integer | Opt count. | |
| SpamComplains | Integer | Spam complains. | |
| Opens | Integer | Opens. | |
| UniqueOpens | Integer | Unique opens. | |
| DeliveryRate | String | Delivery rate. | |
| OpensRate | String | Open rate. | |
| ClickThroughRate | String | Click through rate. | |
| UniqueClickThroughRate | String | Unique click through rate. | |
| ClickOpenRatio | String | Click to open ration. | |
| OptOutrate | String | Opt rate. | |
| SpamComplaintRate | String | Spam complaint rate. |
Retrieve email templates.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM EmailTemplates WHERE Id = 22
| Name | Type | References | Description |
| Id | Integer | Identifier. | |
| EmailType | Integer | Email type. | |
| Error | Integer | Error. | |
| HtmlMessage | String | Html content. | |
| IsAutoResponderEmail | Integer | Whether it is an auto responder email. | |
| IsDripEmail | Integer | Whether it is a drip email. | |
| IsListEmail | Integer | Whether it is a lsit email. | |
| IsOneToOneEmail | Integer | Whether it is a one to one email. | |
| Name | String | Name | |
| SendOptionsReplyToAddressAggregate | String | Reply to addresses. | |
| SendOptionsSendFromDataAggregate | String | Send from information. | |
| Subject | String | Email subject. | |
| TextMessage | String | Email text. | |
| TrackedHtmlMessage | String | Tracked html message. | |
| TrackedTextMessage | String | Tracked text message. | |
| Type | Integer | Email type. |
Retrieve forms.
| Name | Type | References | Description |
| Id [KEY] | Integer | Pardot ID for this form. | |
| Name | String | Form's name. | |
| CampaignId | String |
Campaigns.Id | Pardot ID of the campaign associated with this form. |
| EmbedCode | String | The code used to embed the form on your webpage. | |
| CreatedAt | Datetime | Time form was created in Pardot. | |
| UpdatedAt | Datetime | Last time form was updated. |
Retrieve lifecycle histories.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM LifecycleHistories WHERE Id = 49 SELECT * FROM LifecycleHistories WHERE Id >= 44 SELECT * FROM LifecycleHistories WHERE CreatedAt <= '02/03/2019 23:11:33'
| Name | Type | References | Description |
| Id [KEY] | Integer | Pardot ID of this lifecycle history. | |
| ProspectId | Integer |
Prospects.Id | Pardot's ID for the prospect in this stage. |
| PreviousStageId | Integer | Pardot ID of the stage this prospect was previously in. | |
| NextStageId | Integer | Pardot ID of the stage this prospect will be in next. | |
| SecondsElapsed | Integer | Number of seconds for prospect to get to current stage. | |
| CreatedAt | Datetime | Time lifecycle history was created in Pardot. |
Retrieve lifecycle stages.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM LifecycleStages WHERE Id = 18
| Name | Type | References | Description |
| Id [KEY] | Integer | Pardot ID of this lifecycle stage. | |
| Name | String | Lifecycle stage's name. | |
| Position | Integer | Lifcycle stage's position in lifecycle. | |
| IsLocked | Boolean | If true, lifecycle stage is locked. |
Retrieve one to one emails.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM OneToOneEmails WHERE Id = 11
| Name | Type | References | Description |
| Id [KEY] | Integer | Identifier. | |
| EmailType | Integer | Email type. | |
| IsAutoResponderEmail | Integer | Whether it is an auto responder email. | |
| IsDripEmail | Integer | Where it is a drip email. | |
| IsListEmail | Integer | Whether it is a list email. | |
| IsOneToOneEmail | Integer | Whether it is a one to one email. | |
| Name | String | Name. | |
| Subject | String | Email subject. | |
| Type | Integer | Email type. |
Retrieve tag objects.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM TagObjects WHERE Id <= 31 SELECT * FROM TagObjects WHERE TagId = 12 SELECT * FROM TagObjects WHERE CreatedAt <= '02/03/2019 23:11:33'
| Name | Type | References | Description |
| Id [KEY] | Integer | Pardot ID of the tag object. | |
| TagId | Integer |
Tags.Id | The Pardot ID of the tag. |
| Type | String | The type of object associated with the tag. | |
| ObjectId | Integer | The Pardot ID of the object. | |
| CreatedAt | Datetime | Time tag was associated with the object in Pardot. |
Retrieve tags.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM Tags WHERE Id >= 42 SELECT * FROM Tags WHERE Name = 'criteria' SELECT * FROM Tags WHERE CreatedAt >= '02/03/2019 23:11:33'
| Name | Type | References | Description |
| Id [KEY] | Integer | Pardot ID for this tag. | |
| Name | String | Tag's name. | |
| CreatedAt | Datetime | Time tag was created in Pardot. | |
| UpdatedAt | Datetime | Last time tag was updated. |
Retrieve users.
| Name | Type | References | Description |
| Id [KEY] | Integer | Pardot ID of the user. | |
| String | User's email address. | ||
| FirstName | String | User's first name. | |
| LastName | String | User's last name. | |
| JobTitle | String | User's job title. | |
| Role | String | User's role. | |
| CreatedAt | Datetime | Time user was created in Pardot; Time is reported in the API user's preferred timezone. | |
| UpdatedAt | Datetime | Last time user was updated in Pardot; Time is reported in the API user's preferred timezone. |
Retrieve visitor activities.
| Name | Type | References | Description |
| Id [KEY] | Integer | Pardot ID for this visitor activity. | |
| ProspectId | Integer |
Prospects.Id | Pardot ID for the associated prospect. |
| VisitorId | Integer |
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 | Integer |
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 | Integer | 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 | Integer | 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 | Integer |
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 | Integer | 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 | Integer | 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 | Integer | 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 | Integer | 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 | Integer | 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 | Integer | 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 | Integer | 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 | Integer |
Campaigns.Id | Campaign id. |
| CampaignName | String | Campaign name. | |
| CampaignCost | Integer | Campaign cost. | |
| CreatedAt | Datetime | Time that visitor activity occurred. |
Retrieve visitors.
| Name | Type | References | Description |
| Id [KEY] | Integer | 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 | Integer | Selects visits with the given Prospect IDs. |
Retrieve visitors page views.
| Name | Type | References | Description |
| Id [KEY] | Integer | Pardot ID for this visitor page view. | |
| VisitId | Integer |
Visits.Id | Pardot ID for this visit. |
| VisitorId | Integer |
Visitors.Id | Pardot ID for the associated visitor. |
| ProspectId | Integer |
Prospects.Id | Pardot ID for the associated prospect. |
| Url | String | The Url of the page. | |
| Title | String | The Title column of the VisitorsPageViews object. | |
| CreatedAt | Datetime | The CreatedAt column of the VisitorsPageViews object. |
Retrieve visits.
| Name | Type | References | Description |
| Id [KEY] | Integer | Pardot ID for this visit. | |
| VisitorId | Integer |
Visitors.Id | Pardot ID for the associated visitor. |
| ProspectId | Integer |
Prospects.Id | Pardot ID for the associated prospect. |
| VisitorPageViewCount | Integer | Number of page views for this visit. | |
| FirstVisitorPageViewAt | Datetime | Time of first page view for this visit. | |
| LastVisitorPageViewAt | Datetime | Time of last page view for this visit. | |
| DurationInSeconds | Integer | Length of this visit. | |
| CampaignParameter | String | Visit's campaign parameter utm_campaign from Google Analytics. | |
| MediumParameter | String | Visit's medium parameter utm_medium from Google Analytics. | |
| SourceParameter | String | Visit's source parameter utm_source from Google Analytics. | |
| ContentParameter | String | Visit's content parameter utm_content from Google Analytics. | |
| TermParameter | String | Visit's term parameter utm_term from Google Analytics. | |
| CreatedAt | Datetime | Time visit was created in Pardot. | |
| UpdatedAt | Datetime | Last time visit was updated in Pardot. |
ストアドプロシージャはファンクションライクなインターフェースで、Salesforce Pardot の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、該当する場合は、プロシージャが成功したか失敗したかを示すとともにSalesforce Pardot から関連するレスポンスデータを返します。
| Name | Description |
| AssignProspect | Update the locations for a shipping zone. |
| AssignProspectAccount | Update the locations for a shipping zone. |
| SendEmail | Update the locations for a shipping zone. |
| UnAssignProspect | Update the locations for a shipping zone. |
| UnDeleteOpportunity | Update the locations for a shipping zone. |
Update the locations for a shipping zone.
EXEC AssignProspect ProspectId=432, AssignmentType='user', AssignTo=101 EXEC AssignProspect ProspectId=432, AssignmentType='email', AssignTo='[email protected]'
| Name | Type | Required | Description |
| ProspectId | String | False | The ID of the prospect. |
| AssignmentType | String | False | The type of the assignment. Can be one of: email, user, group. |
| AssignTo | String | False | The value to assign to. If the type is user or group the value should be the respective id. |
| Name | Type | Description |
| Success | String | This value shows a boolean indication of whether the operation was successful or not. |
Update the locations for a shipping zone.
EXEC AssignProspectAccount UserId=432, ProspectAccountId=501
| Name | Type | Required | Description |
| ProspectAccountId | String | False | The ID of the prospect account. |
| UserId | String | False | The ID of the user. |
| Name | Type | Description |
| Success | String | This value shows a boolean indication of whether the operation was successful or not. |
If using a Windows application, set Authmode to App. If using a Web app, set Authmode to Web and specify the Verifier obtained by GetOAuthAuthorizationUrl.
| Name | Type | Required | Description |
| Authmode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.
使用できる値は次のとおりです。APP, WEB デフォルト値はAPPです。 |
| Verifier | String | False | The verifier token returned by Salesforce after using the URL obtained with GetOAuthAuthorizationUrl. |
| Scope | String | False | A space-separated scope of permissions you need the app to have access to. The available values are api, chatter_api, full, id, refresh_token, visualforce, and web. For details, refer to: http://help.salesforce.com/help/doc/en/remoteaccess_oauth_scopes.htm. |
| CallbackUrl | String | False | The page to return the Salesforce app after authentication has been completed. |
| Api_Version | String | False | The API version you would like to authenticate to.
デフォルト値は49.0です。 |
| State | String | False | Any value that you wish to be sent with the callback. |
| GrantType | String | False | Authorization grant type. Only available for OAuth 2.0. If left unspecified, the default value is the value of the OAuthGrantType connection property.
使用できる値は次のとおりです。CODE, PASSWORD |
| Name | Type | Description |
| Scope | String | The scope of permissions for the app. |
| Instance_Url | String | The instance URL being used by the app. |
| Id | String | The Id associated with the OAuth token. |
| Issued_At | String | When the token was issued at. |
| Signature | String | A signature for the OAuth token. |
| OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
| OAuthAccessToken | String | The OAuth access token. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps.
| Name | Type | Required | Description |
| CallbackUrl | String | False | The page to return the user after authorization is complete. |
| Scope | String | False | A space-separated scope of permissions you need the app to have access to. The available values are api, chatter_api, full, id, refresh_token, visualforce, web. For more details, refer to: http://help.salesforce.com/help/doc/en/remoteaccess_oauth_scopes.htm. |
| Grant_Type | String | False | The type of authorization to be granted for your app. If this is set to code, the stored procedure will return an authorization URL containing the verifier code in a query string parameter, which you will need to submit back with the GetOAuthAccessToken stored procedure. Implicit will cause the OAuth access token to be returned directly in the URL.
使用できる値は次のとおりです。Implicit, Code |
| State | String | False | Any value that you wish to be sent with the callback. |
| Name | Type | Description |
| Url | String | The authorization url. |
Refreshes the OAuth token or session id after the session has expired. Your OAuth application must have the refresh_token scope enabled.
| Name | Type | Required | Description |
| OAuthRefreshToken | String | True | The refresh token returned when the OAuth Token was first created. |
| Name | Type | Description |
| Instance_Url | String | Instance of Salesforce the OAuth token is valid for. |
| OAuthAccessToken | String | The OAuth token. |
| Id | String | Id associated with the OAuth Token. |
| Issued_At | String | When the OAuth Token was issued. |
| Signature | String | Signature of the OAuth Token. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
Update the locations for a shipping zone.
One of: ProspectId, ProspectEmail or ListId.
One of: TemplateId or (TextContent, Name, Subject and (FromEmail, FromName or FromUserId))
Examples:
EXEC SendEmail CampaignId=20006, ProspectId=1807618, TemplateId=13598 EXEC SendEmail CampaignId=20006, ProspectEmail='[email protected]', TextContent='content', Name='email name', Subject='email subject', FromUserId=24486 EXEC SendEmail CampaignId=20006, ListId=20104, TextContent='content', Name='email name', Subject='email subject', FromEmail='[email protected]', FromName='Name Surname'
| Name | Type | Required | Description |
| CampaignId | String | False | The ID of the campaign. |
| ProspectId | String | False | The ID of the prospect. |
| ProspectEmail | String | False | The email of the prospect. |
| ListId | String | False | The ID of the lists to send to. |
| TemplateId | String | False | The ID of the prospect. |
| TextContent | String | False | The ID of the prospect. |
| Name | String | False | The ID of the prospect. |
| Subject | String | False | The ID of the prospect. |
| FromEmail | String | False | The ID of the prospect. |
| FromName | String | False | The ID of the prospect. |
| FromUserId | String | False | The ID of the prospect. |
| ReplyToEmail | String | False | The ID of the prospect. |
| OperationalEmail | String | False | The ID of the prospect. |
| HTMLContent | String | False | The ID of the prospect. |
| Name | Type | Description |
| Success | String | This value shows a boolean indication of whether the operation was successful or not. |
Update the locations for a shipping zone.
EXEC UnAssignProspect ProspectId=432
| Name | Type | Required | Description |
| ProspectId | String | False | The ID of the prospect. |
| Name | Type | Description |
| Success | String | This value shows a boolean indication of whether the operation was successful or not. |
Update the locations for a shipping zone.
EXEC UnDeleteOpportunity Id=600
| Name | Type | Required | Description |
| Id | String | False | The ID of the opportunity. |
| Name | Type | Description |
| Success | String | This value shows a boolean indication of whether the operation was successful or not. |
The CData Cloud models Salesforce Pardot Pardot API v5 objects as relational Tables, Views, and Stored Procedures. API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.
テーブル describes a sample of the available standard tables.
Cloud はSalesforce Pardot のデータを、標準のSQL ステートメントを使用してクエリできるテーブルのリストにモデル化します。
一般的には、Salesforce Pardot テーブルのクエリは、リレーショナルデータベースのテーブルのクエリと同じです。時には特別なケースもあります。例えば、テーブルの特定のカラムデータを取得するために特定のカラムをWHERE 句に含める必要がある場合などです。これは通常、特定のカラムを取得するために行ごとに個別のリクエストを行う必要がある場合に必要です。これらの特別な状況は、以下にリンクされているテーブルページの上部に明確に文書化されています。
| Name | Description |
| CustomRedirects | Track links on your website or third-party site with Pardot custom redirects. |
| DynamicContent | Retrieve a collection of dynamic content |
| EmailTemplates | Query email templates. |
| Files | Upload images and other files to use in your Pardot emails, forms, and landing pages. |
| FormHandlers | Retrieve,Create,Updata,Delete a collection of Form Handlers |
| FormHandlersFields | Retrieve,Create,Update,Delete a collection of Form Handler Stages |
| LandingPages | Retrieving a collection of landing pages |
| LayoutTemplates | Retrieve and modify layout templates. |
| LifecycleStages | Retrieving a collection of lifecycle stages |
| ListMemberships | Retrieve,Create,Update,Delete a collection of list memberships |
| Lists | Retrieve and modify lists. |
| Prospects | Retrieve and modify prospects. |
Track links on your website or third-party site with Pardot custom redirects.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM CustomRedirects WHERE Id = 40 SELECT * FROM CustomRedirects WHERE IsDeleted = 'true'
The following attributes are required when performing an insert: Name, CampaignId, DestinationUrl.
INSERT INTO CustomRedirects (Name,CampaignId,DestinationUrl) VALUES ('name','1','https://example.com/content.html')
Update CustomRedirects attributes.
UPDATE CustomRedirects SET Name = 'newName', FolderId = '527425' WHERE Id = 24143
Remove all CustomRedirects objects or one by specifying the Id of the CustomRedirect.
DELETE FROM CustomRedirects WHERE Id = 10003
To retrieve custom redirects that are in the recycle bin in Pardot the following operation is supported:
GETDELETED FROM CustomRedirects
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Pardot ID for this campaign. | |
| Name | String | False |
Name of the object for identification in Pardot. | |
| CampaignId | Integer | 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 | Integer | False |
ID of the folder containing this object. Uses the asset type's uncategorized folder if not specified on create. | |
| TrackerDomainId | Integer | 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 | Integer | True |
ID of the individual who created this object. | |
| UpdatedById | Integer | True |
ID of the individual who last updated this object. |
Retrieve a collection of dynamic content
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Pardot ID for this dynamic content. | |
| Name | String | True |
Dynamic content's name. | |
| EmbedCode | String | True |
The code used to embed the dynamic content into a web page. | |
| EmbedUrl | String | True |
The URL to embed this dynamic content. | |
| BaseContent | String | True |
The default content that shows when the prospect doesn't meet the criteria for a variation. | |
| BasedOn | String | True |
The kind field that dynamic content is based on. Values are | |
| CreatedAt | Datetime | True |
Time | |
| 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 | Int | True |
ID of the user who created this object. | |
| UpdatedById | Int | True |
ID of the user who last updated this object. | |
| FolderId | Int | True |
ID of the folder containing this object. | |
| TrackerDomainId | Int | True |
The ID of the tracker domain associated with this object. |
Query email templates.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM EmailTemplates WHERE Id = 50 SELECT * FROM EmailTemplates WHERE UpdatedAt > '01/01/2022' SELECT * FROM EmailTemplates WHERE CreatedAt > '01/01/2022'
To insert EmailTemplates the following fields are required:
For inserting into this table specifying the SenderOptionsAggregate is required. The input for this field follows CData principles of deep Inserts. In Deep Insert, you simultaneously create a base object and link it to the related field in the main table.
You may either submit JSON data, or you may create a temporary table for the child table(in this case SenderOptions) and then reference the temporary table in the insert to the base table.
To submit JSON data, simply supply the values for the child table in JSON format.
For example, the following JSON adds two sender options in the email template.
[
{
"address": "[email protected]",
"name": "CDataTest",
"type": "general_user"
},
{
"address": "[email protected]",
"name": "CDataTest2",
"type": "general_user"
}
]
In order to execute the insert, simply reference or include as string literals the complete JSON. For example:
INSERT INTO EmailTemplates(..., SenderOptionsAggregate) VALUES (..., '[{"address":"[email protected]","name":"CDataTest","type":"general_user"},{"address":"[email protected]","name":"CDataTest2","type":"general_user"}]')
If using temporary tables, they must be defined and inserted within the same connection. Closing the connection will clear out any temporary tables in memory.
Insert the child table fields into temporary table.
INSERT INTO SenderOptions#TEMP (Type, Address) VALUES ('general_user','address1')
INSERT INTO SenderOptions#TEMP (Type, Address) VALUES ('general_user','address2')
In the INSERT statement for the EmailTemplates table, reference the temporary tables in the SenderOptionsAggregate input.
INSERT INTO EmailTemplates(..., SenderOptionsAggregate) VALUES (..., 'SenderOptions#TEMP')
Updating EmailTemplates:
Update EmailTemplates set TextMessage='newMessage' WHERE Id=24143
Remove all email templates or a email template by specifying the Id of the template.
DELETE FROM EmailTemplates DELETE FROM EmailTemplates WHERE Id = 10003
To retrieve email templates that are in the recycle bin in Pardot the following operation is supported:
GETDELETED FROM EmailTemplates
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | 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 | Integer | False |
ID of the tracker domain used for the list email. | |
| FolderId | Integer | False |
ID of the folder containing this object. | |
| Type | String | False |
'html', 'text', and 'htmlAndText' values. | |
| CampaignId | Integer | False |
Pardot campaign related to this object. | |
| IsDeleted | Boolean | True |
True if the object is in the recycle bin in Pardot. | |
| CreatedById | Integer | True |
ID of the individual who created this object. | |
| UpdatedById | Integer | True |
ID of the individual who last updated this object. | |
| CreatedAt | Datetime | True |
The timestamp of when this object was created. | |
| UpdatedAt | Datetime | True |
The timestamp of when this object was last updated. | |
| SenderOptionsType | String | True |
The sending user type(s). | |
| SenderOptionsAddress | String | True |
The sending email address(s). | |
| SenderOptionsName | String | True |
The name(s) of the sender. | |
| SenderOptionsUserId | String | True |
The user ID(s) of the sender. | |
| SenderOptionsProspectCustomFieldId | String | True |
The ID of the prospect custom field that contains the sender value. Only available on read and query. | |
| SenderOptionsAccountCustomFieldId | String | True |
The ID of the account custom field that contains the sender value. Only available on read and query. | |
| ReplyToOptionsType | String | True |
The reply to user type(s). | |
| ReplyToOptionsAddress | String | True |
The sending email address(s). | |
| ReplyToOptionsUserId | String | True |
The user ID(s) of the sender. | |
| ReplyToOptionsProspectCustomFieldId | String | True |
The ID of the prospect custom field that contains the sender value. Only available on read and query. | |
| ReplyToOptionsAccountCustomFieldId | String | True |
The ID of the account custom field that contains the sender value. Only available on read and query. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| SenderOptionsAggregate | String |
This input is used for INSERT/UPDATE statements. Set this to SenderOptions#TEMP temporary table, whose rows contain inputs for inserting/updating the sender options. Or simply reference or include as string literals the complete JSON. |
| ReplyToOptionsAggregate | String |
This input is used for INSERT/UPDATE statements. Set this to ReplyToOptions#TEMP temporary table, whose rows contain inputs for inserting/updating the replyTo options. Or simply reference or include as string literals the complete JSON. |
Upload images and other files to use in your Pardot emails, forms, and landing pages.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
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'
The following attributes are required when performing an insert: Name, FilePath.
INSERT INTO Files (Name, FilePath) VALUES ('file1','C:\\file1.txt')
Updating Files:
UPDATE Files SET Name='testingUpdate', FolderId='33609' WHERE id='804969'
Remove all files or a file by specifying the Id of the file.
DELETE FROM Files DELETE FROM Files WHERE Id = 10003
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | 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 | Integer | False |
ID of the folder containing this object. Uses the asset type's uncategorized folder if not specified on create. | |
| CampaignId | Integer | 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 | Integer | 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 | Integer | True |
ID of the individual who created this object. | |
| UpdatedById | Integer | True |
ID of the individual who last updated this object. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| FilePath | String |
This parameter is used only in INSERT operations to upload the content of a file. It should be set to the path of the file including the name. Ex: C:\Users\User\Desktop\test.txt or to the BASE64 encoded content of the file. |
Retrieve,Create,Updata,Delete a collection of Form Handlers
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
ID of this object. | |
| Name | String | False |
Name of the object for identification in Pardot. | |
| FolderId | Int | False |
ID of the folder containing this object. | |
| CampaignId | Int | False |
The ID of the campaign associated with this object. | |
| TrackerDomainId | Int | 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 | Int | True |
ID of the user who created the object. | |
| IsDeleted | Boolean | True |
True if the object is in the Pardot recycle bin. | |
| UpdatedById | Int | True |
ID of the user who last updated the object. |
Retrieve,Create,Update,Delete a collection of Form Handler Stages
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
ID of this object. | |
| Name | String | False |
Name of the object for identification in Pardot. | |
| FormHandlerId | Int | 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 | Int | True |
ID of the user who created the object. | |
| UpdatedAt | Datetime | True |
Last updated time for the object. | |
| UpdatedById | Int | True |
ID of the user who last updated the object. |
Retrieving a collection of landing pages
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
ID of the object. | |
| Name | String | True |
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 | Int | 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 | Int | True |
ID of the user who last updated this object. | |
| CampaignId | Int | True |
Pardot Campaign related to this object. | |
| FormId | Int | True |
ID of the form related to this object. | |
| LayoutTemplateId | Int | True |
ID of the layout template related to this object. | |
| Title | String | True |
The landing page's title. | |
| Description | String | True |
The landing page's meta description. Used for SEO. | |
| IsDoNotIndex | Boolean | True |
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 | True |
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 | True |
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 | True |
The unique path for the asset, used to create the vanity URL. | |
| TrackerDomainId | Int | True |
The ID of the tracker domain associated with this object. | |
| FolderId | Int | True |
The ID of the folder associated with this object. |
Retrieve and modify layout templates.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM LayoutTemplates WHERE Id = 40 SELECT * FROM LayoutTemplates WHERE IsDeleted = 'true'
The following attributes are required when performing an insert: Name, LayoutContent.
INSERT INTO LayoutTemplates (Name,IsIncludeDefaultCss,LayoutContent,FolderId) VALUES ('name','true','content', 33621)
Updating LayoutTemplates:
UPDATE LayoutTemplates SET Name = 'newName' WHERE Id = 24143
Remove all layout templates or a layout template by specifying the Id of the template.
DELETE FROM LayoutTemplates WHERE Id = 10003
To retrieve layout templates that are in the recycle bin in Pardot the following operation is supported:
GETDELETED FROM LayoutTemplates
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | 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 | Integer | 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 | Integer | True |
ID of the individual who created this object. | |
| UpdatedById | Integer | True |
ID of the individual who last updated this object. |
Retrieving a collection of lifecycle stages
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
ID of the lifecycle stage. | |
| Name | String | True |
Pardot ID of this lifecycle stage. | |
| IsDeleted | Boolean | True |
True if the lifecycle stage is in the recycle bin in Pardot. | |
| CreatedAt | Datetime | True |
Creation time of the lifecycle stage. | |
| UpdatedAt | Datetime | True |
Last updated time for the lifecycle stage. | |
| IsLocked | Boolean | True |
When true, lifecycle stage is locked. | |
| Position | Int | True |
Lifcycle stage's position in lifecycle. | |
| MatchType | String | True |
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 |
Retrieve,Create,Update,Delete a collection of list memberships
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Pardot ID for this list membership. | |
| IsDeleted | Boolean | True |
When true, the list membership is in the Pardot recycle bin. | |
| CreatedById | Int | 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 | Int | 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 | Int | False |
Pardot ID of the list for this membership | |
| ProspectID | Int | False |
Pardot ID of the prospect for this membership |
Retrieve and modify lists.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM Lists WHERE Id = 40 SELECT * FROM Lists WHERE IsDeleted = 'true' SELECT * FROM Lists WHERE CreatedAt > '01/01/2022'
The following attribute is required when performing an insert: Name.
INSERT INTO Lists (Name) VALUES ('name')
Update Lists attributes.
UPDATE Lists SET Name = 'newName' WHERE Id = 24143
Remove all lists or a list by specifying the Id of the list.
DELETE FROM Lists WHERE Id = 10003
To retrieve lists that are in the recycle bin in Pardot the following operation is supported:
GETDELETED FROM Lists
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Pardot ID of this list. | |
| Name | String | False |
List's name (internal to Pardot). | |
| FolderId | Integer | False |
ID of the folder containing this object. | |
| CampaignId | Integer | 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 | Integer | True |
ID of the individual who created this object. | |
| UpdatedById | Integer | True |
ID of the individual who last updated this object. |
Retrieve and modify prospects.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
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'
To retrieve deleted prospects, a GETDELETED statement can be executed.
GETDELETED FROM Prospects
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | 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 | Integer | False |
Pardot campaign related to this object. | |
| CampaignParameter | String | True |
Prospect's campaign parameter utm_campaign from Google Analytics. | |
| SalesforceCampaignId | String | True |
The alpha-numeric Id of the associated campaign in the Salesforce Org. | |
| City | String | False |
Prospect's city. | |
| Comments | String | False |
Comments about this prospect. | |
| Company | String | False |
Prospect's company. | |
| ContentParameter | String | True |
Prospect's content parameter utm_content from Google Analytics. | |
| ConvertedAt | Datetime | True |
Time when prospect was converted from visitor. | |
| ConvertedFromObjectName | String | True |
Name of object associated with visitor activity that resulted in prospect being converted from visitor. | |
| ConvertedFromObjectType | String | True |
ype of object associated with visitor activity that resulted in prospect being converted from visitor. Supported values include 'Form', 'FormHandler', 'LandingPage', 'MultivariateTestVariation', and 'Video'. | |
| Country | String | False |
Prospect's country. | |
| SalesforceAccountId | String | True |
Account ID in a supported Salesforce system. | |
| SalesforceContactId | String | True |
Prospect's contact ID in a supported Salesforce system. | |
| SalesforceLastSync | Datetime | True |
Last time this prospect was synced with a supported Salesforce system. | |
| SalesforceLeadId | String | True |
Prospect's lead ID in a supported Salesforce system. | |
| SalesforceOwnerId | String | False |
Prospect's owner ID in a supported Salesforce system. | |
| SalesforceId | String | False |
The alpha-numeric Id of the Salesforce Org. | |
| Department | String | False |
Prospect's department. | |
| String | False |
Prospect's email address. | ||
| EmailBouncedAt | Datetime | True |
Time | |
| EmailBouncedReason | String | True |
Reason why prospect email address hard bounced. | |
| Employees | String | False |
Prospect's number of employees. | |
| Fax | String | False |
Prospect's fax number. | |
| FirstActivityAt | Datetime | True |
Time when first visitor activity occurred for this prospect. | |
| FirstAssignedAt | Datetime | True |
Time prospect was first assigned to a user. | |
| FirstName | String | False |
Prospect's first name. | |
| FirstReferrerQuery | String | True |
First referrer's search query. | |
| FirstReferrerType | String | True |
First referrer's vendor and type (such as 'Google Natural Search'). | |
| FirstReferrerUrl | String | True |
First referrer's URL. | |
| Grade | String | True |
Prospect's letter grade. | |
| Industry | String | False |
Prospect's industry. | |
| IsDeleted | Boolean | True |
True if the object is in the recycle bin in Pardot. | |
| IsDoNotCall | Boolean | False |
If value is 1, prospect prefers not to be called. | |
| IsDoNotEmail | Boolean | False |
If value is 1, prospect prefers not to be emailed. | |
| isEmailHardBounced | Boolean | True |
If true, prospect email address has hard bounced. | |
| IsReviewed | Boolean | False |
If value is 1, prospect has been reviewed. | |
| IsStarred | Boolean | False |
If value is 1, prospect has been starred. | |
| JobTitle | String | False |
Prospect's job title. | |
| LastActivityAt | Datetime | True |
Time stamp of this prospect's latest visitor activity. | |
| LastName | String | False |
Prospect's last name. | |
| MediumParameter | String | True |
Prospect's medium parameter utm_medium from Google Analytics. | |
| Notes | String | False |
Notes about this prospect. | |
| OptedOut | Boolean | False |
If value is 1, prospect has opted out of marketing communications. | |
| Password | String | True |
Prospect's password. | |
| Phone | String | False |
Prospect's phone number. | |
| ProspectAccountId | Integer | 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 | Integer | True |
ID of the user who the object record is assigned to. | |
| ProfileId | Integer | False |
Pardot profile related to this object. | |
| SalesforceUrl | String | True |
URL to view the prospect within the Salesforce system. | |
| LifecycleStageId | Integer | True |
Pardot lifecycle stage related to this object. | |
| UserId | Integer | 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 | Integer | True |
ID of the individual who created this object. | |
| UpdatedById | Integer | True |
ID of the individual who last updated this object. |
ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。
ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。
ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。
| Name | Description |
| Campaigns | Retrieve and modify campaigns. |
| CustomFields | Retrieve custom fields metadata. |
| DynamicContentVariations | Retrieve a collection of Dynamic Content Variations |
| Emails | Query emails to learn how prospects responded to the emails. |
| Folders | Retrieve folders or organize and nest your content and marketing assets in a way that makes sense for your team. |
| Forms | Retrieve forms. |
| ListEmail | A list email is a single email sent to a recipient list. |
| Opportunities | Retrieve a collection of opportunities |
| ProspectAccounts | Retrieve and modify prospect accounts. |
| ReplyToOptions | Query the repltyTo options of email templates. |
| SenderOptions | Query the sender options of email templates. |
| TrackerDomains | Query the available tracker domains. |
| Users | Query the available users. |
| VisitorActivities | Retrieve visitor activities. |
| Visitors | Retrieve visitors. |
| VisitorsPageViews | Retrieve visitors page views. |
| Visits | Retrieve visits. |
Retrieve and modify campaigns.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM Campaigns WHERE Id = 50 SELECT * FROM Campaigns WHERE Name = 'campaignName' SELECT * FROM Campaigns WHERE CreatedAt > '01/01/2022'
To retrieve campaigns that are in the recycle bin in Pardot the following operation is supported:
GETDELETED FROM Campaings
| Name | Type | References | Description |
| Id [KEY] | Integer | 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 | Integer | ID of the folder containing this object. | |
| ParentCampaignId | Integer | 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 | Integer | ID of the individual who created this object. | |
| UpdatedById | Integer | ID of the individual who last updated this object. |
Retrieve custom fields metadata.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM CustomFields WHERE Id = 50 SELECT * FROM CustomFields WHERE CreatedAt > '01/01/2022' SELECT * FROM CustomFields WHERE UpdatedAt < '01/01/2022'
| Name | Type | References | Description |
| Id [KEY] | Integer | Pardot ID for this custom field. | |
| Name | String | Custom field's name. | |
| FieldId | String | API ID for custom field. | |
| Type | String | The type of field. | |
| CreatedAt | Datetime | Time custom field was created in Pardot. | |
| UpdatedAt | Datetime | Last time custom field was updated. | |
| CreatedById | Integer | ID of the individual who created this object. | |
| UpdatedById | Integer | ID of the individual who last updated this object. | |
| IsRecordMultipleResponses | Boolean | If true, this custom field will record multiple responses. | |
| IsUseValues | Boolean | If true, this custom field will use predefined values. | |
| SalesforceId | String | The alpha-numeric Id of the Salesforce Org. | |
| IsRequired | String | True if the custom field is required. | |
| isAnalyticsSynced | Boolean | True if the object is synced to Analytics. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ValuesPrefill | String | Write-Only field on create operation. Possible values: Countries, |
Retrieve a collection of Dynamic Content Variations
| Name | Type | References | Description |
| Id [KEY] | Integer | Pardot ID for this dynamic content variation. | |
| Comparison | String | The logic used to set the criteria for a variation. This field works together with the Dynamic Content basedOn field to determine which variation a prospect is served. | |
| Content | String | The text content of the variation. | |
| DynamicContentId | String | ID of the dynamic content this variation is associated with. |
Query emails to learn how prospects responded to the emails.
The Cloud uses the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM Emails WHERE Id = 50 SELECT * FROM Emails WHERE ProspectId = 23 SELECT * FROM Emails WHERE SentAt > '01/01/2022'
| Name | Type | References | Description |
| Id [KEY] | Integer | ID of the email. | |
| ProspectId | Integer | Pardot prospect id related to this email. | |
| CampaignId | Integer | Pardot campaign related to this object. | |
| CreatedById | Integer | 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 | Integer | ID of the list associated with this email. | |
| listEmailId | Integer | 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. |
Retrieve folders or organize and nest your content and marketing assets in a way that makes sense for your team.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM Folders WHERE Id = 50 SELECT * FROM Folders WHERE ParentFolderId = 2
| Name | Type | References | Description |
| Id [KEY] | Integer | Pardot ID of this file. | |
| Name | String | Name of the folder. | |
| ParentFolderId | Integer | 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 | Integer | ID of the individual who created this object. | |
| UpdatedById | Integer | ID of the individual who last updated this object. |
Retrieve forms.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM Forms WHERE Id <= 17 SELECT * FROM Forms WHERE IsDeleted = 'true'
To retrieve forms that are in the recycle bin in Pardot the following operation is supported:
GETDELETED FROM Forms
| Name | Type | References | Description |
| Id [KEY] | Integer | Pardot ID for this form. | |
| Name | String | Form's name. | |
| CampaignId | Integer |
Campaigns.Id | Pardot ID of the campaign associated with this form. |
| EmbedCode | String | The code used to embed the form on your webpage. | |
| SalesforceId | String | The alpha-numeric Id of the Salesforce Org. | |
| LayoutTemplateId | Integer | The ID of the layout template associated with this object | |
| SubmitButtonText | String | The label used for the submit button | |
| BeforeFormContent | String | The HTML text displayed above the form | |
| AfterFormContent | String | The HTML text displayed below the form | |
| ThankYouContent | String | The HTML text displayed after the form is submitted | |
| ThankYouCode | String | Thank you code is typically Javascript used to call other systems like Google Conversion Tracking | |
| IsAlwaysDisplay | Boolean | Always display form after submission. Disable the 10 minute waiting period after submitting a form | |
| RedirectLocation | String | Redirect to this URL instead of showing the | |
| IsUseRedirectLocation | Boolean | When redirect location is valid and enabled. | |
| FontSize | String | Possible values: default, 8pt, 10pt, 12pt, 14pt , 18pt, 24pt, 36pt. | |
| FontFamily | String | Possible values: default, | |
| FontColor | String | 6 digit number in hexadecimal format such as #123456 | |
| LabelAlignment | String | Possible values: default, above, left | |
| RadioAlignment | String | Possible values: default, horizontal, stacked | |
| CheckboxAlignment | String | Possible values: default, horizontal, stacked | |
| RequiredCharacter | String | Possible values: default , * | |
| IsCookieless | String | Kiosk/Data Entry Mode: Do not cookie browser as submitted prospect | |
| ShowNotProspect | Boolean | Include | |
| IsCaptchaEnabled | Boolean | Enable explicit bot protecting using reCAPTCHA | |
| IsDeleted | Boolean | True if the object is in the recycle bin in Pardot. | |
| TrackerDomainId | Integer | The ID of the tracker domain associated with this object. | |
| FolderId | Integer | ID of the folder containing this object. | |
| CreatedAt | Datetime | The timestamp of when this object was created. | |
| UpdatedAt | Datetime | The timestamp of when this object was last updated. | |
| CreatedById | Integer | ID of the individual who created this object. | |
| UpdatedById | Integer | ID of the individual who last updated this object. |
A list email is a single email sent to a recipient list.
The Cloud uses the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM ListEmail WHERE Id = 50 SELECT * FROM ListEmail WHERE SentAt > '01/01/2022' SELECT * FROM ListEmail WHERE CreatedAt > '01/01/2022'
To retrieve list email that are in the recycle bin in Pardot the following operation is supported:
GETDELETED FROM ListEmail
| Name | Type | References | Description |
| Id [KEY] | Integer | 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 | Integer | 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 | Integer | ID of the individual who created this object. | |
| UpdatedById | Integer | 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 | Integer | ID of the email template used for the list email. | |
| TrackerDomainId | Integer | 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. |
Retrieve a collection of opportunities
| Name | Type | References | Description |
| Id [KEY] | Integer | Pardot ID for this opportunity. | |
| CampaignId | Int | 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 | Int | 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 | Int | ID of the user who last updated this object. | |
| Value | Double | The opportunity's value. Must be a positive numeric value. |
Retrieve and modify prospect accounts.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM ProspectAccounts WHERE Id > 31
To retrieve deleted prospect accounts, a GETDELETED statement can be executed.
GETDELETED FROM ProspectAccounts
| Name | Type | References | Description |
| Id [KEY] | Integer | ID of the object. | |
| Name | String | Name of the object. | |
| SalesforceId | String | ID of the Salesforce object representing this object. | |
| IsDeleted | Boolean | True if the object is in the recycle bin in Pardot. | |
| AnnualRevenue | String | Annual Revenue of the object. | |
| BillingAddressOne | String | Billing Address of the object. | |
| BillingAddressTwo | String | Second Billing Address of the object. | |
| BillingCity | String | City of the object. | |
| BillingCountry | String | County of the object. | |
| BillingState | String | State of the object. | |
| BillingZip | String | Zip of the object. | |
| Description | String | Description of the object. | |
| Employees | String | Employees of the object. | |
| Fax | String | Fax of the object. | |
| Industry | String | Industry of the object. | |
| Number | String | Number of the object. | |
| Ownership | String | Ownership of the object. | |
| Phone | String | Phone Number of the object. | |
| Rating | String | Rating of the object. | |
| ShippingAddressOne | String | Shipping Address of the object. | |
| ShippingAddressTwo | String | Second Shipping Address of the object. | |
| ShippingCity | String | Shipping Address city of the object. | |
| ShippingCountry | String | Shipping Address country of the object. | |
| ShippingState | String | Shipping Address state of the object. | |
| ShippingZip | String | Shipping Address zip of the object. | |
| Sic | String | SIC of the object. | |
| Site | String | Site of the object. | |
| TickerSymbol | String | Ticker Symbol of the object. | |
| Type | String | Type of the object. | |
| Website | String | Website of the object. | |
| CreatedAt | Datetime | Creation time of the object. | |
| UpdatedAt | Datetime | Last update time of the object. | |
| AssignedToId | Integer | ID of the user who the object record is assigned to. | |
| CreatedById | Integer | ID of the individual who created this object. | |
| UpdatedById | Integer | ID of the individual who last updated this object. |
Query the repltyTo options of email templates.
| Name | Type | References | Description |
| EmailId [KEY] | Integer | 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. | |
| Name | String | The name of the sender. | |
| ProspectCustomFieldId | String | The ID of the prospect custom field that contains the sender value. Only available on read and query. | |
| AccountCustomFieldId | String | The ID of the account custom field that contains the sender value. Only available on read and query. |
Query the sender options of email templates.
| Name | Type | References | Description |
| EmailId [KEY] | Integer | ID of the email template. | |
| Address | String | The sending email address. | |
| Name | String | The name of the sender. | |
| Type | String | The sending user type. Can be general_user, specific_user, assigned_user, or account_owner. | |
| UserId | String | The user ID of the sender. | |
| ProspectCustomFieldId | String | The ID of the prospect custom field that contains the sender value. Only available on read and query. | |
| AccountCustomFieldId | String | The ID of the account custom field that contains the sender value. Only available on read and query. |
Query the available tracker domains.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM TrackerDomains WHERE Id = 50
To retrieve deleted records, a GETDELETED statement can be executed.
GETDELETED FROM TrackerDomains
| Name | Type | References | Description |
| Id [KEY] | Integer | 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 | Integer | 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 | Integer | 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 | Integer | ID of the individual who created this object. | |
| UpdatedById | Integer | ID of the individual who last updated this object. |
Query the available users.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
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'
To retrieve deleted users, a GETDELETED statement can be executed.
GETDELETED FROM Users
| Name | Type | References | Description |
| Id [KEY] | Integer | Pardot ID for this object. | |
| String | Email address of the user. | ||
| FirstName | String | First name of the user. | |
| Username | String | Formatted as an email address, though distinct from the email field on the user object. | |
| JobTitle | String | Job title of the user. | |
| Role | String | Role of the user. | |
| SalesforceId | String | Salesforce Id of the object. | |
| IsDeleted | Boolean | True if the object is in the recycle bin in Pardot. | |
| CreatedAt | Datetime | The timestamp of when this object was created. | |
| UpdatedAt | Datetime | The timestamp of when this object was last updated. | |
| CreatedById | Integer | ID of the individual who created this object. | |
| UpdatedById | Integer | ID of the individual who last updated this object. |
Retrieve visitor activities.
| Name | Type | References | Description |
| Id [KEY] | Integer | Pardot ID for this campaign. | |
| CampaignId | Integer |
Campaigns.Id | Pardot ID for the associated campaign. |
| CustomRedirectId | Integer | 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 | Integer |
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 | Integer | 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 | Integer |
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 | Integer |
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 | Integer |
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 | Integer |
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 | Integer |
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 | Integer |
Visits.Id | Pardot ID for the associated visit. |
| VisitorId | Integer |
Visitors.Id | Pardot ID for the associated visitor. |
| VisitorPageViewId | Integer | 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 | Integer | Pardot ID for the associated opportunity. | |
| ProspectId | Integer |
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 | Integer | 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 | Integer | 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 | Integer | Pardot ID of the site search query associated with this visitor activity Note: This node will only appear if this visitor activity has a site search query associated with it. | |
| Type | Integer | Visitor activity's type number. | |
| TypeName | String | Visitor activity's type name. | |
| CreatedAt | Datetime | The timestamp of when this object was created. | |
| UpdatedAt | Datetime | The timestamp of when this object was last updated. |
Retrieve visitors.
| Name | Type | References | Description |
| Id [KEY] | Integer | 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 | Time visitor was created in Pardot. | |
| UpdatedAt | Datetime | Last time visitor was updated in Pardot. | |
| ProspectId | Integer | Selects visits with the given Prospect IDs. |
Retrieve visitors page views.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM VisitorPageViews WHERE VisitId = 22 SELECT * FROM VisitorPageViews WHERE Id >= 22 AND VisitorId = 1234
| Name | Type | References | Description |
| Id [KEY] | Integer | Pardot ID for this visitor page view. | |
| Url | String | The Url of the page. | |
| Title | String | The Title column of the VisitorsPageViews object. | |
| VisitId | Integer | Pardot ID for this visit. | |
| VisitorId | Integer | Pardot ID for the associated visitor. | |
| CampaignId | Integer | Pardot campaign related to this object. | |
| SalesforceId | String | Salesforce Id of the object. | |
| DurationInSeconds | Integer | Length of this page view. | |
| CreatedAt | Datetime | The timestamp of when this object was created. |
Retrieve visits.
The Cloud will use the Salesforce Pardot 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.
For example, the following queries are processed server side:
SELECT * FROM Visits WHERE Id = 22 SELECT * FROM Visits WHERE VisitorId > 234
| Name | Type | References | Description |
| Id [KEY] | Integer | ID of the object. | |
| VisitorId | Integer | Pardot ID for the associated visitor. | |
| ProspectId | Integer |
Prospects.Id | Pardot ID for the associated prospect. |
| VisitorPageViewCount | Integer | Number of page views for this visit. | |
| FirstVisitorPageViewAt | Datetime | Time of first page view for this visit. | |
| LastVisitorPageViewAt | Datetime | Time of last page view for this visit. | |
| DurationInSeconds | Integer | Length of this visit. | |
| CampaignParameter | String | Visit's campaign parameter utm_campaign from Google Analytics. | |
| MediumParameter | String | Visit's medium parameter utm_medium from Google Analytics. | |
| SourceParameter | String | Visit's source parameter utm_source from Google Analytics. | |
| ContentParameter | String | Visit's content parameter utm_content from Google Analytics. | |
| TermParameter | String | Visit's term parameter utm_term from Google Analytics. | |
| CreatedAt | Datetime | The timestamp of when this object was created. | |
| UpdatedAt | Datetime | The timestamp of when this object was last updated. |
ストアドプロシージャはファンクションライクなインターフェースで、Salesforce Pardot の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、該当する場合は、プロシージャが成功したか失敗したかを示すとともにSalesforce Pardot から関連するレスポンスデータを返します。
| Name | Description |
If using a Windows application, set Authmode to App. If using a Web app, set Authmode to Web and specify the Verifier obtained by GetOAuthAuthorizationUrl.
| Name | Type | Required | Description |
| Authmode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.
使用できる値は次のとおりです。APP, WEB デフォルト値はAPPです。 |
| Verifier | String | False | The verifier token returned by Salesforce after using the URL obtained with GetOAuthAuthorizationUrl. |
| Scope | String | False | A space-separated scope of permissions you need the app to have access to. The available values are api, chatter_api, full, id, refresh_token, visualforce, and web. For details, refer to: http://help.salesforce.com/help/doc/en/remoteaccess_oauth_scopes.htm. |
| CallbackUrl | String | False | The page to return the Salesforce app after authentication has been completed. |
| Api_Version | String | False | The API version you would like to authenticate to.
デフォルト値は49.0です。 |
| State | String | False | Any value that you wish to be sent with the callback. |
| GrantType | String | False | Authorization grant type. Only available for OAuth 2.0. If left unspecified, the default value is the value of the OAuthGrantType connection property.
使用できる値は次のとおりです。CODE, PASSWORD |
| Name | Type | Description |
| Scope | String | The scope of permissions for the app. |
| Instance_Url | String | The instance URL being used by the app. |
| Id | String | The Id associated with the OAuth token. |
| Issued_At | String | When the token was issued at. |
| Signature | String | A signature for the OAuth token. |
| OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
| OAuthAccessToken | String | The OAuth access token. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps.
| Name | Type | Required | Description |
| CallbackUrl | String | False | The page to return the user after authorization is complete. |
| Scope | String | False | A space-separated scope of permissions you need the app to have access to. The available values are api, chatter_api, full, id, refresh_token, visualforce, web. For more details, refer to: http://help.salesforce.com/help/doc/en/remoteaccess_oauth_scopes.htm. |
| Grant_Type | String | False | The type of authorization to be granted for your app. If this is set to code, the stored procedure will return an authorization URL containing the verifier code in a query string parameter, which you will need to submit back with the GetOAuthAccessToken stored procedure. Implicit will cause the OAuth access token to be returned directly in the URL.
使用できる値は次のとおりです。Implicit, Code |
| State | String | False | Any value that you wish to be sent with the callback. |
| Name | Type | Description |
| Url | String | The authorization url. |
Refreshes the OAuth token or session id after the session has expired. Your OAuth application must have the refresh_token scope enabled.
| Name | Type | Required | Description |
| OAuthRefreshToken | String | True | The refresh token returned when the OAuth Token was first created. |
| Name | Type | Description |
| Instance_Url | String | Instance of Salesforce the OAuth token is valid for. |
| OAuthAccessToken | String | The OAuth token. |
| Id | String | Id associated with the OAuth Token. |
| Issued_At | String | When the OAuth Token was issued. |
| Signature | String | Signature of the OAuth Token. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、Salesforce Pardot のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリのクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | データベース名。 |
利用可能なスキーマをリストします。
次のクエリは、すべての利用可能なスキーマを取得します。
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | データベース名。 |
| SchemaName | String | スキーマ名。 |
利用可能なテーブルをリストします。
次のクエリは、利用可能なテーブルおよびビューを取得します。
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | テーブルまたはビューを含むデータベース。 |
| SchemaName | String | テーブルまたはビューを含むスキーマ。 |
| TableName | String | テーブル名またはビュー名。 |
| TableType | String | テーブルの種類（テーブルまたはビュー）。 |
| Description | String | テーブルまたはビューの説明。 |
| IsUpdateable | Boolean | テーブルが更新可能かどうか。 |
利用可能なテーブルのカラムについて説明します。
次のクエリは、Prospects テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Prospects'
| 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 | カラムが配列かどうか。 |
利用可能なストアドプロシージャをリストします。
次のクエリは、利用可能なストアドプロシージャを取得します。
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | ストアドプロシージャを含むデータベース。 |
| SchemaName | String | ストアドプロシージャを含むスキーマ。 |
| ProcedureName | String | ストアドプロシージャの名前。 |
| Description | String | ストアドプロシージャの説明。 |
| ProcedureType | String | PROCEDURE やFUNCTION などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、UnAssignProspect ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName='UnAssignProspect' AND Direction=1 OR Direction=2
| Name | Type | Description |
| CatalogName | String | ストアドプロシージャを含むデータベースの名前。 |
| SchemaName | String | ストアドプロシージャを含むスキーマの名前。 |
| ProcedureName | String | パラメータを含むストアドプロシージャの名前。 |
| ColumnName | String | ストアドプロシージャパラメータの名前。 |
| Direction | Int32 | パラメータのタイプに対応する整数値：input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。 |
| DataTypeName | String | データ型の名前。 |
| DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
| Length | Int32 | 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。 |
| NumericPrecision | Int32 | 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ（文字数）。 |
| NumericScale | Int32 | 数値データの小数点以下の桁数。 |
| IsNullable | Boolean | パラメータがNull を含められるかどうか。 |
| IsRequired | Boolean | プロシージャの実行にパラメータが必要かどうか。 |
| IsArray | Boolean | パラメータが配列かどうか。 |
| Description | String | パラメータの説明。 |
| Ordinal | Int32 | パラメータのインデックス。 |
主キーおよび外部キーについて説明します。
次のクエリは、Prospects テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Prospects'
| 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 | 主キーのカラム名。 |
外部キーについて説明します。
次のクエリは、他のテーブルを参照するすべての外部キーを取得します。
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 | 外部キーがインポート（他のテーブルを指す）キーかエクスポート（他のテーブルから参照される）キーかを指定します。 |
利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。
次のクエリは、主キーでないすべてのインデックスを取得します。
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| 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 | インデックスのカラムのシーケンスナンバー。 |
利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。
このテーブルをクエリする際は、config 接続文字列を使用する必要があります。
jdbc:cdata:salesforcepardot:config:
この接続文字列を使用すると、有効な接続がなくてもこのテーブルをクエリできます。
次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。
SELECT * FROM sys_connection_props WHERE Value <> ''
| 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 | プロパティに関するその他のさまざまな情報。 |
Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。
SQL 構文の詳細については、SQL 準拠 を参照してください。
以下はSQL 機能のサンプルデータセットです。 次の結果セットは、Cloud がデータソースにオフロードできる、またはクライアントサイドで処理できるSELECT 機能を示します。データソースは追加のSQL 構文をサポートすることがあります。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。
| 名前 | 説明 | 有効な値 |
| AGGREGATE_FUNCTIONS | サポートされている集計関数。 | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | COUNT 関数がサポートされているかどうか。 | 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_BY | GROUP 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_PROPERTIES | Uniform データベースを特定するプロパティを示します。 | |
| SUPPORTS_MULTIPLE_SCHEMAS | プロバイダー用に複数のスキームが存在するかどうかを示します。 | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | プロバイダー用に複数のカタログが存在するかどうかを示します。 | YES, NO |
| DATASYNCVERSION | このドライバーにアクセスするために必要な、CData Sync のバージョン。 | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | このドライバーのCData Sync カテゴリ。 | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | API で提供されている以上の、追加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_PARENTID | CheckCache 構文を親キーカラムに対して実行するかどうかを示します。 | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | スキーマファイルの生成に使用できる、ストアドプロシージャを示します。 |
次のクエリは、WHERE 句で使用できる演算子を取得します。
SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。
| Name | Type | Description |
| NAME | String | SQL 構文のコンポーネント、またはサーバー上で処理できる機能。 |
| VALUE | String | サポートされるSQL またはSQL 構文の詳細。 |
試行された変更に関する情報を返します。
次のクエリは、バッチ処理で変更された行のId を取得します。
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | データ変更処理から返された、データベース生成Id。 |
| Batch | String | バッチの識別子。1 は単一処理。 |
| Operation | String | バッチ内の処理の結果：INSERTED、UPDATED、またはDELETED。 |
| Message | String | SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
| プロパティ | 説明 |
| AuthScheme | The type of authentication to use when connecting to Salesforce Pardot. |
| Schema | Specify the Salesforce Pardot API version to use. SalesforcePardotV5 is the new rebuilt API. |
| BusinessUnitID | Your Salesforce Pardot Business Unit ID (BU). Required when connecting via OAuth 2.0. |
| IsDemoAccount | Whether the provided account is a demo account or not. |
| UseSalesforceSandbox | A boolean determining if the connection should be made to a Salesforce sandbox account. |
| User | The user that is SSO-enabled. |
| Password | The password of the user that is SSO-enabled. |
| SecurityToken | The security token used to authenticate access to the Salesforce Pardot account. |
| プロパティ | 説明 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
| OAuthAccessToken | OAuth を使用して接続するためのアクセストークン。 |
| CallbackURL | 認証時にリダイレクトされるOAuth コールバックURL。この値をアプリケーションに指定したコールバックURL と同じ値に設定します。 |
| OAuthGrantType | OAuth フローのグラント種別。 |
| OAuthVerifier | OAuth 認可URL から返された検証コード。 |
| OAuthRefreshToken | 対応するOAuth アクセストークンのためのOAuth リフレッシュトークン。 |
| OAuthExpiresIn | OAuth アクセストークンの有効期限（秒単位）。 |
| OAuthTokenTimestamp | 現在のアクセストークンが作成されたときのUnix エポックタイムスタンプ（ミリ秒）。 |
| プロパティ | 説明 |
| OAuthJWTCert | JWT 証明書のストア。 |
| OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
| OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。 |
| OAuthJWTCertSubject | OAuth JWT 証明書の件名。 |
| OAuthJWTIssuer | Java Web Token の発行者。 |
| OAuthJWTSubject | アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
| プロパティ | 説明 |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
| プロパティ | 説明 |
| ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
| ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
| ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
| ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
| ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
| ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| Logfile | ログファイルの名前と場所を指定するファイルパス。 |
| Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
| LogModules | ログファイルに含めるコアモジュール。 |
| MaxLogFileSize | ログファイルの最大バイトサイズ（例えば、10MB）を指定する文字列。 |
| MaxLogFileCount | ログファイルの最大ファイル数を指定する文字列。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
| Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| AutoCache | SELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。 |
| CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
| CacheTolerance | AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。 |
| Offline | オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。 |
| CacheMetadata | このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。 |
| プロパティ | 説明 |
| Archived | Specify whether to get archived or unarchived records. |
| IncludeMessage | 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 | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
| MaxThreads | Specifies the number of concurrent requests. |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| Pagesize | Salesforce Pardot から返されるページあたりの結果の最大数。 |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| Readonly | このプロパティを使用して、provider からSalesforce Pardot へのアクセスを読み取り専用に設定できます。 |
| 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. |
| RTK | ライセンス供与で使用されるランタイムキー。 |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AuthScheme | The type of authentication to use when connecting to Salesforce Pardot. |
| Schema | Specify the Salesforce Pardot API version to use. SalesforcePardotV5 is the new rebuilt API. |
| BusinessUnitID | Your Salesforce Pardot Business Unit ID (BU). Required when connecting via OAuth 2.0. |
| IsDemoAccount | Whether the provided account is a demo account or not. |
| UseSalesforceSandbox | A boolean determining if the connection should be made to a Salesforce sandbox account. |
| User | The user that is SSO-enabled. |
| Password | The password of the user that is SSO-enabled. |
| SecurityToken | The security token used to authenticate access to the Salesforce Pardot account. |
The type of authentication to use when connecting to Salesforce Pardot.
string
"Auto"
Specify the Salesforce Pardot API version to use. SalesforcePardotV5 is the new rebuilt API.
string
"SalesforcePardotV4"
Specify the Salesforce Pardot API version to use. SalesforcePardotV5 is the rebuilt API.
Your Salesforce Pardot Business Unit ID (BU). Required when connecting via OAuth 2.0.
string
""
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.
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".
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.
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.
The security token used to authenticate access to the Salesforce Pardot 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.
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
| OAuthAccessToken | OAuth を使用して接続するためのアクセストークン。 |
| CallbackURL | 認証時にリダイレクトされるOAuth コールバックURL。この値をアプリケーションに指定したコールバックURL と同じ値に設定します。 |
| OAuthGrantType | OAuth フローのグラント種別。 |
| OAuthVerifier | OAuth 認可URL から返された検証コード。 |
| OAuthRefreshToken | 対応するOAuth アクセストークンのためのOAuth リフレッシュトークン。 |
| OAuthExpiresIn | OAuth アクセストークンの有効期限（秒単位）。 |
| OAuthTokenTimestamp | 現在のアクセストークンが作成されたときのUnix エポックタイムスタンプ（ミリ秒）。 |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
string
""
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
string
""
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
OAuth を使用して接続するためのアクセストークン。
string
""
OAuth を使用して接続するには、OAuthAccessToken プロパティが使用されます。認証プロセスにおいてOAuth サーバーからOAuthAccessToken が取得されます。このプロパティは、サーバーに依存するタイムアウトがあり、要求の間で再利用することができます。
アクセストークンは、ユーザー名とパスワードの代わりに使用されます。サーバー上で維持することで、認証情報が保護されます。
認証時にリダイレクトされるOAuth コールバックURL。この値をアプリケーションに指定したコールバックURL と同じ値に設定します。
string
""
認証プロセス中、OAuth 認証サーバーはユーザーをこのURL にリダイレクトします。この値をアプリケーションに指定したコールバックURL と同じ値に設定します。
OAuth フローのグラント種別。
string
"CODE"
OAuth フローのグラント種別。次のオプションが利用可能です：CODE,PASSWORD
OAuth 認可URL から返された検証コード。
string
""
OAuth 認可URL から返された検証コード。これは、ヘッドレスシステムのようにブラウザを起動できないシステム上で使用できます。
OAuthVerifier 値を取得するには、 を参照してください。
OAuthVerifier に加えてOAuthSettingsLocation を設定します。接続すると、Cloud はOAuth 認証トークンのOAuthVerifier を交換し、暗号化して、指定されたファイルに保存します。
OAuth 設定ファイルが生成されたら、接続プロパティからOAuthVerifier を削除して OAuthSettingsLocation セットで接続できます。
OAuth トークン値を自動的にリフレッシュするには、 OAuthSettingsLocation を設定し、さらにInitiateOAuth をREFRESH に設定します。
対応するOAuth アクセストークンのためのOAuth リフレッシュトークン。
string
""
OAuthRefreshToken プロパティは、OAuth 認証時にOAuthAccessToken のリフレッシュに使われます。
OAuth アクセストークンの有効期限（秒単位）。
string
""
OAuthTokenTimestamp と併用して、アクセストークンの有効期限を決定します。
現在のアクセストークンが作成されたときのUnix エポックタイムスタンプ（ミリ秒）。
string
""
OAuthExpiresIn と併用して、アクセストークンの有効期限を決定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthJWTCert | JWT 証明書のストア。 |
| OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
| OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。 |
| OAuthJWTCertSubject | OAuth JWT 証明書の件名。 |
| OAuthJWTIssuer | Java Web Token の発行者。 |
| OAuthJWTSubject | アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。 |
JWT 証明書のストア。
string
""
クライアント証明書のための証明書ストア名。
OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword でパスワードを指定します。
OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。 詳しくは、OAuthJWTCertSubject フィールドを参照してください。
証明書ストアの指定はプラットフォームに依存します。
Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。
| MY | 個人証明書と関連付けられた秘密キーを格納している証明書ストア。 |
| CA | 証明機関の証明書。 |
| ROOT | ルート証明書。 |
| SPC | ソフトウェア発行元証明書。 |
Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。
証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ（例えば、PKCS12証明書ストア）に設定する必要があります。
JWT 証明書を格納するキーストアの種類。
string
"USER"
このプロパティには次の値の一つを設定できます。
| USER | Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。 Note：この種類はJava では利用できません。 |
| MACHINE | Windows の場合、この証明書ストアがシステムストアであることを指定します。 Note：この種類はJava では利用できません。 |
| PFXFILE | この証明書ストアは、証明書を含むPFX（PKCS12）ファイルの名前です。 |
| PFXBLOB | この証明書ストアは、PFX（PKCS12）形式の証明書ストアを表すBase-64でエンコードされた文字列です。 |
| JKSFILE | この証明書ストアは、証明書を含むJava key store（JKS）ファイルの名前です。 Note：この種類はJava のみで利用できます。 |
| JKSBLOB | この証明書ストアは、Java key store（JKS）形式の証明書ストアを表すBase-64でエンコードされた文字列です。 Note：この種類はJava のみで利用できます。 |
| PEMKEY_FILE | この証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。 |
| PEMKEY_BLOB | この証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。 |
| PUBLIC_KEY_FILE | この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。 |
| PUBLIC_KEY_BLOB | この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。 |
| SSHPUBLIC_KEY_FILE | この証明書ストアは、SSH 公開キーを含むファイルの名前です。 |
| SSHPUBLIC_KEY_BLOB | この証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。 |
| P7BFILE | この証明書ストアは、証明書を含むPKCS7 ファイルの名前です。 |
| PPKFILE | この証明書ストアは、PuTTY 秘密キー（PPK）を含むファイルの名前です。 |
| XMLFILE | この証明書ストアは、XML 形式の証明書を含むファイルの名前です。 |
| XMLBLOB | この証明書ストアは、XML 形式の証明書を含む文字列の名前です。 |
OAuth JWT 証明書のパスワード。
string
""
証明書ストアでパスワードが必要である場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。
OAuth JWT 証明書の件名。
string
"*"
証明書の件名は、証明書をロードするときにストア内の証明書を検索するために使用されます。
完全に一致するものが見つからない場合、ストアはプロパティの値を含む件名を検索します。
それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。
"*" に設定すると、証明書ストアの1番目の証明書が選択されます。
証明書の件名は識別の名前フィールドおよび値のカンマ区切りのリストです。 例えば、"CN=www.server.com, OU=test, C=US, [email protected]"。共通のフィールドとその説明は以下のとおりです。
| フィールド | 説明 |
| CN | 共通名。一般的には、www.server.com のようなホスト名です。 |
| O | 法人名 |
| OU | 法人の部署名 |
| L | 法人の住所（市町村名） |
| S | 法人の住所（都道府県） |
| C | 国名 |
| E | Eメールアドレス |
フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。
Java Web Token の発行者。
string
""
Java Web Token の発行者。通常は、OAuth アプリケーションのクライアントId またはE メールアドレスとなります。
アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。
string
""
アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクトです。通常は、ユーザーのアカウント名またはE メールアドレスとなります。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
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 |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
| プロパティ | 説明 |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロキシベースのファイアウォールで使われるプロトコル。
string
"NONE"
このプロパティは、Cloud がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Cloud はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
| タイプ | デフォルトポート | 説明 |
| TUNNEL | 80 | これが設定されている場合、Cloud はSalesforce Pardot への接続を開き、プロキシを経由して通信が行われます。 |
| SOCKS4 | 1080 | これが設定されている場合、Cloud はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | これが設定されている場合、Cloud はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
プロキシベースのファイアウォールの名前もしくはIP アドレス。
string
""
ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。
Cloud はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。
プロキシベースのファイアウォールのTCP ポート。
int
0
ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。
プロキシベースのファイアウォールに認証するために使うユーザー名。
string
""
FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。
プロキシベースのファイアウォールへの認証に使われるパスワード。
string
""
このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
| ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
| ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
| ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
| ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
| ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
bool
true
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
string
""
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Cloud はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。
SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。
デフォルトで、Cloud はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。
ProxyServer プロキシが起動しているTCP ポート。
int
80
HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer プロキシへの認証で使われる認証タイプ。
string
"BASIC"
この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。
Cloud は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
認証タイプは、次のどれかになります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer プロキシへの認証に使われるユーザー名。
string
""
ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。
ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。
user@domain domain\user
ProxyServer プロキシへの認証に使われるパスワード。
string
""
このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。
HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。
NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
デフォルトで、Cloud はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。
ProxyServer プロキシへの接続時に使用するSSL タイプ。
string
"AUTO"
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。
| AUTO | デフォルト設定。URL がHTTPS URL の場合、Cloud は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
string
""
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Cloud は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| Logfile | ログファイルの名前と場所を指定するファイルパス。 |
| Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
| LogModules | ログファイルに含めるコアモジュール。 |
| MaxLogFileSize | ログファイルの最大バイトサイズ（例えば、10MB）を指定する文字列。 |
| MaxLogFileCount | ログファイルの最大ファイル数を指定する文字列。 |
ログファイルの名前と場所を指定するファイルパス。
string
""
このプロパティを設定すると、認証が実行されたときやクエリが実行されたときなど、さまざまなタスクを実行する際に、Cloud がログファイルを生成します。指定したファイルが存在しない場合は作成されます。
接続文字列およびバージョン情報も記録されますが、機密情報を含む接続プロパティは自動的にマスクされます。
相対ファイルパスが指定された場合、ログファイルの場所は、Location 接続プロパティにあるパスに基づいて解決されます。
ログファイルに記録される内容をより細かく制御するには、Verbosity プロパティを調整してください。
ログ内容はいくつかのモジュールに分類されます。LogModules プロパティを使うことで、個々のモジュールを表示または非表示にすることができます。
新しいログファイルの作成前にログファイル1つの最大サイズを変更する方法については、MaxLogFileSize を参照してください。
生成されるログファイル数に上限を設定したい場合は、MaxLogFileCount を使用してください。
ログファイルに含めるコアモジュール。
string
""
指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
ログファイルの最大バイトサイズ（例えば、10MB）を指定する文字列。
string
"100MB"
サイズリミットを超えると、日付と時刻が末尾に追加された新しいログが同じフォルダ内に作成されます。リミットのデフォルトは100 MB です。100 kB より小さい値を設定した場合、100 kB がリミットとなります。
生成されるログファイルの最大数は、MaxLogFileCount で調整できます。
ログファイルの最大ファイル数を指定する文字列。
int
-1
サイズリミットを超えると、日付と時刻が末尾に追加された新しいログが同じフォルダ内に作成され、最も古いログファイルが削除されます。
サポートされている最小値は2です。0や負の値は、数に制限がないことを示します。
生成されるログファイルの最大サイズは、MaxLogFileSize で調整できます。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
| Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
string
"%APPDATA%\\CData\\SalesforcePardot Data Provider\\Schema"
Cloud のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\SalesforcePardot Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
string
""
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
string
""
テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Cloud のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
string
""
ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Cloud のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なCaching プロパティの全リストを提供します。
| プロパティ | 説明 |
| AutoCache | SELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。 |
| CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
| CacheTolerance | AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。 |
| Offline | オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。 |
| CacheMetadata | このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。 |
SELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。
bool
false
AutoCache がtrue に設定されていると、Cloud はテーブルデータのキャッシュを選択したデータベースに自動的に保存します。
AutoCache がtrue の場合、Cloud はシンプルなファイルベースストアにキャッシュします。次のプロパティを使って、場所またはキャッシュを別のデータベースに構成できます。
キャッシュデータベースへのパスとファイル名を指定します。
string
"%APPDATA%\\CData\\SalesforcePardot Data Provider"
CacheLocation は単純なファイルベースキャッシュです。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\SalesforcePardot Data Provider" となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます：
AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。
int
600
キャッシュ内の失効データに対する許容範囲の秒数。これは、AutoCache が使用されている場合のみ有効です。Cloud は、許容インターバルが過ぎると、新しいレコードがないかデータソースをチェックしに行きます。それ以外は、キャッシュから直接データを返します。
オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。
bool
false
Offline がtrue に設定されている場合、すべてのクエリは、ライブデータソースではなくキャッシュに対して実行されます。このモードでは、INSERT、UPDATE、DELETE、CACHE などのクエリは許可されません。
このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。
bool
false
このプロパティを設定してクエリを実行すると、Salesforce Pardot カタログのテーブルメタデータが設定されている場合にはCacheLocation で指定されたファイルストアに、設定されていない場合にはホームディレクトリにキャッシュされます。テーブルのメタデータの取得は、テーブルがはじめてクエリされた際に一度だけ行われます。
Cloud は、はじめてテーブルやビューを発見したときから2時間の間、メタデータをインメモリに自動的に保管します。そのため、CacheMetadata は一般的には必要ありません。CacheMetadata は、大量のメタデータを扱う場合でメタデータオペレーションのコストが高い場合や、短い接続を大量に行う場合などに役立ちます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| Archived | Specify whether to get archived or unarchived records. |
| IncludeMessage | 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 | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
| MaxThreads | Specifies the number of concurrent requests. |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| Pagesize | Salesforce Pardot から返されるページあたりの結果の最大数。 |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| Readonly | このプロパティを使用して、provider からSalesforce Pardot へのアクセスを読み取り専用に設定できます。 |
| 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. |
| RTK | ライセンス供与で使用されるランタイムキー。 |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
Specify whether to get archived or unarchived records.
string
"false"
This property is only valid for tables OneToOneEmails and EmailTemplates of SalesforcePardot.
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.
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
int
-1
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
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".
これらの隠しプロパティは特定のユースケースでのみ使用されます。
string
""
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
Salesforce Pardot から返されるページあたりの結果の最大数。
int
1000
Pagesize プロパティは、Salesforce Pardot から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
string
""
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
このプロパティを使用して、provider からSalesforce Pardot へのアクセスを読み取り専用に設定できます。
bool
false
このプロパティがtrue に設定されている場合、Cloud はSELECT クエリのみ許可します。INSERT、UPDATE、DELETE、およびストアドプロシージャクエリではエラーが返されます。
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.
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.
ライセンス供与で使用されるランタイムキー。
string
""
RTK プロパティは、ビルドにライセンスを供与するために使用されます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
int
60
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Cloud は例外をスローします。
A filepath pointing to the JSON configuration file containing your custom views.
string
""
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Cloud automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Cloud.
This User Defined View configuration file is formatted as follows:
For example:
{
"MyView": {
"query": "SELECT * FROM Prospects WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"