Amazon Ads API MCP

{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"AccessDeniedErrorCode":{"enum":["ACCESS_DENIED"],"type":"string"},"AccessDeniedExceptionResponseContent":{"description":"User does not have sufficient access to perform this action.","properties":{"code":{"$ref":"#/components/schemas/AccessDeniedErrorCode"},"message":{"description":"Human readable error message.","type":"string"},"requestId":{"description":"RequestId of the failed request.","type":"string"}},"required":["code","message","requestId"],"type":"object"},"AdMutationExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/InvalidArgumentErrorCode"},"message":{"description":"Human readable error message.","type":"string"},"requestId":{"description":"RequestId of the failed request.","type":"string"}},"required":["code","message","requestId"],"type":"object"},"AttributeType":{"description":"For a given audienceType, the type of the attributes being supplied.","enum":["ASIN"],"type":"string"},"AudienceCommonFieldsV1":{"properties":{"audienceId":{"description":"Audience segment identifier","type":"string"},"audienceName":{"description":"Audience name","type":"string"},"category":{"description":"Audience segment category","type":"string"},"createDate":{"format":"date-time","type":"string"},"description":{"description":"Audience description","type":"string"},"forecasts":{"properties":{"inventoryForecasts":{"properties":{"all":{"$ref":"#/components/schemas/InventoryForecastV1"}},"type":"object"}},"required":["inventoryForecasts"],"type":"object"},"status":{"enum":["Active","Deactivated","Deprecated","Failed","Pending","Processing"],"type":"string"},"subCategory":{"description":"Audience segment sub-category","type":"string"},"updateDate":{"format":"date-time","type":"string"}},"required":["audienceId","audienceName","category","description","forecasts","status"],"type":"object"},"AudienceDeleteAccessDeniedExceptionResponseContent":{"description":"User does not have sufficient access to perform this action.","properties":{"errorResponse":{"$ref":"#/components/schemas/DspAudienceDeleteResponse"}},"required":["errorResponse"],"type":"object"},"AudienceDeleteAdMutationExceptionResponseContent":{"properties":{"errorResponse":{"$ref":"#/components/schemas/DspAudienceDeleteResponse"}},"required":["errorResponse"],"type":"object"},"AudienceDeleteBadGatewayExceptionResponseContent":{"description":"Unexpected error during processing of request.","properties":{"errorResponse":{"$ref":"#/components/schemas/DspAudienceDeleteResponse"}},"required":["errorResponse"],"type":"object"},"AudienceDeleteInternalServerExceptionResponseContent":{"description":"Unexpected error during processing of request.","properties":{"errorResponse":{"$ref":"#/components/schemas/DspAudienceDeleteResponse"}},"required":["errorResponse"],"type":"object"},"AudienceDeleteThrottlingExceptionResponseContent":{"description":"Request was denied due to request throttling.","properties":{"errorResponse":{"$ref":"#/components/schemas/DspAudienceDeleteResponse"}},"required":["errorResponse"],"type":"object"},"AudienceDeleteUnauthorizedExceptionResponseContent":{"description":"Caller does not have permissions to edit specified audience.","properties":{"errorResponse":{"$ref":"#/components/schemas/DspAudienceDeleteResponse"}},"required":["errorResponse"],"type":"object"},"AudienceErrorV1":{"description":"The error response object.","properties":{"errors":{"items":{"$ref":"#/components/schemas/AudienceSubErrorV1","properties":{}},"type":"array"},"message":{"description":"A human-readable description of the response.","type":"string"},"requestId":{"description":"A value created by Amazon API Gateway that uniquely identifies your request.","type":"string"}},"type":"object"},"AudienceFilterV1":{"properties":{"field":{"description":"Field to filter by. Supported enums are 'audienceName', 'category', 'categoryPath', 'audienceId' and 'status'. The 'audienceName' is a broad match filter but not an exact match.","type":"string"},"operator":{"default":"EQ","description":"Operator to apply to the specified filter.","enum":["EQ","NOT_EQ"],"type":"string"},"values":{"items":{"type":"string"},"type":"array"}},"type":"object"},"AudienceSubErrorV1":{"description":"The sub error object.","properties":{"errorType":{"type":"string"},"fieldName":{"type":"string"},"message":{"type":"string"}},"required":["errorType","message"],"type":"object"},"AudienceType":{"description":"Type of the audience which is being edited.\nThis type must match the current audience type associated with the audienceId.","enum":["PRODUCT_PURCHASES","PRODUCT_SEARCH","PRODUCT_SIMS","PRODUCT_VIEWS"],"type":"string"},"AudienceV1":{"allOf":[{"$ref":"#/components/schemas/AudienceCommonFieldsV1"},{"oneOf":[{"$ref":"#/components/schemas/DSPAudienceFieldsV1","properties":{}},{"$ref":"#/components/schemas/SDAudienceFieldsV1","properties":{}},{"$ref":"#/components/schemas/STAudienceFieldsV1","properties":{}}]}]},"BadGatewayErrorCode":{"enum":["BAD_GATEWAY"],"type":"string"},"BadGatewayExceptionResponseContent":{"description":"Unexpected error during processing of request.","properties":{"code":{"$ref":"#/components/schemas/BadGatewayErrorCode"},"message":{"description":"Human readable error message.","type":"string"},"requestId":{"description":"RequestId of the failed request.","type":"string"}},"required":["code","message","requestId"],"type":"object"},"Clause":{"description":"parameter used to include or exclude this particular rule. Currently only include is supported.","enum":["INCLUDE"],"type":"string"},"DSPAudienceFieldsV1":{"properties":{"fees":{"description":"Fees that will apply to this segment. Not all segments have fees. Fees may differ depending on the supply type the segment is attached to. In this case, multiple fee objects will be present.","items":{"properties":{"amount":{"type":"integer"},"currency":{"enum":["AED","AUD","BRL","CAD","EUR","GBP","INR","JPY","KSA","MXN","SEK","TRY","USD"],"type":"string"},"feeCalculationType":{"type":"string"},"impressionSupplyType":{"type":"string"},"scale":{"type":"integer"}},"type":"object"},"type":"array"},"providerId":{"description":"The Data Management Platform provider identifier. Only applicable to Third party audience segments.","type":"string"}},"type":"object"},"DSPAudienceRule":{"description":"Rule to define an audience.\n\n**Rule Constraints Table**: Provides available valid combinations of parameters allowed in DspAudienceRule\n| audienceType | attributeType | attributeValues | max attribute...","properties":{"attributeType":{"$ref":"#/components/schemas/AttributeType"},"attributeValues":{"description":"For a given audienceType and attributeType combination, the attribute values being supplied.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"clause":{"$ref":"#/components/schemas/Clause"},"operator":{"$ref":"#/components/schemas/Operator"}},"required":["attributeType","attributeValues","clause","operator"],"type":"object"},"DSPInventoryForecastV1":{"properties":{"dailyImpressions":{"$ref":"#/components/schemas/ForecastBucketV1","description":"The forecasted available daily impressions for the inventory type."},"dailyReach":{"$ref":"#/components/schemas/ForecastBucketV1","description":"The forecasted unique devices reachable daily for the inventory type."}},"required":["dailyImpressions","dailyReach"],"type":"object"},"DspAudienceDeleteErrorItem":{"properties":{"audienceId":{"description":"Identifier of audience for which delete was attempted.","maxLength":128,"minLength":1,"type":"string"},"errors":{"items":{"$ref":"#/components/schemas/DspAudienceDeleteErrorItemError","properties":{}},"maxItems":7,"minItems":0,"type":"array"},"httpStatusCode":{"description":"HTTP Response Code for the request","type":"integer"},"index":{"description":"Index of the DspAudienceDeleteRequestItem from the request. e.g. 1st item in the request will correspond to index 0 in the response.","type":"integer"},"message":{"description":"A human-readable description of the response.","type":"string"},"requestId":{"type":"string"}},"required":["audienceId","errors","httpStatusCode","index","message","requestId"],"type":"object"},"DspAudienceDeleteErrorItemError":{"properties":{"errorCode":{"$ref":"#/components/schemas/ErrorType"},"errorId":{"type":"integer"},"errorMessage":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorCode","errorId","errorMessage"],"type":"object"},"DspAudienceDeleteRequestContent":{"properties":{"dspAudienceDeleteRequestItems":{"description":"A list of audiences to be deleted","items":{"$ref":"#/components/schemas/DspAudienceDeleteRequestItem"},"maxItems":1,"minItems":1,"type":"array"}},"required":["dspAudienceDeleteRequestItems"],"type":"object"},"DspAudienceDeleteRequestItem":{"properties":{"audienceId":{"description":"The audience identifier of the audience to be actioned.","maxLength":128,"minLength":1,"type":"string"},"idempotencyKey":{"description":"unique request token for this request.","pattern":"[A-Za-z1-9\\-]{1,36}","type":"string"}},"required":["audienceId","idempotencyKey"],"type":"object"},"DspAudienceDeleteResponse":{"description":"Holds an array of successful items and an array of error items from the request.","properties":{"failed":{"items":{"$ref":"#/components/schemas/DspAudienceDeleteErrorItem","properties":{}},"maxItems":1,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/DspAudienceDeleteSuccessItem","properties":{}},"maxItems":1,"minItems":0,"type":"array"}},"required":["failed","success"],"type":"object"},"DspAudienceDeleteResponseContent":{"description":"Holds an array of successful items and an array of error items from the request.","properties":{"failed":{"items":{"$ref":"#/components/schemas/DspAudienceDeleteErrorItem","properties":{}},"maxItems":1,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/DspAudienceDeleteSuccessItem","properties":{}},"maxItems":1,"minItems":0,"type":"array"}},"required":["failed","success"],"type":"object"},"DspAudienceDeleteSuccessItem":{"description":"The success response object.","properties":{"audienceId":{"description":"The audience identifier of the audience to be actioned.","maxLength":128,"minLength":1,"type":"string"},"idempotencyKey":{"description":"unique request token for this request.","type":"string"},"index":{"description":"index of the DspAudienceEditRequestItem from the request. e.g. 1st item in the request will correspond to index 0 in the response.","type":"integer"}},"required":["audienceId","idempotencyKey","index"],"type":"object"},"DspAudienceEditRequestContent":{"properties":{"dspAudienceEditRequestItems":{"description":"A list of audience edit objects containing fields to be overwritten. For each object, specify fields and their values to be modified.","items":{"$ref":"#/components/schemas/DspAudienceEditRequestItem"},"maxItems":1,"minItems":1,"type":"array"}},"required":["dspAudienceEditRequestItems"],"type":"object"},"DspAudienceEditRequestItem":{"description":"Partial audience model to be used for edit of the audience.","properties":{"audienceId":{"description":"The audience identifier of the audience to be actioned.","maxLength":128,"minLength":1,"type":"string"},"audienceType":{"$ref":"#/components/schemas/AudienceType"},"description":{"description":"The audience description.","maxLength":1000,"minLength":1,"type":"string"},"idempotencyKey":{"description":"unique request token for this request.","pattern":"[A-Za-z1-9\\-]{1,36}","type":"string"},"lookback":{"description":"The specified time period (in days) to include those who performed the action in the audience.\nLookback Constraints Table: Provides available valid values of lookback allowed for given audienceType\n|...","maximum":365,"minimum":1,"type":"integer"},"name":{"description":"The audience name.","maxLength":128,"minLength":1,"type":"string"},"rules":{"description":"Set of rules to define an audience, these rules will be ORed.","items":{"$ref":"#/components/schemas/DSPAudienceRule"},"maxItems":1,"minItems":1,"type":"array"}},"required":["audienceId","audienceType","idempotencyKey"],"type":"object"},"DspAudienceEditResponseContent":{"description":"Holds an array of successful items and an array of error items from the request.","properties":{"failed":{"items":{"$ref":"#/components/schemas/DspAudienceErrorItem","properties":{}},"maxItems":1,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/DspAudienceSuccessItem","properties":{}},"maxItems":1,"minItems":0,"type":"array"}},"required":["failed","success"],"type":"object"},"DspAudienceErrorItem":{"properties":{"audienceId":{"description":"Identifier of audience for which edit was attempted.","maxLength":128,"minLength":1,"type":"string"},"errors":{"items":{"$ref":"#/components/schemas/DspAudienceErrorItemError","properties":{}},"maxItems":7,"minItems":0,"type":"array"},"idempotencyKey":{"description":"unique request token for this request.","type":"string"},"index":{"description":"Index of the DspAudienceEditRequestItem from the request. e.g. 1st item in the request will correspond to index 0 in the response.","type":"integer"},"message":{"description":"A human-readable description of the response.","type":"string"}},"required":["audienceId","errors","idempotencyKey","index","message"],"type":"object"},"DspAudienceErrorItemError":{"properties":{"errorType":{"$ref":"#/components/schemas/ErrorType"},"fieldName":{"type":"string"},"message":{"type":"string"}},"required":["errorType","message"],"type":"object"},"DspAudienceSuccessItem":{"description":"The success response object.","properties":{"audienceId":{"description":"The audience identifier of the audience to be actioned.","maxLength":128,"minLength":1,"type":"string"},"idempotencyKey":{"description":"unique request token for this request.","type":"string"},"index":{"description":"index of the DspAudienceEditRequestItem from the request. e.g. 1st item in the request will correspond to index 0 in the response.","type":"integer"}},"required":["audienceId","idempotencyKey","index"],"type":"object"},"ErrorType":{"enum":["OTHER","VALUE_INVALID","VALUE_NOT_FOUND","VALUE_OUT_OF_RANGE"],"type":"string"},"FetchTaxonomyNodeV1":{"properties":{"audienceCount":{"format":"int64","type":"integer"},"category":{"type":"string"}},"type":"object"},"FetchTaxonomyRequestBodyV1":{"description":"The response data will have the categories that are under the given path, and main categories will be returned if no path is specified. The response data also depends on the adType specified here since ad programs may support targeting audiences in certain categories.","properties":{"adType":{"enum":["DSP","SD","ST"],"type":"string"},"categoryPath":{"items":{"type":"string"},"type":"array"},"countries":{"description":"The ISO Alpha-2 country codes to search audiences from. This field must be specified if the advertiser does not have an associated country. Currently, it is only supported to specify a single country per request.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"type":"object"},"FetchTaxonomyResponseV1":{"properties":{"categories":{"items":{"$ref":"#/components/schemas/FetchTaxonomyNodeV1","properties":{}},"type":"array"},"categoryPath":{"items":{"properties":{},"type":"string"},"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"ForecastBucketV1":{"properties":{"lowerBoundInclusive":{"description":"The inclusive lower bound for the bucket. If not specified, the bucket captures all values below the upper bound.","format":"int64","type":"integer"},"upperBoundExclusive":{"description":"The exclusive upper bound for the bucket. If not specified, the bucket captures all values above the lower bound.","format":"int64","type":"integer"}},"type":"object"},"InternalErrorErrorCode":{"enum":["INTERNAL_ERROR"],"type":"string"},"InternalServerExceptionResponseContent":{"description":"Unexpected error during processing of request.","properties":{"code":{"$ref":"#/components/schemas/InternalErrorErrorCode"},"message":{"description":"Human readable error message.","type":"string"},"requestId":{"description":"RequestId of the failed request.","type":"string"}},"required":["code","message","requestId"],"type":"object"},"InvalidArgumentErrorCode":{"enum":["INVALID_ARGUMENT"],"type":"string"},"InventoryForecastV1":{"oneOf":[{"$ref":"#/components/schemas/DSPInventoryForecastV1"},{"$ref":"#/components/schemas/SDInventoryForecastV1"},{"$ref":"#/components/schemas/STInventoryForecastV1"}]},"ListAudiencesRequestBodyV1":{"description":"Resulting segments will match all specified filters","properties":{"adType":{"enum":["DSP","SD","ST"],"type":"string"},"countries":{"description":"The ISO Alpha-2 country codes to search audiences from. This field must be specified if the advertiser does not have an associated country. Currently, it is only supported to specify a single country per request.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"filters":{"items":{"$ref":"#/components/schemas/AudienceFilterV1"},"type":"array"}},"type":"object"},"ListAudiencesResponseV1":{"properties":{"audiences":{"description":"Array of segments matching given filters sorted by create time, earliest first.","items":{"$ref":"#/components/schemas/AudienceV1","properties":{}},"type":"array"},"matchCount":{"format":"int64","type":"integer"},"nextToken":{"type":"string"}},"type":"object"},"NotFoundErrorCode":{"enum":["NOT_FOUND"],"type":"string"},"Operator":{"description":"For a given attributeType, operator used for attributeValues.","enum":["ONE_OF"],"type":"string"},"ResourceNotFoundExceptionResponseContent":{"description":"Request references a resource which does not exist.","properties":{"code":{"$ref":"#/components/schemas/NotFoundErrorCode"},"message":{"description":"Human readable error message.","type":"string"},"requestId":{"description":"RequestId of the failed request.","type":"string"}},"required":["code","message","requestId"],"type":"object"},"SDAudienceFieldsV1":{"type":"object"},"SDInventoryForecastV1":{"properties":{"dailyReach":{"$ref":"#/components/schemas/ForecastBucketV1","description":"The forecasted unique devices reachable daily for the inventory type."}},"required":["dailyReach"],"type":"object"},"STAudienceFieldsV1":{"type":"object"},"STInventoryForecastV1":{"properties":{"dailyReach":{"$ref":"#/components/schemas/ForecastBucketV1","description":"The forecasted unique devices reachable daily for the inventory type."}},"required":["dailyReach"],"type":"object"},"ThrottledErrorCode":{"enum":["THROTTLED"],"type":"string"},"ThrottlingExceptionResponseContent":{"description":"Request was denied due to request throttling.","properties":{"code":{"$ref":"#/components/schemas/ThrottledErrorCode"},"message":{"description":"Human readable error message.","type":"string"},"requestId":{"description":"RequestId of the failed request.","type":"string"}},"required":["code","message","requestId"],"type":"object"},"UnauthorizedErrorCode":{"enum":["UNAUTHORIZED"],"type":"string"},"UnauthorizedExceptionResponseContent":{"description":"Caller does not have permissions to edit specified audience.","properties":{"code":{"$ref":"#/components/schemas/UnauthorizedErrorCode"},"message":{"description":"Human readable error message.","type":"string"},"requestId":{"description":"RequestId of the failed request.","type":"string"}},"required":["code","message","requestId"],"type":"object"}},"securitySchemes":{}},"info":{"title":"Audiences","version":"3.0"},"openapi":"3.0.1","paths":{"/audiences/list":{"post":{"description":"Returns a list of audience segments for an advertiser. The result set can be filtered by providing an array of Filter objects. Each item in the resulting set will match all specified filters.","operationId":"listAudiences","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"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.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}},{"description":"The advertiser to retrieve segments for. This parameter is required for the DSP adType, but optional for the SD adType.","in":"query","name":"advertiserId","required":false,"schema":{"type":"string"}},{"description":"When set to true, only targetable audience segments will be returned.","in":"query","name":"canTarget","required":false,"schema":{"default":"false","type":"boolean"}},{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","in":"query","name":"nextToken","required":false,"schema":{"type":"string"}},{"description":"Sets the maximum number of audiences in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. For example, supplying maxResults=20 with a previously returned token will fetch up to the next 20 items. In some cases, fewer items may be returned.","in":"query","name":"maxResults","required":false,"schema":{"default":"10","maximum":250,"minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAudiencesRequestBodyV1"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAudiencesResponseV1"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceErrorV1"}}},"description":"Bad Request. The request could not be processed or handled. Please correct the issues specified and try again."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceErrorV1"}}},"description":"Forbidden. The request failed because the user is unauthenticated or does not have access to the specified resource."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceErrorV1"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceErrorV1"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Gets audience segments based on filters","tags":["Discovery"]}},"/audiences/taxonomy/list":{"post":{"description":"Returns a list of audience categories for a given category path\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Advertising-AccountId\n\n**Param...","operationId":"fetchTaxonomy","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"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.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}},{"description":"The advertiser associated with the advertising account. This parameter is required for the DSP adType, but optional for the SD adType.","in":"query","name":"advertiserId","required":false,"schema":{"type":"string"}},{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","in":"query","name":"nextToken","required":false,"schema":{"type":"string"}},{"description":"Sets the maximum number of categories in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. For example, supplying maxResults=20 with a previously returned token will fetch up to the next 20 items. In some cases, fewer items may be returned.","in":"query","name":"maxResults","required":false,"schema":{"default":"250","maximum":250,"minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchTaxonomyRequestBodyV1"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchTaxonomyResponseV1"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceErrorV1"}}},"description":"Bad Request. The request could not be processed or handled. Please correct the issues specified and try again."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceErrorV1"}}},"description":"Forbidden. The request failed because the user is unauthenticated or does not have access to the specified resource."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceErrorV1"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceErrorV1"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Browse the taxonomy of audience categories","tags":["Discovery"]}},"/dsp/audiences/delete":{"post":{"description":"Deletes an existing targeting audience based on audience ID. Only available for the audiences of the type: *PRODUCT_PURCHASES*, *PRODUCT_VIEWS*, *PRODUCT_SIMS*, *PRODUCT_SEARCH* and *COMBINED_AUDIENCE*\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"audiences_edit\"]","operationId":"DspAudienceDelete","parameters":[{"description":"ID that describe DSP advertiser level accounts that exists under a manager account (previously under a DSP entity). The owner of the audience.","examples":{"DspAudienceDelete_example1":{"summary":"Audience Delete Success example.","value":"592059203698558089"},"DspAudienceDelete_example2":{"summary":"Audience Delete Failure Example.","value":"592059203698558000"}},"in":"header","name":"AdvertiserId","required":true,"schema":{"description":"ID that describe DSP advertiser level accounts that exists under a manager account (previously under a DSP entity). The owner of the audience.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","examples":{"DspAudienceDelete_example1":{"summary":"Audience Delete Success example.","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"},"DspAudienceDelete_example2":{"summary":"Audience Delete Failure Example.","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"}},"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.","examples":{"DspAudienceDelete_example1":{"summary":"Audience Delete Success example.","value":"3900820857650036"},"DspAudienceDelete_example2":{"summary":"Audience Delete Failure Example.","value":"3900820857650000"}},"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.dspaudiences.v1+json":{"schema":{"$ref":"#/components/schemas/DspAudienceDeleteRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.dspaudiences.v1+json":{"schema":{"$ref":"#/components/schemas/DspAudienceDeleteResponseContent"}}},"description":"DspAudienceDelete 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceDeleteAdMutationExceptionResponseContent"}}},"description":"AudienceDeleteAdMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceDeleteUnauthorizedExceptionResponseContent"}}},"description":"AudienceDeleteUnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceDeleteAccessDeniedExceptionResponseContent"}}},"description":"AudienceDeleteAccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceDeleteThrottlingExceptionResponseContent"}}},"description":"AudienceDeleteThrottlingException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceDeleteInternalServerExceptionResponseContent"}}},"description":"AudienceDeleteInternalServerException 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceDeleteBadGatewayExceptionResponseContent"}}},"description":"AudienceDeleteBadGatewayException 502 response"}},"tags":["Ads"]}},"/dsp/audiences/edit":{"put":{"description":"Updates an existing targeting audience based on an audience definition and audience ID.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"audiences_edit\"]","operationId":"DspAudienceEdit","parameters":[{"description":"ID that describe DSP advertiser level accounts that exists under a manager account (previously under a DSP entity). The owner of the audience.","examples":{"DspAudienceEdit_example1":{"summary":"Audience Edit example.","value":"myAdvertiserId"}},"in":"header","name":"AdvertiserId","required":true,"schema":{"description":"ID that describe DSP advertiser level accounts that exists under a manager account (previously under a DSP entity). The owner of the audience.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","examples":{"DspAudienceEdit_example1":{"summary":"Audience Edit example.","value":"myClientId"}},"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.","examples":{"DspAudienceEdit_example1":{"summary":"Audience Edit example.","value":"myAPIScope"}},"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.dspaudiences.v1+json":{"schema":{"$ref":"#/components/schemas/DspAudienceEditRequestContent"}}},"required":true},"responses":{"200":{"content":{"application/vnd.dspaudiences.v1+json":{"schema":{"$ref":"#/components/schemas/DspAudienceEditResponseContent"}}},"description":"DspAudienceEdit 200 response"},"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"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 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"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayExceptionResponseContent"}}},"description":"BadGatewayException 502 response"}},"tags":["Ads"]}}}}