Reporting API: dimension reference
The table below lists the dimensions supported by Equativ's new reporting API. Each row contains:
- Dimension name
- Use case - the use case the given dimension can be used in. For more information, see section "Use cases" in Reporting API: get started.
- Definition
| Dimension name | Use Case | Definition |
|---|---|---|
| AdBreakTypeId | Both | The type Id of an in-stream video ad break: 1 - pre-roll; 2 - mid-roll; 3 - post-roll. |
| AdBreakTypeName | Both | The type name of an in-stream video ad break: pre-roll; mid-roll; post-roll. |
| AddConsentStringStatusName | RTB | The 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. |
| AddConsentStringVersionId | RTB | The 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. |
| AdId | RTB | A unique ad id sent for each served programmatic ad markup; not related to the ad being served, but to the ad request itself. |
| AdPodStatusId | RTB | The Id of the ad pod status: 0 - Unknown; 1 - InAdPod; 2 - InPassback; 3 - NotUsed. |
| AdPodStatusName | RTB | The name of the ad pod status: 0 - Unknown; 1 - InAdPod; 2 - InPassback; 3 - NotUsed. |
| AdPositionName | RTB | The name of the ad position: atf. - above the fold; btf. - below the fold; mtf. - middle of the page. |
| AdservingCreativeClickUrl | Adserving | The click URL associated with a creative from a direct insertion. |
| AdservingCreativeDuration | Adserving | The duration of a creative from a direct insertion. |
| AdservingCreativeEndDate | Adserving | The end date of a creative from a direct insertion. Format: |
| AdservingCreativeExternalDescription | Adserving | The external description of a creative from a direct insertion. |
| AdservingCreativeFileName | Adserving | The file name of a creative from a direct insertion. |
| AdservingCreativeFileSize | Adserving | The file size of a creative from a direct insertion. |
| AdservingCreativeHasGeoTargeting | Adserving | A boolean indicating if a creative from a direct insertion has geo targeting. |
| AdservingCreativeHeight | Adserving | The height of the creative from a direct (non-programmatic) insertion. |
| AdservingCreativeId | Adserving | The Id of a creative from a direct insertion. |
| AdservingCreativeIndex | Adserving | A dimension used to specify a custom order of the creatives in the insertion's creative list. |
| AdservingCreativeName | Adserving | The name of a creative from a direct insertion. |
| AdservingCreativeStartDate | Adserving | The start date of a creative from a direct insertion. Format: |
| AdservingCreativeTypeName | Adserving | The type name of the creative from a direct (non-programmatic) insertion. |
| AdservingCreativeWeight | Adserving | The weight of a creative from a direct insertion (creative rotation). |
| AdservingCreativeWidth | Both | The width of the creative from a direct (non-programmatic) insertion. |
| AdvertiserBarter | Adserving | A boolean indicating if the advertiser of a direct campaign is an in-house one. |
| AdvertiserDescription | Adserving | The description of the advertiser of a direct campaign. |
| AdvertiserDomain | RTB | The domain of a programmatic advertiser. |
| AdvertiserDomainCategoryId | RTB | The Id of the category, a programmatic advertiser's domain belongs to. |
| AdvertiserDomainId | RTB | The Id of a programmatic advertiser's domain. |
| AdvertiserExternalId | Adserving | The external id of the advertiser of a direct campaign. |
| AdvertiserId | Adserving | The Id of the advertiser of a direct campaign. |
| AdvertiserName | Adserving | The name of the advertiser of a direct campaign. |
| AdvertiserSalesPersonFirstName | Both | The first name of the sales person, as specified on advertiser level. |
| AdvertiserSalesPersonId | Adserving | The Id of the sales person associated with the advertiser of a direct campaign. |
| AdvertiserSalesPersonLastName | Both | The last name of the sales person, as specified on advertiser level. |
| AdvertiserSalesPersonName | Both | The first and last name of the sales person, as specified on advertiser level. |
| AdvertiserTrafficManagerFirstName | Both | The first name of the traffic manager, as specified on advertiser level. |
| AdvertiserTrafficManagerId | Adserving | The Id of the traffic manager associated with the advertiser of a direct campaign. |
| AdvertiserTrafficManagerLastName | Both | The last name of the traffic manager, as specified on advertiser level. |
| AdvertiserTrafficManagerName | Both | The first and last name of the traffic manager, as specified on advertiser level. |
| AgencyId | Adserving | The Id of the agency of a direct campaign. |
| AgencyName | Adserving | The name of the agency of a direct campaign. |
| AppOrSiteDomain | Both |
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 ( |
| AppOrSiteId | Both | The Id of the site, app or TV channel, as declared under Inventory > Sites & Pages. |
| AppOrSiteName | Both | The name of the site, app or TV channel, as declared under Inventory > Sites & Pages. |
| AppSiteChannelExternalId | Both | The external Id of the site, app or TV channel, as declared under Inventory > Sites & Pages. |
| AppSiteChannelIsMobile | Both | A boolean indicating if the site, app or TV channel is a mobile one. |
| AppSiteChannelUrl | Both | The URL of the site, app or TV channel. |
| AttStatus | RTB | 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. |
| AttStatusName | RTB | The 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. |
| BidStatusId | RTB | The 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). |
| BidStatusName | RTB | The 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). |
| BrowserId | Both | The end user's browser Id that calls an ad from Equativ. |
| BrowserName | Both | The end user's browser name that calls an ad from Equativ. |
| BrowserParentId | Both | The end user's parent browser Id. |
| BrowserParentName | Both | The end user's parent browser name. |
| BuyerContactEmail | RTB | The buyer's email address, as specified in the deal. |
| BuyerContactName | RTB | The buyer's name, as specified in the deal. |
| CampaignBookingStatusId | Both | The status Id of the campaign. 0 - Draft; 1 - PreBooked; 2 - Booked; 3 - Sold; 4 - Canceled. |
| CampaignBookingStatusName | Both | The status name of the campaign. 0 - Draft; 1 - PreBooked; 2 - Booked; 3 - Sold; 4 - Canceled. |
| CampaignEndDate | Both | The end date of the campaign. Format: |
| CampaignExternalId | Both | The external Id of the campaign. |
| CampaignId | Both | The Id of the campaign. |
| CampaignName | Both | The name of the campaign. |
| CampaignSalesPersonId | Both | The Id of the sales person associated with the campaign. |
| CampaignStartDate | Both | The start date of the campaign. Format: |
| CampaignStatus | Both | The status of the campaign: Draft, Prebooked, Booked, Sold, Canceled |
| CampaignTrafficManagerId | Both | The Id of the traffic manager associated with the campaign. |
| CityId | Both | The Id of the city where an ad opportunity occurs. |
| CityName | Both | The name of the city where an ad opportunity occurs. |
| CmpId | Both | The Id of the Consent Management Platform (CMP) used to retrieve the end users' consent to data processing, in compliance with privacy regulations. |
| ComputedVideoPlacementId | Both | The 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. |
| ConsentStringStatusId | Both | The status Id of the IAB Europe TCF consent string: -1 - N/A (malformed or invalid); 0 - Empty; 1 - OK; 2 - Fallback consent connected TV. |
| ConsentStringStatusName | Both | The status name of the IAB Europe TCF consent string: -1 - N/A (malformed or invalid); 0 - Empty; 1 - OK; 2 - Fallback consent connected TV. |
| ContentAlbum | RTB | The album of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentArtist | RTB | The artist of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentCattax | RTB | The categorization taxonomy used to categorize the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentChannelDomain | RTB | The channel domain of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentChannelId | RTB | The channel Id of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentChannelName | RTB | The channel name of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentContext | RTB | The context of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentDistributorId | RTB | The Id of the distributor of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentDistributorId | RTB | The distributor Id of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentDistributorName | RTB | The distributor name of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentDurationCategoryId | RTB | The duration category Id of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentDurationCategoryName | RTB | The duration category name of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentEmbeddable | RTB | A boolean indicating if the content surrounding the ad is embeddable, declared by the publisher as part of content metadata. |
| ContentEpisodeNumberId | Both | The episode number Id of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentGenre | RTB | The genre of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentIsrc | RTB | The International Standard Recording Code (conforming to ISO 3901) of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentKwarray | RTB | An array of keywords describing the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentLangb | RTB | The language (conforming to IETF BCP 47) of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentLanguage | RTB | The language (conforming to ISO-639-1-alpha-2) of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentLivestream | RTB | A 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). |
| ContentNetworkDomain | RTB | The content network domain of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentNetworkId | RTB | The network Id of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentNetworkName | RTB | The network name of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentPlayerId | RTB | The player Id of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentPlayerName | RTB | The player name of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentProdq | RTB | The 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). |
| ContentProviderId | RTB | The provider Id of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentProviderName | RTB | The provider name of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentQagmediaRating | RTB | The rating of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentRating | RTB | The rating of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentSeasonNumberId | Both | The season number Id of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentSeries | RTB | The series of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentTypeName | RTB | The type name of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentUrl | RTB | The URL of the content surrounding the ad, declared by the publisher as part of content metadata. |
| ContentUserRating | RTB | The 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. |
| CountryCode | RTB | The country code of the ad opportunity, folIowing the ISO 3166-1 alpha-2 specification. |
| CountryId | Both | The Id of the country the end user is coming from. |
| CountryName | Both | The name of the country the end user is coming from. |
| CpcNet | Adserving | The cost-per-click (CPC), as specified at insertion level. |
| CpmNet | Adserving | The Cost per 1000 impressions, as specified in insertions. |
| CreativeDurationBucketId | Both | The 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. |
| CreativeDurationBucketName | Both | The 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. |
| CreativeHashcode | RTB | The hash code of the creative. |
| CreativeHeight | RTB | The height of the programmatic creative. |
| CreativeId | RTB | The Id of the programmatic creative. |
| CreativeSize | RTB | The size (width and height in pixels) of the programmatic creative, separated by an asterisk, e. g.: 300*250; previously, the separator was "x". |
| CreativeWidth | RTB | The width of the programmatic creative. |
| Day | Both | The day dimension. |
| DeviceTypeId | Both | The Id of the device type: 8 - TV; 16 - Set top box; 32 - Game Console; 64 - Other Connected Devices. |
| DeviceTypeName | Both | The name of the device type: 8 - TV; 16 - Set top box; 32 - Game Console; 64 - Other Connected Devices. |
| deviceVendorId | Both | The Id of the device vendor. |
| deviceVendorName | Both | The name of the device producer/brand; e. g. Apple. |
| DoohMultiplier | RTB | The multilplier to use to compute the number of people exposed to a digital out of home ad. |
| DoohVenueTypes | RTB | The types of spaces/locations/areas where people are exposed to a digital out of home ad. |
| DspCampaignId | RTB | The Id of a campaign on the DSP side. |
| DspId | RTB | The Id of the DSP that bids on a bid request. |
| DspName | RTB | The name of the DSP that bids on a bid request. |
| EnvironmentTypeId | Both | The Id of the environment type. 0 - Web; 1 - Mobile Web; 2 - App. |
| EnvironmentTypeName | Both | The name of the environment type. 0 - Web; 1 - Mobile Web; 2 - App. |
| ExtendedIds | RTB | The 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")). |
| ExternalContentId | Both | The Id of the content surrounding the ad in a third party system, declared by the publisher as part of content metadata. |
| externalSeatId | RTB | The Id of a seat in an external system. |
| FormatExternalId | Both | The external Id to identify a format in third party systems. |
| FormatHeight | Both | The height of the format (in pixels). |
| FormatId | Both | The Id of the format. |
| FormatName | Both | The name of the format. |
| FormatTypeId | Both | The Id of the impression type: 0 - Banner; 1 - VideoInStream; 2 - Native; 3 - VideoOutStream; 4 - Unknown; 5 - Audio. |
| FormatTypeName | Both | The name of the impression type: 0 - Banner; 1 - VideoInStream; 2 - Native; 3 - VideoOutStream; 4 - Unknown; 5 - Audio. |
| FormatWidth | Both | The width of the format (in pixels). |
| GdprApplies | Both | A 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). |
| GdprVersion | Both | The IAB Transparency and Consent Framework (TCF) version. |
| HasBidFeedback | RTB | A boolean indicating if a BidFeedback is provided by the caller in the context of header bidding. |
| HasBuyerUid | RTB | A 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. |
| HasIFA | Both | A boolean indicating if an IFA has been sent by the device in the ad call. |
| HasIFV | Both | A boolean indicating if an IFV has been sent by the iOS device in the ad call. |
| HasUserPid | Both | A boolean indicating if Equativ's Pid is sent in the ad call. Pid is Equativ's own proprietary user identifier assigned to each user. |
| HasUserUid | Both | A 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. |
| HeaderBiddingPartnerName | Adserving | The 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. |
| HeaderBiddingTypeId | RTB | The 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. |
| HeaderBiddingTypeName | RTB | The 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. |
| Hour | Both | The hour dimension. |
| InputBundleId | RTB | The bundle (app) identifer received in the ad call. |
| InputVideoPlacementId | RTB | The Id of the video placement type, according to the IAB's new taxonomy: 1 - Instream; 2 - Accompanying Content; 3 - Interstitial; 4 - Standalone. |
| InsertionDescription | Both | The description of the insertion. |
| InsertionEndDate | Both | The end date of the insertion. Format: |
| InsertionExternalDescription | Both | The external description of the insertion, describing the insertion in a third party system. |
| InsertionExternalId | Both | The external Id of the insertion, identifying the insertion in a third party system. |
| InsertionId | Both | The Id of the insertion. |
| InsertionName | Both | The Name of the insertion. |
| InsertionPriorityId | Both | The insertion priority Id ranging from "Exclusive without capping" to "Very low without capping". |
| InsertionPriorityName | Both | The insertion priority name ranging from "Exclusive without capping" to "Very low without capping". |
| InsertionStartDate | Both | The start date of the insertion. Format: |
| InsertionTimeZone | Both | The time zone of the insertion. |
| insertionTypeId | Both | The 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. |
| insertionTypeName | Both | The 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. |
| IsAllowedToUseGeolocationData | Both | A boolean indicating if consent to use geolocation data was given/withheld by the end user under the GPP / GDPR / CCPA frameworks. |
| IsAllowedToUsePersonalData | Both | A boolean indicating if consent to use personal data was given/withheld by the end user under the GPP / GDPR / CCPA frameworks. |
| IsAmp | Both | A boolean indicating if the ad call is from an Accelerated Mobile Page (AMP). |
| IsAuctionPackages | RTB | A 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. |
| IsClientSideHeaderBidding | RTB | A boolean indicating if the ad opportunity's context is a standard header bidding integration. |
| IsEquativSdk | Both | A boolean indicating if the ad opportunity's context is an Equativ SDK integration. |
| IsHeaderBidding | RTB | A boolean indicating if the ad opportunity's context is a header bidding integration (client side header bidding, server side bidding, in-app bidding). |
| IsLiveEvent | Both | A boolean indicating if an ad was delivered during a live event (e. g. a soccer match). |
| IsOpenAuction | RTB | A boolean indicating if the winning bid won in an open auction. |
| IsPrivateDeal | RTB | A boolean indicating if the winning bid was from a private deal. |
| IsProgrammaticGuaranteedDeal | RTB | A boolean indicating if the winning bid was from a programmatic guaranteed deal. |
| IsRewarded | RTB | A 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.). |
| IsRtb | Adserving | A boolean indicating if an ad opportunity was monetized through RTB. |
| IsServerSideBidding | RTB | A boolean indicating if the ad opportunity's context is a server side bidding integration. |
| IsWin | RTB | A boolean indicating if a bid won the auction. |
| IspId | RTB | The Id of the Internet Service Provider. |
| IspName | RTB | The name of the Internet Service Provider. |
| Minute | Both | The minute dimension. |
| MobileConnectionTypeId | Adserving | The Id of the mobile connection type: 0 - Unknown; 1 - Wifi; 2 - Cell. |
| Month | Both | The month dimension. |
| NetworkCurrencyRate | Both | The currency rate of the network. |
| NetworkCurrencySymbol | Both | The symbol of the currency of the network. |
| NetworkTimeZone | Both | The time zone of the network. |
| OsId | Both | The identifier of the end user's operating system. |
| OsName | Both | The name of the operating system family (iOS, Android, Windows etc.), as sent in the bid request. |
| OsParentId | Both | The Id of the end user's parent operating system. |
| OutputBundleId | RTB | The bundle (app) identifer sent in the bid requests to Equativ's demand partners. |
| OutputOsName | RTB | The name of the operating system family (iOS, Android, Windows etc.), as sent in the bid request. |
| OutputOsVersion | RTB | The version of the operating system, as sent in the bid request. |
| OutputStoreUrl | RTB | The URL of the app store, as sent in the bid request. |
| OutputVideoPlacementTypeId | RTB | The 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. |
| PackId | Both | The Id of the pack, as declared under Inventory > Packs. |
| PackName | Both | The name of the pack, as declared under Inventory > Packs. |
| PageExternalId | Both | The identifier used to identify a page in a third party system. |
| PageGroupName | Both | The 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. |
| PageId | Both | The Id of a page. Pages are declared under Inventory > Sites & Pages. |
| PageName | Both | The name of a page. Pages are declared under Inventory > Sites & Pages. |
| PageUrl | Both | The URL of the page. |
| PartnerId | RTB | The Id of the demand partner receiving and bidding on bid requests. |
| PartnerName | RTB | The name of the demand partner receiving and bidding on bid requests. |
| PlatformStoreId | RTB | The 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. |
| PlatformStoreName | RTB | The 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. |
| PositionInAdBreak | Both | The position of an ad in an ad break. |
| PostalCode | Both | The postal code, based on the end user's geolocation. |
| PrivacyRegulationsApplicable | Both | The 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). |
| PublisherDealId | RTB | The Id of the deal, generated by Equativ. |
| PublisherDealName | RTB | The name of the deal, as displayed at deal level in EMP. |
| PublisherExternalDealId | RTB | The Id of the deal, as specified during the creation of the deal. This Id is also used by DSPs to identify the deal. |
| RevenueSharing | RTB | The revenue share of the publisher, as defined in the SSP contract between Equativ and the publisher. |
| ScreenHeight | Both | The height of the end user's screen (in pixels). |
| ScreenWidth | Both | The width of the end user's screen (in pixels). |
| sdkVersionId | Both | The Id of the mobile SDK version. |
| sdkVersionName | Both | The name of the mobile SDK version. |
| SeatName | RTB | The name of the buyer seat that bids on the bid request. |
| seatId | RTB | The Id of the buyer seat that bids on the bid request. |
| ServerSideBiddingCallerId | RTB | The Id of the caller calling Equativ in the server side bidding context. |
| serverSideBiddingCallerName | RTB | The name of the caller calling Equativ in the server side bidding context. |
| StateId | Both | The Id of the state the ad opportunity is originating from; determined based on the user's IP address. |
| StateName | Both | The name of the state the ad opportunity is originating from; determined based on the user's IP address. |
| templateName | Both | The name of the creative template. Creative templates are used to configure how the creative is displayed (e. g. as an interstitial). |
| templateVersionId | Both | The version of the creative template. Creative templates are used to configure how the creative is displayed (e. g. as an interstitial). |
| TrustId | RTB | An identifier sent by the DSP in the bid repsonse, allowing for improved traceability of ad spend. |
| VendorListVersion | Both | The version of the list of vendors registered in the IAB Europe's Transparency and Consent Framework (TCF). |
| VideoClientTechnologyId | Both | The Id of the video client technology, sent by Equativ's video plugin in the ad request, using the parameter vct: 1 - Flash; 2 - javascript. |
| VideoClientTechnologyName | Both | The 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. |
| VideoCmsId | Both | The video content management system of the content surrounding the ad, declared by the publisher as part of content metadata. |
| VideoContentCategory | RTB | The category of the content surrounding the ad, declared by the publisher as part of content metadata. |
| VideoContentDurationName | RTB | The duration of the content surrounding the ad, declared by the publisher as part of content metadata. |
| VideoContentId | RTB | The Id of the content surrounding the ad, declared by the publisher as part of content metadata. |
| VideoContentTags | RTB | The tags that describe the content surrounding the ad, declared by the publisher as part of content metadata. |
| VideoContentTitle | RTB | The title (name) of the content surrounding the ad, declared by the publisher as part of content metadata. |
| VideoContentType | RTB | The type of the content surrounding the ad, declared by the publisher as part of content metadata. |
| videoErrorCodeId | Both | The Id of the error code that occurred in a video ad. |
| videoErrorCodeName | Both | The name of the error code that occurred in a video ad. |
| videoIntegrationTypeId | Both | The 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. |
| videoIntegrationTypeName | Both | The 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. |
| VideoMaxDuration | RTB | The 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. |
| VideoMIMEs | RTB | The MIME type of the media files in creative templates. |
| VideoMinDuration | RTB | The 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. |
| VideoPlayerHeight | RTB | The height of the video player. |
| VideoPlayerSizeBucketId | RTB | The 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. |
| VideoPlayerSizeBucketName | RTB | The 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. |
| VideoPlayerWidth | RTB | The width of the video player. |
| VideoPlaybackMethodId | RTB | The 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. |
| VideoProtocolIds | RTB | The 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. |
| videoPlacementTypeId | RTB | The 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. |
| videoPlacementTypeName | RTB | The 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. |
| videoSkipId | RTB | The Id of the skippability of the video: -1 - Unknown; 0 - No; 1 - Yes. |
| videoSkipName | RTB | The name of the skippability of the video: -1 - Unknown; 0 - No; 1 - Yes. |
| WinnerDealTypeId | RTB | The 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. |
| WinnerDealTypeName | RTB | The 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. |