|Table of Contents|
Synchronous or Asynchronous API
This data connector supports two kinds of APIs to put records into SFMC: Synchronous APIs and Asynchronous APIs.
In order to use the Asynchronous APIs, you must ensure that your SFMC account is enabled as a Data Extensions Async REST API from Salesforce Marketing Cloud. You can also create a support case in Salesforce Marketing Cloud to have them enable it.
Replace or Upsert Existing Audience Data in a Data Extension
This data connector also supports Upsert and Replace.
Upsert Audience Data
Upsert updates existing dataand inserts any new additional data in the data extension. Both the update and insert operation use the data extension primary key to determine if a record existed or not to perform the update or insert. All the existing data in the target data extension remains.
Replace Audience Data
Replace which means before updating data, we will clear all existing data in the target data extension. This mode useful if you need only the newest data in the data extension each time in order to send email for targeted customers every time.
To use replace, your account must be an Enterprise 2.0 account and the installed package must have admin privileges. Contact your Customer Success representative to find out more.
Basic knowledge of Treasure Data
Basic knowledge of Salesforce Marketing Cloud
This connector also requires that the Data Extension have a primary key that uniquely identifies each record.
In addition, the Data Extension needs to have more than 2 fields or more if you use Synchronous API.
If you specify 'Create Data Extension' in order to create a new Data Extension, only 1 column as primary key is supported. Specify the multiple columns will cause an error.
Create an Installed App in Salesforce Marketing Cloud
Treasure Data supports both Legacy and Enhanced Package in Salesforce Marketing Cloud.
We highly recommend you create an Enhanced Package.
Create Enhanced Functionality Package
Log on to your Salesforce Marketing Cloud account.
On the Welcome Page, select your name on top right corner. Select Setup.
On the left side menu of new screen, navigate to App > Installed Packages.
On the Installed Packages screen. Select New.
Type the Name and Description.Select Create with enhanced functionality (recommended).
Select Add Component.
- Select API Integration.
Locate Contacts > Audiences and to Contacts > List and Subscribers.
Select Read and Write under both to use Replace Audience feature.
Locate Data > Data Extensions.
Select Read and Write.
You need these permissions to write data to Salesforce Marketing Cloud.
Locate the Components panel.
Make note of the Client Id, Client Secret and Authentication Base URI.
You use the information to write the data from Treasure Data to Salesforce Marketing Cloud.
Using TD Console
Complete the following steps to export TD query results to a Salesforce Marketing Cloud Data Extension:
Create a New Data Connection
When you configure a data connection, you provide authentication to access the integration. In Treasure Data, you configure the authentication and then specify the source information.
Open TD Console.
Navigate to Integrations Hub > Catalog.
Search for and select Salesforce Marketing Cloud Version 2.
Select Enhanced Package Integration.
Select Enhanced Functionality Package, then enter the Client Id, Client Secret and Authentication Base URI (which you obtained when you created the enhanced package in SFMC). Optionally, you could specify:
-Account identifier or MID to access multiple BUs.
-Scope to limit the token's scope (more detail in API scopes).
Name the Connection
Type a name for your connection.
Configure Export Results
In this step you create or reuse a query. In the query, you configure the data connection.
Open the TD Console.
Navigate to Data Workbench > Queries > New Query.
Type your query in the query editor. For example:
Code Block language sql firstline 1
SELECT name as customer_name, email as primary_key FROM data_extension limit 10
The primary key can be a text field.
Select Export Results located at top of your query editor.
Select an existing connection.
Specify a Data Extension Name. Optionally, if your Data Extension does not exist, select Create Data Extension to create a brand new data extension.
If using an existing Data Extension Name and you want to use Asynchronous API, select Using Async API. To use the Synchronous API,leave the box unchecked.
If creating a new data extension, select Create Data Extension. With the newly created data extension, input your Data Extension Nameand name the Primary Column in your new data extension.
- Long & Text are 2 supported data type for Primary Column. If Text is Primary Column, you can specify Text length for Primary Key to optimize data extension performance by not unnecessarily allocating unused space.
Select the Is Sendable option, if your data extension is sendable.
Set your Sendable Rule by Subscriber Key or Email Address.
Select your Sendable Column as a sendable property in your data extension.
Select Data Operation for your data extension
Upsert to add when there are new records or update when records are duplicated.
Replace to delete records and completely replace them for each new export.
Replaced data will not be recoverable.
Run the Query
Select Run to run the query.
Check the query results are written to the configured data extension.
Plugin Configuration and Options
Installed package client key
Installed package client secret
Authenticate URI (required if auth_type=v2)
Data Extension name
Flag to indicate create new data extension if it is not existed
default is false
Name of primary column (required of create_new_de=true)
Only 1 column can be specified.
Length of text field when it is selected as primary column
max: 4000, min: 10 (default: 4000)
Flag to indicate created DE is sendable or not
default is false
Your account’s configured sendable business rule (required if is_sendable=true)
Column name to use as sendable property (required if is_sendable=true
Determine whether clear data in DE before inserting
default is upsert
Flag to indicate using asynchronous or synchronous API from SFMC
default is false
Flag to indicate continue running if there is an insertion error (applied only for synchronous API)
default is true
Example configuration for using Synchronous APIs to upsert data extension using Enhanced package.