{"openapi":"3.0.3","info":{"title":"Marketplace Resources","version":"2.0.0","description":"Buzz API v2"},"paths":{"/marketplace/deals":{"get":{"operationId":"deals_list","description":"Retrieve a list of all available marketplace deals.","summary":"List marketplace deals","parameters":[{"in":"query","name":"advertiser_id","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__equals_or_null","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__gt","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__gte","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"advertiser_id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"advertiser_id__lt","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__lte","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__not","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id","schema":{"type":"string"}},{"in":"query","name":"alternative_id__contains","schema":{"type":"string"}},{"in":"query","name":"alternative_id__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"alternative_id__not","schema":{"type":"string"}},{"in":"query","name":"alternative_id__not_contains","schema":{"type":"string"}},{"in":"query","name":"alternative_id__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id__not_startswith","schema":{"type":"string"}},{"in":"query","name":"alternative_id__startswith","schema":{"type":"string"}},{"in":"query","name":"archived","schema":{"type":"boolean"},"description":"Archived deals cannot be selected for targeting"},{"in":"query","name":"create_date","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__gt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__gte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__isempty","schema":{"type":"boolean"}},{"in":"query","name":"create_date__lt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__lte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__range","schema":{"type":"string","format":"date-time","nullable":true,"enum":["future","last_14_complete_days","last_14_days","last_24_hours","last_30_complete_days","last_30_days","last_365_complete_days","last_365_days","last_7_complete_days","last_7_days","last_90_complete_days","last_90_days","last_month","last_quarter","last_week","last_year","past","this_month","this_quarter","this_week","this_year","today","until_past_24_hours","yesterday"]},"description":"The date and time the object was first created\n\n* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"},{"in":"query","name":"deal_format","schema":{"type":"string"}},{"in":"query","name":"deal_format__equals_or_null","schema":{"type":"string"}},{"in":"query","name":"deal_format__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"deal_format__isempty","schema":{"type":"string"}},{"in":"query","name":"deal_format__not","schema":{"type":"string"}},{"in":"query","name":"deal_format__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"deal_id","schema":{"type":"string"}},{"in":"query","name":"deal_id__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"deal_id__isempty","schema":{"type":"string"}},{"in":"query","name":"deal_id__not","schema":{"type":"string"}},{"in":"query","name":"deal_id__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"end_date__range_or_null","schema":{"type":"string","format":"date-time","nullable":true,"enum":["future","last_14_complete_days","last_14_days","last_24_hours","last_30_complete_days","last_30_days","last_365_complete_days","last_365_days","last_7_complete_days","last_7_days","last_90_complete_days","last_90_days","last_month","last_quarter","last_week","last_year","past","this_month","this_quarter","this_week","this_year","today","until_past_24_hours","yesterday"]},"description":"* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"},{"in":"query","name":"id","schema":{"type":"number"}},{"in":"query","name":"id__gt","schema":{"type":"number"}},{"in":"query","name":"id__gte","schema":{"type":"number"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__lt","schema":{"type":"number"}},{"in":"query","name":"id__lte","schema":{"type":"number"}},{"in":"query","name":"id__not","schema":{"type":"number"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"inventory_source_key","schema":{"type":"string"}},{"in":"query","name":"inventory_source_viewable","schema":{"type":"boolean"},"description":"Viewability of the inventory source"},{"in":"query","name":"marketplace_status","schema":{"type":"string","enum":["draft","ordered"]},"description":"One of: `\"draft\"`, `\"ordered\"`\n\n* `draft` - Draft\n* `ordered` - Ordered"},{"in":"query","name":"marketplace_status__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"marketplace_status__isempty","schema":{"type":"boolean"}},{"in":"query","name":"marketplace_status__not","schema":{"type":"string","enum":["draft","ordered"]},"description":"One of: `\"draft\"`, `\"ordered\"`\n\n* `draft` - Draft\n* `ordered` - Ordered"},{"in":"query","name":"marketplace_status__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"string"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"restricted_adomains__contains","schema":{"type":"string"}},{"in":"query","name":"restricted_adomains__not_contains","schema":{"type":"string"}},{"in":"query","name":"update_date","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__gt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__gte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__isempty","schema":{"type":"boolean"}},{"in":"query","name":"update_date__lt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__lte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__range","schema":{"type":"string","format":"date-time","nullable":true,"enum":["future","last_14_complete_days","last_14_days","last_24_hours","last_30_complete_days","last_30_days","last_365_complete_days","last_365_days","last_7_complete_days","last_7_days","last_90_complete_days","last_90_days","last_month","last_quarter","last_week","last_year","past","this_month","this_quarter","this_week","this_year","today","until_past_24_hours","yesterday"]},"description":"The date and time the object was last updated\n\n* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"}],"tags":["Marketplace Deals"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedMarketplaceDealListList"}}},"description":"Marketplace deals retrieved successfully."},"403":{"description":"Permission denied."},"500":{"description":"Unexpected server error."}}},"post":{"operationId":"deals_create","description":"Create a new marketplace deal with the provided details.","summary":"Create a marketplace deal","tags":["Marketplace Deals"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketplaceDeal"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/MarketplaceDeal"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/MarketplaceDeal"}}},"required":true},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketplaceDeal"}}},"description":"Marketplace deal created successfully."},"400":{"description":"Invalid request data."},"403":{"description":"Permission denied."}}}},"/marketplace/deals/{id}":{"get":{"operationId":"deals_retrieve","description":"Retrieve a single marketplace deal by its unique ID.","summary":"Retrieve a marketplace deal","parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this marketplace deal.","required":true}],"tags":["Marketplace Deals"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketplaceDeal"}}},"description":"Marketplace deal retrieved successfully."},"403":{"description":"Permission denied."},"404":{"description":"Marketplace deal not found."}}},"put":{"operationId":"deals_update","description":"Update an existing marketplace deal by ID.","summary":"Update a marketplace deal","parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this marketplace deal.","required":true}],"tags":["Marketplace Deals"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketplaceDeal"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/MarketplaceDeal"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/MarketplaceDeal"}}},"required":true},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketplaceDeal"}}},"description":"Marketplace deal updated successfully."},"400":{"description":"Invalid update data."},"404":{"description":"Marketplace deal not found."}}},"patch":{"operationId":"deals_partial_update","description":"Perform a partial update on a marketplace deal by ID.","summary":"Partially update a marketplace deal","parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this marketplace deal.","required":true}],"tags":["Marketplace Deals"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchedMarketplaceDeal"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/PatchedMarketplaceDeal"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/PatchedMarketplaceDeal"}}}},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketplaceDeal"}}},"description":"Marketplace deal partially updated successfully."},"400":{"description":"Invalid update data."},"404":{"description":"Marketplace deal not found."}}},"delete":{"operationId":"deals_destroy","description":"Delete a specific marketplace deal by ID.","summary":"Delete a marketplace deal","parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this marketplace deal.","required":true}],"tags":["Marketplace Deals"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"204":{"description":"Marketplace deal deleted successfully."},"400":{"description":"Delete blocked due to business rules."},"404":{"description":"Marketplace deal not found."}}}},"/marketplace/deals/{id}/order":{"post":{"operationId":"deals_order_create","description":"Convert a draft marketplace deal into an ordered deal.","summary":"Order a draft marketplace deal","parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this marketplace deal.","required":true}],"tags":["Marketplace Deals"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketplaceDeal"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/MarketplaceDeal"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/MarketplaceDeal"}}},"required":true},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketplaceDeal"}}},"description":"Marketplace deal ordered successfully."},"400":{"description":"Deal cannot be ordered."},"404":{"description":"Marketplace deal not found."}}}},"/marketplace/freewheel/ref/advertiser-industries/{id}":{"get":{"operationId":"freewheel_ref_advertiser_industries_list","description":"Returns a list of industries associated with the given advertiser. The advertiser must have a valid Freewheel advertiser ID. If no Freewheel advertiser ID exists, a 404 error is returned.","summary":"Get Freewheel advertiser industries","parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"description":"Advertiser ID (Buzz advertiser ID)","required":true}],"tags":["Reference"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedIndustryList"}}},"description":"Industries retrieved successfully."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"404":{"description":"Advertiser not found or advertiser has no Freewheel advertiser ID."},"500":{"description":"Internal server error."}}}},"/marketplace/freewheel/ref/dmas":{"get":{"operationId":"freewheel_ref_dmas_list","description":"Returns the full list of DMAs (Designated Market Areas) from the FreeWheel Campaign Management API. This endpoint proxies `/demand/v1/dmas`.","summary":"Get FreeWheel DMA list","tags":["Reference"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedDMAList"}}},"description":"DMA list retrieved successfully."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."},"502":{"description":"Failed to fetch DMAs from FreeWheel."}}}},"/marketplace/freewheel/ref/industries":{"get":{"operationId":"freewheel_ref_industries_list","description":"Returns the full list of Industries from the FreeWheel Campaign Management API. This endpoint proxies FreeWheel’s `/demand/v1/industries`.","summary":"Get FreeWheel industry list","tags":["Reference"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedIndustryList"}}},"description":"Industry list retrieved successfully."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."},"502":{"description":"Failed to fetch industries from FreeWheel."}}}},"/marketplace/freewheel/ref/standard-attributes":{"get":{"operationId":"freewheel_ref_standard_attributes_list","description":"Returns the Standard Attributes from the FreeWheel Campaign Management API. This proxies `/demand/v1/accounts/{account_id}/standard_attributes`. The FreeWheel API returns a dictionary of lists, which is transformed into a flat list of attribute objects for consistency.","summary":"Get FreeWheel standard attributes","tags":["Reference"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedStandardAttributeList"}}},"description":"Standard attributes retrieved successfully."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."},"502":{"description":"Failed to fetch attributes from FreeWheel."}}}}},"components":{"schemas":{"AdvertiserIndustry":{"type":"object","properties":{"industry_id":{"type":"integer"}},"required":["industry_id"]},"BrandField":{"type":"object","properties":{"include":{"type":"array","items":{"type":"integer"}}},"required":["include"]},"BudgetModelEnum":{"enum":["CURRENCY"],"type":"string","description":"* `CURRENCY` - CURRENCY"},"ContentGenreField":{"type":"object","properties":{"include":{"type":"array","items":{"type":"integer"}}},"required":["include"]},"CountryField":{"type":"object","properties":{"include":{"type":"array","items":{"type":"integer"}}}},"CreativeDurationEnum":{"enum":[6,15,30,60,90,120],"type":"integer","description":"* `6` - 6\n* `15` - 15\n* `30` - 30\n* `60` - 60\n* `90` - 90\n* `120` - 120"},"DMA":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name"]},"DealFormatEnum":{"enum":["banner","video","native","audio"],"type":"string","description":"* `banner` - Banner\n* `video` - Video\n* `native` - Native\n* `audio` - Audio"},"DealTypeEnum":{"enum":["open_auction","private_auction","preferred","guaranteed"],"type":"string","description":"* `open_auction` - Open Auction\n* `private_auction` - Private Auction\n* `preferred` - Preferred\n* `guaranteed` - Guaranteed"},"DeviceField":{"type":"object","properties":{"include":{"type":"array","items":{"type":"integer"}}},"required":["include"]},"DmaField":{"type":"object","properties":{"include":{"type":"array","items":{"type":"integer"}},"exclude":{"type":"array","items":{"type":"integer"}}}},"EnvironmentField":{"type":"object","properties":{"include":{"type":"array","items":{"type":"integer"}}},"required":["include"]},"FreeWheelMarketplaceDealDetailsField":{"type":"object","properties":{"transaction_type":{"$ref":"#/components/schemas/TransactionTypeEnum"},"advertiser":{"$ref":"#/components/schemas/AdvertiserIndustry"},"audience_id":{"type":"integer"},"budget_model":{"$ref":"#/components/schemas/BudgetModelEnum"},"currency_goal":{"type":"string","format":"decimal","pattern":"^-?\\d{0,12}(?:\\.\\d{0,2})?$"},"creative_duration":{"$ref":"#/components/schemas/CreativeDurationEnum"},"targeting":{"$ref":"#/components/schemas/TargetingField"},"frequency_cap":{"$ref":"#/components/schemas/FrequencyCapField"},"forecast":{"type":"object","additionalProperties":{}},"status":{"type":"string"}},"required":["advertiser","budget_model","creative_duration","frequency_cap","targeting","transaction_type"]},"FrequencyCapField":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TypeEnum"},"cap":{"type":"integer"},"period":{"$ref":"#/components/schemas/PeriodEnum"}},"required":["period"]},"GeoTargetingField":{"type":"object","properties":{"dma":{"$ref":"#/components/schemas/DmaField"},"country":{"allOf":[{"$ref":"#/components/schemas/CountryField"}],"default":{"include":[165]}}}},"Industry":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name"]},"LanguageField":{"type":"object","properties":{"include":{"type":"array","items":{"type":"integer"}}},"required":["include"]},"MarketplaceDeal":{"type":"object","description":"This serializer only contains validation for shape and format, not values.\nIt is used in the adapter so we can adapt without validating date values.","properties":{"id":{"type":"integer","readOnly":true},"inventory_source_key":{"type":"string"},"archived":{"type":"boolean","default":true},"advertiser_id":{"type":"integer"},"details":{"$ref":"#/components/schemas/FreeWheelMarketplaceDealDetailsField"},"remote_key":{"type":"string"},"deal_id":{"type":"string","nullable":true},"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"cpm_override":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","nullable":true},"marketplace_status":{"type":"string","default":"draft"},"create_date":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the object was first created"},"update_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was last updated"},"alternative_id":{"type":"string","nullable":true,"description":"An ID that may be used for any reporting or administrative purpose. Limited to 191 characters.","maxLength":200},"notes":{"type":"string","nullable":true,"description":"Free-form notes of up to 255 characters.","maxLength":255},"deal_format":{"nullable":true,"description":"One of: `\"banner\"`, `\"video\"`, `\"native\"`, `\"audio\"`\n\n* `banner` - Banner\n* `video` - Video\n* `native` - Native\n* `audio` - Audio","oneOf":[{"$ref":"#/components/schemas/DealFormatEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"deal_type":{"nullable":true,"description":"One of: `\"open_auction\"`, `\"private_auction\"`, `\"preferred\"`, `\"guaranteed\"`\n\n* `open_auction` - Open Auction\n* `private_auction` - Private Auction\n* `preferred` - Preferred\n* `guaranteed` - Guaranteed","oneOf":[{"$ref":"#/components/schemas/DealTypeEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"name":{"type":"string","maxLength":191},"publisher":{"type":"string","nullable":true,"maxLength":191},"floor_price":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","nullable":true,"description":"Lowest possible CPM bid price"},"account_id":{"type":"integer","description":"Defaults to the account in the active session"},"currency":{"type":"string","description":"Currency in which floor_price and cpm_override are expressed"}},"required":["account_id","advertiser_id","details","end_date","id","inventory_source_key","name","start_date","update_date"]},"MarketplaceDealList":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"inventory_source_key":{"type":"string"},"archived":{"type":"boolean","default":true,"description":"Archived marketplace deals cannot be selected for targeting"},"create_date":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the object was first created"},"update_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was last updated"},"start_date":{"type":"string","format":"date-time","nullable":true},"end_date":{"type":"string","format":"date-time","nullable":true},"alternative_id":{"type":"string","nullable":true,"description":"An ID that may be used for any reporting or administrative purpose. Limited to 191 characters.","maxLength":200},"notes":{"type":"string","nullable":true,"description":"Free-form notes of up to 255 characters.","maxLength":255},"deal_format":{"nullable":true,"description":"One of: `\"banner\"`, `\"video\"`, `\"native\"`, `\"audio\"`\n\n* `banner` - Banner\n* `video` - Video\n* `native` - Native\n* `audio` - Audio","oneOf":[{"$ref":"#/components/schemas/DealFormatEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"deal_type":{"nullable":true,"description":"One of: `\"open_auction\"`, `\"private_auction\"`, `\"preferred\"`, `\"guaranteed\"`\n\n* `open_auction` - Open Auction\n* `private_auction` - Private Auction\n* `preferred` - Preferred\n* `guaranteed` - Guaranteed","oneOf":[{"$ref":"#/components/schemas/DealTypeEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"name":{"type":"string","maxLength":191},"publisher":{"type":"string","nullable":true,"maxLength":191},"floor_price":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","nullable":true,"description":"Lowest possible CPM bid price"},"cpm_override":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","nullable":true,"description":"Default CPM bid value to use when this deal is targeted and matches a bid request"},"deal_id":{"type":"string","nullable":true,"description":"The supply-side deal identifier","maxLength":191},"remote_key":{"type":"string","maxLength":191},"marketplace_status":{"allOf":[{"$ref":"#/components/schemas/MarketplaceStatusEnum"}],"description":"One of: `\"draft\"`, `\"ordered\"`\n\n* `draft` - Draft\n* `ordered` - Ordered"},"account_id":{"type":"integer","description":"Defaults to the account in the active session"},"currency":{"type":"string","description":"Currency in which floor_price and cpm_override are expressed"},"advertiser_id":{"type":"integer"}},"required":["account_id","advertiser_id","id","inventory_source_key","name","remote_key","update_date"]},"MarketplaceStatusEnum":{"enum":["draft","ordered"],"type":"string","description":"* `draft` - Draft\n* `ordered` - Ordered"},"NullEnum":{"enum":[null]},"OsField":{"type":"object","properties":{"include":{"type":"array","items":{"type":"integer"}}},"required":["include"]},"PaginatedDMAList":{"type":"object","properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/DMA"}}}},"PaginatedIndustryList":{"type":"object","properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Industry"}}}},"PaginatedMarketplaceDealListList":{"type":"object","properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/MarketplaceDealList"}}}},"PaginatedStandardAttributeList":{"type":"object","properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/StandardAttribute"}}}},"PatchedMarketplaceDeal":{"type":"object","description":"This serializer only contains validation for shape and format, not values.\nIt is used in the adapter so we can adapt without validating date values.","properties":{"id":{"type":"integer","readOnly":true},"inventory_source_key":{"type":"string"},"archived":{"type":"boolean","default":true},"advertiser_id":{"type":"integer"},"details":{"$ref":"#/components/schemas/FreeWheelMarketplaceDealDetailsField"},"remote_key":{"type":"string"},"deal_id":{"type":"string","nullable":true},"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"cpm_override":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","nullable":true},"marketplace_status":{"type":"string","default":"draft"},"create_date":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the object was first created"},"update_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was last updated"},"alternative_id":{"type":"string","nullable":true,"description":"An ID that may be used for any reporting or administrative purpose. Limited to 191 characters.","maxLength":200},"notes":{"type":"string","nullable":true,"description":"Free-form notes of up to 255 characters.","maxLength":255},"deal_format":{"nullable":true,"description":"One of: `\"banner\"`, `\"video\"`, `\"native\"`, `\"audio\"`\n\n* `banner` - Banner\n* `video` - Video\n* `native` - Native\n* `audio` - Audio","oneOf":[{"$ref":"#/components/schemas/DealFormatEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"deal_type":{"nullable":true,"description":"One of: `\"open_auction\"`, `\"private_auction\"`, `\"preferred\"`, `\"guaranteed\"`\n\n* `open_auction` - Open Auction\n* `private_auction` - Private Auction\n* `preferred` - Preferred\n* `guaranteed` - Guaranteed","oneOf":[{"$ref":"#/components/schemas/DealTypeEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"name":{"type":"string","maxLength":191},"publisher":{"type":"string","nullable":true,"maxLength":191},"floor_price":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","nullable":true,"description":"Lowest possible CPM bid price"},"account_id":{"type":"integer","description":"Defaults to the account in the active session"},"currency":{"type":"string","description":"Currency in which floor_price and cpm_override are expressed"}}},"PeriodEnum":{"enum":["NONE","DAY","WEEK","MONTH"],"type":"string","description":"* `NONE` - NONE\n* `DAY` - DAY\n* `WEEK` - WEEK\n* `MONTH` - MONTH"},"ProgrammerField":{"type":"object","properties":{"include":{"type":"array","items":{"type":"integer"}}},"required":["include"]},"RatingField":{"type":"object","properties":{"include":{"type":"array","items":{"type":"integer"}}},"required":["include"]},"StandardAttribute":{"type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"parent_genre_id":{"type":"integer","nullable":true},"parent_programmer_id":{"type":"integer","nullable":true}},"required":["id","key","name","parent_genre_id","parent_programmer_id"]},"TargetingField":{"type":"object","properties":{"geo":{"allOf":[{"$ref":"#/components/schemas/GeoTargetingField"}],"default":{"country":{"include":[165]}}},"programmer":{"$ref":"#/components/schemas/ProgrammerField"},"brand":{"$ref":"#/components/schemas/BrandField"},"content_genre":{"$ref":"#/components/schemas/ContentGenreField"},"device":{"$ref":"#/components/schemas/DeviceField"},"os":{"$ref":"#/components/schemas/OsField"},"rating":{"$ref":"#/components/schemas/RatingField"},"environment":{"$ref":"#/components/schemas/EnvironmentField"},"language":{"$ref":"#/components/schemas/LanguageField"}}},"TransactionTypeEnum":{"enum":["NG"],"type":"string","description":"* `NG` - NG"},"TypeEnum":{"enum":["UNIVERSAL_HHID"],"type":"string","description":"* `UNIVERSAL_HHID` - UNIVERSAL_HHID"}},"securitySchemes":{"nestBasicAuth":{"type":"http","scheme":"basic","description":"Form-based Basic Authentication"},"nestSessionAuth":{"type":"http","scheme":"basic","description":"Form-based Basic Authentication"}}},"x-explorer-enabled":false,"x-samples-languages":["curl","node","ruby","javascript","python","php","java"],"servers":[{"url":"https://{buzz_key}.api.beeswax.com/rest/v2","variables":{"buzz_key":{"default":"stingersbx","description":"Unique customer ID assigned by the Beeswax"}}}],"x-readme":{"proxy-enabled":true}}