The Salesforce Marketing Cloud is used to manage marketing campaigns. Users can use the marketing APIs to create mailing lists, send emails, etc.
It is a different system than the core Salesforce product (it was formerly ExactTarget), with a different set of APIs. https://developer.salesforce.com/docs/atlas.en-us.noversion.mc-apis.meta/mc-apis/supported_operations_for_objects_and_methods.htm contains a list of the different types of objects that can be managed.
Use Cases
User would like to specify
Salesforce Objects
| Salesforce objects | APIs | |
|---|---|---|
| Approvals | GET Approvals | |
| Audit | GET audit event | |
| GET security events | ||
| Campaigns | GET campaigns | |
| GET assets associated with campaigns | ||
| Interaction | GET Interactions | |
Plugin Type
- Batch Source
- Batch Sink
- Real-time Source
- Real-time Sink
- Action
- Post-Run Action
- Aggregate
- Join
- Spark Model
- Spark Compute
User Configurations
| Section | User Configuration Label | Description | Default | User Widget |
|---|---|---|---|---|
| Authentication | Client ID | OAuth client ID for authentication | Text Box | |
| Client Secret | OAuth client ID for authentication | Password | ||
| Basic | Object | Name of Object - ex: Account, List, Subscriber. | ||
| Operation | Create | Update | Upsert (only supported by some objects) | |||
| Advanced | Maximum bytes per batch | If size of batch data is larger than given number of bytes, split the batch. | Text Box | |
| Maximum records per batch | If there are more than given number of records, split the batch. | Text Box | ||
| Error handling | Possible values: "Skip on error" - ignores any reports about records not inserted. Simply prints an error log. | Skip on error | Select |
Design / Implementation Tips
- REST API documentation can be found here: https://developer.salesforce.com/docs/atlas.en-us.noversion.mc-apis.meta/mc-apis/routes.htm
- API Integration: https://developer.salesforce.com/docs/atlas.en-us.mc-app-development.meta/mc-app-development/api-integration.htm
Design
Approach(s)
Properties
Security
Limitation(s)
Future Work
Test Case(s)
- Test case #1
- Test case #2
Sample Pipeline
Please attach one or more sample pipeline(s) and associated data.