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.
API name |
Adverity UI name |
Description |
Use in Adverity |
|---|---|---|---|
accountId |
accountId |
The unique identifier for the advertiser account. |
metric |
adInitiations |
adInitiations |
This field specifies the initiation method for an ad, particularly for video and native ads. It indicates whether the ad is auto-initiated (starts without user action) or user-initiated (starts after a user click). |
dimension |
ages |
ages |
Targeting based on specific age ranges of users. |
dimension |
appId |
appId |
Unique identifier for a mobile application, used for targeting or tracking within a line item. |
dimension |
appLocale |
appLocale |
The locale (language and region) of the application being targeted. |
dimension |
appUrl |
appUrl |
The URL or unique identifier of a mobile application. This field is typically used within App Lists for targeting purposes in Yahoo DSP campaigns. |
dimension |
bidMultiplierCap |
bidMultiplierCap |
The maximum value a bid multiplier can reach, preventing bids from exceeding a certain limit. |
dimension |
bidMultiplierCap_bmAdLearnOverride |
bidMultiplierCap_bmAdLearnOverride |
A boolean indicating if the bid multiplier cap overrides the ad learning optimization. |
dimension |
bidMultiplierCap_id |
bidMultiplierCap_id |
The unique identifier for the bid multiplier cap. |
dimension |
bidMultiplierCap_lineId |
bidMultiplierCap_lineId |
The unique identifier of the line item to which the bid multiplier cap applies. |
metric |
bidMultiplierCap_multiplierCap |
bidMultiplierCap_multiplierCap |
The maximum value allowed for the bid multiplier. |
metric |
bidMultipliers.id |
bidMultipliers.id |
The unique identifier for a specific bid multiplier. |
metric |
bidMultipliers.isAppName |
bidMultipliers.isAppName |
A boolean indicating if the bid multiplier is applied to an application name. |
dimension |
bidMultipliers.multiplier |
bidMultipliers.multiplier |
The value by which the base bid is multiplied. |
metric |
bidMultipliers.targetDomain |
bidMultipliers.targetDomain |
The domain to which the bid multiplier applies. |
dimension |
bidMultipliers.targetType |
bidMultipliers.targetType |
The type of target (e.g., domain, geo, segment) for the bid multiplier. |
dimension |
bidPrice |
bidPrice |
The price bid for an ad impression. |
metric |
browsers |
browsers |
Targeting based on the web browsers used by users. |
dimension |
budgetSchedules.budget |
budgetSchedules.budget |
The total budget allocated for a specific budget schedule. |
metric |
budgetSchedules.dailyBudget |
budgetSchedules.dailyBudget |
The daily budget allocated for a specific budget schedule. |
metric |
budgetSchedules.dailyBudgetType |
budgetSchedules.dailyBudgetType |
The type of daily budget (e.g., fixed, impression-based) for a budget schedule. |
dimension |
budgetSchedules.endDate |
budgetSchedules.endDate |
The end date of a budget schedule. |
dimension |
budgetSchedules.id |
budgetSchedules.id |
The unique identifier for a budget schedule. |
metric |
budgetSchedules.impBudget |
budgetSchedules.impBudget |
The total impression budget for a budget schedule. |
metric |
budgetSchedules.impDailyBudget |
budgetSchedules.impDailyBudget |
The daily impression budget for a budget schedule. |
metric |
budgetSchedules.name |
budgetSchedules.name |
The name of the budget schedule. |
dimension |
budgetSchedules.scheduleBudget |
budgetSchedules.scheduleBudget |
The total budget allocated for a specific budget schedule. |
metric |
budgetSchedules.scheduleBudgetType |
budgetSchedules.scheduleBudgetType |
The type of budget (e.g., daily, total) for a budget schedule. |
dimension |
budgetSchedules.scheduleDailyBudget |
budgetSchedules.scheduleDailyBudget |
The daily budget allocated for a specific budget schedule. |
metric |
budgetSchedules.scheduleName |
budgetSchedules.scheduleName |
The name of the budget schedule. |
dimension |
budgetSchedules.startDate |
budgetSchedules.startDate |
The start date of a budget schedule. |
dimension |
budgetType |
budgetType |
The type of budget allocated (e.g., daily budget, total budget). |
dimension |
channelType |
channelType |
The type of advertising channel used for the line item (e.g., mobile, desktop, video). |
dimension |
completionThreshold |
completionThreshold |
The percentage threshold for video ad completion that is considered a conversion or goal. |
metric |
contextualsExcluded |
contextualsExcluded |
A list of contextual categories to exclude from ad delivery. |
dimension |
contextualsIncluded |
contextualsIncluded |
A list of contextual categories to include for ad delivery. |
dimension |
conversionList |
conversionList |
A list of conversion events tracked for the campaign or line item. |
dimension |
conversion_category |
conversion_category |
The category of the conversion event, often based on IAB taxonomy. |
dimension |
conversion_default_value |
conversion_default_value |
The default monetary value assigned to a conversion event. |
metric |
createdAt |
createdAt |
The timestamp indicating when the object was created. |
dimension |
currency |
currency |
The currency type used for financial values. |
dimension |
date |
date |
This field represents a specific date used to define reporting periods, such as the start or end date for a report or a campaign. |
dimension |
dayParting |
dayParting |
Targeting based on specific times of the day or days of the week. |
dimension |
deviceTypes |
deviceTypes |
Targeting based on the types of devices used by users (e.g., desktop, mobile, tablet). |
dimension |
enableSegmentExpansion |
enableSegmentExpansion |
Indicates whether audience segment expansion is enabled, allowing targeting of similar users. |
dimension |
enableViewabilityFreqCap |
enableViewabilityFreqCap |
A boolean indicating if viewability-based frequency capping is enabled. |
dimension |
feeList |
feeList |
A list of fees associated with the campaign or line item. |
dimension |
frequencyCapPeriod |
frequencyCapPeriod |
The time period (e.g., day, week, month) over which a frequency cap is applied. |
dimension |
frequencyCapPeriodType |
frequencyCapPeriodType |
The type of period for frequency capping (e.g., daily, weekly, monthly). |
dimension |
frequencyCapValue |
frequencyCapValue |
The maximum number of times an ad can be shown within the specified frequency cap period. |
metric |
genders |
genders |
Targeting based on the gender of users. |
dimension |
geosExcluded |
geosExcluded |
A list of geographical locations to exclude from ad delivery. |
dimension |
geosIncluded |
geosIncluded |
A list of geographical locations to include for ad delivery. |
dimension |
goalAmount |
goalAmount |
The target monetary amount for a specific campaign goal. |
metric |
goalType |
goalType |
The type of advertising goal for a campaign or line item (e.g., conversions, impressions). |
dimension |
hhFrequencyCapEnabled |
hhFrequencyCapEnabled |
A boolean indicating if household frequency capping is enabled. |
dimension |
householdFrequencyCap |
householdFrequencyCap |
Configuration for frequency capping applied at the household level. |
dimension |
householdFrequencyCap_frequencyCapEnabled |
householdFrequencyCap_frequencyCapEnabled |
A boolean indicating if frequency capping is enabled at the household level. |
dimension |
householdFrequencyCap_frequencyCapPacingType |
householdFrequencyCap_frequencyCapPacingType |
The pacing type for household frequency capping (e.g., even, accelerated). |
dimension |
householdFrequencyCap_frequencyCapPeriodMultiHour |
householdFrequencyCap_frequencyCapPeriodMultiHour |
The multi-hour period for household frequency capping. |
metric |
householdFrequencyCap_frequencyCapValueDay |
householdFrequencyCap_frequencyCapValueDay |
The maximum number of times an ad can be shown to a household per day. |
metric |
householdFrequencyCap_frequencyCapValueHour |
householdFrequencyCap_frequencyCapValueHour |
The maximum number of times an ad can be shown to a household per hour. |
metric |
householdFrequencyCap_frequencyCapValueMinute |
householdFrequencyCap_frequencyCapValueMinute |
The maximum number of times an ad can be shown to a household per minute. |
metric |
householdFrequencyCap_frequencyCapValueMonth |
householdFrequencyCap_frequencyCapValueMonth |
The maximum number of times an ad can be shown to a household per month. |
metric |
householdFrequencyCap_frequencyCapValueMultiHour |
householdFrequencyCap_frequencyCapValueMultiHour |
The maximum number of times an ad can be shown to a household per multi-hour period. |
metric |
householdFrequencyCap_frequencyCapValueWeek |
householdFrequencyCap_frequencyCapValueWeek |
The maximum number of times an ad can be shown to a household per week. |
metric |
iabCategoryId |
iabCategoryId |
The primary IAB (Interactive Advertising Bureau) content category ID, used for content targeting or classification. |
metric |
iabSecondaryCategoryId |
iabSecondaryCategoryId |
The secondary IAB content category ID, providing more granular content targeting or classification. |
metric |
id |
id |
The unique identifier for the object. |
dimension |
inventoryTypes |
inventoryTypes |
Targeting based on types of ad inventory (e.g., guaranteed, non-guaranteed, direct). |
dimension |
isAllCountriesTargeted |
isAllCountriesTargeted |
A boolean indicating if all countries are targeted by the line item. |
dimension |
isCrossdeviceOff |
isCrossdeviceOff |
A boolean indicating if cross-device targeting is disabled. |
dimension |
isNativeEnabled |
isNativeEnabled |
A boolean indicating if native ad format is enabled for the line item. |
dimension |
isps |
isps |
Targeting based on the Internet Service Providers of users. |
dimension |
landingPageUrl |
landingPageUrl |
The URL of the landing page where users are directed after clicking an ad. |
dimension |
language |
language |
The language targeted for ad delivery. |
dimension |
languages |
languages |
Targeting based on the languages of users or content. |
dimension |
lineFrequencyCap |
lineFrequencyCap |
Frequency capping settings applied at the line item level. |
dimension |
mediaType |
mediaType |
The type of media for the creative (e.g., image, video, native). |
dimension |
mobileBrowsers |
mobileBrowsers |
Targeting based on mobile web browsers used by users. |
dimension |
mobileCarriers |
mobileCarriers |
Targeting based on mobile network carriers of users. |
dimension |
mobileMakes |
mobileMakes |
Targeting based on the manufacturers of mobile devices. |
dimension |
mobileModels |
mobileModels |
Targeting based on the specific models of mobile devices. |
dimension |
mobileOs |
mobileOs |
Targeting based on mobile operating systems (e.g., iOS, Android). |
dimension |
mobilePlacements |
mobilePlacements |
Targeting based on ad placement types within mobile applications or websites. |
dimension |
name |
name |
The name of the object (e.g., campaign name, line item name). |
dimension |
objective |
objective |
The primary advertising objective for the campaign or line item (e.g., brand awareness, website traffic, conversions). |
dimension |
orderFrequencyCap |
orderFrequencyCap |
Configuration for frequency capping applied at the order (campaign) level. |
dimension |
orderFrequencyCap_frequencyCapPacingType |
orderFrequencyCap_frequencyCapPacingType |
The pacing type for frequency capping at the order (campaign) level. |
dimension |
orderFrequencyCap_frequencyCapPeriodMultiHour |
orderFrequencyCap_frequencyCapPeriodMultiHour |
The multi-hour period for order-level frequency capping. |
metric |
orderFrequencyCap_frequencyCapValueDay |
orderFrequencyCap_frequencyCapValueDay |
The maximum number of times an ad can be shown within an order per day. |
metric |
orderFrequencyCap_frequencyCapValueHour |
orderFrequencyCap_frequencyCapValueHour |
The maximum number of times an ad can be shown within an order per hour. |
metric |
orderFrequencyCap_frequencyCapValueMinute |
orderFrequencyCap_frequencyCapValueMinute |
The maximum number of times an ad can be shown within an order per minute. |
metric |
orderFrequencyCap_frequencyCapValueMonth |
orderFrequencyCap_frequencyCapValueMonth |
The maximum number of times an ad can be shown within an order per month. |
metric |
orderFrequencyCap_frequencyCapValueMultiHour |
orderFrequencyCap_frequencyCapValueMultiHour |
The maximum number of times an ad can be shown within an order per multi-hour period. |
metric |
orderFrequencyCap_frequencyCapValueWeek |
orderFrequencyCap_frequencyCapValueWeek |
The maximum number of times an ad can be shown within an order per week. |
metric |
orderFrequencyCap_orderId |
orderFrequencyCap_orderId |
The unique identifier of the order to which the frequency cap applies. |
metric |
orderId |
orderId |
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. |
metric |
os |
os |
Targeting based on the operating systems of users’ devices (e.g., Windows, macOS). |
dimension |
pacingModeType |
pacingModeType |
The method by which the budget is spent over time (e.g., standard, accelerated). |
dimension |
packageEnabled |
packageEnabled |
A boolean indicating if the package is currently enabled. |
dimension |
packageId |
packageId |
The unique identifier for an advertising package. |
metric |
pixelId |
pixelId |
The unique identifier for a conversion pixel. |
metric |
playerSizes |
playerSizes |
Targeting based on the size of video players where ads will be displayed. |
dimension |
positions |
positions |
Targeting based on the position of the ad on a page or screen (e.g., above the fold). |
dimension |
publishersIncluded |
publishersIncluded |
A list of publishers explicitly included for ad delivery. |
dimension |
schedules.budget |
schedules.budget |
The total budget allocated for a specific schedule. |
metric |
schedules.dailyBudget |
schedules.dailyBudget |
The daily budget allocated for a specific schedule. |
metric |
schedules.dailyBudgetType |
schedules.dailyBudgetType |
The type of daily budget (e.g., fixed, impression-based) for a schedule. |
dimension |
schedules.endDateStr |
schedules.endDateStr |
The end date of the schedule, formatted as a string. |
dimension |
schedules.id |
schedules.id |
The unique identifier for a specific schedule. |
metric |
schedules.impBudget |
schedules.impBudget |
The total impression budget allocated for a specific schedule. |
metric |
schedules.impDailyBudget |
schedules.impDailyBudget |
The daily impression budget allocated for a specific schedule. |
metric |
schedules.name |
schedules.name |
The name of the schedule. |
dimension |
schedules.startDateStr |
schedules.startDateStr |
The start date of the schedule, formatted as a string. |
dimension |
segmentsExcluded |
segmentsExcluded |
A list of audience segments to exclude from ad delivery. |
dimension |
segmentsIncluded |
segmentsIncluded |
A list of audience segments to include for ad delivery. |
dimension |
siteListsExcluded |
siteListsExcluded |
A list of site or app lists to exclude from ad delivery. |
dimension |
siteListsIncluded |
siteListsIncluded |
A list of site or app lists to include for ad delivery. |
dimension |
status |
status |
The current operational status of the object (e.g., active, paused, archived). |
dimension |
supplyType |
supplyType |
The type of inventory supply where ads will be served (e.g., open exchange, private marketplace). |
dimension |
timezone |
timezone |
The timezone associated with the account or campaign. |
dimension |
updatedAt |
updatedAt |
The timestamp indicating when the object was last updated. |
dimension |
userFrequencyCap |
userFrequencyCap |
Configuration for frequency capping applied at the individual user level. |
dimension |
userFrequencyCap_frequencyCapPacingType |
userFrequencyCap_frequencyCapPacingType |
The pacing type for frequency capping at the user level. |
dimension |
userFrequencyCap_frequencyCapPeriodMultiHour |
userFrequencyCap_frequencyCapPeriodMultiHour |
The multi-hour period for user-level frequency capping. |
metric |
userFrequencyCap_frequencyCapValueDay |
userFrequencyCap_frequencyCapValueDay |
The maximum number of times an ad can be shown to a user per day. |
metric |
userFrequencyCap_frequencyCapValueHour |
userFrequencyCap_frequencyCapValueHour |
The maximum number of times an ad can be shown to a user per hour. |
metric |
userFrequencyCap_frequencyCapValueMinute |
userFrequencyCap_frequencyCapValueMinute |
The maximum number of times an ad can be shown to a user per minute. |
metric |
userFrequencyCap_frequencyCapValueMonth |
userFrequencyCap_frequencyCapValueMonth |
The maximum number of times an ad can be shown to a user per month. |
metric |
userFrequencyCap_frequencyCapValueMultiHour |
userFrequencyCap_frequencyCapValueMultiHour |
The maximum number of times an ad can be shown to a user per multi-hour period. |
metric |
userFrequencyCap_frequencyCapValueWeek |
userFrequencyCap_frequencyCapValueWeek |
The maximum number of times an ad can be shown to a user per week. |
metric |
videoContentLength |
videoContentLength |
Targeting based on the length of video content. |
dimension |
videoPlacementTypes |
videoPlacementTypes |
Targeting based on the placement types for video ads (e.g., in-stream, out-stream). |
dimension |
weatherConditions |
weatherConditions |
Targeting based on current weather conditions (e.g., sunny, rainy). |
dimension |
weatherHumidities_allHumidities |
weatherHumidities_allHumidities |
Targeting based on humidity levels in specific locations. |
dimension |
weatherTemperatures_allTemperatures |
weatherTemperatures_allTemperatures |
Targeting based on temperature ranges in specific locations. |
dimension |
weatherUVs |
weatherUVs |
Targeting based on UV index levels in specific locations. |
dimension |