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
accessibilityText	accessibilityText	Accessible names that are labels given to HTML elements for assistive technologies like screen readers.	dimension
adChoicesPosition	adChoicesPosition	The position where the AdChoices icon is displayed on the ad creative, e.g., ‘BOTTOM_LEFT’, ‘TOP_RIGHT’.	dimension
adCreativeCategories	adCreativeCategories	A list of categories that describe the content or nature of the ad creative.	dimension
adCreativeFormatProperties.adCopy	adCreativeFormatProperties.adCopy	The ad copy details, including its type and value, used in the creative.	dimension
adCreativeFormatProperties.adCopy.type	adCreativeFormatProperties.adCopy.type	The type of ad copy, such as ‘BODY’ for the main text content.	dimension
adCreativeFormatProperties.adCopy.value	adCreativeFormatProperties.adCopy.value	The actual text content of the ad copy.	dimension
adCreativeFormatProperties.adCreativeFormatType	adCreativeFormatProperties.adCreativeFormatType	The format type of the ad creative, e.g., ‘DISPLAY’, ‘VIDEO’, ‘AUDIO’, ‘THIRD_PARTY’, or ‘COMPONENT’.	dimension
adCreativeFormatProperties.additionalAttributes	adCreativeFormatProperties.additionalAttributes	Additional attributes and settings specific to the ad creative’s format.	dimension
adCreativeFormatProperties.additionalAttributes.allowThirdPartySellers	adCreativeFormatProperties.additionalAttributes.allowThirdPartySellers	Indicates whether third-party sellers are allowed for the ad creative.	dimension
adCreativeFormatProperties.additionalAttributes.allowedRetailFormats	adCreativeFormatProperties.additionalAttributes.allowedRetailFormats	Specifies the retail formats permitted for the ad creative.	dimension
adCreativeFormatProperties.additionalAttributes.creativeContentType	adCreativeFormatProperties.additionalAttributes.creativeContentType	The content type of the ad creative.	dimension
adCreativeFormatProperties.additionalAttributes.optimizationGoal	adCreativeFormatProperties.additionalAttributes.optimizationGoal	The optimization goal set for the ad creative, influencing how it is delivered for performance.	dimension
adCreativeFormatProperties.additionalAttributes.renderOptimizations	adCreativeFormatProperties.additionalAttributes.renderOptimizations	Additional attributes related to how the ad creative is rendered to optimize its display.	dimension
adCreativeFormatProperties.additionalAttributes.targetPlacements	adCreativeFormatProperties.additionalAttributes.targetPlacements	Specifies the intended placements for the ad creative, such as above or below the fold, or in-feed.	dimension
adCreativeFormatProperties.assets	adCreativeFormatProperties.assets	A collection of assets, such as images or videos, used in the ad creative.	dimension
adCreativeFormatProperties.assets.applyBorder	adCreativeFormatProperties.assets.applyBorder	Indicates whether a border should be applied to the creative asset.	dimension
adCreativeFormatProperties.assets.assetId	adCreativeFormatProperties.assets.assetId	The unique identifier of the asset used in the ad creative.	dimension
adCreativeFormatProperties.assets.assetType	adCreativeFormatProperties.assets.assetType	The type of creative asset, such as ‘IMAGE’ or ‘VIDEO’.	dimension
adCreativeFormatProperties.assets.assetVersion	adCreativeFormatProperties.assets.assetVersion	The version of the asset.	dimension
adCreativeFormatProperties.assets.associatedAdExperience	adCreativeFormatProperties.assets.associatedAdExperience	The ad experience associated with the asset.	dimension
adCreativeFormatProperties.assets.url	adCreativeFormatProperties.assets.url	The URL of the asset used in the ad creative.	dimension
adCreativeFormatProperties.clickActions	adCreativeFormatProperties.clickActions	Defines the actions that occur when the ad creative is clicked.	dimension
adCreativeFormatProperties.clickActions.associatedAdExperience	adCreativeFormatProperties.clickActions.associatedAdExperience	The ad experience associated with the click action.	dimension
adCreativeFormatProperties.clickActions.clickActionType	adCreativeFormatProperties.clickActions.clickActionType	The type of action performed on click, e.g., navigating to a URL.	dimension
adCreativeFormatProperties.clickActions.position	adCreativeFormatProperties.clickActions.position	The position of an AdChoices icon or other clickable elements on the ad creative. For instance, ‘TOP_RIGHT’ indicates the AdChoices icon is displayed in the top right corner of the ad.	dimension
adCreativeFormatProperties.clickActions.urlDestination	adCreativeFormatProperties.clickActions.urlDestination	The URL to which the user is directed when the ad is clicked.	dimension
adCreativeFormatProperties.creativeSizes	adCreativeFormatProperties.creativeSizes	The dimensions and responsiveness settings for the ad creative.	dimension
adCreativeFormatProperties.creativeSizes.height	adCreativeFormatProperties.creativeSizes.height	The height of the creative size in pixels.	metric
adCreativeFormatProperties.creativeSizes.responsive	adCreativeFormatProperties.creativeSizes.responsive	Indicates whether the creative size is responsive.	dimension
adCreativeFormatProperties.creativeSizes.width	adCreativeFormatProperties.creativeSizes.width	The width of the creative size in pixels.	metric
adCreativeFormatProperties.products	adCreativeFormatProperties.products	A list of products associated with the ad creative, including their details.	dimension
adCreativeFormatProperties.products.productId	adCreativeFormatProperties.products.productId	The unique identifier of the product associated with the ad creative.	dimension
adCreativeFormatProperties.products.productTitle	adCreativeFormatProperties.products.productTitle	The title of the product associated with the ad creative.	dimension
adCreativeFormatProperties.products.productType	adCreativeFormatProperties.products.productType	The type of product, e.g., ‘ASIN’.	dimension
adCreativeFormatProperties.products.reviewText	adCreativeFormatProperties.products.reviewText	The review text for the product associated with the ad creative.	dimension
adCreativeFormatProperties.products.reviewUrl	adCreativeFormatProperties.products.reviewUrl	The URL for the product review associated with the ad creative.	dimension
adCreativeFormatProperties.skippabilitySettings	adCreativeFormatProperties.skippabilitySettings	Settings that define whether an ad creative can be skipped by the viewer.	dimension
adCreativeFormatProperties.skippabilitySettings.skippableType	adCreativeFormatProperties.skippabilitySettings.skippableType	The specific type of skippability for an ad creative, defining if and how a user can skip the ad.	dimension
adCreativeFormatProperties.thirdPartyTag	adCreativeFormatProperties.thirdPartyTag	Details for third-party ad tags used in the creative.	dimension
adCreativeFormatProperties.thirdPartyTag.destinationOnAmazon	adCreativeFormatProperties.thirdPartyTag.destinationOnAmazon	Indicates whether the third-party tag links to an Amazon site (AMAZON) or an external site (OTHER).	dimension
adCreativeFormatProperties.thirdPartyTag.tagSource	adCreativeFormatProperties.thirdPartyTag.tagSource	The URL or content of the third-party creative tag, such as a VAST tag URL.	dimension
adCreativeFormatProperties.thirdPartyTag.tagType	adCreativeFormatProperties.thirdPartyTag.tagType	The type of third-party tag used in the ad creative, for example, VAST_VPAID.	dimension
adCreativeFormatProperties.trackingUrls	adCreativeFormatProperties.trackingUrls	A list of tracking URLs used for monitoring ad performance.	dimension
adCreativeFormatProperties.trackingUrls.associatedAdExperience	adCreativeFormatProperties.trackingUrls.associatedAdExperience	The ad experience associated with the tracking URL.	dimension
adCreativeFormatProperties.trackingUrls.type	adCreativeFormatProperties.trackingUrls.type	The type of tracking URL, such as ‘CLICK’ for click-through tracking.	dimension
adCreativeFormatProperties.trackingUrls.url	adCreativeFormatProperties.trackingUrls.url	The URL used for tracking ad events.	dimension
adCreativeFormatProperties.universalAdIds	adCreativeFormatProperties.universalAdIds	Universal identifiers associated with the ad creative, used for consistent identification across various platforms and systems.	dimension
adCreativeId	adCreativeId	The unique identifier for the ad creative.	dimension
adCreativeName	adCreativeName	The name of the ad creative.	dimension
adExperiences	adExperiences	A collection of ad experiences, representing rendered views of a creative for specific contexts.	dimension
adExperiences.adExperience	adExperiences.adExperience	The specific ad experience, representing a rendered view of the creative.	dimension
adExperiences.associationModerationStatus	adExperiences.associationModerationStatus	The moderation status of the ad experience association.	dimension
adGroupId	adGroupId	The unique identifier for the ad group.	dimension
adProduct	adProduct	The advertising product associated with the entity, e.g., ‘AMAZON_DSP’.	dimension
additionalHtml	additionalHtml	Additional HTML content to be added to the creative for surveys or other supplemental purposes.	dimension
advertiserId	advertiserId	The unique identifier for the advertiser account.	dimension
country	country	The country associated with the campaign or creative, in ISO 3166-1 alpha-2 format.	dimension
createdDateTime	createdDateTime	The date and time when the entity was created.	dimension
creationDateTime	creationDateTime	The date and time when the entity was created.	dimension
creativeAssociationStatus	creativeAssociationStatus	The overall moderation status of the creative association.	dimension
endDate	endDate	The end date of the association or flight.	dimension
hostedType	hostedType	Indicates whether the ad creative is hosted by Amazon or a third party.	dimension
language	language	The language used in the creative, in ISO_639-1 standard.	dimension
lastUpdatedDate	lastUpdatedDate	The date and time when the entity was last updated.	dimension
lastUpdatedDateTime	lastUpdatedDateTime	The date and time when the entity was last updated.	dimension
name	name	The name of the campaign, ad group, or creative.	dimension
profileId	profileId	The identifier of the profile associated with the advertiser account.	metric
startDate	startDate	The start date of the association or flight.	dimension
state	state	The current state of the entity, e.g., ‘ACTIVE’, ‘PAUSED’, ‘ENABLED’.	dimension
targetDetails.adInitiationTarget	targetDetails.adInitiationTarget	Targeting settings related to the initiation of an ad.	dimension
targetDetails.adInitiationTarget.targetType	targetDetails.adInitiationTarget.targetType	The specific type of target related to the initiation of an ad, used to define when or how an ad should start playing or displaying.	dimension
targetDetails.adInitiationTarget.videoInitiationType	targetDetails.adInitiationTarget.videoInitiationType	Specifies the type of video ad initiation for targeting purposes, such as pre-roll, mid-roll, or post-roll.	dimension
targetDetails.adPlayerSizeTarget	targetDetails.adPlayerSizeTarget	Targeting settings based on the size of the ad player.	dimension
targetDetails.adPlayerSizeTarget.adPlayerSize	targetDetails.adPlayerSizeTarget.adPlayerSize	The size of the ad player for targeting purposes.	dimension
targetDetails.adPlayerSizeTarget.targetType	targetDetails.adPlayerSizeTarget.targetType	The type of targeting, specifically for ad player size.	dimension
targetDetails.appTarget	targetDetails.appTarget	Targeting settings related to specific mobile applications.	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	Configuration for automatically generated targeting expressions for an ad group.	dimension
targetDetails.autoTarget.matchType	targetDetails.autoTarget.matchType	The match type for auto-targeting, such as ‘KEYWORDS_CLOSE_MATCH’.	dimension
targetDetails.autoTarget.targetType	targetDetails.autoTarget.targetType	The type of auto-targeting applied, often represented as ‘THEME’ for automatically generated targets.	dimension
targetDetails.contentGenreTarget	targetDetails.contentGenreTarget	Targeting settings based on the genre of the content.	dimension
targetDetails.contentInstreamPositionTarget	targetDetails.contentInstreamPositionTarget	Defines targeting for ads placed within video content streams (in-stream), specifying criteria for their position relative to the main video content.	dimension
targetDetails.contentOutstreamPositionTarget	targetDetails.contentOutstreamPositionTarget	Defines targeting for ads placed outside of video content streams (out-stream), specifying criteria for their position within general web content.	dimension
targetDetails.contentOutstreamPositionTarget.targetType	targetDetails.contentOutstreamPositionTarget.targetType	This field specifies the type of targeting applied to the content outstream position. Content outstream position targeting allows advertisers to control where their ads appear within video content outside of a video player, for instance, in articles or interstitial spaces.	dimension
targetDetails.contentRatingTarget	targetDetails.contentRatingTarget	Specifies content rating criteria for targeting, allowing ads to appear on or avoid content based on its rating.	dimension
targetDetails.dayPartTarget	targetDetails.dayPartTarget	Targeting settings based on specific days of the week and times of the day.	dimension
targetDetails.deviceTarget	targetDetails.deviceTarget	Targeting settings based on device types or operating systems.	dimension
targetDetails.domainTarget	targetDetails.domainTarget	Defines targets based on specific site domains for inclusion or exclusion.	dimension
targetDetails.domainTarget.domainTargetDetails	targetDetails.domainTarget.domainTargetDetails	Details for domain-based targeting, including specific domain names for inclusion or exclusion.	dimension
targetDetails.domainTarget.targetType	targetDetails.domainTarget.targetType	The type of domain targeting being applied, which is ‘DOMAIN’.	dimension
targetDetails.iabCategoryTarget	targetDetails.iabCategoryTarget	Targets ads based on Interactive Advertising Bureau (IAB) content categories, which classify the content of web pages.	dimension
targetDetails.inventorySourceTarget	targetDetails.inventorySourceTarget	Targeting that specifies the inventory sources or exchanges where ads should be shown. By default, all eligible inventory sources are included.	dimension
targetDetails.inventorySourceTarget.inventorySourceId	targetDetails.inventorySourceTarget.inventorySourceId	The unique identifier for an inventory source used in targeting, defining where ad placements are sourced.	metric
targetDetails.inventorySourceTarget.inventorySourceType	targetDetails.inventorySourceTarget.inventorySourceType	The type or category of the inventory source used in targeting, such as an ad exchange or a specific publisher.	dimension
targetDetails.inventorySourceTarget.targetType	targetDetails.inventorySourceTarget.targetType	The specific type of targeting applied to an inventory source, categorizing the nature of the inventory being included or excluded.	dimension
targetDetails.keywordTarget	targetDetails.keywordTarget	Targeting settings based on specific keywords.	dimension
targetDetails.locationTarget	targetDetails.locationTarget	This field specifies geographical targeting criteria, allowing advertisers to reach audiences in particular countries, states, postal codes, Designated Market Areas (DMAs), or cities.	dimension
targetDetails.nativeContentPositionTarget	targetDetails.nativeContentPositionTarget	This field defines targeting based on the position of an ad within native content, influencing where ads appear in a native advertising context.	dimension
targetDetails.onScreenPositionTarget	targetDetails.onScreenPositionTarget	Targets ads based on their on-screen position, such as above or below the fold.	dimension
targetDetails.productCategoryTarget	targetDetails.productCategoryTarget	A type of contextual targeting using ASIN categories.	dimension
targetDetails.productCategoryTarget.asinCategory	targetDetails.productCategoryTarget.asinCategory	A specific Amazon Standard Identification Number (ASIN) category or browse node used for contextual targeting. This allows advertisers to target ads based on Amazon’s retail product taxonomy.	metric
targetDetails.productCategoryTarget.targetType	targetDetails.productCategoryTarget.targetType	The type of targeting being applied to the ad group. When using product category targeting, this field indicates that the ad group is targeting a product category.	dimension
targetDetails.productTarget	targetDetails.productTarget	This field specifies targeting criteria based on specific Amazon products (ASINs) or product categories (Browse Nodes), allowing ads to be shown alongside or in relation to particular product content.	dimension
targetDetails.productTarget.asin	targetDetails.productTarget.asin	The Amazon Standard Identification Number (ASIN) of the product to be targeted in Amazon DSP campaigns. Advertisers use ASINs to precisely target individual products for ad delivery.	dimension
targetDetails.productTarget.matchType	targetDetails.productTarget.matchType	This field specifies the matching criteria for product targeting, defining whether the ad targets the exact ASIN specified or also includes similar products like substitutes or complements.	dimension
targetDetails.productTarget.targetType	targetDetails.productTarget.targetType	This field indicates the specific type of targeting being used within the targetDetails object. For product targeting, its value would identify the target as product-based, differentiating it from other target types like audience or location.	dimension
targetDetails.thirdPartyTarget	targetDetails.thirdPartyTarget	Targeting based on segments provided by third-party data vendors.	dimension
targetDetails.thirdPartyTarget.targetType	targetDetails.thirdPartyTarget.targetType	The specific type of third-party target being used.	dimension
targetDetails.thirdPartyTarget.thirdPartyTargetDetails	targetDetails.thirdPartyTarget.thirdPartyTargetDetails	Specific details for the third-party target segment.	dimension
targetDetails.videoAdFormatTarget	targetDetails.videoAdFormatTarget	Defines targets based on video ad formats.	dimension
targetDetails.videoAdFormatTarget.targetType	targetDetails.videoAdFormatTarget.targetType	The type of targeting, specifically for video ad format.	dimension
targetDetails.videoAdFormatTarget.videoAdFormat	targetDetails.videoAdFormatTarget.videoAdFormat	The specific video ad format for targeting purposes.	dimension
targetId	targetId	This field represents the unique identifier assigned to a specific target within the Amazon DSP API, used for managing (creating, reading, updating, or deleting) targeting configurations.	dimension