AdsWizz

The AdsWizz connector provides automated access to the AdsWizz API

Prerequisites
Scheduling
Ads Bundle
Custom Reports

Prerequisites

The AdsWizz connector requires you create a AdsWizz Key in the Key Editor with the following value:

API key: The API key that you have received from Adswizz. If you do not have one, you have to ask for a key in order to be able to access Adswizz API

Scheduling

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

Ads Bundle

This report bundles data for “agencies”, “advertisers”, “campaigns”, “orders”, and “ads”

Please note that the API will be called once for each ad available, so be cautious about the quota limits.

Parameters

api_version string: optional; The AdsWizz connector supports different API versions: v6 and v7. If no value is specified, we will use v6 by default.

Sample SBS Script

download bundle adswizz_ads_bundle {
    type: "adswizz:ads_bundle";
    key: "adswizz_key";
    api_version: "v7"; \\Optional Field
    
    table agencies using {
        id: integer;
        name: string;
        contact: string;
        email: string;
    };
    
    table advertisers using {
        "id": integer;
        "name": string;
        "contact": string;
        "email":  string;
        "externalReference": string;
        "status": string;
        "notificationStatus": string;
        "adjacencyPeriod": integer;
        "overrideAdjacency": boolean;
        "adClashing": boolean;
        "domain": string;
    };
    
    table campaigns using {
        "id": integer;
        "name": string;
        "campaignType": string;
        "status": string;
        "advertiserId": integer;
        "orderId": float;
        "startDate": datetime;
        "endDate": datetime; 
        "objectiveType":  string;
        "campaignObjective": {
          "type": string;
          "value": integer;
          "unlimited": boolean;
            };
        };
    
    table orders using {
        "id": integer;
        "name": string;
        "advertiserId": integer;
        "dealId": integer;
        "startDate": datetime; 
        "endDate": datetime; 
        "objective": {
          "type": string;
          "value": integer;
          "currency": string;
          "unlimited": boolean;
          "managedObjective": boolean;
          "optimisedObjective":  boolean;
             };
        };
        
    table ads using {
        "id": integer;
        "campaignId": integer;
        "archived": boolean;
        "type": string;
        "adUnitId": integer; 
        };        
};

Custom Reports

Parameters

api_version string: optional; The AdsWizz connector supports different API versions: v6 and v7. If no value is specified, we will use v6 by default.
dimensions string: required; Dimensions are the attributes for your data. For instance country indicates the country where the request originated and os indicates the operating system the request originated.; See the AdsWizz Dimensions endpoint documentation.; You may specify up to five values.
environments string: optional; AUDIOMAX, AUDIOSERVE, AUDIOMATIC; AUDIOSERVE is considered the default
metrics string: required; Metrics are quantitative measurements. For example impressions is a metric that indicates the total number of impressions for a particular ad.; The metrics available are dependent on the environment specified. See the AdsWizz Metrics endpoint documentation

Sample SBS Script

download bundle adswizz_audiomax_advertiser_raw {
    type: "adswizz:custom_reports";
    key: "adswizz_key";
    api_version: "v7"; \\Optional Field
    environment: "AUDIOMAX";
    dimensions: ["salesChannelName",
                "advertiserDomains",
                "zoneName"];
    metrics: ["supplyRevenueInUSD", 
        "supplyGrossClearingPriceSum", 
        "supplyDataCostInUSD", 
        "supplyECPMInUSD", 
        "objectiveCountableSum"
        ];
    
    table custom_reports using { 
      "_interval_from": datetime;
      "_interval_to": datetime;
      "_agency_id": string;
      "salesChannelId": integer;
      "salesChannelName": string;
      "advertiserDomains": string;
      "zoneId": integer;
      "zoneName":  string;
      "objectiveCountableSum": integer;
      "supplyECPMInUSD": float;
      "supplyDataCostInUSD": float;
      "supplyGrossClearingPriceSum": float;
      "supplyRevenueInUSD": float;
    };
};