OpenAI Sync

What is OpenAI?

OpenAI is an artificial intelligence research and deployment company that develops and operates a range of AI products and services. Through its advertising offerings, OpenAI provides a Conversions API (CAPI) that allows advertisers to measure and attribute conversions resulting from their campaigns. This integration captures a URL-based identifier and forwards it to OpenAI's server-side endpoint to support accurate conversion measurement and attribution.


Product Type: Advertising

Integration Type: Starter Kit & ID Sync


Capabilities

  • Captures oppref from URL parameters and stores it in first-party storage.
  • Refreshes the stored value whenever the oppref parameter is detected on a page load.
  • Adds the captured identifier to server-side event payloads for conversion attribution.
  • Forwards resolved identifiers to OpenAI's Conversions API for measurement and targeting.

Sync Details

  • IDs:

    • oppref – A unique reference identifier appended to ad URLs by OpenAI, used to track and attribute conversions back to specific ad interactions.
  • Description:

    • The sync captures oppref from URL parameters.
    • Each value is stored in first-party storage for the duration set by the Cookie Lifetime setting (defaults to 30 days).
    • The stored value is refreshed and reset to the full duration whenever the oppref parameter is detected again on page load.
    • The identifier is added to server-side event payloads for attribution and targeting.
  • 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:

    {
      "openAI": {
        "oppref": "string"
      }
    }
  • Cookie Name:

    • Cookie: _meta_openAI_oppref
    • IndexedDB: [your storage prefix]_openAI_oppref
    • For a general guide on ID Sync validation, see here.

Sync Setup Guide

Add an OpenAI Sync in MetaRouter

To gather the oppref, you must add an OpenAI 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 OpenAI sync.
  3. Fill out the following fields:
    • Cookie Lifetime (days) (Required) – How long a synced identifier remains in first-party storage. When expired or no longer detected, the sync will re-trigger. Example: 30
  4. Scroll down and click the Save and Build File button.
  5. Deploy your AJS file to propagate changes to your web property.