{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"AUDIENCESTATUS":{"description":"Status of audiences.","enum":["Active","Deactivated","Deprecated","Failed","Processing"],"type":"string"},"AudienceTargetingExpression":{"properties":{"audiences":{"description":"Specify groups of audiences to include or exclude when targeting.\u003cul\u003e\u003cli\u003eIncluded groups are joined by an intersection. Users must be in all of the groups specified to be included.\u003c/li\u003e\u003cli\u003eAudiences within a group are joined by a union. Users can be in any of the audiences specified to be included/excluded.\u003c/li\u003e\u003cli\u003eUsers within the same group must either be included or excluded.\u003c/li\u003e\u003cli\u003eYou can specify up to 10 groups to be included, but only 1 group to be excluded.\u003c/li\u003e\u003cli\u003eUp to 100 audienceIds can be specified per group.\u003c/li\u003e\u003cul\u003e","items":{"$ref":"#/components/schemas/AudienceV1"},"maxItems":100,"minItems":1,"type":"array"}},"required":["audiences"],"type":"object"},"AudienceV1":{"properties":{"audienceId":{"description":"An audience identifier retrieved from the audiences/list resource.","type":"string"},"groupId":{"description":"A customer-provided string used to create a group of audiences. This string is only used for this single request. Amazon does not store it.","type":"string"},"negative":{"description":"Whether to include (false) or exclude (true) audiences when targeting. Only one state may be used per groupId.","type":"boolean"}},"required":["audienceId","groupId","negative"],"type":"object"},"CURRENCY":{"description":"The supported currencies.","enum":["AED","AUD","BRL","CAD","EUR","GBP","INR","JPY","MXN","SAR","SEK","TRY","USD"],"type":"string"},"CreateCombinedAudienceRequestBody":{"properties":{"description":{"description":"The combined audience description.","maxLength":1000,"minLength":1,"type":"string"},"idempotencyKey":{"description":"The unique UUID for this requested audience.","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"inputExpression":{"$ref":"#/components/schemas/Expression"},"name":{"description":"The combined audience name.","maxLength":128,"minLength":1,"type":"string"}},"required":["description","idempotencyKey","inputExpression","name"],"type":"object"},"CreateCombinedAudienceResponseContent":{"properties":{"audienceId":{"description":"The audience identifier.","type":"string"}},"required":["audienceId"],"type":"object"},"DspBadRequestExceptionV1ResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubErrorV1"},"maxItems":100,"minItems":1,"type":"array"},"message":{"type":"string"},"requestId":{"type":"string"}},"type":"object"},"DspConflictExceptionV1ResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubErrorV1"},"maxItems":100,"minItems":1,"type":"array"},"message":{"type":"string"},"requestId":{"type":"string"}},"type":"object"},"DspForbiddenExceptionV1ResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubErrorV1"},"maxItems":100,"minItems":1,"type":"array"},"message":{"type":"string"},"requestId":{"type":"string"}},"type":"object"},"DspInternalServerExceptionV1ResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubErrorV1"},"maxItems":100,"minItems":1,"type":"array"},"message":{"type":"string"},"requestId":{"type":"string"}},"type":"object"},"DspNotFoundExceptionV1ResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubErrorV1"},"maxItems":100,"minItems":1,"type":"array"},"message":{"type":"string"},"requestId":{"type":"string"}},"type":"object"},"DspSubErrorV1":{"properties":{"errorType":{"type":"string"},"fieldName":{"type":"string"},"message":{"type":"string"}},"required":["errorType","message"],"type":"object"},"DspTooManyRequestsExceptionV1ResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubErrorV1"},"maxItems":100,"minItems":1,"type":"array"},"message":{"type":"string"},"requestId":{"type":"string"}},"type":"object"},"DspUnauthorizedExceptionV1ResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubErrorV1"},"maxItems":100,"minItems":1,"type":"array"},"message":{"type":"string"},"requestId":{"type":"string"}},"type":"object"},"DspUnsupportedMediaTypeExceptionV1ResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubErrorV1"},"maxItems":100,"minItems":1,"type":"array"},"message":{"type":"string"},"requestId":{"type":"string"}},"type":"object"},"Expression":{"description":"The expression should consist of audience targeting expression.","properties":{"audienceTargetingExpression":{"$ref":"#/components/schemas/AudienceTargetingExpression"}},"type":"object"},"ExternalAudienceForecast":{"description":"Forecast for an audience.","properties":{"dailyImpressions":{"$ref":"#/components/schemas/ForecastBucket"},"dailyReach":{"$ref":"#/components/schemas/ForecastBucket"}},"type":"object"},"Fee":{"description":"Fee applied to a segment.","properties":{"amount":{"description":"Fee amount in base currency units, multiplied by scaling factor (\u0027scale\u0027).","type":"number"},"currency":{"$ref":"#/components/schemas/CURRENCY"},"feeCalculationType":{"description":"How the fee is applied.","type":"string"},"impressionSupplyType":{"description":"To which supply types this fee applies to. The fee may be different for different supply types.","type":"string"},"scale":{"description":"Scale of the amount relative to the base currency unit. For instance, if the scale is 1000, the currency is USD, and the amount is 500, the human-readable fee is $0.50.","type":"number"}},"type":"object"},"ForecastBucket":{"description":"Bucket containing lower and upper bounds for forecast.","properties":{"lowerBoundInclusive":{"description":"minimum number of devices reached/ minimum number of available impressions.","type":"number"},"upperBoundExclusive":{"description":"maximum number of devices reached/ maximum number of available impressions.","type":"number"}},"type":"object"},"GetCombinedAudienceDetailsResponseContent":{"properties":{"audienceId":{"description":"Audience segment identifier.","type":"string"},"audienceName":{"description":"Audience name.","type":"string"},"category":{"description":"Audience segment category.","type":"string"},"createDate":{"description":"Audience creation date.","format":"date-time","type":"string"},"description":{"description":"Audience description.","type":"string"},"expression":{"$ref":"#/components/schemas/Expression"},"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":{"$ref":"#/components/schemas/Fee"},"maxItems":168,"minItems":0,"type":"array"},"forecast":{"$ref":"#/components/schemas/ExternalAudienceForecast"},"status":{"$ref":"#/components/schemas/AUDIENCESTATUS"},"subCategory":{"description":"Audience segment sub-category.","type":"string"},"updateDate":{"description":"Audience update date.","format":"date-time","type":"string"}},"required":["audienceId","audienceName","category","createDate","description","expression","status"],"type":"object"}},"securitySchemes":{}},"info":{"description":"DSP Combined Audience API.","title":"Combined Audience API","version":"3.0"},"openapi":"3.0.1","paths":{"/dsp/audiences/combinedAudiences":{"post":{"description":"Creates a new combined audience based on the input audience expression.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Advertising-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_edit\"]","operationId":"CreateCombinedAudience","parameters":[{"description":"The identifier of the advertiser, retrieved from /dsp/advertisers, that you\u0027d like to retrieve insights for.","in":"query","name":"advertiserId","required":true,"schema":{"description":"The identifier of the advertiser, retrieved from /dsp/advertisers, that you\u0027d like to retrieve insights for.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","type":"string"}}],"requestBody":{"content":{"application/vnd.createcombinedaudiencerequestbody.v1+json":{"examples":{"CreateCombinedAudience_example1":{"description":"An example request of create combined audience.","summary":"This example uses the audience Targeting Expression to create a combined audience.","value":{"description":"This is my combined audience for targeting males who are coffee lovers.","idempotencyKey":"edc151c2-3728-4f07-36d1-cf218c4d5c5d","inputExpression":{"audienceTargetingExpression":{"audiences":[{"audienceId":"375708607609104723","groupId":"group1","negative":"false"},{"audienceId":"409494242014254223","groupId":"group1","negative":"false"}]}},"name":"Male coffee lovers"}}},"schema":{"$ref":"#/components/schemas/CreateCombinedAudienceRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/vnd.createcombinedaudienceresponse.v1+json":{"examples":{"CreateCombinedAudience_example1":{"description":"Successful operation.","summary":"An example response of create combined audience.","value":{"audienceId":431077023057010923}}},"schema":{"$ref":"#/components/schemas/CreateCombinedAudienceResponseContent"}}},"description":"CreateCombinedAudience 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionV1ResponseContent"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnauthorizedExceptionV1ResponseContent"}}},"description":"Unauthenticated request."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspForbiddenExceptionV1ResponseContent"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspNotFoundExceptionV1ResponseContent"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspConflictExceptionV1ResponseContent"}}},"description":"DspConflictExceptionV1 409 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnsupportedMediaTypeExceptionV1ResponseContent"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspTooManyRequestsExceptionV1ResponseContent"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspInternalServerExceptionV1ResponseContent"}}},"description":"Internal Server Error."}},"tags":["Combined Audience API"]}},"/dsp/audiences/combinedAudiences/{audienceId}":{"get":{"description":"Gets details of an existing combined audience.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Advertising-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_edit\"]","operationId":"GetCombinedAudienceDetails","parameters":[{"description":"The audience identifier.","in":"path","name":"audienceId","required":true,"schema":{"description":"The audience identifier.","type":"string"}},{"description":"The identifier of the advertiser, retrieved from /dsp/advertisers, that you\u0027d like to retrieve insights for.","in":"query","name":"advertiserId","required":true,"schema":{"description":"The identifier of the advertiser, retrieved from /dsp/advertisers, that you\u0027d like to retrieve insights for.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","type":"string"}}],"responses":{"200":{"content":{"application/vnd.getcombinedaudiencedetailsresponse.v1+json":{"examples":{"GetCombinedAudience_example1":{"description":"Successful operation.","summary":"An example response of get combined audience","value":{"audienceId":431077023057010923,"audienceName":"Male coffee lovers","category":"Combined audience","createDate":"2023-06-14T13:20:34.474Z","description":"This is my combined audience for targeting males who are coffee lovers.","expression":{"audienceTargetingExpression":{"audiences":[{"audienceId":"375708607609104723","groupId":"group1","negative":"false"},{"audienceId":"409494242014254223","groupId":"group1","negative":"false"}]}},"status":"Active"}}},"schema":{"$ref":"#/components/schemas/GetCombinedAudienceDetailsResponseContent"}}},"description":"GetCombinedAudienceDetails 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionV1ResponseContent"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnauthorizedExceptionV1ResponseContent"}}},"description":"Unauthenticated request."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspForbiddenExceptionV1ResponseContent"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspNotFoundExceptionV1ResponseContent"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspConflictExceptionV1ResponseContent"}}},"description":"DspConflictExceptionV1 409 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnsupportedMediaTypeExceptionV1ResponseContent"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspTooManyRequestsExceptionV1ResponseContent"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspInternalServerExceptionV1ResponseContent"}}},"description":"Internal Server Error."}},"tags":["Combined Audience API"]}}}}