Acuity Ads (illumin) Sync

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.


Product Type: Advertising

Integration Type: Starter Kit & ID Sync


Capabilities

  • Pulls the Acuity Ads user identifier (auid) and Acuity Ads cookie (cauid) to be used in the connection parameter of the Acuity Ads starter kit.

Sync Details

  • IDs:
    • auid - Acuity Ads user identifier.
    • cauid - Acuity Ads cookie. Value of this marker is defined by auid. Whole value should look like this: auid=${auid}.
  • Description:
    • A request is sent to Acuity Ads' identity endpoint using the configured Client ID.
    • If successful, two identifiers—auid and cauid—are returned and stored for a set duration, based on the Cookie Lifetime setting in the UI.
    • The cauid value is derived from auid in the format auid=${auid}.
    • If the request fails, fallback values are temporarily stored for 1 day to prevent repeated failed attempts.
    • The resolved identifiers are added to the context.providers.acuityAds object in all server-side event payloads.
    • Additional syncs are paused until the ID Sync Time To Live period expires to avoid redundant requests.
    • The sync request will time out based on the API Timeout setting defined in the UI.
  • Server-side Event Payload: 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
       }
    }
    
  • Cookie Name:
    • Cookie: _meta_acuityAds_auid, _meta_acuityAds_auid_failure, _meta_acuityAds_cauid, _meta_acuityAds_cauid_failure
    • IndexedDB: [your storage prefix]_acuityAds_auid, [your storage prefix]_acuityAds_auid_failure, [your storage prefix]_acuityAds_cauid, [your storage prefix]_acuityAds_cauid_failure
    • For a general guide on ID Sync validation, see here.

Sync Setup Guide

1. Gather Credentials

  • Client ID - 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. Add an Acuity Ads Sync in MetaRouter

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.

What’s Next

If applicable, proceed with setting up your Acuity Ads Starter Kit.