Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameters

Description

Default value

type

must be salesforce_marketing_cloud_v2


client_id

Salesforce Marketing Cloud Client ID


client_secret

Salesforce Marketing Cloud Client Secret


auth_type

Package Type

This is a enum (v1, v2) where v1 is Legacy package and v2 is Enhanced Package

v1

tenant_auth_uri

Tenant Authentication Base URI (only enter this option if auth_type = v1)

This is required from September 2022 as Marketing Cloud is going to deprecate the legacy endponts endpoints [https://*.exacttargetapis.com].

For more information: https://help.salesforce.com/s/articleView?id=000356497, https://help.salesforce.com/s/articleView?id=000356498


auth_uri


Authentication Base URI (only enter this option if auth_type = v2)


...

Parameters

Description

Default value

type

must be salesforce_marketing_cloud_v2


client_id

Salesforce Marketing Cloud Client ID


client_secret

Salesforce Marketing Cloud Client Secret


auth_type

Package Type

This is a enum (v1, v2) where v1 is Legacy package and v2 is Enhanced Package

v1

tenant_auth_uri

Tenant Authentication Base URI (only enter this option if auth_type = v1)

This is required as of September 2022 as Marketing Cloud is going to deprecate the legacy endponts endpoints [https://*.exacttargetapis.com].

For more information: https://help.salesforce.com/s/articleView?id=000356497, https://help.salesforce.com/s/articleView?id=000356498


auth_uri


Authentication Base URI (only enter this option if auth_type = v2)


contact_attributes_request_limit

Number of attributes to ingest for each contact in a single request. When number of attributes greater than this value, it is split into multiple requests

100

contact_multiple_requests

Enable plugin to ingest contact detail with so many attributes in multiple requests (This only effects when number of attributes greater than 100 )

false

ignore_attribute_set_names

List of attributes are ignored. Useful when you want to eliminate some unnecessary attributes

null

...

Parameters

Description

Default value

type

must be salesforce_marketing_cloud_v2


client_id

Salesforce Marketing Cloud Client ID


client_secret

Salesforce Marketing Cloud Client Secret


auth_type

Package Type

This is a enum (v1, v2) where v1 is Legacy package and v2 is Enhanced Package

v1

tenant_auth_uri

Tenant Authentication Base URI (only enter this option if auth_type = v1)

This is required as of September 2022 as Marketing Cloud is going to deprecate the legacy endponts endpoints [https://*.exacttargetapis.com].

For more information: https://help.salesforce.com/s/articleView?id=000356497, https://help.salesforce.com/s/articleView?id=000356498


auth_uri


Authentication Base URI (only enter this option if auth_type = v2)


shared_data_extension

Set this flag to true when you want to ingest the data from shared data extensions

false

incremental

Set this flag to true if you want to get newer data between each schedule only

false

incremental_column_name

Column used for incremental loading. Must be set if you set incremental = true

null

from_date

Set this to ingest data from this date

null

fetch_days

Duration to ingest is from_date to from_date + fetch_days

1

...

Parameters

Description

Default value

type

must be salesforce_marketing_cloud_v2


client_id

Salesforce Marketing Cloud Client ID


client_secret

Salesforce Marketing Cloud Client Secret


auth_type

Package Type

This is a enum (v1, v2) where v1 is Legacy package and v2 is Enhanced Package

v1

tenant_auth_uri

Tenant Authentication Base URI (only enter this option if auth_type = v1)

This is required as of September 2022 as Marketing Cloud is going to deprecate the legacy endponts endpoints [https://*.exacttargetapis.com].

For more information: https://help.salesforce.com/s/articleView?id=000356497, https://help.salesforce.com/s/articleView?id=000356498


auth_uri


Authentication Base URI (only enter this option if auth_type = v2)


target

must be email_event (in this case)


search_term

Name of email you want to ingest

null

search_mode

Mode for name matching pattern. Must be exact or partial only

exact

email_event_types

List of event types you want to import. Valid options are as follows:

  • value : all

  • value : bounce

  • value : click

  • value : forward

  • value : forwardOptIn

  • value : open

  • value : sent

  • value : survey

  • value : unsub

null

start_time

Set this to ingest data from this time

null

end_time

Set this to ingest data to this time

null

incremental

Set this flag to true if you want to get newer data between each schedule only

false

...