Salesforce Marketing Cloud Source Documentation
This is currently in beta. If you are interested in joining, let us know!
Salesforce Marketing Cloud, formerly known as ExactTarget, is a marketing automation suite with the ability to build complete customer journeys as well as creating, targeting, tracking, and managing email and digital media campaigns.
With the Segment Salesforce Marketing Cloud Source, you can extract data from Marketing Cloud and send them to a data warehouse such as Redshift or Big Query with ease, avoiding having to build your own expensive custom solutions.
If you are trying to setup Salesforce Marketing Cloud as a destination to receive data from Segment, check out
NOTE: The Salesforce Marketing Cloud Source is currently in beta. This means that component names and functionality may change. If you have any feedback to help us improve the Salesforce Marketing Cloud Source and its documentation, and please let us know!
Getting Started
API Access
To access the Salesforce Marketing Cloud data on your behalf, Segment requires the client ID and client secret from your Salesforce Marketing Cloud integration. The integration must also have the following permissions:
| Category | Collection | Permission Needed |
|---|---|---|
| Automation | Journeys (Interactions) | Read |
| Contacts | Lists and Subscribers | Read |
| Hub | Campaigns | Read |
If you already have a Salesforce Marketing Cloud Segment Destination, you can choose to re-use the client ID and client secret setup for the destination. To enable the permissions required for the source:
- Log in to your Salesforce Marketing Cloud account.
- Click your name in the top-right corner of the screen and select “Administration”.
- Navigate to the existing package with the the Segment destination API Integration.
- Adjust the scope according to the permission table above.
- Click “Save”.
If you do not have a Salesforce Marketing Cloud Segment Destination, follow the steps below to acquire the client ID and client secret:
- Log in to your Salesforce Marketing Cloud account.
- Click your name in the top-right corner of the screen and select “Administration”.
- Click the “Account” menu at the top-left corner of the page and select “Installed Packages”.
- If you want to use an existing package, click on that one or click “New” to create a new one. We recommend giving it a name like “Segment”.
- Click “Add Component”.
- Select “API Integration” and click “Next”.
- Enable the permissions as specified in the table above.
- Click “Save”.
You should now see a Summary page with a Components section. This section lists your Client ID and Client Secret settings.
Enable the Salesforce Marketing Cloud Source
- From your Segment workspace’s
/Sourcespage, clickAdd Source. - Under the Email Marketing category, choose Salesforce Marketing Cloud and click
Connect. - Give your source a name to identify it within your workspace.
- Select the data warehouses to connect the source to.
- Specify the Client ID and Client Secret values acquired from the API Access section above
Components
Sync
The Salesforce Marketing Cloud source is built with a sync component, which means we’ll make requests to their API on your behalf on a 3 hour interval to pull the latest data into Segment. In the initial sync, we’ll grab all the Salesforce objects (and their corresponding properties) according to the Collections Table below. The objects will be written into a separate schema, corresponding to the source instance’s schema name you designated upon creation. For example, if you went with sfmc_prod, the campaigns collection will be accessible at sfmc_prod.campaigns in SQL.
Each sync will only sync the data that has been modified since the previous sync.
The source syncs and warehouse syncs are independent processes. Source runs pull your data into the Segment Hub, and warehouse runs flush that data to your warehouse. Sources will sync with Segment every 3 hours. Depending on your Warehouses plan, we will push the Source data to your warehouse on the interval associated with your billing plan.
Collections
Collections are the groupings of resources we pull from your source. In your warehouse, each collection gets its own table.
| Collection | Type | Description |
|---|---|---|
| campaigns | Object | A campaign in your account. Corresponds to Campaigns |
| campaign_assets | Object | The assets associated with each campaign. Corresponds to campaign_assets |
| lists | Object | A mailing list. Corresponds to Lists |
Collection Properties
Segment performs a one-to-one mapping of all publicly available fields from Salesforce Marketing Cloud. Below are tables outlining the properties included in the collections listed above.To see the full description of each property, please refer to the Salesforce Marketing Cloud documentation linked in each collection above.
Campaigns
| Property Name | Description |
|---|---|
| campaign_code | The campaign short code |
| color | The code of the calendar color given to the campaign |
| created_date | Timestamp when the campaign was created |
| description | The campaign description |
| favorite | Whether the campaign was favorited |
| id | The campaign’s unique ID in Salesforce Marketing Cloud |
| modified_date | Timestamp when the campaign was last modified |
| name | The campaign name |
Campaign Assets
| Property Name | Description |
|---|---|
| campaign_id | The ID of the campaign this asset is associated to |
| created_date | Timestamp when the asset was created |
| id | The campaign asset ID |
| item_id | The asset’s unique ID in Salesforce Marketing Cloud |
| type | The asset type. Can be one of: email, triggered send, mobile message, push message, twitter update, facebook update, facebook tab, sites, landing pages, subscriber list, subscriber group, data extension, automation, or event |
Lists
| Property Name | Description |
|---|---|
| category | ID of the folder containing the list |
| client_created_by | User ID of the user who created the list |
| client_customer_key | External key assigned to the list in Marketing Cloud |
| client_id | ID of the owner account of the list |
| client_modified_by | User ID of the user who last modified the list |
| client_partner_client_key | User-defined partner key for owner account of the list |
| client_partner_user_key | Specifies the partner key value of a user |
| client_user_id | User ID of the owner account of the list |
| created_date | Timestamp when the list was created |
| customer_key | User-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object in Marketing Cloud. |
| description | The list description |
| id | The list’s unique ID in Salesforce Marketing Cloud |
| list_classification | Specifies the classification for a list. Valid values include: ExactTargetList, PublicationList, SuppressionList |
| list_name | The list name |
| modified_date | Timestamp when the list was last modified |
| object_id | Auto-generated ID for the object |
| partner_key | Unique ID provided by the partner for the object |
| type | Indicates the list type. Valid values include Public, Private, Salesforce, GlobalUnsubscribe, and Master |
Interactions (aka journeys)
| Property Name | Description |
|---|---|
| key | The developer defined customer key (also a unique identifier within the MID) for this journey |
| name | 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 |
| last_published_date | |
| description | The human readable description of this journey that informs others of purpose |
| version | This number denotes the iteration of this particular journey |
| workflow_api_version | This number represents the current release of the Journey Spec that the Journey Builder APIs will expect in order to understand how to parse and properly respond to your API requests |
| created_date | |
| modified_date | |
| stats_cumulative_population | |
| stats_current_population | |
| stats_goal_performance | |
| stats_met_goal | |
| execution_mode | |
| status | |
| definition_id | |
| default_email | An ordered list of email expressions used to determine which email address to use as the default, starting with the first expression |
| default_analytics_type | |
| default_enabled |
Goals
| Property Name | Description |
|---|---|
| interaction_id | The id of the interaction that this goal is associated with |
| key | The customer key for this goal |
| name | The display name for this goal |
| description | The description for this goal, will be displayed in the Journey Builder user interface |
| type | The type of goal this is (only option currently is ContactEvent) |
| arguments_dequeue_reason | |
| arguments_filter_result | |
| arguments_last_executed_activity_key | |
| start_activity_key | |
| config_arguments_filter_def_id | |
| config_arguments_criteria | |
| config_arguments_schema_version_id | |
| metadata_is_exit_criteria | |
| metadata_conversion_unit | This value is used for deterministic evaluations of the goal, can be either “percentage” or “wholenumber” |
| metadata_conversion_value | Based on the conversionUnit this is the metric Journey Builder uses to determine if the goal has been satisfied |
| metadata_event_definition_id | |
| metadata_event_definition_key | |
| metadata_configuration_description | |
| metadata_configuration_chain_type | |
| metadata_configuration_required | |
| metadata_configuration_icon_url | |
| metadata_configuration_title | |
| schema_args_condition_outcome_access | |
| schema_args_condition_outcome_data_type | |
| schema_args_condition_outcome_direction | |
| schema_args_condition_outcome_is_nullable | |
| schema_args_condition_outcome_read_only | |
| schema_args_dequeue_reason_access | |
| schema_args_dequeue_reason_type | |
| schema_args_dequeue_reason_direction | |
| schema_args_dequeue_reason_is_nullable | |
| schema_args_dequeue_reason_read_only | |
| schema_args_filter_result_access | |
| schema_args_filter_result_data_type | |
| schema_args_filter_result_direction | |
| schema_args_filter_result_is_nullable | |
| schema_args_filter_result_read_only | |
| schema_args_last_exectuted_activity_key_access | |
| schema_args_last_exectuted_activity_key_data_type | |
| schema_args_last_exectuted_activity_key_direction | |
| schema_args_last_exectuted_activity_key_is_nullable | |
| schema_args_last_exectuted_activity_key_read_only | |
| schema_args_start_activity_key_access | |
| schema_args_start_activity_key_data_type | |
| schema_args_start_activity_key_direction | |
| schema_args_start_activity_key_is_nullable | |
| schema_args_start_activity_key_read_only |
Adding Destinations
Currently, Warehouses are the only supported destination for object-cloud sources.
If you have any questions, or see anywhere we can improve our documentation, please let us know!
相關推薦
Salesforce Marketing Cloud Source Documentation
This is currently in beta. If you are interested in joining, let us know!Salesforce Marketing Cloud, formerly known as ExactTarget, is a marketing automati
What can you do with cloud source data? Documentation
What kind of data do you pull from each source?In general, we’ve focused on pulling all of the collections directly related to the customer experience. We
How do I handle common cloud source errors? Documentation
The most common reasons why sources will have trouble is due to authentication or permission issues. When the issue is authentication-related, you'll see a
python3獲取oracle REST API for Oracle Eloqua Marketing Cloud Service 資料
這個程式碼是自定義，獲取客戶自定義的資料 import json import base64 import requests import time url = 'https://login.eloqua.com/id' str_encrypt= 'GenScript\manzu.sh
python3 通過api獲取oracle REST API for Oracle Eloqua Marketing Cloud Service 資料
通過REST API for Oracle Eloqua Marketing Cloud Service 獲取資料， 驗證方式是Authenticate using HTTP Basic Authentication驗證方式 import base64 import requests i
What are object cloud sources? Documentation
To use object cloud sources (Salesforce, Zendesk, Stripe, etc.), you must also have a warehouse setup in your Segment account. In the app data from website
Pixel Tracking API Source Documentation
Tracking pixels (aka beacon, 1×1 gif, or clear gif) allow for tracking email opens, advertising impressions and checkout pages where JavaScript and POST re
Facebook Lead Ads Source Documentation
The Facebook Lead Ads Source is currently in beta! If you have any feedback for us, please reach out.OverviewFacebook Lead Ads help you capture contact inf
使用nodejs對Marketing Cloud的contact主資料進行修改操作
假設在Marketing Cloud有這樣一個contact主資料： 現在需求是使用程式語言比如nodejs修改這個contac
SAP Marketing Cloud裡的contact main facet是什麼意思
介面如下： Basically, contact data for SAP Hybris Marketing can be lo
AWS Documentation is Now Open Source and on GitHub
Earlier this year we made the AWS SDK developer guides available as GitHub repos (all found within the awsdocs organization) and invited intereste
AWS Marketplace: Cloud Replication for Salesforce
AWS Marketplace is hiring! Amazon Web Services (AWS) is a dynamic, growing business unit within Am
How do cloud sources work? Documentation
Sources are functionally comprised of either one or both of the following components: a "sync" component and a "streaming" component. They work together to
How do I find my source slug? Documentation
Your source slug can be found in the URL when you’re looking at the source destinations page or live debugger. The URL structure will look like this:If you
Pardot by Salesforce Email Marketing Integration · Segment
How Pardot worksThe marketing automation features of Pardot rely on two main data sources. The first is Salesforce activity, so you can coordinate e
How do I measure the ROI of my Marketing Campaigns? Documentation
The purpose of marketing campaigns is to drive traffic to your store front. But how do you know which campaigns yield the most conversions or what channel
Spring cloud Eureka 服務治理(高可用服務中心)
image 本地host available png active url 狀態 name spring 在微服務的架構中，我們考慮發生故障的情況，所以在生產環境中我們需要對服務中各個組件進行高可用部署。 Eureka Server 的高可用實際上就是將自己作為服務想其
修改字符集時source使其生效詳解
source 版權 ==版權聲明：#本文的所有內容均來自作者劉春凱的學習總結，未經本人許可，禁止私自轉發及使用。QQ:1151887353E-mail:[email protected]/* */ [email protected]/* */[email p
分布式服務跟蹤及Spring Cloud的實現
在分布式服務架構中，需要對分布式服務進行治理——在分布式服務協同向用戶提供服務時，每個請求都被哪些服務處理？在遇到問題時，在調用哪個服務上發生了問題？在分析性能時，調用各個服務都花了多長時間？哪些調用可以並行執行？……為此，分布式服務平臺就需要提供這樣一種基礎服務——可以記錄每個請求的調用鏈；調用鏈上調用
Gitlab 工具Source tree使用
gitlab source tree 在win的客戶端，我們可以使用工具來方便開發和管理工作，例如source tree，是一款免費的工具，直接下載exe文件安裝就可以了1、安裝完畢後，克隆項目2、克隆完畢後，可以看到各個分支和master信息，而且會有圖線形式給表示3、開發項目創建分支3、創建完畢分