What Is Acuity Ads (illumin)?

Illumin (formerly AcuityAds) is a comprehensive journey advertising platform designed to help marketers engage with consumers at various stages of their journey, utilizing advanced machine learning and real-time data analytics to optimize campaigns across multiple channels, including display, video, and social media.

The illumin platform offers an intuitive drag-and-drop interface for planning, executing, and analyzing marketing strategies, ensuring that advertisers can deliver targeted messages effectively throughout the marketing funnel. The platform integrates with various media channels and provides tools for granular planning, audience engagement mapping, and performance analysis.

Getting Started

1. From Your illumin Account

• Please reach out to your illumin support team to get your Client ID. The Client ID will be needed for the illumin sync injector.

2. From Your MetaRouter Account

To gather the auid value, cauid value, etc., you must add an Acuity Ads sync.

1. From the Pipelines page, find the pipeline associated with the web property you’d like to add a sync to. Hover over the three dot dropdown and select “Build AJS File.”
2. In the Identity Syncs section, select the Acuity Ads sync.
3. Fill out the following fields:
   1. Consent Type - We recommend that you consult with your legal team when determining your consent requirements.
   2. Client ID - Your account’s unique Client ID.
   3. API Timeout (in milliseconds) - Sets a time limit for how long the Sync Injector will wait for an API response from the vendor. The maximum timeout value is 300ms.
   4. Cookie Lifetime (in days) - 365 default.
4. Scroll down and click the Save and Build File button.
5. Deploy your AJS file to propagate changes to your web property.

Technical Details

Sync Types

syncType: fetchSync

Sync Ids

ids: auid, cauid

FetchSync

• This sync does a REST call to an endpoint. Then it will be able to set "identity markers" based on the callback it is passed. The purpose of the callback is to read the client response.

• This sync will be able to read from a request response or from the headers that are passed back from the response.

• Endpoint: https://ums.acuityplatform.com/tum?umid=[CLIENT_ID]

• HTTP method: GET

• Response format: JSON

• Response example : ExampleWillBeAddedSoon

• Identifiers: auid from request

Conclusions

Values added to storage

• *_acuityAds_auid
  • Time to live: Set by the Cookie Lifetime setting in the UI(e.g. 365 days). Defaults to 365 days.
  • Notes: N/A
• *_acuityAds_auid_failure
  • Time to live: 1 day
  • Notes: Created when fetch sync fails.
• *_acuityAds_cauid
  • Time to live: Set by the Cookie Lifetime setting in the UI. Defaults to 365 days.
  • Notes: Value of this marker is defined by auid. Whole value should look like this: auid=${auid}.
• *_acuityAds_cauid_failure
  • Time to live: 1 day
  • Notes: Created when fetch sync fails.

Server-Side Event Payload: providers object enrichments

Upon completion of all vendor's sync, the server-side events will incorporate all resolved identifiers as described above. The following object will be appended to the context.providers property within the event's JSON payload

{
   "acuityAds": {
     "auid": String
     "cauid": String
   }
}

UI build settings

• (Required) Client ID
  • Defines defines the client ID used in fetch url. It's value should be the client ID from the Acuity Ads.
  • Example: "42"
• (Required) Cookie Lifetime (in days)
  • Defines the duration after which a stored value is automatically removed from storage unless renewed. When this time expires, the corresponding storage marker is deleted.
  • Example: 365
• (Required) API Timeout (in miliseconds)
  • Defines how long should the sync injector wait until timing out the request to the URL.
  • Example: 5000