This is a list of all fields in the schema. Select a method to learn more about how a call uses a field.
Field
Parent field
Applicable resources and methods
A
adGroupId
(method-level)
ads
negativeKeywords
requests
responses
adGroupStatus
(method-level)
adGroups
adId
(method-level)
ads
responses
responses.ads
adIds
(method-level)
adRateAdjustmentPercent
campaigns.fundingStrategy.dynamicAdRatePreferences
dynamicAdRatePreferences
fundingStrategy.dynamicAdRatePreferences
adRateCapPercent
campaigns.fundingStrategy.dynamicAdRatePreferences
dynamicAdRatePreferences
fundingStrategy.dynamicAdRatePreferences
adRateStrategy
campaigns.fundingStrategy
fundingStrategy
adStatus
(method-level)
ads
requests
additionalInfo
additionalRecords
ads
(method-level)
responses
alertType
ads.alerts
alerts
campaigns.alerts
alerts
(method-level)
ads
campaigns
amount
(method-level)
bidPreferences.maxCpc
budget.daily
campaigns.budget.daily
campaigns.fundingStrategy.bidPreferences.maxCpc
fundingStrategy.bidPreferences.maxCpc
amountOffItem
discountRules.discountBenefit
selectedInventoryDiscounts.discountBenefit
amountOffOrder
discountRules.discountBenefit
selectedInventoryDiscounts.discountBenefit
annotationKey
dimensionMetadata.dimensionKeyAnnotations
reportMetadata.dimensionMetadata.dimensionKeyAnnotations
annotationKeys
dimensions
applyDiscountToSingleItemOnly
(method-level)
applyFreeShipping
(method-level)
aspect
ads.alerts.details
alerts.details
campaigns.alerts.details
audienceCodes
(method-level)
audienceType
audiences
audiences
(method-level)
autoSelectFutureInventory
(method-level)
campaignCriterion
campaigns.campaignCriterion
averageItemDiscount
averageItemRevenue
averageOrderDiscount
averageOrderRevenue
B
baseSale
(method-level)
bases
bid
(method-level)
requests
bidPercentage
(method-level)
ads
campaigns.fundingStrategy
fundingStrategy
requests
bidPreferences
campaigns.fundingStrategy
fundingStrategy
biddingStrategy
campaigns.fundingStrategy
fundingStrategy
blockPriceIncreaseInItemRevision
(method-level)
brands
campaignCriterion.selectionRules
campaigns.campaignCriterion.selectionRules
inventoryCriterion.ruleCriteria.selectionRules
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.selectionRules
budget
(method-level)
campaigns
budgetStatus
budget.daily
campaigns.budget.daily
C
campaignCriterion
(method-level)
campaigns
campaignId
(method-level)
campaigns
negativeKeywords
campaignIds
(method-level)
campaignName
(method-level)
campaigns
campaignStatus
(method-level)
campaigns
campaignTargetingType
(method-level)
campaigns
campaigns
(method-level)
category
responses.errors
responses.warnings
warnings
categoryId
(method-level)
categoryIds
campaignCriterion.selectionRules
campaigns.campaignCriterion.selectionRules
inventoryCriterion.ruleCriteria.selectionRules
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.selectionRules
categoryScope
campaignCriterion.selectionRules
campaigns.campaignCriterion.selectionRules
inventoryCriterion.ruleCriteria.selectionRules
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.selectionRules
categoryType
(method-level)
channel
channels
(method-level)
campaigns
clickCount
code
audiences
content
couponCode
couponConfiguration
couponConfiguration
(method-level)
couponType
couponConfiguration
creationDate
(method-level)
criterionType
campaignCriterion
campaigns.campaignCriterion
currency
adGroups.defaultBid
bid
bidPreferences.maxCpc.amount
budget
budget.daily.amount
campaignCriterion.selectionRules.maxPrice
campaignCriterion.selectionRules.minPrice
campaigns.budget.daily.amount
campaigns.campaignCriterion.selectionRules.maxPrice
campaigns.campaignCriterion.selectionRules.minPrice
campaigns.fundingStrategy.bidPreferences.maxCpc.amount
defaultBid
discountRules.discountBenefit.amountOffItem
discountRules.discountBenefit.amountOffOrder
discountRules.discountSpecification.forEachAmount
discountRules.discountSpecification.minAmount
discountRules.maxDiscountAmount
fundingStrategy.bidPreferences.maxCpc.amount
inventoryCriterion.ruleCriteria.selectionRules.maxPrice
inventoryCriterion.ruleCriteria.selectionRules.minPrice
listings.currentPrice
priceRange
promotionReports.averageItemDiscount
promotionReports.averageItemRevenue
promotionReports.averageOrderDiscount
promotionReports.averageOrderRevenue
promotionReports.baseSale
promotionReports.promotionSale
promotionReports.totalDiscount
promotionReports.totalSale
requests.bid
selectedInventoryDiscounts.discountBenefit.amountOffItem
selectedInventoryDiscounts.discountBenefit.amountOffOrder
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.selectionRules.maxPrice
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.selectionRules.minPrice
suggestedBids.proposedBid
suggestedBudget.budget.daily.amount
D
daily
(method-level)
budget
campaigns.budget
dataType
dimensionMetadata.dimensionKeyAnnotations
reportMetadata.dimensionMetadata
reportMetadata.dimensionMetadata.dimensionKeyAnnotations
dateFrom
(method-level)
dateTo
(method-level)
defaultBid
(method-level)
description
(method-level)
details
ads.alerts
alerts
campaigns.alerts
dimension
ads.alerts.details
alerts.details
campaigns.alerts.details
dimensionKey
dimensions
reportMetadata.dimensionMetadata
dimensionKeyAnnotations
dimensionMetadata
dimensions
(method-level)
discountBenefit
discountRules
selectedInventoryDiscounts
discountId
selectedInventoryDiscounts
discountRules
(method-level)
discountSpecification
discountRules
domain
responses.errors
responses.warnings
warnings
dynamicAdRatePreferences
campaigns.fundingStrategy
fundingStrategy
E
emailCampaignId
(method-level)
emailCampaignStatus
(method-level)
emailCampaignType
(method-level)
endDate
(method-level)
campaigns
errorId
responses.errors
responses.warnings
warnings
errors
(method-level)
responses
estimatedValue
excludeInventoryItems
inventoryCriterion.ruleCriteria
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria
excludeListingIds
inventoryCriterion.ruleCriteria
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria
F
forEachAmount
discountRules.discountSpecification
forEachQuantity
discountRules.discountSpecification
freeShipping
fundingModel
campaigns.fundingStrategy
fundingStrategy
fundingModels
(method-level)
fundingStrategy
(method-level)
campaigns
G
gte
priceRange
H
href
(method-level)
GET
GET
responses
responses.ads
I
infoType
inputRefIds
responses.errors
responses.warnings
warnings
inventoryCriterion
(method-level)
selectedInventoryDiscounts
inventoryCriterionType
inventoryCriterion
selectedInventoryDiscounts.inventoryCriterion
inventoryItems
inventoryCriterion
selectedInventoryDiscounts.inventoryCriterion
inventoryReferenceId
(method-level)
ads
inventoryCriterion.inventoryItems
inventoryCriterion.ruleCriteria.excludeInventoryItems
inventoryCriterion.ruleCriteria.markupInventoryItems
inventoryReferences
reportTasks.inventoryReferences
requests
responses
selectedInventoryDiscounts.inventoryCriterion.inventoryItems
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.excludeInventoryItems
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.markupInventoryItems
inventoryReferenceType
(method-level)
ads
inventoryCriterion.inventoryItems
inventoryCriterion.ruleCriteria.excludeInventoryItems
inventoryCriterion.ruleCriteria.markupInventoryItems
inventoryReferences
reportTasks.inventoryReferences
requests
responses
selectedInventoryDiscounts.inventoryCriterion.inventoryItems
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.excludeInventoryItems
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.markupInventoryItems
inventoryReferences
(method-level)
itemIds
(method-level)
itemSelectMode
(method-level)
K
key
ads.alerts.details.aspect
ads.alerts.details.dimension
alerts.details.aspect
alerts.details.dimension
campaigns.alerts.details.aspect
campaigns.alerts.details.dimension
keywordId
(method-level)
responses
keywordStatus
(method-level)
keywordText
(method-level)
keywords
keywords
(method-level)
L
lastUpdated
limit
(method-level)
listingCategoryId
listingCondition
listingConditionId
listingConditionIds
campaignCriterion.selectionRules
campaigns.campaignCriterion.selectionRules
inventoryCriterion.ruleCriteria.selectionRules
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.selectionRules
listingId
(method-level)
ads
requests
responses
listingIds
(method-level)
inventoryCriterion
selectedInventoryDiscounts.inventoryCriterion
listingMarkdownStatus
listingPromotionStatuses
listings
longMessage
responses.errors
responses.warnings
warnings
lte
priceRange
M
marketplaceId
(method-level)
campaigns
markupInventoryItems
inventoryCriterion.ruleCriteria
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria
markupListingIds
inventoryCriterion.ruleCriteria
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria
matchType
(method-level)
keywords
maxCouponRedemptionPerUser
couponConfiguration
maxCpc
campaigns.fundingStrategy.bidPreferences
fundingStrategy.bidPreferences
maxDiscountAmount
discountRules
maxNumberOfDimensionsToRequest
maxNumberOfMetricsToRequest
maxPrice
campaignCriterion.selectionRules
campaigns.campaignCriterion.selectionRules
inventoryCriterion.ruleCriteria.selectionRules
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.selectionRules
message
responses.errors
responses.warnings
warnings
metric
metricKey
reportMetadata.metricMetadata
metricKeys
(method-level)
metricMetadata
metrics
minAmount
discountRules.discountSpecification
minPrice
campaignCriterion.selectionRules
campaigns.campaignCriterion.selectionRules
inventoryCriterion.ruleCriteria.selectionRules
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.selectionRules
minQuantity
discountRules.discountSpecification
modificationDate
N
name
(method-level)
audiences
campaigns.audiences
errors.parameters
responses.errors.parameters
responses.warnings.parameters
warnings.parameters
negativeKeywordId
responses
negativeKeywordMatchType
(method-level)
negativeKeywordStatus
(method-level)
negativeKeywordText
(method-level)
negativeKeywords
next
(method-level)
GET
GET
numberOfDiscountedItems
discountRules.discountSpecification
O
offset
(method-level)
openCount
outputRefIds
responses.errors
responses.warnings
warnings
P
parameters
responses.errors
responses.warnings
warnings
percentageOffItem
discountRules.discountBenefit
selectedInventoryDiscounts.discountBenefit
percentageOffOrder
discountRules.discountBenefit
selectedInventoryDiscounts.discountBenefit
percentageSalesLift
personalizedMessage
(method-level)
prev
(method-level)
GET
GET
priceRange
(method-level)
priority
(method-level)
promotionHref
promotionReports
promotionId
(method-level)
promotionReports
promotionImageUrl
(method-level)
promotionReportId
promotionReports
promotionSale
promotionSelectMode
promotionSelectModeEnum
(method-level)
promotionStatus
(method-level)
promotionType
(method-level)
promotionReports
promotions
Q
R
rangeEnd
rangeStart
renderDate
reportExpirationDate
reportFormat
(method-level)
reportHref
(method-level)
reportId
(method-level)
reportMetadata
reportName
(method-level)
reportTaskCompletionDate
reportTaskCreationDate
reportTaskExpectedCompletionDate
reportTaskId
(method-level)
reportTaskStatus
(method-level)
reportTaskStatusMessage
reportTasks
reportType
(method-level)
requests
(method-level)
responses
(method-level)
ruleCriteria
inventoryCriterion
selectedInventoryDiscounts.inventoryCriterion
ruleOrder
discountRules
selectedInventoryDiscounts
S
scheduleDate
(method-level)
scheduleDateType
selectedInventoryDiscounts
(method-level)
selectionRules
campaignCriterion
campaigns.campaignCriterion
inventoryCriterion.ruleCriteria
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria
sentDate
(method-level)
sort
(method-level)
startDate
(method-level)
campaigns
statusChangedDate
statusCode
(method-level)
responses
statusMessage
storeCategoryId
subdomain
responses.errors
responses.warnings
warnings
subject
(method-level)
suggestedBids
suggestedBudget
suggestedItems
T
total
(method-level)
totalDiscount
totalSale
(method-level)
V
value
adGroups.defaultBid
ads.alerts.details.aspect
ads.alerts.details.dimension
alerts.details.aspect
alerts.details.dimension
bid
bidPreferences.maxCpc.amount
budget
budget.daily.amount
campaignCriterion.selectionRules.maxPrice
campaignCriterion.selectionRules.minPrice
campaigns.alerts.details.aspect
campaigns.alerts.details.dimension
campaigns.budget.daily.amount
campaigns.campaignCriterion.selectionRules.maxPrice
campaigns.campaignCriterion.selectionRules.minPrice
campaigns.fundingStrategy.bidPreferences.maxCpc.amount
defaultBid
discountRules.discountBenefit.amountOffItem
discountRules.discountBenefit.amountOffOrder
discountRules.discountSpecification.forEachAmount
discountRules.discountSpecification.minAmount
discountRules.maxDiscountAmount
errors.parameters
fundingStrategy.bidPreferences.maxCpc.amount
inventoryCriterion.ruleCriteria.selectionRules.maxPrice
inventoryCriterion.ruleCriteria.selectionRules.minPrice
listings.currentPrice
promotionReports.averageItemDiscount
promotionReports.averageItemRevenue
promotionReports.averageOrderDiscount
promotionReports.averageOrderRevenue
promotionReports.baseSale
promotionReports.promotionSale
promotionReports.totalDiscount
promotionReports.totalSale
requests.bid
responses.errors.parameters
responses.warnings.parameters
selectedInventoryDiscounts.discountBenefit.amountOffItem
selectedInventoryDiscounts.discountBenefit.amountOffOrder
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.selectionRules.maxPrice
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.selectionRules.minPrice
suggestedBids.proposedBid
suggestedBudget.budget.daily.amount
suggestedKeywords.additionalInfo.metrics
warnings.parameters
W
warnings
(method-level)
responses