Button Sync

What is Button?

Button is a mobile commerce platform that enables seamless in-app purchasing experiences by connecting brands, publishers, and consumers. It provides a deep-linking and monetization infrastructure that facilitates transactions while ensuring a smooth user journey across apps and mobile web. Button's technology helps brands drive conversions, optimize performance marketing, and track user engagement with deterministic attribution. By integrating with Button, businesses can enhance their mobile commerce strategy, leveraging server-side data to improve targeting, personalization, and measurement.


Product Type: Advertising

Integration Type: Starter Kit & ID Sync


Capabilities

  • Captures btn_ref from URL parameters on page load.
  • Stores the identifier in first-party storage for attribution and user recognition.
  • Refreshes the stored value whenever a new btn_ref is detected in the URL.
  • Adds the identifier to server-side events for tracking and reporting through Button’s affiliate ecosystem.

Considerations

  • This sync only activates when the btn_ref parameter is present in the URL.
  • The stored value is updated each time a new btn_ref is detected.
  • Only one identifier is captured by this sync.

Sync Details

  • IDs:
    • btn_ref – A referral ID used by Button to track and attribute user actions across affiliate partners and mobile commerce journeys.
  • Description:
    • Captures the btn_ref parameter from the URL.
    • Stores the value in cookie and IndexedDB storage for the duration set in the UI.
    • Refreshes the TTL if a new btn_ref is detected on a subsequent visit.
    • Adds the value to the server-side event payload for Button attribution.
  • 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.
    {
       "button": {
         "btn_ref": "URL parameter value from btn_ref"
       }
    }
    
  • Cookie Name:
    • Cookie: _meta_button_btn_ref
    • IndexedDB: [your storage prefix]_button_btn_ref
    • For a general guide on ID Sync validation, see here.

Sync Setup Guide

Add a Button Sync in MetaRouter

To gather the btn_ref value, you must add a Button 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 Button sync.
  3. Fill out the following fields:
    1. The Button Source Token Lifetime (in days) – Duration to store the btn_ref identifier. Example: 365
  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 Button Starter Kit.