Smaato

The Switchboard Smaato Connector provides automated reports for the Smaato Publisher Platform (SPX).

Prerequisites

To configure access to the Smaato connector, you’ll need:

  • Client ID
  • Client Secret

To obtain these credentials, log in to your SPX account. Click on “OAuth API Credentials” in the user menu in the top right corner. From this page, click “Generate API credentials->Create Client ID”.

Scheduling

The Smaato 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.

Sample Switchboard Script

import smaato_spx_report from {
    type: "smaato:spx_report";
    key: "smaato_key";
    dimensions: ["DealId","LineItemType", "ApplicationId", "AdspaceId", "CountryCode"];  
    attributes: ["name", "app_url"]; 
    kpis: [];
} using {
    criteria: {
        Date: {
            value: datetime;
        };
        DealId: {
            meta: {
                name: string;
            };
            value: string;
        };
        LineItemType: {
            meta: {
                name: string;
            };
            value: string;
        };
        ApplicationId: {
            meta: {
                name: string;
                app_url: string;
                };
            value: integer;
        };
        AdspaceId: {
            meta: {
                name: string;
                };
            value: integer;
        };
        CountryCode: {
            meta: {
                name: string;
                };
            value: string;
        };
    };
    kpi: {
        CTR: float;
        clicks: integer;
        eCPM: float;
        grossRevenue: float;
        impressions: integer;
        incomingAdRequests: integer;
        netRevenue: float;
        outgoingRequests: integer;
        servedAds: integer;
    };
};

Parameters

Parameter Description Required/Optional?
api_version The Smaato API version. Defaults to "2" Optional
kpis Will return all KPIs if not specificed. Options are:

impressions
grossRevenue
netRevenue		 Optional
dimensions A string list with the following options:

AdvertiserId
ApplicationId
ApplicationType
CountryCode
CreativeId
DealId
DemandPartnerId
LineItemId
LineItemType
OrderId		 Required
attributes A string list of requested attributes. The list of available attributes varies with the choice of dimensions. See table below for more details. Optional

Attributes

The available attributes list varies with the selection of dimensions.

AdvertiserId No supported attributes available.
ApplicationId Available attributes:
  • name
  • app_type
  • app_url
  • iab_category
  • created
ApplicationType No supported attributes available.
AdspaceId Available attributes:
  • name
  • width
  • height
  • iab_category
  • page_placement
CountryCode No supported attributes available.
CreativeId Available attributes:
  • name
  • creative_type
  • status
  • created
DealId No supported attributes available.
DemandPartnerId No supported attributes available.
LineItemId Available attributes:
  • name
  • status
  • start_date
  • end_date
  • priority
  • pacing
  • traffic_allocation
  • created
LineItemType No supported attributes available.
OrderId Available attributes:
  • name
  • advertiser
  • status
  • created