1. Home
  2. Docs
  3. TikTok Offline Events API
  4. Step 1: Set up Offline Events Source
  5. Step 1 (Option 1): Set-up FTP File data source

Step 1 (Option 1): Set-up FTP File data source

Overview

File Transfer Protocol (FTP) is a standard network protocol used to transfer computer files between a client and server on a computer network. FTP is built on a client-server model architecture and uses separate control and data connections between the client and the server. With this integration, you will be able to sync offline data with your server through an FTP/SFTP connection.

Pre-Requisites:

FTP server access details for reading files:

  • The FTP server address
  • The FTP server port
  • The FTP server username
  • The FTP server password
Getting Started:

Let’s go through the process required to set-up Files FTP for Offline events..

The First step is to select the File data type. This helps in 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.

  1. Go to the Datahash dashboard and locate the Sources card. Look for File FTP connector under Files category and click on it
  2. Select the Events options in the data type selection step as shown below and give a name to your connection.
  3. 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 FTP location and add credentials in the next step.
  4. 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:
    • FTP Hostname: This is the hosting server name
    • FTP Port: This is the server port, the default port for FTP is 22
    • FTP Username/Password: Your FTP credentials, usually they’re the same as your cPanel login details
    • Relative path to data folder: A path like prefix name where you have stored the files in the FTP folder like myfolder/thistable

File Format

Overview – To Implement Offline events, the client needs to upload event data with the 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 says ‘Hashed’ needs to be encrypted using the ‘SHA256’ format

Mandatory Fields:

Taghash FieldsRequired/OptionalFormat
Event Data
event_timeRequiredUNIX timestamp
event_nameRequiredString
currencyRequired for purchase eventsThree-letter ISO currency code
valueRequired for purchase eventsDouble
transaction_idRequired for purchase eventsString
User Data
Email_hashedRequiredTrim leading and trailing white space and convert all characters to lowercase
Phone_hashedRequiredNumber up to fifteen digits in length starting without 0 and removing any non-numeric characters such as whitespace, parentheses, ‘+’, or ‘-‘ from phone numbers

How can we help?