{"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"},"SPAd":{"properties":{"adGroupId":{"description":"The ad group associated with the ad.","type":"string"},"adId":{"description":"The identifier of the ad.","type":"string"},"adProduct":{"$ref":"#/components/schemas/SPAdProduct"},"adType":{"$ref":"#/components/schemas/SPAdType"},"campaignId":{"description":"The campaign associated with the ad. It\u0027s a read-only field.","type":"string"},"creationDateTime":{"description":"The date time that the ad was created.","format":"date-time","type":"string"},"creative":{"$ref":"#/components/schemas/SPCreative"},"globalAdId":{"description":"The global ad identifier that manages this marketplace ad.","type":"string"},"lastUpdatedDateTime":{"description":"The date time that the ad was last updated.","format":"date-time","type":"string"},"marketplaceScope":{"$ref":"#/components/schemas/SPMarketplaceScope"},"marketplaces":{"description":"The list of country codes representing amazon marketplaces in which the global ad is applicable. For Sponsored Ads, the marketplaces included should either be same as or subset of parent ad group. For ADSP, 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. The field represents the Amazon marketplaces for the advertised product included in the creative settings.","items":{"$ref":"#/components/schemas/SPMarketplace"},"maxItems":1,"minItems":1,"type":"array"},"state":{"$ref":"#/components/schemas/SPState"},"status":{"$ref":"#/components/schemas/SPStatus"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/SPTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adGroupId","adId","adProduct","adType","campaignId","creationDateTime","creative","lastUpdatedDateTime","marketplaceScope","marketplaces","state"],"type":"object"},"SPAdAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPAdAdIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPAdAdProductFilter":{"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"},"SPAdCampaignIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPAdCreate":{"properties":{"adGroupId":{"description":"The ad group associated with the ad.","type":"string"},"adProduct":{"$ref":"#/components/schemas/SPAdProduct"},"adType":{"$ref":"#/components/schemas/SPAdType"},"creative":{"$ref":"#/components/schemas/SPCreateCreative"},"state":{"$ref":"#/components/schemas/SPCreateState"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/SPCreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adGroupId","adProduct","adType","creative","state"],"type":"object"},"SPAdExtension":{"properties":{"adExtensionId":{"description":"A unique identifier for the ad_extension.","type":"string"},"adExtensionSettings":{"$ref":"#/components/schemas/SPAdExtensionSettings"},"adExtensionStatus":{"$ref":"#/components/schemas/SPAdExtensionStatus"},"adExtensionType":{"$ref":"#/components/schemas/SPAdExtensionType"},"adGroupId":{"description":"A unique identifier for the ad group associated with the ad_extension.","type":"string"},"adId":{"description":"A unique identifier for the ad associated with the ad_extension.","type":"string"},"adProduct":{"$ref":"#/components/schemas/SPAdProduct"},"creationDateTime":{"description":"The date time the ad_extension was created.","format":"date-time","type":"string"},"lastUpdatedDateTime":{"description":"The date time the ad_extension was last updated.","format":"date-time","type":"string"},"marketplaceScope":{"$ref":"#/components/schemas/SPMarketplaceScope"},"marketplaces":{"description":"The list of marketplace in which the global ad_extension is applicable. The marketplaces included should either be same as or subset of parent campaign/adGroup/ad","items":{"$ref":"#/components/schemas/SPMarketplace"},"maxItems":1,"minItems":1,"type":"array"},"state":{"$ref":"#/components/schemas/SPState"},"status":{"$ref":"#/components/schemas/SPStatus"}},"required":["adExtensionId","adExtensionSettings","adExtensionType","adProduct","creationDateTime","lastUpdatedDateTime","marketplaceScope","marketplaces","state"],"type":"object"},"SPAdExtensionAdExtensionIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPAdExtensionAdExtensionStatusFilter":{"properties":{"include":{"description":"**AdExtensionStatus Enum:**\n| AdExtensionStatus | Description |\n| --- | --- |\n| `OPTED_OUT` | If the advertiser has opted out of this Ad Extension. |","items":{"$ref":"#/components/schemas/SPAdExtensionStatus"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPAdExtensionAdExtensionTypeFilter":{"properties":{"include":{"description":"**AdExtensionType Enum:**\n| AdExtensionType | Description |\n| --- | --- |\n| `PROMPTS` | Enables Prompt based Ad Extension. |\n| `VIDEO` | Enables Video based Ad Extension. |","items":{"$ref":"#/components/schemas/SPAdExtensionType"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPAdExtensionAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPAdExtensionAdIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPAdExtensionAdProductFilter":{"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"},"SPAdExtensionCreate":{"properties":{"adExtensionSettings":{"$ref":"#/components/schemas/SPCreateAdExtensionSettings"},"adExtensionStatus":{"$ref":"#/components/schemas/SPAdExtensionStatus"},"adExtensionType":{"$ref":"#/components/schemas/SPAdExtensionType"},"adGroupId":{"description":"A unique identifier for the ad group associated with the ad_extension.","type":"string"},"adId":{"description":"A unique identifier for the ad associated with the ad_extension.","type":"string"},"adProduct":{"$ref":"#/components/schemas/SPAdProduct"},"marketplaceScope":{"$ref":"#/components/schemas/SPMarketplaceScope"},"marketplaces":{"description":"The list of marketplace in which the global ad_extension is applicable. The marketplaces included should either be same as or subset of parent campaign/adGroup/ad","items":{"$ref":"#/components/schemas/SPMarketplace"},"maxItems":1,"minItems":1,"type":"array"},"state":{"$ref":"#/components/schemas/SPCreateState"}},"required":["adExtensionSettings","adExtensionType","adProduct","marketplaceScope","marketplaces","state"],"type":"object"},"SPAdExtensionMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":50,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SPAdExtensionMultiStatusSuccess"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"SPAdExtensionMultiStatusSuccess":{"properties":{"adExtension":{"$ref":"#/components/schemas/SPAdExtension"},"index":{"format":"int32","maximum":49,"minimum":0,"type":"integer"}},"required":["adExtension","index"],"type":"object"},"SPAdExtensionSettings":{"oneOf":[{"properties":{"promptExtension":{"$ref":"#/components/schemas/SPPromptExtension"}},"required":["promptExtension"],"title":"promptExtension","type":"object"},{"properties":{"videoExtension":{"$ref":"#/components/schemas/SPVideoExtension"}},"required":["videoExtension"],"title":"videoExtension","type":"object"}]},"SPAdExtensionStateFilter":{"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"},"SPAdExtensionStatus":{"description":"Ad Extension Status.\n**AdExtensionStatus Enum:**\n\n| AdExtensionStatus | Description |\n|------|------|\n| `OPTED_OUT` | If the advertiser has opted out of this Ad Extension. |\n","enum":["OPTED_OUT"],"type":"string"},"SPAdExtensionSuccessResponse":{"properties":{"adExtensions":{"items":{"$ref":"#/components/schemas/SPAdExtension"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"SPAdExtensionType":{"description":"Ad Extension Type.\n**AdExtensionType Enum:**\n\n| AdExtensionType | Description |\n|------|------|\n| `PROMPTS` | Enables Prompt based Ad Extension. |\n| `VIDEO` | Enables Video based Ad Extension. |\n","enum":["PROMPTS","VIDEO"],"type":"string"},"SPAdExtensionUpdate":{"properties":{"adExtensionId":{"description":"A unique identifier for the ad_extension.","type":"string"},"state":{"$ref":"#/components/schemas/SPUpdateState"}},"required":["adExtensionId"],"type":"object"},"SPAdGroup":{"properties":{"adGroupId":{"description":"The unique identifier of the ad group.","type":"string"},"adProduct":{"$ref":"#/components/schemas/SPAdProduct"},"adSettings":{"$ref":"#/components/schemas/SPAdSettings"},"bid":{"$ref":"#/components/schemas/SPAdGroupBid"},"campaignId":{"description":"The unique identifier of the campaign the ad group belongs to.","type":"string"},"creationDateTime":{"description":"The date time that the ad group was created.","format":"date-time","type":"string"},"globalAdGroupId":{"description":"The global adGroup identifier that manages this marketplace adGroup.","type":"string"},"lastUpdatedDateTime":{"description":"The date time that the ad group was last updated.","format":"date-time","type":"string"},"marketplaceScope":{"$ref":"#/components/schemas/SPMarketplaceScope"},"marketplaces":{"description":"The list of country codes representing amazon marketplaces in which the global ad group is applicable. The marketplaces included should either be same as or subset of parent campaign","items":{"$ref":"#/components/schemas/SPMarketplace"},"maxItems":1,"minItems":1,"type":"array"},"name":{"description":"The name of the ad group.","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 ad group","items":{"$ref":"#/components/schemas/SPTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adGroupId","adProduct","bid","campaignId","creationDateTime","lastUpdatedDateTime","marketplaceScope","marketplaces","name","state"],"type":"object"},"SPAdGroupAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPAdGroupAdProductFilter":{"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"},"SPAdGroupBid":{"properties":{"currencyCode":{"$ref":"#/components/schemas/SPCurrencyCode"},"defaultBid":{"description":"The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction.","format":"double","type":"number"}},"required":["currencyCode","defaultBid"],"type":"object"},"SPAdGroupCampaignIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPAdGroupCreate":{"properties":{"adProduct":{"$ref":"#/components/schemas/SPAdProduct"},"adSettings":{"$ref":"#/components/schemas/SPCreateAdSettings"},"bid":{"$ref":"#/components/schemas/SPCreateAdGroupBid"},"campaignId":{"description":"The unique identifier of the campaign the ad group belongs to.","type":"string"},"name":{"description":"The name of the ad group.","type":"string"},"state":{"$ref":"#/components/schemas/SPCreateState"},"tags":{"description":"Open ended labels with a key value pair applied to the ad group","items":{"$ref":"#/components/schemas/SPCreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adProduct","bid","campaignId","name","state"],"type":"object"},"SPAdGroupMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SPAdGroupMultiStatusSuccess"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SPAdGroupMultiStatusSuccess":{"properties":{"adGroup":{"$ref":"#/components/schemas/SPAdGroup"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"}},"required":["adGroup","index"],"type":"object"},"SPAdGroupNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/SPAdGroupNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"SPAdGroupNameFilterType":{"description":"**AdGroupNameFilterType Enum:**\n| AdGroupNameFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"SPAdGroupStateFilter":{"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"},"SPAdGroupSuccessResponse":{"properties":{"adGroups":{"items":{"$ref":"#/components/schemas/SPAdGroup"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"SPAdGroupUpdate":{"properties":{"adGroupId":{"description":"The unique identifier of the ad group.","type":"string"},"adSettings":{"$ref":"#/components/schemas/SPUpdateAdSettings"},"bid":{"$ref":"#/components/schemas/SPUpdateAdGroupBid"},"name":{"description":"The name of the ad group.","type":"string"},"state":{"$ref":"#/components/schemas/SPUpdateState"},"tags":{"description":"Open ended labels with a key value pair applied to the ad group","items":{"$ref":"#/components/schemas/SPCreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adGroupId"],"type":"object"},"SPAdMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SPAdMultiStatusSuccess"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SPAdMultiStatusSuccess":{"properties":{"ad":{"$ref":"#/components/schemas/SPAd"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"}},"required":["ad","index"],"type":"object"},"SPAdProduct":{"description":"**AdProduct Enum:**\n\n| AdProduct | Description |\n|------|------|\n| `SPONSORED_PRODUCTS` | Sponsored Products ad product. |\n","enum":["SPONSORED_PRODUCTS"],"type":"string"},"SPAdSettings":{"properties":{"productAttributeSetRefinementConfigurationId":{"description":"Identifier for the product attribute configuration set associated with this ad group.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"}},"type":"object"},"SPAdStateFilter":{"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"},"SPAdSuccessResponse":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/SPAd"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"SPAdType":{"description":"**AdType Enum:**\n\n| AdType | Description |\n|------|------|\n| `PRODUCT_AD` | A creative built based on a specified product. |\n","enum":["PRODUCT_AD"],"type":"string"},"SPAdUpdate":{"properties":{"adId":{"description":"The identifier of the ad.","type":"string"},"creative":{"$ref":"#/components/schemas/SPUpdateCreative"},"state":{"$ref":"#/components/schemas/SPUpdateState"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/SPCreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adId"],"type":"object"},"SPAdvertisedProducts":{"properties":{"globalStoreSetting":{"$ref":"#/components/schemas/SPGlobalStoreSettings"},"productId":{"description":"The identifier of the advertised product.","type":"string"},"productIdType":{"$ref":"#/components/schemas/SPProductIdType"},"resolvedProductId":{"description":"The identifier of product associated with the advertised product. It\u0027s a read-only field.","type":"string"},"resolvedProductIdType":{"$ref":"#/components/schemas/SPProductIdType"}},"required":["productId","productIdType"],"type":"object"},"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.","format":"int32","type":"integer"}},"required":["audienceId","percentage"],"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":1,"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":4,"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"},"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"},"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"},"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"},"SPCreateAdExtensionRequest":{"properties":{"adExtensions":{"items":{"$ref":"#/components/schemas/SPAdExtensionCreate"},"maxItems":50,"minItems":1,"type":"array"}},"required":["adExtensions"],"type":"object"},"SPCreateAdExtensionSettings":{"oneOf":[{"properties":{"promptExtension":{"$ref":"#/components/schemas/SPCreatePromptExtension"}},"required":["promptExtension"],"title":"promptExtension","type":"object"},{"properties":{"videoExtension":{"$ref":"#/components/schemas/SPCreateVideoExtension"}},"required":["videoExtension"],"title":"videoExtension","type":"object"}]},"SPCreateAdGroupBid":{"properties":{"defaultBid":{"description":"The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction.","format":"double","type":"number"}},"required":["defaultBid"],"type":"object"},"SPCreateAdGroupRequest":{"properties":{"adGroups":{"items":{"$ref":"#/components/schemas/SPAdGroupCreate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["adGroups"],"type":"object"},"SPCreateAdRequest":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/SPAdCreate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"},"SPCreateAdSettings":{"properties":{"productAttributeSetRefinementConfigurationId":{"description":"Identifier for the product attribute configuration set associated with this ad group.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"}},"type":"object"},"SPCreateAdvertisedProducts":{"properties":{"globalStoreSetting":{"$ref":"#/components/schemas/SPCreateGlobalStoreSettings"},"productId":{"description":"The identifier of the advertised product.","type":"string"},"productIdType":{"$ref":"#/components/schemas/SPProductIdType"}},"required":["productId","productIdType"],"type":"object"},"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.","format":"int32","type":"integer"}},"required":["audienceId","percentage"],"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":1,"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":4,"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"},"SPCreateCreative":{"oneOf":[{"properties":{"productCreative":{"$ref":"#/components/schemas/SPCreateProductCreative"}},"required":["productCreative"],"title":"productCreative","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"},"SPCreateGlobalStoreSettings":{"properties":{"catalogSourceMarketplace":{"$ref":"#/components/schemas/SPMarketplace"}},"type":"object"},"SPCreateKeywordTarget":{"description":"Targets a specific customer search term.","properties":{"keyword":{"description":"The customer search term or text to target. For valid characters and constraints, [see keyword character constraints](https://advertising.amazon.com/API/docs/en-us/reference/concepts/limits#keyword-character-constraints).","type":"string"},"matchType":{"$ref":"#/components/schemas/SPKeywordMatchType"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"nativeLanguageLocale":{"$ref":"#/components/schemas/SPLanguageLocale"}},"required":["keyword","matchType"],"type":"object"},"SPCreateLocationTarget":{"description":"Target based on geographic location.","properties":{"locationId":{"description":"The ID of the geographic location to target.","type":"string"}},"required":["locationId"],"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"},"SPCreateProductCategoryRefinement":{"properties":{"productAgeRangeId":{"description":"The age range ID to target.","type":"string"},"productBrandId":{"description":"The brand ID to target.","type":"string"},"productCategoryId":{"description":"The product category ID to target.","type":"string"},"productGenreId":{"description":"The product genre ID to target.","type":"string"},"productPriceGreaterThan":{"description":"Refinement to target products with a price greater than the value within the product category.","format":"double","type":"number"},"productPriceLessThan":{"description":"Refinement to target products with a price less than the value within the product category.","format":"double","type":"number"},"productPrimeShippingEligible":{"description":"Target based on if a product is Prime-shipping eligible.","type":"boolean"},"productRatingGreaterThan":{"description":"Refinement to target products with a rating greater than the value within the product category.","format":"double","type":"number"},"productRatingLessThan":{"description":"Refinement to target products with a rating less than the value within the product category.","format":"double","type":"number"}},"type":"object"},"SPCreateProductCategoryRefinementValue":{"properties":{"productCategoryRefinement":{"$ref":"#/components/schemas/SPCreateProductCategoryRefinement"}},"required":["productCategoryRefinement"],"type":"object"},"SPCreateProductCategoryTarget":{"description":"Targets a specific customer search term.","properties":{"productCategoryRefinement":{"$ref":"#/components/schemas/SPCreateProductCategoryRefinementValue"}},"required":["productCategoryRefinement"],"type":"object"},"SPCreateProductCreative":{"properties":{"productCreativeSettings":{"$ref":"#/components/schemas/SPCreateProductCreativeSettings"}},"required":["productCreativeSettings"],"type":"object"},"SPCreateProductCreativeSettings":{"description":"An ad with a creative built based on the product being advertised.","properties":{"advertisedProduct":{"$ref":"#/components/schemas/SPCreateAdvertisedProducts"},"headline":{"description":"The headline/custom text associated with the ad creative.","type":"string"},"spotlightVideos":{"$ref":"#/components/schemas/SPCreateSpotlightVideoSettings"}},"required":["advertisedProduct"],"type":"object"},"SPCreateProductTarget":{"description":"Targets a specific product.","properties":{"matchType":{"$ref":"#/components/schemas/SPProductMatchType"},"product":{"$ref":"#/components/schemas/SPCreateProductValue"},"productIdType":{"$ref":"#/components/schemas/SPProductIdType"}},"required":["matchType","product","productIdType"],"type":"object"},"SPCreateProductValue":{"properties":{"productId":{"description":"The product identifier. Either the product id or the marketplace settings should always be specified","type":"string"}},"required":["productId"],"type":"object"},"SPCreatePromptExtension":{"description":"Prompts Ad Extension","properties":{"promptText":{"description":"The prompt text rendered in the ads","type":"string"}},"required":["promptText"],"type":"object"},"SPCreateSpotlightVideoSettings":{"description":"An ad with a creative built with spotlight videos.","properties":{"optimizeText":{"description":"If the advertiser wants text they provided to be optimized by Amazon or not.","type":"boolean"},"videos":{"description":"The video asset(s) to use for the Sponsored Product experience.","items":{"$ref":"#/components/schemas/SPCreateVideo"},"maxItems":5,"minItems":1,"type":"array"}},"required":["optimizeText","videos"],"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\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. |\n","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"},"SPCreateTargetBid":{"properties":{"bid":{"description":"The maximum bid for a target.","format":"double","type":"number"}},"type":"object"},"SPCreateTargetDetails":{"oneOf":[{"properties":{"keywordTarget":{"$ref":"#/components/schemas/SPCreateKeywordTarget"}},"required":["keywordTarget"],"title":"keywordTarget","type":"object"},{"properties":{"productTarget":{"$ref":"#/components/schemas/SPCreateProductTarget"}},"required":["productTarget"],"title":"productTarget","type":"object"},{"properties":{"productCategoryTarget":{"$ref":"#/components/schemas/SPCreateProductCategoryTarget"}},"required":["productCategoryTarget"],"title":"productCategoryTarget","type":"object"},{"properties":{"locationTarget":{"$ref":"#/components/schemas/SPCreateLocationTarget"}},"required":["locationTarget"],"title":"locationTarget","type":"object"},{"properties":{"themeTarget":{"$ref":"#/components/schemas/SPCreateThemeTarget"}},"required":["themeTarget"],"title":"themeTarget","type":"object"}]},"SPCreateTargetRequest":{"properties":{"targets":{"items":{"$ref":"#/components/schemas/SPTargetCreate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["targets"],"type":"object"},"SPCreateThemeTarget":{"description":"Theme targets let advertisers select high-performing targets based on a common theme.","properties":{"matchType":{"$ref":"#/components/schemas/SPThemeMatchType"}},"required":["matchType"],"type":"object"},"SPCreateVideo":{"properties":{"assetId":{"description":"The asset library ID associated with the video asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the video asset.","type":"string"},"description":{"description":"The description of the video content.","type":"string"},"headline":{"description":"The headline/custom text associated with the video.","type":"string"}},"required":["assetId","assetVersion"],"type":"object"},"SPCreateVideoExtension":{"description":"Video Ad Extension","type":"object"},"SPCreative":{"oneOf":[{"properties":{"productCreative":{"$ref":"#/components/schemas/SPProductCreative"}},"required":["productCreative"],"title":"productCreative","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"},"SPDeleteAdGroupRequest":{"properties":{"adGroupIds":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["adGroupIds"],"type":"object"},"SPDeleteAdRequest":{"properties":{"adIds":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["adIds"],"type":"object"},"SPDeleteCampaignRequest":{"properties":{"campaignIds":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["campaignIds"],"type":"object"},"SPDeleteTargetRequest":{"properties":{"targetIds":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["targetIds"],"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"},"SPGlobalStoreSettings":{"properties":{"catalogSourceMarketplace":{"$ref":"#/components/schemas/SPMarketplace"}},"type":"object"},"SPKeywordMatchType":{"description":"**KeywordMatchType Enum:**\n\n| KeywordMatchType | Description |\n|------|------|\n| `BROAD` | Broad match search terms. This expands matching on user intent beyond PHRASE. |\n| `EXACT` | Exact match search terms. |\n| `PHRASE` | Phrase match search terms. This expands matching on user intent beyond EXACT. |\n","enum":["BROAD","EXACT","PHRASE"],"type":"string"},"SPKeywordTarget":{"description":"Targets a specific customer search term.","properties":{"keyword":{"description":"The customer search term or text to target. For valid characters and constraints, [see keyword character constraints](https://advertising.amazon.com/API/docs/en-us/reference/concepts/limits#keyword-character-constraints).","type":"string"},"matchType":{"$ref":"#/components/schemas/SPKeywordMatchType"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"nativeLanguageLocale":{"$ref":"#/components/schemas/SPLanguageLocale"}},"required":["keyword","matchType"],"type":"object"},"SPLanguageLocale":{"description":"A combination of ISO-639 standard for language code and ISO-3166 for country code.\n**LanguageLocale Enum:**\n\n| LanguageLocale | Description |\n|------|------|\n| `zh_CN` | Chinese (China). |\n","enum":["zh_CN"],"type":"string"},"SPLocationTarget":{"description":"Target based on geographic location.","properties":{"locationId":{"description":"The ID of the geographic location to target.","type":"string"}},"required":["locationId"],"type":"object"},"SPMarketplace":{"description":"A list of country codes representing Amazon marketplaces\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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"},"SPMatchType":{"description":"**MatchType Enum:**\n| MatchType | Description |\n| --- | --- |\n| `KEYWORDS_RELATED_TO_GIFTS` | Search terms related to gifts. |\n| `KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY` | Search terms that shoppers often use when searching for and interacting with products from other brands in the category of your advertised products. The peer brands are selected automatically. |\n| `PRODUCT_SIMILAR` | Products similar to the specified product. |\n| `BROAD` | Broad match search terms. This expands matching on user intent beyond PHRASE.  |\n| `EXACT` | Exact match search terms. |\n| `KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY` | Search terms shoppers often use to search for products in the same category as the products you\u0027re advertising. |\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `PRODUCT_SUBSTITUTES` | Products that can be substituted for advertised product. |\n| `KEYWORDS_LOOSE_MATCH` | Search terms loosely matching advertised product. |\n| `PHRASE` | Phrase match search terms. This expands matching on user intent beyond EXACT. |\n| `KEYWORDS_CLOSE_MATCH` | Search terms closely matching advertised product. |\n| `PRODUCT_COMPLEMENTS` | Products that complement advertised product. |\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |\n| `KEYWORDS_RELATED_TO_PRIME_DAY` | Search terms that shoppers are likely to use during Prime Day. These keywords can include terms related to the event, like \"prime day\", combined with product-specific terms. These keywords can help you expand reach to shoppers during the sales event. These keywords will only match queries through the end of Prime Day. |","enum":["BROAD","EXACT","KEYWORDS_CLOSE_MATCH","KEYWORDS_LOOSE_MATCH","KEYWORDS_RELATED_TO_GIFTS","KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY","KEYWORDS_RELATED_TO_PRIME_DAY","KEYWORDS_RELATED_TO_YOUR_BRAND","KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY","PHRASE","PRODUCT_COMPLEMENTS","PRODUCT_EXACT","PRODUCT_SIMILAR","PRODUCT_SUBSTITUTES"],"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_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_SEARCH` | Placements on the top row of the first-page search results. |\n","enum":["PRODUCT_PAGE","REST_OF_SEARCH","SITE_AMAZON_BUSINESS","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"},"SPProductCategoryRefinement":{"properties":{"productAgeRangeId":{"description":"The age range ID to target.","type":"string"},"productAgeRangeIdResolved":{"description":"The resolved age range to target.","type":"string"},"productBrandId":{"description":"The brand ID to target.","type":"string"},"productBrandIdResolved":{"description":"The resolved name of the brand.","type":"string"},"productCategoryId":{"description":"The product category ID to target.","type":"string"},"productCategoryIdResolved":{"description":"The resolved product category.","type":"string"},"productGenreId":{"description":"The product genre ID to target.","type":"string"},"productGenreIdResolved":{"description":"The resolved product genre to target.","type":"string"},"productPriceGreaterThan":{"description":"Refinement to target products with a price greater than the value within the product category.","format":"double","type":"number"},"productPriceLessThan":{"description":"Refinement to target products with a price less than the value within the product category.","format":"double","type":"number"},"productPrimeShippingEligible":{"description":"Target based on if a product is Prime-shipping eligible.","type":"boolean"},"productRatingGreaterThan":{"description":"Refinement to target products with a rating greater than the value within the product category.","format":"double","type":"number"},"productRatingLessThan":{"description":"Refinement to target products with a rating less than the value within the product category.","format":"double","type":"number"}},"type":"object"},"SPProductCategoryRefinementValue":{"properties":{"productCategoryRefinement":{"$ref":"#/components/schemas/SPProductCategoryRefinement"}},"required":["productCategoryRefinement"],"type":"object"},"SPProductCategoryTarget":{"description":"Targets a specific customer search term.","properties":{"productCategoryRefinement":{"$ref":"#/components/schemas/SPProductCategoryRefinementValue"}},"required":["productCategoryRefinement"],"type":"object"},"SPProductCreative":{"properties":{"productCreativeSettings":{"$ref":"#/components/schemas/SPProductCreativeSettings"}},"required":["productCreativeSettings"],"type":"object"},"SPProductCreativeSettings":{"description":"An ad with a creative built based on the product being advertised.","properties":{"advertisedProduct":{"$ref":"#/components/schemas/SPAdvertisedProducts"},"headline":{"description":"The headline/custom text associated with the ad creative.","type":"string"},"spotlightVideos":{"$ref":"#/components/schemas/SPSpotlightVideoSettings"}},"required":["advertisedProduct"],"type":"object"},"SPProductIdType":{"description":"**ProductIdType Enum:**\n\n| ProductIdType | Description |\n|------|------|\n| `ASIN` | ASIN identifier type. |\n| `SKU` | SKU identifier type. |\n","enum":["ASIN","SKU"],"type":"string"},"SPProductMatchType":{"description":"**ProductMatchType Enum:**\n\n| ProductMatchType | Description |\n|------|------|\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |\n| `PRODUCT_SIMILAR` | Products similar to the specified product. |\n","enum":["PRODUCT_EXACT","PRODUCT_SIMILAR"],"type":"string"},"SPProductTarget":{"description":"Targets a specific product.","properties":{"matchType":{"$ref":"#/components/schemas/SPProductMatchType"},"product":{"$ref":"#/components/schemas/SPProductValue"},"productIdType":{"$ref":"#/components/schemas/SPProductIdType"}},"required":["matchType","product","productIdType"],"type":"object"},"SPProductValue":{"properties":{"productId":{"description":"The product identifier. Either the product id or the marketplace settings should always be specified","type":"string"}},"required":["productId"],"type":"object"},"SPPromptExtension":{"description":"Prompts Ad Extension","properties":{"promptText":{"description":"The prompt text rendered in the ads","type":"string"}},"required":["promptText"],"type":"object"},"SPQueryAdExtensionRequest":{"properties":{"adExtensionIdFilter":{"$ref":"#/components/schemas/SPAdExtensionAdExtensionIdFilter"},"adExtensionStatusFilter":{"$ref":"#/components/schemas/SPAdExtensionAdExtensionStatusFilter"},"adExtensionTypeFilter":{"$ref":"#/components/schemas/SPAdExtensionAdExtensionTypeFilter"},"adGroupIdFilter":{"$ref":"#/components/schemas/SPAdExtensionAdGroupIdFilter"},"adIdFilter":{"$ref":"#/components/schemas/SPAdExtensionAdIdFilter"},"adProductFilter":{"$ref":"#/components/schemas/SPAdExtensionAdProductFilter"},"maxResults":{"default":1000,"format":"int32","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"type":"string"},"stateFilter":{"$ref":"#/components/schemas/SPAdExtensionStateFilter"}},"type":"object"},"SPQueryAdGroupRequest":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/SPAdGroupAdGroupIdFilter"},"adProductFilter":{"$ref":"#/components/schemas/SPAdGroupAdProductFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/SPAdGroupCampaignIdFilter"},"maxResults":{"default":1000,"format":"int32","maximum":1000,"minimum":1,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/SPAdGroupNameFilter"},"nextToken":{"type":"string"},"stateFilter":{"$ref":"#/components/schemas/SPAdGroupStateFilter"}},"required":["adProductFilter"],"type":"object"},"SPQueryAdRequest":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/SPAdAdGroupIdFilter"},"adIdFilter":{"$ref":"#/components/schemas/SPAdAdIdFilter"},"adProductFilter":{"$ref":"#/components/schemas/SPAdAdProductFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/SPAdCampaignIdFilter"},"maxResults":{"default":1000,"format":"int32","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"type":"string"},"stateFilter":{"$ref":"#/components/schemas/SPAdStateFilter"}},"required":["adProductFilter"],"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"},"stateFilter":{"$ref":"#/components/schemas/SPCampaignStateFilter"}},"required":["adProductFilter"],"type":"object"},"SPQueryTargetRequest":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/SPTargetAdGroupIdFilter"},"adProductFilter":{"$ref":"#/components/schemas/SPTargetAdProductFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/SPTargetCampaignIdFilter"},"keywordFilter":{"$ref":"#/components/schemas/SPTargetKeywordFilter"},"matchTypeFilter":{"$ref":"#/components/schemas/SPTargetMatchTypeFilter"},"maxResults":{"default":1000,"format":"int32","maximum":1000,"minimum":1,"type":"integer"},"negativeFilter":{"$ref":"#/components/schemas/SPTargetNegativeFilter"},"nextToken":{"type":"string"},"productIdFilter":{"$ref":"#/components/schemas/SPTargetProductIdFilter"},"stateFilter":{"$ref":"#/components/schemas/SPTargetStateFilter"},"targetIdFilter":{"$ref":"#/components/schemas/SPTargetTargetIdFilter"},"targetTypeFilter":{"$ref":"#/components/schemas/SPTargetTargetTypeFilter"}},"required":["adProductFilter"],"type":"object"},"SPRecurrence":{"enum":["DAILY"],"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"},"SPSpotlightVideoSettings":{"description":"An ad with a creative built with spotlight videos.","properties":{"optimizeText":{"description":"If the advertiser wants text they provided to be optimized by Amazon or not.","type":"boolean"},"videos":{"description":"The video asset(s) to use for the Sponsored Product experience.","items":{"$ref":"#/components/schemas/SPVideo"},"maxItems":5,"minItems":1,"type":"array"}},"required":["optimizeText","videos"],"type":"object"},"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"},"SPTarget":{"properties":{"adGroupId":{"description":"A unique identifier for the ad group associated with the target. Only used for ad-group level targets.","type":"string"},"adProduct":{"$ref":"#/components/schemas/SPAdProduct"},"bid":{"$ref":"#/components/schemas/SPTargetBid"},"campaignId":{"description":"A unique identifier for the campaign associated with the target. Only used for campaign-level targets.","type":"string"},"creationDateTime":{"description":"The date time the target was created.","format":"date-time","type":"string"},"globalTargetId":{"description":"The global target identifier that manages this marketplace target.","type":"string"},"lastUpdatedDateTime":{"description":"The date time the target was last updated.","format":"date-time","type":"string"},"marketplaceScope":{"$ref":"#/components/schemas/SPMarketplaceScope"},"marketplaces":{"description":"The list of marketplace in which the global target is applicable. The marketplaces included should either be same as or subset of parent campaign/ad group","items":{"$ref":"#/components/schemas/SPMarketplace"},"maxItems":1,"minItems":1,"type":"array"},"negative":{"description":"Indicates whether the target is negative or not.","type":"boolean"},"state":{"$ref":"#/components/schemas/SPState"},"status":{"$ref":"#/components/schemas/SPStatus"},"tags":{"description":"Open ended labels with a key value pair applied to the target","items":{"$ref":"#/components/schemas/SPTag"},"maxItems":50,"minItems":0,"type":"array"},"targetDetails":{"$ref":"#/components/schemas/SPTargetDetails"},"targetId":{"description":"A unique identifier for the target.","type":"string"},"targetLevel":{"$ref":"#/components/schemas/SPTargetLevel"},"targetType":{"$ref":"#/components/schemas/SPTargetType"}},"required":["adProduct","creationDateTime","lastUpdatedDateTime","marketplaceScope","marketplaces","negative","state","targetDetails","targetId","targetLevel","targetType"],"type":"object"},"SPTargetAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPTargetAdProductFilter":{"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"},"SPTargetBid":{"properties":{"bid":{"description":"The maximum bid for a target.","format":"double","type":"number"},"currencyCode":{"$ref":"#/components/schemas/SPCurrencyCode"}},"required":["currencyCode"],"type":"object"},"SPTargetCampaignIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPTargetCreate":{"properties":{"adGroupId":{"description":"A unique identifier for the ad group associated with the target. Only used for ad-group level targets.","type":"string"},"adProduct":{"$ref":"#/components/schemas/SPAdProduct"},"bid":{"$ref":"#/components/schemas/SPCreateTargetBid"},"campaignId":{"description":"A unique identifier for the campaign associated with the target. Only used for campaign-level targets.","type":"string"},"negative":{"description":"Indicates whether the target is negative or not.","type":"boolean"},"state":{"$ref":"#/components/schemas/SPCreateState"},"tags":{"description":"Open ended labels with a key value pair applied to the target","items":{"$ref":"#/components/schemas/SPCreateTag"},"maxItems":50,"minItems":0,"type":"array"},"targetDetails":{"$ref":"#/components/schemas/SPCreateTargetDetails"},"targetType":{"$ref":"#/components/schemas/SPTargetType"}},"required":["adProduct","negative","state","targetDetails","targetType"],"type":"object"},"SPTargetDetails":{"oneOf":[{"properties":{"keywordTarget":{"$ref":"#/components/schemas/SPKeywordTarget"}},"required":["keywordTarget"],"title":"keywordTarget","type":"object"},{"properties":{"locationTarget":{"$ref":"#/components/schemas/SPLocationTarget"}},"required":["locationTarget"],"title":"locationTarget","type":"object"},{"properties":{"productCategoryTarget":{"$ref":"#/components/schemas/SPProductCategoryTarget"}},"required":["productCategoryTarget"],"title":"productCategoryTarget","type":"object"},{"properties":{"productTarget":{"$ref":"#/components/schemas/SPProductTarget"}},"required":["productTarget"],"title":"productTarget","type":"object"},{"properties":{"themeTarget":{"$ref":"#/components/schemas/SPThemeTarget"}},"required":["themeTarget"],"title":"themeTarget","type":"object"}]},"SPTargetKeywordFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/SPTargetKeywordFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"SPTargetKeywordFilterType":{"description":"**TargetKeywordFilterType Enum:**\n| TargetKeywordFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"SPTargetLevel":{"description":"**TargetLevel Enum:**\n\n| TargetLevel | Description |\n|------|------|\n| `AD_GROUP` | Target applied at the ad group level. |\n| `CAMPAIGN` | Target applied at the campaign level. |\n","enum":["AD_GROUP","CAMPAIGN"],"type":"string"},"SPTargetMatchTypeFilter":{"properties":{"include":{"description":"**MatchType Enum:**\n| MatchType | Description |\n| --- | --- |\n| `KEYWORDS_RELATED_TO_GIFTS` | Search terms related to gifts. |\n| `KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY` | Search terms that shoppers often use when searching for and interacting with products from other brands in the category of your advertised products. The peer brands are selected automatically. |\n| `PRODUCT_SIMILAR` | Products similar to the specified product. |\n| `BROAD` | Broad match search terms. This expands matching on user intent beyond PHRASE.  |\n| `EXACT` | Exact match search terms. |\n| `KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY` | Search terms shoppers often use to search for products in the same category as the products you\u0027re advertising. |\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `PRODUCT_SUBSTITUTES` | Products that can be substituted for advertised product. |\n| `KEYWORDS_LOOSE_MATCH` | Search terms loosely matching advertised product. |\n| `PHRASE` | Phrase match search terms. This expands matching on user intent beyond EXACT. |\n| `KEYWORDS_CLOSE_MATCH` | Search terms closely matching advertised product. |\n| `PRODUCT_COMPLEMENTS` | Products that complement advertised product. |\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |\n| `KEYWORDS_RELATED_TO_PRIME_DAY` | Search terms that shoppers are likely to use during Prime Day. These keywords can include terms related to the event, like \"prime day\", combined with product-specific terms. These keywords can help you expand reach to shoppers during the sales event. These keywords will only match queries through the end of Prime Day. |","items":{"$ref":"#/components/schemas/SPMatchType"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPTargetMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SPTargetMultiStatusSuccess"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SPTargetMultiStatusSuccess":{"properties":{"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"},"target":{"$ref":"#/components/schemas/SPTarget"}},"required":["index","target"],"type":"object"},"SPTargetNegativeFilter":{"properties":{"include":{"items":{"type":"boolean"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPTargetProductIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/SPTargetProductIdFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"SPTargetProductIdFilterType":{"description":"**TargetProductIdFilterType Enum:**\n| TargetProductIdFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"SPTargetStateFilter":{"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"},"SPTargetSuccessResponse":{"properties":{"nextToken":{"type":"string"},"targets":{"items":{"$ref":"#/components/schemas/SPTarget"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SPTargetTargetIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPTargetTargetTypeFilter":{"properties":{"include":{"description":"**TargetType Enum:**\n| TargetType | Description |\n| --- | --- |\n| `KEYWORD` | Target based on customer search terms. |\n| `PRODUCT` | Target based on a specific product. |\n| `PRODUCT_CATEGORY` | Target based on a product category. |\n| `LOCATION` | Target based on geographic location. |\n| `THEME` | Target based on a keyword theme. These were formerly known as Auto Targets for Sponsored Products. |","items":{"$ref":"#/components/schemas/SPTargetType"},"maxItems":4,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPTargetType":{"description":"**TargetType Enum:**\n\n| TargetType | Description |\n|------|------|\n| `KEYWORD` | Target based on customer search terms. |\n| `LOCATION` | Target based on geographic location. |\n| `PRODUCT_CATEGORY` | Target based on a product category. |\n| `PRODUCT` | Target based on a specific product. |\n| `THEME` | Target based on a keyword theme. These were formerly known as Auto Targets for Sponsored Products. |\n","enum":["KEYWORD","LOCATION","PRODUCT","PRODUCT_CATEGORY","THEME"],"type":"string"},"SPTargetUpdate":{"properties":{"bid":{"$ref":"#/components/schemas/SPUpdateTargetBid"},"state":{"$ref":"#/components/schemas/SPUpdateState"},"tags":{"description":"Open ended labels with a key value pair applied to the target","items":{"$ref":"#/components/schemas/SPCreateTag"},"maxItems":50,"minItems":0,"type":"array"},"targetId":{"description":"A unique identifier for the target.","type":"string"}},"required":["targetId"],"type":"object"},"SPThemeMatchType":{"description":"**ThemeMatchType Enum:**\n\n| ThemeMatchType | Description |\n|------|------|\n| `KEYWORDS_CLOSE_MATCH` | Search terms closely matching advertised product. |\n| `KEYWORDS_LOOSE_MATCH` | Search terms loosely matching advertised product. |\n| `KEYWORDS_RELATED_TO_GIFTS` | Search terms related to gifts. |\n| `KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY` | Search terms that shoppers often use when searching for and interacting with products from other brands in the category of your advertised products. The peer brands are selected automatically. |\n| `KEYWORDS_RELATED_TO_PRIME_DAY` | Search terms that shoppers are likely to use during Prime Day. These keywords can include terms related to the event, like \"prime day\", combined with product-specific terms. These keywords can help you expand reach to shoppers during the sales event. These keywords will only match queries through the end of Prime Day. |\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY` | Search terms shoppers often use to search for products in the same category as the products you\u0027re advertising. |\n| `PRODUCT_COMPLEMENTS` | Products that complement advertised product. |\n| `PRODUCT_SUBSTITUTES` | Products that can be substituted for advertised product. |\n","enum":["KEYWORDS_CLOSE_MATCH","KEYWORDS_LOOSE_MATCH","KEYWORDS_RELATED_TO_GIFTS","KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY","KEYWORDS_RELATED_TO_PRIME_DAY","KEYWORDS_RELATED_TO_YOUR_BRAND","KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY","PRODUCT_COMPLEMENTS","PRODUCT_SUBSTITUTES"],"type":"string"},"SPThemeTarget":{"description":"Theme targets let advertisers select high-performing targets based on a common theme.","properties":{"matchType":{"$ref":"#/components/schemas/SPThemeMatchType"}},"required":["matchType"],"type":"object"},"SPUpdateAdExtensionRequest":{"properties":{"adExtensions":{"items":{"$ref":"#/components/schemas/SPAdExtensionUpdate"},"maxItems":50,"minItems":1,"type":"array"}},"required":["adExtensions"],"type":"object"},"SPUpdateAdGroupBid":{"properties":{"defaultBid":{"description":"The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction.","format":"double","type":"number"}},"type":"object"},"SPUpdateAdGroupRequest":{"properties":{"adGroups":{"items":{"$ref":"#/components/schemas/SPAdGroupUpdate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["adGroups"],"type":"object"},"SPUpdateAdRequest":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/SPAdUpdate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"},"SPUpdateAdSettings":{"properties":{"productAttributeSetRefinementConfigurationId":{"description":"Identifier for the product attribute configuration set associated with this ad group.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"}},"type":"object"},"SPUpdateBidAdjustments":{"properties":{"audienceBidAdjustments":{"description":"Bid Adjustments based on the audiences","items":{"$ref":"#/components/schemas/SPCreateAudienceBidAdjustment"},"maxItems":1,"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":4,"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"},"SPUpdateCreative":{"oneOf":[{"properties":{"productCreative":{"$ref":"#/components/schemas/SPUpdateProductCreative"}},"required":["productCreative"],"title":"productCreative","type":"object"}]},"SPUpdateProductCreative":{"properties":{"productCreativeSettings":{"$ref":"#/components/schemas/SPUpdateProductCreativeSettings"}},"type":"object"},"SPUpdateProductCreativeSettings":{"description":"An ad with a creative built based on the product being advertised.","properties":{"spotlightVideos":{"$ref":"#/components/schemas/SPUpdateSpotlightVideoSettings"}},"type":"object"},"SPUpdateSpotlightVideoSettings":{"description":"An ad with a creative built with spotlight videos.","properties":{"optimizeText":{"description":"If the advertiser wants text they provided to be optimized by Amazon or not.","type":"boolean"},"videos":{"description":"The video asset(s) to use for the Sponsored Product experience.","items":{"$ref":"#/components/schemas/SPCreateVideo"},"maxItems":5,"minItems":1,"type":"array"}},"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\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. |\n","enum":["ENABLED","PAUSED"],"type":"string"},"SPUpdateTargetBid":{"nullable":true,"properties":{"bid":{"description":"The maximum bid for a target.","format":"double","nullable":true,"type":"number"}},"type":"object"},"SPUpdateTargetRequest":{"properties":{"targets":{"items":{"$ref":"#/components/schemas/SPTargetUpdate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["targets"],"type":"object"},"SPVideo":{"properties":{"assetId":{"description":"The asset library ID associated with the video asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the video asset.","type":"string"},"description":{"description":"The description of the video content.","type":"string"},"headline":{"description":"The headline/custom text associated with the video.","type":"string"}},"required":["assetId","assetVersion"],"type":"object"},"SPVideoExtension":{"description":"Video Ad Extension","properties":{"renderedAssetId":{"description":"The video asset ID rendered in the ad.","type":"string"},"renderedCoverImageUrl":{"description":"The image displayed over the video player before the video is played.","type":"string"},"videoType":{"$ref":"#/components/schemas/SPVideoType"}},"required":["videoType"],"type":"object"},"SPVideoType":{"description":"Video Type: Video type of the asset added in the ad extension and its rendering form.\n**VideoType Enum:**\n\n| VideoType | Description |\n|------|------|\n| `SPOTLIGHT` | SPOTLIGHT Video Asset. |\n","enum":["SPOTLIGHT"],"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 Advertising API","title":"Amazon Ads API SP Merged","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/create/adExtensions":{"post":{"description":"Create ad extensions - API is in open beta\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":"SPCreateAdExtension","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPCreateAdExtensionRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPAdExtensionMultiStatusResponse"}}},"description":"SPCreateAdExtension 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":["AdExtensions"]}},"/adsApi/v1/create/adGroups":{"post":{"description":"Create ad groups\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":"SPCreateAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPCreateAdGroupRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPAdGroupMultiStatusResponse"}}},"description":"SPCreateAdGroup 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":["AdGroups"]}},"/adsApi/v1/create/ads":{"post":{"description":"Create ads\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\", \"creatives_edit\"]","operationId":"SPCreateAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPCreateAdRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPAdMultiStatusResponse"}}},"description":"SPCreateAd 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":["Ads"]}},"/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/create/targets":{"post":{"description":"Create target\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":"SPCreateTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPCreateTargetRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPTargetMultiStatusResponse"}}},"description":"SPCreateTarget 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":["Targets"]}},"/adsApi/v1/delete/adGroups":{"post":{"description":"Delete ad groups\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":"SPDeleteAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPDeleteAdGroupRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPAdGroupMultiStatusResponse"}}},"description":"SPDeleteAdGroup 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":["AdGroups"]}},"/adsApi/v1/delete/ads":{"post":{"description":"Delete ads\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":"SPDeleteAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPDeleteAdRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPAdMultiStatusResponse"}}},"description":"SPDeleteAd 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":["Ads"]}},"/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/delete/targets":{"post":{"description":"Delete target\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":"SPDeleteTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPDeleteTargetRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPTargetMultiStatusResponse"}}},"description":"SPDeleteTarget 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":["Targets"]}},"/adsApi/v1/query/adExtensions":{"post":{"description":"Query ad_extension - API is in open beta\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\", \"advertiser_campaign_view\"]","operationId":"SPQueryAdExtension","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPQueryAdExtensionRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPAdExtensionSuccessResponse"}}},"description":"SPQueryAdExtension 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":["AdExtensions"]}},"/adsApi/v1/query/adGroups":{"post":{"description":"List ad groups\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":"SPQueryAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPQueryAdGroupRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPAdGroupSuccessResponse"}}},"description":"SPQueryAdGroup 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":["AdGroups"]}},"/adsApi/v1/query/ads":{"post":{"description":"List ads\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\", \"creatives_view\", \"creatives_edit\", \n\"advertiser_campaign_view\"]","operationId":"SPQueryAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPQueryAdRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPAdSuccessResponse"}}},"description":"SPQueryAd 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":["Ads"]}},"/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/query/targets":{"post":{"description":"List target\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\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"SPQueryTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPQueryTargetRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPTargetSuccessResponse"}}},"description":"SPQueryTarget 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":["Targets"]}},"/adsApi/v1/update/adExtensions":{"post":{"description":"Update ad_extension - API is in open beta\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":"SPUpdateAdExtension","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPUpdateAdExtensionRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPAdExtensionMultiStatusResponse"}}},"description":"SPUpdateAdExtension 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":["AdExtensions"]}},"/adsApi/v1/update/adGroups":{"post":{"description":"Update ad groups\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":"SPUpdateAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPUpdateAdGroupRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPAdGroupMultiStatusResponse"}}},"description":"SPUpdateAdGroup 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":["AdGroups"]}},"/adsApi/v1/update/ads":{"post":{"description":"Update ads\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\", \"creatives_edit\"]","operationId":"SPUpdateAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPUpdateAdRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPAdMultiStatusResponse"}}},"description":"SPUpdateAd 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":["Ads"]}},"/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**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"]}},"/adsApi/v1/update/targets":{"post":{"description":"Update target\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":"SPUpdateTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPUpdateTargetRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPTargetMultiStatusResponse"}}},"description":"SPUpdateTarget 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":["Targets"]}}},"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"}]}