Loader Twitter Ads Audience

This component is used to import contacts to Twitter Ads audiences.

Learn more: about Twitter Ads API documentation here.

Data In/ Data Out

Data In

Loader requires imports.csv file in the directory /data/in/tables/imports.csv

File structure:

/data/in/tables/imports.csv file must contain the following columns:

*email()**	Data type: Array[String] The array of email addresses for the user. - lowercase, remove leading and trailing spaces; example: "support@twitter.com"
*device_id ()**	Data type: Array[String] DFA/AdID/Android ID IDFA - IDFA - lower-cased with dashes; ex: 4b61639e-47cc-4056-a16a-c8217e029462 AdID - original format on device is required, not capitalized with dashes; ex: 2f5f5391-3e45-4d02-b645-4575a08f86e Android ID - original format on device is required, not capitalized without dashes or spaces; ex: af3802a465767e36
*handle ()**	Data type - Array[String] The @handle(s) (Twitter usernames) belonging to the user no @, lowercased and leading and trailing spaces trimmed; ex: john
twitter_id	Data type - Array[String] The Twitter IDs belonging to the user String representation of integer; ex: "143567"
partner_user_id	Data type - Array[String] The user's ID is in the partners' system.

Remember: (*) - At least one attribute - email, device_id, handle or twitter_id is required.

Remember: If any attribute is missing use empty array [] as a placeholder.

Remember: DO NOT hash data in imports.csv. The component takes care of hashing all required attributes.

Learn more: about data structure in Twitter Ads documentation here and here.

Example:

email	device_id	handle	twitter_id	partner_user_id
["john@doe.com"]	["1234"]	["john"]	[]	[]
[]	[]	"marek"]	[“42”]	[]
["jane@doe.com"","jane@meiro.io"]	["9876"]	["jane"]	[]	["84"]

Plain CSV file:

Data Out N/A

Learn more: about the folder structure here.

Parameters

consumer_key (required)	Consumer (API) key generated by Twitter in the registered application.
#consumer_secret (required)	Consumer (API) secret generated by Twitter in the registered application.
access_token (required)	Access token generated by Twitter in the registered application.
#access_token_secret (required)	Access token secret generated by Twitter in the registered application.
account_id	The ID of the account where the audience will be imported.

Audience

audience_id (*)

The ID of the audience where the contacts from the imports.csv file will be imported.

Remember: the audience_id is in the URL

audience_name (*)

The name of the newly created audience.

Warning: Using the same audience_name as an existing audience would cause the export to fail. Please keep this in mind when exporting to new audiences. If you wish to export to the same audience, remember to specify the audience_id.

Remember: At least one audience_id OR audience_name must be provided.

Remember: All credentials are placed in 1Password.

Example:

{
  "parameters": {
    "credentials": {
      "consumer_key": "consumer_key",
      "#consumer_secret": "###",
      "access_token": "access_token",
      "#access_token_secret": "###",
      "account_id": "qwerty12345"
    },
    "audience": {
      "audience_id": "foo42",
      "audience_name": "my_audience_audience"
    }
  }

Methods

When audience_id is provided in the configuration. The component will check audience_id existence and import all given contacts there.
When audience_id is unknown, audience_name must be provided in the configuration. The component will create a new audience with a defined audience_name and import all given contacts to the newly created audience.