AdForm

The AdForm connector provides automated access to the AdForm API

• Prerequisites
• Scheduling
• Parameters
• Sample SBS Script

Prerequisites

An OAuth client must be registered to consume Adform API, which is done by contacting Adform API support. For more details, please see the AdForm API Authorization prerequisites.

The AdForm connector requires you create an AdForm Key in the Key Editor with the following values:

• Client ID
• Client Secret

Scheduling

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

dimensions string

required

The following dimension values are support as of the time of writing: advertiser, recognisedAdvertiser, advertiserDomain, auctionType, buyer, campaignId, banner, bannerId, campaign, creative, currency, date, day, dealID, dealName, demandPartner, demandSource, domain, inventorySource, month, package, placement, placementId, placementSize, placementType, publisher, publisherId, year, openDealIdDealName, lineItemId, lineItem, city, continent, country, region, mkvKey, mkvValue, winningPriceType

metrics string

required

The following metrics values are support as of the time of writing: bidRequests, bidRequestsCreative, bidRequestsDeal, bidRequestsPackage, clicks, ecpcgross, ecpcnet, ecpcpublisher, ecpmgross, ecpmnet, ecpmpublisher, impressions, paidImpressions, revenuegross, revenuenet, viewImpressionsIAB, viewImpressionsCustom1, viewImpressionsCustom2, uniquecampaignimpressions, uniquelineitemimpressions, bidResponsesDeal, bidResponsesPackage, bidResponsesCreativeSettings, bidResponses, uniqueCampaignClicks, uniqueLineItemClicks, viewableCTR, campaignUniqueViewableCTR, lineItemUniqueViewableCTR, measurableImpressions, impressionsVisibilityTime, averageImpressionsVisibilityTime, bidRequestsDemandPartner, bidResponsesDemandPartner, customfee, dealCustomFee, publisherRevenue

Sample SBS Script

download t from {
                key: "adform";
                type: "adform:report";
                metrics: ["impressions","clicks"];
                dimensions: ["date","campaign","placement"];
} using {*};