Implementation Guide: TikTok Events API for Offline Events [Part 2: Set up an Offline Data Source]
AWS S3 Setup:
Amazon Web Services (AWS) offers Amazon S3, a scalable cloud-based object storage service. It allows users to store and retrieve data from anywhere on the internet using a simple web interface, or application programming interface.
To get started, click on the AWS S3 Source tile from the dashboard.
The First step is to select the data type. This helps Datahash in understanding what type of integration the user wants to do. Currently, we support offline events, custom audience, and leads data type integration across multiple advertising destinations.
For offline events, click on Events.
Offline Events Integration:
- Select the ‘Events’ options in the data type selection step as shown below and give a name to your connection.
- In order to setup the connection successfully, kindly download the file which help you understand the overall structure in which you need to get the data setup. Once done, take the downloaded file set-up in an AWS S3 bucket and add credentials in the next step.
- This is the most important step where the user needs to provide the FTP credentials which will help Datahash to access the file for further processing. These credentials are:
- S3 Bucket Name: The AWS S3 bucket name is a unique identifier for your storage container in Amazon S3 (Simple Storage Service).
- S3 Bucket Access Key: The AWS S3 bucket access key is a security credential used to authenticate and authorize access to your Amazon S3 buckets. It is a combination of an access key ID and a secret access key.
- S3 Bucket Secret: The AWS S3 bucket access key is a security credential used to authenticate and authorize access to your Amazon S3 buckets.
- Relative path to data folder: A path like prefix name where you have stored the data in the S3 Bucket like ‘my folder/this table’
Once all the credentials are provided, Datahash will validate the credentials, after which the connection will be successfully setup – if all the credentials are valid.
File Format
Overview – To Implement Offline events, the client needs to upload the Customer Fields as mentioned in the file downloaded during the setup (Step 2) in a CSV using the below-specified format. This file works for all three platforms i.e., Facebook, Google and Snap
Note on Encryption – All the Customer Data Fields that say ‘Hashed’ needs to be encrypted using the ‘SHA256’ format.
Mandatory Fields:
| Datahash Fields | Required/Optional | Format |
| Event Data | ||
| event_time | Required | UNIX timestamp |
| event_name | Required | String |
| currency | Required for purchase events | Three-letter ISO currency code |
| value | Required for purchase events | Double |
| transaction_id | Required for purchase events | String |
| User Data | ||
| Email_hashed | Required | Trim leading and trailing white space and convert all characters to lowercase |
| Phone_hashed | Required | Number up to fifteen digits in length starting without 0 and removing any non-numeric characters such as whitespace, parentheses, ‘+’, or ‘-‘ from phone numbers |
Related Articles
Implementation Guide: TikTok Events API for Offline Events
Introduction This comprehensive resource is designed to assist marketers in integrating and utilizing the TikTok Events API for Offline Events effectively using Datahash. Overview TikTok’s Offline Events API enables advertisers to gauge the impact of ...Implementation Guide: TikTok Events API for Offline Events [Part 2: Set up an Offline Data Source]
AWS S3 Setup: Amazon Web Services (AWS) offers Amazon S3, a scalable cloud-based object storage service. It allows users to store and retrieve data from anywhere on the internet using a simple web interface, or application programming interface. To ...Setting up Data Source for Snapchat Offline Conversions API
Offline Conversions API can be set-up using any one of the below available data sources that can provide offline events or conversion data. The type of data sources enable reading of CSV files at regular frequency e.g. daily. Data automation can be ...Overview of TikTok Web Events API
Overview: TikTok for Business offers tools that allow businesses to share the events on their website with TikTok. TikTok Events API is designed to give our advertisers a more reliable connection between TikTok and advertiser’s marketing data ...Implementation Guide: TikTok Events API for Offline Events [Part 3: Setup TikTok Events API for Offline Events Data Destination]
Setup The process to set up the TikTok Events API for Offline Events is detailed below:- Sign in on your Datahash Dashboard. Click on the studio section where you will find the TikTok Offline Events API in the Destinations section. Click on the ...