Amazon Ads API MCP

{"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"},"BudgetControls":{"properties":{"campaignUnspentBudgetSharing":{"$ref":"#/components/schemas/CampaignUnspentBudgetSharing"}},"type":"object"},"BudgetUsageError":{"description":"The Error Response Object.","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"BudgetUsagePortfolio":{"properties":{"budget":{"description":"Budget amount of resource requested","type":"number"},"budgetUsagePercent":{"description":"Budget usage percentage (spend / available budget) for the given budget policy.","type":"number"},"index":{"description":"An index to maintain order of the portfolioIds","type":"number"},"portfolioId":{"description":"ID of requested resource","type":"string"},"usageUpdatedTimestamp":{"description":"Last evaluation time for budget usage","format":"date-time","type":"string"}},"type":"object"},"BudgetUsagePortfolioBatchError":{"properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"},"index":{"description":"An index to maintain order of the portfolioIds","type":"number"},"portfolioId":{"description":"ID of requested resource","type":"string"}},"type":"object"},"BudgetUsagePortfolioRequest":{"properties":{"portfolioIds":{"description":"A list of portfolio IDs.","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"BudgetUsagePortfolioResponse":{"properties":{"error":{"description":"List of budget usage percentages that failed to pull","items":{"$ref":"#/components/schemas/BudgetUsagePortfolioBatchError","properties":{}},"type":"array"},"success":{"description":"List of budget usage percentages that were successfully pulled","items":{"$ref":"#/components/schemas/BudgetUsagePortfolio","properties":{}},"type":"array"}},"type":"object"},"BulkPortfolioOperationResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/PortfolioFailureResponseItem","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/PortfolioSuccessResponseItem","properties":{}},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"CampaignUnspentBudgetSharing":{"properties":{"featureState":{"$ref":"#/components/schemas/FeatureState"}},"required":["featureState"],"type":"object"},"CreatePortfolio":{"properties":{"budget":{"$ref":"#/components/schemas/PortfolioBudget"},"budgetControls":{"$ref":"#/components/schemas/BudgetControls"},"name":{"description":"The name of the portfolio.","type":"string"},"state":{"$ref":"#/components/schemas/EntityState"}},"required":["name","state"],"type":"object"},"CreatePortfoliosRequestContent":{"properties":{"portfolios":{"description":"An array of portfolio to create.","items":{"$ref":"#/components/schemas/CreatePortfolio"},"maxItems":100,"minItems":1,"type":"array"}},"required":["portfolios"],"type":"object"},"CreatePortfoliosResponseContent":{"properties":{"portfolios":{"$ref":"#/components/schemas/BulkPortfolioOperationResponse"}},"required":["portfolios"],"type":"object"},"CurrencyCode":{"description":"The currency used for all monetary values for entities under this profile. Cannot be `null`.\n|Region|`countryCode`|Country Name|`currencyCode`|\n|-----|------|------|------|\n|NA|US|United States|USD|\n|...","enum":["AED","AUD","BRL","CAD","CLP","CNY","COP","EGP","EUR","GBP","INR","JPY","MXN","NGN","PLN","SAR","SEK","SGD","TRY","USD","ZAR"],"type":"string"},"EntityState":{"description":"The current resource state.","enum":["ENABLED"],"type":"string"},"EntityStateFilter":{"description":"Filter entities by state","properties":{"include":{"items":{"$ref":"#/components/schemas/EntityState"},"maxItems":1,"minItems":1,"type":"array"}},"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"},"FeatureState":{"description":"The state for sharing unspent campaign budget.","enum":["DISABLED","ENABLED"],"type":"string"},"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"},"InvalidArgumentErrorCode":{"enum":["INVALID_ARGUMENT"],"type":"string"},"ListPortfoliosRequestContent":{"properties":{"includeExtendedDataFields":{"description":"whether to get a list of targetingClauses with extended data fields (creationDate, lastUpdateDate, servingStatus).","type":"boolean"},"nameFilter":{"$ref":"#/components/schemas/NameFilter"},"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"portfolioIdFilter":{"$ref":"#/components/schemas/ObjectIdFilter"},"stateFilter":{"$ref":"#/components/schemas/EntityStateFilter"}},"type":"object"},"ListPortfoliosResponseContent":{"properties":{"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"portfolios":{"items":{"$ref":"#/components/schemas/Portfolio","properties":{}},"maxItems":1000,"minItems":0,"type":"array"},"totalResults":{"description":"The total number of entities","type":"number"}},"type":"object"},"NameFilter":{"description":"Filter entities by name","properties":{"include":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/QueryTermMatchType"}},"type":"object"},"ObjectIdFilter":{"description":"Filter entities by the list of objectIds","properties":{"include":{"items":{"description":"entity object identifier","type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"PolicyType":{"description":"The budget policy. Set to `DATE_RANGE` to specify a budget for a specific period of time. Set to `MONTHLY_RECURRING` to specify a budget that is automatically renewed at the beginning of each month. To remove budget, set budget `amount`, `startDate`, `endDate` to null and set `policy` to `NO_CAP`.","enum":["DATE_RANGE","MONTHLY_RECURRING","NO_CAP","OTHER"],"type":"string"},"Portfolio":{"properties":{"budget":{"$ref":"#/components/schemas/PortfolioBudget"},"budgetControls":{"$ref":"#/components/schemas/BudgetControls"},"extendedData":{"$ref":"#/components/schemas/PortfolioExtendedData"},"inBudget":{"description":"States if the portfolio is still within budget.","type":"boolean"},"name":{"description":"The name of the portfolio.","type":"string"},"portfolioId":{"description":"The ID of the portfolio.","type":"string"},"state":{"$ref":"#/components/schemas/EntityState"}},"required":["name","portfolioId","state"],"type":"object"},"PortfolioAccessError":{"properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"$ref":"#/components/schemas/PortfolioAccessErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"PortfolioAccessErrorSelector":{"properties":{"dateError":{"$ref":"#/components/schemas/PortfolioDateError"},"entityNotFoundError":{"$ref":"#/components/schemas/PortfolioEntityNotFoundError"},"malformedValueError":{"$ref":"#/components/schemas/PortfolioMalformedValueError"},"missingValueError":{"$ref":"#/components/schemas/PortfolioMissingValueError"},"otherError":{"$ref":"#/components/schemas/PortfolioOtherError"},"rangeError":{"$ref":"#/components/schemas/PortfolioRangeError"}},"type":"object"},"PortfolioAccessExceptionResponseContent":{"description":"Exception resulting in accessing portfolio entity","properties":{"code":{"$ref":"#/components/schemas/InvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/PortfolioAccessError","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"PortfolioBillingError":{"description":"Errors related to bids","properties":{"cause":{"$ref":"#/components/schemas/ErrorCause"},"marketplace":{"type":"string"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/PortfolioBillingErrorReason"}},"required":["cause","message","reason"],"type":"object"},"PortfolioBillingErrorReason":{"enum":["ADVERTISER_SUSPENDED","BILLING_ACCOUNT_NOT_FOUND","EXPIRED_PAYMENT_METHOD","PAYMENT_PROFILE_NOT_FOUND","VETTING_FAILURE"],"type":"string"},"PortfolioBudget":{"properties":{"amount":{"description":"The amount of the budget.","format":"double","nullable":true,"type":"number"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"endDate":{"description":"The end date after which the budget is no longer applied in ISO 8601.","format":"date","nullable":true,"type":"string"},"policy":{"$ref":"#/components/schemas/PolicyType","nullable":true},"startDate":{"description":"The starting date to which the budget is applied in ISO 8601.","format":"date","nullable":true,"type":"string"}},"type":"object"},"PortfolioBudgetError":{"properties":{"cause":{"$ref":"#/components/schemas/ErrorCause"},"lowerLimit":{"type":"string"},"marketplace":{"type":"string"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/PortfolioBudgetErrorReason"},"upperLimit":{"type":"string"}},"required":["cause","message","reason"],"type":"object"},"PortfolioBudgetErrorReason":{"enum":["BUDGETING_POLICY_INVALID","BUDGET_AMOUNT_INVALID","BUDGET_CURRENCY_DOES_NOT_MATCH_MARKETPLACE_SETTINGS","BUDGET_LT_DEFAULT_BIDS","BUDGET_LT_KEYWORD_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"],"type":"string"},"PortfolioDateError":{"properties":{"cause":{"$ref":"#/components/schemas/ErrorCause"},"marketplace":{"type":"string"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/PortfolioDateErrorReason"}},"required":["cause","message","reason"],"type":"object"},"PortfolioDateErrorReason":{"enum":["END_DATE_EARLIER_THAN_TODAY","INVALID_DATE","START_DATE_AFTER_END_DATE","START_DATE_EARLIER_THAN_TODAY","START_DATE_EQUAL_END_DATE","START_DATE_NOT_NULL"],"type":"string"},"PortfolioDuplicateValueError":{"properties":{"cause":{"$ref":"#/components/schemas/ErrorCause"},"marketplace":{"type":"string"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/PortfolioDuplicateValueErrorReason"}},"required":["cause","message","reason"],"type":"object"},"PortfolioDuplicateValueErrorReason":{"enum":["DUPLICATE_VALUE"],"type":"string"},"PortfolioEntityNotFoundError":{"properties":{"cause":{"$ref":"#/components/schemas/ErrorCause"},"entityId":{"description":"The entity id in the request","type":"string"},"entityType":{"$ref":"#/components/schemas/PortfolioEntityType"},"marketplace":{"type":"string"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/PortfolioEntityNotFoundErrorReason"}},"required":["cause","entityId","entityType","message","reason"],"type":"object"},"PortfolioEntityNotFoundErrorReason":{"enum":["ENTITY_NOT_FOUND"],"type":"string"},"PortfolioEntityQuotaError":{"description":"Errors related to exceeding quota in portfolios service","properties":{"cause":{"$ref":"#/components/schemas/ErrorCause"},"entityType":{"$ref":"#/components/schemas/PortfolioEntityType"},"marketplace":{"type":"string"},"message":{"description":"Human readable error message","type":"string"},"quota":{"description":"optional current quota","type":"string"},"quotaScope":{"$ref":"#/components/schemas/PortfolioQuotaScope"},"reason":{"$ref":"#/components/schemas/PortfolioEntityQuotaErrorReason"}},"required":["cause","entityType","message","reason"],"type":"object"},"PortfolioEntityQuotaErrorReason":{"enum":["QUOTA_EXCEEDED"],"type":"string"},"PortfolioEntityType":{"enum":["PORTFOLIO"],"type":"string"},"PortfolioExtendedData":{"properties":{"creationDateTime":{"description":"Creation date in ISO 8601.","format":"date-time","type":"string"},"lastUpdateDateTime":{"description":"Date of last update in ISO 8601.","format":"date-time","type":"string"},"servingStatus":{"$ref":"#/components/schemas/PortfolioServingStatus"},"statusReasons":{"items":{"$ref":"#/components/schemas/PortfolioServingStatusReason","properties":{}},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"PortfolioFailureResponseItem":{"properties":{"errors":{"description":"a list of validation errors","items":{"$ref":"#/components/schemas/PortfolioMutationError","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"index":{"description":"the index of the portfolio in the array from the request body","minimum":0,"type":"number"}},"required":["index"],"type":"object"},"PortfolioMalformedValueError":{"description":"Errors being used to represent malformed values\ne.g. containing not allowed characters, not following patterns etc","properties":{"cause":{"$ref":"#/components/schemas/ErrorCause"},"fragment":{"description":"fragment of the value which is wrong","type":"string"},"marketplace":{"type":"string"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/PortfolioMalformedValueErrorReason"}},"required":["cause","message","reason"],"type":"object"},"PortfolioMalformedValueErrorReason":{"enum":["FORBIDDEN_CHARS","PATTERN_NOT_MATCHED","TOO_LONG","TOO_SHORT"],"type":"string"},"PortfolioMissingValueError":{"description":"Error describing missing values in API payloads","properties":{"cause":{"$ref":"#/components/schemas/ErrorCause"},"marketplace":{"type":"string"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/PortfolioMissingValueErrorReason"}},"required":["cause","message","reason"],"type":"object"},"PortfolioMissingValueErrorReason":{"enum":["MISSING_VALUE"],"type":"string"},"PortfolioMutationError":{"properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"$ref":"#/components/schemas/PortfolioMutationErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"PortfolioMutationErrorSelector":{"properties":{"billingError":{"$ref":"#/components/schemas/PortfolioBillingError"},"budgetError":{"$ref":"#/components/schemas/PortfolioBudgetError"},"dateError":{"$ref":"#/components/schemas/PortfolioDateError"},"duplicateValueError":{"$ref":"#/components/schemas/PortfolioDuplicateValueError"},"entityNotFoundError":{"$ref":"#/components/schemas/PortfolioEntityNotFoundError"},"entityQuotaError":{"$ref":"#/components/schemas/PortfolioEntityQuotaError"},"malformedValueError":{"$ref":"#/components/schemas/PortfolioMalformedValueError"},"missingValueError":{"$ref":"#/components/schemas/PortfolioMissingValueError"},"otherError":{"$ref":"#/components/schemas/PortfolioOtherError"},"rangeError":{"$ref":"#/components/schemas/PortfolioRangeError"}},"type":"object"},"PortfolioOtherError":{"description":"Errors not related to any of the other error types","properties":{"cause":{"$ref":"#/components/schemas/ErrorCause"},"marketplace":{"type":"string"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/PortfolioOtherErrorReason"}},"required":["cause","message","reason"],"type":"object"},"PortfolioOtherErrorReason":{"enum":["OTHER_ERROR"],"type":"string"},"PortfolioQuotaScope":{"enum":["ACCOUNT"],"type":"string"},"PortfolioRangeError":{"description":"Errors related to range constraints violations","properties":{"allowed":{"description":"allowed values","items":{"properties":{},"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"cause":{"$ref":"#/components/schemas/ErrorCause"},"lowerLimit":{"description":"optional lower limit","type":"string"},"marketplace":{"type":"string"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/PortfolioValueLimitErrorReason"},"upperLimit":{"description":"optional upper limit","type":"string"}},"required":["cause","message","reason"],"type":"object"},"PortfolioServingStatus":{"enum":["ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_EXCEED_SPENDS_LIMIT","ADVERTISER_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_PAUSED","ADVERTISER_PAYMENT_FAILURE","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_STATUS_ENABLED"],"type":"string"},"PortfolioServingStatusReason":{"enum":["ADVERTISER_ACCOUNT_OUT_OF_BUDGET_DETAIL","ADVERTISER_ARCHIVED_DETAIL","ADVERTISER_EXCEED_SPENDS_LIMIT_DETAIL","ADVERTISER_OUT_OF_BUDGET_DETAIL","ADVERTISER_OUT_OF_PREPAY_BALANCE_DETAIL","ADVERTISER_PAUSED_DETAIL","ADVERTISER_PAYMENT_FAILURE_DETAIL","PORTFOLIO_ENDED_DETAIL","PORTFOLIO_OUT_OF_BUDGET_DETAIL","PORTFOLIO_PENDING_START_DATE_DETAIL","PORTFOLIO_STATUS_ENABLED_DETAIL"],"type":"string"},"PortfolioSuccessResponseItem":{"properties":{"index":{"description":"the index of the portfolio in the array from the request body","minimum":0,"type":"number"},"portfolio":{"$ref":"#/components/schemas/Portfolio"},"portfolioId":{"description":"the Portfolio ID","type":"string"}},"required":["index"],"type":"object"},"PortfolioValueLimitErrorReason":{"enum":["INVALID_ENUM_VALUE","TOO_HIGH","TOO_LOW"],"type":"string"},"QueryTermMatchType":{"enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"SchemaValidationExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/InvalidArgumentErrorCode"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"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":{"enum":["UNAUTHORIZED"],"type":"string"},"UnauthorizedExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/UnauthorizedErrorCode"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"UnsupportedMediaTypeErrorCode":{"enum":["UNSUPPORTED_MEDIA_TYPE"],"type":"string"},"UnsupportedMediaTypeExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/UnsupportedMediaTypeErrorCode"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"UpdatePortfolio":{"properties":{"budget":{"$ref":"#/components/schemas/PortfolioBudget"},"budgetControls":{"$ref":"#/components/schemas/BudgetControls"},"name":{"description":"The name of the portfolio.","type":"string"},"portfolioId":{"description":"The ID of the portfolio.","type":"string"},"state":{"$ref":"#/components/schemas/EntityState"}},"required":["portfolioId"],"type":"object"},"UpdatePortfoliosRequestContent":{"properties":{"portfolios":{"description":"An array of portfolio with updated values.","items":{"$ref":"#/components/schemas/UpdatePortfolio"},"maxItems":100,"minItems":1,"type":"array"}},"required":["portfolios"],"type":"object"},"UpdatePortfoliosResponseContent":{"properties":{"portfolios":{"$ref":"#/components/schemas/BulkPortfolioOperationResponse"}},"required":["portfolios"],"type":"object"}},"securitySchemes":{}},"info":{"title":"Portfolios","version":"3.0"},"openapi":"3.0.1","paths":{"/portfolios":{"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreatePortfolios","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\nprofiles associated with the access token passed in the HTTP Authorization header.","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\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.","type":"string"}}],"requestBody":{"content":{"application/vnd.spPortfolio.v3+json":{"schema":{"$ref":"#/components/schemas/CreatePortfoliosRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spPortfolio.v3+json":{"schema":{"$ref":"#/components/schemas/CreatePortfoliosResponseContent"}}},"description":"CreatePortfolios 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaValidationExceptionResponseContent"}}},"description":"SchemaValidationException 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"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Portfolios"]},"put":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdatePortfolios","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\nprofiles associated with the access token passed in the HTTP Authorization header.","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\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.","type":"string"}}],"requestBody":{"content":{"application/vnd.spPortfolio.v3+json":{"schema":{"$ref":"#/components/schemas/UpdatePortfoliosRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spPortfolio.v3+json":{"schema":{"$ref":"#/components/schemas/UpdatePortfoliosResponseContent"}}},"description":"UpdatePortfolios 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaValidationExceptionResponseContent"}}},"description":"SchemaValidationException 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"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Portfolios"]}},"/portfolios/budget/usage":{"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"portfolioBudgetUsage","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{}}],"requestBody":{"content":{"application/vnd.portfoliobudgetusage.v1+json":{"schema":{"$ref":"#/components/schemas/BudgetUsagePortfolioRequest"}}}},"responses":{"207":{"content":{"application/vnd.portfoliobudgetusage.v1+json":{"schema":{"$ref":"#/components/schemas/BudgetUsagePortfolioResponse"}}},"description":"Multi-status. An object containing a list of budget usage response objects reflecting the same order as the input."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetUsageError"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetUsageError"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetUsageError"}}},"description":"Forbidden. The request failed because user does not have access to a specified resource."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetUsageError"}}},"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetUsageError"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetUsageError"}}},"description":"Internal Server BudgetUsageError - Something went wrong on the server. Retry later and report an BudgetUsageError if unresolved."}},"summary":"Budget usage API for portfolios","tags":["Budget Usage"]}},"/portfolios/list":{"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListPortfolios","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\nprofiles associated with the access token passed in the HTTP Authorization header.","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\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.","type":"string"}}],"requestBody":{"content":{"application/vnd.spPortfolio.v3+json":{"schema":{"$ref":"#/components/schemas/ListPortfoliosRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.spPortfolio.v3+json":{"schema":{"$ref":"#/components/schemas/ListPortfoliosResponseContent"}}},"description":"ListPortfolios 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioAccessExceptionResponseContent"}}},"description":"PortfolioAccessException 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"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Portfolios"]}}}}