Amazon S3

Sync your user with Audiens

This document will outline the cookie sync procedure for the Audiens platform.


Requirements:

  1. The user must already be already mapped in the Audiens system.

User mapping steps:

  1. Partner's client: The user visit a page where the Audiens pixel is present and a call is made to the endpoint.
  2. Audiens user mapping: Audiens receive the call identify the user.
  3. Audiens reply: Audiens will conclude the redirect flow with an empty 1x1 pixel.

Add the Audiens pixel

To map the user with Audiens, the partner will call the endpoint and initiate the sync procedure.

The URL must respect the following format:

http(s)://data.audiens.com/v1/cookie/match/?audiens_partner={an_id}&audiens_partner_uuid={an_id}

Mandatory parameters:

audiens_partner:
The id of the Partner provided by Audiens during the integration kick-off.
audiens_partner_uuid
The user identification parameter used by the Partner, it will be required to store the matching table on Audiens side.

Examples:

http(s)://data.audiens.com/v1/cookie/match/?audiens_partner=7&audiens_partner_uuid=234
http(s)://data.audiens.com/v1/cookie/match/?audiens_partner=44&audiens_partner_uuid=4578bb95aa2a4

The simplest way to implement the Audiens Mapping Service to an html page is to add an img tag with the correct formatted URL

<img src='http(s)://data.audiens.com/v1/cookie/match/?audiens_partner=7&audiens_partner_uuid=23' />

Audiens identify the user

Audiens will match the audiens_partner_uuid with the internal profiled user.

From this point forward the audiens_partner_uuid can be used to send user data.


Exceptions:

Whenever is possible the system will always try to deliver the invisible 1x1 pixel to avoid console/network notification.

Error codes are listed below:

400
Reason: Malformed request, there is something wrong with the request

Storage on S3 buckets
Send your data to Audiens using AWS S3

Amazon S3 is provided together with the access credentials :

  • Path of the folder bucket.
  • Access Key.
  • Secret Access Key.

Standard format of the data storage URL is:

https://audiens.s3.amazonaws.com/{partner-id}/{date-component}/{filename}

{partner-id}:

Is the partner id provided by Audiens during the integration kick-off.

Examples:

  • 1245
  • 4178

{date-component}

Is the date of files that are provided the split is mandatory as it is used by the system to handle import.

Examples:

  • 2017/01/01
  • 2017/03/10

The date component is in the format yyyy/mm/dd

{filename}

The name of the file that the partner is uploading. The filename can be any format the partner desire. The only restriction is that the extension must be .gz and the file is compressed accordingly.

Examples:

  • 124dfgtre_53ns.gz
  • 20170101_23456789.gz
  • 2017-01-01_11-40_123456.gz

A non mandatory format proposal: yyyymmddhis.gz example 20170101102059.gz

File content format

The content of the file must adhere at the following convention

partner-user-uuid,segment1_id[;segment2_id][;segment_3_id]

{partner-uuid}

Is the uuid provided by the partner during the cookie-sync phase, it will be used by the system to relate the segment to the user.

{segment1_id}

Can be multiple for each line, they represent the segment id of the taxonomy.

Examples:

7958b37e-955b-4aaa-a5a3-9b94f3b1c9fc,12456;78965;441447;8569;478454
807e16fa-0942-466b-80a0-1bec896bfe44,17456;78895;42347;85149;447544
2825ca84-4910-453f-be08-9906d76622d2,12156;78965;254447;98769;98854
6adb1b44-ea68-47bc-8cc9-dd5b913f64aa,4569856;781254;15677;8748;4854

The file must not exceed the 20MB size limit

The same partner-uuid should be present only one time per data file