{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"AccountIdHeaderOptional":{"description":"The identifier of an Amazon Ads Advertiser Account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"type":"string"}},"ClientIdHeader":{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account.","in":"header","name":"Amazon-Ads-ClientId","required":true,"schema":{"type":"string"}},"ScopeHeaderOptional":{"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 and choose profile id profileId from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}}},"requestBodies":{},"responses":{},"schemas":{"BadGatewayResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"BadRequestResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ContentTooLargeResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"Error":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"fieldLocation":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ErrorCode":{"description":"**ErrorCode Enum:**\n\n| ErrorCode | Description |\n|------|------|\n| `ACTION_NOT_SUPPORTED` | The request is not supported. |\n| `ACTIVE_RESOURCE_LIMIT_EXCEEDED` | Too many live resources. Remove resources and try again. |\n| `ARCHIVED_PARENT_CANNOT_CREATE` | New resources cannot be created within an archived parent. |\n| `ARCHIVED_PARENT_CANNOT_EDIT` | Resources within an archived parent cannot be edited. |\n| `ARCHIVED_RESOURCE_CANNOT_EDIT` | Archived resources cannot be edited. |\n| `AUTOCREATED_ENTITY_CANNOT_EDIT` | Autocreated entities cannot be edited. To complete this action, create the resource manually. |\n| `BAD_REQUEST` | The request is not valid considering the documented schema. |\n| `CONFLICT` | Operation could not be completed due to a conflict. Please retry your request. |\n| `CONTENT_TOO_LARGE` | The request is too large. Consider splitting it into multiple requests. |\n| `DATE_CANNOT_BE_IN_PAST` | Update the date to be in the future. |\n| `DATE_CANNOT_BE_NULL` | Update the date. |\n| `DATE_TOO_SOON` | Update the date to be further in the future. |\n| `DUPLICATE_FIELD_VALUE_FOUND` | Multiple resources share the non-unique field values. Remove the non-unique field value. |\n| `DUPLICATE_RESOURCE_ID_FOUND` | Multiple resources share the same ID. Remove the duplicate ID. |\n| `DURATION_TOO_SHORT` | Update the length to be within the required range. |\n| `FEATURE_DISCONTINUED` | Feature has been discontinued. |\n| `FIELD_SIZE_IS_ABOVE_MAXIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_SIZE_IS_BELOW_MINIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_SIZE_IS_OUT_OF_RANGE` | Update the value to be within the required range. |\n| `FIELD_VALUE_CANNOT_EDIT` | Field value cannot be edited. |\n| `FIELD_VALUE_CONTAINS_BLOCKLISTED_WORDS` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_CONTAINS_INVALID_CHARACTERS` | Remove the invalid characters and try again. |\n| `FIELD_VALUE_IS_ABOVE_MAXIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_VALUE_IS_BELOW_MINIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_VALUE_IS_EMPTY` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_INVALID` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_NULL` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_OUT_OF_RANGE` | Update the value to be within the required range. |\n| `FIELD_VALUE_MISMATCH` | Mismatch among resource field values. |\n| `FIELD_VALUE_MUST_BE_EMPTY_OR_NULL` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_NOT_FOUND` | Resource specified in the field value not found. Try again with valid value. |\n| `FIELD_VALUE_NOT_UNIQUE` | Resource field value conflicts with existing resource. Try again with an unique field value. |\n| `FORBIDDEN` | The caller is not authorized to make the given request. |\n| `GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_PORTFOLIO` | The campaign is associated with a global campaign. Portfolio association cannot be updated on a child campaign. Please perform operation on the global campaign. |\n| `GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_STATE` | The campaign is associated with a global campaign. The state on child campaign cannot be set to archived. Please perform operation on global campaign. |\n| `GLOBAL_CAMPAIGN_SINGLE_ADGROUP_LIMIT` | The campaign is associated with a global campaign. Only one ad group can be created under this campaign. |\n| `INTERNAL_ERROR` | The server encountered an unexpected condition that prevented it from fulfilling the request. |\n| `NOT_FOUND` | The requested resource does not exist. |\n| `PAYMENT_ISSUE` | Payment failed. |\n| `PRODUCT_INELIGIBLE` | Product is not eligible for advertising. Try again with a valid product. |\n| `RESOURCE_DOES_NOT_BELONG_TO_PARENT` | Resource does not belong to the specified parent. Try again with a valid parent ID. |\n| `RESOURCE_ID_NOT_FOUND` | Resource ID not found. Try again with valid ID. |\n| `RESOURCE_IS_EMPTY` | Update the request with the required information for this resource. |\n| `RESOURCE_IS_IN_TERMINAL_STATE` | Resource is in terminal state. |\n| `RESOURCE_IS_NULL` | Update the request with the required information for this resource. |\n| `TOO_MANY_REQUESTS` | There have been too many requests, please slow down your call rate. |\n| `TOTAL_RESOURCE_LIMIT_EXCEEDED` | Too many resources. Remove resources and try again. |\n| `UNAUTHORIZED` | The request lacks the necessary credentials. |\n| `UNSUPPORTED_MARKETPLACE` | Marketplace not supported. Try again with a supported marketplace. |\n","enum":["ACTION_NOT_SUPPORTED","ACTIVE_RESOURCE_LIMIT_EXCEEDED","ARCHIVED_PARENT_CANNOT_CREATE","ARCHIVED_PARENT_CANNOT_EDIT","ARCHIVED_RESOURCE_CANNOT_EDIT","AUTOCREATED_ENTITY_CANNOT_EDIT","BAD_REQUEST","CONFLICT","CONTENT_TOO_LARGE","DATE_CANNOT_BE_IN_PAST","DATE_CANNOT_BE_NULL","DATE_TOO_SOON","DUPLICATE_FIELD_VALUE_FOUND","DUPLICATE_RESOURCE_ID_FOUND","DURATION_TOO_SHORT","FEATURE_DISCONTINUED","FIELD_SIZE_IS_ABOVE_MAXIMUM_LIMIT","FIELD_SIZE_IS_BELOW_MINIMUM_LIMIT","FIELD_SIZE_IS_OUT_OF_RANGE","FIELD_VALUE_CANNOT_EDIT","FIELD_VALUE_CONTAINS_BLOCKLISTED_WORDS","FIELD_VALUE_CONTAINS_INVALID_CHARACTERS","FIELD_VALUE_IS_ABOVE_MAXIMUM_LIMIT","FIELD_VALUE_IS_BELOW_MINIMUM_LIMIT","FIELD_VALUE_IS_EMPTY","FIELD_VALUE_IS_INVALID","FIELD_VALUE_IS_NULL","FIELD_VALUE_IS_OUT_OF_RANGE","FIELD_VALUE_MISMATCH","FIELD_VALUE_MUST_BE_EMPTY_OR_NULL","FIELD_VALUE_NOT_FOUND","FIELD_VALUE_NOT_UNIQUE","FORBIDDEN","GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_PORTFOLIO","GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_STATE","GLOBAL_CAMPAIGN_SINGLE_ADGROUP_LIMIT","INTERNAL_ERROR","NOT_FOUND","PAYMENT_ISSUE","PRODUCT_INELIGIBLE","RESOURCE_DOES_NOT_BELONG_TO_PARENT","RESOURCE_ID_NOT_FOUND","RESOURCE_IS_EMPTY","RESOURCE_IS_IN_TERMINAL_STATE","RESOURCE_IS_NULL","TOO_MANY_REQUESTS","TOTAL_RESOURCE_LIMIT_EXCEEDED","UNAUTHORIZED","UNSUPPORTED_MARKETPLACE"],"type":"string"},"ErrorsIndex":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"}},"required":["errors","index"],"type":"object"},"ForbiddenResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"GatewayTimeoutResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"InternalServerErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"NotFoundResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"SPAdProduct":{"description":"**AdProduct Enum:**\n\n| AdProduct | Description |\n|------|------|\n| `SPONSORED_PRODUCTS` | Sponsored Products ad product. |\n","enum":["SPONSORED_PRODUCTS"],"type":"string"},"SPAudienceBidAdjustment":{"properties":{"audienceId":{"description":"The unique identifier of the Audience to apply bid adjustment.","type":"string"},"percentage":{"description":"The selection of the percentage change associated with a given audience and bid adjustment settings. Null removes audience","format":"int32","type":"integer"}},"required":["audienceId"],"type":"object"},"SPAutoCreationSettings":{"properties":{"autoCreateTargets":{"description":"Gives Amazon permission to automatically create targets associated with the campaign based on the products being advertised.","type":"boolean"},"autoManageCampaign":{"description":"Flag that allows Amazon to manage the lifecycle of your Campaign.","type":"boolean"}},"required":["autoCreateTargets"],"type":"object"},"SPAutoScaleGlobalCampaignSetting":{"description":"**AutoScaleGlobalCampaignSetting Enum:**\n\n| AutoScaleGlobalCampaignSetting | Description |\n|------|------|\n| `AUTO` | Auto scale global campaign to new marketplaces |\n| `MANUAL` | Manually scale global campaign to new marketplaces |\n","enum":["AUTO","MANUAL"],"type":"string"},"SPBidAdjustments":{"properties":{"audienceBidAdjustments":{"description":"Bid Adjustments based on the audiences","items":{"$ref":"#/components/schemas/SPAudienceBidAdjustment"},"maxItems":10,"minItems":0,"type":"array"},"creativeBidAdjustments":{"description":"Bid Adjustments based on ads being shown as a creative. Range of bid adjustment value would be 0:900","items":{"$ref":"#/components/schemas/SPCreativeBidAdjustment"},"maxItems":2,"minItems":0,"type":"array"},"placementBidAdjustments":{"description":"Bid adjustments based on ad placements. Not supported for Sponsored Brands campaigns using the SALES_UP_AND_DOWN bid strategy.","items":{"$ref":"#/components/schemas/SPPlacementBidAdjustment"},"maxItems":5,"minItems":0,"type":"array"}},"type":"object"},"SPBidSettings":{"properties":{"bidAdjustments":{"$ref":"#/components/schemas/SPBidAdjustments"},"bidStrategy":{"$ref":"#/components/schemas/SPBidStrategy"}},"type":"object"},"SPBidStrategy":{"description":"**BidStrategy Enum:**\n\n| BidStrategy | Description |\n|------|------|\n| `MANUAL` | Uses your exact bid and any placement adjustments you set, and is not subject to dynamic bidding. |\n| `RULE_BASED` | Applies bidding rules defined by the advertiser. |\n| `SALES_DOWN_ONLY` | Decreases your bids in real time when your ad is less likely to convert to a sale. Bids will never increase beyond your set bid. |\n| `SALES_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","enum":["MANUAL","RULE_BASED","SALES_DOWN_ONLY","SALES_UP_AND_DOWN"],"type":"string"},"SPBudget":{"properties":{"budgetType":{"$ref":"#/components/schemas/SPBudgetType"},"budgetValue":{"$ref":"#/components/schemas/SPBudgetValue"},"recurrenceTimePeriod":{"$ref":"#/components/schemas/SPRecurrence"}},"required":["budgetType","budgetValue","recurrenceTimePeriod"],"type":"object"},"SPBudgetSettings":{"properties":{"marketplaceBudgetAllocation":{"$ref":"#/components/schemas/SPMarketplaceBudgetAllocation"},"offAmazonBudgetControlStrategy":{"$ref":"#/components/schemas/SPOffAmazonBudgetControlStrategy"}},"type":"object"},"SPBudgetType":{"enum":["MONETARY"],"type":"string"},"SPBudgetValue":{"oneOf":[{"properties":{"monetaryBudgetValue":{"$ref":"#/components/schemas/SPMonetaryBudgetValue"}},"required":["monetaryBudgetValue"],"title":"monetaryBudgetValue","type":"object"}]},"SPCampaign":{"properties":{"adProduct":{"$ref":"#/components/schemas/SPAdProduct"},"autoCreationSettings":{"$ref":"#/components/schemas/SPAutoCreationSettings"},"autoScaleGlobalCampaign":{"$ref":"#/components/schemas/SPAutoScaleGlobalCampaignSetting"},"budgets":{"description":"The object containing budget details for the campaign (for campaigns that support multiple budgets).","items":{"$ref":"#/components/schemas/SPBudget"},"maxItems":1,"minItems":1,"type":"array"},"campaignId":{"description":"A unique identifier for a campaign.","type":"string"},"countries":{"description":"This field is used in Sponsored Ads and ADSP and impacts targeted supply. For Sponsored Ads, the campaign.countries field determines what Amazon retail supply (Amazon.com, Amazon.co.uk, Amazon.mx, etc) the campaign will serve in. Similarly in ADSP, this has an implicit filter on your inventory targets. If you choose an inventory target of AMAZON with campaign.countries set to US, this will target the retail supply of Amazon.com and non-retail Amazon properties. ADSP options include additional countries - for example, choosing Austria means targeting Austria eligible inventory and Amazon retail supply of Amazon.de.","items":{"$ref":"#/components/schemas/SPCountryCode"},"maxItems":1,"minItems":0,"type":"array"},"creationDateTime":{"description":"The date time that the campaign was created.","format":"date-time","type":"string"},"endDateTime":{"description":"The end date time for the campaign.","format":"date-time","type":"string"},"globalCampaignId":{"description":"The global campaign identifier that manages this marketplace campaign.","type":"string"},"lastUpdatedDateTime":{"description":"The date time that the campaign was last updated.","format":"date-time","type":"string"},"marketplaceScope":{"$ref":"#/components/schemas/SPMarketplaceScope"},"marketplaces":{"description":"This represents retail domains such as Amazon.com, Amazon.co.uk, and Amazon.mx, each corresponding to a country where an Amazon customer can shop. ADSP campaigns can be created by specifying either countries or marketplaces, but at least one of these attributes must be provided. In ADSP, this field acts as an implicit filter on your inventory targets. For example, if you choose an inventory target of AMAZON with campaign.countries set to US, this will target the retail supply of Amazon.com and non-retail Amazon properties.","items":{"$ref":"#/components/schemas/SPMarketplace"},"maxItems":1,"minItems":0,"type":"array"},"name":{"description":"The name of the campaign.","type":"string"},"optimizations":{"$ref":"#/components/schemas/SPCampaignOptimizations"},"portfolioId":{"description":"The ID of the portfolio associated with the campaign.","type":"string"},"retailerScope":{"$ref":"#/components/schemas/SPRetailerScope"},"siteRestrictions":{"description":"Restrict the ad to a particular site","items":{"$ref":"#/components/schemas/SPSiteRestriction"},"maxItems":1,"minItems":0,"type":"array"},"startDateTime":{"description":"The start date time for the campaign.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/SPState"},"status":{"$ref":"#/components/schemas/SPStatus"},"tags":{"description":"Open ended labels with a key value pair applied to the campaign","items":{"$ref":"#/components/schemas/SPTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adProduct","autoCreationSettings","budgets","campaignId","creationDateTime","lastUpdatedDateTime","marketplaceScope","name","startDateTime","state"],"type":"object"},"SPCampaignAdProductFilter":{"properties":{"include":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `SPONSORED_PRODUCTS` | Sponsored Products ad product. |","items":{"$ref":"#/components/schemas/SPAdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPCampaignCampaignIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPCampaignCreate":{"properties":{"adProduct":{"$ref":"#/components/schemas/SPAdProduct"},"autoCreationSettings":{"$ref":"#/components/schemas/SPCreateAutoCreationSettings"},"budgets":{"description":"The object containing budget details for the campaign (for campaigns that support multiple budgets).","items":{"$ref":"#/components/schemas/SPCreateBudget"},"maxItems":1,"minItems":1,"type":"array"},"countries":{"description":"This field is used in Sponsored Ads and ADSP and impacts targeted supply. For Sponsored Ads, the campaign.countries field determines what Amazon retail supply (Amazon.com, Amazon.co.uk, Amazon.mx, etc) the campaign will serve in. Similarly in ADSP, this has an implicit filter on your inventory targets. If you choose an inventory target of AMAZON with campaign.countries set to US, this will target the retail supply of Amazon.com and non-retail Amazon properties. ADSP options include additional countries - for example, choosing Austria means targeting Austria eligible inventory and Amazon retail supply of Amazon.de.","items":{"$ref":"#/components/schemas/SPCountryCode"},"maxItems":1,"minItems":0,"type":"array"},"endDateTime":{"description":"The end date time for the campaign.","format":"date-time","type":"string"},"marketplaceScope":{"$ref":"#/components/schemas/SPMarketplaceScope"},"marketplaces":{"description":"This represents retail domains such as Amazon.com, Amazon.co.uk, and Amazon.mx, each corresponding to a country where an Amazon customer can shop. ADSP campaigns can be created by specifying either countries or marketplaces, but at least one of these attributes must be provided. In ADSP, this field acts as an implicit filter on your inventory targets. For example, if you choose an inventory target of AMAZON with campaign.countries set to US, this will target the retail supply of Amazon.com and non-retail Amazon properties.","items":{"$ref":"#/components/schemas/SPMarketplace"},"maxItems":1,"minItems":0,"type":"array"},"name":{"description":"The name of the campaign.","type":"string"},"optimizations":{"$ref":"#/components/schemas/SPCreateCampaignOptimizations"},"portfolioId":{"description":"The ID of the portfolio associated with the campaign.","type":"string"},"retailerScope":{"$ref":"#/components/schemas/SPRetailerScope"},"siteRestrictions":{"description":"Restrict the ad to a particular site","items":{"$ref":"#/components/schemas/SPSiteRestriction"},"maxItems":1,"minItems":0,"type":"array"},"startDateTime":{"description":"The start date time for the campaign.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/SPCreateState"},"tags":{"description":"Open ended labels with a key value pair applied to the campaign","items":{"$ref":"#/components/schemas/SPCreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adProduct","autoCreationSettings","budgets","marketplaceScope","name","startDateTime","state"],"type":"object"},"SPCampaignMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SPCampaignMultiStatusSuccess"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SPCampaignMultiStatusSuccess":{"properties":{"campaign":{"$ref":"#/components/schemas/SPCampaign"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"}},"required":["campaign","index"],"type":"object"},"SPCampaignNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/SPCampaignNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"SPCampaignNameFilterType":{"description":"**CampaignNameFilterType Enum:**\n| CampaignNameFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"SPCampaignOptimizations":{"properties":{"bidSettings":{"$ref":"#/components/schemas/SPBidSettings"},"budgetSettings":{"$ref":"#/components/schemas/SPBudgetSettings"}},"type":"object"},"SPCampaignPortfolioIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPCampaignRetailerScopeFilter":{"properties":{"include":{"description":"**RetailerScope Enum:**\n| RetailerScope | Description |\n| --- | --- |\n| `AMAZON` | Ads served on Amazon-owned retail properties. |\n| `OTHER_RETAILERS` | Ads served on external retailer partner properties. |","items":{"$ref":"#/components/schemas/SPRetailerScope"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPCampaignStateFilter":{"properties":{"include":{"description":"**State Enum:**\n| State | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |","items":{"$ref":"#/components/schemas/SPState"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPCampaignSuccessResponse":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/SPCampaign"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"SPCampaignUpdate":{"properties":{"budgets":{"description":"The object containing budget details for the campaign (for campaigns that support multiple budgets).","items":{"$ref":"#/components/schemas/SPCreateBudget"},"maxItems":1,"minItems":1,"type":"array"},"campaignId":{"description":"A unique identifier for a campaign.","type":"string"},"endDateTime":{"description":"The end date time for the campaign.","format":"date-time","nullable":true,"type":"string"},"name":{"description":"The name of the campaign.","type":"string"},"optimizations":{"$ref":"#/components/schemas/SPUpdateCampaignOptimizations"},"portfolioId":{"description":"The ID of the portfolio associated with the campaign.","nullable":true,"type":"string"},"siteRestrictions":{"description":"Restrict the ad to a particular site","items":{"$ref":"#/components/schemas/SPSiteRestriction"},"maxItems":1,"minItems":0,"type":"array"},"startDateTime":{"description":"The start date time for the campaign.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/SPUpdateState"},"tags":{"description":"Open ended labels with a key value pair applied to the campaign","items":{"$ref":"#/components/schemas/SPCreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["campaignId"],"type":"object"},"SPCountryCode":{"enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"],"type":"string"},"SPCreateAudienceBidAdjustment":{"properties":{"audienceId":{"description":"The unique identifier of the Audience to apply bid adjustment.","type":"string"},"percentage":{"description":"The selection of the percentage change associated with a given audience and bid adjustment settings. Null removes audience","format":"int32","nullable":true,"type":"integer"}},"required":["audienceId"],"type":"object"},"SPCreateAutoCreationSettings":{"properties":{"autoCreateTargets":{"description":"Gives Amazon permission to automatically create targets associated with the campaign based on the products being advertised.","type":"boolean"},"autoManageCampaign":{"description":"Flag that allows Amazon to manage the lifecycle of your Campaign.","type":"boolean"}},"required":["autoCreateTargets"],"type":"object"},"SPCreateBidAdjustments":{"properties":{"audienceBidAdjustments":{"description":"Bid Adjustments based on the audiences","items":{"$ref":"#/components/schemas/SPCreateAudienceBidAdjustment"},"maxItems":10,"minItems":0,"type":"array"},"creativeBidAdjustments":{"description":"Bid Adjustments based on ads being shown as a creative. Range of bid adjustment value would be 0:900","items":{"$ref":"#/components/schemas/SPCreateCreativeBidAdjustment"},"maxItems":2,"minItems":0,"type":"array"},"placementBidAdjustments":{"description":"Bid adjustments based on ad placements. Not supported for Sponsored Brands campaigns using the SALES_UP_AND_DOWN bid strategy.","items":{"$ref":"#/components/schemas/SPCreatePlacementBidAdjustment"},"maxItems":5,"minItems":0,"type":"array"}},"type":"object"},"SPCreateBidSettings":{"properties":{"bidAdjustments":{"$ref":"#/components/schemas/SPCreateBidAdjustments"},"bidStrategy":{"$ref":"#/components/schemas/SPBidStrategy"}},"type":"object"},"SPCreateBudget":{"properties":{"budgetType":{"$ref":"#/components/schemas/SPBudgetType"},"budgetValue":{"$ref":"#/components/schemas/SPCreateBudgetValue"},"recurrenceTimePeriod":{"$ref":"#/components/schemas/SPRecurrence"}},"required":["budgetType","budgetValue","recurrenceTimePeriod"],"type":"object"},"SPCreateBudgetSettings":{"properties":{"offAmazonBudgetControlStrategy":{"$ref":"#/components/schemas/SPOffAmazonBudgetControlStrategy"}},"type":"object"},"SPCreateBudgetValue":{"oneOf":[{"properties":{"monetaryBudgetValue":{"$ref":"#/components/schemas/SPCreateMonetaryBudgetValue"}},"required":["monetaryBudgetValue"],"title":"monetaryBudgetValue","type":"object"}]},"SPCreateCampaignOptimizations":{"properties":{"bidSettings":{"$ref":"#/components/schemas/SPCreateBidSettings"},"budgetSettings":{"$ref":"#/components/schemas/SPCreateBudgetSettings"}},"type":"object"},"SPCreateCampaignRequest":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/SPCampaignCreate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["campaigns"],"type":"object"},"SPCreateCreativeBidAdjustment":{"properties":{"creativeType":{"$ref":"#/components/schemas/SPCreativeBidAdjustmentType"},"percentage":{"description":"The selection of the percentage change associated with the creative type and bid adjustment settings.","format":"int32","type":"integer"}},"required":["percentage"],"type":"object"},"SPCreateMonetaryBudget":{"properties":{"value":{"description":"The monetary amount of the budget cap in the given currency.","format":"double","type":"number"}},"required":["value"],"type":"object"},"SPCreateMonetaryBudgetValue":{"properties":{"monetaryBudget":{"$ref":"#/components/schemas/SPCreateMonetaryBudget"}},"required":["monetaryBudget"],"type":"object"},"SPCreatePlacementBidAdjustment":{"properties":{"percentage":{"description":"The selection of the percentage change associated with a given placement and bid adjustment settings.","format":"int32","type":"integer"},"placement":{"$ref":"#/components/schemas/SPPlacement"}},"required":["percentage","placement"],"type":"object"},"SPCreateState":{"description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n**CreateState Enum:**\n| CreateState | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |","enum":["ENABLED","PAUSED"],"type":"string"},"SPCreateTag":{"properties":{"key":{"description":"A custom key value pair entered by the advertiser. For ADSP Campaigns and Ad Groups, Amazon creates a COMMENTS key when the Comments field is populated in UI.","type":"string"},"value":{"description":"A custom key value pair entered by the advertiser.","type":"string"}},"required":["key","value"],"type":"object"},"SPCreativeBidAdjustment":{"properties":{"creativeType":{"$ref":"#/components/schemas/SPCreativeBidAdjustmentType"},"percentage":{"description":"The selection of the percentage change associated with the creative type and bid adjustment settings.","format":"int32","type":"integer"}},"required":["percentage"],"type":"object"},"SPCreativeBidAdjustmentType":{"description":"**CreativeBidAdjustmentType Enum:**\n\n| CreativeBidAdjustmentType | Description |\n|------|------|\n| `SPOTLIGHT` | SPOTLIGHT Video Asset. |\n","enum":["SPOTLIGHT"],"type":"string"},"SPCurrencyCode":{"description":"**CurrencyCode Enum:**\n\n| CurrencyCode | Description |\n|------|------|\n| `AED` | United Arab Emirates Dirham |\n| `AUD` | Australian Dollar |\n| `BRL` | Brazilian Real |\n| `CAD` | Canadian Dollar |\n| `CHF` | Swiss Franc |\n| `CNY` | Chinese Yuan |\n| `DKK` | Danish Krone |\n| `EGP` | Egyptian Pound |\n| `EUR` | Euro |\n| `GBP` | British Pound Sterling |\n| `INR` | Indian Rupee |\n| `JPY` | Japanese Yen |\n| `MXN` | Mexican Peso |\n| `MXP` | Mexican Peso |\n| `NGN` | Nigerian Naira |\n| `NOK` | Norwegian Krone |\n| `NZD` | New Zealand Dollar |\n| `PLN` | Polish Złoty |\n| `SAR` | Saudi Riyal |\n| `SEK` | Swedish Krona |\n| `SGD` | Singapore Dollar |\n| `TRY` | Turkish Lira |\n| `USD` | United States Dollar |\n| `ZAR` | South African Rand |\n","enum":["AED","AUD","BRL","CAD","CHF","CNY","DKK","EGP","EUR","GBP","INR","JPY","MXN","MXP","NGN","NOK","NZD","PLN","SAR","SEK","SGD","TRY","USD","ZAR"],"type":"string"},"SPDeleteCampaignRequest":{"properties":{"campaignIds":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["campaignIds"],"type":"object"},"SPDeliveryReason":{"description":"**DeliveryReason Enum:**\n\n| DeliveryReason | Description |\n|------|------|\n| `ADVERTISER_ARCHIVED` |  |\n| `ADVERTISER_OUT_OF_BUDGET` | Indicates that an advertiser is out of budget for Sponsored Products campaigns for sellers. |\n| `ADVERTISER_OUT_OF_POSTPAY_CREDIT_LIMIT` | Indicates that a postpay advertiser is out of credit limit for all Sponsored Ads campaigns. |\n| `ADVERTISER_OUT_OF_POSTPAY_MONTHLY_BUDGET` | Indicates that a postpay advertiser is out of monthly budget for all Sponsored Ads campaigns. |\n| `ADVERTISER_OUT_OF_PREPAY_BALANCE` | Indicates that a prepay advertiser is out of prepay balance for all Sponsored Ads campaigns. |\n| `ADVERTISER_PAUSED` |  |\n| `ADVERTISER_PAYMENT_FAILURE` |  |\n| `ADVERTISER_POLICING_PENDING_REVIEW` |  |\n| `ADVERTISER_POLICING_SUSPENDED` |  |\n| `AD_ARCHIVED` |  |\n| `AD_CREATION_FAILED` |  |\n| `AD_CREATION_IN_PROGRESS` |  |\n| `AD_EXTENSION_ARCHIVED` |  |\n| `AD_EXTENSION_PAUSED` |  |\n| `AD_EXTENSION_POLICING_PENDING_REVIEW` |  |\n| `AD_EXTENSION_POLICING_SUSPENDED` |  |\n| `AD_GROUP_ARCHIVED` |  |\n| `AD_GROUP_INCOMPLETE` |  |\n| `AD_GROUP_LOW_BID` |  |\n| `AD_GROUP_PAUSED` |  |\n| `AD_GROUP_PENDING_REVIEW` |  |\n| `AD_GROUP_POLICING_PENDING_REVIEW` |  |\n| `AD_GROUP_REJECTED` |  |\n| `AD_INELIGIBLE` |  |\n| `AD_MISSING_DECORATION` |  |\n| `AD_MISSING_IMAGE` |  |\n| `AD_NOT_DELIVERING` |  |\n| `AD_PAUSED` |  |\n| `AD_POLICING_PENDING_REVIEW` |  |\n| `AD_POLICING_SUSPENDED` |  |\n| `BRAND_INELIGIBLE` |  |\n| `CAMPAIGN_ARCHIVED` |  |\n| `CAMPAIGN_END_DATE_REACHED` |  |\n| `CAMPAIGN_INCOMPLETE` |  |\n| `CAMPAIGN_OUT_OF_BUDGET` |  |\n| `CAMPAIGN_PAUSED` |  |\n| `CAMPAIGN_PENDING_REVIEW` |  |\n| `CAMPAIGN_PENDING_START_DATE` |  |\n| `CAMPAIGN_REJECTED` |  |\n| `CREATIVE_MISSING_ASSET` |  |\n| `CREATIVE_PENDING_REVIEW` |  |\n| `CREATIVE_REJECTED` |  |\n| `LANDING_PAGE_INELIGIBLE` |  |\n| `LANDING_PAGE_NOT_AVAILABLE` |  |\n| `MODERATION_ADULT_NOVELTY_POLICY_VIOLATION` |  |\n| `MODERATION_ADULT_PRODUCT_POLICY_VIOLATION` |  |\n| `MODERATION_ADULT_SOFTLINES_POLICY_VIOLATION` |  |\n| `MODERATION_CLAIM_WEIGHTLOSS_POLICY_VIOLATION` |  |\n| `MODERATION_CONTENT_NUDITY_POLICY_VIOLATION` |  |\n| `MODERATION_CONTENT_PROVOCATIVE_POLICY_VIOLATION` |  |\n| `MODERATION_CONTENT_SMOKING_POLICY_VIOLATION` |  |\n| `MODERATION_CRITICAL_EVENTS_POLICY_VIOLATION` |  |\n| `MODERATION_ERROR_404` |  |\n| `MODERATION_GRAPHICAL_SEXUAL_IMAGES_POLICY_VIOLATION` |  |\n| `MODERATION_HFSS_PRODUCT_POLICY_VIOLATION` |  |\n| `MODERATION_LANGUAGE_OFFENSIVE_POLICY_VIOLATION` |  |\n| `MODERATION_NOT_COMPLIANT_TO_AD_POLICY` |  |\n| `MODERATION_SMOKING_RELATED_POLICY_VIOLATION` |  |\n| `NOT_BUYABLE` |  |\n| `NOT_IN_BUYBOX` |  |\n| `NOT_IN_POLICY` |  |\n| `NO_INVENTORY` |  |\n| `NO_PURCHASABLE_OFFER` |  |\n| `OTHER` |  |\n| `OUT_OF_REWARD_BUDGET` |  |\n| `OUT_OF_STOCK` |  |\n| `PIR_RULE_EXCLUDED` |  |\n| `PORTFOLIO_ARCHIVED` |  |\n| `PORTFOLIO_END_DATE_REACHED` |  |\n| `PORTFOLIO_OUT_OF_BUDGET` |  |\n| `PORTFOLIO_PAUSED` |  |\n| `PORTFOLIO_PENDING_START_DATE` |  |\n| `SECURITY_SCAN_PENDING_REVIEW` |  |\n| `SECURITY_SCAN_REJECTED` |  |\n| `SPEND_LIMIT_EXCEEDED` |  |\n| `STATUS_UNAVAILABLE` |  |\n| `TARGET_ARCHIVED` |  |\n| `TARGET_BLOCKED` |  |\n| `TARGET_PAUSED` |  |\n| `TARGET_POLICING_SUSPENDED` |  |\n","enum":["ADVERTISER_ARCHIVED","ADVERTISER_OUT_OF_BUDGET","ADVERTISER_OUT_OF_POSTPAY_CREDIT_LIMIT","ADVERTISER_OUT_OF_POSTPAY_MONTHLY_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_PAUSED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","AD_ARCHIVED","AD_CREATION_FAILED","AD_CREATION_IN_PROGRESS","AD_EXTENSION_ARCHIVED","AD_EXTENSION_PAUSED","AD_EXTENSION_POLICING_PENDING_REVIEW","AD_EXTENSION_POLICING_SUSPENDED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","AD_GROUP_PAUSED","AD_GROUP_PENDING_REVIEW","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_REJECTED","AD_INELIGIBLE","AD_MISSING_DECORATION","AD_MISSING_IMAGE","AD_NOT_DELIVERING","AD_PAUSED","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","BRAND_INELIGIBLE","CAMPAIGN_ARCHIVED","CAMPAIGN_END_DATE_REACHED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","CAMPAIGN_PAUSED","CAMPAIGN_PENDING_REVIEW","CAMPAIGN_PENDING_START_DATE","CAMPAIGN_REJECTED","CREATIVE_MISSING_ASSET","CREATIVE_PENDING_REVIEW","CREATIVE_REJECTED","LANDING_PAGE_INELIGIBLE","LANDING_PAGE_NOT_AVAILABLE","MODERATION_ADULT_NOVELTY_POLICY_VIOLATION","MODERATION_ADULT_PRODUCT_POLICY_VIOLATION","MODERATION_ADULT_SOFTLINES_POLICY_VIOLATION","MODERATION_CLAIM_WEIGHTLOSS_POLICY_VIOLATION","MODERATION_CONTENT_NUDITY_POLICY_VIOLATION","MODERATION_CONTENT_PROVOCATIVE_POLICY_VIOLATION","MODERATION_CONTENT_SMOKING_POLICY_VIOLATION","MODERATION_CRITICAL_EVENTS_POLICY_VIOLATION","MODERATION_ERROR_404","MODERATION_GRAPHICAL_SEXUAL_IMAGES_POLICY_VIOLATION","MODERATION_HFSS_PRODUCT_POLICY_VIOLATION","MODERATION_LANGUAGE_OFFENSIVE_POLICY_VIOLATION","MODERATION_NOT_COMPLIANT_TO_AD_POLICY","MODERATION_SMOKING_RELATED_POLICY_VIOLATION","NOT_BUYABLE","NOT_IN_BUYBOX","NOT_IN_POLICY","NO_INVENTORY","NO_PURCHASABLE_OFFER","OTHER","OUT_OF_REWARD_BUDGET","OUT_OF_STOCK","PIR_RULE_EXCLUDED","PORTFOLIO_ARCHIVED","PORTFOLIO_END_DATE_REACHED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PAUSED","PORTFOLIO_PENDING_START_DATE","SECURITY_SCAN_PENDING_REVIEW","SECURITY_SCAN_REJECTED","SPEND_LIMIT_EXCEEDED","STATUS_UNAVAILABLE","TARGET_ARCHIVED","TARGET_BLOCKED","TARGET_PAUSED","TARGET_POLICING_SUSPENDED"],"type":"string"},"SPDeliveryStatus":{"description":"**DeliveryStatus Enum:**\n\n| DeliveryStatus | Description |\n|------|------|\n| `DELIVERING` | Represents the resource is delivering. For global, DELIVERING status indicates that the resource is delivering in all marketplaces |\n| `NOT_DELIVERING` | Represents the resource is not delivering. For global, NOT_DELIVERING status indicates that the resource is NOT delivering in all marketplaces |\n| `UNAVAILABLE` | Represents unavailable resource status. For global, UNAVAILABLE status indicates that the status is unavailable in all marketplaces |\n","enum":["DELIVERING","NOT_DELIVERING","UNAVAILABLE"],"type":"string"},"SPMarketplace":{"description":"A list of country codes representing Amazon marketplaces\n\n\n\n\n\n","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"],"type":"string"},"SPMarketplaceBudgetAllocation":{"description":"**MarketplaceBudgetAllocation Enum:**\n\n| MarketplaceBudgetAllocation | Description |\n|------|------|\n| `AUTO` | Auto distribute global budget to marketplaces in global campaign |\n| `MANUAL` | Manually distribute global budget to marketplaces in global campaign |\n","enum":["AUTO","MANUAL"],"type":"string"},"SPMarketplaceScope":{"enum":["SINGLE_MARKETPLACE"],"type":"string"},"SPMonetaryBudget":{"properties":{"currencyCode":{"$ref":"#/components/schemas/SPCurrencyCode"},"ruleValue":{"description":"The monetary amount of the budget when a budget rule is applied.","format":"double","type":"number"},"value":{"description":"The monetary amount of the budget cap in the given currency.","format":"double","type":"number"}},"required":["currencyCode","value"],"type":"object"},"SPMonetaryBudgetValue":{"properties":{"monetaryBudget":{"$ref":"#/components/schemas/SPMonetaryBudget"}},"required":["monetaryBudget"],"type":"object"},"SPOffAmazonBudgetControlStrategy":{"description":"**OffAmazonBudgetControlStrategy Enum:**\n\n| OffAmazonBudgetControlStrategy | Description |\n|------|------|\n| `MAXIMIZE_REACH` | Maximize the reach of off-Amazon inventory within the budget. |\n| `MINIMIZE_SPEND` | Minimize spend on off-Amazon inventory while maintaining delivery. |\n","enum":["MAXIMIZE_REACH","MINIMIZE_SPEND"],"type":"string"},"SPPlacement":{"description":"**Placement Enum:**\n\n| Placement | Description |\n|------|------|\n| `PRODUCT_PAGE` | Placements on the product detail page, and all nonsearch placements such as the add-to-cart page. |\n| `REST_OF_BROWSE` | Placements on the middle or the bottom of the first-page browse results. Only applicable for OTHER_RETAILERS retailer scope. |\n| `REST_OF_SEARCH` | Placements on the middle or the bottom of the first-page search results. Also refers to ads on the second page of search results and beyond. |\n| `SITE_AMAZON_BUSINESS` | Amazon Business site placements. |\n| `TOP_OF_BROWSE` | Placements on the top row of the first-page browse results. Only applicable for OTHER_RETAILERS retailer scope. |\n| `TOP_OF_SEARCH` | Placements on the top row of the first-page search results. |\n","enum":["PRODUCT_PAGE","REST_OF_BROWSE","REST_OF_SEARCH","SITE_AMAZON_BUSINESS","TOP_OF_BROWSE","TOP_OF_SEARCH"],"type":"string"},"SPPlacementBidAdjustment":{"properties":{"percentage":{"description":"The selection of the percentage change associated with a given placement and bid adjustment settings.","format":"int32","type":"integer"},"placement":{"$ref":"#/components/schemas/SPPlacement"}},"required":["percentage","placement"],"type":"object"},"SPQueryCampaignRequest":{"properties":{"adProductFilter":{"$ref":"#/components/schemas/SPCampaignAdProductFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/SPCampaignCampaignIdFilter"},"maxResults":{"default":1000,"format":"int32","maximum":1000,"minimum":1,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/SPCampaignNameFilter"},"nextToken":{"type":"string"},"portfolioIdFilter":{"$ref":"#/components/schemas/SPCampaignPortfolioIdFilter"},"retailerScopeFilter":{"$ref":"#/components/schemas/SPCampaignRetailerScopeFilter"},"stateFilter":{"$ref":"#/components/schemas/SPCampaignStateFilter"}},"required":["adProductFilter"],"type":"object"},"SPRecurrence":{"enum":["DAILY"],"type":"string"},"SPRetailerScope":{"description":"**RetailerScope Enum:**\n\n| RetailerScope | Description |\n|------|------|\n| `AMAZON` | Ads served on Amazon-owned retail properties. |\n| `OTHER_RETAILERS` | Ads served on external retailer partner properties. |\n","enum":["AMAZON","OTHER_RETAILERS"],"type":"string"},"SPSiteRestriction":{"description":"**SiteRestriction Enum:**\n\n| SiteRestriction | Description |\n|------|------|\n| `AMAZON_BUSINESS` | Restrict the ad to only show on Amazon Business. |\n| `AMAZON_HAUL` | Restrict the ad to only show on Amazon Haul. |\n","enum":["AMAZON_BUSINESS","AMAZON_HAUL"],"type":"string"},"SPState":{"description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n**State Enum:**\n\n| State | Description |\n|------|------|\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n","enum":["ARCHIVED","ENABLED","PAUSED"],"type":"string"},"SPStatus":{"properties":{"deliveryReasons":{"description":"This is the list of reasons behind the delivery status.","items":{"$ref":"#/components/schemas/SPDeliveryReason"},"maxItems":50,"minItems":0,"type":"array"},"deliveryStatus":{"$ref":"#/components/schemas/SPDeliveryStatus"}},"required":["deliveryStatus"],"type":"object"},"SPTag":{"properties":{"key":{"description":"A custom key value pair entered by the advertiser. For ADSP Campaigns and Ad Groups, Amazon creates a COMMENTS key when the Comments field is populated in UI.","type":"string"},"value":{"description":"A custom key value pair entered by the advertiser.","type":"string"}},"required":["key","value"],"type":"object"},"SPUpdateBidAdjustments":{"properties":{"audienceBidAdjustments":{"description":"Bid Adjustments based on the audiences","items":{"$ref":"#/components/schemas/SPCreateAudienceBidAdjustment"},"maxItems":10,"minItems":0,"type":"array"},"creativeBidAdjustments":{"description":"Bid Adjustments based on ads being shown as a creative. Range of bid adjustment value would be 0:900","items":{"$ref":"#/components/schemas/SPCreateCreativeBidAdjustment"},"maxItems":2,"minItems":0,"type":"array"},"placementBidAdjustments":{"description":"Bid adjustments based on ad placements. Not supported for Sponsored Brands campaigns using the SALES_UP_AND_DOWN bid strategy.","items":{"$ref":"#/components/schemas/SPCreatePlacementBidAdjustment"},"maxItems":5,"minItems":0,"type":"array"}},"type":"object"},"SPUpdateBidSettings":{"properties":{"bidAdjustments":{"$ref":"#/components/schemas/SPUpdateBidAdjustments"},"bidStrategy":{"$ref":"#/components/schemas/SPBidStrategy"}},"type":"object"},"SPUpdateBudgetSettings":{"properties":{"offAmazonBudgetControlStrategy":{"$ref":"#/components/schemas/SPOffAmazonBudgetControlStrategy"}},"type":"object"},"SPUpdateCampaignOptimizations":{"properties":{"bidSettings":{"$ref":"#/components/schemas/SPUpdateBidSettings"},"budgetSettings":{"$ref":"#/components/schemas/SPUpdateBudgetSettings"}},"type":"object"},"SPUpdateCampaignRequest":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/SPCampaignUpdate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["campaigns"],"type":"object"},"SPUpdateState":{"description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n**UpdateState Enum:**\n| UpdateState | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |","enum":["ENABLED","PAUSED"],"type":"string"},"ServiceUnavailableErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"TooManyRequestsResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"UnauthorizedResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"}},"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://www.amazon.com/ap/oa","scopes":{"advertising::audiences":"Grants access to data provider APIs","advertising::campaign_management":"Grants write access to campaign management.","advertising::test:create_account":"Grants write access to create test accounts functionality","cpc_advertising:campaign_management":"Grants write access to campaign management. Legacy name (no difference from advertising::campaign_management)"},"tokenUrl":"https://api.amazon.com/auth/o2/token"}},"type":"oauth2"}}},"info":{"description":"Amazon Ads API v1 is a reimagined approach to our Ads API, built to provide a seamless experience across all Amazon advertising products through a common model. [Learn more about Ads API v1.](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/overview) To learn about prerequisites and header values, see [Getting started with Amazon Ads API v1](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/getting-started).\n\n**Download Amazon Ads API V1 OpenAPI Spec** ([All Products](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIALLMerged_prod_3p.json) | [SP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPMerged_prod_3p.json) | [SP Global](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPGLOBALMerged_prod_3p.json) | [SB](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISBMerged_prod_3p.json) | [DSP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIDSPMerged_prod_3p.json) | [ST](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISTMerged_prod_3p.json) | [SD](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISDMerged_prod_3p.json))","title":"SP Campaigns API","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/create/campaigns":{"post":{"description":"Create campaigns\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"SPCreateCampaign","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPCreateCampaignRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPCampaignMultiStatusResponse"}}},"description":"SPCreateCampaign 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Campaigns"]}},"/adsApi/v1/delete/campaigns":{"post":{"description":"Delete campaigns\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"SPDeleteCampaign","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPDeleteCampaignRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPCampaignMultiStatusResponse"}}},"description":"SPDeleteCampaign 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Campaigns"]}},"/adsApi/v1/query/campaigns":{"post":{"description":"Query campaign\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"dsp_campaign_view\", \"campaign_view\", \n\"advertiser_campaign_view\"]","operationId":"SPQueryCampaign","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPQueryCampaignRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPCampaignSuccessResponse"}}},"description":"SPQueryCampaign 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Campaigns"]}},"/adsApi/v1/update/campaigns":{"post":{"description":"Update campaign\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Note:** For Amazon DSP, `state` supports only ENABLED and PAUSED; ARCHIVED is not a valid state for DSP campaigns.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"SPUpdateCampaign","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPUpdateCampaignRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPCampaignMultiStatusResponse"}}},"description":"SPUpdateCampaign 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Campaigns"]}}},"servers":[{"description":"Production server for NA","url":"https://advertising-api.amazon.com"},{"description":"Production server for EU","url":"https://advertising-api-eu.amazon.com"},{"description":"Production server for FE","url":"https://advertising-api-fe.amazon.com"}]}