User matching and activation service.
Endpoints for matching the user's uid cookie with a given hash.
All the match endpoints apply the same logic except the return value:
| Endpoint | Return | Use case |
|---|---|---|
| /match | HTML | to use in a <iframe/>'s src |
| /match/pixel.gif | image | to use in a <img/>'s src |
| /match/redirect | redirection | to use in a <a/>'s href to match the user and redirect him to the target page |
For the matching to be successful, the query param providerId must be an enabled MatchProvider configured in Audience's system.
The hash given to the endpoint should exactly match a hash present within the system.
Example to hash an unique identifier (as long as the data in the system was processed the same way):
function encode {
echo -n $1 |
awk '{print tolower($0)}' | tr -d '\n' | # convert to lowercase
openssl dgst -binary -sha256 | # apply SHA256 hash function
base64 | sed -e "s/\//_/g" -e "s/=*$//" # encode using url-safe base64
}
Concrete example: example@example.com becomes McVUPBc00lxyBvX9WRUl0Clb7G_oT_gvlGo0_pcKHmY.
Tries to match Audience's cookie with the query param hash value.
An empty HTML page is returned. The HTML may contain additional tags to activate the user with:
configId is not present;configId is present.Adequate to use in a <iframe/>'s src.
| providerId required | string The |
| configId | string The |
| id_{idType} required | string Multiple instances of this query parameter can be received.
The If configured for the given |
| cookies | boolean Default: true If false, a new adstax_uid Cookie won't be generated if it is missing from the request. |
| Cookie | string
|
Tries to match Audience's ID cookie with the query param {hash} value. An blank pixel gif is returned.
Adequate to use in a <img/>'s src.
| providerId required | string The |
| id_{idType} required | string Multiple instances of this query parameter can be received.
The If configured for the given |
| cookies | boolean Default: true If false, a new adstax_uid Cookie won't be generated if it is missing from the request. |
| Cookie | string
|
Tries to match Audience's ID cookie with the query param hash value.
A redirection to ourl is returned.
Adequate to use in a <a/>'s href to match the user and redirect him to the target page.
| providerId required | string The |
| id_{idType} required | string Multiple instances of this query parameter can be received.
The If configured for the given |
| cookies | boolean Default: true If false, a new adstax_uid Cookie won't be generated if it is missing from the request. |
| ourl required | string The URL to which the browser will be redirected. This field must be URL-encoded. |
| Cookie | string
|
Tries to activate an user identified by the request UserId with the configuration defined by the specified
ActivationContainer. An HTML page is returned, containing:
<img/> tags pointing to the URLs configured by DataReceiver.dataTransferUrlTemplate with the macros
replaced by the user's parsed attributes for that DataReceiver config;<img/> tags pointing to the URLs configured by DataReceiver.cookieSyncRedirectUrl with the
adstax_uid encoded for the specific partner.The DataReceivers that are considered for activation are all those enabled for the provided ActivationContainer.
Adequate to use in a <iframe/>'s src.
| receiverId | string The |
| configId | string The |
| id_{idType} | string Overrides the request UserId which is extracted by Cookie by default. The |
| Cookie | string
|
Tries to activate an user identified by the request UserId with the configuration defined by the specified
ActivationContainer*. A redirect is performed to an DataReceiver.dataTransferUrlTemplate of the
DataReceivers enabled for the provided ActivationContainer. The DataReceiver is chosen at
random if ActivationContainer.receiverRedirectActivation.random* is enabled. Otherwise, the receiver whose
id is specified in ActivationContainer.receiverRedirectActivation.receiver is used.
Background activations are performed for all DataReceivers enabled for the provided ActivationContainer.
Adequate to use in a <img/>'s src as long as the configured DataReceiver.dataTransferUrlTemplate
returns an image as well.
| receiverId | string The |
| configId | string The |
| id_{idType} | string Overrides the request UserId which is extracted by Cookie by default. The |
| Cookie | string
|
The privacy cookie is updated so that future match requests for that user are ignored.
| token required | string A token needed for alteration to the cookie privacy status.
It must match the token found inside the cookie |
{- "status": "cookie",
- "token": "string"
}The privacy cookie is updated so that future match requests for that user are ignored.
| token required | string A token needed for alteration to the cookie privacy status.
It must match the token found inside the cookie |
{- "status": "cookie",
- "token": "string"
}The privacy cookie is updated so that future match requests are considered normally.
| token required | string A token needed for alteration to the cookie privacy status.
It must match the token found inside the cookie |
{- "status": "cookie",
- "token": "string"
}The privacy cookie is updated so that future match requests are considered normally.
| token required | string A token needed for alteration to the cookie privacy status.
It must match the token found inside the cookie |
{- "status": "cookie",
- "token": "string"
}