Yahoo DSP Metadata: Most-used fields
The table below gives information about most-used fields that you can import from Yahoo DSP Metadata. 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.
accountIdMetric
The unique identifier for an advertiser account, used to associate campaigns, pixels, and other entities.
bidMultiplierCapDimension
The maximum value a bid multiplier can reach, preventing bids from exceeding a certain limit.
bidMultiplierCap_idDimension
The unique identifier for the bid multiplier cap object associated with a line.
bidMultiplierCap_lineIdDimension
Specifies the unique identifier for the line item to which the bid multiplier cap applies. Bid multipliers are always line-specific.
bidMultiplierCap_multiplierCapMetric
Specifies the maximum amount that a line may bid on ad placement opportunities that satisfy the targeting attributes specified for two or more bid multipliers. This prevents bids from exceeding a certain limit.
bidMultipliers.idDimension
A read-only field that specifies the unique identifier for the bid multiplier.
bidMultipliers.multiplierMetric
Specifies the bid multiplier value (a number between 0 and 9.95), which is used to calculate the amount the line will bid on ad placement opportunities that match the specified targeting attributes. A value greater than 1 increases the bid, while a value less than 1 decreases it.
bidMultipliers.targetTypeDimension
Specifies the bid multiplier's targeting attribute, indicating the type of target (e.g., AD, EXCHANGE, DEAL, SEGMENT, AD_POSITION, DEVICE, COUNTRY, CITY).
bidMultipliers.targetValueDimension
Specifies a value for the bid multiplier's targeting attribute. The specific value is determined by the `targetType` field (e.g., ad ID, exchange ID, or a string for ad position).
bidPriceMetric
The price bid for an ad impression.
budgetTypeDimension
The type of budget allocated (e.g., daily budget, total budget).
channelTypeDimension
The type of advertising channel used for the line item (e.g., mobile, desktop, video).
completionThresholdMetric
The percentage threshold for video ad completion that is considered a conversion or goal.
conversionListDimension
A list of conversion events tracked for the campaign or line item.
conversion_categoryDimension
A category or segment that the transaction is in (e.g., “Store Sales”). All rows in files for the same campaign should contain the same transaction_category value in the Yahoo Conversions API.
conversion_default_valueMetric
A placeholder value for a conversion event that can be overridden by a dynamic value at the event level.
createdAtDimension
The timestamp indicating when the object (e.g., campaign, advertiser, pixel) was created.
currencyDimension
The currency type used for financial values.
goalAmountMetric
The target monetary amount for a specific campaign goal.
goalTypeDimension
The type of advertising goal for a campaign or line item (e.g., conversions, impressions).
iabCategoryIdMetric
Specifies the primary category of the advertiser's business, using an ID from the IAB Taxonomy Categories.
iabSecondaryCategoryIdMetric
Specifies a secondary category of the advertiser's business, using an ID from the IAB Taxonomy Categories.
idDimension
The unique identifier for the object.
isCrossdeviceOffDimension
Indicates whether cross-device support for targeting and conversions is disabled. If true, Yahoo DSP will not link cookie and mobile device identifiers.
isNativeEnabledDimension
A boolean indicating if native ad format is enabled for the line item.
landingPageUrlDimension
Specifies the URL that redirects to the final landing page destination for an ad or creative. For advertisers, it specifies the advertiser's website URL.
languageDimension
The language targeted for ad delivery.
mediaTypeDimension
The type of media for the creative (e.g., image, video, native).
nameDimension
The name of the object (e.g., campaign name, line item name).
objectiveDimension
The primary advertising objective for the campaign or line item (e.g., brand awareness, website traffic, conversions).
orderIdMetric
This field represents the unique identifier for an order or campaign within the Yahoo DSP. It is used to filter and retrieve details about specific packages or line items.
pacingModeTypeDimension
The method by which the budget is spent over time (e.g., standard, accelerated).
packageIdMetric
The unique identifier for an advertising package.
pixelIdMetric
Specifies the unique identifier for a pixel, which is an organizational structure for a series of rules used for conversion tracking and retargeting.
schedules.budgetMetric
The total budget allocated for a specific schedule.
schedules.dailyBudgetMetric
The daily budget allocated for a specific schedule.
schedules.dailyBudgetTypeDimension
The type of daily budget (e.g., fixed, impression-based) for a schedule.
schedules.endDateStrDimension
The end date of the schedule, formatted as a string.
schedules.idMetric
The unique identifier for a specific schedule.
schedules.impBudgetMetric
The total impression budget allocated for a specific schedule.
schedules.impDailyBudgetMetric
The daily impression budget allocated for a specific schedule.
schedules.nameDimension
The name of the schedule.
schedules.startDateStrDimension
The start date of the schedule, formatted as a string.
statusDimension
The current operational status of the object (e.g., active, paused, archived).
supplyTypeDimension
The type of inventory supply where ads will be served (e.g., open exchange, private marketplace).
timezoneDimension
The timezone associated with the account or campaign.
updatedAtDimension
The timestamp indicating when the object (e.g., campaign, advertiser, pixel) was last updated.
userFrequencyCapDimension
An object that defines multi-layer frequency capping at the user level, which can be configured with multiple layers of frequency capping parameters.
userFrequencyCap_frequencyCapPacingTypeDimension
Specifies how the user frequency cap budget is spent over time. Allowed values include 'EVEN', 'ASAP', or 'PACE_AHEAD', which determine the delivery strategy for impressions.
userFrequencyCap_frequencyCapPeriodMultiHourMetric
Specifies multi-hour periods for user frequency capping, such as 6 hours or 12 hours.
userFrequencyCap_frequencyCapValueDayMetric
Specifies the maximum number of impressions to serve per day for user frequency capping.
userFrequencyCap_frequencyCapValueHourMetric
Specifies the maximum number of impressions to serve per hour for user frequency capping.
userFrequencyCap_frequencyCapValueMinuteMetric
Specifies the maximum number of impressions to serve per minute for user frequency capping.
userFrequencyCap_frequencyCapValueMonthMetric
Specifies the maximum number of impressions to serve per month for user frequency capping.
userFrequencyCap_frequencyCapValueMultiHourMetric
Specifies the maximum number of impressions to serve over the defined multi-hour period (e.g., 6 or 12 hours) for user frequency capping.
userFrequencyCap_frequencyCapValueWeekMetric
Specifies the maximum number of impressions to serve per week for user frequency capping.