{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"AccountIdHeader":{"description":"The identifier of an Amazon Ads Advertiser Account.","in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"type":"string"}},"AccountIdHeaderOptional":{"description":"The identifier of an Amazon Ads Advertiser Account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"type":"string"}},"BrandStoreIdQuery":{"in":"query","name":"brandStoreId","required":true,"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"}},"ManagerAccountIdHeaderOptional":{"description":"The identifier of an Amazon Ads Manager Account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"type":"string"}},"MaxResultsQuery":{"in":"query","name":"maxResults","schema":{"default":50,"format":"int32","maximum":50,"minimum":11,"type":"integer"}},"NextTokenQuery":{"in":"query","name":"nextToken","schema":{"type":"string"}},"ScopeHeader":{"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","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":{"AcrossGroupOperator":{"description":"| AcrossGroupOperator | Description |\n|------|------|\n| `ALL` |  |\n| `ANY` |  |\n","enum":["ALL","ANY"],"type":"string"},"Ad":{"properties":{"activeCreative":{"$ref":"#/components/schemas/Creative"},"adGroupId":{"description":"The ad group associated with the ad.","type":"string"},"adId":{"description":"The identifier of the ad.","type":"string"},"adProduct":{"$ref":"#/components/schemas/AdProduct"},"adType":{"$ref":"#/components/schemas/AdType"},"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/Creative"},"globalAdId":{"description":"The global ad identifier that manages this marketplace ad.","type":"string"},"lastUpdatedDateTime":{"description":"The date time that the ad was last updated.","format":"date-time","type":"string"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global ad that enables overriding certain attributes at individual marketplace level. For example, if a global ad is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the ad\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/MarketplaceAdConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"The list of country codes representing amazon marketplaces in which the global ad is applicable. The marketplaces included should either be same as or subset of parent ad group","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the ad.","type":"string"},"state":{"$ref":"#/components/schemas/State"},"status":{"$ref":"#/components/schemas/Status"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/Tag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adId","adProduct","adType","creationDateTime","creative","lastUpdatedDateTime","state"],"type":"object"},"AdAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdAdIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdAdProductFilter":{"properties":{"include":{"description":"| AdProduct | Description |\n| --- | --- |\n| `SPONSORED_PRODUCTS` | Sponsored Products ad product. |\n| `SPONSORED_BRANDS` | Sponsored Brands ad product. |\n| `SPONSORED_DISPLAY` | Sponsored Display ad product. |\n| `SPONSORED_TELEVISION` | Sponsored Television ad product. |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","items":{"$ref":"#/components/schemas/AdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdAssociation":{"properties":{"adAssociationId":{"description":"The unique identifier of the ad association.","type":"string"},"adGroupId":{"description":"The ad group associated with the ad.","type":"string"},"adId":{"description":"The ad Id  associated with the ad.","type":"string"},"endDateTime":{"description":"The end date time for the ad association.","format":"date-time","type":"string"},"startDateTime":{"description":"The start date time for the ad association.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/State"},"weight":{"description":"The relative percentage of traffic which would be directed to the associated Ad Creative in the Ad Group.","format":"int32","type":"integer"}},"required":["adAssociationId","adGroupId","adId","state"],"type":"object"},"AdAssociationAdAssociationIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdAssociationAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdAssociationAdIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdAssociationCreate":{"properties":{"adGroupId":{"description":"The ad group associated with the ad.","type":"string"},"adId":{"description":"The ad Id  associated with the ad.","type":"string"},"endDateTime":{"description":"The end date time for the ad association.","format":"date-time","type":"string"},"startDateTime":{"description":"The start date time for the ad association.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/CreateState"},"weight":{"description":"The relative percentage of traffic which would be directed to the associated Ad Creative in the Ad Group.","format":"int32","type":"integer"}},"required":["adGroupId","adId","state"],"type":"object"},"AdAssociationMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":20,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/AdAssociationMultiStatusSuccess"},"maxItems":20,"minItems":0,"type":"array"}},"type":"object"},"AdAssociationMultiStatusSuccess":{"properties":{"adAssociation":{"$ref":"#/components/schemas/AdAssociation"},"index":{"format":"int32","maximum":19,"minimum":0,"type":"integer"}},"required":["adAssociation","index"],"type":"object"},"AdAssociationSuccessResponse":{"properties":{"adAssociations":{"items":{"$ref":"#/components/schemas/AdAssociation"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"AdAssociationUpdate":{"properties":{"adAssociationId":{"description":"The unique identifier of the ad association.","type":"string"},"endDateTime":{"description":"The end date time for the ad association.","format":"date-time","type":"string"},"startDateTime":{"description":"The start date time for the ad association.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/UpdateState"},"weight":{"description":"The relative percentage of traffic which would be directed to the associated Ad Creative in the Ad Group.","format":"int32","type":"integer"}},"required":["adAssociationId"],"type":"object"},"AdCampaignIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdChoicesPosition":{"description":"| AdChoicesPosition | Description |\n|------|------|\n| `BOTTOM_LEFT` |  |\n| `BOTTOM_RIGHT` |  |\n| `TOP_LEFT` |  |\n| `TOP_RIGHT` |  |\n","enum":["BOTTOM_LEFT","BOTTOM_RIGHT","TOP_LEFT","TOP_RIGHT"],"type":"string"},"AdCreate":{"properties":{"adGroupId":{"description":"The ad group associated with the ad.","type":"string"},"adProduct":{"$ref":"#/components/schemas/AdProduct"},"adType":{"$ref":"#/components/schemas/AdType"},"creative":{"$ref":"#/components/schemas/CreateCreative"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global ad that enables overriding certain attributes at individual marketplace level. For example, if a global ad is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the ad\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/CreateMarketplaceAdConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"The list of country codes representing amazon marketplaces in which the global ad is applicable. The marketplaces included should either be same as or subset of parent ad group","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the ad.","type":"string"},"state":{"$ref":"#/components/schemas/CreateState"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adProduct","adType","creative","state"],"type":"object"},"AdExtension":{"properties":{"adExtensionId":{"description":"A unique identifier for the ad_extension.","type":"string"},"adExtensionSettings":{"$ref":"#/components/schemas/AdExtensionSettings"},"adExtensionStatus":{"$ref":"#/components/schemas/AdExtensionStatus"},"adExtensionType":{"$ref":"#/components/schemas/AdExtensionType"},"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/AdProduct"},"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/MarketplaceScope"},"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/Marketplace"},"maxItems":30,"minItems":1,"type":"array"},"state":{"$ref":"#/components/schemas/State"},"status":{"$ref":"#/components/schemas/Status"}},"required":["adExtensionId","adExtensionSettings","adExtensionType","adProduct","creationDateTime","lastUpdatedDateTime","marketplaceScope","marketplaces","state"],"type":"object"},"AdExtensionAdExtensionIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdExtensionAdExtensionStatusFilter":{"properties":{"include":{"description":"| AdExtensionStatus | Description |\n| --- | --- |\n| `OPTED_OUT` | If the advertiser has opted out of this Ad Extension. |","items":{"$ref":"#/components/schemas/AdExtensionStatus"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdExtensionAdExtensionTypeFilter":{"properties":{"include":{"description":"| AdExtensionType | Description |\n| --- | --- |\n| `PROMPTS` | Enables Prompt based Ad Extension. |\n| `VIDEO` | Enables Video based Ad Extension. |","items":{"$ref":"#/components/schemas/AdExtensionType"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdExtensionAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdExtensionAdIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdExtensionAdProductFilter":{"properties":{"include":{"description":"| AdProduct | Description |\n| --- | --- |\n| `SPONSORED_PRODUCTS` | Sponsored Products ad product. |\n| `SPONSORED_BRANDS` | Sponsored Brands ad product. |\n| `SPONSORED_DISPLAY` | Sponsored Display ad product. |\n| `SPONSORED_TELEVISION` | Sponsored Television ad product. |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","items":{"$ref":"#/components/schemas/AdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdExtensionCreate":{"properties":{"adExtensionSettings":{"$ref":"#/components/schemas/CreateAdExtensionSettings"},"adExtensionStatus":{"$ref":"#/components/schemas/AdExtensionStatus"},"adExtensionType":{"$ref":"#/components/schemas/AdExtensionType"},"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/AdProduct"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"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/Marketplace"},"maxItems":30,"minItems":1,"type":"array"},"state":{"$ref":"#/components/schemas/CreateState"}},"required":["adExtensionSettings","adExtensionType","adProduct","marketplaceScope","marketplaces","state"],"type":"object"},"AdExtensionMultiStatusResponseWithPartialErrors":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":50,"minItems":0,"type":"array"},"partialSuccess":{"items":{"$ref":"#/components/schemas/AdExtensionPartialIndex"},"maxItems":50,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/AdExtensionMultiStatusSuccess"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"AdExtensionMultiStatusSuccess":{"properties":{"adExtension":{"$ref":"#/components/schemas/AdExtension"},"index":{"format":"int32","maximum":49,"minimum":0,"type":"integer"}},"required":["adExtension","index"],"type":"object"},"AdExtensionPartialIndex":{"properties":{"adExtension":{"$ref":"#/components/schemas/AdExtension"},"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":49,"minimum":0,"type":"integer"}},"required":["adExtension","errors","index"],"type":"object"},"AdExtensionSettings":{"oneOf":[{"properties":{"promptExtension":{"$ref":"#/components/schemas/PromptExtension"}},"required":["promptExtension"],"title":"promptExtension","type":"object"},{"properties":{"videoExtension":{"$ref":"#/components/schemas/VideoExtension"}},"required":["videoExtension"],"title":"videoExtension","type":"object"}]},"AdExtensionStateFilter":{"properties":{"include":{"description":"| 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/State"},"maxItems":2,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdExtensionStatus":{"description":"Ad Extension Status.\n\n| AdExtensionStatus | Description |\n|------|------|\n| `OPTED_OUT` | If the advertiser has opted out of this Ad Extension. |\n","enum":["OPTED_OUT"],"type":"string"},"AdExtensionSuccessResponse":{"properties":{"adExtensions":{"items":{"$ref":"#/components/schemas/AdExtension"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"AdExtensionType":{"description":"Ad Extension Type.\n\n| AdExtensionType | Description |\n|------|------|\n| `PROMPTS` | Enables Prompt based Ad Extension. |\n| `VIDEO` | Enables Video based Ad Extension. |\n","enum":["PROMPTS","VIDEO"],"type":"string"},"AdExtensionUpdate":{"properties":{"adExtensionId":{"description":"A unique identifier for the ad_extension.","type":"string"},"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/Marketplace"},"maxItems":30,"minItems":1,"type":"array"},"state":{"$ref":"#/components/schemas/UpdateState"}},"required":["adExtensionId"],"type":"object"},"AdGroup":{"properties":{"adGroupId":{"description":"The unique identifier of the ad group.","type":"string"},"adProduct":{"$ref":"#/components/schemas/AdProduct"},"advertisedProductCategoryIds":{"description":"The array of identifiers of product categories associated with the ad group. For VIDEO ad group type only one parent product category or multiple sub-categories from one parent product category are allowed.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"bid":{"$ref":"#/components/schemas/AdGroupBid"},"budgets":{"description":"An object containing budget details for the ad group.","items":{"$ref":"#/components/schemas/Budget"},"maxItems":3,"minItems":0,"type":"array"},"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"},"creativeRotationType":{"$ref":"#/components/schemas/CreativeRotationType"},"creativeType":{"$ref":"#/components/schemas/CreativeType"},"endDateTime":{"description":"The end date time for the ad group.","format":"date-time","type":"string"},"fees":{"description":"The fees associated with the ad group.","items":{"$ref":"#/components/schemas/Fee"},"maxItems":7,"minItems":0,"type":"array"},"frequencies":{"description":"An object containing frequency details for the ad group.","items":{"$ref":"#/components/schemas/Frequency"},"maxItems":3,"minItems":0,"type":"array"},"globalAdGroupId":{"description":"The global adGroup identifier that manages this marketplace adGroup.","type":"string"},"inventoryType":{"$ref":"#/components/schemas/InventoryType"},"lastUpdatedDateTime":{"description":"The date time that the ad group was last updated.","format":"date-time","type":"string"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global ad group that enables overriding certain attributes at individual marketplace level. For example, if a global ad group state is ENABLED and needs to be PAUSED only in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, ad group\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/MarketplaceAdGroupConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"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/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the ad group.","type":"string"},"optimization":{"$ref":"#/components/schemas/Optimization"},"pacing":{"$ref":"#/components/schemas/Pacing"},"purchaseOrderNumber":{"description":"The purchase order number associated with the ad group.","type":"string"},"startDateTime":{"description":"The start date time for the ad group.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/State"},"status":{"$ref":"#/components/schemas/Status"},"tags":{"description":"Open ended labels with a key value pair applied to the ad group","items":{"$ref":"#/components/schemas/Tag"},"maxItems":50,"minItems":0,"type":"array"},"targetingSettings":{"$ref":"#/components/schemas/TargetingSettings"}},"required":["adGroupId","adProduct","campaignId","creationDateTime","lastUpdatedDateTime","name","state"],"type":"object"},"AdGroupAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdGroupAdProductFilter":{"properties":{"include":{"description":"| AdProduct | Description |\n| --- | --- |\n| `SPONSORED_PRODUCTS` | Sponsored Products ad product. |\n| `SPONSORED_BRANDS` | Sponsored Brands ad product. |\n| `SPONSORED_DISPLAY` | Sponsored Display ad product. |\n| `SPONSORED_TELEVISION` | Sponsored Television ad product. |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","items":{"$ref":"#/components/schemas/AdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdGroupBid":{"properties":{"baseBid":{"description":"The lower bound bid used for the ads in the ad group.","format":"double","type":"number"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"defaultBid":{"description":"The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction.","format":"double","type":"number"},"marketplaceSettings":{"description":"The bid associated with the ad group at specified marketplace level. Either one of bid or marketplaceSettings should always be specified","items":{"$ref":"#/components/schemas/AdGroupBidMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"maxAverageBid":{"description":"The max average bid that will be targeted on the ad group across all of the bids (a single bid could be lower or higher that this number).","format":"double","type":"number"}},"type":"object"},"AdGroupBidMarketplaceSetting":{"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"defaultBid":{"description":"The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction.","format":"double","type":"number"},"marketplace":{"$ref":"#/components/schemas/Marketplace"}},"required":["currencyCode","marketplace"],"type":"object"},"AdGroupBudgetSettings":{"properties":{"budgetAllocation":{"$ref":"#/components/schemas/BudgetAllocation"},"dailyMinSpendValue":{"description":"Denotes the daily minimum spend on the ad group in local currency.","format":"double","type":"number"}},"type":"object"},"AdGroupCampaignIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdGroupCreate":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"advertisedProductCategoryIds":{"description":"The array of identifiers of product categories associated with the ad group. For VIDEO ad group type only one parent product category or multiple sub-categories from one parent product category are allowed.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"bid":{"$ref":"#/components/schemas/CreateAdGroupBid"},"budgets":{"description":"An object containing budget details for the ad group.","items":{"$ref":"#/components/schemas/CreateBudget"},"maxItems":3,"minItems":0,"type":"array"},"campaignId":{"description":"The unique identifier of the campaign the ad group belongs to.","type":"string"},"creativeRotationType":{"$ref":"#/components/schemas/CreativeRotationType"},"creativeType":{"$ref":"#/components/schemas/CreativeType"},"endDateTime":{"description":"The end date time for the ad group.","format":"date-time","type":"string"},"fees":{"description":"The fees associated with the ad group.","items":{"$ref":"#/components/schemas/CreateFee"},"maxItems":7,"minItems":0,"type":"array"},"frequencies":{"description":"An object containing frequency details for the ad group.","items":{"$ref":"#/components/schemas/CreateFrequency"},"maxItems":3,"minItems":0,"type":"array"},"inventoryType":{"$ref":"#/components/schemas/InventoryType"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global ad group that enables overriding certain attributes at individual marketplace level. For example, if a global ad group state is ENABLED and needs to be PAUSED only in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, ad group\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/CreateMarketplaceAdGroupConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"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/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the ad group.","type":"string"},"optimization":{"$ref":"#/components/schemas/CreateOptimization"},"pacing":{"$ref":"#/components/schemas/CreatePacing"},"purchaseOrderNumber":{"description":"The purchase order number associated with the ad group.","type":"string"},"startDateTime":{"description":"The start date time for the ad group.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/CreateState"},"tags":{"description":"Open ended labels with a key value pair applied to the ad group","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"},"targetingSettings":{"$ref":"#/components/schemas/CreateTargetingSettings"}},"required":["adProduct","campaignId","name","state"],"type":"object"},"AdGroupGoalSettings":{"properties":{"kpi":{"$ref":"#/components/schemas/KPI"}},"type":"object"},"AdGroupMarketplaceScopeFilter":{"properties":{"include":{"description":"| MarketplaceScope | Description |\n| --- | --- |\n| `GLOBAL` |  |\n| `SINGLE_MARKETPLACE` |  |","items":{"$ref":"#/components/schemas/MarketplaceScope"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdGroupMultiStatusResponseWithPartialErrors":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1000,"minItems":0,"type":"array"},"partialSuccess":{"items":{"$ref":"#/components/schemas/AdGroupPartialIndex"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/AdGroupMultiStatusSuccess"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"AdGroupMultiStatusSuccess":{"properties":{"adGroup":{"$ref":"#/components/schemas/AdGroup"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"}},"required":["adGroup","index"],"type":"object"},"AdGroupNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/AdGroupNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"AdGroupNameFilterType":{"description":"| AdGroupNameFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"AdGroupPartialIndex":{"properties":{"adGroup":{"$ref":"#/components/schemas/AdGroup"},"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"}},"required":["adGroup","errors","index"],"type":"object"},"AdGroupStateFilter":{"properties":{"include":{"description":"| 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/State"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdGroupSuccessResponse":{"properties":{"adGroups":{"items":{"$ref":"#/components/schemas/AdGroup"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"AdGroupUpdate":{"properties":{"adGroupId":{"description":"The unique identifier of the ad group.","type":"string"},"adProduct":{"$ref":"#/components/schemas/AdProduct"},"advertisedProductCategoryIds":{"description":"The array of identifiers of product categories associated with the ad group. For VIDEO ad group type only one parent product category or multiple sub-categories from one parent product category are allowed.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"bid":{"$ref":"#/components/schemas/UpdateAdGroupBid"},"budgets":{"description":"An object containing budget details for the ad group.","items":{"$ref":"#/components/schemas/CreateBudget"},"maxItems":3,"minItems":0,"type":"array"},"creativeRotationType":{"$ref":"#/components/schemas/CreativeRotationType"},"endDateTime":{"description":"The end date time for the ad group.","format":"date-time","type":"string"},"fees":{"description":"The fees associated with the ad group.","items":{"$ref":"#/components/schemas/CreateFee"},"maxItems":7,"minItems":0,"type":"array"},"frequencies":{"description":"An object containing frequency details for the ad group.","items":{"$ref":"#/components/schemas/CreateFrequency"},"maxItems":3,"minItems":0,"type":"array"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global ad group that enables overriding certain attributes at individual marketplace level. For example, if a global ad group state is ENABLED and needs to be PAUSED only in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, ad group\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/CreateMarketplaceAdGroupConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"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/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the ad group.","type":"string"},"optimization":{"$ref":"#/components/schemas/UpdateOptimization"},"pacing":{"$ref":"#/components/schemas/UpdatePacing"},"purchaseOrderNumber":{"description":"The purchase order number associated with the ad group.","nullable":true,"type":"string"},"startDateTime":{"description":"The start date time for the ad group.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/UpdateState"},"tags":{"description":"Open ended labels with a key value pair applied to the ad group","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"},"targetingSettings":{"$ref":"#/components/schemas/UpdateTargetingSettings"}},"required":["adGroupId"],"type":"object"},"AdInitiationTarget":{"description":"Target based on how the video ad will be started.","properties":{"videoInitiationType":{"$ref":"#/components/schemas/VideoInitiationType"}},"required":["videoInitiationType"],"type":"object"},"AdMarketplaceScopeFilter":{"properties":{"include":{"description":"| MarketplaceScope | Description |\n| --- | --- |\n| `GLOBAL` |  |\n| `SINGLE_MARKETPLACE` |  |","items":{"$ref":"#/components/schemas/MarketplaceScope"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdMultiStatusResponseWithPartialErrors":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1000,"minItems":0,"type":"array"},"partialSuccess":{"items":{"$ref":"#/components/schemas/AdPartialIndex"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/AdMultiStatusSuccess"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"AdMultiStatusSuccess":{"properties":{"ad":{"$ref":"#/components/schemas/Ad"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"}},"required":["ad","index"],"type":"object"},"AdNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/AdNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"AdNameFilterType":{"description":"| AdNameFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"AdPartialIndex":{"properties":{"ad":{"$ref":"#/components/schemas/Ad"},"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"}},"required":["ad","errors","index"],"type":"object"},"AdPlayerSize":{"description":"| AdPlayerSize | Description |\n|------|------|\n| `LARGE` | Large video player. |\n| `MEDIUM` | Medium video player. |\n| `SMALL` | Small video player. |\n| `UNKNOWN` | Unknown player size. |\n","enum":["LARGE","MEDIUM","SMALL","UNKNOWN"],"type":"string"},"AdPlayerSizeTarget":{"description":"Target based on the size of the ad player.","properties":{"adPlayerSize":{"$ref":"#/components/schemas/AdPlayerSize"}},"required":["adPlayerSize"],"type":"object"},"AdProduct":{"description":"| AdProduct | Description |\n|------|------|\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |\n| `SPONSORED_BRANDS` | Sponsored Brands ad product. |\n| `SPONSORED_DISPLAY` | Sponsored Display ad product. |\n| `SPONSORED_PRODUCTS` | Sponsored Products ad product. |\n| `SPONSORED_TELEVISION` | Sponsored Television ad product. |\n","enum":["AMAZON_DSP","SPONSORED_BRANDS","SPONSORED_DISPLAY","SPONSORED_PRODUCTS","SPONSORED_TELEVISION"],"type":"string"},"AdStateFilter":{"properties":{"include":{"description":"| 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/State"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdSuccessResponse":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/Ad"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"AdType":{"description":"| AdType | Description |\n|------|------|\n| `AUDIO` | A creative that features one or more audio assets. |\n| `COMPONENT` | A creative that can features a collection of videos, images, and products. |\n| `DISPLAY` | A creative that features one or more custom images. |\n| `PRODUCT_AD` | A creative built based on a specified product. |\n| `THIRD_PARTY` | A creative that is served from a third party ad server. |\n| `VIDEO` | A creative that features one or more videos. |\n","enum":["AUDIO","COMPONENT","DISPLAY","PRODUCT_AD","THIRD_PARTY","VIDEO"],"type":"string"},"AdUpdate":{"properties":{"adId":{"description":"The identifier of the ad.","type":"string"},"creative":{"$ref":"#/components/schemas/UpdateCreative"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global ad that enables overriding certain attributes at individual marketplace level. For example, if a global ad is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the ad\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/CreateMarketplaceAdConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"The list of country codes representing amazon marketplaces in which the global ad is applicable. The marketplaces included should either be same as or subset of parent ad group","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the ad.","type":"string"},"state":{"$ref":"#/components/schemas/UpdateState"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adId"],"type":"object"},"AdvertisedProductMarketplaceSetting":{"properties":{"globalStoreSetting":{"$ref":"#/components/schemas/GlobalStoreSettings"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"productId":{"description":"The identifier of the product advertised.","type":"string"},"resolvedProductId":{"description":"The identifier of product associated with the advertised product. It\u0027s a read-only field.","type":"string"}},"required":["marketplace","productId"],"type":"object"},"AdvertisedProducts":{"properties":{"globalStoreSetting":{"$ref":"#/components/schemas/GlobalStoreSettings"},"marketplaceSettings":{"description":"List of advertised product selectively applied at the given marketplace level","items":{"$ref":"#/components/schemas/AdvertisedProductMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"productId":{"description":"The identifier of the advertised product.","type":"string"},"productIdType":{"$ref":"#/components/schemas/ProductIdType"},"resolvedProductId":{"description":"The identifier of product associated with the advertised product. It\u0027s a read-only field.","type":"string"},"resolvedProductIdType":{"$ref":"#/components/schemas/ProductIdType"}},"required":["productIdType"],"type":"object"},"AdvertiserDomainList":{"description":"Targets domains based on list inherited from the advertiser.","properties":{"inheritFromAdvertiser":{"description":"Set to TRUE to inherit domain list from advertiser.","type":"boolean"}},"required":["inheritFromAdvertiser"],"type":"object"},"AmazonViewability":{"properties":{"includeUnmeasurableImpressions":{"description":"Must be false if viewabilityTier is set to ALL_TIERS. You can set to true to include impressions that can not be measured when a viewabilityTier other than ALL_TIERS is selected. We recommend setting to false if high viewability is your goal.","type":"boolean"},"viewabilityTier":{"$ref":"#/components/schemas/ViewabilityTier"}},"required":["includeUnmeasurableImpressions","viewabilityTier"],"type":"object"},"AppTarget":{"description":"Target based on user application.","properties":{"appId":{"description":"The app identifier being targeted.","type":"string"},"appType":{"$ref":"#/components/schemas/AppType"}},"required":["appId","appType"],"type":"object"},"AppType":{"description":"| AppType | Description |\n|------|------|\n| `MOBILE` | Mobile application. |\n| `STREAMING_TV` | Streaming TV application. |\n","enum":["MOBILE","STREAMING_TV"],"type":"string"},"AssetBasedCreativeCallToAction":{"oneOf":[{"properties":{"assetBasedCreativeCallToActionSettings":{"$ref":"#/components/schemas/AssetBasedCreativeCallToActionSettings"}},"required":["assetBasedCreativeCallToActionSettings"],"title":"assetBasedCreativeCallToActionSettings","type":"object"}]},"AssetBasedCreativeCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for AssetBasedCreative.","items":{"$ref":"#/components/schemas/AssetBasedCreativeCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["url"],"type":"object"},"AssetBasedCreativeCallToActionType":{"description":"| AssetBasedCreativeCallToActionType | Description |\n|------|------|\n| `BOOK_NOW` |  |\n| `BUY_NOW` |  |\n| `DISCOVER_MORE` |  |\n| `DOWNLOAD_NOW` |  |\n| `EXPLORE_NOW` |  |\n| `GET_APP` |  |\n| `GET_QUOTE` |  |\n| `LEARN_MORE` |  |\n| `PRE_ORDER_NOW` |  |\n| `SEE_DETAILS` |  |\n| `SHOP_NOW` |  |\n| `SIGN_UP_NOW` |  |\n| `SUBSCRIBE_NOW` |  |\n","enum":["BOOK_NOW","BUY_NOW","DISCOVER_MORE","DOWNLOAD_NOW","EXPLORE_NOW","GET_APP","GET_QUOTE","LEARN_MORE","PRE_ORDER_NOW","SEE_DETAILS","SHOP_NOW","SIGN_UP_NOW","SUBSCRIBE_NOW"],"type":"string"},"AssetBasedCreativeSettings":{"properties":{"additionalHtml":{"description":"Additional HTML to include with the render response for display inventory targets.","type":"string"},"backgrounds":{"description":"The background which is displayed on the ad.","items":{"$ref":"#/components/schemas/Background"},"maxItems":1,"minItems":0,"type":"array"},"bodyText":{"description":"The body text to use for the Asset Based Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"brand":{"description":"The brand of the product(s) being advertised.","type":"string"},"callToActions":{"$ref":"#/components/schemas/AssetBasedCreativeCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/Size"},"maxItems":20,"minItems":0,"type":"array"},"customVideos":{"$ref":"#/components/schemas/Video"},"disclaimers":{"description":"The disclaimers to use for the Asset Based Creative experience.","type":"string"},"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"},"hasTermsAndConditions":{"description":"Indicates that the ad promotes a free product or service and has qualifying terms and conditions applicable to the customer. LandingPageURL must link out to a page detailing terms and conditions or contain a link to those.","type":"boolean"},"headlines":{"description":"The headline(s) to use for the Asset Based Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"images":{"description":"The image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":3,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/ComponentLandingPage"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"description":"The logos to use for the Asset Based Creative experience.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":0,"type":"array"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":0,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":0,"type":"array"},"untranslatedHeadlines":{"description":"The headline entered by the advertiser.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":0,"type":"array"}},"required":["headlines"],"type":"object"},"AudienceBidAdjustment":{"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"},"AudienceTarget":{"description":"Target based on a specified audience ID.","properties":{"acrossGroupOperator":{"$ref":"#/components/schemas/AcrossGroupOperator"},"audienceId":{"$ref":"#/components/schemas/MarketplaceStringValue"},"groupId":{"description":"The string identifying a group of audiences. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audiences to a new group, choose any string not currently being used on this ad group. To add audiences to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group.","type":"string"},"inGroupOperator":{"$ref":"#/components/schemas/InGroupOperator"}},"required":["audienceId"],"type":"object"},"Audio":{"properties":{"assetId":{"description":"The asset library ID associated with the audio asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the audio asset.","type":"string"}},"required":["assetId","assetVersion"],"type":"object"},"AudioCreative":{"description":"| AudioCreative | Description |\n|------|------|\n| `standardAudioSettings` | The standard audio experience settings. See the Audio Spec for more info: https://advertising.amazon.com/en-us/resources/ad-specs/audio-ads?ref_\u003da20m_us_spcs_spcs_aa |\n","oneOf":[{"properties":{"standardAudioSettings":{"$ref":"#/components/schemas/StandardAudioExperienceSettings"}},"required":["standardAudioSettings"],"title":"standardAudioSettings","type":"object"}]},"AutoCollectionSettings":{"description":"Settings for automatically generated collections.","properties":{"productExclusions":{"description":"Products to exclude from auto collection.","items":{"$ref":"#/components/schemas/AdvertisedProducts"},"maxItems":1000,"minItems":0,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/SharedCollectionSettings"}},"required":["sharedSettings"],"type":"object"},"AutoCreationSettings":{"properties":{"autoCreateTargets":{"description":"Gives Amazon permission to automatically create targets associated with the campaign based on the products being advertised.","type":"boolean"},"autoManageCampaign":{"description":"Flag that allows Amazon to manage the lifecycle of your Campaign.","type":"boolean"}},"type":"object"},"AutoScaleGlobalCampaignSetting":{"description":"| AutoScaleGlobalCampaignSetting | Description |\n|------|------|\n| `AUTO` | Auto scale global campaign to new marketplaces |\n| `MANUAL` | Manually scale global campaign to new marketplaces |\n","enum":["AUTO","MANUAL"],"type":"string"},"AutomatedTargetingTactic":{"description":"| AutomatedTargetingTactic | Description |\n|------|------|\n| `AWARENESS` | Ad Group tactic (Complete TV) that indicates that this line item drives awareness to your selected audience on publisher streaming TV for the linked deal while fulfilling your commitment. |\n| `CUSTOMER_ACQUISITION` | Ad Group Tactic (P+) that reaches shoppers who are similar to past purchasers |\n| `MAXIMIZE_PERFORMANCE` | Ad Group Tactic (P+) that reaches shoppers who are similar to past shoppers who viewed a product detail page |\n| `PROSPECTING` | Ad Group Tactic (B+) that reaches consumers who are highly likely to show interest and engage with your brand or product |\n| `REMARKETING` | Ad Group Tactic (P+) that reaches shoppers who have viewed a product detail page, searched for your product, or visited your homepage |\n| `RETENTION` | Ad Group Tactic (P+) that reaches shoppers who have purchased your product |\n| `SEARCH` | Ad Group Tactic that targets shoppers based on search signals. |\n","enum":["AWARENESS","CUSTOMER_ACQUISITION","MAXIMIZE_PERFORMANCE","PROSPECTING","REMARKETING","RETENTION","SEARCH"],"type":"string"},"AverageCompletionAndFullyViewableRateTargetingType":{"description":"The type of average completion and fully viewable rate targeting.\n\n| AverageCompletionAndFullyViewableRateTargetingType | Description |\n|------|------|\n| `ALLOW_ALL` |  |\n| `AVG_COMPLETION_FULLY_VIEWABLE_GTE_10` |  |\n| `AVG_COMPLETION_FULLY_VIEWABLE_GTE_20` |  |\n| `AVG_COMPLETION_FULLY_VIEWABLE_GTE_25` |  |\n| `AVG_COMPLETION_FULLY_VIEWABLE_GTE_30` |  |\n| `AVG_COMPLETION_FULLY_VIEWABLE_GTE_35` |  |\n| `AVG_COMPLETION_FULLY_VIEWABLE_GTE_40` |  |\n","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"],"type":"string"},"Background":{"properties":{"color":{"description":"The color hex code of the background.","type":"string"}},"type":"object"},"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"},"BidAdjustments":{"properties":{"audienceBidAdjustments":{"description":"Bid Adjustments based on the audiences","items":{"$ref":"#/components/schemas/AudienceBidAdjustment"},"maxItems":1,"minItems":0,"type":"array"},"creativeBidAdjustments":{"description":"Bid Adjustments based on ads being shown as a creative. Range of bid adjustment value would be 0:900","items":{"$ref":"#/components/schemas/CreativeBidAdjustment"},"maxItems":2,"minItems":0,"type":"array"},"placementBidAdjustments":{"description":"Bid adjustments based on ad placements.","items":{"$ref":"#/components/schemas/PlacementBidAdjustment"},"maxItems":4,"minItems":0,"type":"array"},"shopperSegmentBidAdjustments":{"description":"Legacy SB field (marked for deprecation)","items":{"$ref":"#/components/schemas/ShopperSegmentBidAdjustment"},"maxItems":2,"minItems":0,"type":"array"}},"type":"object"},"BidSettings":{"properties":{"bidAdjustments":{"$ref":"#/components/schemas/BidAdjustments"},"bidStrategy":{"$ref":"#/components/schemas/BidStrategy"}},"type":"object"},"BidStrategy":{"description":"| BidStrategy | Description |\n|------|------|\n| `MANUAL` | Uses your exact bid and any placement adjustments you set, and is not subject to dynamic bidding. |\n| `NEW_TO_BRAND` | Optimizes bidding to maximize new-to-brand customer acquisitions. |\n| `PRIORITIZE_KPI_TARGET` | Optimizes bidding to achieve the KPI target specified. |\n| `RULE_BASED` | Applies bidding rules defined by the advertiser. |\n| `SALES_DOWN_ONLY` | Decreases your bids in real time when your ad is less likely to convert to a sale. Bids will never increase beyond your set bid. |\n| `SALES_UP_AND_DOWN` | Increases or decreases your bids in real time by a maximum of 100%. With this setting bids increase when your ad is more likely to convert to a sale, and bids decrease when less likely to convert to a sale. |\n| `SPEND_BUDGET_IN_FULL` | Prioritize spending full budget, while maximizing performance |\n| `USE_CAMPAIGN_STRATEGY` | Inherit the bid strategy from the parent campaign. |\n","enum":["MANUAL","NEW_TO_BRAND","PRIORITIZE_KPI_TARGET","RULE_BASED","SALES_DOWN_ONLY","SALES_UP_AND_DOWN","SPEND_BUDGET_IN_FULL","USE_CAMPAIGN_STRATEGY"],"type":"string"},"BrandExposureViewabilityTargetingType":{"description":"The type of brand exposure viewability targeting.\n\n| BrandExposureViewabilityTargetingType | Description |\n|------|------|\n| `ALLOW_ALL` |  |\n| `BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION` |  |\n| `BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION` |  |\n| `BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION` |  |\n","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"],"type":"string"},"BrandSafetyCategory":{"description":"| BrandSafetyCategory | Description |\n|------|------|\n| `ACCIDENTS_DISASTERS_AND_TRAGEDIES` | Content related to sensitive tragedies, man-made or natural disasters and calamities, including content that graphically depicts such events. |\n| `ALCOHOL_AND_RELATED_PRODUCTS` | Content related to the general consumption of alcohol. |\n| `BLOOD_GORE_VIOLENCE` | Content in a fictional entertainment context that contains blood, gore or acts of violence. |\n| `CRIME` | Content related to crime, such as law enforcement efforts, criminal behavior, crime prevention, and justice systems. |\n| `DRUG_REFERENCES_OR_USE` | Content related to substance use, drugs, and other mind-altering substances. |\n| `GAMBLING` | Content related to gambling, such as instructions on how to play, accessories like home poker sets, and industry news. It does not include online gambling services where money or items of value can be wagered in exchange for the opportunity to win prizes with real-world value. |\n| `HIGHLY_DEBATED_SOCIAL_ISSUES` | Content related to highly debated and politically or socially divisive topics, which is reasonably likely to cause offense to the average person with opposing views. |\n| `POLITICS` | Content related to politics, governments, political science, political parties, elections, and political issues of public debate. |\n| `PROFANITY` | Content containing excessive use of strong language, explicit, offensive, or sensitive words and expressions. |\n| `RELIGIOUS_CONTENT` | Content related to religious and spiritual beliefs. |\n| `SEXUAL_REFERENCES_AND_SUGGESTIVE` | Content that contains references or depictions that are mildly provocative, or mature in nature, whether real, simulated or animated. It does not contain sexually explicit content. |\n| `SHOCK_AND_HORROR` | Content that may cause shock, fear, or unease. It includes supernatural, disturbing elements, and horror themes. |\n| `TOBACCO_AND_RELATED_PRODUCTS` | Content related to the smoking of cigarettes, cigars, pipe tobacco, smokeless tobacco, and other tobacco or nicotine products. |\n| `UNRATED_MEDIA_CONTENT` | Content that has not been classified. This covers games on Twitch not rated by ESRB. |\n| `WEAPONS` | Content related to realistic weapons, such as firearms, bladed weapons, bows and arrows, and military equipment and vehicles. |\n","enum":["ACCIDENTS_DISASTERS_AND_TRAGEDIES","ALCOHOL_AND_RELATED_PRODUCTS","BLOOD_GORE_VIOLENCE","CRIME","DRUG_REFERENCES_OR_USE","GAMBLING","HIGHLY_DEBATED_SOCIAL_ISSUES","POLITICS","PROFANITY","RELIGIOUS_CONTENT","SEXUAL_REFERENCES_AND_SUGGESTIVE","SHOCK_AND_HORROR","TOBACCO_AND_RELATED_PRODUCTS","UNRATED_MEDIA_CONTENT","WEAPONS"],"type":"string"},"BrandSafetyCategoryTarget":{"description":"Target based on, if any, the classifications of unsuitable contexts that may pose a risk to a brand\u0027s reputation of content being viewed.","properties":{"brandSafetyCategory":{"$ref":"#/components/schemas/BrandSafetyCategory"}},"required":["brandSafetyCategory"],"type":"object"},"BrandSafetyTier":{"description":"| BrandSafetyTier | Description |\n|------|------|\n| `EXPANDED` | Tier that maximizes reach across all ad-eligible inventory. This tier is suitable for brands with a greater risk tolerance for advertising alongside a wide variety of content. |\n| `RESTRICTIVE` | Tier that prioritizes brand suitability over reach. This tier is suitable for brands with the lowest risk tolerance for advertising alongside a wide variety of content. |\n| `STANDARD` | Tier that offers broad reach and is the default for all campaigns. This tier is suitable for brands with a moderate risk tolerance for advertising alongside a wide variety of content. |\n","enum":["EXPANDED","RESTRICTIVE","STANDARD"],"type":"string"},"BrandSafetyTierTarget":{"description":"Target based on the brand suitability risk levels of content being viewed.","properties":{"brandSafetyTier":{"$ref":"#/components/schemas/BrandSafetyTier"}},"required":["brandSafetyTier"],"type":"object"},"BrandStore":{"properties":{"pageInfos":{"description":"Collection of BrandStorePageInfo for all pages tied to the brand store","items":{"$ref":"#/components/schemas/BrandStorePageInfo"},"maxItems":30,"minItems":0,"type":"array"},"storeId":{"description":"Unique identifier for the store","type":"string"},"storeName":{"description":"The name of the store","type":"string"}},"required":["storeId"],"type":"object"},"BrandStoreCallToAction":{"oneOf":[{"properties":{"brandStoreCallToActionSettings":{"$ref":"#/components/schemas/BrandStoreCallToActionSettings"}},"required":["brandStoreCallToActionSettings"],"title":"brandStoreCallToActionSettings","type":"object"}]},"BrandStoreCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for BrandStore.","items":{"$ref":"#/components/schemas/BrandStoreCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["url"],"type":"object"},"BrandStoreCallToActionType":{"description":"| BrandStoreCallToActionType | Description |\n|------|------|\n| `BUY_NOW` |  |\n| `DISCOVER_MORE` |  |\n| `LEARN_MORE` |  |\n| `SEE_DETAILS` |  |\n| `SHOP_NOW` |  |\n","enum":["BUY_NOW","DISCOVER_MORE","LEARN_MORE","SEE_DETAILS","SHOP_NOW"],"type":"string"},"BrandStoreEdition":{"properties":{"editionId":{"description":"Unique identifier for the edition within the store","type":"string"},"editionName":{"description":"Name of the store edition","type":"string"},"storeEditionSchedule":{"$ref":"#/components/schemas/StoreEditionSchedule"},"storeId":{"description":"Identifier of the associated store","type":"string"}},"required":["editionId","editionName","storeId"],"type":"object"},"BrandStoreEditionPublishVersion":{"properties":{"editionId":{"description":"Reference to the store edition","type":"string"},"pages":{"description":"Collection of page versions included in this publish version","items":{"$ref":"#/components/schemas/StorePageVersion"},"maxItems":5000,"minItems":0,"type":"array"},"publishState":{"$ref":"#/components/schemas/StorePublishState"},"publishStatus":{"$ref":"#/components/schemas/StorePublishStatus"},"storeEditionPublishId":{"description":"Unique identifier for the publish version","type":"string"},"storeId":{"description":"Identifier of the associated store","type":"string"}},"required":["editionId","publishState","publishStatus","storeEditionPublishId","storeId"],"type":"object"},"BrandStoreEditionPublishVersionBrandStoreEditionIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"BrandStoreEditionPublishVersionBrandStoreIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"BrandStoreEditionPublishVersionMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersionMultiStatusSuccess"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"BrandStoreEditionPublishVersionMultiStatusSuccess":{"properties":{"brandStoreEditionPublishVersion":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersion"},"index":{"format":"int32","maximum":0,"minimum":0,"type":"integer"}},"required":["brandStoreEditionPublishVersion","index"],"type":"object"},"BrandStoreEditionPublishVersionStorePublishStatusFilter":{"properties":{"include":{"description":"| PublishStatus | Description |\n| --- | --- |\n| `DRAFT` | Content is in draft state |\n| `REVIEW_IN_PROGRESS` | Content is pending publication for review |","items":{"$ref":"#/components/schemas/StorePublishStatus"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"BrandStoreEditionPublishVersionSuccessResponse":{"properties":{"brandStoreEditionPublishVersions":{"items":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersion"},"maxItems":50,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"BrandStoreEditionPublishVersionUpdate":{"properties":{"editionId":{"description":"Reference to the store edition","type":"string"},"publishState":{"$ref":"#/components/schemas/StorePublishState"},"storeEditionPublishId":{"description":"Unique identifier for the publish version","type":"string"},"storeId":{"description":"Identifier of the associated store","type":"string"}},"required":["storeEditionPublishId"],"type":"object"},"BrandStoreEditionSuccessResponse":{"properties":{"brandStoreEditions":{"items":{"$ref":"#/components/schemas/BrandStoreEdition"},"maxItems":50,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"BrandStorePage":{"properties":{"content":{"$ref":"#/components/schemas/StorePageContent"},"editionId":{"description":"Reference to the store edition","type":"string"},"pageId":{"description":"Unique identifier for the store page","type":"string"},"pageType":{"$ref":"#/components/schemas/StorePageType"},"storeEditionPublishId":{"description":"Optional identifier for the published version of this page","type":"string"},"storeId":{"description":"Identifier of the associated store","type":"string"}},"required":["content","editionId","pageId","pageType","storeId"],"type":"object"},"BrandStorePageBrandStoreEditionIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"BrandStorePageBrandStoreEditionPublishVersionIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"BrandStorePageBrandStoreIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"BrandStorePageInfo":{"description":"Structure containing the basic information of a store page","properties":{"tag":{"description":"Unique tag for the store page","type":"string"},"title":{"description":"Title of the page","type":"string"}},"required":["tag","title"],"type":"object"},"BrandStorePagePageIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"BrandStorePageSuccessResponse":{"properties":{"brandStorePages":{"items":{"$ref":"#/components/schemas/BrandStorePage"},"maxItems":50,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"BrandStoreSettings":{"properties":{"additionalHtml":{"description":"Additional HTML to include with the render response for display inventory targets.","type":"string"},"bodyText":{"description":"The body text to use for the Brand Store Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"brand":{"description":"The brand of the product(s) being advertised.","type":"string"},"callToActions":{"$ref":"#/components/schemas/BrandStoreCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/Size"},"maxItems":20,"minItems":0,"type":"array"},"disclaimers":{"description":"The disclaimers to use for the Brand Store Creative experience.","type":"string"},"headlines":{"description":"The headline(s) to use for the Brand Store Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":1,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"$ref":"#/components/schemas/Image"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":1,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":1,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":1,"type":"array"}},"required":["brand","callToActions","headlines","inventoryTypes","language","optimizationGoalKpi","responsiveSizingBehavior","squareImages","tallImages","wideImages"],"type":"object"},"BrandStoreStoreNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"BrandStoreSuccessResponse":{"properties":{"brandStores":{"items":{"$ref":"#/components/schemas/BrandStore"},"maxItems":30,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"BrandSuitabilityRiskLevelType":{"description":"The Double Verify brand suitability risk level.\n\n| BrandSuitabilityRiskLevelType | Description |\n|------|------|\n| `ALLOW_ALL` |  |\n| `HIGH_MEDIUM_LOW` |  |\n| `HIGH_MEDIUM` |  |\n| `HIGH` |  |\n","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"],"type":"string"},"BrandedRecipeDirection":{"description":"Represents a single step in a recipe\u0027s directions","properties":{"body":{"description":"Detailed instruction text for the direction step","type":"string"},"title":{"description":"Title or heading for the direction step","type":"string"}},"required":["body","title"],"type":"object"},"BrandedRecipeIngredient":{"description":"Represents an ingredient in a branded recipe","properties":{"asinOverrides":{"description":"List of ASIN overrides for the ingredient","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"brand":{"description":"Brand name associated with the ingredient","type":"string"},"displayText":{"description":"Formatted text for displaying the ingredient","type":"string"},"isAsinRestricted":{"description":"Flag indicating if ASIN is restricted for this ingredient","type":"boolean"},"isBrandRestricted":{"description":"Flag indicating if brand is restricted for this ingredient","type":"boolean"},"isExclusiveOverride":{"description":"Flag indicating if this ingredient has exclusive override","type":"boolean"},"name":{"description":"Name of the ingredient","type":"string"},"quantityList":{"description":"List of quantity measurements for the ingredient","items":{"$ref":"#/components/schemas/BrandedRecipeQuantityItem"},"maxItems":500,"minItems":0,"type":"array"}},"required":["brand","displayText","isAsinRestricted","isBrandRestricted","isExclusiveOverride","name"],"type":"object"},"BrandedRecipeIngredientsMetadata":{"description":"Contains metadata information for recipe ingredients","properties":{"priorityAsins":{"description":"List of priority ASINs for ingredients with detailed product information","items":{"$ref":"#/components/schemas/PriorityAsin"},"maxItems":500,"minItems":0,"type":"array"},"quantity":{"description":"Quantity amount for the ingredient","format":"double","type":"number"},"searchText":{"description":"Search text for ingredient metadata","type":"string"},"translatedUnit":{"description":"Translated unit of measurement","type":"string"}},"type":"object"},"BrandedRecipeMedia":{"description":"Represents media content associated with a recipe","properties":{"altText":{"description":"Alternative text description of the media content","type":"string"},"assetLibraryId":{"description":"Identifier for the asset.","type":"string"},"mediaUrl":{"description":"URL of the media content","type":"string"}},"type":"object"},"BrandedRecipeQuantityItem":{"description":"Represents a quantity measurement for a recipe ingredient","properties":{"amount":{"description":"Numerical amount of the ingredient","format":"double","type":"number"},"unit":{"description":"Unit of measurement for the ingredient","type":"string"}},"required":["amount","unit"],"type":"object"},"BrandedRecipeWidget":{"description":"Main widget structure for displaying a branded recipe","properties":{"availableProductAsins":{"description":"List of available product ASINs.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"desktopMedia":{"$ref":"#/components/schemas/BrandedRecipeMedia"},"directions":{"description":"List of preparation directions for the recipe","items":{"$ref":"#/components/schemas/BrandedRecipeDirection"},"maxItems":500,"minItems":0,"type":"array"},"encodedIngredientComposition":{"description":"Encoded string containing ingredient composition details","type":"string"},"ingredientMetadata":{"description":"Metadata associated with recipe ingredients","items":{"$ref":"#/components/schemas/BrandedRecipeIngredientsMetadata"},"maxItems":500,"minItems":0,"type":"array"},"ingredients":{"description":"List of ingredients required for the recipe","items":{"$ref":"#/components/schemas/BrandedRecipeIngredient"},"maxItems":500,"minItems":0,"type":"array"},"isInitialLoad":{"description":"Flag indicating if recipe is set to initial load","type":"boolean"},"mobileMedia":{"$ref":"#/components/schemas/BrandedRecipeMedia"},"preparationTime":{"description":"Time required to prepare the recipe","type":"string"},"refTag":{"description":"REF tracking tag for the branded recipe","type":"string"},"servingSize":{"description":"Number of servings the recipe yields","format":"double","type":"number"},"title":{"description":"Title of the recipe","type":"string"}},"required":["preparationTime","servingSize"],"type":"object"},"Budget":{"properties":{"budgetType":{"$ref":"#/components/schemas/BudgetType"},"budgetValue":{"$ref":"#/components/schemas/BudgetValue"},"recurrenceTimePeriod":{"$ref":"#/components/schemas/Recurrence"}},"required":["budgetType","budgetValue","recurrenceTimePeriod"],"type":"object"},"BudgetAllocation":{"description":"| BudgetAllocation | Description |\n|------|------|\n| `AUTO` | Automatically allocate budget to better performing ad groups based on the selected goal KPI. |\n| `MANUAL` | Manually allocate budget across ad groups. |\n","enum":["AUTO","MANUAL"],"type":"string"},"BudgetSettings":{"properties":{"budgetAllocation":{"$ref":"#/components/schemas/BudgetAllocation"},"flightBudgetRolloverStrategy":{"$ref":"#/components/schemas/RolloverStrategy"},"marketplaceBudgetAllocation":{"$ref":"#/components/schemas/MarketplaceBudgetAllocation"},"offAmazonBudgetControlStrategy":{"$ref":"#/components/schemas/OffAmazonBudgetControlStrategy"}},"type":"object"},"BudgetType":{"description":"| BudgetType | Description |\n|------|------|\n| `MONETARY` |  |\n","enum":["MONETARY"],"type":"string"},"BudgetValue":{"oneOf":[{"properties":{"monetaryBudgetValue":{"$ref":"#/components/schemas/MonetaryBudgetValue"}},"required":["monetaryBudgetValue"],"title":"monetaryBudgetValue","type":"object"}]},"CTI":{"properties":{"category":{"description":"Category identifier.","type":"string"},"item":{"description":"Item identifier.","type":"string"},"type":{"description":"Type identifier.","type":"string"}},"type":"object"},"Campaign":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"autoCreationSettings":{"$ref":"#/components/schemas/AutoCreationSettings"},"autoScaleGlobalCampaign":{"$ref":"#/components/schemas/AutoScaleGlobalCampaignSetting"},"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/Budget"},"maxItems":2,"minItems":0,"type":"array"},"campaignId":{"description":"A unique identifier for a campaign.","type":"string"},"costType":{"$ref":"#/components/schemas/CostType"},"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/CountryCode"},"maxItems":249,"minItems":0,"type":"array"},"creationDateTime":{"description":"The date time that the campaign was created.","format":"date-time","type":"string"},"eligibleAutomatedTargetingTactics":{"description":"List of tactic type and inventory type pairs that are eligible for use with this campaign","items":{"$ref":"#/components/schemas/TacticKey"},"maxItems":20,"minItems":0,"type":"array"},"endDateTime":{"description":"The end date time for the campaign.","format":"date-time","type":"string"},"fees":{"description":"Any fees associated with the campaign.","items":{"$ref":"#/components/schemas/CampaignFee"},"maxItems":1,"minItems":0,"type":"array"},"flights":{"description":"Flight details associated with the campaign.","items":{"$ref":"#/components/schemas/CampaignFlight"},"maxItems":150,"minItems":0,"type":"array"},"frequencies":{"description":"Any frequency caps associated with the campaign.","items":{"$ref":"#/components/schemas/Frequency"},"maxItems":3,"minItems":0,"type":"array"},"globalCampaignId":{"description":"The global campaign identifier that manages this marketplace campaign.","type":"string"},"ineligibleAutomatedTargetingTactics":{"description":"List of tactic type and inventory type pairs that are ineligible for use with this campaign, along with reasons for ineligibility","items":{"$ref":"#/components/schemas/IneligibleAutomatedTargetingTactic"},"maxItems":20,"minItems":0,"type":"array"},"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"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global campaign that enables overriding certain attributes at individual marketplace level. For example, if a global campaign is ENABLED and startDate \u00272024-06-01\u0027 but needs to be PAUSED in DE with startDateTime \u00272024-06-02\u0027 marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED, startDate: \u00272024-06-02\u0027}}]. When a marketplace-specific override is not provided, the campaign\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/MarketplaceCampaignConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"This represent retail domains such as Amazon.com, Amazon.co.uk, Amazon.mx, etc, that represent a country that an Amazon customer can shop.","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the campaign.","type":"string"},"optimizations":{"$ref":"#/components/schemas/CampaignOptimizations"},"portfolioId":{"description":"The ID of the portfolio associated with the campaign.","type":"string"},"purchaseOrderNumber":{"description":"The purchase order number associated with the campaign.","type":"string"},"salesChannel":{"$ref":"#/components/schemas/SalesChannel"},"siteRestrictions":{"description":"Restrict the ad to a particular site","items":{"$ref":"#/components/schemas/SiteRestriction"},"maxItems":1,"minItems":0,"type":"array"},"skanAppId":{"description":"StoreKit AdNetwork application ID. Represents iTunes application ID with which SKAN-enabled campaigns are associated.","type":"string"},"startDateTime":{"description":"The start date time for the campaign.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/State"},"status":{"$ref":"#/components/schemas/Status"},"tags":{"description":"Open ended labels with a key value pair applied to the campaign","items":{"$ref":"#/components/schemas/Tag"},"maxItems":50,"minItems":0,"type":"array"},"targetedPGDealId":{"description":"DealId associated with the campaign.","type":"string"},"targetsAmazonDeal":{"description":"If the campaign is targeting an Amazon deal, the value will be true, and the campaign and ad group(s) will be read-only.","type":"boolean"}},"required":["adProduct","campaignId","creationDateTime","lastUpdatedDateTime","name","state"],"type":"object"},"CampaignAdProductFilter":{"properties":{"include":{"description":"| AdProduct | Description |\n| --- | --- |\n| `SPONSORED_PRODUCTS` | Sponsored Products ad product. |\n| `SPONSORED_BRANDS` | Sponsored Brands ad product. |\n| `SPONSORED_DISPLAY` | Sponsored Display ad product. |\n| `SPONSORED_TELEVISION` | Sponsored Television ad product. |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","items":{"$ref":"#/components/schemas/AdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"CampaignCampaignIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"CampaignCreate":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"autoCreationSettings":{"$ref":"#/components/schemas/CreateAutoCreationSettings"},"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/CreateBudget"},"maxItems":2,"minItems":0,"type":"array"},"costType":{"$ref":"#/components/schemas/CostType"},"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/CountryCode"},"maxItems":249,"minItems":0,"type":"array"},"endDateTime":{"description":"The end date time for the campaign.","format":"date-time","type":"string"},"fees":{"description":"Any fees associated with the campaign.","items":{"$ref":"#/components/schemas/CreateCampaignFee"},"maxItems":1,"minItems":0,"type":"array"},"flights":{"description":"Flight details associated with the campaign.","items":{"$ref":"#/components/schemas/CreateCampaignFlight"},"maxItems":150,"minItems":0,"type":"array"},"frequencies":{"description":"Any frequency caps associated with the campaign.","items":{"$ref":"#/components/schemas/CreateFrequency"},"maxItems":3,"minItems":0,"type":"array"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global campaign that enables overriding certain attributes at individual marketplace level. For example, if a global campaign is ENABLED and startDate \u00272024-06-01\u0027 but needs to be PAUSED in DE with startDateTime \u00272024-06-02\u0027 marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED, startDate: \u00272024-06-02\u0027}}]. When a marketplace-specific override is not provided, the campaign\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/CreateMarketplaceCampaignConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"This represent retail domains such as Amazon.com, Amazon.co.uk, Amazon.mx, etc, that represent a country that an Amazon customer can shop.","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the campaign.","type":"string"},"optimizations":{"$ref":"#/components/schemas/CreateCampaignOptimizations"},"portfolioId":{"description":"The ID of the portfolio associated with the campaign.","type":"string"},"purchaseOrderNumber":{"description":"The purchase order number associated with the campaign.","type":"string"},"salesChannel":{"$ref":"#/components/schemas/SalesChannel"},"siteRestrictions":{"description":"Restrict the ad to a particular site","items":{"$ref":"#/components/schemas/SiteRestriction"},"maxItems":1,"minItems":0,"type":"array"},"skanAppId":{"description":"StoreKit AdNetwork application ID. Represents iTunes application ID with which SKAN-enabled campaigns are associated.","type":"string"},"startDateTime":{"description":"The start date time for the campaign.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/CreateState"},"tags":{"description":"Open ended labels with a key value pair applied to the campaign","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"},"targetedPGDealId":{"description":"DealId associated with the campaign.","type":"string"}},"required":["adProduct","name","state"],"type":"object"},"CampaignFee":{"properties":{"feeType":{"$ref":"#/components/schemas/CampaignFeeType"},"feeValue":{"description":"A service fee that is subtracted from the campaign budget as a percent of budget. This setting can’t be changed after an ad group has been added to a campaign.","format":"double","type":"number"},"feeValueType":{"$ref":"#/components/schemas/CampaignFeeValueType"}},"required":["feeType","feeValue","feeValueType"],"type":"object"},"CampaignFeeType":{"description":"| CampaignFeeType | Description |\n|------|------|\n| `AGENCY` | A service fee that is subtracted from the campaign budget as a percent of budget. |\n","enum":["AGENCY"],"type":"string"},"CampaignFeeValueType":{"description":"| CampaignFeeValueType | Description |\n|------|------|\n| `PERCENTAGE_OF_BUDGET` | Subtracted from the campaign budget as a percent of budget |\n","enum":["PERCENTAGE_OF_BUDGET"],"type":"string"},"CampaignFlight":{"properties":{"budget":{"$ref":"#/components/schemas/FlightBudget"},"endDateTime":{"description":"The end date of the flight.","format":"date-time","type":"string"},"flightId":{"description":"The ID associated with the flight.","type":"string"},"name":{"description":"The name of the flight.","type":"string"},"startDateTime":{"description":"The start date of the flight.","format":"date-time","type":"string"}},"required":["budget","endDateTime","startDateTime"],"type":"object"},"CampaignGoalFilter":{"properties":{"include":{"description":"| 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/Goal"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"CampaignMarketplaceScopeFilter":{"properties":{"include":{"description":"| MarketplaceScope | Description |\n| --- | --- |\n| `GLOBAL` |  |\n| `SINGLE_MARKETPLACE` |  |","items":{"$ref":"#/components/schemas/MarketplaceScope"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"CampaignMultiStatusResponseWithPartialErrors":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1000,"minItems":0,"type":"array"},"partialSuccess":{"items":{"$ref":"#/components/schemas/CampaignPartialIndex"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/CampaignMultiStatusSuccess"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"CampaignMultiStatusSuccess":{"properties":{"campaign":{"$ref":"#/components/schemas/Campaign"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"}},"required":["campaign","index"],"type":"object"},"CampaignNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/CampaignNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"CampaignNameFilterType":{"description":"| CampaignNameFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"CampaignOptimizations":{"properties":{"bidSettings":{"$ref":"#/components/schemas/BidSettings"},"budgetSettings":{"$ref":"#/components/schemas/BudgetSettings"},"goalSettings":{"$ref":"#/components/schemas/GoalSettings"},"primaryInventoryTypes":{"description":"Primary inventory type of the campaign for filtering KPIs and recommending tactics.","items":{"$ref":"#/components/schemas/PrimaryInventoryType"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"CampaignPartialIndex":{"properties":{"campaign":{"$ref":"#/components/schemas/Campaign"},"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"}},"required":["campaign","errors","index"],"type":"object"},"CampaignPortfolioIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"CampaignStateFilter":{"properties":{"include":{"description":"| 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/State"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"CampaignSuccessResponse":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/Campaign"},"maxItems":5000,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"CampaignUpdate":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"budgets":{"description":"The object containing budget details for the campaign (for campaigns that support multiple budgets).","items":{"$ref":"#/components/schemas/CreateBudget"},"maxItems":2,"minItems":0,"type":"array"},"campaignId":{"description":"A unique identifier for a campaign.","type":"string"},"costType":{"$ref":"#/components/schemas/CostType"},"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/CountryCode"},"maxItems":249,"minItems":0,"type":"array"},"endDateTime":{"description":"The end date time for the campaign.","format":"date-time","nullable":true,"type":"string"},"fees":{"description":"Any fees associated with the campaign.","items":{"$ref":"#/components/schemas/CreateCampaignFee"},"maxItems":1,"minItems":0,"type":"array"},"flights":{"description":"Flight details associated with the campaign.","items":{"$ref":"#/components/schemas/CreateCampaignFlight"},"maxItems":150,"minItems":0,"type":"array"},"frequencies":{"description":"Any frequency caps associated with the campaign.","items":{"$ref":"#/components/schemas/CreateFrequency"},"maxItems":3,"minItems":0,"type":"array"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global campaign that enables overriding certain attributes at individual marketplace level. For example, if a global campaign is ENABLED and startDate \u00272024-06-01\u0027 but needs to be PAUSED in DE with startDateTime \u00272024-06-02\u0027 marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED, startDate: \u00272024-06-02\u0027}}]. When a marketplace-specific override is not provided, the campaign\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/CreateMarketplaceCampaignConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaces":{"description":"This represent retail domains such as Amazon.com, Amazon.co.uk, Amazon.mx, etc, that represent a country that an Amazon customer can shop.","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the campaign.","type":"string"},"optimizations":{"$ref":"#/components/schemas/UpdateCampaignOptimizations"},"portfolioId":{"description":"The ID of the portfolio associated with the campaign.","nullable":true,"type":"string"},"purchaseOrderNumber":{"description":"The purchase order number associated with the campaign.","nullable":true,"type":"string"},"siteRestrictions":{"description":"Restrict the ad to a particular site","items":{"$ref":"#/components/schemas/SiteRestriction"},"maxItems":1,"minItems":0,"type":"array"},"skanAppId":{"description":"StoreKit AdNetwork application ID. Represents iTunes application ID with which SKAN-enabled campaigns are associated.","type":"string"},"startDateTime":{"description":"The start date time for the campaign.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/UpdateState"},"tags":{"description":"Open ended labels with a key value pair applied to the campaign","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"},"targetedPGDealId":{"description":"DealId associated with the campaign.","type":"string"}},"required":["campaignId"],"type":"object"},"CardCreativeElement":{"properties":{"headline":{"description":"The headline used for the card.","type":"string"},"landingPage":{"$ref":"#/components/schemas/StoreSpotlightLandingPage"},"products":{"$ref":"#/components/schemas/AdvertisedProducts"}},"required":["headline","landingPage","products"],"type":"object"},"ClickToAppDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The app that customers are directed to.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"ClickToUrlDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"ClickToUrlVideoCallToActionSettings":{"properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The url to redirect the user via the video CallToAction.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"CollectionLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/CollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page.","type":"string"}},"required":["landingPageType"],"type":"object"},"CollectionLandingPageType":{"description":"| 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"},"CommonTileProperties":{"properties":{"size":{"$ref":"#/components/schemas/StoreTileSize"},"tag":{"description":"The unique tag for the tile to help track on performance.","type":"string"},"type":{"$ref":"#/components/schemas/StoreTileType"}},"required":["size","tag","type"],"type":"object"},"CommonWidgetProperties":{"properties":{"sectionType":{"$ref":"#/components/schemas/StoreWidgetSectionType"},"widgetTag":{"description":"The unique tag for the widget to help track on performance.","type":"string"},"widgetType":{"$ref":"#/components/schemas/StoreWidgetType"}},"required":["sectionType","widgetTag","widgetType"],"type":"object"},"ComponentCreative":{"properties":{"assetBasedCreativeSettings":{"$ref":"#/components/schemas/AssetBasedCreativeSettings"},"autoCollectionSettings":{"$ref":"#/components/schemas/AutoCollectionSettings"},"brandStoreSettings":{"$ref":"#/components/schemas/BrandStoreSettings"},"manualCollectionSettings":{"$ref":"#/components/schemas/ManualCollectionSettings"},"productCollectionSettings":{"$ref":"#/components/schemas/ProductCollectionSettings"},"productVideoSettings":{"$ref":"#/components/schemas/ProductVideoSettings"},"responsiveEcommerceSettings":{"$ref":"#/components/schemas/ResponsiveEcommerceSettings"},"storeSpotlightSettings":{"$ref":"#/components/schemas/StoreSpotlightSettings"}},"type":"object"},"ComponentInventoryType":{"description":"| ComponentInventoryType | Description |\n|------|------|\n| `DISPLAY` |  |\n| `NATIVE` |  |\n","enum":["DISPLAY","NATIVE"],"type":"string"},"ComponentLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/ComponentLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"ComponentLandingPageType":{"description":"| ComponentLandingPageType | Description |\n|------|------|\n| `OFF_AMAZON_LINK` | An off-Amazon landing page. |\n","enum":["OFF_AMAZON_LINK"],"type":"string"},"ConstituentIndexValue":{"description":"Values for a location index where the indexValue is calculated from the constituents.","properties":{"brandSales":{"description":"The brand sales value for the postal code.","format":"double","type":"number"},"categorySales":{"description":"The category sales value for the postal code.","format":"double","type":"number"},"postalCode":{"description":"The postal code for the location index prefixed by country code (i.e. US-10118).","type":"string"}},"required":["brandSales","categorySales","postalCode"],"type":"object"},"ConstituentIndexValues":{"properties":{"values":{"description":"List of brand and category sales values.","items":{"$ref":"#/components/schemas/ConstituentIndexValue"},"maxItems":1000000,"minItems":1,"type":"array"}},"required":["values"],"type":"object"},"ContentCategoryTarget":{"description":"Target based on the category of content being viewed.","properties":{"contentCategoryId":{"description":"The content category being targeted.","type":"string"}},"required":["contentCategoryId"],"type":"object"},"ContentGenre":{"description":"| ContentGenre | Description |\n|------|------|\n| `ACTION` | Action genre content. |\n| `ADVENTURE` | Adventure genre content. |\n| `ALTERNATIVE_ROCK` | Alternative rock music content. |\n| `ANIMATION` | Animation genre content. |\n| `ARTS` | Arts content. |\n| `BIOGRAPHY` | Biography genre content. |\n| `BLUES` | Blues music content. |\n| `BUSINESS` | Business content. |\n| `CHILDRENS_MUSIC` | Children\u0027s music content. |\n| `CHRISTIAN_GOSPEL` | Christian and gospel music content. |\n| `CHRISTMAS_HOLIDAY` | Christmas and holiday content. |\n| `CLASSICAL` | Classical music content. |\n| `CLASSIC_ROCK` | Classic rock music content. |\n| `COLLEGE_RADIO` | College radio content. |\n| `COMEDY` | Comedy genre content. |\n| `COUNTRY` | Country music content. |\n| `CRIME` | Crime genre content. |\n| `DANCE_DJ` | Dance and DJ music content. |\n| `DOCUMENTARY` | Documentary genre content. |\n| `DRAMA` | Drama genre content. |\n| `EASY_LISTENING` | Easy listening music content. |\n| `EDUCATION` | Education content. |\n| `EUROPEAN_POP_FOLK` | European pop and folk music content. |\n| `FAMILY` | Family genre content. |\n| `FANTASY` | Fantasy genre content. |\n| `FICTION` | Fiction genre content. |\n| `FILM_NOIR` | Film noir genre content. |\n| `FOLK` | Folk music content. |\n| `FRENCH_VARIETY` | French variety music content. |\n| `GAME_SHOW` | Game show content. |\n| `GENRE_NOT_AVAILABLE` | Content where genre is not available. |\n| `GERMAN_ROCK_POP` | German rock and pop music content. |\n| `GOVERNMENT` | Government content. |\n| `HARD_ROCK_METAL` | Hard rock and metal music content. |\n| `HEALTH_AND_FITNESS` | Health and fitness content. |\n| `HISTORY` | History genre content. |\n| `HORROR` | Horror genre content. |\n| `INTERNATIONAL` | International content. |\n| `JAPANESE` | Japanese content. |\n| `JAZZ` | Jazz music content. |\n| `KIDS_AND_FAMILY` | Kids and family content. |\n| `LATIN_MUSIC` | Latin music content. |\n| `LEISURE` | Leisure content. |\n| `MISCELLANEOUS` | Miscellaneous content. |\n| `MUSICALS_CABARET` | Musicals and cabaret content. |\n| `MUSICAL` | Musical genre content. |\n| `MUSIC` | General music content. |\n| `MYSTERY` | Mystery genre content. |\n| `NEWS` | News content. |\n| `NEW_AGE` | New age music content. |\n| `OLDIES_ADULT_STANDARDS` | Oldies and adult standards music content. |\n| `POP` | Pop music content. |\n| `RAP_HIP_HOP` | Rap and hip-hop music content. |\n| `RB` | R\u0026B music content. |\n| `REALITY_TV` | Reality TV content. |\n| `REGGAE_ISLAND` | Reggae and island music content. |\n| `RELIGION_AND_SPIRITUALITY` | Religion and spirituality content. |\n| `ROCK` | Rock music content. |\n| `ROMANCE` | Romance genre content. |\n| `SCIENCE_FICTION` | Science fiction genre content. |\n| `SCIENCE` | Science content. |\n| `SHORT` | Short-form content. |\n| `SOCIETY_AND_CULTURE` | Society and culture content. |\n| `SOUNDTRACKS` | Soundtrack music content. |\n| `SPORT` | Sports content. |\n| `SUPER_HERO` | Super hero genre content. |\n| `TALK_SHOW` | Talk show content. |\n| `TECHNOLOGY` | Technology content. |\n| `THRILLER` | Thriller genre content. |\n| `TRUE_CRIME` | True crime content. |\n| `TV_AND_FILM` | TV and film content. |\n| `WAR` | War genre content. |\n| `WESTERN` | Western genre content. |\n","enum":["ACTION","ADVENTURE","ALTERNATIVE_ROCK","ANIMATION","ARTS","BIOGRAPHY","BLUES","BUSINESS","CHILDRENS_MUSIC","CHRISTIAN_GOSPEL","CHRISTMAS_HOLIDAY","CLASSICAL","CLASSIC_ROCK","COLLEGE_RADIO","COMEDY","COUNTRY","CRIME","DANCE_DJ","DOCUMENTARY","DRAMA","EASY_LISTENING","EDUCATION","EUROPEAN_POP_FOLK","FAMILY","FANTASY","FICTION","FILM_NOIR","FOLK","FRENCH_VARIETY","GAME_SHOW","GENRE_NOT_AVAILABLE","GERMAN_ROCK_POP","GOVERNMENT","HARD_ROCK_METAL","HEALTH_AND_FITNESS","HISTORY","HORROR","INTERNATIONAL","JAPANESE","JAZZ","KIDS_AND_FAMILY","LATIN_MUSIC","LEISURE","MISCELLANEOUS","MUSIC","MUSICAL","MUSICALS_CABARET","MYSTERY","NEWS","NEW_AGE","OLDIES_ADULT_STANDARDS","POP","RAP_HIP_HOP","RB","REALITY_TV","REGGAE_ISLAND","RELIGION_AND_SPIRITUALITY","ROCK","ROMANCE","SCIENCE","SCIENCE_FICTION","SHORT","SOCIETY_AND_CULTURE","SOUNDTRACKS","SPORT","SUPER_HERO","TALK_SHOW","TECHNOLOGY","THRILLER","TRUE_CRIME","TV_AND_FILM","WAR","WESTERN"],"type":"string"},"ContentGenreTarget":{"description":"Target based on the genre of content being viewed.","properties":{"contentGenre":{"$ref":"#/components/schemas/ContentGenre"}},"required":["contentGenre"],"type":"object"},"ContentInstreamPosition":{"description":"| ContentInstreamPosition | Description |\n|------|------|\n| `MID_ROLL` | Ad plays during the main video content. |\n| `POST_ROLL` | Ad plays after the main video content. |\n| `PRE_ROLL` | Ad plays before the main video content. |\n| `UNKNOWN` | Unknown instream position. |\n","enum":["MID_ROLL","POST_ROLL","PRE_ROLL","UNKNOWN"],"type":"string"},"ContentInstreamPositionTarget":{"description":"Targets ads in the specified content instream position","properties":{"instreamPosition":{"$ref":"#/components/schemas/ContentInstreamPosition"}},"required":["instreamPosition"],"type":"object"},"ContentOutstreamPosition":{"description":"| ContentOutstreamPosition | Description |\n|------|------|\n| `ACCOMPANYING_CONTENT` | Ad plays alongside editorial content. |\n| `INTERSTITIAL` | Ad plays between content transitions. |\n| `STANDALONE` | Ad plays as a standalone unit outside video content. |\n| `UNKNOWN` | Unknown outstream position. |\n","enum":["ACCOMPANYING_CONTENT","INTERSTITIAL","STANDALONE","UNKNOWN"],"type":"string"},"ContentOutstreamPositionTarget":{"description":"Targets ads in the specified content outstream position","properties":{"outstreamPosition":{"$ref":"#/components/schemas/ContentOutstreamPosition"}},"required":["outstreamPosition"],"type":"object"},"ContentRating":{"oneOf":[{"properties":{"dspContentRating":{"$ref":"#/components/schemas/DspContentRating"}},"required":["dspContentRating"],"title":"dspContentRating","type":"object"},{"properties":{"twitchContentRating":{"$ref":"#/components/schemas/TwitchContentRating"}},"required":["twitchContentRating"],"title":"twitchContentRating","type":"object"}]},"ContentRatingTarget":{"description":"Target based on the rating of content being viewed.","properties":{"contentRatingType":{"$ref":"#/components/schemas/ContentRatingTypes"},"contentRatingTypeDetails":{"$ref":"#/components/schemas/ContentRating"}},"required":["contentRatingType","contentRatingTypeDetails"],"type":"object"},"ContentRatingTypes":{"description":"| ContentRatingTypes | Description |\n|------|------|\n| `DSP_CONTENT_RATING` | Content rating based on DSP content classification. |\n| `TWITCH_CONTENT_RATING` | Content rating based on Twitch content classification labels. |\n","enum":["DSP_CONTENT_RATING","TWITCH_CONTENT_RATING"],"type":"string"},"ContentTooLargeResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"Coordinates":{"properties":{"x":{"description":"X coordinate.","format":"double","type":"number"},"y":{"description":"Y coordinate.","format":"double","type":"number"}},"type":"object"},"CostType":{"description":"| CostType | Description |\n|------|------|\n| `CPC` | Cost per click. |\n| `FIXED_PRICE` | Sale price for a specific ad placement regardless of auction performance. |\n| `VCPM` | Cost per thousand views. |\n","enum":["CPC","FIXED_PRICE","VCPM"],"type":"string"},"CountryCode":{"description":"| CountryCode | Description |\n|------|------|\n| `AE` |  |\n| `AT` |  |\n| `AU` |  |\n| `BE` |  |\n| `BH` |  |\n| `BR` |  |\n| `CA` |  |\n| `CH` |  |\n| `DE` |  |\n| `DK` |  |\n| `EG` |  |\n| `ES` |  |\n| `FI` |  |\n| `FR` |  |\n| `GB` |  |\n| `IE` |  |\n| `IL` |  |\n| `IN` |  |\n| `IT` |  |\n| `JO` |  |\n| `JP` |  |\n| `KW` |  |\n| `LU` |  |\n| `MA` |  |\n| `MK` |  |\n| `MX` |  |\n| `NL` |  |\n| `NO` |  |\n| `NZ` |  |\n| `OM` |  |\n| `PL` |  |\n| `QA` |  |\n| `SA` |  |\n| `SE` |  |\n| `SG` |  |\n| `TR` |  |\n| `US` |  |\n| `ZA` |  |\n","enum":["AE","AT","AU","BE","BH","BR","CA","CH","DE","DK","EG","ES","FI","FR","GB","IE","IL","IN","IT","JO","JP","KW","LU","MA","MK","MX","NL","NO","NZ","OM","PL","QA","SA","SE","SG","TR","US","ZA"],"type":"string"},"CreateAdAssociationRequest":{"properties":{"adAssociations":{"items":{"$ref":"#/components/schemas/AdAssociationCreate"},"maxItems":20,"minItems":1,"type":"array"}},"type":"object"},"CreateAdExtensionRequest":{"properties":{"adExtensions":{"items":{"$ref":"#/components/schemas/AdExtensionCreate"},"maxItems":50,"minItems":1,"type":"array"}},"type":"object"},"CreateAdExtensionSettings":{"oneOf":[{"properties":{"promptExtension":{"$ref":"#/components/schemas/CreatePromptExtension"}},"required":["promptExtension"],"title":"promptExtension","type":"object"},{"properties":{"videoExtension":{"$ref":"#/components/schemas/CreateVideoExtension"}},"required":["videoExtension"],"title":"videoExtension","type":"object"}]},"CreateAdGroupBid":{"properties":{"baseBid":{"description":"The lower bound bid used for the ads in the ad group.","format":"double","type":"number"},"defaultBid":{"description":"The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction.","format":"double","type":"number"},"marketplaceSettings":{"description":"The bid associated with the ad group at specified marketplace level. Either one of bid or marketplaceSettings should always be specified","items":{"$ref":"#/components/schemas/CreateAdGroupBidMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"maxAverageBid":{"description":"The max average bid that will be targeted on the ad group across all of the bids (a single bid could be lower or higher that this number).","format":"double","type":"number"}},"type":"object"},"CreateAdGroupBidMarketplaceSetting":{"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"defaultBid":{"description":"The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction.","format":"double","type":"number"},"marketplace":{"$ref":"#/components/schemas/Marketplace"}},"required":["currencyCode","marketplace"],"type":"object"},"CreateAdGroupBudgetSettings":{"properties":{"budgetAllocation":{"$ref":"#/components/schemas/BudgetAllocation"},"dailyMinSpendValue":{"description":"Denotes the daily minimum spend on the ad group in local currency.","format":"double","type":"number"}},"type":"object"},"CreateAdGroupGoalSettings":{"properties":{"kpi":{"$ref":"#/components/schemas/KPI"}},"type":"object"},"CreateAdGroupRequest":{"properties":{"adGroups":{"items":{"$ref":"#/components/schemas/AdGroupCreate"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"CreateAdInitiationTarget":{"description":"Target based on how the video ad will be started.","properties":{"videoInitiationType":{"$ref":"#/components/schemas/VideoInitiationType"}},"required":["videoInitiationType"],"type":"object"},"CreateAdPlayerSizeTarget":{"description":"Target based on the size of the ad player.","properties":{"adPlayerSize":{"$ref":"#/components/schemas/AdPlayerSize"}},"required":["adPlayerSize"],"type":"object"},"CreateAdRequest":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/AdCreate"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"CreateAdvertisedProductMarketplaceSetting":{"properties":{"globalStoreSetting":{"$ref":"#/components/schemas/CreateGlobalStoreSettings"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"productId":{"description":"The identifier of the product advertised.","type":"string"}},"required":["marketplace","productId"],"type":"object"},"CreateAdvertisedProducts":{"properties":{"globalStoreSetting":{"$ref":"#/components/schemas/CreateGlobalStoreSettings"},"marketplaceSettings":{"description":"List of advertised product selectively applied at the given marketplace level","items":{"$ref":"#/components/schemas/CreateAdvertisedProductMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"productId":{"description":"The identifier of the advertised product.","type":"string"},"productIdType":{"$ref":"#/components/schemas/ProductIdType"}},"required":["productIdType"],"type":"object"},"CreateAdvertiserDomainList":{"description":"Targets domains based on list inherited from the advertiser.","properties":{"inheritFromAdvertiser":{"description":"Set to TRUE to inherit domain list from advertiser.","type":"boolean"}},"required":["inheritFromAdvertiser"],"type":"object"},"CreateAmazonViewability":{"properties":{"includeUnmeasurableImpressions":{"description":"Must be false if viewabilityTier is set to ALL_TIERS. You can set to true to include impressions that can not be measured when a viewabilityTier other than ALL_TIERS is selected. We recommend setting to false if high viewability is your goal.","type":"boolean"},"viewabilityTier":{"$ref":"#/components/schemas/ViewabilityTier"}},"required":["includeUnmeasurableImpressions","viewabilityTier"],"type":"object"},"CreateAppTarget":{"description":"Target based on user application.","properties":{"appId":{"description":"The app identifier being targeted.","type":"string"},"appType":{"$ref":"#/components/schemas/AppType"}},"required":["appId","appType"],"type":"object"},"CreateAssetBasedCreativeCallToAction":{"oneOf":[{"properties":{"assetBasedCreativeCallToActionSettings":{"$ref":"#/components/schemas/CreateAssetBasedCreativeCallToActionSettings"}},"required":["assetBasedCreativeCallToActionSettings"],"title":"assetBasedCreativeCallToActionSettings","type":"object"}]},"CreateAssetBasedCreativeCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for AssetBasedCreative.","items":{"$ref":"#/components/schemas/AssetBasedCreativeCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["url"],"type":"object"},"CreateAssetBasedCreativeSettings":{"properties":{"additionalHtml":{"description":"Additional HTML to include with the render response for display inventory targets.","type":"string"},"bodyText":{"description":"The body text to use for the Asset Based Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"brand":{"description":"The brand of the product(s) being advertised.","type":"string"},"callToActions":{"$ref":"#/components/schemas/CreateAssetBasedCreativeCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":0,"type":"array"},"customVideos":{"$ref":"#/components/schemas/CreateVideo"},"disclaimers":{"description":"The disclaimers to use for the Asset Based Creative experience.","type":"string"},"headlines":{"description":"The headline(s) to use for the Asset Based Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/CreateComponentLandingPage"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"description":"The logos to use for the Asset Based Creative experience.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"}},"required":["headlines"],"type":"object"},"CreateAudienceBidAdjustment":{"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"},"CreateAudienceTarget":{"description":"Target based on a specified audience ID.","properties":{"acrossGroupOperator":{"$ref":"#/components/schemas/AcrossGroupOperator"},"audienceId":{"$ref":"#/components/schemas/CreateMarketplaceStringValue"},"groupId":{"description":"The string identifying a group of audiences. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audiences to a new group, choose any string not currently being used on this ad group. To add audiences to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group.","type":"string"},"inGroupOperator":{"$ref":"#/components/schemas/InGroupOperator"}},"required":["audienceId"],"type":"object"},"CreateAudio":{"properties":{"assetId":{"description":"The asset library ID associated with the audio asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the audio asset.","type":"string"}},"required":["assetId","assetVersion"],"type":"object"},"CreateAudioCreative":{"description":"| CreateAudioCreative | Description |\n| --- | --- |\n| `standardAudioSettings` | The standard audio experience settings. See the Audio Spec for more info: https://advertising.amazon.com/en-us/resources/ad-specs/audio-ads?ref_\u003da20m_us_spcs_spcs_aa |","oneOf":[{"properties":{"standardAudioSettings":{"$ref":"#/components/schemas/CreateStandardAudioExperienceSettings"}},"required":["standardAudioSettings"],"title":"standardAudioSettings","type":"object"}]},"CreateAutoCollectionSettings":{"description":"Settings for automatically generated collections.","properties":{"productExclusions":{"description":"Products to exclude from auto collection.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":1000,"minItems":0,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/CreateSharedCollectionSettings"}},"required":["sharedSettings"],"type":"object"},"CreateAutoCreationSettings":{"properties":{"autoCreateTargets":{"description":"Gives Amazon permission to automatically create targets associated with the campaign based on the products being advertised.","type":"boolean"},"autoManageCampaign":{"description":"Flag that allows Amazon to manage the lifecycle of your Campaign.","type":"boolean"}},"type":"object"},"CreateBidAdjustments":{"properties":{"audienceBidAdjustments":{"description":"Bid Adjustments based on the audiences","items":{"$ref":"#/components/schemas/CreateAudienceBidAdjustment"},"maxItems":1,"minItems":0,"type":"array"},"creativeBidAdjustments":{"description":"Bid Adjustments based on ads being shown as a creative. Range of bid adjustment value would be 0:900","items":{"$ref":"#/components/schemas/CreateCreativeBidAdjustment"},"maxItems":2,"minItems":0,"type":"array"},"placementBidAdjustments":{"description":"Bid adjustments based on ad placements.","items":{"$ref":"#/components/schemas/CreatePlacementBidAdjustment"},"maxItems":4,"minItems":0,"type":"array"},"shopperSegmentBidAdjustments":{"description":"Legacy SB field (marked for deprecation)","items":{"$ref":"#/components/schemas/CreateShopperSegmentBidAdjustment"},"maxItems":2,"minItems":0,"type":"array"}},"type":"object"},"CreateBidSettings":{"properties":{"bidAdjustments":{"$ref":"#/components/schemas/CreateBidAdjustments"},"bidStrategy":{"$ref":"#/components/schemas/BidStrategy"}},"type":"object"},"CreateBrandSafetyCategoryTarget":{"description":"Target based on, if any, the classifications of unsuitable contexts that may pose a risk to a brand\u0027s reputation of content being viewed.","properties":{"brandSafetyCategory":{"$ref":"#/components/schemas/BrandSafetyCategory"}},"required":["brandSafetyCategory"],"type":"object"},"CreateBrandSafetyTierTarget":{"description":"Target based on the brand suitability risk levels of content being viewed.","properties":{"brandSafetyTier":{"$ref":"#/components/schemas/BrandSafetyTier"}},"required":["brandSafetyTier"],"type":"object"},"CreateBrandStoreCallToAction":{"oneOf":[{"properties":{"brandStoreCallToActionSettings":{"$ref":"#/components/schemas/CreateBrandStoreCallToActionSettings"}},"required":["brandStoreCallToActionSettings"],"title":"brandStoreCallToActionSettings","type":"object"}]},"CreateBrandStoreCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for BrandStore.","items":{"$ref":"#/components/schemas/BrandStoreCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["url"],"type":"object"},"CreateBrandStoreSettings":{"properties":{"additionalHtml":{"description":"Additional HTML to include with the render response for display inventory targets.","type":"string"},"bodyText":{"description":"The body text to use for the Brand Store Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"brand":{"description":"The brand of the product(s) being advertised.","type":"string"},"callToActions":{"$ref":"#/components/schemas/CreateBrandStoreCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":0,"type":"array"},"disclaimers":{"description":"The disclaimers to use for the Brand Store Creative experience.","type":"string"},"headlines":{"description":"The headline(s) to use for the Brand Store Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":1,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"$ref":"#/components/schemas/CreateImage"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":1,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":1,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":1,"type":"array"}},"required":["brand","callToActions","headlines","inventoryTypes","language","optimizationGoalKpi","responsiveSizingBehavior","squareImages","tallImages","wideImages"],"type":"object"},"CreateBudget":{"properties":{"budgetType":{"$ref":"#/components/schemas/BudgetType"},"budgetValue":{"$ref":"#/components/schemas/CreateBudgetValue"},"recurrenceTimePeriod":{"$ref":"#/components/schemas/Recurrence"}},"required":["budgetType","budgetValue","recurrenceTimePeriod"],"type":"object"},"CreateBudgetSettings":{"properties":{"budgetAllocation":{"$ref":"#/components/schemas/BudgetAllocation"},"flightBudgetRolloverStrategy":{"$ref":"#/components/schemas/RolloverStrategy"},"offAmazonBudgetControlStrategy":{"$ref":"#/components/schemas/OffAmazonBudgetControlStrategy"}},"type":"object"},"CreateBudgetValue":{"oneOf":[{"properties":{"monetaryBudgetValue":{"$ref":"#/components/schemas/CreateMonetaryBudgetValue"}},"required":["monetaryBudgetValue"],"title":"monetaryBudgetValue","type":"object"}]},"CreateCampaignFee":{"properties":{"feeType":{"$ref":"#/components/schemas/CampaignFeeType"},"feeValue":{"description":"A service fee that is subtracted from the campaign budget as a percent of budget. This setting can’t be changed after an ad group has been added to a campaign.","format":"double","type":"number"},"feeValueType":{"$ref":"#/components/schemas/CampaignFeeValueType"}},"required":["feeType","feeValue","feeValueType"],"type":"object"},"CreateCampaignFlight":{"properties":{"budget":{"$ref":"#/components/schemas/CreateFlightBudget"},"endDateTime":{"description":"The end date of the flight.","format":"date-time","type":"string"},"flightId":{"description":"The ID associated with the flight.","type":"string"},"name":{"description":"The name of the flight.","type":"string"},"startDateTime":{"description":"The start date of the flight.","format":"date-time","type":"string"}},"required":["budget","endDateTime","startDateTime"],"type":"object"},"CreateCampaignOptimizations":{"properties":{"bidSettings":{"$ref":"#/components/schemas/CreateBidSettings"},"budgetSettings":{"$ref":"#/components/schemas/CreateBudgetSettings"},"goalSettings":{"$ref":"#/components/schemas/CreateGoalSettings"},"primaryInventoryTypes":{"description":"Primary inventory type of the campaign for filtering KPIs and recommending tactics.","items":{"$ref":"#/components/schemas/PrimaryInventoryType"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"CreateCampaignRequest":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/CampaignCreate"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"CreateCardCreativeElement":{"properties":{"headline":{"description":"The headline used for the card.","type":"string"},"landingPage":{"$ref":"#/components/schemas/CreateStoreSpotlightLandingPage"},"products":{"$ref":"#/components/schemas/CreateAdvertisedProducts"}},"required":["headline","landingPage","products"],"type":"object"},"CreateClickToAppDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The app that customers are directed to.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"CreateClickToUrlDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"CreateClickToUrlVideoCallToActionSettings":{"properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The url to redirect the user via the video CallToAction.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"CreateCollectionLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/CollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page.","type":"string"}},"required":["landingPageType"],"type":"object"},"CreateComponentCreative":{"properties":{"assetBasedCreativeSettings":{"$ref":"#/components/schemas/CreateAssetBasedCreativeSettings"},"autoCollectionSettings":{"$ref":"#/components/schemas/CreateAutoCollectionSettings"},"brandStoreSettings":{"$ref":"#/components/schemas/CreateBrandStoreSettings"},"manualCollectionSettings":{"$ref":"#/components/schemas/CreateManualCollectionSettings"},"productCollectionSettings":{"$ref":"#/components/schemas/CreateProductCollectionSettings"},"productVideoSettings":{"$ref":"#/components/schemas/CreateProductVideoSettings"},"responsiveEcommerceSettings":{"$ref":"#/components/schemas/CreateResponsiveEcommerceSettings"},"storeSpotlightSettings":{"$ref":"#/components/schemas/CreateStoreSpotlightSettings"}},"type":"object"},"CreateComponentLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/ComponentLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"CreateConstituentIndexValue":{"description":"Values for a location index where the indexValue is calculated from the constituents.","properties":{"brandSales":{"description":"The brand sales value for the postal code.","format":"double","type":"number"},"categorySales":{"description":"The category sales value for the postal code.","format":"double","type":"number"},"postalCode":{"description":"The postal code for the location index prefixed by country code (i.e. US-10118).","type":"string"}},"required":["brandSales","categorySales","postalCode"],"type":"object"},"CreateConstituentIndexValues":{"properties":{"values":{"description":"List of brand and category sales values.","items":{"$ref":"#/components/schemas/CreateConstituentIndexValue"},"maxItems":1000000,"minItems":1,"type":"array"}},"required":["values"],"type":"object"},"CreateContentCategoryTarget":{"description":"Target based on the category of content being viewed.","properties":{"contentCategoryId":{"description":"The content category being targeted.","type":"string"}},"required":["contentCategoryId"],"type":"object"},"CreateContentGenreTarget":{"description":"Target based on the genre of content being viewed.","properties":{"contentGenre":{"$ref":"#/components/schemas/ContentGenre"}},"required":["contentGenre"],"type":"object"},"CreateContentInstreamPositionTarget":{"description":"Targets ads in the specified content instream position","properties":{"instreamPosition":{"$ref":"#/components/schemas/ContentInstreamPosition"}},"required":["instreamPosition"],"type":"object"},"CreateContentOutstreamPositionTarget":{"description":"Targets ads in the specified content outstream position","properties":{"outstreamPosition":{"$ref":"#/components/schemas/ContentOutstreamPosition"}},"required":["outstreamPosition"],"type":"object"},"CreateContentRating":{"oneOf":[{"properties":{"dspContentRating":{"$ref":"#/components/schemas/CreateDspContentRating"}},"required":["dspContentRating"],"title":"dspContentRating","type":"object"},{"properties":{"twitchContentRating":{"$ref":"#/components/schemas/CreateTwitchContentRating"}},"required":["twitchContentRating"],"title":"twitchContentRating","type":"object"}]},"CreateContentRatingTarget":{"description":"Target based on the rating of content being viewed.","properties":{"contentRatingType":{"$ref":"#/components/schemas/ContentRatingTypes"},"contentRatingTypeDetails":{"$ref":"#/components/schemas/CreateContentRating"}},"required":["contentRatingType","contentRatingTypeDetails"],"type":"object"},"CreateCreative":{"oneOf":[{"properties":{"audioCreative":{"$ref":"#/components/schemas/CreateAudioCreative"}},"required":["audioCreative"],"title":"audioCreative","type":"object"},{"properties":{"displayCreative":{"$ref":"#/components/schemas/CreateDisplayCreative"}},"required":["displayCreative"],"title":"displayCreative","type":"object"},{"properties":{"thirdPartyCreative":{"$ref":"#/components/schemas/CreateThirdPartyCreative"}},"required":["thirdPartyCreative"],"title":"thirdPartyCreative","type":"object"},{"properties":{"videoCreative":{"$ref":"#/components/schemas/CreateVideoCreative"}},"required":["videoCreative"],"title":"videoCreative","type":"object"},{"properties":{"componentCreative":{"$ref":"#/components/schemas/CreateComponentCreative"}},"required":["componentCreative"],"title":"componentCreative","type":"object"},{"properties":{"productCreative":{"$ref":"#/components/schemas/CreateProductCreative"}},"required":["productCreative"],"title":"productCreative","type":"object"}]},"CreateCreativeBidAdjustment":{"properties":{"creativeType":{"$ref":"#/components/schemas/CreativeBidAdjustmentType"},"percentage":{"description":"The selection of the percentage change associated with the creative type and bid adjustment settings.","format":"int32","type":"integer"}},"required":["percentage"],"type":"object"},"CreateCreativeTrackingUrl":{"properties":{"url":{"description":"A url to be triggered for tracking events.","type":"string"}},"required":["url"],"type":"object"},"CreateDVBrandSafetyContentCategoriesWithRiskMap":{"description":"A map from content categories to risk level to exclude from targeting. Available keys are: [ADULT_CONTENT, ALCOHOL, CRIME, DEATH_INJURIES, DISASTER_AVIATION, DISASTER_MAN_MADE, DISASTER_NATURAL, DISASTER_TERRORIST_EVENTS, DISASTER_VEHICLE, HATE_SPEECH, PROFANITY, SUBSTANCE_ABUSE, TOBACCO_ECIGARETTES, VIOLENCE_EXTREME_GRAPHIC].","properties":{"key":{"description":"Available keys are: [ADULT_CONTENT, ALCOHOL, CRIME, DEATH_INJURIES, DISASTER_AVIATION, DISASTER_MAN_MADE, DISASTER_NATURAL, DISASTER_TERRORIST_EVENTS, DISASTER_VEHICLE, HATE_SPEECH, PROFANITY, SUBSTANCE_ABUSE, TOBACCO_ECIGARETTES, VIOLENCE_EXTREME_GRAPHIC].","type":"string"},"value":{"$ref":"#/components/schemas/BrandSuitabilityRiskLevelType"}},"required":["key","value"],"type":"object"},"CreateDayPartTarget":{"description":"Target based on time of day.","properties":{"dayOfWeek":{"$ref":"#/components/schemas/DayOfWeek"},"timeOfDay":{"$ref":"#/components/schemas/CreateTimeOfDay"}},"required":["dayOfWeek","timeOfDay"],"type":"object"},"CreateDeviceTarget":{"description":"Target based on user device.","properties":{"deviceOrientation":{"$ref":"#/components/schemas/DeviceOrientation"},"deviceType":{"$ref":"#/components/schemas/DeviceType"},"mobileDevice":{"$ref":"#/components/schemas/MobileDevice"},"mobileEnvironment":{"$ref":"#/components/schemas/MobileEnvironment"},"mobileOs":{"$ref":"#/components/schemas/MobileOs"}},"required":["deviceType"],"type":"object"},"CreateDirectIndexValue":{"description":"Values for a location index where the indexValue is the pre-calculated index.","properties":{"indexValue":{"description":"The pre-calculated index value.","format":"double","type":"number"},"postalCode":{"description":"The postal code for the location index prefixed by country code (i.e. US-10118).","type":"string"}},"required":["indexValue","postalCode"],"type":"object"},"CreateDirectIndexValues":{"properties":{"values":{"description":"List of direct index values.","items":{"$ref":"#/components/schemas/CreateDirectIndexValue"},"maxItems":1000000,"minItems":1,"type":"array"}},"required":["values"],"type":"object"},"CreateDisplayCallToAction":{"oneOf":[{"properties":{"clickToUrlDisplayCallToActionSettings":{"$ref":"#/components/schemas/CreateClickToUrlDisplayCallToActionSettings"}},"required":["clickToUrlDisplayCallToActionSettings"],"title":"clickToUrlDisplayCallToActionSettings","type":"object"},{"properties":{"clickToAppDisplayCallToActionSettings":{"$ref":"#/components/schemas/CreateClickToAppDisplayCallToActionSettings"}},"required":["clickToAppDisplayCallToActionSettings"],"title":"clickToAppDisplayCallToActionSettings","type":"object"}]},"CreateDisplayCreative":{"properties":{"standardDisplaySettings":{"$ref":"#/components/schemas/CreateStandardDisplaySettings"}},"type":"object"},"CreateDomainFileTarget":{"description":"Targets domains based on list provided via file upload.","properties":{"domainFileKey":{"description":"The S3 key of the uploaded file which can be obtained from the file upload policy endpoint. A max of 10 files may be associated to one ad group.","type":"string"},"domainFileName":{"description":"The name of the file.","type":"string"}},"required":["domainFileKey","domainFileName"],"type":"object"},"CreateDomainListTarget":{"description":"Targets domains based on an existing domain list.","properties":{"domainListId":{"description":"The ID of the domain list to target.","type":"string"}},"required":["domainListId"],"type":"object"},"CreateDomainNameTarget":{"description":"Targets domains based on URL.","properties":{"domainName":{"description":"The URL of the domain to target.","type":"string"}},"required":["domainName"],"type":"object"},"CreateDomainTarget":{"description":"Target based on a specified domain.","properties":{"domainTargetDetails":{"$ref":"#/components/schemas/CreateDomainTargetDetails"},"domainTargetType":{"$ref":"#/components/schemas/DomainTargetTypes"}},"required":["domainTargetDetails","domainTargetType"],"type":"object"},"CreateDomainTargetDetails":{"oneOf":[{"properties":{"domainListTarget":{"$ref":"#/components/schemas/CreateDomainListTarget"}},"required":["domainListTarget"],"title":"domainListTarget","type":"object"},{"properties":{"domainNameTarget":{"$ref":"#/components/schemas/CreateDomainNameTarget"}},"required":["domainNameTarget"],"title":"domainNameTarget","type":"object"},{"properties":{"domainFileTarget":{"$ref":"#/components/schemas/CreateDomainFileTarget"}},"required":["domainFileTarget"],"title":"domainFileTarget","type":"object"},{"properties":{"advertiserDomainList":{"$ref":"#/components/schemas/CreateAdvertiserDomainList"}},"required":["advertiserDomainList"],"title":"advertiserDomainList","type":"object"}]},"CreateDoubleVerifyAuthenticAttention":{"properties":{"universalAttention":{"description":"One omni-channel segment that is informed by data from all DV campaigns to help avoid serving ads on generally poor performing apps and domains.","type":"boolean"}},"required":["universalAttention"],"type":"object"},"CreateDoubleVerifyAuthenticBrandSafety":{"properties":{"doubleVerifySegmentId":{"pattern":"^51[0-9]{6}$","type":"string"}},"type":"object"},"CreateDoubleVerifyBrandSafety":{"properties":{"appAgeRating":{"description":"A list of app age ratings to be used for excluding apps. For example, TEENS_12_PLUS will only exclude apps with content rated for everyone ages 12 and over. UNKNOWN will exclude apps with content unrated or unknown to Double Verify.","items":{"$ref":"#/components/schemas/DVBrandSafetyAppAgeRatingType"},"maxItems":50,"minItems":0,"type":"array"},"appStarRating":{"$ref":"#/components/schemas/DVBrandSafetyAppStarRatingType"},"contentCategories":{"description":"A list of content categories to exclude from targeting.","items":{"$ref":"#/components/schemas/DVBrandSafetyContentCategoryType"},"maxItems":50,"minItems":0,"type":"array"},"contentCategoriesWithRisk":{"items":{"$ref":"#/components/schemas/CreateDVBrandSafetyContentCategoriesWithRiskMap"},"maxItems":50,"minItems":0,"type":"array"},"excludeAppsWithInsufficientRating":{"description":"Set to true to exclude unofficial apps or apps with insufficient user ratings (\u003c100 lifetime).","type":"boolean"},"unknownContent":{"description":"Set to true to exclude unknown content.","type":"boolean"}},"type":"object"},"CreateDoubleVerifyCustomContextualSegmentId":{"properties":{"doubleVerifySegmentId":{"pattern":"^52[0-9]{6}$","type":"string"}},"type":"object"},"CreateDoubleVerifyFraudInvalidTraffic":{"properties":{"blockAppAndSites":{"description":"Set to true to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen.","type":"boolean"},"excludeAppsAndSites":{"$ref":"#/components/schemas/ExcludeAppsAndSitesType"},"excludeImpressions":{"description":"Set to true to exclude impressions delivered to devices identified to be fraudulent or invalid.","type":"boolean"}},"type":"object"},"CreateDoubleVerifyStandardDisplayBrandSafety":{"properties":{"contentCategories":{"description":"A list of content categories to exclude from targeting.","items":{"$ref":"#/components/schemas/DVBrandSafetyContentCategoryType"},"maxItems":50,"minItems":0,"type":"array"},"contentCategoriesWithRisk":{"items":{"$ref":"#/components/schemas/CreateDVBrandSafetyContentCategoriesWithRiskMap"},"maxItems":50,"minItems":0,"type":"array"},"unknownContent":{"description":"Set to true to exclude unknown content.","type":"boolean"}},"type":"object"},"CreateDoubleVerifyViewability":{"properties":{"averageCompletionAndFullyViewableRateTargeting":{"$ref":"#/components/schemas/AverageCompletionAndFullyViewableRateTargetingType"},"brandExposureViewabilityTargeting":{"$ref":"#/components/schemas/BrandExposureViewabilityTargetingType"},"includeUnmeasurableImpressions":{"description":"Set to true to include impressions where impressions can\u0027t be measured.","type":"boolean"},"mrcViewabilityTargeting":{"$ref":"#/components/schemas/MrcViewabilityTargetingType"}},"type":"object"},"CreateDspContentRating":{"properties":{"dspContentRating":{"$ref":"#/components/schemas/DspContentRatingEnum"}},"required":["dspContentRating"],"type":"object"},"CreateFee":{"properties":{"addToBudgetSpentAmount":{"description":"Applies only to THIRD_PARTY_APPLIED_FEE. When set to true, third-party applied fees are are added on top of the total ad group budget spent amount in reports.","type":"boolean"},"feeType":{"$ref":"#/components/schemas/FeeType"},"feeValue":{"description":"The fee amount expressed as the feeValueType. AMAZON_AUDIENCE_FEE AND THIRD_PARTY_AUDIENCE_FEE is in the currency of the marketplace. All other CPM based fees are in the currency of the advertiser. For percentages, 100 represents 100%.","format":"double","type":"number"},"thirdPartyProvider":{"$ref":"#/components/schemas/FeesThirdPartyProvider"}},"required":["addToBudgetSpentAmount","feeType","feeValue","thirdPartyProvider"],"type":"object"},"CreateFlightBudget":{"properties":{"budgetType":{"$ref":"#/components/schemas/BudgetType"},"budgetValue":{"$ref":"#/components/schemas/CreateBudgetValue"}},"required":["budgetType","budgetValue"],"type":"object"},"CreateFoldPositionTarget":{"description":"Targets ads in the specified fold position","properties":{"foldPosition":{"$ref":"#/components/schemas/FoldPosition"}},"required":["foldPosition"],"type":"object"},"CreateFormatProperties":{"properties":{"applyBorder":{"description":"Apply a boarder to the image to fit rules for some supplies.","type":"boolean"},"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"},"CreateFrequency":{"properties":{"eventMaxCount":{"description":"The maximum number of times an EventType is served per user. For ADSP ad group, maximum supported value is 500.","format":"int32","maximum":99000,"minimum":1,"type":"integer"},"frequencyTargetingSetting":{"$ref":"#/components/schemas/FrequencyTargetingSetting"},"timeCount":{"description":"The value associated with the time and unit of time for this frequency cap.","format":"int32","maximum":60,"minimum":1,"type":"integer"},"timeUnit":{"$ref":"#/components/schemas/TimeUnit"}},"required":["eventMaxCount","frequencyTargetingSetting","timeCount","timeUnit"],"type":"object"},"CreateGeoLocationRequest":{"properties":{"geoLocations":{"items":{"$ref":"#/components/schemas/GeoLocationCreate"},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"CreateGeoLocationUnion":{"oneOf":[{"properties":{"smartLocation":{"$ref":"#/components/schemas/CreateSmartLocation"}},"required":["smartLocation"],"title":"smartLocation","type":"object"}]},"CreateGlobalStoreSettings":{"properties":{"catalogSourceMarketplace":{"$ref":"#/components/schemas/Marketplace"}},"type":"object"},"CreateGoalSettings":{"properties":{"kpi":{"$ref":"#/components/schemas/KPI"},"kpiValue":{"description":"The value of the KPI that the campaign is working to optimize.","format":"double","type":"number"}},"required":["kpi"],"type":"object"},"CreateImage":{"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/CreateFormatProperties"},"maxItems":10,"minItems":0,"type":"array"}},"required":["assetId","assetVersion"],"type":"object"},"CreateIndexValues":{"oneOf":[{"properties":{"directIndexValues":{"$ref":"#/components/schemas/CreateDirectIndexValues"}},"required":["directIndexValues"],"title":"directIndexValues","type":"object"},{"properties":{"constituentIndexValues":{"$ref":"#/components/schemas/CreateConstituentIndexValues"}},"required":["constituentIndexValues"],"title":"constituentIndexValues","type":"object"}]},"CreateIntegralAdScienceBrandSafety":{"properties":{"excludeContent":{"description":"Set to true to exclude content that Integral Ad Science is not able to rate.","type":"boolean"},"iasBrandSafetyAdult":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyAlcohol":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyGambling":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyHateSpeech":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyIllegalDownloads":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyIllegalDrugs":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyOffensiveLanguage":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyViolence":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"}},"type":"object"},"CreateIntegralAdScienceContextualAvoidance":{"properties":{"avoidanceSegments":{"description":"The unique identifier of the IAS contextual avoidance segment","items":{"type":"string"},"maxItems":200,"minItems":0,"type":"array"}},"type":"object"},"CreateIntegralAdScienceContextualTargeting":{"properties":{"topicalSegments":{"description":"The unique identifier of the IAS contextual topical targeting segment","items":{"type":"string"},"maxItems":200,"minItems":0,"type":"array"},"verticalSegments":{"description":"The unique identifier of the IAS contextual vertical targeting segment","items":{"type":"string"},"maxItems":200,"minItems":0,"type":"array"}},"type":"object"},"CreateIntegralAdScienceFraudInvalidTraffic":{"properties":{"targetSetting":{"$ref":"#/components/schemas/IASFraudInvalidTrafficType"}},"type":"object"},"CreateIntegralAdScienceQualitySync":{"properties":{"segmentId":{"pattern":"^4[0-9]{6}$","type":"string"}},"type":"object"},"CreateIntegralAdScienceViewability":{"description":"The IAS viewability standard.","properties":{"standard":{"$ref":"#/components/schemas/IASViewabilityStandardType"},"viewabilityTargeting":{"$ref":"#/components/schemas/ViewabilityTierType"}},"required":["standard"],"type":"object"},"CreateInventorySourceTarget":{"description":"Target based on the source of the inventory.","properties":{"inventorySourceId":{"$ref":"#/components/schemas/CreateMarketplaceStringValue"},"inventorySourceType":{"$ref":"#/components/schemas/InventorySourceType"}},"required":["inventorySourceId","inventorySourceType"],"type":"object"},"CreateKeywordTarget":{"description":"Targets a specific customer search term.","properties":{"keyword":{"description":"The customer search term or text to target","type":"string"},"matchType":{"$ref":"#/components/schemas/KeywordMatchType"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"nativeLanguageLocale":{"$ref":"#/components/schemas/LanguageLocale"}},"required":["keyword","matchType"],"type":"object"},"CreateLandingPageAsins":{"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"},"CreateLearnMoreVideoCallToActionSettings":{"properties":{"url":{"description":"The url to drive users to learn more via the video CallToAction.","type":"string"}},"required":["url"],"type":"object"},"CreateLocationIndexRequest":{"properties":{"locationIndexes":{"items":{"$ref":"#/components/schemas/LocationIndexCreate"},"maxItems":10,"minItems":1,"type":"array"}},"type":"object"},"CreateLocationTarget":{"description":"Target based on geographic location.","properties":{"locationId":{"description":"The ID of the geographic location to target.","type":"string"},"locationIdResolved":{"description":"A human-readable location text. It\u0027s a read-only field.","type":"string"}},"required":["locationId"],"type":"object"},"CreateManualCollectionSettings":{"description":"Settings for manually curated collections.","properties":{"landingPage":{"$ref":"#/components/schemas/CreateCollectionLandingPage"},"productInclusions":{"description":"The products featured in the ad. Required for manual collections.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":10,"minItems":3,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/CreateSharedCollectionSettings"}},"required":["landingPage","productInclusions","sharedSettings"],"type":"object"},"CreateMarketplaceAdConfigurations":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"overrides":{"$ref":"#/components/schemas/CreateMarketplaceAdFieldOverrides"}},"required":["marketplace","overrides"],"type":"object"},"CreateMarketplaceAdFieldOverrides":{"properties":{"state":{"$ref":"#/components/schemas/State"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"CreateMarketplaceAdGroupConfigurations":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"overrides":{"$ref":"#/components/schemas/CreateMarketplaceAdGroupFieldOverrides"}},"required":["marketplace","overrides"],"type":"object"},"CreateMarketplaceAdGroupFieldOverrides":{"properties":{"name":{"description":"The name of the ad group for this marketplace","type":"string"},"state":{"$ref":"#/components/schemas/State"},"tags":{"description":"Marketplace specific tags for the ad group","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"CreateMarketplaceCampaignConfigurations":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"overrides":{"$ref":"#/components/schemas/CreateMarketplaceCampaignFieldOverrides"}},"required":["marketplace","overrides"],"type":"object"},"CreateMarketplaceCampaignFieldOverrides":{"properties":{"endDateTime":{"description":"The end date time for the campaign","format":"date-time","type":"string"},"name":{"description":"The name of the campaign","type":"string"},"optimizations":{"$ref":"#/components/schemas/CreateCampaignOptimizations"},"startDateTime":{"description":"The start date time for the campaign","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/State"},"tags":{"description":"Open ended labels with a key value pair applied to the campaign","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"CreateMarketplaceStringValue":{"properties":{"defaultValue":{"description":"The default value. Either the default value or the marketplace settings should always be specified","type":"string"}},"type":"object"},"CreateMarketplaceTargetConfigurations":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"overrides":{"$ref":"#/components/schemas/CreateMarketplaceTargetFieldOverrides"}},"required":["marketplace","overrides"],"type":"object"},"CreateMarketplaceTargetFieldOverrides":{"properties":{"state":{"$ref":"#/components/schemas/State"},"tags":{"description":"Open ended labels with a key value pair applied to the target","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"},"targetDetails":{"$ref":"#/components/schemas/CreateOverridableTargets"}},"type":"object"},"CreateMonetaryBudget":{"properties":{"value":{"description":"The monetary amount of the budget cap in the given currency.","format":"double","type":"number"}},"required":["value"],"type":"object"},"CreateMonetaryBudgetMarketplaceSetting":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"monetaryBudget":{"$ref":"#/components/schemas/CreateMonetaryBudget"}},"required":["marketplace","monetaryBudget"],"type":"object"},"CreateMonetaryBudgetValue":{"properties":{"marketplaceSettings":{"description":"List of Monetary Budget values selectively applied at the given marketplace level","items":{"$ref":"#/components/schemas/CreateMonetaryBudgetMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"monetaryBudget":{"$ref":"#/components/schemas/CreateMonetaryBudget"}},"type":"object"},"CreateNativeContentPositionTarget":{"description":"Targets ads to a specific native content position","properties":{"nativePosition":{"$ref":"#/components/schemas/NativeContentPosition"}},"required":["nativePosition"],"type":"object"},"CreateNewsGuardBrandGuardMisinformationSafety":{"properties":{"avoidanceList":{"description":"The unique identifiers of misinformation targets","items":{"$ref":"#/components/schemas/NewsGuardBrandGuardMisinformationSafetyType"},"maxItems":20,"minItems":0,"type":"array"}},"type":"object"},"CreateNewsGuardBrandGuardTrustedNewsTargeting":{"description":"Only applicable for Web supply.","properties":{"targetingList":{"description":"The unique identifiers of trusted news targets","items":{"$ref":"#/components/schemas/NewsGuardBrandGuardTrustedNewsTargetingType"},"maxItems":15,"minItems":0,"type":"array"}},"type":"object"},"CreateOnlineVideoSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/CreateVideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"videos":{"$ref":"#/components/schemas/CreateVideo"}},"required":["language","videos"],"type":"object"},"CreateOptimization":{"properties":{"bidStrategy":{"$ref":"#/components/schemas/BidStrategy"},"budgetSettings":{"$ref":"#/components/schemas/CreateAdGroupBudgetSettings"},"goalSettings":{"$ref":"#/components/schemas/CreateAdGroupGoalSettings"}},"type":"object"},"CreateOverridableTargets":{"oneOf":[{"properties":{"keywordTarget":{"$ref":"#/components/schemas/CreateKeywordTarget"}},"required":["keywordTarget"],"title":"keywordTarget","type":"object"},{"properties":{"themeTarget":{"$ref":"#/components/schemas/CreateThemeTarget"}},"required":["themeTarget"],"title":"themeTarget","type":"object"}]},"CreatePacing":{"properties":{"deliveryProfile":{"$ref":"#/components/schemas/DeliveryProfile"}},"required":["deliveryProfile"],"type":"object"},"CreatePixalateFraudInvalidTraffic":{"properties":{"excludeAppsAndDomains":{"description":"Set to true to exclude traffic from Apps and Domains identified to be fraudulent or invalid.","type":"boolean"},"excludeIpAddressAndUserAgents":{"description":"Set to true to exclude traffic from IPV4 and IPV6 addresses and user agents identified to be fraudulent or invalid.","type":"boolean"},"excludeOttAndMobileDevices":{"description":"Set to true to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid.","type":"boolean"},"excludeRemovedAppsFromAppStores":{"description":"Set to true to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months.","type":"boolean"}},"type":"object"},"CreatePlacementBidAdjustment":{"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/Placement"}},"required":["percentage","placement"],"type":"object"},"CreatePlacementTypeTarget":{"description":"Target based on the placement type.","properties":{"placementType":{"$ref":"#/components/schemas/PlacementType"}},"required":["placementType"],"type":"object"},"CreateProductAudienceTarget":{"description":"Target customers who have viewed or purchased a certain product within a specified lookback window.","properties":{"asin":{"$ref":"#/components/schemas/CreateMarketplaceStringValue"},"event":{"$ref":"#/components/schemas/TargetEvent"},"lookback":{"$ref":"#/components/schemas/Lookback"},"matchType":{"$ref":"#/components/schemas/ProductAudienceMatchType"}},"required":["asin","event","lookback","matchType"],"type":"object"},"CreateProductCategoryRefinement":{"properties":{"productAgeRangeId":{"description":"The age range ID to target.","type":"string"},"productAgeRangeIdResolved":{"description":"The resolved age range to target.","type":"string"},"productBrandId":{"description":"The brand ID to target.","type":"string"},"productBrandIdResolved":{"description":"The resolved name of the brand.","type":"string"},"productCategoryId":{"description":"The product category ID to target.","type":"string"},"productCategoryIdResolved":{"description":"The resolved product category.","type":"string"},"productGenreId":{"description":"The product genre ID to target.","type":"string"},"productPriceGreaterThan":{"description":"Refinement to target products with a price greater than the value within the product category.","format":"double","type":"number"},"productPriceLessThan":{"description":"Refinement to target products with a price less than the value within the product category.","format":"double","type":"number"},"productPrimeShippingEligible":{"description":"Target based on if a product is Prime-shipping eligible.","type":"boolean"},"productRatingGreaterThan":{"description":"Refinement to target products with a rating greater than the value within the product category.","format":"double","type":"number"},"productRatingLessThan":{"description":"Refinement to target products with a rating less than the value within the product category.","format":"double","type":"number"}},"type":"object"},"CreateProductCategoryRefinementMarketplaceSetting":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"productCategoryRefinement":{"$ref":"#/components/schemas/CreateProductCategoryRefinement"}},"required":["marketplace","productCategoryRefinement"],"type":"object"},"CreateProductCategoryRefinementValue":{"properties":{"marketplaceSettings":{"description":"Marketplace specific product category refinements. Either the value or the marketplaceSettings should always be specified","items":{"$ref":"#/components/schemas/CreateProductCategoryRefinementMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"productCategoryRefinement":{"$ref":"#/components/schemas/CreateProductCategoryRefinement"}},"type":"object"},"CreateProductCategoryTarget":{"description":"Targets a specific customer search term.","properties":{"matchType":{"$ref":"#/components/schemas/ProductCategoryMatchType"},"productCategoryRefinement":{"$ref":"#/components/schemas/CreateProductCategoryRefinementValue"},"productGenreRefinement":{"$ref":"#/components/schemas/CreateProductGenreRefinement"}},"required":["productCategoryRefinement"],"type":"object"},"CreateProductCollectionLandingPage":{"properties":{"landingPageAsins":{"$ref":"#/components/schemas/CreateLandingPageAsins"},"landingPageType":{"$ref":"#/components/schemas/ProductCollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page. Read only if landingPageType is ASIN_LIST","type":"string"}},"required":["landingPageType"],"type":"object"},"CreateProductCollectionSettings":{"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/CreateImage"},"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/ProductCollectionCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"customImages":{"description":"The set of custom images featured in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"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/CreateProductCollectionLandingPage"},"products":{"description":"The products featured in the ad.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":3,"minItems":0,"type":"array"}},"required":["brand","brandLogos","customImages","headlines","landingPage"],"type":"object"},"CreateProductCreative":{"properties":{"productCreativeSettings":{"$ref":"#/components/schemas/CreateProductCreativeSettings"}},"required":["productCreativeSettings"],"type":"object"},"CreateProductCreativeSettings":{"description":"An ad with a creative built based on the product being advertised.","properties":{"advertisedProduct":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"headline":{"description":"The headline/custom text associated with the ad creative.","type":"string"},"spotlightVideos":{"$ref":"#/components/schemas/CreateSpotlightVideoSettings"}},"required":["advertisedProduct"],"type":"object"},"CreateProductGenreRefinement":{"properties":{"productGenreId":{"description":"The product genre ID to target.","type":"string"}},"required":["productGenreId"],"type":"object"},"CreateProductMarketplaceSetting":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"productId":{"description":"The product id applicable at the specified marketplace.","type":"string"}},"required":["marketplace","productId"],"type":"object"},"CreateProductTarget":{"description":"Targets a specific product.","properties":{"matchType":{"$ref":"#/components/schemas/ProductMatchType"},"product":{"$ref":"#/components/schemas/CreateProductValue"},"productIdType":{"$ref":"#/components/schemas/ProductIdType"}},"required":["matchType","product","productIdType"],"type":"object"},"CreateProductValue":{"properties":{"marketplaceSettings":{"description":"The product ids at specific marketplace level. Either the product id or the marketplace settings should always be specified","items":{"$ref":"#/components/schemas/CreateProductMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"productId":{"description":"The product identifier. Either the product id or the marketplace settings should always be specified","type":"string"}},"type":"object"},"CreateProductVideoSettings":{"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/CreateImage"},"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/CreateVideoLandingPage"},"products":{"description":"The products featured in the video ad.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":3,"minItems":0,"type":"array"},"videos":{"description":"The video assets used in the ad.","items":{"$ref":"#/components/schemas/CreateVideo"},"maxItems":2,"minItems":1,"type":"array"}},"required":["videos"],"type":"object"},"CreatePromptExtension":{"description":"Prompts Ad Extension","properties":{"promptText":{"description":"The prompt text rendered in the ads","type":"string"}},"required":["promptText"],"type":"object"},"CreateResponsiveEcommerceLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/ResponsiveEcommerceLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"CreateResponsiveEcommerceSettings":{"properties":{"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/ResponsiveEcommerceCreativePropertiesToOptimize"},"maxItems":3,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":0,"type":"array"},"disclaimers":{"description":"The disclaimer to use for the Responsive eCommerce experience.","type":"string"},"headlines":{"description":"The headline to use for the Responsive eCommerce experience.","type":"string"},"images":{"description":"The image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":3,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/CreateResponsiveEcommerceLandingPage"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"$ref":"#/components/schemas/CreateImage"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"products":{"description":"The products advertised for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":20,"minItems":0,"type":"array"},"recAdVariations":{"description":"The rendering variations selected for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/ResponsiveEcommerceAdVariations"},"maxItems":5,"minItems":0,"type":"array"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"supportedThirdPartySellers":{"$ref":"#/components/schemas/SupportedThirdPartySellers"}},"type":"object"},"CreateSharedCollectionSettings":{"description":"Settings shared by all collection types.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"$ref":"#/components/schemas/CreateImage"}},"required":["brand"],"type":"object"},"CreateShopperSegmentBidAdjustment":{"type":"object"},"CreateSize":{"properties":{"height":{"description":"The height of the creative placement.","format":"int32","type":"integer"},"width":{"description":"The width of the creative placement.","format":"int32","type":"integer"}},"required":["height","width"],"type":"object"},"CreateSmartLocation":{"description":"A smart location targets postal codes based on a sales index.","properties":{"locationIndexId":{"description":"The ID of the index used for this smart location.","type":"string"},"maxIndexValuePercentile":{"description":"Maximum percentile value (0-100). Must be greater than minIndexValuePercentile. Null will be treated as 0.","format":"int32","maximum":100,"minimum":0,"type":"integer"},"minIndexValuePercentile":{"description":"Minimum percentile value (0-100). Must be less than maxIndexValuePercentile. Null will be treated as 0.","format":"int32","maximum":100,"minimum":0,"type":"integer"},"name":{"description":"Name for the smart location.","type":"string"}},"required":["locationIndexId","name"],"type":"object"},"CreateSpotlightVideoSettings":{"description":"An ad with a creative built with spotlight videos.","properties":{"optimizeText":{"description":"If the advertiser wants text they provided to be optimized by Amazon or not.","type":"boolean"},"videos":{"description":"The video asset(s) to use for the Sponsored Product experience.","items":{"$ref":"#/components/schemas/CreateVideo"},"maxItems":5,"minItems":1,"type":"array"}},"required":["optimizeText","videos"],"type":"object"},"CreateStandardAudioExperienceSettings":{"properties":{"audio":{"$ref":"#/components/schemas/CreateAudio"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded. Urls cannot exceed 2048 characters.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"description":"The product(s) being advertised.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":10,"minItems":0,"type":"array"}},"required":["audio","language"],"type":"object"},"CreateStandardDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/AdChoicesPosition"},"callToAction":{"$ref":"#/components/schemas/CreateDisplayCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The list of placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":1,"type":"array"},"customImages":{"description":"The custom images to use for the standard display experience.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":20,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"}},"required":["adChoicesPosition","creativeSizes","customImages","language"],"type":"object"},"CreateState":{"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\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"},"CreateStoreSpotlightLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/StoreSpotlightLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"CreateStoreSpotlightSettings":{"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/CreateImage"},"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/CreateCardCreativeElement"},"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/StoreSpotlightCreativePropertiesToOptimize"},"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/CreateStoreSpotlightLandingPage"}},"required":["brand","brandLogos","cards","headlines","landingPage"],"type":"object"},"CreateStreamingTvSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/CreateVideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/CreateVideoLandingPage"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"description":"The product advertised on this video creative.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":20,"minItems":0,"type":"array"},"videos":{"$ref":"#/components/schemas/CreateVideo"}},"required":["videos"],"type":"object"},"CreateTag":{"properties":{"key":{"description":"A custom key value pair entered by the advertiser.","type":"string"},"value":{"description":"A custom key value pair entered by the advertiser.","type":"string"}},"required":["key","value"],"type":"object"},"CreateTargetBid":{"properties":{"bid":{"description":"The maximum bid for a target.","format":"double","type":"number"},"marketplaceSettings":{"description":"The bid associated with the target at specified marketplace level. Either one of bid or marketplaceSettings should always be specified","items":{"$ref":"#/components/schemas/CreateTargetBidMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"}},"type":"object"},"CreateTargetBidMarketplaceSetting":{"properties":{"bid":{"description":"The maximum bid for a target.","format":"double","type":"number"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"marketplace":{"$ref":"#/components/schemas/Marketplace"}},"required":["currencyCode","marketplace"],"type":"object"},"CreateTargetDetails":{"oneOf":[{"properties":{"keywordTarget":{"$ref":"#/components/schemas/CreateKeywordTarget"}},"required":["keywordTarget"],"title":"keywordTarget","type":"object"},{"properties":{"productTarget":{"$ref":"#/components/schemas/CreateProductTarget"}},"required":["productTarget"],"title":"productTarget","type":"object"},{"properties":{"productCategoryTarget":{"$ref":"#/components/schemas/CreateProductCategoryTarget"}},"required":["productCategoryTarget"],"title":"productCategoryTarget","type":"object"},{"properties":{"productAudienceTarget":{"$ref":"#/components/schemas/CreateProductAudienceTarget"}},"required":["productAudienceTarget"],"title":"productAudienceTarget","type":"object"},{"properties":{"audienceTarget":{"$ref":"#/components/schemas/CreateAudienceTarget"}},"required":["audienceTarget"],"title":"audienceTarget","type":"object"},{"properties":{"locationTarget":{"$ref":"#/components/schemas/CreateLocationTarget"}},"required":["locationTarget"],"title":"locationTarget","type":"object"},{"properties":{"domainTarget":{"$ref":"#/components/schemas/CreateDomainTarget"}},"required":["domainTarget"],"title":"domainTarget","type":"object"},{"properties":{"appTarget":{"$ref":"#/components/schemas/CreateAppTarget"}},"required":["appTarget"],"title":"appTarget","type":"object"},{"properties":{"deviceTarget":{"$ref":"#/components/schemas/CreateDeviceTarget"}},"required":["deviceTarget"],"title":"deviceTarget","type":"object"},{"properties":{"dayPartTarget":{"$ref":"#/components/schemas/CreateDayPartTarget"}},"required":["dayPartTarget"],"title":"dayPartTarget","type":"object"},{"properties":{"contentCategoryTarget":{"$ref":"#/components/schemas/CreateContentCategoryTarget"}},"required":["contentCategoryTarget"],"title":"contentCategoryTarget","type":"object"},{"properties":{"contentGenreTarget":{"$ref":"#/components/schemas/CreateContentGenreTarget"}},"required":["contentGenreTarget"],"title":"contentGenreTarget","type":"object"},{"properties":{"contentRatingTarget":{"$ref":"#/components/schemas/CreateContentRatingTarget"}},"required":["contentRatingTarget"],"title":"contentRatingTarget","type":"object"},{"properties":{"brandSafetyTierTarget":{"$ref":"#/components/schemas/CreateBrandSafetyTierTarget"}},"required":["brandSafetyTierTarget"],"title":"brandSafetyTierTarget","type":"object"},{"properties":{"brandSafetyCategoryTarget":{"$ref":"#/components/schemas/CreateBrandSafetyCategoryTarget"}},"required":["brandSafetyCategoryTarget"],"title":"brandSafetyCategoryTarget","type":"object"},{"properties":{"inventorySourceTarget":{"$ref":"#/components/schemas/CreateInventorySourceTarget"}},"required":["inventorySourceTarget"],"title":"inventorySourceTarget","type":"object"},{"properties":{"adInitiationTarget":{"$ref":"#/components/schemas/CreateAdInitiationTarget"}},"required":["adInitiationTarget"],"title":"adInitiationTarget","type":"object"},{"properties":{"adPlayerSizeTarget":{"$ref":"#/components/schemas/CreateAdPlayerSizeTarget"}},"required":["adPlayerSizeTarget"],"title":"adPlayerSizeTarget","type":"object"},{"properties":{"videoAdFormatTarget":{"$ref":"#/components/schemas/CreateVideoAdFormatTarget"}},"required":["videoAdFormatTarget"],"title":"videoAdFormatTarget","type":"object"},{"properties":{"thirdPartyTarget":{"$ref":"#/components/schemas/CreateThirdPartyTarget"}},"required":["thirdPartyTarget"],"title":"thirdPartyTarget","type":"object"},{"properties":{"themeTarget":{"$ref":"#/components/schemas/CreateThemeTarget"}},"required":["themeTarget"],"title":"themeTarget","type":"object"},{"properties":{"contentInstreamPositionTarget":{"$ref":"#/components/schemas/CreateContentInstreamPositionTarget"}},"required":["contentInstreamPositionTarget"],"title":"contentInstreamPositionTarget","type":"object"},{"properties":{"contentOutstreamPositionTarget":{"$ref":"#/components/schemas/CreateContentOutstreamPositionTarget"}},"required":["contentOutstreamPositionTarget"],"title":"contentOutstreamPositionTarget","type":"object"},{"properties":{"videoContentDurationTarget":{"$ref":"#/components/schemas/CreateVideoContentDurationTarget"}},"required":["videoContentDurationTarget"],"title":"videoContentDurationTarget","type":"object"},{"properties":{"foldPositionTarget":{"$ref":"#/components/schemas/CreateFoldPositionTarget"}},"required":["foldPositionTarget"],"title":"foldPositionTarget","type":"object"},{"properties":{"nativeContentPositionTarget":{"$ref":"#/components/schemas/CreateNativeContentPositionTarget"}},"required":["nativeContentPositionTarget"],"title":"nativeContentPositionTarget","type":"object"},{"properties":{"placementTypeTarget":{"$ref":"#/components/schemas/CreatePlacementTypeTarget"}},"required":["placementTypeTarget"],"title":"placementTypeTarget","type":"object"}]},"CreateTargetRequest":{"properties":{"targets":{"items":{"$ref":"#/components/schemas/TargetCreate"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"CreateTargetingSettings":{"properties":{"amazonViewability":{"$ref":"#/components/schemas/CreateAmazonViewability"},"automatedTargetingTactic":{"$ref":"#/components/schemas/AutomatedTargetingTactic"},"defaultAudienceTargetingMatchType":{"$ref":"#/components/schemas/DefaultAudienceTargetingMatchType"},"enableLanguageTargeting":{"description":"If set to true, creatives will only target supply where the content language matches the creative language.","type":"boolean"},"tacticsConvertersExclusionType":{"$ref":"#/components/schemas/TacticsConvertersExclusionType"},"targetedPGDealId":{"description":"DealId to be targeted by the Ad Group being created. If you are creating an ad group targeting a programmatic guaranteed deal, the deal can be provided here.","type":"string"},"timeZoneType":{"$ref":"#/components/schemas/TimeZoneType"},"userLocationSignal":{"$ref":"#/components/schemas/UserLocationSignal"},"videoCompletionTier":{"$ref":"#/components/schemas/VideoCompletionTier"}},"required":["amazonViewability","timeZoneType","userLocationSignal"],"type":"object"},"CreateThemeTarget":{"description":"Theme targets let advertisers select high-performing targets based on a common theme.","properties":{"matchType":{"$ref":"#/components/schemas/ThemeMatchType"}},"required":["matchType"],"type":"object"},"CreateThirdPartyCreative":{"properties":{"thirdPartyDisplaySettings":{"$ref":"#/components/schemas/CreateThirdPartyDisplaySettings"},"thirdPartyVideoSettings":{"$ref":"#/components/schemas/CreateThirdPartyVideoSettings"}},"type":"object"},"CreateThirdPartyDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/AdChoicesPosition"},"additionalHtml":{"description":"Additional html to be included along with the creative when rendered.","type":"string"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The list of placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"thirdPartyTagHostingSource":{"description":"The html tag to use to fetch this creative from the 3p ad server.","type":"string"}},"required":["adChoicesPosition","creativeSizes","language","thirdPartyTagHostingSource"],"type":"object"},"CreateThirdPartyTarget":{"properties":{"thirdPartyTargetDetails":{"$ref":"#/components/schemas/CreateThirdPartyTargetDetails"},"thirdPartyTargetType":{"$ref":"#/components/schemas/ThirdPartyTargetType"}},"required":["thirdPartyTargetDetails","thirdPartyTargetType"],"type":"object"},"CreateThirdPartyTargetDetails":{"oneOf":[{"properties":{"doubleVerifyFraudInvalidTraffic":{"$ref":"#/components/schemas/CreateDoubleVerifyFraudInvalidTraffic"}},"required":["doubleVerifyFraudInvalidTraffic"],"title":"doubleVerifyFraudInvalidTraffic","type":"object"},{"properties":{"doubleVerifyStandardDisplayBrandSafety":{"$ref":"#/components/schemas/CreateDoubleVerifyStandardDisplayBrandSafety"}},"required":["doubleVerifyStandardDisplayBrandSafety"],"title":"doubleVerifyStandardDisplayBrandSafety","type":"object"},{"properties":{"doubleVerifyBrandSafety":{"$ref":"#/components/schemas/CreateDoubleVerifyBrandSafety"}},"required":["doubleVerifyBrandSafety"],"title":"doubleVerifyBrandSafety","type":"object"},{"properties":{"doubleVerifyViewability":{"$ref":"#/components/schemas/CreateDoubleVerifyViewability"}},"required":["doubleVerifyViewability"],"title":"doubleVerifyViewability","type":"object"},{"properties":{"doubleVerifyAuthenticBrandSafety":{"$ref":"#/components/schemas/CreateDoubleVerifyAuthenticBrandSafety"}},"required":["doubleVerifyAuthenticBrandSafety"],"title":"doubleVerifyAuthenticBrandSafety","type":"object"},{"properties":{"doubleVerifyCustomContextualSegmentId":{"$ref":"#/components/schemas/CreateDoubleVerifyCustomContextualSegmentId"}},"required":["doubleVerifyCustomContextualSegmentId"],"title":"doubleVerifyCustomContextualSegmentId","type":"object"},{"properties":{"doubleVerifyAuthenticAttention":{"$ref":"#/components/schemas/CreateDoubleVerifyAuthenticAttention"}},"required":["doubleVerifyAuthenticAttention"],"title":"doubleVerifyAuthenticAttention","type":"object"},{"properties":{"integralAdScienceFraudInvalidTraffic":{"$ref":"#/components/schemas/CreateIntegralAdScienceFraudInvalidTraffic"}},"required":["integralAdScienceFraudInvalidTraffic"],"title":"integralAdScienceFraudInvalidTraffic","type":"object"},{"properties":{"integralAdScienceBrandSafety":{"$ref":"#/components/schemas/CreateIntegralAdScienceBrandSafety"}},"required":["integralAdScienceBrandSafety"],"title":"integralAdScienceBrandSafety","type":"object"},{"properties":{"integralAdScienceViewability":{"$ref":"#/components/schemas/CreateIntegralAdScienceViewability"}},"required":["integralAdScienceViewability"],"title":"integralAdScienceViewability","type":"object"},{"properties":{"integralAdScienceContextualTargeting":{"$ref":"#/components/schemas/CreateIntegralAdScienceContextualTargeting"}},"required":["integralAdScienceContextualTargeting"],"title":"integralAdScienceContextualTargeting","type":"object"},{"properties":{"integralAdScienceContextualAvoidance":{"$ref":"#/components/schemas/CreateIntegralAdScienceContextualAvoidance"}},"required":["integralAdScienceContextualAvoidance"],"title":"integralAdScienceContextualAvoidance","type":"object"},{"properties":{"pixalateFraudInvalidTraffic":{"$ref":"#/components/schemas/CreatePixalateFraudInvalidTraffic"}},"required":["pixalateFraudInvalidTraffic"],"title":"pixalateFraudInvalidTraffic","type":"object"},{"properties":{"integralAdScienceQualitySync":{"$ref":"#/components/schemas/CreateIntegralAdScienceQualitySync"}},"required":["integralAdScienceQualitySync"],"title":"integralAdScienceQualitySync","type":"object"},{"properties":{"newsGuardBrandGuardTrustedNewsTargeting":{"$ref":"#/components/schemas/CreateNewsGuardBrandGuardTrustedNewsTargeting"}},"required":["newsGuardBrandGuardTrustedNewsTargeting"],"title":"newsGuardBrandGuardTrustedNewsTargeting","type":"object"},{"properties":{"newsGuardBrandGuardMisinformationSafety":{"$ref":"#/components/schemas/CreateNewsGuardBrandGuardMisinformationSafety"}},"required":["newsGuardBrandGuardMisinformationSafety"],"title":"newsGuardBrandGuardMisinformationSafety","type":"object"}]},"CreateThirdPartyVideoSettings":{"properties":{"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"vastUrl":{"description":"The url to use to fetch the VAST XML for this video creative.","type":"string"}},"required":["language","vastUrl"],"type":"object"},"CreateTimeOfDay":{"properties":{"endTime":{"description":"Selected end time","pattern":"^([01][0-9]|2[0-3]):[0-5][0-9]Z$","type":"string"},"startTime":{"description":"Selected start time","pattern":"^([01][0-9]|2[0-3]):[0-5][0-9]Z$","type":"string"}},"required":["endTime","startTime"],"type":"object"},"CreateTwitchContentRating":{"properties":{"twitchContentRating":{"$ref":"#/components/schemas/TwitchContentRatingEnum"}},"required":["twitchContentRating"],"type":"object"},"CreateVideo":{"properties":{"assetId":{"description":"The asset library ID associated with the video asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the video asset.","type":"string"},"description":{"description":"The description of the video content.","type":"string"},"headline":{"description":"The headline/custom text associated with the video.","type":"string"}},"required":["assetId","assetVersion"],"type":"object"},"CreateVideoAdFormatTarget":{"description":"Target based on the video ad format.","properties":{"videoAdFormat":{"$ref":"#/components/schemas/VideoAdFormat"}},"required":["videoAdFormat"],"type":"object"},"CreateVideoCallToAction":{"oneOf":[{"properties":{"clickToUrlVideoCallToActionSettings":{"$ref":"#/components/schemas/CreateClickToUrlVideoCallToActionSettings"}},"required":["clickToUrlVideoCallToActionSettings"],"title":"clickToUrlVideoCallToActionSettings","type":"object"},{"properties":{"learnMoreVideoCallToActionSettings":{"$ref":"#/components/schemas/CreateLearnMoreVideoCallToActionSettings"}},"required":["learnMoreVideoCallToActionSettings"],"title":"learnMoreVideoCallToActionSettings","type":"object"}]},"CreateVideoContentDurationTarget":{"description":"Targets ads to a specific video content duration","properties":{"duration":{"$ref":"#/components/schemas/VideoContentDuration"}},"required":["duration"],"type":"object"},"CreateVideoCreative":{"properties":{"onlineVideoSettings":{"$ref":"#/components/schemas/CreateOnlineVideoSettings"},"streamingTvSettings":{"$ref":"#/components/schemas/CreateStreamingTvSettings"}},"type":"object"},"CreateVideoExtension":{"description":"Video Ad Extension","type":"object"},"CreateVideoLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/VideoLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType"],"type":"object"},"Creative":{"oneOf":[{"properties":{"audioCreative":{"$ref":"#/components/schemas/AudioCreative"}},"required":["audioCreative"],"title":"audioCreative","type":"object"},{"properties":{"componentCreative":{"$ref":"#/components/schemas/ComponentCreative"}},"required":["componentCreative"],"title":"componentCreative","type":"object"},{"properties":{"displayCreative":{"$ref":"#/components/schemas/DisplayCreative"}},"required":["displayCreative"],"title":"displayCreative","type":"object"},{"properties":{"productCreative":{"$ref":"#/components/schemas/ProductCreative"}},"required":["productCreative"],"title":"productCreative","type":"object"},{"properties":{"thirdPartyCreative":{"$ref":"#/components/schemas/ThirdPartyCreative"}},"required":["thirdPartyCreative"],"title":"thirdPartyCreative","type":"object"},{"properties":{"videoCreative":{"$ref":"#/components/schemas/VideoCreative"}},"required":["videoCreative"],"title":"videoCreative","type":"object"}]},"CreativeBidAdjustment":{"properties":{"creativeType":{"$ref":"#/components/schemas/CreativeBidAdjustmentType"},"percentage":{"description":"The selection of the percentage change associated with the creative type and bid adjustment settings.","format":"int32","type":"integer"}},"required":["percentage"],"type":"object"},"CreativeBidAdjustmentType":{"description":"| CreativeBidAdjustmentType | Description |\n|------|------|\n| `SPOTLIGHT` | SPOTLIGHT Video Asset. |\n","enum":["SPOTLIGHT"],"type":"string"},"CreativeOptimizationGoalKpi":{"description":"| CreativeOptimizationGoalKpi | Description |\n|------|------|\n| `CLICK_THROUGH_RATE` |  |\n| `DETAIL_PAGE_VIEW_RATE` |  |\n| `PURCHASE_RATE` |  |\n","enum":["CLICK_THROUGH_RATE","DETAIL_PAGE_VIEW_RATE","PURCHASE_RATE"],"type":"string"},"CreativeRotationType":{"description":"| CreativeRotationType | Description |\n|------|------|\n| `RANDOM` | Creatives are rotated randomly with equal weight. |\n| `WEIGHTED` | Creatives are rotated based on assigned weights. |\n","enum":["RANDOM","WEIGHTED"],"type":"string"},"CreativeStatus":{"properties":{"moderationStatus":{"$ref":"#/components/schemas/ModerationStatus"}},"required":["moderationStatus"],"type":"object"},"CreativeTrackingUrl":{"properties":{"url":{"description":"A url to be triggered for tracking events.","type":"string"}},"required":["url"],"type":"object"},"CreativeType":{"description":"| CreativeType | Description |\n|------|------|\n| `IMAGE` | An image creative. |\n| `VIDEO` | A video creative. |\n","enum":["IMAGE","VIDEO"],"type":"string"},"CurrencyCode":{"description":"| CurrencyCode | Description |\n|------|------|\n| `AED` | United Arab Emirates Dirham |\n| `ARS` | Argentine Peso |\n| `AUD` | Australian Dollar |\n| `BGN` | Bulgarian Lev |\n| `BHD` | Bahraini Dinar |\n| `BOB` | Bolivian Boliviano |\n| `BRL` | Brazilian Real |\n| `CAD` | Canadian Dollar |\n| `CHF` | Swiss Franc |\n| `CLP` | Chilean Peso |\n| `CNY` | Chinese Yuan |\n| `COP` | Colombian Peso |\n| `CRC` | Costa Rican Colón |\n| `CZK` | Czech Koruna |\n| `DKK` | Danish Krone |\n| `DOP` | Dominican Peso |\n| `DZD` | Algerian Dinar |\n| `EGP` | Egyptian Pound |\n| `EUR` | Euro |\n| `GBP` | British Pound Sterling |\n| `GTQ` | Guatemalan Quetzal |\n| `HKD` | Hong Kong Dollar |\n| `HNL` | Honduran Lempira |\n| `HRK` | Croatian Kuna |\n| `HUF` | Hungarian Forint |\n| `IDR` | Indonesian Rupiah |\n| `ILS` | Israeli New Shekel |\n| `INR` | Indian Rupee |\n| `JMD` | Jamaican Dollar |\n| `JPY` | Japanese Yen |\n| `KRW` | South Korean Won |\n| `KWD` | Kuwaiti Dinar |\n| `MAD` | Moroccan Dirham |\n| `MXN` | Mexican Peso |\n| `MXP` | Mexican Peso |\n| `MYR` | Malaysian Ringgit |\n| `NGN` | Nigerian Naira |\n| `NOK` | Norwegian Krone |\n| `NZD` | New Zealand Dollar |\n| `PAB` | Panamanian Balboa |\n| `PEN` | Peruvian Sol |\n| `PHP` | Philippine Peso |\n| `PKR` | Pakistani Rupee |\n| `PLN` | Polish Złoty |\n| `PYG` | Paraguayan Guaraní |\n| `QAR` | Qatari Riyal |\n| `RON` | Romanian Leu |\n| `RSD` | Serbian Dinar |\n| `RUB` | Russian Ruble |\n| `SAR` | Saudi Riyal |\n| `SEK` | Swedish Krona |\n| `SGD` | Singapore Dollar |\n| `THB` | Thai Baht |\n| `TND` | Tunisian Dinar |\n| `TRY` | Turkish Lira |\n| `TWD` | New Taiwan Dollar |\n| `UAH` | Ukrainian Hryvnia |\n| `USD` | United States Dollar |\n| `UYU` | Uruguayan Peso |\n| `VND` | Vietnamese Đồng |\n| `ZAR` | South African Rand |\n","enum":["AED","ARS","AUD","BGN","BHD","BOB","BRL","CAD","CHF","CLP","CNY","COP","CRC","CZK","DKK","DOP","DZD","EGP","EUR","GBP","GTQ","HKD","HNL","HRK","HUF","IDR","ILS","INR","JMD","JPY","KRW","KWD","MAD","MXN","MXP","MYR","NGN","NOK","NZD","PAB","PEN","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SEK","SGD","THB","TND","TRY","TWD","UAH","USD","UYU","VND","ZAR"],"type":"string"},"DSPAcrossGroupOperator":{"description":"| AcrossGroupOperator | Description |\n| --- | --- |\n| `ANY` |  |\n| `ALL` |  |","enum":["ALL","ANY"],"type":"string"},"DSPAdGroupBid":{"properties":{"baseBid":{"description":"The lower bound bid used for the ads in the ad group.","format":"double","type":"number"},"currencyCode":{"$ref":"#/components/schemas/DSPCurrencyCode"},"maxAverageBid":{"description":"The max average bid that will be targeted on the ad group across all of the bids (a single bid could be lower or higher that this number).","format":"double","type":"number"}},"required":["currencyCode"],"type":"object"},"DSPAdGroupBudgetSettings":{"properties":{"budgetAllocation":{"$ref":"#/components/schemas/DSPBudgetAllocation"},"dailyMinSpendValue":{"description":"Denotes the daily minimum spend on the ad group in local currency.","format":"double","type":"number"}},"type":"object"},"DSPAdInitiationTarget":{"description":"Target based on how the video ad will be started.","properties":{"videoInitiationType":{"$ref":"#/components/schemas/DSPVideoInitiationType"}},"required":["videoInitiationType"],"type":"object"},"DSPAdPlayerSize":{"description":"| AdPlayerSize | Description |\n| --- | --- |\n| `SMALL` |  |\n| `MEDIUM` |  |\n| `LARGE` |  |\n| `UNKNOWN` |  |","enum":["LARGE","MEDIUM","SMALL","UNKNOWN"],"type":"string"},"DSPAdPlayerSizeTarget":{"description":"Target based on the size of the ad player.","properties":{"adPlayerSize":{"$ref":"#/components/schemas/DSPAdPlayerSize"}},"required":["adPlayerSize"],"type":"object"},"DSPAdProduct":{"description":"| AdProduct | Description |\n| --- | --- |\n| `AMAZON_DSP` |  |","enum":["AMAZON_DSP"],"type":"string"},"DSPAdvertiserDomainList":{"description":"Targets domains based on list inherited from the advertiser.","properties":{"inheritFromAdvertiser":{"description":"Set to TRUE to inherit domain list from advertiser.","type":"boolean"}},"required":["inheritFromAdvertiser"],"type":"object"},"DSPAmazonViewability":{"properties":{"includeUnmeasurableImpressions":{"description":"Must be false if viewabilityTier is set to ALL_TIERS. You can set to true to include impressions that can not be measured when a viewabilityTier other than ALL_TIERS is selected. We recommend setting to false if high viewability is your goal.","type":"boolean"},"viewabilityTier":{"$ref":"#/components/schemas/DSPViewabilityTier"}},"required":["includeUnmeasurableImpressions","viewabilityTier"],"type":"object"},"DSPAppTarget":{"description":"Target based on user application.","properties":{"appId":{"description":"The app identifier being targeted.","type":"string"},"appType":{"$ref":"#/components/schemas/DSPAppType"}},"required":["appId","appType"],"type":"object"},"DSPAppType":{"description":"| AppType | Description |\n| --- | --- |\n| `MOBILE` |  |\n| `STREAMING_TV` |  |","enum":["MOBILE","STREAMING_TV"],"type":"string"},"DSPAudienceTarget":{"description":"Target based on a specified audience ID.","properties":{"acrossGroupOperator":{"$ref":"#/components/schemas/DSPAcrossGroupOperator"},"audienceId":{"$ref":"#/components/schemas/DSPMarketplaceStringValue"},"groupId":{"description":"The string identifying a group of audiences. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audiences to a new group, choose any string not currently being used on this ad group. To add audiences to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group.","type":"string"},"inGroupOperator":{"$ref":"#/components/schemas/DSPInGroupOperator"}},"required":["audienceId"],"type":"object"},"DSPAutoCreationSettings":{"type":"object"},"DSPAutomatedTargetingTactic":{"description":"| AutomatedTargetingTactic | Description |\n| --- | --- |\n| `REMARKETING` | Ad Group Tactic (P+) that reaches shoppers who have viewed a product detail page, searched for your product, or visited your homepage |\n| `RETENTION` | Ad Group Tactic (P+) that reaches shoppers who have purchased your product |\n| `PROSPECTING` | Ad Group Tactic (B+) that reaches consumers who are highly likely to show interest and engage with your brand or product |\n| `CUSTOMER_ACQUISITION` | Ad Group Tactic (P+) that reaches shoppers who are similar to past purchasers |\n| `AWARENESS` | Ad Group tactic (Complete TV) that indicates that this line item drives awareness to your selected audience on publisher streaming TV for the linked deal while fulfilling your commitment. |\n| `SEARCH` |  |\n| `MAXIMIZE_PERFORMANCE` | Ad Group Tactic (P+) that reaches shoppers who are similar to past shoppers who viewed a product detail page |","enum":["AWARENESS","CUSTOMER_ACQUISITION","MAXIMIZE_PERFORMANCE","PROSPECTING","REMARKETING","RETENTION","SEARCH"],"type":"string"},"DSPAverageCompletionAndFullyViewableRateTargetingType":{"description":"The type of average completion and fully viewable rate targeting.\n| AverageCompletionAndFullyViewableRateTargetingType | Description |\n| --- | --- |\n| `ALLOW_ALL` |  |\n| `AVG_COMPLETION_FULLY_VIEWABLE_GTE_10` |  |\n| `AVG_COMPLETION_FULLY_VIEWABLE_GTE_20` |  |\n| `AVG_COMPLETION_FULLY_VIEWABLE_GTE_25` |  |\n| `AVG_COMPLETION_FULLY_VIEWABLE_GTE_30` |  |\n| `AVG_COMPLETION_FULLY_VIEWABLE_GTE_35` |  |\n| `AVG_COMPLETION_FULLY_VIEWABLE_GTE_40` |  |","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"],"type":"string"},"DSPBidSettings":{"properties":{"bidStrategy":{"$ref":"#/components/schemas/DSPBidStrategy"}},"type":"object"},"DSPBidStrategy":{"description":"| BidStrategy | Description |\n| --- | --- |\n| `SPEND_BUDGET_IN_FULL` | Prioritize spending full budget, while maximizing performance |\n| `PRIORITIZE_KPI_TARGET` |  |\n| `USE_CAMPAIGN_STRATEGY` |  |","enum":["PRIORITIZE_KPI_TARGET","SPEND_BUDGET_IN_FULL","USE_CAMPAIGN_STRATEGY"],"type":"string"},"DSPBrandExposureViewabilityTargetingType":{"description":"The type of brand exposure viewability targeting.\n| BrandExposureViewabilityTargetingType | Description |\n| --- | --- |\n| `ALLOW_ALL` |  |\n| `BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION` |  |\n| `BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION` |  |\n| `BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION` |  |","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"],"type":"string"},"DSPBrandSafetyCategory":{"description":"| BrandSafetyCategory | Description |\n| --- | --- |\n| `ACCIDENTS_DISASTERS_AND_TRAGEDIES` | Content related to sensitive tragedies, man-made or natural disasters and calamities, including content that graphically depicts such events. |\n| `WEAPONS` | Content related to realistic weapons, such as firearms, bladed weapons, bows and arrows, and military equipment and vehicles. |\n| `GAMBLING` | Content related to gambling, such as instructions on how to play, accessories like home poker sets, and industry news. It does not include online gambling services where money or items of value can be wagered in exchange for the opportunity to win prizes with real-world value. |\n| `BLOOD_GORE_VIOLENCE` | Content in a fictional entertainment context that contains blood, gore or acts of violence. |\n| `CRIME` | Content related to crime, such as law enforcement efforts, criminal behavior, crime prevention, and justice systems. |\n| `SHOCK_AND_HORROR` | Content that may cause shock, fear, or unease. It includes supernatural, disturbing elements, and horror themes. |\n| `PROFANITY` | Content containing excessive use of strong language, explicit, offensive, or sensitive words and expressions. |\n| `HIGHLY_DEBATED_SOCIAL_ISSUES` | Content related to highly debated and politically or socially divisive topics, which is reasonably likely to cause offense to the average person with opposing views. |\n| `POLITICS` | Content related to politics, governments, political science, political parties, elections, and political issues of public debate. |\n| `SEXUAL_REFERENCES_AND_SUGGESTIVE` | Content that contains references or depictions that are mildly provocative, or mature in nature, whether real, simulated or animated. It does not contain sexually explicit content. |\n| `ALCOHOL_AND_RELATED_PRODUCTS` | Content related to the general consumption of alcohol. |\n| `TOBACCO_AND_RELATED_PRODUCTS` | Content related to the smoking of cigarettes, cigars, pipe tobacco, smokeless tobacco, and other tobacco or nicotine products. |\n| `DRUG_REFERENCES_OR_USE` | Content related to substance use, drugs, and other mind-altering substances. |\n| `RELIGIOUS_CONTENT` | Content related to religious and spiritual beliefs. |\n| `UNRATED_MEDIA_CONTENT` | Content that has not been classified. This covers games on Twitch not rated by ESRB. |","enum":["ACCIDENTS_DISASTERS_AND_TRAGEDIES","ALCOHOL_AND_RELATED_PRODUCTS","BLOOD_GORE_VIOLENCE","CRIME","DRUG_REFERENCES_OR_USE","GAMBLING","HIGHLY_DEBATED_SOCIAL_ISSUES","POLITICS","PROFANITY","RELIGIOUS_CONTENT","SEXUAL_REFERENCES_AND_SUGGESTIVE","SHOCK_AND_HORROR","TOBACCO_AND_RELATED_PRODUCTS","UNRATED_MEDIA_CONTENT","WEAPONS"],"type":"string"},"DSPBrandSafetyCategoryTarget":{"description":"Target based on, if any, the classifications of unsuitable contexts that may pose a risk to a brand\u0027s reputation of content being viewed.","properties":{"brandSafetyCategory":{"$ref":"#/components/schemas/DSPBrandSafetyCategory"}},"required":["brandSafetyCategory"],"type":"object"},"DSPBrandSafetyTier":{"description":"| BrandSafetyTier | Description |\n| --- | --- |\n| `EXPANDED` | Tier that maximizes reach across all ad-eligible inventory. This tier is suitable for brands with a greater risk tolerance for advertising alongside a wide variety of content. |\n| `STANDARD` | Tier that offers broad reach and is the default for all campaigns. This tier is suitable for brands with a moderate risk tolerance for advertising alongside a wide variety of content. |\n| `RESTRICTIVE` | Tier that prioritizes brand suitability over reach. This tier is suitable for brands with the lowest risk tolerance for advertising alongside a wide variety of content. |","enum":["EXPANDED","RESTRICTIVE","STANDARD"],"type":"string"},"DSPBrandSafetyTierTarget":{"description":"Target based on the brand suitability risk levels of content being viewed.","properties":{"brandSafetyTier":{"$ref":"#/components/schemas/DSPBrandSafetyTier"}},"required":["brandSafetyTier"],"type":"object"},"DSPBrandSuitabilityRiskLevelType":{"description":"The Double Verify brand suitability risk level.\n| BrandSuitabilityRiskLevelType | Description |\n| --- | --- |\n| `ALLOW_ALL` |  |\n| `HIGH` |  |\n| `HIGH_MEDIUM` |  |\n| `HIGH_MEDIUM_LOW` |  |","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"],"type":"string"},"DSPBudget":{"properties":{"budgetType":{"$ref":"#/components/schemas/DSPBudgetType"},"budgetValue":{"$ref":"#/components/schemas/DSPBudgetValue"},"recurrenceTimePeriod":{"$ref":"#/components/schemas/DSPRecurrence"}},"required":["budgetType","budgetValue","recurrenceTimePeriod"],"type":"object"},"DSPBudgetAllocation":{"description":"| BudgetAllocation | Description |\n| --- | --- |\n| `AUTO` |  |\n| `MANUAL` |  |","enum":["AUTO","MANUAL"],"type":"string"},"DSPBudgetSettings":{"properties":{"budgetAllocation":{"$ref":"#/components/schemas/DSPBudgetAllocation"},"flightBudgetRolloverStrategy":{"$ref":"#/components/schemas/DSPRolloverStrategy"}},"type":"object"},"DSPBudgetType":{"description":"| BudgetType | Description |\n| --- | --- |\n| `MONETARY` |  |","enum":["MONETARY"],"type":"string"},"DSPBudgetValue":{"oneOf":[{"properties":{"monetaryBudgetValue":{"$ref":"#/components/schemas/DSPMonetaryBudgetValue"}},"required":["monetaryBudgetValue"],"title":"monetaryBudgetValue","type":"object"}]},"DSPCampaignFee":{"properties":{"feeType":{"$ref":"#/components/schemas/DSPCampaignFeeType"},"feeValue":{"description":"A service fee that is subtracted from the campaign budget as a percent of budget. This setting can’t be changed after an ad group has been added to a campaign.","format":"double","type":"number"},"feeValueType":{"$ref":"#/components/schemas/DSPCampaignFeeValueType"}},"required":["feeType","feeValue","feeValueType"],"type":"object"},"DSPCampaignFeeType":{"description":"| CampaignFeeType | Description |\n| --- | --- |\n| `AGENCY` | A service fee that is subtracted from the campaign budget as a percent of budget. |","enum":["AGENCY"],"type":"string"},"DSPCampaignFeeValueType":{"description":"| CampaignFeeValueType | Description |\n| --- | --- |\n| `PERCENTAGE_OF_BUDGET` | Subtracted from the campaign budget as a percent of budget |","enum":["PERCENTAGE_OF_BUDGET"],"type":"string"},"DSPCampaignFlight":{"properties":{"budget":{"$ref":"#/components/schemas/DSPFlightBudget"},"endDateTime":{"format":"date-time","type":"string"},"flightId":{"description":"The ID associated with the flight.","type":"string"},"name":{"description":"The name of the flight.","type":"string"},"startDateTime":{"description":"The start date of the flight.","format":"date-time","type":"string"}},"required":["budget","endDateTime","startDateTime"],"type":"object"},"DSPCampaignForecast":{"properties":{"availableForecastFlights":{"description":"The combination of existing flight settings and proposed flight settings based on forecasting.","items":{"$ref":"#/components/schemas/DSPForecastFlight"},"maxItems":100,"minItems":0,"type":"array"},"campaignDisplayName":{"description":"The display name of the campaign used for the forecast.","type":"string"},"campaignForecastDescription":{"$ref":"#/components/schemas/DSPCampaignForecastDescription"},"creationDateTime":{"description":"The creation date of the campaign forecast.","format":"date-time","type":"string"},"flightForecasts":{"description":"The forecast results of multiple flights of the campaign.","items":{"$ref":"#/components/schemas/DSPFlightForecast"},"maxItems":5,"minItems":0,"type":"array"},"hasExistingGuidance":{"description":"Indicates whether there are existing recommendations/guidance available for the campaign from the Noble ListGuidance API.","type":"boolean"}},"required":["campaignDisplayName","campaignForecastDescription","creationDateTime"],"type":"object"},"DSPCampaignForecastDescription":{"description":"The description of which campaign and what features are enabled for a forecast.","properties":{"campaignId":{"description":"The unique identifier of the campaign.","type":"string"},"enabledFeatures":{"$ref":"#/components/schemas/DSPEnabledFeaturesInCampaignForecast"},"flightIds":{"description":"The unique identifier of the flight.","items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"replanningSettings":{"$ref":"#/components/schemas/DSPReplanningSettings"}},"required":["campaignId"],"type":"object"},"DSPCampaignForecastMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/DSPCampaignForecastMultiStatusSuccess"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"DSPCampaignForecastMultiStatusSuccess":{"properties":{"campaignForecast":{"$ref":"#/components/schemas/DSPCampaignForecast"},"index":{"format":"int32","maximum":0,"minimum":0,"type":"integer"}},"required":["campaignForecast","index"],"type":"object"},"DSPCampaignOptimizations":{"properties":{"bidSettings":{"$ref":"#/components/schemas/DSPBidSettings"},"budgetSettings":{"$ref":"#/components/schemas/DSPBudgetSettings"},"goalSettings":{"$ref":"#/components/schemas/DSPGoalSettings"},"primaryInventoryTypes":{"description":"Primary inventory type of the campaign for filtering KPIs and recommending tactics.","items":{"$ref":"#/components/schemas/DSPPrimaryInventoryType"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"DSPCommitment":{"properties":{"advertiserIds":{"description":"Advertiser IDs associated with the commitment.","items":{"type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"campaignIds":{"description":"Campaign IDs associated with the commitment.","items":{"type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"commitmentId":{"description":"A unique identifier for the commitment.","type":"string"},"commitmentName":{"description":"The name of the commitment.","type":"string"},"committedSpend":{"description":"The total committed spend for the commitment.","format":"double","type":"number"},"currencyCode":{"$ref":"#/components/schemas/DSPCurrencyCode"},"dealIds":{"description":"Deal IDs associated with the commitment.","items":{"type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"endDateTime":{"description":"The end date and time of the commitment.","format":"date-time","type":"string"},"fulfillmentLevel":{"$ref":"#/components/schemas/DSPFulfillmentLevel"},"spendCalculationMode":{"$ref":"#/components/schemas/DSPSpendCalculationMode"},"startDateTime":{"description":"The start date and time of the commitment.","format":"date-time","type":"string"}},"required":["commitmentId","commitmentName","committedSpend","currencyCode","endDateTime","fulfillmentLevel","spendCalculationMode","startDateTime"],"type":"object"},"DSPCommitmentCreate":{"properties":{"advertiserIds":{"description":"Advertiser IDs associated with the commitment.","items":{"type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"campaignIds":{"description":"Campaign IDs associated with the commitment.","items":{"type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"commitmentName":{"description":"The name of the commitment.","type":"string"},"committedSpend":{"description":"The total committed spend for the commitment.","format":"double","type":"number"},"currencyCode":{"$ref":"#/components/schemas/DSPCurrencyCode"},"dealIds":{"description":"Deal IDs associated with the commitment.","items":{"type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"endDateTime":{"description":"The end date and time of the commitment.","format":"date-time","type":"string"},"fulfillmentLevel":{"$ref":"#/components/schemas/DSPFulfillmentLevel"},"spendCalculationMode":{"$ref":"#/components/schemas/DSPSpendCalculationMode"},"startDateTime":{"description":"The start date and time of the commitment.","format":"date-time","type":"string"}},"required":["commitmentName","committedSpend","currencyCode","endDateTime","fulfillmentLevel","spendCalculationMode","startDateTime"],"type":"object"},"DSPCommitmentMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/DSPCommitmentMultiStatusSuccess"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"DSPCommitmentMultiStatusSuccess":{"properties":{"commitment":{"$ref":"#/components/schemas/DSPCommitment"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"}},"required":["commitment","index"],"type":"object"},"DSPCommitmentSpend":{"properties":{"accruedSpendValue":{"description":"Actual accrual spend amount in commitment currency.","format":"double","type":"number"},"accruedToDateTime":{"description":"Timestamp for accrual spend.","format":"date-time","type":"string"},"commitmentId":{"$ref":"#/components/schemas/DSPCommitmentSpendIdentifier"},"currencyCode":{"$ref":"#/components/schemas/DSPCurrencyCode"},"projectedSpendValue":{"description":"Projected spend amount in commitment currency.","format":"double","type":"number"},"spendAtRiskValue":{"description":"Spend at risk amount in commitment currency.","format":"double","type":"number"},"spendDimensionType":{"$ref":"#/components/schemas/DSPSpendDimensionType"}},"required":["accruedToDateTime","commitmentId","currencyCode","spendDimensionType"],"type":"object"},"DSPCommitmentSpendIdentifier":{"properties":{"commitmentId":{"description":"Commitment ID associated with the commitment.","type":"string"},"spendDimension":{"$ref":"#/components/schemas/DSPSpendDimension"}},"required":["commitmentId"],"type":"object"},"DSPCommitmentSpendMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/DSPCommitmentSpendMultiStatusSuccess"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"DSPCommitmentSpendMultiStatusSuccess":{"properties":{"commitmentSpend":{"$ref":"#/components/schemas/DSPCommitmentSpend"},"index":{"format":"int32","maximum":0,"minimum":0,"type":"integer"}},"required":["commitmentSpend","index"],"type":"object"},"DSPCommitmentSuccessResponse":{"properties":{"commitments":{"items":{"$ref":"#/components/schemas/DSPCommitment"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"DSPCommitmentUpdate":{"properties":{"advertiserIds":{"description":"Advertiser IDs associated with the commitment.","items":{"type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"campaignIds":{"description":"Campaign IDs associated with the commitment.","items":{"type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"commitmentId":{"description":"A unique identifier for the commitment.","type":"string"},"commitmentName":{"description":"The name of the commitment.","type":"string"},"committedSpend":{"description":"The total committed spend for the commitment.","format":"double","type":"number"},"currencyCode":{"$ref":"#/components/schemas/DSPCurrencyCode"},"dealIds":{"description":"Deal IDs associated with the commitment.","items":{"type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"endDateTime":{"description":"The end date and time of the commitment.","format":"date-time","type":"string"},"fulfillmentLevel":{"$ref":"#/components/schemas/DSPFulfillmentLevel"},"spendCalculationMode":{"$ref":"#/components/schemas/DSPSpendCalculationMode"},"startDateTime":{"description":"The start date and time of the commitment.","format":"date-time","type":"string"}},"required":["commitmentId"],"type":"object"},"DSPContentCategoryTarget":{"description":"Target based on the category of content being viewed.","properties":{"contentCategoryId":{"description":"The content category being targeted.","type":"string"}},"required":["contentCategoryId"],"type":"object"},"DSPContentGenre":{"description":"| ContentGenre | Description |\n| --- | --- |\n| `ACTION` |  |\n| `ADVENTURE` |  |\n| `ALTERNATIVE_ROCK` |  |\n| `ANIMATION` |  |\n| `ARTS` |  |\n| `BIOGRAPHY` |  |\n| `BLUES` |  |\n| `BUSINESS` |  |\n| `CHILDRENS_MUSIC` |  |\n| `CHRISTIAN_GOSPEL` |  |\n| `CHRISTMAS_HOLIDAY` |  |\n| `CLASSIC_ROCK` |  |\n| `CLASSICAL` |  |\n| `COMEDY` |  |\n| `COLLEGE_RADIO` |  |\n| `COUNTRY` |  |\n| `CRIME` |  |\n| `DANCE_DJ` |  |\n| `DOCUMENTARY` |  |\n| `DRAMA` |  |\n| `EASY_LISTENING` |  |\n| `EDUCATION` |  |\n| `EUROPEAN_POP_FOLK` |  |\n| `FAMILY` |  |\n| `FANTASY` |  |\n| `FICTION` |  |\n| `FILM_NOIR` |  |\n| `FOLK` |  |\n| `FRENCH_VARIETY` |  |\n| `GAME_SHOW` |  |\n| `GERMAN_ROCK_POP` |  |\n| `GOVERNMENT` |  |\n| `HARD_ROCK_METAL` |  |\n| `HEALTH_AND_FITNESS` |  |\n| `HISTORY` |  |\n| `HORROR` |  |\n| `INTERNATIONAL` |  |\n| `JAPANESE` |  |\n| `JAZZ` |  |\n| `KIDS_AND_FAMILY` |  |\n| `LATIN_MUSIC` |  |\n| `LEISURE` |  |\n| `MISCELLANEOUS` |  |\n| `MUSIC` |  |\n| `MUSICAL` |  |\n| `MUSICALS_CABARET` |  |\n| `MYSTERY` |  |\n| `NEWS` |  |\n| `NEW_AGE` |  |\n| `OLDIES_ADULT_STANDARDS` |  |\n| `POP` |  |\n| `RAP_HIP_HOP` |  |\n| `RB` |  |\n| `REALITY_TV` |  |\n| `REGGAE_ISLAND` |  |\n| `RELIGION_AND_SPIRITUALITY` |  |\n| `ROCK` |  |\n| `ROMANCE` |  |\n| `SCIENCE` |  |\n| `SCIENCE_FICTION` |  |\n| `SHORT` |  |\n| `SOCIETY_AND_CULTURE` |  |\n| `SOUNDTRACKS` |  |\n| `SPORT` |  |\n| `SUPER_HERO` |  |\n| `TALK_SHOW` |  |\n| `TECHNOLOGY` |  |\n| `THRILLER` |  |\n| `TRUE_CRIME` |  |\n| `TV_AND_FILM` |  |\n| `WAR` |  |\n| `WESTERN` |  |\n| `GENRE_NOT_AVAILABLE` |  |","enum":["ACTION","ADVENTURE","ALTERNATIVE_ROCK","ANIMATION","ARTS","BIOGRAPHY","BLUES","BUSINESS","CHILDRENS_MUSIC","CHRISTIAN_GOSPEL","CHRISTMAS_HOLIDAY","CLASSICAL","CLASSIC_ROCK","COLLEGE_RADIO","COMEDY","COUNTRY","CRIME","DANCE_DJ","DOCUMENTARY","DRAMA","EASY_LISTENING","EDUCATION","EUROPEAN_POP_FOLK","FAMILY","FANTASY","FICTION","FILM_NOIR","FOLK","FRENCH_VARIETY","GAME_SHOW","GENRE_NOT_AVAILABLE","GERMAN_ROCK_POP","GOVERNMENT","HARD_ROCK_METAL","HEALTH_AND_FITNESS","HISTORY","HORROR","INTERNATIONAL","JAPANESE","JAZZ","KIDS_AND_FAMILY","LATIN_MUSIC","LEISURE","MISCELLANEOUS","MUSIC","MUSICAL","MUSICALS_CABARET","MYSTERY","NEWS","NEW_AGE","OLDIES_ADULT_STANDARDS","POP","RAP_HIP_HOP","RB","REALITY_TV","REGGAE_ISLAND","RELIGION_AND_SPIRITUALITY","ROCK","ROMANCE","SCIENCE","SCIENCE_FICTION","SHORT","SOCIETY_AND_CULTURE","SOUNDTRACKS","SPORT","SUPER_HERO","TALK_SHOW","TECHNOLOGY","THRILLER","TRUE_CRIME","TV_AND_FILM","WAR","WESTERN"],"type":"string"},"DSPContentGenreTarget":{"description":"Target based on the genre of content being viewed.","properties":{"contentGenre":{"$ref":"#/components/schemas/DSPContentGenre"}},"required":["contentGenre"],"type":"object"},"DSPContentInstreamPosition":{"description":"| ContentInstreamPosition | Description |\n| --- | --- |\n| `PRE_ROLL` |  |\n| `MID_ROLL` |  |\n| `POST_ROLL` |  |\n| `UNKNOWN` |  |","enum":["MID_ROLL","POST_ROLL","PRE_ROLL","UNKNOWN"],"type":"string"},"DSPContentInstreamPositionTarget":{"description":"Targets ads in the specified content instream position","properties":{"instreamPosition":{"$ref":"#/components/schemas/DSPContentInstreamPosition"}},"required":["instreamPosition"],"type":"object"},"DSPContentOutstreamPosition":{"description":"| ContentOutstreamPosition | Description |\n| --- | --- |\n| `STANDALONE` |  |\n| `ACCOMPANYING_CONTENT` |  |\n| `INTERSTITIAL` |  |\n| `UNKNOWN` |  |","enum":["ACCOMPANYING_CONTENT","INTERSTITIAL","STANDALONE","UNKNOWN"],"type":"string"},"DSPContentOutstreamPositionTarget":{"description":"Targets ads in the specified content outstream position","properties":{"outstreamPosition":{"$ref":"#/components/schemas/DSPContentOutstreamPosition"}},"required":["outstreamPosition"],"type":"object"},"DSPContentRating":{"oneOf":[{"properties":{"dspContentRating":{"$ref":"#/components/schemas/DSPDspContentRating"}},"required":["dspContentRating"],"title":"dspContentRating","type":"object"},{"properties":{"twitchContentRating":{"$ref":"#/components/schemas/DSPTwitchContentRating"}},"required":["twitchContentRating"],"title":"twitchContentRating","type":"object"}]},"DSPContentRatingTarget":{"description":"Target based on the rating of content being viewed.","properties":{"contentRatingType":{"$ref":"#/components/schemas/DSPContentRatingTypes"},"contentRatingTypeDetails":{"$ref":"#/components/schemas/DSPContentRating"}},"required":["contentRatingType","contentRatingTypeDetails"],"type":"object"},"DSPContentRatingTypes":{"description":"| ContentRatingTypes | Description |\n| --- | --- |\n| `DSP_CONTENT_RATING` |  |\n| `TWITCH_CONTENT_RATING` |  |","enum":["DSP_CONTENT_RATING","TWITCH_CONTENT_RATING"],"type":"string"},"DSPCountryCode":{"description":"| CountryCode | Description |\n| --- | --- |\n| `AE` |  |\n| `AT` |  |\n| `AU` |  |\n| `BE` |  |\n| `BH` |  |\n| `BR` |  |\n| `CA` |  |\n| `CH` |  |\n| `DE` |  |\n| `DK` |  |\n| `EG` |  |\n| `ES` |  |\n| `FI` |  |\n| `FR` |  |\n| `GB` |  |\n| `IE` |  |\n| `IL` |  |\n| `IN` |  |\n| `IT` |  |\n| `JO` |  |\n| `JP` |  |\n| `KW` |  |\n| `LU` |  |\n| `MA` |  |\n| `MX` |  |\n| `NL` |  |\n| `NO` |  |\n| `NZ` |  |\n| `OM` |  |\n| `QA` |  |\n| `SA` |  |\n| `SE` |  |\n| `SG` |  |\n| `TR` |  |\n| `US` |  |","enum":["AE","AT","AU","BE","BH","BR","CA","CH","DE","DK","EG","ES","FI","FR","GB","IE","IL","IN","IT","JO","JP","KW","LU","MA","MX","NL","NO","NZ","OM","QA","SA","SE","SG","TR","US"],"type":"string"},"DSPCreateCommitmentRequest":{"properties":{"commitments":{"items":{"$ref":"#/components/schemas/DSPCommitmentCreate"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"DSPCreativeRotationType":{"description":"| CreativeRotationType | Description |\n| --- | --- |\n| `RANDOM` |  |\n| `WEIGHTED` |  |","enum":["RANDOM","WEIGHTED"],"type":"string"},"DSPCurrencyCode":{"description":"| CurrencyCode | Description |\n|------|------|\n| `AED` | United Arab Emirates Dirham |\n| `ARS` | Argentine Peso |\n| `AUD` | Australian Dollar |\n| `BGN` | Bulgarian Lev |\n| `BHD` | Bahraini Dinar |\n| `BOB` | Bolivian Boliviano |\n| `BRL` | Brazilian Real |\n| `CAD` | Canadian Dollar |\n| `CHF` | Swiss Franc |\n| `CLP` | Chilean Peso |\n| `CNY` | Chinese Yuan |\n| `COP` | Colombian Peso |\n| `CRC` | Costa Rican Colón |\n| `CZK` | Czech Koruna |\n| `DKK` | Danish Krone |\n| `DOP` | Dominican Peso |\n| `DZD` | Algerian Dinar |\n| `EUR` | Euro |\n| `GBP` | British Pound Sterling |\n| `GTQ` | Guatemalan Quetzal |\n| `HKD` | Hong Kong Dollar |\n| `HNL` | Honduran Lempira |\n| `HRK` | Croatian Kuna |\n| `HUF` | Hungarian Forint |\n| `IDR` | Indonesian Rupiah |\n| `ILS` | Israeli New Shekel |\n| `INR` | Indian Rupee |\n| `JMD` | Jamaican Dollar |\n| `JPY` | Japanese Yen |\n| `KRW` | South Korean Won |\n| `KWD` | Kuwaiti Dinar |\n| `MAD` | Moroccan Dirham |\n| `MXN` | Mexican Peso |\n| `MYR` | Malaysian Ringgit |\n| `NOK` | Norwegian Krone |\n| `NZD` | New Zealand Dollar |\n| `PAB` | Panamanian Balboa |\n| `PEN` | Peruvian Sol |\n| `PHP` | Philippine Peso |\n| `PKR` | Pakistani Rupee |\n| `PYG` | Paraguayan Guaraní |\n| `QAR` | Qatari Riyal |\n| `RON` | Romanian Leu |\n| `RSD` | Serbian Dinar |\n| `RUB` | Russian Ruble |\n| `SAR` | Saudi Riyal |\n| `SEK` | Swedish Krona |\n| `SGD` | Singapore Dollar |\n| `THB` | Thai Baht |\n| `TND` | Tunisian Dinar |\n| `TRY` | Turkish Lira |\n| `TWD` | New Taiwan Dollar |\n| `UAH` | Ukrainian Hryvnia |\n| `USD` | United States Dollar |\n| `UYU` | Uruguayan Peso |\n| `VND` | Vietnamese Đồng |\n","enum":["AED","ARS","AUD","BGN","BHD","BOB","BRL","CAD","CHF","CLP","CNY","COP","CRC","CZK","DKK","DOP","DZD","EUR","GBP","GTQ","HKD","HNL","HRK","HUF","IDR","ILS","INR","JMD","JPY","KRW","KWD","MAD","MXN","MYR","NOK","NZD","PAB","PEN","PHP","PKR","PYG","QAR","RON","RSD","RUB","SAR","SEK","SGD","THB","TND","TRY","TWD","UAH","USD","UYU","VND"],"type":"string"},"DSPCurve":{"description":"The forecast curve of Bid/Spend vs the metric type based on periodicity.","properties":{"focusPoint":{"items":{"$ref":"#/components/schemas/DSPPoint"},"maxItems":10,"minItems":0,"type":"array"},"periodicity":{"$ref":"#/components/schemas/DSPForecastPeriodicity"},"points":{"items":{"$ref":"#/components/schemas/DSPPoint"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"DSPDVBrandSafetyAppAgeRatingType":{"description":"| DVBrandSafetyAppAgeRatingType | Description |\n| --- | --- |\n| `EVERYONE_4_PLUS` |  |\n| `TWEENS_9_PLUS` |  |\n| `TEENS_12_PLUS` |  |\n| `MATURE_17_PLUS` |  |\n| `ADULTS_ONLY_18_PLUS` |  |\n| `UNKNOWN` |  |","enum":["ADULTS_ONLY_18_PLUS","EVERYONE_4_PLUS","MATURE_17_PLUS","TEENS_12_PLUS","TWEENS_9_PLUS","UNKNOWN"],"type":"string"},"DSPDVBrandSafetyAppStarRatingType":{"description":"App star rating to be used for excluding apps.\n| DVBrandSafetyAppStarRatingType | Description |\n| --- | --- |\n| `ALLOW_ALL` |  |\n| `APP_STAR_RATING_LT_1_POINT_5_STARS` |  |\n| `APP_STAR_RATING_LT_2_STARS` |  |\n| `APP_STAR_RATING_LT_2_POINT_5_STARS` |  |\n| `APP_STAR_RATING_LT_3_STARS` |  |\n| `APP_STAR_RATING_LT_3_POINT_5_STARS` |  |\n| `APP_STAR_RATING_LT_4_STARS` |  |\n| `APP_STAR_RATING_LT_4_POINT_5_STARS` |  |","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS"],"type":"string"},"DSPDVBrandSafetyContentCategoriesWithRiskMap":{"description":"A map from content categories to risk level to exclude from targeting. Available keys are: [ADULT_CONTENT, ALCOHOL, CRIME, DEATH_INJURIES, DISASTER_AVIATION, DISASTER_MAN_MADE, DISASTER_NATURAL, DISASTER_TERRORIST_EVENTS, DISASTER_VEHICLE, HATE_SPEECH, PROFANITY, SUBSTANCE_ABUSE, TOBACCO_ECIGARETTES, VIOLENCE_EXTREME_GRAPHIC].","properties":{"key":{"description":"Available keys are: [ADULT_CONTENT, ALCOHOL, CRIME, DEATH_INJURIES, DISASTER_AVIATION, DISASTER_MAN_MADE, DISASTER_NATURAL, DISASTER_TERRORIST_EVENTS, DISASTER_VEHICLE, HATE_SPEECH, PROFANITY, SUBSTANCE_ABUSE, TOBACCO_ECIGARETTES, VIOLENCE_EXTREME_GRAPHIC].","type":"string"},"value":{"$ref":"#/components/schemas/DSPBrandSuitabilityRiskLevelType"}},"required":["key","value"],"type":"object"},"DSPDVBrandSafetyContentCategoryType":{"description":"| DVBrandSafetyContentCategoryType | Description |\n| --- | --- |\n| `AD_SERVER` |  |\n| `CELEBRITY_GOSSIP` |  |\n| `CULTS_SURVIVALISM` |  |\n| `GAMBLING` |  |\n| `INCENTIVIZED_MALWARE_CLUTTER` |  |\n| `INFLAMMATORY_POLITICS_NEWS` |  |\n| `NEGATIVE_NEWS_FINANCIAL` |  |\n| `NEGATIVE_NEWS_PHARMACEUTICAL` |  |\n| `NON_STANDARD_CONTENT_NON_ENGLISH` |  |\n| `NON_STANDARD_CONTENT_PARKING_PAGE` |  |\n| `OCCULT` |  |\n| `PIRACY_COPYRIGHT_INFRINGEMENT` |  |\n| `UNMODERATED_UGC_FORUMS_IMAGES_VIDEO` |  |\n| `EXTREME_GRAPHIC` |  |","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","EXTREME_GRAPHIC","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"],"type":"string"},"DSPDayOfWeek":{"description":"| DayOfWeek | Description |\n| --- | --- |\n| `MONDAY` |  |\n| `TUESDAY` |  |\n| `WEDNESDAY` |  |\n| `THURSDAY` |  |\n| `FRIDAY` |  |\n| `SATURDAY` |  |\n| `SUNDAY` |  |","enum":["FRIDAY","MONDAY","SATURDAY","SUNDAY","THURSDAY","TUESDAY","WEDNESDAY"],"type":"string"},"DSPDayPartTarget":{"description":"Target based on time of day.","properties":{"dayOfWeek":{"$ref":"#/components/schemas/DSPDayOfWeek"},"timeOfDay":{"$ref":"#/components/schemas/DSPTimeOfDay"}},"required":["dayOfWeek","timeOfDay"],"type":"object"},"DSPDefaultAudienceTargetingMatchType":{"description":"Match type for audience targeting inclusion groups, if any. You can enhance your ad group’s reach to consumers with similar shopping, streaming, and browsing behaviors or interests as your selected audiences across all inventory sources, regardless of the presence of ad identifiers. Only applicable at the adGroup level, rather than at individual audience level. (Default: SIMILAR). Note, SIMILAR is not applicable to certain advertised product categories, [see here](https://advertising.amazon.com/help/GX8G7HNDS5RBX3EF) for more information.\n| DefaultAudienceTargetingMatchType | Description |\n| --- | --- |\n| `SIMILAR` | Reach more audiences who are similar to your included audiences. |\n| `EXACT` | Target the exact audiences specified in the ad group audience targeting. |","enum":["EXACT","SIMILAR"],"type":"string"},"DSPDeliverInFullConfidence":{"description":"Description of how confident we delivery 100% of the ads for the specific metric.","properties":{"value":{"$ref":"#/components/schemas/DSPDeliverInFullConfidenceLevel"}},"required":["value"],"type":"object"},"DSPDeliverInFullConfidenceLevel":{"description":"| DeliverInFullConfidenceLevel | Description |\n| --- | --- |\n| `HIGH` | There is a high level of confidence that the campaign or flight will fully deliver its planned budget or impressions. |\n| `MEDIUM` | There is a moderate level of confidence that the campaign or flight will fully deliver its planned budget or impressions. |\n| `LOW` | There is a low level of confidence that the campaign or flight will fully deliver its planned budget or impressions. |\n| `UNAVAILABLE` | Confidence level cannot be determined due to insufficient or missing data. |","enum":["HIGH","LOW","MEDIUM","UNAVAILABLE"],"type":"string"},"DSPDeliveryProfile":{"description":"| DeliveryProfile | Description |\n| --- | --- |\n| `EVEN` | Even pacing spends your budget consistently across the length of the campaign. |\n| `PACE_AHEAD` | Pace Ahead can deliver up to 25% more than the daily Even pace targets. |\n| `ASAP` | Makes your entire budget available to spend immediately. This is ideal for ad groups with limited inventory or when there\u0027s no requirement to spend throughout the length of the campaign.Warning: Selecting ASAP may result in your entire budget being spent immediately. |","enum":["ASAP","EVEN","PACE_AHEAD"],"type":"string"},"DSPDeliveryReason":{"description":"| DeliveryReason | Description |\n| --- | --- |\n| `AD_CREATIVES_NOT_RUNNING` |  |\n| `AD_GROUP_ARCHIVED` |  |\n| `AD_GROUP_ENDED` |  |\n| `AD_GROUP_INELIGIBLE_GOAL_KPI` | Indicates that the ad group is suspended because the campaign\u0027s goal KPI is not supported. |\n| `AD_GROUP_MISSING_CONVERSION_TRACKING_SELECTIONS` | Indicates that the ad group is suspended because the campaign is missing conversion tracking selections. |\n| `AD_GROUP_PAUSED` |  |\n| `AD_GROUP_PENDING_START_DATE` |  |\n| `AD_GROUP_POLICING_SUSPENDED` |  |\n| `AD_GROUP_TOO_FEW_CONVERSION_TRACKING_SELECTIONS` | Indicates that the ad group is suspended because the campaign has an insufficient number of conversion tracking selections. |\n| `AD_GROUP_TOO_MANY_CONVERSION_TRACKING_SELECTIONS` | Indicates that the ad group is suspended because the campaign exceeded the maximum number of conversion tracking selections. |\n| `AD_GROUPS_NOT_RUNNING` |  |\n| `AD_NOT_ASSOCIATED_WITH_AD_GROUP` |  |\n| `AD_NOT_APPROVED_FOR_ALL_AD_GROUPS` |  |\n| `AD_POLICING_PENDING_REVIEW` |  |\n| `AD_POLICING_SUSPENDED` |  |\n| `CAMPAIGN_ARCHIVED` |  |\n| `CAMPAIGN_END_DATE_REACHED` |  |\n| `CAMPAIGN_PAUSED` |  |\n| `CAMPAIGN_PENDING_START_DATE` |  |\n| `CAMPAIGN_POLICING_SUSPENDED` |  |\n| `OTHER` |  |","enum":["AD_CREATIVES_NOT_RUNNING","AD_GROUPS_NOT_RUNNING","AD_GROUP_ARCHIVED","AD_GROUP_ENDED","AD_GROUP_INELIGIBLE_GOAL_KPI","AD_GROUP_MISSING_CONVERSION_TRACKING_SELECTIONS","AD_GROUP_PAUSED","AD_GROUP_PENDING_START_DATE","AD_GROUP_POLICING_SUSPENDED","AD_GROUP_TOO_FEW_CONVERSION_TRACKING_SELECTIONS","AD_GROUP_TOO_MANY_CONVERSION_TRACKING_SELECTIONS","AD_NOT_APPROVED_FOR_ALL_AD_GROUPS","AD_NOT_ASSOCIATED_WITH_AD_GROUP","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","CAMPAIGN_ARCHIVED","CAMPAIGN_END_DATE_REACHED","CAMPAIGN_PAUSED","CAMPAIGN_PENDING_START_DATE","CAMPAIGN_POLICING_SUSPENDED","OTHER"],"type":"string"},"DSPDeliveryStatus":{"description":"| 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| `LIMITED` | Represents partial delivery status, applicable to global resources that have different delivery status across marketplaces |","enum":["DELIVERING","LIMITED","NOT_DELIVERING","UNAVAILABLE"],"type":"string"},"DSPDeviceOrientation":{"description":"| DeviceOrientation | Description |\n| --- | --- |\n| `PORTRAIT` |  |\n| `LANDSCAPE` |  |","enum":["LANDSCAPE","PORTRAIT"],"type":"string"},"DSPDeviceTarget":{"description":"Target based on user device.","properties":{"deviceOrientation":{"$ref":"#/components/schemas/DSPDeviceOrientation"},"deviceType":{"$ref":"#/components/schemas/DSPDeviceType"},"mobileDevice":{"$ref":"#/components/schemas/DSPMobileDevice"},"mobileEnvironment":{"$ref":"#/components/schemas/DSPMobileEnvironment"},"mobileOs":{"$ref":"#/components/schemas/DSPMobileOs"}},"required":["deviceType"],"type":"object"},"DSPDeviceType":{"description":"| DeviceType | Description |\n| --- | --- |\n| `DESKTOP` |  |\n| `MOBILE` |  |\n| `CONNECTED_TV` |  |\n| `CONNECTED_DEVICE` | Connected TV, smart speakers. Used for audio AdGroup type. |","enum":["CONNECTED_DEVICE","CONNECTED_TV","DESKTOP","MOBILE"],"type":"string"},"DSPDomainFileTarget":{"description":"Targets domains based on list provided via file upload.","properties":{"domainFileId":{"description":"The ID associated to the domain file to target. Read-only and created based on the inputted domainFileKey.","type":"string"},"domainFileKey":{"description":"The S3 key of the uploaded file which can be obtained from the file upload policy endpoint. A max of 10 files may be associated to one ad group.","type":"string"},"domainFileName":{"description":"The name of the file.","type":"string"},"domainFileUrl":{"description":"The file containing the domains uploaded. It expires in one hour.","type":"string"}},"type":"object"},"DSPDomainListTarget":{"description":"Targets domains based on an existing domain list.","properties":{"domainListId":{"description":"The ID of the domain list to target.","type":"string"}},"required":["domainListId"],"type":"object"},"DSPDomainNameTarget":{"description":"Targets domains based on URL.","properties":{"domainName":{"description":"The URL of the domain to target.","type":"string"}},"required":["domainName"],"type":"object"},"DSPDomainTarget":{"description":"Target based on a specified domain.","properties":{"domainTargetDetails":{"$ref":"#/components/schemas/DSPDomainTargetDetails"},"domainTargetType":{"$ref":"#/components/schemas/DSPDomainTargetTypes"}},"required":["domainTargetDetails","domainTargetType"],"type":"object"},"DSPDomainTargetDetails":{"oneOf":[{"properties":{"domainListTarget":{"$ref":"#/components/schemas/DSPDomainListTarget"}},"required":["domainListTarget"],"title":"domainListTarget","type":"object"},{"properties":{"domainNameTarget":{"$ref":"#/components/schemas/DSPDomainNameTarget"}},"required":["domainNameTarget"],"title":"domainNameTarget","type":"object"},{"properties":{"domainFileTarget":{"$ref":"#/components/schemas/DSPDomainFileTarget"}},"required":["domainFileTarget"],"title":"domainFileTarget","type":"object"},{"properties":{"advertiserDomainList":{"$ref":"#/components/schemas/DSPAdvertiserDomainList"}},"required":["advertiserDomainList"],"title":"advertiserDomainList","type":"object"}]},"DSPDomainTargetTypes":{"description":"| DomainTargetTypes | Description |\n| --- | --- |\n| `DOMAIN_LIST` |  |\n| `DOMAIN_NAME` |  |\n| `DOMAIN_FILE` |  |\n| `ADVERTISER_DOMAIN_LIST` |  |","enum":["ADVERTISER_DOMAIN_LIST","DOMAIN_FILE","DOMAIN_LIST","DOMAIN_NAME"],"type":"string"},"DSPDoubleVerifyAuthenticAttention":{"properties":{"universalAttention":{"description":"One omni-channel segment that is informed by data from all DV campaigns to help avoid serving ads on generally poor performing apps and domains.","type":"boolean"}},"required":["universalAttention"],"type":"object"},"DSPDoubleVerifyAuthenticBrandSafety":{"properties":{"doubleVerifySegmentId":{"pattern":"^51[0-9]{6}$","type":"string"}},"type":"object"},"DSPDoubleVerifyBrandSafety":{"properties":{"appAgeRating":{"description":"A list of app age ratings to be used for excluding apps. For example, TEENS_12_PLUS will only exclude apps with content rated for everyone ages 12 and over. UNKNOWN will exclude apps with content unrated or unknown to Double Verify.","items":{"$ref":"#/components/schemas/DSPDVBrandSafetyAppAgeRatingType"},"maxItems":50,"minItems":0,"type":"array"},"appStarRating":{"$ref":"#/components/schemas/DSPDVBrandSafetyAppStarRatingType"},"contentCategories":{"description":"A list of content categories to exclude from targeting.","items":{"$ref":"#/components/schemas/DSPDVBrandSafetyContentCategoryType"},"maxItems":50,"minItems":0,"type":"array"},"contentCategoriesWithRisk":{"items":{"$ref":"#/components/schemas/DSPDVBrandSafetyContentCategoriesWithRiskMap"},"maxItems":50,"minItems":0,"type":"array"},"excludeAppsWithInsufficientRating":{"description":"Set to true to exclude unofficial apps or apps with insufficient user ratings (\u003c100 lifetime).","type":"boolean"},"unknownContent":{"description":"Set to true to exclude unknown content.","type":"boolean"}},"type":"object"},"DSPDoubleVerifyCustomContextualSegmentId":{"properties":{"doubleVerifySegmentId":{"pattern":"^52[0-9]{6}$","type":"string"}},"type":"object"},"DSPDoubleVerifyFraudInvalidTraffic":{"properties":{"blockAppAndSites":{"description":"Set to true to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen.","type":"boolean"},"excludeAppsAndSites":{"$ref":"#/components/schemas/DSPExcludeAppsAndSitesType"},"excludeImpressions":{"description":"Set to true to exclude impressions delivered to devices identified to be fraudulent or invalid.","type":"boolean"}},"type":"object"},"DSPDoubleVerifyStandardDisplayBrandSafety":{"properties":{"contentCategories":{"description":"A list of content categories to exclude from targeting.","items":{"$ref":"#/components/schemas/DSPDVBrandSafetyContentCategoryType"},"maxItems":50,"minItems":0,"type":"array"},"contentCategoriesWithRisk":{"items":{"$ref":"#/components/schemas/DSPDVBrandSafetyContentCategoriesWithRiskMap"},"maxItems":50,"minItems":0,"type":"array"},"unknownContent":{"description":"Set to true to exclude unknown content.","type":"boolean"}},"type":"object"},"DSPDoubleVerifyViewability":{"properties":{"averageCompletionAndFullyViewableRateTargeting":{"$ref":"#/components/schemas/DSPAverageCompletionAndFullyViewableRateTargetingType"},"brandExposureViewabilityTargeting":{"$ref":"#/components/schemas/DSPBrandExposureViewabilityTargetingType"},"includeUnmeasurableImpressions":{"description":"Set to true to include impressions where impressions can\u0027t be measured.","type":"boolean"},"mrcViewabilityTargeting":{"$ref":"#/components/schemas/DSPMrcViewabilityTargetingType"}},"type":"object"},"DSPDspContentRating":{"properties":{"dspContentRating":{"$ref":"#/components/schemas/DSPDspContentRatingEnum"}},"required":["dspContentRating"],"type":"object"},"DSPDspContentRatingEnum":{"description":"| DspContentRatingEnum | Description |\n| --- | --- |\n| `SUITABLE_FOR_ALL_AUDIENCES` | Equivalent to content that is rated G (film), TV-Y (TV), TV-Y7 (TV), TV-G (TV), EC (game), or E (game). |\n| `SUITABLE_FOR_MOST_AUDIENCES_WITH_PARENTAL_GUIDANCE` | Equivalent to content that is rated PG (film), TV-PG (TV), or E-10+ (game). |\n| `SUITABLE_FOR_TEEN_AND_OLDER_AUDIENCES` | Equivalent to content that is rated PG-13 (film), TV-14 (TV), or T (game). |\n| `SUITABLE_FOR_MATURE_AUDIENCES` | Ages 17+. Equivalent to content that is rated R (film), TV-MA (TV), or M (game). |\n| `SUITABLE_FOR_ADULTS` | Ages 18+. Equivalent to content that is rated NC-17 (film). |\n| `RATING_NOT_AVAILABLE` | Content where rating isn\u0027t available from the publisher. |","enum":["RATING_NOT_AVAILABLE","SUITABLE_FOR_ADULTS","SUITABLE_FOR_ALL_AUDIENCES","SUITABLE_FOR_MATURE_AUDIENCES","SUITABLE_FOR_MOST_AUDIENCES_WITH_PARENTAL_GUIDANCE","SUITABLE_FOR_TEEN_AND_OLDER_AUDIENCES"],"type":"string"},"DSPEnabledFeaturesInCampaignForecast":{"description":"For the user to specify which features to enable in the forecast result.","properties":{"campaignSettingsCache":{"description":"Describe if the forecast will use cached settings of a campaign.","type":"boolean"},"curve":{"description":"Describe if the user want to see curve or not.","type":"boolean"},"insights":{"description":"Describe if the user want to see detailed insights for leading drivers of forecast results.","type":"boolean"},"metrics":{"$ref":"#/components/schemas/DSPForecastMetricsDescription"},"replanning":{"description":"Describe if the forecast will show replanning recommendation.","type":"boolean"}},"type":"object"},"DSPExcludeAppsAndSitesType":{"description":"| ExcludeAppsAndSitesType | Description |\n| --- | --- |\n| `ALLOW_ALL` |  |\n| `FRAUD_TRAFFIC_LEVEL_GTE_100` |  |\n| `FRAUD_TRAFFIC_LEVEL_GTE_50` |  |\n| `FRAUD_TRAFFIC_LEVEL_GTE_25` |  |\n| `FRAUD_TRAFFIC_LEVEL_GTE_10` |  |\n| `FRAUD_TRAFFIC_LEVEL_GTE_08` |  |\n| `FRAUD_TRAFFIC_LEVEL_GTE_06` |  |\n| `FRAUD_TRAFFIC_LEVEL_GTE_04` |  |\n| `FRAUD_TRAFFIC_LEVEL_GTE_02` |  |","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_02","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_50"],"type":"string"},"DSPFee":{"properties":{"addToBudgetSpentAmount":{"description":"Applies only to THIRD_PARTY_APPLIED_FEE. When set to true, third-party applied fees are are added on top of the total ad group budget spent amount in reports.","type":"boolean"},"currencyCode":{"$ref":"#/components/schemas/DSPCurrencyCode"},"feeType":{"$ref":"#/components/schemas/DSPFeeType"},"feeValue":{"description":"The fee amount expressed as the feeValueType. AMAZON_AUDIENCE_FEE AND THIRD_PARTY_AUDIENCE_FEE is in the currency of the marketplace. All other CPM based fees are in the currency of the advertiser. For percentages, 100 represents 100%.","format":"double","type":"number"},"feeValueType":{"$ref":"#/components/schemas/DSPFeeValueType"},"thirdPartyProvider":{"$ref":"#/components/schemas/DSPFeesThirdPartyProvider"}},"required":["currencyCode","feeType","feeValue","feeValueType"],"type":"object"},"DSPFeeType":{"description":"| FeeType | Description |\n| --- | --- |\n| `AMAZON_DSP` | A service fee for using Amazon DSP and subtracted from the budget. This fee is applied as a percent of supply cost. |\n| `AMAZON_AUDIENCE` | CPM fee for using Amazon audiences. |\n| `THIRD_PARTY_AUDIENCE` | CPM fee for using a third party audience. |\n| `OMNICHANNEL_METRICS` | Fee for using Amazon Omnichannel Metrics. |\n| `THIRD_PARTY_APPLIED` | User added CPM fee for using third-party data to track CPM costs. This fee is applied as a percent of supply cost. |\n| `THIRD_PARTY_TARGETING` | CPM fee for using targeting provided by a third-party data provider. |\n| `MANAGED_SERVICE_FEE` | The percentage-based fee applied to the Supply Cost for Amazon programmatic managed service. |","enum":["AMAZON_AUDIENCE","AMAZON_DSP","MANAGED_SERVICE_FEE","OMNICHANNEL_METRICS","THIRD_PARTY_APPLIED","THIRD_PARTY_AUDIENCE","THIRD_PARTY_TARGETING"],"type":"string"},"DSPFeeValueType":{"description":"| FeeValueType | Description |\n| --- | --- |\n| `FIXED_CPM` | Charged based on a fixed CPM. The currency depends on the feeType. |\n| `PERCENTAGE_OF_SUPPLY_COST` | Charged as a percent of supply (media) cost. Ranges from 0 to 1 where 0.15 represents 15%. |\n| `PERCENTAGE_OF_BUDGET` | Subtracted from the campaign budget as a percent of budget |","enum":["FIXED_CPM","PERCENTAGE_OF_BUDGET","PERCENTAGE_OF_SUPPLY_COST"],"type":"string"},"DSPFeesThirdPartyProvider":{"description":"| FeesThirdPartyProvider | Description |\n| --- | --- |\n| `INTEGRAL_AD_SCIENCE` |  |\n| `DOUBLE_VERIFY` |  |\n| `DOUBLE_CLICK_CAMPAIGN_MANAGER` |  |\n| `COM_SCORE` |  |\n| `CPM_1` |  |\n| `CPM_2` |  |\n| `CPM_3` |  |","enum":["COM_SCORE","CPM_1","CPM_2","CPM_3","DOUBLE_CLICK_CAMPAIGN_MANAGER","DOUBLE_VERIFY","INTEGRAL_AD_SCIENCE"],"type":"string"},"DSPFlightBudget":{"properties":{"budgetType":{"$ref":"#/components/schemas/DSPBudgetType"},"budgetValue":{"$ref":"#/components/schemas/DSPBudgetValue"}},"required":["budgetType","budgetValue"],"type":"object"},"DSPFlightForecast":{"description":"The forecast result of a specific flight.","properties":{"curves":{"description":"The forecasting curves of a flight based on different periodicities.","items":{"$ref":"#/components/schemas/DSPCurve"},"maxItems":4,"minItems":0,"type":"array"},"deliverInFullConfidence":{"$ref":"#/components/schemas/DSPDeliverInFullConfidence"},"flightId":{"description":"The flightId of the flight.","type":"string"},"forecastEndDateTime":{"description":"The endtime of the flight for forecasting.","format":"date-time","type":"string"},"forecastStartDateTime":{"description":"The starttime of the flight for forecasting.","format":"date-time","type":"string"},"insights":{"$ref":"#/components/schemas/DSPFlightForecastInsights"},"metrics":{"description":"The different metrics to measure the performance of the flight.","items":{"$ref":"#/components/schemas/DSPForecastMetric"},"maxItems":20,"minItems":0,"type":"array"},"replanning":{"description":"The recommendation for replanning.","items":{"$ref":"#/components/schemas/DSPReplanning"},"maxItems":100,"minItems":0,"type":"array"},"spend":{"description":"The amount of money spend for this flight.","format":"double","type":"number"},"totalBudget":{"$ref":"#/components/schemas/DSPMonetaryBudget"},"warnings":{"description":"Warnings of the campaign forecast.","items":{"$ref":"#/components/schemas/DSPWarning"},"maxItems":10,"minItems":0,"type":"array"}},"required":["flightId","forecastEndDateTime","forecastStartDateTime"],"type":"object"},"DSPFlightForecastInsights":{"description":"Collection of insights for a particular flight forecast.","properties":{"forecastExplainabilityInsights":{"description":"Detailed insights explaining leading drivers of the flight forecast results, per entity (e.g. campaign or its line items).","items":{"$ref":"#/components/schemas/DSPForecastInsightsGroup"},"maxItems":49,"minItems":0,"type":"array"},"topExplainabilityFactors":{"description":"Top factors affecting the forecast results, e.g. max bid, frequency cap, etc.","items":{"$ref":"#/components/schemas/DSPInsightFeature"},"maxItems":4,"minItems":0,"type":"array"}},"type":"object"},"DSPFoldPosition":{"description":"| FoldPosition | Description |\n| --- | --- |\n| `ABOVE_THE_FOLD` |  |\n| `BELOW_THE_FOLD` |  |\n| `UNKNOWN` |  |","enum":["ABOVE_THE_FOLD","BELOW_THE_FOLD","UNKNOWN"],"type":"string"},"DSPFoldPositionTarget":{"description":"Targets ads in the specified fold position","properties":{"foldPosition":{"$ref":"#/components/schemas/DSPFoldPosition"}},"required":["foldPosition"],"type":"object"},"DSPForecastAdGroup":{"description":"Ad group domain model","properties":{"adGroupId":{"description":"The unique identifier of the ad group.","type":"string"},"adProduct":{"$ref":"#/components/schemas/DSPAdProduct"},"advertisedProductCategoryIds":{"description":"The array of identifiers of product categories associated with the ad group. For VIDEO ad group type only one parent product category or multiple sub-categories from one parent product category are allowed.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"bid":{"$ref":"#/components/schemas/DSPAdGroupBid"},"budgets":{"description":"An object containing budget details for the ad group.","items":{"$ref":"#/components/schemas/DSPBudget"},"maxItems":3,"minItems":0,"type":"array"},"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"},"creativeRotationType":{"$ref":"#/components/schemas/DSPCreativeRotationType"},"endDateTime":{"description":"The end date time for the ad group.","format":"date-time","type":"string"},"fees":{"description":"The fees associated with the ad group.","items":{"$ref":"#/components/schemas/DSPFee"},"maxItems":100,"minItems":0,"type":"array"},"frequencies":{"description":"An object containing frequency details for the ad group.","items":{"$ref":"#/components/schemas/DSPFrequency"},"maxItems":10,"minItems":0,"type":"array"},"globalAdGroupId":{"description":"The global adGroup identifier that manages this marketplace adGroup.","type":"string"},"inventoryType":{"$ref":"#/components/schemas/DSPInventoryType"},"lastUpdatedDateTime":{"description":"The date time that the ad group was last updated.","format":"date-time","type":"string"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global ad group that enables overriding certain attributes at individual marketplace level. For example, if a global ad group state is ENABLED and needs to be PAUSED only in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, ad group\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/DSPMarketplaceAdGroupConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/DSPMarketplaceScope"},"marketplaces":{"description":"A list of country codes representing Amazon marketplaces\n| Marketplace | Description |\n| --- | --- |\n| `AE` |  |\n| `AU` |  |\n| `BR` |  |\n| `CA` |  |\n| `DE` |  |\n| `ES` |  |\n| `FR` |  |\n| `GB` |  |\n| `IN` |  |\n| `IT` |  |\n| `JP` |  |\n| `MX` |  |\n| `NL` |  |\n| `SA` |  |\n| `SE` |  |\n| `TR` |  |\n| `US` |  |","items":{"$ref":"#/components/schemas/DSPMarketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the ad group.","type":"string"},"optimization":{"$ref":"#/components/schemas/DSPOptimization"},"pacing":{"$ref":"#/components/schemas/DSPPacing"},"purchaseOrderNumber":{"description":"The purchase order number associated with the ad group.","type":"string"},"retailerId":{"description":"Identifier for retailer associated with this ad group.","type":"string"},"startDateTime":{"description":"The start date time for the ad group.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/DSPState"},"status":{"$ref":"#/components/schemas/DSPStatus"},"tags":{"description":"Open ended labels with a key value pair applied to the ad group","items":{"$ref":"#/components/schemas/DSPTag"},"maxItems":50,"minItems":0,"type":"array"},"targetingSettings":{"$ref":"#/components/schemas/DSPTargetingSettings"}},"type":"object"},"DSPForecastCampaign":{"description":"Campaign domain model","properties":{"adProduct":{"$ref":"#/components/schemas/DSPAdProduct"},"adomains":{"description":"OpenRTB standard naming meaning: Advertiser domain for block list checking. This can be an array of strings for the case of rotating creatives. Exchanges can mandate that only one domain is allowed.","items":{"type":"string"},"maxItems":2,"minItems":0,"type":"array"},"autoCreationSettings":{"$ref":"#/components/schemas/DSPAutoCreationSettings"},"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/DSPBudget"},"maxItems":3,"minItems":0,"type":"array"},"campaignId":{"description":"A unique identifier for a campaign.","type":"string"},"campaignPresetId":{"description":"This is the ID of the originally generated campaign preset that the campaign is associated with.","type":"string"},"countries":{"description":"This field is used in Sponsored Ads and ADSP and impacts targeted supply. For Sponsored Ads, the campaign.countries field determines what Amazon retail supply (Amazon.com, Amazon.co.uk, Amazon.mx, etc) the campaign will serve in. Similarly in ADSP, this has an implicit filter on your inventory targets. If you choose an inventory target of AMAZON with campaign.countries set to US, this will target the retail supply of Amazon.com and non-retail Amazon properties. ADSP options include additional countries - for example, choosing Austria means targeting Austria eligible inventory and Amazon retail supply of Amazon.de.","items":{"$ref":"#/components/schemas/DSPCountryCode"},"maxItems":249,"minItems":0,"type":"array"},"creationDateTime":{"description":"The date time that the campaign was created.","format":"date-time","type":"string"},"eligibleAutomatedTargetingTactics":{"description":"List of tactic type and inventory type pairs that are eligible for use with this campaign","items":{"$ref":"#/components/schemas/DSPTacticKey"},"maxItems":20,"minItems":0,"type":"array"},"endDate":{"description":"The end date of the campaign.","format":"date","type":"string"},"endDateTime":{"description":"The end date time for the campaign.","format":"date-time","type":"string"},"fees":{"description":"Any fees associated with the campaign.","items":{"$ref":"#/components/schemas/DSPCampaignFee"},"maxItems":2,"minItems":0,"type":"array"},"flights":{"description":"Flight details associated with the campaign.","items":{"$ref":"#/components/schemas/DSPCampaignFlight"},"maxItems":10,"minItems":0,"type":"array"},"frequencies":{"description":"Any frequency caps associated with the campaign.","items":{"$ref":"#/components/schemas/DSPFrequency"},"maxItems":10,"minItems":0,"type":"array"},"globalCampaignId":{"description":"The global campaign identifier that manages this marketplace campaign.","type":"string"},"ineligibleAutomatedTargetingTactics":{"description":"List of tactic type and inventory type pairs that are ineligible for use with this campaign, along with reasons for ineligibility","items":{"$ref":"#/components/schemas/DSPIneligibleAutomatedTargetingTactic"},"maxItems":20,"minItems":0,"type":"array"},"lastUpdatedDateTime":{"description":"The date time that the campaign was last updated.","format":"date-time","type":"string"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global campaign that enables overriding certain attributes at individual marketplace level. For example, if a global campaign is ENABLED and startDate \u00272024-06-01\u0027 but needs to be PAUSED in DE with startDateTime \u00272024-06-02\u0027 marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED, startDate: \u00272024-06-02\u0027}}]. When a marketplace-specific override is not provided, the campaign\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/DSPMarketplaceCampaignConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/DSPMarketplaceScope"},"marketplaces":{"description":"A list of country codes representing Amazon marketplaces\n| Marketplace | Description |\n| --- | --- |\n| `AE` |  |\n| `AU` |  |\n| `BR` |  |\n| `CA` |  |\n| `DE` |  |\n| `ES` |  |\n| `FR` |  |\n| `GB` |  |\n| `IN` |  |\n| `IT` |  |\n| `JP` |  |\n| `MX` |  |\n| `NL` |  |\n| `SA` |  |\n| `SE` |  |\n| `TR` |  |\n| `US` |  |","items":{"$ref":"#/components/schemas/DSPMarketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the campaign.","type":"string"},"optimizations":{"$ref":"#/components/schemas/DSPCampaignOptimizations"},"portfolioId":{"description":"The ID of the portfolio associated with the campaign.","type":"string"},"productCategoryId":{"description":"This is the ID of the product category that the campaign is associated with.","type":"string"},"purchaseOrderNumber":{"description":"The purchase order number associated with the campaign.","type":"string"},"skanAppId":{"description":"StoreKit AdNetwork application ID. Represents iTunes application ID with which SKAN-enabled campaigns are associated.","type":"string"},"startDate":{"description":"The start date of the campaign.","format":"date","type":"string"},"startDateTime":{"description":"The start date time for the campaign.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/DSPState"},"status":{"$ref":"#/components/schemas/DSPStatus"},"tags":{"description":"Open ended labels with a key value pair applied to the campaign","items":{"$ref":"#/components/schemas/DSPTag"},"maxItems":50,"minItems":0,"type":"array"},"targetedPGDealId":{"description":"DealId associated with the campaign.","type":"string"},"targetsAmazonDeal":{"description":"If the campaign is targeting an Amazon deal, the value will be true, and the campaign and ad group(s) will be read-only.","type":"boolean"}},"type":"object"},"DSPForecastFlight":{"properties":{"budget":{"$ref":"#/components/schemas/DSPBudget"},"endDateTime":{"format":"date-time","type":"string"},"flightId":{"description":"The ID associated with the flight.","type":"string"},"startDateTime":{"description":"The start date of the flight.","format":"date-time","type":"string"}},"required":["budget","endDateTime","startDateTime"],"type":"object"},"DSPForecastInsightsGroup":{"description":"Insights for leading drivers of forecast results for a specific entity, e.g. campaign frequency cap, line item max bid.","properties":{"coldStartDealNames":{"description":"The names of audience deals attached to the entity, that are newly created and may not be accurately incorporated into the forecast.","items":{"type":"string"},"maxItems":99,"minItems":0,"type":"array"},"coldStartSegmentNames":{"description":"The names of audience segments attached to the entity, that are newly created and may not be accurately incorporated into the forecast.","items":{"type":"string"},"maxItems":99,"minItems":0,"type":"array"},"displayName":{"description":"The display name for the entity this insight is for, e.g. campaign/line item display name.","type":"string"},"groupType":{"$ref":"#/components/schemas/DSPRecommendedObjectType"},"insightsFeatures":{"description":"The features corresponding to this group of insights, e.g. array of line item max bid, campaign frequency cap, etc.","items":{"$ref":"#/components/schemas/DSPInsightFeature"},"maxItems":9,"minItems":1,"type":"array"},"tag":{"description":"The unique identifier for the entity this group of insights refers to, e.g. line item ID, campaign ID, etc.","type":"string"}},"required":["displayName","groupType","insightsFeatures","tag"],"type":"object"},"DSPForecastMetric":{"description":"The forecast based on metric and periodicity.","properties":{"metric":{"$ref":"#/components/schemas/DSPSelectedForecastMetric"},"periodicity":{"$ref":"#/components/schemas/DSPForecastPeriodicity"},"value":{"$ref":"#/components/schemas/DSPForecastValue"}},"required":["metric","value"],"type":"object"},"DSPForecastMetricsDescription":{"description":"Describe how user select to see all metrics or selected ones.","properties":{"allMetrics":{"description":"If it is true, all the supported metrics would return.","type":"boolean"},"selectedMetrics":{"description":"The list of selected metrics in order.","items":{"$ref":"#/components/schemas/DSPSelectedForecastMetric"},"maxItems":20,"minItems":0,"type":"array"}},"required":["allMetrics"],"type":"object"},"DSPForecastPeriodicity":{"description":"| ForecastPeriodicity | Description |\n| --- | --- |\n| `DAILY` | Forecast results are generated and presented for each individual day. |\n| `LIFETIME` | Forecast results represent the total performance over the remaining entire campaign duration. |\n| `MONTHLY` | Forecast results are aggregated and presented for each calendar month. |\n| `WEEKLY` | Forecast results are aggregated and presented for each calendar week. |","enum":["DAILY","LIFETIME","MONTHLY","WEEKLY"],"type":"string"},"DSPForecastTarget":{"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/DSPAdProduct"},"bid":{"$ref":"#/components/schemas/DSPTargetBid"},"campaignId":{"description":"A unique identifier for the campaign associated with the target. Only used for campaign-level targets.","type":"string"},"creationDateTime":{"description":"The date time the target was created.","format":"date-time","type":"string"},"globalTargetId":{"description":"The global target identifier that manages this marketplace target.","type":"string"},"lastUpdatedDateTime":{"description":"The date time the target was last updated.","format":"date-time","type":"string"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global target that enables overriding certain attributes at individual marketplace level. For example, if a global target is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the target\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/DSPMarketplaceTargetConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/DSPMarketplaceScope"},"marketplaces":{"description":"A list of country codes representing Amazon marketplaces\n| Marketplace | Description |\n| --- | --- |\n| `AE` |  |\n| `AU` |  |\n| `BR` |  |\n| `CA` |  |\n| `DE` |  |\n| `ES` |  |\n| `FR` |  |\n| `GB` |  |\n| `IN` |  |\n| `IT` |  |\n| `JP` |  |\n| `MX` |  |\n| `NL` |  |\n| `SA` |  |\n| `SE` |  |\n| `TR` |  |\n| `US` |  |","items":{"$ref":"#/components/schemas/DSPMarketplace"},"maxItems":30,"minItems":0,"type":"array"},"negative":{"description":"Indicates whether the target is negative or not.","type":"boolean"},"state":{"$ref":"#/components/schemas/DSPState"},"status":{"$ref":"#/components/schemas/DSPStatus"},"tags":{"description":"Open ended labels with a key value pair applied to the target","items":{"$ref":"#/components/schemas/DSPTag"},"maxItems":50,"minItems":0,"type":"array"},"targetDetails":{"$ref":"#/components/schemas/DSPTargetDetails"},"targetId":{"description":"A unique identifier for the target.","type":"string"},"targetLevel":{"$ref":"#/components/schemas/DSPTargetLevel"},"targetType":{"$ref":"#/components/schemas/DSPTargetType"}},"type":"object"},"DSPForecastValue":{"properties":{"high":{"format":"double","type":"number"},"low":{"format":"double","type":"number"},"mean":{"format":"double","type":"number"}},"required":["high","low","mean"],"type":"object"},"DSPFrequency":{"properties":{"eventMaxCount":{"description":"The maximum number of times an EventType is served per user. For ADSP ad group, maximum supported value is 500.","format":"int32","maximum":99000,"minimum":1,"type":"integer"},"frequencyTargetingSetting":{"$ref":"#/components/schemas/DSPFrequencyTargetingSetting"},"timeCount":{"description":"The value associated with the time and unit of time for this frequency cap.","format":"int32","maximum":60,"minimum":1,"type":"integer"},"timeUnit":{"$ref":"#/components/schemas/DSPTimeUnit"}},"required":["eventMaxCount","frequencyTargetingSetting"],"type":"object"},"DSPFrequencyTargetingSetting":{"description":"| FrequencyTargetingSetting | Description |\n| --- | --- |\n| `USER` | Control frequency an ad will be selected to a person. |\n| `HOUSEHOLD` | Control frequency an ad will be selected across people within the same household. |","enum":["HOUSEHOLD","USER"],"type":"string"},"DSPFulfillmentLevel":{"description":"| FulfillmentLevel | Description |\n|------|------|\n| `LEVEL_0` | Tracking-only commitments |\n| `LEVEL_5` | Prioritize commitment over campaign performance |\n","enum":["LEVEL_0","LEVEL_5"],"type":"string"},"DSPGoal":{"description":"| 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. |","enum":["AWARENESS","CONSIDERATION","CONVERSIONS"],"type":"string"},"DSPGoalSettings":{"properties":{"currencyCode":{"$ref":"#/components/schemas/DSPCurrencyCode"},"goal":{"$ref":"#/components/schemas/DSPGoal"},"kpi":{"$ref":"#/components/schemas/DSPKPI"},"kpiValue":{"description":"The value of the KPI that the campaign is working to optimize.","format":"double","type":"number"}},"required":["goal"],"type":"object"},"DSPIASBrandSafetyLevelType":{"description":"The IAS brand safety risk level.\n| IASBrandSafetyLevelType | Description |\n| --- | --- |\n| `ALLOW_ALL` |  |\n| `BRAND_SAFETY_EXCLUDE_HIGH_RISK` |  |\n| `BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK` |  |","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK","BRAND_SAFETY_EXCLUDE_HIGH_RISK"],"type":"string"},"DSPIASFraudInvalidTrafficType":{"description":"The type of fraud invalid traffic.\n| IASFraudInvalidTrafficType | Description |\n| --- | --- |\n| `ALLOW_ALL` |  |\n| `FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK` |  |\n| `FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK` |  |","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK"],"type":"string"},"DSPIASViewabilityStandardType":{"description":"The viewability standard.\n| IASViewabilityStandardType | Description |\n| --- | --- |\n| `NONE` |  |\n| `MRC` |  |\n| `GROUPM` |  |\n| `PUBLICIS` |  |","enum":["GROUPM","MRC","NONE","PUBLICIS"],"type":"string"},"DSPInGroupOperator":{"description":"| InGroupOperator | Description |\n| --- | --- |\n| `ANY` |  |\n| `ALL` |  |","enum":["ALL","ANY"],"type":"string"},"DSPIneligibleAutomatedTargetingTactic":{"description":"Information about an ineligible tactic key and the reasons for ineligibility","type":"object"},"DSPInsightFeature":{"description":"| InsightFeature | Description |\n| --- | --- |\n| `LINE_ITEM_FREQUENCY_CAP` | Insight associated with line item having restrictive frequency cap setting. |\n| `LINE_ITEM_MAX_BID` | Insight associated with line item having inadequate max bid setting. |\n| `LINE_ITEM_SIMILAR_AUDIENCES` | Insight associated with line item not presently reaching similar audiences. |\n| `LINE_ITEM_COLD_START_DEALS` | Insight associated with line item having newly created deals present. |\n| `LINE_ITEM_COLD_START_SEGMENTS` | Insight associated with line item having newly created behavioral segments present. |\n| `LINE_ITEM_NARROW_SEGMENTS` | Insight associated with line item having narrowly targeted behavioral segments present. |\n| `LINE_ITEM_LARGE_TARGETING` | Insight associated with line item having an excessive amount of behavioral segments targeted. |\n| `LINE_ITEM_UNSUPPORTED_KEYWORD_TARGETING` | Insight associated with line item having unsupported keyword targeting settings present. |\n| `LINE_ITEM_UNSUPPORTED_CONTEXTUAL_TARGETING` | Insight associated with line item having unsupported contextual targeting settings present. |\n| `LINE_ITEM_GEO_TARGETING` | Insight associated with line item having restrictive geo-targeting present. |\n| `LINE_ITEM_TOO_FAR_IN_FUTURE` | Insight associated with line item having end date too far in the future. |\n| `LINE_ITEM_DOMAINLIST_TARGETING` | Insight associated with line item having restrictive domain list targeting. |\n| `LINE_ITEM_APPBLOCKING_TARGETING` | Insight associated with line item having restrictive app blocking targeting. |\n| `LINE_ITEM_MOBILE_DEVICES_TARGETING` | Insight associated with line item having restrictive mobile device targeting. |\n| `LINE_ITEM_CONTEXTUAL_TARGETING` | Insight associated with line item having restrictive contextual targeting. |\n| `CAMPAIGN_FREQUENCY_CAP` | Insight associated with restrictive campaign frequency cap setting. |","enum":["CAMPAIGN_FREQUENCY_CAP","LINE_ITEM_APPBLOCKING_TARGETING","LINE_ITEM_COLD_START_DEALS","LINE_ITEM_COLD_START_SEGMENTS","LINE_ITEM_CONTEXTUAL_TARGETING","LINE_ITEM_DOMAINLIST_TARGETING","LINE_ITEM_FREQUENCY_CAP","LINE_ITEM_GEO_TARGETING","LINE_ITEM_LARGE_TARGETING","LINE_ITEM_MAX_BID","LINE_ITEM_MOBILE_DEVICES_TARGETING","LINE_ITEM_NARROW_SEGMENTS","LINE_ITEM_SIMILAR_AUDIENCES","LINE_ITEM_TOO_FAR_IN_FUTURE","LINE_ITEM_UNSUPPORTED_CONTEXTUAL_TARGETING","LINE_ITEM_UNSUPPORTED_KEYWORD_TARGETING"],"type":"string"},"DSPIntegralAdScienceBrandSafety":{"properties":{"excludeContent":{"description":"Set to true to exclude content that Integral Ad Science is not able to rate.","type":"boolean"},"iasBrandSafetyAdult":{"$ref":"#/components/schemas/DSPIASBrandSafetyLevelType"},"iasBrandSafetyAlcohol":{"$ref":"#/components/schemas/DSPIASBrandSafetyLevelType"},"iasBrandSafetyGambling":{"$ref":"#/components/schemas/DSPIASBrandSafetyLevelType"},"iasBrandSafetyHateSpeech":{"$ref":"#/components/schemas/DSPIASBrandSafetyLevelType"},"iasBrandSafetyIllegalDownloads":{"$ref":"#/components/schemas/DSPIASBrandSafetyLevelType"},"iasBrandSafetyIllegalDrugs":{"$ref":"#/components/schemas/DSPIASBrandSafetyLevelType"},"iasBrandSafetyOffensiveLanguage":{"$ref":"#/components/schemas/DSPIASBrandSafetyLevelType"},"iasBrandSafetyViolence":{"$ref":"#/components/schemas/DSPIASBrandSafetyLevelType"}},"type":"object"},"DSPIntegralAdScienceContextualAvoidance":{"properties":{"avoidanceSegments":{"description":"The unique identifier of the IAS contextual avoidance segment","items":{"type":"string"},"maxItems":200,"minItems":0,"type":"array"}},"type":"object"},"DSPIntegralAdScienceContextualTargeting":{"properties":{"topicalSegments":{"description":"The unique identifier of the IAS contextual topical targeting segment","items":{"type":"string"},"maxItems":200,"minItems":0,"type":"array"},"verticalSegments":{"description":"The unique identifier of the IAS contextual vertical targeting segment","items":{"type":"string"},"maxItems":200,"minItems":0,"type":"array"}},"type":"object"},"DSPIntegralAdScienceFraudInvalidTraffic":{"properties":{"targetSetting":{"$ref":"#/components/schemas/DSPIASFraudInvalidTrafficType"}},"type":"object"},"DSPIntegralAdScienceQualitySync":{"properties":{"segmentId":{"pattern":"^4[0-9]{6}$","type":"string"}},"type":"object"},"DSPIntegralAdScienceViewability":{"description":"The IAS viewability standard.","properties":{"standard":{"$ref":"#/components/schemas/DSPIASViewabilityStandardType"},"viewabilityTargeting":{"$ref":"#/components/schemas/DSPViewabilityTierType"}},"required":["standard"],"type":"object"},"DSPInventorySourceTarget":{"description":"Target based on the source of the inventory.","properties":{"inventorySourceId":{"$ref":"#/components/schemas/DSPMarketplaceStringValue"},"inventorySourceType":{"$ref":"#/components/schemas/DSPInventorySourceType"}},"required":["inventorySourceId","inventorySourceType"],"type":"object"},"DSPInventorySourceType":{"description":"| InventorySourceType | Description |\n| --- | --- |\n| `AMAZON` |  |\n| `APD` |  |\n| `THIRD_PARTY_EXCHANGE` |  |\n| `DEAL` |  |\n| `INVENTORY_GROUP` |  |","enum":["AMAZON","APD","DEAL","INVENTORY_GROUP","THIRD_PARTY_EXCHANGE"],"type":"string"},"DSPInventoryType":{"description":"| InventoryType | Description |\n| --- | --- |\n| `STANDARD_DISPLAY` |  |\n| `AMAZON_MOBILE_DISPLAY` |  |\n| `AAP_MOBILE_APP` |  |\n| `DISPLAY` |  |\n| `VIDEO` |  |\n| `STREAMING_TV` |  |\n| `ONLINE_VIDEO` |  |\n| `AUDIO` | Audio ads that serve on streaming audio inventory. |\n| `PODCAST` | Podcast ads that serve on streaming podcast inventory. |\n| `AUDIO_AMAZON_DEAL` |  |\n| `STREAMING_TV_AMAZON_DEAL` |  |\n| `LIVE_EVENTS` | Real-time broadcast inventory (sports, concerts, award shows) with audience volatility and concentrated traffic patterns requiring specialized pacing algorithms and event-specific metadata handling.  |","enum":["AAP_MOBILE_APP","AMAZON_MOBILE_DISPLAY","AUDIO","AUDIO_AMAZON_DEAL","DISPLAY","LIVE_EVENTS","ONLINE_VIDEO","PODCAST","STANDARD_DISPLAY","STREAMING_TV","STREAMING_TV_AMAZON_DEAL","VIDEO"],"type":"string"},"DSPKPI":{"description":"| KPI | Description |\n| --- | --- |\n| `CLICK_THROUGH_RATE` | Indicates a goal of driving clickthrough rate. |\n| `COMBINED_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_COMBINED. |\n| `COST_PER_ACTION` | Deprecated. Please use COST_PER_CONVERSION_OFF_AMAZON. |\n| `COST_PER_CLICK` | Indicates a goal of driving improved cost per click. |\n| `COST_PER_CONVERSION_OFF_AMAZON` | Indicates a goal of driving improved cost per conversion off Amazon. |\n| `COST_PER_DETAIL_PAGE_VIEW` | Indicates a goal of driving improved cost per detail page view. |\n| `COST_PER_FIRST_APP_OPEN` | Indicates a goal of improved cost per first app open. |\n| `COST_PER_INSTALL` | Indicates a goal of driving improved cost per app install. |\n| `COST_PER_SIGN_UP` | Indicates a goal of driving improved cost per sign up. |\n| `COST_PER_VIDEO_COMPLETION` | Indicates a goal of driving improved cost per video completion. |\n| `DETAIL_PAGE_VIEW_RATE` | Indicates a goal of driving improved detail page view rate. |\n| `FREQUENCY_AVERAGE` | Indicates a goal of driving to a target frequency. |\n| `REACH` | Indicates a goal of driving improved reach. |\n| `RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_PROMOTED. |\n| `ROAS` | Indicates a goal of driving improved return of ad spend. |\n| `ROAS_COMBINED` | Indicates a goal of driving improved return of ad spend (combined). |\n| `ROAS_PROMOTED` | Indicates a goal of driving improved return of ad spend (promoted). |\n| `TOTAL_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS. |\n| `VIDEO_COMPLETION_RATE` | Indicates a goal of driving improved video completion rate. |","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_CONVERSION_OFF_AMAZON","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_SIGN_UP","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","FREQUENCY_AVERAGE","REACH","RETURN_ON_AD_SPEND","ROAS","ROAS_COMBINED","ROAS_PROMOTED","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"],"type":"string"},"DSPKeywordMatchType":{"description":"| KeywordMatchType | Description |\n| --- | --- |\n| `BROAD` | Broad match search terms. This expands matching on user intent beyond PHRASE.  |","enum":["BROAD"],"type":"string"},"DSPKeywordTarget":{"description":"Targets a specific customer search term.","properties":{"keyword":{"description":"The customer search term or text to target","type":"string"},"matchType":{"$ref":"#/components/schemas/DSPKeywordMatchType"}},"required":["keyword","matchType"],"type":"object"},"DSPLocationTarget":{"description":"Target based on geographic location.","properties":{"locationId":{"description":"The ID of the geographic location to target.","type":"string"}},"required":["locationId"],"type":"object"},"DSPMarketplace":{"description":"A list of country codes representing Amazon marketplaces\n| Marketplace | Description |\n| --- | --- |\n| `AE` |  |\n| `AU` |  |\n| `BR` |  |\n| `CA` |  |\n| `DE` |  |\n| `ES` |  |\n| `FR` |  |\n| `GB` |  |\n| `IN` |  |\n| `IT` |  |\n| `JP` |  |\n| `MX` |  |\n| `NL` |  |\n| `SA` |  |\n| `SE` |  |\n| `TR` |  |\n| `US` |  |","enum":["AE","AU","BR","CA","DE","ES","FR","GB","IN","IT","JP","MX","NL","SA","SE","TR","US"],"type":"string"},"DSPMarketplaceAdGroupConfigurations":{"type":"object"},"DSPMarketplaceCampaignConfigurations":{"type":"object"},"DSPMarketplaceScope":{"description":"| MarketplaceScope | Description |\n| --- | --- |\n| `SINGLE_MARKETPLACE` |  |","enum":["SINGLE_MARKETPLACE"],"type":"string"},"DSPMarketplaceStringValue":{"properties":{"defaultValue":{"description":"The default value. Either the default value or the marketplace settings should always be specified","type":"string"}},"type":"object"},"DSPMarketplaceTargetConfigurations":{"type":"object"},"DSPMobileDevice":{"description":"| MobileDevice | Description |\n| --- | --- |\n| `IPHONE` |  |\n| `IPAD` |  |\n| `ANDROID` |  |\n| `KINDLE_FIRE` |  |\n| `KINDLE_FIRE_HD` |  |","enum":["ANDROID","IPAD","IPHONE","KINDLE_FIRE","KINDLE_FIRE_HD"],"type":"string"},"DSPMobileEnvironment":{"description":"| MobileEnvironment | Description |\n| --- | --- |\n| `WEB` |  |\n| `APP` |  |","enum":["APP","WEB"],"type":"string"},"DSPMobileOs":{"description":"| MobileOs | Description |\n| --- | --- |\n| `IOS` |  |\n| `ANDROID` |  |","enum":["ANDROID","IOS"],"type":"string"},"DSPMonetaryBudget":{"properties":{"currencyCode":{"$ref":"#/components/schemas/DSPCurrencyCode"},"value":{"description":"The monetary amount of the budget cap in the given currency.","format":"double","type":"number"}},"required":["currencyCode","value"],"type":"object"},"DSPMonetaryBudgetValue":{"properties":{"monetaryBudget":{"$ref":"#/components/schemas/DSPMonetaryBudget"}},"type":"object"},"DSPMrcViewabilityTargetingType":{"description":"The type of MRC viewability targeting.\n| MrcViewabilityTargetingType | Description |\n| --- | --- |\n| `ALLOW_ALL` |  |\n| `MRC_VIEWABILITY_GTE_80` |  |\n| `MRC_VIEWABILITY_GTE_75` |  |\n| `MRC_VIEWABILITY_GTE_70` |  |\n| `MRC_VIEWABILITY_GTE_65` |  |\n| `MRC_VIEWABILITY_GTE_60` |  |\n| `MRC_VIEWABILITY_GTE_55` |  |\n| `MRC_VIEWABILITY_GTE_50` |  |\n| `MRC_VIEWABILITY_GTE_40` |  |\n| `MRC_VIEWABILITY_GTE_30` |  |","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_30","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_80"],"type":"string"},"DSPNativeContentPosition":{"description":"| NativeContentPosition | Description |\n| --- | --- |\n| `IN_ARTICLE` | Positioned in the atomic unit of the content (e.g., in the article page or single image page). |\n| `IN_FEED` | Positioned in the feed of content (e.g., as an item inside the organic feed, grid, listing, carousel, etc.). |\n| `PERIPHERAL` | Positioned utside the core content (e.g., in the ads section on the right rail, as a banner-style placement near the content, etc.). |\n| `RECOMMENDATION` | Positioned in recommendation widget; most commonly presented below article content. |\n| `UNKNOWN` | Unknown position. |","enum":["IN_ARTICLE","IN_FEED","PERIPHERAL","RECOMMENDATION","UNKNOWN"],"type":"string"},"DSPNativeContentPositionTarget":{"description":"Targets ads to a specific native content position","properties":{"nativePosition":{"$ref":"#/components/schemas/DSPNativeContentPosition"}},"required":["nativePosition"],"type":"object"},"DSPNewsGuardBrandGuardMisinformationSafety":{"properties":{"avoidanceList":{"description":"The unique identifiers of misinformation targets","items":{"$ref":"#/components/schemas/DSPNewsGuardBrandGuardMisinformationSafetyType"},"maxItems":20,"minItems":0,"type":"array"}},"type":"object"},"DSPNewsGuardBrandGuardMisinformationSafetyType":{"description":"| NewsGuardBrandGuardMisinformationSafetyType | Description |\n| --- | --- |\n| `MAX_EXCLUDE` |  |\n| `HIGH_EXCLUDE` |  |\n| `BASIC_EXCLUDE` |  |\n| `OPINIONATED_NEWS` |  |\n| `MISINFORMATION_SITES` |  |\n| `ELECTION_MISINFORMATION` |  |\n| `HEALTH_MISINFORMATION` |  |\n| `VACCINE_MISINFORMATION` |  |\n| `COVID_MISINFORMATION` |  |\n| `QANON_MISINFORMATION` |  |\n| `CLIMATE_MISINFORMATION` |  |\n| `UKRAINE_MISINFORMATION` |  |\n| `ISRAEL_HAMAS_MISINFORMATION` |  |\n| `AI_GENERATED_MFA` |  |","enum":["AI_GENERATED_MFA","BASIC_EXCLUDE","CLIMATE_MISINFORMATION","COVID_MISINFORMATION","ELECTION_MISINFORMATION","HEALTH_MISINFORMATION","HIGH_EXCLUDE","ISRAEL_HAMAS_MISINFORMATION","MAX_EXCLUDE","MISINFORMATION_SITES","OPINIONATED_NEWS","QANON_MISINFORMATION","UKRAINE_MISINFORMATION","VACCINE_MISINFORMATION"],"type":"string"},"DSPNewsGuardBrandGuardTrustedNewsTargeting":{"description":"Only applicable for Web supply.","properties":{"targetingList":{"description":"The unique identifiers of trusted news targets","items":{"$ref":"#/components/schemas/DSPNewsGuardBrandGuardTrustedNewsTargetingType"},"maxItems":15,"minItems":0,"type":"array"}},"type":"object"},"DSPNewsGuardBrandGuardTrustedNewsTargetingType":{"description":"| NewsGuardBrandGuardTrustedNewsTargetingType | Description |\n| --- | --- |\n| `MAX_INCLUDE` |  |\n| `HIGH_INCLUDE` |  |\n| `BASIC_INCLUDE` |  |\n| `LOCAL_INCLUDE` |  |\n| `POLITICS_INCLUDE` |  |\n| `HEALTH_INCLUDE` |  |\n| `BUSINESS_INCLUDE` |  |\n| `COMMUNITY_INCLUDE` |  |\n| `LIFESTYLE_INCLUDE` |  |\n| `TECH_INCLUDE` |  |","enum":["BASIC_INCLUDE","BUSINESS_INCLUDE","COMMUNITY_INCLUDE","HEALTH_INCLUDE","HIGH_INCLUDE","LIFESTYLE_INCLUDE","LOCAL_INCLUDE","MAX_INCLUDE","POLITICS_INCLUDE","TECH_INCLUDE"],"type":"string"},"DSPOptimization":{"properties":{"bidStrategy":{"$ref":"#/components/schemas/DSPBidStrategy"},"budgetSettings":{"$ref":"#/components/schemas/DSPAdGroupBudgetSettings"}},"type":"object"},"DSPPacing":{"properties":{"deliveryProfile":{"$ref":"#/components/schemas/DSPDeliveryProfile"}},"type":"object"},"DSPPixalateFraudInvalidTraffic":{"properties":{"excludeAppsAndDomains":{"description":"Set to true to exclude traffic from Apps and Domains identified to be fraudulent or invalid.","type":"boolean"},"excludeIpAddressAndUserAgents":{"description":"Set to true to exclude traffic from IPV4 and IPV6 addresses and user agents identified to be fraudulent or invalid.","type":"boolean"},"excludeOttAndMobileDevices":{"description":"Set to true to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid.","type":"boolean"},"excludeRemovedAppsFromAppStores":{"description":"Set to true to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months.","type":"boolean"}},"type":"object"},"DSPPlacementType":{"description":"| PlacementType | Description |\n| --- | --- |\n| `REWARDED` | Rewarded video type where users receive rewards from the publisher for watching ads. |","enum":["REWARDED"],"type":"string"},"DSPPlacementTypeTarget":{"description":"Target based on the placement type.","properties":{"placementType":{"$ref":"#/components/schemas/DSPPlacementType"}},"required":["placementType"],"type":"object"},"DSPPoint":{"properties":{"pointType":{"type":"string"},"x":{"$ref":"#/components/schemas/DSPXPoint"},"y":{"items":{"$ref":"#/components/schemas/DSPYPoint"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["x"],"type":"object"},"DSPPointLabel":{"description":"| PointLabel | Description |\n| --- | --- |\n| `SPEND` | Spend in monetary value. |\n| `BID` | Bid in monetary value. |\n| `DC` | Delivery confidence. |\n| `TAS` | Total available spend. |\n| `AIMP` | Available impressions. |\n| `AREA` | Available reach. |\n| `EIMP` | Expected impressions. |\n| `EREA` | Expected reach. |\n| `CPC` | Cost per click. |\n| `CPA` | Cost per action. |\n| `CPM` | Cost per mille. |\n| `ROAS` | Return on ad spend. |\n| `CAS` | Capped available spend. |","enum":["AIMP","AREA","BID","CAS","CPA","CPC","CPM","DC","EIMP","EREA","ROAS","SPEND","TAS"],"type":"string"},"DSPPrimaryInventoryType":{"description":"| PrimaryInventoryType | Description |\n| --- | --- |\n| `DISPLAY` |  |\n| `VIDEO_OLV` |  |\n| `VIDEO_STV` |  |\n| `AUDIO` |  |","enum":["AUDIO","DISPLAY","VIDEO_OLV","VIDEO_STV"],"type":"string"},"DSPProductCategoryRefinement":{"properties":{"productCategoryId":{"description":"The product category ID to target.","type":"string"}},"type":"object"},"DSPProductCategoryRefinementValue":{"properties":{"productCategoryRefinement":{"$ref":"#/components/schemas/DSPProductCategoryRefinement"}},"type":"object"},"DSPProductCategoryTarget":{"description":"Targets a specific customer search term.","properties":{"productCategoryRefinement":{"$ref":"#/components/schemas/DSPProductCategoryRefinementValue"}},"required":["productCategoryRefinement"],"type":"object"},"DSPProductIdType":{"description":"| ProductIdType | Description |\n| --- | --- |\n| `ASIN` | ASIN identifier type. |","enum":["ASIN"],"type":"string"},"DSPProductMarketplaceSetting":{"properties":{"marketplace":{"$ref":"#/components/schemas/DSPMarketplace"},"productId":{"description":"The product id applicable at the specified marketplace.","type":"string"}},"required":["marketplace","productId"],"type":"object"},"DSPProductMatchType":{"description":"| ProductMatchType | Description |\n| --- | --- |\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |","enum":["PRODUCT_EXACT"],"type":"string"},"DSPProductTarget":{"description":"Targets a specific product.","properties":{"matchType":{"$ref":"#/components/schemas/DSPProductMatchType"},"product":{"$ref":"#/components/schemas/DSPProductValue"},"productIdType":{"$ref":"#/components/schemas/DSPProductIdType"}},"required":["matchType","product","productIdType"],"type":"object"},"DSPProductValue":{"properties":{"marketplaceSettings":{"description":"The product ids at specific marketplace level. Either the product id or the marketplace settings should always be specified","items":{"$ref":"#/components/schemas/DSPProductMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"productId":{"description":"The product identifier. Either the product id or the marketplace settings should always be specified","type":"string"}},"type":"object"},"DSPRecommendedObjectType":{"description":"| RecommendedObjectType | Description |\n| --- | --- |\n| `CAMPAIGN` | An advertising campaign that groups together ad groups and ads |\n| `ADGROUP` | A group of ads within a campaign that share similar targeting |","enum":["ADGROUP","CAMPAIGN"],"type":"string"},"DSPRecurrence":{"description":"| Recurrence | Description |\n| --- | --- |\n| `DAILY` |  |\n| `MONTHLY` |  |\n| `LIFETIME` |  |","enum":["DAILY","LIFETIME","MONTHLY"],"type":"string"},"DSPReplanning":{"description":"Recommendation for replanning.","properties":{"content":{"type":"string"},"curves":{"items":{"$ref":"#/components/schemas/DSPCurve"},"maxItems":4,"minItems":0,"type":"array"},"deliverInFullConfidence":{"$ref":"#/components/schemas/DSPDeliverInFullConfidence"},"metrics":{"items":{"$ref":"#/components/schemas/DSPForecastMetric"},"maxItems":20,"minItems":0,"type":"array"},"scenarioFlight":{"$ref":"#/components/schemas/DSPForecastFlight"},"scenarioType":{"type":"string"},"selectedMetrics":{"description":"| SelectedForecastMetric | Description |\n| --- | --- |\n| `DC` | Delivery confidence. |\n| `TAS` | Total available spend. |\n| `AIMP` | Available impressions. |\n| `AREA` | Available reach. |\n| `EIMP` | Expected impressions. |\n| `EREA` | Expected reach. |\n| `CPC` | Cost per click. |\n| `CPA` | Cost per action. |\n| `CPM` | Cost per mille. |\n| `ROAS` | Return on ad spend. |\n| `CAS` | Capped available spend. |\n| `IREA` | Incremental reach. |","items":{"$ref":"#/components/schemas/DSPSelectedForecastMetric"},"maxItems":20,"minItems":0,"type":"array"},"title":{"type":"string"}},"required":["content","title"],"type":"object"},"DSPReplanningSettings":{"description":"Forecast request of a campaign, adGroups, flights, and targets with adjusted settings.","properties":{"adGroups":{"items":{"$ref":"#/components/schemas/DSPForecastAdGroup"},"maxItems":10,"minItems":0,"type":"array"},"campaign":{"$ref":"#/components/schemas/DSPForecastCampaign"},"flights":{"items":{"$ref":"#/components/schemas/DSPForecastFlight"},"maxItems":5,"minItems":0,"type":"array"},"targets":{"items":{"$ref":"#/components/schemas/DSPForecastTarget"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"DSPRetrieveCampaignForecastRequest":{"properties":{"campaignForecastDescriptions":{"items":{"$ref":"#/components/schemas/DSPCampaignForecastDescription"},"maxItems":1,"minItems":1,"type":"array"}},"type":"object"},"DSPRetrieveCommitmentRequest":{"properties":{"commitmentIds":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"DSPRetrieveCommitmentSpendRequest":{"properties":{"commitmentIds":{"items":{"$ref":"#/components/schemas/DSPCommitmentSpendIdentifier"},"maxItems":1,"minItems":1,"type":"array"}},"type":"object"},"DSPRolloverStrategy":{"description":"| RolloverStrategy | Description |\n| --- | --- |\n| `NO_ROLLOVER` | Do not rollover flight budgets. |\n| `PRIOR_BUDGET_ROLLOVER` | Rollover prior flight unused budget. |\n| `CUMULATIVE_BUDGET_ROLLOVER` | Rollover cumulative unused budget. |","enum":["CUMULATIVE_BUDGET_ROLLOVER","NO_ROLLOVER","PRIOR_BUDGET_ROLLOVER"],"type":"string"},"DSPSelectedForecastMetric":{"description":"| SelectedForecastMetric | Description |\n| --- | --- |\n| `DC` | Delivery confidence. |\n| `TAS` | Total available spend. |\n| `AIMP` | Available impressions. |\n| `AREA` | Available reach. |\n| `EIMP` | Expected impressions. |\n| `EREA` | Expected reach. |\n| `CPC` | Cost per click. |\n| `CPA` | Cost per action. |\n| `CPM` | Cost per mille. |\n| `ROAS` | Return on ad spend. |\n| `CAS` | Capped available spend. |\n| `IREA` | Incremental reach. |","enum":["AIMP","AREA","CAS","CPA","CPC","CPM","DC","EIMP","EREA","IREA","ROAS","TAS"],"type":"string"},"DSPSiteLanguage":{"description":"| SiteLanguage | Description |\n| --- | --- |\n| `AR` |  |\n| `BN` |  |\n| `CS` |  |\n| `DA` |  |\n| `DE` |  |\n| `EN` |  |\n| `ES` |  |\n| `FI` |  |\n| `FR` |  |\n| `GU` |  |\n| `HI` |  |\n| `IT` |  |\n| `JA` |  |\n| `KN` |  |\n| `ML` |  |\n| `MR` |  |\n| `NL` |  |\n| `NO` |  |\n| `PL` |  |\n| `PT` |  |\n| `PA` |  |\n| `SV` |  |\n| `TA` |  |\n| `TE` |  |\n| `TR` |  |\n| `ZH` |  |\n| `OTHER` |  |","enum":["AR","BN","CS","DA","DE","EN","ES","FI","FR","GU","HI","IT","JA","KN","ML","MR","NL","NO","OTHER","PA","PL","PT","SV","TA","TE","TR","ZH"],"type":"string"},"DSPSpendCalculationMode":{"description":"| SpendCalculationMode | Description |\n|------|------|\n| `ADVERTISER_ACCOUNT` | Spend is aggregated at the advertiser account level |\n| `CAMPAIGN` | Spend is aggregated at the campaign level |\n| `MANAGER_ACCOUNT` | Spend is aggregated at the manager account level |\n","enum":["ADVERTISER_ACCOUNT","CAMPAIGN","MANAGER_ACCOUNT"],"type":"string"},"DSPSpendDimension":{"description":"| SpendDimension | Description |\n| --- | --- |\n| `advertiserAccountId` | Identifier for an advertising account. |\n| `campaignId` | Identifier for campaign entity |\n| `dealId` | Identifier for deal entity |","oneOf":[{"properties":{"advertiserAccountId":{"type":"string"}},"required":["advertiserAccountId"],"title":"advertiserAccountId","type":"object"},{"properties":{"campaignId":{"type":"string"}},"required":["campaignId"],"title":"campaignId","type":"object"},{"properties":{"dealId":{"type":"string"}},"required":["dealId"],"title":"dealId","type":"object"}]},"DSPSpendDimensionType":{"description":"| SpendDimensionType | Description |\n| --- | --- |\n| `COMMITMENT` | Commitment Level Spend Detail |\n| `ADVERTISER` | Advertiser Level Spend Detail |\n| `CAMPAIGN` | Campaign Level Spend Detail |\n| `DEAL` | Deal Level Spend Detail |","enum":["ADVERTISER","CAMPAIGN","COMMITMENT","DEAL"],"type":"string"},"DSPState":{"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 | Description |\n| --- | --- |\n| `ENABLED` |  |\n| `PAUSED` |  |\n| `ARCHIVED` |  |","enum":["ARCHIVED","ENABLED","PAUSED"],"type":"string"},"DSPStatus":{"properties":{"deliveryReasons":{"description":"This is the list of reasons behind the delivery status.","items":{"$ref":"#/components/schemas/DSPDeliveryReason"},"maxItems":50,"minItems":0,"type":"array"},"deliveryStatus":{"$ref":"#/components/schemas/DSPDeliveryStatus"}},"required":["deliveryStatus"],"type":"object"},"DSPTacticKey":{"description":"A tactic type paired with its compatible inventory type","type":"object"},"DSPTacticsConvertersExclusionType":{"description":"| TacticsConvertersExclusionType | Description |\n| --- | --- |\n| `NO_EXCLUSION` |  |\n| `RECENT_CONVERTERS` |  |","enum":["NO_EXCLUSION","RECENT_CONVERTERS"],"type":"string"},"DSPTag":{"properties":{"key":{"description":"A custom key value pair entered by the advertiser.","type":"string"},"value":{"description":"A custom key value pair entered by the advertiser.","type":"string"}},"required":["key","value"],"type":"object"},"DSPTargetBid":{"type":"object"},"DSPTargetDetails":{"oneOf":[{"properties":{"keywordTarget":{"$ref":"#/components/schemas/DSPKeywordTarget"}},"required":["keywordTarget"],"title":"keywordTarget","type":"object"},{"properties":{"productTarget":{"$ref":"#/components/schemas/DSPProductTarget"}},"required":["productTarget"],"title":"productTarget","type":"object"},{"properties":{"productCategoryTarget":{"$ref":"#/components/schemas/DSPProductCategoryTarget"}},"required":["productCategoryTarget"],"title":"productCategoryTarget","type":"object"},{"properties":{"audienceTarget":{"$ref":"#/components/schemas/DSPAudienceTarget"}},"required":["audienceTarget"],"title":"audienceTarget","type":"object"},{"properties":{"locationTarget":{"$ref":"#/components/schemas/DSPLocationTarget"}},"required":["locationTarget"],"title":"locationTarget","type":"object"},{"properties":{"domainTarget":{"$ref":"#/components/schemas/DSPDomainTarget"}},"required":["domainTarget"],"title":"domainTarget","type":"object"},{"properties":{"appTarget":{"$ref":"#/components/schemas/DSPAppTarget"}},"required":["appTarget"],"title":"appTarget","type":"object"},{"properties":{"deviceTarget":{"$ref":"#/components/schemas/DSPDeviceTarget"}},"required":["deviceTarget"],"title":"deviceTarget","type":"object"},{"properties":{"dayPartTarget":{"$ref":"#/components/schemas/DSPDayPartTarget"}},"required":["dayPartTarget"],"title":"dayPartTarget","type":"object"},{"properties":{"contentCategoryTarget":{"$ref":"#/components/schemas/DSPContentCategoryTarget"}},"required":["contentCategoryTarget"],"title":"contentCategoryTarget","type":"object"},{"properties":{"contentGenreTarget":{"$ref":"#/components/schemas/DSPContentGenreTarget"}},"required":["contentGenreTarget"],"title":"contentGenreTarget","type":"object"},{"properties":{"contentRatingTarget":{"$ref":"#/components/schemas/DSPContentRatingTarget"}},"required":["contentRatingTarget"],"title":"contentRatingTarget","type":"object"},{"properties":{"brandSafetyTierTarget":{"$ref":"#/components/schemas/DSPBrandSafetyTierTarget"}},"required":["brandSafetyTierTarget"],"title":"brandSafetyTierTarget","type":"object"},{"properties":{"brandSafetyCategoryTarget":{"$ref":"#/components/schemas/DSPBrandSafetyCategoryTarget"}},"required":["brandSafetyCategoryTarget"],"title":"brandSafetyCategoryTarget","type":"object"},{"properties":{"inventorySourceTarget":{"$ref":"#/components/schemas/DSPInventorySourceTarget"}},"required":["inventorySourceTarget"],"title":"inventorySourceTarget","type":"object"},{"properties":{"adInitiationTarget":{"$ref":"#/components/schemas/DSPAdInitiationTarget"}},"required":["adInitiationTarget"],"title":"adInitiationTarget","type":"object"},{"properties":{"adPlayerSizeTarget":{"$ref":"#/components/schemas/DSPAdPlayerSizeTarget"}},"required":["adPlayerSizeTarget"],"title":"adPlayerSizeTarget","type":"object"},{"properties":{"videoAdFormatTarget":{"$ref":"#/components/schemas/DSPVideoAdFormatTarget"}},"required":["videoAdFormatTarget"],"title":"videoAdFormatTarget","type":"object"},{"properties":{"thirdPartyTarget":{"$ref":"#/components/schemas/DSPThirdPartyTarget"}},"required":["thirdPartyTarget"],"title":"thirdPartyTarget","type":"object"},{"properties":{"themeTarget":{"$ref":"#/components/schemas/DSPThemeTarget"}},"required":["themeTarget"],"title":"themeTarget","type":"object"},{"properties":{"contentInstreamPositionTarget":{"$ref":"#/components/schemas/DSPContentInstreamPositionTarget"}},"required":["contentInstreamPositionTarget"],"title":"contentInstreamPositionTarget","type":"object"},{"properties":{"contentOutstreamPositionTarget":{"$ref":"#/components/schemas/DSPContentOutstreamPositionTarget"}},"required":["contentOutstreamPositionTarget"],"title":"contentOutstreamPositionTarget","type":"object"},{"properties":{"videoContentDurationTarget":{"$ref":"#/components/schemas/DSPVideoContentDurationTarget"}},"required":["videoContentDurationTarget"],"title":"videoContentDurationTarget","type":"object"},{"properties":{"foldPositionTarget":{"$ref":"#/components/schemas/DSPFoldPositionTarget"}},"required":["foldPositionTarget"],"title":"foldPositionTarget","type":"object"},{"properties":{"nativeContentPositionTarget":{"$ref":"#/components/schemas/DSPNativeContentPositionTarget"}},"required":["nativeContentPositionTarget"],"title":"nativeContentPositionTarget","type":"object"},{"properties":{"placementTypeTarget":{"$ref":"#/components/schemas/DSPPlacementTypeTarget"}},"required":["placementTypeTarget"],"title":"placementTypeTarget","type":"object"}]},"DSPTargetLevel":{"description":"| TargetLevel | Description |\n| --- | --- |\n| `AD_GROUP` |  |","enum":["AD_GROUP"],"type":"string"},"DSPTargetType":{"description":"| TargetType | Description |\n| --- | --- |\n| `KEYWORD` |  |\n| `PRODUCT` |  |\n| `PRODUCT_CATEGORY` |  |\n| `AUDIENCE` |  |\n| `LOCATION` |  |\n| `DOMAIN` |  |\n| `APP` |  |\n| `DEVICE` |  |\n| `DAYPART` |  |\n| `CONTENT_CATEGORY` |  |\n| `CONTENT_GENRE` |  |\n| `CONTENT_RATING` |  |\n| `BRAND_SAFETY_TIER` |  |\n| `BRAND_SAFETY_CATEGORY` |  |\n| `INVENTORY_SOURCE` |  |\n| `AD_INITIATION` |  |\n| `AD_PLAYER_SIZE` |  |\n| `VIDEO_AD_FORMAT` |  |\n| `THIRD_PARTY` |  |\n| `THEME` |  |\n| `CONTENT_INSTREAM_POSITION` |  |\n| `CONTENT_OUTSTREAM_POSITION` |  |\n| `VIDEO_CONTENT_DURATION` |  |\n| `FOLD_POSITION` |  |\n| `NATIVE_CONTENT_POSITION` |  |\n| `PLACEMENT_TYPE` |  |","enum":["AD_INITIATION","AD_PLAYER_SIZE","APP","AUDIENCE","BRAND_SAFETY_CATEGORY","BRAND_SAFETY_TIER","CONTENT_CATEGORY","CONTENT_GENRE","CONTENT_INSTREAM_POSITION","CONTENT_OUTSTREAM_POSITION","CONTENT_RATING","DAYPART","DEVICE","DOMAIN","FOLD_POSITION","INVENTORY_SOURCE","KEYWORD","LOCATION","NATIVE_CONTENT_POSITION","PLACEMENT_TYPE","PRODUCT","PRODUCT_CATEGORY","THEME","THIRD_PARTY","VIDEO_AD_FORMAT","VIDEO_CONTENT_DURATION"],"type":"string"},"DSPTargetingSettings":{"properties":{"amazonViewability":{"$ref":"#/components/schemas/DSPAmazonViewability"},"automatedTargetingTactic":{"$ref":"#/components/schemas/DSPAutomatedTargetingTactic"},"defaultAudienceTargetingMatchType":{"$ref":"#/components/schemas/DSPDefaultAudienceTargetingMatchType"},"enableLanguageTargeting":{"description":"If set to true, creatives will only target supply where the content language matches the creative language.","type":"boolean"},"siteLanguage":{"$ref":"#/components/schemas/DSPSiteLanguage"},"tacticsConvertersExclusionType":{"$ref":"#/components/schemas/DSPTacticsConvertersExclusionType"},"targetedPGDealId":{"description":"DealId to be targeted by the Ad Group being created. If you are creating an ad group targeting a programmatic guaranteed deal, the deal can be provided here.","type":"string"},"timeZoneType":{"$ref":"#/components/schemas/DSPTimeZoneType"},"userLocationSignal":{"$ref":"#/components/schemas/DSPUserLocationSignal"},"videoCompletionTier":{"$ref":"#/components/schemas/DSPVideoCompletionTier"}},"type":"object"},"DSPThemeMatchType":{"description":"| ThemeMatchType | Description |\n| --- | --- |\n| `PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS` | Products similar to products advertised as part of the ad group. |","enum":["PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS"],"type":"string"},"DSPThemeTarget":{"description":"Theme targets let advertisers select high-performing targets based on a common theme.","properties":{"matchType":{"$ref":"#/components/schemas/DSPThemeMatchType"}},"required":["matchType"],"type":"object"},"DSPThirdPartyTarget":{"properties":{"thirdPartyTargetDetails":{"$ref":"#/components/schemas/DSPThirdPartyTargetDetails"},"thirdPartyTargetType":{"$ref":"#/components/schemas/DSPThirdPartyTargetType"}},"required":["thirdPartyTargetDetails","thirdPartyTargetType"],"type":"object"},"DSPThirdPartyTargetDetails":{"oneOf":[{"properties":{"doubleVerifyFraudInvalidTraffic":{"$ref":"#/components/schemas/DSPDoubleVerifyFraudInvalidTraffic"}},"required":["doubleVerifyFraudInvalidTraffic"],"title":"doubleVerifyFraudInvalidTraffic","type":"object"},{"properties":{"doubleVerifyStandardDisplayBrandSafety":{"$ref":"#/components/schemas/DSPDoubleVerifyStandardDisplayBrandSafety"}},"required":["doubleVerifyStandardDisplayBrandSafety"],"title":"doubleVerifyStandardDisplayBrandSafety","type":"object"},{"properties":{"doubleVerifyBrandSafety":{"$ref":"#/components/schemas/DSPDoubleVerifyBrandSafety"}},"required":["doubleVerifyBrandSafety"],"title":"doubleVerifyBrandSafety","type":"object"},{"properties":{"doubleVerifyViewability":{"$ref":"#/components/schemas/DSPDoubleVerifyViewability"}},"required":["doubleVerifyViewability"],"title":"doubleVerifyViewability","type":"object"},{"properties":{"doubleVerifyAuthenticBrandSafety":{"$ref":"#/components/schemas/DSPDoubleVerifyAuthenticBrandSafety"}},"required":["doubleVerifyAuthenticBrandSafety"],"title":"doubleVerifyAuthenticBrandSafety","type":"object"},{"properties":{"doubleVerifyCustomContextualSegmentId":{"$ref":"#/components/schemas/DSPDoubleVerifyCustomContextualSegmentId"}},"required":["doubleVerifyCustomContextualSegmentId"],"title":"doubleVerifyCustomContextualSegmentId","type":"object"},{"properties":{"doubleVerifyAuthenticAttention":{"$ref":"#/components/schemas/DSPDoubleVerifyAuthenticAttention"}},"required":["doubleVerifyAuthenticAttention"],"title":"doubleVerifyAuthenticAttention","type":"object"},{"properties":{"integralAdScienceFraudInvalidTraffic":{"$ref":"#/components/schemas/DSPIntegralAdScienceFraudInvalidTraffic"}},"required":["integralAdScienceFraudInvalidTraffic"],"title":"integralAdScienceFraudInvalidTraffic","type":"object"},{"properties":{"integralAdScienceBrandSafety":{"$ref":"#/components/schemas/DSPIntegralAdScienceBrandSafety"}},"required":["integralAdScienceBrandSafety"],"title":"integralAdScienceBrandSafety","type":"object"},{"properties":{"integralAdScienceViewability":{"$ref":"#/components/schemas/DSPIntegralAdScienceViewability"}},"required":["integralAdScienceViewability"],"title":"integralAdScienceViewability","type":"object"},{"properties":{"integralAdScienceContextualTargeting":{"$ref":"#/components/schemas/DSPIntegralAdScienceContextualTargeting"}},"required":["integralAdScienceContextualTargeting"],"title":"integralAdScienceContextualTargeting","type":"object"},{"properties":{"integralAdScienceContextualAvoidance":{"$ref":"#/components/schemas/DSPIntegralAdScienceContextualAvoidance"}},"required":["integralAdScienceContextualAvoidance"],"title":"integralAdScienceContextualAvoidance","type":"object"},{"properties":{"pixalateFraudInvalidTraffic":{"$ref":"#/components/schemas/DSPPixalateFraudInvalidTraffic"}},"required":["pixalateFraudInvalidTraffic"],"title":"pixalateFraudInvalidTraffic","type":"object"},{"properties":{"integralAdScienceQualitySync":{"$ref":"#/components/schemas/DSPIntegralAdScienceQualitySync"}},"required":["integralAdScienceQualitySync"],"title":"integralAdScienceQualitySync","type":"object"},{"properties":{"newsGuardBrandGuardTrustedNewsTargeting":{"$ref":"#/components/schemas/DSPNewsGuardBrandGuardTrustedNewsTargeting"}},"required":["newsGuardBrandGuardTrustedNewsTargeting"],"title":"newsGuardBrandGuardTrustedNewsTargeting","type":"object"},{"properties":{"newsGuardBrandGuardMisinformationSafety":{"$ref":"#/components/schemas/DSPNewsGuardBrandGuardMisinformationSafety"}},"required":["newsGuardBrandGuardMisinformationSafety"],"title":"newsGuardBrandGuardMisinformationSafety","type":"object"}]},"DSPThirdPartyTargetType":{"description":"| ThirdPartyTargetType | Description |\n| --- | --- |\n| `DOUBLE_VERIFY_FRAUD_INVALID_TRAFFIC` |  |\n| `DOUBLE_VERIFY_STANDARD_DISPLAY_BRAND_SAFETY` |  |\n| `DOUBLE_VERIFY_BRAND_SAFETY` |  |\n| `DOUBLE_VERIFY_VIEWABILITY` |  |\n| `DOUBLE_VERIFY_AUTHENTIC_BRAND_SAFETY` |  |\n| `DOUBLE_VERIFY_CUSTOM_CONTEXTUAL_SEGMENT_ID` |  |\n| `DOUBLE_VERIFY_AUTHENTIC_ATTENTION` |  |\n| `INTEGRAL_AD_SCIENCE_FRAUD_INVALID_TRAFFIC` |  |\n| `INTEGRAL_AD_SCIENCE_BRAND_SAFETY` |  |\n| `INTEGRAL_AD_SCIENCE_VIEWABILITY` |  |\n| `INTEGRAL_AD_SCIENCE_CONTEXTUAL_TARGETING` |  |\n| `INTEGRAL_AD_SCIENCE_CONTEXTUAL_AVOIDANCE` |  |\n| `PIXALATE_FRAUD_INVALID_TRAFFIC` |  |\n| `INTEGRAL_AD_SCIENCE_QUALITY_SYNC` | Integral Ad Science (IAS) Quality |\n| `NEWS_GUARD_BRAND_GUARD_TRUSTED_NEWS_TARGETING` | NewsGuard Trusted News Targeting. NewsGuard is a rating system for news and information websites. |\n| `NEWS_GUARD_BRAND_GUARD_MISINFORMATION_SAFETY` | NewsGuard Misinformation Safety. NewsGuard is a rating system for news and information websites. |","enum":["DOUBLE_VERIFY_AUTHENTIC_ATTENTION","DOUBLE_VERIFY_AUTHENTIC_BRAND_SAFETY","DOUBLE_VERIFY_BRAND_SAFETY","DOUBLE_VERIFY_CUSTOM_CONTEXTUAL_SEGMENT_ID","DOUBLE_VERIFY_FRAUD_INVALID_TRAFFIC","DOUBLE_VERIFY_STANDARD_DISPLAY_BRAND_SAFETY","DOUBLE_VERIFY_VIEWABILITY","INTEGRAL_AD_SCIENCE_BRAND_SAFETY","INTEGRAL_AD_SCIENCE_CONTEXTUAL_AVOIDANCE","INTEGRAL_AD_SCIENCE_CONTEXTUAL_TARGETING","INTEGRAL_AD_SCIENCE_FRAUD_INVALID_TRAFFIC","INTEGRAL_AD_SCIENCE_QUALITY_SYNC","INTEGRAL_AD_SCIENCE_VIEWABILITY","NEWS_GUARD_BRAND_GUARD_MISINFORMATION_SAFETY","NEWS_GUARD_BRAND_GUARD_TRUSTED_NEWS_TARGETING","PIXALATE_FRAUD_INVALID_TRAFFIC"],"type":"string"},"DSPTimeOfDay":{"properties":{"endTime":{"description":"Selected end time","pattern":"^([01][0-9]|2[0-3]):[0-5][0-9]Z$","type":"string"},"startTime":{"description":"Selected start time","pattern":"^([01][0-9]|2[0-3]):[0-5][0-9]Z$","type":"string"}},"required":["endTime","startTime"],"type":"object"},"DSPTimeUnit":{"description":"| TimeUnit | Description |\n| --- | --- |\n| `DAYS` |  |\n| `HOURS` |  |\n| `MINUTES` |  |","enum":["DAYS","HOURS","MINUTES"],"type":"string"},"DSPTimeZoneType":{"description":"| TimeZoneType | Description |\n| --- | --- |\n| `VIEWER` |  |\n| `ADVERTISER_REGION` |  |","enum":["ADVERTISER_REGION","VIEWER"],"type":"string"},"DSPTwitchContentRating":{"properties":{"twitchContentRating":{"$ref":"#/components/schemas/DSPTwitchContentRatingEnum"}},"required":["twitchContentRating"],"type":"object"},"DSPTwitchContentRatingEnum":{"description":"| TwitchContentRatingEnum | Description |\n| --- | --- |\n| `TWITCH_MODERATE` | Twitch Content with moderate content exclusions based on content classification labels received from Twitch. |\n| `TWITCH_RESTRICTIVE` | Twitch Content with restrictive content exlcusions based on content classification labels received from Twitch. |","enum":["TWITCH_MODERATE","TWITCH_RESTRICTIVE"],"type":"string"},"DSPUpdateCommitmentRequest":{"properties":{"commitments":{"items":{"$ref":"#/components/schemas/DSPCommitmentUpdate"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"DSPUserLocationSignal":{"description":"| UserLocationSignal | Description |\n| --- | --- |\n| `CURRENT` |  |\n| `MULTIPLE_SIGNALS` |  |","enum":["CURRENT","MULTIPLE_SIGNALS"],"type":"string"},"DSPVideoAdFormat":{"description":"| VideoAdFormat | Description |\n| --- | --- |\n| `INSTREAM` |  |\n| `FULL_EPISODE_PLAYER` |  |\n| `OUTSTREAM` |  |","enum":["FULL_EPISODE_PLAYER","INSTREAM","OUTSTREAM"],"type":"string"},"DSPVideoAdFormatTarget":{"description":"Target based on the video ad format.","properties":{"videoAdFormat":{"$ref":"#/components/schemas/DSPVideoAdFormat"}},"required":["videoAdFormat"],"type":"object"},"DSPVideoCompletionTier":{"description":"| VideoCompletionTier | Description |\n| --- | --- |\n| `ALL_TIERS` |  |\n| `GREATER_THAN_10_PERCENT` |  |\n| `GREATER_THAN_20_PERCENT` |  |\n| `GREATER_THAN_30_PERCENT` |  |\n| `GREATER_THAN_40_PERCENT` |  |\n| `GREATER_THAN_50_PERCENT` |  |\n| `GREATER_THAN_60_PERCENT` |  |\n| `GREATER_THAN_70_PERCENT` |  |\n| `GREATER_THAN_80_PERCENT` |  |\n| `GREATER_THAN_90_PERCENT` |  |","enum":["ALL_TIERS","GREATER_THAN_10_PERCENT","GREATER_THAN_20_PERCENT","GREATER_THAN_30_PERCENT","GREATER_THAN_40_PERCENT","GREATER_THAN_50_PERCENT","GREATER_THAN_60_PERCENT","GREATER_THAN_70_PERCENT","GREATER_THAN_80_PERCENT","GREATER_THAN_90_PERCENT"],"type":"string"},"DSPVideoContentDuration":{"description":"| VideoContentDuration | Description |\n| --- | --- |\n| `SHORT` | Video content duration of 0 to 10 minutes |\n| `MEDIUM` | Video content duration of 10 to 30 minutes |\n| `LONG` | Video content duration of 30 to 60 minutes |\n| `EXTENDED` | Video content duration of 60+ minutes |\n| `UNKNOWN` | Unknown video content duration |","enum":["EXTENDED","LONG","MEDIUM","SHORT","UNKNOWN"],"type":"string"},"DSPVideoContentDurationTarget":{"description":"Targets ads to a specific video content duration","properties":{"duration":{"$ref":"#/components/schemas/DSPVideoContentDuration"}},"required":["duration"],"type":"object"},"DSPVideoInitiationType":{"description":"| VideoInitiationType | Description |\n| --- | --- |\n| `USER_INITIATED` |  |\n| `AUTOPLAY` |  |\n| `UNKNOWN` |  |","enum":["AUTOPLAY","UNKNOWN","USER_INITIATED"],"type":"string"},"DSPViewabilityTier":{"description":"| ViewabilityTier | Description |\n| --- | --- |\n| `ALL_TIERS` |  |\n| `LESS_THAN_40_PERCENT` |  |\n| `GREATER_THAN_40_PERCENT` |  |\n| `GREATER_THAN_50_PERCENT` |  |\n| `GREATER_THAN_60_PERCENT` |  |\n| `GREATER_THAN_70_PERCENT` |  |","enum":["ALL_TIERS","GREATER_THAN_40_PERCENT","GREATER_THAN_50_PERCENT","GREATER_THAN_60_PERCENT","GREATER_THAN_70_PERCENT","LESS_THAN_40_PERCENT"],"type":"string"},"DSPViewabilityTierType":{"description":"The type of viewability tier.\n| ViewabilityTierType | Description |\n| --- | --- |\n| `ALLOW_ALL` |  |\n| `VIEWABILITY_TIER_GT_70` |  |\n| `VIEWABILITY_TIER_GT_60` |  |\n| `VIEWABILITY_TIER_GT_50` |  |\n| `VIEWABILITY_TIER_GT_40` |  |\n| `VIEWABILITY_TIER_LT_40` |  |","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_LT_40"],"type":"string"},"DSPWarning":{"description":"The warning message of a forecast.","properties":{"adGroupIds":{"items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"code":{"type":"string"},"message":{"type":"string"},"messageParameters":{"items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"warningLevel":{"format":"int32","type":"integer"}},"required":["code","message"],"type":"object"},"DSPXPoint":{"description":"The label and value on X axis of the curve.","properties":{"label":{"$ref":"#/components/schemas/DSPPointLabel"},"value":{"format":"double","type":"number"}},"required":["label","value"],"type":"object"},"DSPYPoint":{"description":"The label and value on Y axis of the curve.","properties":{"label":{"$ref":"#/components/schemas/DSPPointLabel"},"value":{"$ref":"#/components/schemas/DSPForecastValue"}},"required":["label","value"],"type":"object"},"DVBrandSafetyAppAgeRatingType":{"description":"| DVBrandSafetyAppAgeRatingType | Description |\n|------|------|\n| `ADULTS_ONLY_18_PLUS` |  |\n| `EVERYONE_4_PLUS` |  |\n| `MATURE_17_PLUS` |  |\n| `TEENS_12_PLUS` |  |\n| `TWEENS_9_PLUS` |  |\n| `UNKNOWN` |  |\n","enum":["ADULTS_ONLY_18_PLUS","EVERYONE_4_PLUS","MATURE_17_PLUS","TEENS_12_PLUS","TWEENS_9_PLUS","UNKNOWN"],"type":"string"},"DVBrandSafetyAppStarRatingType":{"description":"App star rating to be used for excluding apps.\n\n| DVBrandSafetyAppStarRatingType | Description |\n|------|------|\n| `ALLOW_ALL` |  |\n| `APP_STAR_RATING_LT_1_POINT_5_STARS` |  |\n| `APP_STAR_RATING_LT_2_POINT_5_STARS` |  |\n| `APP_STAR_RATING_LT_2_STARS` |  |\n| `APP_STAR_RATING_LT_3_POINT_5_STARS` |  |\n| `APP_STAR_RATING_LT_3_STARS` |  |\n| `APP_STAR_RATING_LT_4_POINT_5_STARS` |  |\n| `APP_STAR_RATING_LT_4_STARS` |  |\n","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS"],"type":"string"},"DVBrandSafetyContentCategoriesWithRiskMap":{"description":"A map from content categories to risk level to exclude from targeting. Available keys are: [ADULT_CONTENT, ALCOHOL, CRIME, DEATH_INJURIES, DISASTER_AVIATION, DISASTER_MAN_MADE, DISASTER_NATURAL, DISASTER_TERRORIST_EVENTS, DISASTER_VEHICLE, HATE_SPEECH, PROFANITY, SUBSTANCE_ABUSE, TOBACCO_ECIGARETTES, VIOLENCE_EXTREME_GRAPHIC].","properties":{"key":{"description":"Available keys are: [ADULT_CONTENT, ALCOHOL, CRIME, DEATH_INJURIES, DISASTER_AVIATION, DISASTER_MAN_MADE, DISASTER_NATURAL, DISASTER_TERRORIST_EVENTS, DISASTER_VEHICLE, HATE_SPEECH, PROFANITY, SUBSTANCE_ABUSE, TOBACCO_ECIGARETTES, VIOLENCE_EXTREME_GRAPHIC].","type":"string"},"value":{"$ref":"#/components/schemas/BrandSuitabilityRiskLevelType"}},"required":["key","value"],"type":"object"},"DVBrandSafetyContentCategoryType":{"description":"| DVBrandSafetyContentCategoryType | Description |\n|------|------|\n| `AD_SERVER` |  |\n| `CELEBRITY_GOSSIP` |  |\n| `CULTS_SURVIVALISM` |  |\n| `EXTREME_GRAPHIC` |  |\n| `GAMBLING` |  |\n| `INCENTIVIZED_MALWARE_CLUTTER` |  |\n| `INFLAMMATORY_POLITICS_NEWS` |  |\n| `NEGATIVE_NEWS_FINANCIAL` |  |\n| `NEGATIVE_NEWS_PHARMACEUTICAL` |  |\n| `NON_STANDARD_CONTENT_NON_ENGLISH` |  |\n| `NON_STANDARD_CONTENT_PARKING_PAGE` |  |\n| `OCCULT` |  |\n| `PIRACY_COPYRIGHT_INFRINGEMENT` |  |\n| `UNMODERATED_UGC_FORUMS_IMAGES_VIDEO` |  |\n","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","EXTREME_GRAPHIC","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"],"type":"string"},"DayOfWeek":{"description":"| DayOfWeek | Description |\n|------|------|\n| `FRIDAY` | Friday. |\n| `MONDAY` | Monday. |\n| `SATURDAY` | Saturday. |\n| `SUNDAY` | Sunday. |\n| `THURSDAY` | Thursday. |\n| `TUESDAY` | Tuesday. |\n| `WEDNESDAY` | Wednesday. |\n","enum":["FRIDAY","MONDAY","SATURDAY","SUNDAY","THURSDAY","TUESDAY","WEDNESDAY"],"type":"string"},"DayPartTarget":{"description":"Target based on time of day.","properties":{"dayOfWeek":{"$ref":"#/components/schemas/DayOfWeek"},"timeOfDay":{"$ref":"#/components/schemas/TimeOfDay"}},"required":["dayOfWeek","timeOfDay"],"type":"object"},"DeepLinkingBehavior":{"description":"| DeepLinkingBehavior | Description |\n|------|------|\n| `DISABLED` |  |\n| `ENABLED` |  |\n","enum":["DISABLED","ENABLED"],"type":"string"},"DefaultAudienceTargetingMatchType":{"description":"Match type for audience targeting inclusion groups, if any. You can enhance your ad group’s reach to consumers with similar shopping, streaming, and browsing behaviors or interests as your selected audiences across all inventory sources, regardless of the presence of ad identifiers. Only applicable at the adGroup level, rather than at individual audience level. (Default: SIMILAR). Note, SIMILAR is not applicable to certain advertised product categories, [see here](https://advertising.amazon.com/help/GX8G7HNDS5RBX3EF) for more information.\n\n| DefaultAudienceTargetingMatchType | Description |\n|------|------|\n| `EXACT` | Target the exact audiences specified in the ad group audience targeting. |\n| `SIMILAR` | Reach more audiences who are similar to your included audiences. |\n","enum":["EXACT","SIMILAR"],"type":"string"},"DeleteAdAssociationRequest":{"properties":{"adAssociationIds":{"items":{"type":"string"},"maxItems":20,"minItems":1,"type":"array"}},"type":"object"},"DeleteAdGroupRequest":{"properties":{"adGroupIds":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"DeleteAdRequest":{"properties":{"adIds":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"DeleteCampaignRequest":{"properties":{"campaignIds":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"DeleteTargetRequest":{"properties":{"targetIds":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"DeliveryProfile":{"description":"| DeliveryProfile | Description |\n|------|------|\n| `ASAP` | Makes your entire budget available to spend immediately. This is ideal for ad groups with limited inventory or when there\u0027s no requirement to spend throughout the length of the campaign.Warning: Selecting ASAP may result in your entire budget being spent immediately. |\n| `EVEN` | Even pacing spends your budget consistently across the length of the campaign. |\n| `PACE_AHEAD` | Pace Ahead can deliver up to 25% more than the daily Even pace targets. |\n","enum":["ASAP","EVEN","PACE_AHEAD"],"type":"string"},"DeliveryReason":{"description":"| 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_CREATIVES_NOT_RUNNING` |  |\n| `AD_EXTENSION_ARCHIVED` |  |\n| `AD_EXTENSION_PAUSED` |  |\n| `AD_EXTENSION_POLICING_PENDING_REVIEW` |  |\n| `AD_EXTENSION_POLICING_SUSPENDED` |  |\n| `AD_GROUPS_NOT_RUNNING` |  |\n| `AD_GROUP_ARCHIVED` |  |\n| `AD_GROUP_ENDED` |  |\n| `AD_GROUP_INCOMPLETE` |  |\n| `AD_GROUP_INELIGIBLE_GOAL_KPI` | Indicates that the ad group is suspended because the campaign\u0027s goal KPI is not supported. |\n| `AD_GROUP_LOW_BID` |  |\n| `AD_GROUP_MISSING_CONVERSION_TRACKING_SELECTIONS` | Indicates that the ad group is suspended because the campaign is missing conversion tracking selections. |\n| `AD_GROUP_PAUSED` |  |\n| `AD_GROUP_PENDING_REVIEW` |  |\n| `AD_GROUP_PENDING_START_DATE` |  |\n| `AD_GROUP_POLICING_PENDING_REVIEW` |  |\n| `AD_GROUP_POLICING_SUSPENDED` |  |\n| `AD_GROUP_REJECTED` |  |\n| `AD_GROUP_TOO_FEW_CONVERSION_TRACKING_SELECTIONS` | Indicates that the ad group is suspended because the campaign has an insufficient number of conversion tracking selections. |\n| `AD_GROUP_TOO_MANY_CONVERSION_TRACKING_SELECTIONS` | Indicates that the ad group is suspended because the campaign exceeded the maximum number of conversion tracking selections. |\n| `AD_INELIGIBLE` |  |\n| `AD_MISSING_DECORATION` |  |\n| `AD_MISSING_IMAGE` |  |\n| `AD_NOT_APPROVED_FOR_ALL_AD_GROUPS` |  |\n| `AD_NOT_ASSOCIATED_WITH_AD_GROUP` |  |\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_POLICING_SUSPENDED` |  |\n| `CAMPAIGN_REJECTED` |  |\n| `CREATIVE_MISSING_ASSET` |  |\n| `CREATIVE_PENDING_REVIEW` |  |\n| `CREATIVE_REJECTED` |  |\n| `LANDING_PAGE_INELIGIBLE` |  |\n| `LANDING_PAGE_NOT_AVAILABLE` |  |\n| `MODERATION_ADULT_NOVELTY_POLICY_VIOLATION` |  |\n| `MODERATION_ADULT_PRODUCT_POLICY_VIOLATION` |  |\n| `MODERATION_ADULT_SOFTLINES_POLICY_VIOLATION` |  |\n| `MODERATION_CLAIM_WEIGHTLOSS_POLICY_VIOLATION` |  |\n| `MODERATION_CONTENT_NUDITY_POLICY_VIOLATION` |  |\n| `MODERATION_CONTENT_PROVOCATIVE_POLICY_VIOLATION` |  |\n| `MODERATION_CONTENT_SMOKING_POLICY_VIOLATION` |  |\n| `MODERATION_CRITICAL_EVENTS_POLICY_VIOLATION` |  |\n| `MODERATION_ERROR_404` |  |\n| `MODERATION_GRAPHICAL_SEXUAL_IMAGES_POLICY_VIOLATION` |  |\n| `MODERATION_HFSS_PRODUCT_POLICY_VIOLATION` |  |\n| `MODERATION_LANGUAGE_OFFENSIVE_POLICY_VIOLATION` |  |\n| `MODERATION_NOT_COMPLIANT_TO_AD_POLICY` |  |\n| `MODERATION_SMOKING_RELATED_POLICY_VIOLATION` |  |\n| `NOT_BUYABLE` |  |\n| `NOT_IN_BUYBOX` |  |\n| `NOT_IN_POLICY` |  |\n| `NO_INVENTORY` |  |\n| `NO_PURCHASABLE_OFFER` |  |\n| `OTHER` |  |\n| `OUT_OF_REWARD_BUDGET` |  |\n| `OUT_OF_STOCK` |  |\n| `PIR_RULE_EXCLUDED` |  |\n| `PORTFOLIO_ARCHIVED` |  |\n| `PORTFOLIO_END_DATE_REACHED` |  |\n| `PORTFOLIO_OUT_OF_BUDGET` |  |\n| `PORTFOLIO_PAUSED` |  |\n| `PORTFOLIO_PENDING_START_DATE` |  |\n| `SECURITY_SCAN_PENDING_REVIEW` |  |\n| `SECURITY_SCAN_REJECTED` |  |\n| `SPEND_LIMIT_EXCEEDED` |  |\n| `STATUS_UNAVAILABLE` |  |\n| `TARGET_ARCHIVED` |  |\n| `TARGET_BLOCKED` |  |\n| `TARGET_PAUSED` |  |\n| `TARGET_POLICING_SUSPENDED` |  |\n","enum":["ADVERTISER_ARCHIVED","ADVERTISER_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_CREATIVES_NOT_RUNNING","AD_EXTENSION_ARCHIVED","AD_EXTENSION_PAUSED","AD_EXTENSION_POLICING_PENDING_REVIEW","AD_EXTENSION_POLICING_SUSPENDED","AD_GROUPS_NOT_RUNNING","AD_GROUP_ARCHIVED","AD_GROUP_ENDED","AD_GROUP_INCOMPLETE","AD_GROUP_INELIGIBLE_GOAL_KPI","AD_GROUP_LOW_BID","AD_GROUP_MISSING_CONVERSION_TRACKING_SELECTIONS","AD_GROUP_PAUSED","AD_GROUP_PENDING_REVIEW","AD_GROUP_PENDING_START_DATE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_SUSPENDED","AD_GROUP_REJECTED","AD_GROUP_TOO_FEW_CONVERSION_TRACKING_SELECTIONS","AD_GROUP_TOO_MANY_CONVERSION_TRACKING_SELECTIONS","AD_INELIGIBLE","AD_MISSING_DECORATION","AD_MISSING_IMAGE","AD_NOT_APPROVED_FOR_ALL_AD_GROUPS","AD_NOT_ASSOCIATED_WITH_AD_GROUP","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_POLICING_SUSPENDED","CAMPAIGN_REJECTED","CREATIVE_MISSING_ASSET","CREATIVE_PENDING_REVIEW","CREATIVE_REJECTED","LANDING_PAGE_INELIGIBLE","LANDING_PAGE_NOT_AVAILABLE","MODERATION_ADULT_NOVELTY_POLICY_VIOLATION","MODERATION_ADULT_PRODUCT_POLICY_VIOLATION","MODERATION_ADULT_SOFTLINES_POLICY_VIOLATION","MODERATION_CLAIM_WEIGHTLOSS_POLICY_VIOLATION","MODERATION_CONTENT_NUDITY_POLICY_VIOLATION","MODERATION_CONTENT_PROVOCATIVE_POLICY_VIOLATION","MODERATION_CONTENT_SMOKING_POLICY_VIOLATION","MODERATION_CRITICAL_EVENTS_POLICY_VIOLATION","MODERATION_ERROR_404","MODERATION_GRAPHICAL_SEXUAL_IMAGES_POLICY_VIOLATION","MODERATION_HFSS_PRODUCT_POLICY_VIOLATION","MODERATION_LANGUAGE_OFFENSIVE_POLICY_VIOLATION","MODERATION_NOT_COMPLIANT_TO_AD_POLICY","MODERATION_SMOKING_RELATED_POLICY_VIOLATION","NOT_BUYABLE","NOT_IN_BUYBOX","NOT_IN_POLICY","NO_INVENTORY","NO_PURCHASABLE_OFFER","OTHER","OUT_OF_REWARD_BUDGET","OUT_OF_STOCK","PIR_RULE_EXCLUDED","PORTFOLIO_ARCHIVED","PORTFOLIO_END_DATE_REACHED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PAUSED","PORTFOLIO_PENDING_START_DATE","SECURITY_SCAN_PENDING_REVIEW","SECURITY_SCAN_REJECTED","SPEND_LIMIT_EXCEEDED","STATUS_UNAVAILABLE","TARGET_ARCHIVED","TARGET_BLOCKED","TARGET_PAUSED","TARGET_POLICING_SUSPENDED"],"type":"string"},"DeliveryStatus":{"description":"| DeliveryStatus | Description |\n|------|------|\n| `DELIVERING` | Represents the resource is delivering. For global, DELIVERING status indicates that the resource is delivering in all marketplaces |\n| `LIMITED` | Represents partial delivery status, applicable to global resources that have different delivery status across 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","LIMITED","NOT_DELIVERING","UNAVAILABLE"],"type":"string"},"DeviceOrientation":{"description":"| DeviceOrientation | Description |\n|------|------|\n| `LANDSCAPE` | Device held horizontally. |\n| `PORTRAIT` | Device held vertically. |\n","enum":["LANDSCAPE","PORTRAIT"],"type":"string"},"DeviceTarget":{"description":"Target based on user device.","properties":{"deviceOrientation":{"$ref":"#/components/schemas/DeviceOrientation"},"deviceType":{"$ref":"#/components/schemas/DeviceType"},"mobileDevice":{"$ref":"#/components/schemas/MobileDevice"},"mobileEnvironment":{"$ref":"#/components/schemas/MobileEnvironment"},"mobileOs":{"$ref":"#/components/schemas/MobileOs"}},"required":["deviceType"],"type":"object"},"DeviceType":{"description":"| DeviceType | Description |\n|------|------|\n| `CONNECTED_DEVICE` | Connected TV, smart speakers. Used for audio AdGroup type. |\n| `CONNECTED_TV` | Connected TV devices. |\n| `DESKTOP` | Desktop computers and laptops. |\n| `MOBILE` | Mobile phones and tablets. |\n","enum":["CONNECTED_DEVICE","CONNECTED_TV","DESKTOP","MOBILE"],"type":"string"},"DirectIndexValue":{"description":"Values for a location index where the indexValue is the pre-calculated index.","properties":{"indexValue":{"description":"The pre-calculated index value.","format":"double","type":"number"},"postalCode":{"description":"The postal code for the location index prefixed by country code (i.e. US-10118).","type":"string"}},"required":["indexValue","postalCode"],"type":"object"},"DirectIndexValues":{"properties":{"values":{"description":"List of direct index values.","items":{"$ref":"#/components/schemas/DirectIndexValue"},"maxItems":1000000,"minItems":1,"type":"array"}},"required":["values"],"type":"object"},"DisplayCallToAction":{"oneOf":[{"properties":{"clickToAppDisplayCallToActionSettings":{"$ref":"#/components/schemas/ClickToAppDisplayCallToActionSettings"}},"required":["clickToAppDisplayCallToActionSettings"],"title":"clickToAppDisplayCallToActionSettings","type":"object"},{"properties":{"clickToUrlDisplayCallToActionSettings":{"$ref":"#/components/schemas/ClickToUrlDisplayCallToActionSettings"}},"required":["clickToUrlDisplayCallToActionSettings"],"title":"clickToUrlDisplayCallToActionSettings","type":"object"}]},"DisplayCreative":{"properties":{"standardDisplaySettings":{"$ref":"#/components/schemas/StandardDisplaySettings"}},"type":"object"},"DomainFileTarget":{"description":"Targets domains based on list provided via file upload.","properties":{"domainFileId":{"description":"The ID associated to the domain file to target. Read-only and created based on the inputted domainFileKey.","type":"string"},"domainFileKey":{"description":"The S3 key of the uploaded file which can be obtained from the file upload policy endpoint. A max of 10 files may be associated to one ad group.","type":"string"},"domainFileName":{"description":"The name of the file.","type":"string"},"domainFileUrl":{"description":"The file containing the domains uploaded. It expires in one hour.","type":"string"}},"required":["domainFileKey","domainFileName"],"type":"object"},"DomainListTarget":{"description":"Targets domains based on an existing domain list.","properties":{"domainListId":{"description":"The ID of the domain list to target.","type":"string"}},"required":["domainListId"],"type":"object"},"DomainNameTarget":{"description":"Targets domains based on URL.","properties":{"domainName":{"description":"The URL of the domain to target.","type":"string"}},"required":["domainName"],"type":"object"},"DomainTarget":{"description":"Target based on a specified domain.","properties":{"domainTargetDetails":{"$ref":"#/components/schemas/DomainTargetDetails"},"domainTargetType":{"$ref":"#/components/schemas/DomainTargetTypes"}},"required":["domainTargetDetails","domainTargetType"],"type":"object"},"DomainTargetDetails":{"oneOf":[{"properties":{"advertiserDomainList":{"$ref":"#/components/schemas/AdvertiserDomainList"}},"required":["advertiserDomainList"],"title":"advertiserDomainList","type":"object"},{"properties":{"domainFileTarget":{"$ref":"#/components/schemas/DomainFileTarget"}},"required":["domainFileTarget"],"title":"domainFileTarget","type":"object"},{"properties":{"domainListTarget":{"$ref":"#/components/schemas/DomainListTarget"}},"required":["domainListTarget"],"title":"domainListTarget","type":"object"},{"properties":{"domainNameTarget":{"$ref":"#/components/schemas/DomainNameTarget"}},"required":["domainNameTarget"],"title":"domainNameTarget","type":"object"}]},"DomainTargetTypes":{"description":"| DomainTargetTypes | Description |\n|------|------|\n| `ADVERTISER_DOMAIN_LIST` | Target domains inherited from the advertiser. |\n| `DOMAIN_FILE` | Target domains from an uploaded file. |\n| `DOMAIN_LIST` | Target domains from an existing domain list. |\n| `DOMAIN_NAME` | Target a specific domain by URL. |\n","enum":["ADVERTISER_DOMAIN_LIST","DOMAIN_FILE","DOMAIN_LIST","DOMAIN_NAME"],"type":"string"},"DoubleVerifyAuthenticAttention":{"properties":{"universalAttention":{"description":"One omni-channel segment that is informed by data from all DV campaigns to help avoid serving ads on generally poor performing apps and domains.","type":"boolean"}},"required":["universalAttention"],"type":"object"},"DoubleVerifyAuthenticBrandSafety":{"properties":{"doubleVerifySegmentId":{"pattern":"^51[0-9]{6}$","type":"string"}},"type":"object"},"DoubleVerifyBrandSafety":{"properties":{"appAgeRating":{"description":"A list of app age ratings to be used for excluding apps. For example, TEENS_12_PLUS will only exclude apps with content rated for everyone ages 12 and over. UNKNOWN will exclude apps with content unrated or unknown to Double Verify.","items":{"$ref":"#/components/schemas/DVBrandSafetyAppAgeRatingType"},"maxItems":50,"minItems":0,"type":"array"},"appStarRating":{"$ref":"#/components/schemas/DVBrandSafetyAppStarRatingType"},"contentCategories":{"description":"A list of content categories to exclude from targeting.","items":{"$ref":"#/components/schemas/DVBrandSafetyContentCategoryType"},"maxItems":50,"minItems":0,"type":"array"},"contentCategoriesWithRisk":{"items":{"$ref":"#/components/schemas/DVBrandSafetyContentCategoriesWithRiskMap"},"maxItems":50,"minItems":0,"type":"array"},"excludeAppsWithInsufficientRating":{"description":"Set to true to exclude unofficial apps or apps with insufficient user ratings (\u003c100 lifetime).","type":"boolean"},"unknownContent":{"description":"Set to true to exclude unknown content.","type":"boolean"}},"type":"object"},"DoubleVerifyCustomContextualSegmentId":{"properties":{"doubleVerifySegmentId":{"pattern":"^52[0-9]{6}$","type":"string"}},"type":"object"},"DoubleVerifyFraudInvalidTraffic":{"properties":{"blockAppAndSites":{"description":"Set to true to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen.","type":"boolean"},"excludeAppsAndSites":{"$ref":"#/components/schemas/ExcludeAppsAndSitesType"},"excludeImpressions":{"description":"Set to true to exclude impressions delivered to devices identified to be fraudulent or invalid.","type":"boolean"}},"type":"object"},"DoubleVerifyStandardDisplayBrandSafety":{"properties":{"contentCategories":{"description":"A list of content categories to exclude from targeting.","items":{"$ref":"#/components/schemas/DVBrandSafetyContentCategoryType"},"maxItems":50,"minItems":0,"type":"array"},"contentCategoriesWithRisk":{"items":{"$ref":"#/components/schemas/DVBrandSafetyContentCategoriesWithRiskMap"},"maxItems":50,"minItems":0,"type":"array"},"unknownContent":{"description":"Set to true to exclude unknown content.","type":"boolean"}},"type":"object"},"DoubleVerifyViewability":{"properties":{"averageCompletionAndFullyViewableRateTargeting":{"$ref":"#/components/schemas/AverageCompletionAndFullyViewableRateTargetingType"},"brandExposureViewabilityTargeting":{"$ref":"#/components/schemas/BrandExposureViewabilityTargetingType"},"includeUnmeasurableImpressions":{"description":"Set to true to include impressions where impressions can\u0027t be measured.","type":"boolean"},"mrcViewabilityTargeting":{"$ref":"#/components/schemas/MrcViewabilityTargetingType"}},"type":"object"},"DspContentRating":{"properties":{"dspContentRating":{"$ref":"#/components/schemas/DspContentRatingEnum"}},"required":["dspContentRating"],"type":"object"},"DspContentRatingEnum":{"description":"| DspContentRatingEnum | Description |\n|------|------|\n| `RATING_NOT_AVAILABLE` | Content where rating isn\u0027t available from the publisher. |\n| `SUITABLE_FOR_ADULTS` | Ages 18+. Equivalent to content that is rated NC-17 (film). |\n| `SUITABLE_FOR_ALL_AUDIENCES` | Equivalent to content that is rated G (film), TV-Y (TV), TV-Y7 (TV), TV-G (TV), EC (game), or E (game). |\n| `SUITABLE_FOR_MATURE_AUDIENCES` | Ages 17+. Equivalent to content that is rated R (film), TV-MA (TV), or M (game). |\n| `SUITABLE_FOR_MOST_AUDIENCES_WITH_PARENTAL_GUIDANCE` | Equivalent to content that is rated PG (film), TV-PG (TV), or E-10+ (game). |\n| `SUITABLE_FOR_TEEN_AND_OLDER_AUDIENCES` | Equivalent to content that is rated PG-13 (film), TV-14 (TV), or T (game). |\n","enum":["RATING_NOT_AVAILABLE","SUITABLE_FOR_ADULTS","SUITABLE_FOR_ALL_AUDIENCES","SUITABLE_FOR_MATURE_AUDIENCES","SUITABLE_FOR_MOST_AUDIENCES_WITH_PARENTAL_GUIDANCE","SUITABLE_FOR_TEEN_AND_OLDER_AUDIENCES"],"type":"string"},"Error":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"fieldLocation":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ErrorCode":{"description":"| 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| `GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_PORTFOLIO` | The campaign is associated with a global campaign. Portfolio association cannot be updated on a child campaign. Please perform operation on the global campaign. |\n| `GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_STATE` | The campaign is associated with a global campaign. The state on child campaign cannot be set to archived. Please perform operation on global campaign. |\n| `GLOBAL_CAMPAIGN_SINGLE_ADGROUP_LIMIT` | The campaign is associated with a global campaign. Only one ad group can be created under this campaign. |\n| `INTERNAL_ERROR` | The server encountered an unexpected condition that prevented it from fulfilling the request. |\n| `NOT_FOUND` | The requested resource does not exist. |\n| `PAYMENT_ISSUE` | Payment failed. |\n| `PRODUCT_INELIGIBLE` | Product is not eligible for advertising. Try again with a valid product. |\n| `RESOURCE_DOES_NOT_BELONG_TO_PARENT` | Resource does not belong to the specified parent. Try again with a valid parent ID. |\n| `RESOURCE_ID_NOT_FOUND` | Resource ID not found. Try again with valid ID. |\n| `RESOURCE_IS_EMPTY` | Update the request with the required information for this resource. |\n| `RESOURCE_IS_IN_TERMINAL_STATE` | Resource is in terminal state. |\n| `RESOURCE_IS_NULL` | Update the request with the required information for this resource. |\n| `TOO_MANY_REQUESTS` | There have been too many requests, please slow down your call rate. |\n| `TOTAL_RESOURCE_LIMIT_EXCEEDED` | Too many resources. Remove resources and try again. |\n| `UNAUTHORIZED` | The request lacks the necessary credentials. |\n| `UNSUPPORTED_MARKETPLACE` | Marketplace not supported. Try again with a supported marketplace. |\n","enum":["ACTION_NOT_SUPPORTED","ACTIVE_RESOURCE_LIMIT_EXCEEDED","ARCHIVED_PARENT_CANNOT_CREATE","ARCHIVED_PARENT_CANNOT_EDIT","ARCHIVED_RESOURCE_CANNOT_EDIT","AUTOCREATED_ENTITY_CANNOT_EDIT","BAD_REQUEST","CONFLICT","CONTENT_TOO_LARGE","DATE_CANNOT_BE_IN_PAST","DATE_CANNOT_BE_NULL","DATE_TOO_SOON","DUPLICATE_FIELD_VALUE_FOUND","DUPLICATE_RESOURCE_ID_FOUND","DURATION_TOO_SHORT","FEATURE_DISCONTINUED","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","GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_PORTFOLIO","GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_STATE","GLOBAL_CAMPAIGN_SINGLE_ADGROUP_LIMIT","INTERNAL_ERROR","NOT_FOUND","PAYMENT_ISSUE","PRODUCT_INELIGIBLE","RESOURCE_DOES_NOT_BELONG_TO_PARENT","RESOURCE_ID_NOT_FOUND","RESOURCE_IS_EMPTY","RESOURCE_IS_IN_TERMINAL_STATE","RESOURCE_IS_NULL","TOO_MANY_REQUESTS","TOTAL_RESOURCE_LIMIT_EXCEEDED","UNAUTHORIZED","UNSUPPORTED_MARKETPLACE"],"type":"string"},"ErrorsIndex":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":0,"minimum":0,"type":"integer"}},"required":["errors","index"],"type":"object"},"ExcludeAppsAndSitesType":{"description":"| ExcludeAppsAndSitesType | Description |\n|------|------|\n| `ALLOW_ALL` |  |\n| `FRAUD_TRAFFIC_LEVEL_GTE_02` |  |\n| `FRAUD_TRAFFIC_LEVEL_GTE_04` |  |\n| `FRAUD_TRAFFIC_LEVEL_GTE_06` |  |\n| `FRAUD_TRAFFIC_LEVEL_GTE_08` |  |\n| `FRAUD_TRAFFIC_LEVEL_GTE_100` |  |\n| `FRAUD_TRAFFIC_LEVEL_GTE_10` |  |\n| `FRAUD_TRAFFIC_LEVEL_GTE_25` |  |\n| `FRAUD_TRAFFIC_LEVEL_GTE_50` |  |\n","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_02","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_50"],"type":"string"},"Fee":{"properties":{"addToBudgetSpentAmount":{"description":"Applies only to THIRD_PARTY_APPLIED_FEE. When set to true, third-party applied fees are are added on top of the total ad group budget spent amount in reports.","type":"boolean"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"feeType":{"$ref":"#/components/schemas/FeeType"},"feeValue":{"description":"The fee amount expressed as the feeValueType. AMAZON_AUDIENCE_FEE AND THIRD_PARTY_AUDIENCE_FEE is in the currency of the marketplace. All other CPM based fees are in the currency of the advertiser. For percentages, 100 represents 100%.","format":"double","type":"number"},"feeValueType":{"$ref":"#/components/schemas/FeeValueType"},"thirdPartyProvider":{"$ref":"#/components/schemas/FeesThirdPartyProvider"}},"required":["addToBudgetSpentAmount","currencyCode","feeType","feeValue","feeValueType","thirdPartyProvider"],"type":"object"},"FeeType":{"description":"| FeeType | Description |\n|------|------|\n| `AMAZON_AUDIENCE` | CPM fee for using Amazon audiences. |\n| `AMAZON_DSP` | A service fee for using Amazon DSP and subtracted from the budget. This fee is applied as a percent of supply cost. |\n| `MANAGED_SERVICE_FEE` | The percentage-based fee applied to the Supply Cost for Amazon programmatic managed service. |\n| `OMNICHANNEL_METRICS` | Fee for using Amazon Omnichannel Metrics. |\n| `THIRD_PARTY_APPLIED` | User added CPM fee for using third-party data to track CPM costs. This fee is applied as a percent of supply cost. |\n| `THIRD_PARTY_AUDIENCE` | CPM fee for using a third party audience. |\n| `THIRD_PARTY_TARGETING` | CPM fee for using targeting provided by a third-party data provider. |\n","enum":["AMAZON_AUDIENCE","AMAZON_DSP","MANAGED_SERVICE_FEE","OMNICHANNEL_METRICS","THIRD_PARTY_APPLIED","THIRD_PARTY_AUDIENCE","THIRD_PARTY_TARGETING"],"type":"string"},"FeeValueType":{"description":"| FeeValueType | Description |\n|------|------|\n| `FIXED_CPM` | Charged based on a fixed CPM. The currency depends on the feeType. |\n| `PERCENTAGE_OF_BUDGET` | Subtracted from the campaign budget as a percent of budget |\n| `PERCENTAGE_OF_SUPPLY_COST` | Charged as a percent of supply (media) cost. Ranges from 0 to 1 where 0.15 represents 15%. |\n","enum":["FIXED_CPM","PERCENTAGE_OF_BUDGET","PERCENTAGE_OF_SUPPLY_COST"],"type":"string"},"FeesThirdPartyProvider":{"description":"| FeesThirdPartyProvider | Description |\n|------|------|\n| `COM_SCORE` |  |\n| `CPM_1` |  |\n| `CPM_2` |  |\n| `CPM_3` |  |\n| `DOUBLE_CLICK_CAMPAIGN_MANAGER` |  |\n| `DOUBLE_VERIFY` |  |\n| `INTEGRAL_AD_SCIENCE` |  |\n","enum":["COM_SCORE","CPM_1","CPM_2","CPM_3","DOUBLE_CLICK_CAMPAIGN_MANAGER","DOUBLE_VERIFY","INTEGRAL_AD_SCIENCE"],"type":"string"},"FlightBudget":{"properties":{"budgetType":{"$ref":"#/components/schemas/BudgetType"},"budgetValue":{"$ref":"#/components/schemas/BudgetValue"}},"required":["budgetType","budgetValue"],"type":"object"},"FoldPosition":{"description":"| FoldPosition | Description |\n|------|------|\n| `ABOVE_THE_FOLD` | Ad placement visible without scrolling. |\n| `BELOW_THE_FOLD` | Ad placement visible only after scrolling. |\n| `UNKNOWN` | Unknown fold position. |\n","enum":["ABOVE_THE_FOLD","BELOW_THE_FOLD","UNKNOWN"],"type":"string"},"FoldPositionTarget":{"description":"Targets ads in the specified fold position","properties":{"foldPosition":{"$ref":"#/components/schemas/FoldPosition"}},"required":["foldPosition"],"type":"object"},"ForbiddenResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"FormatProperties":{"properties":{"applyBorder":{"description":"Apply a boarder to the image to fit rules for some supplies.","type":"boolean"},"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"},"Frequency":{"properties":{"eventMaxCount":{"description":"The maximum number of times an EventType is served per user. For ADSP ad group, maximum supported value is 500.","format":"int32","maximum":99000,"minimum":1,"type":"integer"},"frequencyTargetingSetting":{"$ref":"#/components/schemas/FrequencyTargetingSetting"},"timeCount":{"description":"The value associated with the time and unit of time for this frequency cap.","format":"int32","maximum":60,"minimum":1,"type":"integer"},"timeUnit":{"$ref":"#/components/schemas/TimeUnit"}},"required":["eventMaxCount","frequencyTargetingSetting","timeCount","timeUnit"],"type":"object"},"FrequencyTargetingSetting":{"description":"| FrequencyTargetingSetting | Description |\n|------|------|\n| `HOUSEHOLD` | Control frequency an ad will be selected across people within the same household. |\n| `USER` | Control frequency an ad will be selected to a person. |\n","enum":["HOUSEHOLD","USER"],"type":"string"},"GatewayTimeoutResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"GeoLocation":{"properties":{"geoLocationId":{"description":"The identifier of the geo location.","type":"string"},"location":{"$ref":"#/components/schemas/GeoLocationUnion"}},"required":["geoLocationId","location"],"type":"object"},"GeoLocationCreate":{"properties":{"location":{"$ref":"#/components/schemas/CreateGeoLocationUnion"}},"required":["location"],"type":"object"},"GeoLocationMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":100,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/GeoLocationMultiStatusSuccess"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"GeoLocationMultiStatusSuccess":{"properties":{"geoLocation":{"$ref":"#/components/schemas/GeoLocation"},"index":{"format":"int32","maximum":99,"minimum":0,"type":"integer"}},"required":["geoLocation","index"],"type":"object"},"GeoLocationUnion":{"oneOf":[{"properties":{"smartLocation":{"$ref":"#/components/schemas/SmartLocation"}},"required":["smartLocation"],"title":"smartLocation","type":"object"}]},"GlobalStoreSettings":{"properties":{"catalogSourceMarketplace":{"$ref":"#/components/schemas/Marketplace"}},"type":"object"},"Goal":{"description":"| 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"},"GoalSettings":{"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"goal":{"$ref":"#/components/schemas/Goal"},"kpi":{"$ref":"#/components/schemas/KPI"},"kpiValue":{"description":"The value of the KPI that the campaign is working to optimize.","format":"double","type":"number"}},"required":["goal","kpi"],"type":"object"},"HorizontalPosition":{"description":"| HorizontalPosition | Description |\n| --- | --- |\n| `LEFT` | Left position |\n| `CENTER` | Center position |\n| `RIGHT` | Right position |","enum":["CENTER","LEFT","RIGHT"],"type":"string"},"IASBrandSafetyLevelType":{"description":"The IAS brand safety risk level.\n\n| IASBrandSafetyLevelType | Description |\n|------|------|\n| `ALLOW_ALL` |  |\n| `BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK` |  |\n| `BRAND_SAFETY_EXCLUDE_HIGH_RISK` |  |\n","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK","BRAND_SAFETY_EXCLUDE_HIGH_RISK"],"type":"string"},"IASFraudInvalidTrafficType":{"description":"The type of fraud invalid traffic.\n\n| IASFraudInvalidTrafficType | Description |\n|------|------|\n| `ALLOW_ALL` |  |\n| `FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK` |  |\n| `FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK` |  |\n","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK"],"type":"string"},"IASViewabilityStandardType":{"description":"The viewability standard.\n\n| IASViewabilityStandardType | Description |\n|------|------|\n| `GROUPM` |  |\n| `MRC` |  |\n| `NONE` |  |\n| `PUBLICIS` |  |\n","enum":["GROUPM","MRC","NONE","PUBLICIS"],"type":"string"},"Image":{"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/FormatProperties"},"maxItems":10,"minItems":0,"type":"array"}},"required":["assetId","assetVersion"],"type":"object"},"InGroupOperator":{"description":"| InGroupOperator | Description |\n|------|------|\n| `ALL` |  |\n| `ANY` |  |\n","enum":["ALL","ANY"],"type":"string"},"IndexStatus":{"description":"| IndexStatus | Description |\n|------|------|\n| `ENABLED` | The location index is active and can be used in smart locations. |\n| `FAILED` | The location index creation failed and cannot be used in smart locations. |\n| `PENDING` | The location index is being created and cannot be used in smart locations yet. |\n| `UPDATE_FAILED` | The location index update has failed, but the old version can still be used. |\n","enum":["ENABLED","FAILED","PENDING","UPDATE_FAILED"],"type":"string"},"IndexValues":{"oneOf":[{"properties":{"constituentIndexValues":{"$ref":"#/components/schemas/ConstituentIndexValues"}},"required":["constituentIndexValues"],"title":"constituentIndexValues","type":"object"},{"properties":{"directIndexValues":{"$ref":"#/components/schemas/DirectIndexValues"}},"required":["directIndexValues"],"title":"directIndexValues","type":"object"}]},"IneligibleAutomatedTargetingTactic":{"description":"Information about an ineligible tactic key and the reasons for ineligibility","properties":{"reasons":{"description":"List of reasons why this tactic key is ineligible","items":{"$ref":"#/components/schemas/IneligibleAutomatedTargetingTacticReason"},"maxItems":10,"minItems":0,"type":"array"},"tacticKey":{"$ref":"#/components/schemas/TacticKey"}},"required":["tacticKey"],"type":"object"},"IneligibleAutomatedTargetingTacticReason":{"description":"A single reason for tactic type ineligibility","properties":{"reasonCode":{"$ref":"#/components/schemas/IneligibleAutomatedTargetingTacticReasonCode"},"reasonMessage":{"description":"Human readable explanation of why this tactic type is ineligible","type":"string"}},"required":["reasonCode","reasonMessage"],"type":"object"},"IneligibleAutomatedTargetingTacticReasonCode":{"description":"Reason codes for why a tactic type is ineligible\n\n| IneligibleAutomatedTargetingTacticReasonCode | Description |\n|------|------|\n| `CONVERSION_SELECTIONS_EMPTY` | Campaign has no product or conversion event associations. |\n| `CONVERSION_SELECTIONS_EXCEEDED` | Campaign is associated with too many products or conversion events. |\n| `CONVERSION_SELECTIONS_MINIMUM_NOT_MET` | Minimum product or conversion event constraints not met. |\n| `NOT_ELIGIBLE_ADVERTISER` | The advertiser is not eligible for this tactic. |\n| `NOT_ELIGIBLE_GOAL` | The current campaign goal is not compatible with this tactic type. |\n| `NOT_ELIGIBLE_INVENTORY_TYPE` | This campaign\u0027s primary inventory types are not supported with this tactic type. |\n| `UNSUPPORTED_COUNTRY` | Selected tactic type is not available for the given country. |\n","enum":["CONVERSION_SELECTIONS_EMPTY","CONVERSION_SELECTIONS_EXCEEDED","CONVERSION_SELECTIONS_MINIMUM_NOT_MET","NOT_ELIGIBLE_ADVERTISER","NOT_ELIGIBLE_GOAL","NOT_ELIGIBLE_INVENTORY_TYPE","UNSUPPORTED_COUNTRY"],"type":"string"},"IntegralAdScienceBrandSafety":{"properties":{"excludeContent":{"description":"Set to true to exclude content that Integral Ad Science is not able to rate.","type":"boolean"},"iasBrandSafetyAdult":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyAlcohol":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyGambling":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyHateSpeech":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyIllegalDownloads":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyIllegalDrugs":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyOffensiveLanguage":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyViolence":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"}},"type":"object"},"IntegralAdScienceContextualAvoidance":{"properties":{"avoidanceSegments":{"description":"The unique identifier of the IAS contextual avoidance segment","items":{"type":"string"},"maxItems":200,"minItems":0,"type":"array"}},"type":"object"},"IntegralAdScienceContextualTargeting":{"properties":{"topicalSegments":{"description":"The unique identifier of the IAS contextual topical targeting segment","items":{"type":"string"},"maxItems":200,"minItems":0,"type":"array"},"verticalSegments":{"description":"The unique identifier of the IAS contextual vertical targeting segment","items":{"type":"string"},"maxItems":200,"minItems":0,"type":"array"}},"type":"object"},"IntegralAdScienceFraudInvalidTraffic":{"properties":{"targetSetting":{"$ref":"#/components/schemas/IASFraudInvalidTrafficType"}},"type":"object"},"IntegralAdScienceQualitySync":{"properties":{"segmentId":{"pattern":"^4[0-9]{6}$","type":"string"}},"type":"object"},"IntegralAdScienceViewability":{"description":"The IAS viewability standard.","properties":{"standard":{"$ref":"#/components/schemas/IASViewabilityStandardType"},"viewabilityTargeting":{"$ref":"#/components/schemas/ViewabilityTierType"}},"required":["standard"],"type":"object"},"InternalServerErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"InventorySourceTarget":{"description":"Target based on the source of the inventory.","properties":{"inventorySourceId":{"$ref":"#/components/schemas/MarketplaceStringValue"},"inventorySourceType":{"$ref":"#/components/schemas/InventorySourceType"}},"required":["inventorySourceId","inventorySourceType"],"type":"object"},"InventorySourceType":{"description":"| InventorySourceType | Description |\n|------|------|\n| `AMAZON` | Amazon-owned inventory. |\n| `APD` | Amazon Publisher Direct inventory. |\n| `DEAL` | Deal-based inventory. |\n| `INVENTORY_GROUP` | A group representing a set of inventories. |\n| `THIRD_PARTY_EXCHANGE` | Third-party exchange inventory. |\n","enum":["AMAZON","APD","DEAL","INVENTORY_GROUP","THIRD_PARTY_EXCHANGE"],"type":"string"},"InventoryType":{"description":"| InventoryType | Description |\n|------|------|\n| `AAP_MOBILE_APP` |  |\n| `AMAZON_MOBILE_DISPLAY` |  |\n| `AUDIO_AMAZON_DEAL` |  |\n| `AUDIO` | Audio ads that serve on streaming audio inventory. |\n| `DISPLAY` |  |\n| `LIVE_EVENTS` | Real-time broadcast inventory (sports, concerts, award shows) with audience volatility and concentrated traffic patterns requiring specialized pacing algorithms and event-specific metadata handling. |\n| `ONLINE_VIDEO` |  |\n| `PODCAST` | Podcast ads that serve on streaming podcast inventory. |\n| `STANDARD_DISPLAY` |  |\n| `STREAMING_TV_AMAZON_DEAL` |  |\n| `STREAMING_TV` |  |\n| `VIDEO` |  |\n","enum":["AAP_MOBILE_APP","AMAZON_MOBILE_DISPLAY","AUDIO","AUDIO_AMAZON_DEAL","DISPLAY","LIVE_EVENTS","ONLINE_VIDEO","PODCAST","STANDARD_DISPLAY","STREAMING_TV","STREAMING_TV_AMAZON_DEAL","VIDEO"],"type":"string"},"KPI":{"description":"| KPI | Description |\n|------|------|\n| `ADD_TO_CART` | Indicates a goal of driving improved add to cart |\n| `APPLICATIONS` | Indicates a goal of driving applications |\n| `CHECKOUTS` | Indicates a goal of driving improved checkouts |\n| `CLICKS` | Indicates a goal of driving clicks. |\n| `CLICK_THROUGH_RATE` | Indicates a goal of driving clickthrough rate. |\n| `COMBINED_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_COMBINED. |\n| `CONTACTS` | Indicates a goal of driving improved contacts |\n| `COST_PER_ACTION` | Deprecated. Please use COST_PER_CONVERSION_OFF_AMAZON. |\n| `COST_PER_CLICK` | Indicates a goal of driving improved cost per click. |\n| `COST_PER_CONVERSION_OFF_AMAZON` | Indicates a goal of driving improved cost per conversion off Amazon. |\n| `COST_PER_DETAIL_PAGE_VIEW` | Indicates a goal of driving improved cost per detail page view. |\n| `COST_PER_FIRST_APP_OPEN` | Indicates a goal of improved cost per first app open. |\n| `COST_PER_INSTALL` | Indicates a goal of driving improved cost per app install. |\n| `COST_PER_SIGN_UP` | Indicates a goal of driving improved cost per sign up. |\n| `COST_PER_VIDEO_COMPLETION` | Indicates a goal of driving improved cost per video completion. |\n| `DETAIL_PAGE_VIEW_RATE` | Indicates a goal of driving improved detail page view rate. |\n| `FREQUENCY_AVERAGE` | Indicates a goal of driving to a target frequency. |\n| `LEADS` | Indicates a goal of driving leads. |\n| `OTHER` | Indicates a goal of driving other metric |\n| `PAGE_VIEWS` | Indicates a goal of driving improved page views |\n| `PURCHASES` | Indicates a goal of driving improved purchases |\n| `REACH` | Indicates a goal of driving improved reach. |\n| `RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_PROMOTED. |\n| `ROAS_COMBINED` | Indicates a goal of driving improved return of ad spend (combined). |\n| `ROAS_PROMOTED` | Indicates a goal of driving improved return of ad spend (promoted). |\n| `ROAS` | Indicates a goal of driving improved return of ad spend. |\n| `SEARCH` | Indicates a goal of driving improved search |\n| `SIGN_UP` | Indicates a goal of driving improved sign up |\n| `SUBSCRIBE` | Indicates a goal of driving improved subscriptions |\n| `TOP_OF_SEARCH_IMPRESSION_SHARE` | Indicates a goal of maximizing impression for top search placement. |\n| `TOTAL_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS. |\n| `VIDEO_COMPLETION_RATE` | Indicates a goal of driving improved video completion rate. |\n","enum":["ADD_TO_CART","APPLICATIONS","CHECKOUTS","CLICKS","CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","CONTACTS","COST_PER_ACTION","COST_PER_CLICK","COST_PER_CONVERSION_OFF_AMAZON","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_SIGN_UP","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","FREQUENCY_AVERAGE","LEADS","OTHER","PAGE_VIEWS","PURCHASES","REACH","RETURN_ON_AD_SPEND","ROAS","ROAS_COMBINED","ROAS_PROMOTED","SEARCH","SIGN_UP","SUBSCRIBE","TOP_OF_SEARCH_IMPRESSION_SHARE","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"],"type":"string"},"KeywordMatchType":{"description":"| 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"},"KeywordTarget":{"description":"Targets a specific customer search term.","properties":{"keyword":{"description":"The customer search term or text to target","type":"string"},"matchType":{"$ref":"#/components/schemas/KeywordMatchType"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"nativeLanguageLocale":{"$ref":"#/components/schemas/LanguageLocale"}},"required":["keyword","matchType"],"type":"object"},"LandingPageAsins":{"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"},"LanguageLocale":{"description":"A combination of ISO-639 standard for language code and ISO-3166 for country code.\n\n| LanguageLocale | Description |\n|------|------|\n| `ak_GH` | Akan (Ghana). |\n| `am_ET` | Amharic (Ethiopia). |\n| `an_ES` | Aragonese (Spain). |\n| `ar_AE` | Arabic (UAE). |\n| `as_IN` | Assamese (India). |\n| `av_RU` | Avaric (Russia). |\n| `ay_BO` | Aymara (Bolivia). |\n| `ba_RU` | Bashkir (Russia). |\n| `be_BY` | Belarusian (Belarus). |\n| `bg_BG` | Bulgarian (Bulgaria). |\n| `bh_IN` | Bihari (India). |\n| `bi_VU` | Bislama (Vanuatu). |\n| `bm_ML` | Bambara (Mali). |\n| `bo_CN` | Tibetan (China). |\n| `bs_BA` | Bosnian (Bosnia and Herzegovina). |\n| `ca_ES` | Catalan (Spain). |\n| `ce_RU` | Chechen (Russia). |\n| `ch_GU` | Chamorro (Guam). |\n| `de_DE` | German (Germany). |\n| `el_GR` | Greek (Greece). |\n| `en_US` | English (United States). |\n| `eo_INT` | Esperanto (International). |\n| `es_ES` | Spanish (Spain). |\n| `et_EE` | Estonian (Estonia). |\n| `eu_ES` | Basque (Spain). |\n| `fa_IR` | Persian (Iran). |\n| `fi_FI` | Finnish (Finland). |\n| `fj_FJ` | Fijian (Fiji). |\n| `fo_FO` | Faroese (Faroe Islands). |\n| `fr_FR` | French (France). |\n| `fy_NL` | Western Frisian (Netherlands). |\n| `ga_IE` | Irish (Ireland). |\n| `gd_GB` | Scottish Gaelic (United Kingdom). |\n| `gl_ES` | Galician (Spain). |\n| `gn_PY` | Guarani (Paraguay). |\n| `gu_IN` | Gujarati (India). |\n| `gv_IM` | Manx (Isle of Man). |\n| `ha_NG` | Hausa (Nigeria). |\n| `he_IL` | Hebrew (Israel). |\n| `hi_IN` | Hindi (India). |\n| `ho_PG` | Hiri Motu (Papua New Guinea). |\n| `hr_HR` | Croatian (Croatia). |\n| `ht_HT` | Haitian Creole (Haiti). |\n| `hu_HU` | Hungarian (Hungary). |\n| `hy_AM` | Armenian (Armenia). |\n| `hz_NA` | Herero (Namibia). |\n| `ia_INT` | Interlingua (International). |\n| `id_ID` | Indonesian (Indonesia). |\n| `ie_INT` | Interlingue (International). |\n| `ig_NG` | Igbo (Nigeria). |\n| `ii_CN` | Sichuan Yi (China). |\n| `ik_US` | Inupiaq (United States). |\n| `io_INT` | Ido (International). |\n| `is_IS` | Icelandic (Iceland). |\n| `it_IT` | Italian (Italy). |\n| `iu_CA` | Inuktitut (Canada). |\n| `ja_JP` | Japanese (Japan). |\n| `jv_ID` | Javanese (Indonesia). |\n| `ka_GE` | Georgian (Georgia). |\n| `kg_CD` | Kongo (Democratic Republic of the Congo). |\n| `ki_KE` | Kikuyu (Kenya). |\n| `kj_NA` | Kwanyama (Namibia). |\n| `kk_KZ` | Kazakh (Kazakhstan). |\n| `kl_GL` | Kalaallisut (Greenland). |\n| `km_KH` | Khmer (Cambodia). |\n| `kn_IN` | Kannada (India). |\n| `ko_KR` | Korean (South Korea). |\n| `kr_NG` | Kanuri (Nigeria). |\n| `ks_IN` | Kashmiri (India). |\n| `ku_TR` | Kurdish (Turkey). |\n| `kv_RU` | Komi (Russia). |\n| `kw_GB` | Cornish (United Kingdom). |\n| `ky_KG` | Kyrgyz (Kyrgyzstan). |\n| `la_VA` | Latin (Vatican City). |\n| `lb_LU` | Luxembourgish (Luxembourg). |\n| `lg_UG` | Ganda (Uganda). |\n| `li_NL` | Limburgish (Netherlands). |\n| `ln_CD` | Lingala (Democratic Republic of the Congo). |\n| `lo_LA` | Lao (Laos). |\n| `lt_LT` | Lithuanian (Lithuania). |\n| `lu_CD` | Luba-Katanga (Democratic Republic of the Congo). |\n| `lv_LV` | Latvian (Latvia). |\n| `mg_MG` | Malagasy (Madagascar). |\n| `mh_MH` | Marshallese (Marshall Islands). |\n| `mi_NZ` | Māori (New Zealand). |\n| `mk_MK` | Macedonian (North Macedonia). |\n| `ml_IN` | Malayalam (India). |\n| `mn_MN` | Mongolian (Mongolia). |\n| `mr_IN` | Marathi (India). |\n| `ms_MY` | Malay (Malaysia). |\n| `mt_MT` | Maltese (Malta). |\n| `my_MM` | Burmese (Myanmar). |\n| `na_NR` | Nauru (Nauru). |\n| `nb_NO` | Norwegian Bokmål (Norway). |\n| `nd_ZW` | North Ndebele (Zimbabwe). |\n| `ne_NP` | Nepali (Nepal). |\n| `ng_NA` | Ndonga (Namibia). |\n| `nl_NL` | Dutch (Netherlands). |\n| `nn_NO` | Norwegian Nynorsk (Norway). |\n| `no_NO` | Norwegian (Norway). |\n| `nr_ZA` | South Ndebele (South Africa). |\n| `nv_US` | Navajo (United States). |\n| `ny_MW` | Chichewa (Malawi). |\n| `oc_FR` | Occitan (France). |\n| `oj_CA` | Ojibwa (Canada). |\n| `om_ET` | Oromo (Ethiopia). |\n| `or_IN` | Oriya (India). |\n| `os_RU` | Ossetian (Russia). |\n| `pa_IN` | Punjabi (India). |\n| `pi_IN` | Pali (India). |\n| `pl_PL` | Polish (Poland). |\n| `ps_AF` | Pashto (Afghanistan). |\n| `pt_PT` | Portuguese (Portugal). |\n| `qu_PE` | Quechua (Peru). |\n| `rm_CH` | Romansh (Switzerland). |\n| `rn_BI` | Kirundi (Burundi). |\n| `ro_RO` | Romanian (Romania). |\n| `ru_RU` | Russian (Russia). |\n| `rw_RW` | Kinyarwanda (Rwanda). |\n| `sa_IN` | Sanskrit (India). |\n| `sc_IT` | Sardinian (Italy). |\n| `sd_PK` | Sindhi (Pakistan). |\n| `se_NO` | Northern Sami (Norway). |\n| `sg_CF` | Sango (Central African Republic). |\n| `si_LK` | Sinhala (Sri Lanka). |\n| `sk_SK` | Slovak (Slovakia). |\n| `sl_SI` | Slovenian (Slovenia). |\n| `sm_WS` | Samoan (Samoa). |\n| `sn_ZW` | Shona (Zimbabwe). |\n| `so_SO` | Somali (Somalia). |\n| `sq_AL` | Albanian (Albania). |\n| `sr_RS` | Serbian (Serbia). |\n| `ss_SZ` | Swati (Eswatini). |\n| `st_LS` | Southern Sotho (Lesotho). |\n| `su_ID` | Sundanese (Indonesia). |\n| `sv_SE` | Swedish (Sweden). |\n| `sw_TZ` | Swahili (Tanzania). |\n| `ta_IN` | Tamil (India). |\n| `te_IN` | Telugu (India). |\n| `tg_TJ` | Tajik (Tajikistan). |\n| `th_TH` | Thai (Thailand). |\n| `ti_ET` | Tigrinya (Ethiopia). |\n| `tk_TM` | Turkmen (Turkmenistan). |\n| `tl_PH` | Tagalog (Philippines). |\n| `tn_BW` | Tswana (Botswana). |\n| `to_TO` | Tonga (Tonga). |\n| `tr_TR` | Turkish (Turkey). |\n| `ts_ZA` | Tsonga (South Africa). |\n| `tt_RU` | Tatar (Russia). |\n| `tw_GH` | Twi (Ghana). |\n| `ty_PF` | Tahitian (French Polynesia). |\n| `ug_CN` | Uyghur (China). |\n| `uk_UA` | Ukrainian (Ukraine). |\n| `ur_PK` | Urdu (Pakistan). |\n| `uz_UZ` | Uzbek (Uzbekistan). |\n| `ve_ZA` | Venda (South Africa). |\n| `vi_VN` | Vietnamese (Vietnam). |\n| `vo_INT` | Volapük (International). |\n| `wa_BE` | Walloon (Belgium). |\n| `wo_SN` | Wolof (Senegal). |\n| `xh_ZA` | Xhosa (South Africa). |\n| `yi_IL` | Yiddish (Israel). |\n| `yo_NG` | Yoruba (Nigeria). |\n| `za_CN` | Zhuang (China). |\n| `zh_CN` | Chinese (China). |\n| `zu_ZA` | Zulu (South Africa). |\n","enum":["ak_GH","am_ET","an_ES","ar_AE","as_IN","av_RU","ay_BO","ba_RU","be_BY","bg_BG","bh_IN","bi_VU","bm_ML","bo_CN","bs_BA","ca_ES","ce_RU","ch_GU","de_DE","el_GR","en_US","eo_INT","es_ES","et_EE","eu_ES","fa_IR","fi_FI","fj_FJ","fo_FO","fr_FR","fy_NL","ga_IE","gd_GB","gl_ES","gn_PY","gu_IN","gv_IM","ha_NG","he_IL","hi_IN","ho_PG","hr_HR","ht_HT","hu_HU","hy_AM","hz_NA","ia_INT","id_ID","ie_INT","ig_NG","ii_CN","ik_US","io_INT","is_IS","it_IT","iu_CA","ja_JP","jv_ID","ka_GE","kg_CD","ki_KE","kj_NA","kk_KZ","kl_GL","km_KH","kn_IN","ko_KR","kr_NG","ks_IN","ku_TR","kv_RU","kw_GB","ky_KG","la_VA","lb_LU","lg_UG","li_NL","ln_CD","lo_LA","lt_LT","lu_CD","lv_LV","mg_MG","mh_MH","mi_NZ","mk_MK","ml_IN","mn_MN","mr_IN","ms_MY","mt_MT","my_MM","na_NR","nb_NO","nd_ZW","ne_NP","ng_NA","nl_NL","nn_NO","no_NO","nr_ZA","nv_US","ny_MW","oc_FR","oj_CA","om_ET","or_IN","os_RU","pa_IN","pi_IN","pl_PL","ps_AF","pt_PT","qu_PE","rm_CH","rn_BI","ro_RO","ru_RU","rw_RW","sa_IN","sc_IT","sd_PK","se_NO","sg_CF","si_LK","sk_SK","sl_SI","sm_WS","sn_ZW","so_SO","sq_AL","sr_RS","ss_SZ","st_LS","su_ID","sv_SE","sw_TZ","ta_IN","te_IN","tg_TJ","th_TH","ti_ET","tk_TM","tl_PH","tn_BW","to_TO","tr_TR","ts_ZA","tt_RU","tw_GH","ty_PF","ug_CN","uk_UA","ur_PK","uz_UZ","ve_ZA","vi_VN","vo_INT","wa_BE","wo_SN","xh_ZA","yi_IL","yo_NG","za_CN","zh_CN","zu_ZA"],"type":"string"},"LearnMoreVideoCallToActionSettings":{"properties":{"url":{"description":"The url to drive users to learn more via the video CallToAction.","type":"string"}},"required":["url"],"type":"object"},"LocationIndex":{"properties":{"creationDateTime":{"description":"The date time the location index was created.","format":"date-time","type":"string"},"indexData":{"$ref":"#/components/schemas/IndexValues"},"indexId":{"description":"The identifier of the location index.","type":"string"},"indexName":{"description":"The name of the location index.","type":"string"},"lastUpdatedDateTime":{"description":"The date time the location index was last updated successfully.","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/IndexStatus"}},"required":["creationDateTime","indexData","indexId","indexName","lastUpdatedDateTime","status"],"type":"object"},"LocationIndexCreate":{"properties":{"indexData":{"$ref":"#/components/schemas/CreateIndexValues"},"indexName":{"description":"The name of the location index.","type":"string"}},"required":["indexData","indexName"],"type":"object"},"LocationIndexMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":10,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/LocationIndexMultiStatusSuccess"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"LocationIndexMultiStatusSuccess":{"properties":{"index":{"format":"int32","maximum":9,"minimum":0,"type":"integer"},"locationIndex":{"$ref":"#/components/schemas/LocationIndex"}},"required":["index","locationIndex"],"type":"object"},"LocationIndexSuccessResponse":{"properties":{"locationIndexes":{"items":{"$ref":"#/components/schemas/LocationIndex"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"LocationIndexUpdate":{"properties":{"indexData":{"$ref":"#/components/schemas/UpdateIndexValues"},"indexId":{"description":"The identifier of the location index.","type":"string"}},"required":["indexId"],"type":"object"},"LocationTarget":{"description":"Target based on geographic location.","properties":{"locationId":{"description":"The ID of the geographic location to target.","type":"string"},"locationIdResolved":{"description":"A human-readable location text. It\u0027s a read-only field.","type":"string"}},"required":["locationId"],"type":"object"},"Lookback":{"description":"| Lookback | Description |\n|------|------|\n| `DAYS_14` | Two week lookback period. |\n| `DAYS_180` | Six month lookback period. |\n| `DAYS_30` | One month lookback period. |\n| `DAYS_365` | One year lookback period. |\n| `DAYS_60` | Two month lookback period. |\n| `DAYS_7` | One week lookback period. |\n| `DAYS_90` | Three month lookback period. |\n","enum":["DAYS_14","DAYS_180","DAYS_30","DAYS_365","DAYS_60","DAYS_7","DAYS_90"],"type":"string"},"ManualCollectionSettings":{"description":"Settings for manually curated collections.","properties":{"landingPage":{"$ref":"#/components/schemas/CollectionLandingPage"},"productInclusions":{"description":"The products featured in the ad. Required for manual collections.","items":{"$ref":"#/components/schemas/AdvertisedProducts"},"maxItems":10,"minItems":3,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/SharedCollectionSettings"}},"required":["landingPage","productInclusions","sharedSettings"],"type":"object"},"Marketplace":{"description":"A list of country codes representing Amazon marketplaces\n\n| Marketplace | Description |\n|------|------|\n| `AE` |  |\n| `AU` |  |\n| `BE` |  |\n| `BR` |  |\n| `CA` |  |\n| `DE` |  |\n| `EG` |  |\n| `ES` |  |\n| `FR` |  |\n| `GB` |  |\n| `IE` |  |\n| `IN` |  |\n| `IT` |  |\n| `JP` |  |\n| `MX` |  |\n| `NL` |  |\n| `PL` |  |\n| `SA` |  |\n| `SE` |  |\n| `SG` |  |\n| `TR` |  |\n| `US` |  |\n| `ZA` |  |\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"},"MarketplaceAdConfigurations":{"properties":{"adId":{"description":"Represents marketplace ad id (Ex: adId-US) associated to global ad (Ex: adId-Global)","type":"string"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"overrides":{"$ref":"#/components/schemas/MarketplaceAdFieldOverrides"}},"required":["adId","marketplace","overrides"],"type":"object"},"MarketplaceAdFieldOverrides":{"properties":{"state":{"$ref":"#/components/schemas/State"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/Tag"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"MarketplaceAdGroupConfigurations":{"properties":{"adGroupId":{"description":"Represents marketplace adGroup id (Ex: adGroupId-US) associated to global adGroup (Ex: adGroupId-Global)","type":"string"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"overrides":{"$ref":"#/components/schemas/MarketplaceAdGroupFieldOverrides"}},"required":["adGroupId","marketplace","overrides"],"type":"object"},"MarketplaceAdGroupFieldOverrides":{"properties":{"name":{"description":"The name of the ad group for this marketplace","type":"string"},"state":{"$ref":"#/components/schemas/State"},"tags":{"description":"Marketplace specific tags for the ad group","items":{"$ref":"#/components/schemas/Tag"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"MarketplaceBudgetAllocation":{"description":"| MarketplaceBudgetAllocation | Description |\n|------|------|\n| `AUTO` | Auto distribute global budget to marketplaces in global campaign |\n| `MANUAL` | Manually distribute global budget to marketplaces in global campaign |\n","enum":["AUTO","MANUAL"],"type":"string"},"MarketplaceCampaignConfigurations":{"properties":{"campaignId":{"description":"Represents marketplace campaign id (Ex: campaignId-US) associated to global campaign (Ex: campaignId-Global)","type":"string"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"overrides":{"$ref":"#/components/schemas/MarketplaceCampaignFieldOverrides"}},"required":["campaignId","marketplace","overrides"],"type":"object"},"MarketplaceCampaignFieldOverrides":{"properties":{"endDateTime":{"description":"The end date time for the campaign","format":"date-time","type":"string"},"name":{"description":"The name of the campaign","type":"string"},"optimizations":{"$ref":"#/components/schemas/CampaignOptimizations"},"startDateTime":{"description":"The start date time for the campaign","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/State"},"tags":{"description":"Open ended labels with a key value pair applied to the campaign","items":{"$ref":"#/components/schemas/Tag"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"MarketplaceScope":{"description":"| MarketplaceScope | Description |\n|------|------|\n| `GLOBAL` |  |\n| `SINGLE_MARKETPLACE` |  |\n","enum":["GLOBAL","SINGLE_MARKETPLACE"],"type":"string"},"MarketplaceStringValue":{"properties":{"defaultValue":{"description":"The default value. Either the default value or the marketplace settings should always be specified","type":"string"}},"type":"object"},"MarketplaceTargetConfigurations":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"overrides":{"$ref":"#/components/schemas/MarketplaceTargetFieldOverrides"},"targetId":{"description":"Represents marketplace target id (Ex: targetId-US) associated to global target (Ex: targetId-Global)","type":"string"}},"required":["marketplace","overrides","targetId"],"type":"object"},"MarketplaceTargetFieldOverrides":{"properties":{"state":{"$ref":"#/components/schemas/State"},"tags":{"description":"Open ended labels with a key value pair applied to the target","items":{"$ref":"#/components/schemas/Tag"},"maxItems":50,"minItems":0,"type":"array"},"targetDetails":{"$ref":"#/components/schemas/OverridableTargets"}},"type":"object"},"MatchType":{"description":"| MatchType | Description |\n| --- | --- |\n| `KEYWORDS_RELATED_TO_GIFTS` | Search terms related to gifts. |\n| `KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY` | Search terms that shoppers often use when searching for and interacting with products from other brands in the category of your advertised products. The peer brands are selected automatically. |\n| `KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES` | Search terms related to your landing pages. |\n| `PRODUCT_SIMILAR` | Products similar to the specified product. |\n| `BROAD` | Broad match search terms. This expands matching on user intent beyond PHRASE.  |\n| `EXACT` | Exact match search terms. |\n| `KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY` | Search terms shoppers often use to search for products in the same category as the products you\u0027re advertising. |\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `PRODUCT_SUBSTITUTES` | Products that can be substituted for advertised product. |\n| `PRODUCT_REMARKETING` | Products to target users who have previously interacted with the specified product. |\n| `KEYWORDS_LOOSE_MATCH` | Search terms loosely matching advertised product. |\n| `PHRASE` | Phrase match search terms. This expands matching on user intent beyond EXACT. |\n| `INTERESTED_AUDIENCE` | Audiences that are likely interested in the advertised product or service. |\n| `KEYWORDS_CLOSE_MATCH` | Search terms closely matching advertised product. |\n| `PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS` | Products similar to products advertised as part of the ad group. |\n| `PRODUCT_COMPLEMENTS` |  |\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |\n| `KEYWORDS_RELATED_TO_PRIME_DAY` | Search terms that shoppers are likely to use during Prime Day. These keywords can include terms related to the event, like \"prime day\", combined with product-specific terms. These keywords can help you expand reach to shoppers during the sales event. These keywords will only match queries through the end of Prime Day. |","enum":["BROAD","EXACT","INTERESTED_AUDIENCE","KEYWORDS_CLOSE_MATCH","KEYWORDS_LOOSE_MATCH","KEYWORDS_RELATED_TO_GIFTS","KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY","KEYWORDS_RELATED_TO_PRIME_DAY","KEYWORDS_RELATED_TO_YOUR_BRAND","KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES","KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY","PHRASE","PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS","PRODUCT_COMPLEMENTS","PRODUCT_EXACT","PRODUCT_REMARKETING","PRODUCT_SIMILAR","PRODUCT_SUBSTITUTES"],"type":"string"},"MobileDevice":{"description":"| MobileDevice | Description |\n|------|------|\n| `ANDROID` | Android device. |\n| `IPAD` | Apple iPad. |\n| `IPHONE` | Apple iPhone. |\n| `KINDLE_FIRE_HD` | Amazon Kindle Fire HD. |\n| `KINDLE_FIRE` | Amazon Kindle Fire. |\n","enum":["ANDROID","IPAD","IPHONE","KINDLE_FIRE","KINDLE_FIRE_HD"],"type":"string"},"MobileEnvironment":{"description":"| MobileEnvironment | Description |\n|------|------|\n| `APP` | Mobile application. |\n| `WEB` | Mobile web browser. |\n","enum":["APP","WEB"],"type":"string"},"MobileOs":{"description":"| MobileOs | Description |\n|------|------|\n| `ANDROID` | Google Android operating system. |\n| `IOS` | Apple iOS operating system. |\n","enum":["ANDROID","IOS"],"type":"string"},"ModerationStatus":{"description":"| 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"},"MonetaryBudget":{"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"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"},"MonetaryBudgetMarketplaceSetting":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"monetaryBudget":{"$ref":"#/components/schemas/MonetaryBudget"}},"required":["marketplace","monetaryBudget"],"type":"object"},"MonetaryBudgetValue":{"properties":{"marketplaceSettings":{"description":"List of Monetary Budget values selectively applied at the given marketplace level","items":{"$ref":"#/components/schemas/MonetaryBudgetMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"monetaryBudget":{"$ref":"#/components/schemas/MonetaryBudget"}},"type":"object"},"MrcViewabilityTargetingType":{"description":"The type of MRC viewability targeting.\n\n| MrcViewabilityTargetingType | Description |\n|------|------|\n| `ALLOW_ALL` |  |\n| `MRC_VIEWABILITY_GTE_30` |  |\n| `MRC_VIEWABILITY_GTE_40` |  |\n| `MRC_VIEWABILITY_GTE_50` |  |\n| `MRC_VIEWABILITY_GTE_55` |  |\n| `MRC_VIEWABILITY_GTE_60` |  |\n| `MRC_VIEWABILITY_GTE_65` |  |\n| `MRC_VIEWABILITY_GTE_70` |  |\n| `MRC_VIEWABILITY_GTE_75` |  |\n| `MRC_VIEWABILITY_GTE_80` |  |\n","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_30","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_80"],"type":"string"},"NativeContentPosition":{"description":"| NativeContentPosition | Description |\n|------|------|\n| `IN_ARTICLE` | Positioned in the atomic unit of the content (e.g., in the article page or single image page). |\n| `IN_FEED` | Positioned in the feed of content (e.g., as an item inside the organic feed, grid, listing, carousel, etc.). |\n| `PERIPHERAL` | Positioned utside the core content (e.g., in the ads section on the right rail, as a banner-style placement near the content, etc.). |\n| `RECOMMENDATION` | Positioned in recommendation widget; most commonly presented below article content. |\n| `UNKNOWN` | Unknown position. |\n","enum":["IN_ARTICLE","IN_FEED","PERIPHERAL","RECOMMENDATION","UNKNOWN"],"type":"string"},"NativeContentPositionTarget":{"description":"Targets ads to a specific native content position","properties":{"nativePosition":{"$ref":"#/components/schemas/NativeContentPosition"}},"required":["nativePosition"],"type":"object"},"NewsGuardBrandGuardMisinformationSafety":{"properties":{"avoidanceList":{"description":"The unique identifiers of misinformation targets","items":{"$ref":"#/components/schemas/NewsGuardBrandGuardMisinformationSafetyType"},"maxItems":20,"minItems":0,"type":"array"}},"type":"object"},"NewsGuardBrandGuardMisinformationSafetyType":{"description":"| NewsGuardBrandGuardMisinformationSafetyType | Description |\n|------|------|\n| `AI_GENERATED_MFA` |  |\n| `BASIC_EXCLUDE` |  |\n| `CLIMATE_MISINFORMATION` |  |\n| `COVID_MISINFORMATION` |  |\n| `ELECTION_MISINFORMATION` |  |\n| `HEALTH_MISINFORMATION` |  |\n| `HIGH_EXCLUDE` |  |\n| `ISRAEL_HAMAS_MISINFORMATION` |  |\n| `MAX_EXCLUDE` |  |\n| `MISINFORMATION_SITES` |  |\n| `OPINIONATED_NEWS` |  |\n| `QANON_MISINFORMATION` |  |\n| `UKRAINE_MISINFORMATION` |  |\n| `VACCINE_MISINFORMATION` |  |\n","enum":["AI_GENERATED_MFA","BASIC_EXCLUDE","CLIMATE_MISINFORMATION","COVID_MISINFORMATION","ELECTION_MISINFORMATION","HEALTH_MISINFORMATION","HIGH_EXCLUDE","ISRAEL_HAMAS_MISINFORMATION","MAX_EXCLUDE","MISINFORMATION_SITES","OPINIONATED_NEWS","QANON_MISINFORMATION","UKRAINE_MISINFORMATION","VACCINE_MISINFORMATION"],"type":"string"},"NewsGuardBrandGuardTrustedNewsTargeting":{"description":"Only applicable for Web supply.","properties":{"targetingList":{"description":"The unique identifiers of trusted news targets","items":{"$ref":"#/components/schemas/NewsGuardBrandGuardTrustedNewsTargetingType"},"maxItems":15,"minItems":0,"type":"array"}},"type":"object"},"NewsGuardBrandGuardTrustedNewsTargetingType":{"description":"| NewsGuardBrandGuardTrustedNewsTargetingType | Description |\n|------|------|\n| `BASIC_INCLUDE` |  |\n| `BUSINESS_INCLUDE` |  |\n| `COMMUNITY_INCLUDE` |  |\n| `HEALTH_INCLUDE` |  |\n| `HIGH_INCLUDE` |  |\n| `LIFESTYLE_INCLUDE` |  |\n| `LOCAL_INCLUDE` |  |\n| `MAX_INCLUDE` |  |\n| `POLITICS_INCLUDE` |  |\n| `TECH_INCLUDE` |  |\n","enum":["BASIC_INCLUDE","BUSINESS_INCLUDE","COMMUNITY_INCLUDE","HEALTH_INCLUDE","HIGH_INCLUDE","LIFESTYLE_INCLUDE","LOCAL_INCLUDE","MAX_INCLUDE","POLITICS_INCLUDE","TECH_INCLUDE"],"type":"string"},"NotFoundResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"OffAmazonBudgetControlStrategy":{"description":"| OffAmazonBudgetControlStrategy | Description |\n|------|------|\n| `MAXIMIZE_REACH` | Maximize the reach of off-Amazon inventory within the budget. |\n| `MINIMIZE_SPEND` | Minimize spend on off-Amazon inventory while maintaining delivery. |\n","enum":["MAXIMIZE_REACH","MINIMIZE_SPEND"],"type":"string"},"OnlineVideoSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/VideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"$ref":"#/components/schemas/AdvertisedProducts"},"videos":{"$ref":"#/components/schemas/Video"}},"required":["language","videos"],"type":"object"},"Optimization":{"properties":{"bidStrategy":{"$ref":"#/components/schemas/BidStrategy"},"budgetSettings":{"$ref":"#/components/schemas/AdGroupBudgetSettings"},"goalSettings":{"$ref":"#/components/schemas/AdGroupGoalSettings"}},"type":"object"},"OverridableTargets":{"oneOf":[{"properties":{"keywordTarget":{"$ref":"#/components/schemas/KeywordTarget"}},"required":["keywordTarget"],"title":"keywordTarget","type":"object"},{"properties":{"themeTarget":{"$ref":"#/components/schemas/ThemeTarget"}},"required":["themeTarget"],"title":"themeTarget","type":"object"}]},"Pacing":{"properties":{"deliveryProfile":{"$ref":"#/components/schemas/DeliveryProfile"}},"required":["deliveryProfile"],"type":"object"},"PixalateFraudInvalidTraffic":{"properties":{"excludeAppsAndDomains":{"description":"Set to true to exclude traffic from Apps and Domains identified to be fraudulent or invalid.","type":"boolean"},"excludeIpAddressAndUserAgents":{"description":"Set to true to exclude traffic from IPV4 and IPV6 addresses and user agents identified to be fraudulent or invalid.","type":"boolean"},"excludeOttAndMobileDevices":{"description":"Set to true to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid.","type":"boolean"},"excludeRemovedAppsFromAppStores":{"description":"Set to true to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months.","type":"boolean"}},"type":"object"},"Placement":{"description":"| 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| `SITE_AMAZON_BUSINESS` | Amazon Business site placements. |\n| `TOP_OF_SEARCH` | Placements on the top row of the first-page search results. |\n","enum":["HOME_PAGE","PRODUCT_PAGE","REST_OF_SEARCH","SITE_AMAZON_BUSINESS","TOP_OF_SEARCH"],"type":"string"},"PlacementBidAdjustment":{"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/Placement"}},"required":["percentage","placement"],"type":"object"},"PlacementType":{"description":"| PlacementType | Description |\n|------|------|\n| `REWARDED` | Rewarded video type where users receive rewards from the publisher for watching ads. |\n","enum":["REWARDED"],"type":"string"},"PlacementTypeTarget":{"description":"Target based on the placement type.","properties":{"placementType":{"$ref":"#/components/schemas/PlacementType"}},"required":["placementType"],"type":"object"},"PrimaryInventoryType":{"description":"| PrimaryInventoryType | Description |\n|------|------|\n| `AUDIO` | Audio ads that serve on streaming audio and podcast inventory. |\n| `DISPLAY` | Image ads that serve across Amazon and third-party inventory. |\n| `VIDEO_OLV` | Video ads that serve on online video inventory. |\n| `VIDEO_STV` | Video ads that serve on streaming TV inventory. |\n","enum":["AUDIO","DISPLAY","VIDEO_OLV","VIDEO_STV"],"type":"string"},"PriorityAsin":{"description":"Product information for a priority ASIN","properties":{"addToCartActionParams":{"description":"Parameters for add to cart action","type":"string"},"bottleDepositFee":{"description":"Bottle deposit fee amount","type":"string"},"bottleDepositFeeString":{"description":"Bottle deposit fee as string","type":"string"},"cartQuantity":{"description":"Quantity of this item in the cart","format":"double","type":"number"},"catalogDisplayPricePerUnitOfMeasure":{"description":"Price per unit of measure for display","type":"string"},"freshButton":{"description":"Fresh button information","type":"string"},"isAlternateSearchResult":{"description":"Flag indicating if this is an alternate search result","type":"boolean"},"isRequiredQuantityInCart":{"description":"Flag indicating if a quantity is required in cart","type":"boolean"},"isSoldByCount":{"description":"Flag indicating if the product is sold by count","type":"boolean"},"itemAvailability":{"description":"Status of item availability","type":"string"},"offerId":{"description":"Unique identifier for the offer","type":"string"},"offerName":{"description":"Display name of the product offer","type":"string"},"offerUnit":{"description":"Unit of the offer (e.g., Fl Oz, lb)","type":"string"},"productAsin":{"description":"ASIN associated with this product","type":"string"},"productDetailsUrl":{"description":"URL to the product details page","type":"string"},"productImageUrl":{"description":"URL of the product image","type":"string"},"promotionDisplay":{"description":"Display text for active promotion","type":"string"},"promotionId":{"description":"Identifier for active promotion","type":"string"},"quantityInStock":{"description":"Available quantity in stock","format":"double","type":"number"},"requiredQuantity":{"description":"Required quantity for purchase","format":"double","type":"number"},"retailATCButton":{"description":"Retail add-to-cart button information","type":"string"},"reviewStars":{"$ref":"#/components/schemas/ReviewStars"},"searchTerm":{"description":"Search term associated with this product","type":"string"},"subtotalParams":{"description":"Subtotal parameters for pricing calculations","type":"string"},"vuomDisplayPrice":{"description":"Display price for virtual unit of measure","type":"string"}},"required":["addToCartActionParams","cartQuantity","isAlternateSearchResult","isRequiredQuantityInCart","isSoldByCount","itemAvailability","offerId","offerName","offerUnit","productAsin","productDetailsUrl","productImageUrl","requiredQuantity","subtotalParams","vuomDisplayPrice"],"type":"object"},"ProductAudienceMatchType":{"description":"| ProductAudienceMatchType | Description |\n|------|------|\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |\n| `PRODUCT_SIMILAR` | Products similar to the specified product. |\n","enum":["PRODUCT_EXACT","PRODUCT_SIMILAR"],"type":"string"},"ProductAudienceTarget":{"description":"Target customers who have viewed or purchased a certain product within a specified lookback window.","properties":{"asin":{"$ref":"#/components/schemas/MarketplaceStringValue"},"event":{"$ref":"#/components/schemas/TargetEvent"},"lookback":{"$ref":"#/components/schemas/Lookback"},"matchType":{"$ref":"#/components/schemas/ProductAudienceMatchType"}},"required":["asin","event","lookback","matchType"],"type":"object"},"ProductCategoryMatchType":{"description":"| ProductCategoryMatchType | Description |\n|------|------|\n| `MULTISIGNAL_BROAD` | This expands matching on user intent beyond BROAD by taking multiple behavioral and contextual signals. |\n","enum":["MULTISIGNAL_BROAD"],"type":"string"},"ProductCategoryRefinement":{"properties":{"productAgeRangeId":{"description":"The age range ID to target.","type":"string"},"productAgeRangeIdResolved":{"description":"The resolved age range to target.","type":"string"},"productBrandId":{"description":"The brand ID to target.","type":"string"},"productBrandIdResolved":{"description":"The resolved name of the brand.","type":"string"},"productCategoryId":{"description":"The product category ID to target.","type":"string"},"productCategoryIdResolved":{"description":"The resolved product category.","type":"string"},"productGenreId":{"description":"The product genre ID to target.","type":"string"},"productGenreIdResolved":{"description":"The resolved product genre to target.","type":"string"},"productPriceGreaterThan":{"description":"Refinement to target products with a price greater than the value within the product category.","format":"double","type":"number"},"productPriceLessThan":{"description":"Refinement to target products with a price less than the value within the product category.","format":"double","type":"number"},"productPrimeShippingEligible":{"description":"Target based on if a product is Prime-shipping eligible.","type":"boolean"},"productRatingGreaterThan":{"description":"Refinement to target products with a rating greater than the value within the product category.","format":"double","type":"number"},"productRatingLessThan":{"description":"Refinement to target products with a rating less than the value within the product category.","format":"double","type":"number"}},"type":"object"},"ProductCategoryRefinementMarketplaceSetting":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"productCategoryRefinement":{"$ref":"#/components/schemas/ProductCategoryRefinement"}},"required":["marketplace","productCategoryRefinement"],"type":"object"},"ProductCategoryRefinementValue":{"properties":{"marketplaceSettings":{"description":"Marketplace specific product category refinements. Either the value or the marketplaceSettings should always be specified","items":{"$ref":"#/components/schemas/ProductCategoryRefinementMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"productCategoryRefinement":{"$ref":"#/components/schemas/ProductCategoryRefinement"}},"type":"object"},"ProductCategoryTarget":{"description":"Targets a specific customer search term.","properties":{"matchType":{"$ref":"#/components/schemas/ProductCategoryMatchType"},"productCategoryRefinement":{"$ref":"#/components/schemas/ProductCategoryRefinementValue"},"productGenreRefinement":{"$ref":"#/components/schemas/ProductGenreRefinement"}},"required":["productCategoryRefinement"],"type":"object"},"ProductCollectionCreativePropertiesToOptimize":{"description":"| ProductCollectionCreativePropertiesToOptimize | Description |\n|------|------|\n| `HEADLINE` | The headline in the creative. |\n","enum":["HEADLINE"],"type":"string"},"ProductCollectionLandingPage":{"properties":{"landingPageAsins":{"$ref":"#/components/schemas/LandingPageAsins"},"landingPageType":{"$ref":"#/components/schemas/ProductCollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page. Read only if landingPageType is ASIN_LIST","type":"string"}},"required":["landingPageType"],"type":"object"},"ProductCollectionLandingPageType":{"description":"| 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"},"ProductCollectionSettings":{"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/Image"},"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/ProductCollectionCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"customImages":{"description":"The set of custom images featured in the ad.","items":{"$ref":"#/components/schemas/Image"},"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/ProductCollectionLandingPage"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"},"products":{"description":"The products featured in the ad.","items":{"$ref":"#/components/schemas/AdvertisedProducts"},"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"},"ProductCreative":{"properties":{"productCreativeSettings":{"$ref":"#/components/schemas/ProductCreativeSettings"}},"required":["productCreativeSettings"],"type":"object"},"ProductCreativeSettings":{"description":"An ad with a creative built based on the product being advertised.","properties":{"advertisedProduct":{"$ref":"#/components/schemas/AdvertisedProducts"},"headline":{"description":"The headline/custom text associated with the ad creative.","type":"string"},"spotlightVideos":{"$ref":"#/components/schemas/SpotlightVideoSettings"}},"required":["advertisedProduct"],"type":"object"},"ProductGenreRefinement":{"properties":{"productGenreId":{"description":"The product genre ID to target.","type":"string"},"productGenreIdResolved":{"description":"The resolved product genre to target.","type":"string"}},"required":["productGenreId"],"type":"object"},"ProductIdType":{"description":"| ProductIdType | Description |\n|------|------|\n| `ASIN` | ASIN identifier type. |\n| `SKU` | SKU identifier type. |\n","enum":["ASIN","SKU"],"type":"string"},"ProductMarketplaceSetting":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"productId":{"description":"The product id applicable at the specified marketplace.","type":"string"}},"required":["marketplace","productId"],"type":"object"},"ProductMatchType":{"description":"| ProductMatchType | Description |\n|------|------|\n| `PRODUCT_COMPLEMENTS` | Products that are frequently purchased together with the specified product. |\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |\n| `PRODUCT_REMARKETING` | Products to target users who have previously interacted with the specified product. |\n| `PRODUCT_SIMILAR` | Products similar to the specified product. |\n","enum":["PRODUCT_COMPLEMENTS","PRODUCT_EXACT","PRODUCT_REMARKETING","PRODUCT_SIMILAR"],"type":"string"},"ProductTarget":{"description":"Targets a specific product.","properties":{"matchType":{"$ref":"#/components/schemas/ProductMatchType"},"product":{"$ref":"#/components/schemas/ProductValue"},"productIdType":{"$ref":"#/components/schemas/ProductIdType"}},"required":["matchType","product","productIdType"],"type":"object"},"ProductValue":{"properties":{"marketplaceSettings":{"description":"The product ids at specific marketplace level. Either the product id or the marketplace settings should always be specified","items":{"$ref":"#/components/schemas/ProductMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"productId":{"description":"The product identifier. Either the product id or the marketplace settings should always be specified","type":"string"}},"type":"object"},"ProductVideoSettings":{"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/Image"},"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/VideoLandingPage"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"},"products":{"description":"The products featured in the video ad.","items":{"$ref":"#/components/schemas/AdvertisedProducts"},"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/Video"},"maxItems":2,"minItems":1,"type":"array"},"videos":{"description":"The video assets used in the ad.","items":{"$ref":"#/components/schemas/Video"},"maxItems":2,"minItems":1,"type":"array"}},"required":["untranslatedVideos","videos"],"type":"object"},"PromptExtension":{"description":"Prompts Ad Extension","properties":{"promptText":{"description":"The prompt text rendered in the ads","type":"string"}},"required":["promptText"],"type":"object"},"QueryAdAssociationRequest":{"properties":{"adAssociationIdFilter":{"$ref":"#/components/schemas/AdAssociationAdAssociationIdFilter"},"adGroupIdFilter":{"$ref":"#/components/schemas/AdAssociationAdGroupIdFilter"},"adIdFilter":{"$ref":"#/components/schemas/AdAssociationAdIdFilter"},"maxResults":{"default":100,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"nextToken":{"type":"string"}},"type":"object"},"QueryAdExtensionRequest":{"properties":{"adExtensionIdFilter":{"$ref":"#/components/schemas/AdExtensionAdExtensionIdFilter"},"adExtensionStatusFilter":{"$ref":"#/components/schemas/AdExtensionAdExtensionStatusFilter"},"adExtensionTypeFilter":{"$ref":"#/components/schemas/AdExtensionAdExtensionTypeFilter"},"adGroupIdFilter":{"$ref":"#/components/schemas/AdExtensionAdGroupIdFilter"},"adIdFilter":{"$ref":"#/components/schemas/AdExtensionAdIdFilter"},"adProductFilter":{"$ref":"#/components/schemas/AdExtensionAdProductFilter"},"maxResults":{"default":1000,"format":"int32","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"type":"string"},"stateFilter":{"$ref":"#/components/schemas/AdExtensionStateFilter"}},"type":"object"},"QueryAdGroupRequest":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/AdGroupAdGroupIdFilter"},"adProductFilter":{"$ref":"#/components/schemas/AdGroupAdProductFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/AdGroupCampaignIdFilter"},"marketplaceScopeFilter":{"$ref":"#/components/schemas/AdGroupMarketplaceScopeFilter"},"maxResults":{"format":"int32","maximum":1000,"minimum":1,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/AdGroupNameFilter"},"nextToken":{"type":"string"},"stateFilter":{"$ref":"#/components/schemas/AdGroupStateFilter"}},"required":["adProductFilter"],"type":"object"},"QueryAdRequest":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/AdAdGroupIdFilter"},"adIdFilter":{"$ref":"#/components/schemas/AdAdIdFilter"},"adProductFilter":{"$ref":"#/components/schemas/AdAdProductFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/AdCampaignIdFilter"},"marketplaceScopeFilter":{"$ref":"#/components/schemas/AdMarketplaceScopeFilter"},"maxResults":{"format":"int32","maximum":1000,"minimum":1,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/AdNameFilter"},"nextToken":{"type":"string"},"stateFilter":{"$ref":"#/components/schemas/AdStateFilter"}},"required":["adProductFilter"],"type":"object"},"QueryBrandStoreEditionPublishVersionRequest":{"properties":{"editionIdFilter":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersionBrandStoreEditionIdFilter"},"maxResults":{"default":50,"format":"int32","maximum":50,"minimum":1,"type":"integer"},"nextToken":{"type":"string"},"publishStatusFilter":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersionStorePublishStatusFilter"},"storeIdFilter":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersionBrandStoreIdFilter"}},"required":["editionIdFilter","publishStatusFilter","storeIdFilter"],"type":"object"},"QueryBrandStorePageRequest":{"properties":{"editionIdFilter":{"$ref":"#/components/schemas/BrandStorePageBrandStoreEditionIdFilter"},"maxResults":{"default":50,"format":"int32","maximum":50,"minimum":1,"type":"integer"},"nextToken":{"type":"string"},"pageIdFilter":{"$ref":"#/components/schemas/BrandStorePagePageIdFilter"},"storeEditionPublishIdFilter":{"$ref":"#/components/schemas/BrandStorePageBrandStoreEditionPublishVersionIdFilter"},"storeIdFilter":{"$ref":"#/components/schemas/BrandStorePageBrandStoreIdFilter"}},"required":["editionIdFilter","pageIdFilter","storeIdFilter"],"type":"object"},"QueryBrandStoreRequest":{"properties":{"maxResults":{"default":30,"format":"int32","maximum":30,"minimum":1,"type":"integer"},"nextToken":{"type":"string"},"storeNameFilter":{"$ref":"#/components/schemas/BrandStoreStoreNameFilter"}},"required":["storeNameFilter"],"type":"object"},"QueryCampaignRequest":{"properties":{"adProductFilter":{"$ref":"#/components/schemas/CampaignAdProductFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/CampaignCampaignIdFilter"},"goalFilter":{"$ref":"#/components/schemas/CampaignGoalFilter"},"marketplaceScopeFilter":{"$ref":"#/components/schemas/CampaignMarketplaceScopeFilter"},"maxResults":{"format":"int32","maximum":5000,"minimum":1,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/CampaignNameFilter"},"nextToken":{"type":"string"},"portfolioIdFilter":{"$ref":"#/components/schemas/CampaignPortfolioIdFilter"},"stateFilter":{"$ref":"#/components/schemas/CampaignStateFilter"}},"required":["adProductFilter"],"type":"object"},"QueryTargetRequest":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/TargetAdGroupIdFilter"},"adProductFilter":{"$ref":"#/components/schemas/TargetAdProductFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/TargetCampaignIdFilter"},"inventorySourceIdFilter":{"$ref":"#/components/schemas/TargetMarketplaceStringValueFilter"},"inventorySourceTypeFilter":{"$ref":"#/components/schemas/TargetInventorySourceTypeFilter"},"keywordFilter":{"$ref":"#/components/schemas/TargetKeywordFilter"},"marketplaceScopeFilter":{"$ref":"#/components/schemas/TargetMarketplaceScopeFilter"},"matchTypeFilter":{"$ref":"#/components/schemas/TargetMatchTypeFilter"},"maxResults":{"format":"int32","maximum":5000,"minimum":1,"type":"integer"},"nativeLanguageLocaleFilter":{"$ref":"#/components/schemas/TargetLanguageLocaleFilter"},"negativeFilter":{"$ref":"#/components/schemas/TargetNegativeFilter"},"nextToken":{"type":"string"},"productIdFilter":{"$ref":"#/components/schemas/TargetProductIdFilter"},"stateFilter":{"$ref":"#/components/schemas/TargetStateFilter"},"targetIdFilter":{"$ref":"#/components/schemas/TargetTargetIdFilter"},"targetTypeFilter":{"$ref":"#/components/schemas/TargetTargetTypeFilter"}},"required":["adProductFilter"],"type":"object"},"Recurrence":{"description":"| Recurrence | Description |\n|------|------|\n| `DAILY` |  |\n| `LIFETIME` |  |\n| `MONTHLY` |  |\n","enum":["DAILY","LIFETIME","MONTHLY"],"type":"string"},"ResponsiveEcommerceAdVariations":{"description":"| ResponsiveEcommerceAdVariations | Description |\n|------|------|\n| `ADD_TO_CART` |  |\n| `COUPON` |  |\n| `CUSTOMER_REVIEWS` |  |\n| `SHOP_NOW` |  |\n","enum":["ADD_TO_CART","COUPON","CUSTOMER_REVIEWS","SHOP_NOW"],"type":"string"},"ResponsiveEcommerceCreativePropertiesToOptimize":{"description":"| ResponsiveEcommerceCreativePropertiesToOptimize | Description |\n|------|------|\n| `HEADLINE` | The headline in the creative. |\n","enum":["HEADLINE"],"type":"string"},"ResponsiveEcommerceLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/ResponsiveEcommerceLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"ResponsiveEcommerceLandingPageType":{"description":"| ResponsiveEcommerceLandingPageType | Description |\n|------|------|\n| `MOMENT` | A moment landing page. |\n| `STORE` | A brand Store landing page. |\n","enum":["MOMENT","STORE"],"type":"string"},"ResponsiveEcommerceSettings":{"properties":{"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/ResponsiveEcommerceCreativePropertiesToOptimize"},"maxItems":3,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/Size"},"maxItems":20,"minItems":0,"type":"array"},"disclaimers":{"description":"The disclaimer to use for the Responsive eCommerce experience.","type":"string"},"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 to use for the Responsive eCommerce experience.","type":"string"},"images":{"description":"The image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":3,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/ResponsiveEcommerceLandingPage"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"$ref":"#/components/schemas/Image"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"products":{"description":"The products advertised for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/AdvertisedProducts"},"maxItems":20,"minItems":0,"type":"array"},"recAdVariations":{"description":"The rendering variations selected for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/ResponsiveEcommerceAdVariations"},"maxItems":5,"minItems":0,"type":"array"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"supportedThirdPartySellers":{"$ref":"#/components/schemas/SupportedThirdPartySellers"},"untranslatedHeadlines":{"description":"The headline entered by the advertiser.","type":"string"}},"type":"object"},"ResponsiveSizingBehavior":{"description":"| ResponsiveSizingBehavior | Description |\n|------|------|\n| `DISABLED` |  |\n| `ENABLED` |  |\n","enum":["DISABLED","ENABLED"],"type":"string"},"RetrieveLocationIndexRequest":{"properties":{"indexIds":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"type":"object"},"ReviewStars":{"description":"Review information for a product","properties":{"hasHalfStar":{"description":"Flag indicating if the product has a half star in the rating","type":"boolean"},"reviewCount":{"description":"Number of reviews for the product","format":"int32","type":"integer"},"wholeStars":{"description":"Number of whole stars in the rating","format":"int32","type":"integer"}},"required":["hasHalfStar","reviewCount","wholeStars"],"type":"object"},"RolloverStrategy":{"description":"| RolloverStrategy | Description |\n|------|------|\n| `CUMULATIVE_BUDGET_ROLLOVER` | Rollover cumulative unused budget. |\n| `NO_ROLLOVER` | Do not rollover flight budgets. |\n| `PRIOR_BUDGET_ROLLOVER` | Rollover prior flight unused budget. |\n","enum":["CUMULATIVE_BUDGET_ROLLOVER","NO_ROLLOVER","PRIOR_BUDGET_ROLLOVER"],"type":"string"},"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"},"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"},"SBBrandedKeyword":{"properties":{"brandAlternateId":{"$ref":"#/components/schemas/SBBrandAlternateId"},"keyword":{"description":"Branded keyword","type":"string"}},"required":["brandAlternateId","keyword"],"type":"object"},"SBBrandedKeywordList":{"properties":{"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"}},"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"},"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"},"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"},"SBCreateBrandedKeywordRecommendationTypeDetails":{"properties":{"brandAlternateId":{"items":{"$ref":"#/components/schemas/SBCreateBrandAlternateId"},"maxItems":1,"minItems":1,"type":"array"}},"required":["brandAlternateId"],"type":"object"},"SBCreateBrandedKeywordsPricingRequest":{"properties":{"brandedKeywordsPricings":{"items":{"$ref":"#/components/schemas/SBBrandedKeywordsPricingCreate"},"maxItems":10,"minItems":1,"type":"array"}},"type":"object"},"SBCreateKeywordReservationValidationRequest":{"properties":{"keywordReservationValidations":{"items":{"$ref":"#/components/schemas/SBKeywordReservationValidationCreate"},"maxItems":1000,"minItems":1,"type":"array"}},"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"}]},"SBCurrencyCode":{"description":"| 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"},"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"},"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"},"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"},"SBObjectSettings":{"oneOf":[{"properties":{"brandedKeywordList":{"$ref":"#/components/schemas/SBBrandedKeywordList"}},"required":["brandedKeywordList"],"title":"brandedKeywordList","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"},"SBQueryRecommendationTypeRequest":{"properties":{"maxResults":{"default":50,"format":"int32","maximum":500,"minimum":50,"type":"integer"},"nextToken":{"type":"string"}},"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"}]},"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"},"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"},"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"},"SalesChannel":{"description":"| 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"},"ServiceUnavailableErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"SharedCollectionSettings":{"description":"Settings shared by all collection types.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"$ref":"#/components/schemas/Image"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"}},"required":["brand"],"type":"object"},"ShopperSegment":{"description":"| ShopperSegment | Description |\n|------|------|\n| `NEW_TO_BRAND` |  |\n","enum":["NEW_TO_BRAND"],"type":"string"},"ShopperSegmentBidAdjustment":{"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/ShopperSegment"}},"required":["percentage","shopperSegment"],"type":"object"},"SiteLanguage":{"description":"| SiteLanguage | Description |\n|------|------|\n| `AR` | Arabic. |\n| `BN` | Bengali. |\n| `CS` | Czech. |\n| `DA` | Danish. |\n| `DE` | German. |\n| `EN` | English. |\n| `ES` | Spanish. |\n| `FI` | Finnish. |\n| `FR` | French. |\n| `GU` | Gujarati. |\n| `HI` | Hindi. |\n| `IT` | Italian. |\n| `JA` | Japanese. |\n| `KN` | Kannada. |\n| `ML` | Malayalam. |\n| `MR` | Marathi. |\n| `NL` | Dutch. |\n| `NO` | Norwegian. |\n| `OTHER` | Other language. |\n| `PA` | Punjabi. |\n| `PL` | Polish. |\n| `PT` | Portuguese. |\n| `SV` | Swedish. |\n| `TA` | Tamil. |\n| `TE` | Telugu. |\n| `TR` | Turkish. |\n| `ZH` | Chinese. |\n","enum":["AR","BN","CS","DA","DE","EN","ES","FI","FR","GU","HI","IT","JA","KN","ML","MR","NL","NO","OTHER","PA","PL","PT","SV","TA","TE","TR","ZH"],"type":"string"},"SiteRestriction":{"description":"| SiteRestriction | Description |\n|------|------|\n| `AMAZON_BUSINESS` | Restrict the ad to only show on Amazon Business. |\n| `AMAZON_HAUL` | Restrict the ad to only show on Amazon Haul. |\n","enum":["AMAZON_BUSINESS","AMAZON_HAUL"],"type":"string"},"Size":{"properties":{"height":{"description":"The height of the creative placement.","format":"int32","type":"integer"},"width":{"description":"The width of the creative placement.","format":"int32","type":"integer"}},"required":["height","width"],"type":"object"},"SmartLocation":{"description":"A smart location targets postal codes based on a sales index.","properties":{"locationIndexId":{"description":"The ID of the index used for this smart location.","type":"string"},"maxIndexValuePercentile":{"description":"Maximum percentile value (0-100). Must be greater than minIndexValuePercentile. Null will be treated as 0.","format":"int32","maximum":100,"minimum":0,"type":"integer"},"minIndexValuePercentile":{"description":"Minimum percentile value (0-100). Must be less than maxIndexValuePercentile. Null will be treated as 0.","format":"int32","maximum":100,"minimum":0,"type":"integer"},"name":{"description":"Name for the smart location.","type":"string"}},"required":["locationIndexId","name"],"type":"object"},"SpotlightVideoSettings":{"description":"An ad with a creative built with spotlight videos.","properties":{"optimizeText":{"description":"If the advertiser wants text they provided to be optimized by Amazon or not.","type":"boolean"},"videos":{"description":"The video asset(s) to use for the Sponsored Product experience.","items":{"$ref":"#/components/schemas/Video"},"maxItems":5,"minItems":1,"type":"array"}},"required":["optimizeText","videos"],"type":"object"},"StandardAudioExperienceSettings":{"properties":{"audio":{"$ref":"#/components/schemas/Audio"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded. Urls cannot exceed 2048 characters.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"description":"The product(s) being advertised.","items":{"$ref":"#/components/schemas/AdvertisedProducts"},"maxItems":10,"minItems":0,"type":"array"}},"required":["audio","language"],"type":"object"},"StandardDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/AdChoicesPosition"},"callToAction":{"$ref":"#/components/schemas/DisplayCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The list of placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/Size"},"maxItems":20,"minItems":1,"type":"array"},"customImages":{"description":"The custom images to use for the standard display experience.","items":{"$ref":"#/components/schemas/Image"},"maxItems":20,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"}},"required":["adChoicesPosition","creativeSizes","customImages","language"],"type":"object"},"State":{"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\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"},"Status":{"properties":{"deliveryReasons":{"description":"This is the list of reasons behind the delivery status.","items":{"$ref":"#/components/schemas/DeliveryReason"},"maxItems":50,"minItems":0,"type":"array"},"deliveryStatus":{"$ref":"#/components/schemas/DeliveryStatus"},"marketplaceSettings":{"description":"The list of marketplace level delivery status and reasons of global resources, for all the marketplaces the global resource is applicable in.","items":{"$ref":"#/components/schemas/StatusMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"}},"required":["deliveryStatus"],"type":"object"},"StatusMarketplaceSetting":{"properties":{"deliveryReasons":{"description":"This is the list of reasons behind the delivery status.","items":{"$ref":"#/components/schemas/DeliveryReason"},"maxItems":50,"minItems":0,"type":"array"},"deliveryStatus":{"$ref":"#/components/schemas/DeliveryStatus"},"marketplace":{"$ref":"#/components/schemas/Marketplace"}},"required":["deliveryStatus","marketplace"],"type":"object"},"StoreASINSlide":{"properties":{"productAsin":{"description":"The ASIN of the product.","type":"string"},"tag":{"description":"Unique tag for the slide which will be ASIN.","type":"string"},"type":{"$ref":"#/components/schemas/StoreSlideType"}},"required":["productAsin","tag","type"],"type":"object"},"StoreAWLSTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonTileProperties"},"content":{"$ref":"#/components/schemas/StoreAWLSTileContent"},"externalWidgetId":{"description":"External widget identifier.","type":"string"}},"required":["commonProperties","externalWidgetId"],"type":"object"},"StoreAWLSTileContent":{"oneOf":[{"properties":{"brandedRecipeWidget":{"$ref":"#/components/schemas/BrandedRecipeWidget"}},"required":["brandedRecipeWidget"],"title":"brandedRecipeWidget","type":"object"},{"properties":{"storeProductSelectorWidget":{"$ref":"#/components/schemas/StoreProductSelectorWidget"}},"required":["storeProductSelectorWidget"],"title":"storeProductSelectorWidget","type":"object"},{"properties":{"storeVideoRevealWidget":{"$ref":"#/components/schemas/StoreVideoRevealWidget"}},"required":["storeVideoRevealWidget"],"title":"storeVideoRevealWidget","type":"object"}]},"StoreAWLSWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"tiles":{"description":"The AWLS tile configuration. Exactly one tile is required.","items":{"$ref":"#/components/schemas/StoreAWLSTile"},"maxItems":1,"minItems":1,"type":"array"},"widgetDependencies":{"description":"List of widget dependencies.","items":{"type":"string"},"maxItems":10,"minItems":0,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"StoreBannerContent":{"properties":{"banners":{"$ref":"#/components/schemas/StoreBanners"},"tag":{"description":"Unique tag for the content.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetType"}},"type":"object"},"StoreBannerWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"content":{"$ref":"#/components/schemas/StoreBannerContent"}},"required":["commonProperties","content"],"type":"object"},"StoreBanners":{"properties":{"blackLivesMatter":{"description":"Flag to display Black Lives Matter banner","type":"boolean"},"stopAsianHate":{"description":"Flag to display Stop Asian Hate banner","type":"boolean"}},"required":["blackLivesMatter","stopAsianHate"],"type":"object"},"StoreBleedImageType":{"description":"| StoreBleedImageType | Description |\n| --- | --- |\n| `NONE` | No image bleed |\n| `SIDE` | Side image bleed |\n| `CORNER` | Corner image bleed |\n| `ALL` | All sides image bleed |","enum":["ALL","CORNER","NONE","SIDE"],"type":"string"},"StoreCallToActionData":{"properties":{"customUrl":{"description":"Custom URL for the call to action.","type":"string"},"pageId":{"description":"Page identifier.","type":"string"},"productAsin":{"description":"ASIN for the call to action.","type":"string"},"text":{"description":"Call to action text.","type":"string"}},"type":"object"},"StoreCallToActionProductData":{"properties":{"customUrl":{"description":"Custom URL for the call to action.","type":"string"},"productAsin":{"description":"Product ASIN for the call to action.","type":"string"},"text":{"description":"Call to action text.","type":"string"}},"type":"object"},"StoreCallToActionType":{"description":"| StoreCallToActionType | Description |\n| --- | --- |\n| `LINK` | Link type call to action |\n| `BUTTON` | Button type call to action |","enum":["BUTTON","LINK"],"type":"string"},"StoreCanvasData":{"properties":{"canvasHeight":{"description":"Height in the canvas.","format":"double","type":"number"},"height":{"description":"Height in the canvas.","format":"double","type":"number"},"left":{"description":"Left position in the canvas.","format":"double","type":"number"},"naturalHeight":{"description":"Natural height of the image.","format":"double","type":"number"},"naturalWidth":{"description":"Natural width of the image.","format":"double","type":"number"},"top":{"description":"Top position in the canvas.","format":"double","type":"number"},"width":{"description":"Width in the canvas.","format":"double","type":"number"}},"type":"object"},"StoreCarouselContent":{"properties":{"bulk":{"description":"Whether this is a bulk configuration.","type":"boolean"},"callToActionData":{"$ref":"#/components/schemas/StoreCallToActionData"},"includeOutOfStock":{"description":"Whether to include out of stock items.","type":"boolean"},"keyword":{"description":"Keyword for product filtering.","type":"string"},"productAsins":{"description":"List of ASINs, maximum 500 unique items.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"search":{"$ref":"#/components/schemas/StoreCarouselSearch"},"slides":{"description":"List of ASIN slides.","items":{"$ref":"#/components/schemas/StoreASINSlide"},"maxItems":500,"minItems":0,"type":"array"},"tag":{"description":"Unique tag for the content to track performance.","type":"string"},"text":{"description":"Description text.","type":"string"},"title":{"description":"Title of the carousel.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetSectionType"}},"required":["bulk","callToActionData","includeOutOfStock","keyword","tag","text","title","type"],"type":"object"},"StoreCarouselSearch":{"properties":{"includeOutOfStock":{"description":"Whether to include out of stock items in search.","type":"boolean"},"keyword":{"description":"Search keyword.","type":"string"},"node":{"description":"Node identifier for search.","type":"string"},"productAsins":{"description":"List of ASINs for search filtering.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"}},"required":["includeOutOfStock","keyword","node"],"type":"object"},"StoreColorPalette":{"description":"| StoreColorPalette | Description |\n| --- | --- |\n| `DEFAULT` | Default color scheme |\n| `DEFAULT_INVERTED` | Inverted default color scheme |\n| `SOLID_WHITE` | Solid white color scheme |\n| `SOLID_BLACK` | Solid black color scheme |\n| `TRANSLUCENT_WHITE` | Translucent white color scheme |\n| `TRANSLUCENT_BLACK` | Translucent black color scheme |\n| `TRANSPARENT_BLACK` | Transparent black color scheme |\n| `TRANSPARENT_WHITE` | Transparent white color scheme |","enum":["DEFAULT","DEFAULT_INVERTED","SOLID_BLACK","SOLID_WHITE","TRANSLUCENT_BLACK","TRANSLUCENT_WHITE","TRANSPARENT_BLACK","TRANSPARENT_WHITE"],"type":"string"},"StoreCropBoxData":{"properties":{"height":{"description":"Height of the crop box.","format":"double","type":"number"},"left":{"description":"Left position of the crop box.","format":"double","type":"number"},"top":{"description":"Top position of the crop box.","format":"double","type":"number"},"width":{"description":"Width of the crop box.","format":"double","type":"number"}},"type":"object"},"StoreCroppedImage":{"properties":{"altText":{"description":"Alternative text for the image.","type":"string"},"assetId":{"description":"Asset identifier.","type":"string"},"canvasData":{"$ref":"#/components/schemas/StoreCanvasData"},"cropBox":{"$ref":"#/components/schemas/StoreCropBoxData"},"imageKey":{"description":"Key identifier for the image.","type":"string"},"imageNaturalHeight":{"description":"Natural height of the image.","format":"double","type":"number"},"imageNaturalWidth":{"description":"Natural width of the image.","format":"double","type":"number"},"imageUrl":{"description":"URL of the image.","type":"string"}},"type":"object"},"StoreCustomCodeContent":{"properties":{"autoDimension":{"description":"Whether to use automatic dimensioning.","type":"boolean"},"availableProductAsins":{"description":"List of available ASINs, maximum 500 unique items.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"cti":{"$ref":"#/components/schemas/CTI"},"embedCode":{"description":"Embedded code content.","type":"string"},"integrity":{"description":"Integrity hash for security.","type":"string"},"widgetName":{"description":"Name of the widget.","type":"string"},"widgetTag":{"description":"Widget identifier.","type":"string"}},"type":"object"},"StoreCustomCodeTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonTileProperties"},"content":{"$ref":"#/components/schemas/StoreCustomCodeContent"}},"required":["commonProperties"],"type":"object"},"StoreCustomCodeWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"tiles":{"description":"The custom code tile configuration. Exactly one tile is required.","items":{"$ref":"#/components/schemas/StoreCustomCodeTile"},"maxItems":1,"minItems":1,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"StoreDealsConfig":{"properties":{"node":{"description":"Node identifier for deals.","type":"string"}},"type":"object"},"StoreDealsContent":{"properties":{"deals":{"$ref":"#/components/schemas/StoreDealsConfig"},"dealsMode":{"$ref":"#/components/schemas/StoreDealsMode"},"productAsins":{"description":"List of ASINs, maximum 500 unique items.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"tag":{"description":"Unique tag for the content to track performance.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetSectionType"}},"type":"object"},"StoreDealsMode":{"description":"| StoreDealsMode | Description |\n| --- | --- |\n| `BULK` | Bulk mode |\n| `AUTOMATIC` | Automatic mode |","enum":["AUTOMATIC","BULK"],"type":"string"},"StoreDealsWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"content":{"$ref":"#/components/schemas/StoreDealsContent"}},"required":["commonProperties"],"type":"object"},"StoreEditionSchedule":{"description":"Schedule information for store edition","properties":{"endAt":{"description":"End time for the store edition","format":"date-time","type":"string"},"startAt":{"description":"Start time for the store edition","format":"date-time","type":"string"}},"type":"object"},"StoreEmptyTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonTileProperties"},"content":{"$ref":"#/components/schemas/StoreEmptyTileContent"}},"required":["commonProperties","content"],"type":"object"},"StoreEmptyTileContent":{"properties":{"bondCustomerServiceLink":{"description":"Whether to include a customer service link.","type":"boolean"},"callToAction":{"description":"Call to action text.","type":"string"},"text":{"description":"Text content (must be empty).","type":"string"},"textAlign":{"$ref":"#/components/schemas/StoreTextAlignment"},"title":{"description":"Title of the tile (must be empty).","type":"string"}},"type":"object"},"StoreGalleryContent":{"properties":{"metadata":{"description":"Metadata associated with the gallery.","items":{"$ref":"#/components/schemas/StoreMetadataItem"},"maxItems":15,"minItems":0,"type":"array"},"slides":{"description":"List of slides in the gallery.","items":{"$ref":"#/components/schemas/StoreGallerySlide"},"maxItems":15,"minItems":0,"type":"array"},"tag":{"description":"Unique tag for the content.","type":"string"},"text":{"description":"Text content of the gallery.","type":"string"},"title":{"description":"Title of the gallery.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetType"}},"type":"object"},"StoreGallerySlide":{"properties":{"alt":{"description":"Alternative text for the slide.","type":"string"},"assetId":{"description":"Asset identifier for the slide.","type":"string"},"imageKey":{"description":"Key identifier for the image.","type":"string"},"type":{"$ref":"#/components/schemas/StoreSlideType"}},"type":"object"},"StoreGalleryWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"content":{"$ref":"#/components/schemas/StoreGalleryContent"}},"required":["commonProperties"],"type":"object"},"StoreHeroContent":{"properties":{"assetId":{"description":"Identifier for the asset.","type":"string"},"assetTags":{"description":"Tags associated with the asset.","type":"string"},"canvasData":{"$ref":"#/components/schemas/StoreCanvasData"},"description":{"description":"Description of the hero image.","type":"string"},"imageHeight":{"description":"Height of the hero image.","format":"double","type":"number"},"imageKey":{"description":"Key identifier for the image.","type":"string"},"imageOffsetLeft":{"description":"Left offset of the image.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset of the image.","format":"double","type":"number"},"imageUrl":{"description":"URL of the hero image.","type":"string"},"imageWidth":{"description":"Width of the hero image.","format":"double","type":"number"},"mobileContent":{"$ref":"#/components/schemas/StoreMobileContent"},"tag":{"description":"Unique tag for the content.","type":"string"},"textOverlay":{"description":"Text overlay displayed on the hero image.","type":"string"}},"required":["imageUrl"],"type":"object"},"StoreHeroImageWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"content":{"$ref":"#/components/schemas/StoreHeroContent"}},"required":["commonProperties"],"type":"object"},"StoreImageContent":{"properties":{"altText":{"description":"Alternative text for the image.","type":"string"},"assetId":{"description":"Asset identifier.","type":"string"},"assetTags":{"description":"Tags associated with the asset.","type":"string"},"bleedImage":{"$ref":"#/components/schemas/StoreBleedImageType"},"callToAction":{"description":"Call to action text.","type":"string"},"canvasData":{"$ref":"#/components/schemas/StoreCanvasData"},"cropBoxData":{"$ref":"#/components/schemas/StoreCropBoxData"},"customUrl":{"description":"Custom URL.","type":"string"},"hideTitle":{"description":"Whether to hide the title.","type":"boolean"},"imageHeight":{"description":"Height of the image.","format":"double","type":"number"},"imageKey":{"description":"Key identifier for the image.","type":"string"},"imageOffsetLeft":{"description":"Left offset for image positioning.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset for image positioning.","format":"double","type":"number"},"imageUrl":{"description":"URL of the image.","type":"string"},"imageWidth":{"description":"Width of the image.","format":"double","type":"number"},"isAiGen":{"description":"Whether the image is AI-generated.","type":"boolean"},"layout":{"$ref":"#/components/schemas/StoreImageLayout"},"pageId":{"description":"Page identifier.","type":"string"},"productAsins":{"description":"Single ASIN for the image.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"text":{"description":"Text content.","type":"string"},"textAlign":{"$ref":"#/components/schemas/StoreImageTextAlign"},"tileLayers":{"description":"Layer configuration for the tile.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"title":{"description":"Title of the image.","type":"string"},"verticalAlign":{"$ref":"#/components/schemas/StoreVerticalAlign"}},"type":"object"},"StoreImageLayout":{"description":"| StoreImageLayout | Description |\n| --- | --- |\n| `COVER` | Cover layout |\n| `CONTAIN` | Contain layout |\n| `TEXT` | Text layout |","enum":["CONTAIN","COVER","TEXT"],"type":"string"},"StoreImageShape":{"description":"| StoreImageShape | Description |\n| --- | --- |\n| `SQUARE` | Square shape |","enum":["SQUARE"],"type":"string"},"StoreImageSlide":{"properties":{"assetId":{"description":"Asset identifier.","type":"string"},"assetTags":{"description":"Tags associated with the asset.","type":"string"},"canvasData":{"$ref":"#/components/schemas/StoreCanvasData"},"imageHeight":{"description":"Height of the image.","format":"double","type":"number"},"imageKey":{"description":"Key identifier for the image.","type":"string"},"imageOffsetLeft":{"description":"Left offset for image positioning.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset for image positioning.","format":"double","type":"number"},"imageUrl":{"description":"URL of the image.","type":"string"},"imageWidth":{"description":"Width of the image.","format":"double","type":"number"},"tag":{"description":"Unique identifier for the slide.","type":"string"},"type":{"$ref":"#/components/schemas/StoreSlideType"}},"type":"object"},"StoreImageTextAlign":{"description":"| StoreImageTextAlign | Description |\n| --- | --- |\n| `LEFT` | Left text alignment |\n| `RIGHT` | Right text alignment |","enum":["LEFT","RIGHT"],"type":"string"},"StoreImageTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonTileProperties"},"content":{"$ref":"#/components/schemas/StoreImageContent"},"flexHeight":{"description":"Whether the height is flexible.","type":"boolean"},"mobileContent":{"$ref":"#/components/schemas/StoreMobileImageContent"},"uploadMobileImage":{"description":"Whether to upload a mobile-specific image.","type":"boolean"}},"required":["commonProperties"],"type":"object"},"StoreImageWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"tiles":{"description":"The image tile configuration. Exactly one tile is required.","items":{"$ref":"#/components/schemas/StoreImageTile"},"maxItems":1,"minItems":1,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"StoreImageWithTextContent":{"properties":{"altText":{"description":"Alternative text for the image.","type":"string"},"assetId":{"description":"Asset identifier.","type":"string"},"assetTags":{"description":"Tags associated with the asset.","type":"string"},"bleedImage":{"$ref":"#/components/schemas/StoreBleedImageType"},"callToAction":{"description":"Call to action text.","type":"string"},"canvasData":{"$ref":"#/components/schemas/StoreCanvasData"},"cropBoxData":{"$ref":"#/components/schemas/StoreCropBoxData"},"customUrl":{"description":"Custom URL.","type":"string"},"hideTitle":{"description":"Whether to hide the title.","type":"boolean"},"imageHeight":{"description":"Height of the image.","format":"double","type":"number"},"imageKey":{"description":"Key identifier for the image.","type":"string"},"imageOffsetLeft":{"description":"Left offset for image positioning.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset for image positioning.","format":"double","type":"number"},"imageUrl":{"description":"URL of the image.","type":"string"},"imageWidth":{"description":"Width of the image.","format":"double","type":"number"},"isAiGen":{"description":"Whether the image is AI-generated.","type":"boolean"},"layout":{"$ref":"#/components/schemas/StoreImageLayout"},"pageId":{"description":"Page identifier.","type":"string"},"productAsins":{"description":"Single ASIN for the image.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"renderTileLayers":{"description":"Whether to render tile layers.","type":"boolean"},"shape":{"$ref":"#/components/schemas/StoreImageShape"},"text":{"description":"Text content.","type":"string"},"textAlign":{"$ref":"#/components/schemas/StoreTextAlignment"},"textOption":{"$ref":"#/components/schemas/StoreTextOption"},"tileLayers":{"description":"Layer configuration for the tile.","items":{"$ref":"#/components/schemas/StoreTileLayer"},"maxItems":1,"minItems":0,"type":"array"},"title":{"description":"Title of the image.","type":"string"},"verticalAlign":{"$ref":"#/components/schemas/StoreVerticalAlign"}},"type":"object"},"StoreImageWithTextTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonTileProperties"},"content":{"$ref":"#/components/schemas/StoreImageWithTextContent"},"flexHeight":{"description":"Whether the height is flexible.","type":"boolean"},"mobileContent":{"$ref":"#/components/schemas/StoreMobileImageWithTextContent"},"uploadMobileImage":{"description":"Whether to upload a mobile-specific image.","type":"boolean"},"variation":{"$ref":"#/components/schemas/StoreImageWithTextTileVariation"}},"required":["commonProperties","variation"],"type":"object"},"StoreImageWithTextTileVariation":{"description":"| StoreImageWithTextTileVariation | Description |\n| --- | --- |\n| `IMAGE_WITH_TEXT` | Image with text variation |","enum":["IMAGE_WITH_TEXT"],"type":"string"},"StoreImageWithTextWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"tiles":{"description":"The image with text tile configuration. Exactly one tile is required.","items":{"$ref":"#/components/schemas/StoreImageWithTextTile"},"maxItems":1,"minItems":1,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"StoreLayoutType":{"description":"| StoreLayoutType | Description |\n| --- | --- |\n| `DEFAULT` | Default layout configuration |\n| `SHOWCASE` | Showcase layout configuration for featured display |","enum":["DEFAULT","SHOWCASE"],"type":"string"},"StoreLiveVideoContent":{"properties":{"channel":{"description":"Channel of the video.","type":"string"},"tag":{"description":"Unique tag for the content.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetType"}},"required":["tag","type"],"type":"object"},"StoreLiveVideoWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"content":{"$ref":"#/components/schemas/StoreLiveVideoContent"}},"required":["commonProperties","content"],"type":"object"},"StoreManuallyCuratedProductCarouselWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"content":{"$ref":"#/components/schemas/StoreCarouselContent"}},"required":["commonProperties"],"type":"object"},"StoreMetadataItem":{"properties":{"alt":{"description":"Alternative text.","type":"string"},"assetId":{"description":"Asset identifier.","type":"string"},"filename":{"description":"Name of the file.","type":"string"},"imageKey":{"description":"Key identifier for the image.","type":"string"},"imageUrl":{"description":"The imageUrl of the item.","type":"string"},"type":{"$ref":"#/components/schemas/StoreTileType"},"url":{"description":"URL of the item.","type":"string"}},"type":"object"},"StoreMobileContent":{"properties":{"assetId":{"description":"Asset identifier for mobile view.","type":"string"},"assetTags":{"description":"Asset tags for mobile view.","type":"string"},"canvasData":{"$ref":"#/components/schemas/StoreCanvasData"},"imageHeight":{"description":"Height of the image for mobile view.","format":"double","type":"number"},"imageKey":{"description":"Image key for mobile view.","type":"string"},"imageOffsetLeft":{"description":"Left offset of the image for mobile view.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset of the image for mobile view.","format":"double","type":"number"},"imageUrl":{"description":"URL of the image for mobile view.","type":"string"},"imageWidth":{"description":"Width of the image for mobile view.","format":"double","type":"number"},"version":{"description":"Version identifier for mobile content","type":"string"}},"type":"object"},"StoreMobileImageContent":{"properties":{"altText":{"description":"Alternative text for the mobile image.","type":"string"},"assetId":{"description":"Asset identifier for mobile.","type":"string"},"assetTags":{"description":"Tags associated with the mobile asset.","type":"string"},"bleedImage":{"$ref":"#/components/schemas/StoreBleedImageType"},"canvasData":{"$ref":"#/components/schemas/StoreCanvasData"},"cropBoxData":{"$ref":"#/components/schemas/StoreCropBoxData"},"hideTitle":{"description":"Whether to hide the title on mobile.","type":"boolean"},"imageHeight":{"description":"Height of the mobile image.","format":"double","type":"number"},"imageKey":{"description":"Key identifier for the mobile image.","type":"string"},"imageOffsetLeft":{"description":"Left offset for mobile image positioning.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset for mobile image positioning.","format":"double","type":"number"},"imageUrl":{"description":"URL of the mobile image.","type":"string"},"imageWidth":{"description":"Width of the mobile image.","format":"double","type":"number"},"isAiGen":{"description":"Whether the mobile image is AI-generated.","type":"boolean"},"layout":{"$ref":"#/components/schemas/StoreImageLayout"},"tileLayers":{"description":"Layer configuration for the mobile tile.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"title":{"description":"Title for mobile display.","type":"string"},"verticalAlign":{"$ref":"#/components/schemas/StoreVerticalAlign"}},"type":"object"},"StoreMobileImageWithTextContent":{"properties":{"altText":{"description":"Alternative text for the mobile image.","type":"string"},"assetId":{"description":"Asset identifier for mobile.","type":"string"},"assetTags":{"description":"Tags associated with the mobile asset.","type":"string"},"bleedImage":{"$ref":"#/components/schemas/StoreBleedImageType"},"canvasData":{"$ref":"#/components/schemas/StoreCanvasData"},"cropBoxData":{"$ref":"#/components/schemas/StoreCropBoxData"},"hideTitle":{"description":"Whether to hide the title on mobile.","type":"boolean"},"imageHeight":{"description":"Height of the mobile image.","format":"double","type":"number"},"imageKey":{"description":"Key identifier for the mobile image.","type":"string"},"imageOffsetLeft":{"description":"Left offset for mobile image positioning.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset for mobile image positioning.","format":"double","type":"number"},"imageUrl":{"description":"URL of the mobile image.","type":"string"},"imageWidth":{"description":"Width of the mobile image.","format":"double","type":"number"},"isAiGen":{"description":"Whether the mobile image is AI-generated.","type":"boolean"},"layout":{"$ref":"#/components/schemas/StoreImageLayout"},"renderTileLayers":{"description":"Whether to render tile layers on mobile.","type":"boolean"},"shape":{"$ref":"#/components/schemas/StoreImageShape"},"text":{"description":"Text content for mobile.","type":"string"},"textAlign":{"$ref":"#/components/schemas/StoreTextAlignment"},"textOption":{"$ref":"#/components/schemas/StoreTextOption"},"tileLayers":{"description":"Layer configuration for the mobile tile.","items":{"$ref":"#/components/schemas/StoreTileLayer"},"maxItems":1,"minItems":0,"type":"array"},"title":{"description":"Title for mobile display.","type":"string"},"verticalAlign":{"$ref":"#/components/schemas/StoreVerticalAlign"}},"type":"object"},"StorePageContent":{"description":"Structure containing the content elements of a store page","properties":{"description":{"description":"Description of the page","type":"string"},"template":{"$ref":"#/components/schemas/StorePageTemplate"},"title":{"description":"For store page, title of the page; for SB landing page, this can be optional","type":"string"},"widgets":{"description":"Collection of widgets displayed on the page","items":{"$ref":"#/components/schemas/StorePageWidget"},"maxItems":20,"minItems":0,"type":"array"}},"required":["template"],"type":"object"},"StorePageTemplate":{"description":"| StorePageTemplate | Description |\n| --- | --- |\n| `PRODUCT_GRID` | Template displaying products in a grid layout |\n| `HIGHLIGHT` | Template for highlighting specific content |\n| `MARQUEE` | Template featuring a prominent marquee section |\n| `BLANK` | Empty template for custom layouts |\n| `PRODUCT_COLLECTION` | Template for displaying collections of products |","enum":["BLANK","HIGHLIGHT","MARQUEE","PRODUCT_COLLECTION","PRODUCT_GRID"],"type":"string"},"StorePageType":{"description":"| StorePageType | Description |\n| --- | --- |\n| `BRAND_STORE_PAGE` | Standard brand store page that allows customization to show case the brand and product |\n| `LANDING_PAGE` | Landing page for specific ads program with predefined template |","enum":["BRAND_STORE_PAGE","LANDING_PAGE"],"type":"string"},"StorePageVersion":{"description":"Version information for a store page","properties":{"pageId":{"description":"Identifier of the page","type":"string"},"version":{"description":"Version number of the page","format":"int32","type":"integer"}},"required":["pageId","version"],"type":"object"},"StorePageWidget":{"description":"Union of all possible widget types that can be used on a store page","oneOf":[{"properties":{"storeHeroImageWidget":{"$ref":"#/components/schemas/StoreHeroImageWidget"}},"required":["storeHeroImageWidget"],"title":"storeHeroImageWidget","type":"object"},{"properties":{"storeTileWidget":{"$ref":"#/components/schemas/StoreTileWidget"}},"required":["storeTileWidget"],"title":"storeTileWidget","type":"object"},{"properties":{"storeImageWidget":{"$ref":"#/components/schemas/StoreImageWidget"}},"required":["storeImageWidget"],"title":"storeImageWidget","type":"object"},{"properties":{"storeTextWidget":{"$ref":"#/components/schemas/StoreTextWidget"}},"required":["storeTextWidget"],"title":"storeTextWidget","type":"object"},{"properties":{"storeImageWithTextWidget":{"$ref":"#/components/schemas/StoreImageWithTextWidget"}},"required":["storeImageWithTextWidget"],"title":"storeImageWithTextWidget","type":"object"},{"properties":{"storeProductCollectionWidget":{"$ref":"#/components/schemas/StoreProductCollectionWidget"}},"required":["storeProductCollectionWidget"],"title":"storeProductCollectionWidget","type":"object"},{"properties":{"storeProductGridWidget":{"$ref":"#/components/schemas/StoreProductGridWidget"}},"required":["storeProductGridWidget"],"title":"storeProductGridWidget","type":"object"},{"properties":{"storeDealsWidget":{"$ref":"#/components/schemas/StoreDealsWidget"}},"required":["storeDealsWidget"],"title":"storeDealsWidget","type":"object"},{"properties":{"storeProductWidget":{"$ref":"#/components/schemas/StoreProductWidget"}},"required":["storeProductWidget"],"title":"storeProductWidget","type":"object"},{"properties":{"storeShoppableImageWidget":{"$ref":"#/components/schemas/StoreShoppableImageWidget"}},"required":["storeShoppableImageWidget"],"title":"storeShoppableImageWidget","type":"object"},{"properties":{"storeCustomCodeWidget":{"$ref":"#/components/schemas/StoreCustomCodeWidget"}},"required":["storeCustomCodeWidget"],"title":"storeCustomCodeWidget","type":"object"},{"properties":{"storeVideoWidget":{"$ref":"#/components/schemas/StoreVideoWidget"}},"required":["storeVideoWidget"],"title":"storeVideoWidget","type":"object"},{"properties":{"storeGalleryWidget":{"$ref":"#/components/schemas/StoreGalleryWidget"}},"required":["storeGalleryWidget"],"title":"storeGalleryWidget","type":"object"},{"properties":{"storeShopTheLookWidget":{"$ref":"#/components/schemas/StoreShopTheLookWidget"}},"required":["storeShopTheLookWidget"],"title":"storeShopTheLookWidget","type":"object"},{"properties":{"storeManuallyCuratedProductCarouselWidget":{"$ref":"#/components/schemas/StoreManuallyCuratedProductCarouselWidget"}},"required":["storeManuallyCuratedProductCarouselWidget"],"title":"storeManuallyCuratedProductCarouselWidget","type":"object"},{"properties":{"storeAWLSWidget":{"$ref":"#/components/schemas/StoreAWLSWidget"}},"required":["storeAWLSWidget"],"title":"storeAWLSWidget","type":"object"},{"properties":{"storeBannerWidget":{"$ref":"#/components/schemas/StoreBannerWidget"}},"required":["storeBannerWidget"],"title":"storeBannerWidget","type":"object"},{"properties":{"storeProductCarouselWidget":{"$ref":"#/components/schemas/StoreProductCarouselWidget"}},"required":["storeProductCarouselWidget"],"title":"storeProductCarouselWidget","type":"object"},{"properties":{"storeLiveVideoWidget":{"$ref":"#/components/schemas/StoreLiveVideoWidget"}},"required":["storeLiveVideoWidget"],"title":"storeLiveVideoWidget","type":"object"}]},"StoreProductCarouselContent":{"properties":{"callToActionData":{"$ref":"#/components/schemas/StoreCallToActionProductData"},"searchContent":{"$ref":"#/components/schemas/StoreProductCarouselSearch"},"tag":{"description":"Unique tag for the content.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetSectionType"}},"required":["tag","type"],"type":"object"},"StoreProductCarouselSearch":{"properties":{"node":{"description":"Node identifier for search","type":"string"},"type":{"$ref":"#/components/schemas/StoreProductCarouselSearchType"}},"type":"object"},"StoreProductCarouselSearchType":{"description":"| StoreProductCarouselSearchType | Description |\n| --- | --- |\n| `RECOMMENDATION_FOR_YOU` | Personalized recommendations |\n| `BEST_SELLING` | Best selling items |","enum":["BEST_SELLING","RECOMMENDATION_FOR_YOU"],"type":"string"},"StoreProductCarouselWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"content":{"$ref":"#/components/schemas/StoreProductCarouselContent"}},"required":["commonProperties","content"],"type":"object"},"StoreProductCollectionASINGrid":{"properties":{"bulk":{"description":"Whether this is a bulk configuration.","type":"boolean"},"description":{"description":"Description of the product grid.","type":"string"},"displayProductGridHeader":{"description":"Whether to display the product grid header.","type":"boolean"},"includeOutOfStock":{"description":"Whether to include out of stock products.","type":"boolean"},"isAutomatedProductGrid":{"description":"Whether the product grid is automatically populated","type":"boolean"},"keyword":{"description":"Keyword for product filtering.","type":"string"},"productAsins":{"description":"List of ASINs, maximum 60 unique items.","items":{"type":"string"},"maxItems":60,"minItems":0,"type":"array"},"sort":{"description":"Sort order for products.","type":"string"},"tag":{"description":"Unique tag for the tile to track performance.","type":"string"},"title":{"description":"Title of the product grid.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetSectionType"},"variation":{"description":"Variation of the product grid.","type":"string"}},"required":["type"],"type":"object"},"StoreProductCollectionContent":{"properties":{"collectionTags":{"description":"Tags associated with the collection.","type":"string"},"productGridConversionTimestamp":{"description":"Timestamp of product grid conversion.","format":"double","type":"number"},"tag":{"description":"Unique tag for the content.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetType"}},"type":"object"},"StoreProductCollectionImageTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonTileProperties"},"content":{"$ref":"#/components/schemas/StoreImageWithTextContent"},"flexHeight":{"description":"Whether the height is flexible.","type":"boolean"},"mobileContent":{"$ref":"#/components/schemas/StoreMobileImageWithTextContent"},"uploadMobileImage":{"description":"Whether to upload a mobile-specific image.","type":"boolean"},"variation":{"$ref":"#/components/schemas/StoreImageWithTextTileVariation"}},"required":["commonProperties","variation"],"type":"object"},"StoreProductCollectionTile":{"oneOf":[{"properties":{"storeProductCollectionImageTile":{"$ref":"#/components/schemas/StoreProductCollectionImageTile"}},"required":["storeProductCollectionImageTile"],"title":"storeProductCollectionImageTile","type":"object"},{"properties":{"storeProductCollectionASINGrid":{"$ref":"#/components/schemas/StoreProductCollectionASINGrid"}},"required":["storeProductCollectionASINGrid"],"title":"storeProductCollectionASINGrid","type":"object"}]},"StoreProductCollectionWidget":{"properties":{"aiMetadata":{"description":"Metadata about AI generated fields.","items":{"$ref":"#/components/schemas/Tag"},"maxItems":1000,"minItems":0,"type":"array"},"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"content":{"$ref":"#/components/schemas/StoreProductCollectionContent"},"tiles":{"description":"The tiles for the product collection. Exactly two tiles are required.","items":{"$ref":"#/components/schemas/StoreProductCollectionTile"},"maxItems":2,"minItems":2,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"StoreProductGridContent":{"properties":{"bulk":{"description":"Whether this is a bulk product grid.","type":"boolean"},"description":{"description":"Description of the product grid.","type":"string"},"displayProductGridHeader":{"description":"Whether to display the grid header.","type":"boolean"},"excludedProductAsins":{"description":"List of product ASINs exclude when dynamic.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"includeOutOfStock":{"description":"Whether to include out of stock products.","type":"boolean"},"isAutomatedProductGrid":{"description":"Whether the product grid is automatically populated","type":"boolean"},"keyword":{"description":"Keyword for product filtering.","type":"string"},"pinnedProductAsins":{"description":"List of product ASINs include when dynamic.","items":{"type":"string"},"maxItems":25,"minItems":0,"type":"array"},"productAsins":{"description":"List of product ASINs.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"productType":{"description":"Type of products to display","type":"string"},"search":{"$ref":"#/components/schemas/StoreProductGridSearch"},"showOnlyMarkdown":{"description":"Whether to only show products on markdown.","type":"boolean"},"sort":{"description":"Sort order for products.","type":"string"},"tag":{"description":"Unique tag for the content.","type":"string"},"title":{"description":"Title of the product grid.","type":"string"},"type":{"description":"Type of the content.","type":"string"}},"type":"object"},"StoreProductGridSearch":{"properties":{"brandId":{"description":"brand id to search.","type":"string"},"includeOutOfStock":{"description":"Whether to include out of stock products in search.","type":"boolean"},"keyword":{"description":"Search keyword.","type":"string"},"node":{"description":"Node identifier for search.","type":"string"},"productAsins":{"description":"List of product ASINs.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"sort":{"description":"Sort order for search results.","type":"string"}},"type":"object"},"StoreProductGridWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"content":{"$ref":"#/components/schemas/StoreProductGridContent"}},"required":["commonProperties","content"],"type":"object"},"StoreProductSelectorAnswer":{"description":"Represents a possible answer in the product selector questionnaire","properties":{"image":{"$ref":"#/components/schemas/StoreProductSelectorImage"},"nextStep":{"description":"Reference to the next question or step in the selection flow","type":"string"},"productAsins":{"description":"List of ASINs associated with this answer","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"tag":{"description":"Unique identifier for the answer","type":"string"},"text":{"description":"Display text for the answer option","type":"string"}},"required":["nextStep","tag"],"type":"object"},"StoreProductSelectorButtonColor":{"description":"| StoreProductSelectorButtonColor | Description |\n| --- | --- |\n| `WHITE` | White button color |\n| `BLACK` | Black button color |\n| `TRANSPARENT` | Transparent button color |","enum":["BLACK","TRANSPARENT","WHITE"],"type":"string"},"StoreProductSelectorDesignOptions":{"description":"Visual styling options for the product selector widget","properties":{"backgroundColor":{"description":"Background color in hex or named color value","type":"string"},"backgroundShape":{"description":"Shape of the background container","type":"string"},"buttonColor":{"$ref":"#/components/schemas/StoreProductSelectorButtonColor"},"buttonShape":{"description":"Shape style for buttons in the selector","type":"string"},"textAlignment":{"description":"Alignment of text elements (left, center, right)","type":"string"},"textSize":{"description":"Size of the text elements","type":"string"},"textStyle":{"description":"Font family or style to be used","type":"string"},"textWeight":{"description":"Font weight for text elements","type":"string"}},"required":["backgroundColor","backgroundShape","buttonShape","textAlignment","textSize","textStyle","textWeight"],"type":"object"},"StoreProductSelectorImage":{"description":"Represents an image used in the product selector introduction","properties":{"assetId":{"description":"Asset ID of the image","type":"string"},"fileName":{"description":"File name of the image","type":"string"},"imageUrl":{"description":"URL of the image","type":"string"},"layout":{"$ref":"#/components/schemas/StoreProductSelectorImageLayout"}},"required":["assetId","imageUrl"],"type":"object"},"StoreProductSelectorImageLayout":{"description":"| StoreProductSelectorImageLayout | Description |\n| --- | --- |\n| `TOP` | Top image layout |\n| `LEFT` | Left image layout |\n| `RIGHT` | Right image layout |\n| `BOTTOM` | Bottom image layout |","enum":["BOTTOM","LEFT","RIGHT","TOP"],"type":"string"},"StoreProductSelectorImageOptions":{"description":"Image options for the product selector introduction","properties":{"image":{"$ref":"#/components/schemas/StoreProductSelectorImage"},"layoutConfiguration":{"$ref":"#/components/schemas/StoreProductSelectorLayoutConfiguration"}},"required":["image","layoutConfiguration"],"type":"object"},"StoreProductSelectorIntroduction":{"description":"Introduction section for the product selector widget","properties":{"buttonText":{"description":"Text displayed on the introduction button","type":"string"},"description":{"description":"Description text for the introduction section","type":"string"},"heading":{"description":"Heading text for the introduction section","type":"string"},"headline":{"description":"Headline text for the introduction section","type":"string"},"imageOptions":{"$ref":"#/components/schemas/StoreProductSelectorImageOptions"},"isEnabled":{"description":"Flag indicating whether the introduction is enabled","type":"boolean"}},"required":["buttonText","description","heading","imageOptions","isEnabled"],"type":"object"},"StoreProductSelectorLayoutConfiguration":{"description":"Layout configuration for desktop and mobile views","properties":{"desktopLayout":{"$ref":"#/components/schemas/StoreProductSelectorImageLayout"},"mobileLayout":{"$ref":"#/components/schemas/StoreProductSelectorImageLayout"}},"required":["desktopLayout","mobileLayout"],"type":"object"},"StoreProductSelectorQuestion":{"description":"Represents a question in the product selector questionnaire","properties":{"answerList":{"description":"List of possible answers for this question","items":{"$ref":"#/components/schemas/StoreProductSelectorAnswer"},"maxItems":500,"minItems":0,"type":"array"},"areImagesEnabled":{"description":"Flag indicating whether images are enabled","type":"boolean"},"description":{"description":"Additional descriptive text or context for the question","type":"string"},"hasImage":{"description":"Flag indicating whether the question has an image","type":"boolean"},"tag":{"description":"Unique identifier for the question","type":"string"},"text":{"description":"Main question text displayed to the user","type":"string"}},"required":["tag"],"type":"object"},"StoreProductSelectorResults":{"description":"Configuration for displaying product selector results","properties":{"buttonText":{"description":"Text to display on the call-to-action button","type":"string"},"description":{"description":"Descriptive text explaining the results","type":"string"},"disclaimer":{"description":"Legal or additional information text for the results","type":"string"},"headline":{"description":"Main heading text for the results section","type":"string"},"storeUrl":{"description":"URL to the store page for the selected products","type":"string"}},"required":["disclaimer","headline"],"type":"object"},"StoreProductSelectorWidget":{"description":"Main widget structure for the product selector feature","properties":{"designOptions":{"$ref":"#/components/schemas/StoreProductSelectorDesignOptions"},"introduction":{"$ref":"#/components/schemas/StoreProductSelectorIntroduction"},"productAsins":{"description":"Master list of ASINs available in the selector","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"questionList":{"description":"Ordered list of questions in the selector flow","items":{"$ref":"#/components/schemas/StoreProductSelectorQuestion"},"maxItems":500,"minItems":0,"type":"array"},"results":{"$ref":"#/components/schemas/StoreProductSelectorResults"}},"required":["designOptions","results"],"type":"object"},"StoreProductTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonTileProperties"},"content":{"$ref":"#/components/schemas/StoreProductTileContent"}},"required":["commonProperties"],"type":"object"},"StoreProductTileContent":{"properties":{"bleedImage":{"$ref":"#/components/schemas/StoreBleedImageType"},"displayOutOfStockASIN":{"description":"Whether to display out of stock ASIN.","type":"boolean"},"layout":{"$ref":"#/components/schemas/StoreLayoutType"},"productAsins":{"description":"Single ASIN for the product.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"text":{"description":"Description text for the product.","type":"string"},"textAlign":{"$ref":"#/components/schemas/StoreTextAlignment"},"title":{"description":"Title of the product.","type":"string"}},"type":"object"},"StoreProductWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"tiles":{"description":"The product tile configuration. Exactly one tile is required.","items":{"$ref":"#/components/schemas/StoreProductTile"},"maxItems":1,"minItems":1,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"StorePublishState":{"description":"User State for content\n\n| StorePublishState | Description |\n|------|------|\n| `DRAFT` | Content is in draft form |\n| `PUBLISH` | Submit Content to Publish to LIVE / SCHEDULED |\n","enum":["DRAFT","PUBLISH"],"type":"string"},"StorePublishStatus":{"description":"Status of content publish\n\n| StorePublishStatus | Description |\n|------|------|\n| `DRAFT` | Content is in draft state |\n| `REVIEW_IN_PROGRESS` | Content is pending publication for review |\n","enum":["DRAFT","REVIEW_IN_PROGRESS"],"type":"string"},"StoreShopTheLookContent":{"properties":{"bulk":{"description":"Whether this is a bulk configuration.","type":"boolean"},"callToActionData":{"$ref":"#/components/schemas/StoreCallToActionData"},"includeOutOfStock":{"description":"Whether to include out of stock items.","type":"boolean"},"keyword":{"description":"Keyword for searching.","type":"string"},"productAsins":{"description":"List of product ASINs, maximum 25 unique items.","items":{"type":"string"},"maxItems":25,"minItems":0,"type":"array"},"search":{"$ref":"#/components/schemas/StoreShopTheLookSearch"},"slides":{"description":"List of slides in the carousel.","items":{"$ref":"#/components/schemas/StoreShopTheLookSlide"},"maxItems":500,"minItems":0,"type":"array"},"tag":{"description":"Unique tag for the content.","type":"string"},"text":{"description":"Text content.","type":"string"},"title":{"description":"Title of the content.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetSectionType"}},"type":"object"},"StoreShopTheLookSearch":{"properties":{"includeOutOfStock":{"description":"Whether to include out of stock items in search.","type":"boolean"},"keyword":{"description":"Search keyword.","type":"string"},"node":{"description":"Node identifier for search.","type":"string"},"productAsins":{"description":"Single ASIN for search filtering.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"StoreShopTheLookSlide":{"oneOf":[{"properties":{"storeImageSlide":{"$ref":"#/components/schemas/StoreImageSlide"}},"required":["storeImageSlide"],"title":"storeImageSlide","type":"object"},{"properties":{"storeASINSlide":{"$ref":"#/components/schemas/StoreASINSlide"}},"required":["storeASINSlide"],"title":"storeASINSlide","type":"object"}]},"StoreShopTheLookWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"content":{"$ref":"#/components/schemas/StoreShopTheLookContent"}},"required":["commonProperties"],"type":"object"},"StoreShoppableImageContent":{"properties":{"croppedImage":{"$ref":"#/components/schemas/StoreCroppedImage"},"points":{"description":"Interactive points on the image.","items":{"$ref":"#/components/schemas/StoreShoppablePoint"},"maxItems":6,"minItems":0,"type":"array"},"productAsins":{"description":"Single ASIN for the point.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"renderTileLayers":{"description":"Whether to render tile layers.","type":"boolean"},"textOption":{"$ref":"#/components/schemas/StoreShoppableTextOption"},"tileLayers":{"description":"Layer configuration for the tile.","items":{"$ref":"#/components/schemas/StoreTileLayer"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"StoreShoppableImageTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonTileProperties"},"content":{"$ref":"#/components/schemas/StoreShoppableImageContent"}},"required":["commonProperties"],"type":"object"},"StoreShoppableImageWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"tiles":{"description":"The shoppable image tile configuration. Exactly one tile is required.","items":{"$ref":"#/components/schemas/StoreShoppableImageTile"},"maxItems":1,"minItems":1,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"StoreShoppablePoint":{"properties":{"coordinates":{"$ref":"#/components/schemas/Coordinates"},"productAsins":{"description":"Single ASIN for the point.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"tag":{"description":"Unique tag for the point.","type":"string"},"type":{"$ref":"#/components/schemas/StoreTileType"}},"required":["coordinates"],"type":"object"},"StoreShoppableTextOption":{"description":"| StoreShoppableTextOption | Description |\n| --- | --- |\n| `TEXT_UNDER_INTERACTIVE_IMAGE` | Text under interactive image |\n| `NO_TEXT_UNDER_INTERACTIVE_IMAGE` | No text under interactive image |\n| `TEXT_OVER_IMAGE` | Text over interactive image |","enum":["NO_TEXT_UNDER_INTERACTIVE_IMAGE","TEXT_OVER_IMAGE","TEXT_UNDER_INTERACTIVE_IMAGE"],"type":"string"},"StoreSlideType":{"description":"| StoreSlideType | Description |\n| --- | --- |\n| `IMAGE` | Slide type for StoreGallerySlide, StoreImageSlide |\n| `ASIN` | Slide type for StoreASINSlide |","enum":["ASIN","IMAGE"],"type":"string"},"StoreSpotlightCreativePropertiesToOptimize":{"description":"| StoreSpotlightCreativePropertiesToOptimize | Description |\n|------|------|\n| `HEADLINE` | The headline in the creative. |\n","enum":["HEADLINE"],"type":"string"},"StoreSpotlightLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/StoreSpotlightLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"StoreSpotlightLandingPageType":{"description":"| StoreSpotlightLandingPageType | Description |\n|------|------|\n| `STORE` | A brand Store landing page. |\n","enum":["STORE"],"type":"string"},"StoreSpotlightSettings":{"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/Image"},"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/CardCreativeElement"},"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/StoreSpotlightCreativePropertiesToOptimize"},"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/StoreSpotlightLandingPage"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"},"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"},"StoreTextAlignment":{"description":"| StoreTextAlignment | Description |\n| --- | --- |\n| `LEFT` | Left alignment. Default value configured for StoreEmptyTile |\n| `CENTER` | Center alignment |\n| `RIGHT` | Right alignment |\n| `JUSTIFY` | Justified alignment |","enum":["CENTER","JUSTIFY","LEFT","RIGHT"],"type":"string"},"StoreTextContent":{"properties":{"bold":{"description":"Whether text should be bold.","type":"boolean"},"bondCustomerServiceLink":{"description":"Whether to include customer service link.","type":"boolean"},"callToAction":{"description":"Call to action text.","type":"string"},"customUrl":{"description":"Custom URL for the content.","type":"string"},"pageId":{"description":"Identifier for the page.","type":"string"},"productAsins":{"description":"Single product ASIN for the content.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"text":{"description":"Main text content.","type":"string"},"textAlign":{"$ref":"#/components/schemas/StoreTextAlignment"},"title":{"description":"Title of the content.","type":"string"},"uppercase":{"description":"Whether text should be uppercase.","type":"boolean"}},"required":["bold","text","title","uppercase"],"type":"object"},"StoreTextOption":{"description":"| StoreTextOption | Description |\n| --- | --- |\n| `TEXT_OVER_IMAGE` | Text overlaid on image |\n| `TEXT_NEXT_TO_IMAGE` | Text next to image |","enum":["TEXT_NEXT_TO_IMAGE","TEXT_OVER_IMAGE"],"type":"string"},"StoreTextOptionType":{"description":"| StoreTextOptionType | Description |\n| --- | --- |\n| `NO_TEXT_OVER_VIDEO` | No text overlay on video |\n| `TEXT_OVER_VIDEO` | Text overlay on video |","enum":["NO_TEXT_OVER_VIDEO","TEXT_OVER_VIDEO"],"type":"string"},"StoreTextTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonTileProperties"},"content":{"$ref":"#/components/schemas/StoreTextContent"}},"required":["commonProperties"],"type":"object"},"StoreTextWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"tiles":{"description":"Single text tile configuration.","items":{"$ref":"#/components/schemas/StoreTextTile"},"maxItems":1,"minItems":1,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"StoreTile":{"oneOf":[{"properties":{"storeImageWithTextTile":{"$ref":"#/components/schemas/StoreImageWithTextTile"}},"required":["storeImageWithTextTile"],"title":"storeImageWithTextTile","type":"object"},{"properties":{"storeImageTile":{"$ref":"#/components/schemas/StoreImageTile"}},"required":["storeImageTile"],"title":"storeImageTile","type":"object"},{"properties":{"storeProductTile":{"$ref":"#/components/schemas/StoreProductTile"}},"required":["storeProductTile"],"title":"storeProductTile","type":"object"},{"properties":{"storeShoppableImageTile":{"$ref":"#/components/schemas/StoreShoppableImageTile"}},"required":["storeShoppableImageTile"],"title":"storeShoppableImageTile","type":"object"},{"properties":{"storeTextTile":{"$ref":"#/components/schemas/StoreTextTile"}},"required":["storeTextTile"],"title":"storeTextTile","type":"object"},{"properties":{"storeVideoTile":{"$ref":"#/components/schemas/StoreVideoTile"}},"required":["storeVideoTile"],"title":"storeVideoTile","type":"object"},{"properties":{"storeEmptyTile":{"$ref":"#/components/schemas/StoreEmptyTile"}},"required":["storeEmptyTile"],"title":"storeEmptyTile","type":"object"},{"properties":{"storeCustomCodeTile":{"$ref":"#/components/schemas/StoreCustomCodeTile"}},"required":["storeCustomCodeTile"],"title":"storeCustomCodeTile","type":"object"}]},"StoreTileBorderSize":{"description":"| StoreTileBorderSize | Description |\n| --- | --- |\n| `NONE` | No border |\n| `SMALL` | Small border size |\n| `MEDIUM` | Medium border size |\n| `LARGE` | Large border size |","enum":["LARGE","MEDIUM","NONE","SMALL"],"type":"string"},"StoreTileLayer":{"properties":{"colorPalette":{"$ref":"#/components/schemas/StoreColorPalette"},"content":{"$ref":"#/components/schemas/StoreTileLayerContent"},"coverTile":{"description":"Whether the layer covers the entire tile.","type":"boolean"},"margin":{"$ref":"#/components/schemas/StoreTileBorderSize"},"opacity":{"description":"Opacity level of the layer.","format":"double","type":"number"},"outOfBounds":{"description":"Whether the layer is out of bounds.","type":"boolean"},"padding":{"$ref":"#/components/schemas/StoreTileBorderSize"},"position":{"$ref":"#/components/schemas/StoreTilePosition"},"tag":{"description":"Unique tag for the tile layer to track performance.","type":"string"},"type":{"$ref":"#/components/schemas/StoreTileType"}},"type":"object"},"StoreTileLayerContent":{"properties":{"bodyText":{"description":"Body text for the layer.","type":"string"},"bondCustomerServiceLink":{"description":"Whether to include a customer service link.","type":"boolean"},"callToAction":{"description":"Call to action text for the layer.","type":"string"},"callToActionType":{"$ref":"#/components/schemas/StoreCallToActionType"},"customUrl":{"description":"Custom URL for the layer.","type":"string"},"headerText":{"description":"Header text for the layer.","type":"string"},"pageId":{"description":"Page identifier for the layer.","type":"string"},"prefixText":{"description":"Prefix text for the layer.","type":"string"},"productAsins":{"description":"Single ASIN for the layer.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"tileTextAlignment":{"$ref":"#/components/schemas/StoreTextAlignment"},"tileTextSize":{"$ref":"#/components/schemas/StoreTileTextSize"}},"type":"object"},"StoreTilePosition":{"properties":{"x":{"$ref":"#/components/schemas/HorizontalPosition"},"y":{"$ref":"#/components/schemas/VerticalPosition"}},"type":"object"},"StoreTileSize":{"description":"| StoreTileSize | Description |\n| --- | --- |\n| `LARGE` | Large tile size, StoreAWLSTile only uses LARGE |\n| `MEDIUM` | Medium tile size |\n| `SMALL` | Small tile size |\n| `MINI` | Mini tile size |","enum":["LARGE","MEDIUM","MINI","SMALL"],"type":"string"},"StoreTileTextSize":{"description":"| StoreTileTextSize | Description |\n| --- | --- |\n| `MINI` | Mini text size |\n| `SMALL` | Small text size |\n| `MEDIUM` | Medium text size |\n| `LARGE` | Large text size |","enum":["LARGE","MEDIUM","MINI","SMALL"],"type":"string"},"StoreTileType":{"description":"| StoreTileType | Description |\n| --- | --- |\n| `TEXT` | Tile type for StoreTextTile and tile layers |\n| `IMAGE` | Tile type for StoreImageTile, StoreImageWithTextTile, StoreMetadataItem type |\n| `PRODUCT` | Tile type for StoreProductTile and StoreShoppablePoint type |\n| `INTERACTIVE_IMAGE` | Tile type for StoreShoppableImageTile |\n| `VIDEO` | Tile type for StoreVideoTile |\n| `CUSTOM_CODE` | Tile type for StoreCustomCodeTile |\n| `EMPTY` | Tile type for StoreEmptyTile |\n| `EXTERNAL_WIDGET` | Tile type for StoreAWLSTile |","enum":["CUSTOM_CODE","EMPTY","EXTERNAL_WIDGET","IMAGE","INTERACTIVE_IMAGE","PRODUCT","TEXT","VIDEO"],"type":"string"},"StoreTileWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"rowHeight":{"description":"Height of the row in pixels.","format":"int32","type":"integer"},"tiles":{"description":"The tiles for the widget. Minimum 2 and maximum 8 tiles are allowed.","items":{"$ref":"#/components/schemas/StoreTile"},"maxItems":8,"minItems":2,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"StoreVerticalAlign":{"description":"| StoreVerticalAlign | Description |\n| --- | --- |\n| `TOP` | Top alignment |\n| `MIDDLE` | Middle alignment |\n| `BOTTOM` | Bottom alignment |","enum":["BOTTOM","MIDDLE","TOP"],"type":"string"},"StoreVideoContent":{"properties":{"assetId":{"description":"Asset identifier.","type":"string"},"assetTags":{"description":"Tags associated with the asset.","type":"string"},"autoPlay":{"description":"Whether video should auto-play.","type":"boolean"},"callToAction":{"description":"Call to action text.","type":"string"},"canvasData":{"$ref":"#/components/schemas/StoreCanvasData"},"customUrl":{"description":"Custom URL for the content.","type":"string"},"imageHeight":{"description":"Height of the image.","format":"double","type":"number"},"imageKey":{"description":"Key for the image asset.","type":"string"},"imageOffsetLeft":{"description":"Left offset for image positioning.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset for image positioning.","format":"double","type":"number"},"imageUrl":{"description":"URL of the image.","type":"string"},"imageWidth":{"description":"Width of the image.","format":"double","type":"number"},"mute":{"description":"Whether video should be muted.","type":"boolean"},"pageId":{"description":"Page identifier","type":"string"},"productAsins":{"description":"List of product ASINs.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"renderTileLayers":{"description":"Whether to render tile layers.","type":"boolean"},"resourceId":{"description":"Resource identifier.","type":"string"},"text":{"description":"Text content.","type":"string"},"textAlign":{"description":"Text alignment.","type":"string"},"textOption":{"$ref":"#/components/schemas/StoreTextOptionType"},"tileLayers":{"description":"Configuration for tile layers.","items":{"$ref":"#/components/schemas/StoreTileLayer"},"maxItems":1,"minItems":0,"type":"array"},"title":{"description":"Title of the content.","type":"string"},"videoAssetId":{"description":"Video asset identifier.","type":"string"},"videoAssetTags":{"description":"Tags associated with the video asset.","type":"string"},"videoDescription":{"description":"Description of the video.","type":"string"},"videoKey":{"description":"Key for the video asset.","type":"string"},"videoName":{"description":"Name of the video.","type":"string"},"videoSize":{"description":"Size of the video in bytes.","format":"double","type":"number"},"videoUrl":{"description":"URL of the video.","type":"string"}},"type":"object"},"StoreVideoRevealVRVideo":{"description":"Configuration for a single video reveal video asset","properties":{"assetId":{"description":"Unique identifier for the video asset","type":"string"},"url":{"description":"URL of the video content","type":"string"}},"required":["assetId","url"],"type":"object"},"StoreVideoRevealVideos":{"description":"Collection of video assets for different device types","properties":{"desktop":{"$ref":"#/components/schemas/StoreVideoRevealVRVideo"},"mobile":{"$ref":"#/components/schemas/StoreVideoRevealVRVideo"}},"required":["desktop","mobile"],"type":"object"},"StoreVideoRevealWidget":{"description":"Main widget structure for the video reveal feature","properties":{"backgroundColor":{"description":"Background color (CSS property)","type":"string"},"csmTag":{"description":"CSM tracking tag for the video reveal","type":"string"},"fadeoutDuration":{"description":"Fadeout duration (in ms)","type":"string"},"objectFit":{"description":"Object fit (CSS property)","type":"string"},"skipReveal":{"description":"Skip reveal (to be used in development only)","type":"boolean"},"throttleLimit":{"description":"Play video every X minutes","type":"string"},"videos":{"$ref":"#/components/schemas/StoreVideoRevealVideos"}},"required":["backgroundColor","csmTag","fadeoutDuration","objectFit","skipReveal","throttleLimit","videos"],"type":"object"},"StoreVideoTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonTileProperties"},"content":{"$ref":"#/components/schemas/StoreVideoContent"}},"required":["commonProperties"],"type":"object"},"StoreVideoWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"tiles":{"description":"The content configuration for the video widget.","items":{"$ref":"#/components/schemas/StoreVideoTile"},"maxItems":1,"minItems":1,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"StoreWidgetSectionType":{"description":"| StoreWidgetSectionType | Description |\n| --- | --- |\n| `HERO` | Section type for StoreHeroImageWidget |\n| `EDITORIAL_ROW` | Widget type for StoreCustomCodeWidget, StoreImageWithTextWidget, StoreImageWidget, StoreProductWidget, StoreShoppableImageWidget, StoreTextWidget, StoreTileWidget, StoreVideoWidget and StoreAWLSWidget |\n| `DEALS_AND_COUPONS` | Section type for StoreDealsWidget and StoreDealsContent type |\n| `GALLERY` | Section type for StoreGalleryWidget |\n| `PRODUCT_COLLECTION` | Section type for StoreProductCollectionWidget |\n| `PRODUCT_GRID` | Section type for StoreProductGridWidget and type for StoreProductCollectionASINGrid |\n| `SHOP_THE_LOOK_CAROUSEL` | Section type for StoreShopTheLookWidget and type for StoreShopTheLookContent |\n| `MANUALLY_CURATED_PRODUCT_CAROUSEL` | Section type for StoreManuallyCuratedProductCarouselWidget and StoreCarouselContent type |\n| `RECOMMENDED` | Section type for StoreProductCarouselWidget and StoreProductCarouselContent type |\n| `BEST_SELLING` | Section type for StoreProductCarouselWidget and StoreProductCarouselContent type |\n| `PREMIUM_BEST_SELLING` | Section type for StoreProductCarouselWidget and StoreProductCarouselContent type |\n| `LIVE_VIDEO` | Section type for StoreLiveVideoWidget |\n| `BANNER` | Section type for StoreBannerWidget |","enum":["BANNER","BEST_SELLING","DEALS_AND_COUPONS","EDITORIAL_ROW","GALLERY","HERO","LIVE_VIDEO","MANUALLY_CURATED_PRODUCT_CAROUSEL","PREMIUM_BEST_SELLING","PRODUCT_COLLECTION","PRODUCT_GRID","RECOMMENDED","SHOP_THE_LOOK_CAROUSEL"],"type":"string"},"StoreWidgetType":{"description":"| StoreWidgetType | Description |\n| --- | --- |\n| `HERO` | Widget type for StoreHeroImageWidget |\n| `EDITORIAL_ROW` | Widget type for StoreCustomCodeWidget, StoreImageWithTextWidget, StoreImageWidget, StoreProductWidget, StoreShoppableImageWidget, StoreTextWidget, StoreTileWidget, StoreVideoWidget and StoreAWLSWidget |\n| `PRODUCT_GRID` | Widget type for StoreProductGridWidget and StoreDealsWidget |\n| `GALLERY` | Widget type for StoreGalleryWidget and StoreGalleryContent type |\n| `PRODUCT_COLLECTION` | Widget type for StoreProductCollectionWidget and StoreProductCollection type |\n| `MULTI_MEDIA_CAROUSEL` | Widget type for StoreShopTheLookWidget, StoreManuallyCuratedProductCarouselWidget and StoreProductCarouselWidget |\n| `PRODUCT_CAROUSEL` | Widget type for StoreProductCarouselWidget |\n| `LIVE_VIDEO` | Widget type and content type for StoreLiveVideoWidget |\n| `BANNER` | Widget type and content type for StoreBannerWidget |","enum":["BANNER","EDITORIAL_ROW","GALLERY","HERO","LIVE_VIDEO","MULTI_MEDIA_CAROUSEL","PRODUCT_CAROUSEL","PRODUCT_COLLECTION","PRODUCT_GRID"],"type":"string"},"StreamingTvSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/VideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/VideoLandingPage"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"},"products":{"description":"The product advertised on this video creative.","items":{"$ref":"#/components/schemas/AdvertisedProducts"},"maxItems":20,"minItems":0,"type":"array"},"videos":{"$ref":"#/components/schemas/Video"}},"required":["videos"],"type":"object"},"SupportedThirdPartySellers":{"description":"| SupportedThirdPartySellers | Description |\n|------|------|\n| `ALL` |  |\n| `NONE` |  |\n","enum":["ALL","NONE"],"type":"string"},"TacticKey":{"description":"A tactic type paired with its compatible inventory type","properties":{"primaryInventoryType":{"$ref":"#/components/schemas/PrimaryInventoryType"},"tacticType":{"$ref":"#/components/schemas/AutomatedTargetingTactic"}},"required":["primaryInventoryType","tacticType"],"type":"object"},"TacticsConvertersExclusionType":{"description":"| TacticsConvertersExclusionType | Description |\n|------|------|\n| `NO_EXCLUSION` | Do not exclude any converters from targeting. |\n| `RECENT_CONVERTERS` | Exclude recent converters from targeting to focus on new customers. |\n","enum":["NO_EXCLUSION","RECENT_CONVERTERS"],"type":"string"},"Tag":{"properties":{"key":{"description":"A custom key value pair entered by the advertiser.","type":"string"},"value":{"description":"A custom key value pair entered by the advertiser.","type":"string"}},"required":["key","value"],"type":"object"},"Target":{"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/AdProduct"},"bid":{"$ref":"#/components/schemas/TargetBid"},"campaignId":{"description":"A unique identifier for the campaign associated with the target. Only used for campaign-level targets.","type":"string"},"creationDateTime":{"description":"The date time the target was created.","format":"date-time","type":"string"},"globalTargetId":{"description":"The global target identifier that manages this marketplace target.","type":"string"},"lastUpdatedDateTime":{"description":"The date time the target was last updated.","format":"date-time","type":"string"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global target that enables overriding certain attributes at individual marketplace level. For example, if a global target is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the target\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/MarketplaceTargetConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"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/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"negative":{"description":"Indicates whether the target is negative or not.","type":"boolean"},"state":{"$ref":"#/components/schemas/State"},"status":{"$ref":"#/components/schemas/Status"},"tags":{"description":"Open ended labels with a key value pair applied to the target","items":{"$ref":"#/components/schemas/Tag"},"maxItems":50,"minItems":0,"type":"array"},"targetDetails":{"$ref":"#/components/schemas/TargetDetails"},"targetId":{"description":"A unique identifier for the target.","type":"string"},"targetLevel":{"$ref":"#/components/schemas/TargetLevel"},"targetType":{"$ref":"#/components/schemas/TargetType"}},"required":["adProduct","creationDateTime","lastUpdatedDateTime","negative","state","targetDetails","targetId","targetType"],"type":"object"},"TargetAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetAdProductFilter":{"properties":{"include":{"description":"| AdProduct | Description |\n| --- | --- |\n| `SPONSORED_PRODUCTS` | Sponsored Products ad product. |\n| `SPONSORED_BRANDS` | Sponsored Brands ad product. |\n| `SPONSORED_DISPLAY` | Sponsored Display ad product. |\n| `SPONSORED_TELEVISION` | Sponsored Television ad product. |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","items":{"$ref":"#/components/schemas/AdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetBid":{"properties":{"bid":{"description":"The maximum bid for a target.","format":"double","type":"number"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"marketplaceSettings":{"description":"The bid associated with the target at specified marketplace level. Either one of bid or marketplaceSettings should always be specified","items":{"$ref":"#/components/schemas/TargetBidMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"}},"type":"object"},"TargetBidMarketplaceSetting":{"properties":{"bid":{"description":"The maximum bid for a target.","format":"double","type":"number"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"marketplace":{"$ref":"#/components/schemas/Marketplace"}},"required":["currencyCode","marketplace"],"type":"object"},"TargetCampaignIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetCreate":{"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/AdProduct"},"bid":{"$ref":"#/components/schemas/CreateTargetBid"},"campaignId":{"description":"A unique identifier for the campaign associated with the target. Only used for campaign-level targets.","type":"string"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global target that enables overriding certain attributes at individual marketplace level. For example, if a global target is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the target\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/CreateMarketplaceTargetConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"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/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"negative":{"description":"Indicates whether the target is negative or not.","type":"boolean"},"state":{"$ref":"#/components/schemas/CreateState"},"tags":{"description":"Open ended labels with a key value pair applied to the target","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"},"targetDetails":{"$ref":"#/components/schemas/CreateTargetDetails"},"targetType":{"$ref":"#/components/schemas/TargetType"}},"required":["adProduct","negative","state","targetDetails","targetType"],"type":"object"},"TargetDetails":{"oneOf":[{"properties":{"adInitiationTarget":{"$ref":"#/components/schemas/AdInitiationTarget"}},"required":["adInitiationTarget"],"title":"adInitiationTarget","type":"object"},{"properties":{"adPlayerSizeTarget":{"$ref":"#/components/schemas/AdPlayerSizeTarget"}},"required":["adPlayerSizeTarget"],"title":"adPlayerSizeTarget","type":"object"},{"properties":{"appTarget":{"$ref":"#/components/schemas/AppTarget"}},"required":["appTarget"],"title":"appTarget","type":"object"},{"properties":{"audienceTarget":{"$ref":"#/components/schemas/AudienceTarget"}},"required":["audienceTarget"],"title":"audienceTarget","type":"object"},{"properties":{"brandSafetyCategoryTarget":{"$ref":"#/components/schemas/BrandSafetyCategoryTarget"}},"required":["brandSafetyCategoryTarget"],"title":"brandSafetyCategoryTarget","type":"object"},{"properties":{"brandSafetyTierTarget":{"$ref":"#/components/schemas/BrandSafetyTierTarget"}},"required":["brandSafetyTierTarget"],"title":"brandSafetyTierTarget","type":"object"},{"properties":{"contentCategoryTarget":{"$ref":"#/components/schemas/ContentCategoryTarget"}},"required":["contentCategoryTarget"],"title":"contentCategoryTarget","type":"object"},{"properties":{"contentGenreTarget":{"$ref":"#/components/schemas/ContentGenreTarget"}},"required":["contentGenreTarget"],"title":"contentGenreTarget","type":"object"},{"properties":{"contentInstreamPositionTarget":{"$ref":"#/components/schemas/ContentInstreamPositionTarget"}},"required":["contentInstreamPositionTarget"],"title":"contentInstreamPositionTarget","type":"object"},{"properties":{"contentOutstreamPositionTarget":{"$ref":"#/components/schemas/ContentOutstreamPositionTarget"}},"required":["contentOutstreamPositionTarget"],"title":"contentOutstreamPositionTarget","type":"object"},{"properties":{"contentRatingTarget":{"$ref":"#/components/schemas/ContentRatingTarget"}},"required":["contentRatingTarget"],"title":"contentRatingTarget","type":"object"},{"properties":{"dayPartTarget":{"$ref":"#/components/schemas/DayPartTarget"}},"required":["dayPartTarget"],"title":"dayPartTarget","type":"object"},{"properties":{"deviceTarget":{"$ref":"#/components/schemas/DeviceTarget"}},"required":["deviceTarget"],"title":"deviceTarget","type":"object"},{"properties":{"domainTarget":{"$ref":"#/components/schemas/DomainTarget"}},"required":["domainTarget"],"title":"domainTarget","type":"object"},{"properties":{"foldPositionTarget":{"$ref":"#/components/schemas/FoldPositionTarget"}},"required":["foldPositionTarget"],"title":"foldPositionTarget","type":"object"},{"properties":{"inventorySourceTarget":{"$ref":"#/components/schemas/InventorySourceTarget"}},"required":["inventorySourceTarget"],"title":"inventorySourceTarget","type":"object"},{"properties":{"keywordTarget":{"$ref":"#/components/schemas/KeywordTarget"}},"required":["keywordTarget"],"title":"keywordTarget","type":"object"},{"properties":{"locationTarget":{"$ref":"#/components/schemas/LocationTarget"}},"required":["locationTarget"],"title":"locationTarget","type":"object"},{"properties":{"nativeContentPositionTarget":{"$ref":"#/components/schemas/NativeContentPositionTarget"}},"required":["nativeContentPositionTarget"],"title":"nativeContentPositionTarget","type":"object"},{"properties":{"placementTypeTarget":{"$ref":"#/components/schemas/PlacementTypeTarget"}},"required":["placementTypeTarget"],"title":"placementTypeTarget","type":"object"},{"properties":{"productAudienceTarget":{"$ref":"#/components/schemas/ProductAudienceTarget"}},"required":["productAudienceTarget"],"title":"productAudienceTarget","type":"object"},{"properties":{"productCategoryTarget":{"$ref":"#/components/schemas/ProductCategoryTarget"}},"required":["productCategoryTarget"],"title":"productCategoryTarget","type":"object"},{"properties":{"productTarget":{"$ref":"#/components/schemas/ProductTarget"}},"required":["productTarget"],"title":"productTarget","type":"object"},{"properties":{"themeTarget":{"$ref":"#/components/schemas/ThemeTarget"}},"required":["themeTarget"],"title":"themeTarget","type":"object"},{"properties":{"thirdPartyTarget":{"$ref":"#/components/schemas/ThirdPartyTarget"}},"required":["thirdPartyTarget"],"title":"thirdPartyTarget","type":"object"},{"properties":{"videoAdFormatTarget":{"$ref":"#/components/schemas/VideoAdFormatTarget"}},"required":["videoAdFormatTarget"],"title":"videoAdFormatTarget","type":"object"},{"properties":{"videoContentDurationTarget":{"$ref":"#/components/schemas/VideoContentDurationTarget"}},"required":["videoContentDurationTarget"],"title":"videoContentDurationTarget","type":"object"}]},"TargetEvent":{"description":"| TargetEvent | Description |\n|------|------|\n| `PURCHASE` | A product purchase event. |\n| `VIEW` | A product view event. |\n","enum":["PURCHASE","VIEW"],"type":"string"},"TargetInventorySourceTypeFilter":{"properties":{"include":{"description":"| InventorySourceType | Description |\n| --- | --- |\n| `AMAZON` | Amazon-owned inventory. |\n| `APD` | Amazon Publisher Direct inventory. |\n| `THIRD_PARTY_EXCHANGE` | Third-party exchange inventory. |\n| `DEAL` | Deal-based inventory. |\n| `INVENTORY_GROUP` | A group representing a set of inventories. |","items":{"$ref":"#/components/schemas/InventorySourceType"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetKeywordFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/TargetKeywordFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"TargetKeywordFilterType":{"description":"| TargetKeywordFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"TargetLanguageLocaleFilter":{"properties":{"include":{"description":"| NativeLanguageLocale | Description |\n| --- | --- |\n| `ak_GH` | Akan (Ghana). |\n| `am_ET` | Amharic (Ethiopia). |\n| `an_ES` | Aragonese (Spain). |\n| `ar_AE` | Arabic (UAE). |\n| `as_IN` | Assamese (India). |\n| `av_RU` | Avaric (Russia). |\n| `ay_BO` | Aymara (Bolivia). |\n| `ba_RU` | Bashkir (Russia). |\n| `be_BY` | Belarusian (Belarus). |\n| `bg_BG` | Bulgarian (Bulgaria). |\n| `bh_IN` | Bihari (India). |\n| `bi_VU` | Bislama (Vanuatu). |\n| `bm_ML` | Bambara (Mali). |\n| `bo_CN` | Tibetan (China). |\n| `bs_BA` | Bosnian (Bosnia and Herzegovina). |\n| `ca_ES` | Catalan (Spain). |\n| `ce_RU` | Chechen (Russia). |\n| `ch_GU` | Chamorro (Guam). |\n| `de_DE` | German (Germany). |\n| `el_GR` | Greek (Greece). |\n| `en_US` | English (United States). |\n| `eo_INT` | Esperanto (International). |\n| `es_ES` | Spanish (Spain). |\n| `et_EE` | Estonian (Estonia). |\n| `eu_ES` | Basque (Spain). |\n| `fa_IR` | Persian (Iran). |\n| `fi_FI` | Finnish (Finland). |\n| `fj_FJ` | Fijian (Fiji). |\n| `fo_FO` | Faroese (Faroe Islands). |\n| `fr_FR` | French (France). |\n| `fy_NL` | Western Frisian (Netherlands). |\n| `ga_IE` | Irish (Ireland). |\n| `gd_GB` | Scottish Gaelic (United Kingdom). |\n| `gl_ES` | Galician (Spain). |\n| `gn_PY` | Guarani (Paraguay). |\n| `gu_IN` | Gujarati (India). |\n| `gv_IM` | Manx (Isle of Man). |\n| `ha_NG` | Hausa (Nigeria). |\n| `he_IL` | Hebrew (Israel). |\n| `hi_IN` | Hindi (India). |\n| `ho_PG` | Hiri Motu (Papua New Guinea). |\n| `hr_HR` | Croatian (Croatia). |\n| `ht_HT` | Haitian Creole (Haiti). |\n| `hu_HU` | Hungarian (Hungary). |\n| `hy_AM` | Armenian (Armenia). |\n| `hz_NA` | Herero (Namibia). |\n| `ia_INT` | Interlingua (International). |\n| `id_ID` | Indonesian (Indonesia). |\n| `ie_INT` | Interlingue (International). |\n| `ig_NG` | Igbo (Nigeria). |\n| `ii_CN` | Sichuan Yi (China). |\n| `ik_US` | Inupiaq (United States). |\n| `io_INT` | Ido (International). |\n| `is_IS` | Icelandic (Iceland). |\n| `it_IT` | Italian (Italy). |\n| `iu_CA` | Inuktitut (Canada). |\n| `ja_JP` | Japanese (Japan). |\n| `jv_ID` | Javanese (Indonesia). |\n| `ka_GE` | Georgian (Georgia). |\n| `kg_CD` | Kongo (Democratic Republic of the Congo). |\n| `ki_KE` | Kikuyu (Kenya). |\n| `kj_NA` | Kwanyama (Namibia). |\n| `kk_KZ` | Kazakh (Kazakhstan). |\n| `kl_GL` | Kalaallisut (Greenland). |\n| `km_KH` | Khmer (Cambodia). |\n| `kn_IN` | Kannada (India). |\n| `ko_KR` | Korean (South Korea). |\n| `kr_NG` | Kanuri (Nigeria). |\n| `ks_IN` | Kashmiri (India). |\n| `ku_TR` | Kurdish (Turkey). |\n| `kv_RU` | Komi (Russia). |\n| `kw_GB` | Cornish (United Kingdom). |\n| `ky_KG` | Kyrgyz (Kyrgyzstan). |\n| `la_VA` | Latin (Vatican City). |\n| `lb_LU` | Luxembourgish (Luxembourg). |\n| `lg_UG` | Ganda (Uganda). |\n| `li_NL` | Limburgish (Netherlands). |\n| `ln_CD` | Lingala (Democratic Republic of the Congo). |\n| `lo_LA` | Lao (Laos). |\n| `lt_LT` | Lithuanian (Lithuania). |\n| `lu_CD` | Luba-Katanga (Democratic Republic of the Congo). |\n| `lv_LV` | Latvian (Latvia). |\n| `mg_MG` | Malagasy (Madagascar). |\n| `mh_MH` | Marshallese (Marshall Islands). |\n| `mi_NZ` | Māori (New Zealand). |\n| `mk_MK` | Macedonian (North Macedonia). |\n| `ml_IN` | Malayalam (India). |\n| `mn_MN` | Mongolian (Mongolia). |\n| `mr_IN` | Marathi (India). |\n| `ms_MY` | Malay (Malaysia). |\n| `mt_MT` | Maltese (Malta). |\n| `my_MM` | Burmese (Myanmar). |\n| `na_NR` | Nauru (Nauru). |\n| `nb_NO` | Norwegian Bokmål (Norway). |\n| `nd_ZW` | North Ndebele (Zimbabwe). |\n| `ne_NP` | Nepali (Nepal). |\n| `ng_NA` | Ndonga (Namibia). |\n| `nl_NL` | Dutch (Netherlands). |\n| `nn_NO` | Norwegian Nynorsk (Norway). |\n| `no_NO` | Norwegian (Norway). |\n| `nr_ZA` | South Ndebele (South Africa). |\n| `nv_US` | Navajo (United States). |\n| `ny_MW` | Chichewa (Malawi). |\n| `oc_FR` | Occitan (France). |\n| `oj_CA` | Ojibwa (Canada). |\n| `om_ET` | Oromo (Ethiopia). |\n| `or_IN` | Oriya (India). |\n| `os_RU` | Ossetian (Russia). |\n| `pa_IN` | Punjabi (India). |\n| `pi_IN` | Pali (India). |\n| `pl_PL` | Polish (Poland). |\n| `ps_AF` | Pashto (Afghanistan). |\n| `pt_PT` | Portuguese (Portugal). |\n| `qu_PE` | Quechua (Peru). |\n| `rm_CH` | Romansh (Switzerland). |\n| `rn_BI` | Kirundi (Burundi). |\n| `ro_RO` | Romanian (Romania). |\n| `ru_RU` | Russian (Russia). |\n| `rw_RW` | Kinyarwanda (Rwanda). |\n| `sa_IN` | Sanskrit (India). |\n| `sc_IT` | Sardinian (Italy). |\n| `sd_PK` | Sindhi (Pakistan). |\n| `se_NO` | Northern Sami (Norway). |\n| `sg_CF` | Sango (Central African Republic). |\n| `si_LK` | Sinhala (Sri Lanka). |\n| `sk_SK` | Slovak (Slovakia). |\n| `sl_SI` | Slovenian (Slovenia). |\n| `sm_WS` | Samoan (Samoa). |\n| `sn_ZW` | Shona (Zimbabwe). |\n| `so_SO` | Somali (Somalia). |\n| `sq_AL` | Albanian (Albania). |\n| `sr_RS` | Serbian (Serbia). |\n| `ss_SZ` | Swati (Eswatini). |\n| `st_LS` | Southern Sotho (Lesotho). |\n| `su_ID` | Sundanese (Indonesia). |\n| `sv_SE` | Swedish (Sweden). |\n| `sw_TZ` | Swahili (Tanzania). |\n| `ta_IN` | Tamil (India). |\n| `te_IN` | Telugu (India). |\n| `tg_TJ` | Tajik (Tajikistan). |\n| `th_TH` | Thai (Thailand). |\n| `ti_ET` | Tigrinya (Ethiopia). |\n| `tk_TM` | Turkmen (Turkmenistan). |\n| `tl_PH` | Tagalog (Philippines). |\n| `tn_BW` | Tswana (Botswana). |\n| `to_TO` | Tonga (Tonga). |\n| `tr_TR` | Turkish (Turkey). |\n| `ts_ZA` | Tsonga (South Africa). |\n| `tt_RU` | Tatar (Russia). |\n| `tw_GH` | Twi (Ghana). |\n| `ty_PF` | Tahitian (French Polynesia). |\n| `ug_CN` | Uyghur (China). |\n| `uk_UA` | Ukrainian (Ukraine). |\n| `ur_PK` | Urdu (Pakistan). |\n| `uz_UZ` | Uzbek (Uzbekistan). |\n| `ve_ZA` | Venda (South Africa). |\n| `vi_VN` | Vietnamese (Vietnam). |\n| `vo_INT` | Volapük (International). |\n| `wa_BE` | Walloon (Belgium). |\n| `wo_SN` | Wolof (Senegal). |\n| `xh_ZA` | Xhosa (South Africa). |\n| `yi_IL` | Yiddish (Israel). |\n| `yo_NG` | Yoruba (Nigeria). |\n| `za_CN` | Zhuang (China). |\n| `zh_CN` | Chinese (China). |\n| `zu_ZA` | Zulu (South Africa). |","items":{"$ref":"#/components/schemas/LanguageLocale"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetLevel":{"description":"| TargetLevel | Description |\n|------|------|\n| `AD_GROUP` | Target applied at the ad group level. |\n| `CAMPAIGN` | Target applied at the campaign level. |\n","enum":["AD_GROUP","CAMPAIGN"],"type":"string"},"TargetMarketplaceScopeFilter":{"properties":{"include":{"description":"| MarketplaceScope | Description |\n| --- | --- |\n| `GLOBAL` |  |\n| `SINGLE_MARKETPLACE` |  |","items":{"$ref":"#/components/schemas/MarketplaceScope"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetMarketplaceStringValueFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/MarketplaceStringValue"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetMatchTypeFilter":{"properties":{"include":{"description":"| MatchType | Description |\n| --- | --- |\n| `KEYWORDS_RELATED_TO_GIFTS` | Search terms related to gifts. |\n| `KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY` | Search terms that shoppers often use when searching for and interacting with products from other brands in the category of your advertised products. The peer brands are selected automatically. |\n| `KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES` | Search terms related to your landing pages. |\n| `PRODUCT_SIMILAR` | Products similar to the specified product. |\n| `BROAD` | Broad match search terms. This expands matching on user intent beyond PHRASE.  |\n| `EXACT` | Exact match search terms. |\n| `KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY` | Search terms shoppers often use to search for products in the same category as the products you\u0027re advertising. |\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `PRODUCT_SUBSTITUTES` | Products that can be substituted for advertised product. |\n| `PRODUCT_REMARKETING` | Products to target users who have previously interacted with the specified product. |\n| `KEYWORDS_LOOSE_MATCH` | Search terms loosely matching advertised product. |\n| `PHRASE` | Phrase match search terms. This expands matching on user intent beyond EXACT. |\n| `INTERESTED_AUDIENCE` | Audiences that are likely interested in the advertised product or service. |\n| `KEYWORDS_CLOSE_MATCH` | Search terms closely matching advertised product. |\n| `PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS` | Products similar to products advertised as part of the ad group. |\n| `PRODUCT_COMPLEMENTS` |  |\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |\n| `KEYWORDS_RELATED_TO_PRIME_DAY` | Search terms that shoppers are likely to use during Prime Day. These keywords can include terms related to the event, like \"prime day\", combined with product-specific terms. These keywords can help you expand reach to shoppers during the sales event. These keywords will only match queries through the end of Prime Day. |","items":{"$ref":"#/components/schemas/MatchType"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetMultiStatusResponseWithPartialErrors":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1000,"minItems":0,"type":"array"},"partialSuccess":{"items":{"$ref":"#/components/schemas/TargetPartialIndex"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/TargetMultiStatusSuccess"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"TargetMultiStatusSuccess":{"properties":{"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"},"target":{"$ref":"#/components/schemas/Target"}},"required":["index","target"],"type":"object"},"TargetNegativeFilter":{"properties":{"include":{"items":{"type":"boolean"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetPartialIndex":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"},"target":{"$ref":"#/components/schemas/Target"}},"required":["errors","index","target"],"type":"object"},"TargetProductIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/TargetProductIdFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"TargetProductIdFilterType":{"description":"| TargetProductIdFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"TargetStateFilter":{"properties":{"include":{"description":"| 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/State"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetSuccessResponse":{"properties":{"nextToken":{"type":"string"},"targets":{"items":{"$ref":"#/components/schemas/Target"},"maxItems":5000,"minItems":0,"type":"array"},"totalResults":{"format":"int32","type":"integer"}},"type":"object"},"TargetTargetIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetTargetTypeFilter":{"properties":{"include":{"description":"| 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| `PRODUCT_AUDIENCE` | Target customers who interacted with a specific product. |\n| `AUDIENCE` | Target based on an audience segment. |\n| `LOCATION` | Target based on geographic location. |\n| `DOMAIN` | Target based on a domain. |\n| `APP` | Target based on an application. |\n| `DEVICE` | Target based on device type. |\n| `DAYPART` | Target based on time of day and day of week. |\n| `CONTENT_CATEGORY` | Target based on content category. |\n| `CONTENT_GENRE` | Target based on content genre. |\n| `CONTENT_RATING` | Target based on content rating. |\n| `BRAND_SAFETY_TIER` | Target based on brand suitability tier. |\n| `BRAND_SAFETY_CATEGORY` | Target based on brand safety category. |\n| `INVENTORY_SOURCE` | Target based on inventory source. |\n| `AD_INITIATION` | Target based on how the video ad is initiated. |\n| `AD_PLAYER_SIZE` | Target based on video player size. |\n| `VIDEO_AD_FORMAT` | Target based on video ad format. This is an older function being replaced by newer targets for instream and outstream targets. |\n| `THIRD_PARTY` | Target based on third-party data. |\n| `THEME` | Target based on a keyword theme. These were formerly known as Auto Targets for Sponsored Products. |\n| `CONTENT_INSTREAM_POSITION` | Target based on instream ad position. |\n| `CONTENT_OUTSTREAM_POSITION` | Target based on outstream ad position. |\n| `VIDEO_CONTENT_DURATION` | Target based on video content duration. |\n| `FOLD_POSITION` | Target based on above or below the fold placement. |\n| `NATIVE_CONTENT_POSITION` | Target based on native content position. |\n| `PLACEMENT_TYPE` | Target based on placement type. |","items":{"$ref":"#/components/schemas/TargetType"},"maxItems":17,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetType":{"description":"| TargetType | Description |\n|------|------|\n| `AD_INITIATION` | Target based on how the video ad is initiated. |\n| `AD_PLAYER_SIZE` | Target based on video player size. |\n| `APP` | Target based on an application. |\n| `AUDIENCE` | Target based on an audience segment. |\n| `BRAND_SAFETY_CATEGORY` | Target based on brand safety category. |\n| `BRAND_SAFETY_TIER` | Target based on brand suitability tier. |\n| `CONTENT_CATEGORY` | Target based on content category. |\n| `CONTENT_GENRE` | Target based on content genre. |\n| `CONTENT_INSTREAM_POSITION` | Target based on instream ad position. |\n| `CONTENT_OUTSTREAM_POSITION` | Target based on outstream ad position. |\n| `CONTENT_RATING` | Target based on content rating. |\n| `DAYPART` | Target based on time of day and day of week. |\n| `DEVICE` | Target based on device type. |\n| `DOMAIN` | Target based on a domain. |\n| `FOLD_POSITION` | Target based on above or below the fold placement. |\n| `INVENTORY_SOURCE` | Target based on inventory source. |\n| `KEYWORD` | Target based on customer search terms. |\n| `LOCATION` | Target based on geographic location. |\n| `NATIVE_CONTENT_POSITION` | Target based on native content position. |\n| `PLACEMENT_TYPE` | Target based on placement type. |\n| `PRODUCT_AUDIENCE` | Target customers who interacted with a specific product. |\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| `THIRD_PARTY` | Target based on third-party data. |\n| `VIDEO_AD_FORMAT` | Target based on video ad format. This is an older function being replaced by newer targets for instream and outstream targets. |\n| `VIDEO_CONTENT_DURATION` | Target based on video content duration. |\n","enum":["AD_INITIATION","AD_PLAYER_SIZE","APP","AUDIENCE","BRAND_SAFETY_CATEGORY","BRAND_SAFETY_TIER","CONTENT_CATEGORY","CONTENT_GENRE","CONTENT_INSTREAM_POSITION","CONTENT_OUTSTREAM_POSITION","CONTENT_RATING","DAYPART","DEVICE","DOMAIN","FOLD_POSITION","INVENTORY_SOURCE","KEYWORD","LOCATION","NATIVE_CONTENT_POSITION","PLACEMENT_TYPE","PRODUCT","PRODUCT_AUDIENCE","PRODUCT_CATEGORY","THEME","THIRD_PARTY","VIDEO_AD_FORMAT","VIDEO_CONTENT_DURATION"],"type":"string"},"TargetUpdate":{"properties":{"bid":{"$ref":"#/components/schemas/UpdateTargetBid"},"campaignId":{"description":"A unique identifier for the campaign associated with the target. Only used for campaign-level targets.","type":"string"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global target that enables overriding certain attributes at individual marketplace level. For example, if a global target is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the target\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/CreateMarketplaceTargetConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"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/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"state":{"$ref":"#/components/schemas/UpdateState"},"tags":{"description":"Open ended labels with a key value pair applied to the target","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"},"targetId":{"description":"A unique identifier for the target.","type":"string"}},"required":["targetId"],"type":"object"},"TargetingSettings":{"properties":{"amazonViewability":{"$ref":"#/components/schemas/AmazonViewability"},"automatedTargetingTactic":{"$ref":"#/components/schemas/AutomatedTargetingTactic"},"defaultAudienceTargetingMatchType":{"$ref":"#/components/schemas/DefaultAudienceTargetingMatchType"},"enableLanguageTargeting":{"description":"If set to true, creatives will only target supply where the content language matches the creative language.","type":"boolean"},"siteLanguage":{"$ref":"#/components/schemas/SiteLanguage"},"tacticsConvertersExclusionType":{"$ref":"#/components/schemas/TacticsConvertersExclusionType"},"targetedPGDealId":{"description":"DealId to be targeted by the Ad Group being created. If you are creating an ad group targeting a programmatic guaranteed deal, the deal can be provided here.","type":"string"},"timeZoneType":{"$ref":"#/components/schemas/TimeZoneType"},"userLocationSignal":{"$ref":"#/components/schemas/UserLocationSignal"},"videoCompletionTier":{"$ref":"#/components/schemas/VideoCompletionTier"}},"required":["amazonViewability","timeZoneType","userLocationSignal"],"type":"object"},"ThemeMatchType":{"description":"| ThemeMatchType | Description |\n|------|------|\n| `INTERESTED_AUDIENCE` | Audiences that are likely interested in the advertised product or service. |\n| `KEYWORDS_CLOSE_MATCH` | Search terms closely matching advertised product. |\n| `KEYWORDS_LOOSE_MATCH` | Search terms loosely matching advertised product. |\n| `KEYWORDS_RELATED_TO_GIFTS` | Search terms related to gifts. |\n| `KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY` | Search terms that shoppers often use when searching for and interacting with products from other brands in the category of your advertised products. The peer brands are selected automatically. |\n| `KEYWORDS_RELATED_TO_PRIME_DAY` | Search terms that shoppers are likely to use during Prime Day. These keywords can include terms related to the event, like \"prime day\", combined with product-specific terms. These keywords can help you expand reach to shoppers during the sales event. These keywords will only match queries through the end of Prime Day. |\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES` | Search terms related to your landing pages. |\n| `KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY` | Search terms shoppers often use to search for products in the same category as the products you\u0027re advertising. |\n| `PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS` | Products similar to products advertised as part of the ad group. |\n| `PRODUCT_COMPLEMENTS` | Products that complement advertised product. |\n| `PRODUCT_SUBSTITUTES` | Products that can be substituted for advertised product. |\n","enum":["INTERESTED_AUDIENCE","KEYWORDS_CLOSE_MATCH","KEYWORDS_LOOSE_MATCH","KEYWORDS_RELATED_TO_GIFTS","KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY","KEYWORDS_RELATED_TO_PRIME_DAY","KEYWORDS_RELATED_TO_YOUR_BRAND","KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES","KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY","PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS","PRODUCT_COMPLEMENTS","PRODUCT_SUBSTITUTES"],"type":"string"},"ThemeTarget":{"description":"Theme targets let advertisers select high-performing targets based on a common theme.","properties":{"matchType":{"$ref":"#/components/schemas/ThemeMatchType"}},"required":["matchType"],"type":"object"},"ThirdPartyCreative":{"properties":{"thirdPartyDisplaySettings":{"$ref":"#/components/schemas/ThirdPartyDisplaySettings"},"thirdPartyVideoSettings":{"$ref":"#/components/schemas/ThirdPartyVideoSettings"}},"type":"object"},"ThirdPartyDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/AdChoicesPosition"},"additionalHtml":{"description":"Additional html to be included along with the creative when rendered.","type":"string"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The list of placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/Size"},"maxItems":20,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"thirdPartyTagHostingSource":{"description":"The html tag to use to fetch this creative from the 3p ad server.","type":"string"}},"required":["adChoicesPosition","creativeSizes","language","thirdPartyTagHostingSource"],"type":"object"},"ThirdPartyTarget":{"properties":{"thirdPartyTargetDetails":{"$ref":"#/components/schemas/ThirdPartyTargetDetails"},"thirdPartyTargetType":{"$ref":"#/components/schemas/ThirdPartyTargetType"}},"required":["thirdPartyTargetDetails","thirdPartyTargetType"],"type":"object"},"ThirdPartyTargetDetails":{"oneOf":[{"properties":{"doubleVerifyAuthenticAttention":{"$ref":"#/components/schemas/DoubleVerifyAuthenticAttention"}},"required":["doubleVerifyAuthenticAttention"],"title":"doubleVerifyAuthenticAttention","type":"object"},{"properties":{"doubleVerifyAuthenticBrandSafety":{"$ref":"#/components/schemas/DoubleVerifyAuthenticBrandSafety"}},"required":["doubleVerifyAuthenticBrandSafety"],"title":"doubleVerifyAuthenticBrandSafety","type":"object"},{"properties":{"doubleVerifyBrandSafety":{"$ref":"#/components/schemas/DoubleVerifyBrandSafety"}},"required":["doubleVerifyBrandSafety"],"title":"doubleVerifyBrandSafety","type":"object"},{"properties":{"doubleVerifyCustomContextualSegmentId":{"$ref":"#/components/schemas/DoubleVerifyCustomContextualSegmentId"}},"required":["doubleVerifyCustomContextualSegmentId"],"title":"doubleVerifyCustomContextualSegmentId","type":"object"},{"properties":{"doubleVerifyFraudInvalidTraffic":{"$ref":"#/components/schemas/DoubleVerifyFraudInvalidTraffic"}},"required":["doubleVerifyFraudInvalidTraffic"],"title":"doubleVerifyFraudInvalidTraffic","type":"object"},{"properties":{"doubleVerifyStandardDisplayBrandSafety":{"$ref":"#/components/schemas/DoubleVerifyStandardDisplayBrandSafety"}},"required":["doubleVerifyStandardDisplayBrandSafety"],"title":"doubleVerifyStandardDisplayBrandSafety","type":"object"},{"properties":{"doubleVerifyViewability":{"$ref":"#/components/schemas/DoubleVerifyViewability"}},"required":["doubleVerifyViewability"],"title":"doubleVerifyViewability","type":"object"},{"properties":{"integralAdScienceBrandSafety":{"$ref":"#/components/schemas/IntegralAdScienceBrandSafety"}},"required":["integralAdScienceBrandSafety"],"title":"integralAdScienceBrandSafety","type":"object"},{"properties":{"integralAdScienceContextualAvoidance":{"$ref":"#/components/schemas/IntegralAdScienceContextualAvoidance"}},"required":["integralAdScienceContextualAvoidance"],"title":"integralAdScienceContextualAvoidance","type":"object"},{"properties":{"integralAdScienceContextualTargeting":{"$ref":"#/components/schemas/IntegralAdScienceContextualTargeting"}},"required":["integralAdScienceContextualTargeting"],"title":"integralAdScienceContextualTargeting","type":"object"},{"properties":{"integralAdScienceFraudInvalidTraffic":{"$ref":"#/components/schemas/IntegralAdScienceFraudInvalidTraffic"}},"required":["integralAdScienceFraudInvalidTraffic"],"title":"integralAdScienceFraudInvalidTraffic","type":"object"},{"properties":{"integralAdScienceQualitySync":{"$ref":"#/components/schemas/IntegralAdScienceQualitySync"}},"required":["integralAdScienceQualitySync"],"title":"integralAdScienceQualitySync","type":"object"},{"properties":{"integralAdScienceViewability":{"$ref":"#/components/schemas/IntegralAdScienceViewability"}},"required":["integralAdScienceViewability"],"title":"integralAdScienceViewability","type":"object"},{"properties":{"newsGuardBrandGuardMisinformationSafety":{"$ref":"#/components/schemas/NewsGuardBrandGuardMisinformationSafety"}},"required":["newsGuardBrandGuardMisinformationSafety"],"title":"newsGuardBrandGuardMisinformationSafety","type":"object"},{"properties":{"newsGuardBrandGuardTrustedNewsTargeting":{"$ref":"#/components/schemas/NewsGuardBrandGuardTrustedNewsTargeting"}},"required":["newsGuardBrandGuardTrustedNewsTargeting"],"title":"newsGuardBrandGuardTrustedNewsTargeting","type":"object"},{"properties":{"pixalateFraudInvalidTraffic":{"$ref":"#/components/schemas/PixalateFraudInvalidTraffic"}},"required":["pixalateFraudInvalidTraffic"],"title":"pixalateFraudInvalidTraffic","type":"object"}]},"ThirdPartyTargetType":{"description":"| ThirdPartyTargetType | Description |\n|------|------|\n| `DOUBLE_VERIFY_AUTHENTIC_ATTENTION` |  |\n| `DOUBLE_VERIFY_AUTHENTIC_BRAND_SAFETY` |  |\n| `DOUBLE_VERIFY_BRAND_SAFETY` |  |\n| `DOUBLE_VERIFY_CUSTOM_CONTEXTUAL_SEGMENT_ID` |  |\n| `DOUBLE_VERIFY_FRAUD_INVALID_TRAFFIC` |  |\n| `DOUBLE_VERIFY_STANDARD_DISPLAY_BRAND_SAFETY` |  |\n| `DOUBLE_VERIFY_VIEWABILITY` |  |\n| `INTEGRAL_AD_SCIENCE_BRAND_SAFETY` |  |\n| `INTEGRAL_AD_SCIENCE_CONTEXTUAL_AVOIDANCE` |  |\n| `INTEGRAL_AD_SCIENCE_CONTEXTUAL_TARGETING` |  |\n| `INTEGRAL_AD_SCIENCE_FRAUD_INVALID_TRAFFIC` |  |\n| `INTEGRAL_AD_SCIENCE_QUALITY_SYNC` | Integral Ad Science (IAS) Quality |\n| `INTEGRAL_AD_SCIENCE_VIEWABILITY` |  |\n| `NEWS_GUARD_BRAND_GUARD_MISINFORMATION_SAFETY` | NewsGuard Misinformation Safety. NewsGuard is a rating system for news and information websites. |\n| `NEWS_GUARD_BRAND_GUARD_TRUSTED_NEWS_TARGETING` | NewsGuard Trusted News Targeting. NewsGuard is a rating system for news and information websites. |\n| `PIXALATE_FRAUD_INVALID_TRAFFIC` |  |\n","enum":["DOUBLE_VERIFY_AUTHENTIC_ATTENTION","DOUBLE_VERIFY_AUTHENTIC_BRAND_SAFETY","DOUBLE_VERIFY_BRAND_SAFETY","DOUBLE_VERIFY_CUSTOM_CONTEXTUAL_SEGMENT_ID","DOUBLE_VERIFY_FRAUD_INVALID_TRAFFIC","DOUBLE_VERIFY_STANDARD_DISPLAY_BRAND_SAFETY","DOUBLE_VERIFY_VIEWABILITY","INTEGRAL_AD_SCIENCE_BRAND_SAFETY","INTEGRAL_AD_SCIENCE_CONTEXTUAL_AVOIDANCE","INTEGRAL_AD_SCIENCE_CONTEXTUAL_TARGETING","INTEGRAL_AD_SCIENCE_FRAUD_INVALID_TRAFFIC","INTEGRAL_AD_SCIENCE_QUALITY_SYNC","INTEGRAL_AD_SCIENCE_VIEWABILITY","NEWS_GUARD_BRAND_GUARD_MISINFORMATION_SAFETY","NEWS_GUARD_BRAND_GUARD_TRUSTED_NEWS_TARGETING","PIXALATE_FRAUD_INVALID_TRAFFIC"],"type":"string"},"ThirdPartyVideoSettings":{"properties":{"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"vastUrl":{"description":"The url to use to fetch the VAST XML for this video creative.","type":"string"}},"required":["language","vastUrl"],"type":"object"},"TimeOfDay":{"properties":{"endTime":{"description":"Selected end time","pattern":"^([01][0-9]|2[0-3]):[0-5][0-9]Z$","type":"string"},"startTime":{"description":"Selected start time","pattern":"^([01][0-9]|2[0-3]):[0-5][0-9]Z$","type":"string"}},"required":["endTime","startTime"],"type":"object"},"TimeUnit":{"description":"| TimeUnit | Description |\n|------|------|\n| `DAYS` |  |\n| `HOURS` |  |\n| `MINUTES` |  |\n","enum":["DAYS","HOURS","MINUTES"],"type":"string"},"TimeZoneType":{"description":"| TimeZoneType | Description |\n|------|------|\n| `ADVERTISER_REGION` | Use the advertiser\u0027s regional time zone for daypart targeting. |\n| `VIEWER` | Use the viewer\u0027s local time zone for daypart targeting. |\n","enum":["ADVERTISER_REGION","VIEWER"],"type":"string"},"TooManyRequestsResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"TwitchContentRating":{"properties":{"twitchContentRating":{"$ref":"#/components/schemas/TwitchContentRatingEnum"}},"required":["twitchContentRating"],"type":"object"},"TwitchContentRatingEnum":{"description":"| TwitchContentRatingEnum | Description |\n|------|------|\n| `TWITCH_MODERATE` | Twitch Content with moderate content exclusions based on content classification labels received from Twitch. |\n| `TWITCH_RESTRICTIVE` | Twitch Content with restrictive content exlcusions based on content classification labels received from Twitch. |\n","enum":["TWITCH_MODERATE","TWITCH_RESTRICTIVE"],"type":"string"},"UnauthorizedResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"UpdateAdAssociationRequest":{"properties":{"adAssociations":{"items":{"$ref":"#/components/schemas/AdAssociationUpdate"},"maxItems":20,"minItems":1,"type":"array"}},"type":"object"},"UpdateAdExtensionRequest":{"properties":{"adExtensions":{"items":{"$ref":"#/components/schemas/AdExtensionUpdate"},"maxItems":50,"minItems":1,"type":"array"}},"type":"object"},"UpdateAdGroupBid":{"properties":{"baseBid":{"description":"The lower bound bid used for the ads in the ad group.","format":"double","type":"number"},"defaultBid":{"description":"The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction.","format":"double","type":"number"},"marketplaceSettings":{"description":"The bid associated with the ad group at specified marketplace level. Either one of bid or marketplaceSettings should always be specified","items":{"$ref":"#/components/schemas/CreateAdGroupBidMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"maxAverageBid":{"description":"The max average bid that will be targeted on the ad group across all of the bids (a single bid could be lower or higher that this number).","format":"double","nullable":true,"type":"number"}},"type":"object"},"UpdateAdGroupBudgetSettings":{"properties":{"budgetAllocation":{"$ref":"#/components/schemas/BudgetAllocation"},"dailyMinSpendValue":{"description":"Denotes the daily minimum spend on the ad group in local currency.","format":"double","type":"number"}},"type":"object"},"UpdateAdGroupGoalSettings":{"properties":{"kpi":{"$ref":"#/components/schemas/KPI"}},"type":"object"},"UpdateAdGroupRequest":{"properties":{"adGroups":{"items":{"$ref":"#/components/schemas/AdGroupUpdate"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"UpdateAdRequest":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/AdUpdate"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"UpdateAdvertisedProducts":{"properties":{"globalStoreSetting":{"$ref":"#/components/schemas/UpdateGlobalStoreSettings"},"marketplaceSettings":{"description":"List of advertised product selectively applied at the given marketplace level","items":{"$ref":"#/components/schemas/CreateAdvertisedProductMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"productId":{"description":"The identifier of the advertised product.","type":"string"},"productIdType":{"$ref":"#/components/schemas/ProductIdType"}},"type":"object"},"UpdateAmazonViewability":{"properties":{"includeUnmeasurableImpressions":{"description":"Must be false if viewabilityTier is set to ALL_TIERS. You can set to true to include impressions that can not be measured when a viewabilityTier other than ALL_TIERS is selected. We recommend setting to false if high viewability is your goal.","type":"boolean"},"viewabilityTier":{"$ref":"#/components/schemas/ViewabilityTier"}},"type":"object"},"UpdateAssetBasedCreativeCallToAction":{"oneOf":[{"properties":{"assetBasedCreativeCallToActionSettings":{"$ref":"#/components/schemas/UpdateAssetBasedCreativeCallToActionSettings"}},"required":["assetBasedCreativeCallToActionSettings"],"title":"assetBasedCreativeCallToActionSettings","type":"object"}]},"UpdateAssetBasedCreativeCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for AssetBasedCreative.","items":{"$ref":"#/components/schemas/AssetBasedCreativeCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"type":"object"},"UpdateAssetBasedCreativeSettings":{"properties":{"additionalHtml":{"description":"Additional HTML to include with the render response for display inventory targets.","type":"string"},"bodyText":{"description":"The body text to use for the Asset Based Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"brand":{"description":"The brand of the product(s) being advertised.","type":"string"},"callToActions":{"$ref":"#/components/schemas/UpdateAssetBasedCreativeCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":0,"type":"array"},"customVideos":{"$ref":"#/components/schemas/UpdateVideo"},"disclaimers":{"description":"The disclaimers to use for the Asset Based Creative experience.","type":"string"},"headlines":{"description":"The headline(s) to use for the Asset Based Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"description":"The logos to use for the Asset Based Creative experience.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"}},"type":"object"},"UpdateAudio":{"properties":{"assetId":{"description":"The asset library ID associated with the audio asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the audio asset.","type":"string"}},"type":"object"},"UpdateAudioCreative":{"description":"| UpdateAudioCreative | Description |\n| --- | --- |\n| `standardAudioSettings` | The standard audio experience settings. See the Audio Spec for more info: https://advertising.amazon.com/en-us/resources/ad-specs/audio-ads?ref_\u003da20m_us_spcs_spcs_aa |","oneOf":[{"properties":{"standardAudioSettings":{"$ref":"#/components/schemas/UpdateStandardAudioExperienceSettings"}},"required":["standardAudioSettings"],"title":"standardAudioSettings","type":"object"}]},"UpdateAutoCollectionSettings":{"description":"Settings for automatically generated collections.","properties":{"productExclusions":{"description":"Products to exclude from auto collection.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":1000,"minItems":0,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/UpdateSharedCollectionSettings"}},"type":"object"},"UpdateBidAdjustments":{"properties":{"audienceBidAdjustments":{"description":"Bid Adjustments based on the audiences","items":{"$ref":"#/components/schemas/CreateAudienceBidAdjustment"},"maxItems":1,"minItems":0,"type":"array"},"creativeBidAdjustments":{"description":"Bid Adjustments based on ads being shown as a creative. Range of bid adjustment value would be 0:900","items":{"$ref":"#/components/schemas/CreateCreativeBidAdjustment"},"maxItems":2,"minItems":0,"type":"array"},"placementBidAdjustments":{"description":"Bid adjustments based on ad placements.","items":{"$ref":"#/components/schemas/CreatePlacementBidAdjustment"},"maxItems":4,"minItems":0,"type":"array"},"shopperSegmentBidAdjustments":{"description":"Legacy SB field (marked for deprecation)","items":{"$ref":"#/components/schemas/CreateShopperSegmentBidAdjustment"},"maxItems":2,"minItems":0,"type":"array"}},"type":"object"},"UpdateBidSettings":{"properties":{"bidAdjustments":{"$ref":"#/components/schemas/UpdateBidAdjustments"},"bidStrategy":{"$ref":"#/components/schemas/BidStrategy"}},"type":"object"},"UpdateBrandStoreCallToAction":{"oneOf":[{"properties":{"brandStoreCallToActionSettings":{"$ref":"#/components/schemas/UpdateBrandStoreCallToActionSettings"}},"required":["brandStoreCallToActionSettings"],"title":"brandStoreCallToActionSettings","type":"object"}]},"UpdateBrandStoreCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for BrandStore.","items":{"$ref":"#/components/schemas/BrandStoreCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"type":"object"},"UpdateBrandStoreEditionPublishVersionRequest":{"properties":{"brandStoreEditionPublishVersions":{"items":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersionUpdate"},"maxItems":1,"minItems":1,"type":"array"}},"type":"object"},"UpdateBrandStoreSettings":{"properties":{"additionalHtml":{"description":"Additional HTML to include with the render response for display inventory targets.","type":"string"},"bodyText":{"description":"The body text to use for the Brand Store Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"brand":{"description":"The brand of the product(s) being advertised.","type":"string"},"callToActions":{"$ref":"#/components/schemas/UpdateBrandStoreCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":0,"type":"array"},"disclaimers":{"description":"The disclaimers to use for the Brand Store Creative experience.","type":"string"},"headlines":{"description":"The headline(s) to use for the Brand Store Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":1,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"$ref":"#/components/schemas/UpdateImage"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":1,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":1,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":1,"type":"array"}},"type":"object"},"UpdateBudgetSettings":{"properties":{"budgetAllocation":{"$ref":"#/components/schemas/BudgetAllocation"},"flightBudgetRolloverStrategy":{"$ref":"#/components/schemas/RolloverStrategy"},"offAmazonBudgetControlStrategy":{"$ref":"#/components/schemas/OffAmazonBudgetControlStrategy"}},"type":"object"},"UpdateCampaignOptimizations":{"properties":{"bidSettings":{"$ref":"#/components/schemas/UpdateBidSettings"},"budgetSettings":{"$ref":"#/components/schemas/UpdateBudgetSettings"},"goalSettings":{"$ref":"#/components/schemas/UpdateGoalSettings"},"primaryInventoryTypes":{"description":"Primary inventory type of the campaign for filtering KPIs and recommending tactics.","items":{"$ref":"#/components/schemas/PrimaryInventoryType"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"UpdateCampaignRequest":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/CampaignUpdate"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"UpdateClickToAppDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The app that customers are directed to.","type":"string"}},"type":"object"},"UpdateClickToUrlDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"type":"object"},"UpdateCollectionLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/CollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page.","type":"string"}},"type":"object"},"UpdateComponentCreative":{"properties":{"assetBasedCreativeSettings":{"$ref":"#/components/schemas/UpdateAssetBasedCreativeSettings"},"autoCollectionSettings":{"$ref":"#/components/schemas/UpdateAutoCollectionSettings"},"brandStoreSettings":{"$ref":"#/components/schemas/UpdateBrandStoreSettings"},"manualCollectionSettings":{"$ref":"#/components/schemas/UpdateManualCollectionSettings"},"productCollectionSettings":{"$ref":"#/components/schemas/UpdateProductCollectionSettings"},"productVideoSettings":{"$ref":"#/components/schemas/UpdateProductVideoSettings"},"responsiveEcommerceSettings":{"$ref":"#/components/schemas/UpdateResponsiveEcommerceSettings"},"storeSpotlightSettings":{"$ref":"#/components/schemas/UpdateStoreSpotlightSettings"}},"type":"object"},"UpdateConstituentIndexValues":{"properties":{"values":{"description":"List of brand and category sales values.","items":{"$ref":"#/components/schemas/CreateConstituentIndexValue"},"maxItems":1000000,"minItems":1,"type":"array"}},"type":"object"},"UpdateCreative":{"oneOf":[{"properties":{"audioCreative":{"$ref":"#/components/schemas/UpdateAudioCreative"}},"required":["audioCreative"],"title":"audioCreative","type":"object"},{"properties":{"displayCreative":{"$ref":"#/components/schemas/UpdateDisplayCreative"}},"required":["displayCreative"],"title":"displayCreative","type":"object"},{"properties":{"thirdPartyCreative":{"$ref":"#/components/schemas/UpdateThirdPartyCreative"}},"required":["thirdPartyCreative"],"title":"thirdPartyCreative","type":"object"},{"properties":{"videoCreative":{"$ref":"#/components/schemas/UpdateVideoCreative"}},"required":["videoCreative"],"title":"videoCreative","type":"object"},{"properties":{"componentCreative":{"$ref":"#/components/schemas/UpdateComponentCreative"}},"required":["componentCreative"],"title":"componentCreative","type":"object"},{"properties":{"productCreative":{"$ref":"#/components/schemas/UpdateProductCreative"}},"required":["productCreative"],"title":"productCreative","type":"object"}]},"UpdateDirectIndexValues":{"properties":{"values":{"description":"List of direct index values.","items":{"$ref":"#/components/schemas/CreateDirectIndexValue"},"maxItems":1000000,"minItems":1,"type":"array"}},"type":"object"},"UpdateDisplayCallToAction":{"oneOf":[{"properties":{"clickToUrlDisplayCallToActionSettings":{"$ref":"#/components/schemas/UpdateClickToUrlDisplayCallToActionSettings"}},"required":["clickToUrlDisplayCallToActionSettings"],"title":"clickToUrlDisplayCallToActionSettings","type":"object"},{"properties":{"clickToAppDisplayCallToActionSettings":{"$ref":"#/components/schemas/UpdateClickToAppDisplayCallToActionSettings"}},"required":["clickToAppDisplayCallToActionSettings"],"title":"clickToAppDisplayCallToActionSettings","type":"object"}]},"UpdateDisplayCreative":{"properties":{"standardDisplaySettings":{"$ref":"#/components/schemas/UpdateStandardDisplaySettings"}},"type":"object"},"UpdateGlobalStoreSettings":{"properties":{"catalogSourceMarketplace":{"$ref":"#/components/schemas/Marketplace"}},"type":"object"},"UpdateGoalSettings":{"properties":{"kpi":{"$ref":"#/components/schemas/KPI"},"kpiValue":{"description":"The value of the KPI that the campaign is working to optimize.","format":"double","nullable":true,"type":"number"}},"type":"object"},"UpdateImage":{"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/CreateFormatProperties"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"UpdateIndexValues":{"oneOf":[{"properties":{"directIndexValues":{"$ref":"#/components/schemas/UpdateDirectIndexValues"}},"required":["directIndexValues"],"title":"directIndexValues","type":"object"},{"properties":{"constituentIndexValues":{"$ref":"#/components/schemas/UpdateConstituentIndexValues"}},"required":["constituentIndexValues"],"title":"constituentIndexValues","type":"object"}]},"UpdateLandingPageAsins":{"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"},"UpdateLocationIndexRequest":{"properties":{"locationIndexes":{"items":{"$ref":"#/components/schemas/LocationIndexUpdate"},"maxItems":10,"minItems":1,"type":"array"}},"type":"object"},"UpdateManualCollectionSettings":{"description":"Settings for manually curated collections.","properties":{"landingPage":{"$ref":"#/components/schemas/UpdateCollectionLandingPage"},"productInclusions":{"description":"The products featured in the ad. Required for manual collections.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":10,"minItems":3,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/UpdateSharedCollectionSettings"}},"type":"object"},"UpdateOnlineVideoSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/CreateVideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"$ref":"#/components/schemas/UpdateAdvertisedProducts"},"videos":{"$ref":"#/components/schemas/UpdateVideo"}},"type":"object"},"UpdateOptimization":{"properties":{"bidStrategy":{"$ref":"#/components/schemas/BidStrategy"},"budgetSettings":{"$ref":"#/components/schemas/UpdateAdGroupBudgetSettings"},"goalSettings":{"$ref":"#/components/schemas/UpdateAdGroupGoalSettings"}},"type":"object"},"UpdatePacing":{"properties":{"deliveryProfile":{"$ref":"#/components/schemas/DeliveryProfile"}},"type":"object"},"UpdateProductCollectionLandingPage":{"properties":{"landingPageAsins":{"$ref":"#/components/schemas/UpdateLandingPageAsins"},"landingPageType":{"$ref":"#/components/schemas/ProductCollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page. Read only if landingPageType is ASIN_LIST","type":"string"}},"type":"object"},"UpdateProductCollectionSettings":{"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/CreateImage"},"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/ProductCollectionCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"customImages":{"description":"The set of custom images featured in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"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/UpdateProductCollectionLandingPage"},"products":{"description":"The products featured in the ad.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":3,"minItems":0,"type":"array"}},"type":"object"},"UpdateProductCreative":{"properties":{"productCreativeSettings":{"$ref":"#/components/schemas/UpdateProductCreativeSettings"}},"type":"object"},"UpdateProductCreativeSettings":{"description":"An ad with a creative built based on the product being advertised.","properties":{"advertisedProduct":{"$ref":"#/components/schemas/UpdateAdvertisedProducts"},"spotlightVideos":{"$ref":"#/components/schemas/UpdateSpotlightVideoSettings"}},"type":"object"},"UpdateProductVideoSettings":{"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/CreateImage"},"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/UpdateVideoLandingPage"},"products":{"description":"The products featured in the video ad.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":3,"minItems":0,"type":"array"},"videos":{"description":"The video assets used in the ad.","items":{"$ref":"#/components/schemas/CreateVideo"},"maxItems":2,"minItems":1,"type":"array"}},"type":"object"},"UpdateResponsiveEcommerceSettings":{"properties":{"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/ResponsiveEcommerceCreativePropertiesToOptimize"},"maxItems":3,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":0,"type":"array"},"disclaimers":{"description":"The disclaimer to use for the Responsive eCommerce experience.","type":"string"},"headlines":{"description":"The headline to use for the Responsive eCommerce experience.","type":"string"},"images":{"description":"The image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":3,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"$ref":"#/components/schemas/UpdateImage"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"products":{"description":"The products advertised for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":20,"minItems":0,"type":"array"},"recAdVariations":{"description":"The rendering variations selected for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/ResponsiveEcommerceAdVariations"},"maxItems":5,"minItems":0,"type":"array"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"supportedThirdPartySellers":{"$ref":"#/components/schemas/SupportedThirdPartySellers"}},"type":"object"},"UpdateSharedCollectionSettings":{"description":"Settings shared by all collection types.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"$ref":"#/components/schemas/UpdateImage"}},"type":"object"},"UpdateSpotlightVideoSettings":{"description":"An ad with a creative built with spotlight videos.","properties":{"optimizeText":{"description":"If the advertiser wants text they provided to be optimized by Amazon or not.","type":"boolean"},"videos":{"description":"The video asset(s) to use for the Sponsored Product experience.","items":{"$ref":"#/components/schemas/CreateVideo"},"maxItems":5,"minItems":1,"type":"array"}},"type":"object"},"UpdateStandardAudioExperienceSettings":{"properties":{"audio":{"$ref":"#/components/schemas/UpdateAudio"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded. Urls cannot exceed 2048 characters.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"description":"The product(s) being advertised.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"UpdateStandardDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/AdChoicesPosition"},"callToAction":{"$ref":"#/components/schemas/UpdateDisplayCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The list of placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":1,"type":"array"},"customImages":{"description":"The custom images to use for the standard display experience.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":20,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"}},"type":"object"},"UpdateState":{"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\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"},"UpdateStoreSpotlightLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/StoreSpotlightLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"type":"object"},"UpdateStoreSpotlightSettings":{"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/CreateImage"},"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/CreateCardCreativeElement"},"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/StoreSpotlightCreativePropertiesToOptimize"},"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/UpdateStoreSpotlightLandingPage"}},"type":"object"},"UpdateStreamingTvSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/CreateVideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"description":"The product advertised on this video creative.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":20,"minItems":0,"type":"array"},"videos":{"$ref":"#/components/schemas/UpdateVideo"}},"type":"object"},"UpdateTargetBid":{"nullable":true,"properties":{"bid":{"description":"The maximum bid for a target.","format":"double","nullable":true,"type":"number"},"marketplaceSettings":{"description":"The bid associated with the target at specified marketplace level. Either one of bid or marketplaceSettings should always be specified","items":{"$ref":"#/components/schemas/CreateTargetBidMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"}},"type":"object"},"UpdateTargetRequest":{"properties":{"targets":{"items":{"$ref":"#/components/schemas/TargetUpdate"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"UpdateTargetingSettings":{"properties":{"amazonViewability":{"$ref":"#/components/schemas/UpdateAmazonViewability"},"defaultAudienceTargetingMatchType":{"$ref":"#/components/schemas/DefaultAudienceTargetingMatchType"},"enableLanguageTargeting":{"description":"If set to true, creatives will only target supply where the content language matches the creative language.","type":"boolean"},"tacticsConvertersExclusionType":{"$ref":"#/components/schemas/TacticsConvertersExclusionType"},"targetedPGDealId":{"description":"DealId to be targeted by the Ad Group being created. If you are creating an ad group targeting a programmatic guaranteed deal, the deal can be provided here.","type":"string"},"timeZoneType":{"$ref":"#/components/schemas/TimeZoneType"},"userLocationSignal":{"$ref":"#/components/schemas/UserLocationSignal"},"videoCompletionTier":{"$ref":"#/components/schemas/VideoCompletionTier"}},"type":"object"},"UpdateThirdPartyCreative":{"properties":{"thirdPartyDisplaySettings":{"$ref":"#/components/schemas/UpdateThirdPartyDisplaySettings"},"thirdPartyVideoSettings":{"$ref":"#/components/schemas/UpdateThirdPartyVideoSettings"}},"type":"object"},"UpdateThirdPartyDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/AdChoicesPosition"},"additionalHtml":{"description":"Additional html to be included along with the creative when rendered.","type":"string"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The list of placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"thirdPartyTagHostingSource":{"description":"The html tag to use to fetch this creative from the 3p ad server.","type":"string"}},"type":"object"},"UpdateThirdPartyVideoSettings":{"properties":{"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"vastUrl":{"description":"The url to use to fetch the VAST XML for this video creative.","type":"string"}},"type":"object"},"UpdateVideo":{"properties":{"assetId":{"description":"The asset library ID associated with the video asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the video asset.","type":"string"},"description":{"description":"The description of the video content.","type":"string"},"headline":{"description":"The headline/custom text associated with the video.","type":"string"}},"type":"object"},"UpdateVideoCreative":{"properties":{"onlineVideoSettings":{"$ref":"#/components/schemas/UpdateOnlineVideoSettings"},"streamingTvSettings":{"$ref":"#/components/schemas/UpdateStreamingTvSettings"}},"type":"object"},"UpdateVideoLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/VideoLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"type":"object"},"UserLocationSignal":{"description":"| UserLocationSignal | Description |\n|------|------|\n| `CURRENT` | Target users based on their current geographic location. |\n| `MULTIPLE_SIGNALS` | Target users based on multiple location signals. |\n","enum":["CURRENT","MULTIPLE_SIGNALS"],"type":"string"},"VerticalPosition":{"description":"| VerticalPosition | Description |\n| --- | --- |\n| `TOP` | Top position |\n| `MIDDLE` | Middle position |\n| `BOTTOM` | Bottom position |","enum":["BOTTOM","MIDDLE","TOP"],"type":"string"},"Video":{"properties":{"assetId":{"description":"The asset library ID associated with the video asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the video asset.","type":"string"},"description":{"description":"The description of the video content.","type":"string"},"headline":{"description":"The headline/custom text associated with the video.","type":"string"}},"required":["assetId","assetVersion"],"type":"object"},"VideoAdFormat":{"description":"| VideoAdFormat | Description |\n|------|------|\n| `FULL_EPISODE_PLAYER` | Video ad plays within a full episode player. |\n| `INSTREAM` | Video ad plays within streaming video content. |\n| `OUTSTREAM` | Video ad plays outside of streaming video content. |\n","enum":["FULL_EPISODE_PLAYER","INSTREAM","OUTSTREAM"],"type":"string"},"VideoAdFormatTarget":{"description":"Target based on the video ad format.","properties":{"videoAdFormat":{"$ref":"#/components/schemas/VideoAdFormat"}},"required":["videoAdFormat"],"type":"object"},"VideoCallToAction":{"oneOf":[{"properties":{"clickToUrlVideoCallToActionSettings":{"$ref":"#/components/schemas/ClickToUrlVideoCallToActionSettings"}},"required":["clickToUrlVideoCallToActionSettings"],"title":"clickToUrlVideoCallToActionSettings","type":"object"},{"properties":{"learnMoreVideoCallToActionSettings":{"$ref":"#/components/schemas/LearnMoreVideoCallToActionSettings"}},"required":["learnMoreVideoCallToActionSettings"],"title":"learnMoreVideoCallToActionSettings","type":"object"}]},"VideoCompletionTier":{"description":"| VideoCompletionTier | Description |\n|------|------|\n| `ALL_TIERS` | Target all video completion tiers. |\n| `GREATER_THAN_10_PERCENT` | Target videos with greater than 10% predicted completion rate. |\n| `GREATER_THAN_20_PERCENT` | Target videos with greater than 20% predicted completion rate. |\n| `GREATER_THAN_30_PERCENT` | Target videos with greater than 30% predicted completion rate. |\n| `GREATER_THAN_40_PERCENT` | Target videos with greater than 40% predicted completion rate. |\n| `GREATER_THAN_50_PERCENT` | Target videos with greater than 50% predicted completion rate. |\n| `GREATER_THAN_60_PERCENT` | Target videos with greater than 60% predicted completion rate. |\n| `GREATER_THAN_70_PERCENT` | Target videos with greater than 70% predicted completion rate. |\n| `GREATER_THAN_80_PERCENT` | Target videos with greater than 80% predicted completion rate. |\n| `GREATER_THAN_90_PERCENT` | Target videos with greater than 90% predicted completion rate. |\n","enum":["ALL_TIERS","GREATER_THAN_10_PERCENT","GREATER_THAN_20_PERCENT","GREATER_THAN_30_PERCENT","GREATER_THAN_40_PERCENT","GREATER_THAN_50_PERCENT","GREATER_THAN_60_PERCENT","GREATER_THAN_70_PERCENT","GREATER_THAN_80_PERCENT","GREATER_THAN_90_PERCENT"],"type":"string"},"VideoContentDuration":{"description":"| VideoContentDuration | Description |\n|------|------|\n| `EXTENDED` | Video content duration of 60+ minutes |\n| `LONG` | Video content duration of 30 to 60 minutes |\n| `MEDIUM` | Video content duration of 10 to 30 minutes |\n| `SHORT` | Video content duration of 0 to 10 minutes |\n| `UNKNOWN` | Unknown video content duration |\n","enum":["EXTENDED","LONG","MEDIUM","SHORT","UNKNOWN"],"type":"string"},"VideoContentDurationTarget":{"description":"Targets ads to a specific video content duration","properties":{"duration":{"$ref":"#/components/schemas/VideoContentDuration"}},"required":["duration"],"type":"object"},"VideoCreative":{"properties":{"onlineVideoSettings":{"$ref":"#/components/schemas/OnlineVideoSettings"},"streamingTvSettings":{"$ref":"#/components/schemas/StreamingTvSettings"}},"type":"object"},"VideoExtension":{"description":"Video Ad Extension","properties":{"renderedAssetId":{"description":"The video asset ID rendered in the ad.","type":"string"},"renderedCoverImageUrl":{"description":"The image displayed over the video player before the video is played.","type":"string"},"videoType":{"$ref":"#/components/schemas/VideoType"}},"required":["videoType"],"type":"object"},"VideoInitiationType":{"description":"| VideoInitiationType | Description |\n|------|------|\n| `AUTOPLAY` | Video ad starts automatically without user action. |\n| `UNKNOWN` | Unknown video initiation type. |\n| `USER_INITIATED` | Video ad started by user action such as a click. |\n","enum":["AUTOPLAY","UNKNOWN","USER_INITIATED"],"type":"string"},"VideoLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/VideoLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType"],"type":"object"},"VideoLandingPageType":{"description":"| VideoLandingPageType | Description |\n|------|------|\n| `DETAIL_PAGE` | A product detail page. |\n| `MOMENT` | A moment landing page. |\n| `OFF_AMAZON_LINK` | An off-Amazon landing page. |\n| `STORE` | A brand Store landing page. |\n","enum":["DETAIL_PAGE","MOMENT","OFF_AMAZON_LINK","STORE"],"type":"string"},"VideoType":{"description":"Video Type: Video type of the asset added in the ad extension and its rendering form.\n\n| VideoType | Description |\n|------|------|\n| `SPOTLIGHT` | SPOTLIGHT Video Asset. |\n","enum":["SPOTLIGHT"],"type":"string"},"ViewabilityTier":{"description":"| ViewabilityTier | Description |\n|------|------|\n| `ALL_TIERS` | Target all viewability tiers with no filtering. |\n| `GREATER_THAN_40_PERCENT` | Target impressions with greater than 40% predicted viewability. |\n| `GREATER_THAN_50_PERCENT` | Target impressions with greater than 50% predicted viewability. |\n| `GREATER_THAN_60_PERCENT` | Target impressions with greater than 60% predicted viewability. |\n| `GREATER_THAN_70_PERCENT` | Target impressions with greater than 70% predicted viewability. |\n| `LESS_THAN_40_PERCENT` | Target impressions with less than 40% predicted viewability. |\n","enum":["ALL_TIERS","GREATER_THAN_40_PERCENT","GREATER_THAN_50_PERCENT","GREATER_THAN_60_PERCENT","GREATER_THAN_70_PERCENT","LESS_THAN_40_PERCENT"],"type":"string"},"ViewabilityTierType":{"description":"The type of viewability tier.\n\n| ViewabilityTierType | Description |\n|------|------|\n| `ALLOW_ALL` |  |\n| `VIEWABILITY_TIER_GT_40` |  |\n| `VIEWABILITY_TIER_GT_50` |  |\n| `VIEWABILITY_TIER_GT_60` |  |\n| `VIEWABILITY_TIER_GT_70` |  |\n| `VIEWABILITY_TIER_LT_40` |  |\n","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_LT_40"],"type":"string"}},"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 ALL Merged","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/brandStoreEditions":{"get":{"description":"Retrieve brand store page content\n\n**Requires one of these permissions**:\n[\"amazon_stores_edit\",\"amazon_stores_view\"]","operationId":"ListBrandStoreEdition","parameters":[{"$ref":"#/components/parameters/BrandStoreIdQuery"},{"$ref":"#/components/parameters/NextTokenQuery"},{"$ref":"#/components/parameters/MaxResultsQuery"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeader"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandStoreEditionSuccessResponse"}}},"description":"ListBrandStoreEdition 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":["BrandStoreEditions"]}},"/adsApi/v1/commitments/dsp":{"get":{"description":"List commitments\n\n**Requires one of these permissions**:\n[]","operationId":"DSPListCommitment","parameters":[{"$ref":"#/components/parameters/NextTokenQuery"},{"$ref":"#/components/parameters/MaxResultsQuery"},{"$ref":"#/components/parameters/ClientIdHeader"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPCommitmentSuccessResponse"}}},"description":"DSPListCommitment 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":["Commitments"]}},"/adsApi/v1/create/adAssociations":{"post":{"description":"Create Ad Association\n\n**Requires one of these permissions**:\n[\"campaign_edit\"]","operationId":"CreateAdAssociation","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAdAssociationRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdAssociationMultiStatusResponse"}}},"description":"CreateAdAssociation 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":["AdAssociations"]}},"/adsApi/v1/create/adExtensions":{"post":{"description":"Create ad extensions - API is in open beta\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateAdExtension","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAdExtensionRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdExtensionMultiStatusResponseWithPartialErrors"}}},"description":"CreateAdExtension 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**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"CreateAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAdGroupRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdGroupMultiStatusResponseWithPartialErrors"}}},"description":"CreateAdGroup 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**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"creatives_edit\"]","operationId":"CreateAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAdRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdMultiStatusResponseWithPartialErrors"}}},"description":"CreateAd 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"}}}},"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"}}}},"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"}}}},"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**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"CreateCampaign","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCampaignRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignMultiStatusResponseWithPartialErrors"}}},"description":"CreateCampaign 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/commitments/dsp":{"post":{"description":"Create commitments\n\n**Requires one of these permissions**:\n[]","operationId":"DSPCreateCommitment","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPCreateCommitmentRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPCommitmentMultiStatusResponse"}}},"description":"DSPCreateCommitment 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":["Commitments"]}},"/adsApi/v1/create/geoLocations":{"post":{"description":"Create geo location targeting definitions. Supports smart locations, which target users based on their percentile rank within a Smart Location Index.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"campaign_edit\", \"dsp_campaign_edit\", \n\"MasterAccount_Manager\"]","operationId":"CreateGeoLocation","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ManagerAccountIdHeaderOptional"}],"requestBody":{"content":{"application/json":{"examples":{"GeoLocationCreateSmartRequestExample":{"summary":"Create Smart GeoLocation Request Example","value":{"geoLocations":[{"location":{"smartLocation":{"locationIndexId":"518f53e3-1739-4644-8f9a-a0211a6188d0","maxIndexValuePercentile":100,"minIndexValuePercentile":75,"name":"High-value customers"}}}]}}},"schema":{"$ref":"#/components/schemas/CreateGeoLocationRequest"}}}},"responses":{"207":{"content":{"application/json":{"examples":{"GeoLocationCreateSmartResponseExample":{"summary":"Create Smart GeoLocation Response Example","value":{"error":[],"success":[{"geoLocation":{"geoLocationId":"XHvCjcKHXsKGfcKLaMKMwoh_wpHCkWzChcKHfH_CjsKFT04tYzVkNjNiZDMtZTRhMS00NGUwLWE0YzQtNzk0M2Q4Mzk0M2Qx","location":{"smartLocation":{"locationIndexId":"518f53e3-1739-4644-8f9a-a0211a6188d0","maxIndexValuePercentile":100,"minIndexValuePercentile":75,"name":"High-value customers"}}},"index":0}]}}},"schema":{"$ref":"#/components/schemas/GeoLocationMultiStatusResponse"}}},"description":"CreateGeoLocation 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":["GeoLocations"]}},"/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"}}}},"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/locationIndexes":{"post":{"description":"Create a Smart Location Index. A Smart Location Index is a named dataset that maps postal codes to index values representing relative audience quality or sales potential for a given advertiser. Index data is processed asynchronously; the index status will transition from PENDING to ENABLED once processing is complete.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"campaign_edit\", \"dsp_campaign_edit\", \n\"MasterAccount_Manager\"]","operationId":"CreateLocationIndex","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ManagerAccountIdHeaderOptional"}],"requestBody":{"content":{"application/json":{"examples":{"LocationIndexCreateRequestExample":{"summary":"Create Location Index Request Example","value":{"locationIndexes":[{"indexData":{"directIndexValues":{"values":[{"indexValue":42,"postalCode":"80202"},{"indexValue":72,"postalCode":"80301"},{"indexValue":13,"postalCode":"80424"}]}},"indexName":"test index name"}]}}},"schema":{"$ref":"#/components/schemas/CreateLocationIndexRequest"}}}},"responses":{"207":{"content":{"application/json":{"examples":{"LocationIndexCreateResponseExample":{"summary":"Create Location Index Response Example","value":{"error":[],"success":[{"index":0,"locationIndex":{"creationDateTime":"2025-09-22T22:24:46.229162573Z","indexId":"518f53e3-1739-4644-8f9a-a0211a6188d0","indexName":"test index name","lastUpdatedDateTime":"2025-09-22T22:24:46.229162573Z","status":"PENDING"}}]}}},"schema":{"$ref":"#/components/schemas/LocationIndexMultiStatusResponse"}}},"description":"CreateLocationIndex 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":["LocationIndexes"]}},"/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"}}}},"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/targets":{"post":{"description":"Create target\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"CreateTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTargetRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetMultiStatusResponseWithPartialErrors"}}},"description":"CreateTarget 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/adAssociations":{"post":{"description":"Delete Ad Association\n\n**Requires one of these permissions**:\n[\"campaign_edit\"]","operationId":"DeleteAdAssociation","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAdAssociationRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdAssociationMultiStatusResponse"}}},"description":"DeleteAdAssociation 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":["AdAssociations"]}},"/adsApi/v1/delete/adGroups":{"post":{"description":"Delete ad groups\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"DeleteAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAdGroupRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdGroupMultiStatusResponseWithPartialErrors"}}},"description":"DeleteAdGroup 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**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"DeleteAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAdRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdMultiStatusResponseWithPartialErrors"}}},"description":"DeleteAd 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"}}}},"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"}}}},"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**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"DeleteCampaign","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCampaignRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignMultiStatusResponseWithPartialErrors"}}},"description":"DeleteCampaign 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**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"DeleteTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTargetRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetMultiStatusResponseWithPartialErrors"}}},"description":"DeleteTarget 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/locationIndexes":{"get":{"description":"List all Smart Location Indexes for the authenticated advertiser. Returns a paginated collection of indexes including their current processing status. Use the nextToken from the response to retrieve subsequent pages.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"MasterAccount_Viewer\", \"dsp_campaign_view\", \n\"campaign_view\", \"advertiser_campaign_view\", \"campaign_edit\", \n\"dsp_campaign_edit\", \"MasterAccount_Manager\"]","operationId":"ListLocationIndex","parameters":[{"$ref":"#/components/parameters/NextTokenQuery"},{"$ref":"#/components/parameters/MaxResultsQuery"},{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ManagerAccountIdHeaderOptional"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationIndexSuccessResponse"}}},"description":"ListLocationIndex 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":["LocationIndexes"]}},"/adsApi/v1/query/adAssociations":{"post":{"description":"Query Ad Association\n\n**Requires one of these permissions**:\n[\"creatives_view\", \"campaign_view\"]","operationId":"QueryAdAssociation","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAdAssociationRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdAssociationSuccessResponse"}}},"description":"QueryAdAssociation 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":["AdAssociations"]}},"/adsApi/v1/query/adExtensions":{"post":{"description":"Query ad_extension - API is in open beta\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"advertiser_campaign_view\"]","operationId":"QueryAdExtension","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAdExtensionRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdExtensionSuccessResponse"}}},"description":"QueryAdExtension 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**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"dsp_campaign_view\", \"campaign_view\", \n\"advertiser_campaign_view\"]","operationId":"QueryAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAdGroupRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdGroupSuccessResponse"}}},"description":"QueryAdGroup 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**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"creatives_view\", \"advertiser_campaign_view\"]","operationId":"QueryAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAdRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdSuccessResponse"}}},"description":"QueryAd 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/brandStoreEditionPublishVersions":{"post":{"description":"Query store edition publish versions\n\n**Requires one of these permissions**:\n[\"amazon_stores_edit\",\"amazon_stores_view\"]","operationId":"QueryBrandStoreEditionPublishVersion","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBrandStoreEditionPublishVersionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersionSuccessResponse"}}},"description":"QueryBrandStoreEditionPublishVersion 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":["BrandStoreEditionPublishVersions"]}},"/adsApi/v1/query/brandStorePages":{"post":{"description":"Retrieve brand store page content\n\n**Requires one of these permissions**:\n[\"amazon_stores_edit\",\"amazon_stores_view\"]","operationId":"QueryBrandStorePage","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBrandStorePageRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandStorePageSuccessResponse"}}},"description":"QueryBrandStorePage 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":["BrandStorePages"]}},"/adsApi/v1/query/brandStores":{"post":{"description":"Query brand store content\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"creatives_view\", \"account_view\", \n\"creatives_edit\", \"account_edit\", \"campaign_view\", \n\"advertiser_campaign_view\", \"campaign_edit\"]","operationId":"QueryBrandStore","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBrandStoreRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandStoreSuccessResponse"}}},"description":"QueryBrandStore 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":["BrandStores"]}},"/adsApi/v1/query/campaigns":{"post":{"description":"Query campaign\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"dsp_campaign_view\", \"campaign_view\", \n\"advertiser_campaign_view\"]","operationId":"QueryCampaign","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCampaignRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignSuccessResponse"}}},"description":"QueryCampaign 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**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"dsp_campaign_view\", \"campaign_view\", \n\"advertiser_campaign_view\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"QueryTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryTargetRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetSuccessResponse"}}},"description":"QueryTarget 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/retrieve/campaignForecasts/dsp":{"post":{"description":"Retrieve campaign forecast\n\n**Requires one of these permissions**:\n[\"campaign_view\", \"advertiser_campaign_view\"]","operationId":"DSPRetrieveCampaignForecast","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPRetrieveCampaignForecastRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPCampaignForecastMultiStatusResponse"}}},"description":"DSPRetrieveCampaignForecast 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":["CampaignForecasts"]}},"/adsApi/v1/retrieve/commitmentSpends/dsp":{"post":{"description":"Retrieve commitment spend\n\n**Requires one of these permissions**:\n[]","operationId":"DSPRetrieveCommitmentSpend","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPRetrieveCommitmentSpendRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPCommitmentSpendMultiStatusResponse"}}},"description":"DSPRetrieveCommitmentSpend 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":["CommitmentSpends"]}},"/adsApi/v1/retrieve/commitments/dsp":{"post":{"description":"Get Commitments\n\n**Requires one of these permissions**:\n[]","operationId":"DSPRetrieveCommitment","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPRetrieveCommitmentRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPCommitmentMultiStatusResponse"}}},"description":"DSPRetrieveCommitment 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":["Commitments"]}},"/adsApi/v1/retrieve/locationIndexes":{"post":{"description":"Retrieve one or more Smart Location Indexes by ID. Returns the current metadata and processing status for each requested index. An index with status PENDING is still being processed and is not yet available for use in smart location targeting.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"MasterAccount_Viewer\", \"dsp_campaign_view\", \n\"campaign_view\", \"advertiser_campaign_view\", \"campaign_edit\", \n\"dsp_campaign_edit\", \"MasterAccount_Manager\"]","operationId":"RetrieveLocationIndex","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ManagerAccountIdHeaderOptional"}],"requestBody":{"content":{"application/json":{"examples":{"LocationIndexRetrieveRequestExample":{"summary":"Retrieve Location Index Example","value":{"indexIds":["518f53e3-1739-4644-8f9a-a0211a6188d0"]}}},"schema":{"$ref":"#/components/schemas/RetrieveLocationIndexRequest"}}}},"responses":{"207":{"content":{"application/json":{"examples":{"LocationIndexRetrieveResponseExample":{"summary":"Retrieve Location Index Response Example","value":{"error":[],"success":[{"index":0,"locationIndex":{"creationDateTime":"2025-09-22T22:24:46.229162573Z","indexId":"518f53e3-1739-4644-8f9a-a0211a6188d0","indexName":"test index name","lastUpdatedDateTime":"2025-09-22T22:24:46.229162573Z","status":"ENABLED"}}]}}},"schema":{"$ref":"#/components/schemas/LocationIndexMultiStatusResponse"}}},"description":"RetrieveLocationIndex 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":["LocationIndexes"]}},"/adsApi/v1/update/adAssociations":{"post":{"description":"Update Ad Association\n\n**Requires one of these permissions**:\n[\"campaign_edit\"]","operationId":"UpdateAdAssociation","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdAssociationRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdAssociationMultiStatusResponse"}}},"description":"UpdateAdAssociation 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":["AdAssociations"]}},"/adsApi/v1/update/adExtensions":{"post":{"description":"Update ad_extension - API is in open beta\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdateAdExtension","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdExtensionRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdExtensionMultiStatusResponseWithPartialErrors"}}},"description":"UpdateAdExtension 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**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"UpdateAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdGroupRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdGroupMultiStatusResponseWithPartialErrors"}}},"description":"UpdateAdGroup 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**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"creatives_edit\"]","operationId":"UpdateAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdMultiStatusResponseWithPartialErrors"}}},"description":"UpdateAd 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"}}}},"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/brandStoreEditionPublishVersions":{"post":{"description":"Update store edition publish versions\n\n**Requires one of these permissions**:\n[\"amazon_stores_edit\"]","operationId":"UpdateBrandStoreEditionPublishVersion","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBrandStoreEditionPublishVersionRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersionMultiStatusResponse"}}},"description":"UpdateBrandStoreEditionPublishVersion 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":["BrandStoreEditionPublishVersions"]}},"/adsApi/v1/update/campaigns":{"post":{"description":"Update campaign\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"UpdateCampaign","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCampaignRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignMultiStatusResponseWithPartialErrors"}}},"description":"UpdateCampaign 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/commitments/dsp":{"post":{"description":"Update commitments\n\n**Requires one of these permissions**:\n[]","operationId":"DSPUpdateCommitment","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPUpdateCommitmentRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPCommitmentMultiStatusResponse"}}},"description":"DSPUpdateCommitment 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":["Commitments"]}},"/adsApi/v1/update/locationIndexes":{"post":{"description":"Update the data for an existing Smart Location Index. Replaces the index\u0027s postal code values with the provided dataset. The update is processed asynchronously; the index status will return to PENDING until the new data has been fully processed.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"campaign_edit\", \"dsp_campaign_edit\", \n\"MasterAccount_Manager\"]","operationId":"UpdateLocationIndex","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ManagerAccountIdHeaderOptional"}],"requestBody":{"content":{"application/json":{"examples":{"LocationIndexUpdateRequestExample":{"summary":"Update Location Index Request Example","value":{"locationIndexes":[{"indexData":{"directIndexValues":{"values":[{"indexValue":55,"postalCode":"80202"},{"indexValue":80,"postalCode":"80301"},{"indexValue":20,"postalCode":"80424"}]}},"indexId":"518f53e3-1739-4644-8f9a-a0211a6188d0"}]}}},"schema":{"$ref":"#/components/schemas/UpdateLocationIndexRequest"}}}},"responses":{"207":{"content":{"application/json":{"examples":{"LocationIndexUpdateResponseExample":{"summary":"Update Location Index Response Example","value":{"error":[],"success":[{"index":0,"locationIndex":{"creationDateTime":"2025-09-22T22:24:46.229162573Z","indexId":"518f53e3-1739-4644-8f9a-a0211a6188d0","indexName":"test index name","lastUpdatedDateTime":"2025-09-23T10:00:00.000000000Z","status":"PENDING"}}]}}},"schema":{"$ref":"#/components/schemas/LocationIndexMultiStatusResponse"}}},"description":"UpdateLocationIndex 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":["LocationIndexes"]}},"/adsApi/v1/update/targets":{"post":{"description":"Update target\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdateTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTargetRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetMultiStatusResponseWithPartialErrors"}}},"description":"UpdateTarget 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"}]}