Amazon Ads API MCP

{"openapi":"3.0.2","info":{"version":"2.0","title":"Amazon Ads API - Sponsored Products","description":"Use the Amazon Ads API for Sponsored Products for campaign, ad group, keyword, negative keyword, and product ad management operations. For more information about Sponsored Products, see the [Sponsored Products Support Center](https://advertising.amazon.com/help?entityId=ENTITY3CWETCZD9HEG2#GWGFKPEWVWG2CLUJ). For onboarding information, see the [account setup](guides/onboarding/overview) topic.<br/> <br/> **Note**: This contract contains endpoints with upcoming planned deprecations. For more information on the latest versions and migration details, see [Deprecations](release-notes/deprecations).<br/> <br/>","contact":{"name":"Amazon Ads API Support","url":"https://amzn-clicks.atlassian.net/servicedesk/customer/portals"},"license":{"name":"Amazon Ads API License Agreement","url":"https://advertising.amazon.com/API/docs/license-agreement"}},"servers":[{"url":"https://advertising-api.amazon.com"},{"url":"https://advertising-api-eu.amazon.com"},{"url":"https://advertising-api-fe.amazon.com"}],"tags":[{"name":"Bid recommendations"},{"name":"Suggested keywords"},{"name":"Snapshots"}],"security":[{"bearer":[]}],"paths":{"/v2/sp/adGroups/{adGroupId}/bidRecommendations":{"get":{"tags":["Bid recommendations"],"operationId":"getAdGroupBidRecommendations","summary":"Gets a bid recommendation for an ad group. [PLANNED DEPRECATION 3/27/2024]","description":"**Deprecation notice: This endpoint will be deprecated on March 27, 2024. Use [theme-based bid recommendations](/API/docs/en-us/sponsored-products/3-0/openapi/prod#/ThemeBasedBidRecommendation/GetThemeBasedBidRecommendationForAdGroup_v1) going forward.**","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"name":"adGroupId","in":"path","description":"The identifier of an existing ad group.","required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdGroupBidRecommendationsResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"description":"Either the specified ad group identifier was not found, or the specified ad group was found but no associated bid was found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v2/sp/keywords/{keywordId}/bidRecommendations":{"get":{"tags":["Bid recommendations"],"operationId":"getKeywordBidRecommendations","summary":"Gets a bid recommendation for a keyword. [PLANNED DEPRECATION 3/27/2024]","description":"**Deprecation notice: This endpoint will be deprecated on March 27, 2024. Use [theme-based bid recommendations](/API/docs/en-us/sponsored-products/3-0/openapi/prod#/ThemeBasedBidRecommendation/GetThemeBasedBidRecommendationForAdGroup_v1) going forward.**","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"name":"keywordId","in":"path","description":"The identifier of an existing keyword.","required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordBidRecommendationsResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"}}}},"/v2/sp/keywords/bidRecommendations":{"post":{"tags":["Bid recommendations"],"operationId":"createKeywordBidRecommendations","summary":"Gets bid recommendations for keywords. [PLANNED DEPRECATION 3/27/2024]","description":"**Deprecation notice: This endpoint will be deprecated on March 27, 2024. Use [theme-based bid recommendations](/API/docs/en-us/sponsored-products/3-0/openapi/prod#/ThemeBasedBidRecommendation/GetThemeBasedBidRecommendationForAdGroup_v1) going forward.**","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"}],"requestBody":{"description":"An array of keyword bid recommendation objects.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordBidRecommendationsData"}}}},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidRecommendationsResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/v2/sp/adGroups/{adGroupId}/suggested/keywords":{"get":{"tags":["Suggested keywords"],"operationId":"getAdGroupSuggestedKeywords","summary":"Gets suggested keywords for the specified ad group.","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/adGroupId"},{"$ref":"#/components/parameters/maxNumSuggestions"},{"$ref":"#/components/parameters/adStateFilter"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdGroupSuggestedKeywordsResponse"}}}},"400":{"$ref":"#/components/responses/ResourceNotFound"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/v2/sp/adGroups/{adGroupId}/suggested/keywords/extended":{"get":{"tags":["Suggested keywords"],"operationId":"getAdGroupSuggestedKeywordsEx","summary":"Gets suggested keywords with extended data for the specified ad group.","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/adGroupId"},{"$ref":"#/components/parameters/maxNumSuggestions"},{"name":"suggestBids","in":"query","description":"Set to `yes` to include a suggest bid for the suggested keyword in the response. Otherwise, set to `no`.","schema":{"type":"string","default":"no","enum":["yes","no"]}},{"$ref":"#/components/parameters/adStateFilter"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AdGroupSuggestedKeywordsResponseEx"}}}}},"400":{"$ref":"#/components/responses/InvalidQueryParam"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/v2/sp/asins/{asinValue}/suggested/keywords":{"get":{"tags":["Suggested keywords"],"operationId":"getAsinSuggestedKeywords","summary":"Gets suggested keywords for the specified ASIN.","description":"Suggested keywords are returned in an array ordered by descending effectiveness.","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"name":"asinValue","in":"path","required":true,"description":"An ASIN.","schema":{"type":"string"}},{"$ref":"#/components/parameters/maxNumSuggestions"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAsinSuggestedKeywordsResponse"}}}},"400":{"$ref":"#/components/responses/InvalidQueryParam"}}}},"/v2/sp/asins/suggested/keywords":{"post":{"tags":["Suggested keywords"],"operationId":"bulkGetAsinSuggestedKeywords","summary":"Gets suggested keyword for a specified list of ASINs.","description":"Suggested keywords are returned in an array ordered by descending effectiveness.","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"asins":{"description":"A list of ASINs.","type":"array","items":{"type":"string"}},"maxNumSuggestions":{"description":"The maximum number of suggested keywords in the response.","type":"integer","minItems":1,"maxItems":1000,"default":100}}}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkGetAsinSuggestedKeywordsResponse"}}}},"400":{"$ref":"#/components/responses/InvalidQueryParam"}}}},"/v2/sp/targets/bidRecommendations":{"post":{"tags":["Bid recommendations"],"operationId":"getBidRecommendations","summary":"Gets a list of bid recommendations for keyword, product, or auto targeting expressions.","requestBody":{"description":"An ad group identifier and list of associated targeting expressions for which to generate bid recommendations. Note that targeting expressions are required to be of the same type. That is, all targeting expressions in the list must be one of **keyword**, **product**, or **auto** target types.","content":{"application/json":{"schema":{"type":"object","properties":{"adGroupId":{"description":"The ad group identifier.","type":"number"},"expressions":{"description":"The list of targeting expressions.","type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/TargetingExpressionPredicate"}}}}}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"adGroupId":{"description":"The ad group identifier.","type":"number"},"recommendations":{"description":"The list of recommended bids with associated targeting expressions.","type":"array","items":{"type":"object","properties":{"suggestedBid":{"$ref":"#/components/schemas/SuggestedBid"},"expression":{"$ref":"#/components/schemas/TargetingExpressionPredicate"},"code":{"description":"The response code.","type":"string","enum":["SUCCESS","INVALID_ARGUMENT","NOT_FOUND","INTERNAL_ERROR","SERVER_IS_BUSY","UNAUTHORIZED"]}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"}}}},"/v2/sp/{recordType}/snapshot":{"post":{"tags":["Snapshots"],"operationId":"requestSnapshot","summary":"Request a snapshot","deprecated":true,"description":"**Note: Snapshots APIs are deprecated and will be shut off on October 15, 2024. For replacement functionality, see the [exports](guides/exports/overview) API. To learn more, view the [migration guide](reference/migration-guides/snapshots-exports).** \n\nRequest a file-based snapshot of all entities of the specified type in the account satisfying the filtering criteria.\n\nTo understand the call flow for asynchronous snapshots, see [Getting started with sponsored ads snapshots](/API/docs/en-us/guides/snapshots/get-started).","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"name":"recordType","in":"path","required":true,"description":"The type of entity for which the snapshot is generated.","schema":{"type":"string","enum":["campaigns","adGroups","keywords","negativeKeywords","campaignNegativeKeywords","productAds","targets","negativeTargets"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SnapshotRequest"}}}},"responses":{"202":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SnapshotResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/v2/sp/snapshots/{snapshotId}":{"get":{"tags":["Snapshots"],"operationId":"getSnapshotStatus","summary":"Get the status of a requested snapshot","deprecated":true,"description":"**Note: Snapshots APIs are deprecated and will be shut off on October 15, 2024. For replacement functionality, see the [exports](guides/exports/overview) API. To learn more, view the [migration guide](reference/migration-guides/snapshots-exports).** \n\nTo understand the call flow for asynchronous snapshots, see [Getting started with sponsored ads snapshots](/API/docs/en-us/guides/snapshots/overview).","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"name":"snapshotId","in":"path","required":true,"description":"The snapshot identifier.","schema":{"type":"number"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SnapshotResponse"}}}},"307":{"description":"Temporary redirect.","headers":{"Location":{"schema":{"type":"string","description":"The download location of the requested snapshot."}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/v2/sp/snapshots/{snapshotId}/download":{"get":{"tags":["Snapshots"],"operationId":"downloadSnapshot","summary":"Download requested snapshot","deprecated":true,"description":"**Note: Snapshots APIs are deprecated and will be shut off on October 15, 2024. For replacement functionality, see the [exports](guides/exports/overview) API. To learn more, view the [migration guide](reference/migration-guides/snapshots-exports).** \n\nTo understand the call flow for asynchronous snapshots, see [Getting started with sponsored ads snapshots](/API/docs/en-us/guides/snapshots/get-started).","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"name":"snapshotId","in":"path","required":true,"description":"The snapshot identifier.","schema":{"type":"number"}}],"responses":{"307":{"description":"Successful operation.","headers":{"Location":{"schema":{"type":"string","description":"Redirect URI with S3 file location containing snapshot data"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}},"parameters":{"adId":{"name":"adId","in":"path","required":true,"description":"A product ad identifier.","schema":{"type":"number"}},"adIdFilter":{"name":"adIdFilter","in":"query","required":false,"description":"Restricts results to product ads associated with the product ad identifiers specified in the comma-delimited list.","schema":{"type":"string"}},"adGroupId":{"name":"adGroupId","in":"path","description":"The identifier of a valid ad group.","required":true,"schema":{"type":"number"}},"adGroupIdFilter":{"name":"adGroupIdFilter","in":"query","description":"Restricts results to keywords associated with ad groups specified by identifier in the comma-delimited list.","required":false,"schema":{"type":"string"}},"adStateFilter":{"name":"adStateFilter","in":"query","description":"Filters results to ad groups with state matching the comma-delimited list.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"]}},"campaignIdFilter":{"name":"campaignIdFilter","in":"query","description":"A comma-delimited list of campaign identifiers.","required":false,"schema":{"type":"string"}},"campaignType":{"name":"campaignType","in":"query","description":"Restricts results to ad groups within campaign types specified in comma-separated list.","required":false,"schema":{"type":"string"}},"clientHeader":{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" developer account.","required":true,"schema":{"type":"string"}},"count":{"name":"count","in":"query","description":"Number of records to include in the paged response. Defaults to max page size of 5000.","required":false,"schema":{"type":"number"}},"keywordIdFilter":{"name":"keywordIdFilter","in":"query","description":"Restricts results to keywords associated with campaigns specified by identifier in the comma-delimited list.","required":false,"schema":{"type":"string"}},"locale":{"name":"locale","in":"query","description":"Restricts results to keywords associated with locale.","required":false,"schema":{"type":"string"}},"keywordText":{"name":"keywordText","in":"query","description":"Restricts results to keywords that match the specified text exactly.","schema":{"type":"string"}},"matchTypeFilter":{"name":"matchTypeFilter","in":"query","description":"Restricts results to keywords with match types within the specified comma-separated list. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","schema":{"type":"string","enum":["broad","phrase","exact"]}},"maxNumSuggestions":{"name":"maxNumSuggestions","in":"query","description":"The maximum number of suggested keywords for the response.","schema":{"type":"integer","default":100,"minimum":1,"maximum":1000}},"name":{"name":"name","in":"query","description":"Restricts results to campaigns with the specified name.","required":false,"schema":{"type":"string"}},"negativeAdGroupIdFilter":{"name":"adGroupIdFilter","in":"query","description":"Restricts results to negative keywords associated with ad groups specified by identifier in the comma-delimited list.","required":false,"schema":{"type":"string"}},"negativeCampaignIdFilter":{"name":"campaignIdFilter","in":"query","description":"Restricts results to negative keywords associated with campaigns specified by identifier in the comma-delimited list.","required":false,"schema":{"type":"string"}},"negativeKeywordText":{"name":"keywordText","in":"query","description":"Restricts results to negative keywords that match the specified text.","schema":{"type":"string"}},"negativeMatchTypeFilter":{"name":"matchTypeFilter","in":"query","description":"Restricts results to negative keywords with match types within the specified comma-separated list. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","schema":{"type":"string","enum":["negativePhrase","negativeExact"]}},"negativeStateFilter":{"name":"stateFilter","in":"query","description":"Restricts results to negative resources with state within the specified comma-separated list. Default includes all.","required":false,"schema":{"type":"string","enum":["enabled","archived"]}},"negativeKeywordIdFilter":{"name":"keywordIdFilter","in":"query","description":"Restricts results to negative keywords associated with campaigns specified by identifier in the comma-delimited list.","required":false,"schema":{"type":"string"}},"portfolioIdFilter":{"name":"portfolioIdFilter","in":"query","description":"A comma-delimited list of portfolio identifiers.","required":false,"schema":{"type":"string"}},"profileHeader":{"name":"Amazon-Advertising-API-Scope","in":"header","description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.","required":true,"schema":{"type":"string"}},"startIndex":{"name":"startIndex","in":"query","description":"0-indexed record offset for the result set.","schema":{"type":"number","default":0}},"stateFilter":{"name":"stateFilter","in":"query","description":"Restricts results to resources with state within the specified comma-separated list.","required":false,"schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"]}},"targetId":{"name":"targetId","in":"path","required":true,"description":"The target identifier.","schema":{"type":"number"}},"targetIdFilter":{"name":"targetIdFilter","in":"query","description":"A comma-delimited list of target identifiers.","schema":{"type":"string"}}},"responses":{"BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotAcceptable":{"description":"One or more values specified for a parameter was not within the specified acceptable range.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"UnprocessableEntity":{"description":"An invalid parameter was specified.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"InvalidQueryParam":{"description":"One or more query parameters contained an invalid value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"ResourceNotFound":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthorized":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"AdGroup":{"properties":{"adGroupId":{"description":"The identifier of the ad group.","type":"number"},"name":{"description":"The name of the ad group.","type":"string"},"campaignId":{"description":"The identifier of the campaign that the ad group is associated with.","type":"number"},"defaultBid":{"description":"The bid value used when no bid is specified for keywords in the ad group.","type":"number","format":"float"},"state":{"$ref":"#/components/schemas/State"}}},"AdGroupEx":{"properties":{"adGroupId":{"description":"The identifier of the ad group.","type":"number"},"name":{"description":"The name of the ad group.","type":"string"},"campaignId":{"description":"The identifier of the campaign that the ad group is associated with.","type":"number"},"defaultBid":{"description":"The bid value used when no bid is specified for keywords in the ad group.","type":"number"},"state":{"$ref":"#/components/schemas/State"},"creationDate":{"description":"The creation date of the ad group in epoch time.","type":"number"},"lastUpdatedDate":{"description":"The date that any value associated with the ad group was last changed, in epoch time.","type":"number"},"servingStatus":{"description":"The computed status. See developer notes for more information.","type":"string","enum":["AD_GROUP_ARCHIVED","AD_GROUP_PAUSED","AD_GROUP_STATUS_ENABLED","AD_POLICING_SUSPENDED","AD_GROUP_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","ACCOUNT_OUT_OF_BUDGET","PENDING_START_DATE"]}}},"AdGroupResponse":{"properties":{"adGroupId":{"description":"The identifier of the ad group.","type":"number"},"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the code.","type":"string"},"description":{"description":"A human-readable description of the code.","type":"string"}}},"AdGroupBidRecommendationsResponse":{"properties":{"adGroupId":{"description":"The identifier of the ad group.","type":"number"},"suggestedBid":{"$ref":"#/components/schemas/SuggestedBid"}}},"AdGroupSuggestedKeywordsResponse":{"properties":{"adGroupId":{"description":"The ad group identifier.","type":"number"},"suggestededKeywords":{"description":"An array of suggested keywords.","type":"array","items":{"type":"string"}}}},"AdGroupSuggestedKeywordsResponseEx":{"properties":{"adGroupId":{"description":"The ad group identifier.","type":"number"},"campaignId":{"description":"The campaign identifier.","type":"number"},"keywordText":{"description":"The suggested keyword.","type":"string"},"matchType":{"$ref":"#/components/schemas/MatchType"},"state":{"description":"The state of the ad for which the keyword is suggested.","type":"string","enum":["enabled","paused"]},"bid":{"description":"The suggested bid for the suggested keyword. Note that this field will not be included in the response if the `suggestBids` query parameter is set to `no` in the request.","type":"number"}}},"ProductAdResponse":{"properties":{"adId":{"description":"The product ad identifier.","type":"number"},"code":{"description":"The enumerated success or error code.","type":"string"},"details":{"description":"A human-readable description of the code.","type":"string"},"description":{"description":"A human-readable description of the code.","type":"string"}}},"Bidding":{"description":"Specifies bidding controls.","type":"object","properties":{"strategy":{"description":"The bidding strategy.\n| Value | Strategy name | Description |\n|----------------|---------------|-------------|\n| `legacyForSales` | Dynamic bids - down only | Lowers your bids in real time when your ad may be less likely to convert to a sale. Campaigns created before the release of the bidding controls feature used this setting by default. |\n| `autoForSales` | Dynamic bids - up and down | Increases or decreases your bids in real time by a maximum of 100%. With this setting bids increase when your ad is more likely to convert to a sale, and bids decrease when less likely to convert to a sale. |\n| `manual` | Fixed bid | Uses your exact bid and any placement adjustments you set, and is not subject to dynamic bidding. |","type":"string","enum":["legacyForSales","autoForSales","manual"]},"adjustments":{"type":"array","items":{"type":"object","properties":{"predicate":{"type":"string","description":"You can enable controls to adjust your bid based on the placement location. Specify a location where you want to use bid controls. The percentage value set is the percentage of the original bid for which you want to have your bid adjustment increased. For example, a 50% adjustment on a $1.00 bid would increase the bid to $1.50 for the opportunity to win a specified placement.\n| Predicate | Placement |\n|-----------|------------|\n| `placementTop` | Top of search (first page) |\n| `placementProductPage` | Product pages |","enum":["placementTop","placementProductPage"]},"percentage":{"type":"number","format":"float","description":"The bid adjustment percentage value."}}}}}},"BidRecommendationsResponse":{"properties":{"adGroupId":{"description":"The identifier of the ad group that the recommendations are associated with.","type":"string"},"recommendations":{"description":"An array of bid recommendation objects.","type":"array","items":{"properties":{"code":{"description":"The resulting status code for retrieving the bid.","type":"string","enum":["SUCCESS","NOT_FOUND"]},"keyword":{"description":"The keyword text.","type":"string"},"matchType":{"$ref":"#/components/schemas/MatchType"},"suggestedBid":{"$ref":"#/components/schemas/SuggestedBid"}}}}}},"BidRecommendationRequest":{"properties":{"adGroupId":{"description":"The identifier of the ad group that is associated with the targeting expression used to generate the bid recommendation.","type":"number"},"expressions":{"$ref":"#/components/schemas/TargetingExpression"}}},"BidRecommendationsForTargetsResponse":{"properties":{"adGroupId":{"description":"The identifier of the ad group that the recommended bid are associated with.","type":"number"},"recommendations":{"description":"An array of recommendation objects.","type":"array","items":{"type":"object","properties":{"suggestedBid":{"$ref":"#/components/schemas/SuggestedBid"},"expressions":{"$ref":"#/components/schemas/TargetingExpression"}}}}}},"BrandResponse":{"properties":{"id":{"description":"The brand identifier.","type":"number"},"name":{"description":"The brand name.","type":"string"}}},"BulkGetAsinSuggestedKeywordsResponse":{"type":"array","items":{"type":"object","properties":{"keywordText":{"description":"The keyword text.","type":"string"},"matchType":{"$ref":"#/components/schemas/MatchType"}}}},"CreateAdGroup":{"properties":{"name":{"description":"A name for the ad group.","type":"string"},"campaignId":{"description":"An existing campaign to which the ad group is associated.","type":"number"},"defaultBid":{"description":"A bid value for use when no bid is specified for keywords in the ad group.","type":"number","format":"float","minimum":0.02},"state":{"$ref":"#/components/schemas/State"}}},"UpdateAdGroup":{"properties":{"adGroupId":{"description":"The identifier of the ad group.","type":"number"},"name":{"description":"The name of the ad group.","type":"string"},"defaultBid":{"description":"The bid value used when no bid is specified for keywords in the ad group.","type":"number","format":"float"},"state":{"$ref":"#/components/schemas/State"}}},"CampaignTags":{"description":"A list of advertiser-specified custom identifiers for the campaign. Each customer identifier is a key-value pair. You can specify a maximum of 50 identifiers.","type":"object","additionalProperties":{"type":"string"},"example":{"PONumber":"examplePONumber","accountManager":"exampleAccountManager"}},"CreateCampaign":{"properties":{"portfolioId":{"description":"The identifier of an existing portfolio to which the campaign is associated.","type":"number"},"name":{"description":"A name for the campaign. Note that idempotency for this field works different for sellers and vendors. Sellers aren't allowed to have duplicate campaign names, but vendors can have duplicate campaign names.","type":"string"},"tags":{"$ref":"#/components/schemas/CampaignTags"},"campaignType":{"description":"The advertising product managed by this campaign.","type":"string","required":["sponsoredProducts"],"enum":["sponsoredProducts"]},"targetingType":{"description":"The type of targeting for the campaign.","type":"string","enum":["manual","auto"]},"state":{"$ref":"#/components/schemas/State"},"dailyBudget":{"description":"A daily budget for the campaign.","type":"number","format":"float"},"startDate":{"description":"A starting date for the campaign to go live. The format of the date is YYYYMMDD.","type":"string"},"endDate":{"description":"An ending date for the campaign to stop running. The format of the date is YYYYMMDD.","type":"string","nullable":true},"premiumBidAdjustment":{"description":"If set to true, Amazon increases the default bid for ads that are eligible to appear in this placement. See developer notes for more information.","type":"boolean"},"bidding":{"$ref":"#/components/schemas/Bidding"}}},"Campaign":{"properties":{"portfolioId":{"description":"The identifier of an existing portfolio to which the campaign is associated.","type":"number"},"campaignId":{"description":"The identifier of the campaign.","type":"number"},"name":{"description":"The name of the campaign.","type":"string"},"tags":{"$ref":"#/components/schemas/CampaignTags"},"campaignType":{"description":"The advertising product managed by this campaign.","type":"string","enum":["sponsoredProducts"]},"targetingType":{"description":"The type of targeting of the campaign.","type":"string","enum":["manual","auto"]},"state":{"$ref":"#/components/schemas/State"},"dailyBudget":{"description":"The daily budget of the campaign.","type":"number","format":"float","minimum":1.0},"startDate":{"description":"The starting date of the campaign. The format of the date is YYYYMMDD.","type":"string"},"endDate":{"description":"The ending date of the campaign to stop running. The format of the date is YYYYMMDD.","type":"string"},"premiumBidAdjustment":{"description":"If set to true, Amazon increases the default bid for ads that are eligible to appear in this placement. See developer notes for more information.","type":"boolean"},"bidding":{"$ref":"#/components/schemas/Bidding"}}},"CampaignEx":{"properties":{"portfolioId":{"description":"The identifier of an existing portfolio to which the campaign is associated.","type":"number"},"campaignId":{"description":"The identifier of the campaign.","type":"number"},"tags":{"$ref":"#/components/schemas/CampaignTags"},"name":{"description":"The name of the campaign.","type":"string"},"campaignType":{"description":"The advertising product managed by this campaign.","type":"string","enum":["sponsoredProducts"]},"targetingType":{"description":"The type of targeting of the campaign.","type":"string","enum":["manual","auto"]},"state":{"$ref":"#/components/schemas/State"},"dailyBudget":{"description":"The daily budget of the campaign.","type":"number","format":"float","minimum":1.0},"startDate":{"description":"The starting date of the campaign. The format of the date is YYYYMMDD.","type":"string"},"endDate":{"description":"The ending date of the campaign to stop running. The format of the date is YYYYMMDD.","type":"string"},"premiumBidAdjustment":{"description":"If set to true, Amazon increases the default bid for ads that are eligible to appear in this placement. See developer notes for more information.","type":"boolean"},"bidding":{"$ref":"#/components/schemas/Bidding"},"creationDate":{"description":"The creation date of the campaign, in epoch time.","type":"number"},"lastUpdatedDate":{"description":"The date that any value associated with the campaign was last changed, in epoch time.","type":"number"},"servingStatus":{"description":"The computed status of the campaign. See developer notes for more information.","type":"string","enum":["CAMPAIGN_ARCHIVED","CAMPAIGN_PAUSED","CAMPAIGN_STATUS_ENABLED","ADVERTISER_PAYMENT_FAILED","ADVERTISER_PAYMENT_FAILURE","CAMPAIGN_OUT_OF_BUDGET","PENDING_START_DATE","CAMPAIGN_INCOMPLETE","ENDED"]}}},"CampaignNegativeKeyword":{"properties":{"keywordId":{"description":"The identifier of the campaign negative keyword.","type":"number"},"campaignId":{"description":"The identifer of the campaign to which the campaign negative keyword is associated.","type":"number"},"state":{"description":"The campaign negative keyword state.","type":"string","enum":["enabled"]},"keywordText":{"description":"The text of the expression to match against a search query.","type":"string"},"matchType":{"$ref":"#/components/schemas/NegativeMatchType"}}},"CreateCampaignNegativeKeyword":{"properties":{"campaignId":{"description":"The identifer of the campaign to which the campaign negative keyword is associated.","type":"number"},"state":{"description":"The campaign negative keyword state.","type":"string","enum":["enabled"]},"keywordText":{"description":"The text of the expression to match against a search query.","type":"string"},"matchType":{"$ref":"#/components/schemas/NegativeMatchType"}}},"UpdateCampaignNegativeKeyword":{"properties":{"keywordId":{"description":"The identifier of the campaign negative keyword.","type":"number"},"state":{"description":"The campaign negative keyword state.","type":"string","enum":["deleted"]}}},"CampaignNegativeKeywordEx":{"properties":{"keywordId":{"description":"The identifier of the campaign negative keyword.","type":"number"},"campaignId":{"description":"The identifer of the campaign to which the campaign negative keyword is associated.","type":"number"},"state":{"description":"The campaign negative keyword state.","type":"string","enum":["enabled"]},"keywordText":{"description":"The text of the expression to match against a search query.","type":"string"},"matchType":{"$ref":"#/components/schemas/NegativeMatchType"},"creationDate":{"description":"Creation date in epoch time.","type":"number"},"lastUpdatedDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatus":{"description":"The serving status of the campaign negative keyword. See the **computed status** section of the [developer notes](https://advertising.amazon.com/API/docs/en-us/reference/concepts/developer-notes) for definitions.","type":"string","enum":["TARGETING_CLAUSE_STATUS_LIVE","PENDING_START_DATE"]}}},"CampaignNegativeKeywordResponse":{"properties":{"keywordId":{"description":"The identifier of the campaign negative keyword.","type":"number"},"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the code.","type":"string"},"description":{"description":"A human-readable description of the code.","type":"string"}}},"CampaignResponse":{"properties":{"campaignId":{"description":"The identifier of the campaign.","type":"number"},"code":{"description":"An enumerated `SUCCESS` or `ERROR` code for machine use.","type":"string"},"description":{"description":"A human-readable description of the code.","type":"string"}}},"CategoryResponse":{"properties":{"id":{"description":"The category identifier.","type":"number"},"name":{"description":"The category name.","type":"string"},"isTargetable":{"description":"If set to `true`, indicates this category can be targeted in a targeting expression. Otherwise, set to false.","type":"string","enum":[true,false]},"path":{"description":"The path of this category within the category catalog.","type":"string"}}},"Error":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}},"ExpressionType":{"description":"The type of expression.","type":"string","enum":["manual","auto"]},"GetAsinSuggestedKeywordsResponse":{"properties":{"asin":{"description":"The ASIN for which keywords are suggested.","type":"string"},"suggestedKeywords":{"description":"The list of suggested keywords.","type":"array","items":{"type":"object","properties":{"keywordText":{"description":"The text of the suggested keyword.","type":"string"},"matchType":{"$ref":"#/components/schemas/MatchType"}}}}}},"Keyword":{"properties":{"keywordId":{"description":"The identifier of the keyword.","type":"number"},"campaignId":{"description":"The identifer of the campaign to which the keyword is associated.","type":"number"},"adGroupId":{"description":"The identifier of the ad group to which this keyword is associated.","type":"number"},"state":{"$ref":"#/components/schemas/State"},"keywordText":{"description":"The keyword text.","type":"string"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"matchType":{"$ref":"#/components/schemas/MatchType"},"bid":{"description":"Bid associated with this keyword. Applicable to biddable match types only.","type":"number","format":"float","minimum":0.02}}},"CreateKeyword":{"properties":{"campaignId":{"description":"The identifer of the campaign to which the keyword is associated.","type":"number"},"adGroupId":{"description":"The identifier of the ad group to which this keyword is associated.","type":"number"},"state":{"$ref":"#/components/schemas/State"},"keywordText":{"description":"The keyword text.","type":"string"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"nativeLanguageLocale":{"description":"The locale preference of the advertiser. For example, if the advertiser’s preferred language is Simplified Chinese, set the locale to `zh_CN`. Supported locales include: Simplified Chinese (locale: zh_CN) for US, UK and CA. English (locale: en_GB) for DE, FR, IT and ES.","type":"string"},"matchType":{"$ref":"#/components/schemas/MatchType"},"bid":{"description":"Bid associated with this keyword. Applicable to biddable match types only.","type":"number","format":"float","nullable":true,"minimum":0.02}}},"UpdateKeyword":{"properties":{"keywordId":{"description":"The identifier of the keyword.","type":"number"},"state":{"$ref":"#/components/schemas/State"},"bid":{"description":"Bid associated with this keyword. Applicable to biddable match types only.","type":"number","format":"float","nullable":true,"minimum":0.02}}},"KeywordEx":{"properties":{"keywordId":{"description":"The identifier of the keyword.","type":"number"},"campaignId":{"description":"The identifer of the campaign to which the keyword is associated.","type":"number"},"adGroupId":{"description":"The identifier of the ad group to which this keyword is associated.","type":"number"},"state":{"$ref":"#/components/schemas/State"},"keywordText":{"description":"The text of the expression to match against a search query.","type":"string"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"matchType":{"$ref":"#/components/schemas/MatchType"},"bid":{"description":"Bid associated with this keyword. This table details the maximum allowable bid (in local currency) for keywords by marketplace:\n| Marketplace | Currency | Min / Max bid for SP |\n| --- | --- | --- |\n| US | USD | 0.02 / 1000 |\n| CA | CAD | 0.02 / 1000 |\n| UK | GBP | 0.02 / 1000 |\n| DE | EUR | 0.02 / 1000 |\n| FR | EUR | 0.02 / 1000 |\n| ES | EUR | 0.02 / 1000 |\n| IT | EUR | 0.02 / 1000 |\n| JP | JPY | 2.0 / 100000 |\n| AU | AUD | 0.10 / 1410 |\n| AE | AED | 0.24 / 184.0 |","type":"number","format":"float","minimum":0.02},"creationDate":{"description":"Creation date in epoch time.","type":"number"},"lastUpdatedDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatus":{"description":"The serving status of the keyword. See the **computed status** section of the [developer notes](https://advertising.amazon.com/API/docs/en-us/reference/concepts/developer-notes) for definitions.","type":"string","enum":["TARGETING_CLAUSE_ARCHIVED","TARGETING_CLAUSE_PAUSED","TARGETING_CLAUSE_STATUS_LIVE","TARGETING_CLAUSE_POLICING_SUSPENDED","CAMPAIGN_OUT_OF_BUDGET","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","ACCOUNT_OUT_OF_BUDGET","PENDING_START_DATE"]}}},"KeywordBidRecommendationsResponse":{"properties":{"keywordId":{"description":"The identifier of the keyword that the bid is associated with.","type":"number"},"adGroupId":{"description":"The identifier of the ad group that the bid is associated with.","type":"number"},"suggestedBid":{"$ref":"#/components/schemas/SuggestedBid"}}},"KeywordBidRecommendationsData":{"properties":{"adGroupId":{"description":"The identifier of the ad group that the keywords are associated with.","type":"number"},"keywords":{"description":"An array of keyword data objects.","type":"array","items":{"type":"object","properties":{"keyword":{"description":"The keyword text.","type":"string"},"matchType":{"$ref":"#/components/schemas/MatchType"}}},"minItems":0,"maxItems":5000}}},"KeywordResponse":{"properties":{"keywordId":{"description":"The identifer of the keyword.","type":"number"},"code":{"description":"The success or error code for the operation.","type":"string"},"details":{"description":"The human-readable description of the error.","type":"string"},"description":{"description":"The human-readable description of the error.","type":"string"}}},"MatchType":{"description":"The type of match. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","type":"string","enum":["exact","phrase","broad"]},"NegativeMatchType":{"description":"The type of match. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","type":"string","enum":["negativeExact","negativePhrase"]},"NegativeKeyword":{"properties":{"keywordId":{"description":"The identifier of the negative keyword.","type":"number"},"campaignId":{"description":"The identifer of the campaign to which the negative keyword is associated.","type":"number"},"adGroupId":{"description":"The identifier of the ad group to which the negative keyword is associated.","type":"number"},"state":{"$ref":"#/components/schemas/State"},"keywordText":{"description":"The text of the expression to match against a search query.","type":"string"},"matchType":{"$ref":"#/components/schemas/NegativeMatchType"}}},"NegativeKeywordEx":{"properties":{"keywordId":{"description":"The identifier of the keyword.","type":"number"},"campaignId":{"description":"The identifer of the campaign to which the keyword is associated.","type":"number"},"adGroupId":{"description":"The identifier of the ad group to which this keyword is associated.","type":"number"},"state":{"$ref":"#/components/schemas/State"},"keywordText":{"description":"The text of the expression to match against a search query.","type":"string"},"matchType":{"$ref":"#/components/schemas/NegativeMatchType"},"creationDate":{"description":"Creation date in epoch time.","type":"number"},"lastUpdatedDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatus":{"description":"The serving status of the keyword. See the **computed status** section of the [developer notes](https://advertising.amazon.com/API/docs/en-us/reference/concepts/developer-notes) for definitions.","type":"string","enum":["TARGETING_CLAUSE_ARCHIVED","TARGETING_CLAUSE_PAUSED","TARGETING_CLAUSE_STATUS_LIVE","TARGETING_CLAUSE_POLICING_SUSPENDED","CAMPAIGN_OUT_OF_BUDGET","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","ACCOUNT_OUT_OF_BUDGET","PENDING_START_DATE"]}}},"CreateNegativeKeyword":{"properties":{"campaignId":{"description":"The identifier of the campaign to which the negative keyword is associated.","type":"number"},"adGroupId":{"description":"The identifier of the ad group to which the negative keyword is associated.","type":"number"},"state":{"$ref":"#/components/schemas/State"},"keywordText":{"description":"The text of the expression to match against a search query.","type":"string"},"matchType":{"$ref":"#/components/schemas/NegativeMatchType"}}},"UpdateNegativeKeyword":{"properties":{"keywordId":{"description":"The identifer of the keyword.","type":"number"},"state":{"$ref":"#/components/schemas/State"}}},"NegativeKeywordResponse":{"properties":{"keywordId":{"description":"The identifier of the keyword.","type":"number"},"code":{"description":"The success or error code for the operation.","type":"string"},"details":{"description":"The human-readable description of the error.","type":"string"},"description":{"description":"The human-readable description of the error.","type":"string"}}},"NegativeTargetingClauseResponse":{"properties":{"targetId":{"description":"The negative target identifier.","type":"number"},"code":{"description":"An enumerated response code.","type":"string"},"details":{"description":"A human-readable description of the value in the `code` field.","type":"string"},"description":{"description":"A human-readable description of the value in the `code` field.","type":"string"}}},"CreateNegativeTargetingClause":{"properties":{"campaignId":{"description":"The identifier of the campaign to which this negative target is associated.","type":"number"},"adGroupId":{"description":"The identifier of the ad group to which this negative target is associated.","type":"number"},"state":{"$ref":"#/components/schemas/State"},"expression":{"description":"The negative targeting expression.","type":"array","items":{"$ref":"#/components/schemas/NegativeTargetingExpressionPredicate"}},"expressionType":{"$ref":"#/components/schemas/ExpressionType"}}},"UpdateNegativeTargetingClause":{"properties":{"targetId":{"description":"The target identifier.","type":"number"},"state":{"$ref":"#/components/schemas/State"},"expression":{"description":"The targeting expression.","type":"array","items":{"$ref":"#/components/schemas/NegativeTargetingExpressionPredicate"}},"expressionType":{"$ref":"#/components/schemas/ExpressionType"}}},"NegativeTargetingClause":{"properties":{"targetId":{"description":"The negative target identifier.","type":"number"},"campaignId":{"description":"The identifier of the campaign to which this negative target is associated.","type":"number"},"adGroupId":{"description":"The identifier of the ad group to which this negative target is associated.","type":"number"},"state":{"$ref":"#/components/schemas/State"},"expression":{"description":"The negative targeting expression.","type":"array","items":{"$ref":"#/components/schemas/NegativeTargetingExpressionPredicate"}},"expressionType":{"$ref":"#/components/schemas/NegativeExpressionType"}}},"NegativeTargetingClauseEx":{"properties":{"targetId":{"description":"The negative target identifier.","type":"number"},"campaignId":{"description":"The identifier of the campaign to which this negative target is associated.","type":"number"},"adGroupId":{"description":"The identifier of the ad group to which this negative target is associated.","type":"number"},"state":{"$ref":"#/components/schemas/State"},"expression":{"description":"The negative targeting expression.","type":"array","items":{"$ref":"#/components/schemas/NegativeTargetingExpressionPredicate"}},"expressionType":{"$ref":"#/components/schemas/NegativeExpressionType"},"creationDate":{"description":"The epoch time that the negative targeting clause was created.","type":"number"},"lastUpdatedDate":{"description":"The epoch time that the negative targeting clause was updated.","type":"number"},"servingStatus":{"description":"The computed status of the negative targeting clause. See the [developer notes](https://advertising.amazon.com/API/docs/en-us/reference/concepts/developer-notes) for more information.","type":"string","enum":["TARGETING_CLAUSE_ARCHIVED","TARGETING_CLAUSE_PAUSED","TARGETING_CLAUSE_STATUS_LIVE","TARGETING_CLAUSE_POLICING_SUSPENDED","CAMPAIGN_OUT_OF_BUDGET","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","ACCOUNT_OUT_OF_BUDGET","PENDING_START_DATE"]}}},"ProductAd":{"properties":{"adId":{"description":"The product ad identifier.","type":"number"},"campaignId":{"description":"The campaign identifier.","type":"number"},"adGroupId":{"description":"The ad group identifier.","type":"number"},"sku":{"description":"The SKU associated with the product. Defined for seller accounts only.","type":"string"},"asin":{"description":"The ASIN associated with the product. Defined for vendors only.","type":"string"},"state":{"$ref":"#/components/schemas/State"}}},"CreateProductAd":{"properties":{"campaignId":{"description":"The campaign identifier.","type":"number"},"adGroupId":{"description":"The ad group identifier.","type":"number"},"sku":{"description":"The SKU associated with the product. Defined for seller accounts only.","type":"string"},"asin":{"description":"The ASIN associated with the product. Defined for vendors only.","type":"string"},"state":{"$ref":"#/components/schemas/State"}}},"UpdateProductAd":{"properties":{"adId":{"description":"The product ad identifier.","type":"number"},"state":{"$ref":"#/components/schemas/State"}}},"ProductAdEx":{"properties":{"adId":{"description":"The product ad identifier.","type":"number"},"campaignId":{"description":"The campaign identifier.","type":"number"},"adGroupId":{"description":"The ad group identifier.","type":"number"},"sku":{"description":"The SKU associated with the product. Defined for seller accounts only.","type":"string"},"asin":{"description":"The ASIN associated with the product. Defined for vendors only.","type":"string"},"state":{"$ref":"#/components/schemas/State"},"creationDate":{"description":"The epoch date the product ad was created.","type":"number"},"lastUpdatedDate":{"description":"The epoch date the product ad was last updated.","type":"number"},"servingStatus":{"description":"The computed status of the product ad. See the [developer notes](https://advertising.amazon.com/API/docs/en-us/reference/concepts/developer-notes) for more information.","type":"string","enum":["AD_ARCHIVED","AD_PAUSED","AD_STATUS_LIVE","AD_POLICING_SUSPENDED","CAMPAIGN_OUT_OF_BUDGET","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","ACCOUNT_OUT_OF_BUDGET","MISSING_DECORATION","PENDING_START_DATE"]},"servingStatusDetails":{"description":"Details of serving status. Only statuses related to moderation according to the ad policy are currently included.","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The status identifier."},"severity":{"type":"string","description":"An enumerated advertising eligibility severity status. If set to `INELIGIBLE`, the product cannot be included in an advertisement. If set to `ELIGIBLE_WITH_WARNING`, the product may not receive impressions when included in an advertisement."},"message":{"type":"string","description":"A human-readable description of the status identifier specified in the `name` field."},"helpUrl":{"type":"string","description":"A URL with additional information about the status identifier. May not be present for all status identifiers."}}}}}},"ProductRecommendationsResponse":{"properties":{"totalResultCount":{"description":"The total number of recommendations in the response.","type":"number"},"recommendedProducts":{"type":"array","items":{"type":"object","properties":{"recommendedTargetAsin":{"description":"The recommended ASIN for targeting.","type":"string"}}}}}},"RefinementsResponse":{"properties":{"categoryId":{"description":"The category identifier.","type":"number"},"brands":{"description":"The brands found in this category.","type":"array","items":{"type":"object","properties":{"id":{"description":"The brand identifier. Note that this is not the same identifier returned from the [getBrands](sponsored-brands/3-0/openapi#/Brands/getBrands) operation.","type":"number"},"name":{"description":"The brand name.","type":"string"}}}}}},"ReportMetrics":{"description":"A comma-separated list of the metrics to be included in the report. \nEach report type supports different metrics. To understand supported metrics for each report type, see [Report types](/API/docs/en-us/guides/reporting/v2/report-types).","type":"string"},"Report":{"properties":{"stateFilter":{"type":"string","description":"Filters the response to include reports with `stateFilter` set to one of the values in the comma-delimited list. `stateFilter` and `segment` cannot be used in the same report request. \n`asins` report types do not support the use of `stateFilter`.","enum":["enabled","paused","archived"]},"campaignType":{"type":"string","description":"The type of campaign. Only required for `asins` reports - don't use with other report types.","required":["sponsoredProducts"],"enum":["sponsoredProducts"]},"segment":{"description":"A secondary dimension used to further segment certain types of reports. `stateFilter` and `segment` cannot be used in the same report request. Keyword search term reports only return search terms that have generated at least one click or sale.\n\n**Note**: Search term reports for auto-targeted campaigns created before 11/14/2018 can be accessed from the `/v2/sp/keywords/report` resource. Search term reports for auto-targeted campaigns generated on-and-after 11/14/2018 can be accessed from the `/v2/sp/targets/report` resource. \n\n| Dimension | Valid report types | Description |\n|-----------|-------------|-------------|\n| query | keywords, targets | Segments a report based on customer search term. |\n| placement | campaigns | Segments a `campaigns` report based on the page location where the ad appeared. |","type":"string","enum":["query","placement"]},"reportDate":{"description":"The date for which to retrieve the performance report in YYYYMMDD format. The time zone is specified by the profile used to request the report. If this date is today, then the performance report may contain partial information. Reports are not available for data older than 60 days. For details on data latency, see the service guarantees in the [developer notes](https://advertising.amazon.com/API/docs/en-us/reference/concepts/developer-notes) section.","type":"string"},"metrics":{"$ref":"#/components/schemas/ReportMetrics"}}},"SnapshotRequest":{"properties":{"stateFilter":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"]}}},"SnapshotResponse":{"properties":{"snapshotId":{"description":"The snapshot identifier.","type":"string"},"recordType":{"description":"The record type of the report.","type":"string","enum":["campaigns","adGroups","keywords","negativeKeywords","campaignNegativeKeywords","productAds","targets","negativeTargets"]},"status":{"description":"The generation status of the snapshot.","type":"string","enum":["IN_PROGRESS","SUCCESS","FAILURE"]}}},"State":{"description":"The current resource state.","type":"string","enum":["enabled","paused","archived"]},"SuggestedBid":{"description":"Information about the recommended bid.","type":"object","properties":{"suggested":{"description":"The bid recommendation.","type":"number"},"rangeStart":{"description":"The lower bound bid recommendation.","type":"number"},"rangeEnd":{"description":"The upper bound bid recommendation.","type":"number"}}},"TargetingExpression":{"properties":{"expressions":{"description":"List of targeting expressions for which to generate bid recommendations.","type":"array","items":{"type":"object","properties":{"type":{"description":"The type.","type":"array","items":{"type":"string","enum":["queryBroadMatches","queryPhraseMatches","queryExactMatches","asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs","queryBroadRelMatches","queryHighRelMatches","asinSubstituteRelated","asinAccessoryRelated"]}},"value":{"description":"The expression value","type":"string"}}}}}},"NegativeExpressionType":{"description":"The type of expression.","type":"string","enum":["manual"]},"NegativeTargetingExpressionPredicate":{"properties":{"value":{"description":"The expression value","type":"string"},"type":{"description":"The targeting type","type":"string","enum":["asinBrandSameAs","asinSameAs"]}}},"TargetingExpressionPredicate":{"properties":{"value":{"description":"The expression value","type":"string"},"type":{"description":"The type of targeting expression. You can specify values for the following predicates:\n| Predicate | Description |\n| --- | --- |\n| `asinCategorySameAs` | Negatively Target the same category as the category expressed. |\n| `asinBrandSameAs` | Target the brand that is the same as the brand expressed. |\n| `asinPriceLessThan` | Target a price that is less than the price expressed. |\n| `asinPriceBetween` | Target a price that is between the prices expressed. |\n| `asinPriceGreaterThan` | Target a price that is greater than the price expressed. |\n| `asinReviewRatingLessThan` | Target a review rating less than the review rating that is expressed. |\n| `asinReviewRatingBetween` | Target a review rating that is between the review ratings expressed. |\n| `asinReviewRatingGreaterThan` | Target a review rating that is greater than the review rating expressed. |\n| `asinSameAs` | Target an ASIN that is the same as the ASIN expressed. |\n| `asinIsPrimeShippingEligible` | Target products that are Prime Shipping Eligible. This refinement can be applied at a category or brand level only. |\n| `asinAgeRangeSameAs` | Target an age range that is in the expressed range. This refinement can be applied for toys and games categories only. |\n| `asinGenreSameAs` | Target products related to the expressed genre. This refinement can be applied for Books and eBooks categories only. |\n| `asinExpandedFrom` | Target a single product along with others closely related to it, including substitutes and complements. |\n| `queryExactMatches` | Use this enum to exactly match your query with search queries. |\n| `queryPhraseMatches` | Use this enum to match your query with search phrases. |\n| `queryBroadMatches` | Use this enum to broadly match your query with search queries. |","type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs","queryBroadRelMatches","queryHighRelMatches","asinSubstituteRelated","asinAccessoryRelated","asinAgeRangeSameAs","asinGenreSameAs","asinIsPrimeShippingEligible","asinExpandedFrom","queryExactMatches","queryPhraseMatches","queryBroadMatches"]}}},"TargetingClause":{"properties":{"targetId":{"description":"The target identifier.","type":"number"},"campaignId":{"description":"The identifier of the campaign to which this target is associated.","type":"number"},"adGroupId":{"description":"The identifier of the ad group to which this target is associated.","type":"number"},"state":{"$ref":"#/components/schemas/State"},"expression":{"description":"The targeting expression.","type":"array","items":{"$ref":"#/components/schemas/TargetingExpressionPredicate"}},"resolvedExpression":{"description":"The resolved targeting expression.","type":"array","items":{"$ref":"#/components/schemas/TargetingExpressionPredicate"}},"expressionType":{"$ref":"#/components/schemas/ExpressionType"},"bid":{"$ref":"#/components/schemas/Bid"}}},"CreateTargetingClause":{"properties":{"campaignId":{"description":"The identifier of the campaign to which this target is associated.","type":"number"},"adGroupId":{"description":"The identifier of the ad group to which this target is associated.","type":"number"},"state":{"$ref":"#/components/schemas/State"},"expression":{"description":"The targeting expression.","type":"array","items":{"$ref":"#/components/schemas/TargetingExpressionPredicate"}},"resolvedExpression":{"description":"The resolved targeting expression.","type":"array","items":{"$ref":"#/components/schemas/TargetingExpressionPredicate"}},"expressionType":{"$ref":"#/components/schemas/ExpressionType"},"bid":{"$ref":"#/components/schemas/Bid"}}},"UpdateTargetingClause":{"properties":{"targetId":{"description":"The target identifier.","type":"number"},"state":{"$ref":"#/components/schemas/State"},"expression":{"description":"The targeting expression.","type":"array","items":{"$ref":"#/components/schemas/TargetingExpressionPredicate"}},"resolvedExpression":{"description":"The resolved targeting expression.","type":"array","items":{"$ref":"#/components/schemas/TargetingExpressionPredicate"}},"expressionType":{"$ref":"#/components/schemas/ExpressionType"},"bid":{"$ref":"#/components/schemas/Bid"}}},"TargetingClauseEx":{"properties":{"targetId":{"description":"The target identifier.","type":"number"},"campaignId":{"description":"The identifier of the campaign to which this target is associated.","type":"number"},"adGroupId":{"description":"The identifier of the ad group to which this target is associated.","type":"number"},"state":{"$ref":"#/components/schemas/State"},"expression":{"description":"The targeting expression.","type":"array","items":{"$ref":"#/components/schemas/TargetingExpressionPredicate"}},"resolvedExpression":{"description":"The resolved targeting expression.","type":"array","items":{"$ref":"#/components/schemas/TargetingExpressionPredicate"}},"expressionType":{"$ref":"#/components/schemas/ExpressionType"},"bid":{"$ref":"#/components/schemas/Bid"},"creationDate":{"description":"The epoch time that the targeting clause was created.","type":"number"},"lastUpdatedDate":{"description":"The epoch time that the targeting clause was updated.","type":"number"},"servingStatus":{"description":"The computed status of the targeting clause. See the [developer notes](https://advertising.amazon.com/API/docs/en-us/reference/concepts/developer-notes) for more information.","type":"string","enum":["TARGETING_CLAUSE_ARCHIVED","TARGETING_CLAUSE_PAUSED","TARGETING_CLAUSE_STATUS_LIVE","TARGETING_CLAUSE_POLICING_SUSPENDED","CAMPAIGN_OUT_OF_BUDGET","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","ACCOUNT_OUT_OF_BUDGET","PENDING_START_DATE"]}}},"TargetingClauseResponse":{"properties":{"targetId":{"description":"The target identifier.","type":"number"},"code":{"description":"An enumerated response code.","type":"string"},"details":{"description":"A human-readable description of the value in the `code` field.","type":"string"},"description":{"description":"A human-readable description of the value in the `code` field.","type":"string"}}},"UpdateCampaign":{"properties":{"campaignId":{"description":"The identifier of an existing campaign to update.","type":"number"},"portfolioId":{"description":"The identifier of an existing portfolio to which the campaign is associated.","type":"number"},"name":{"description":"The name of the campaign.","type":"string"},"tags":{"$ref":"#/components/schemas/CampaignTags"},"state":{"$ref":"#/components/schemas/State"},"dailyBudget":{"description":"The daily budget of the campaign.","type":"number","format":"float","minimum":1.0},"startDate":{"description":"The starting date of the campaign. The format of the date is YYYYMMDD.","type":"string"},"endDate":{"description":"The ending date of the campaign to stop running. The format of the date is YYYYMMDD.","type":"string","nullable":true},"premiumBidAdjustment":{"description":"If set to true, Amazon increases the default bid for ads that are eligible to appear in this placement. See developer notes for more information.","type":"boolean"},"bidding":{"$ref":"#/components/schemas/Bidding"}}},"Bid":{"description":"The bid for ads sourced using the target. Targets that do not have bid values in listTargetingClauses will inherit the defaultBid from the adGroup level. This table details the maximum allowable bid (in local currency) for keywords by marketplace:\n| Marketplace | Currency | Min / Max bid for SP |\n| --- | --- | --- |\n| US | USD | 0.02 / 1000 |\n| CA | CAD | 0.02 / 1000 |\n| UK | GBP | 0.02 / 1000 |\n| DE | EUR | 0.02 / 1000 |\n| FR | EUR | 0.02 / 1000 |\n| ES | EUR | 0.02 / 1000 |\n| IT | EUR | 0.02 / 1000 |\n| JP | JPY | 2.0 / 100000 |\n| AU | AUD | 0.10 / 1410 |\n| AE | AED | 0.24 / 184.0 |","type":"number","format":"float","minimum":0.02,"nullable":true}}}}