{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"CreateDealResponseContent":{"properties":{"dealId":{"description":"Amazon assigned ID unique to each Deal.","type":"string"}},"type":"object"},"Currency":{"description":"Supported Currency ISO-4217 codes.","enum":["AED","AUD","BRL","CAD","CNY","DKK","EUR","GBP","INR","JPY","MXN","NOK","NZD","SAR","SEK","SGD","TRY","USD"],"type":"string"},"Deal":{"properties":{"budgetMillis":{"description":"Numeric value for the agreed guaranteed budget for PROGRAMMATIC_GUARANTEED deal type, expressed in thousandths of hundreths of the currency base unit.","type":"number"},"currency":{"$ref":"#/components/schemas/Currency"},"dealName":{"description":"The name of the deal.","maxLength":256,"minLength":1,"type":"string"},"dealType":{"$ref":"#/components/schemas/ThirdPartyDealType"},"endDateTime":{"description":"The deal end date. Format is ISO-8601 and UTC timezone.","format":"date-time","type":"string"},"exchangeId":{"description":"ID of the Exchange where the deal is registered.","minLength":1,"type":"string"},"externalDealId":{"description":"The external \u0027Deal ID\u0027 provided by the SSP/publisher to the DSP, and advertisers will reference this ID in their correspondence with the SSP/publisher.","maxLength":150,"minLength":1,"type":"string"},"priceMillis":{"description":"Numeric value for the price, expressed in thousandths of hundreths of the currency base unit.","type":"number"},"priceType":{"$ref":"#/components/schemas/PriceType"},"publisher":{"description":"The name of the publisher providing the deal.","maxLength":150,"minLength":1,"type":"string"},"startDateTime":{"description":"The deal start date. Format is ISO-8601 and UTC timezone.","format":"date-time","type":"string"}},"required":["dealName","dealType","exchangeId","externalDealId","priceType","startDateTime"],"type":"object"},"DspBadRequestExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspConflictExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspForbiddenExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspInternalServerExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspNotFoundExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspSubError":{"properties":{"errorCode":{"type":"string"},"errorId":{"type":"string"},"errorMessage":{"type":"string"}},"required":["errorCode","errorMessage"],"type":"object"},"DspTooManyRequestsExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspUnauthorizedExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspUnsupportedMediaTypeExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"PriceType":{"enum":["FIXED_CPM","FLOOR_RATE"],"type":"string"},"ThirdPartyDealType":{"description":"The type of deal used defines the structure of the agreement between the seller and the buyer, and informs the buyer on subsequent actions and settings that may be allowed on the deal. Other settings, such as delivery guarantee and price type, may be implied by the deal type.","enum":["PREFERRED","PRIVATE_AUCTION","PROGRAMMATIC_GUARANTEED"],"type":"string"}},"securitySchemes":{}},"info":{"description":"\t\tA Deal is an object representing an inventory agreement between a buyer (advertiser or agency) and a seller \t\t(publisher or exchange). Depending on the specific type of deal, the terms, and implementation can vary. \t\tOnce created within an entity, a Deal object may be targeted by one or several line items, which sit \t\thierarchically under orders and advertisers.","title":"D16GDspApiDeals","version":"3.0"},"openapi":"3.0.1","paths":{"/dsp/inventory/deals":{"post":{"description":"Creates a third party deal object matching the submitted parameters.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"inventory_edit\"]","operationId":"CreateDeal","parameters":[{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID. Use Amazon-Ads-AccountId to get resources at advertiser level. Use Amazon-Advertising-API-Scope and leave     Amazon-Ads-AccountId empty to get resources at manager account level.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID. Use Amazon-Ads-AccountId to get resources at advertiser level. Use Amazon-Advertising-API-Scope and leave     Amazon-Ads-AccountId empty to get resources at manager account level.","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.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.","type":"string"}}],"requestBody":{"content":{"application/vnd.dspDealResource.v1+json":{"schema":{"$ref":"#/components/schemas/Deal"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDealResponseContent"}}},"description":"CreateDeal 201 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionResponseContent"}}},"description":"DspBadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnauthorizedExceptionResponseContent"}}},"description":"DspUnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspForbiddenExceptionResponseContent"}}},"description":"DspForbiddenException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspNotFoundExceptionResponseContent"}}},"description":"DspNotFoundException 404 response"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspConflictExceptionResponseContent"}}},"description":"DspConflictException 409 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnsupportedMediaTypeExceptionResponseContent"}}},"description":"DspUnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspTooManyRequestsExceptionResponseContent"}}},"description":"DspTooManyRequestsException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspInternalServerExceptionResponseContent"}}},"description":"DspInternalServerException 500 response"}},"tags":["Deal"]}},"/dsp/inventory/deals/{dealId}":{"put":{"description":"Updates a third party deal object matching the submitted parameters.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"inventory_edit\"]","operationId":"UpdateDeal","parameters":[{"description":"Deal Id of the Deal","in":"path","name":"dealId","required":true,"schema":{"description":"Deal Id of the Deal","type":"string"}},{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID. Use Amazon-Ads-AccountId to get resources at advertiser level. Use Amazon-Advertising-API-Scope and leave     Amazon-Ads-AccountId empty to get resources at manager account level.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID. Use Amazon-Ads-AccountId to get resources at advertiser level. Use Amazon-Advertising-API-Scope and leave     Amazon-Ads-AccountId empty to get resources at manager account level.","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.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.","type":"string"}}],"requestBody":{"content":{"application/vnd.dspDealResource.v1+json":{"schema":{"$ref":"#/components/schemas/Deal"}}},"required":true},"responses":{"200":{"description":"UpdateDeal 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionResponseContent"}}},"description":"DspBadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnauthorizedExceptionResponseContent"}}},"description":"DspUnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspForbiddenExceptionResponseContent"}}},"description":"DspForbiddenException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspNotFoundExceptionResponseContent"}}},"description":"DspNotFoundException 404 response"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspConflictExceptionResponseContent"}}},"description":"DspConflictException 409 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnsupportedMediaTypeExceptionResponseContent"}}},"description":"DspUnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspTooManyRequestsExceptionResponseContent"}}},"description":"DspTooManyRequestsException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspInternalServerExceptionResponseContent"}}},"description":"DspInternalServerException 500 response"}},"tags":["Deal"]}}}}