Amazon DSP Metadata: Most-used fields#
The table below gives information about most-used fields that you can import from Amazon 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 |
|---|---|---|---|
adChoicesPosition |
adChoicesPosition |
The position of the AdChoices icon on the ad creative. |
dimension |
adCreativeFormatProperties.adCopy |
adCreativeFormatProperties.adCopy |
dimension |
|
adCreativeFormatProperties.adCopy.type |
adCreativeFormatProperties.adCopy.type |
dimension |
|
adCreativeFormatProperties.adCreativeFormatType |
adCreativeFormatProperties.adCreativeFormatType |
dimension |
|
adCreativeFormatProperties.additionalAttributes |
adCreativeFormatProperties.additionalAttributes |
dimension |
|
adCreativeFormatProperties.additionalAttributes.allowThirdPartySellers |
adCreativeFormatProperties.additionalAttributes.allowThirdPartySellers |
dimension |
|
adCreativeFormatProperties.additionalAttributes.allowedRetailFormats |
adCreativeFormatProperties.additionalAttributes.allowedRetailFormats |
dimension |
|
adCreativeFormatProperties.additionalAttributes.optimizationGoal |
adCreativeFormatProperties.additionalAttributes.optimizationGoal |
dimension |
|
adCreativeFormatProperties.additionalAttributes.targetPlacements |
adCreativeFormatProperties.additionalAttributes.targetPlacements |
dimension |
|
adCreativeFormatProperties.assets |
adCreativeFormatProperties.assets |
dimension |
|
adCreativeFormatProperties.assets.applyBorder |
adCreativeFormatProperties.assets.applyBorder |
dimension |
|
adCreativeFormatProperties.assets.assetCroppingCoordinates |
adCreativeFormatProperties.assets.assetCroppingCoordinates |
dimension |
|
adCreativeFormatProperties.assets.assetId |
adCreativeFormatProperties.assets.assetId |
dimension |
|
adCreativeFormatProperties.assets.assetType |
adCreativeFormatProperties.assets.assetType |
dimension |
|
adCreativeFormatProperties.assets.assetVersion |
adCreativeFormatProperties.assets.assetVersion |
dimension |
|
adCreativeFormatProperties.assets.associatedAdExperience |
adCreativeFormatProperties.assets.associatedAdExperience |
dimension |
|
adCreativeFormatProperties.assets.url |
adCreativeFormatProperties.assets.url |
dimension |
|
adCreativeFormatProperties.clickActions |
adCreativeFormatProperties.clickActions |
dimension |
|
adCreativeFormatProperties.clickActions.associatedAdExperience |
adCreativeFormatProperties.clickActions.associatedAdExperience |
dimension |
|
adCreativeFormatProperties.clickActions.clickActionType |
adCreativeFormatProperties.clickActions.clickActionType |
dimension |
|
adCreativeFormatProperties.clickActions.urlDestination |
adCreativeFormatProperties.clickActions.urlDestination |
dimension |
|
adCreativeFormatProperties.creativeSizes |
adCreativeFormatProperties.creativeSizes |
dimension |
|
adCreativeFormatProperties.creativeSizes.height |
adCreativeFormatProperties.creativeSizes.height |
metric |
|
adCreativeFormatProperties.creativeSizes.responsive |
adCreativeFormatProperties.creativeSizes.responsive |
dimension |
|
adCreativeFormatProperties.creativeSizes.width |
adCreativeFormatProperties.creativeSizes.width |
metric |
|
adCreativeFormatProperties.products |
adCreativeFormatProperties.products |
dimension |
|
adCreativeFormatProperties.products.productId |
adCreativeFormatProperties.products.productId |
dimension |
|
adCreativeFormatProperties.products.productTitle |
adCreativeFormatProperties.products.productTitle |
dimension |
|
adCreativeFormatProperties.products.productType |
adCreativeFormatProperties.products.productType |
dimension |
|
adCreativeFormatProperties.products.reviewText |
adCreativeFormatProperties.products.reviewText |
dimension |
|
adCreativeFormatProperties.products.reviewUrl |
adCreativeFormatProperties.products.reviewUrl |
dimension |
|
adCreativeFormatProperties.thirdPartyTag |
adCreativeFormatProperties.thirdPartyTag |
dimension |
|
adCreativeFormatProperties.thirdPartyTag.destinationOnAmazon |
adCreativeFormatProperties.thirdPartyTag.destinationOnAmazon |
dimension |
|
adCreativeFormatProperties.thirdPartyTag.tagSource |
adCreativeFormatProperties.thirdPartyTag.tagSource |
dimension |
|
adCreativeFormatProperties.thirdPartyTag.tagType |
adCreativeFormatProperties.thirdPartyTag.tagType |
dimension |
|
adCreativeFormatProperties.trackingUrls |
adCreativeFormatProperties.trackingUrls |
dimension |
|
adCreativeFormatProperties.trackingUrls.type |
adCreativeFormatProperties.trackingUrls.type |
dimension |
|
adCreativeFormatProperties.trackingUrls.url |
adCreativeFormatProperties.trackingUrls.url |
dimension |
|
adCreativeId |
adCreativeId |
The unique identifier for an ad creative. |
metric |
adCreativeModerationStatus |
adCreativeModerationStatus |
dimension |
|
adCreativeName |
adCreativeName |
dimension |
|
adExperiences |
adExperiences |
dimension |
|
adExperiences.adExperience |
adExperiences.adExperience |
dimension |
|
adExperiences.associationModerationStatus |
adExperiences.associationModerationStatus |
dimension |
|
adExperiences.moderationStatus |
adExperiences.moderationStatus |
dimension |
|
adExperiences.reasons |
adExperiences.reasons |
dimension |
|
adGroupId |
adGroupId |
The unique identifier for an ad group. |
metric |
adProduct |
adProduct |
The specific advertising product used for the ad group, such as AMAZON_DSP. |
dimension |
additionalHtml |
additionalHtml |
dimension |
|
advertisedProductCategoryIds |
advertisedProductCategoryIds |
The category IDs of the products being advertised, used to determine campaign eligibility. |
dimension |
advertiserId |
advertiserId |
The unique identifier for the advertiser. |
metric |
bid.baseBid |
bid.baseBid |
The base bid amount for an ad group. |
metric |
bid.currencyCode |
bid.currencyCode |
dimension |
|
bid.maxAverageCPM |
bid.maxAverageCPM |
metric |
|
budgetAmount |
budgetAmount |
The budget amount allocated for a campaign or ad group. |
metric |
budgetCaps |
budgetCaps |
dimension |
|
budgetCaps.amount |
budgetCaps.amount |
metric |
|
budgetCaps.currencyCode |
budgetCaps.currencyCode |
dimension |
|
budgetCaps.recurrenceTimePeriod |
budgetCaps.recurrenceTimePeriod |
dimension |
|
campaignId |
campaignId |
The unique identifier for a campaign. |
metric |
country |
country |
dimension |
|
createdDateTime |
createdDateTime |
The date and time when the entity was created. |
dimension |
creationDate |
creationDate |
dimension |
|
creationDateTime |
creationDateTime |
The date and time when the entity (e.g., campaign, ad group) was created. |
dimension |
creativeAssociationStatus |
creativeAssociationStatus |
dimension |
|
creativeRotationType |
creativeRotationType |
The method used to rotate creatives within an ad group, such as RANDOM. |
dimension |
currency |
currency |
dimension |
|
deliveryStatus |
deliveryStatus |
dimension |
|
endDate |
endDate |
dimension |
|
endDateTime |
endDateTime |
The end date and time for a campaign, ad group, or flight. |
dimension |
fees |
fees |
Information about fees associated with a campaign or ad group. |
dimension |
fees.addToBudgetSpentAmount |
fees.addToBudgetSpentAmount |
dimension |
|
fees.currencyCode |
fees.currencyCode |
dimension |
|
fees.feeType |
fees.feeType |
dimension |
|
fees.feeValue |
fees.feeValue |
metric |
|
fees.feeValueType |
fees.feeValueType |
dimension |
|
fees.thirdPartyProvider |
fees.thirdPartyProvider |
dimension |
|
flights |
flights |
A collection of flight periods for a campaign, each with its own budget and dates. |
dimension |
flights.budgetAmount |
flights.budgetAmount |
The budget amount allocated for a specific flight within a campaign. |
metric |
flights.currencyCode |
flights.currencyCode |
dimension |
|
flights.endDate |
flights.endDate |
dimension |
|
flights.endDateTime |
flights.endDateTime |
The end date and time for a specific flight within a campaign. |
dimension |
flights.flightId |
flights.flightId |
The unique identifier for a flight within a campaign. |
metric |
flights.name |
flights.name |
dimension |
|
flights.startDate |
flights.startDate |
dimension |
|
flights.startDateTime |
flights.startDateTime |
The start date and time for a specific flight within a campaign. |
dimension |
frequencies.frequencyType |
frequencies.frequencyType |
The type of frequency cap applied, such as UNCAPPED. |
dimension |
frequencies.levelType |
frequencies.levelType |
dimension |
|
frequencies.maxImpressions |
frequencies.maxImpressions |
metric |
|
frequencies.timeUnit |
frequencies.timeUnit |
dimension |
|
frequencies.timeUnitCount |
frequencies.timeUnitCount |
metric |
|
hostedType |
hostedType |
dimension |
|
inventoryType |
inventoryType |
The type of inventory where ads will be served, such as DISPLAY, STREAMING_TV, or ONLINE_VIDEO. |
dimension |
language |
language |
dimension |
|
lastUpdatedDate |
lastUpdatedDate |
dimension |
|
lastUpdatedDateTime |
lastUpdatedDateTime |
dimension |
|
name |
name |
The name of a campaign, ad group, or flight. |
dimension |
optimization.automateBudgetAllocation |
optimization.automateBudgetAllocation |
Indicates whether budget allocation is automated by Amazon’s optimization systems. |
dimension |
optimization.bidStrategy |
optimization.bidStrategy |
The bidding strategy used for optimization, such as SPEND_BUDGET_IN_FULL. |
dimension |
optimization.flightBudgetRolloverSetting |
optimization.flightBudgetRolloverSetting |
dimension |
|
optimization.flightBudgetRolloverSetting.rolloverStrategy |
optimization.flightBudgetRolloverSetting.rolloverStrategy |
dimension |
|
optimization.goalSetting.currencyCode |
optimization.goalSetting.currencyCode |
dimension |
|
optimization.goalSetting.goal |
optimization.goalSetting.goal |
The read-only campaign goal inferred from the Key Performance Indicator (KPI), such as AWARENESS, CONSIDERATION, or CONVERSIONS. |
dimension |
optimization.goalSetting.kpi |
optimization.goalSetting.kpi |
The Key Performance Indicator (KPI) for campaign optimization, such as CLICK_THROUGH_RATE, COST_PER_CLICK, or RETURN_ON_AD_SPEND. |
dimension |
optimization.goalSetting.targetKpi |
optimization.goalSetting.targetKpi |
The target value for the Key Performance Indicator (KPI) for campaign optimization. |
metric |
optimization.primaryInventoryTypes |
optimization.primaryInventoryTypes |
dimension |
|
pacing.deliveryProfile |
pacing.deliveryProfile |
The delivery profile for ad pacing, such as EVEN. |
dimension |
profileId |
profileId |
The identifier of a profile associated with the advertiser account. |
metric |
startDate |
startDate |
dimension |
|
startDateTime |
startDateTime |
The start date and time for a campaign, ad group, or flight. |
dimension |
state |
state |
The current state of a campaign, ad group, or ad creative (e.g., ACTIVE, INACTIVE, ENABLED). |
dimension |
targetDetails.adInitiationTarget |
targetDetails.adInitiationTarget |
dimension |
|
targetDetails.adPlayerSizeTarget |
targetDetails.adPlayerSizeTarget |
dimension |
|
targetDetails.audienceTarget |
targetDetails.audienceTarget |
Defines targets based on specific audiences, which can be Amazon-created, custom-built, or from a third-party data provider. |
dimension |
targetDetails.audienceTarget.acrossGroupOperator |
targetDetails.audienceTarget.acrossGroupOperator |
The operator used to join audience groups, such as ALL (AND logic). |
dimension |
targetDetails.audienceTarget.audienceId |
targetDetails.audienceTarget.audienceId |
The unique identifier for an audience in audience targeting. |
metric |
targetDetails.audienceTarget.groupId |
targetDetails.audienceTarget.groupId |
The group ID for an audience within audience targeting. |
metric |
targetDetails.audienceTarget.inGroupOperator |
targetDetails.audienceTarget.inGroupOperator |
The operator used to join audiences within a group, such as ANY (OR logic) or ALL (AND logic). |
dimension |
targetDetails.audienceTarget.targetType |
targetDetails.audienceTarget.targetType |
The type of audience target, specifically AUDIENCE. |
dimension |
targetDetails.autoTarget |
targetDetails.autoTarget |
dimension |
|
targetDetails.autoTarget.matchType |
targetDetails.autoTarget.matchType |
dimension |
|
targetDetails.autoTarget.targetType |
targetDetails.autoTarget.targetType |
dimension |
|
targetDetails.contentGenreTarget |
targetDetails.contentGenreTarget |
dimension |
|
targetDetails.contentInstreamPositionTarget |
targetDetails.contentInstreamPositionTarget |
dimension |
|
targetDetails.contentOutstreamPositionTarget |
targetDetails.contentOutstreamPositionTarget |
dimension |
|
targetDetails.contentRatingTarget |
targetDetails.contentRatingTarget |
dimension |
|
targetDetails.dayPartTarget |
targetDetails.dayPartTarget |
Defines targets based on specific times of day (day parts). |
dimension |
targetDetails.deviceTarget |
targetDetails.deviceTarget |
Defines targets based on device types. |
dimension |
targetDetails.domainTarget |
targetDetails.domainTarget |
Defines targets based on specific site domains for inclusion or exclusion. |
dimension |
targetDetails.inventorySourceTarget |
targetDetails.inventorySourceTarget |
Defines targets based on inventory sources, including deals and exchanges. |
dimension |
targetDetails.keywordTarget |
targetDetails.keywordTarget |
dimension |
|
targetDetails.locationTarget |
targetDetails.locationTarget |
Defines targets based on geographic locations such as countries, states, postal codes, DMAs, and cities. |
dimension |
targetDetails.productCategoryTarget |
targetDetails.productCategoryTarget |
A type of contextual targeting using ASIN categories. |
dimension |
targetDetails.productTarget |
targetDetails.productTarget |
A type of contextual targeting using specific ASINs (Amazon Standard Identification Numbers). |
dimension |
targetDetails.thirdPartyTarget |
targetDetails.thirdPartyTarget |
Defines targets using segments from third-party vendors like DoubleVerify and Oracle Data Cloud. |
dimension |
targetDetails.thirdPartyTarget.targetType |
targetDetails.thirdPartyTarget.targetType |
dimension |
|
targetDetails.thirdPartyTarget.thirdPartyTargetDetails |
targetDetails.thirdPartyTarget.thirdPartyTargetDetails |
dimension |
|
targetDetails.videoAdFormatTarget |
targetDetails.videoAdFormatTarget |
Defines targets based on video ad formats. |
dimension |
targetId |
targetId |
metric |
|
targetingSettings.amazonViewability.includeUnmeasurableImpressions |
targetingSettings.amazonViewability.includeUnmeasurableImpressions |
Indicates whether unmeasurable impressions are included in Amazon viewability calculations. |
dimension |
targetingSettings.amazonViewability.viewabilityTier |
targetingSettings.amazonViewability.viewabilityTier |
The viewability tier for Amazon DSP campaigns, such as ALL_TIERS. |
dimension |
targetingSettings.automatedTargetingTactic |
targetingSettings.automatedTargetingTactic |
dimension |
|
targetingSettings.defaultAudienceTargetingMatchType |
targetingSettings.defaultAudienceTargetingMatchType |
dimension |
|
targetingSettings.enableLanguageTargeting |
targetingSettings.enableLanguageTargeting |
dimension |
|
targetingSettings.timeZoneType |
targetingSettings.timeZoneType |
The time zone type for targeting, such as VIEWER. |
dimension |
targetingSettings.userLocation |
targetingSettings.userLocation |
dimension |
|
targetingSettings.userLocationSignal |
targetingSettings.userLocationSignal |
The signal used to determine user location for targeting, such as CURRENT. |
dimension |
targetingSettings.videoCompletionTier |
targetingSettings.videoCompletionTier |
dimension |
|
timezone |
timezone |
dimension |
|
url |
url |
dimension |