Skip to main content

S3 Audience Integrations

Melia Cavedoni
Updated

Overview

Liftoff supports ingesting suppression lists (app installs) and audiences for targeting via Amazon S3. In order for this to work correctly, you will need to be able to upload flat files containing raw advertising IDs (IDFA, GAID) to a Liftoff-supplied S3 bucket.

If you want to automate updates programmatically, refer to the API Audience Integrations page. 

Getting started

  1. Ensure your audience data and file formatting conventions are able to meet the following requirements.
  2. Contact your Account Manager to obtain AWS credentials and S3 bucket information.

File format

The uploaded files should be flat text files containing a single advertising ID per line. The IDs should use the following casing convention:

  • IDFAs in uppercase: ABCDEF01-2345-6789-ABCD-EF0123456789
  • Google AIDs in lowercase: abcdef01-2345-6789-abcd-ef0123456789

We also support SHA1 hashes of the raw advertising IDs, but raw IDs must follow the casing convention outlined above before they are hashed. 

You may also optionally use gzip compression. Please include a “.gz” file extension to indicate when the text files are compressed.

Actions & file naming conventions

The filenames of the uploaded files determine the actions performed during ingestion.

Actions: add/remove

These actions can be used to add or remove devices from an audience segment. Note that there is no way to “remove all” previous users from a segment or to replace an audience with a new one outright. You must be able to send us the net changes to the audience when making automatic updates.

When you use a new audience ID, Liftoff automatically creates a corresponding "Targeted User Tag" in our system. Before this audience can be used for targeting, Liftoff must manually configure the new tag within the appropriate ad group targeting settings.

If you plan to use a new audience, please notify your Liftoff account team in advance and provide a brief description of the audience and how you intend to use it. This will help us ensure the necessary targeting configuration is completed before launch.

Hyphen-delimited parameters: [Timestamp]-<Customer Key>-<Action>-<Audience ID>-[Audience Name]

Field Required? Description
Timestamp No Unix timestamp when device list was generated. 
Customer Key Yes API key provided by Liftoff Account Manager
Action Yes
  • “add” to mark the devices as members of the current audience
  • “remove” to remove the devices from the audience segment
Audience ID Yes A unique identifier for your audience.
Audience Name No A descriptive name for your audience.

Examples

1630094847-1234abcd-add-1234-Lapsed Purchasers

1630094847-1234abcd-remove-1234-1234abcd-add-9876

1630094847-1234abcd-add-1234-Lapsed Purchasers.gz

Action: install

This action will add app install records to our user profiles for the provided advertising IDs. This is most commonly used to suppress existing users from UA campaigns. There is no corresponding action for removing installs so this action should not be used for dynamic audience segments.

Hyphen-delimited parameters: [Timestamp]-<Customer Key>-<Action>-<App Store ID>

Field Required? Description
Timestamp No Unix timestamp when device list was generated. Typically used to differentiate 
Customer Key Yes API key provided by Liftoff engineer or account team.
Action Yes “install”
App Store ID Yes

The Apple or Google Play Store app ID for the app to add an install record for.

  • On Apple this is a numeric ID, e.g. 1234567890
  • On Google Play this is a bundle/package ID, e.g. com.gamestudio.puzzledrop

Examples

1630094847-1234abcd-install-1234567890

1630094847-1234abcd-install-com.gamestudio.puzzledrop-1234abcd-install-com.gamestudio.actiontitle

1630094847-1234abcd-install-1234567890.gz

Related articles

Comments

0 comments

Article is closed for comments.