{"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| `FEATURE_NOT_AVAILABLE` | The requested feature is not available. |\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| `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","FEATURE_NOT_AVAILABLE","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","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":4999,"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"},"SBAd":{"properties":{"activeCreative":{"$ref":"#/components/schemas/SBCreative"},"adGroupId":{"description":"The ad group associated with the ad.","type":"string"},"adId":{"description":"The identifier of the ad.","type":"string"},"adProduct":{"$ref":"#/components/schemas/SBAdProduct"},"adType":{"$ref":"#/components/schemas/SBAdType"},"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/SBCreative"},"lastUpdatedDateTime":{"description":"The date time that the ad was last updated.","format":"date-time","type":"string"},"marketplaceScope":{"$ref":"#/components/schemas/SBMarketplaceScope"},"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/SBMarketplace"},"maxItems":1,"minItems":1,"type":"array"},"name":{"description":"The name of the ad.","type":"string"},"state":{"$ref":"#/components/schemas/SBState"},"status":{"$ref":"#/components/schemas/SBStatus"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/SBTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adGroupId","adId","adProduct","adType","campaignId","creationDateTime","creative","lastUpdatedDateTime","marketplaceScope","marketplaces","name","state"],"type":"object"},"SBAdAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBAdAdIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBAdAdProductFilter":{"properties":{"include":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `SPONSORED_BRANDS` | Sponsored Brands ad product. |","items":{"$ref":"#/components/schemas/SBAdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBAdCampaignIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBAdCreate":{"properties":{"adGroupId":{"description":"The ad group associated with the ad.","type":"string"},"adProduct":{"$ref":"#/components/schemas/SBAdProduct"},"adType":{"$ref":"#/components/schemas/SBAdType"},"creative":{"$ref":"#/components/schemas/SBCreateCreative"},"name":{"description":"The name of the ad.","type":"string"},"state":{"$ref":"#/components/schemas/SBCreateState"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/SBCreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adGroupId","adProduct","adType","creative","name","state"],"type":"object"},"SBAdExtension":{"properties":{"adExtensionId":{"description":"A unique identifier for the ad_extension.","type":"string"},"adExtensionSettings":{"$ref":"#/components/schemas/SBAdExtensionSettings"},"adExtensionStatus":{"$ref":"#/components/schemas/SBAdExtensionStatus"},"adExtensionType":{"$ref":"#/components/schemas/SBAdExtensionType"},"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/SBAdProduct"},"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/SBMarketplaceScope"},"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/SBMarketplace"},"maxItems":1,"minItems":1,"type":"array"},"state":{"$ref":"#/components/schemas/SBState"}},"required":["adExtensionId","adExtensionSettings","adExtensionType","adProduct","creationDateTime","lastUpdatedDateTime","marketplaceScope","marketplaces","state"],"type":"object"},"SBAdExtensionAdExtensionIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBAdExtensionAdExtensionStatusFilter":{"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/SBAdExtensionStatus"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBAdExtensionAdExtensionTypeFilter":{"properties":{"include":{"description":"**AdExtensionType Enum:**\n| AdExtensionType | Description |\n| --- | --- |\n| `PROMPTS` | Enables Prompt based Ad Extension. |","items":{"$ref":"#/components/schemas/SBAdExtensionType"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBAdExtensionAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBAdExtensionAdIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBAdExtensionAdProductFilter":{"properties":{"include":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `SPONSORED_BRANDS` | Sponsored Brands ad product. |","items":{"$ref":"#/components/schemas/SBAdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBAdExtensionCreate":{"properties":{"adExtensionSettings":{"$ref":"#/components/schemas/SBCreateAdExtensionSettings"},"adExtensionStatus":{"$ref":"#/components/schemas/SBAdExtensionStatus"},"adExtensionType":{"$ref":"#/components/schemas/SBAdExtensionType"},"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/SBAdProduct"},"marketplaceScope":{"$ref":"#/components/schemas/SBMarketplaceScope"},"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/SBMarketplace"},"maxItems":1,"minItems":1,"type":"array"},"state":{"$ref":"#/components/schemas/SBCreateState"}},"required":["adExtensionSettings","adExtensionType","adProduct","marketplaceScope","marketplaces","state"],"type":"object"},"SBAdExtensionMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":50,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SBAdExtensionMultiStatusSuccess"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"SBAdExtensionMultiStatusSuccess":{"properties":{"adExtension":{"$ref":"#/components/schemas/SBAdExtension"},"index":{"format":"int32","maximum":49,"minimum":0,"type":"integer"}},"required":["adExtension","index"],"type":"object"},"SBAdExtensionSettings":{"oneOf":[{"properties":{"promptExtension":{"$ref":"#/components/schemas/SBPromptExtension"}},"required":["promptExtension"],"title":"promptExtension","type":"object"}]},"SBAdExtensionStateFilter":{"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/SBState"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBAdExtensionStatus":{"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"},"SBAdExtensionSuccessResponse":{"properties":{"adExtensions":{"items":{"$ref":"#/components/schemas/SBAdExtension"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"SBAdExtensionType":{"description":"Ad Extension Type.\n**AdExtensionType Enum:**\n\n| AdExtensionType | Description |\n|------|------|\n| `PROMPTS` | Enables Prompt based Ad Extension. |\n","enum":["PROMPTS"],"type":"string"},"SBAdExtensionUpdate":{"properties":{"adExtensionId":{"description":"A unique identifier for the ad_extension.","type":"string"},"state":{"$ref":"#/components/schemas/SBUpdateState"}},"required":["adExtensionId"],"type":"object"},"SBAdGroup":{"properties":{"adGroupId":{"description":"The unique identifier of the ad group.","type":"string"},"adProduct":{"$ref":"#/components/schemas/SBAdProduct"},"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"},"lastUpdatedDateTime":{"description":"The date time that the ad group was last updated.","format":"date-time","type":"string"},"marketplaceScope":{"$ref":"#/components/schemas/SBMarketplaceScope"},"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/SBMarketplace"},"maxItems":1,"minItems":1,"type":"array"},"name":{"description":"The name of the ad group.","type":"string"},"state":{"$ref":"#/components/schemas/SBState"},"status":{"$ref":"#/components/schemas/SBStatus"},"tags":{"description":"Open ended labels with a key value pair applied to the ad group","items":{"$ref":"#/components/schemas/SBTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adGroupId","adProduct","campaignId","creationDateTime","lastUpdatedDateTime","marketplaceScope","marketplaces","name","state"],"type":"object"},"SBAdGroupAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBAdGroupAdProductFilter":{"properties":{"include":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `SPONSORED_BRANDS` | Sponsored Brands ad product. |","items":{"$ref":"#/components/schemas/SBAdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBAdGroupCampaignIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBAdGroupCreate":{"properties":{"adProduct":{"$ref":"#/components/schemas/SBAdProduct"},"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/SBCreateState"},"tags":{"description":"Open ended labels with a key value pair applied to the ad group","items":{"$ref":"#/components/schemas/SBCreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adProduct","campaignId","name","state"],"type":"object"},"SBAdGroupMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":10,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SBAdGroupMultiStatusSuccess"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"SBAdGroupMultiStatusSuccess":{"properties":{"adGroup":{"$ref":"#/components/schemas/SBAdGroup"},"index":{"format":"int32","maximum":9,"minimum":0,"type":"integer"}},"required":["adGroup","index"],"type":"object"},"SBAdGroupNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/SBAdGroupNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"SBAdGroupNameFilterType":{"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"},"SBAdGroupStateFilter":{"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/SBState"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBAdGroupSuccessResponse":{"properties":{"adGroups":{"items":{"$ref":"#/components/schemas/SBAdGroup"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"SBAdGroupUpdate":{"properties":{"adGroupId":{"description":"The unique identifier of the ad group.","type":"string"},"name":{"description":"The name of the ad group.","type":"string"},"state":{"$ref":"#/components/schemas/SBUpdateState"},"tags":{"description":"Open ended labels with a key value pair applied to the ad group","items":{"$ref":"#/components/schemas/SBCreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adGroupId"],"type":"object"},"SBAdMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":10,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SBAdMultiStatusSuccess"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"SBAdMultiStatusSuccess":{"properties":{"ad":{"$ref":"#/components/schemas/SBAd"},"index":{"format":"int32","maximum":9,"minimum":0,"type":"integer"}},"required":["ad","index"],"type":"object"},"SBAdNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/SBAdNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"SBAdNameFilterType":{"description":"**AdNameFilterType Enum:**\n| AdNameFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"SBAdProduct":{"description":"**AdProduct Enum:**\n\n| AdProduct | Description |\n|------|------|\n| `SPONSORED_BRANDS` | Sponsored Brands ad product. |\n","enum":["SPONSORED_BRANDS"],"type":"string"},"SBAdStateFilter":{"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/SBState"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBAdSuccessResponse":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/SBAd"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"SBAdType":{"description":"**AdType Enum:**\n\n| AdType | Description |\n|------|------|\n| `COMPONENT` | A creative that can features a collection of videos, images, and products. |\n","enum":["COMPONENT"],"type":"string"},"SBAdUpdate":{"properties":{"adId":{"description":"The identifier of the ad.","type":"string"},"creative":{"$ref":"#/components/schemas/SBUpdateCreative"},"name":{"description":"The name of the ad.","type":"string"},"state":{"$ref":"#/components/schemas/SBUpdateState"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/SBCreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adId"],"type":"object"},"SBAdvertisedProducts":{"properties":{"productId":{"description":"The identifier of the advertised product.","type":"string"},"productIdType":{"$ref":"#/components/schemas/SBProductIdType"}},"required":["productIdType"],"type":"object"},"SBAdvertisingDeal":{"properties":{"advertisingDealId":{"description":"A unique identifier for a deal.","type":"string"},"endDateTime":{"description":"The end date time for the deal.","format":"date-time","type":"string"},"name":{"description":"The name of the deal.","type":"string"},"price":{"$ref":"#/components/schemas/SBAdvertisingDealPrice"},"replacingDealId":{"description":"The ID of an advertising deal that this deal intends to replace.","type":"string"},"startDateTime":{"description":"The start date time for the deal.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/SBAdvertisingDealState"},"status":{"$ref":"#/components/schemas/SBAdvertisingDealStatus"}},"required":["advertisingDealId","endDateTime","name","startDateTime","status"],"type":"object"},"SBAdvertisingDealAdvertisingDealIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBAdvertisingDealBrandedKeywordTargetDetails":{"description":"The detail of a BRANDED_KEYWORD target.","properties":{"brandedKeyword":{"description":"The branded keyword that is an exact match to the shoppers\u0027 search term.","type":"string"}},"required":["brandedKeyword"],"type":"object"},"SBAdvertisingDealCreate":{"properties":{"endDateTime":{"description":"The end date time for the deal.","format":"date-time","type":"string"},"name":{"description":"The name of the deal.","type":"string"},"price":{"$ref":"#/components/schemas/SBCreateAdvertisingDealPrice"},"replacingDealId":{"description":"The ID of an advertising deal that this deal intends to replace.","type":"string"},"startDateTime":{"description":"The start date time for the deal.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/SBAdvertisingDealState"}},"required":["endDateTime","name","startDateTime"],"type":"object"},"SBAdvertisingDealMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":10,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SBAdvertisingDealMultiStatusSuccess"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"SBAdvertisingDealMultiStatusSuccess":{"properties":{"advertisingDeal":{"$ref":"#/components/schemas/SBAdvertisingDeal"},"index":{"format":"int32","maximum":9,"minimum":0,"type":"integer"}},"required":["advertisingDeal","index"],"type":"object"},"SBAdvertisingDealNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/SBAdvertisingDealNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"SBAdvertisingDealNameFilterType":{"description":"| AdvertisingDealNameFilterType | Description |\n|------|------|\n| `BROAD_MATCH` | Filter by broad match. |\n| `EXACT_MATCH` | Filter by exact match. |\n","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"SBAdvertisingDealPrice":{"properties":{"currencyCode":{"$ref":"#/components/schemas/SBCurrencyCode"},"priceType":{"$ref":"#/components/schemas/SBAdvertisingDealPriceType"},"value":{"description":"The monetary amount of the price in the given currency.","format":"double","type":"number"}},"required":["currencyCode","priceType","value"],"type":"object"},"SBAdvertisingDealPriceType":{"description":"| AdvertisingDealPriceType | Description |\n|------|------|\n| `FIXED_PRICE` | Sale price for a specific ad placement regardless of auction performance. |\n","enum":["FIXED_PRICE"],"type":"string"},"SBAdvertisingDealState":{"description":"| AdvertisingDealState | Description |\n|------|------|\n| `DRAFT` |  |\n| `PROPOSED` |  |\n","enum":["DRAFT","PROPOSED"],"type":"string"},"SBAdvertisingDealStatus":{"properties":{"status":{"$ref":"#/components/schemas/SBAdvertisingDealStatusEnum"}},"required":["status"],"type":"object"},"SBAdvertisingDealStatusEnum":{"description":"| AdvertisingDealStatusEnum | Description |\n|------|------|\n| `DRAFT` | The deal has not been submitted yet. |\n| `MODERATION_APPROVED` | The deal has passed moderation. |\n| `PROPOSED` | The deal has been submitted for moderation. |\n","enum":["DRAFT","MODERATION_APPROVED","PROPOSED"],"type":"string"},"SBAdvertisingDealSuccessResponse":{"properties":{"advertisingDeals":{"items":{"$ref":"#/components/schemas/SBAdvertisingDeal"},"maxItems":50,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"SBAdvertisingDealTarget":{"properties":{"advertisingDealId":{"description":"A unique identifier for the deal associated with the target.","type":"string"},"advertisingDealTargetId":{"description":"A unique identifier for a deal target.","type":"string"},"targetDetails":{"$ref":"#/components/schemas/SBAdvertisingDealTargetDetails"},"targetType":{"$ref":"#/components/schemas/SBAdvertisingDealTargetType"}},"required":["advertisingDealId","advertisingDealTargetId","targetDetails","targetType"],"type":"object"},"SBAdvertisingDealTargetAdvertisingDealIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBAdvertisingDealTargetCreate":{"properties":{"advertisingDealId":{"description":"A unique identifier for the deal associated with the target.","type":"string"},"targetDetails":{"$ref":"#/components/schemas/SBCreateAdvertisingDealTargetDetails"},"targetType":{"$ref":"#/components/schemas/SBAdvertisingDealTargetType"}},"required":["advertisingDealId","targetDetails","targetType"],"type":"object"},"SBAdvertisingDealTargetDetails":{"oneOf":[{"properties":{"advertisingDealBrandedKeywordTargetDetails":{"$ref":"#/components/schemas/SBAdvertisingDealBrandedKeywordTargetDetails"}},"required":["advertisingDealBrandedKeywordTargetDetails"],"title":"advertisingDealBrandedKeywordTargetDetails","type":"object"}]},"SBAdvertisingDealTargetMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SBAdvertisingDealTargetMultiStatusSuccess"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SBAdvertisingDealTargetMultiStatusSuccess":{"properties":{"advertisingDealTarget":{"$ref":"#/components/schemas/SBAdvertisingDealTarget"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"}},"required":["advertisingDealTarget","index"],"type":"object"},"SBAdvertisingDealTargetSuccessResponse":{"properties":{"advertisingDealTargets":{"items":{"$ref":"#/components/schemas/SBAdvertisingDealTarget"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"SBAdvertisingDealTargetType":{"description":"| AdvertisingDealTargetType | Description |\n|------|------|\n| `BRANDED_KEYWORD` |  |\n","enum":["BRANDED_KEYWORD"],"type":"string"},"SBAdvertisingDealUpdate":{"properties":{"advertisingDealId":{"description":"A unique identifier for a deal.","type":"string"},"endDateTime":{"description":"The end date time for the deal.","format":"date-time","type":"string"},"name":{"description":"The name of the deal.","type":"string"},"price":{"$ref":"#/components/schemas/SBUpdateAdvertisingDealPrice"},"replacingDealId":{"description":"The ID of an advertising deal that this deal intends to replace.","nullable":true,"type":"string"},"startDateTime":{"description":"The start date time for the deal.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/SBAdvertisingDealState"}},"required":["advertisingDealId"],"type":"object"},"SBAlternateBrandIdType":{"description":"The type of identifier for the alternate brand identifier.\n\n| AlternateBrandIdType | Description |\n|------|------|\n| `BRAND_REGISTRY` | Previous version of brand identifier retrieved from BrandRegistry. Identifiers of this type are returned by the GET /brands operation. |\n","enum":["BRAND_REGISTRY"],"type":"string"},"SBAudienceBidAdjustment":{"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"},"SBAutoCollectionSettings":{"description":"Settings for automatically generated collections.","properties":{"productExclusions":{"description":"Products to exclude from auto collection.","items":{"$ref":"#/components/schemas/SBAdvertisedProducts"},"maxItems":1000,"minItems":0,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/SBSharedCollectionSettings"}},"required":["sharedSettings"],"type":"object"},"SBAutoCreationSettings":{"properties":{"autoCreateTargets":{"description":"Gives Amazon permission to automatically create targets associated with the campaign based on the products being advertised.","type":"boolean"}},"type":"object"},"SBBidAdjustments":{"properties":{"audienceBidAdjustments":{"description":"Bid Adjustments based on the audiences","items":{"$ref":"#/components/schemas/SBAudienceBidAdjustment"},"maxItems":1,"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/SBPlacementBidAdjustment"},"maxItems":4,"minItems":0,"type":"array"},"shopperSegmentBidAdjustments":{"description":"Legacy SB field (marked for deprecation)","items":{"$ref":"#/components/schemas/SBShopperSegmentBidAdjustment"},"maxItems":2,"minItems":0,"type":"array"}},"type":"object"},"SBBidSettings":{"properties":{"bidAdjustments":{"$ref":"#/components/schemas/SBBidAdjustments"},"bidStrategy":{"$ref":"#/components/schemas/SBBidStrategy"}},"type":"object"},"SBBidStrategy":{"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| `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","SALES_UP_AND_DOWN"],"type":"string"},"SBBrandAlternateId":{"description":"Other types of brand identifiers for a brand that are used with other operations.","properties":{"alternateBrandId":{"description":"The alternative brand identifier for the brandId.","type":"string"},"alternateBrandIdType":{"$ref":"#/components/schemas/SBAlternateBrandIdType"}},"required":["alternateBrandId","alternateBrandIdType"],"type":"object"},"SBBrandGalleryCardCreativeElement":{"properties":{"customImage":{"$ref":"#/components/schemas/SBImage"},"headline":{"description":"The headline used for the card.","type":"string"},"landingPage":{"$ref":"#/components/schemas/SBStoreSpotlightLandingPage"}},"required":["customImage","headline","landingPage"],"type":"object"},"SBBrandGalleryCreativePropertiesToOptimize":{"description":"**BrandGalleryCreativePropertiesToOptimize Enum:**\n\n| BrandGalleryCreativePropertiesToOptimize | Description |\n|------|------|\n| `HEADLINE` | The headline in the creative. |\n","enum":["HEADLINE"],"type":"string"},"SBBrandGallerySettings":{"description":"An ad creative that showcases a brand and its categories and collections.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/SBImage"},"maxItems":1,"minItems":1,"type":"array"},"cards":{"description":"The sub-elements of the creative. Each card highlights a different category associated to a brand.","items":{"$ref":"#/components/schemas/SBBrandGalleryCardCreativeElement"},"maxItems":5,"minItems":3,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/SBBrandGalleryCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"customImages":{"description":"The custom images featured in the ad.","items":{"$ref":"#/components/schemas/SBImage"},"maxItems":1,"minItems":1,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/SBStoreSpotlightLandingPage"},"moderationStatus":{"$ref":"#/components/schemas/SBCreativeStatus"},"untranslatedHeadlines":{"description":"The headline entered by the advertiser.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"}},"required":["brand","brandLogos","cards","customImages","headlines","landingPage"],"type":"object"},"SBBrandedKeyword":{"properties":{"brandAlternateId":{"$ref":"#/components/schemas/SBBrandAlternateId"},"keyword":{"description":"Branded keyword","type":"string"}},"required":["brandAlternateId","keyword"],"type":"object"},"SBBrandedKeywordList":{"properties":{"associatedBrandIds":{"description":"Brand IDs associated with the branded keyword list","items":{"type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"brandedKeyword":{"description":"Branded keywords are specific words or phrases that include a company\u0027s brand name or a registered trademark of a brand","items":{"$ref":"#/components/schemas/SBBrandedKeyword"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SBBrandedKeywordRecommendationTypeDetails":{"properties":{"brandAlternateId":{"items":{"$ref":"#/components/schemas/SBBrandAlternateId"},"maxItems":1,"minItems":1,"type":"array"},"brandIds":{"description":"The brand ID to scope branded keyword recommendations for","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"}},"required":["brandAlternateId"],"type":"object"},"SBBrandedKeywordsPricing":{"properties":{"advertisingDealId":{"description":"Identifier of the existing deal to price. Omit when pricing a new deal.","type":"string"},"brandedKeywordsPricingId":{"description":"A unique identifier for the branded keywords pricing.","type":"string"},"endDateTime":{"description":"The end date time for the deal.","format":"date-time","type":"string"},"keywords":{"description":"The list of branded keywords advertiser wants to reserve.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"keywordsPricing":{"$ref":"#/components/schemas/SBKeywordsPricing"},"rejectedKeywords":{"description":"The list of branded keywords rejected for reservation by this advertiser.","items":{"$ref":"#/components/schemas/SBRejectedKeyword"},"maxItems":1000,"minItems":0,"type":"array"},"startDateTime":{"description":"The start date time for the deal.","format":"date-time","type":"string"}},"required":["brandedKeywordsPricingId","endDateTime","keywords","startDateTime"],"type":"object"},"SBBrandedKeywordsPricingCreate":{"properties":{"advertisingDealId":{"description":"Identifier of the existing deal to price. Omit when pricing a new deal.","type":"string"},"endDateTime":{"description":"The end date time for the deal.","format":"date-time","type":"string"},"keywords":{"description":"The list of branded keywords advertiser wants to reserve.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"startDateTime":{"description":"The start date time for the deal.","format":"date-time","type":"string"}},"required":["endDateTime","keywords","startDateTime"],"type":"object"},"SBBrandedKeywordsPricingMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":10,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SBBrandedKeywordsPricingMultiStatusSuccess"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"SBBrandedKeywordsPricingMultiStatusSuccess":{"properties":{"brandedKeywordsPricing":{"$ref":"#/components/schemas/SBBrandedKeywordsPricing"},"index":{"format":"int32","maximum":9,"minimum":0,"type":"integer"}},"required":["brandedKeywordsPricing","index"],"type":"object"},"SBBudget":{"properties":{"budgetType":{"$ref":"#/components/schemas/SBBudgetType"},"budgetValue":{"$ref":"#/components/schemas/SBBudgetValue"},"recurrenceTimePeriod":{"$ref":"#/components/schemas/SBRecurrence"}},"required":["budgetType","budgetValue","recurrenceTimePeriod"],"type":"object"},"SBBudgetType":{"enum":["MONETARY"],"type":"string"},"SBBudgetValue":{"oneOf":[{"properties":{"monetaryBudgetValue":{"$ref":"#/components/schemas/SBMonetaryBudgetValue"}},"required":["monetaryBudgetValue"],"title":"monetaryBudgetValue","type":"object"}]},"SBCampaign":{"properties":{"adProduct":{"$ref":"#/components/schemas/SBAdProduct"},"autoCreationSettings":{"$ref":"#/components/schemas/SBAutoCreationSettings"},"brandId":{"description":"This is the ID of the brand that the campaign is associated with.","type":"string"},"budgets":{"description":"The object containing budget details for the campaign (for campaigns that support multiple budgets).","items":{"$ref":"#/components/schemas/SBBudget"},"maxItems":1,"minItems":1,"type":"array"},"campaignId":{"description":"A unique identifier for a campaign.","type":"string"},"costType":{"$ref":"#/components/schemas/SBCostType"},"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/SBCountryCode"},"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"},"isMultiAdGroupsEnabled":{"description":"A read-only field that indicates whether a campaign supports multiple adGroups.","type":"boolean"},"lastUpdatedDateTime":{"description":"The date time that the campaign was last updated.","format":"date-time","type":"string"},"marketplaceScope":{"$ref":"#/components/schemas/SBMarketplaceScope"},"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/SBMarketplace"},"maxItems":1,"minItems":0,"type":"array"},"name":{"description":"The name of the campaign.","type":"string"},"optimizations":{"$ref":"#/components/schemas/SBCampaignOptimizations"},"portfolioId":{"description":"The ID of the portfolio associated with the campaign.","type":"string"},"salesChannel":{"$ref":"#/components/schemas/SBSalesChannel"},"siteRestrictions":{"description":"Restrict the ad to a particular site","items":{"$ref":"#/components/schemas/SBSiteRestriction"},"maxItems":1,"minItems":0,"type":"array"},"startDateTime":{"description":"The start date time for the campaign.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/SBState"},"status":{"$ref":"#/components/schemas/SBStatus"},"tags":{"description":"Open ended labels with a key value pair applied to the campaign","items":{"$ref":"#/components/schemas/SBTag"},"maxItems":50,"minItems":0,"type":"array"},"targetedPGDealId":{"description":"DealId associated with the campaign.","type":"string"}},"required":["adProduct","budgets","campaignId","costType","creationDateTime","isMultiAdGroupsEnabled","lastUpdatedDateTime","marketplaceScope","name","startDateTime","state"],"type":"object"},"SBCampaignAdProductFilter":{"properties":{"include":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `SPONSORED_BRANDS` | Sponsored Brands ad product. |","items":{"$ref":"#/components/schemas/SBAdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBCampaignCampaignIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBCampaignCreate":{"properties":{"adProduct":{"$ref":"#/components/schemas/SBAdProduct"},"autoCreationSettings":{"$ref":"#/components/schemas/SBCreateAutoCreationSettings"},"brandId":{"description":"This is the ID of the brand that the campaign is associated with.","type":"string"},"budgets":{"description":"The object containing budget details for the campaign (for campaigns that support multiple budgets).","items":{"$ref":"#/components/schemas/SBCreateBudget"},"maxItems":1,"minItems":1,"type":"array"},"costType":{"$ref":"#/components/schemas/SBCostType"},"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/SBCountryCode"},"maxItems":1,"minItems":0,"type":"array"},"endDateTime":{"description":"The end date time for the campaign.","format":"date-time","type":"string"},"marketplaceScope":{"$ref":"#/components/schemas/SBMarketplaceScope"},"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/SBMarketplace"},"maxItems":1,"minItems":0,"type":"array"},"name":{"description":"The name of the campaign.","type":"string"},"optimizations":{"$ref":"#/components/schemas/SBCreateCampaignOptimizations"},"portfolioId":{"description":"The ID of the portfolio associated with the campaign.","type":"string"},"salesChannel":{"$ref":"#/components/schemas/SBSalesChannel"},"siteRestrictions":{"description":"Restrict the ad to a particular site","items":{"$ref":"#/components/schemas/SBSiteRestriction"},"maxItems":1,"minItems":0,"type":"array"},"startDateTime":{"description":"The start date time for the campaign.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/SBCreateState"},"tags":{"description":"Open ended labels with a key value pair applied to the campaign","items":{"$ref":"#/components/schemas/SBCreateTag"},"maxItems":50,"minItems":0,"type":"array"},"targetedPGDealId":{"description":"DealId associated with the campaign.","type":"string"}},"required":["adProduct","budgets","costType","marketplaceScope","name","startDateTime","state"],"type":"object"},"SBCampaignGoalFilter":{"properties":{"include":{"description":"**Goal Enum:**\n| Goal | Description |\n| --- | --- |\n| `AWARENESS` | Indicates a goal of driving awareness. |\n| `CONSIDERATION` | Indicates a goal of driving consideration. |\n| `CONVERSIONS` | Indicates a goal of driving conversions. |","items":{"$ref":"#/components/schemas/SBGoal"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBCampaignMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":10,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SBCampaignMultiStatusSuccess"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"SBCampaignMultiStatusSuccess":{"properties":{"campaign":{"$ref":"#/components/schemas/SBCampaign"},"index":{"format":"int32","maximum":9,"minimum":0,"type":"integer"}},"required":["campaign","index"],"type":"object"},"SBCampaignNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/SBCampaignNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"SBCampaignNameFilterType":{"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"},"SBCampaignOptimizations":{"properties":{"bidSettings":{"$ref":"#/components/schemas/SBBidSettings"},"goalSettings":{"$ref":"#/components/schemas/SBGoalSettings"}},"type":"object"},"SBCampaignPortfolioIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBCampaignStateFilter":{"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/SBState"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBCampaignSuccessResponse":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/SBCampaign"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"SBCampaignUpdate":{"properties":{"budgets":{"description":"The object containing budget details for the campaign (for campaigns that support multiple budgets).","items":{"$ref":"#/components/schemas/SBCreateBudget"},"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/SBUpdateCampaignOptimizations"},"portfolioId":{"description":"The ID of the portfolio associated with the campaign.","nullable":true,"type":"string"},"startDateTime":{"description":"The start date time for the campaign.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/SBUpdateState"},"tags":{"description":"Open ended labels with a key value pair applied to the campaign","items":{"$ref":"#/components/schemas/SBCreateTag"},"maxItems":50,"minItems":0,"type":"array"},"targetedPGDealId":{"description":"DealId associated with the campaign.","type":"string"}},"required":["campaignId"],"type":"object"},"SBCardCreativeElement":{"properties":{"headline":{"description":"The headline used for the card.","type":"string"},"landingPage":{"$ref":"#/components/schemas/SBStoreSpotlightLandingPage"},"products":{"$ref":"#/components/schemas/SBAdvertisedProducts"}},"required":["headline","landingPage","products"],"type":"object"},"SBCollectionLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/SBCollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page.","type":"string"}},"required":["landingPageType"],"type":"object"},"SBCollectionLandingPageType":{"description":"**CollectionLandingPageType Enum:**\n\n| CollectionLandingPageType | Description |\n|------|------|\n| `ASIN_LIST` | A list of products based on the products promoted in the ad creative. |\n| `STORE` | A brand Store landing page. |\n","enum":["ASIN_LIST","STORE"],"type":"string"},"SBComponentCreative":{"properties":{"autoCollectionSettings":{"$ref":"#/components/schemas/SBAutoCollectionSettings"},"brandGallerySettings":{"$ref":"#/components/schemas/SBBrandGallerySettings"},"manualCollectionSettings":{"$ref":"#/components/schemas/SBManualCollectionSettings"},"productCollectionSettings":{"$ref":"#/components/schemas/SBProductCollectionSettings"},"productVideoSettings":{"$ref":"#/components/schemas/SBProductVideoSettings"},"storeSpotlightSettings":{"$ref":"#/components/schemas/SBStoreSpotlightSettings"}},"type":"object"},"SBCostType":{"description":"**CostType Enum:**\n\n| CostType | Description |\n|------|------|\n| `CPC` | Cost per click. |\n| `CPM` | Cost per thousand impressions. |\n| `FIXED_PRICE` | Sale price for a specific ad placement regardless of auction performance. |\n| `VCPM` | Cost per thousand views. |\n","enum":["CPC","CPM","FIXED_PRICE","VCPM"],"type":"string"},"SBCountryCode":{"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"},"SBCreateAdExtensionRequest":{"properties":{"adExtensions":{"items":{"$ref":"#/components/schemas/SBAdExtensionCreate"},"maxItems":50,"minItems":1,"type":"array"}},"required":["adExtensions"],"type":"object"},"SBCreateAdExtensionSettings":{"oneOf":[{"properties":{"promptExtension":{"$ref":"#/components/schemas/SBCreatePromptExtension"}},"required":["promptExtension"],"title":"promptExtension","type":"object"}]},"SBCreateAdGroupRequest":{"properties":{"adGroups":{"items":{"$ref":"#/components/schemas/SBAdGroupCreate"},"maxItems":10,"minItems":1,"type":"array"}},"required":["adGroups"],"type":"object"},"SBCreateAdRequest":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/SBAdCreate"},"maxItems":10,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"},"SBCreateAdvertisedProducts":{"properties":{"productId":{"description":"The identifier of the advertised product.","type":"string"},"productIdType":{"$ref":"#/components/schemas/SBProductIdType"}},"required":["productIdType"],"type":"object"},"SBCreateAdvertisingDealBrandedKeywordTargetDetails":{"description":"The detail of a BRANDED_KEYWORD target.","properties":{"brandedKeyword":{"description":"The branded keyword that is an exact match to the shoppers\u0027 search term.","type":"string"}},"required":["brandedKeyword"],"type":"object"},"SBCreateAdvertisingDealPrice":{"properties":{"priceType":{"$ref":"#/components/schemas/SBAdvertisingDealPriceType"},"value":{"description":"The monetary amount of the price in the given currency.","format":"double","type":"number"}},"required":["priceType","value"],"type":"object"},"SBCreateAdvertisingDealRequest":{"properties":{"advertisingDeals":{"items":{"$ref":"#/components/schemas/SBAdvertisingDealCreate"},"maxItems":10,"minItems":1,"type":"array"}},"type":"object"},"SBCreateAdvertisingDealTargetDetails":{"oneOf":[{"properties":{"advertisingDealBrandedKeywordTargetDetails":{"$ref":"#/components/schemas/SBCreateAdvertisingDealBrandedKeywordTargetDetails"}},"required":["advertisingDealBrandedKeywordTargetDetails"],"title":"advertisingDealBrandedKeywordTargetDetails","type":"object"}]},"SBCreateAdvertisingDealTargetRequest":{"properties":{"advertisingDealTargets":{"items":{"$ref":"#/components/schemas/SBAdvertisingDealTargetCreate"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"SBCreateAudienceBidAdjustment":{"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"},"SBCreateAutoCollectionSettings":{"description":"Settings for automatically generated collections.","properties":{"productExclusions":{"description":"Products to exclude from auto collection.","items":{"$ref":"#/components/schemas/SBCreateAdvertisedProducts"},"maxItems":1000,"minItems":0,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/SBCreateSharedCollectionSettings"}},"required":["sharedSettings"],"type":"object"},"SBCreateAutoCreationSettings":{"properties":{"autoCreateTargets":{"description":"Gives Amazon permission to automatically create targets associated with the campaign based on the products being advertised.","type":"boolean"}},"type":"object"},"SBCreateBidAdjustments":{"properties":{"audienceBidAdjustments":{"description":"Bid Adjustments based on the audiences","items":{"$ref":"#/components/schemas/SBCreateAudienceBidAdjustment"},"maxItems":1,"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/SBCreatePlacementBidAdjustment"},"maxItems":4,"minItems":0,"type":"array"},"shopperSegmentBidAdjustments":{"description":"Legacy SB field (marked for deprecation)","items":{"$ref":"#/components/schemas/SBCreateShopperSegmentBidAdjustment"},"maxItems":2,"minItems":0,"type":"array"}},"type":"object"},"SBCreateBidSettings":{"properties":{"bidAdjustments":{"$ref":"#/components/schemas/SBCreateBidAdjustments"},"bidStrategy":{"$ref":"#/components/schemas/SBBidStrategy"}},"type":"object"},"SBCreateBrandAlternateId":{"description":"Other types of brand identifiers for a brand that are used with other operations.","properties":{"alternateBrandId":{"description":"The alternative brand identifier for the brandId.","type":"string"},"alternateBrandIdType":{"$ref":"#/components/schemas/SBAlternateBrandIdType"}},"required":["alternateBrandId","alternateBrandIdType"],"type":"object"},"SBCreateBrandGalleryCardCreativeElement":{"properties":{"customImage":{"$ref":"#/components/schemas/SBCreateImage"},"headline":{"description":"The headline used for the card.","type":"string"},"landingPage":{"$ref":"#/components/schemas/SBCreateStoreSpotlightLandingPage"}},"required":["customImage","headline","landingPage"],"type":"object"},"SBCreateBrandGallerySettings":{"description":"An ad creative that showcases a brand and its categories and collections.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/SBCreateImage"},"maxItems":1,"minItems":1,"type":"array"},"cards":{"description":"The sub-elements of the creative. Each card highlights a different category associated to a brand.","items":{"$ref":"#/components/schemas/SBCreateBrandGalleryCardCreativeElement"},"maxItems":5,"minItems":3,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/SBBrandGalleryCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"customImages":{"description":"The custom images featured in the ad.","items":{"$ref":"#/components/schemas/SBCreateImage"},"maxItems":1,"minItems":1,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/SBCreateStoreSpotlightLandingPage"}},"required":["brand","brandLogos","cards","customImages","headlines","landingPage"],"type":"object"},"SBCreateBrandedKeywordRecommendationTypeDetails":{"properties":{"brandAlternateId":{"items":{"$ref":"#/components/schemas/SBCreateBrandAlternateId"},"maxItems":1,"minItems":1,"type":"array"},"brandIds":{"description":"The brand ID to scope branded keyword recommendations for","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"}},"required":["brandAlternateId"],"type":"object"},"SBCreateBrandedKeywordsPricingRequest":{"properties":{"brandedKeywordsPricings":{"items":{"$ref":"#/components/schemas/SBBrandedKeywordsPricingCreate"},"maxItems":10,"minItems":1,"type":"array"}},"type":"object"},"SBCreateBudget":{"properties":{"budgetType":{"$ref":"#/components/schemas/SBBudgetType"},"budgetValue":{"$ref":"#/components/schemas/SBCreateBudgetValue"},"recurrenceTimePeriod":{"$ref":"#/components/schemas/SBRecurrence"}},"required":["budgetType","budgetValue","recurrenceTimePeriod"],"type":"object"},"SBCreateBudgetValue":{"oneOf":[{"properties":{"monetaryBudgetValue":{"$ref":"#/components/schemas/SBCreateMonetaryBudgetValue"}},"required":["monetaryBudgetValue"],"title":"monetaryBudgetValue","type":"object"}]},"SBCreateCampaignOptimizations":{"properties":{"bidSettings":{"$ref":"#/components/schemas/SBCreateBidSettings"},"goalSettings":{"$ref":"#/components/schemas/SBCreateGoalSettings"}},"type":"object"},"SBCreateCampaignRequest":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/SBCampaignCreate"},"maxItems":10,"minItems":1,"type":"array"}},"required":["campaigns"],"type":"object"},"SBCreateCardCreativeElement":{"properties":{"headline":{"description":"The headline used for the card.","type":"string"},"landingPage":{"$ref":"#/components/schemas/SBCreateStoreSpotlightLandingPage"},"products":{"$ref":"#/components/schemas/SBCreateAdvertisedProducts"}},"required":["headline","landingPage","products"],"type":"object"},"SBCreateCollectionLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/SBCollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page.","type":"string"}},"required":["landingPageType"],"type":"object"},"SBCreateComponentCreative":{"properties":{"autoCollectionSettings":{"$ref":"#/components/schemas/SBCreateAutoCollectionSettings"},"brandGallerySettings":{"$ref":"#/components/schemas/SBCreateBrandGallerySettings"},"manualCollectionSettings":{"$ref":"#/components/schemas/SBCreateManualCollectionSettings"},"productCollectionSettings":{"$ref":"#/components/schemas/SBCreateProductCollectionSettings"},"productVideoSettings":{"$ref":"#/components/schemas/SBCreateProductVideoSettings"},"storeSpotlightSettings":{"$ref":"#/components/schemas/SBCreateStoreSpotlightSettings"}},"type":"object"},"SBCreateCreative":{"oneOf":[{"properties":{"componentCreative":{"$ref":"#/components/schemas/SBCreateComponentCreative"}},"required":["componentCreative"],"title":"componentCreative","type":"object"}]},"SBCreateFormatProperties":{"properties":{"height":{"description":"The height (in pixels) of the cropped image.","format":"int32","type":"integer"},"left":{"description":"The number of pixels from the left of the image where the crop should begin.","format":"int32","type":"integer"},"top":{"description":"The number of pixels from the top of the image where the crop should begin.","format":"int32","type":"integer"},"width":{"description":"The width (in pixels) of the cropped image.","format":"int32","type":"integer"}},"type":"object"},"SBCreateGoalSettings":{"properties":{"kpi":{"$ref":"#/components/schemas/SBKPI"}},"required":["kpi"],"type":"object"},"SBCreateImage":{"properties":{"assetId":{"description":"The asset library ID associated with the image asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the image asset.","type":"string"},"formatProperties":{"description":"The cropping and positioning properties associated with the asset.","items":{"$ref":"#/components/schemas/SBCreateFormatProperties"},"maxItems":10,"minItems":0,"type":"array"}},"required":["assetId","assetVersion"],"type":"object"},"SBCreateKeywordReservationValidationRequest":{"properties":{"keywordReservationValidations":{"items":{"$ref":"#/components/schemas/SBKeywordReservationValidationCreate"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"SBCreateKeywordTarget":{"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/SBKeywordMatchType"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"nativeLanguageLocale":{"$ref":"#/components/schemas/SBLanguageLocale"}},"required":["keyword","matchType"],"type":"object"},"SBCreateLandingPageAsins":{"properties":{"asins":{"description":"For landing page of type ASIN_LIST, the list of ASINs used to create the landing page.","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["asins"],"type":"object"},"SBCreateManualCollectionSettings":{"description":"Settings for manually curated collections.","properties":{"landingPage":{"$ref":"#/components/schemas/SBCreateCollectionLandingPage"},"productInclusions":{"description":"The products featured in the ad. Required for manual collections.","items":{"$ref":"#/components/schemas/SBCreateAdvertisedProducts"},"maxItems":10,"minItems":3,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/SBCreateSharedCollectionSettings"}},"required":["landingPage","productInclusions","sharedSettings"],"type":"object"},"SBCreateMonetaryBudget":{"properties":{"value":{"description":"The monetary amount of the budget cap in the given currency.","format":"double","type":"number"}},"required":["value"],"type":"object"},"SBCreateMonetaryBudgetValue":{"properties":{"monetaryBudget":{"$ref":"#/components/schemas/SBCreateMonetaryBudget"}},"required":["monetaryBudget"],"type":"object"},"SBCreatePlacementBidAdjustment":{"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/SBPlacement"}},"required":["percentage","placement"],"type":"object"},"SBCreateProductCategoryRefinement":{"properties":{"productBrandId":{"description":"The brand ID to target.","type":"string"},"productCategoryId":{"description":"The product category 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"},"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"},"SBCreateProductCategoryRefinementValue":{"properties":{"productCategoryRefinement":{"$ref":"#/components/schemas/SBCreateProductCategoryRefinement"}},"type":"object"},"SBCreateProductCategoryTarget":{"description":"Targets a specific customer search term.","properties":{"productCategoryRefinement":{"$ref":"#/components/schemas/SBCreateProductCategoryRefinementValue"}},"required":["productCategoryRefinement"],"type":"object"},"SBCreateProductCollectionLandingPage":{"properties":{"landingPageAsins":{"$ref":"#/components/schemas/SBCreateLandingPageAsins"},"landingPageType":{"$ref":"#/components/schemas/SBProductCollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page. Read only if landingPageType is ASIN_LIST","type":"string"}},"required":["landingPageType"],"type":"object"},"SBCreateProductCollectionSettings":{"description":"An ad creative that contains multiple products and a custom image.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/SBCreateImage"},"maxItems":2,"minItems":1,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/SBProductCollectionCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"customImages":{"description":"The set of custom images featured in the ad.","items":{"$ref":"#/components/schemas/SBCreateImage"},"maxItems":5,"minItems":1,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/SBCreateProductCollectionLandingPage"},"products":{"description":"The products featured in the ad.","items":{"$ref":"#/components/schemas/SBCreateAdvertisedProducts"},"maxItems":3,"minItems":0,"type":"array"}},"required":["brand","brandLogos","customImages","headlines","landingPage"],"type":"object"},"SBCreateProductTarget":{"description":"Targets a specific product.","properties":{"matchType":{"$ref":"#/components/schemas/SBProductMatchType"},"product":{"$ref":"#/components/schemas/SBCreateProductValue"},"productIdType":{"$ref":"#/components/schemas/SBProductIdType"}},"required":["matchType","product","productIdType"],"type":"object"},"SBCreateProductValue":{"properties":{"productId":{"description":"The product identifier. Either the product id or the marketplace settings should always be specified","type":"string"}},"type":"object"},"SBCreateProductVideoSettings":{"description":"An ad with a creative that includes a video.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/SBCreateImage"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/SBCreateVideoLandingPage"},"products":{"description":"The products featured in the video ad.","items":{"$ref":"#/components/schemas/SBCreateAdvertisedProducts"},"maxItems":3,"minItems":0,"type":"array"},"videos":{"description":"The video assets used in the ad.","items":{"$ref":"#/components/schemas/SBCreateVideo"},"maxItems":1,"minItems":1,"type":"array"}},"required":["videos"],"type":"object"},"SBCreatePromptExtension":{"description":"Prompts Ad Extension","properties":{"promptText":{"description":"The prompt text rendered in the ads","type":"string"}},"required":["promptText"],"type":"object"},"SBCreateRecommendationRequest":{"properties":{"recommendations":{"items":{"$ref":"#/components/schemas/SBRecommendationCreate"},"maxItems":1,"minItems":1,"type":"array"}},"type":"object"},"SBCreateRecommendationTypeDetails":{"oneOf":[{"properties":{"brandedKeywordRecommendationTypeDetails":{"$ref":"#/components/schemas/SBCreateBrandedKeywordRecommendationTypeDetails"}},"required":["brandedKeywordRecommendationTypeDetails"],"title":"brandedKeywordRecommendationTypeDetails","type":"object"}]},"SBCreateReservedTargetPricingRequest":{"properties":{"reservedTargetPricings":{"items":{"$ref":"#/components/schemas/SBReservedTargetPricingCreate"},"maxItems":10,"minItems":1,"type":"array"}},"required":["reservedTargetPricings"],"type":"object"},"SBCreateSharedCollectionSettings":{"description":"Settings shared by all collection types.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"$ref":"#/components/schemas/SBCreateImage"}},"required":["brand"],"type":"object"},"SBCreateShopperSegmentBidAdjustment":{"type":"object"},"SBCreateState":{"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"},"SBCreateStoreSpotlightLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/SBStoreSpotlightLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"SBCreateStoreSpotlightSettings":{"description":"An ad creative that contains ASINs within a brand Store.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/SBCreateImage"},"maxItems":1,"minItems":1,"type":"array"},"cards":{"description":"The sub-elements of the creative. Each card highlights a different ASIN associated to a brand Store.","items":{"$ref":"#/components/schemas/SBCreateCardCreativeElement"},"maxItems":3,"minItems":3,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/SBStoreSpotlightCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/SBCreateStoreSpotlightLandingPage"}},"required":["brand","brandLogos","cards","headlines","landingPage"],"type":"object"},"SBCreateTag":{"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"},"SBCreateTargetBid":{"properties":{"bid":{"description":"The maximum bid for a target.","format":"double","type":"number"}},"required":["bid"],"type":"object"},"SBCreateTargetDetails":{"oneOf":[{"properties":{"keywordTarget":{"$ref":"#/components/schemas/SBCreateKeywordTarget"}},"required":["keywordTarget"],"title":"keywordTarget","type":"object"},{"properties":{"productTarget":{"$ref":"#/components/schemas/SBCreateProductTarget"}},"required":["productTarget"],"title":"productTarget","type":"object"},{"properties":{"productCategoryTarget":{"$ref":"#/components/schemas/SBCreateProductCategoryTarget"}},"required":["productCategoryTarget"],"title":"productCategoryTarget","type":"object"},{"properties":{"themeTarget":{"$ref":"#/components/schemas/SBCreateThemeTarget"}},"required":["themeTarget"],"title":"themeTarget","type":"object"}]},"SBCreateTargetRequest":{"properties":{"targets":{"items":{"$ref":"#/components/schemas/SBTargetCreate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["targets"],"type":"object"},"SBCreateThemeTarget":{"description":"Theme targets let advertisers select high-performing targets based on a common theme.","properties":{"matchType":{"$ref":"#/components/schemas/SBThemeMatchType"}},"required":["matchType"],"type":"object"},"SBCreateVideo":{"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"}},"required":["assetId","assetVersion"],"type":"object"},"SBCreateVideoLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/SBVideoLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType"],"type":"object"},"SBCreative":{"oneOf":[{"properties":{"componentCreative":{"$ref":"#/components/schemas/SBComponentCreative"}},"required":["componentCreative"],"title":"componentCreative","type":"object"}]},"SBCreativeStatus":{"properties":{"moderationStatus":{"$ref":"#/components/schemas/SBModerationStatus"}},"required":["moderationStatus"],"type":"object"},"SBCurrencyCode":{"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"},"SBDeleteAdGroupRequest":{"properties":{"adGroupIds":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["adGroupIds"],"type":"object"},"SBDeleteAdRequest":{"properties":{"adIds":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["adIds"],"type":"object"},"SBDeleteAdvertisingDealRequest":{"properties":{"advertisingDealIds":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"type":"object"},"SBDeleteAdvertisingDealTargetRequest":{"properties":{"advertisingDealTargetIds":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"SBDeleteCampaignRequest":{"properties":{"campaignIds":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["campaignIds"],"type":"object"},"SBDeleteTargetRequest":{"properties":{"targetIds":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["targetIds"],"type":"object"},"SBDeliveryReason":{"description":"**DeliveryReason Enum:**\n\n| DeliveryReason | Description |\n|------|------|\n| `ADVERTISER_ARCHIVED` |  |\n| `ADVERTISER_INELIGIBLE` |  |\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_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| `OTHER` |  |\n| `PORTFOLIO_ARCHIVED` |  |\n| `PORTFOLIO_END_DATE_REACHED` |  |\n| `PORTFOLIO_OUT_OF_BUDGET` |  |\n| `PORTFOLIO_PAUSED` |  |\n| `PORTFOLIO_PENDING_START_DATE` |  |\n| `STATUS_UNAVAILABLE` |  |\n| `TARGET_ARCHIVED` |  |\n| `TARGET_BLOCKED` |  |\n| `TARGET_PAUSED` |  |\n| `TARGET_POLICING_SUSPENDED` |  |\n","enum":["ADVERTISER_ARCHIVED","ADVERTISER_INELIGIBLE","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_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","OTHER","PORTFOLIO_ARCHIVED","PORTFOLIO_END_DATE_REACHED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PAUSED","PORTFOLIO_PENDING_START_DATE","STATUS_UNAVAILABLE","TARGET_ARCHIVED","TARGET_BLOCKED","TARGET_PAUSED","TARGET_POLICING_SUSPENDED"],"type":"string"},"SBDeliveryStatus":{"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"},"SBFormatProperties":{"properties":{"height":{"description":"The height (in pixels) of the cropped image.","format":"int32","type":"integer"},"left":{"description":"The number of pixels from the left of the image where the crop should begin.","format":"int32","type":"integer"},"top":{"description":"The number of pixels from the top of the image where the crop should begin.","format":"int32","type":"integer"},"width":{"description":"The width (in pixels) of the cropped image.","format":"int32","type":"integer"}},"type":"object"},"SBGoal":{"description":"**Goal Enum:**\n\n| Goal | Description |\n|------|------|\n| `AWARENESS` | Indicates a goal of driving awareness. |\n| `CONSIDERATION` | Indicates a goal of driving consideration. |\n| `CONVERSIONS` | Indicates a goal of driving conversions. |\n","enum":["AWARENESS","CONSIDERATION","CONVERSIONS"],"type":"string"},"SBGoalSettings":{"properties":{"goal":{"$ref":"#/components/schemas/SBGoal"},"kpi":{"$ref":"#/components/schemas/SBKPI"}},"required":["goal","kpi"],"type":"object"},"SBImage":{"properties":{"assetId":{"description":"The asset library ID associated with the image asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the image asset.","type":"string"},"formatProperties":{"description":"The cropping and positioning properties associated with the asset.","items":{"$ref":"#/components/schemas/SBFormatProperties"},"maxItems":10,"minItems":0,"type":"array"}},"required":["assetId","assetVersion"],"type":"object"},"SBKPI":{"description":"**KPI Enum:**\n\n| KPI | Description |\n|------|------|\n| `CLICKS` | Indicates a goal of driving clicks. |\n| `TOP_OF_SEARCH_IMPRESSION_SHARE` | Indicates a goal of maximizing impression for top search placement. |\n","enum":["CLICKS","TOP_OF_SEARCH_IMPRESSION_SHARE"],"type":"string"},"SBKeywordMatchType":{"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"},"SBKeywordReservationValidation":{"properties":{"isReservable":{"description":"Whether the keyword can be reserved or not.","type":"boolean"},"keyword":{"description":"Keyword to be validated.","type":"string"},"keywordReservationValidationId":{"description":"The identifier of the KeywordReservationValidation.","type":"string"},"reservationRejectedReason":{"description":"Reason why the keyword cannot be reserved. It is present only when isReservable is false.","type":"string"}},"required":["isReservable","keyword","keywordReservationValidationId"],"type":"object"},"SBKeywordReservationValidationCreate":{"properties":{"keyword":{"description":"Keyword to be validated.","type":"string"}},"required":["keyword"],"type":"object"},"SBKeywordReservationValidationMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SBKeywordReservationValidationMultiStatusSuccess"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SBKeywordReservationValidationMultiStatusSuccess":{"properties":{"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"},"keywordReservationValidation":{"$ref":"#/components/schemas/SBKeywordReservationValidation"}},"required":["index","keywordReservationValidation"],"type":"object"},"SBKeywordTarget":{"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/SBKeywordMatchType"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"nativeLanguageLocale":{"$ref":"#/components/schemas/SBLanguageLocale"}},"required":["keyword","matchType"],"type":"object"},"SBKeywordsPricing":{"description":"The detail of keywords pricing.","properties":{"price":{"$ref":"#/components/schemas/SBAdvertisingDealPrice"},"validKeywords":{"description":"List of valid keywords.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["price","validKeywords"],"type":"object"},"SBLandingPageAsins":{"properties":{"asins":{"description":"For landing page of type ASIN_LIST, the list of ASINs used to create the landing page.","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["asins"],"type":"object"},"SBLanguageLocale":{"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"},"SBManualCollectionSettings":{"description":"Settings for manually curated collections.","properties":{"landingPage":{"$ref":"#/components/schemas/SBCollectionLandingPage"},"productInclusions":{"description":"The products featured in the ad. Required for manual collections.","items":{"$ref":"#/components/schemas/SBAdvertisedProducts"},"maxItems":10,"minItems":3,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/SBSharedCollectionSettings"}},"required":["landingPage","productInclusions","sharedSettings"],"type":"object"},"SBMarketplace":{"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"},"SBMarketplaceScope":{"enum":["SINGLE_MARKETPLACE"],"type":"string"},"SBMatchType":{"description":"**MatchType Enum:**\n| MatchType | Description |\n| --- | --- |\n| `KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES` | Search terms related to your landing pages. |\n| `PHRASE` | Phrase match search terms. This expands matching on user intent beyond EXACT. |\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_BRAND` | Search terms related to your brand. |\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |","enum":["BROAD","EXACT","KEYWORDS_RELATED_TO_YOUR_BRAND","KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES","PHRASE","PRODUCT_EXACT"],"type":"string"},"SBModerationStatus":{"description":"**ModerationStatus Enum:**\n\n| ModerationStatus | Description |\n|------|------|\n| `APPROVED_WITH_EXCEPTIONS` | The creative passed basic moderation but was found to be invalid for some supplies. The creative is serving on approved supplies. |\n| `PENDING_TRANSLATION` | The creative is pending creative Translations. |\n| `PUBLISHED` | The creative passed moderation and is serving. |\n| `REJECTED_BY_MODERATION` | The creative was rejected during the moderation process. |\n| `SUBMITTED_FOR_MODERATION` | The creative has been submitted, but has not yet been reviewed. |\n","enum":["APPROVED_WITH_EXCEPTIONS","PENDING_TRANSLATION","PUBLISHED","REJECTED_BY_MODERATION","SUBMITTED_FOR_MODERATION"],"type":"string"},"SBMonetaryBudget":{"properties":{"currencyCode":{"$ref":"#/components/schemas/SBCurrencyCode"},"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"},"SBMonetaryBudgetValue":{"properties":{"monetaryBudget":{"$ref":"#/components/schemas/SBMonetaryBudget"}},"required":["monetaryBudget"],"type":"object"},"SBObjectSettings":{"oneOf":[{"properties":{"brandedKeywordList":{"$ref":"#/components/schemas/SBBrandedKeywordList"}},"required":["brandedKeywordList"],"title":"brandedKeywordList","type":"object"}]},"SBPlacement":{"description":"**Placement Enum:**\n\n| Placement | Description |\n|------|------|\n| `HOME_PAGE` | Home page. |\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| `TOP_OF_SEARCH` | Placements on the top row of the first-page search results. |\n","enum":["HOME_PAGE","PRODUCT_PAGE","REST_OF_SEARCH","TOP_OF_SEARCH"],"type":"string"},"SBPlacementBidAdjustment":{"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/SBPlacement"}},"required":["percentage","placement"],"type":"object"},"SBProductCategoryRefinement":{"properties":{"productBrandId":{"description":"The brand ID to target.","type":"string"},"productCategoryId":{"description":"The product category 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"},"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"},"SBProductCategoryRefinementValue":{"properties":{"productCategoryRefinement":{"$ref":"#/components/schemas/SBProductCategoryRefinement"}},"type":"object"},"SBProductCategoryTarget":{"description":"Targets a specific customer search term.","properties":{"productCategoryRefinement":{"$ref":"#/components/schemas/SBProductCategoryRefinementValue"}},"required":["productCategoryRefinement"],"type":"object"},"SBProductCollectionCreativePropertiesToOptimize":{"description":"**ProductCollectionCreativePropertiesToOptimize Enum:**\n\n| ProductCollectionCreativePropertiesToOptimize | Description |\n|------|------|\n| `HEADLINE` | The headline in the creative. |\n","enum":["HEADLINE"],"type":"string"},"SBProductCollectionLandingPage":{"properties":{"landingPageAsins":{"$ref":"#/components/schemas/SBLandingPageAsins"},"landingPageType":{"$ref":"#/components/schemas/SBProductCollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page. Read only if landingPageType is ASIN_LIST","type":"string"}},"required":["landingPageType"],"type":"object"},"SBProductCollectionLandingPageType":{"description":"**ProductCollectionLandingPageType Enum:**\n\n| ProductCollectionLandingPageType | Description |\n|------|------|\n| `ASIN_LIST` | A list of products based on the products promoted in the ad creative. |\n| `CUSTOM_URL` | A custom landing page. Available for vendors only. |\n| `STORE` | A brand Store landing page. |\n","enum":["ASIN_LIST","CUSTOM_URL","STORE"],"type":"string"},"SBProductCollectionSettings":{"description":"An ad creative that contains multiple products and a custom image.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/SBImage"},"maxItems":2,"minItems":1,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/SBProductCollectionCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"customImages":{"description":"The set of custom images featured in the ad.","items":{"$ref":"#/components/schemas/SBImage"},"maxItems":5,"minItems":1,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/SBProductCollectionLandingPage"},"moderationStatus":{"$ref":"#/components/schemas/SBCreativeStatus"},"products":{"description":"The products featured in the ad.","items":{"$ref":"#/components/schemas/SBAdvertisedProducts"},"maxItems":3,"minItems":0,"type":"array"},"untranslatedHeadlines":{"description":"The headlines entered by the advertiser.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"}},"required":["brand","brandLogos","customImages","headlines","landingPage"],"type":"object"},"SBProductIdType":{"description":"**ProductIdType Enum:**\n\n| ProductIdType | Description |\n|------|------|\n| `ASIN` | ASIN identifier type. |\n","enum":["ASIN"],"type":"string"},"SBProductMatchType":{"description":"**ProductMatchType Enum:**\n\n| ProductMatchType | Description |\n|------|------|\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |\n","enum":["PRODUCT_EXACT"],"type":"string"},"SBProductTarget":{"description":"Targets a specific product.","properties":{"matchType":{"$ref":"#/components/schemas/SBProductMatchType"},"product":{"$ref":"#/components/schemas/SBProductValue"},"productIdType":{"$ref":"#/components/schemas/SBProductIdType"}},"required":["matchType","product","productIdType"],"type":"object"},"SBProductValue":{"properties":{"productId":{"description":"The product identifier. Either the product id or the marketplace settings should always be specified","type":"string"}},"type":"object"},"SBProductVideoSettings":{"description":"An ad with a creative that includes a video.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/SBImage"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/SBVideoLandingPage"},"moderationStatus":{"$ref":"#/components/schemas/SBCreativeStatus"},"products":{"description":"The products featured in the video ad.","items":{"$ref":"#/components/schemas/SBAdvertisedProducts"},"maxItems":3,"minItems":0,"type":"array"},"untranslatedHeadlines":{"description":"The headline entered by the advertiser.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"untranslatedVideos":{"description":"The original video assets submitted as part of the creative.","items":{"$ref":"#/components/schemas/SBVideo"},"maxItems":2,"minItems":1,"type":"array"},"videos":{"description":"The video assets used in the ad.","items":{"$ref":"#/components/schemas/SBVideo"},"maxItems":1,"minItems":1,"type":"array"}},"required":["untranslatedVideos","videos"],"type":"object"},"SBPromptExtension":{"description":"Prompts Ad Extension","properties":{"promptText":{"description":"The prompt text rendered in the ads","type":"string"}},"required":["promptText"],"type":"object"},"SBQueryAdExtensionRequest":{"properties":{"adExtensionIdFilter":{"$ref":"#/components/schemas/SBAdExtensionAdExtensionIdFilter"},"adExtensionStatusFilter":{"$ref":"#/components/schemas/SBAdExtensionAdExtensionStatusFilter"},"adExtensionTypeFilter":{"$ref":"#/components/schemas/SBAdExtensionAdExtensionTypeFilter"},"adGroupIdFilter":{"$ref":"#/components/schemas/SBAdExtensionAdGroupIdFilter"},"adIdFilter":{"$ref":"#/components/schemas/SBAdExtensionAdIdFilter"},"adProductFilter":{"$ref":"#/components/schemas/SBAdExtensionAdProductFilter"},"maxResults":{"default":1000,"format":"int32","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"type":"string"},"stateFilter":{"$ref":"#/components/schemas/SBAdExtensionStateFilter"}},"type":"object"},"SBQueryAdGroupRequest":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/SBAdGroupAdGroupIdFilter"},"adProductFilter":{"$ref":"#/components/schemas/SBAdGroupAdProductFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/SBAdGroupCampaignIdFilter"},"maxResults":{"default":100,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/SBAdGroupNameFilter"},"nextToken":{"type":"string"},"stateFilter":{"$ref":"#/components/schemas/SBAdGroupStateFilter"}},"required":["adProductFilter"],"type":"object"},"SBQueryAdRequest":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/SBAdAdGroupIdFilter"},"adIdFilter":{"$ref":"#/components/schemas/SBAdAdIdFilter"},"adProductFilter":{"$ref":"#/components/schemas/SBAdAdProductFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/SBAdCampaignIdFilter"},"maxResults":{"default":100,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/SBAdNameFilter"},"nextToken":{"type":"string"},"stateFilter":{"$ref":"#/components/schemas/SBAdStateFilter"}},"required":["adProductFilter"],"type":"object"},"SBQueryAdvertisingDealRequest":{"properties":{"advertisingDealIdFilter":{"$ref":"#/components/schemas/SBAdvertisingDealAdvertisingDealIdFilter"},"maxResults":{"default":10,"format":"int32","maximum":50,"minimum":1,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/SBAdvertisingDealNameFilter"},"nextToken":{"type":"string"}},"type":"object"},"SBQueryAdvertisingDealTargetRequest":{"properties":{"advertisingDealIdFilter":{"$ref":"#/components/schemas/SBAdvertisingDealTargetAdvertisingDealIdFilter"},"maxResults":{"default":100,"format":"int32","maximum":1000,"minimum":100,"type":"integer"},"nextToken":{"type":"string"}},"required":["advertisingDealIdFilter"],"type":"object"},"SBQueryCampaignRequest":{"properties":{"adProductFilter":{"$ref":"#/components/schemas/SBCampaignAdProductFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/SBCampaignCampaignIdFilter"},"goalFilter":{"$ref":"#/components/schemas/SBCampaignGoalFilter"},"maxResults":{"default":100,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/SBCampaignNameFilter"},"nextToken":{"type":"string"},"portfolioIdFilter":{"$ref":"#/components/schemas/SBCampaignPortfolioIdFilter"},"stateFilter":{"$ref":"#/components/schemas/SBCampaignStateFilter"}},"required":["adProductFilter"],"type":"object"},"SBQueryRecommendationTypeRequest":{"properties":{"maxResults":{"default":50,"format":"int32","maximum":500,"minimum":50,"type":"integer"},"nextToken":{"type":"string"}},"type":"object"},"SBQueryTargetRequest":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/SBTargetAdGroupIdFilter"},"adProductFilter":{"$ref":"#/components/schemas/SBTargetAdProductFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/SBTargetCampaignIdFilter"},"keywordFilter":{"$ref":"#/components/schemas/SBTargetKeywordFilter"},"matchTypeFilter":{"$ref":"#/components/schemas/SBTargetMatchTypeFilter"},"maxResults":{"default":5000,"format":"int32","maximum":5000,"minimum":1,"type":"integer"},"nativeLanguageLocaleFilter":{"$ref":"#/components/schemas/SBTargetLanguageLocaleFilter"},"negativeFilter":{"$ref":"#/components/schemas/SBTargetNegativeFilter"},"nextToken":{"type":"string"},"stateFilter":{"$ref":"#/components/schemas/SBTargetStateFilter"},"targetIdFilter":{"$ref":"#/components/schemas/SBTargetTargetIdFilter"},"targetTypeFilter":{"$ref":"#/components/schemas/SBTargetTargetTypeFilter"}},"required":["adProductFilter"],"type":"object"},"SBRecommendation":{"properties":{"recommendationId":{"description":"The identifier of the recommendation","type":"string"},"recommendationType":{"description":"A unique value to indicate similar recommendations, used for internal purposes only","type":"string"},"recommendationTypeDetails":{"$ref":"#/components/schemas/SBRecommendationTypeDetails"},"recommendedObjects":{"description":"The target objects of the recommendation","items":{"$ref":"#/components/schemas/SBRecommendedObject"},"maxItems":10,"minItems":1,"type":"array"}},"required":["recommendationId","recommendationType","recommendedObjects"],"type":"object"},"SBRecommendationCreate":{"properties":{"recommendationType":{"description":"A unique value to indicate similar recommendations, used for internal purposes only","type":"string"},"recommendationTypeDetails":{"$ref":"#/components/schemas/SBCreateRecommendationTypeDetails"}},"required":["recommendationType"],"type":"object"},"SBRecommendationMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SBRecommendationMultiStatusSuccess"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"SBRecommendationMultiStatusSuccess":{"properties":{"index":{"format":"int32","maximum":0,"minimum":0,"type":"integer"},"recommendation":{"$ref":"#/components/schemas/SBRecommendation"}},"required":["index","recommendation"],"type":"object"},"SBRecommendationType":{"properties":{"recommendationTypeId":{"description":"The ID of the recommendation type. Format: Either a UUID or a unique descriptive string identifier","type":"string"},"recommendationTypeTitle":{"description":"Titles or short descriptions of the recommendation","type":"string"}},"required":["recommendationTypeId","recommendationTypeTitle"],"type":"object"},"SBRecommendationTypeDetails":{"oneOf":[{"properties":{"brandedKeywordRecommendationTypeDetails":{"$ref":"#/components/schemas/SBBrandedKeywordRecommendationTypeDetails"}},"required":["brandedKeywordRecommendationTypeDetails"],"title":"brandedKeywordRecommendationTypeDetails","type":"object"}]},"SBRecommendationTypeEnum":{"description":"The unique identifier of the recommendation type. Used to classify and group similar recommendations (e.g. \u0027BRANDED_KEYWORD\u0027).\n**RecommendationTypeEnum Enum:**\n| RecommendationTypeEnum | Description |\n| --- | --- |\n| `BRANDED_KEYWORD` | Suggests branded keywords for advertiser campaigns based on associated brands. Requires BrandedKeywordRecommendationTypeDetails to scope suggestions by brand alternate IDs. |","enum":["BRANDED_KEYWORD"],"type":"string"},"SBRecommendationTypeSuccessResponse":{"properties":{"nextToken":{"type":"string"},"recommendationTypes":{"items":{"$ref":"#/components/schemas/SBRecommendationType"},"maxItems":500,"minItems":0,"type":"array"}},"type":"object"},"SBRecommendedObject":{"description":"Details of the recommended object","properties":{"recommendedObjectSettings":{"$ref":"#/components/schemas/SBObjectSettings"}},"type":"object"},"SBRecurrence":{"enum":["DAILY","LIFETIME"],"type":"string"},"SBRejectedKeyword":{"description":"The detail of a rejected keyword.","properties":{"keyword":{"description":"The keyword that has been rejected.","type":"string"},"reason":{"description":"The reason keyword has been rejected for this advertiser.","type":"string"}},"required":["keyword","reason"],"type":"object"},"SBReservedTargetPricing":{"properties":{"targetPricingId":{"description":"A unique identifier for the reserved target pricing.","type":"string"}},"required":["targetPricingId"],"type":"object"},"SBReservedTargetPricingCreate":{"properties":{"targetPricingId":{"description":"A unique identifier for the reserved target pricing.","type":"string"}},"required":["targetPricingId"],"type":"object"},"SBReservedTargetPricingMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":10,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SBReservedTargetPricingMultiStatusSuccess"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"SBReservedTargetPricingMultiStatusSuccess":{"properties":{"index":{"format":"int32","maximum":9,"minimum":0,"type":"integer"},"reservedTargetPricing":{"$ref":"#/components/schemas/SBReservedTargetPricing"}},"required":["index","reservedTargetPricing"],"type":"object"},"SBSalesChannel":{"description":"**SalesChannel Enum:**\n\n| SalesChannel | Description |\n|------|------|\n| `AMAZON` | A product sold on Amazon-owned sites. |\n| `OFF_AMAZON` | A product sold on a site not owned by Amazon. |\n","enum":["AMAZON","OFF_AMAZON"],"type":"string"},"SBSharedCollectionSettings":{"description":"Settings shared by all collection types.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"$ref":"#/components/schemas/SBImage"},"moderationStatus":{"$ref":"#/components/schemas/SBCreativeStatus"}},"required":["brand"],"type":"object"},"SBShopperSegment":{"enum":["NEW_TO_BRAND"],"type":"string"},"SBShopperSegmentBidAdjustment":{"properties":{"percentage":{"description":"The selection of the percentage change associated with a given shopper segment and bid adjustment settings.","format":"int32","type":"integer"},"shopperSegment":{"$ref":"#/components/schemas/SBShopperSegment"}},"required":["percentage","shopperSegment"],"type":"object"},"SBSiteRestriction":{"description":"**SiteRestriction Enum:**\n\n| SiteRestriction | Description |\n|------|------|\n| `AMAZON_BUSINESS` | Restrict the ad to only show on Amazon Business. |\n","enum":["AMAZON_BUSINESS"],"type":"string"},"SBState":{"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"},"SBStatus":{"properties":{"deliveryReasons":{"description":"This is the list of reasons behind the delivery status.","items":{"$ref":"#/components/schemas/SBDeliveryReason"},"maxItems":50,"minItems":0,"type":"array"},"deliveryStatus":{"$ref":"#/components/schemas/SBDeliveryStatus"}},"required":["deliveryStatus"],"type":"object"},"SBStoreSpotlightCreativePropertiesToOptimize":{"description":"**StoreSpotlightCreativePropertiesToOptimize Enum:**\n\n| StoreSpotlightCreativePropertiesToOptimize | Description |\n|------|------|\n| `HEADLINE` | The headline in the creative. |\n","enum":["HEADLINE"],"type":"string"},"SBStoreSpotlightLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/SBStoreSpotlightLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"SBStoreSpotlightLandingPageType":{"description":"**StoreSpotlightLandingPageType Enum:**\n\n| StoreSpotlightLandingPageType | Description |\n|------|------|\n| `STORE` | A brand Store landing page. |\n","enum":["STORE"],"type":"string"},"SBStoreSpotlightSettings":{"description":"An ad creative that contains ASINs within a brand Store.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/SBImage"},"maxItems":1,"minItems":1,"type":"array"},"cards":{"description":"The sub-elements of the creative. Each card highlights a different ASIN associated to a brand Store.","items":{"$ref":"#/components/schemas/SBCardCreativeElement"},"maxItems":3,"minItems":3,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/SBStoreSpotlightCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/SBStoreSpotlightLandingPage"},"moderationStatus":{"$ref":"#/components/schemas/SBCreativeStatus"},"untranslatedHeadlines":{"description":"The headline entered by the advertiser.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"}},"required":["brand","brandLogos","cards","headlines","landingPage"],"type":"object"},"SBTag":{"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"},"SBTarget":{"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/SBAdProduct"},"bid":{"$ref":"#/components/schemas/SBTargetBid"},"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"},"lastUpdatedDateTime":{"description":"The date time the target was last updated.","format":"date-time","type":"string"},"marketplaceScope":{"$ref":"#/components/schemas/SBMarketplaceScope"},"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/SBMarketplace"},"maxItems":1,"minItems":1,"type":"array"},"negative":{"description":"Indicates whether the target is negative or not.","type":"boolean"},"state":{"$ref":"#/components/schemas/SBState"},"status":{"$ref":"#/components/schemas/SBStatus"},"targetDetails":{"$ref":"#/components/schemas/SBTargetDetails"},"targetId":{"description":"A unique identifier for the target.","type":"string"},"targetLevel":{"$ref":"#/components/schemas/SBTargetLevel"},"targetType":{"$ref":"#/components/schemas/SBTargetType"}},"required":["adGroupId","adProduct","creationDateTime","lastUpdatedDateTime","marketplaceScope","marketplaces","negative","state","targetDetails","targetId","targetLevel","targetType"],"type":"object"},"SBTargetAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBTargetAdProductFilter":{"properties":{"include":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `SPONSORED_BRANDS` | Sponsored Brands ad product. |","items":{"$ref":"#/components/schemas/SBAdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBTargetBid":{"properties":{"bid":{"description":"The maximum bid for a target.","format":"double","type":"number"},"currencyCode":{"$ref":"#/components/schemas/SBCurrencyCode"}},"required":["bid","currencyCode"],"type":"object"},"SBTargetCampaignIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBTargetCreate":{"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/SBAdProduct"},"bid":{"$ref":"#/components/schemas/SBCreateTargetBid"},"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/SBCreateState"},"targetDetails":{"$ref":"#/components/schemas/SBCreateTargetDetails"},"targetType":{"$ref":"#/components/schemas/SBTargetType"}},"required":["adGroupId","adProduct","negative","state","targetDetails","targetType"],"type":"object"},"SBTargetDetails":{"oneOf":[{"properties":{"keywordTarget":{"$ref":"#/components/schemas/SBKeywordTarget"}},"required":["keywordTarget"],"title":"keywordTarget","type":"object"},{"properties":{"productCategoryTarget":{"$ref":"#/components/schemas/SBProductCategoryTarget"}},"required":["productCategoryTarget"],"title":"productCategoryTarget","type":"object"},{"properties":{"productTarget":{"$ref":"#/components/schemas/SBProductTarget"}},"required":["productTarget"],"title":"productTarget","type":"object"},{"properties":{"themeTarget":{"$ref":"#/components/schemas/SBThemeTarget"}},"required":["themeTarget"],"title":"themeTarget","type":"object"}]},"SBTargetKeywordFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":2,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/SBTargetKeywordFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"SBTargetKeywordFilterType":{"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"},"SBTargetLanguageLocaleFilter":{"properties":{"include":{"description":"**NativeLanguageLocale Enum:**\n| NativeLanguageLocale | Description |\n| --- | --- |\n| `zh_CN` | Chinese (China). |","items":{"$ref":"#/components/schemas/SBLanguageLocale"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBTargetLevel":{"description":"**TargetLevel Enum:**\n\n| TargetLevel | Description |\n|------|------|\n| `AD_GROUP` | Target applied at the ad group level. |\n","enum":["AD_GROUP"],"type":"string"},"SBTargetMatchTypeFilter":{"properties":{"include":{"description":"**MatchType Enum:**\n| MatchType | Description |\n| --- | --- |\n| `KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES` | Search terms related to your landing pages. |\n| `PHRASE` | Phrase match search terms. This expands matching on user intent beyond EXACT. |\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_BRAND` | Search terms related to your brand. |\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |","items":{"$ref":"#/components/schemas/SBMatchType"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBTargetMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SBTargetMultiStatusSuccess"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SBTargetMultiStatusSuccess":{"properties":{"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"},"target":{"$ref":"#/components/schemas/SBTarget"}},"required":["index","target"],"type":"object"},"SBTargetNegativeFilter":{"properties":{"include":{"items":{"type":"boolean"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBTargetStateFilter":{"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/SBState"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBTargetSuccessResponse":{"properties":{"nextToken":{"type":"string"},"targets":{"items":{"$ref":"#/components/schemas/SBTarget"},"maxItems":5000,"minItems":0,"type":"array"}},"type":"object"},"SBTargetTargetIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBTargetTargetTypeFilter":{"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| `THEME` | Target based on a keyword theme. These were formerly known as Auto Targets for Sponsored Products. |","items":{"$ref":"#/components/schemas/SBTargetType"},"maxItems":4,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SBTargetType":{"description":"**TargetType Enum:**\n\n| TargetType | Description |\n|------|------|\n| `KEYWORD` | Target based on customer search terms. |\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","PRODUCT","PRODUCT_CATEGORY","THEME"],"type":"string"},"SBTargetUpdate":{"properties":{"bid":{"$ref":"#/components/schemas/SBUpdateTargetBid"},"state":{"$ref":"#/components/schemas/SBUpdateState"},"targetId":{"description":"A unique identifier for the target.","type":"string"}},"required":["targetId"],"type":"object"},"SBThemeMatchType":{"description":"**ThemeMatchType Enum:**\n\n| ThemeMatchType | Description |\n|------|------|\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES` | Search terms related to your landing pages. |\n","enum":["KEYWORDS_RELATED_TO_YOUR_BRAND","KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES"],"type":"string"},"SBThemeTarget":{"description":"Theme targets let advertisers select high-performing targets based on a common theme.","properties":{"matchType":{"$ref":"#/components/schemas/SBThemeMatchType"}},"required":["matchType"],"type":"object"},"SBUpdateAdExtensionRequest":{"properties":{"adExtensions":{"items":{"$ref":"#/components/schemas/SBAdExtensionUpdate"},"maxItems":50,"minItems":1,"type":"array"}},"required":["adExtensions"],"type":"object"},"SBUpdateAdGroupRequest":{"properties":{"adGroups":{"items":{"$ref":"#/components/schemas/SBAdGroupUpdate"},"maxItems":10,"minItems":1,"type":"array"}},"required":["adGroups"],"type":"object"},"SBUpdateAdRequest":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/SBAdUpdate"},"maxItems":10,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"},"SBUpdateAdvertisingDealPrice":{"properties":{"priceType":{"$ref":"#/components/schemas/SBAdvertisingDealPriceType"},"value":{"description":"The monetary amount of the price in the given currency.","format":"double","type":"number"}},"type":"object"},"SBUpdateAdvertisingDealRequest":{"properties":{"advertisingDeals":{"items":{"$ref":"#/components/schemas/SBAdvertisingDealUpdate"},"maxItems":10,"minItems":1,"type":"array"}},"type":"object"},"SBUpdateAutoCollectionSettings":{"description":"Settings for automatically generated collections.","properties":{"productExclusions":{"description":"Products to exclude from auto collection.","items":{"$ref":"#/components/schemas/SBCreateAdvertisedProducts"},"maxItems":1000,"minItems":0,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/SBUpdateSharedCollectionSettings"}},"type":"object"},"SBUpdateBidAdjustments":{"properties":{"audienceBidAdjustments":{"description":"Bid Adjustments based on the audiences","items":{"$ref":"#/components/schemas/SBCreateAudienceBidAdjustment"},"maxItems":1,"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/SBCreatePlacementBidAdjustment"},"maxItems":4,"minItems":0,"type":"array"},"shopperSegmentBidAdjustments":{"description":"Legacy SB field (marked for deprecation)","items":{"$ref":"#/components/schemas/SBCreateShopperSegmentBidAdjustment"},"maxItems":2,"minItems":0,"type":"array"}},"type":"object"},"SBUpdateBidSettings":{"properties":{"bidAdjustments":{"$ref":"#/components/schemas/SBUpdateBidAdjustments"},"bidStrategy":{"$ref":"#/components/schemas/SBBidStrategy"}},"type":"object"},"SBUpdateBrandGallerySettings":{"description":"An ad creative that showcases a brand and its categories and collections.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/SBCreateImage"},"maxItems":1,"minItems":1,"type":"array"},"cards":{"description":"The sub-elements of the creative. Each card highlights a different category associated to a brand.","items":{"$ref":"#/components/schemas/SBCreateBrandGalleryCardCreativeElement"},"maxItems":5,"minItems":3,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/SBBrandGalleryCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"customImages":{"description":"The custom images featured in the ad.","items":{"$ref":"#/components/schemas/SBCreateImage"},"maxItems":1,"minItems":1,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/SBUpdateStoreSpotlightLandingPage"}},"type":"object"},"SBUpdateCampaignOptimizations":{"properties":{"bidSettings":{"$ref":"#/components/schemas/SBUpdateBidSettings"}},"type":"object"},"SBUpdateCampaignRequest":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/SBCampaignUpdate"},"maxItems":10,"minItems":1,"type":"array"}},"required":["campaigns"],"type":"object"},"SBUpdateCollectionLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/SBCollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page.","type":"string"}},"type":"object"},"SBUpdateComponentCreative":{"properties":{"autoCollectionSettings":{"$ref":"#/components/schemas/SBUpdateAutoCollectionSettings"},"brandGallerySettings":{"$ref":"#/components/schemas/SBUpdateBrandGallerySettings"},"manualCollectionSettings":{"$ref":"#/components/schemas/SBUpdateManualCollectionSettings"},"productCollectionSettings":{"$ref":"#/components/schemas/SBUpdateProductCollectionSettings"},"productVideoSettings":{"$ref":"#/components/schemas/SBUpdateProductVideoSettings"},"storeSpotlightSettings":{"$ref":"#/components/schemas/SBUpdateStoreSpotlightSettings"}},"type":"object"},"SBUpdateCreative":{"oneOf":[{"properties":{"componentCreative":{"$ref":"#/components/schemas/SBUpdateComponentCreative"}},"required":["componentCreative"],"title":"componentCreative","type":"object"}]},"SBUpdateImage":{"properties":{"assetId":{"description":"The asset library ID associated with the image asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the image asset.","type":"string"},"formatProperties":{"description":"The cropping and positioning properties associated with the asset.","items":{"$ref":"#/components/schemas/SBCreateFormatProperties"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"SBUpdateLandingPageAsins":{"properties":{"asins":{"description":"For landing page of type ASIN_LIST, the list of ASINs used to create the landing page.","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"SBUpdateManualCollectionSettings":{"description":"Settings for manually curated collections.","properties":{"landingPage":{"$ref":"#/components/schemas/SBUpdateCollectionLandingPage"},"productInclusions":{"description":"The products featured in the ad. Required for manual collections.","items":{"$ref":"#/components/schemas/SBCreateAdvertisedProducts"},"maxItems":10,"minItems":3,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/SBUpdateSharedCollectionSettings"}},"type":"object"},"SBUpdateProductCollectionLandingPage":{"properties":{"landingPageAsins":{"$ref":"#/components/schemas/SBUpdateLandingPageAsins"},"landingPageType":{"$ref":"#/components/schemas/SBProductCollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page. Read only if landingPageType is ASIN_LIST","type":"string"}},"type":"object"},"SBUpdateProductCollectionSettings":{"description":"An ad creative that contains multiple products and a custom image.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/SBCreateImage"},"maxItems":2,"minItems":1,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/SBProductCollectionCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"customImages":{"description":"The set of custom images featured in the ad.","items":{"$ref":"#/components/schemas/SBCreateImage"},"maxItems":5,"minItems":1,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/SBUpdateProductCollectionLandingPage"},"products":{"description":"The products featured in the ad.","items":{"$ref":"#/components/schemas/SBCreateAdvertisedProducts"},"maxItems":3,"minItems":0,"type":"array"}},"type":"object"},"SBUpdateProductVideoSettings":{"description":"An ad with a creative that includes a video.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/SBCreateImage"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/SBUpdateVideoLandingPage"},"products":{"description":"The products featured in the video ad.","items":{"$ref":"#/components/schemas/SBCreateAdvertisedProducts"},"maxItems":3,"minItems":0,"type":"array"},"videos":{"description":"The video assets used in the ad.","items":{"$ref":"#/components/schemas/SBCreateVideo"},"maxItems":1,"minItems":1,"type":"array"}},"type":"object"},"SBUpdateSharedCollectionSettings":{"description":"Settings shared by all collection types.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"$ref":"#/components/schemas/SBUpdateImage"}},"type":"object"},"SBUpdateState":{"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"},"SBUpdateStoreSpotlightLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/SBStoreSpotlightLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"type":"object"},"SBUpdateStoreSpotlightSettings":{"description":"An ad creative that contains ASINs within a brand Store.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/SBCreateImage"},"maxItems":1,"minItems":1,"type":"array"},"cards":{"description":"The sub-elements of the creative. Each card highlights a different ASIN associated to a brand Store.","items":{"$ref":"#/components/schemas/SBCreateCardCreativeElement"},"maxItems":3,"minItems":3,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/SBStoreSpotlightCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/SBUpdateStoreSpotlightLandingPage"}},"type":"object"},"SBUpdateTargetBid":{"properties":{"bid":{"description":"The maximum bid for a target.","format":"double","type":"number"}},"type":"object"},"SBUpdateTargetRequest":{"properties":{"targets":{"items":{"$ref":"#/components/schemas/SBTargetUpdate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["targets"],"type":"object"},"SBUpdateVideoLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/SBVideoLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"type":"object"},"SBVideo":{"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"}},"required":["assetId","assetVersion"],"type":"object"},"SBVideoLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/SBVideoLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType"],"type":"object"},"SBVideoLandingPageType":{"description":"**VideoLandingPageType Enum:**\n\n| VideoLandingPageType | Description |\n|------|------|\n| `DETAIL_PAGE` | A product detail page. |\n| `STORE` | A brand Store landing page. |\n","enum":["DETAIL_PAGE","STORE"],"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 SB 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":"SBCreateAdExtension","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBCreateAdExtensionRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBAdExtensionMultiStatusResponse"}}},"description":"SBCreateAdExtension 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":"SBCreateAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBCreateAdGroupRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBAdGroupMultiStatusResponse"}}},"description":"SBCreateAdGroup 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":"SBCreateAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBCreateAdRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBAdMultiStatusResponse"}}},"description":"SBCreateAd 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/advertisingDealTargets/sb":{"post":{"description":"Create advertisingDealTarget\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"advertiser_campaign_view\"]","operationId":"SBCreateAdvertisingDealTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBCreateAdvertisingDealTargetRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBAdvertisingDealTargetMultiStatusResponse"}}},"description":"SBCreateAdvertisingDealTarget 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":["AdvertisingDealTargets"]}},"/adsApi/v1/create/advertisingDeals/sb":{"post":{"description":"Create advertisingDeal\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"advertiser_campaign_view\"]","operationId":"SBCreateAdvertisingDeal","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBCreateAdvertisingDealRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBAdvertisingDealMultiStatusResponse"}}},"description":"SBCreateAdvertisingDeal 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":["AdvertisingDeals"]}},"/adsApi/v1/create/brandedKeywordsPricings/sb":{"post":{"description":"Create brandedKeywords pricing\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"advertiser_campaign_view\"]","operationId":"SBCreateBrandedKeywordsPricing","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBCreateBrandedKeywordsPricingRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBBrandedKeywordsPricingMultiStatusResponse"}}},"description":"SBCreateBrandedKeywordsPricing 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":["BrandedKeywordsPricings"]}},"/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":"SBCreateCampaign","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBCreateCampaignRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBCampaignMultiStatusResponse"}}},"description":"SBCreateCampaign 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/keywordReservationValidations/sb":{"post":{"description":"Validate keyword reservation\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"advertiser_campaign_view\"]","operationId":"SBCreateKeywordReservationValidation","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBCreateKeywordReservationValidationRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBKeywordReservationValidationMultiStatusResponse"}}},"description":"SBCreateKeywordReservationValidation 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":["KeywordReservationValidations"]}},"/adsApi/v1/create/recommendations/sb":{"post":{"description":"Create recommendations\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_view\"]","operationId":"SBCreateRecommendation","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBCreateRecommendationRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBRecommendationMultiStatusResponse"}}},"description":"SBCreateRecommendation 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":["Recommendations"]}},"/adsApi/v1/create/reservedTargetPricings/sb":{"post":{"description":"Create reservedTarget pricing\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"advertiser_campaign_view\"]","operationId":"SBAdsApiv1CreateReservedTargetPricing","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBCreateReservedTargetPricingRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBReservedTargetPricingMultiStatusResponse"}}},"description":"SBAdsApiv1CreateReservedTargetPricing 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":["ReservedTargetPricings"]}},"/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":"SBCreateTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBCreateTargetRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBTargetMultiStatusResponse"}}},"description":"SBCreateTarget 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":"SBDeleteAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBDeleteAdGroupRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBAdGroupMultiStatusResponse"}}},"description":"SBDeleteAdGroup 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":"SBDeleteAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBDeleteAdRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBAdMultiStatusResponse"}}},"description":"SBDeleteAd 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/advertisingDealTargets/sb":{"post":{"description":"Delete advertisingDealTarget\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"advertiser_campaign_view\"]","operationId":"SBDeleteAdvertisingDealTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBDeleteAdvertisingDealTargetRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBAdvertisingDealTargetMultiStatusResponse"}}},"description":"SBDeleteAdvertisingDealTarget 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":["AdvertisingDealTargets"]}},"/adsApi/v1/delete/advertisingDeals/sb":{"post":{"description":"Delete advertisingDeal\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"advertiser_campaign_view\"]","operationId":"SBDeleteAdvertisingDeal","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBDeleteAdvertisingDealRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBAdvertisingDealMultiStatusResponse"}}},"description":"SBDeleteAdvertisingDeal 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":["AdvertisingDeals"]}},"/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":"SBDeleteCampaign","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBDeleteCampaignRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBCampaignMultiStatusResponse"}}},"description":"SBDeleteCampaign 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":"SBDeleteTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBDeleteTargetRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBTargetMultiStatusResponse"}}},"description":"SBDeleteTarget 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":"SBQueryAdExtension","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBQueryAdExtensionRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBAdExtensionSuccessResponse"}}},"description":"SBQueryAdExtension 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":"SBQueryAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBQueryAdGroupRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBAdGroupSuccessResponse"}}},"description":"SBQueryAdGroup 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":"SBQueryAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBQueryAdRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBAdSuccessResponse"}}},"description":"SBQueryAd 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/advertisingDealTargets/sb":{"post":{"description":"Query advertisingDealTarget\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"advertiser_campaign_view\"]","operationId":"SBQueryAdvertisingDealTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBQueryAdvertisingDealTargetRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBAdvertisingDealTargetSuccessResponse"}}},"description":"SBQueryAdvertisingDealTarget 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":["AdvertisingDealTargets"]}},"/adsApi/v1/query/advertisingDeals/sb":{"post":{"description":"Query advertisingDeal\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"advertiser_campaign_view\"]","operationId":"SBQueryAdvertisingDeal","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBQueryAdvertisingDealRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBAdvertisingDealSuccessResponse"}}},"description":"SBQueryAdvertisingDeal 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":["AdvertisingDeals"]}},"/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":"SBQueryCampaign","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBQueryCampaignRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBCampaignSuccessResponse"}}},"description":"SBQueryCampaign 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/recommendationTypes/sb":{"post":{"description":"Query RecommendationTypes\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_view\"]","operationId":"SBQueryRecommendationType","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBQueryRecommendationTypeRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBRecommendationTypeSuccessResponse"}}},"description":"SBQueryRecommendationType 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":["RecommendationTypes"]}},"/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":"SBQueryTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBQueryTargetRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBTargetSuccessResponse"}}},"description":"SBQueryTarget 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":"SBUpdateAdExtension","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBUpdateAdExtensionRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBAdExtensionMultiStatusResponse"}}},"description":"SBUpdateAdExtension 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":"SBUpdateAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBUpdateAdGroupRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBAdGroupMultiStatusResponse"}}},"description":"SBUpdateAdGroup 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":"SBUpdateAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBUpdateAdRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBAdMultiStatusResponse"}}},"description":"SBUpdateAd 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/advertisingDeals/sb":{"post":{"description":"Update advertisingDeal\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"advertiser_campaign_view\"]","operationId":"SBUpdateAdvertisingDeal","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBUpdateAdvertisingDealRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBAdvertisingDealMultiStatusResponse"}}},"description":"SBUpdateAdvertisingDeal 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":["AdvertisingDeals"]}},"/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":"SBUpdateCampaign","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBUpdateCampaignRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBCampaignMultiStatusResponse"}}},"description":"SBUpdateCampaign 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":"SBUpdateTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBUpdateTargetRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBTargetMultiStatusResponse"}}},"description":"SBUpdateTarget 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"}]}