Salesforce

Reporting API – Dimensions

« Go Back
Information
Reporting API – Dimensions
Reporting-API-Dimensions
Details



The table below lists the dimensions supported by Equativ's new reporting API. Each row contains:

Dimension nameUse CaseDefinition
AdBreakTypeIdBothThe type Id of an in-stream video ad break: 1 - pre-roll; 2 - mid-roll; 3 - post-roll.
AdBreakTypeNameBothThe type name of an in-stream video ad break: pre-roll; mid-roll; post-roll.
AddConsentStringStatusNameRTBThe name of the additional consent string status, as specified by Google's Additional Consent framework; used for vendors who are not yet registered as an IAB Europe TCF vendor, but are registered as a Google Ad Tech Provider.
AddConsentStringVersionIdRTBThe Id of the additional consent string version, as specified by Google's Additional Consent framework; used for vendors who are not yet registered as an IAB Europe TCF vendor, but are registered as a Google Ad Tech Provider.
AdIdRTBA unique ad id sent for each served programmatic ad markup; not related to the ad being served, but to the ad request itself.
AdPodStatusIdRTBThe Id of the ad pod status: 0 - Unknown; 1 - InAdPod; 2 - InPassback; 3 - NotUsed.
AdPodStatusNameRTBThe name of the ad pod status: 0 - Unknown; 1 - InAdPod; 2 - InPassback; 3 - NotUsed.
AdPositionNameRTBThe name of the ad position: atf. - above the fold; btf. - below the fold; mtf. - middle of the page.
AdservingCreativeClickUrlAdservingThe click URL associated with a creative from a direct insertion.
AdservingCreativeDurationAdservingThe duration of a creative from a direct insertion.
AdservingCreativeEndDateAdservingThe end date of a creative from a direct insertion. Format: YYYY-MM-DDTHH:MM:SS.fffff.
AdservingCreativeExternalDescriptionAdservingThe external description of a creative from a direct insertion.
AdservingCreativeFileNameAdservingThe file name of a creative from a direct insertion.
AdservingCreativeFileSizeAdservingThe file size of a creative from a direct insertion.
AdservingCreativeHasGeoTargetingAdservingA boolean indicating if a creative from a direct insertion has geo targeting.
AdservingCreativeHeightAdservingThe height of the creative from a direct (non-programmatic) insertion.
AdservingCreativeIdAdservingThe Id of a creative from a direct insertion.
AdservingCreativeIndexAdservingA dimension used to specify a custom order of the creatives in the insertion's creative list.
AdservingCreativeNameAdservingThe name of a creative from a direct insertion.
AdservingCreativeStartDateAdservingThe start date of a creative from a direct insertion. Format: YYYY-MM-DDTHH:MM:SS.fffff.
AdservingCreativeTypeNameAdservingThe type name of the creative from a direct (non-programmatic) insertion.
AdservingCreativeWeightAdservingThe weight of a creative from a direct insertion (see "Percentage of delivery" in Creative rotation modes).
AdservingCreativeWidthBothThe width of the creative from a direct (non-programmatic) insertion.
AdvertiserBarterAdservingA boolean indicating if the advertiser of a direct campaign is an in-house one (see "In-house Ad" in Creating advertisers and agencies).
AdvertiserDescriptionAdservingThe description of the advertiser of a direct campaign.
AdvertiserDomainRTBThe domain of a programmatic advertiser.
AdvertiserDomainCategoryIdRTBThe Id of the category, a programmatic advertiser's domain belongs to.
AdvertiserDomainIdRTBThe Id of a programmatic advertiser's domain.
AdvertiserExternalIdAdservingThe external id of the advertiser of a direct campaign.
AdvertiserIdAdservingThe Id of the advertiser of a direct campaign.
AdvertiserNameAdservingThe name of the advertiser of a direct campaign.
AdvertiserSalesPersonFirstNameBothThe first name of the sales person, as specified on advertiser level.
AdvertiserSalesPersonIdAdservingThe Id of the sales person associated with the advertiser of a direct campaign.
AdvertiserSalesPersonLastNameBothThe last name of the sales person, as specified on advertiser level.
AdvertiserSalesPersonNameBothThe first and last name of the sales person, as specified on advertiser level.
AdvertiserTrafficManagerFirstNameBothThe first name of the traffic manager, as specified on advertiser level.
AdvertiserTrafficManagerIdAdservingThe Id of the traffic manager associated with the advertiser of a direct campaign.
AdvertiserTrafficManagerLastNameBothThe last name of the traffic manager, as specified on advertiser level.
AdvertiserTrafficManagerNameBothThe first and last name of the traffic manager, as specified on advertiser level.
AgencyIdAdservingThe Id of the agency of a direct campaign.
AgencyNameAdservingThe name of the agency of a direct campaign.
AppOrSiteDomainBoth

The publisher domain or bundle Id, extracted form the ad request. Domains are represented without prefixes like "http://" or "www", and any query string parameters are excluded.

Direct campaign data (Adserving use case) is approximate as the data for this dimension is sampled.

AppOrSiteIdBothThe Id of the site, app or TV channel, as declared under Inventory > Sites & Pages.
AppOrSiteNameBothThe name of the site, app or TV channel, as declared under Inventory > Sites & Pages.
AppSiteChannelExternalIdBothThe external Id of the site, app or TV channel, as declared under Inventory > Sites & Pages.
AppSiteChannelIsMobileBothA boolean indicating if the site, app or TV channel is a mobile one.
AppSiteChannelUrlBothThe URL of the site, app or TV channel.
AttStatusRTBThe authorization status to access app related data, as specified by Apple's App Tracking Transparency (ATT) framework: -1 - ATT Not Supported (for older SDKs that do not recognize ATT); 0 - Not Determined; 1 - Restricted; 2 - Denied; 3 - Authorized.
AttStatusNameRTBThe name of the authorization status to access app related data, as specified by Apple's App Tracking Transparency (ATT) framework: -1 - ATT Not Supported (for older SDKs that do not recognize ATT); 0 - Not Determined; 1 - Restricted; 2 - Denied; 3 - Authorized.
BidStatusIdRTBThe status Id of bids in the auction process: 0 - None; 1 - Loss; 2 - Win etc. Useful for troubelshooting. Works with specific bid related metrics only (e. g. "Bids" metric).
BidStatusNameRTBThe status name of bids in the auction process: 0 - None; 1 - Loss; 2 - Win etc. Useful for troubelshooting. Works with specific bid related metrics only (e. g. "Bids" metric).
BrowserIdBothThe end user's browser Id that calls an ad from Equativ.
BrowserNameBothThe end user's browser name that calls an ad from Equativ.
BrowserParentIdBothThe end user's parent browser Id.
BrowserParentNameBothThe end user's parent browser name.
BuyerContactEmailRTBThe buyer's email address, as specified in the deal.
BuyerContactNameRTBThe buyer's name, as specified in the deal.
CampaignBookingStatusIdBothThe status Id of the campaign. 0 - Draft; 1 - PreBooked; 2 - Booked; 3 - Sold; 4 - Canceled.
CampaignBookingStatusNameBothThe status name of the campaign. 0 - Draft; 1 - PreBooked; 2 - Booked; 3 - Sold; 4 - Canceled.
CampaignEndDateBothThe end date of the campaign. Format: YYYY-MM-DDTHH:MM:SS.fffff.
CampaignExternalIdBothThe external Id of the campaign.
CampaignIdBothThe Id of the campaign.
CampaignNameBothThe name of the campaign.
CampaignSalesPersonIdBothThe Id of the sales person associated with the campaign.
CampaignStartDateBothThe start date of the campaign. Format: YYYY-MM-DDTHH:MM:SS.fffff.
CampaignStatusBothThe status of the campaign: Draft, Prebooked, Booked, Sold, Canceled
CampaignTrafficManagerIdBothThe Id of the traffic manager associated with the campaign.
CityIdBothThe Id of the city where an ad opportunity occurs.
CityNameBothThe name of the city where an ad opportunity occurs.
CmpIdBothThe Id of the Consent Management Platform (CMP) used to retrieve the end users' consent to data processing, in compliance with privacy regulations.
ComputedVideoPlacementIdBothThe Id of the video placement type, according to the IAB's new specification, as computed by Equativ based on the ad request: 1 - Instream; 2 - Accompagnying Content; 3 - Interstitial; 4 - Standalone.
ConsentStringStatusIdBothThe status Id of the IAB Europe TCF consent string: -1 - N/A (malformed or invalid); 0 - Empty; 1 - OK; 2 - Fallback consent connected TV.
ConsentStringStatusNameBothThe status name of the IAB Europe TCF consent string: -1 - N/A (malformed or invalid); 0 - Empty; 1 - OK; 2 - Fallback consent connected TV.
ContentAlbumRTBThe album of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentArtistRTBThe artist of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentCattaxRTBThe categorization taxonomy used to categorize the content surrounding the ad, declared by the publisher as part of content metadata.
ContentChannelDomainRTBThe channel domain of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentChannelIdRTBThe channel Id of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentChannelNameRTBThe channel name of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentContextRTBThe context of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentDistributorIdRTBThe distributor Id of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentDistributorIdRTBThe Id of the distributor of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentDistributorNameRTBThe distributor name of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentDurationCategoryIdRTBThe duration category Id of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentDurationCategoryNameRTBThe duration category name of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentEmbeddableRTBA boolean indicating if the content surrounding the ad is embeddable, declared by the publisher as part of content metadata.
ContentEpisodeNumberIdBothThe episode number Id of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentGenreRTBThe genre of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentIsrcRTBThe International Standard Recording Code (conforming to ISO 3901) of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentKwarrayRTBAn array of keywords describing the content surrounding the ad, declared by the publisher as part of content metadata.
ContentLangbRTBThe language (conforming to IETF BCP 47) of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentLanguageRTBThe language (conforming to ISO-639-1-alpha-2) of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentLivestreamRTBA boolean indicating if the content surrounding the ad is a live stream, declared by the publisher as part of content metadata. FALSE - content not live; TRUE - content is live (e.g. stream, live blog).
ContentNetworkDomainRTBThe content network domain of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentNetworkIdRTBThe network Id of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentNetworkNameRTBThe network name of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentPlayerIdRTBThe player Id of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentPlayerNameRTBThe player name of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentProdqRTBThe production quality of the content surrounding the ad, declared by the publisher as part of content metadata. 0 - Unknown; 1 - Professionally Produced; 2 - Prosumer; 3 - User Generated (UGC).
ContentProviderIdRTBThe provider Id of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentProviderNameRTBThe provider name of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentQagmediaRatingRTBThe rating of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentRatingRTBThe rating of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentSeasonNumberIdBothThe season number Id of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentSeriesRTBThe series of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentTypeNameRTBThe type name of the content surrounding the ad, declared by the publisher as part of content metadata.
ContentUrlRTBThe URL of the content surrounding the ad, declared by the publisher as part of content metadata.  
ContentUserRatingRTBThe user rating of the content surrounding the ad, declared by the publisher as part of content metadata. User ratings may be declared with Stars/Likes etc.
CountryCodeRTBThe country code of the ad opportunity, folIowing the ISO 3166-1 alpha-2 specification.
CountryIdBothThe Id of the country the end user is coming from.
CountryNameBothThe name of the country the end user is coming from.
CpcNetAdservingThe cost-per-click (CPC), as specified at insertion level.
CpmNetAdservingThe Cost per 1000 impressions, as specified in insertions.
CreativeDurationBucketIdBothThe bucket Id of the video creative duration: 0 - Unknown; 1 - Less than 6 seconds; 2 - Between 6 and 15 seconds; 3 - Between 15 and 30 seconds; 4 - Between 30 and 60 seconds; 5 - More than 60 seconds.
CreativeDurationBucketNameBothThe bucket name of the video creative duration: 0 - Unknown; 1 - Less than 6 seconds; 2 - Between 6 and 15 seconds; 3 - Between 15 and 30 seconds; 4 - Between 30 and 60 seconds; 5 - More than 60 seconds.
CreativeHashcodeRTBThe hash code of the creative.
CreativeHeightRTBThe height of the programmatic creative.
CreativeIdRTBThe Id of the programmatic creative.
CreativeSizeRTBThe size (width and height in pixels) of the programmatic creative, separated by an asterisk, e. g.: 300*250; previously, the separator was "x".
CreativeWidthRTBThe width of the programmatic creative.
DayBothThe day dimension.
PublisherDealNameRTBThe name of the deal, as displayed at deal level in EMP.
DeviceTypeIdBothThe Id of the device type: 8 - TV; 16 - Set top box; 32 - Game Console; 64 - Other Connected Devices.
DeviceTypeNameBothThe name of the device type: 8 - TV; 16 - Set top box; 32 - Game Console; 64 - Other Connected Devices.
deviceVendorIdBothThe Id of the device vendor.
deviceVendorNameBothThe name of the device producer/brand; e. g. Apple.
DoohMultiplierRTBThe multilplier to use to compute the number of people exposed to a digital out of home ad.
DoohVenueTypesRTBThe types of spaces/locations/areas where people are exposed to a digital out of home ad.
DspCampaignIdRTBThe Id of a campaign on the DSP side.
DspIdRTBThe Id of the DSP that bids on a bid request.
DspNameRTBThe name of the DSP that bids on a bid request.
EnvironmentTypeIdBothThe Id of the environment type. 0 - Web; 1 - Mobile Web; 2 - App.
EnvironmentTypeNameBothThe name of the environment type. 0 - Web; 1 - Mobile Web; 2 - App.
ExtendedIdsRTBThe extended Ids sent with the ad opportunity. A row in the report containing multiple provider IDs (for example: "4,5") represents the case where extended IDs of multiple providers were sent in the same ad call (for example: Identity Link ("4") and ID5 ("5")).
ExternalContentIdBothThe Id of the content surrounding the ad in a third party system, declared by the publisher as part of content metadata.
externalSeatIdRTBThe Id of a seat in an external system.
FormatExternalIdBothThe external Id to identify a format in third party systems.
FormatHeightBothThe height of the format (in pixels).
FormatIdBothThe Id of the format.
FormatNameBothThe name of the format.
FormatTypeIdBothThe Id of the impression type: 0 - Banner; 1 - VideoInStream; 2 - Native; 3 - VideoOutStream; 4 - Unknown; 5 - Audio.
FormatTypeNameBothThe name of the impression type: 0 - Banner; 1 - VideoInStream; 2 - Native; 3 - VideoOutStream; 4 - Unknown; 5 - Audio.
FormatWidthBothThe width of the format (in pixels).
GdprAppliesBothA boolean indicating if the GDPR legislation applies: 0 - GDPR does not apply (ad call does not come from EU territory); 1 - GDPR applies (ad call comes from EU territory).
GdprVersionBothThe IAB Transparency and Consent Framework (TCF) version.
HasBidFeedbackRTBA boolean indicating if a BidFeedback is provided by the caller in the context of header bidding.
HasBuyerUidRTBA boolean indicating if the Buyer Uid is present in the call. The Buyer Uid is stored on the user’s browser by the DSP through a third-party cookie and is shared with Equativ via cookie-sync. This way, Equativ can link its own Pid with the Buyer Uid and send the latter to the DSP when necessary.
HasIFABothA boolean indicating if an IFA has been sent by the device in the ad call.
HasIFVBothA boolean indicating if an IFV has been sent by the iOS device in the ad call.   
HasUserPidBothA boolean indicating if Equativ's Pid is sent in the ad call. Pid is Equativ's own proprietary user identifier assigned to each user.
HasUserUidBothA boolean indicating if User Uid is sent in the ad call. Uid is a 1st party user identifier generated by a publisher on the website.
HeaderBiddingPartnerNameAdservingThe name of the SSP winning the header bidding competition (in the context of unified auctions). In unified auctions, the highest bid among Equativ's demand partners is in competition with the highest bid among header bidding SSPs.
HeaderBiddingTypeIdRTBThe type Id of the Header Bidding mechanism: 0 - No Header Bidding; 1 - Client Side Header Bidding; 2 - Server Side Header Bidding. This field is computed as follows: IF IsHeaderBidding = True AND IsServerSideBidding = False THEN 1 ELSE IF IsHeaderBidding = True AND IsServerSideBidding = True THEN 2 ELSE 0.
HeaderBiddingTypeNameRTBThe name of the Header Bidding mechanism: 0 - No Header Bidding; 1 - Client Side Header Bidding; 2 - Server Side Header Bidding. This field is computed as follows: IF IsHeaderBidding = True AND IsServerSideBidding = False THEN 1 ELSE IF IsHeaderBidding = True AND IsServerSideBidding = True THEN 2 ELSE 0.
HourBothThe hour dimension.
InputBundleIdRTBThe bundle (app) identifer received in the ad call.
InputVideoPlacementIdRTBThe Id of the video placement type, according to the IAB's new taxonomy: 1 - Instream; 2 - Accompanying Content; 3 - Interstitial; 4 - Standalone.
InsertionDescriptionBothThe description of the insertion.
InsertionEndDateBothThe end date of the insertion. Format: YYYY-MM-DDTHH:MM:SS.fffff.
InsertionExternalDescriptionBothThe external description of the insertion, describing the insertion in a third party system.
InsertionExternalIdBothThe external Id of the insertion, identifying the insertion in a third party system.
InsertionIdBothThe Id of the insertion.
InsertionNameBothThe Name of the insertion.
InsertionPriorityIdBothThe insertion priority Id ranging from "Exclusive without capping" to "Very low without capping".
InsertionPriorityNameBothThe insertion priority name ranging from "Exclusive without capping" to "Very low without capping".
InsertionStartDateBothThe start date of the insertion. Format: YYYY-MM-DDTHH:MM:SS.fffff.
InsertionTimeZoneBothThe time zone of the insertion.
insertionTypeIdBothThe Id of the insertion type that can be assigned to an insertion for reporting purposes (field "Type for report" in insertions); e.g.: 0 - Pay; 1 - Barter; 2 - Performance etc.
insertionTypeNameBothThe name of the insertion type that can be assigned to an insertion for reporting purposes (field "Type for report" in insertions); e.g.: 0 - Pay; 1 - Barter; 2 - Performance etc.
isAllowedToUseGeolocationDataBothA boolean indicating if consent to use geolocation data was given/withheld by the end user under the GPP / GDPR / CCPA frameworks.
isAllowedToUsePersonalDataBothA boolean indicating if consent to use personal data was given/withheld by the end user under the GPP / GDPR / CCPA frameworks.
IsAmpBothA boolean indicating if the ad call is from an Accelerated Mobile Page (AMP).
IsAuctionPackagesRTBA boolean indicating if a deal is an Auction Package deal. Auction Packages are created and managed either by Equativ or curators / buyers using Equativ Buyer Connect.
IsClientSideHeaderBiddingRTBA boolean indicating if the ad opportunity's context is a standard header bidding integration.
IsEquativSdkBothA boolean indicating if the ad opportunity's context is an Equativ SDK integration.
IsHeaderBiddingRTBA boolean indicating if the ad opportunity's context is a header bidding integration (client side header bidding, server side bidding, in-app bidding).        
IsLiveEventBothA boolean indicating if an ad was delivered during a live event (e. g. a soccer match).
IsOpenAuctionRTBA boolean indicating if the winning bid won in an open auction.
IspIdRTBThe Id of the Internet Service Provider.
IspNameRTBThe name of the Internet Service Provider.
IsPrivateDealRTBA boolean indicating if the winning bid was from a private deal.
IsProgrammaticGuaranteedDealRTBA boolean indicating if the winning bid was from a programmatic guaranteed deal.
IsRewardedRTBA boolean indicating if the user is rewarded after viewing an ad (e. g. free access to content, bonus in a game, free music session etc.).
IsRtbAdservingA boolean indicating if an ad opportunity was monetized through RTB.
IsServerSideBiddingRTBA boolean indicating if the ad opportunity's context is a server side bidding integration.
IsWinRTBA boolean indicating if a bid won the auction.
MinuteBothThe minute dimension.
MobileConnectionTypeIdAdservingThe Id of the mobile connection type: 0 - Unknown; 1 - Wifi; 2 - Cell.
MonthBothThe month dimension.
NetworkCurrencyRateBothThe currency rate of the network.
NetworkCurrencySymbolBothThe symbol of the currency of the network.
NetworkTimeZoneBothThe time zone of the network.
OsIdBothThe identifier of the end user's operating system.
OsNameBothThe name of the operating system family (iOS, Android, Windows etc.), as sent in the bid request.
OsParentIdBothThe Id of the end user's parent operating system.
OutputBundleIdRTBThe bundle (app) identifer sent in the bid requests to Equativ's demand partners.
OutputOsNameRTBThe name of the operating system family (iOS, Android, Windows etc.), as sent in the bid request.
OutputOsVersionRTBThe version of the operating system, as sent in the bid request.
OutputStoreUrlRTBThe URL of the app store, as sent in the bid request.
OutputVideoPlacementTypeIdRTBThe identifier of the video placement type, according to the old IAB taxonomy, sent in the bid request: 1 - Instream; 2 - In-Banner; 3 - In-Article; 4 - In-Feed; 5 - Interstitial/Floating.
PackIdBothThe Id of the pack, as declared under Inventory > Packs.
PackNameBothThe name of the pack, as declared under Inventory > Packs.
PageExternalIdBothThe identifier used to identify a page in a third party system.
PageGroupNameBothThe name of the page group a page is assigned to, as declared under Inventory > Sites & Pages. Page groups are groups of formats. Multiple pages of a website can be assigned to the same page group.
PageIdBothThe Id of a page. Pages are declared under Inventory > Sites & Pages.
PageNameBothThe name of a page. Pages are declared under Inventory > Sites & Pages.
PageUrlBothThe URL of the page.
PartnerIdRTBThe Id of the demand partner receiving and bidding on bid requests.
PartnerNameRTBThe name of the demand partner receiving and bidding on bid requests.
PlatformStoreIdRTBThe platform Id of the connected TV app store. 0 - Unknown; 1 - IOS; 2 - Android; 3 - Roku; 4 - Amazon; 5 - Microsoft; 6 - SamsungSmartTV; 7 - LGSmartTV; 8 - SonyPlaystation; 9 - Vizio; 10 - PhilipsSmartTV.
PlatformStoreNameRTBThe platform name of the connected TV app store. 0 - Unknown; 1 - IOS; 2 - Android; 3 - Roku; 4 - Amazon; 5 - Microsoft; 6 - SamsungSmartTV; 7 - LGSmartTV; 8 - SonyPlaystation; 9 - Vizio; 10 - PhilipsSmartTV.
PositionInAdBreakBothThe position of an ad in an ad break.
PostalCodeBothThe postal code, based on the end user's geolocation.
PrivacyRegulationsApplicableBothThe list of applicable privacy regulations, depending on the user's geolocation. Corresponds to the section IDs specified by the Global Privacy Platform framework, e. g. 1 - tcfeuv1; 2 - tcfeuv2 etc. (see documentation).
PublisherDealIdRTBThe Id of the deal, generated by Equativ.
PublisherExternalDealIdRTBThe Id of the deal, as specified during the creation of the deal. This Id is also used by DSPs to identify the deal.
RevenueSharingRTBThe revenue share of the publisher, as defined in the SSP contract between Equativ and the publisher.
ScreenHeightBothThe height of the end user's screen (in pixels).
ScreenWidthBothThe width of the end user's screen (in pixels).
sdkVersionIdBothThe Id of the mobile SDK version.
sdkVersionNameBothThe name of the mobile SDK version.
seatIdRTBThe Id of the buyer seat that bids on the bid request.
SeatNameRTBThe name of the buyer seat that bids on the bid request.
ServerSideBiddingCallerIdRTBThe Id of the caller calling Equativ in the server side bidding context.
serverSideBiddingCallerNameRTBThe name of the caller calling Equativ in the server side bidding context.
StateIdBothThe Id of the state the ad opportunity is originating from; determined based on the user's IP address.
StateNameBothThe name of the state the ad opportunity is originating from; determined based on the user's IP address.
templateNameBothThe name of the creative template. Creative templates are used to configure how the creative is displayed (e. g. as an interstitial).
templateVersionIdBothThe version of the creative template. Creative templates are used to configure how the creative is displayed (e. g. as an interstitial).
TrustIdRTBAn identifier sent by the DSP in the bid repsonse, allowing for improved traceability of ad spend.
VendorListVersionBothThe version of the list of vendors registered in the IAB Europe's Transparency and Consent Framework (TCF).
VideoClientTechnologyIdBothThe Id of the video client technology, sent by Equativ's video plugin in the ad request, using the parameter vct: 1 - Flash; 2 - javascript.
VideoClientTechnologyNameBothThe name of the video client technology. The corresponding Id is sent by Equativ's video plugin in the ad request, using the parameter vct: 1 - Flash; 2 - javascript; see VideoClientTechnologyId.
VideoCmsIdBothThe video content management system of the content surrounding the ad, declared by the publisher as part of content metadata.
VideoContentCategoryRTBThe category of the content surrounding the ad, declared by the publisher as part of content metadata.
VideoContentDurationNameRTBThe duration of the content surrounding the ad, declared by the publisher as part of content metadata.
VideoContentIdRTBThe Id of the content surrounding the ad, declared by the publisher as part of content metadata.
VideoContentTagsRTBThe tags that describe the content surrounding the ad, declared by the publisher as part of content metadata.
VideoContentTitleRTBThe title (name) of the content surrounding the ad, declared by the publisher as part of content metadata.
VideoContentTypeRTBThe type of the content surrounding the ad, declared by the publisher as part of content metadata.
videoErrorCodeIdBothThe Id of the error code that occurred in a video ad.
videoErrorCodeNameBothThe name of the error code that occurred in a video ad.
videoIntegrationTypeIdBothThe Id of the type of out-stream video/in-stream video integration: 0 - N/A; 1 - Instream Plugins; 2 - Instream Embedded Ad Manager; 3 - Outstream synchronous formats (obsolete); 4 - Outstream asynchronous formats.
videoIntegrationTypeNameBothThe name of the type of out-stream video/in-stream video integration: 0 - N/A; 1 - Instream Plugins; 2 - Instream Embedded Ad Manager; 3 - Outstream synchronous formats (obsolete); 4 - Outstream asynchronous formats.
VideoMaxDurationRTBThe maximum duration (in seconds) for RTB (programmatic) video creatives. By default, this parameter is not passed in the VAST request, nor in the bid requests; it can be enabled by setting a positive value; parameter name: vdmax.
VideoMIMEsRTBThe MIME type of the media files in creative templates.
VideoMinDurationRTBThe minimum duration (in seconds) for RTB (programmatic) video creatives. By default, this parameter is not passed in the VAST request, nor in the bid requests; it can be enabled by setting a positive value, greater than 1.
videoPlacementTypeIdRTBThe identifier of the video placement type, according to the old IAB taxonomy, sent in the bid request: 1 - Instream; 2 - In-Banner; 3 - In-Article; 4 - In-Feed; 5 - Interstitial/Floating.
videoPlacementTypeNameRTBThe name of the video placement type, according to the old IAB taxonomy, sent in the bid request: 1 - Instream; 2 - In-Banner; 3 - In-Article; 4 - In-Feed; 5 - Interstitial/Floating.
videoPlaybackMethodIdRTBThe playback method of the video player, specified with the parameter vpmt in GET ad requests or with the "Playback method" parameter in the insertion's creative template: 0 - unknown; 1 - autoplay with sound on; 2 - autoplay with sound off; 3 - play on click with sound on; 4 - play on mouse-over with sound on.
VideoPlayerHeightRTBThe height of the video player.
VideoPlayerSizeBucketIdRTBThe Id of the static video player size, grouped into buckets:
1 - NoSize - both player width and player height equal to or less than 0;
2 - NotCategorized - width between 1 and 49 or height between 1 and 29; any other sizes that do not match with the buckets Small, Large or Extra Large;
3 - Small - Desktop - less than 400x225; Mobile: less than 20% of screen covered;
4 - Large - Desktop: between 400x225 and 1280x720; Mobile: between 21% and 90% of screen covered;
5 - ExtraLarge - Desktop: greater than 1280x720; Mobile: more than 91% of screen covered.
VideoPlayerSizeBucketNameRTBThe name of the static video player size, grouped into buckets:
1 - NoSize - both player width and player height equal to or less than 0;
2 - NotCategorized - width between 1 and 49 or height between 1 and 29; any other sizes that do not match with the buckets Small, Large or Extra Large;
3 - Small - Desktop - less than 400x225; Mobile: less than 20% of screen covered;
4 - Large - Desktop: between 400x225 and 1280x720; Mobile: between 21% and 90% of screen covered;
5 - ExtraLarge - Desktop: greater than 1280x720; Mobile: more than 91% of screen covered.
VideoPlayerWidthRTBThe width of the video player.
VideoProtocolIdsRTBThe video protocol in the bid response: 1 - VAST 1.0; 2 - VAST 2.0; 3 - VAST 3.0; 4 - VAST 1.0 Wrapper; 5 - VAST 2.0 Wrapper; 6 - VAST 3.0 Wrapper; 7 - VAST 4.0; 8 - VAST 4.0 Wrapper; 9 - DAAST 1.0; 10 - DAAST 1.0 Wrapper.
videoSkipIdRTBThe Id of the skippability of the video: -1 - Unknown; 0 - No; 1 - Yes.
videoSkipNameRTBThe name of the skippability of the video: -1 - Unknown; 0 - No; 1 - Yes.
WinnerDealTypeIdRTBThe Id of the deal type that won the auction: 0 - Open Auction (no deal); 1 - Private Auction; 2 - Preferred Deal; 3 - Programmatic Guaranteed; 4 - Auction Package.
WinnerDealTypeNameRTBThe name of the deal type that won the auction: 0 - Open Auction (no deal); 1 - Private Auction; 2 - Preferred Deal; 3 - Programmatic Guaranteed; 4 - Auction Package.

Powered by