{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"AccessDeniedErrorCode":{"enum":["ACCESS_DENIED"],"type":"string"},"AccessDeniedExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/AccessDeniedErrorCode"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"],"type":"object"},"Ad":{"properties":{"adGroupId":{"description":"The identifier of the Ad Group associated with the Ad.","type":"string"},"adId":{"description":"The identifier of the Ad.","type":"string"},"adName":{"description":"The name of the Ad.","type":"string"},"asin":{"description":"The asin associated with this Ad.","type":"string"},"campaignId":{"description":"The identifier of the Campaign associated with the Ad.","type":"string"},"extendedData":{"$ref":"#/components/schemas/AdExtendedData"},"landingPageType":{"description":"The landing page type of the Ad. It can be one of ASIN_DP, SKU_DP, OFF_AMAZON_LINK, or STORE\nwith ASIN, SKU, or an HTTPS URL value in the\n`landingPageValue` field.","type":"string"},"landingPageValue":{"description":"The landing page for the Ad.","type":"string"},"state":{"$ref":"#/components/schemas/EntityState"}},"required":["adGroupId","adId","campaignId","state"],"type":"object"},"AdErrorType":{"description":"Ad Error Type","enum":["OTHER_ERROR","RANGE_ERROR"],"type":"string"},"AdExtendedData":{"properties":{"creationDate":{"description":"The date in ISO 8601 format","format":"date-time","type":"string"},"lastUpdateDate":{"description":"The date in ISO 8601 format","format":"date-time","type":"string"},"servingStatus":{"$ref":"#/components/schemas/AdServingStatus"}},"type":"object"},"AdFailureResponseItem":{"properties":{"errors":{"description":"A list of validation errors.","items":{"$ref":"#/components/schemas/AdMutationError"},"maxItems":100,"minItems":0,"type":"array"},"index":{"description":"The index of the ad in the array from the request body.","format":"int32","maximum":99,"minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"AdGroup":{"properties":{"adGroupId":{"description":"The identifier of the Ad Group.","type":"string"},"campaignId":{"description":"The identifier of the Campaign associated with the Ad Group.","type":"string"},"defaultBid":{"$ref":"#/components/schemas/DefaultBid"},"extendedData":{"$ref":"#/components/schemas/AdGroupExtendedData"},"name":{"description":"The name of the Ad Group.","maxLength":255,"minLength":1,"type":"string"},"state":{"$ref":"#/components/schemas/EntityState"}},"required":["adGroupId","campaignId","name","state"],"type":"object"},"AdGroupErrorType":{"description":"AdGroup Error Type","enum":["BIDDING_ERROR","DATE_ERROR","OTHER_ERROR","RANGE_ERROR"],"type":"string"},"AdGroupExtendedData":{"properties":{"creationDate":{"description":"The date in ISO 8601 format","format":"date-time","type":"string"},"lastUpdateDate":{"description":"The date in ISO 8601 format","format":"date-time","type":"string"},"servingStatus":{"$ref":"#/components/schemas/AdGroupServingStatus"}},"type":"object"},"AdGroupFailureResponseItem":{"properties":{"errors":{"description":"A list of validation errors.","items":{"$ref":"#/components/schemas/AdGroupMutationError"},"maxItems":100,"minItems":0,"type":"array"},"index":{"description":"The index of the ad group in the array from the request body.","format":"int32","maximum":99,"minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"AdGroupMutationError":{"properties":{"errorType":{"$ref":"#/components/schemas/AdGroupErrorType"},"errorValue":{"$ref":"#/components/schemas/AdGroupMutationErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"AdGroupMutationErrorSelector":{"properties":{"biddingError":{"$ref":"#/components/schemas/BiddingError"},"dateError":{"$ref":"#/components/schemas/DateError"},"otherError":{"$ref":"#/components/schemas/OtherError"},"rangeError":{"$ref":"#/components/schemas/RangeError"}},"type":"object"},"AdGroupMutationExceptionResponseContent":{"description":"Exception resulting in mutating campaign management entities","properties":{"code":{"$ref":"#/components/schemas/InvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/AdGroupMutationError"},"maxItems":100,"minItems":0,"type":"array"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"],"type":"object"},"AdGroupServingStatus":{"enum":["ACCOUNT_OUT_OF_BUDGET","ADGROUP_POLICING_CREATIVE_REJECTED","ADGROUP_POLICING_PENDING_REVIEW","ADVERTISER_ARCHIVED","ADVERTISER_EXCEED_SPENDS_LIMIT","ADVERTISER_PAUSED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_STATUS_ENABLED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","AD_GROUP_PAUSED","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_STATUS_ENABLED","AD_POLICING_PENDING_REVIEW","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","CAMPAIGN_PAUSED","ENDED","INELIGIBLE","OTHER","PENDING_START_DATE","STATUS_UNAVAILABLE"],"type":"string"},"AdGroupSuccessResponseItem":{"properties":{"adGroup":{"$ref":"#/components/schemas/AdGroup"},"adGroupId":{"description":"The ad group ID.","type":"string"},"index":{"description":"The index of the ad group in the array from the request body.","format":"int32","maximum":99,"minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"AdMutationError":{"properties":{"errorType":{"$ref":"#/components/schemas/AdErrorType"},"errorValue":{"$ref":"#/components/schemas/AdMutationErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"AdMutationErrorSelector":{"properties":{"otherError":{"$ref":"#/components/schemas/OtherError"},"rangeError":{"$ref":"#/components/schemas/RangeError"}},"type":"object"},"AdMutationExceptionResponseContent":{"description":"Exception resulting in mutating campaign management entities","properties":{"code":{"$ref":"#/components/schemas/InvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/AdMutationError"},"maxItems":100,"minItems":0,"type":"array"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"],"type":"object"},"AdServingStatus":{"enum":["ACCOUNT_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_EXCEED_SPENDS_LIMIT","ADVERTISER_PAUSED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_STATUS_ENABLED","AD_ARCHIVED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","AD_GROUP_PAUSED","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_STATUS_ENABLED","AD_PAUSED","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_STATUS_ARCHIVED","AD_STATUS_LIVE","AD_STATUS_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","CAMPAIGN_PAUSED","ENDED","INELIGIBLE","MISSING_DECORATION","NOT_BUYABLE","NOT_IN_BUYBOX","NOT_IN_POLICY","OTHER","OUT_OF_STOCK","PENDING_START_DATE","SECURITY_SCAN_PENDING_REVIEW","SECURITY_SCAN_REJECTED","STATUS_UNAVAILABLE"],"type":"string"},"AdSuccessResponseItem":{"properties":{"ad":{"$ref":"#/components/schemas/Ad"},"adId":{"description":"The ad ID.","type":"string"},"index":{"description":"The index of the ad in the array from the request body.","format":"int32","maximum":99,"minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"AssetProperties":{"description":"The properties of the video asset to preview. You must provide either `creativeId` or `assetProperties`. `assetProperties` cannot be used in conjunction with `creativeId`.","properties":{"assetId":{"description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library.","type":"string"},"assetVersion":{"description":"The identifier of the particular video asset version.","type":"string"}},"required":["assetId","assetVersion"],"type":"object"},"BiddingError":{"description":"Errors related to bids.","properties":{"cause":{"$ref":"#/components/schemas/ErrorCause"},"lowerLimit":{"type":"string"},"message":{"description":"Human readable error message.","type":"string"},"reason":{"$ref":"#/components/schemas/BiddingErrorReason"},"upperLimit":{"type":"string"}},"required":["cause","message","reason"],"type":"object"},"BiddingErrorReason":{"description":"Error Reasons\n\nBidding Error Reasons","enum":["BID_GT_BUDGET","BID_OUT_OF_MARKET_PLACE_RANGE","OTHER"],"type":"string"},"BillingError":{"description":"Errors related to billing","properties":{"cause":{"$ref":"#/components/schemas/ErrorCause"},"message":{"description":"Human readable error message.","type":"string"},"reason":{"$ref":"#/components/schemas/BillingErrorReason"}},"required":["cause","message","reason"],"type":"object"},"BillingErrorReason":{"description":"Billing Error Reasons","enum":["ADVERTISER_BILLING_SETUP_INCOMPLETE","ADVERTISER_SUSPENDED","BILLING_ACCOUNT_NOT_FOUND","EXPIRED_PAYMENT_METHOD","OTHER","PAYMENT_PROFILE_NOT_FOUND","VETTING_FAILURE"],"type":"string"},"Budget":{"properties":{"budgetValue":{"$ref":"#/components/schemas/BudgetValue"},"recurrenceType":{"$ref":"#/components/schemas/RecurrenceType"}},"required":["budgetValue"],"type":"object"},"BudgetCurrencyCode":{"description":"The currency code of the campaign budget. Following table summarizes the list of available marketplaces, with their\ncurrency codes\n| Marketplace | CurrencyCode | Supported |\n| --- | --- | --- |\n| US | USD | Yes |\n| CA | CAD | Coming Soon |\n| MX | MXP | Deprecated  |\n| MX | MXN | Coming Soon |\n| BR | BRL | Coming Soon |\n| GB | GBP | Coming Soon |\n| DE | EUR | Coming Soon |\n| ES | EUR | Coming Soon |\n| FR | EUR | Coming Soon |\n| IT | EUR | Coming Soon |\n| NL | EUR | Coming Soon |\n| PL | EUR | Coming Soon |\n| SE | EUR | Coming Soon |\n| BE | EUR | Coming Soon |\n| IN | INR | Coming Soon |\n| UAE | AED | Coming Soon |\n| TR | TRY | Coming Soon |\n| SA | SAR | Coming Soon |\n| JP | JPY | Coming Soon |\n| SG | SGD | Coming Soon |\n| SE | SEK | Coming Soon |\n| PL | PLN | Coming Soon |","enum":["AED","AUD","BRL","CAD","EGP","EUR","GBP","INR","JPY","MXN","MXP","PLN","SAR","SEK","SGD","TRY","USD"],"type":"string"},"BudgetError":{"description":"Errors related to budgets","properties":{"cause":{"$ref":"#/components/schemas/ErrorCause"},"lowerLimit":{"type":"string"},"message":{"description":"Human readable error message.","type":"string"},"reason":{"$ref":"#/components/schemas/BudgetErrorReason"},"upperLimit":{"type":"string"}},"required":["cause","message","reason"],"type":"object"},"BudgetErrorReason":{"description":"Budget Error Reasons","enum":["BUDGETING_POLICY_INVALID","BUDGET_CURRENCY_DOES_NOT_MATCH_MARKETPLACE_SETTINGS","BUDGET_LT_DEFAULT_BIDS","BUDGET_LT_PREDEFINED_TARGET_BIDS","BUDGET_OUT_OF_MARKET_PLACE_RANGE","BUDGET_TOO_HIGH","BUDGET_TOO_LOW","MISSING_BUDGETING_POLICY","MISSING_IN_BUDGET_FLAG","OTHER"],"type":"string"},"BudgetSettings":{"properties":{"budget":{"$ref":"#/components/schemas/Budget"}},"required":["budget"],"type":"object"},"BudgetValue":{"properties":{"amount":{"description":"The budget amount of the campaign","format":"double","type":"number"},"budgetCurrencyCode":{"$ref":"#/components/schemas/BudgetCurrencyCode"}},"type":"object"},"BulkAdGroupsOperationResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/AdGroupFailureResponseItem"},"maxItems":100,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/AdGroupSuccessResponseItem"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"BulkAdsOperationResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/AdFailureResponseItem"},"maxItems":100,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/AdSuccessResponseItem"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"BulkCampaignOperationResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/CampaignFailureResponseItem"},"maxItems":100,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/CampaignSuccessResponseItem"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"BulkCreativeOperationResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/CreativeFailureResponseItem"},"maxItems":100,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/CreativeSuccessResponseItem"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"BulkLocationOperationResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/LocationFailureResponseItem"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/LocationSuccessResponseItem"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"BulkTargetingClauseOperationResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/TargetingClauseFailureResponseItem"},"maxItems":100,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/TargetingClauseSuccessResponseItem"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"CallToAction":{"description":"Prompt to encourage the customer to take a desired action.\nIf no value is provided, the preview API will return previews for all supported CallToAction.","enum":["LEARN_MORE","SHOP_NOW"],"type":"string"},"CallToActionPosition":{"description":"The location of the CallToAction (default: LEFT).","enum":["LEFT","RIGHT"],"type":"string"},"Campaign":{"properties":{"budgetSettings":{"$ref":"#/components/schemas/BudgetSettings"},"campaignId":{"description":"The identifier of the Campaign.","type":"string"},"costType":{"description":"Cost type of the Campaign. Determines how the Campaign will bid and charge. Note that new values can be added to this list in the future. Support for the responses with newly addded values should be ensured for using them at the time of creation or updates.\n\n| Type | Description |\n| --- | --- |\n| \"CPM\" | [Default] The performance of the campaign will be measured per 1000 impresions |","type":"string"},"endDate":{"description":"The YYYYMMDD end date for the Campaign. Must be greater than the value for startDate.\nIf not specified, the Campaign has no end date and runs continuously.","format":"date-time","type":"string"},"extendedData":{"$ref":"#/components/schemas/CampaignExtendedData"},"name":{"description":"The name of the Campaign.\n\nNote: Names including single quotes must be escaped.\nFor example, to create `Campaign \u0027A\u0027`,\nthe name field should be as follows:\n`\"name\": \"Campaign \u0027\\\u0027\u0027A\u0027\\\u0027\u0027\"`","maxLength":128,"minLength":1,"type":"string"},"startDate":{"description":"The YYYYMMDD start date for the Campaign. If this field is not set to a value, the current date is used.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/EntityState"},"tags":{"$ref":"#/components/schemas/Tags"},"targetingType":{"$ref":"#/components/schemas/TargetingType"}},"required":["budgetSettings","campaignId","name","state"],"type":"object"},"CampaignErrorType":{"description":"Campaign Error Type","enum":["BIDDING_ERROR","BILLING_ERROR","BUDGET_ERROR","DATE_ERROR","OTHER_ERROR","RANGE_ERROR"],"type":"string"},"CampaignExtendedData":{"properties":{"creationDate":{"description":"The date in ISO 8601 format.","format":"date-time","type":"string"},"lastUpdateDate":{"description":"The date in ISO 8601 format.","format":"date-time","type":"string"},"servingStatus":{"$ref":"#/components/schemas/CampaignServingStatus"}},"type":"object"},"CampaignFailureResponseItem":{"properties":{"errors":{"description":"A list of validation errors.","items":{"$ref":"#/components/schemas/CampaignMutationError"},"maxItems":100,"minItems":0,"type":"array"},"index":{"description":"the index of the campaign in the array from the request body.","format":"int32","maximum":99,"minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"CampaignMutationError":{"properties":{"errorType":{"$ref":"#/components/schemas/CampaignErrorType"},"errorValue":{"$ref":"#/components/schemas/CampaignMutationErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"CampaignMutationErrorSelector":{"properties":{"biddingError":{"$ref":"#/components/schemas/BiddingError"},"budgetError":{"$ref":"#/components/schemas/BudgetError"},"dateError":{"$ref":"#/components/schemas/DateError"},"otherError":{"$ref":"#/components/schemas/OtherError"},"rangeError":{"$ref":"#/components/schemas/RangeError"}},"type":"object"},"CampaignMutationExceptionResponseContent":{"description":"Exception resulting in mutating campaign management entities","properties":{"code":{"$ref":"#/components/schemas/InvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/CampaignMutationError"},"maxItems":100,"minItems":0,"type":"array"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"],"type":"object"},"CampaignServingStatus":{"description":"`Notice: the servingStatus enums have not been finalized yet.`\nThe campaign serving status determined by system.\n- ADVERTISER_STATUS_ENABLED - Advertiser\u0027s status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Advertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser\u0027s status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser\u0027s status is paused\n- ADVERTISER_ARCHIVED - Advertiser\u0027s status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser\u0027s internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all sponsored tv campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all sponsored tv campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign\u0027s status is enabled.\n- CAMPAIGN_PAUSED - Campaign\u0027s status is paused.\n- CAMPAIGN_ARCHIVED - Campaign\u0027s status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio\u0027s status is enabled\n- PORTFOLIO_PAUSED - Portfolio\u0027s status is paused\n- PORTFOLIO_ARCHIVED - Portfolio\u0027s status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio\u0027s start date is in the future\n- PORTFOLIO_ENDED - Portfolio\u0027s end date is in the past.\n\n- INELIGIBLE - Ad Offer is ineligible\n- ELIGIBLE - Ad Offer is eligible\n- ENDED - Campaign\u0027s end date is in the past.\n- PENDING_REVIEW - Campaign is pending review.\n- PENDING_START_DATE - Campaign\u0027s start date is in the future.\n- REJECTED - Campaign is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","enum":["ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_EXCEED_SPENDS_LIMIT","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_PAUSED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_STATUS_ENABLED","AD_POLICING_PENDING_REVIEW","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","CAMPAIGN_PAUSED","CAMPAIGN_STATUS_ENABLED","ELIGIBLE","ENDED","INELIGIBLE","OTHER","PENDING_REVIEW","PENDING_START_DATE","PORTFOLIO_ARCHIVED","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PAUSED","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_STATUS_ENABLED","REJECTED","STATUS_UNAVAILABLE"],"type":"string"},"CampaignSuccessResponseItem":{"properties":{"campaign":{"$ref":"#/components/schemas/Campaign"},"campaignId":{"description":"The campaign ID.","type":"string"},"index":{"description":"The index of the campaign in the array from the request body.","format":"int32","maximum":99,"minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"CreateAd":{"properties":{"adGroupId":{"description":"The identifier of the Ad Group associated with the Ad.","type":"string"},"adName":{"description":"The name of the Ad.","type":"string"},"landingPageType":{"description":"The type of landing page for the Ad. You can specify one of these values:\n| Type | Description |\n| --- | ------- |\n| ASIN_DP | The detail page of the asin. Please specify the ASIN in the `landingPageValue` field |\n| SKU_DP | The detail page of the sku. Please specify the SKU in the `landingPageValue` field |\n| OFF_AMAZON_LINK | Landing page URL. Please specify an HTTPS URL value in the `landingPageValue` field |\n| STORE | The Amazon brand store URL. Please specify an HTTPS URL value in the `landingPageValue` field |","type":"string"},"landingPageValue":{"description":"The landing page for the Ad.","type":"string"},"state":{"$ref":"#/components/schemas/CreateOrUpdateEntityState"}},"required":["adGroupId","state"],"type":"object"},"CreateAdGroup":{"properties":{"campaignId":{"description":"The identifier of the Campaign associated with the Ad Group.","type":"string"},"defaultBid":{"$ref":"#/components/schemas/DefaultBid"},"name":{"description":"The name of the Ad Group.","maxLength":255,"minLength":1,"type":"string"},"state":{"$ref":"#/components/schemas/CreateOrUpdateEntityState"}},"required":["campaignId","name","state"],"type":"object"},"CreateCampaign":{"properties":{"budgetSettings":{"$ref":"#/components/schemas/BudgetSettings"},"costType":{"description":"Cost type of the Campaign. Determines how the Campaign will bid and charge. Note that new values can be added to this list in the future. Support for the responses with newly addded values should be ensured for using them at the time of creation or updates. Following are the list of acceptable values\n\n| Type | Description |\n| --- | --- |\n| \"CPM\" | [Default] The performance of the Campaign will be measured per 1000 impresions |","type":"string"},"endDate":{"description":"endDate is optional. If endDate is specified, startDate must be specified as well.","format":"date-time","type":"string"},"name":{"description":"The name of the Campaign.\n\nNote: Names including single quotes must be escaped.\nFor example, to create `Campaign \u0027A\u0027`,\nthe name field should be as follows:\n`\"name\": \"Campaign \u0027\\\u0027\u0027A\u0027\\\u0027\u0027\"`","maxLength":128,"minLength":1,"type":"string"},"startDate":{"description":"startDate is optional. If startDate is not specified, current date will be used.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/CreateOrUpdateEntityState"},"tags":{"$ref":"#/components/schemas/Tags"},"targetingType":{"$ref":"#/components/schemas/TargetingType"}},"required":["budgetSettings","name","state"],"type":"object"},"CreateCreative":{"properties":{"adGroupId":{"description":"The identifier of the Ad Group to which this Creative is associated.","type":"string"},"assetId":{"description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library.","type":"string"},"assetVersion":{"description":"The identifier of the particular video asset version.","type":"string"}},"required":["adGroupId","assetId","assetVersion"],"type":"object"},"CreateLocation":{"properties":{"adGroupId":{"description":"The identifier of the Ad Group to which this Location is associated.","type":"string"},"locationId":{"description":"The Location Geo ACI (Amazon Common Identifier).","type":"string"}},"required":["adGroupId","locationId"],"type":"object"},"CreateOrUpdateEntityState":{"description":"State of the resource during creation or updates.","enum":["ENABLED","PAUSED"],"type":"string"},"CreateSponsoredTvAdGroupsRequestContent":{"properties":{"adGroups":{"description":"An array of Sponsored TV ad groups.","items":{"$ref":"#/components/schemas/CreateAdGroup"},"maxItems":100,"minItems":1,"type":"array"}},"required":["adGroups"],"type":"object"},"CreateSponsoredTvAdGroupsResponseContent":{"properties":{"adGroups":{"$ref":"#/components/schemas/BulkAdGroupsOperationResponse"}},"type":"object"},"CreateSponsoredTvAdsRequestContent":{"properties":{"ads":{"description":"An array of Sponsored TV ads.","items":{"$ref":"#/components/schemas/CreateAd"},"maxItems":100,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"},"CreateSponsoredTvAdsResponseContent":{"properties":{"ads":{"$ref":"#/components/schemas/BulkAdsOperationResponse"}},"type":"object"},"CreateSponsoredTvCampaignsRequestContent":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/CreateCampaign"},"maxItems":100,"minItems":1,"type":"array"}},"required":["campaigns"],"type":"object"},"CreateSponsoredTvCampaignsResponseContent":{"properties":{"campaigns":{"$ref":"#/components/schemas/BulkCampaignOperationResponse"}},"type":"object"},"CreateSponsoredTvCreativesRequestContent":{"properties":{"creatives":{"description":"An array of creatives.","items":{"$ref":"#/components/schemas/CreateCreative"},"maxItems":1,"minItems":1,"type":"array"}},"required":["creatives"],"type":"object"},"CreateSponsoredTvCreativesResponseContent":{"properties":{"creatives":{"$ref":"#/components/schemas/BulkCreativeOperationResponse"}},"required":["creatives"],"type":"object"},"CreateSponsoredTvLocationsRequestContent":{"properties":{"locations":{"description":"An array of locations.","items":{"$ref":"#/components/schemas/CreateLocation"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["locations"],"type":"object"},"CreateSponsoredTvLocationsResponseContent":{"properties":{"locations":{"$ref":"#/components/schemas/BulkLocationOperationResponse"}},"required":["locations"],"type":"object"},"CreateSponsoredTvTargetingClausesRequestContent":{"properties":{"targetingClauses":{"description":"An array of targetingClauses.","items":{"$ref":"#/components/schemas/CreateTargetingClause"},"maxItems":100,"minItems":1,"type":"array"}},"required":["targetingClauses"],"type":"object"},"CreateSponsoredTvTargetingClausesResponseContent":{"properties":{"targetingClauses":{"$ref":"#/components/schemas/BulkTargetingClauseOperationResponse"}},"required":["targetingClauses"],"type":"object"},"CreateTargetingClause":{"properties":{"adGroupId":{"description":"The identifier of the Ad Group to which this Targeting Clause is associated.","type":"string"},"bid":{"deprecated":true,"description":"This shape is deprecated: The bid for Ads sourced using the Targeting Clause. This field will no longer be supported as bids are now only supported at an adGroup level.","format":"double","type":"number"},"expression":{"description":"The targeting expression.","items":{"$ref":"#/components/schemas/CreateTargetingExpressionPredicate"},"maxItems":1,"minItems":1,"type":"array"},"state":{"$ref":"#/components/schemas/CreateOrUpdateEntityState"}},"required":["adGroupId","expression","state"],"type":"object"},"CreateTargetingExpressionPredicate":{"properties":{"type":{"description":"Determines the type of targeting. Note that new values can be added to this list in the future. Support for the responses with newly addded values should be ensured for using them at the time of creation.\n| Predicate | Description |\n| --- | --- |\n| CONTENT_CATEGORY_SIMILAR_TO | Target the content genre that is similar to the specified genre |\n| ASIN_CATEGORY_SIMILAR_TO | Target the category that is similar to the specified category |","type":"string"},"value":{"description":"\"The value of the targeting predicate.\nExample for retail category `Arts, Crafts \u0026 Sewing`: \"2617941011\"\nExample for content categories \"amzn1.iab-content.483\"\n\n You can specify the following predicate values for CONTENT_CATEGORY_SIMILAR_TO expression type:\n| Description | Value |\n| --- | --- |\n| Action or Adventure | amzn1.iab-content.325 |\n| Animation or Anime | amzn1.iab-content.641 |\n| Biographies | amzn1.iab-content.44 |\n| Comedy | amzn1.iab-content.646 |\n| Documentary | amzn1.iab-content.332 |\n| Drama | amzn1.iab-content.647 |\n| Factual | amzn1.iab-content.648 |\n| Family or Children | amzn1.iab-content.645 |\n| Fantasy | amzn1.iab-content.335 |\n| History | amzn1.iab-content.EZWB7V |\n| Holiday | amzn1.iab-content.649 |\n| Horror | amzn1.iab-content.336 |\n| Lifestyle | amzn1.iab-content.TIFQA5 |\n| Music Video | amzn1.iab-content.650 |\n| Musical | amzn1.iab-content.156 |\n| Mystery | amzn1.iab-content.331 |\n| Reality TV | amzn1.iab-content.651 |\n| Romance | amzn1.iab-content.326 |\n| Science Fiction | amzn1.iab-content.652 |\n| Soap Opera | amzn1.iab-content.642 |\n| Special Interest (Indie or Art House) | amzn1.iab-content.643 |\n| Talk Show | amzn1.iab-content.A0AH3G |\n| True Crime | amzn1.iab-content.KHPC5A |\n|  Western | amzn1.iab-content.KHPC6A |\n| Young Adult | amzn1.iab-content.51 |\n| Video Game | amzn1.iab-content.680 |\n| News | amzn1.iab-content.1020 |\n| Sports | amzn1.iab-content.483 |\"","type":"string"}},"required":["type","value"],"type":"object"},"Creative":{"properties":{"adGroupId":{"description":"The identifier of the Ad Group to which this Creative is associated.","type":"string"},"assetId":{"description":"The unique identifier of the video asset in use.","type":"string"},"assetVersion":{"description":"The identifier of the particular video asset version.","type":"string"},"creativeId":{"description":"The Creative identifier.","type":"string"},"moderationStatus":{"$ref":"#/components/schemas/SponsoredTvCreativesModerationsStatus"}},"required":["adGroupId","assetId","assetVersion","creativeId","moderationStatus"],"type":"object"},"CreativeErrorType":{"description":"Creative Error Type","enum":["OTHER_ERROR","RANGE_ERROR"],"type":"string"},"CreativeFailureResponseItem":{"properties":{"errors":{"description":"A list of validation errors.","items":{"$ref":"#/components/schemas/CreativeMutationError"},"maxItems":100,"minItems":0,"type":"array"},"index":{"description":"The index of the creative in the array from the request body.","format":"int32","maximum":99,"minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"CreativeIdFilter":{"description":"Filter entities by the list of creativeIds.","properties":{"include":{"items":{"description":"Entity object identifier.","type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"CreativeMutationError":{"properties":{"errorType":{"$ref":"#/components/schemas/CreativeErrorType"},"errorValue":{"$ref":"#/components/schemas/CreativeMutationErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"CreativeMutationErrorSelector":{"properties":{"otherError":{"$ref":"#/components/schemas/OtherError"},"rangeError":{"$ref":"#/components/schemas/RangeError"}},"type":"object"},"CreativeMutationExceptionResponseContent":{"description":"Exception resulting in mutating creative management entities","properties":{"code":{"$ref":"#/components/schemas/InvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/CreativeMutationError"},"maxItems":100,"minItems":0,"type":"array"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"],"type":"object"},"CreativeSuccessResponseItem":{"properties":{"creative":{"$ref":"#/components/schemas/Creative"},"creativeId":{"description":"The creative ID.","type":"string"},"index":{"description":"The index of the creative in the array from the request body.","format":"int32","maximum":99,"minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"CreativesModerations":{"properties":{"adGroupId":{"description":"The identifier of the Ad Group to which this Creative is associated.","type":"string"},"creativeId":{"description":"The Creative identifier.","type":"string"},"etaForModeration":{"description":"Expected date and time by which moderation will be complete.","format":"date-time","type":"string"},"moderationStatus":{"$ref":"#/components/schemas/SponsoredTvCreativesModerationsStatus"},"reviewedVideoUrl":{"description":"Address of the video reviewed during moderation.","type":"string"}},"required":["adGroupId","creativeId","moderationStatus"],"type":"object"},"DateError":{"description":"Errors related to dates.","properties":{"cause":{"$ref":"#/components/schemas/ErrorCause"},"message":{"description":"Human readable error message.","type":"string"},"reason":{"$ref":"#/components/schemas/DateErrorReason"}},"required":["cause","message","reason"],"type":"object"},"DateErrorReason":{"description":"Date Error Reasons","enum":["END_DATE_EARLIER_THAN_TODAY","END_DATE_LATER_THAN_MAXIMUM","INVALID_DATE","OTHER","START_DATE_AFTER_END_DATE","START_DATE_EARLIER_THAN_TODAY","START_DATE_LATER_THAN_MAXIMUM","UPDATING_READ_ONLY_END_DATE","UPDATING_READ_ONLY_START_DATE"],"type":"string"},"DefaultBid":{"properties":{"bid":{"description":"The amount of the default bid associated with the ad group. Used if no bid is specified.","format":"double","type":"number"}},"type":"object"},"DeleteSponsoredTvAdGroupsRequestContent":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"}},"required":["adGroupIdFilter"],"type":"object"},"DeleteSponsoredTvAdGroupsResponseContent":{"properties":{"adGroups":{"$ref":"#/components/schemas/BulkAdGroupsOperationResponse"}},"type":"object"},"DeleteSponsoredTvAdsRequestContent":{"properties":{"adIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"}},"required":["adIdFilter"],"type":"object"},"DeleteSponsoredTvAdsResponseContent":{"properties":{"ads":{"$ref":"#/components/schemas/BulkAdsOperationResponse"}},"type":"object"},"DeleteSponsoredTvCampaignsRequestContent":{"properties":{"campaignIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"}},"required":["campaignIdFilter"],"type":"object"},"DeleteSponsoredTvCampaignsResponseContent":{"properties":{"campaigns":{"$ref":"#/components/schemas/BulkCampaignOperationResponse"}},"type":"object"},"DeleteSponsoredTvLocationsRequestContent":{"properties":{"locationExpressionIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"}},"required":["locationExpressionIdFilter"],"type":"object"},"DeleteSponsoredTvLocationsResponseContent":{"properties":{"locations":{"$ref":"#/components/schemas/BulkLocationOperationResponse"}},"required":["locations"],"type":"object"},"DeleteSponsoredTvTargetingClausesRequestContent":{"properties":{"targetIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"}},"required":["targetIdFilter"],"type":"object"},"DeleteSponsoredTvTargetingClausesResponseContent":{"properties":{"targetingClauses":{"$ref":"#/components/schemas/BulkTargetingClauseOperationResponse"}},"required":["targetingClauses"],"type":"object"},"EntityState":{"description":"The current resource state.","enum":["ARCHIVED","ENABLED","PAUSED"],"type":"string"},"EntityStateFilter":{"description":"Filter entities by state.","properties":{"include":{"items":{"$ref":"#/components/schemas/EntityState"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"ErrorCause":{"description":"Structure describing error cause - location in the payload and data causing error.","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"],"type":"object"},"Experience":{"description":"The advertiser experience type for a given preview video.","properties":{"callToAction":{"$ref":"#/components/schemas/CallToAction"},"interactivity":{"description":"The types of interactivity experiences Sponsored TV supports. Possible values:\n- BASE: viewers cannot have any interaction with the video\n- CLICKABLE: viewers can interact by directly clicking the button on the video\n- REMOTE: viewers can interact via the pressable button on the video by pressing OK using the remote control\n- REMOTE_CONFIRMATION: viewers can see a confirmation overlay after they press OK using the remote control\n- QR: viewers can interact by scanning the QR code on the video\n\nPlease note: we only support the BASE interactivity experience at this moment.","type":"string"}},"required":["callToAction","interactivity"],"type":"object"},"Forecast":{"properties":{"metric":{"$ref":"#/components/schemas/ForecastMetricType"},"value":{"$ref":"#/components/schemas/ForecastValue"}},"type":"object"},"ForecastAd":{"description":"Simplified Ad for Forecast. Asin and sku used for vendors and sellers","properties":{"landingPageType":{"description":"The landing page type of the Ad. Forecast only use ASIN_DP or SKU_DP with asin or sku value in the\n`landingPageValue` field","type":"string"},"landingPageValue":{"description":"The landing page for the Ad","type":"string"}},"required":["landingPageType","landingPageValue"],"type":"object"},"ForecastAdGroup":{"description":"Simplified AdGroup needed for Forecast","properties":{"defaultBid":{"$ref":"#/components/schemas/DefaultBid"}},"type":"object"},"ForecastCampaign":{"description":"Simplified Campaign needed for Forecast","properties":{"budgetSettings":{"$ref":"#/components/schemas/BudgetSettings"},"campaignId":{"description":"The identifier of the forecast campaign.","type":"string"},"costType":{"description":"Support for the responses with newly added values should be ensured for using them at the time of creation or updates.\n\n| Type | Description |\n| --- | --- |\n| \"CPM\" | [Default] The performance of the campaign will be measured per 1000 impressions |","type":"string"},"endDate":{"description":"The yyyy-MM-dd\u0027T\u0027hh:mm:ss\u0027Z\u0027 end date for the campaign in forecast. Must be greater than the value for startDate.\nIf not specified, the campaign has no end date and runs continuously.","format":"date-time","type":"string"},"startDate":{"description":"The yyyy-MM-dd\u0027T\u0027hh:mm:ss\u0027Z\u0027 start date for the campaign in forecast. If this field is not set to a value, the current date is used.","format":"date-time","type":"string"},"targetingType":{"$ref":"#/components/schemas/TargetingType"}},"required":["budgetSettings","startDate"],"type":"object"},"ForecastCreative":{"description":"Simplified Creative needed for Forecast","properties":{"adGroupId":{"description":"The identifier of the ad group to which this creative is associated.","type":"string"},"assetId":{"description":"The unique identifier of the video asset in use.","type":"string"},"assetVersion":{"description":"The identifier of the particular video asset version.","type":"string"},"creativeId":{"description":"The creative identifier.","type":"string"},"videoDuration":{"description":"The duration time of the creative","format":"int32","type":"integer"}},"required":["videoDuration"],"type":"object"},"ForecastErrorItem":{"properties":{"errorType":{"$ref":"#/components/schemas/ForecastErrorType"},"errorValue":{"$ref":"#/components/schemas/ForecastErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"ForecastErrorSelector":{"properties":{"forecastModelError":{"$ref":"#/components/schemas/ForecastModelError"},"forecastOtherError":{"$ref":"#/components/schemas/ForecastOtherError"},"forecastRulesError":{"$ref":"#/components/schemas/ForecastRulesError"},"forecastValidationError":{"$ref":"#/components/schemas/ForecastValidationError"}},"type":"object"},"ForecastErrorType":{"description":"Forecast Error Type","enum":["FORECAST_MODEL_ERROR","FORECAST_OTHER_ERROR","FORECAST_RULES_ERROR","FORECAST_VALIDATION_ERROR"],"type":"string"},"ForecastExceptionResponseContent":{"description":"Bad Request exception resulting in errors in ST forecast","properties":{"code":{"$ref":"#/components/schemas/InvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/ForecastErrorItem"},"maxItems":100,"minItems":0,"type":"array"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"],"type":"object"},"ForecastLocationTargetingClause":{"description":"Simplified Location Targeting Clause for Forecast","properties":{"category":{"description":"The category of the location, including DMA, CITY, POSTAL_CODE and so on.","type":"string"},"locationId":{"description":"The Location Geo ACI (Amazon Common Identifier).","type":"string"},"locationIdResolved":{"description":"The human readable location information.","type":"string"}},"required":["locationId"],"type":"object"},"ForecastMetricType":{"description":"Forecast Result Types","enum":["CLICKS","DETAIL_PAGE_VIEWS","IMPRESSIONS","REACH"],"type":"string"},"ForecastModelError":{"description":"Forecast Errors related to forecast model","properties":{"cause":{"$ref":"#/components/schemas/ErrorCause"},"message":{"description":"Human readable error message.","type":"string"},"reason":{"description":"Reason for forecast model error","type":"string"}},"required":["cause","message","reason"],"type":"object"},"ForecastOtherError":{"description":"Forecast Errors just targeting on the general forecast error type","properties":{"cause":{"$ref":"#/components/schemas/ErrorCause"},"message":{"description":"Human readable error message.","type":"string"},"reason":{"description":"Reason for forecast other error","type":"string"}},"required":["cause","message","reason"],"type":"object"},"ForecastRulesError":{"description":"Forecast Errors related to forecast rules as too broad or too narrow","properties":{"cause":{"$ref":"#/components/schemas/ErrorCause"},"message":{"description":"Human readable error message.","type":"string"},"reason":{"description":"Reason for forecast rules error","type":"string"}},"required":["cause","message","reason"],"type":"object"},"ForecastTargetingClause":{"description":"Simplified Targeting Clause for Forecast, which only list of Targeting Expression and bid price","properties":{"bid":{"description":"The bid for ads sourced using the target.\nThe US marketplace has a default bid of $15 CPM","format":"double","type":"number"},"expression":{"description":"The targeting expression.","items":{"$ref":"#/components/schemas/TargetingExpressionPredicate"},"maxItems":100,"minItems":0,"type":"array"}},"required":["expression"],"type":"object"},"ForecastValidationError":{"description":"Errors related to forecast input validation errors","properties":{"cause":{"$ref":"#/components/schemas/ErrorCause"},"message":{"description":"Human readable error message.","type":"string"},"reason":{"description":"Reason for validation fields error in forecast","type":"string"}},"required":["cause","message","reason"],"type":"object"},"ForecastValue":{"properties":{"max":{"format":"int64","type":"integer"},"min":{"format":"int64","type":"integer"}},"type":"object"},"InternalErrorErrorCode":{"enum":["INTERNAL_ERROR"],"type":"string"},"InternalServerExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/InternalErrorErrorCode"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"],"type":"object"},"InvalidArgumentError":{"properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"$ref":"#/components/schemas/InvalidArgumentErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"InvalidArgumentErrorCode":{"enum":["INVALID_ARGUMENT"],"type":"string"},"InvalidArgumentErrorSelector":{"properties":{"otherError":{"$ref":"#/components/schemas/OtherError"},"rangeError":{"$ref":"#/components/schemas/RangeError"}},"type":"object"},"InvalidArgumentExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/InvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/InvalidArgumentError"},"maxItems":100,"minItems":0,"type":"array"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"],"type":"object"},"ListSponsoredTvAdGroupsRequestContent":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"},"fullFunnelCampaignIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API.","format":"int32","maximum":100,"minimum":1,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/NameFilter"},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"stateFilter":{"$ref":"#/components/schemas/EntityStateFilter"}},"type":"object"},"ListSponsoredTvAdGroupsResponseContent":{"properties":{"adGroups":{"items":{"$ref":"#/components/schemas/AdGroup"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"totalCount":{"description":"The total number of entities.","format":"int32","type":"integer"}},"type":"object"},"ListSponsoredTvAdsRequestContent":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"},"adIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"},"fullFunnelCampaignIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API.","format":"int32","maximum":100,"minimum":1,"type":"integer"},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"stateFilter":{"$ref":"#/components/schemas/EntityStateFilter"}},"type":"object"},"ListSponsoredTvAdsResponseContent":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/Ad"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"totalCount":{"description":"The total number of entities.","format":"int32","type":"integer"}},"type":"object"},"ListSponsoredTvCampaignsRequestContent":{"properties":{"campaignIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"},"fullFunnelCampaignIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API.","format":"int32","maximum":100,"minimum":1,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/NameFilter"},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"stateFilter":{"$ref":"#/components/schemas/EntityStateFilter"}},"type":"object"},"ListSponsoredTvCampaignsResponseContent":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/Campaign"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"totalCount":{"description":"The total number of entities.","format":"int32","type":"integer"}},"type":"object"},"ListSponsoredTvCreativesModerationsPolicyViolationsRequestContent":{"properties":{"creativeIdFilter":{"$ref":"#/components/schemas/CreativeIdFilter"},"locale":{"$ref":"#/components/schemas/Locale"},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API.","format":"int32","maximum":100,"minimum":1,"type":"integer"},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"}},"required":["creativeIdFilter"],"type":"object"},"ListSponsoredTvCreativesModerationsPolicyViolationsResponseContent":{"properties":{"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"policyViolations":{"items":{"$ref":"#/components/schemas/SponsoredTvPolicyViolation"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"ListSponsoredTvCreativesModerationsRequestContent":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"},"creativeIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"},"locale":{"$ref":"#/components/schemas/Locale"},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API.","format":"int32","maximum":100,"minimum":1,"type":"integer"},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"}},"type":"object"},"ListSponsoredTvCreativesModerationsResponseContent":{"properties":{"creativesModerations":{"items":{"$ref":"#/components/schemas/CreativesModerations"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"}},"type":"object"},"ListSponsoredTvCreativesRequestContent":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"},"creativeIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"},"fullFunnelCampaignIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API.","format":"int32","maximum":100,"minimum":1,"type":"integer"},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"}},"type":"object"},"ListSponsoredTvCreativesResponseContent":{"properties":{"creatives":{"items":{"$ref":"#/components/schemas/Creative"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"totalResults":{"description":"The total number of creative entities.","format":"int32","type":"integer"}},"type":"object"},"ListSponsoredTvLocationsRequestContent":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"},"locationExpressionIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"},"maxResults":{"description":"Number of records to include in the Locations paginated response. Defaults to max page size for given API.","format":"int32","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"}},"type":"object"},"ListSponsoredTvLocationsResponseContent":{"properties":{"locations":{"items":{"$ref":"#/components/schemas/Location"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"totalResults":{"description":"The total number of entities.","format":"int32","type":"integer"}},"type":"object"},"ListSponsoredTvTargetingClausesRequestContent":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"},"fullFunnelCampaignIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API.","format":"int32","maximum":100,"minimum":1,"type":"integer"},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"stateFilter":{"$ref":"#/components/schemas/EntityStateFilter"},"targetIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"}},"type":"object"},"ListSponsoredTvTargetingClausesResponseContent":{"properties":{"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"targetingClauses":{"items":{"$ref":"#/components/schemas/TargetingClause"},"maxItems":100,"minItems":0,"type":"array"},"totalResults":{"description":"The total number of entities.","format":"int32","type":"integer"}},"type":"object"},"Locale":{"description":"Locale\nLocale string as described in [BCP 47](https://tools.ietf.org/html/bcp47). For example, `en-US`","enum":["ar-AE","de-DE","en-AE","en-AU","en-BR","en-CA","en-DE","en-ES","en-FR","en-GB","en-IN","en-IT","en-JP","en-SG","en-US","es-ES","es-MX","fr-CA","fr-FR","hi-IN","it-IT","ja-JP","ko-KR","nl-NL","pt-BR","zh-CN"],"type":"string"},"Location":{"properties":{"adGroupId":{"description":"The identifier of the Ad Group to which this Location is associated.","type":"string"},"campaignId":{"description":"The identifier of the Campaign associated with the Ad Group.","type":"string"},"locationExpressionId":{"description":"The Location identifier.","type":"string"},"locationId":{"description":"The Location Geo ACI (Amazon Common Identifier).","type":"string"},"locationIdResolved":{"description":"A human-readable location text.","type":"string"}},"required":["adGroupId","campaignId","locationExpressionId","locationId"],"type":"object"},"LocationError":{"description":"Errors related to location validation","properties":{"cause":{"$ref":"#/components/schemas/ErrorCause"},"message":{"description":"Human readable error message.","type":"string"},"reason":{"description":"Reason for validation fields error in location","type":"string"}},"required":["message","reason"],"type":"object"},"LocationErrorSelector":{"properties":{"locationError":{"$ref":"#/components/schemas/LocationError"},"otherError":{"$ref":"#/components/schemas/OtherError"}},"type":"object"},"LocationErrorType":{"description":"Location Error Type","enum":["LOCATION_ERROR","OTHER_ERROR"],"type":"string"},"LocationFailureResponseItem":{"properties":{"errors":{"description":"A list of validation errors.","items":{"$ref":"#/components/schemas/LocationMutationError"},"maxItems":100,"minItems":0,"type":"array"},"index":{"description":"The index of the location in the array from the request body.","format":"int32","maximum":99,"minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"LocationMutationError":{"properties":{"errorType":{"$ref":"#/components/schemas/LocationErrorType"},"errorValue":{"$ref":"#/components/schemas/LocationErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"LocationMutationExceptionResponseContent":{"description":"Exception resulting in mutating campaign management entities","properties":{"code":{"$ref":"#/components/schemas/InvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/LocationMutationError"},"maxItems":100,"minItems":0,"type":"array"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"],"type":"object"},"LocationSuccessResponseItem":{"properties":{"index":{"description":"The index of the location in the array from the request body.","format":"int32","maximum":99,"minimum":0,"type":"integer"},"location":{"$ref":"#/components/schemas/Location"}},"required":["index"],"type":"object"},"NameFilter":{"description":"Filter entities by name\n\nNote: Names including single quotes must be escaped.\nFor example, to filter for `Campaign \u0027A\u0027`,\nprovide the following filter array:\n`[\"Campaign \u0027\\\u0027\u0027A\u0027\\\u0027\u0027\"]`","properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/QueryTermMatchType"}},"required":["include"],"type":"object"},"ObjectIdFilter":{"description":"Filter entities by the list of objectIds.","properties":{"include":{"items":{"description":"Entity object identifier.","type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"OtherError":{"description":"Errors not related to any of the other error types","properties":{"cause":{"$ref":"#/components/schemas/ErrorCause"},"message":{"description":"Human readable error message.","type":"string"},"reason":{"$ref":"#/components/schemas/OtherErrorReason"}},"required":["cause","message","reason"],"type":"object"},"OtherErrorReason":{"description":"Other Error Reasons","enum":["OTHER_ERROR"],"type":"string"},"PreviewConfiguration":{"description":"Configuration settings for the preview.","properties":{"asin":{"description":"Amazon Standard Identification Number: The code that identifies the product being advertised. You must provide either `asin` or `sku`. `asin` cannot be used in conjunction with `sku`.","type":"string"},"callToAction":{"$ref":"#/components/schemas/CallToAction"},"callToActionPosition":{"$ref":"#/components/schemas/CallToActionPosition"},"safeZoneEnabled":{"description":"Whether or not to see the safe zone as an overlay (true (default) | false).","type":"boolean"},"sku":{"description":"Stock Keeping Unit: The unique identifier for the product being advertised. You must provide either `asin` or `sku`.`sku` cannot be used in conjunction with `asin`.","type":"string"}},"type":"object"},"PreviewHtml":{"description":"The experience type and HTML for a given preview video","properties":{"experience":{"$ref":"#/components/schemas/Experience"},"html":{"description":"The HTML for one preview video.","type":"string"}},"required":["experience","html"],"type":"object"},"PreviewSponsoredTvCreativeRequestContent":{"properties":{"assetProperties":{"$ref":"#/components/schemas/AssetProperties"},"creativeId":{"description":"The unique identifier of the creative to preview. You must provide either `creativeId` or `assetProperties`. `creativeId` cannot be used in conjunction with `assetProperties`.","type":"string"},"previewConfiguration":{"$ref":"#/components/schemas/PreviewConfiguration"}},"required":["previewConfiguration"],"type":"object"},"PreviewSponsoredTvCreativeResponseContent":{"properties":{"previewHtmls":{"description":"The list of HTMLs for all the requested preview videos.","items":{"$ref":"#/components/schemas/PreviewHtml"},"maxItems":20,"minItems":0,"type":"array"}},"required":["previewHtmls"],"type":"object"},"QueryTermMatchType":{"description":"Match type for query filters.\nBROAD_MATCH: Match if the queried value contains the filter value. (substring matching)\nEXACT_MATCH: Match if the queried value is exactly equivalent to the filter value.","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"RangeError":{"description":"Errors related to range constraints and violations","properties":{"allowed":{"description":"Allowed values","items":{"type":"string"},"maxItems":20,"minItems":0,"type":"array"},"cause":{"$ref":"#/components/schemas/ErrorCause"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"},"reason":{"$ref":"#/components/schemas/RangeErrorReason"},"upperLimit":{"description":"Optional upper limit.","type":"string"}},"required":["cause","message","reason"],"type":"object"},"RangeErrorReason":{"description":"Range Error Reason","enum":["INVALID_ENUM_VALUE","NOT_IN_LIST","OTHER","TOO_HIGH","TOO_LOW"],"type":"string"},"RecurrenceType":{"description":"The time period over which the amount specified in the `budget` property is allocated.\nSet to `DAILY` by default, if empty value is provided","enum":["DAILY"],"type":"string"},"SponsoredTvCreativesModerationsStatus":{"description":"Moderation status of a creative.\nAPPROVED: Moderation of the creative is complete\nPENDING_REVIEW: Moderation of the creative is in progress. The expected date and time for completion are specified in the `etaForModeration` field.\nREJECTED: The creative has failed moderation. Specific information about the content and that violated policy is available in policyViolations.","enum":["APPROVED","PENDING_REVIEW","REJECTED"],"type":"string"},"SponsoredTvForecastsRequestContent":{"properties":{"adGroup":{"$ref":"#/components/schemas/ForecastAdGroup"},"ads":{"description":"list of product Ads specified in ST forecast.","items":{"$ref":"#/components/schemas/ForecastAd"},"maxItems":100,"minItems":1,"type":"array"},"campaign":{"$ref":"#/components/schemas/ForecastCampaign"},"creative":{"$ref":"#/components/schemas/ForecastCreative"},"locationTargetingClauses":{"description":"list of location targeting clauses specified in ST forecast","items":{"$ref":"#/components/schemas/ForecastLocationTargetingClause"},"maxItems":1000,"minItems":0,"type":"array"},"targetingClauses":{"description":"list of targeting clauses specified in ST forecast.","items":{"$ref":"#/components/schemas/ForecastTargetingClause"},"maxItems":100,"minItems":1,"type":"array"}},"required":["adGroup","ads","campaign","targetingClauses"],"type":"object"},"SponsoredTvForecastsResponseContent":{"properties":{"weeklyForecasts":{"description":"the weekly forecast response include in a list","items":{"$ref":"#/components/schemas/Forecast"},"maxItems":4,"minItems":1,"type":"array"}},"type":"object"},"SponsoredTvPolicyViolation":{"properties":{"policyDescription":{"description":"A human-readable description of the policy.","type":"string"},"policyLinkUrl":{"description":"Address of the policy documentation. Follow the link to learn more about the specified policy.","type":"string"},"videoEvidences":{"description":"An array of start and end times in seconds for the given policy violation. While there may be more than 15 video evidences, this API will retrieve at most 15.","items":{"$ref":"#/components/schemas/SponsoredTvViolatingVideoEvidence"},"maxItems":15,"minItems":0,"type":"array"}},"type":"object"},"SponsoredTvViolatingVideoEvidence":{"properties":{"end":{"description":"Time in seconds at which policy violation within the video asset ends.","format":"int32","type":"integer"},"start":{"description":"Time in seconds at which policy violation within the video asset starts.","format":"int32","type":"integer"}},"type":"object"},"Tags":{"additionalProperties":{"type":"string"},"description":"A list of advertiser-specified custom identifiers for the Campaign. Each customer identifier is a key-value pair. Supports up to 50 custom identifiers.\n\nFunctionality varies by date and advertiser type:\n\nAfter March 4th 2025 (2025-03-04):\n* Endemic Advertisers: Fully functional\n* Non-Endemic Advertisers: This field will no longer be processed - any provided values will be ignored\n\nAfter June 30th 2025 (2025-05-30): For all advertisers, this field will no longer be processed - any provided values will be ignored\n\nNote: The field remains in the API for backwards compatibility but has no effect after the dates specified above.\nIf you are currently using this field, you should remove the implementation as the values are not being processed.","maxProperties":50,"minProperties":0,"type":"object"},"TargetMutationError":{"properties":{"errorType":{"$ref":"#/components/schemas/TargetingClauseErrorType"},"errorValue":{"$ref":"#/components/schemas/TargetMutationErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"TargetMutationErrorSelector":{"properties":{"biddingError":{"$ref":"#/components/schemas/BiddingError"},"billingError":{"$ref":"#/components/schemas/BillingError"},"otherError":{"$ref":"#/components/schemas/OtherError"},"rangeError":{"$ref":"#/components/schemas/RangeError"}},"type":"object"},"TargetMutationExceptionResponseContent":{"description":"Exception resulting in mutating campaign management entities","properties":{"code":{"$ref":"#/components/schemas/InvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/TargetMutationError"},"maxItems":100,"minItems":0,"type":"array"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"],"type":"object"},"TargetServingStatus":{"enum":["ACCOUNT_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_EXCEED_SPENDS_LIMIT","ADVERTISER_PAUSED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_STATUS_ENABLED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","AD_GROUP_PAUSED","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_STATUS_ENABLED","AD_POLICING_PENDING_REVIEW","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","CAMPAIGN_PAUSED","ENDED","INELIGIBLE","OTHER","PENDING_START_DATE","STATUS_UNAVAILABLE","TARGETING_CLAUSE_ARCHIVED","TARGETING_CLAUSE_BLOCKED","TARGETING_CLAUSE_PAUSED","TARGETING_CLAUSE_POLICING_SUSPENDED","TARGETING_CLAUSE_STATUS_LIVE"],"type":"string"},"TargetingClause":{"properties":{"adGroupId":{"description":"The identifier of the Ad Group to which this Targeting Clause is associated.","type":"string"},"bid":{"deprecated":true,"description":"This shape is deprecated: The bid for Ads sourced using the Targeting Clause. This field will no longer be supported as bids are now only supported at an adGroup level","format":"double","type":"number"},"campaignId":{"description":"The identifier of the Campaign associated with the Ad.","type":"string"},"expression":{"description":"The targeting expression.","items":{"$ref":"#/components/schemas/TargetingExpressionPredicate"},"maxItems":100,"minItems":0,"type":"array"},"extendedData":{"$ref":"#/components/schemas/TargetingClauseExtendedData"},"resolvedExpression":{"description":"A human-readable target text.","items":{"$ref":"#/components/schemas/TargetingResolvedExpressionPredicate"},"maxItems":100,"minItems":0,"type":"array"},"state":{"$ref":"#/components/schemas/EntityState"},"targetId":{"description":"The Targeting Clause ID.","type":"string"}},"required":["adGroupId","campaignId","expression","state","targetId"],"type":"object"},"TargetingClauseErrorType":{"description":"TargetingClause Error Type","enum":["BIDDING_ERROR","BILLING_ERROR","OTHER_ERROR","RANGE_ERROR"],"type":"string"},"TargetingClauseExtendedData":{"properties":{"creationDate":{"description":"The date in ISO 8601 format.","format":"date-time","type":"string"},"lastUpdateDate":{"description":"The date in ISO 8601 format.","format":"date-time","type":"string"},"servingStatus":{"$ref":"#/components/schemas/TargetServingStatus"}},"type":"object"},"TargetingClauseFailureResponseItem":{"properties":{"errors":{"description":"A list of validation errors","items":{"$ref":"#/components/schemas/TargetMutationError"},"maxItems":100,"minItems":0,"type":"array"},"index":{"description":"the index of the targetingClause in the array from the request body","format":"int32","maximum":99,"minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"TargetingClauseSuccessResponseItem":{"properties":{"index":{"description":"the index of the targetingClause in the array from the request body","format":"int32","maximum":99,"minimum":0,"type":"integer"},"targetId":{"description":"the targetingClause ID","type":"string"},"targetingClause":{"$ref":"#/components/schemas/TargetingClause"}},"required":["index"],"type":"object"},"TargetingExpressionPredicate":{"properties":{"type":{"type":"string"},"value":{"description":"\"The value of the targeting predicate.\nExample for retail category `Arts, Crafts \u0026 Sewing`: \"2617941011\"\nExample for content categories \"amzn1.iab-content.483\"\n\n You can specify the following predicate values for CONTENT_CATEGORY_SIMILAR_TO expression type:\n| Description | Value |\n| --- | --- |\n| Action or Adventure | amzn1.iab-content.325 |\n| Animation or Anime | amzn1.iab-content.641 |\n| Biographies | amzn1.iab-content.44 |\n| Comedy | amzn1.iab-content.646 |\n| Documentary | amzn1.iab-content.332 |\n| Drama | amzn1.iab-content.647 |\n| Factual | amzn1.iab-content.648 |\n| Family or Children | amzn1.iab-content.645 |\n| Fantasy | amzn1.iab-content.335 |\n| History | amzn1.iab-content.EZWB7V |\n| Holiday | amzn1.iab-content.649 |\n| Horror | amzn1.iab-content.336 |\n| Lifestyle | amzn1.iab-content.TIFQA5 |\n| Music Video | amzn1.iab-content.650 |\n| Musical | amzn1.iab-content.156 |\n| Mystery | amzn1.iab-content.331 |\n| Reality TV | amzn1.iab-content.651 |\n| Romance | amzn1.iab-content.326 |\n| Science Fiction | amzn1.iab-content.652 |\n| Soap Opera | amzn1.iab-content.642 |\n| Special Interest (Indie or Art House) | amzn1.iab-content.643 |\n| Talk Show | amzn1.iab-content.A0AH3G |\n| True Crime | amzn1.iab-content.KHPC5A |\n|  Western | amzn1.iab-content.KHPC6A |\n| Young Adult | amzn1.iab-content.51 |\n| Video Game | amzn1.iab-content.680 |\n| News | amzn1.iab-content.1020 |\n| Sports | amzn1.iab-content.483 |\"","type":"string"}},"type":"object"},"TargetingResolvedExpressionPredicate":{"properties":{"type":{"type":"string"},"value":{"description":"\"The human-readable value of the targeting predicate.\nExample for retail category \"2617941011\": `Arts, Crafts \u0026 Sewing`\nExample for content categories \"Sports\"\n\n You can specify the following predicate values for CONTENT_CATEGORY_SIMILAR_TO expression type:\n| Description | Value |\n| --- | --- |\n| Action or Adventure | amzn1.iab-content.325 |\n| Animation or Anime | amzn1.iab-content.641 |\n| Biographies | amzn1.iab-content.44 |\n| Comedy | amzn1.iab-content.646 |\n| Documentary | amzn1.iab-content.332 |\n| Drama | amzn1.iab-content.647 |\n| Factual | amzn1.iab-content.648 |\n| Family or Children | amzn1.iab-content.645 |\n| Fantasy | amzn1.iab-content.335 |\n| History | amzn1.iab-content.EZWB7V |\n| Holiday | amzn1.iab-content.649 |\n| Horror | amzn1.iab-content.336 |\n| Lifestyle | amzn1.iab-content.TIFQA5 |\n| Music Video | amzn1.iab-content.650 |\n| Musical | amzn1.iab-content.156 |\n| Mystery | amzn1.iab-content.331 |\n| Reality TV | amzn1.iab-content.651 |\n| Romance | amzn1.iab-content.326 |\n| Science Fiction | amzn1.iab-content.652 |\n| Soap Opera | amzn1.iab-content.642 |\n| Special Interest (Indie or Art House) | amzn1.iab-content.643 |\n| Talk Show | amzn1.iab-content.A0AH3G |\n| True Crime | amzn1.iab-content.KHPC5A |\n|  Western | amzn1.iab-content.KHPC6A |\n| Young Adult | amzn1.iab-content.51 |\n| Video Game | amzn1.iab-content.680 |\n| News | amzn1.iab-content.1020 |\n| Sports | amzn1.iab-content.483 |\"","type":"string"}},"type":"object"},"TargetingType":{"description":"The targeting strategy of the Campaign. If targetingType is not specified, MANUAL will be used.","enum":["AUTO_RELEVANT_TO_MY_BUSINESS","MANUAL"],"type":"string"},"ThrottledErrorCode":{"enum":["THROTTLED"],"type":"string"},"ThrottlingExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ThrottledErrorCode"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"],"type":"object"},"UnauthorizedErrorCode":{"description":"Error codes reported on top level exceptions\nthey correspond HTTP protocol level response codes","enum":["UNAUTHORIZED"],"type":"string"},"UnauthorizedExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/UnauthorizedErrorCode"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"],"type":"object"},"UpdateAd":{"properties":{"adId":{"description":"The Ad identifier.","type":"string"},"adName":{"description":"The name of the Ad.","type":"string"},"state":{"$ref":"#/components/schemas/CreateOrUpdateEntityState"}},"required":["adId"],"type":"object"},"UpdateAdGroup":{"properties":{"adGroupId":{"description":"The Ad Group ID.","type":"string"},"defaultBid":{"$ref":"#/components/schemas/DefaultBid"},"name":{"description":"The name of the Ad Group.","maxLength":255,"minLength":1,"type":"string"},"state":{"$ref":"#/components/schemas/CreateOrUpdateEntityState"}},"required":["adGroupId"],"type":"object"},"UpdateCampaign":{"properties":{"budgetSettings":{"$ref":"#/components/schemas/BudgetSettings"},"campaignId":{"description":"The identifier of the Campaign.","type":"string"},"costType":{"description":"Cost type of the Campaign. Determines how the campaign will bid and charge. Note that new values can be added to this list in the future. Support for the responses with newly addded values should be ensured for using them at the time of creation or updates.\n\n| Type | Description |\n| --- | --- |\n| \"CPM\" | [Default] The performance of the campaign will be measured per 1000 impresions |","type":"string"},"endDate":{"description":"endDate is optional. If endDate is specified, startDate must be specified as well.","format":"date-time","type":"string"},"name":{"description":"The name of the Campaign.\n\nNote: Names including single quotes must be escaped.\nFor example, to update the name to `Campaign \u0027A\u0027`,\nthe name field should be as follows:\n`\"name\": \"Campaign \u0027\\\u0027\u0027A\u0027\\\u0027\u0027\"`","maxLength":128,"minLength":1,"type":"string"},"startDate":{"description":"startDate can only be changed if the current startDate is in the future.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/CreateOrUpdateEntityState"},"tags":{"$ref":"#/components/schemas/Tags"}},"required":["campaignId"],"type":"object"},"UpdateCreative":{"properties":{"assetId":{"description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library.","type":"string"},"assetVersion":{"description":"The identifier of the particular video asset version.","type":"string"},"creativeId":{"description":"The Creative identifier.","type":"string"}},"required":["assetId","assetVersion","creativeId"],"type":"object"},"UpdateSponsoredTvAdGroupsRequestContent":{"properties":{"adGroups":{"description":"An array of Sponsored TV ad groups.","items":{"$ref":"#/components/schemas/UpdateAdGroup"},"maxItems":100,"minItems":1,"type":"array"}},"required":["adGroups"],"type":"object"},"UpdateSponsoredTvAdGroupsResponseContent":{"properties":{"adGroups":{"$ref":"#/components/schemas/BulkAdGroupsOperationResponse"}},"type":"object"},"UpdateSponsoredTvAdsRequestContent":{"properties":{"ads":{"description":"An array of Sponsored TV ads.","items":{"$ref":"#/components/schemas/UpdateAd"},"maxItems":100,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"},"UpdateSponsoredTvAdsResponseContent":{"properties":{"ads":{"$ref":"#/components/schemas/BulkAdsOperationResponse"}},"type":"object"},"UpdateSponsoredTvCampaignsRequestContent":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/UpdateCampaign"},"maxItems":100,"minItems":1,"type":"array"}},"required":["campaigns"],"type":"object"},"UpdateSponsoredTvCampaignsResponseContent":{"properties":{"campaigns":{"$ref":"#/components/schemas/BulkCampaignOperationResponse"}},"type":"object"},"UpdateSponsoredTvCreativesRequestContent":{"properties":{"creatives":{"description":"An array of creatives.","items":{"$ref":"#/components/schemas/UpdateCreative"},"maxItems":100,"minItems":1,"type":"array"}},"required":["creatives"],"type":"object"},"UpdateSponsoredTvCreativesResponseContent":{"properties":{"creatives":{"$ref":"#/components/schemas/BulkCreativeOperationResponse"}},"required":["creatives"],"type":"object"},"UpdateSponsoredTvTargetingClausesRequestContent":{"properties":{"targetingClauses":{"description":"An array of targetingClauses.","items":{"$ref":"#/components/schemas/UpdateTargetingClause"},"maxItems":100,"minItems":1,"type":"array"}},"required":["targetingClauses"],"type":"object"},"UpdateSponsoredTvTargetingClausesResponseContent":{"properties":{"targetingClauses":{"$ref":"#/components/schemas/BulkTargetingClauseOperationResponse"}},"required":["targetingClauses"],"type":"object"},"UpdateTargetingClause":{"properties":{"bid":{"deprecated":true,"description":"This shape is deprecated: The bid for Ads sourced using the Targeting Clause. This field will no longer be supported as bids are now only supported at an adGroup level.","format":"double","type":"number"},"state":{"$ref":"#/components/schemas/CreateOrUpdateEntityState"},"targetId":{"description":"The Targeting Clause ID.","type":"string"}},"required":["state","targetId"],"type":"object"}},"securitySchemes":{}},"info":{"description":"This API allows users to perform Sponsored TV operations.","title":"Sponsored TV","version":"3.0"},"openapi":"3.0.1","paths":{"/st/adGroups":{"post":{"description":"Creates Sponsored Tv Ad Groups.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredTvAdGroups","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","type":"string"}}],"requestBody":{"content":{"application/vnd.stAdGroup.v1+json":{"schema":{"$ref":"#/components/schemas/CreateSponsoredTvAdGroupsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.stAdGroup.v1+json":{"schema":{"$ref":"#/components/schemas/CreateSponsoredTvAdGroupsResponseContent"}}},"description":"CreateSponsoredTvAdGroups 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call.","schema":{"description":"Header containing preferences applied while processing API call.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdGroupMutationExceptionResponseContent"}}},"description":"AdGroupMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["AdGroups"]},"put":{"description":"Updates Sponsored Tv Ad Groups.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdateSponsoredTvAdGroups","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","type":"string"}}],"requestBody":{"content":{"application/vnd.stAdGroup.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateSponsoredTvAdGroupsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.stAdGroup.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateSponsoredTvAdGroupsResponseContent"}}},"description":"UpdateSponsoredTvAdGroups 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call.","schema":{"description":"Header containing preferences applied while processing API call.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdGroupMutationExceptionResponseContent"}}},"description":"AdGroupMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["AdGroups"]}},"/st/adGroups/delete":{"post":{"description":"Deletes Sponsored Tv Ad Groups.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"DeleteSponsoredTvAdGroups","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","type":"string"}}],"requestBody":{"content":{"application/vnd.stAdGroup.v1+json":{"schema":{"$ref":"#/components/schemas/DeleteSponsoredTvAdGroupsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.stAdGroup.v1+json":{"schema":{"$ref":"#/components/schemas/DeleteSponsoredTvAdGroupsResponseContent"}}},"description":"DeleteSponsoredTvAdGroups 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call.","schema":{"description":"Header containing preferences applied while processing API call.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdGroupMutationExceptionResponseContent"}}},"description":"AdGroupMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["AdGroups"]}},"/st/adGroups/list":{"post":{"description":"Lists Sponsored Tv Ad Groups.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListSponsoredTvAdGroups","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","type":"string"}}],"requestBody":{"content":{"application/vnd.stAdGroup.v1+json":{"schema":{"$ref":"#/components/schemas/ListSponsoredTvAdGroupsRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.stAdGroup.v1+json":{"schema":{"$ref":"#/components/schemas/ListSponsoredTvAdGroupsResponseContent"}}},"description":"ListSponsoredTvAdGroups 200 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call.","schema":{"description":"Header containing preferences applied while processing API call.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArgumentExceptionResponseContent"}}},"description":"InvalidArgumentException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["AdGroups"]}},"/st/ads":{"post":{"description":"Creates Sponsored Tv Ads.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredTvAds","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","type":"string"}}],"requestBody":{"content":{"application/vnd.stAd.v1+json":{"schema":{"$ref":"#/components/schemas/CreateSponsoredTvAdsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.stAd.v1+json":{"schema":{"$ref":"#/components/schemas/CreateSponsoredTvAdsResponseContent"}}},"description":"CreateSponsoredTvAds 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call.","schema":{"description":"Header containing preferences applied while processing API call.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdMutationExceptionResponseContent"}}},"description":"AdMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Ads"]},"put":{"description":"Updates Sponsored Tv Ads.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdateSponsoredTvAds","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","type":"string"}}],"requestBody":{"content":{"application/vnd.stAd.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateSponsoredTvAdsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.stAd.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateSponsoredTvAdsResponseContent"}}},"description":"UpdateSponsoredTvAds 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call.","schema":{"description":"Header containing preferences applied while processing API call.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdMutationExceptionResponseContent"}}},"description":"AdMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Ads"]}},"/st/ads/delete":{"post":{"description":"Deletes Sponsored Tv Ads.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"DeleteSponsoredTvAds","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","type":"string"}}],"requestBody":{"content":{"application/vnd.stAd.v1+json":{"schema":{"$ref":"#/components/schemas/DeleteSponsoredTvAdsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.stAd.v1+json":{"schema":{"$ref":"#/components/schemas/DeleteSponsoredTvAdsResponseContent"}}},"description":"DeleteSponsoredTvAds 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call.","schema":{"description":"Header containing preferences applied while processing API call.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdMutationExceptionResponseContent"}}},"description":"AdMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Ads"]}},"/st/ads/list":{"post":{"description":"Lists Sponsored Tv Ads.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListSponsoredTvAds","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","type":"string"}}],"requestBody":{"content":{"application/vnd.stAd.v1+json":{"schema":{"$ref":"#/components/schemas/ListSponsoredTvAdsRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.stAd.v1+json":{"schema":{"$ref":"#/components/schemas/ListSponsoredTvAdsResponseContent"}}},"description":"ListSponsoredTvAds 200 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call.","schema":{"description":"Header containing preferences applied while processing API call.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArgumentExceptionResponseContent"}}},"description":"InvalidArgumentException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Ads"]}},"/st/campaigns":{"post":{"description":"Creates Sponsored Tv campaigns.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredTvCampaigns","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","type":"string"}}],"requestBody":{"content":{"application/vnd.stCampaign.v1+json":{"schema":{"$ref":"#/components/schemas/CreateSponsoredTvCampaignsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.stCampaign.v1+json":{"schema":{"$ref":"#/components/schemas/CreateSponsoredTvCampaignsResponseContent"}}},"description":"CreateSponsoredTvCampaigns 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call.","schema":{"description":"Header containing preferences applied while processing API call.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignMutationExceptionResponseContent"}}},"description":"CampaignMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Campaigns"]},"put":{"description":"Updates Sponsored Tv campaigns.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdateSponsoredTvCampaigns","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","type":"string"}}],"requestBody":{"content":{"application/vnd.stCampaign.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateSponsoredTvCampaignsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.stCampaign.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateSponsoredTvCampaignsResponseContent"}}},"description":"UpdateSponsoredTvCampaigns 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call.","schema":{"description":"Header containing preferences applied while processing API call.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignMutationExceptionResponseContent"}}},"description":"CampaignMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Campaigns"]}},"/st/campaigns/delete":{"post":{"description":"Deletes Sponsored Tv campaigns.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"DeleteSponsoredTvCampaigns","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","type":"string"}}],"requestBody":{"content":{"application/vnd.stCampaign.v1+json":{"schema":{"$ref":"#/components/schemas/DeleteSponsoredTvCampaignsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.stCampaign.v1+json":{"schema":{"$ref":"#/components/schemas/DeleteSponsoredTvCampaignsResponseContent"}}},"description":"DeleteSponsoredTvCampaigns 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call.","schema":{"description":"Header containing preferences applied while processing API call.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignMutationExceptionResponseContent"}}},"description":"CampaignMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Campaigns"]}},"/st/campaigns/list":{"post":{"description":"Lists Sponsored Tv Campaigns\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListSponsoredTvCampaigns","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","type":"string"}}],"requestBody":{"content":{"application/vnd.stCampaign.v1+json":{"schema":{"$ref":"#/components/schemas/ListSponsoredTvCampaignsRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.stCampaign.v1+json":{"schema":{"$ref":"#/components/schemas/ListSponsoredTvCampaignsResponseContent"}}},"description":"ListSponsoredTvCampaigns 200 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call.","schema":{"description":"Header containing preferences applied while processing API call.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArgumentExceptionResponseContent"}}},"description":"InvalidArgumentException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Campaigns"]}},"/st/creatives":{"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredTvCreatives","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}}],"requestBody":{"content":{"application/vnd.stCreative.v1+json":{"schema":{"$ref":"#/components/schemas/CreateSponsoredTvCreativesRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.stCreative.v1+json":{"schema":{"$ref":"#/components/schemas/CreateSponsoredTvCreativesResponseContent"}}},"description":"CreateSponsoredTvCreatives 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreativeMutationExceptionResponseContent"}}},"description":"CreativeMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Creatives"]},"put":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdateSponsoredTvCreatives","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}}],"requestBody":{"content":{"application/vnd.stCreative.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateSponsoredTvCreativesRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.stCreative.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateSponsoredTvCreativesResponseContent"}}},"description":"UpdateSponsoredTvCreatives 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreativeMutationExceptionResponseContent"}}},"description":"CreativeMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Creatives"]}},"/st/creatives/list":{"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListSponsoredTvCreatives","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}}],"requestBody":{"content":{"application/vnd.stCreative.v1+json":{"schema":{"$ref":"#/components/schemas/ListSponsoredTvCreativesRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.stCreative.v1+json":{"schema":{"$ref":"#/components/schemas/ListSponsoredTvCreativesResponseContent"}}},"description":"ListSponsoredTvCreatives 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArgumentExceptionResponseContent"}}},"description":"InvalidArgumentException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Creatives"]}},"/st/creatives/moderations/list":{"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListSponsoredTvCreativesModerations","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}}],"requestBody":{"content":{"application/vnd.stCreativesModerations.v1+json":{"schema":{"$ref":"#/components/schemas/ListSponsoredTvCreativesModerationsRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.stCreativesModerations.v1+json":{"schema":{"$ref":"#/components/schemas/ListSponsoredTvCreativesModerationsResponseContent"}}},"description":"ListSponsoredTvCreativesModerations 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArgumentExceptionResponseContent"}}},"description":"InvalidArgumentException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["CreativesModerations"]}},"/st/creatives/moderations/policyViolations/list":{"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListSponsoredTvCreativesModerationsPolicyViolations","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}}],"requestBody":{"content":{"application/vnd.stCreativesModerations.v1+json":{"schema":{"$ref":"#/components/schemas/ListSponsoredTvCreativesModerationsPolicyViolationsRequestContent"}}},"required":true},"responses":{"200":{"content":{"application/vnd.stCreativesModerations.v1+json":{"schema":{"$ref":"#/components/schemas/ListSponsoredTvCreativesModerationsPolicyViolationsResponseContent"}}},"description":"ListSponsoredTvCreativesModerationsPolicyViolations 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArgumentExceptionResponseContent"}}},"description":"InvalidArgumentException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["CreativesModerations"]}},"/st/creatives/preview":{"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_view\"]","operationId":"PreviewSponsoredTvCreative","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}}],"requestBody":{"content":{"application/vnd.stCreativesPreview.v1+json":{"schema":{"$ref":"#/components/schemas/PreviewSponsoredTvCreativeRequestContent"}}},"required":true},"responses":{"200":{"content":{"application/vnd.stCreativesPreview.v1+json":{"schema":{"$ref":"#/components/schemas/PreviewSponsoredTvCreativeResponseContent"}}},"description":"PreviewSponsoredTvCreative 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArgumentExceptionResponseContent"}}},"description":"InvalidArgumentException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["CreativesPreview"]}},"/st/forecasts":{"post":{"description":"Returns forecasts for a given ad group specified in Sponsored TV forecast request.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"SponsoredTvForecasts","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}}],"requestBody":{"content":{"application/vnd.stForecast.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredTvForecastsRequestContent"}}},"required":true},"responses":{"200":{"content":{"application/vnd.stForecast.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredTvForecastsResponseContent"}}},"description":"SponsoredTvForecasts 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForecastExceptionResponseContent"}}},"description":"ForecastException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Forecasts"]}},"/st/locations":{"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredTvLocations","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}}],"requestBody":{"content":{"application/vnd.stLocation.v1+json":{"schema":{"$ref":"#/components/schemas/CreateSponsoredTvLocationsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.stLocation.v1+json":{"schema":{"$ref":"#/components/schemas/CreateSponsoredTvLocationsResponseContent"}}},"description":"CreateSponsoredTvLocations 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationMutationExceptionResponseContent"}}},"description":"LocationMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Locations"]}},"/st/locations/delete":{"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"DeleteSponsoredTvLocations","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}}],"requestBody":{"content":{"application/vnd.stLocation.v1+json":{"schema":{"$ref":"#/components/schemas/DeleteSponsoredTvLocationsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.stLocation.v1+json":{"schema":{"$ref":"#/components/schemas/DeleteSponsoredTvLocationsResponseContent"}}},"description":"DeleteSponsoredTvLocations 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationMutationExceptionResponseContent"}}},"description":"LocationMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Locations"]}},"/st/locations/list":{"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListSponsoredTvLocations","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}}],"requestBody":{"content":{"application/vnd.stLocation.v1+json":{"schema":{"$ref":"#/components/schemas/ListSponsoredTvLocationsRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.stLocation.v1+json":{"schema":{"$ref":"#/components/schemas/ListSponsoredTvLocationsResponseContent"}}},"description":"ListSponsoredTvLocations 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArgumentExceptionResponseContent"}}},"description":"InvalidArgumentException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Locations"]}},"/st/targets":{"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredTvTargetingClauses","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","type":"string"}}],"requestBody":{"content":{"application/vnd.stTargetingClause.v1+json":{"schema":{"$ref":"#/components/schemas/CreateSponsoredTvTargetingClausesRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.stTargetingClause.v1+json":{"schema":{"$ref":"#/components/schemas/CreateSponsoredTvTargetingClausesResponseContent"}}},"description":"CreateSponsoredTvTargetingClauses 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call.","schema":{"description":"Header containing preferences applied while processing API call.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetMutationExceptionResponseContent"}}},"description":"TargetMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["TargetingClauses"]},"put":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdateSponsoredTvTargetingClauses","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","type":"string"}}],"requestBody":{"content":{"application/vnd.stTargetingClause.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateSponsoredTvTargetingClausesRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.stTargetingClause.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateSponsoredTvTargetingClausesResponseContent"}}},"description":"UpdateSponsoredTvTargetingClauses 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call.","schema":{"description":"Header containing preferences applied while processing API call.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetMutationExceptionResponseContent"}}},"description":"TargetMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["TargetingClauses"]}},"/st/targets/delete":{"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"DeleteSponsoredTvTargetingClauses","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","type":"string"}}],"requestBody":{"content":{"application/vnd.stTargetingClause.v1+json":{"schema":{"$ref":"#/components/schemas/DeleteSponsoredTvTargetingClausesRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.stTargetingClause.v1+json":{"schema":{"$ref":"#/components/schemas/DeleteSponsoredTvTargetingClausesResponseContent"}}},"description":"DeleteSponsoredTvTargetingClauses 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call.","schema":{"description":"Header containing preferences applied while processing API call.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetMutationExceptionResponseContent"}}},"description":"TargetMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["TargetingClauses"]}},"/st/targets/list":{"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListSponsoredTvTargetingClauses","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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":{"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.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences for operations are as follows:\nList Operation - supports `include\u003dextendedData` preference to return representation with extendedData\nCreate/Update/Delete Operations - supports `return\u003drepresentation` to return the full object. `include\u003dextendedData` can be\nused with `return\u003drepresentation` to return the representation with extendedData.","type":"string"}}],"requestBody":{"content":{"application/vnd.stTargetingClause.v1+json":{"schema":{"$ref":"#/components/schemas/ListSponsoredTvTargetingClausesRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.stTargetingClause.v1+json":{"schema":{"$ref":"#/components/schemas/ListSponsoredTvTargetingClausesResponseContent"}}},"description":"ListSponsoredTvTargetingClauses 200 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call.","schema":{"description":"Header containing preferences applied while processing API call.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetMutationExceptionResponseContent"}}},"description":"TargetMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["TargetingClauses"]}}}}