Criteo Retail Media: Most-used fields#
The table below gives information about most-used fields that you can import from Criteo Retail Media. Other fields might also be available in Adverity.
The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.
API name |
Adverity UI name |
Description |
Use in Adverity |
|---|---|---|---|
accountCompanyName |
dimension |
||
accountCountries |
accountCountries |
Countries associated with the account. Represented as 2-character ISO-3166 alpha-2 codes (e.g., US, FR). |
dimension |
accountCurrency |
accountCurrency |
Default currency for billing, budgeting, bid settings, and campaign performance metrics. Represented as 3-character ISO-4217 currency codes (e.g., USD, EUR). |
dimension |
accountId |
accountId |
The unique identifier of the account, which can be a demand or supply account (generated internally by Criteo). |
dimension |
accountName |
name |
The name of the account, defined at the time of account creation. |
dimension |
accountOnBehalfCompanyName |
dimension |
||
accountTimeZone |
accountTimeZone |
The time zone associated with the account, using IANA (TZ database) identifiers (e.g., America/New_York, Europe/Paris). |
dimension |
accountType |
type |
The type of the account, indicating whether it is a ‘supply’ account for Retailers or a ‘demand’ account for advertisers (brands, marketplace sellers, agencies). |
dimension |
activitySellerId |
The unique identifier for the seller whose advertising activity is being reported. |
dimension |
|
activitySellerName |
The name of the seller associated with the advertising activity. |
dimension |
|
advDate |
The date on which the advertisement event occurred. Dates are reflected based on the API call requested time zone. |
dimension |
|
advEngagement |
dimension |
||
advHour |
The hour of the day when the advertisement event occurred. |
dimension |
|
advProductCategory |
advProductCategory |
The category of the advertised product. |
dimension |
advProductGtin |
advProductGtin |
The Global Trade Item Number (GTIN) for the product that was advertised. |
dimension |
advProductId |
advProductId |
The unique identifier of the advertised product. |
dimension |
advProductMpn |
dimension |
||
advProductName |
advProductName |
The name of the advertised product. |
dimension |
advToPurchasedProductRelationship |
Describes the relationship between an advertised product and a product that was subsequently purchased, often indicating if they are the same or related. |
dimension |
|
assistedSales |
assistedSales |
The number of sales events where an ad contributed to the sale but was not the direct attributing factor. |
metric |
assistedUnits |
assistedUnits |
The number of units where the ad played a supporting role in generating a sale but was not the final attributing factor. These units are excluded from attributed units. |
metric |
attributedOrders |
attributedOrders |
The number of orders directly linked to retail media campaign interactions. |
metric |
attributedSales |
attributedSales |
The sales revenue directly attributed to your marketing campaign, in accordance with your attribution rules, and serving as a measure of campaign conversions. |
metric |
attributedUnits |
attributedUnits |
The number of units sold that are a direct result of your marketing campaign. |
metric |
attributionWindow |
The look-back window (e.g., 7 days, 30 days) used to attribute sales or conversions to an advertisement. |
dimension |
|
brandId |
brandId |
The unique identifier of the brand for the advertised product. |
dimension |
brandName |
brandName |
The name of the brand for the advertised product. |
dimension |
budget |
budget |
The allocated budget for a campaign. |
metric |
budgetRemaining |
budgetRemaining |
The portion of the allocated campaign budget that has not yet been spent. |
metric |
budgetSpent |
budgetSpent |
The total amount of budget that has been spent on the campaign. |
metric |
campaignEndDate |
The date on which the advertising campaign is scheduled to end. |
dimension |
|
campaignId |
campaignId |
The unique identifier for a campaign within the Criteo Retail Media platform. |
dimension |
campaignName |
campaignName |
The name of the campaign. |
dimension |
campaignStartDate |
The date on which the advertising campaign is scheduled to begin. |
dimension |
|
campaignTypeName |
campaignTypeName |
The type of the campaign, such as ‘Open Auction’ or ‘Preferred Deals’. |
dimension |
category |
category |
The category of the product being advertised. |
dimension |
categoryId |
categoryId |
The unique identifier of the product category. |
dimension |
clickAttributionScope |
clickAttributionScope |
Defines the attribution window and rules used to attribute sales or conversions to clicks on ads. |
dimension |
clickAttributionWindow |
clickAttributionWindow |
The lookback window, in days, for attributing conversions to clicks. |
dimension |
clicks |
clicks |
The total number of clicks recorded for an ad. |
metric |
cpc |
cpc |
The Cost Per Click (CPC) for an ad, representing the cost incurred for each click. |
metric |
cpm |
The Cost Per Mille (CPM), representing the cost for one thousand advertisement impressions. |
metric |
|
createdAt |
createdAt |
The timestamp when the campaign or line item was initially created. |
dimension |
ctr |
ctr |
The Click-Through Rate (CTR) of an ad, calculated as the number of clicks divided by the number of impressions. |
metric |
dailyPacing |
dailyPacing |
The target or actual daily spending rate for a campaign or line item. |
metric |
date |
date |
The date on which the reported activity or event occurred. |
dimension |
endDate |
endDate |
The specified end date for a campaign. |
dimension |
frequency |
frequency |
The average number of times a single user has been exposed to an advertisement within the reporting period. |
metric |
gtin |
gtin |
The Global Trade Item Number (GTIN) of the product. |
dimension |
imageUrl |
imageUrl |
The URL of an image for the product. |
dimension |
impressions |
impressions |
The number of times an ad renders on a page. For Sponsored Products, this is when the SKU renders; for Commerce Display, it’s when the entire banner renders. |
metric |
isInStock |
isInStock |
Indicates whether a product is currently available in stock. |
dimension |
keyword |
The keyword or phrase targeted by the advertisement, typically used on search pages. |
dimension |
|
lineItemBudget |
lineItemBudget |
The optional budget allocated specifically for a line item. |
metric |
lineItemBudgetremaining |
lineItemBudgetremaining |
The remaining budget allocated specifically to a particular line item within a campaign. |
metric |
lineItemBudgetspent |
lineItemBudgetspent |
The amount of budget that has been spent on a specific line item within a campaign. |
metric |
lineItemCreatedat |
lineItemCreatedat |
The timestamp when the specific line item was created. |
dimension |
lineItemEnddate |
lineItemEnddate |
The specified end date for a line item. |
dimension |
lineItemId |
lineItemId |
The unique identifier for a line item within a campaign. |
dimension |
lineItemName |
lineItemName |
The name of the line item as specified in the report. |
dimension |
lineItemStartdate |
lineItemStartdate |
The specified start date for a line item. |
dimension |
lineItemStatus |
lineItemStatus |
The current operational status of the line item (e.g., active, paused, archived). |
dimension |
lineItemTargetretailerid |
lineItemTargetretailerid |
The ID of the specific retailer targeted by this line item, as each line item is restricted to a single retailer. |
dimension |
lineItemType |
lineItemType |
The specific type or category of an advertising line item. |
dimension |
lineItemUpdatedat |
lineItemUpdatedat |
The timestamp when the specific line item was last updated. |
dimension |
minBid |
minBid |
The minimum allowed bid for a product or keyword. |
metric |
monthlyPacing |
monthlyPacing |
The target or actual monthly spending rate for a campaign or line item. |
metric |
mpn |
mpn |
The Manufacturer Part Number (MPN) of the product. |
dimension |
name |
A general field representing the name of an entity, such as a campaign, line item, or product. |
dimension |
|
newToBrandAttributedSales |
metric |
||
newToBrandAttributedUnits |
metric |
||
pageTypeName |
The type of retailer web page where an ad creative was displayed, such as a home page, browse page, or product detail page. |
dimension |
|
price |
price |
The price of the product. |
metric |
promotedBrandIds |
promotedBrandIds |
Identifiers of the brands that are being promoted through the campaign or line item. |
dimension |
purchasedDate |
The date when a product was purchased as a result of an attributed transaction. |
dimension |
|
purchasedHour |
The hour when a product was purchased as a result of an attributed transaction. |
dimension |
|
purchasedProductCategory |
The category of the product that was purchased. |
dimension |
|
purchasedProductGtin |
purchasedProductGtin |
The Global Trade Item Number (GTIN) for the product that was purchased. |
dimension |
purchasedProductId |
The unique identifier for the product that was purchased. |
dimension |
|
purchasedProductMpn |
dimension |
||
purchasedProductName |
The name of the product that was purchased. |
dimension |
|
retailerId |
retailerId |
The unique identifier of the retailer associated with the reported activities. |
dimension |
retailerName |
retailerName |
The name of the retailer associated with the reported activities. |
dimension |
roas |
roas |
Return On Ad Spend (ROAS), measuring the revenue generated for every unit of currency spent on ads, inclusive of platform fees. |
metric |
saleSellerId |
The unique identifier for the seller associated with the recorded sale. |
dimension |
|
saleSellerName |
The name of the seller associated with the recorded sale. |
dimension |
|
salesChannel |
salesChannel |
The channel through which a sale or conversion occurred (e.g., online, in-store). |
dimension |
searchTerm |
The actual search query entered by the user that triggered an ad. Criteo also refers to this as the ‘stemmed search term’. |
dimension |
|
sellerId |
The unique identifier for a seller, either associated with an advertising event or a sale. |
dimension |
|
sellerName |
The name of a seller, either associated with an advertising event or a sale. |
dimension |
|
spend |
spend |
The total cost incurred for advertising, inclusive of platform fees. |
metric |
startDate |
startDate |
The specified start date for a campaign. |
dimension |
status |
status |
The current operational status of the campaign (e.g., active, paused, archived). |
dimension |
type |
A general field indicating the type of an entity, such as campaign type, report type, or media type. |
dimension |
|
uniqueVisitors |
uniqueVisitors |
The number of distinct shoppers exposed to an ad within the specified reporting period, identified by retailer cookie IDs. |
metric |
updatedAt |
updatedAt |
The timestamp when the campaign or line item data was last updated. |
dimension |
videoCompletionRate |
The percentage of video ad plays that were completed to 100%. |
metric |
|
videoMuted |
metric |
||
videoPaused |
metric |
||
videoPlayingRate |
metric |
||
videoResumed |
metric |
||
videoStartingRate |
The percentage of video ads that began playing after being served. |
metric |
|
videoUnmuted |
metric |
||
videoViewability |
A metric indicating whether video advertisements met industry standards for being considered viewable (e.g., 50% of pixels in view for at least 2 consecutive seconds). |
metric |
|
videoViews |
The total count of times a video advertisement was viewed. |
metric |
|
videosPlayedTo100 |
The number of times a video advertisement was played to 100% completion. |
metric |
|
videosPlayedTo25 |
metric |
||
videosPlayedTo50 |
metric |
||
videosPlayedTo75 |
metric |
||
videosStarted |
The total number of times a video advertisement began playing. |
metric |
|
viewAttributionScope |
viewAttributionScope |
Defines the attribution window and rules used to attribute sales or conversions to views (impressions) of ads. |
dimension |
viewAttributionWindow |
viewAttributionWindow |
The lookback window, in days, for attributing conversions to ad views. |
dimension |