Amobee Sync

What is Amobee?

Amobee is a global marketing technology company that provides data-driven solutions for advertisers and agencies. It offers an integrated platform for media planning, buying, and real-time analytics across various channels, including digital, TV, and social media. Amobee's technology leverages data to deliver personalized and effective advertising campaigns, aiming to enhance audience engagement and return on investment. By utilizing advanced machine learning and data analytics, Amobee helps brands understand consumer behavior and optimize their marketing strategies.


Product Type: Advertising

Integration Type: Starter Kit & ID Sync


Capabilities

  • Sends a request to Amobee’s identity endpoint using the anonymousId and configured Client ID.
  • Retrieves the uid, a unique user identifier provided by Amobee for identity resolution.
  • Stores the uid in first-party storage for use in downstream event enrichment.
  • Appends the uid to server-side event payloads under context.providers.amobee, enabling Amobee to associate incoming data with known users in its platform.

Considerations

  • Supports re-syncing whenever an Identify call is triggered if Fire on Re-Sync is enabled.

Sync Details

  • IDs:
    • uid – A persistent user identifier provided by Amobee for identity resolution and targeted advertising.
  • Description:
    • Makes a GET request to the configured Amobee identity endpoint using the provided Client ID and current anonymousId.
    • If successful, the response returns a uid that is stored in cookie and IndexedDB storage based on the configured Cookie Lifetime.
    • Sync will retry and re-fire if triggered by an Identify call (when Fire on Re-Sync is enabled).
    • The resolved uid is included in the server-side event payload in the Amobee Starter Kit.
  • Response Example: {"uid":"8575821199332081695"}
  • 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.
    {
       "amobee": {
         "uid": String
       }
    }
    
  • Cookie Name:
    • Cookie: _meta_amobee_uid
    • IndexedDB: [your storage prefix]_amobee_uid
    • For a general guide on ID Sync validation, see here.

Sync Setup Guide

1. Gather Credentials

  • Client ID – This is your Amobee account’s unique identifier, required to generate a valid identity sync request.
    • Please contact your Amobee account representative or customer support to obtain this value.

2. Add An Amobee Sync in MetaRouter

To gather the uid value, you must add an Amobee 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 Amobee sync.
  3. Fill out the following fields:
    1. Client ID – Your Amobee account’s unique identifier. Example: "your-client-id"
    2. API Timeout (in milliseconds) – How long to wait for a response. Example: 300
    3. Cookie Lifetime (in days) – Duration to store the uid. Example: 365
    4. Fire on Re-Sync – Set to on to re-sync on Identify calls. Example: on
  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 Amobee Starter Kit.