CData Sync App は、Salesforce Marketing Cloud データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Salesforce Marketing Cloud コネクタはCData Sync アプリケーションから使用可能で、Salesforce Marketing Cloud からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App アプリケーションの接続 ページに移動し、接続の追加 パネルで対応するアイコンを選択して、Salesforce Marketing Cloud への接続を作成します。Salesforce Marketing Cloud アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからSalesforce Marketing Cloud コネクタをダウンロードおよびインストールします。
必須プロパティは[設定]タブにリストされています。[Advanced]タブには、通常は必要ない接続プロパティが表示されます。
REST API およびSOAP API の両方で、次のプロパティを使用してデータアクセスを絞り込むことができます。
Salesforce Marketing Cloud REST API はOAuth 認証標準を使用しています。OAuth を使って認証するには、カスタムOAuth アプリケーションを作成してOAuthClientId およびOAuthClientSecret 接続プロパティの値を取得する必要があります。詳しくは、カスタムOAuth アプリの作成 を参照してください。
Salesforce Marketing Cloud SOAP API は、OAuth を使用して接続できます。従来のログイン資格情報の使用もサポートしています。
次を設定して、接続してください。
Web アプリケーション経由で接続する場合は、Salesforce Marketing Cloud にカスタムOAuth アプリケーションを登録する必要があります。カスタムOAuth アプリケーションについては、カスタムOAuth アプリの作成 を参照してください。それからSync App を使用してOAuth トークンの値を取得および管理します。 OAuth アクセストークンの取得
次の接続プロパティを設定し、OAuthAccessToken を取得します。
続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。
ストアドプロシージャがOAuth エンドポイントのURL を返します。
OAuthAccessToken 接続プロパティをストアドプロシージャで返されたアクセストークンに設定し、データに接続します。ExpiresIn 秒後に、アクセストークンの期限が切れたときは、GetOAuthAccessToken を呼び出し、新しいアクセストークンを取得します。
オプション1:Verifier code を取得および交換
Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。
インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。
ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。
OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットする必要があります。
オプション2:OAuth 設定を転送
ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバとの接続を作成し、インストールする必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。
「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定されたパスに暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。
接続が正常にテストされたら、OAuth 設定ファイルをヘッドレスマシンにコピーします。
ヘッドレスマシンでは、次の接続プロパティを設定します。
アプリケーションでサーバー間OAuth 認証を有効にするには、次のプロパティを指定します。
ログイン資格情報認証を使用してデータに接続するには、以下を設定します。
Sync App は、データエクステンションからデータを選択、挿入、更新、および削除する機能をリレーショナルデータベースとして提供します。 データエクステンションをクエリするには、DataExtensionObject_Name という形式で名前を入力するだけです。Name はデータエクステンションの名前です。
SELECT * FROM DataExtensionObject_fsefes3
SELECT * FROM DataExtensionObject_fsefes3 WHERE FieldName1 = 'One'
Note 1:通常のテーブル/ビューで機能するすべてのフィルタは、データエクステンションでも機能します。
Note 2:デフォルトでは、Salesforce Marketing Cloud はLoggedIn ClientId のデータを取得します。複数のClientID の結果を取得するには、区切り文字としてセミコロン (;) を使用します。ClientID には、Enterprise 2.0、On-Your-Behalf、Lock & Publish などのアカウントやサブアカウントを指定できます。
SELECT * FROM DataExtensionObject_fsefes3 WHERE ClientID = '1234567'
INSERT INTO DataExtensionObject_fsefes3(FieldName1, FieldName2, FieldName3) VALUES ('One', 'Two', 'Three')
UPDATE DataExtensionObject_secondtest15 SET [Name] = 'ChangedFromTheApi' WHERE [Email Address] = '[email protected]'
Note:更新が機能するためには、このデータエクステンションのための主キーが存在する必要があります。
DELETE FROM DataExtensionObject_secondtest15 WHERE [Email Address] = '[email protected]'
Note:削除が機能するためには、このデータエクステンションのための主キーが存在する必要があります。
このセクションでは、Salesforce Marketing Cloud Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、Salesforce Marketing Cloud にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
CData Sync App は、REST API とSOAP API の2つのSalesforce Marketing Cloud API をリレーショナルデータベースとしてモデル化します。Schema プロパティを設定し、各セクションの情報を使用してプロジェクトのニーズに基づく適切なAPI を選択してください。
REST API はSalesforce Marketing Cloud 機能への幅広いアクセスを公開します。すべての新しいSalesforce Marketing Cloud テクノロジーはREST API を実装しています。REST API で利用可能なエンティティについては、REST データモデル を参照してください。
SOAP API は、大部分のE メール機能への包括的なアクセスを提供します。SOAP API はSOAP エンベロープを使用して、ユーザーとSalesforce Marketing Cloud との間で情報を渡します。SOAP API で利用可能なエンティティについては、SOAP データモデル を参照してください。
Sync App は、Salesforce Marketing Cloud REST API をデータベーステーブル およびストアドプロシージャ としてモデル化します。これらはスキーマファイルにて定義されます。スキーマファイルは、スキーマを簡単にカスタマイズできるシンプルなテキストベースのコンフィギュレーションファイルです。
このセクションでは、API の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。
テーブル では、利用可能なテーブルを説明します。テーブルは、Assets、Categories、Journeys などを静的にモデル化するように定義されています。
ストアドプロシージャ は、Salesforce Marketing Cloud のファンクションライクなインターフェースです。ストアドプロシージャallow you toexecute操作to Salesforce Marketing Cloud, includingダウンロードandアップロード中コントロール.
Sync App はSalesforce Marketing Cloud のデータを、標準のSQL ステートメントを使用してクエリできるテーブルのリストにモデル化します。
一般的には、Salesforce Marketing Cloud テーブルのクエリは、リレーショナルデータベースのテーブルのクエリと同じです。時には特別なケースもあります。例えば、テーブルの特定のカラムデータを取得するために特定のカラムをWHERE 句に含める必要がある場合などです。これは通常、特定のカラムを取得するために行ごとに個別のリクエストを行う必要がある場合に必要です。これらの特別な状況は、以下にリンクされているテーブルページの上部に明確に文書化されています。
Name | Description |
Assets | Create, update, delete and query assets from your SalesForce Marketing Cloud account. |
Callbacks | Create, update, delete and query event notification callbacks |
Campaigns | Create, update, delete and query Campaigns. |
Categories | Create, update, delete and query categories(folders) in Content Builder. |
EventDefinitions | Create, delete and query event definitions. |
FacebookMessengerProperties | Query and create Facebook messenger properties. |
JourneyActivities | Create, update and query journey activities. |
Journeys | Create, update, delete and query journeys. |
LineMessengerProperties | Query and create Line messenger properties. |
SendDefinitions | Create, update, delete and query send definitions. |
Subscriptions | Create, update, delete and query event notification subscriptions. |
Create, update, delete and query assets from your SalesForce Marketing Cloud account.
Select all assets:
SELECT * FROM ASSETS
Retrieve a specific asset:
SELECT * FROM ASSETS WHERE ID=20088
Advanced server side filtering using 'AND' and 'OR' logical operators are supported for this table. You can check in the table info if the column has supported filters.
All the columns which have supported filters, also can be sorted server side.
SELECT * FROM ASSETS WHERE (Id=5895 OR Id=19442) AND EnterpriseId=7307527 ORDER BY Name ASC, Id DESC
To create an Asset, you will need to specify at least the Name and TypeId column.
INSERT INTO ASSETS(TypeID,TypeName,Name) VALUES(207,'templatebasedemail','First_Based_Template_Email_CData')
Assets may be modified by providing the Id of the Asset and issuing an UPDATE statement.
UPDATE ASSETS SET Description='This is an updated asset.', Data=' "campaigns": { "campaigns": [ { "campaignId": 12345, "campaignAssociationId": 2387 } ] }, "email": { } ... }' WHERE ID=19442
Assets may be deleted by providing the Id of the Asset and issuing a DELETE statement.
DELETE FROM ASSETS WHERE ID=20027
Name | Type | ReadOnly | References | Filters | Description |
Id [KEY] | Integer | True | =,!=,<,<=,>,>= |
The Id of the Asset. | |
CustomerKey | String | False | =,!= |
Reference to customer's private ID/name for the asset. | |
ObjectId | String | True |
System-controlled, read-only text string identifier for object. | ||
Name | String | False | =,!= |
Name of the asset, set by the client. | |
Description | String | False | =,!= |
Description of the asset, set by the client. | |
OwnerId | Integer | True | =,!=,<,<=,>,>= |
The Id of the asset owner. | |
OwnerName | String | True | =,!= |
The name of the asset owner. | |
OwnerEmail | String | True | =,!= |
The email of the asset owner. | |
OwnerUserId | Integer | True |
The user Id of the asset owner. | ||
CreatedDate | Datetime | True | =,!=,<,<=,>,>= |
The datetime when the asset was created. | |
CreatorId | Integer | True | =,!=,<,<=,>,>= |
The Id of the asset creator. | |
CreatorName | String | True |
The name of the asset creator. | ||
CreatorEmail | String | True |
The email of the asset creator. | ||
CreatorUserId | Integer | True |
The user Id of the asset creator. | ||
ModifiedDate | Datetime | True | =,!=,<,<=,>,>= |
The last datetime when the asset was modified. | |
ModifierId | Integer | True | =,!=,<,<=,>,>= |
The Id of the asset modifier. | |
ModifierName | String | True |
The name of the asset modifier. | ||
ModifierEmail | String | True |
The email of the asset modifier. | ||
ModifierUserId | Integer | True |
The user Id of the asset modifier. | ||
EnterpriseId | Integer | True | =,!=,<,<=,>,>= |
A short description of the ... | |
MemberId | Integer | True | =,!=,<,<=,>,>= |
Marketing Cloud MID (member ID) for your account. | |
ActiveDate | Datetime | False | =,!=,<,<=,>,>= |
A short description of the ... | |
ExpirationDate | Datetime | False | =,!=,<,<=,>,>= |
A short description of the ... | |
ContentType | String | False | =,!= |
The type that the content attribute will be in. | |
TypeId | Integer | False | =,!=,<,<=,>,>= |
The Id of the asset type. | |
TypeName | String | False |
The name of the asset type. | ||
TypeDisplayName | String | False |
The display name of the asset type. | ||
CategoryId | Integer | False | =,!=,<,<=,>,>= |
The Id of the category where the asset is located. | |
CategoryName | String | False |
The name of the category where the asset is located. | ||
CategoryParentId | Integer | False |
The Parent Id of the category where the asset is located. | ||
Content | String | False | =,!= |
The actual content of the asset. | |
Design | String | False | =,!= |
Fallback for display when neither content nor supercontent are provided. | |
SuperContent | String | False | =,!= |
Content that supersedes content in terms of display. | |
File | String | False |
Base64-encoded string of a file associated with an asset. | ||
FileProperties | String | False |
Stores the different properties that this asset refers to if it is a file type. | ||
ForwardHtml | String | False |
Field inside the views object. | ||
ForwardText | String | False |
Field inside the views object. | ||
HtmlContent | String | False |
Field inside the views object. | ||
HtmlSlots | String | False |
Field inside the views object. | ||
HtmlTemplate | String | False |
Field inside the views object. | ||
Preheader | String | False |
Field inside the views object. | ||
SubjectLine | String | False |
Field inside the views object. | ||
SubscriptionCenter | String | False |
Field inside the views object. | ||
Text | String | False |
Field inside the views object. | ||
ViewAsAWebPage | String | False |
Field inside the views object. | ||
GenerateFrom | String | False |
Tells the sending compiler what view to use for generating this view's content. | ||
Slots | String | False |
Slots within the asset. | ||
Blocks | String | False |
Blocks within the asset. | ||
MinBlocks | Integer | False |
Minimum number of blocks within an asset. | ||
MaxBlocks | Integer | False |
Maximum number of blocks within an asset. | ||
AllowedBlocks | String | False |
List of blocks that are allowed in the asset. | ||
Template | String | False |
Template the asset follows. | ||
CustomFields | String | False |
Custom fields within an asset. | ||
Data | String | False |
Property bag containing the asset data. | ||
Channels | String | False |
List of channels that are allowed to use this asset. | ||
Version | Integer | True |
The version of the asset. | ||
Locked | Boolean | False |
Specifies if the asset can be modified or not. | ||
Status | String | False |
The asset's status. | ||
Tags | String | False |
List of tags associated with the asset. | ||
BusinessUnitAvailability | String | False |
A dictionary of member IDs that have been granted access to the asset. | ||
SharingProperties | String | False |
Allows you to share content with one or more business units that have Content Builder Sharing enabled. |
Create, update, delete and query event notification callbacks
Select all callbacks:
SELECT * FROM Callbacks
Retrieve a specific callback:
SELECT * FROM Callbacks WHERE CallbackId=94766
To create a Callback, you will need to specify at least the CallbackName and Url column.
INSERT INTO [Callbacks] (CallbackName, Url) VALUES ('cb1', 'https://example.com')
Callbacks may be modified by providing the CallbackId of the callback and issuing an UPDATE statement.
UPDATE [Callbacks] SET CallbackName = 'cb update' WHERE CallbackId = '34cd6cfe-5a21-4f3e-94c5-b6313a6954a4'
Callbacks may be deleted by providing the CallbackId of the callback and issuing a DELETE statement.
DELETE FROM [Callbacks] WHERE CallbackId = '43841979-7154-4fc4-9789-909dbba3a54f'
Name | Type | ReadOnly | References | Filters | Description |
CallbackId [KEY] | String | False | = |
The Id of the event notification callback. | |
CallbackName | String | False |
The name of the event notification callback. | ||
Url | String | False |
The url of the event notification callback. | ||
MaxBatchSize | Integer | False |
Maximum batch size of the event notification callback. | ||
Status | String | False |
The status of the event notification callback. | ||
StatusReason | String | False |
The status reason of the event notification callback. |
Create, update, delete and query Campaigns.
Select all campaigns:
SELECT * FROM Campaigns
Retrieve a specific Campaign:
SELECT * FROM Campaigns WHERE Id = '3130'
To create a campaign, you will need to specify at least the Name column.
INSERT INTO [Campaigns] (Name, Description, CampaignCode, Color, Favorite) VALUES ('Test Camp', 'Test Description', 'tst 001', '0000ff', true)
Update operations are not supported for this table.
Campaigns may be deleted by providing the CampaignId of the campaign and issuing a DELETE statement.
DELETE FROM [Campaigns] WHERE Id = '5161'
Name | Type | ReadOnly | References | Filters | Description |
Id [KEY] | Integer | True | = |
The Id of the Campaign. | |
Name | String | False |
Name of the Campaign. | ||
CampaignCode | String | False |
The Campaign code. | ||
Color | String | False |
The Campaign color. | ||
Favorite | Boolean | False |
True if marked as favorite Campaign. | ||
CreatedDate | Datetime | False |
The exact time when the Campaign was created. | ||
ModifiedDate | Datetime | False |
Last time the Campaign was updated. | ||
Description | String | False |
Description of the Campaign. |
Create, update, delete and query categories(folders) in Content Builder.
Select all categories:
SELECT * FROM Categories
Retrieve all categories which have a specific ParentId:
SELECT * FROM Categories WHERE ParentId=71839
Retrieve a specific category:
SELECT * FROM Categories WHERE Id=94766
All the columns except SharedWith and SharingType can be sorted server side:
SELECT * FROM Categories ORDER BY Name ASC
To create a Category, you will need to specify at least the Name and ParentId column.
INSERT INTO Categories(Name,ParentId,categoryType) VALUES('New New New Folder',71839,'asset')
Categories may be modified by providing the Id of the category and issuing an UPDATE statement.
Update Categories SET SharedWith='333,555,888', SharingType='edit', EnterpriseId=12345 WHERE Id=71839
Categories may be deleted by providing the Id of the category and issuing a DELETE statement.
DELETE FROM Categories WHERE Id=94843
Name | Type | ReadOnly | References | Filters | Description |
Id [KEY] | Integer | True | = |
The Id of the category(folder) in Content Builder. | |
Name | String | False |
Name of the category. | ||
ParentId | Integer | False | = |
ID of the parent category. | |
CategoryType | String | False |
The type of category, either asset or asset-shared, which is automatically set to the CategoryType of the parent category. If set to asset-shared, include the SharingProperties in the call. | ||
EnterpriseId | Integer | False |
ID of the enterprise this business unit belongs to. | ||
MemberId | Integer | False |
ID of the member who creates the category. | ||
SharedWith | String | False |
List of up to 100 MID IDs the category is shared with. To share the category with all business units in the enterprise, and if your account has access to Content Builder Across Enterprise Sharing, set this to 0. SharedWith cannot contain 0 and other MIDs simultaneously. Since shared categories live in and are owned by the enterprise business unit, don't include the enterprise business unit in the SharedWith property. | ||
SharingType | String | False |
Indicates the permission that you are granting to the list of MIDs in sharedWith. The only possible value for categories is edit. 使用できる値は次のとおりです。edit | ||
Description | String | False |
Description of the category. |
Create, delete and query event definitions.
Retrieve all event definitions:
SELECT * FROM EventDefinitions
Retrieve a specific event definition:
SELECT * FROM EventDefinitions WHERE Id='9955614b-02e7-4147-91a2-3f5f5fe9d679'
Retrieve all event definitions which are running in a specific mode:
SELECT * FROM EventDefinitions WHERE Mode='Test'
Retrieve all event definitions which contain the specified quoted phrase in their names:
SELECT * FROM EventDefinitions WHERE Contains(Name,'Welcome Journey')
To create an event definition, you will need to specify at least the Name and Type column. DataExtensionId is also required. If you do not specify it, you must specify the Schema column.
INSERT INTO EventDefinitions(Type,Name,DataExtensionId,IsVisibleInPicker) VALUES('Event','FirstEventDefinition','74bc3342-eaca-e711-b98f-38eaa71427a1',true)
Event definitions may be deleted by providing the Id of the event definition and issuing a DELETE statement.
DELETE FROM EventDefinitions WHERE Id='f10efb9e-cb91-4fc9-be50-c20f00f7f255'
Name | Type | ReadOnly | References | Filters | Description |
Id [KEY] | String | True | = |
The Id of the event definition. | |
Type | String | False |
The type of the event definition. 使用できる値は次のとおりです。Event, ContactEvent, DateEvent, RestEvent | ||
Name | String | False | Contains |
A name for your Event Definition that identifies the event in Marketing Cloud. | |
CreatedDate | Datetime | True |
The datetime when the event definition was created. | ||
CreatedBy | Integer | True |
The Id of the event definition creator. | ||
ModifiedDate | Datetime | True |
The datetime when the event definition was updated. | ||
ModifiedBy | Integer | True |
The Id of the event definition modifier. | ||
Mode | String | False | = |
The mode in which the event definitions can run. 使用できる値は次のとおりです。Production, Test デフォルト値はProductionです。 | |
EventDefinitionKey | String | False |
Unique Id for an Event Definition in Marketing Cloud. Don't include special characters. | ||
DataExtensionId | String | False |
The ID for the data extension associated with the event. Events fired from the API write to this data extension. Required only when not providing a schema. | ||
DataExtensionName | String | False |
The read-only name of the data extension associated with the event. | ||
Description | String | False |
The description of Event Definition. | ||
Schema | String | False |
Schema information for an event. The call uses this information to create a data extension associated with the Event Definition. Only required when not providing a dataExtensionId value. | ||
SendableCustomObjectField | String | False |
Defines the subscriber key or email address within a data extension. Required when defining a schema. | ||
SendableSubscriberField | String | False |
Indicates type of sendable subscriber field. The default value is SubscriberKey. Required when defining a schema. | ||
Schedule | String | False |
Creates an automation run daily according to the defined schedule. The call automatically adds a Fire Event activity to the automation. This automation fires events from the data extension defined as part of the Event Definition. | ||
FilterDefinitionId | String | False |
The Id of the filter definition. | ||
FilterDefinitionTemplate | String | False |
The template of the filter definition. | ||
IconUrl | String | False |
URL to an icon displayed in Event Administration and the Journey Builder Canvas that identifies an Event Definition. | ||
Arguments | String | False |
Contains filter criteria for the Event Definition. Only required for types other than event. | ||
Configuration | String | False |
Optional configuration data for the event. Only required for types other than event. | ||
ConfigurationArguments | String | False |
The configuration arguments of Event Definition. | ||
Metadata | String | False |
Optional data describing the event and its configuration. Only required for types other than event. | ||
InteractionCount | Integer | False |
The interaction counter. | ||
IsVisibleInPicker | Boolean | False |
Indicates whether the Event Picker shows the Event Definition to users when configuring a journey. デフォルト値はtrueです。 | ||
Category | String | False |
Broad category of the event type. デフォルト値はeventです。 | ||
PublishedInteractionCount | Integer | False |
The published interaction counter. | ||
AutomationId | String | False |
The Id of the Automation. |
Query and create Facebook messenger properties.
Retrieve all registred facebook messenger properties:
SELECT * FROM FacebookMessengerProperties
Retrieve a specific registred facebook messenger property:
SELECT * FROM FacebookMessengerProperties WHERE PageId='1732555047025799'
To register a new facebook messenger property you must specify PageId, ApplicationId, ApplicationSecret, PageName, PageAccessToken, CallbackVerifyToken, EndpointUrl and ApiVersion:
INSERT INTO FacebookMessengerProperties(PageId,ApplicationId,ApplicationSecret,PageName,PageAccessToken,EndpointUrl,CallbackVerifyToken,ApiVersion) VALUES('1732555047025799','1093076390764037','03d537gg656gvkbe9b430f002e9c4517','SFMC Engineers','someaccesstoken4fasdcruib213123knubkdnfisdubnu12312ub3pijnb','https://graph.facebook.com/v2.6/me/messages','this_is_the_verify_token','v2.0')
Name | Type | ReadOnly | References | Filters | Description |
PageId [KEY] | String | False | = |
The PageId of the Facebook Messenger property. | |
ApplicationId | String | False |
Facebook Application Id. | ||
ApplicationSecret | String | False |
Facebook Application Secret. | ||
PageName | String | False |
Facebook Page Name. | ||
PageAccessToken | String | False |
Access Token required to authenticate send messages requests to Facebook networks. | ||
CallbackVerifyToken | String | False |
Facebook Verify Token need to verify callback events. | ||
EndpointUrl | String | False |
Send API url of the Facebook network. | ||
IsActive | Boolean | False |
Indicate if the Facebook Messenger resource is active. | ||
ApiVersion | String | False |
The API version of the OTT property. |
Create, update and query journey activities.
Retrieve journey activities for the latest version of the specified journey:
SELECT * FROM JourneyActivities WHERE JourneyId='1cb643b5-3144-4d17-80fa-a1f0035e78e2'
Retrieve journey activities for a specific journey version:
SELECT * FROM JourneyActivities WHERE JourneyId='1cb643b5-3144-4d17-80fa-a1f0035e78e2' AND JourneyVersion=1
Retrieve journey activities from all journeys with a specific version:
SELECT * FROM JourneyActivities WHERE JourneyVersion=1
To create a new journey activity, you will need to specify at least the JourneyId, JourneyVersion, Type, Key, Arguments, ConfigurationArguments column.
INSERT INTO JourneyActivities(JourneyId,JourneyVersion,Type,Key,Arguments,ConfigurationArguments) VALUES('4753026f-20b2-481b-89c5-fcd76ffa41f7',1,'WAIT','WAITBYDURATION-1','{ "waitEndDateAttributeDataBound": "", "waitDefinitionId": "f3de0c9a-5ff8-4f7b-84bd-9309ca337227", "waitForEventId": "", "executionMode": "{{Context.ExecutionMode}}", "startActivityKey": "{{Context.StartActivityKey}}", "waitQueueId": "{{Context.WaitQueueId}}" }','{ "waitDuration": 1, "waitUnit": "DAYS", "specifiedTime": "", "timeZone": "", "description": "", "waitEndDateAttributeExpression": "", "specificDate": "", "waitForEventKey": "" }')
Journey activities may be modified by providing the Id, JourneyId, JourneyVersion and issuing an UPDATE statement.
Update JourneyActivities SET Description='First_Journey_Activity_Description', Outcomes='[ { "key": "11bb2807-3f3d-4305-af51-547df032dbaf", "next": "WAITBYDURATION-1", "arguments": null, "metaData": null } ]' WHERE Id='fa4c3d81-8043-40e2-9741-22708d3a2e25' AND JourneyId='4753026f-20b2-481b-89c5-fcd76ffa41f7' AND JourneyVersion=1
Name | Type | ReadOnly | References | Filters | Description |
Id [KEY] | String | True |
This is the Marketing Cloud-provided unique ID for this particular activity. | ||
JourneyId [KEY] | String | True |
Journeys.Id | = |
A unique identifier for this journey that is generated and assigned by the journey API during creation. |
JourneyVersion [KEY] | Integer | True |
Journeys.Version | = |
This number denotes the iteration of this particular journey. |
Key | String | False |
This is the customer key (journey-unique) for this particular activity. | ||
Name | String | False |
This is the display name for this activity, it will be shown in the Journey Builder UI. | ||
Description | String | False |
This is the description for this activity. | ||
Type | String | False |
This property defines what type of activity this is. The expected input for each activity must be passed as an argument to operate correctly. | ||
Outcomes | String | False |
This is a json array of 'outcome' objects. | ||
Arguments | String | False |
This is an object which represents the arguments this particular activity expects to be passed for use at runtime. Each activity type has its own unique argument parameters which are expected. | ||
ConfigurationArguments | String | False |
This is an object which represents the arguments this particular activity expects to be passed for use both at publish and runtime. Each activity type has its own unique argument parameters which are expected. |
Create, update, delete and query journeys.
Retrieve journeys with the most recent version:
SELECT * FROM Journeys
Retrieve a journey version:
SELECT * FROM Journeys WHERE ID='1cb643b5-3144-4d17-80fa-a1f0035e78e2' AND Version=1
Retrieve all journey versions:
SELECT * FROM Journeys WHERE MostRecentVersionOnly=false
Retrieve journeys with a specific tag:
SELECT * FROM Journeys WHERE Tag='First_Tag'
Retrieve journeys which have the specified search string inside the name or description:
SELECT * FROM Journeys WHERE NameOrDescription='Journey'
Retrieve journeys with specific work flow API version:
SELECT * FROM Journeys WHERE workFlowApiVersion=1
Retrieve journeys with specific version:
SELECT * FROM Journeys WHERE Version=1
Retrieve journeys with specific status:
SELECT * FROM Journeys WHERE Status='Draft'
Sort Journeys according to modifiedDate or name column:
SELECT * FROM Journeys Order BY ModifiedDate DESC SELECT * FROM Journeys Order BY Name DESC
To create a new journey, you will need to specify at least the Name column.
INSERT INTO Journeys(Name) VALUES('API-Created journey')
To create a new journey version, you will need to specify an existing journey key.
INSERT INTO Journeys(Name,Key) VALUES('API-Created journey Version 3','53bf5ea2-ff59-4c00-a23a-b1e9e333b80c')
Journeys may be modified by providing the Id, Version of the journey and issuing an UPDATE statement.
UPDATE Journeys SET Name='API-Updated journey' WHERE Id='257c51df-d6ed-4fb6-8fbc-70e63ed52b12' AND Version=5
Journeys may be deleted by providing the Id of the journey and issuing a DELETE statement.
DELETE FROM Journeys WHERE Id='53bf5ea2-ff59-4c00-a23a-b1e9e333b80c'
Journey versions may be deleted by providing the Id, Version of the journey and issuing a DELETE statement.
DELETE FROM Journeys WHERE Id='257c51df-d6ed-4fb6-8fbc-70e63ed52b12' AND Version=5
Name | Type | ReadOnly | References | Filters | Description |
Id [KEY] | String | True | = |
A unique identifier for this journey that is generated and assigned by the journey API during creation. | |
Version | Integer | True | = |
This number denotes the iteration of this particular journey. | |
Key | String | False |
The customer key (also a unique identifier within the MID) for this journey. | ||
Name | String | False |
The display name used in the Journey Builder UI for this journey, this will be visible to everyone who logs into your Marketing Cloud account. | ||
Status | String | False | = |
A status description upon which to filter journeys. 使用できる値は次のとおりです。Draft, Published, ScheduledToPublish, Stopped, Unpublished, Deleted | |
CreatedDate | Datetime | True |
The datetime when the journey was created. | ||
ModifiedDate | Datetime | True |
The datetime when the journey was updated. | ||
LastPublishedDate | Datetime | True |
The datetime when the journey was last published. | ||
Description | String | False |
The human readable description of this journey that informs others of purpose. | ||
WorkFlowApiVersion | Integer | False | = |
The version of work flow API. デフォルト値は1です。 | |
Tags | String | False |
Assigned tags to the journey. | ||
Goals | String | False |
This is an array of goals containing a single object. | ||
Triggers | String | False |
This is an array of triggers containing a single object. | ||
Defaults | String | False |
This object contains an ordered list of email expressions used to determine which email address to use as the default, starting with the first expression. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
MostRecentVersionOnly | Boolean |
A flag to indicate whether to fetch only the most recent version of matching journeys. デフォルト値はtrueです。 |
Tag | String |
Specify a single tag to filter results to only include journeys associated with that tag. |
NameOrDescription | String |
A search string inside the journey's name or description properties upon which to match for filtering. |
Query and create Line messenger properties.
Retrieve all registred line messenger properties:
SELECT * FROM LineMessengerProperties
Retrieve a specific registred line messenger property:
SELECT * FROM LineMessengerProperties WHERE ID='23493453984234345'
To register a new line messenger property you must specify ChannelId, ChannelName, ChannelSecret, IsTransactional, IsTestChannel, EndpointUrl and ApiVersion:
INSERT INTO LineMessengerProperties(ChannelId,ChannelName,ChannelSecret,EndpointUrl,IsTransactional,IsTestChannel,IsActive,ApiVersion) VALUES('23493453984234345','SFMC Engineers','03d537gg656gvkbe9b430f002e9c4517','https://example.com/1732555047025799',true,false,true,'v2.0')");
Name | Type | ReadOnly | References | Filters | Description |
ChannelId [KEY] | String | False | = |
The Id of the LINE Messenger property. | |
ChannelName | String | False |
LINE channel name. | ||
ChannelSecret | String | False |
LINE channel secret. | ||
CustomerConnectSecret | String | False |
LINE Customer Connect Secret needed for validating LINE inbound events when using Switcher API. | ||
IsTransactional | Boolean | False |
Indicate if LINE channel is Transactional or Reseller. | ||
IsTestChannel | Boolean | False |
Indicate if LINE channel is a Test channel. | ||
EndpointUrl | String | False |
Send API url of the LINE network. | ||
IsActive | Boolean | False |
Indicate if the LINE Messenger resource is active. | ||
ApiVersion | String | False |
The API version of the OTT property. |
Create, update, delete and query send definitions.
Retrieve all send definitions:
SELECT * FROM SendDefinitions
Retrieve a specific send definition:
SELECT * FROM SendDefinitions WHERE DefinitionKey = '9955614b-02e7-4147-91a2-3f5f5fe9d679'
Retrieve all send definitions with Status as 'Active':
SELECT * FROM SendDefinitions WHERE Status = 'Active'
To create a send definition, you will need to specify at least the DefinitionKey, Name, SubscriptionsList and ContentCustomerKey column.
INSERT INTO SendDefinitions (DefinitionKey, Name, ContentCustomerKey, SubscriptionsList, OptionsCc, OptionsCreateJourney) VALUES ('TEST_Definition_Key', 'Test Definition Key', '76ad3572-abbc-4baa-b3fe-04c4364bf34a', 'All Subscribers', '[email protected]', true)
To update a send definition, you will need to specify the DefinitionKey of the SendDefinition.
UPDATE SendDefinitions SET OptionsCc='[email protected],[email protected]', OptionsBcc='[email protected],[email protected]' WHERE DefinitionKey='TEST_Definition_Key'
Send definitions may be deleted by providing the Definition Key of the send definition and issuing a DELETE statement.
DELETE FROM SendDefinitions WHERE DefinitionKey='TEST_Definition_Key'
Name | Type | ReadOnly | References | Filters | Description |
DefinitionKey [KEY] | String | False | = |
Unique, user-generated key to access the definition object. | |
DefinitionId | String | True |
Unique Marketing Cloud object identifier. | ||
Classification | String | False |
Marketing Cloud external key of a sending classification defined in Email Studio Administration. Only transactional classifications are permitted. Default is default transactional. | ||
ContentCustomerKey | String | False |
Unique identifier of the content asset. | ||
CreatedDate | Datetime | True |
Date the definition was created. | ||
Description | String | False |
User-provided description of the send definition. | ||
Journey | Boolean | True |
Indicates whether the send definition is available in Journey Builder as a Transactional Send Journey. | ||
JourneyInteractionKey | String | True |
Unique ID of the Transactional Send Journey. | ||
ModifiedDate | Datetime | True |
Date and time the definition was most recently changed. | ||
Name | String | False |
Name of the definition. | ||
OptionsBcc | String | False |
Include BCC email addresses with every send. To dynamically BCC at send time, create a profile attribute and use the %%attribute%% syntax. | ||
OptionsCc | String | False |
Include CC email addresses with every send. To CC dynamically at send time, create a profile attribute and use the %%attribute%% syntax. | ||
OptionsTrackLinks | Boolean | False |
Wraps links for tracking and reporting. Default is true. | ||
OptionsCreateJourney | Boolean | False |
Defines the subscriber key or email address within a data extension. Required when defining a schema. | ||
RequestId | String | True |
The unique identifier of this request. | ||
Status | String | False | =,!= |
Operational state of the definition: active, inactive, or deleted. A message sent to an active definition is processed and delivered. A message sent to an inactive definition isn't processed or delivered. Instead, the message is queued for later processing for up to three days. | |
SubscriptionsAutoAddSubscriber | Boolean | False |
Adds the recipient's email address and contact key as a subscriber key to subscriptions.list. Default is true. | ||
SubscriptionsDataExtension | String | False |
Marketing Cloud external key of the triggered send data extension. Each request inserts as a new row in the data extension. | ||
SubscriptionsList | String | False |
Marketing Cloud external key of the list or all subscribers. Contains the subscriber keys and profile attributes. | ||
SubscriptionsUpdateSubscriber | Boolean | False |
For email only: Updates the recipient's contact key as a subscriber key with the provided email address and profile attributes to subscriptions.list. Default is true. |
Create, update, delete and query event notification subscriptions.
Select all subscriptions:
SELECT * FROM Subscriptions
Retrieve a specific subscription:
SELECT * FROM Subscriptions WHERE SubscriptionId=94766
To create a subscription, you will need to specify at least the SubscriptionName, CallbackId and EventCategoryTypes column.
INSERT INTO [Subscriptions] (SubscriptionName, CallbackId, EventCategoryTypes) VALUES ('sajli subscription', '6fb0758b-155d-4968-869d-7a4f5a3ad2fe', '[\"TransactionalSendEvents.EmailNotSent\", \"TransactionalSendEvents.EmailSent\"]')
Subscriptions may be modified by providing the SubscriptionId and the EventCategoryTypes column of the subscription and issuing an UPDATE statement.
UPDATE [Subscriptions] SET Status = 'paused', EventCategoryTypes = '[\"TransactionalSendEvents.EmailNotSent\", \"TransactionalSendEvents.EmailSent\"]' WHERE SubscriptionId = 'db1e2af0-807d-463b-96e8-fe3aaa019fdb'
Subscriptions may be deleted by providing the SubscriptionId of the subscription and issuing a DELETE statement.
DELETE FROM [Subscriptions] WHERE SubscriptionId = '43841979-7154-4fc4-9789-909dbba3a54f'
Name | Type | ReadOnly | References | Filters | Description |
SubscriptionId [KEY] | String | False | = |
The Id of the event notification subscription. | |
SubscriptionName | String | False |
The name of the event notification subscription. | ||
CallbackId | String | False |
Callbacks.CallbackId | = |
The Id of the event notification callback. |
CallbackName | String | False |
The name of the event notification callback. | ||
EventCategoryTypes | String | False |
Event category types. | ||
Filters | String | False |
Filters. | ||
Url | String | False |
The url of the event notification callback. | ||
MaxBatchSize | Integer | False |
Maximum batch size of the event notification callback. | ||
Status | String | False |
The status of the event notification callback. | ||
StatusReason | String | False |
The status reason of the event notification callback. |
ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます(その機能がデータソースに適用できる場合)。
ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。
ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。
Name | Description |
AssetTypes | Get all available asset types in Salesforce Marketing Cloud. |
CampaignAssets | Retrieve all campaign assets in Salesforce Marketing Cloud. |
Contact | Retrieve contacts in Salesforce Marketing Cloud. |
Contacts | Retrieve all contacts in Salesforce Marketing Cloud. |
JourneyAuditLogs | Retrieves an audit log of a journey and its versions. |
JourneyHistory | Gives the history of a journey |
SmsStatusCodes | Query sms status codes. |
TransactionalMessages | Gets a paginated list of messages that were not sent, ordered from oldest to newest. |
Get all available asset types in Salesforce Marketing Cloud.
Retrieve all asset types:
SELECT * FROM AssetTypes
Name | Type | References | Description |
Id [KEY] | Integer |
Assets.TypeId | The Id of the asset type. |
Name | String | The name of the asset type. | |
IsBaseAssetType | Boolean | Whether the asset type is a base asset type or not. | |
ParentId | Integer | The Id of the parent asset type. |
Retrieve all campaign assets in Salesforce Marketing Cloud.
Select all campaign assets for a specific campaign:
SELECT * FROM CampaignAssets WHERE CampaignId = '3130'
Retrieve a specific Campaign:
SELECT * FROM CampaignAssets WHERE CampaignId = '3130' AND Id = '3325'
Name | Type | References | Description |
Id [KEY] | Integer | The Id of the campaign asset. | |
CampaignId | Integer |
Campaigns.Id | CampaignId assosiated with the asset. |
Type | String | Type of the campaign asset. | |
ItemId | String | Internal object id. | |
CreatedDate | Datetime | The exact time when the asset was created. |
Retrieve contacts in Salesforce Marketing Cloud.
Retrieve all contacts:
SELECT * FROM ContactNote: Most columns for this table are dynamic so they may not be the same as the columns specified below because you can have a different Contact schema in your Salesforce marketing cloud account.
Name | Type | References | Description |
ContactID [KEY] | Int | The system defined identifier of the contact. | |
ContactKey | String | The user defined identifier of the contact. |
Retrieve all contacts in Salesforce Marketing Cloud.
Retrieve all contacts:
SELECT * FROM ContactsNote: Most columns for this table are dynamic so they may not be the same as the columns specified below because you can have a different Contact schema in your Salesforce marketing cloud account.
Name | Type | References | Description |
GroupConnect LINE Demographics.Address ID | String | This is an autogenerated description | |
GroupConnect LINE Demographics.Contact ID | Long | This is an autogenerated description | |
GroupConnect LINE Demographics.Contact Key | String | This is an autogenerated description | |
Contact.Contact ID [KEY] | Int | The system defined identifier of the contact. | |
Contact.Contact Key | String | The user defined identifier of the contact. | |
Email Demographics.Contacts ID | Long | This is an autogenerated description | |
Email Demographics.NewAttrTest | String | Test new attr | |
Email Demographics.NewAttrTest1 | String | New Attr test | |
Email Demographics.NewAttrTest 2 | String | NewAttrTest 2 | |
Email Demographics.tet | String | test | |
Email Addresses.Email Address | String | This is an autogenerated description | |
Email Addresses.HTML Enabled | Bool | This is an autogenerated description | |
MobileConnect Demographics.Contact ID | Long | This is an autogenerated description | |
MobileConnect Demographics.Locale | String | This is an autogenerated description | |
MobileConnect Demographics.Mobile Number | String | This is an autogenerated description | |
MobilePush Demographics.Application | String | This is an autogenerated description | |
MobilePush Demographics.Contact ID | Long | This is an autogenerated description | |
MobilePush Demographics.Device ID | String | This is an autogenerated description | |
Contact.Business Unit ID | Int | This is an autogenerated description | |
Email Addresses.Member ID | Int | This is an autogenerated description | |
Email Addresses.List ID | Int | This is an autogenerated description |
Retrieves an audit log of a journey and its versions.
Name | Type | References | Description |
JourneyId | String |
Journeys.Id | A unique identifier for this journey that is generated and assigned by the journey API during creation. |
JourneyVersion | Integer |
Journeys.Version | This number denotes the iteration of this particular journey. |
Key | String | The customer key (also a unique identifier within the MID) for this journey. | |
Action | String | The actions used to build your audit log.
使用できる値は次のとおりです。all, create, modify, publish, unpublish, delete デフォルト値はallです。 | |
Name | String | This is the display name for this activity, it will be shown in the Journey Builder UI. | |
Description | String | This is the description for the journey. | |
ActionDate | Datetime | The datetime of the action. | |
UserId | Integer | Id of user who performed the action. | |
UserName | String | Name of user who performed the action. | |
ExecutionMode | String | The execution mode in which the journey is running. | |
OriginalDefinitionId | String | The original definition Id of the journey. | |
PublishRequestId | String | The Id of the publish request. | |
PublishStatus | String | The status of the journey publication. | |
Errors | String | Errors occurred during the action. | |
ContactsEjected | String | Ejected Contacts when journey is stopped. |
Gives the history of a journey
Retrieves information about a specific contact, journey, or journey version.:
SELECT * FROM JourneyHistory
Name | Type | References | Description |
Id [KEY] | String | A unique identifier for this journeyhistory that is generated and assigned by the journey API when the journey is in running state. | |
ActivityBatchInstanceId | String | ActivityBatchInstanceId | |
ActivityId | String | A unique identifier for this activity that is generated and assigned by the journey API when the activity is created. | |
ActivityType | String | Type of Activity | |
ClientStatus | String | Client Status | |
ContactKey | String | The customer key (also a unique identifier within the MID) for this journey. | |
CreatedDate | Datetime | The datetime when the journey was created. | |
DefinitionId | String | Definition Id | |
DefinitionInstanceId | String | Definition Instance Id | |
DefinitionName | String | Definition Name | |
EpochTimeInMilliseconds | Long | Epoch Time In Milli Seconds | |
EventId | String | Event Id | |
EventName | String | Event Name | |
LongId | Integer | Id | |
Message | String | Message | |
Mid | Integer | MID | |
ResultMessages | String | Messages | |
ResultStatus | String | Status | |
ResultTags | String | Tags | |
Status | String | Status of Journey History | |
TransactionTime | Datetime | Transaction Time |
Query sms status codes.
Retrieve all status codes for the following countries: U.S., Canada, Brazil, and India. Use these codes to evaluate and troubleshoot your SMS sends.
SELECT * FROM SmsStatusCodes
Name | Type | References | Description |
Code [KEY] | Integer | The SMS code. | |
Status | String | The SMS status for the respective Code. | |
Definition | String | The definition for the SMS status Code. |
Gets a paginated list of messages that were not sent, ordered from oldest to newest.
Select all TransactionalMessages:
SELECT * FROM TransactionalMessages
Name | Type | References | Description |
LastEventId | Integer | The ID of the Event from which you want the response to start. | |
StatusCode | Integer | Integer value of the reason the send did not complete. Review Email Send Error Codes for more information. | |
StatusMessage | String | The reason the send did not complete. Review Email Send Error Codes for more information. | |
EventCategoryType | String | TransactionalSendEvent event type. EmailSent indicates that the email was sent to the email provider. EmailNotSent indicates that the email was not sent and includes the reason. EmailQueued indicates that the email has not yet been processed for sending. | |
Timestamp | String | Time the event occured in Central Standard Time (no daylight savings) | |
DefinitionKey | String | Unique identifier of the definition. | |
EventId | Integer | Numeric identifier of the event. | |
MessageKey | String | Unique identifier to track message send status. | |
ContactKey | String | Unique identifier for a subscriber in Marketing Cloud. | |
To | String | Channel address of the recipient. For email, it’s the recipient's email address. For SMS, it’s the recipient's mobile number. |
Sync App は、Salesforce Marketing Cloud SOAP API をデータベーステーブル およびビュー としてモデル化します。これらはスキーマファイルにて定義されます。スキーマファイルは、スキーマを簡単にカスタマイズできるシンプルなテキストベースのコンフィギュレーションファイルです。
このセクションでは、API の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。
テーブル では、利用可能なテーブルを説明します。テーブルは、Assets、Categories、Journeys などを静的にモデル化するように定義されています。
ビュー は変更ができないテーブルです。一般的に、読み取り専用のデータはビューとして表示されます。ストアドプロシージャを使用すると、オブジェクトのダウンロードやアップロードなど、Salesforce Marketing Cloud の操作を実行できます。
Sync App はSalesforce Marketing Cloud のデータを、標準のSQL ステートメントを使用してクエリできるテーブルのリストにモデル化します。
一般的には、Salesforce Marketing Cloud テーブルのクエリは、リレーショナルデータベースのテーブルのクエリと同じです。時には特別なケースもあります。例えば、テーブルの特定のカラムデータを取得するために特定のカラムをWHERE 句に含める必要がある場合などです。これは通常、特定のカラムを取得するために行ごとに個別のリクエストを行う必要がある場合に必要です。これらの特別な状況は、以下にリンクされているテーブルページの上部に明確に文書化されています。
Name | Description |
Account | A Marketing Cloud account. |
AccountUser | An individual user within an account. This table does not support deletes. |
BusinessUnit | A unit within a larger Enterprise or Enterprise 2.0 account. This table supports queries and updates only. |
ContentArea | A ContentArea represents a defined section of reusable content. |
DataExtension | Represents a data extension within an account. |
Represents an email in a Marketing Cloud account. | |
EmailSendDefinition | Record that contains the message information, sender profile, delivery profile, and audience information. |
FileTrigger | Reserved for future use. This table does not suport deletes. |
FilterDefinition | Defines an audience based on specified rules in a filter. This table does not support inserts. |
ImportDefinition | Defines a reusable pattern of import options. This table does not support inserts. |
List | A marketing list of subscribers. |
Portfolio | Indicates a file within the Portfolio of a Marketing Cloud account. |
ProgramManifestTemplate | Reserved for future use. This table does not support deletes or inserts. |
QueryDefinition | Represents a SQL query activity accessed and performed by the SOAP API. This table does not support updates or inserts. |
ReplyMailManagementConfiguration | Details configuration settings for the reply mail management in an account. This table does not support deletes. |
Send | Used to send email and retrieve aggregate data. This table does not support deletes or updates. |
SendClassification | Represents a send classification in a Marketing Cloud account. |
SenderProfile | The send profile used in conjunction with an email send definition. |
SMSTriggeredSend | Indicates a single instance of an SMS triggered send. This table does not support deletes or updates. |
Subscriber | A person subscribed to receive email or SMS communication. |
SuppressionListDefinition | A suppression list that can be associated with different contexts. |
TriggeredSendDefinition | To create or update a TriggeredSendDefinition where the list ID is the All Subs List ID, you need the Email | Subscribers | All Subscribers | View and SendEmailToList permissions. |
A Marketing Cloud account.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Account SELECT * FROM Account WHERE Id = 123 SELECT * FROM Account WHERE Id IN (123, 456) SELECT * FROM Account WHERE CreatedDate > '2017/01/25'
You must specify the Name column when executing an insert against this table.
INSERT INTO Account(Name) VALUES('Test')
You must specify the Id in the WHERE clause when executing an update against this table.
UPDATE Account SET Fax='1123123' WHERE Id=123
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Account WHERE Id = 123
Name | Type | ReadOnly | Description |
ID [KEY] | Int | False |
Identifier of the account. |
AccountType | String | False |
Type of Marketing Cloud account. 使用できる値は次のとおりです。BUSINESS_UNIT, CHANNEL_CONNECT, CONNECT, DOTO_MEMBER, ENTERPRISE_2, EXACTTARGET, LP_MEMBER, None, PRO_CONNECT, PRO_CONNECT_CLIENT |
ParentID | Int | False |
Specifies the ID number of the parent account for Lock and Publish, On Your Behalf, Enterprise, and Enterprise 2.0 account children and business units. |
BrandID | Int | False |
Specifies brand tags to use on an account. |
PrivateLabelID | Int | False |
Specifies the private label for an account. |
ReportingParentID | Int | False |
Reserved for future use. |
Name | String | False |
Name of the account. |
String | False |
Default email address the account. Indicates if subscriber information can be used for email sends. | |
FromName | String | False |
Specifies the default email message From Name. Deprecated for email send definitions and triggered send definitions. |
BusinessName | String | False |
Business name of an account's owner. |
Phone | String | False |
Specifies a phone number. |
Address | String | False |
The address used to communicate with a Person. |
Fax | String | False |
Fax number of the account's owner. |
City | String | False |
City of an account's owner to be displayed in the physical mailing address required at the bottom of all email messages. |
State | String | False |
Specifies the geographical state of the account's owner. |
Zip | String | False |
Specifies the zip code of the account's owner. |
Country | String | False |
Country of an account's owner, as displayed in the physical mailing address required at the bottom of all email messages. |
IsActive | Boolean | False |
Specifies whether or not the account is active. |
IsTestAccount | Bool | False |
Specifies whether or not an account is a 'Test' account. |
Client_ClientID1 | Int | True |
The Client Id of the client. |
DBID | Int | False |
Reserved for future use. |
CustomerID | Long | False |
Reserved for future use. |
DeletedDate | Datetime | True |
Date and time of an account's deletion. |
EditionID | Int | False |
Specifies the product edition of the account. |
ModifiedDate | Datetime | False |
Indicates the last time account information was modified. |
CreatedDate | Datetime | False |
Date and time of the account's creation. |
ParentName | String | False |
Specifies the name of the Parent account. |
Subscription_SubscriptionID | String | True |
Reserved for future use. |
Subscription_HasPurchasedEmails | Bool | True |
Reserved for future use. |
Subscription_EmailsPurchased | Int | True |
Specifies the number of emails purchased in a subscription. |
Subscription_Period | String | True |
Reserved for future use. |
Subscription_AccountsPurchased | Int | True |
Marketing Cloud Accounts purchased. |
Subscription_LPAccountsPurchased | Int | True |
Specifies the number of Lock and Publish account purchased. |
Subscription_DOTOAccountsPurchased | Int | True |
Specifies number of Marketing Cloud agency reseller accounts purchased. |
Subscription_BUAccountsPurchased | Int | True |
Defines the number of business units purchased for a subscription. |
Subscription_AdvAccountsPurchased | Int | True |
This property represents the number of advertising accounts purchased for the account. |
Subscription_BeginDate | Datetime | True |
Specifies the date a subscription begins. |
Subscription_EndDate | Datetime | True |
Specifies the end data of an activity. |
Subscription_Notes | String | True |
Deprecated. |
PartnerKey | String | False |
Unique identifier provided by partner for an account, accessible only via API. |
Client_PartnerClientKey | String | True |
The partner client key of the client. |
InheritAddress | Bool | False |
Specifies that an Enterprise 2.0 business unit will inherit the address from the parent business unit. |
UnsubscribeBehavior | Int | True |
The behavior of the subscription when unsubscripbed. |
Subscription_ContractNumber | String | True |
Reserved for future use. |
Subscription_ContractModifier | String | True |
Reserved for future use. |
IsTrialAccount | Bool | False |
Reserved for future use. |
Client_EnterpriseID | Long | True |
Read-only identifier the enterprise of the client. |
ParentAccount_ID | Int | False |
Read-only identifier for the parent of the account. |
ParentAccount_Name | String | True |
Name of the parent of the account. |
ParentAccount_ParentID | Int | True |
Read-only identifier for the parent of the parent of this account. |
ParentAccount_CustomerKey | String | True |
The customer key of the parent account. |
ParentAccount_AccountType | String | True |
The account type of the parent account. |
CustomerKey | String | False |
User-supplied unique identifier for an object within an object type. |
Locale_LocaleCode | String | True |
The locale code of the locale. |
TimeZone_ID | Int | True |
Read-only identifier of the timezone. |
TimeZone_Name | String | True |
Name of the timezone. |
Roles | String | False |
Collection of roles defined for an account. |
ContextualRoles | Int | True |
The contextual roles of the account. |
ObjectState | String | False |
Reserved for future use. |
LanguageLocale_LocaleCode | String | True |
The locale code of the language layout. |
IndustryCode | String | False |
The code of the industry. |
AccountState | Int | False |
The state of the account. |
SubscriptionRestrictionFlags | Long | False |
Restriction flags of the subscription. |
An individual user within an account. This table does not support deletes.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM AccountUser SELECT * FROM AccountUser WHERE Id = 123 SELECT * FROM AccountUser WHERE Id IN (123, 456) SELECT * FROM AccountUser WHERE CreatedDate > '2017/01/25'
You must specify the following fields when inserting to this table: Client_Id, Name, Email, UserID, and Password.
INSERT INTO AccountUser(Client_Id, UserId, Name, Email, Password) VALUES(123, 'bcabsbasbcasb', 'Test', '[email protected]', 'testpas@2sowrd')
You must specify the Id and the Client_Id in the WHERE clause when executing an update against this table.
UPDATE AccountUser SET Name='changed' WHERE Id=123 AND Client_Id=456
Name | Type | ReadOnly | Description |
ID [KEY] | Int | False |
Identifier for an object. |
CreatedDate | Datetime | False |
Date and time of the object's creation.. |
ModifiedDate | Datetime | False |
Indicates the last time object information was modified. |
Client_ID [KEY] | Int | False |
The Id of the client. |
AccountUserID | Int | False |
Specifies the Marketing Cloud identifier of an account user. |
UserID | String | False |
The Id of the user. |
Name | String | False |
Name of the object or property. |
String | False |
Default email address for object. Indicates if subscriber information can be used for email sends. | |
MustChangePassword | Bool | False |
Indicates whether user must change password on next login. |
ActiveFlag | Bool | False |
Specifies the status of an account user. |
ChallengePhrase | String | False |
Specifies the challenge answer for login assistance. |
ChallengeAnswer | String | False |
Specifies the challenge answer for login assistance. |
IsAPIUser | Bool | False |
Indicates if a user can use the API. A value of true indicates the user's password remains the same until actively changed. |
NotificationEmailAddress | String | False |
Indicates email address to which to send notifications. |
Client_PartnerClientKey | String | False |
The partner client key of the partner. |
Password | String | False |
Specified the password of an account user. |
Locale_LocaleCode | String | True |
The locale code of the locale. |
TimeZone_ID | Int | True |
The id of the timezone. |
TimeZone_Name | String | True |
The name of the timezone. |
CustomerKey | String | False |
User-supplied unique identifier for an object within an object type. |
DefaultBusinessUnit | Int | False |
Indicates business unit account user initially accesses. |
LanguageLocale_LocaleCode | String | True |
The locale code of the language locale. |
Client_ModifiedBy | Int | False |
Returns user ID for user who modified the object. |
A unit within a larger Enterprise or Enterprise 2.0 account. This table supports queries and updates only.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM BusinessUnit SELECT * FROM BusinessUnit WHERE Id = 123 SELECT * FROM BusinessUnit WHERE Id IN (123, 456) SELECT * FROM BusinessUnit WHERE CreatedDate > '2017/01/25'
You must specify the Id in the WHERE clause when executing an update against this table.
UPDATE BusinessUnit SET Name='Changed' WHERE Id=123
Name | Type | ReadOnly | Description |
ID [KEY] | Int | False |
Identifier for an object. |
AccountType | String | False |
Type of Marketing Cloud account. Valid values are BUSINESS_UNIT, CHANNEL_CONNECT, CONNECT, DOTO_MEMBER, ENTERPRISE_2, EXACTTARGET, LP_MEMBER, None, PRO_CONNECT, PRO_CONNECT_CLIENT. |
ParentID | Int | False |
Specifies the ID number of the parent account. |
BrandID | Int | False |
Specifies brand tags to use on an account. |
PrivateLabelID | Int | False |
Specifies the private label for an account. |
ReportingParentID | Int | False |
Reserved for future use.. |
Name | String | False |
Name of the object or property. |
String | False |
Default email address for object. | |
FromName | String | False |
Specifies the default email message From Name. |
BusinessName | String | False |
Business name of an account's owner. |
Phone | String | False |
Specifies a phone number. |
Address | String | False |
The address used to communicate with a Person. |
Fax | String | False |
Fax number of the account's owner. |
City | String | False |
City of an account's owner to be displayed in the physical mailing address required at the bottom of all email messages. |
State | String | False |
Specifies the geographical state of the account's owner. |
Zip | String | False |
Specifies the zip code of the account's owner. |
Country | String | False |
Country of an account's owner, as displayed in the physical mailing address required at the bottom of all email messages. |
IsActive | Bool | False |
Specifies whether or not the object is active. |
IsTestAccount | Bool | False |
Specifies whether or not an account is a 'Test' account. |
Client_ID | Int | False |
The Id of the client. |
DBID | Int | False |
Reserved for future use. |
CustomerID | Long | False |
The Id of the customer. |
DeletedDate | Datetime | False |
Date and time of an account's deletion (the value of this property must be set before the account can be deleted). |
EditionID | Int | False |
Specifies the product edition of the account. |
IsTrialAccount | Bool | False |
Reserved for future use. |
Locale_LocaleCode | String | True |
The locale code of the locale. |
Client_EnterpriseID | Long | True |
The enterprise Id of the client. |
ModifiedDate | Datetime | False |
Indicates the last time object information was modified. |
CreatedDate | Datetime | False |
Date and time of the object's creation. |
Subscription_SubscriptionID | String | True |
The subscription id of the subscription. |
Subscription_HasPurchasedEmails | Bool | True |
Reserved for future use.. |
Subscription_EmailsPurchased | Int | True |
Specifies the number of emails purchased in a subscription.. |
Subscription_Period | String | True |
Reserved for future use.. |
Subscription_AccountsPurchased | Int | True |
Marketing Cloud Accounts purchased. |
Subscription_LPAccountsPurchased | Int | True |
Specifies the number of Lock and Publish account purchased. |
Subscription_DOTOAccountsPurchased | Int | True |
Specifies number of Marketing Cloud agency reseller accounts purchased. |
Subscription_BUAccountsPurchased | Int | True |
Defines the number of business units purchased for a subscription. |
Subscription_AdvAccountsPurchased | Int | True |
This property represents the number of advertising accounts purchased for the account. |
Subscription_BeginDate | Datetime | True |
Specifies the date a subscription begins.. |
Subscription_EndDate | Datetime | True |
Specifies the end data of an activity.. |
Subscription_Notes | String | True |
Deprecated.. |
Subscription_ContractNumber | String | True |
Reserved for future use.. |
Subscription_ContractModifier | String | True |
Reserved for future use.. |
PartnerKey | String | False |
Unique identifier provided by partner for an object, accessible only via API. |
Client_PartnerClientKey | String | True |
Unique identifier provided by partner for an object, accessible only via API. |
ParentName | String | False |
Specifies the name of the Parent account. |
ParentAccount_ID | Int | True |
The Id of the parent account. |
ParentAccount_Name | String | True |
The name of the parent account. |
CustomerKey | String | False |
User-supplied unique identifier for an object within an object type. |
Description | String | False |
Describes and provides information regarding the object. |
DefaultSendClassification_ObjectID | String | True |
System-controlled, read-only text string identifier for object. |
DefaultHomePage_ID | String | True |
The Id of the default home page.. |
InheritAddress | Bool | False |
Specifies that an Enterprise 2.0 business unit will inherit the address from the parent business unit. |
ContextualRoles | Int | True |
The contextual roles of the business unit. |
LanguageLocale_LocaleCode | String | True |
The locale code of the language locale. |
A ContentArea represents a defined section of reusable content.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ContentArea SELECT * FROM ContentArea WHERE Id = 123 SELECT * FROM ContentArea WHERE Id IN (123, 456) SELECT * FROM ContentArea WHERE CreatedDate > '2017/01/25'
You must specify the following fields when inserting to this table: Name and Content.
INSERT INTO ContentArea(Name, Content) VALUES('Testing', 'Hello world')
You must specify the Id in the WHERE clause when executing an update against this table.
UPDATE ContentArea SET Name='Changed' WHERE Id=123
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM ContentArea WHERE Id = 123
Name | Type | ReadOnly | Description |
RowObjectID | String | False |
Identifier for the row of an object. |
ObjectID | String | False |
System-controlled, text string identifier for object. |
ID [KEY] | Int | False |
Identifier for an object. |
CustomerKey | String | False |
User-supplied unique identifier for an object within an object type. |
Client_ID | Int | False |
The Id of the client. |
ModifiedDate | Datetime | False |
Indicates the last time object information was modified. |
CreatedDate | Datetime | False |
Date and time of the object's creation. |
CategoryID | Int | False |
Specifies the identifier of the folder containing the email. |
Name | String | False |
Name of the object or property. |
Layout | String | False |
Indicates layout type of content area. |
IsDynamicContent | Bool | False |
Indicates if specific content area contains dynamic content. |
Content | String | False |
Identifies content contained in a content area. |
IsSurvey | Bool | False |
Indicates whether a specific content area contains survey questions. |
IsBlank | Bool | False |
Indicates if specified content area contains no content. |
Key | String | False |
Specifies key associated with content area in HTML body. |
Represents a data extension within an account.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM DataExtension SELECT * FROM DataExtension WHERE CreatedDate > '2017/01/25'
You must specify the following fields when inserting to this table: Name, CustomerKey, and Fields.
Note: The Salesforce Marketing Cloud APIs have problems with DataExtensions with names longer than 40 characters. Try to limit the name to something relatively short.
INSERT INTO DataExtension (Name, CustomerKey, Fields) VALUES('TestName', 'TestCustomerKey', 'fieldname1;fieldname2;fieldname3')
You must specify the ObjectId or CustomerKey or Name in the WHERE clause when executing an update against this table.
UPDATE DataExtension SET ResetRetentionPeriodOnImport=true WHERE ObjectId='nzxcaslkjd-123'
You must specify the ObjectId or CustomerKey or Name in the WHERE clause when executing a delete against this table.
DELETE FROM DataExtension WHERE ObjectId = 'nzxcaslkjd-123'
Name | Type | ReadOnly | Description |
ObjectID [KEY] | String | False |
System-controlled, text string identifier for object. |
PartnerKey | String | False |
Unique identifier provided by partner for an object, accessible only via API. |
CustomerKey | String | False |
User-supplied unique identifier for an object within an object type. |
Name | String | False |
Name of the object or property. |
CreatedDate | Datetime | False |
Date and time of the object's creation. |
ModifiedDate | Datetime | False |
Indicates the last time object information was modified. |
Client_ID | Int | False |
The Id of the client. |
Description | String | False |
Describes and provides information regarding the object. |
IsSendable | Bool | False |
Indicates whether you can use a data extension as part of an audience for a message send. |
IsTestable | Bool | False |
Indicates whether a sendable data extension can be used within tests sends for a message. |
SendableDataExtensionField_Name | String | False |
The name of the sendable data extension field. |
SendableSubscriberField_Name | String | False |
The name of the sendablesubscriber field. |
Template_CustomerKey | String | False |
User-supplied unique identifier for an object within an object type. |
CategoryID | Long | False |
Specifies the identifier of the folder. |
Status | String | False |
Defines status of the object. |
IsPlatformObject | Bool | False |
Indicated whether the object is a platform object. |
DataRetentionPeriodLength | Int | False |
Specifies the number of time units for which data will be retained. |
DataRetentionPeriodUnitOfMeasure | Int | False |
Specifies the units of time for which data will be retained. |
RowBasedRetention | Bool | False |
Indicates whether the data retention policy removes data by row or by entire data extension. |
ResetRetentionPeriodOnImport | Bool | False |
Indicates whether a data retention period should be reset after a successful import of new data. |
DeleteAtEndOfRetentionPeriod | Bool | False |
Indicates whether data should be deleted at the end of the retention period. |
RetainUntil | String | False |
Indicates the date that ends the retention period for a data extension. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Fields | String |
A semi-colon separated list of names for the fields to add to this data entension. |
Represents an email in a Marketing Cloud account.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Email SELECT * FROM Email WHERE Id = 123 SELECT * FROM Email WHERE Id IN (123, 456) SELECT * FROM Email WHERE CreatedDate > '2017/01/25'
You must specify the following fields when inserting to this table: Name and Subject.
INSERT INTO Email(Name, Subject) VALUES('Testing', 'Greetings')
You must specify the Id in the WHERE clause when executing an update against this table.
UPDATE Email SET Name='Changed' WHERE Id=31558
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Email WHERE Id = 123
Name | Type | ReadOnly | Description |
ID [KEY] | Int | False |
Identifier for an object. |
PartnerKey | String | False |
Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | False |
Indicates the date and time of the object's creation. |
ModifiedDate | Datetime | False |
Indicates the last time object information was modified. |
Client_ID | Int | False |
The Id of the client. |
Name | String | False |
Name of the object or property. |
PreHeader | String | False |
Contains text used in preheader of email message on mobile devices. |
Folder | String | False |
Specifies folder information (Retrieve only) - Deprecated. |
CategoryID | Int | False |
Specifies the identifier of the folder containing the email. |
HTMLBody | String | False |
Contains HTML body of an email message. |
TextBody | String | False |
Contains raw text body of a message. |
Subject | String | False |
Defines the subject of an object. |
IsActive | Bool | False |
Specifies whether or not the object is active. |
IsHTMLPaste | Bool | False |
Indicates whether email message was created via pasted HTML. |
ClonedFromID | Int | False |
ID of email message from which the specified email message was created. |
Status | String | False |
Defines the status of an object. |
EmailType | String | False |
Defines the preferred email type. |
CharacterSet | String | False |
Indicates encoding used in an email message. |
HasDynamicSubjectLine | Bool | False |
Indicates whether email message contains a dynamic subject line. |
ContentCheckStatus | String | False |
Indicates whether content validation has completed for this email message. |
Client_PartnerClientKey | String | False |
User-defined partner key for an account. |
ContentAreas | String | False |
Contains information on content areas included in an email message. |
CustomerKey | String | False |
User-supplied unique identifier for an object within an object type. |
Record that contains the message information, sender profile, delivery profile, and audience information.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM EmailSendDefinition SELECT * FROM EmailSendDefinition WHERE ObjectID = 123 SELECT * FROM EmailSendDefinition WHERE ObjectID IN (123, 456) SELECT * FROM EmailSendDefinition WHERE CreatedDate > '2017/01/25'
You must specify the following fields when inserting to this table: Name, SendClassification_CustomerKey, and Email_Id.
INSERT INTO EmailSendDefinition(Name, SendClassification_CustomerKey, Email_Id) VALUES('Testing', 13507, 31677)
You must specify the Id in the WHERE clause when executing an update against this table.
UPDATE EmailSendDefinition SET Description='Changed' WHERE ObjectId='acasascas'
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM EmailSendDefinition WHERE ObjectId = 'sdfsdf123'
Name | Type | ReadOnly | Description |
Client_ID | Int | True |
The Id of the client. |
CreatedDate | Datetime | False |
Indicates the date and time of the object's creation. |
ModifiedDate | Datetime | False |
Indicates the last time object information was modified. |
ObjectID | String | False |
System-controlled, text string identifier for object. |
CustomerKey | String | False |
User-supplied unique identifier for an object within an object type. |
Name | String | False |
Name of the object or property. |
CategoryID | Int | False |
Specifies the identifier of the folder containing the email. |
Description | String | False |
Describes and provides information regarding the object. |
SendClassification_CustomerKey | String | False |
User-supplied unique identifier for an object within an object type. |
SenderProfile_CustomerKey | String | True |
User-supplied unique identifier for an object within an object type |
SenderProfile_FromName | String | True |
Specifies the default email message From Name. |
SenderProfile_FromAddress | String | True |
Indicates From address associated with a object. |
DeliveryProfile_SourceAddressType | String | True |
Indicates the source IP address type used with the delivery profile. |
DeliveryProfile_PrivateIP | String | True |
Contains information on the private IP address associated with a delivery profile. |
DeliveryProfile_DomainType | String | True |
Defines the type of domain. |
DeliveryProfile_PrivateDomain | String | True |
Defines private domain to use as part of a delivery profile or send definition. |
DeliveryProfile_HeaderSalutationSource | String | True |
Defines source of header salutation for a delivery profile or send definition. |
DeliveryProfile_FooterSalutationSource | String | True |
Defines source of a footer salutation to use as part of a delivery profile or send definition (Default, ContentLibrary, or None). |
SuppressTracking | Bool | False |
Indicates whether the send definition suppresses tracking results for associated sends. |
IsSendLogging | Bool | False |
Indicates whether send logging is enabled for the specified send definition |
Email_ID | Int | True |
The Id of the email. |
CCEmail | String | False |
Carbon copy email address. |
BccEmail | String | False |
Indicates email addresses to receive blind carbon copy of a message. |
AutoBccEmail | String | False |
Defines blind carbon copy email address to which to send a message as part of an email send definition. |
TestEmailAddr | String | False |
Defines an email address to which to send a test message as part of an email send definition. |
EmailSubject | String | False |
Subject of the email. |
DynamicEmailSubject | String | False |
Contains content to be used in a dynamic subject line. |
IsMultipart | Bool | False |
Indicates whether the email is sent with Multipart/MIME enabled. |
IsWrapped | Bool | False |
Indicates whether an email send contains the links necessary to process tracking information for clicks. |
SendLimit | Int | False |
Indicates limit of messages to send as part of a send definition within a predefined send window. |
DeduplicateByEmail | Bool | False |
Indicates whether a send definition should de-duplicate multiple emails sent to the same email address. |
ExclusionFilter | String | False |
Contains a string of AMPscript that can evaluate to true or false, used to exclude email addresses from a send definition. |
Additional | String | False |
The ID for a send that customers use as a campaign ID. |
IsPlatformObject | Bool | False |
Indicated whether the object is a platform object. |
Reserved for future use. This table does not suport deletes.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM FileTrigger SELECT * FROM FileTrigger WHERE CreatedDate > '2017/01/25'
You must specify the following fields when inserting to this table: Name.
INSERT INTO FileTrigger(Name) VALUES('Testing')
You must specify the ObjectId in the WHERE clause when executing an update against this table.
UPDATE FileTrigger SET Name='Changed' WHERE ObjectId='nzxcaslkjd-123'
Name | Type | ReadOnly | Description |
ObjectID [KEY] | String | False |
System-controlled, text string identifier for object. |
CustomerKey | String | False |
User-supplied unique identifier for an object within an object type. |
Client_ID | Long | False |
The Id of the client. |
ExternalReference | String | False |
Reserved for future use. |
Name | String | False |
Name of the object or property. |
Description | String | False |
Describes and provides information regarding the object. |
Type | String | False |
Indicates type of specific list. Valid values include Public, Private, Salesforce, GlobalUnsubscribe, and Master. |
Status | String | False |
Defines status of the object. |
StatusMessage | String | False |
Describes the status of an API call. |
RequestParameterDetail | String | False |
Reserved for future use. |
ResponseControlManifest | String | False |
Reserved for future use. |
FileName | String | False |
Indicates name of file associated with the object. |
LastPullDate | Datetime | False |
Reserved for future use. |
ScheduledDate | Datetime | False |
Reserved for future use. |
IsActive | Bool | False |
Specifies whether or not the object is active. |
CreatedDate | Datetime | False |
Indicated the date and time of the object's creation. |
ModifiedDate | Datetime | False |
Indicates the last time object information was modified. |
Client_CreatedBy | Int | False |
Returns user ID for user who created object |
Client_ModifiedBy | Int | False |
Returns user ID for user who modified object. |
Defines an audience based on specified rules in a filter. This table does not support inserts.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM FilterDefinition SELECT * FROM FilterDefinition WHERE CreatedDate > '2017/01/25'
You must specify the ObjectId in the WHERE clause when executing an update against this table.
UPDATE FilterDefinition SET Name='Changed' WHERE ObjectId='nzxcaslkjd-123'
You must specify the ObjectId in the WHERE clause when executing a delete against this table.
DELETE FROM FilterDefinition WHERE Object='nzxcaslkjd-123'
Name | Type | ReadOnly | Description |
ObjectID [KEY] | String | False |
System-controlled, text string identifier for object. |
Client_ID | Int | True |
The Id of the client. |
Client_ClientPartnerKey | Int | True |
User-defined partner key for an account. |
Name | String | False |
Name of the object or property. |
CustomerKey | String | False |
User-supplied unique identifier for an object within an object type. |
CreatedDate | Datetime | False |
Indicated the date and time of the object's creation. |
ModifiedDate | Datetime | False |
Indicates the last time object information was modified. |
Description | String | False |
Describes and provides information regarding the object. |
DataSource_ID | Int | True |
Read-only identifier for an object. |
DataSource_ObjectID | String | True |
System-controlled, read-only text string identifier for object. |
DataSource_Name | Int | True |
Name of the object or property. |
DataSource_ListName | Int | True |
The list name of the data source. |
DataSource_CustomerKey | String | True |
User-supplied unique identifier for an object within an object type. |
DataSource_CreatedDate | Datetime | True |
Read-only date and time of the object's creation. |
DataSource_ModifiedDate | Datetime | True |
Indicates the last time object information was modified. |
DataFilter | String | False |
Filter parts for a filter definition. |
Defines a reusable pattern of import options. This table does not support inserts.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ImportDefinition SELECT * FROM ImportDefinition WHERE ObjectID = 'nzxcaslkjd-123' SELECT * FROM ImportDefinition WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456') SELECT * FROM ImportDefinition WHERE CreatedDate > '2017/01/25'
You must specify the ObjectId in the WHERE clause when executing an update against this table.
UPDATE ImportDefinition SET Name='Changed' WHERE ObjectId='nzxcaslkjd-123'
You must specify the ObjectId in the WHERE clause when executing a delete against this table.
DELETE FROM ImportDefinition WHERE ObjectId='nzxcaslkjd-123'
Name | Type | ReadOnly | Description |
ObjectID [KEY] | String | False |
System-controlled, text string identifier for object. |
PartnerKey | String | False |
Unique identifier provided by partner for an object, accessible only via API. |
Client_ClientID1 | Int | False |
The client Id of the client. |
Name | String | False |
Name of the object or property. |
CustomerKey | String | False |
User-supplied unique identifier for an object within an object type. |
Description | String | False |
Describes and provides information regarding the object. |
FileSpec | String | False |
Defines the file-naming pattern associated with an activity (valid substitutions include%%YEAR%%, %%MONTH%%, and %%DAY%%). |
AllowErrors | Bool | False |
Specifies whether an import should continue after an error occurs. |
FieldMappingType | String | False |
Defines how fields are mapped within an import definition. |
FileType | String | False |
Specifies column delimiter of a file (CSV, TAB, or Other). |
UpdateType | String | False |
Indicates update type associated with an import definition. |
MaxFileAge | Int | False |
Specifies the age of the oldest file to be included in an import definition. |
MaxFileAgeScheduleOffset | Int | False |
Specifies an offset in hours to associate with a file age for accomodating timezone differences. |
MaxImportFrequency | Int | False |
Specifies the number of hours to wait before allowing a file to be imported again. |
DestinationObject_ID | Int | False |
Identifier for an object. |
DestinationObject_ObjectID | String | False |
System-controlled, text string identifier for object. |
Notification_ResponseType | String | True |
The response type of the notification. |
Notification_ResponseAddress | String | False |
The response address of the notification. |
RetrieveFileTransferLocation_ObjectID | String | False |
System-controlled, text string identifier for object. |
Delimiter | String | False |
Specifies the delimiter used as part of an import definition. |
HeaderLines | Int | False |
Specifies the number of lines in the file that are header lines that should not be processed. |
EndOfLineRepresentation | String | False |
Specifies the line-ending character(s) used in delimited files to be imported. |
NullRepresentation | String | False |
Defines character used to represent a null value during an import. |
StandardQuotedStrings | Bool | False |
Specifies whether standard quoted strings are used as part of an import definition. |
DateFormattingLocale_LocaleCode | String | False |
The locale code of the date formatting locale. |
A marketing list of subscribers.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM List SELECT * FROM List WHERE Id = 123 SELECT * FROM List WHERE Id IN (123, 456) SELECT * FROM List WHERE CreatedDate > '2017/01/25'
You must specify the following field when inserting to this table: ListName.
INSERT INTO List(ListName) VALUES('Test')
You must specify the Id in the WHERE clause when executing an update against this table.
UPDATE List SET ListName='Changed' WHERE Id=123
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM List WHERE Id = 123
Name | Type | ReadOnly | Description |
ID [KEY] | Int | False |
Identifier for an object. |
ObjectID | String | False |
System-controlled, text string identifier for object. |
PartnerKey | String | False |
Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | False |
Indicates the date and time of the object's creation. |
ModifiedDate | Datetime | False |
Indicates the last time object information was modified. |
Client_ID | Int | False |
The Id of the client. |
Client_PartnerClientKey | String | False |
User-defined partner key for an account. |
ListName | String | False |
Name of a specific list. |
Description | String | False |
Describes and provides information regarding the object. |
Category | Int | False |
ID of the folder that an item is located in. |
Type | String | False |
Indicates type of specific list. Valid values include Public, Private, Salesforce, GlobalUnsubscribe, and Master. |
CustomerKey | String | False |
User-supplied unique identifier for an object within an object type. |
ListClassification | String | True |
Specifies the classification for a list. |
AutomatedEmail_ID | Int | False |
Identifier for an object. |
Indicates a file within the Portfolio of a Marketing Cloud account.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Portfolio SELECT * FROM Portfolio WHERE ObjectID = 'nzxcaslkjd-123' SELECT * FROM Portfolio WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456') SELECT * FROM Portfolio WHERE CreatedDate > '2017/01/25'
You must specify the following fields when inserting to this table: DisplayName, FileName, CustomerKey, and Source_URN.
INSERT INTO Portfolio (DisplayName, FileName, CustomerKey, Source_URN) VALUES('portdisplayname', 'portfilename.jpg', 'portcuskey', 'https://example.com/image.jpg')
You must specify the ObjectID in the WHERE clause when executing an update against this table.
UPDATE Portfolio SET DisplayName='ChangedDisplayName' WHERE ObjectID='nzxcaslkjd-123'
You must specify the ObjectID in the WHERE clause when executing a delete against this table.
DELETE FROM Portfolio WHERE ObjectID='nzxcaslkjd-123'
Name | Type | ReadOnly | Description |
RowObjectID | String | False |
Identifier for the row of an object. |
ObjectID [KEY] | String | False |
System-controlled, text string identifier for object. |
PartnerKey | String | False |
Unique identifier provided by partner for an object, accessible only via API. |
CustomerKey | String | False |
User-supplied unique identifier for an object within an object type. |
Client_ID | Int | False |
The Id of the client. |
CategoryID | Int | False |
Specifies the identifier of the folder containing the email. |
FileName | String | False |
Indicates name of file associated with the object. |
DisplayName | String | False |
Name to be displayed for an item within a Portfolio. |
Description | String | False |
Describes and provides information regarding the object. |
TypeDescription | String | False |
Describes type for a Portfolio object. |
IsUploaded | Bool | False |
Indicates whether the Portfolio object in question was uploaded. |
IsActive | Bool | False |
Specifies whether or not the object is active. |
FileSizeKB | Int | False |
Specifies file size of a Portfolio item. |
ThumbSizeKB | Int | False |
Indicates size of a thumbnail image associated with a Portfolio object. |
FileWidthPX | Int | False |
Specifies the width of a Portfolio image in pixels. |
FileHeightPX | Int | False |
Specifies height of image contained in Portfolio (value) |
FileURL | String | False |
Specifies the URL at which a Portfolio file is stored. |
ThumbURL | String | False |
Indicates URL of a thumbnail image associated with a Portfolio object. |
CacheClearTime | Datetime | False |
Reserved for future use. |
CategoryType | String | False |
Defines whether a folder within a Portfolio is shared to other account users or not. Valid values are shared_portfolio, media. |
CreatedDate | Datetime | False |
Indicated the date and time of the object's creation. |
CreatedBy | Int | False |
The Id of the user who created the Portfolio. |
ModifiedBy | Int | False |
The id of the user who modified the Portfolio. |
ModifiedDate | Datetime | False |
Indicates the last time object information was modified. |
ModifiedByName | String | True |
The name of the user who modified the Portfolio. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Source_URN | String |
A URN (uniform resource name) of the location of the source. |
Reserved for future use. This table does not support deletes or inserts.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ProgramManifestTemplate SELECT * FROM ProgramManifestTemplate WHERE ObjectID = 'nzxcaslkjd-123' SELECT * FROM ProgramManifestTemplate WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-123') SELECT * FROM ProgramManifestTemplate WHERE CreatedDate > '2017/01/25'
You must specify the ObjectID in the WHERE clause when executing an update against this table.
UPDATE ProgramManifestTemplate SET Content='ChangedContent' WHERE ObjectID='nzxcaslkjd-123'
Name | Type | ReadOnly | Description |
ObjectID [KEY] | String | False |
System-controlled, read-only text string identifier for object. |
CustomerKey | String | False |
User-supplied unique identifier for an object within an object type. |
Client_ID | Long | False |
The Id of the client. |
Name | String | False |
Name of the object or property. |
Description | String | False |
Describes and provides information regarding the object. |
Type | String | False |
Indicates type of specific list. Valid values include Public, Private, Salesforce, GlobalUnsubscribe, and Master. Indicates the type of email to send to the address. Valid values include Text and HTML. |
OperationType | String | False |
Specifies metadata about the type of operation to perform. |
Content | String | False |
Identifies content contained in a content area. |
IsActive | Bool | False |
Specifies whether or not the object is active. |
CreatedDate | Datetime | False |
Read-only date and time of the object's creation. |
ModifiedDate | Datetime | False |
Indicates the last time object information was modified. |
Represents a SQL query activity accessed and performed by the SOAP API. This table does not support updates or inserts.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM QueryDefinition SELECT * FROM QueryDefinition WHERE ObjectID = 'nzxcaslkjd-123' SELECT * FROM QueryDefinition WHERE ObjectID IN ('nzxcaslkjd-123', 456) SELECT * FROM QueryDefinition WHERE CreatedDate > '2017/01/25'
You must specify the ObjectID in the WHERE clause when executing a delete against this table.
DELETE FROM QueryDefinition WHERE ObjectID = 'nzxcaslkjd-123'
Name | Type | ReadOnly | Description |
ObjectID [KEY] | String | False |
System-controlled, text string identifier for object. |
Client_ID | Int | False |
The Id of the client. |
Name | String | False |
Name of the object or property. |
CustomerKey | String | False |
User-supplied unique identifier for an object within an object type. |
Description | String | False |
Describes and provides information regarding the object. |
QueryText | String | False |
Specifies text associated with a query definition. |
TargetType | String | False |
Indicates target type for a query definition. |
DataExtensionTarget_Name | String | False |
Name of the object or property. |
DataExtensionTarget_CustomerKey | String | False |
User-supplied unique identifier for an object within an object type |
DataExtensionTarget_Description | String | False |
Describes and provides information regarding the object. |
TargetUpdateType | String | False |
Indicates the target update type for a query definition. |
FileType | String | False |
Specifies column delimiter of a file (CSV, TAB, or Other). |
FileSpec | String | False |
Defines the file-naming pattern associated with an activity (valid substitutions include%%YEAR%%, %%MONTH%%, and %%DAY%%). |
Status | String | False |
Defines status of object. |
CreatedDate | Datetime | False |
Indicated the date and time of the object's creation. |
ModifiedDate | Datetime | False |
Indicates the last time object information was modified. |
CategoryID | Int | False |
Specifies the identifier of the folder containing the email. |
Details configuration settings for the reply mail management in an account. This table does not support deletes.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ReplyMailManagementConfiguration SELECT * FROM ReplyMailManagementConfiguration WHERE Id = 123 SELECT * FROM ReplyMailManagementConfiguration WHERE Id IN (123, 456) SELECT * FROM ReplyMailManagementConfiguration WHERE CreatedDate > '2017/01/25'
You must specify the following fields when inserting to this table: EmailDisplayName and EmailReplyAddress.
INSERT INTO ReplyMailManagementConfiguration(EmailDisplayName, EmailReplyAddress) VALUES('Test', '[email protected]')
You must set a new value for EmailReplyAddress when executing an update against this table, and also supply its Id.
UPDATE ReplyMailManagementConfiguration SET EmailReplyAddress='[email protected]' WHERE Id = 123
Name | Type | ReadOnly | Description |
ID [KEY] | Int | False |
Identifier for an object. |
Client_ID | Int | True |
The Id of the client. |
EmailDisplayName | String | False |
Specifies the From name associated with the From email address as part of reply mail management configuration. |
ReplySubdomain | String | False |
Specifies subdomain associated with a reply mail management subdomain. |
EmailReplyAddress | String | False |
Specifies forwarding address for inbound emails resulting from a send. |
CreatedDate | Datetime | False |
Indicates the date and time of the object's creation. |
ModifiedDate | Datetime | False |
Indicates the last time object information was modified. |
DNSRedirectComplete | Bool | False |
Specifies whether a reply domain's DNS has been redirected to the Marketing Cloud IP addresses. |
DeleteAutoReplies | Bool | False |
Specifies whether auto-replies to a send should be deleted instead of forwarded to the RMM-configured email address. |
SupportUnsubscribes | Bool | False |
Indicates whether a reply mail management configuration allows subscribers to unsubscribe. |
SupportUnsubKeyword | Bool | False |
Indicates whether a reply mail management configuration supports a unsubscribe keyword. |
SupportUnsubscribeKeyword | Bool | False |
Indicates whether a reply mail management configuration supports a unsubscribe keyword. |
SupportRemoveKeyword | Bool | False |
Indicates whether a reply mail management configuration supports a remove keyword. |
SupportOptOutKeyword | Bool | False |
Indicates whether a reply mail management configuration supports an opt-out keyword. |
SupportLeaveKeyword | Bool | False |
Indicates whether a reply mail management configuration supports a leave keyword. |
SupportMisspelledKeywords | Bool | False |
Indicates whether a reply mail management configuration supports misspelled keywords. |
SendAutoReplies | Bool | False |
Indicates whether automatic replies should be sent as part of a reply mail management configuration. |
AutoReplySubject | String | False |
Contains the subject of the email message sent as an automatic reply. |
AutoReplyBody | String | False |
Contains the content of the message sent as an automatic reply. |
ForwardingAddress | String | False |
Specifies forwarding address for inbound emails resulting from a send. |
ConversationLifetimeDays | Int | False |
The number of lifetime days for a conversation. |
ConversationLifetimeCycles | Int | False |
The number of lifetime cycles for a conversation. |
AnonymousRuleSet_ObjectID | String | True |
System-controlled, read-only text string identifier for object. |
AnonymousRuleSet_Name | Int | True |
Name of the object or property. |
AnonymousRuleSet_CustomerKey | String | True |
User-supplied unique identifier for an object within an object type. |
AnonymousAckTriggeredSend_ObjectID | String | True |
System-controlled, read-only text string identifier for object. |
AnonymousAckTriggeredSend_CustomerKey | String | True |
User-supplied unique identifier for an object within an object type. |
AnonymousAckTriggeredSend_Name | String | True |
Name of the object or property. |
AnonymousAckTriggeredSend_TriggeredSendStatus | String | True |
Represents status of triggered send. |
AnonymousForwardTriggeredSend_ObjectID | String | True |
System-controlled, read-only text string identifier for object. |
AnonymousForwardTriggeredSend_CustomerKey | String | True |
User-supplied unique identifier for an object within an object type. |
AnonymousForwardTriggeredSend_Name | String | True |
Name of the object or property. |
AnonymousForwardTriggeredSend_TriggeredSendStatus | String | True |
Represents status of triggered send. |
ResponderConversationRuleSet_ObjectID | String | True |
System-controlled, read-only text string identifier for object. |
ResponderConversationRuleSet_Name | Int | True |
Name of the object or property. |
ResponderConversationRuleSet_CustomerKey | String | True |
User-supplied unique identifier for an object within an object type. |
ResponderConversationAckTriggeredSend_ObjectID | String | True |
System-controlled, read-only text string identifier for object. |
ResponderConversationAckTriggeredSend_CustomerKey | String | True |
User-supplied unique identifier for an object within an object type. |
ResponderConversationAckTriggeredSend_Name | String | True |
Name of the object or property. |
ResponderConversationAckTriggeredSend_TriggeredSendStatus | String | True |
Represents status of triggered send. |
ResponderConversationForwardTriggeredSend_ObjectID | String | True |
System-controlled, read-only text string identifier for object. |
ResponderConversationForwardTriggeredSend_CustomerKey | String | True |
User-supplied unique identifier for an object within an object type. |
ResponderConversationForwardTriggeredSend_Name | String | True |
Name of the object or property. |
ResponderConversationForwardTriggeredSend_TriggeredSendStatus | String | True |
Represents status of triggered send. |
InitiatorConversationRuleSet_ObjectID | String | True |
System-controlled, read-only text string identifier for object. |
InitiatorConversationRuleSet_Name | Int | True |
Name of the object or property. |
InitiatorConversationRuleSet_CustomerKey | String | True |
User-supplied unique identifier for an object within an object type. |
InitiatorConversationAckTriggeredSend_ObjectID | String | True |
System-controlled, read-only text string identifier for object. |
InitiatorConversationAckTriggeredSend_CustomerKey | String | True |
User-supplied unique identifier for an object within an object type. |
InitiatorConversationAckTriggeredSend_Name | String | True |
Name of the object or property. |
InitiatorConversationAckTriggeredSend_TriggeredSendStatus | String | True |
Represents status of triggered send. |
InitiatorConversationForwardTriggeredSend_ObjectID | String | True |
System-controlled, read-only text string identifier for object. |
InitiatorConversationForwardTriggeredSend_CustomerKey | String | True |
User-supplied unique identifier for an object within an object type. |
InitiatorConversationForwardTriggeredSend_Name | String | True |
Name of the object or property. |
InitiatorConversationForwardTriggeredSend_TriggeredSendStatus | String | True |
Represents status of triggered send. |
ConversationExpirationTriggeredSend_ObjectID | String | True |
System-controlled, read-only text string identifier for object. |
ConversationExpirationTriggeredSend_CustomerKey | String | True |
User-supplied unique identifier for an object within an object type. |
ConversationExpirationTriggeredSend_Name | String | True |
Name of the object or property. |
ConversationExpirationTriggeredSend_TriggeredSendStatus | String | True |
Represents status of triggered send. |
MultiUseViolationTriggeredSend_ObjectID | String | True |
System-controlled, read-only text string identifier for object. |
MultiUseViolationTriggeredSend_CustomerKey | String | True |
User-supplied unique identifier for an object within an object type. |
MultiUseViolationTriggeredSend_Name | String | True |
Name of the object or property. |
MultiUseViolationTriggeredSend_TriggeredSendStatus | String | True |
Represents status of triggered send. |
InboundAddressIsOneUse | Bool | False |
Specified whether the inbound address is one use. |
Used to send email and retrieve aggregate data. This table does not support deletes or updates.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Send SELECT * FROM Send WHERE Id = 123 SELECT * FROM Send WHERE Id IN (123, 456) SELECT * FROM Send WHERE CreatedDate > '2017/01/25'
You must specify the following fields when inserting to this table: FromName, Email_Id, and List_Id.
INSERT INTO Send(FromName, Email_Id, List_Id) VALUES('NASA', 31677, 52362)
Name | Type | ReadOnly | Description |
ID [KEY] | Int | False |
Identifier for an object. |
PartnerKey | String | False |
Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | False |
Indicates the date and time of the object's creation. |
ModifiedDate | Datetime | False |
Indicates the last time object information was modified. |
Client_ID | Int | False |
The Id of the client. |
Client_PartnerClientKey | String | False |
User-defined partner key for an account. |
Email_ID | Int | False |
Identifier for an object. |
Email_PartnerKey | String | False |
Unique identifier provided by partner for an object, accessible only via API. |
SendDate | Datetime | False |
Indicates the date on which a send occurred. |
FromAddress | String | False |
Indicates From address associated with a object. |
FromName | String | False |
Specifies the default email message From Name. |
Duplicates | Int | False |
Represent the number of duplicate email addresses associated with a send. |
InvalidAddresses | Int | False |
Specifies the number of invalid addresses associated with a send. |
ExistingUndeliverables | Int | False |
Indicates whether bounces occurred on previous send. |
ExistingUnsubscribes | Int | False |
Indicates whether unsubscriptions occurred on previous send. |
HardBounces | Int | False |
Indicates number of hard bounces associated with a send. |
SoftBounces | Int | False |
Indicates number of soft bounces associated with a specific send. |
OtherBounces | Int | False |
Specifies number of Other-type bounces in a send. |
ForwardedEmails | Int | False |
Number of emails forwarded for a send. |
UniqueClicks | Int | False |
Indicates number of unique clicks on message. |
UniqueOpens | Int | False |
Indicates number of unique opens resulting from a triggered send. |
NumberSent | Int | False |
Number of emails actually sent as part of an email send. |
NumberDelivered | Int | False |
Number of sent emails that did not bounce. |
NumberTargeted | Int | False |
Indicates the number of possible recipients for an email send. |
NumberErrored | Int | False |
Number of emails not sent as part of a send because an error occurred while trying to build the email. |
NumberExcluded | Int | False |
Indicates the number recipients excluded froman email send because of a held, unsubscribed, master unsubscribed, or global unsubscribed status. |
Unsubscribes | Int | False |
Indicates the number of unsubscribe events associated with a send. |
MissingAddresses | Int | False |
Specifies number of missing addresses encountered within a send. |
Subject | String | False |
Defines the status of an object. |
PreviewURL | String | False |
Indicates URL used to preview the message associated with a send. |
SentDate | Datetime | False |
Indicates date on which a send took place. |
EmailName | String | False |
Specifies the name of an email message associated with a send. |
Status | String | False |
The status of the object. |
IsMultipart | Bool | False |
Indicates whether the email is sent with Multipart/MIME enabled. |
SendLimit | Int | False |
Indicates limit of messages to send as part of a send definition within a predefined send window. |
SendWindowOpen | Datetime | False |
Defines the beginning of a send window for a send definition. |
SendWindowClose | Datetime | False |
Defines the end of a send window for a send definition. |
IsAlwaysOn | Bool | False |
Indicates whether the request can be performed while the system is is maintenance mode. |
Additional | String | False |
The ID for a send that customers use as a campaign ID. |
BCCEmail | String | False |
Indicates email addresses to receive blind carbon copy of a message. |
EmailSendDefinition_ObjectID | String | False |
System-controlled, text string identifier for object. |
EmailSendDefinition_CustomerKey | String | False |
The customer key of the email send definition. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
List_Id | Int |
The Id of the list to be sent. |
Represents a send classification in a Marketing Cloud account.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SendClassification SELECT * FROM SendClassification WHERE ObjectID = 'nzxcaslkjd-123' SELECT * FROM SendClassification WHERE ObjectID IN ('nzxcaslkjd-123', 456) SELECT * FROM SendClassification WHERE CreatedDate > '2017/01/25'
You must specify the following fields when inserting to this table: Name, DeliveryProfile_ObjectID, and SenderProfile_ObjectID.
INSERT INTO SendClassification(Name, DeliveryProfile_ObjectID, SenderProfile_ObjectID) VALUES('TestName', 'aa1231231', 'vvb1231231')
You must specify the ObjectID in the WHERE clause when executing a delete against this table.
DELETE FROM SendClassification WHERE ObjectID = 'nzxcaslkjd-123'
Name | Type | ReadOnly | Description |
ObjectID [KEY] | String | False |
System-controlled, text string identifier for object. |
SendClassificationType | String | False |
Defines the type for the applicable send classification. Valid values include Operational and Marketing. |
Name | String | False |
Name of the object or property. |
Description | String | False |
Describes and provides information regarding the object. |
CustomerKey | String | False |
User-supplied unique identifier for an object within an object type. |
SenderProfile_CustomerKey | String | False |
The customer key of the sender profile. |
SenderProfile_ObjectID | String | False |
System-controlled, text string identifier for object. |
DeliveryProfile_CustomerKey | String | False |
The customer key of the delivery profile. |
DeliveryProfile_ObjectID | String | False |
System-controlled, text string identifier for object. |
ArchiveEmail | Bool | False |
Property definition. |
Client_ID | Long | False |
The Id of the client. |
Client_PartnerClientKey | String | False |
User-defined partner key for an account. |
PartnerKey | String | False |
Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | False |
Indicats the date and time of the object's creation. |
ModifiedDate | Datetime | False |
Indicates the last time object information was modified. |
The send profile used in conjunction with an email send definition.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SenderProfile SELECT * FROM SenderProfile WHERE ObjectID = 'nzxcaslkjd-123' SELECT * FROM SenderProfile WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456') SELECT * FROM SenderProfile WHERE CreatedDate > '2017/01/25'
You must specify the following fields when inserting to this table: Name, FromName, and FromAddress.
INSERT INTO SenderProfile(Name, FromName, FromAddress) VALUES('Test', 'Friendly Neighborhood', '[email protected]')
You must specify the ObjectID in the WHERE clause when executing an update against this table.
UPDATE SenderProfile SET Name = 'changed_name', Description='changed_desc', FromName='changed_from_name', FromAddress='[email protected]' WHERE ObjectID='nzxcaslkjd-123'
You must specify the ObjectID in the WHERE clause when executing a delete against this table.
DELETE FROM SenderProfile WHERE ObjectID = 'nzxcaslkjd-123'
Name | Type | ReadOnly | Description |
Name | String | False |
Name of the object or property. |
Description | String | False |
Describes and provides information regarding the object. |
FromName | String | False |
Specifies the default email message From Name. |
FromAddress | String | False |
Indicates From address associated with a object. |
UseDefaultRMMRules | Bool | False |
Indicates whether a sender profile uses the default RMM rules for that account. |
AutoForwardToEmailAddress | String | True |
Indicates the email address to use with automatically forwarded email messages. |
AutoForwardToName | String | True |
Indicates the To name to use on automatically forwarded email messages. |
DirectForward | Bool | False |
Indicates whether the direct forward feature has been enabled for a sender profile. |
AutoForwardTriggeredSend_ObjectID | String | False |
System-controlled, text string identifier for object. |
AutoReply | Bool | False |
Indicates the reply associated with an automatically forwarded email message. |
AutoReplyTriggeredSend_ObjectID | String | False |
System-controlled, text string identifier for object. |
SenderHeaderEmailAddress | String | False |
Specifies the email address to include in the sender header of a sender profile. |
SenderHeaderName | String | False |
Specifies name to include in the sender header of a sender profile. |
DataRetentionPeriodLength | String | False |
Specifies the number of time units for which data will be retained. |
ReplyManagementRuleSet_ObjectID | String | False |
System-controlled, text string identifier for object. |
RMMRuleCollection_ObjectID | String | False |
System-controlled, text string identifier for object. |
Client_ID | Long | False |
The Id of the client. |
PartnerKey | String | False |
Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | False |
Indicates the date and time of the object's creation. |
ModifiedDate | Datetime | False |
Indicates the last time object information was modified. |
ObjectID | String | False |
System-controlled, text string identifier for object. |
CustomerKey | String | False |
User-supplied unique identifier for an object within an object type. |
Client_CreatedBy | Int | False |
Returns user ID for user who created object |
Client_ModifiedBy | Int | False |
Returns user ID for user who modified object. |
Indicates a single instance of an SMS triggered send. This table does not support deletes or updates.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SMSTriggeredSend SELECT * FROM SMSTriggeredSend WHERE ObjectID = 123 SELECT * FROM SMSTriggeredSend WHERE ObjectID IN (123, 456) SELECT * FROM SMSTriggeredSend WHERE CreatedDate > '2017/01/25'
You must specify the following field when inserting to this table: SMSTriggeredSendDefinition_ObjectID.
INSERT INTO SMSTriggeredSend(SMSTriggeredSendDefinition_ObjectID) VALUES(123)
Name | Type | ReadOnly | Description |
ObjectID [KEY] | String | False |
System-controlled, text string identifier for object. |
CreatedDate | Datetime | False |
Indicates the date and time of the object's creation. |
Client_ID | Int | False |
The Id of the client. |
SmsSendId | String | False |
Indicates ID for a specific SMS send. |
SMSTriggeredSendDefinition_ObjectID | String | False |
System-controlled, text string identifier for object. |
A person subscribed to receive email or SMS communication.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Subscriber SELECT * FROM Subscriber WHERE Id = 123 SELECT * FROM Subscriber WHERE Id IN (123, 456) SELECT * FROM Subscriber WHERE CreatedDate > '2017/01/25'
You must specify the following fields when inserting to this table: SubscriberKey and EmailAddress.
INSERT INTO Subscriber(SubscriberKey, EmailAddress) VALUES(123, '[email protected]')
You must specify the Id in the WHERE clause when executing an update against this table.
UPDATE Subscriber SET EmailAddress='[email protected]' WHERE Id=123
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Subscriber WHERE Id = 123
Name | Type | ReadOnly | Description |
ID | Int | False |
Identifier for an object. |
PartnerKey | String | False |
Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | False |
Indicates the date and time of the object's creation. |
Client_ID | Int | False |
The Id of the client. |
Client_PartnerClientKey | String | False |
User-defined partner key for an account. |
EmailAddress | String | False |
Contains the email address for a subscriber. |
SubscriberKey | String | False |
Identification of a specific subscriber. |
UnsubscribedDate | Datetime | False |
Represents date subscriber unsubscribed from a list. |
Status | String | False |
Defines status of object. |
EmailTypePreference | String | False |
The format in which email should be sent. |
A suppression list that can be associated with different contexts.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SuppressionListDefinition WHERE ObjectID = 'nzxcaslkjd-123' SELECT * FROM SuppressionListDefinition WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456') SELECT * FROM SuppressionListDefinition WHERE CreatedDate > '2017/01/25'
You must specify the following fields when inserting to this table: Name.
INSERT INTO SuppressionListDefinition(Name) VALUES('Test')
You must specify the ObjectID in the WHERE clause when executing an update against this table.
UPDATE SuppressionListDefinition SET Name='Changed' WHERE ObjectID='nzxcaslkjd-123'
You must specify the ObjectID in the WHERE clause when executing a delete against this table.
DELETE FROM SuppressionListDefinition WHERE ObjectID='nzxcaslkjd-123'
Name | Type | ReadOnly | Description |
ObjectID | String | False |
System-controlled, text string identifier for object. |
CustomerKey | String | False |
User-supplied unique identifier for an object within an object type. |
Name | String | False |
Name of the object or property. |
Description | String | False |
Describes and provides information regarding the object. |
Client_CreatedBy | Int | False |
Returns user ID for user who created object |
CreatedDate | Datetime | False |
Indicates the date and time of the object's creation. |
Client_ModifiedBy | Int | False |
Returns user ID for user who modified object. |
ModifiedDate | Datetime | False |
Indicates the last time object information was modified. |
Category | Long | False |
ID of the folder that an item is located in. |
Client_ID | Int | False |
The Id of the client. |
Client_EnterpriseID | Long | False |
The EnterpriseID of the client. |
SubscriberCount | Long | False |
Indicates the number of records on a suppression list. |
To create or update a TriggeredSendDefinition where the list ID is the All Subs List ID, you need the Email | Subscribers | All Subscribers | View and SendEmailToList permissions.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM TriggeredSendDefinition SELECT * FROM TriggeredSendDefinition WHERE ObjectID = 'nzxcaslkjd-123' SELECT * FROM TriggeredSendDefinition WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456') SELECT * FROM TriggeredSendDefinition WHERE CreatedDate > '2017/01/25'
You must specify the following fields when inserting to this table: Name, SendClassification_ObjectID, and Email_Id.
INSERT INTO TriggeredSendDefinition(Name, SendClassification_ObjectID, Email_Id) VALUES('Test', 'nzxcaslkjd-789', 123)
You must specify the ObjectID in the WHERE clause when executing an update against this table.
UPDATE TriggeredSendDefinition SET Description='Changed' WHERE ObjectID='nzxcaslkjd-123'
You must specify the ObjectID in the WHERE clause when executing a delete against this table.
When deleting a row from this table, the row will not be deleted, but instead the value of TriggeredSendStatus will be set to false.
DELETE FROM TriggeredSendDefinition WHERE ObjectID = 'nzxcaslkjd-123'
Name | Type | ReadOnly | Description |
ObjectID [KEY] | String | False |
System-controlled, text string identifier for object. |
PartnerKey | String | False |
Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | False |
Indicates the date and time of the object's creation. |
ModifiedDate | Datetime | False |
Indicates the last time object information was modified. |
Client_ID | Long | False |
The Id of the client. |
CustomerKey | String | False |
User-supplied unique identifier for an object within an object type. |
Email_ID | Int | False |
Identifier for an object. |
List_ID | Int | False |
Identifier for an object. |
Name | String | False |
Name of the object or property. |
Description | String | False |
Describes and provides information regarding the object. |
TriggeredSendType | String | False |
Deprecated. |
TriggeredSendStatus | String | False |
Represents status of triggered send. |
HeaderContentArea_ID | Int | False |
Identifier for an object. |
FooterContentArea_ID | Int | False |
Identifier for an object. |
SendClassification_ObjectID | String | False |
System-controlled, text string identifier for object. |
SendClassification_CustomerKey | String | False |
The customer key of the send classification. |
SenderProfile_CustomerKey | String | False |
The customer key of the sender profile. |
SenderProfile_ObjectID | String | False |
System-controlled, text string identifier for object. |
DeliveryProfile_CustomerKey | String | False |
The customer key of the delivery profile. |
DeliveryProfile_ObjectID | String | False |
System-controlled, text string identifier for object. |
PrivateDomain_ObjectID | String | False |
System-controlled, text string identifier for object. |
PrivateIP_ID | Int | True |
Read-only identifier for an object. |
AutoAddSubscribers | Bool | False |
Indicates whether a triggered send recipient should be added to a subscriber list. |
AutoUpdateSubscribers | Bool | False |
Indicates if any subscriber information should be updated as part of a triggered send. |
BatchInterval | Int | False |
Deprecated. |
FromName | String | False |
Specifies the default email message From Name. |
FromAddress | String | False |
Indicates From address associated with a object. |
BccEmail | String | False |
Indicates email addresses to receive blind carbon copy of a message. |
EmailSubject | String | False |
Subject for an email send. |
DynamicEmailSubject | String | False |
Contains content to be used in a dynamic subject line. |
IsMultipart | Bool | False |
Indicates whether the email is sent with Multipart/MIME enabled. |
IsWrapped | Bool | False |
Indicates whether an email send contains the links necessary to process tracking information for clicks. |
TestEmailAddr | String | False |
Specified a test email address. |
AllowedSlots | String | False |
Reserved for future use. |
NewSlotTrigger | Int | False |
Deprecated. |
SendLimit | Int | False |
Indicates limit of messages to send as part of a send definition within a predefined send window. |
SendWindowOpen | Datetime | False |
Defines the beginning of a send window for a send definition. |
SendWindowClose | Datetime | False |
Defines the end of a send window for a send definition. |
SuppressTracking | Bool | False |
Indicates whether the send definition suppresses tracking results for associated sends. |
Keyword | String | False |
Reserved for future use. |
List_PartnerKey | String | False |
Unique identifier provided by partner for an object, accessible only via API. |
Email_PartnerKey | String | False |
Unique identifier provided by partner for an object, accessible only via API. |
SendClassification_PartnerKey | String | False |
Unique identifier provided by partner for an object, accessible only via API. |
PrivateDomain_PartnerKey | String | True |
Unique identifier provided by partner for an object, accessible only via API. |
PrivateIP_PartnerKey | String | True |
Unique identifier provided by partner for an object, accessible only via API. |
Client_PartnerClientKey | String | False |
User-defined partner key for an account. |
IsPlatformObject | Bool | False |
Indicated whether the object is a platform object. |
CategoryID | Int | False |
Specifies the identifier of the folder containing the email. |
ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます(その機能がデータソースに適用できる場合)。
ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。
ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。
Name | Description |
Automation | Defines an automation that exists within Automation Studio for an account. |
BounceEvent | Contains SMTP and other information pertaining to the specific event of an email message bounce. |
ClickEvent | Contains time and date information, as well as a URL ID and a URL, regarding a click on a link contained in a message. |
DataExtensionField | Represents a field within a data extension. |
DataExtensionTemplate | Represents a data extension template within an account. |
DataFolder | Represents a folder in a Marketing Cloud account |
DoubleOptInMOKeyword | The DoubleOptInMOKeyword object defines an MO keyword, allowing a mobile user to subscribe to SMS messages using a double opt-in workflow. |
FileTriggerTypeLastPull | Reserved for future use. |
ForwardedEmailEvent | Indicates a subscriber used the Forward To A Friend feature to send an email to another person. |
ForwardedEmailOptInEvent | Specifies an opt-in event related to a Forward To A Friend event. |
HelpMOKeyword | Defines actions associated with the HELP SMS keyword for an account. |
ImportResultsSummary | A retrieve-only object that contains status and aggregate information on an individual import started from an ImportDefinition. |
LinkSend | Provides information about a link in a send. |
ListSend | Specifies retrieve-only properties associated with the list(s) for a completed send. |
ListSubscriber | Retrieves subscribers for a list or lists for a subscriber. |
MessagingVendorKind | Contains the vendor details for an SMS (short message service) or voice messaging vendor. Deprecated. |
NotSentEvent | Contains information on when email message failed to be sent. |
OpenEvent | Contains information about the opening of a message send by a subscriber. |
PrivateIP | The PrivateIP object contains information on private IP address to be used as part of messages sends. |
Publication | Reserved for future use. |
PublicationSubscriber | Describes subscriber on a publication list. |
PublicKeyManagement | Reserved for future use. |
ResultItem | Contains results of asynchronous API call. |
ResultMessage | Message containing results of async call. |
Role | Defines roles and permissions assigned to a user in an account. |
SendEmailMOKeyword | Defines the action that sends a triggered email message to the email addresses defined in an MO message. |
SendSMSMOKeyword | Defines actions to take when the specified MO keyword is received. |
SendSummary | A retrieve only object that contains summary information about a specific send event. |
SentEvent | Contains tracking data related to a send, including information on individual subscribers. |
SMSMTEvent | Contains information on a specific SMS message sent to a subscriber. |
SMSSharedKeyword | Contains information used to request a keyword for use with SMS messages in a Marketing Cloud account. |
SMSTriggeredSendDefinition | Defines the send definition for an SMS message. |
SubscriberList | Use to retrieve lists for a specific subscriber. |
SubscriberSendResult | Reserved for future use. |
SuppressionListContext | Defines a context that a SuppressionListDefinition can be associated with. |
SurveyEvent | Contains information on when a survey response took place. |
Template | Represents an email template in a Marketing Cloud account. |
TimeZone | Represents a specific time zone in the application. |
TriggeredSendSummary | Summary of results for a specific triggered send. |
UnsubEvent | Contains information regarding a specific unsubscription action taken by a subscriber. |
UnsubscribeFromSMSPublicationMOKeyword | Defines keyword used by a subscriber to unsubscribe from an SMS publication list. |
Defines an automation that exists within Automation Studio for an account.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but DateTime values: =, !=, <>, >, >=, <, <=, IN. For DateTime values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Automation SELECT * FROM Automation WHERE ObjectID = 123 SELECT * FROM Automation WHERE ObjectID IN (123, 456) SELECT * FROM Automation WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ObjectID [KEY] | String | System-controlled, read-only text string identifier for object. |
Name | String | Name of the object or property. |
Description | String | Describes and provides information regarding the object. |
Schedule_ID | Int | Read-only identifier for the schedule. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
Client_ID | Long | The Id of the client. |
IsActive | Bool | Specifies whether or not the object is active. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
Client_CreatedBy | Int | Returns user ID for user who created object. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ModifiedBy | Int | Returns user ID for user who modified object.. |
Status | Int | Indicates status of automation. |
Client_EnterpriseID | Long | Reserved for future use. |
Contains SMTP and other information pertaining to the specific event of an email message bounce.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM BounceEvent SELECT * FROM BounceEvent WHERE Id = 123 SELECT * FROM BounceEvent WHERE Id IN (123, 456) SELECT * FROM BounceEvent WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ID [KEY] | Int | Read-only identifier for an object. |
ObjectID | String | System-controlled, read-only text string identifier for object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API.. |
CreatedDate | Datetime | Read-only date and time of the object's creation.. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Int | Specifies Id of the client. |
SendID | Int | Contains identifier for a specific send. |
SubscriberKey | String | Identification of a specific subscriber. |
EventDate | Datetime | Date when a tracking event occurred. |
SMTPCode | String | Contains SMTP code related to a bounced email. |
BounceCategory | String | Defines category for bounce associated with a bounced email. |
SMTPReason | String | Contains SMTP reason associated with a bounced email. |
BounceType | String | Defines type of bounce associated with a bounced email. |
EventType | String | The type of tracking event. |
TriggeredSendDefinitionObjectID | String | Identifies the triggered send definition associated with an event. |
BatchID | Int | Ties triggered send sent events to other events. |
Contains time and date information, as well as a URL ID and a URL, regarding a click on a link contained in a message.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ClickEvent SELECT * FROM ClickEvent WHERE Id = 123 SELECT * FROM ClickEvent WHERE Id IN (123, 456) SELECT * FROM ClickEvent WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ID [KEY] | Int | Read-only identifier for an object. |
ObjectID | String | System-controlled, read-only text string identifier for object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Int | The Id of the client. |
SendID | Int | Contains identifier for a specific send. |
SubscriberKey | String | Identification of a specific subscriber. |
EventDate | Datetime | Date when a tracking event occurred. |
EventType | String | The type of tracking event |
TriggeredSendDefinitionObjectID | String | Identifies the triggered send definition associated with an event. |
BatchID | Int | Ties triggered send sent events to other events. |
URLID | Int | Indicates URL ID associated with a click tracking event. |
URL | String | Indicates URL included in an event or configuration. |
Represents a field within a data extension.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM DataExtensionField SELECT * FROM DataExtensionField WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ObjectID [KEY] | String | System-controlled, read-only text string identifier for object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
CustomerKey | String | User-supplied unique identifier for an object within an object type, which corresponds to the external key assigned to an object in the user interface. |
Name | String | Name of the object or property. |
DefaultValue | String | The default value for a data extension field if no value is supplied. |
MaxLength | Int | Maximum length of the data. |
IsRequired | Bool | Indicates whether the property must have a value specified. |
Ordinal | Int | Indicates position of object within an array |
IsPrimaryKey | Bool | Designates whether a data extension field is used as a primary key for that data extension. |
FieldType | String | Designates data type for a data extension field. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Scale | Int | Indicates numeric precision for decimal properties. |
Client_ID | Int | The Id of the client. |
DataExtension_CustomerKey | String | User-supplied unique identifier for an object within an object type. |
StorageType | String | Indicates special storage properties for the field. Valid values are: Unspecified, Plain, Encrypted, or Obfuscated. |
Represents a data extension template within an account.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM DataExtensionTemplate SELECT * FROM DataExtensionTemplate WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ObjectID [KEY] | String | System-controlled, read-only text string identifier for object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
Name | String | Name of the object or property. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Int | The Id of the client. |
Description | String | Describes and provides information regarding the object. |
IsSendable | Bool | Specifies whether the template is sendable. |
IsTestable | Bool | Specifies whether the template is testable. |
SendableCustomObjectField | String | Specifies a sendable custom object field. |
SendableSubscriberField | String | Specifies a sendable subscriber field. |
DataRetentionPeriodLength | String | Specifies until when should the data be retained. |
DataRetentionPeriodUnitOfMeasure | Int | Specifies the unit of measure for the data rentention period. |
RowBasedRetention | Bool | Specifies whether row based retention is enabled. |
ResetRetentionPeriodOnImport | Bool | Specifies whether retention period should be reset on import. |
DeleteAtEndOfRetentionPeriod | Bool | Specifies whether the data should be deleted at the end of the retention period. |
RetainUntil | Datetime | Specified until when the data should be retained. |
Represents a folder in a Marketing Cloud account
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM DataFolder SELECT * FROM DataFolder WHERE Id = 123 SELECT * FROM DataFolder WHERE Id IN (123, 456) SELECT * FROM DataFolder WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ID [KEY] | Int | Read-only identifier for an object. |
Client_ID | Int | The Id of the client. |
ParentFolder_ID | Int | Specifies the parent folder If for a data folder. |
ParentFolder_CustomerKey | String | User-supplied unique identifier for an object within an object type. |
ParentFolder_ObjectID | String | System-controlled, read-only text string identifier for object. |
ParentFolder_Name | String | Name of the object or property. |
ParentFolder_Description | String | Describes and provides information regarding the object. |
ParentFolder_ContentType | String | Defines the type of content contained within a folder. |
ParentFolder_IsActive | Bool | Specifies whether or not the object is active. |
ParentFolder_IsEditable | Bool | Indicates if the property can be edited by the end-user in the profile center. |
ParentFolder_AllowChildren | Bool | Specifies whether a data folder can have child data folders. |
Name | String | Name of the object or property. |
Description | String | Describes and provides information regarding the object. |
ContentType | String | Defines the type of content contained within a folder. |
IsActive | Bool | Specifies whether or not the object is active. |
IsEditable | Bool | Indicates if the property can be edited by the end-user in the profile center. |
AllowChildren | Bool | Specifies whether a data folder can have child data folders. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ModifiedBy | Int | Returns user ID for user who modified object. |
ObjectID | String | System-controlled, read-only text string identifier for object. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
Client_EnterpriseID | Long | Reserved for future use. |
Client_CreatedBy | Int | Returns user ID for user who created object |
The DoubleOptInMOKeyword object defines an MO keyword, allowing a mobile user to subscribe to SMS messages using a double opt-in workflow.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM DoubleOptInMOKeyword SELECT * FROM DoubleOptInMOKeyword WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
Client_ID | Int | The Id of the client. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
IsDefaultKeyword | Bool | Specifies if account defaults to this SMS keyword action if no other options are available. |
DefaultPublication_ID | Int | Read-only identifier for an object. |
InvalidPublicationMessage | String | Specifies message to send in case a subscriber requests subscription to or unsubscription from an invalid publication list. |
InvalidResponseMessage | String | Specifies message to send in case a subscriber sends in an invalid response. |
MissingPublicationMessage | String | Reserved for future use. |
NeedPublicationMessage | String | Specifies message to send in case a subscriber sends in an response that does not specify a publication list. |
PromptMessage | String | Contains message sent to subscriber to prompt response as part of the double opt-in process. |
SuccessMessage | String | Defines SMS message to send if triggered email send succeeds. |
UnexpectedErrorMessage | String | Contains message to send to subscriber in case of unexpected error. |
ValidPublications | String | Defines valid publication lists for use with a double opt-in event. |
ValidResponses | String | Defines valid responses a subscriber can use as part of a double opt-in process. |
Reserved for future use.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM FileTriggerTypeLastPull SELECT * FROM FileTriggerTypeLastPull WHERE ObjectID = 'nzxcaslkjd-123' SELECT * FROM FileTriggerTypeLastPull WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')
Name | Type | Description |
Client_ID | Long | The Id of the client. |
ObjectID [KEY] | String | System-controlled, read-only text string identifier for object. |
ExternalReference | String | Reserved for future use. |
Type | String | Indicates type of specific list. |
LastPullDate | Datetime | Reserved for future use. |
Indicates a subscriber used the Forward To A Friend feature to send an email to another person.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ForwardedEmailEvent SELECT * FROM ForwardedEmailEvent WHERE Id = 123 SELECT * FROM ForwardedEmailEvent WHERE Id IN (123, 456) SELECT * FROM ForwardedEmailEvent WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ID [KEY] | Int | Read-only identifier for an object. |
ObjectID | String | System-controlled, read-only text string identifier for object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Int | The Id of the client. |
SendID | Int | Contains identifier for a specific send. |
SubscriberKey | String | Identification of a specific subscriber. |
EventDate | Datetime | Date when a tracking event occurred. |
EventType | String | The type of tracking event. |
TriggeredSendDefinitionObjectID | String | Identifies the triggered send definition associated with an event. |
BatchID | Int | Ties triggered send sent events to other events. |
Specifies an opt-in event related to a Forward To A Friend event.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ForwardedEmailOptInEvent SELECT * FROM ForwardedEmailOptInEvent WHERE Id = 123 SELECT * FROM ForwardedEmailOptInEvent WHERE Id IN (123, 456) SELECT * FROM ForwardedEmailOptInEvent WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ID [KEY] | Int | Read-only identifier for an object. |
ObjectID | String | System-controlled, read-only text string identifier for object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Int | The Id of the client. |
SendID | Int | Contains identifier for a specific send. |
SubscriberKey | String | Identification of a specific subscriber. |
EventDate | Datetime | Date when a tracking event occurred. |
EventType | String | The type of tracking event. |
TriggeredSendDefinitionObjectID | String | Identifies the triggered send definition associated with an event. |
BatchID | Int | Ties triggered send sent events to other events. |
OptInSubscriberKey | String | Specifies the subscriber key of a subscriber opted in via forwarded email. |
Defines actions associated with the HELP SMS keyword for an account.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM HelpMOKeyword SELECT * FROM HelpMOKeyword WHERE Client_ID = 123 SELECT * FROM HelpMOKeyword WHERE Client_ID IN (123, 456) SELECT * FROM HelpMOKeyword WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
Client_ID | Int | The Id of the client. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
IsDefaultKeyword | Bool | Specifies if account defaults to this SMS keyword action if no other options are available. |
MoreChoicesPrompt | String | Text used to inform MO message sender of more available choices as part of a HELP keyword action. |
DefaultHelpMessage | String | Contains default message to deliver for a HELP MO message. |
MenuText | String | Defines text to use for outlining multiple response options in the response to a HELP MO request. |
FriendlyName | String | Contains the friendly name for a HELP MO keyword. |
A retrieve-only object that contains status and aggregate information on an individual import started from an ImportDefinition.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ImportResultsSummary SELECT * FROM ImportResultsSummary WHERE Id = 123 SELECT * FROM ImportResultsSummary WHERE Id IN (123, 456) SELECT * FROM ImportResultsSummary WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ObjectID [KEY] | String | System-controlled, read-only text string identifier for object. |
ID | Int | Read-only identifier for an object. |
Client_ID | Long | The Id of the client. |
ImportDefinitionCustomerKey | String | Specifies customer key associated with import definition used in an import. |
TaskResultID | Int | Indicates the task result ID associated with a summary of import results. |
ImportStatus | String | Specifies import status associated with an import. |
StartDate | String | Indicates the start date for the time period for which to retrieve import results. |
EndDate | String | Specifies the end data of an activity. |
DestinationID | String | Specifies the identifier of either the list or the data extension associated with a completed import. |
NumberSuccessful | Int | Specifies number of successful record imports resulting from an import action. |
NumberDuplicated | Int | Specifies number of duplicated records resulting from an import. |
NumberErrors | Int | Indicates number of errors resulting from an import. |
TotalRows | Int | Indicates the total number of rows included in the summary of an import. |
ImportType | String | Specfies type of import performed. |
Provides information about a link in a send.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM LinkSend SELECT * FROM LinkSend WHERE Id = 123 SELECT * FROM LinkSend WHERE Id IN (123, 456) SELECT * FROM LinkSend WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ID [KEY] | Int | Read-only identifier for an object. |
SendID | Int | Contains identifier for a specific send. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
Client_ID | Int | The Id of the client. |
Client_PartnerClientKey | String | User-defined partner key for an account. |
Link_ID | Int | The Id of the link. |
Link_PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
Link_TotalClicks | Int | Indicates total number of clicks on link in message. |
Link_UniqueClicks | Int | Indicates number of unique clicks on message. |
Link_URL | String | Indicates URL included in an event or configuration. |
Link_Alias | String | Name of link contained in message. |
Specifies retrieve-only properties associated with the list(s) for a completed send.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ListSend SELECT * FROM ListSend WHERE Id = 123 SELECT * FROM ListSend WHERE Id IN (123, 456) SELECT * FROM ListSend WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ID [KEY] | Int | Read-only identifier for an object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
Client_ID | Int | The Id of the client. |
SendID | Int | Contains identifier for a specific send. |
List_ID | Int | Read-only identifier for an object. |
List_ListName | String | The name of the list. |
Duplicates | Int | Represent the number of duplicate email addresses associated with a send (exists only when a send occurs to multiple lists). |
InvalidAddresses | Int | Specifies the number of invalid addresses associated with a send. |
ExistingUndeliverables | Int | Indicates whether bounces occurred on previous send. |
ExistingUnsubscribes | Int | Indicates whether unsubscriptions occurred on previous send. |
HardBounces | Int | Indicates number of hard bounces associated with a send. |
SoftBounces | Int | Indicates number of soft bounces associated with a specific send. |
OtherBounces | Int | Specifies number of Other-type bounces in a send. |
ForwardedEmails | Int | Number of emails forwarded for a send. |
UniqueClicks | Int | Indicates number of unique clicks on message. |
UniqueOpens | Int | Indicates number of unique opens resulting from a triggered send. |
NumberSent | Int | Number of emails actually sent as part of an email send. This number reflects all of the sent messages and may include bounced messages. |
NumberDelivered | Int | Number of sent emails that did not bounce. |
Unsubscribes | Int | Indicates the number of unsubscribe events associated with a send. |
MissingAddresses | Int | Specifies number of missing addresses encountered within a send. |
PreviewURL | String | Indicates URL used to preview the message associated with a send. |
Retrieves subscribers for a list or lists for a subscriber.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ListSubscriber SELECT * FROM ListSubscriber WHERE Id = 123 SELECT * FROM ListSubscriber WHERE Id IN (123, 456) SELECT * FROM ListSubscriber WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ID [KEY] | Int | Read-only identifier for an object. |
ObjectID | String | System-controlled, read-only text string identifier for object. |
SubscriberKey | String | Identification of a specific subscriber. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Int | The Id of the client. |
Client_PartnerClientKey | String | User-defined partner key for an account. |
ListID | Int | Defines identification for a list the subscriber resides on. |
Status | String | Defines status of an object. |
UnsubscribedDate | Datetime | The date the subscriber unsubscribed. |
Contains the vendor details for an SMS (short message service) or voice messaging vendor. Deprecated.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM MessagingVendorKind SELECT * FROM MessagingVendorKind WHERE Id = 123 SELECT * FROM MessagingVendorKind WHERE Id IN (123, 456) SELECT * FROM MessagingVendorKind WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ID [KEY] | Int | Identifier for an object. |
Vendor | String | Deprecated. |
Kind | String | Deprecated. |
IsUsernameRequired | Bool | Deprecated. |
IsPasswordRequired | Bool | Deprecated. |
IsProfileRequired | Bool | Deprecated. |
CreatedDate | Datetime | Indicates the date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Contains information on when email message failed to be sent.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM NotSentEvent SELECT * FROM NotSentEvent WHERE SendID = 123 SELECT * FROM NotSentEvent WHERE SendID IN (123, 456) SELECT * FROM NotSentEvent WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
SendID | Int | Contains identifier for a specific send. |
SubscriberKey | String | Identification of a specific subscriber. |
EventDate | Datetime | Date when a tracking event occurred. |
Client_ID | Int | The Id of the client. |
EventType | String | The type of tracking event |
BatchID | Int | Ties triggered send sent events to other events. |
TriggeredSendDefinitionObjectID | String | Identifies the triggered send definition associated with an event. |
ListID | Int | Defines identification for a list the subscriber resides on. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
SubscriberID | Int | The Id of the subscriber. |
Contains information about the opening of a message send by a subscriber.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM OpenEvent SELECT * FROM OpenEvent WHERE Id = 123 SELECT * FROM OpenEvent WHERE Id IN (123, 456) SELECT * FROM OpenEvent WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ID [KEY] | Int | Read-only identifier for an object. |
ObjectID | String | System-controlled, read-only text string identifier for object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Int | The Id of the client. |
SendID | Int | Contains identifier for a specific send. |
SubscriberKey | String | Identification of a specific subscriber. |
EventDate | Datetime | Date when a tracking event occurred. |
EventType | String | The type of tracking event |
TriggeredSendDefinitionObjectID | String | Identifies the triggered send definition associated with an event. |
BatchID | Int | Ties triggered send sent events to other events. |
The PrivateIP object contains information on private IP address to be used as part of messages sends.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM PrivateIP SELECT * FROM PrivateIP WHERE Id = 123 SELECT * FROM PrivateIP WHERE Id IN (123, 456) SELECT * FROM PrivateIP WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ID [KEY] | Int | Read-only identifier for an object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
Client_ID | Int | The Id of the client. |
Name | String | Name of the object or property. |
Description | String | Describes and provides information regarding the object. |
IsActive | Bool | Specifies whether or not the object is active. |
OrdinalID | String | Defines position of object within an array of information. |
IPAddress | String | Contains IP address to be used in for a private IP. |
Client_PartnerClientKey | String | User-defined partner key for an account. |
Reserved for future use.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Publication SELECT * FROM Publication WHERE Id = 123 SELECT * FROM Publication WHERE Id IN (123, 456) SELECT * FROM Publication WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ID [KEY] | Int | Read-only identifier for an object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Int | The Id of the client. |
Client_PartnerClientKey | String | User-defined partner key for an account. |
Name | String | Name of the object or property. |
Category | Int | ID of the folder that an item is located in. |
Describes subscriber on a publication list.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM PublicationSubscriber SELECT * FROM PublicationSubscriber WHERE Publication_ID = 123 SELECT * FROM PublicationSubscriber WHERE Publication_ID IN (123, 456) SELECT * FROM PublicationSubscriber WHERE Publication_CreatedDate > '2017/01/25'
Name | Type | Description |
Publication_ID | Int | Read-only identifier for an object. |
Publication_PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
Publication_CreatedDate | Datetime | Read-only date and time of the object's creation. |
Publication_ModifiedDate | Datetime | Indicates the last time object information was modified. |
Publication_Client_ID | Int | Read-only identifier for an object. |
Publication_Client_PartnerClientKey | String | Unique identifier provided by partner for an object, accessible only via API. |
Client_ID | Int | The Id of the client. |
Client_PartnerClientKey | String | User-defined partner key for an account. |
Publication_Name | String | Name of the object or property. |
Publication_Category | Int | The category of the publication. |
Subscriber_ID | Int | Read-only identifier for an object. |
Subscriber_SubscriberKey | String | Identification of a specific subscriber. |
Subscriber_PrimarySMSAddress_AddressType | String | The address type of the subscriber. |
Subscriber_PrimarySMSAddress_Address | String | The address of the subscriber. |
Subscriber_PrimarySMSAddress_Carrier | String | The carrier of the subscriber. |
Subscriber_PrimarySMSPublicationStatus | String | The primary SMS publication status of the subscriber. |
Reserved for future use.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM PublicKeyManagement SELECT * FROM PublicKeyManagement WHERE Id = 123 SELECT * FROM PublicKeyManagement WHERE Id IN (123, 456) SELECT * FROM PublicKeyManagement WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ID [KEY] | Int | Read-only identifier for an object. |
Client_ID | Long | The Id of the client. |
Name | String | Name of the object or property. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
Key | String | Specifies key associated with content area in HTML body. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Contains results of asynchronous API call.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ResultItem SELECT * FROM ResultItem WHERE AsyncAPIRequestQueueID = 123 SELECT * FROM ResultItem WHERE AsyncAPIRequestQueueID IN (123, 456) SELECT * FROM ResultItem WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
AsyncAPIRequestQueueID | Int | The Id of the async API request queue. |
RequestID | String | Unique ID of initial async API call. |
ConversationID | String | Unique ID of initial async API call. All requests that should be processed as a single unit will have the same ConversationID. |
CorrelationID | String | Identifies correlation of objects across several requests. |
Client_ID | Int | The Id of the client. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
StatusCode | String | Status of async API request. |
StatusMessage | String | Describes the status of an API call. |
OrdinalID | Int | System-controlled, read-only text string identifier for object. |
ErrorCode | Int | Identifies the error of an API request via a numeric code. |
RequestType | String | Defines request as synchronous or asynchronous API. |
RequestObjectType | String | Defines type of the Request object, such as email or triggered send. |
ResultType | Int | Defines result as coming from synchronous or asynchronous API. |
Client_PartnerClientKey | String | User-defined partner key for an account. |
Message containing results of async call.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ResultMessage SELECT * FROM ResultMessage WHERE RequestID = 123 SELECT * FROM ResultMessage WHERE RequestID IN (123, 456) SELECT * FROM ResultMessage WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
RequestID | String | Unique ID of initial async API call. |
ConversationID | String | Unique ID of initial async API call. |
Client_ID | Int | The Id of the client. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
OverallStatusCode | String | Represents overall status of conversation via async API. |
StatusCode | String | Status of async API request. |
StatusMessage | String | Describes the status of an API call. |
ErrorCode | Int | Identifies the error of an API request. |
RequestType | String | Defines request as synchronous or asynchronous API. |
ResultType | String | Defines result as coming from synchronous or asynchronous API. |
ResultDetailXML | String | Contains details of operation result in XML format. |
Client_PartnerClientKey | String | User-defined partner key for an account. |
Defines roles and permissions assigned to a user in an account.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Account SELECT * FROM Account WHERE ObjectID = 'nzxcaslkjd-123' SELECT * FROM Account WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456') SELECT * FROM Account WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ObjectID [KEY] | String | System-controlled, read-only text string identifier for object. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
Name | String | Name of the object or property. |
Description | String | Describes and provides information regarding the object. |
IsPrivate | Bool | Indicates whether role is defined by Marketing Cloud or a client. |
IsSystemDefined | Bool | Indicates whether role is defined by the application. |
Client_EnterpriseID | Long | Reserved for future use. |
Client_ID | Int | The Id of the client. |
Client_CreatedBy | Int | Returns user ID for user who created object |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
Client_ModifiedBy | Int | Returns user ID for user who modified object. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
PermissionSets | String | Indicates permission sets applied to a Role or PermissionSet object. |
Permissions | String | Specifies an array of permissions. |
Defines the action that sends a triggered email message to the email addresses defined in an MO message.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SendEmailMOKeyword SELECT * FROM SendEmailMOKeyword WHERE Client_ID = 123 SELECT * FROM SendEmailMOKeyword WHERE Client_ID IN (123, 456) SELECT * FROM SendEmailMOKeyword WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
Client_ID | Int | The Id of the client. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
NextState_CustomerKey | String | The customer key of the next state. |
IsDefaultKeyword | Bool | Specifies if account defaults to this SMS keyword action if no other options are available. |
SuccessMessage | String | Defines SMS message to send if triggered email send succeeds. |
MissingEmailMessage | String | Defines message to send if MO message does not contain a valid email address. |
FailureMessage | String | Defines message to deliver in case the email send fails. |
TriggeredSend_CustomerKey | String | The customer key of the triggered send definition. |
Defines actions to take when the specified MO keyword is received.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SendSMSMOKeyword SELECT * FROM SendSMSMOKeyword WHERE Client_ID = 123 SELECT * FROM SendSMSMOKeyword WHERE Client_ID IN (123, 456) SELECT * FROM SendSMSMOKeyword WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
Client_ID | Int | The Id of the client. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
NextMOKeyword_CustomerKey | String | Defines the customer key of the next MO keyword to use in an SMS conversation. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
ObjectID [KEY] | String | System-controlled, read-only text string identifier for object. |
IsDefaultKeyword | Bool | Specifies if account defaults to this SMS keyword action if no other options are available. |
Message | String | Contains contents of results message. |
ScriptErrorMessage | String | Defines message to deliver to subscriber in case of an error in the SMS conversation. |
A retrieve only object that contains summary information about a specific send event.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SendSummary SELECT * FROM SendSummary WHERE Client_ID = 123 SELECT * FROM SendSummary WHERE Client_ID IN (123, 456) SELECT * FROM SendSummary WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
Client_ID | Int | The Id of the client. |
AccountID | Int | Identifier for account. |
SendID | Int | Contains identifier for a specific send. |
DeliveredTime | String | Indicates the time a message was delivered. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
AccountName | String | Name of account. |
AccountEmail | String | Specifies email address attached to account. |
IsTestAccount | Bool | Specifies whether or not an account is a 'Test' account. |
TotalSent | Int | Indicates total number of messages sent as part of a send. |
Transactional | Int | Indicates number of transactional messages included in a send. |
NonTransactional | Int | Specifies number of marketing (non-transactional) messages included as part of a send. |
Contains tracking data related to a send, including information on individual subscribers.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SentEvent SELECT * FROM SentEvent WHERE Id = 123 SELECT * FROM SentEvent WHERE Id IN (123, 456) SELECT * FROM SentEvent WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
SendID | Int | Contains identifier for a specific send. |
SubscriberKey | String | Identification of a specific subscriber. |
EventDate | Datetime | Date when a tracking event occurred. |
Client_ID | Int | The Id of the client. |
EventType | String | The type of tracking event |
BatchID | Int | Ties triggered send sent events to other events. |
TriggeredSendDefinitionObjectID | String | Identifies the triggered send definition associated with an event. |
ListID | Int | Defines identification for a list the subscriber resides on. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
SubscriberID | Int | The Id of the subscriber. |
Contains information on a specific SMS message sent to a subscriber.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SMSMTEvent SELECT * FROM SMSMTEvent WHERE ObjectID = 'nzxcaslkjd-123' SELECT * FROM SMSMTEvent WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456') SELECT * FROM SMSMTEvent WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ObjectID [KEY] | String | System-controlled, read-only text string identifier for object. |
EventDate | Datetime | Date when a tracking event occurred. |
Client_ID | Long | The Id of the client. |
MOCode | String | Specifies the MO code associated with a specific MO or MT tracking event. |
SMSTriggeredSend_SMSSendId | String | Indicates ID for a specific SMS send. |
SMSTriggeredSend_SMSTriggeredSendDefinition_ObjectID | String | System-controlled, read-only text string identifier for object. |
SMSTriggeredSend_SMSTriggeredSendDefinition_CustomerKey | String | User-supplied unique identifier for an object within an object type. |
Subscriber_ID | Int | Read-only identifier for an object. |
Subscriber_SubscriberKey | String | Identification of a specific subscriber. |
Subscriber_PrimarySMSAddress_Address | String | The primary SMS address of the subscribers. |
Carrier | String | Name of the SMS carrier associated with an SMS address. |
Defines the send definition for an SMS message.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SMSTriggeredSendDefinition SELECT * FROM SMSTriggeredSendDefinition WHERE ObjectID = 'nzxcaslkjd-123' SELECT * FROM SMSTriggeredSendDefinition WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456') SELECT * FROM SMSTriggeredSendDefinition WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ObjectID [KEY] | String | System-controlled, read-only text string identifier for object. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
Client_ID | Long | The Id of the client. |
Name | String | Name of the object or property. |
Description | String | Describes and provides information regarding the object. |
Publication_ID | Int | Read-only identifier for an object. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Content_ID | Int | Read-only identifier for an object. |
SendToList | Bool | Indicates whether SMS triggered send goes to a list or a single subscriber. |
DataExtension_ObjectID | String | System-controlled, read-only text string identifier for object. |
IsPlatformObject | Bool | Indicated whether the object is a platform object. |
Use to retrieve lists for a specific subscriber.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SubscriberList SELECT * FROM SubscriberList WHERE Id = 123 SELECT * FROM SubscriberList WHERE Id IN (123, 456) SELECT * FROM SubscriberList WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ListSubID | Long | Identifier for an object. |
ID [KEY] | Int | Identifier for an object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | date and time of the object's creation. |
Subscriber_UnsubscribedDate | Datetime | The unsubscribed date of the subscriber. |
Client_ID | Int | The Id of the client. |
Status | String | Defines status of object. |
List_ID | Int | Identifier for an object. |
List_ListName | String | The name of the list. |
Subscriber_Status | String | Defines status of object. |
Subscriber_CreatedDate | Datetime | Indicates the date and time of the object's creation. |
Subscriber_ID | Int | identifier for an object. |
Subscriber_EmailAddress | String | The email address of a subscriber. |
Subscriber_SubscriberKey | String | Identification of a specific subscriber. |
Subscriber_PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
Reserved for future use.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SubscriberSendResult SELECT * FROM SubscriberSendResult WHERE Id = 123 SELECT * FROM SubscriberSendResult WHERE Id IN (123, 456) SELECT * FROM SubscriberSendResult WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
Send_ID | Int | Read-only identifier for an object. |
ID [KEY] | Int | Read-only identifier for an object. |
Email_ID | Int | Read-only identifier for an object. |
Email_Name | String | Name of the object or property. |
Subject | String | Contains subject area information for a message. |
FromName | String | Specifies the default email message From Name. |
FromAddress | String | Indicates From address associated with a object. |
SentDate | Datetime | Indicates date on which a send took place. |
OpenDate | Datetime | Specifies data on which a subscriber opened a send. |
ClickDate | Datetime | Specifies the data subscriber clicked a link included in a send. |
Subscriber_Partnerkey | String | Unique identifier provided by partner for an object, accessible only via API. |
Subscriber_EmailAddress | String | The email address of the subscriber. |
Subscriber_PartnerType | String | The partner type of the subscriber. |
UnsubscribeDate | Datetime | Indicates the date on which an unsubscribe event took place due to a send. |
LastOpenDate | Int | Specifies the date subscribe was last opened. |
LastClickDate | Int | Specifies the date subscribe was last clicked. |
BounceDate | Datetime | Contains the date on which an individual send bounced for a subscriber. |
EventDate | Int | Indicated the date of the event. |
TotalClicks | Int | Indicates total number of clicks on link in message. |
UniqueClicks | Int | Indicates number of unique clicks on message. |
EmailAddress | Int | Indicates From address associated with a object. |
Subscriber_ID | Int | Read-only identifier for an object. |
SubscriberTypeID | Int | Read-only identifier for an object. |
Subscriber_SubscriberKey | String | The subscriber key of the subscriber. |
Send_PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
Client_ID | Int | The Id of the client. |
OtherBounces | Int | Specifies number of Other-type bounces in a send. |
SoftBounces | Int | Indicates number of soft bounces associated with a specific send. |
HardBounces | Int | Indicates number of hard bounces associated with a send. |
Defines a context that a SuppressionListDefinition can be associated with.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SuppressionListContext SELECT * FROM SuppressionListContext WHERE Id = 123 SELECT * FROM SuppressionListContext WHERE Id IN (123, 456) SELECT * FROM SuppressionListContext WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ObjectID [KEY] | String | System-controlled, read-only text string identifier for object. |
Definition_ObjectID | String | System-controlled, read-only text string identifier for object. |
Definition_Name | String | Name of the object or property. |
Definition_CustomerKey | String | User-supplied unique identifier for an object within an object type. |
Definition_Category | Long | The category of the defition. |
Definition_Description | String | Describes and provides information regarding the object. |
Context | String | The context with which a SuppressionListDefinition is associated. |
SendClassification_ObjectID | String | System-controlled, read-only text string identifier for object. |
Send_ID | Int | Read-only identifier for an object. |
SenderProfile_ObjectID | String | System-controlled, read-only text string identifier for object. |
SendClassificationType | String | Defines the type for the applicable send classification. Valid values include Operational and Marketing. |
Client_CreatedBy | Int | Returns user ID for user who created object |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
Client_ModifiedBy | Int | Returns user ID for user who modified object. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Long | The Id of the client. |
Client_EnterpriseID | Long | Reserved for future use. |
AppliesToAllSends | Bool | Indicates whether this context applies to all transactional and marketing sends. |
Contains information on when a survey response took place.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SurveyEvent SELECT * FROM SurveyEvent WHERE Id = 123 SELECT * FROM SurveyEvent WHERE Id IN (123, 456) SELECT * FROM SurveyEvent WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ID [KEY] | Int | Read-only identifier for an object. |
ObjectID | String | System-controlled, read-only text string identifier for object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Int | The Id of the client. |
SendID | Int | Contains identifier for a specific send. |
SubscriberKey | String | Identification of a specific subscriber. |
EventDate | Datetime | Date when a tracking event occurred. |
EventType | String | The type of tracking event. |
TriggeredSendDefinitionObjectID | String | Identifies the triggered send definition associated with an event. |
BatchID | Int | Ties triggered send sent events to other events. |
Question | String | Specifies question associated with a survey event. |
Answer | String | The answer provided by a subscriber to the survey question. |
Represents an email template in a Marketing Cloud account.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Template SELECT * FROM Template WHERE ObjectID = 'nzxcaslkjd-123' SELECT * FROM Template WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456') SELECT * FROM Template WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ObjectID | String | System-controlled, read-only text string identifier for object. |
ID [KEY] | Int | Read-only identifier for an object. |
Client_ID | Int | The Id of the client. |
TemplateName | String | Name used to identify template within Marketing Cloud application. |
LayoutHTML | String | Contains HTML used to define layout of fields and content within template. |
BackgroundColor | String | Specifies background color used for template. |
BorderColor | String | Specifies border color used in template. |
BorderWidth | Int | Specifies border pixel width used in template. |
Cellpadding | Int | Specifies pixel width of padding within cells used in template. |
Cellspacing | Int | Specifies pixel spacing between cells used in template. |
Width | Int | Specifies the pixel width of the entire template |
Align | String | Indicates the alignment of elements within the template. |
ActiveFlag | Int | Indicates whether the template is available for use within the account. |
CategoryID | Int | Indicates whether content validation has completed for this email message. |
CategoryType | String | Identifies correlation of objects across several requests. |
OwnerID | Int | Specifies MID of business unit that created the template within an Enterprise 2.0 account. |
HeaderContent_ID | Int | The Id of the header content. |
HeaderContent_ObjectID | String | System-controlled, read-only text string identifier for object. |
Layout_ID | Int | The Id of the layout. |
Layout_LayoutName | String | The name of the layout. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
TemplateSubject | String | Contains email subject line specified by the template. |
IsTemplateSubjectLocked | Bool | Indicates whether the subject defined in the header can be changed or not by email using template. |
Represents a specific time zone in the application.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM TimeZone
Name | Type | Description |
ID [KEY] | Int | Read-only identifier for an object. |
Name | String | Name of the object or property. |
Summary of results for a specific triggered send.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM TriggeredSendSummary SELECT * FROM TriggeredSendSummary WHERE ObjectID = 'nzxcaslkjd-123' SELECT * FROM TriggeredSendSummary WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456') SELECT * FROM TriggeredSendSummary WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ObjectID [KEY] | String | System-controlled, read-only text string identifier for object. |
Client_ID | Long | The Id of the client. |
Client_PartnerClientKey | String | User-defined partner key for an account. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
Sent | Long | Indicates number of messages sent. |
NotSentDueToOptOut | Long | Indicates number of sends not completed due to a subscriber's decision to opt out of receiving messages. |
NotSentDueToUndeliverable | Long | Indicates number of sends not completed due to a subscriber's undeliverable status. |
Bounces | Long | Indicates number of bounces resulting from a triggered send. |
Opens | Long | Indicates number of opens from a triggered send. |
UniqueOpens | Long | Indicates number of opens from a triggered send. |
Clicks | Long | Indicates the number of clicks resulting from a triggered send. |
UniqueClicks | Long | Indicates number of unique clicks on message. |
OptOuts | Long | Indicates number of subscribers who opted out of receiving messages after receiving a triggered send. |
SurveyResponses | Long | Indicates number of responses to a survey question contained in a triggered send. |
FTAFRequests | Long | Indicates number of Forward To A Friend requests received as part of a triggered send. |
FTAFEmailsSent | Long | Indicates Forward To A Friend emails sent as a result of a triggered send. |
FTAFOptIns | Long | Indicates number of subscribers opting in to receiving messages as a result of a Forward To A Friend action from a triggered send. |
Conversions | Long | Indicates the number of conversions results from a triggered send. |
UniqueConversions | Long | Indicates number of unique conversions resulting from a triggered send. |
InProcess | Long | Indicates the number of triggered send messages in progress. Deprecated. |
NotSentDueToError | Long | Indicates number of triggered send messages not sent due to error. |
RowObjectID | String | The row id of the object. |
TriggeredSendDefinition_ObjectID | String | The Id of the associated triggered send definition for triggered send. |
Queued | Long | Indicates number of messages queued for sending. |
Contains information regarding a specific unsubscription action taken by a subscriber.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM UnsubEvent SELECT * FROM UnsubEvent WHERE Id = 123 SELECT * FROM UnsubEvent WHERE Id IN (123, 456) SELECT * FROM UnsubEvent WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
ID | Int | Read-only identifier for an object. |
ObjectID | String | System-controlled, read-only text string identifier for object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Int | The Id of the client. |
SendID | Int | Contains identifier for a specific send. |
SubscriberKey | String | Identification of a specific subscriber. |
EventDate | Datetime | Date when a tracking event occurred. |
EventType | String | The type of tracking event |
TriggeredSendDefinitionObjectID | String | Identifies the triggered send definition associated with an event. |
BatchID | Int | Ties triggered send sent events to other events. |
List_ID | Int | Indicates the id of the list involved in the unsubscription. |
List_Type | String | Indicates type of specific list. Valid values include Public, Private, Salesforce, GlobalUnsubscribe, and Master. |
List_ListClassification | String | Specifies the classification for a list. |
IsMasterUnsubscribed | Bool | Indicates whether the subscriber master unsubscribed. |
Defines keyword used by a subscriber to unsubscribe from an SMS publication list.
The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM UnsubscribeFromSMSPublicationMOKeyword SELECT * FROM UnsubscribeFromSMSPublicationMOKeyword WHERE Client_ID = 123 SELECT * FROM UnsubscribeFromSMSPublicationMOKeyword WHERE Client_ID IN (123, 456) SELECT * FROM UnsubscribeFromSMSPublicationMOKeyword WHERE CreatedDate > '2017/01/25'
Name | Type | Description |
Client_ID | Int | The Id of the client. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
NextMOKeyword_CustomerKey | String | Defines next MO keyword to use in an SMS conversation. |
IsDefaultKeyword | Bool | Specifies if account defaults to this SMS keyword action if no other options are available. |
AllUnsubSuccessMessage | String | Contains message to send to subscriber when they have successfully unsubscribed from all SMS publication lists. |
InvalidPublicationMessage | String | Specifies message to send in case a subscriber requests subscription to or unsubscription from an invalid publication list. |
SingleUnsubSuccessMessage | String | Contains message to send to subscriber when they have successfully unsubscribed from a single publication list. |
プロパティ | 説明 |
AuthScheme | The type of authentication to use when connecting to Salesforce Marketing Cloud. |
APIIntegrationType | The grant type for the OAuth flow. Accepted entries are Server-to-Server and Web-App. |
UseLegacyAuthentication | レガシー認証を使用してSalesforce Marketing Cloud REST API に接続する必要があるかどうかを決定するboolean。 |
User | 認証で使用されるSalesforce Marketing Cloud ユーザーアカウント。 |
Password | ユーザーの認証で使用されるパスワード。 |
Subdomain | Salesforce Marketing Cloud API のサブドメイン。 |
UseAsyncBatch | Whether to use the synchronous or the asynchronous SOAP API to perform Batch insert. |
WaitForBulkResults | Whether to wait for bulk results when using the asynchronous API. Only active when UseAsyncBatch is true. |
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
Scope | Space-separated list of data-access permissions for your application. Review REST API Permission IDs and Scopes for a full list of permissions. If scope is not specified, the token is issued with the scopes assigned to the API integration in Installed Packages. |
OAuthGrantType | The grant type for the OAuth flow. |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
プロパティ | 説明 |
LogModules | ログファイルに含めるコアモジュール。 |
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
Schema | 接続するSalesforce Marketing Cloud サーバーのバージョンを指定します。 |
プロパティ | 説明 |
AccountId | The account identifier, or MID, of the target business unit. |
DisplayChildDataExtensions | Displays the Data Extensions of Child Accounts if set. |
Instance | 使用されているSalesforce Marketing Cloud API のインスタンス。 |
ListDataExtensions | データエクステンションがテーブルとしてリストされるかどうかを決定するboolean。 |
MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
Pagesize | Salesforce Marketing Cloud から返されるページあたりの結果の最大数。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
QueryAllAccounts | Queries all accounts, including parent and all children, regarding an event. |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
TimeZone | サーバーのタイムゾーン。形式はUTC オフセットを使用する必要があります。例:+00:00。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
AuthScheme | The type of authentication to use when connecting to Salesforce Marketing Cloud. |
APIIntegrationType | The grant type for the OAuth flow. Accepted entries are Server-to-Server and Web-App. |
UseLegacyAuthentication | レガシー認証を使用してSalesforce Marketing Cloud REST API に接続する必要があるかどうかを決定するboolean。 |
User | 認証で使用されるSalesforce Marketing Cloud ユーザーアカウント。 |
Password | ユーザーの認証で使用されるパスワード。 |
Subdomain | Salesforce Marketing Cloud API のサブドメイン。 |
UseAsyncBatch | Whether to use the synchronous or the asynchronous SOAP API to perform Batch insert. |
WaitForBulkResults | Whether to wait for bulk results when using the asynchronous API. Only active when UseAsyncBatch is true. |
The type of authentication to use when connecting to Salesforce Marketing Cloud.
Select among the following connection properties:
The grant type for the OAuth flow. Accepted entries are Server-to-Server and Web-App.
Deprecated along with OAuthGrantType. Use AuthScheme instead.
When an app is created on SF Marketing Cloud, you are given an option of Web-API and Server-to-Server. This acts to determine the grant type for the OAuth flow. Use the following options to select your authentication grant type:
Optionally set OAuthGrantType directly instead of setting this property. Using OAuthGrantType may be desireable in cases where multiple products are being used to keep everything consistent since APIIntegrationType is specific to Salesforce Marketing Cloud.
レガシー認証を使用してSalesforce Marketing Cloud REST API に接続する必要があるかどうかを決定するboolean。
レガシー機能を持つパッケージをインストールしたSalesforce Marketing Cloud に接続するには、このプロパティをTRUE に設定する必要があります。
認証で使用されるSalesforce Marketing Cloud ユーザーアカウント。
このフィールドは、Password とともに、Salesforce Marketing Cloud サーバーに対して認証をするために使われます。
Salesforce Marketing Cloud API のサブドメイン。
サブドメインは以下の手順で取得できます。
Whether to use the synchronous or the asynchronous SOAP API to perform Batch insert.
This property determines whether or not the asynchronous API is used for Insert data to Salesforce Marketing Cloud. These requests will be processed asynchronously meaning the driver will not wait for Salesforce to process the results fully. You can query the following table to get information about the jobs and batches that were created:
SELECT * FROM LastResultInfo#TEMP
Whether to wait for bulk results when using the asynchronous API. Only active when UseAsyncBatch is true.
This property determines whether the Sync App will wait for bulk requests to report their status. By default this property is false and any INSERT queries will complete as soon as they are submitted to Salesforce Marketing Cloud. When this property is true, the Sync App will wait for INSERT to finish.
When this property is false, data modification queries will be faster but less detailed status information will be available. The LastResultInfo#TEMP table will list the creates batches and not the status of individual rows. Information about individual rows will only be availble if you execute the GetBatchResults stored procedure for each batch.
When this property is true, data modification queries will be slower but more status information will be available. The LastResultInfo#TEMP table will list the ID of each updated row, its status and any associated error messages.
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
Scope | Space-separated list of data-access permissions for your application. Review REST API Permission IDs and Scopes for a full list of permissions. If scope is not specified, the token is issued with the scopes assigned to the API integration in Installed Packages. |
OAuthGrantType | The grant type for the OAuth flow. |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
Space-separated list of data-access permissions for your application. Review REST API Permission IDs and Scopes for a full list of permissions. If scope is not specified, the token is issued with the scopes assigned to the API integration in Installed Packages.
Space-separated list of data-access permissions for your application. Review REST API Permission IDs and Scopes for a full list of permissions. If scope is not specified, the token is issued with the scopes assigned to the API integration in Installed Packages.
The grant type for the OAuth flow.
When an app on is created on Salesforce Marketing Cloud, you are given an option of Web-API or Server-to-Server. Use the following options to select your authentication grant type:
APIIntegrationType may alternatively be specified to indicate the GrantType.
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
説明 | 例 |
フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロキシベースのファイアウォールで使われるプロトコル。
このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
タイプ | デフォルトポート | 説明 |
TUNNEL | 80 | これが設定されている場合、Sync App はSalesforce Marketing Cloud への接続を開き、プロキシを経由して通信が行われます。 |
SOCKS4 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。 |
SOCKS5 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
プロキシベースのファイアウォールの名前もしくはIP アドレス。
ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。
Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。
プロキシベースのファイアウォールのTCP ポート。
ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。
プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。
プロキシベースのファイアウォールへの認証に使われるパスワード。
このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。
SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。
ProxyServer プロキシが起動しているTCP ポート。
HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer プロキシへの認証で使われる認証タイプ。
この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。
Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
認証タイプは、次のどれかになります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer プロキシへの認証に使われるユーザー名。
ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。
ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。
user@domain domain\user
ProxyServer プロキシへの認証に使われるパスワード。
このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。
HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。
NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。
ProxyServer プロキシへの接続時に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。
AUTO | デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。 |
ALWAYS | 接続は、常にSSL 有効となります。 |
NEVER | 接続は、SSL 有効になりません。 |
TUNNEL | 接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
ログファイルに含めるコアモジュール。
指定された(';' で区切られた)モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
Schema | 接続するSalesforce Marketing Cloud サーバーのバージョンを指定します。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル(テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル)を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
Note: このSync App は複数のスキーマをサポートするため、Salesforce Marketing Cloud カスタムスキーマファイルの構造は以下のようになります。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\SFMarketingCloud Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます:
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
接続するSalesforce Marketing Cloud サーバーのバージョンを指定します。
このプロパティをREST に設定するとSalesforce Marketing Cloud 1.x REST API を使用し、SOAP に設定するとSalesforce Marketing Cloud SOAP API を使用します。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
AccountId | The account identifier, or MID, of the target business unit. |
DisplayChildDataExtensions | Displays the Data Extensions of Child Accounts if set. |
Instance | 使用されているSalesforce Marketing Cloud API のインスタンス。 |
ListDataExtensions | データエクステンションがテーブルとしてリストされるかどうかを決定するboolean。 |
MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
Pagesize | Salesforce Marketing Cloud から返されるページあたりの結果の最大数。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
QueryAllAccounts | Queries all accounts, including parent and all children, regarding an event. |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
TimeZone | サーバーのタイムゾーン。形式はUTC オフセットを使用する必要があります。例:+00:00。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
The account identifier, or MID, of the target business unit.
Use this property to switch between business units. If you don't specify account_id, the returned access token is in the context of the business unit that created the integration. The specified AccountId will be used only during the OAuth flow. It is not supported for legacy packages.
Displays the Data Extensions of Child Accounts if set.
Use this property to list child accounts data extension objects. By default, only parent and shared data extensions are displayed.
使用されているSalesforce Marketing Cloud API のインスタンス。
デフォルトで使用されるSalesforce Marketing Cloud インスタンスはs7 です。インスタンスを特定するには、次の手順に従ってください。
データエクステンションがテーブルとしてリストされるかどうかを決定するboolean。
データエクステンションがテーブルとしてリストされるかどうかを決定するboolean。
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
Salesforce Marketing Cloud から返されるページあたりの結果の最大数。
Pagesize プロパティは、Salesforce Marketing Cloud から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
Queries all accounts, including parent and all children, regarding an event.
Use this property to query all accounts, including parent and all children, regarding an event. Available only for SOAP schema.
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
サーバーのタイムゾーン。形式はUTC オフセットを使用する必要があります。例:+00:00。
If you have contacted your Marketing Cloud representative to disable the "Incoming Date Normalization" feature, you must specify the Account timezone instead of server timezone.
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{ "MyView": { "query": "SELECT * FROM Subscriber WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"