OpenX

The Switchboard OpenX Data Connector provides automated impressions and revenue reports. 

Prerequisites

To configure access to the OpenX Connector, you need:

  • Email address
  • Password
  • Hostname/Domain
  • Realm
  • Key
  • Secret

To obtain the above information, contact your OpenX Account Manager. 

NOTE: OpenX limit per API call is 500k rows. Data is always returned in UTC. 

Scheduling

The OpenX 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

Parameter

Description

Required/Optional?

metrics

A list of requested metrics:

  • allRequests
  • clicks
  • closeAllOccurance
  • closeFirstOccurance
  • collapseAllOccurance
  • collapseFirstOccurance
  • companionClickFirstOccurance
  • companionViewFirstOccurance
  • completeFirstOccurance
  • exchangeFills
  • existFullscreenAllOccurance
  • expandAllOccurance
  • expandFirstOccurance
  • firstQuartileFirstOccurance
  • fullScreenAllOccurance
  • fullScreenFirstOccurance
  • marketImpressions
  • marketPublisherRevenue
  • marketRequests
  • midPointFirstOccurance
  • muteAllOccurance
  • muteFirstOccurance
  • pauseAllOccurance
  • pauseFirstOccurance
  • privateMarketImpressions
  • privateMarketPublisherGrossRe
  • venue
  • resumeAllOccurance
  • resumeFirstOccurance
  • rewindAllOccurance
  • rewindFirstOccurance
  • skipFirstOccurrence
  • startFirstOccurance
  • thirdQuartileFirstOccurance
  • unmuteAllOccurance
  • unmuteFirstOccurance

At least one value is required.

dimensions

A list of requested dimensions:

  • adHeight
  • adSize
  • adWidth
  • brandIndustry
  • buyerId
  • buyerName
  • category1
  • category2
  • day
  • demandPartnerAccountId
  • demandPartnerAccountName
  • distributionChannel
  • hour
  • isRewarded
  • mediaSubtype
  • mobileAppBundle
  • mobileAppName
  • mobileAppStoreURL
  • mobileSDKPlatform
  • openXBrandId
  • openXBrandName
  • openXFacility
  • pageDomain
  • privateMarketplaceAccountExecutive
  • privateMarketplaceAccountManager
  • privateMarketplaceDealPriority
  • privateMarketplaceDealSource
  • privateMarketplaceOpenXDealId
  • privateMarketplacePackageId
  • privateMarketplacePackageName
  • privateMarketplacePublisherDealId
  • privateMarketplacePublisherDealName
  • publisherAccountId
  • publisherAccountName
  • publisherAdUnitId
  • publisherAdUnitName
  • publisherCurrency
  • publisherPlatformName
  • publisherSelectedVideoRespons
  • eProtocol
  • publisherSiteId
  • publisherSiteName
  • publisherSupportedAPIFrameworks
  • publisherSupportedVideoPlaybackMethods
  • transactionTimeHour
  • userBrowserName
  • userDeviceManufacturer
  • userDeviceType
  • userGeoCountry
  • userOperatingSystem
  • videoPlacementSubtype

At least one value is required.

Sample Switchboard Script

import openx_data_report_raw from {
   type: "openx:data";
   key: "openx_credential";
   dimensions:[
       "day",
       "pageDomain",
       "publisherSiteId",
       "publisherSiteName",
       "privateMarketplaceOpenXDealId"];
   metrics: [
       "marketImpressions",
       "marketPublisherRevenue",
       "privateMarketImpressions",
       "privateMarketPublisherGrossRevenue"];
   } using {
       date: datetime;
       day: datetime;
       "pageDomain": string;
       "publisherSiteName": string;
       "publisherSiteId": integer;
       "privateMarketplaceOpenXDealId": integer;
       "privateMarketImpressions": integer;
       "marketImpressions": integer;
       "privateMarketPublisherGrossRevenueInPCoin": float;
       "marketPublisherRevenueInPCoin": float;
};