The goal of this script is to reduce the friction for Advertisers with offline store activities to be able to send offline events with Meta using Conversions API for Offline. A lot of clients do not have enough Dev Resources to develop a full blown Direct Integration for CAPI Offline and there are not enough partners supporting it. This script is a sample script which the advertisers can take and use it to send offline events with minimum lift and resources
This is just a sample script and you can modify ths as per your use case. You can also schedule this script via Windows Scheduler or a Cron Job and it can run periodically to upload offline events
This is a python script and will need Python3 or higher installed.
You need to udpate the config file with your config details which are need to make CAPI for Offline Calls. Below are all the sections and what needs to be in there.
Don't use single or double quotes in this file
You need to set your DATASET ID, API Version and Access Token here.
Specify the path to the offline events CSV file
Specify the column name which has this data, e.g if the column user_email on csv stores the email address, set it as email = user_email. Set it to absent if it is not prsent in the CSV file
If your CSV file has only email, phone and First Name, then it will look like this. This list is all the possible user data you can send.
[user_data]
email = email
phone_number = phone
first_name = first_name
last_name = absent
gender = absent
date_of_birth = absent
city = absent
state = absent
zip_code = absent
country = absent
Here you can specify all the optional custom data field you wish to send. Refer to the developer doc for all required and optional colum names.
For example, if the column product_content_type on csv stores the content_type, then content_type = product_content_type. Set it to absent if it is not prsent in the CSV file.
If your CSV file has only content_type, and contents, then it will look like this. This list is all the possible user data you can send.
[optional_offline_custom_data]
content_type = content_type
contents = contents
custom_data = absent
order_id = absent
item_number = absent
Refer to the link above to check what each of the fields mean.
Specify where you want the log file and a file name
You will need a csv file with your offline events. The column names will need to be in a specific format for this script to run correctly.
Refer to the developer doc for all required and optional colum names.
Note that the column name in the CSV file must be EXACTLY same as shown in above developer page.
List of required fields are
- event_time
- event_name
- currency
- value
Refer to the link above to check what each of the fields mean.
Refer to the user_data section to check what columns you need to send any user data
Refer to the optional_offline_custom_data section to check what columns you need to send any custom data
em,ph,event_time,event_name,currency,value,order_id,content_type,contents,execution_id
[email protected],12312,1695919455,Purchase,USD,20,BusinessDate=2023-06-01&StationId=1&StoreId=1188&TransactionId=7208,product,"[{ id: ""810547695"", quantity: 1, price: 11.9900 }, { id: ""810409941"", quantity: 1, price: 3.9900 }]",1.69E+12
[email protected],12312,1695919555,Purchase,USD,40,BusinessDate=2023-06-01&StationId=1&StoreId=1188&TransactionId=7208,product,"[{ id: ""810547695"", quantity: 1, price: 11.9900 }, { id: ""810409941"", quantity: 1, price: 3.9900 }]",1.69E+12
[email protected],12312,1695919655,Purchase,USD,60,BusinessDate=2023-06-01&StationId=1&StoreId=1188&TransactionId=7208,product,"[{ id: ""810547695"", quantity: 1, price: 11.9900 }, { id: ""810409941"", quantity: 1, price: 3.9900 }]",1.69E+12
python3 offline_CAPI.py
You can check the log file set in the log_file section.
See the CONTRIBUTING file for how to help out.
This source code is licensed under MIT, as found in the LICENSE file.