{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"AccountIdHeaderOptional":{"description":"The identifier of an Amazon Ads Advertiser Account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"type":"string"}},"ClientIdHeader":{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account.","in":"header","name":"Amazon-Ads-ClientId","required":true,"schema":{"type":"string"}},"ScopeHeaderOptional":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}}},"requestBodies":{},"responses":{},"schemas":{"BadGatewayResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"BadRequestResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"Budget":{"properties":{"budgetType":{"$ref":"#/components/schemas/BudgetType"},"budgetValue":{"$ref":"#/components/schemas/BudgetValue"},"recurrenceTimePeriod":{"$ref":"#/components/schemas/Recurrence"}},"required":["budgetType","budgetValue","recurrenceTimePeriod"],"type":"object"},"BudgetControls":{"properties":{"campaignBudgetSharing":{"$ref":"#/components/schemas/CampaignBudgetSharing"}},"required":["campaignBudgetSharing"],"type":"object"},"BudgetType":{"enum":["MONETARY"],"type":"string"},"BudgetValue":{"oneOf":[{"properties":{"monetaryBudgetValue":{"$ref":"#/components/schemas/MonetaryBudgetValue"}},"required":["monetaryBudgetValue"],"title":"monetaryBudgetValue","type":"object"}]},"CampaignBudgetSharing":{"properties":{"shareUnspentCampaignBudget":{"$ref":"#/components/schemas/ShareUnspentCampaignBudgetStatus"}},"required":["shareUnspentCampaignBudget"],"type":"object"},"ContentTooLargeResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"CreateBudget":{"properties":{"budgetType":{"$ref":"#/components/schemas/BudgetType"},"budgetValue":{"$ref":"#/components/schemas/CreateBudgetValue"},"recurrenceTimePeriod":{"$ref":"#/components/schemas/Recurrence"}},"required":["budgetType","budgetValue","recurrenceTimePeriod"],"type":"object"},"CreateBudgetControls":{"properties":{"campaignBudgetSharing":{"$ref":"#/components/schemas/CreateCampaignBudgetSharing"}},"required":["campaignBudgetSharing"],"type":"object"},"CreateBudgetValue":{"oneOf":[{"properties":{"monetaryBudgetValue":{"$ref":"#/components/schemas/CreateMonetaryBudgetValue"}},"required":["monetaryBudgetValue"],"title":"monetaryBudgetValue","type":"object"}]},"CreateCampaignBudgetSharing":{"properties":{"shareUnspentCampaignBudget":{"$ref":"#/components/schemas/ShareUnspentCampaignBudgetStatus"}},"required":["shareUnspentCampaignBudget"],"type":"object"},"CreateMarketplacePortfolioConfigurations":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"overrides":{"$ref":"#/components/schemas/CreateMarketplacePortfolioFieldOverrides"}},"required":["marketplace","overrides"],"type":"object"},"CreateMarketplacePortfolioFieldOverrides":{"properties":{"budgetControls":{"$ref":"#/components/schemas/CreateBudgetControls"},"endDateTime":{"description":"The end date time for the Portfolio","format":"date-time","type":"string"},"startDateTime":{"description":"The start date time for the Portfolio","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/State"}},"type":"object"},"CreateMonetaryBudget":{"properties":{"value":{"description":"The monetary amount of the budget cap in the given currency.","format":"double","type":"number"}},"required":["value"],"type":"object"},"CreateMonetaryBudgetMarketplaceSetting":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"monetaryBudget":{"$ref":"#/components/schemas/CreateMonetaryBudget"}},"required":["marketplace","monetaryBudget"],"type":"object"},"CreateMonetaryBudgetValue":{"properties":{"marketplaceSettings":{"description":"List of Monetary Budget values selectively applied at the given marketplace level","items":{"$ref":"#/components/schemas/CreateMonetaryBudgetMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"monetaryBudget":{"$ref":"#/components/schemas/CreateMonetaryBudget"}},"type":"object"},"CreatePortfolioRequest":{"properties":{"portfolios":{"items":{"$ref":"#/components/schemas/PortfolioCreate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["portfolios"],"type":"object"},"CreateState":{"description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n**CreateState Enum:**\n| CreateState | Description |\n| --- | --- |\n| `DRAFT` | The resource is in draft status and has not yet been proposed or enabled. |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |","enum":["DRAFT","ENABLED","PAUSED"],"type":"string"},"CurrencyCode":{"description":"**CurrencyCode Enum:**\n\n| CurrencyCode | Description |\n|------|------|\n| `AED` | United Arab Emirates Dirham |\n| `ARS` | Argentine Peso |\n| `AUD` | Australian Dollar |\n| `BGN` | Bulgarian Lev |\n| `BHD` | Bahraini Dinar |\n| `BOB` | Bolivian Boliviano |\n| `BRL` | Brazilian Real |\n| `CAD` | Canadian Dollar |\n| `CHF` | Swiss Franc |\n| `CLP` | Chilean Peso |\n| `CNY` | Chinese Yuan |\n| `COP` | Colombian Peso |\n| `CRC` | Costa Rican Colón |\n| `CZK` | Czech Koruna |\n| `DKK` | Danish Krone |\n| `DOP` | Dominican Peso |\n| `DZD` | Algerian Dinar |\n| `EGP` | Egyptian Pound |\n| `EUR` | Euro |\n| `GBP` | British Pound Sterling |\n| `GTQ` | Guatemalan Quetzal |\n| `HKD` | Hong Kong Dollar |\n| `HNL` | Honduran Lempira |\n| `HRK` | Croatian Kuna |\n| `HUF` | Hungarian Forint |\n| `IDR` | Indonesian Rupiah |\n| `ILS` | Israeli New Shekel |\n| `INR` | Indian Rupee |\n| `JMD` | Jamaican Dollar |\n| `JPY` | Japanese Yen |\n| `KRW` | South Korean Won |\n| `KWD` | Kuwaiti Dinar |\n| `MAD` | Moroccan Dirham |\n| `MXN` | Mexican Peso |\n| `MXP` | Mexican Peso |\n| `MYR` | Malaysian Ringgit |\n| `NGN` | Nigerian Naira |\n| `NOK` | Norwegian Krone |\n| `NZD` | New Zealand Dollar |\n| `PAB` | Panamanian Balboa |\n| `PEN` | Peruvian Sol |\n| `PHP` | Philippine Peso |\n| `PKR` | Pakistani Rupee |\n| `PLN` | Polish Złoty |\n| `PYG` | Paraguayan Guaraní |\n| `QAR` | Qatari Riyal |\n| `RON` | Romanian Leu |\n| `RSD` | Serbian Dinar |\n| `RUB` | Russian Ruble |\n| `SAR` | Saudi Riyal |\n| `SEK` | Swedish Krona |\n| `SGD` | Singapore Dollar |\n| `THB` | Thai Baht |\n| `TND` | Tunisian Dinar |\n| `TRY` | Turkish Lira |\n| `TWD` | New Taiwan Dollar |\n| `UAH` | Ukrainian Hryvnia |\n| `USD` | United States Dollar |\n| `UYU` | Uruguayan Peso |\n| `VND` | Vietnamese Đồng |\n| `ZAR` | South African Rand |\n","enum":["AED","ARS","AUD","BGN","BHD","BOB","BRL","CAD","CHF","CLP","CNY","COP","CRC","CZK","DKK","DOP","DZD","EGP","EUR","GBP","GTQ","HKD","HNL","HRK","HUF","IDR","ILS","INR","JMD","JPY","KRW","KWD","MAD","MXN","MXP","MYR","NGN","NOK","NZD","PAB","PEN","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SEK","SGD","THB","TND","TRY","TWD","UAH","USD","UYU","VND","ZAR"],"type":"string"},"DeliveryReason":{"description":"**DeliveryReason Enum:**\n\n| DeliveryReason | Description |\n|------|------|\n| `ADVERTISER_ARCHIVED` |  |\n| `ADVERTISER_INELIGIBLE` |  |\n| `ADVERTISER_OUT_OF_BUDGET` | Indicates that an advertiser is out of budget for Sponsored Products campaigns for sellers. |\n| `ADVERTISER_OUT_OF_POSTPAY_CREDIT_LIMIT` | Indicates that a postpay advertiser is out of credit limit for all Sponsored Ads campaigns. |\n| `ADVERTISER_OUT_OF_POSTPAY_MONTHLY_BUDGET` | Indicates that a postpay advertiser is out of monthly budget for all Sponsored Ads campaigns. |\n| `ADVERTISER_OUT_OF_PREPAY_BALANCE` | Indicates that a prepay advertiser is out of prepay balance for all Sponsored Ads campaigns. |\n| `ADVERTISER_PAUSED` |  |\n| `ADVERTISER_PAYMENT_FAILURE` |  |\n| `ADVERTISER_POLICING_PENDING_REVIEW` |  |\n| `ADVERTISER_POLICING_SUSPENDED` |  |\n| `AD_ARCHIVED` |  |\n| `AD_CREATION_FAILED` |  |\n| `AD_CREATION_IN_PROGRESS` |  |\n| `AD_CREATIVES_NOT_RUNNING` |  |\n| `AD_EXTENSION_ARCHIVED` |  |\n| `AD_EXTENSION_PAUSED` |  |\n| `AD_EXTENSION_POLICING_PENDING_REVIEW` |  |\n| `AD_EXTENSION_POLICING_SUSPENDED` |  |\n| `AD_GROUPS_NOT_RUNNING` |  |\n| `AD_GROUP_ARCHIVED` |  |\n| `AD_GROUP_ENDED` |  |\n| `AD_GROUP_INCOMPLETE` |  |\n| `AD_GROUP_INELIGIBLE_GOAL_KPI` | Indicates that the ad group is suspended because the campaign\u0027s goal KPI is not supported. |\n| `AD_GROUP_LOW_BID` |  |\n| `AD_GROUP_MISSING_CONVERSION_TRACKING_SELECTIONS` | Indicates that the ad group is suspended because the campaign is missing conversion tracking selections. |\n| `AD_GROUP_PAUSED` |  |\n| `AD_GROUP_PENDING_REVIEW` |  |\n| `AD_GROUP_PENDING_START_DATE` |  |\n| `AD_GROUP_POLICING_PENDING_REVIEW` |  |\n| `AD_GROUP_POLICING_SUSPENDED` |  |\n| `AD_GROUP_REJECTED` |  |\n| `AD_GROUP_TOO_FEW_CONVERSION_TRACKING_SELECTIONS` | Indicates that the ad group is suspended because the campaign has an insufficient number of conversion tracking selections. |\n| `AD_GROUP_TOO_MANY_CONVERSION_TRACKING_SELECTIONS` | Indicates that the ad group is suspended because the campaign exceeded the maximum number of conversion tracking selections. |\n| `AD_INELIGIBLE` |  |\n| `AD_MISSING_DECORATION` |  |\n| `AD_MISSING_IMAGE` |  |\n| `AD_NOT_APPROVED_FOR_ALL_AD_GROUPS` |  |\n| `AD_NOT_ASSOCIATED_WITH_AD_GROUP` |  |\n| `AD_NOT_DELIVERING` |  |\n| `AD_PAUSED` |  |\n| `AD_POLICING_PENDING_REVIEW` |  |\n| `AD_POLICING_SUSPENDED` |  |\n| `BRAND_INELIGIBLE` |  |\n| `CAMPAIGN_ARCHIVED` |  |\n| `CAMPAIGN_END_DATE_REACHED` |  |\n| `CAMPAIGN_INCOMPLETE` |  |\n| `CAMPAIGN_OUT_OF_BUDGET` |  |\n| `CAMPAIGN_PAUSED` |  |\n| `CAMPAIGN_PENDING_REVIEW` |  |\n| `CAMPAIGN_PENDING_START_DATE` |  |\n| `CAMPAIGN_POLICING_SUSPENDED` |  |\n| `CAMPAIGN_REJECTED` |  |\n| `CREATIVE_MISSING_ASSET` |  |\n| `CREATIVE_PENDING_REVIEW` |  |\n| `CREATIVE_REJECTED` |  |\n| `LANDING_PAGE_INELIGIBLE` |  |\n| `LANDING_PAGE_NOT_AVAILABLE` |  |\n| `MODERATION_ADULT_NOVELTY_POLICY_VIOLATION` |  |\n| `MODERATION_ADULT_PRODUCT_POLICY_VIOLATION` |  |\n| `MODERATION_ADULT_SOFTLINES_POLICY_VIOLATION` |  |\n| `MODERATION_CLAIM_WEIGHTLOSS_POLICY_VIOLATION` |  |\n| `MODERATION_CONTENT_NUDITY_POLICY_VIOLATION` |  |\n| `MODERATION_CONTENT_PROVOCATIVE_POLICY_VIOLATION` |  |\n| `MODERATION_CONTENT_SMOKING_POLICY_VIOLATION` |  |\n| `MODERATION_CRITICAL_EVENTS_POLICY_VIOLATION` |  |\n| `MODERATION_ERROR_404` |  |\n| `MODERATION_GRAPHICAL_SEXUAL_IMAGES_POLICY_VIOLATION` |  |\n| `MODERATION_HFSS_PRODUCT_POLICY_VIOLATION` |  |\n| `MODERATION_LANGUAGE_OFFENSIVE_POLICY_VIOLATION` |  |\n| `MODERATION_NOT_COMPLIANT_TO_AD_POLICY` |  |\n| `MODERATION_SMOKING_RELATED_POLICY_VIOLATION` |  |\n| `NOT_BUYABLE` |  |\n| `NOT_IN_BUYBOX` |  |\n| `NOT_IN_POLICY` |  |\n| `NO_INVENTORY` |  |\n| `NO_PURCHASABLE_OFFER` |  |\n| `OTHER` |  |\n| `OUT_OF_REWARD_BUDGET` |  |\n| `OUT_OF_STOCK` |  |\n| `PIR_RULE_EXCLUDED` |  |\n| `PORTFOLIO_ARCHIVED` |  |\n| `PORTFOLIO_END_DATE_REACHED` |  |\n| `PORTFOLIO_OUT_OF_BUDGET` |  |\n| `PORTFOLIO_PAUSED` |  |\n| `PORTFOLIO_PENDING_START_DATE` |  |\n| `SECURITY_SCAN_PENDING_REVIEW` |  |\n| `SECURITY_SCAN_REJECTED` |  |\n| `SPEND_LIMIT_EXCEEDED` |  |\n| `STATUS_UNAVAILABLE` |  |\n| `TARGET_ARCHIVED` |  |\n| `TARGET_BLOCKED` |  |\n| `TARGET_PAUSED` |  |\n| `TARGET_POLICING_SUSPENDED` |  |\n","enum":["ADVERTISER_ARCHIVED","ADVERTISER_INELIGIBLE","ADVERTISER_OUT_OF_BUDGET","ADVERTISER_OUT_OF_POSTPAY_CREDIT_LIMIT","ADVERTISER_OUT_OF_POSTPAY_MONTHLY_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_PAUSED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","AD_ARCHIVED","AD_CREATION_FAILED","AD_CREATION_IN_PROGRESS","AD_CREATIVES_NOT_RUNNING","AD_EXTENSION_ARCHIVED","AD_EXTENSION_PAUSED","AD_EXTENSION_POLICING_PENDING_REVIEW","AD_EXTENSION_POLICING_SUSPENDED","AD_GROUPS_NOT_RUNNING","AD_GROUP_ARCHIVED","AD_GROUP_ENDED","AD_GROUP_INCOMPLETE","AD_GROUP_INELIGIBLE_GOAL_KPI","AD_GROUP_LOW_BID","AD_GROUP_MISSING_CONVERSION_TRACKING_SELECTIONS","AD_GROUP_PAUSED","AD_GROUP_PENDING_REVIEW","AD_GROUP_PENDING_START_DATE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_SUSPENDED","AD_GROUP_REJECTED","AD_GROUP_TOO_FEW_CONVERSION_TRACKING_SELECTIONS","AD_GROUP_TOO_MANY_CONVERSION_TRACKING_SELECTIONS","AD_INELIGIBLE","AD_MISSING_DECORATION","AD_MISSING_IMAGE","AD_NOT_APPROVED_FOR_ALL_AD_GROUPS","AD_NOT_ASSOCIATED_WITH_AD_GROUP","AD_NOT_DELIVERING","AD_PAUSED","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","BRAND_INELIGIBLE","CAMPAIGN_ARCHIVED","CAMPAIGN_END_DATE_REACHED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","CAMPAIGN_PAUSED","CAMPAIGN_PENDING_REVIEW","CAMPAIGN_PENDING_START_DATE","CAMPAIGN_POLICING_SUSPENDED","CAMPAIGN_REJECTED","CREATIVE_MISSING_ASSET","CREATIVE_PENDING_REVIEW","CREATIVE_REJECTED","LANDING_PAGE_INELIGIBLE","LANDING_PAGE_NOT_AVAILABLE","MODERATION_ADULT_NOVELTY_POLICY_VIOLATION","MODERATION_ADULT_PRODUCT_POLICY_VIOLATION","MODERATION_ADULT_SOFTLINES_POLICY_VIOLATION","MODERATION_CLAIM_WEIGHTLOSS_POLICY_VIOLATION","MODERATION_CONTENT_NUDITY_POLICY_VIOLATION","MODERATION_CONTENT_PROVOCATIVE_POLICY_VIOLATION","MODERATION_CONTENT_SMOKING_POLICY_VIOLATION","MODERATION_CRITICAL_EVENTS_POLICY_VIOLATION","MODERATION_ERROR_404","MODERATION_GRAPHICAL_SEXUAL_IMAGES_POLICY_VIOLATION","MODERATION_HFSS_PRODUCT_POLICY_VIOLATION","MODERATION_LANGUAGE_OFFENSIVE_POLICY_VIOLATION","MODERATION_NOT_COMPLIANT_TO_AD_POLICY","MODERATION_SMOKING_RELATED_POLICY_VIOLATION","NOT_BUYABLE","NOT_IN_BUYBOX","NOT_IN_POLICY","NO_INVENTORY","NO_PURCHASABLE_OFFER","OTHER","OUT_OF_REWARD_BUDGET","OUT_OF_STOCK","PIR_RULE_EXCLUDED","PORTFOLIO_ARCHIVED","PORTFOLIO_END_DATE_REACHED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PAUSED","PORTFOLIO_PENDING_START_DATE","SECURITY_SCAN_PENDING_REVIEW","SECURITY_SCAN_REJECTED","SPEND_LIMIT_EXCEEDED","STATUS_UNAVAILABLE","TARGET_ARCHIVED","TARGET_BLOCKED","TARGET_PAUSED","TARGET_POLICING_SUSPENDED"],"type":"string"},"DeliveryStatus":{"description":"**DeliveryStatus Enum:**\n\n| DeliveryStatus | Description |\n|------|------|\n| `DELIVERING` | Represents the resource is delivering. For global, DELIVERING status indicates that the resource is delivering in all marketplaces |\n| `LIMITED` | Represents partial delivery status, applicable to global resources that have different delivery status across marketplaces |\n| `NOT_DELIVERING` | Represents the resource is not delivering. For global, NOT_DELIVERING status indicates that the resource is NOT delivering in all marketplaces |\n| `UNAVAILABLE` | Represents unavailable resource status. For global, UNAVAILABLE status indicates that the status is unavailable in all marketplaces |\n","enum":["DELIVERING","LIMITED","NOT_DELIVERING","UNAVAILABLE"],"type":"string"},"Error":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"fieldLocation":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ErrorCode":{"description":"**ErrorCode Enum:**\n\n| ErrorCode | Description |\n|------|------|\n| `ACTION_NOT_SUPPORTED` | The request is not supported. |\n| `ACTIVE_RESOURCE_LIMIT_EXCEEDED` | Too many live resources. Remove resources and try again. |\n| `ARCHIVED_PARENT_CANNOT_CREATE` | New resources cannot be created within an archived parent. |\n| `ARCHIVED_PARENT_CANNOT_EDIT` | Resources within an archived parent cannot be edited. |\n| `ARCHIVED_RESOURCE_CANNOT_EDIT` | Archived resources cannot be edited. |\n| `ASSET_NOT_READY` | The provided asset is still being processed. |\n| `AUTOCREATED_ENTITY_CANNOT_EDIT` | Autocreated entities cannot be edited. To complete this action, create the resource manually. |\n| `BAD_REQUEST` | The request is not valid considering the documented schema. |\n| `CONFLICT` | Operation could not be completed due to a conflict. Please retry your request. |\n| `CONTENT_TOO_LARGE` | The request is too large. Consider splitting it into multiple requests. |\n| `DATE_CANNOT_BE_IN_PAST` | Update the date to be in the future. |\n| `DATE_CANNOT_BE_NULL` | Update the date. |\n| `DATE_TOO_SOON` | Update the date to be further in the future. |\n| `DUPLICATE_FIELD_VALUE_FOUND` | Multiple resources share the non-unique field values. Remove the non-unique field value. |\n| `DUPLICATE_RESOURCE_ID_FOUND` | Multiple resources share the same ID. Remove the duplicate ID. |\n| `DURATION_TOO_SHORT` | Update the length to be within the required range. |\n| `FEATURE_DISCONTINUED` | Feature has been discontinued. |\n| `FEATURE_NOT_AVAILABLE` | The requested feature is not available. |\n| `FIELD_SIZE_IS_ABOVE_MAXIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_SIZE_IS_BELOW_MINIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_SIZE_IS_OUT_OF_RANGE` | Update the value to be within the required range. |\n| `FIELD_VALUE_CANNOT_EDIT` | Field value cannot be edited. |\n| `FIELD_VALUE_CONTAINS_BLOCKLISTED_WORDS` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_CONTAINS_INVALID_CHARACTERS` | Remove the invalid characters and try again. |\n| `FIELD_VALUE_IS_ABOVE_MAXIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_VALUE_IS_BELOW_MINIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_VALUE_IS_EMPTY` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_INVALID` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_NULL` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_OUT_OF_RANGE` | Update the value to be within the required range. |\n| `FIELD_VALUE_MISMATCH` | Mismatch among resource field values. |\n| `FIELD_VALUE_MUST_BE_EMPTY_OR_NULL` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_NOT_FOUND` | Resource specified in the field value not found. Try again with valid value. |\n| `FIELD_VALUE_NOT_UNIQUE` | Resource field value conflicts with existing resource. Try again with an unique field value. |\n| `FORBIDDEN` | The caller is not authorized to make the given request. |\n| `GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_PORTFOLIO` | The campaign is associated with a global campaign. Portfolio association cannot be updated on a child campaign. Please perform operation on the global campaign. |\n| `GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_STATE` | The campaign is associated with a global campaign. The state on child campaign cannot be set to archived. Please perform operation on global campaign. |\n| `GLOBAL_CAMPAIGN_SINGLE_ADGROUP_LIMIT` | The campaign is associated with a global campaign. Only one ad group can be created under this campaign. |\n| `INTERNAL_ERROR` | The server encountered an unexpected condition that prevented it from fulfilling the request. |\n| `NOT_FOUND` | The requested resource does not exist. |\n| `PAYMENT_ISSUE` | Payment failed. |\n| `PRODUCT_INELIGIBLE` | Product is not eligible for advertising. Try again with a valid product. |\n| `RESOURCE_DOES_NOT_BELONG_TO_PARENT` | Resource does not belong to the specified parent. Try again with a valid parent ID. |\n| `RESOURCE_ID_NOT_FOUND` | Resource ID not found. Try again with valid ID. |\n| `RESOURCE_IS_EMPTY` | Update the request with the required information for this resource. |\n| `RESOURCE_IS_IN_TERMINAL_STATE` | Resource is in terminal state. |\n| `RESOURCE_IS_NULL` | Update the request with the required information for this resource. |\n| `TOO_MANY_REQUESTS` | There have been too many requests, please slow down your call rate. |\n| `TOTAL_RESOURCE_LIMIT_EXCEEDED` | Too many resources. Remove resources and try again. |\n| `UNAUTHORIZED` | The request lacks the necessary credentials. |\n| `UNSUPPORTED_MARKETPLACE` | Marketplace not supported. Try again with a supported marketplace. |\n","enum":["ACTION_NOT_SUPPORTED","ACTIVE_RESOURCE_LIMIT_EXCEEDED","ARCHIVED_PARENT_CANNOT_CREATE","ARCHIVED_PARENT_CANNOT_EDIT","ARCHIVED_RESOURCE_CANNOT_EDIT","ASSET_NOT_READY","AUTOCREATED_ENTITY_CANNOT_EDIT","BAD_REQUEST","CONFLICT","CONTENT_TOO_LARGE","DATE_CANNOT_BE_IN_PAST","DATE_CANNOT_BE_NULL","DATE_TOO_SOON","DUPLICATE_FIELD_VALUE_FOUND","DUPLICATE_RESOURCE_ID_FOUND","DURATION_TOO_SHORT","FEATURE_DISCONTINUED","FEATURE_NOT_AVAILABLE","FIELD_SIZE_IS_ABOVE_MAXIMUM_LIMIT","FIELD_SIZE_IS_BELOW_MINIMUM_LIMIT","FIELD_SIZE_IS_OUT_OF_RANGE","FIELD_VALUE_CANNOT_EDIT","FIELD_VALUE_CONTAINS_BLOCKLISTED_WORDS","FIELD_VALUE_CONTAINS_INVALID_CHARACTERS","FIELD_VALUE_IS_ABOVE_MAXIMUM_LIMIT","FIELD_VALUE_IS_BELOW_MINIMUM_LIMIT","FIELD_VALUE_IS_EMPTY","FIELD_VALUE_IS_INVALID","FIELD_VALUE_IS_NULL","FIELD_VALUE_IS_OUT_OF_RANGE","FIELD_VALUE_MISMATCH","FIELD_VALUE_MUST_BE_EMPTY_OR_NULL","FIELD_VALUE_NOT_FOUND","FIELD_VALUE_NOT_UNIQUE","FORBIDDEN","GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_PORTFOLIO","GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_STATE","GLOBAL_CAMPAIGN_SINGLE_ADGROUP_LIMIT","INTERNAL_ERROR","NOT_FOUND","PAYMENT_ISSUE","PRODUCT_INELIGIBLE","RESOURCE_DOES_NOT_BELONG_TO_PARENT","RESOURCE_ID_NOT_FOUND","RESOURCE_IS_EMPTY","RESOURCE_IS_IN_TERMINAL_STATE","RESOURCE_IS_NULL","TOO_MANY_REQUESTS","TOTAL_RESOURCE_LIMIT_EXCEEDED","UNAUTHORIZED","UNSUPPORTED_MARKETPLACE"],"type":"string"},"ErrorsIndex":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":4999,"minimum":0,"type":"integer"}},"required":["errors","index"],"type":"object"},"ForbiddenResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"GatewayTimeoutResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"InternalServerErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"Marketplace":{"description":"A list of country codes representing Amazon marketplaces\n\n\n\n","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"],"type":"string"},"MarketplacePortfolioConfigurations":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"overrides":{"$ref":"#/components/schemas/MarketplacePortfolioFieldOverrides"},"portfolioId":{"description":"Represents marketplace Portfolio ID associated to global Portfolio","type":"string"}},"required":["marketplace","overrides","portfolioId"],"type":"object"},"MarketplacePortfolioFieldOverrides":{"properties":{"budgetControls":{"$ref":"#/components/schemas/BudgetControls"},"endDateTime":{"description":"The end date time for the Portfolio","format":"date-time","type":"string"},"name":{"description":"The name of the Portfolio","type":"string"},"startDateTime":{"description":"The start date time for the Portfolio","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/State"}},"type":"object"},"MarketplaceScope":{"enum":["GLOBAL","SINGLE_MARKETPLACE"],"type":"string"},"MonetaryBudget":{"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"ruleValue":{"description":"The monetary amount of the budget when a budget rule is applied.","format":"double","type":"number"},"value":{"description":"The monetary amount of the budget cap in the given currency.","format":"double","type":"number"}},"required":["currencyCode","value"],"type":"object"},"MonetaryBudgetMarketplaceSetting":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"monetaryBudget":{"$ref":"#/components/schemas/MonetaryBudget"}},"required":["marketplace","monetaryBudget"],"type":"object"},"MonetaryBudgetValue":{"properties":{"marketplaceSettings":{"description":"List of Monetary Budget values selectively applied at the given marketplace level","items":{"$ref":"#/components/schemas/MonetaryBudgetMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"monetaryBudget":{"$ref":"#/components/schemas/MonetaryBudget"}},"type":"object"},"NotFoundResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"Portfolio":{"properties":{"budget":{"$ref":"#/components/schemas/Budget"},"budgetControls":{"$ref":"#/components/schemas/BudgetControls"},"endDateTime":{"description":"The end date time for the portfolio. Only applicable if budget recurrenceTimePeriod is LIFETIME","format":"date-time","type":"string"},"globalPortfolioId":{"description":"The global portfolio identifier that manages this marketplace portfolio.","type":"string"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global portfolio that enables overriding certain attributes at individual marketplace level. When a marketplace-specific override is not provided, the portfolio\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/MarketplacePortfolioConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"The list of country codes representing amazon marketplaces in which the portfolio is applicable","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the portfolio","type":"string"},"portfolioId":{"description":"A unique identifier for a portfolio","type":"string"},"startDateTime":{"description":"The start date time for the portfolio. Only applicable if budget recurrenceTimePeriod is LIFETIME","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/State"},"status":{"$ref":"#/components/schemas/Status"}},"type":"object"},"PortfolioCreate":{"properties":{"budget":{"$ref":"#/components/schemas/CreateBudget"},"budgetControls":{"$ref":"#/components/schemas/CreateBudgetControls"},"endDateTime":{"description":"The end date time for the portfolio. Only applicable if budget recurrenceTimePeriod is LIFETIME","format":"date-time","type":"string"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global portfolio that enables overriding certain attributes at individual marketplace level. When a marketplace-specific override is not provided, the portfolio\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/CreateMarketplacePortfolioConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"The list of country codes representing amazon marketplaces in which the portfolio is applicable","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the portfolio","type":"string"},"startDateTime":{"description":"The start date time for the portfolio. Only applicable if budget recurrenceTimePeriod is LIFETIME","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/CreateState"}},"type":"object"},"PortfolioMarketplaceScopeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/MarketplaceScope"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"PortfolioMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/PortfolioMultiStatusSuccess"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"PortfolioMultiStatusSuccess":{"properties":{"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"},"portfolio":{"$ref":"#/components/schemas/Portfolio"}},"required":["index","portfolio"],"type":"object"},"PortfolioNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/PortfolioNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"PortfolioNameFilterType":{"description":"**PortfolioNameFilterType Enum:**\n| PortfolioNameFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"PortfolioPortfolioIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"PortfolioStateFilter":{"properties":{"include":{"description":"**State Enum:**\n| State | Description |\n| --- | --- |\n| `DRAFT` | The resource is in draft status and has not yet been proposed or enabled. |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |","items":{"$ref":"#/components/schemas/State"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"PortfolioSuccessResponse":{"properties":{"nextToken":{"type":"string"},"portfolios":{"items":{"$ref":"#/components/schemas/Portfolio"},"maxItems":5000,"minItems":0,"type":"array"}},"type":"object"},"PortfolioUpdate":{"properties":{"budget":{"$ref":"#/components/schemas/UpdateBudget"},"budgetControls":{"$ref":"#/components/schemas/UpdateBudgetControls"},"endDateTime":{"description":"The end date time for the portfolio. Only applicable if budget recurrenceTimePeriod is LIFETIME","format":"date-time","nullable":true,"type":"string"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global portfolio that enables overriding certain attributes at individual marketplace level. When a marketplace-specific override is not provided, the portfolio\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/CreateMarketplacePortfolioConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaces":{"description":"The list of country codes representing amazon marketplaces in which the portfolio is applicable","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the portfolio","type":"string"},"portfolioId":{"description":"A unique identifier for a portfolio","type":"string"},"startDateTime":{"description":"The start date time for the portfolio. Only applicable if budget recurrenceTimePeriod is LIFETIME","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/UpdateState"}},"type":"object"},"QueryPortfolioRequest":{"properties":{"marketplaceScopeFilter":{"$ref":"#/components/schemas/PortfolioMarketplaceScopeFilter"},"maxResults":{"default":5000,"format":"int32","maximum":5000,"minimum":0,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/PortfolioNameFilter"},"nextToken":{"type":"string"},"portfolioIdFilter":{"$ref":"#/components/schemas/PortfolioPortfolioIdFilter"},"stateFilter":{"$ref":"#/components/schemas/PortfolioStateFilter"}},"type":"object"},"Recurrence":{"enum":["DAILY","LIFETIME","MONTHLY"],"type":"string"},"ServiceUnavailableErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ShareUnspentCampaignBudgetStatus":{"description":"**ShareUnspentCampaignBudgetStatus Enum:**\n\n| ShareUnspentCampaignBudgetStatus | Description |\n|------|------|\n| `DISABLED` | Unspent campaign budget is not shared. |\n| `ENABLED` | Unspent campaign budget is shared across other campaigns in the portfolio. |\n","enum":["DISABLED","ENABLED"],"type":"string"},"State":{"description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n**State Enum:**\n\n| State | Description |\n|------|------|\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |\n| `DRAFT` | The resource is in draft status and has not yet been proposed or enabled. |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n","enum":["ARCHIVED","DRAFT","ENABLED","PAUSED"],"type":"string"},"Status":{"properties":{"deliveryReasons":{"description":"This is the list of reasons behind the delivery status.","items":{"$ref":"#/components/schemas/DeliveryReason"},"maxItems":50,"minItems":0,"type":"array"},"deliveryStatus":{"$ref":"#/components/schemas/DeliveryStatus"},"marketplaceSettings":{"description":"The list of marketplace level delivery status and reasons of global resources, for all the marketplaces the global resource is applicable in.","items":{"$ref":"#/components/schemas/StatusMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"}},"required":["deliveryStatus"],"type":"object"},"StatusMarketplaceSetting":{"properties":{"deliveryReasons":{"description":"This is the list of reasons behind the delivery status.","items":{"$ref":"#/components/schemas/DeliveryReason"},"maxItems":50,"minItems":0,"type":"array"},"deliveryStatus":{"$ref":"#/components/schemas/DeliveryStatus"},"marketplace":{"$ref":"#/components/schemas/Marketplace"}},"required":["deliveryStatus","marketplace"],"type":"object"},"TooManyRequestsResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"UnauthorizedResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"UpdateBudget":{"nullable":true,"properties":{"budgetType":{"$ref":"#/components/schemas/BudgetType"},"budgetValue":{"$ref":"#/components/schemas/UpdateBudgetValue"},"recurrenceTimePeriod":{"$ref":"#/components/schemas/Recurrence"}},"type":"object"},"UpdateBudgetControls":{"properties":{"campaignBudgetSharing":{"$ref":"#/components/schemas/UpdateCampaignBudgetSharing"}},"type":"object"},"UpdateBudgetValue":{"oneOf":[{"properties":{"monetaryBudgetValue":{"$ref":"#/components/schemas/UpdateMonetaryBudgetValue"}},"required":["monetaryBudgetValue"],"title":"monetaryBudgetValue","type":"object"}]},"UpdateCampaignBudgetSharing":{"properties":{"shareUnspentCampaignBudget":{"$ref":"#/components/schemas/ShareUnspentCampaignBudgetStatus"}},"type":"object"},"UpdateMonetaryBudget":{"properties":{"value":{"description":"The monetary amount of the budget cap in the given currency.","format":"double","type":"number"}},"type":"object"},"UpdateMonetaryBudgetValue":{"properties":{"marketplaceSettings":{"description":"List of Monetary Budget values selectively applied at the given marketplace level","items":{"$ref":"#/components/schemas/CreateMonetaryBudgetMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"monetaryBudget":{"$ref":"#/components/schemas/UpdateMonetaryBudget"}},"type":"object"},"UpdatePortfolioRequest":{"properties":{"portfolios":{"items":{"$ref":"#/components/schemas/PortfolioUpdate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["portfolios"],"type":"object"},"UpdateState":{"description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n**UpdateState Enum:**\n| UpdateState | Description |\n| --- | --- |\n| `DRAFT` | The resource is in draft status and has not yet been proposed or enabled. |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |","enum":["DRAFT","ENABLED","PAUSED"],"type":"string"}},"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://www.amazon.com/ap/oa","scopes":{"advertising::audiences":"Grants access to data provider APIs","advertising::campaign_management":"Grants write access to campaign management.","advertising::test:create_account":"Grants write access to create test accounts functionality","cpc_advertising:campaign_management":"Grants write access to campaign management. Legacy name (no difference from advertising::campaign_management)"},"tokenUrl":"https://api.amazon.com/auth/o2/token"}},"type":"oauth2"}}},"info":{"description":"Amazon Ads API v1 is a reimagined approach to our Ads API, built to provide a seamless experience across all Amazon advertising products through a common model. [Learn more about Ads API v1.](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/overview) To learn about prerequisites and header values, see [Getting started with Amazon Ads API v1](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/getting-started).\n\n**Download Amazon Ads API V1 OpenAPI Spec** ([All Products](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIALLMerged_prod_3p.json) | [SP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPMerged_prod_3p.json) | [SP Global](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPGLOBALMerged_prod_3p.json) | [SB](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISBMerged_prod_3p.json) | [DSP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIDSPMerged_prod_3p.json) | [ST](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISTMerged_prod_3p.json) | [SD](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISDMerged_prod_3p.json))","title":"Portfolios API","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/create/portfolios":{"post":{"description":"Create Portfolios\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreatePortfolio","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePortfolioRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioMultiStatusResponse"}}},"description":"CreatePortfolio 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Portfolios"]}},"/adsApi/v1/query/portfolios":{"post":{"description":"Query Portfolios\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"advertiser_campaign_view\"]","operationId":"QueryPortfolio","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPortfolioRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioSuccessResponse"}}},"description":"QueryPortfolio 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Portfolios"]}},"/adsApi/v1/update/portfolios":{"post":{"description":"Update Portfolios\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdatePortfolio","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePortfolioRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioMultiStatusResponse"}}},"description":"UpdatePortfolio 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Portfolios"]}}},"servers":[{"description":"Production server for NA","url":"https://advertising-api.amazon.com"},{"description":"Production server for EU","url":"https://advertising-api-eu.amazon.com"},{"description":"Production server for FE","url":"https://advertising-api-fe.amazon.com"}]}