Triplelift Ads

The Triplelift Ads Connector provides automated access to the Triplelift Reporting API, which is designed to expose query functionality to Triplelift’s publisher partners.

Prerequisites

email
used to login Triplelift Console
password
used to login Triplelift Console
API Key
a user-unique API key that will be provided to you by Triplelift using a secure email

Scheduling

The Triplelift Ads connector can be scheduled to ingest data once per day at a user-defined hour and timezone.

By default, the connector will run once at 6am PT.

See Daily Scheduling for more information.

Parameters

The Triplelift Ads Connector provides the ability to specify dimensions and metrics as part of a data query, providing comparable functionality to the Triplelift Console functionality.

metrics string list
required
The following values are allowed:
  • IMPRESSIONS
  • RENDERED
  • FILL_RATE
  • CLICKS
  • CTR
  • REVENUE
  • CPM
  • MOUSEOVERS
  • MOUSEOVER_RATE
  • VIDEO_Q1
  • VIDEO_Q3
  • VIDEO_Q2
  • VIDEO_2S
  • VIDEO_5S
  • VIDEO_10S
  • VIDEO_STARTS
  • VSR
  • VIDEO_COMPLETIONS
  • VCR
  • VIDEO_3S
dimensions string list
required
The following values are allowed:
  • BRAND
  • BROWSER
  • BUYER_MEMBER
  • COUNTRY_NAME
  • DEAL_CODE
  • DEAL_NAME
  • DEVICE_TYPE
  • DOMAIN
  • FORMAT
  • HOUR
  • OS
  • PLACEMENT_ID
  • PLACEMENT_NAME
  • PUBLISHER_ID
  • PUBLISHER_NAME
  • SUPPLY_SOURCE
  • TRANSACTION_TYPE
  • YMD

Note that the data for the HOUR dimension is only available for data that comes from either the current or previous day (based on the current date UTC time) and cannot be backfilled.

Sample Switchboard Script

NOTE: Switchboard injects report_date into the returned json rows.

A typical data row might appear as follows:

"2021-01-05","Facebook","domain.com","6.757364","1105862","1"

import triplelift from {
    key: "triplelift_key";
    type: "triplelift";
    dimensions: [
        "YMD",
        "DOMAIN",
        "PUBLISHER_NAME",
        "PLACEMENT_ID",
        "PLACEMENT_NAME",
        "FORMAT",
        "DEVICE_TYPE",
        "OS",
        "SUPPLY_SOURCE"
    ];
    metrics: [
        "REVENUE",
        "RENDERED",
        "CLICKS",
        "CPM",
        "CTR"
    ];
} using {
    report_date: datetime;
    YMD: datetime("YYYY-MM-dd");
    domain: string;
    placement_id: string;
    placement_name: string;
    format: string;
    device_type: string;
    os: string;
    supply_source: string;
    publisher_name: string;
    revenue: float;
    rendered: integer;
    clicks: integer;
    cpm: float;
    ctr: float; 
};