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.
accountId Metric
The unique identifier for an advertiser account, used to associate campaigns, pixels, and other entities.
bidMultiplierCap Dimension
The maximum value a bid multiplier can reach, preventing bids from exceeding a certain limit.
bidPrice Metric
The price bid for an ad impression.
budgetSchedules.budget Metric
Specifies the total budget allocated for a campaign or package within a defined schedule. This is typically required when the budgetType is set to CURRENCY.
budgetSchedules.dailyBudget Metric
Specifies the daily budget amount within a budget schedule for a campaign or package. This is typically required when budgetType is CURRENCY and dailyBudgetType is SPECIFIED_AMOUNT.
budgetSchedules.dailyBudgetType Dimension
Specifies the type of daily budget being used within a budget schedule (e.g., currency-based, impression-based).
budgetSchedules.endDate Dimension
Specifies the end date for a specific budget schedule within a campaign or package, in yyyy-MM-dd format.
budgetSchedules.id Metric
Specifies the unique identifier for a budget schedule.
budgetSchedules.name Dimension
Specifies the name of the budget schedule. This is required when defining multiple schedules.
budgetSchedules.scheduleBudget Metric
Specifies the total budget of a package within its schedule. This field is required when the budgetType is CURRENCY.
budgetSchedules.scheduleBudgetType Dimension
Specifies the type of budget for the schedule (e.g., currency-based, impression-based).
budgetSchedules.scheduleDailyBudget Metric
Specifies the total number of impressions or the daily budget amount purchased per day for a package.
budgetSchedules.scheduleName Dimension
Specifies the name of the schedule for lines. It is required when specifying multiple schedules.
budgetSchedules.startDate Dimension
Specifies the start date for a specific budget schedule within a campaign or package, in yyyy-MM-dd format.
budgetType Dimension
The type of budget allocated (e.g., daily budget, total budget).
channelType Dimension
The type of advertising channel used for the line item (e.g., mobile, desktop, video).
completionThreshold Metric
The percentage threshold for video ad completion that is considered a conversion or goal.
conversionList Dimension
A list of conversion events tracked for the campaign or line item.
conversion_category Dimension
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_value Metric
A placeholder value for a conversion event that can be overridden by a dynamic value at the event level.
createdAt Dimension
The timestamp indicating when the object (e.g., campaign, advertiser, pixel) was created.
currency Dimension
The currency type used for financial values.
frequencyCapPeriodType Dimension
Specifies the period type for frequency capping, such as minutes, hourly, daily, weekly, or monthly.
frequencyCapValue Metric
Specifies the maximum number of impressions to serve within a given frequency capping period.
frequencyGroupEnabled Dimension
This field, when enabled, allows for the use of Frequency Groups for advertiser, campaign, package, and line frequency caps, enabling programmatic management of separate frequency strategies within an advertiser.
goalAmount Metric
The target monetary amount for a specific campaign goal.
goalType Dimension
The type of advertising goal for a campaign or line item (e.g., conversions, impressions).
householdFrequencyCap Dimension
An object that defines multi-layer frequency capping at the household level, which can be configured with multiple layers of frequency capping parameters.
householdFrequencyCap_frequencyCapEnabled Dimension
Indicates whether frequency capping is enabled for households.
householdFrequencyCap_frequencyCapPeriodMultiHour Metric
Specifies multi-hour periods for household frequency capping, such as 6 hours or 12 hours.
householdFrequencyCap_frequencyCapValueDay Metric
Specifies the maximum number of impressions to serve per day for household frequency capping.
householdFrequencyCap_frequencyCapValueHour Metric
Specifies the maximum number of impressions to serve per hour for household frequency capping.
householdFrequencyCap_frequencyCapValueMinute Metric
Specifies the maximum number of impressions to serve per minute for household frequency capping.
householdFrequencyCap_frequencyCapValueMonth Metric
Specifies the maximum number of impressions to serve per month for household frequency capping.
householdFrequencyCap_frequencyCapValueMultiHour Metric
Specifies the maximum number of impressions to serve over the defined multi-hour period (e.g., 6 or 12 hours) for household frequency capping.
householdFrequencyCap_frequencyCapValueWeek Metric
Specifies the maximum number of impressions to serve per week for household frequency capping.
iabCategoryId Metric
Specifies the primary category of the advertiser's business, using an ID from the IAB Taxonomy Categories.
iabSecondaryCategoryId Metric
Specifies a secondary category of the advertiser's business, using an ID from the IAB Taxonomy Categories.
id Dimension
The unique identifier for the object.
isCrossdeviceOff Dimension
Indicates whether cross-device support for targeting and conversions is disabled. If true, Yahoo DSP will not link cookie and mobile device identifiers.
isNativeEnabled Dimension
A boolean indicating if native ad format is enabled for the line item.
landingPageUrl Dimension
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.
language Dimension
The language targeted for ad delivery.
mediaType Dimension
The type of media for the creative (e.g., image, video, native).
name Dimension
The name of the object (e.g., campaign name, line item name).
objective Dimension
The primary advertising objective for the campaign or line item (e.g., brand awareness, website traffic, conversions).
orderFrequencyCap Dimension
An object that defines multi-layer frequency capping for a campaign (referred to as 'order' in this context), allowing up to 3 layers of frequency capping.
orderFrequencyCap_frequencyCapPeriodMultiHour Metric
Specifies the multi-hour period for order/campaign frequency capping, such as 6 hours or 12 hours. This is mandatory when frequencyCapPeriodMultiHour is specified.
orderFrequencyCap_frequencyCapValueDay Metric
Specifies the maximum number of impressions to serve per day for order/campaign frequency capping.
orderFrequencyCap_frequencyCapValueHour Metric
Specifies the maximum number of impressions to serve per hour for order/campaign frequency capping.
orderFrequencyCap_frequencyCapValueMinute Metric
Specifies the maximum number of impressions to serve per minute for order/campaign frequency capping.
orderFrequencyCap_frequencyCapValueMonth Metric
Specifies the maximum number of impressions to serve per month for order/campaign frequency capping.
orderFrequencyCap_frequencyCapValueMultiHour Metric
Specifies the maximum number of impressions to serve over the defined multi-hour period (e.g., 6 or 12 hours) for order/campaign frequency capping.
orderFrequencyCap_frequencyCapValueWeek Metric
Specifies the maximum number of impressions to serve per week for order/campaign frequency capping.
orderFrequencyCap_frequencyGroupIndex Metric
Specifies the number of the frequency group that this frequency cap belongs to. Groups are defined at the advertiser level and values can range from 0 to 4.
orderFrequencyCap_orderId Metric
Specifies the ID of the order (campaign) to which the frequency cap applies.
orderId Metric
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.
pacingModeType Dimension
The method by which the budget is spent over time (e.g., standard, accelerated).
packageEnabled Dimension
Indicates whether packages are enabled for a campaign.
packageGoals Dimension
This object specifies multiple goals the platform uses to optimize package performance, such as CPC, CPA, CPCV, VCPM, ROAS, ECPM, CPIA, CPSV, IFO_CPA, IFO_ROAS, and CUSTOMER_VALUE_OPTIMIZATION. It requires Yahoo Blueprint Performance to be enabled at the campaign level and a budget distributor at the package level.
packageId Metric
The unique identifier for an advertising package.
pixelId Metric
Specifies the unique identifier for a pixel, which is an organizational structure for a series of rules used for conversion tracking and retargeting.
schedules.budget Metric
The total budget allocated for a specific schedule.
schedules.dailyBudget Metric
The daily budget allocated for a specific schedule.
schedules.dailyBudgetType Dimension
The type of daily budget (e.g., fixed, impression-based) for a schedule.
schedules.endDateStr Dimension
The end date of the schedule, formatted as a string.
schedules.id Metric
The unique identifier for a specific schedule.
schedules.impBudget Metric
The total impression budget allocated for a specific schedule.
schedules.impDailyBudget Metric
The daily impression budget allocated for a specific schedule.
schedules.minDailyBudget Metric
Specifies the minimum daily budget amount for a line item within a schedule.
schedules.name Dimension
The name of the schedule.
schedules.startDateStr Dimension
The start date of the schedule, formatted as a string.
status Dimension
The current operational status of the object (e.g., active, paused, archived).
supplyType Dimension
The type of inventory supply where ads will be served (e.g., open exchange, private marketplace).
timezone Dimension
The timezone associated with the account or campaign.
updatedAt Dimension
The timestamp indicating when the object (e.g., campaign, advertiser, pixel) was last updated.
userFrequencyCap Dimension
An object that defines multi-layer frequency capping at the user level, which can be configured with multiple layers of frequency capping parameters.
userFrequencyCap_frequencyCapPeriodMultiHour Metric
Specifies multi-hour periods for user frequency capping, such as 6 hours or 12 hours.
userFrequencyCap_frequencyCapValueDay Metric
Specifies the maximum number of impressions to serve per day for user frequency capping.
userFrequencyCap_frequencyCapValueHour Metric
Specifies the maximum number of impressions to serve per hour for user frequency capping.
userFrequencyCap_frequencyCapValueMinute Metric
Specifies the maximum number of impressions to serve per minute for user frequency capping.
userFrequencyCap_frequencyCapValueMonth Metric
Specifies the maximum number of impressions to serve per month for user frequency capping.
userFrequencyCap_frequencyCapValueMultiHour Metric
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_frequencyCapValueWeek Metric
Specifies the maximum number of impressions to serve per week for user frequency capping.