Serveur MCP
AdButler
com.adbutler/mcp-server
Ce que fait ce MCP
Manages AdButler advertisers, campaigns, ad items, audiences, zones, creatives, catalogs, and advertising reports.
Capacités
Outils
627
outils
add_user_list_attribute_values
Add values to a list attribute for a user
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['user_db_id', 'user_id', 'list_attribute_name'], 'properties': {'values': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Values to add'}, 'user_id': {'type': 'string', 'description': 'User ID'}, 'user_db_id': {'type': 'number', 'description': 'User database ID'}, 'list_attribute_name': {'type': 'string', 'description': 'List attribute name'}}, 'additionalProperties': False}
archive_advertiser
Archive an advertiser (soft-delete, can be restored later)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Advertiser ID'}}, 'additionalProperties': False}
archive_campaign
Archive a standard campaign (soft-delete, can be restored later)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Campaign ID'}}, 'additionalProperties': False}
archive_channel
Archive a channel (soft-delete, can be restored later)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Channel ID'}}, 'additionalProperties': False}
archive_contract
Archive a contract (soft-delete, can be restored later)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Contract ID'}}, 'additionalProperties': False}
archive_email_zone
Archive an email zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Email zone ID'}}, 'additionalProperties': False}
archive_publisher
Archive a publisher (soft-delete, can be restored later)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Publisher ID'}}, 'additionalProperties': False}
archive_zone
Archive a standard zone (soft-delete, can be restored later)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Zone ID'}}, 'additionalProperties': False}
bulk_create_product_sources
Bulk create product sources for a publisher
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['publisher_id'], 'properties': {'sources': {'type': 'array', 'items': {'type': 'object', 'additionalProperties': {}}, 'description': 'Array of source objects to create'}, 'publisher_id': {'type': 'number', 'description': 'Publisher ID'}}, 'additionalProperties': False}
bulk_upload_add_data_list
Bulk add entries to a data list
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Data list ID'}, 'data': {'type': 'string', 'description': 'CSV data to add'}}, 'additionalProperties': False}
bulk_upload_product_catalog
Bulk upload items to a product catalog
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['publisher_id', 'catalog_id'], 'properties': {'catalog_id': {'type': 'number', 'description': 'Catalog ID'}, 'publisher_id': {'type': 'number', 'description': 'Publisher ID'}}, 'additionalProperties': False}
bulk_upload_remove_data_list
Bulk remove entries from a data list
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Data list ID'}, 'data': {'type': 'string', 'description': 'CSV data to remove'}}, 'additionalProperties': False}
bulk_upload_replace_data_list
Bulk replace all entries in a data list
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Data list ID'}, 'data': {'type': 'string', 'description': 'CSV data to replace list with'}}, 'additionalProperties': False}
bulk_upload_replace_user_db
Bulk upload to replace all user data in a user database
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'User database ID'}}, 'additionalProperties': False}
call_adbutler_api
Call any AdButler API endpoint directly. Use this only when no specific tool wraps the endpoint you need. The session's configured API key is used automatically â do NOT pass an api_key argument. Substitute path placeholders via path_params: e.g. path="/campaigns/{id}", path_params={ "id": 123 } â /campaigns/123.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['method', 'path'], 'properties': {'body': {'type': 'object', 'description': 'JSON request body (for POST/PUT/PATCH).', 'additionalProperties': {}}, 'path': {'type': 'string', 'description': 'Endpoint path with `{placeholder}` syntax for path params, exactly as returned by search_adbutler_api (e.g. "/campaigns/{id}").'}, 'method': {'type': 'string', 'description': 'HTTP method, e.g. "GET", "POST", "PUT", "DELETE".'}, 'path_params': {'type': 'object', 'description': 'Map of path placeholder names to values, e.g. { "id": 123 }.', 'additionalProperties': {'type': ['string', 'number']}}, 'query_params': {'type': 'object', 'description': 'Query string parameters appended to the URL.', 'additionalProperties': {'type': ['string', 'number', 'boolean']}}}, 'additionalProperties': False}
campaign_bulk_create_catalog_ad_items
Bulk create catalog ad items in a campaign
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['campaign_id', 'items'], 'properties': {'items': {'type': 'array', 'items': {'type': 'object', 'additionalProperties': {}}, 'description': 'Array of catalog ad item objects to create'}, 'campaign_id': {'type': 'number', 'description': 'Campaign ID'}}, 'additionalProperties': False}
campaign_bulk_delete_catalog_ad_items
Bulk delete catalog ad items from a campaign
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['campaign_id', 'items'], 'properties': {'items': {'type': 'array', 'items': {'type': 'number'}, 'description': 'Array of catalog ad item IDs to delete'}, 'campaign_id': {'type': 'number', 'description': 'Campaign ID'}}, 'additionalProperties': False}
cancel_signature_request
Cancel a signature request
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id', 'request_id'], 'properties': {'request_id': {'type': 'number', 'description': 'Signature request ID'}, 'contract_id': {'type': 'number', 'description': 'Contract ID'}}, 'additionalProperties': False}
convert_native_to_image
Convert a native ad item to an image ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Native ad item ID'}}, 'additionalProperties': False}
create_advertiser
Create a new advertiser
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'name': {'type': 'string', 'description': 'Advertiser name'}, 'email': {'type': 'string', 'description': 'Contact email'}, 'metadata': {'type': 'object', 'description': 'Custom metadata key-value pairs', 'additionalProperties': {'type': 'string'}}, 'password': {'type': 'string', 'description': 'Password for advertiser portal (min 8 chars, must include upper, lower, number)'}, 'can_add_ad_items': {'type': 'boolean', 'description': 'Whether advertiser can submit advertisements for scheduling'}, 'can_change_password': {'type': 'boolean', 'description': 'Whether advertiser can change password'}}, 'additionalProperties': False}
create_audience
Create a new audience in a user database
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['user_db_id'], 'properties': {'name': {'type': 'string', 'description': 'Audience name'}, 'attributes': {'type': 'object', 'description': 'Attribute targets defining the audience (e.g. { "gender": { "operator": "=", "operand": "male" } })', 'additionalProperties': {'type': 'object', 'required': ['operator', 'operand'], 'properties': {'operand': {'type': 'string', 'description': 'Value to compare against'}, 'operator': {'type': 'string', 'description': 'Comparison operator (e.g. "=", ">=", "<=", "!=")'}}, 'additionalProperties': False}}, 'user_db_id': {'type': 'number', 'description': 'User database ID'}}, 'additionalProperties': False}
create_audio_creative
Create a new audio creative. The API uses multipart file upload.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['group'], 'properties': {'name': {'type': 'string', 'description': 'Creative name'}, 'group': {'type': 'number', 'description': 'Media group ID'}, 'description': {'type': 'string', 'description': 'Creative description'}}, 'additionalProperties': False}
create_beacon_signing_key
Create a new beacon signing key
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['key_name'], 'properties': {'key_name': {'type': 'string', 'description': 'Beacon signing key name'}}, 'additionalProperties': False}
create_bidder
Create a new bidder
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'name': {'type': 'string', 'description': 'Bidder name'}, 'status': {'enum': ['active', 'inactive'], 'type': 'string', 'description': 'Bidder status'}, 'bid_url': {'type': 'string', 'description': 'Bid endpoint URL'}}, 'additionalProperties': False}
create_campaign
Create a new standard campaign
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'name': {'type': 'string', 'description': 'Campaign name'}, 'budget': {'type': 'object', 'properties': {'daily': {'type': 'number'}, 'weekly': {'type': 'number'}, 'monthly': {'type': 'number'}, 'lifetime': {'type': 'number'}}, 'description': 'Budget limits (daily/weekly/monthly/lifetime)', 'additionalProperties': False}, 'contract': {'type': 'number', 'description': 'Contract ID (requires Contract Management add-on)'}, 'metadata': {'type': 'object', 'description': 'Custom metadata key-value pairs', 'additionalProperties': {'type': 'string'}}, 'advertiser': {'type': 'number', 'description': 'Advertiser ID'}, 'roadblock_tags': {'type': 'string', 'description': 'Tag to link campaign to a roadblock'}, 'targeting_source': {'enum': ['CAMPAIGN', 'AD_ITEM'], 'type': 'string', 'description': 'Whether targeting is set at campaign or ad item level'}, 'scheduling_source': {'enum': ['CAMPAIGN', 'AD_ITEM'], 'type': 'string', 'description': 'Whether scheduling is set at campaign or ad item level'}, 'trusted_redirect_domains': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Array of trusted redirect domains'}}, 'additionalProperties': False}
create_campaign_assignment
Create a new campaign assignment (assign an ad item to a campaign)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['advertisement', 'campaign'], 'properties': {'active': {'type': 'boolean', 'description': 'Whether assignment is active (defaults to true)'}, 'weight': {'type': 'number', 'description': 'Relative delivery weight (defaults to 1)'}, 'campaign': {'type': 'object', 'required': ['id', 'type'], 'properties': {'id': {'type': 'number', 'description': 'Campaign ID'}, 'type': {'type': 'string', 'const': 'standard_campaign', 'description': 'Campaign type'}}, 'description': 'Campaign object with id and type', 'additionalProperties': False}, 'keywords': {'type': 'string', 'description': 'Comma-separated keywords for targeting'}, 'schedule': {'type': 'number', 'description': 'Schedule ID (only if campaign scheduling_source is "AD_ITEM")'}, 'geo_target': {'type': 'number', 'description': 'Geo Target ID (only if campaign targeting_source is "AD_ITEM")'}, 'list_target': {'type': 'number', 'description': 'List Target ID'}, 'advertisement': {'type': 'object', 'required': ['id', 'type'], 'properties': {'id': {'type': 'number', 'description': 'Ad item ID'}, 'type': {'type': 'string', 'description': 'Ad item type: "image_ad_item", "custom_html_ad_item", "rich_media_ad_item", "native_ad_item"'}}, 'description': 'Advertisement object with id and type', 'additionalProperties': False}, 'data_key_target': {'type': 'number', 'description': 'Data Key Target ID'}, 'platform_target': {'type': 'number', 'description': 'Platform Target ID'}, 'keywords_match_method': {'enum': ['required', 'preferred', 'filtered'], 'type': 'string', 'description': 'Keyword matching method'}}, 'additionalProperties': False}
create_catalog_ad_item
Create a new catalog ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name', 'catalog_id', 'catalog_item_identifier'], 'properties': {'name': {'type': 'string', 'description': 'Ad item name'}, 'location': {'type': 'string', 'description': 'Click-through URL'}, 'metadata': {'type': 'object', 'description': 'Custom metadata key-value pairs', 'additionalProperties': {'type': 'string'}}, 'catalog_id': {'type': 'number', 'description': 'Catalog ID'}, 'tracking_pixel': {'type': 'string', 'description': 'Third-party tracking pixel URL'}, 'tracking_pixels': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Array of tracking pixel URLs'}, 'catalog_item_identifier': {'type': 'string', 'description': 'Unique identifier for the catalog item'}}, 'additionalProperties': False}
create_catalog_zone
Create a new catalog zone for product/retail ad serving
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name', 'catalog_id'], 'properties': {'name': {'type': 'string', 'description': 'Zone name'}, 'bid_floor': {'type': 'number', 'description': 'Default bid floor'}, 'publisher': {'type': 'number', 'description': 'Publisher ID'}, 'catalog_id': {'type': 'number', 'description': 'Catalog ID'}, 'auction_type': {'enum': ['FIRST_PRICE', 'SECOND_PRICE'], 'type': 'string', 'description': 'Auction type'}, 'bid_floor_cpc': {'type': 'number', 'description': 'CPC bid floor'}, 'bid_floor_cpm': {'type': 'number', 'description': 'CPM bid floor'}, 'advertiser_cost_type': {'enum': ['CPM', 'CPC'], 'type': 'string', 'description': 'Billing model'}, 'click_cooldown_period': {'type': 'number', 'description': 'Click cooldown period in seconds (1-86400)'}, 'conversion_lookback_period': {'type': 'number', 'description': 'Conversion lookback period in seconds (1-7776000)'}}, 'additionalProperties': False}
create_channel
Create a new channel
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'name': {'type': 'string', 'description': 'Channel name'}, 'priority': {'enum': ['sponsorship', 'standard', 'network', 'bulk', 'house'], 'type': 'string', 'description': 'Serving priority (default: standard)'}, 'use_share_of_voice': {'type': 'boolean', 'description': 'Whether to use share of voice as serving strategy (false = use weight)'}}, 'additionalProperties': False}
create_channel_zone_assignment
Assign a zone to a channel
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['channel', 'zone'], 'properties': {'zone': {'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Zone ID'}, 'type': {'enum': ['standard_zone', 'email_zone'], 'type': 'string', 'description': 'Zone type (default: standard_zone)'}}, 'description': 'Zone object with id and type', 'additionalProperties': False}, 'channel': {'type': 'number', 'description': 'Channel ID'}}, 'additionalProperties': False}
create_contact
Create a new contact
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name', 'email'], 'properties': {'name': {'type': 'string', 'description': 'Contact name (full name recommended)'}, 'email': {'type': 'string', 'description': 'Contact email address (must be unique)'}, 'notes': {'type': 'string', 'description': 'Additional notes about the contact'}}, 'additionalProperties': False}
create_contract
Create a new contract
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name', 'advertiser'], 'properties': {'name': {'type': 'string', 'description': 'Contract name'}, 'rate': {'type': 'number', 'description': 'Contract rate (in account currency)'}, 'end_at': {'type': 'string', 'description': 'Contract end date (YYYY-MM-DD)'}, 'status': {'enum': ['open', 'terminated', 'fulfilled', 'closed'], 'type': 'string', 'description': 'Contract status'}, 'start_at': {'type': 'string', 'description': 'Contract start date (YYYY-MM-DD)'}, 'advertiser': {'type': 'number', 'description': 'Advertiser ID'}, 'description': {'type': 'string', 'description': 'Contract description'}, 'payment_due_date': {'type': 'string', 'description': 'Payment due date (YYYY-MM-DD)'}}, 'additionalProperties': False}
create_contract_document
Create a new document for a contract
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id'], 'properties': {'attributes': {'type': 'string', 'description': 'JSON-encoded object with name, admin_executed, vendor_executed fields'}, 'contract_id': {'type': 'number', 'description': 'Contract ID'}}, 'additionalProperties': False}
create_contract_document_from_template
Create a contract document from a template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id'], 'properties': {'contract_id': {'type': 'number', 'description': 'Contract ID'}, 'template_id': {'type': 'number', 'description': 'Template ID'}}, 'additionalProperties': False}
create_contract_payment
Create a new payment for a contract
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id', 'amount'], 'properties': {'note': {'type': 'string', 'description': 'Payment note or description'}, 'amount': {'type': 'number', 'description': 'Amount paid (can be negative for refunds)'}, 'contract_id': {'type': 'number', 'description': 'Contract ID'}}, 'additionalProperties': False}
create_contract_template
Create a new contract template. Requires name, file, attributes (JSON string), email_subject, and email_body.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name', 'file', 'attributes', 'email_subject', 'email_body'], 'properties': {'file': {'type': 'string', 'description': 'URL or path to the contract template file'}, 'name': {'type': 'string', 'description': 'Template name'}, 'attributes': {'type': 'string', 'description': 'JSON-encoded object containing name, email_subject, email_body, and optionally signing_service, basic_inputs, contract_column_inputs, signers'}, 'email_body': {'type': 'string', 'description': 'Email body text when sending for signature'}, 'email_subject': {'type': 'string', 'description': 'Email subject line when sending for signature'}}, 'additionalProperties': False}
create_creative
Create a new image creative. The API uses multipart file upload â pass the media group ID and file attributes.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['group'], 'properties': {'name': {'type': 'string', 'description': 'Creative name'}, 'group': {'type': 'number', 'description': 'Media group ID'}, 'description': {'type': 'string', 'description': 'Creative description'}}, 'additionalProperties': False}
create_custom_html_ad_item
Create a new custom HTML ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name', 'custom_html'], 'properties': {'name': {'type': 'string', 'description': 'Ad item name'}, 'width': {'type': 'number', 'description': 'Ad width in pixels (0 for flexible)'}, 'height': {'type': 'number', 'description': 'Ad height in pixels (0 for flexible)'}, 'location': {'type': 'string', 'description': 'Click-through URL'}, 'metadata': {'type': 'object', 'description': 'Custom metadata key-value pairs', 'additionalProperties': {'type': 'string'}}, 'custom_html': {'type': 'string', 'description': 'The HTML content of the ad item'}, 'tracking_pixel': {'type': 'string', 'description': 'Third-party tracking pixel URL'}, 'tracking_pixels': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Array of tracking pixel URLs'}, 'html_content_below': {'type': 'string', 'description': 'HTML content below the ad item'}, 'trusted_redirect_domains': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Trusted redirect domains'}, 'expand_vertical_direction': {'enum': ['none', 'up', 'down'], 'type': 'string', 'description': 'Vertical expand direction'}, 'expand_horizontal_direction': {'enum': ['none', 'left', 'right'], 'type': 'string', 'description': 'Horizontal expand direction'}}, 'additionalProperties': False}
create_custom_report
Create a new report configuration
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name', 'type', 'period', 'date'], 'properties': {'date': {'type': 'object', 'properties': {'end': {'type': 'string', 'description': 'Custom end date (ISO 8601 format)'}, 'start': {'type': 'string', 'description': 'Custom start date (ISO 8601 format)'}, 'preset': {'type': 'string', 'description': 'Date preset (today, yesterday, last-7-days, last-30-days, etc.)'}, 'timezone': {'type': 'string', 'description': 'Timezone (e.g. "America/Toronto")'}}, 'description': 'Date configuration (either preset or start+end required)', 'additionalProperties': False}, 'name': {'type': 'string', 'description': 'Report name'}, 'type': {'enum': ['overview', 'advertiser', 'publisher', 'zone', 'campaign', 'channel', 'geo-target', 'ad-item'], 'type': 'string', 'description': 'Report type'}, 'period': {'enum': ['day', 'week', 'month', 'year'], 'type': 'string', 'description': 'Data grouping period'}, 'columns': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Columns to include: impressions, eligible, viewable, clicks, conversions, ctr, cvr, e_cpm, e_cpc, e_cpa, cost, payout, revenue'}, 'filters': {'type': 'object', 'description': 'Filter criteria: { publishers: [...], advertisers: [...], zones: [...], campaigns: [...], ad_items: [...], channels: [...] }', 'additionalProperties': {}}, 'exclude_channel_stats': {'type': 'boolean', 'description': 'Exclude stats from channel-served ads'}, 'require_channel_stats': {'type': 'boolean', 'description': 'Only include stats from channel-served ads'}, 'exclude_campaign_ad_items': {'type': 'boolean', 'description': 'Exclude ad items in campaigns'}, 'exclude_publisher_ad_items': {'type': 'boolean', 'description': 'Exclude ad items directly in zones'}}, 'additionalProperties': False}
create_data_key
Create a new data key for custom targeting
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name', 'type'], 'properties': {'name': {'type': 'string', 'description': 'Data key name (max 32 chars, must be unique)'}, 'type': {'enum': ['STRING', 'NUMBER', 'DATE', 'DATETIME', 'TIME'], 'type': 'string', 'description': 'Data key value type'}}, 'additionalProperties': False}
create_data_key_target
Create a new data key target (targeting rule)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name', 'target'], 'properties': {'name': {'type': 'string', 'description': 'Data key target name'}, 'target': {'type': 'string', 'description': 'JSON formatted target logic, e.g. ["OR", {"my_number": {"=": "5"}}, {"my_string": {"=": "test"}}]'}}, 'additionalProperties': False}
create_data_list
Create a new data list
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['label'], 'properties': {'label': {'type': 'string', 'description': 'Data list label/name'}}, 'additionalProperties': False}
create_day_parting
Create a new day parting rule for time-of-day targeting. Ranges is an object with day names as keys and arrays of time range strings (e.g. "09:00:00-17:00:00") as values.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'name': {'type': 'string', 'description': 'Day parting name'}, 'ranges': {'type': 'object', 'description': 'Object mapping day names (monday-sunday) to arrays of time ranges like "09:00:00-17:00:00"', 'additionalProperties': {'type': 'array', 'items': {'type': 'string'}}}, 'is_template': {'type': 'boolean', 'description': 'If true, shown in UI when creating/editing schedules'}, 'use_member_timezone': {'type': 'boolean', 'description': 'If true, use account timezone; if false, use viewer timezone'}}, 'additionalProperties': False}
create_demand_endpoint
Create a new demand endpoint
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name', 'demand_source', 'default_parameters', 'supported_formats'], 'properties': {'name': {'type': 'string', 'description': 'Demand endpoint name'}, 'status': {'enum': ['active', 'inactive'], 'type': 'string', 'description': 'Whether to send bid requests (default: active)'}, 'priority': {'enum': ['sponsorship', 'standard', 'network', 'bulk', 'house'], 'type': 'string', 'description': 'Serving priority'}, 'bid_floor': {'type': 'number', 'description': 'Default CPM bid floor'}, 'geo_target': {'type': 'number', 'description': 'Geo target ID for geographic targeting'}, 'filter_type': {'enum': ['all', 'whitelist', 'blacklist'], 'type': 'string', 'description': 'Zone filtering type'}, 'allowed_sizes': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Allowed zone sizes (e.g. ["300x250", "728x90"])'}, 'demand_source': {'type': 'number', 'description': 'Demand Source ID this endpoint belongs to'}, 'revenue_share': {'type': 'number', 'description': 'Revenue share percentage paid to publisher'}, 'filtered_zones': {'type': 'array', 'items': {'type': 'number'}, 'description': 'Zone IDs for the filter list'}, 'markup_percent': {'type': 'number', 'description': 'Markup percent applied to zone bid floor'}, 'supported_formats': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Supported ad formats: "display", "native", "video"'}, 'default_parameters': {'type': 'object', 'description': 'Default parameters for the endpoint (e.g. { url: "https://..." })', 'additionalProperties': {}}, 'filtered_vast_zones': {'type': 'array', 'items': {'type': 'number'}, 'description': 'VAST zone IDs for the filter list'}, 'native_json_encoded': {'type': 'boolean', 'description': 'Whether native JSON should be encoded'}}, 'additionalProperties': False}
create_demand_source
Create a new demand source
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name', 'network'], 'properties': {'name': {'type': 'string', 'description': 'Demand source name'}, 'status': {'enum': ['active', 'inactive'], 'type': 'string', 'description': 'Whether to send bid requests (default: active)'}, 'network': {'type': 'string', 'description': "Network type: 'adview', 'aerserv', 'inmobi', 'inneractive', 'loopme', 'mobilefuse', 'onebyaol', 'pubmatic', 'pubnative', 'smaato', 'startapp', 'tappx', 'consumable', 'bidphysics', or 'openrtb'"}, 'spend_limit': {'type': 'number', 'description': 'Spend limit amount'}, 'spend_limit_end': {'type': 'string', 'description': 'Spend limit end date (ISO-8601)'}, 'spend_limit_start': {'type': 'string', 'description': 'Spend limit start date (ISO-8601)'}, 'spend_limit_period': {'enum': ['once', 'weekly', 'biweekly', 'monthly', 'quarterly'], 'type': 'string', 'description': 'Spend limit reset interval'}}, 'additionalProperties': False}
create_email_zone
Create a new email zone for serving ads in email newsletters
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name', 'width', 'height'], 'properties': {'name': {'type': 'string', 'description': 'Zone name'}, 'width': {'type': 'number', 'description': 'Zone width in pixels'}, 'height': {'type': 'number', 'description': 'Zone height in pixels'}, 'metadata': {'type': 'object', 'description': 'Custom metadata key-value pairs', 'additionalProperties': {'type': 'string'}}, 'publisher': {'type': 'number', 'description': 'Publisher ID'}, 'uid_rotate': {'type': 'boolean', 'description': 'Serve different ads per user'}, 'rotate_timer': {'type': 'object', 'required': ['amount', 'interval'], 'properties': {'amount': {'type': 'number', 'description': 'Period amount'}, 'interval': {'enum': ['minutes', 'days'], 'type': 'string', 'description': 'Period interval'}}, 'description': 'Period after which user sees a new ad', 'additionalProperties': False}, 'auction_tie_break': {'enum': ['RANDOM', 'SCORE'], 'type': 'string', 'description': 'Tie-breaking method for auctions'}}, 'additionalProperties': False}
create_event_log_upload_config
Create a new event log upload configuration
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'name': {'type': 'string', 'description': 'Configuration name'}, 'format': {'type': 'string', 'description': 'Log file format'}, 'enabled': {'type': 'boolean', 'description': 'Whether the upload configuration is enabled'}, 'frequency': {'type': 'string', 'description': 'Upload frequency (e.g. "daily", "hourly")'}, 'connection_id': {'type': 'number', 'description': 'SFTP connection ID to use for upload'}}, 'additionalProperties': False}
create_geo_target
Create a new geo target for geographic targeting. Areas is an array of objects with continent, country (2-letter code), region, city fields.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name', 'areas'], 'properties': {'name': {'type': 'string', 'description': 'Geo target name'}, 'unit': {'enum': ['miles', 'kilometers'], 'type': 'string', 'description': 'Distance unit for range'}, 'areas': {'type': 'array', 'items': {'type': 'object', 'properties': {'city': {'type': 'string', 'description': 'City name (e.g., "San Francisco")'}, 'region': {'type': 'string', 'description': 'Region/state (e.g., "California")'}, 'country': {'type': 'string', 'description': 'Two-letter country code (e.g., "US", "CA")'}, 'continent': {'type': 'string', 'description': 'Continent name (e.g. "North America", "Europe"). Not needed if country is provided.'}}, 'additionalProperties': False}, 'description': 'Array of geographic areas to target'}, 'range': {'type': 'number', 'description': 'Radius range for geo-fencing (only applies when targeting a city)'}, 'inclusive': {'type': 'boolean', 'description': 'If true, target users IN these areas; if false, EXCLUDE these areas'}}, 'additionalProperties': False}
create_image_ad_item
Create a new image ad item (banner)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'name': {'type': 'string', 'description': 'Ad item name'}, 'width': {'type': 'number', 'description': 'Ad width in pixels (defaults to 0)'}, 'height': {'type': 'number', 'description': 'Ad height in pixels (defaults to 0)'}, 'creative': {'type': 'number', 'description': 'Image creative ID (mutually exclusive with creative_url)'}, 'location': {'type': 'string', 'description': 'Click-through URL'}, 'metadata': {'type': 'object', 'description': 'Custom metadata key-value pairs', 'additionalProperties': {'type': 'string'}}, 'html_target': {'type': 'string', 'description': 'Window/frame for destination URL (e.g. "_blank")'}, 'creative_url': {'type': 'string', 'description': 'URL to image file â\x80\x94 PNG, JPEG, or GIF (mutually exclusive with creative)'}, 'html_alt_text': {'type': 'string', 'description': 'Alt text for the image'}, 'tracking_pixel': {'type': 'string', 'description': 'Third-party tracking pixel URL'}, 'tracking_pixels': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Array of tracking pixel URLs'}, 'html_content_below': {'type': 'string', 'description': 'HTML content below the ad item'}, 'trusted_redirect_domains': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Trusted redirect domains'}}, 'additionalProperties': False}
create_list_target
Create a new list target (inclusion/exclusion using a data list)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['label'], 'properties': {'label': {'type': 'string', 'description': 'List target name'}, 'data_list': {'type': 'number', 'description': 'Data list ID containing the values to target'}, 'inclusive': {'type': 'boolean', 'description': 'If true, inclusion target; if false, exclusion target'}}, 'additionalProperties': False}
create_manager
Create a new manager
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name', 'email'], 'properties': {'name': {'type': 'string', 'description': 'Manager name'}, 'email': {'type': 'string', 'description': 'Manager email address'}, 'notes': {'type': 'string', 'description': 'Notes about the manager'}, 'password': {'type': 'string', 'description': 'Login password (min 8 chars with upper, lower, number). Random if blank.'}, 'position': {'type': 'string', 'description': 'Manager position in organization'}, 'is_enabled': {'type': 'boolean', 'description': 'Whether the manager account is enabled'}, 'can_manage_links': {'type': 'boolean', 'description': 'Can create/edit/delete active tracking links'}, 'can_manage_media': {'type': 'boolean', 'description': 'Can manage creatives and media groups'}, 'can_manage_users': {'type': 'boolean', 'description': 'Can manage user accounts and permissions'}, 'publisher_access': {'enum': ['none', 'specific', 'all'], 'type': 'string', 'description': 'Publisher access level'}, 'statistics_access': {'enum': ['none', 'specific', 'all'], 'type': 'string', 'description': 'Statistics access level'}, 'can_manage_bidders': {'type': 'boolean', 'description': 'Can manage bidders'}, 'can_manage_billing': {'type': 'boolean', 'description': 'Can view invoices and billing'}, 'can_manage_targets': {'type': 'boolean', 'description': 'Can assign/remove targets from placements'}, 'can_manage_tickets': {'type': 'boolean', 'description': 'Can create/view support tickets'}, 'can_manage_contracts': {'type': 'boolean', 'description': 'Can manage contracts and templates'}, 'can_manage_data_keys': {'type': 'boolean', 'description': 'Can manage data keys'}, 'can_manage_product_db': {'type': 'boolean', 'description': 'Can manage product catalogs'}, 'can_manage_self_serve': {'type': 'boolean', 'description': 'Can manage Self-Serve portals'}, 'publisher_access_list': {'type': 'array', 'items': {'type': 'number'}, 'description': 'Publisher IDs accessible when publisher_access is "specific"'}, 'can_manage_programmatic': {'type': 'boolean', 'description': 'Can manage demand sources and PMP deals'}, 'can_manage_admin_api_access': {'type': 'boolean', 'description': 'Can manage API keys'}, 'can_assign_campaigns_directly': {'type': 'boolean', 'description': 'Can assign campaigns directly to zones'}, 'can_manage_native_ad_templates': {'type': 'boolean', 'description': 'Can manage native templates'}}, 'additionalProperties': False}
create_media_group
Create a new media group
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'name': {'type': 'string', 'description': 'Media group name'}}, 'additionalProperties': False}
create_native_ad_item
Create a new native ad item using a native template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name', 'template', 'variables'], 'properties': {'name': {'type': 'string', 'description': 'Ad item name'}, 'width': {'type': 'number', 'description': 'Ad width in pixels'}, 'height': {'type': 'number', 'description': 'Ad height in pixels'}, 'location': {'type': 'string', 'description': 'Click-through URL'}, 'metadata': {'type': 'object', 'description': 'Custom metadata key-value pairs', 'additionalProperties': {'type': 'string'}}, 'template': {'type': 'number', 'description': 'Native template ID'}, 'variables': {'type': 'object', 'description': 'Template variables as key-value pairs (keys should be integer strings)', 'additionalProperties': {'type': 'string'}}, 'tracking_pixel': {'type': 'string', 'description': 'Third-party tracking pixel URL'}, 'tracking_pixels': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Array of tracking pixel URLs'}, 'trusted_redirect_domains': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Trusted redirect domains'}}, 'additionalProperties': False}
create_native_template
Create a new native ad template with HTML and variable placeholders
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name', 'raw_html', 'variables'], 'properties': {'name': {'type': 'string', 'description': 'Template name'}, 'raw_html': {'type': 'string', 'description': 'HTML template content with variable placeholders (e.g. "[%title%]")'}, 'variables': {'type': 'array', 'items': {'type': 'object', 'required': ['name', 'placeholder', 'type'], 'properties': {'name': {'type': 'string', 'description': 'Variable name'}, 'type': {'enum': ['url', 'url_raw', 'text', 'file', 'number', 'image_url', 'dropdown', 'third_party_script'], 'type': 'string', 'description': 'Variable type'}, 'optional': {'type': 'boolean', 'description': 'Whether the variable can be left blank (default: false)'}, 'max_length': {'type': 'number', 'description': 'Max length for text variables'}, 'placeholder': {'type': 'string', 'description': 'Placeholder in raw_html (e.g. "[%title%]")'}, 'dropdown_values': {'type': 'string', 'description': 'Comma-separated options for dropdown variables'}}, 'additionalProperties': False}, 'description': 'Array of template variables'}}, 'additionalProperties': False}
create_ortb_native_data_asset
Create a new data asset for an ORTB native template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['template_id'], 'properties': {'len': {'type': 'number', 'description': 'Max length'}, 'type': {'type': 'number', 'description': 'Data asset type'}, 'template_id': {'type': 'number', 'description': 'ORTB native template ID'}}, 'additionalProperties': False}
create_ortb_native_image_asset
Create a new image asset for an ORTB native template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['template_id'], 'properties': {'h': {'type': 'number', 'description': 'Height'}, 'w': {'type': 'number', 'description': 'Width'}, 'hmin': {'type': 'number', 'description': 'Min height'}, 'type': {'type': 'number', 'description': 'Image asset type'}, 'wmin': {'type': 'number', 'description': 'Min width'}, 'template_id': {'type': 'number', 'description': 'ORTB native template ID'}}, 'additionalProperties': False}
create_ortb_native_template
Create a new OpenRTB native template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'name': {'type': 'string', 'description': 'ORTB native template name'}, 'html_template': {'type': 'string', 'description': 'HTML template for rendering the native ad (e.g. "<div>{{title}}</div>")'}}, 'additionalProperties': False}
create_ortb_native_title_asset
Create a new title asset for an ORTB native template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['template_id'], 'properties': {'len': {'type': 'number', 'description': 'Max length of title'}, 'template_id': {'type': 'number', 'description': 'ORTB native template ID'}}, 'additionalProperties': False}
create_placement
Create a new placement (assign an ad item or campaign to a zone or channel)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['advertisement', 'schedule'], 'properties': {'cost': {'type': 'object', 'properties': {'cpa': {'type': 'number'}, 'cpc': {'type': 'number'}, 'cpm': {'type': 'number'}, 'fixed_cost': {'type': 'number'}}, 'description': 'Pricing model: fixed_cost OR cpm/cpc/cpa', 'additionalProperties': False}, 'zone': {'type': 'object', 'required': ['id', 'type'], 'properties': {'id': {'type': 'number', 'description': 'Zone ID'}, 'type': {'enum': ['standard_zone', 'text_zone', 'email_zone'], 'type': 'string', 'description': 'Zone type'}}, 'description': 'Zone object (required if channel not set; mutually exclusive with channel)', 'additionalProperties': False}, 'active': {'type': 'boolean', 'description': 'Whether placement is active (defaults to true)'}, 'payout': {'type': 'object', 'properties': {'cpa': {'type': 'number'}, 'cpc': {'type': 'number'}, 'cpm': {'type': 'number'}, 'type': {'enum': ['rate', 'percent'], 'type': 'string'}, 'fixed': {'type': 'number'}}, 'description': 'Publisher payout configuration', 'additionalProperties': False}, 'weight': {'type': 'number', 'description': 'Relative delivery weight'}, 'channel': {'type': 'number', 'description': 'Channel ID (required if zone not set; mutually exclusive with zone)'}, 'keywords': {'type': 'string', 'description': 'Comma-separated keywords for targeting'}, 'priority': {'enum': ['sponsorship', 'standard', 'network', 'bulk', 'house'], 'type': 'string', 'description': 'Serving priority level (defaults to "standard")'}, 'schedule': {'type': 'number', 'description': 'Schedule ID'}, 'geo_target': {'type': 'number', 'description': 'Geotarget ID'}, 'list_target': {'type': 'number', 'description': 'List Target ID'}, 'serve_method': {'enum': ['weight', 'auction'], 'type': 'string', 'description': 'Serving system: weight-based or auction-based'}, 'advertisement': {'type': 'object', 'required': ['id', 'type'], 'properties': {'id': {'type': 'number', 'description': 'Ad item or campaign ID'}, 'type': {'type': 'string', 'description': 'Type: "image_ad_item", "custom_html_ad_item", "rich_media_ad_item", "native_ad_item", "standard_campaign"'}}, 'description': 'Advertisement object with id and type', 'additionalProperties': False}, 'share_of_voice': {'type': 'number', 'description': 'Share of voice percentage (required when zone uses share_of_voice)'}, 'platform_target': {'type': 'number', 'description': 'Platform target ID'}, 'data_key_target_id': {'type': 'number', 'description': 'Data Key Target ID (Enterprise only)'}, 'contextual_segments': {'type': 'array', 'items': {'type': 'number'}, 'description': 'Array of contextual segment IDs'}, 'keywords_match_method': {'enum': ['required', 'preferred', 'filtered'], 'type': 'string', 'description': 'Keyword matching method'}}, 'additionalProperties': False}
create_platform_target
Create a new platform target for device/OS/browser targeting
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'name': {'type': 'string', 'description': 'Platform target name'}, 'platform': {'enum': ['any', 'specific', 'mobile', 'tablet', 'mobile_and_tablet', 'desktop'], 'type': 'string', 'description': 'Preset platform target (default: any)'}, 'device_targets': {'type': 'array', 'items': {'type': 'string'}, 'description': 'List of device patterns to target (e.g. "Apple*", "Samsung Galaxy S5")'}}, 'additionalProperties': False}
create_pmp_deal
Create a new PMP deal
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'name': {'type': 'string', 'description': 'PMP deal name'}, 'bid_floor': {'type': 'number', 'description': 'Bid floor for this deal'}, 'geo_target': {'type': 'number', 'description': 'Geo target ID (0 = no targeting)'}, 'audience_target': {'type': 'number', 'description': 'Audience target ID (null = no targeting)'}, 'whitelist_seats': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Seat IDs with access to this deal'}}, 'additionalProperties': False}
create_postal_code_target
Create a new postal code target
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['label', 'locations'], 'properties': {'label': {'type': 'string', 'description': 'Postal code target name'}, 'inclusive': {'type': 'boolean', 'description': 'If true, inclusion target; if false, exclusion target'}, 'locations': {'type': 'array', 'items': {'type': 'object', 'required': ['country', 'postal_codes'], 'properties': {'country': {'type': 'string', 'description': 'Two-letter country code (e.g. "JP", "US")'}, 'postal_codes': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Array of postal codes for this country'}}, 'additionalProperties': False}, 'description': 'Array of locations grouped by country'}}, 'additionalProperties': False}
create_product_catalog
Create a new product catalog for a publisher
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['publisher_id'], 'properties': {'name': {'type': 'string', 'description': 'Catalog name'}, 'publisher_id': {'type': 'number', 'description': 'Publisher ID'}}, 'additionalProperties': False}
create_product_catalog_item
Create a new item in a product catalog
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['publisher_id', 'catalog_id'], 'properties': {'url': {'type': 'string', 'description': 'Item URL'}, 'name': {'type': 'string', 'description': 'Item name'}, 'price': {'type': 'string', 'description': 'Item price'}, 'category': {'type': 'string', 'description': 'Item category'}, 'image_url': {'type': 'string', 'description': 'Item image URL'}, 'catalog_id': {'type': 'number', 'description': 'Catalog ID'}, 'identifier': {'type': 'string', 'description': 'Unique identifier for the catalog item'}, 'description': {'type': 'string', 'description': 'Item description'}, 'publisher_id': {'type': 'number', 'description': 'Publisher ID'}}, 'additionalProperties': False}
create_product_source
Create a new product source for a publisher
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['publisher_id'], 'properties': {'url': {'type': 'string', 'description': 'Source URL'}, 'name': {'type': 'string', 'description': 'Source name'}, 'type': {'type': 'string', 'description': 'Source type'}, 'publisher_id': {'type': 'number', 'description': 'Publisher ID'}}, 'additionalProperties': False}
create_product_source_target
Create a new product source target for a publisher
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['publisher_id'], 'properties': {'name': {'type': 'string', 'description': 'Source target name'}, 'source_id': {'type': 'number', 'description': 'Source ID to target'}, 'publisher_id': {'type': 'number', 'description': 'Publisher ID'}}, 'additionalProperties': False}
create_publisher
Create a new publisher
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'name': {'type': 'string', 'description': 'Publisher name'}, 'email': {'type': 'string', 'description': 'Contact email (allows publisher to log in)'}, 'domain': {'type': 'string', 'description': 'Publisher domain (top-level domains only)'}, 'metadata': {'type': 'object', 'description': 'Custom metadata key-value pairs', 'additionalProperties': {'type': 'string'}}, 'timezone': {'type': 'string', 'description': 'Timezone (e.g., "America/New_York")'}, 'seller_type': {'enum': ['publisher', 'intermediary', 'both'], 'type': 'string', 'description': 'Seller type for ads.txt'}, 'default_payout': {'type': 'object', 'properties': {'cpa': {'type': 'number'}, 'cpc': {'type': 'number'}, 'cpm': {'type': 'number'}, 'type': {'enum': ['rate', 'percent'], 'type': 'string'}, 'fixed': {'type': 'number'}}, 'description': 'Default payout configuration', 'additionalProperties': False}, 'can_approve_ads': {'type': 'boolean', 'description': 'Allow publisher to approve/deny ad items'}, 'can_admin_account': {'type': 'boolean', 'description': 'Grant administrator privileges'}, 'can_change_password': {'type': 'boolean', 'description': 'Whether publisher can change password'}, 'can_view_wordpress_key': {'type': 'boolean', 'description': 'Allow publisher to view WordPress key'}}, 'additionalProperties': False}
create_report_schedule
Create a new report schedule
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['report_config_id'], 'properties': {'frequency': {'type': 'string', 'description': 'Schedule frequency'}, 'recipients': {'type': 'array', 'items': {}, 'description': 'Array of recipient objects'}, 'report_config_id': {'type': 'number', 'description': 'Report configuration ID'}}, 'additionalProperties': False}
create_rich_media_ad_item
Create a new rich media ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name', 'creative'], 'properties': {'name': {'type': 'string', 'description': 'Ad item name'}, 'width': {'type': 'number', 'description': 'Ad width in pixels'}, 'height': {'type': 'number', 'description': 'Ad height in pixels'}, 'creative': {'type': 'number', 'description': 'Rich media creative ID'}, 'location': {'type': 'string', 'description': 'Click-through URL'}, 'metadata': {'type': 'object', 'description': 'Custom metadata key-value pairs', 'additionalProperties': {'type': 'string'}}, 'tracking_pixel': {'type': 'string', 'description': 'Third-party tracking pixel URL'}, 'tracking_pixels': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Array of tracking pixel URLs'}, 'html_content_below': {'type': 'string', 'description': 'HTML content below the ad item'}, 'trusted_redirect_domains': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Trusted redirect domains'}, 'expand_vertical_direction': {'enum': ['none', 'up', 'down'], 'type': 'string', 'description': 'Vertical expand direction'}, 'expand_horizontal_direction': {'enum': ['none', 'left', 'right'], 'type': 'string', 'description': 'Horizontal expand direction'}}, 'additionalProperties': False}
create_rich_media_creative
Create a new rich media creative. The API uses multipart file upload (ZIP for HTML5).
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['group'], 'properties': {'name': {'type': 'string', 'description': 'Creative name'}, 'group': {'type': 'number', 'description': 'Media group ID'}, 'description': {'type': 'string', 'description': 'Creative description'}, 'index_file_path': {'type': 'string', 'description': 'Path to index HTML file inside ZIP archive (for HTML5)'}}, 'additionalProperties': False}
create_role
Create a new role with permission settings
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'name': {'type': 'string', 'description': 'Role name'}, 'is_default_role': {'type': 'boolean', 'description': 'Auto-assign this role to new users'}, 'can_manage_links': {'type': 'boolean', 'description': 'Can manage tracking links'}, 'can_manage_media': {'type': 'boolean', 'description': 'Can manage creatives and media groups'}, 'can_manage_users': {'type': 'boolean', 'description': 'Can manage users'}, 'publisher_access': {'enum': ['none', 'specific', 'all'], 'type': 'string', 'description': 'Publisher access level'}, 'statistics_access': {'enum': ['none', 'specific', 'all'], 'type': 'string', 'description': 'Statistics access level'}, 'can_manage_bidders': {'type': 'boolean', 'description': 'Can manage bidders'}, 'can_manage_billing': {'type': 'boolean', 'description': 'Can manage billing'}, 'can_manage_targets': {'type': 'boolean', 'description': 'Can manage targets'}, 'can_manage_tickets': {'type': 'boolean', 'description': 'Can manage tickets'}, 'can_manage_contracts': {'type': 'boolean', 'description': 'Can manage contracts'}, 'can_manage_data_keys': {'type': 'boolean', 'description': 'Can manage data keys'}, 'can_manage_product_db': {'type': 'boolean', 'description': 'Can manage product catalogs'}, 'can_manage_self_serve': {'type': 'boolean', 'description': 'Can manage Self-Serve'}, 'publisher_access_list': {'type': 'array', 'items': {'type': 'number'}, 'description': 'Publisher IDs for specific access'}, 'can_manage_programmatic': {'type': 'boolean', 'description': 'Can manage programmatic'}, 'can_manage_admin_api_access': {'type': 'boolean', 'description': 'Can manage API keys'}, 'can_assign_campaigns_directly': {'type': 'boolean', 'description': 'Can assign campaigns directly'}, 'can_manage_native_ad_templates': {'type': 'boolean', 'description': 'Can manage native templates'}}, 'additionalProperties': False}
create_schedule
Create a new schedule for time-based ad delivery. Schedules are automatically linked to ad items via placements.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'end_at': {'type': 'string', 'description': 'End date/time in ISO-8601 format, null for indefinite'}, 'end_date': {'type': 'string', 'description': 'End date (YYYY-MM-DD HH:MM:SS), null for indefinite â\x80\x94 deprecated, use end_at'}, 'start_at': {'type': 'string', 'description': 'Start date/time in ISO-8601 format'}, 'quota_type': {'enum': ['views', 'clicks'], 'type': 'string', 'description': 'Quota measurement type'}, 'start_date': {'type': 'string', 'description': 'Start date (YYYY-MM-DD HH:MM:SS) â\x80\x94 deprecated, use start_at'}, 'day_cap_type': {'enum': ['views', 'clicks'], 'type': 'string', 'description': 'Daily cap type'}, 'day_cap_limit': {'type': 'number', 'description': 'Daily cap limit (number of views or clicks per day)'}, 'day_parting_id': {'type': 'number', 'description': 'Day parting ID for time-of-day targeting'}, 'quota_lifetime': {'type': 'number', 'description': 'Total quota amount (views or clicks, not per thousand)'}, 'delivery_method': {'enum': ['default', 'smooth'], 'type': 'string', 'description': 'Delivery pacing: "default" (ASAP) or "smooth" (evenly distributed)'}, 'end_at_timezone': {'type': 'string', 'description': 'IANA timezone for end_at'}, 'start_at_timezone': {'type': 'string', 'description': 'IANA timezone for start_at (e.g. "America/New_York")'}, 'per_user_view_limit': {'type': 'number', 'description': 'Per-user view frequency cap'}, 'per_user_view_period': {'type': 'number', 'description': 'Days before per-user view counter resets'}, 'under_delivery_behaviour': {'enum': ['endOnQuota', 'endOnDate'], 'type': 'string', 'description': 'Whether to keep serving until quota met or stop on end date'}}, 'additionalProperties': False}
create_sftp_connection
Create a new SFTP connection
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'host': {'type': 'string', 'description': 'SFTP host'}, 'name': {'type': 'string', 'description': 'Connection name'}, 'path': {'type': 'string', 'description': 'Remote path'}, 'port': {'type': 'number', 'description': 'SFTP port'}, 'password': {'type': 'string', 'description': 'SFTP password'}, 'username': {'type': 'string', 'description': 'SFTP username'}}, 'additionalProperties': False}
create_signature_request
Create a new signature request for a contract
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id'], 'properties': {'contract_id': {'type': 'number', 'description': 'Contract ID'}}, 'additionalProperties': False}
create_trial_account
Create a free AdButler trial account. Use this when the user does NOT have an AdButler account yet. Collects their info and creates the account. After calling this, the user must check their email for a verification code, then call verify_trial_email to complete setup.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['email', 'name', 'company'], 'properties': {'name': {'type': 'string', 'description': 'Full name'}, 'email': {'type': 'string', 'description': 'User email address'}, 'phone': {'type': 'string', 'description': 'Phone number (optional)'}, 'company': {'type': 'string', 'description': 'Company or organization name'}, 'website': {'type': 'string', 'description': 'Website URL (optional)'}}, 'additionalProperties': False}
create_trusted_redirect_domain
Create a new trusted redirect domain
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['domain'], 'properties': {'domain': {'type': 'string', 'description': 'Trusted redirect domain (e.g. example.com)'}}, 'additionalProperties': False}
create_user
Create a new user in a user database
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['user_db_id'], 'properties': {'user_id': {'type': 'string', 'description': 'User ID'}, 'attributes': {'type': 'object', 'description': 'User attribute values', 'additionalProperties': {}}, 'user_db_id': {'type': 'number', 'description': 'User database ID'}}, 'additionalProperties': False}
create_user_attribute
Create a new user attribute in a user database
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['user_db_id'], 'properties': {'id': {'type': 'string', 'description': 'Field name in the user data (e.g. "signup_datetime")'}, 'type': {'enum': ['number', 'phone_number', 'email', 'text', 'date_time', 'timestamp'], 'type': 'string', 'description': 'Data type of the field'}, 'label': {'type': 'string', 'description': 'Descriptive label for the field'}, 'user_db_id': {'type': 'number', 'description': 'User database ID'}}, 'additionalProperties': False}
create_user_db
Create a new user database
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'name': {'type': 'string', 'description': 'User database name'}, 'id_field_name': {'type': 'string', 'description': 'Name of the field to use as primary user identifier'}}, 'additionalProperties': False}
create_vast_custom_report
Create a new VAST report configuration
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'name': {'type': 'string', 'description': 'Report name'}}, 'additionalProperties': False}
create_video_creative
Create a new video creative. The API uses multipart file upload.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['group'], 'properties': {'name': {'type': 'string', 'description': 'Creative name'}, 'group': {'type': 'number', 'description': 'Media group ID'}, 'description': {'type': 'string', 'description': 'Creative description'}}, 'additionalProperties': False}
create_zone
Create a new standard zone. Set dimensions to "dynamic" for a dynamic zone (width/height must be 0), or "fixed" (default) for a fixed-size zone.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'name': {'type': 'string', 'description': 'Zone name'}, 'width': {'type': 'number', 'description': 'Zone width in pixels (must be 0 if dimensions is "dynamic")'}, 'height': {'type': 'number', 'description': 'Zone height in pixels (must be 0 if dimensions is "dynamic")'}, 'metadata': {'type': 'object', 'description': 'Custom metadata key-value pairs', 'additionalProperties': {'type': 'string'}}, 'bid_floor': {'type': 'number', 'description': 'Default bid floor for programmatic'}, 'pmp_deals': {'type': 'array', 'items': {'type': 'number'}, 'description': 'Allowed PMP Deal IDs'}, 'publisher': {'type': 'number', 'description': 'Publisher ID'}, 'dimensions': {'enum': ['fixed', 'dynamic'], 'type': 'string', 'description': 'Zone dimensions type: "fixed" (default) or "dynamic"'}, 'min_payout': {'type': 'number', 'description': 'Minimum payout per impression (CPM)'}, 'responsive': {'enum': ['fixed', 'auto', 'inherit'], 'type': 'string', 'description': 'Size behavior'}, 'burn_in_hours': {'type': 'number', 'description': 'Hours before eCPM confidence'}, 'refresh_limit': {'type': 'number', 'description': 'Total times zone will refresh'}, 'ad_size_filter': {'type': 'object', 'properties': {'type': {'enum': ['INCLUSIVE', 'EXCLUSIVE'], 'type': 'string'}, 'sizes': {'type': 'array', 'items': {'type': 'object', 'required': ['width', 'height'], 'properties': {'width': {'type': 'number'}, 'height': {'type': 'number'}}, 'additionalProperties': False}}}, 'description': 'Ad size filter (dynamic zones only)', 'additionalProperties': False}, 'api_frameworks': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Supported API frameworks for OpenRTB'}, 'iab_categories': {'type': 'array', 'items': {'type': 'string'}, 'description': 'IAB category descriptors'}, 'private_auction': {'type': 'boolean', 'description': 'Whether auction ignores non-deal bids'}, 'unique_delivery': {'type': 'boolean', 'description': 'Serve unique ads on each zone'}, 'rtb_placement_id': {'type': 'string', 'description': 'OpenRTB tagid identifier'}, 'auction_tie_break': {'enum': ['RANDOM', 'SCORE'], 'type': 'string', 'description': 'Tie-breaking method for auctions'}, 'refresh_frequency': {'type': 'number', 'description': 'Interval in seconds for serving new ads'}, 'use_share_of_voice': {'type': 'boolean', 'description': 'Use "share of voice" as serving strategy'}, 'burn_in_impressions': {'type': 'number', 'description': 'Impressions before eCPM confidence'}, 'allow_demand_sources': {'type': 'boolean', 'description': 'Allow requests to demand endpoints'}, 'serve_priority_order': {'enum': ['weight', 'auction'], 'type': 'string', 'description': 'Priority order: "weight" or "auction"'}, 'optimization_strategy': {'type': 'string', 'description': 'Zone optimization strategy'}, 'ecpm_testing_allowance': {'type': 'number', 'description': 'Percentage for eCPM recalculation testing'}, 'allowed_root_native_templates': {'type': 'array', 'items': {'type': 'number'}, 'description': 'Allowed root native template IDs'}}, 'additionalProperties': False}
create_zone_ortb_native_ad
Create a new ORTB native ad for a standard zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['zone_id'], 'properties': {'name': {'type': 'string', 'description': 'ORTB native ad name'}, 'zone_id': {'type': 'number', 'description': 'Standard zone ID'}, 'template_id': {'type': 'number', 'description': 'ORTB native template ID'}}, 'additionalProperties': False}
delete_advertiser
Delete an advertiser
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Advertiser ID'}}, 'additionalProperties': False}
delete_archived_campaign
Permanently delete an archived standard campaign
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived campaign ID'}}, 'additionalProperties': False}
delete_archived_channel
Permanently delete an archived channel
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived channel ID'}}, 'additionalProperties': False}
delete_archived_contract
Permanently delete an archived contract
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived contract ID'}}, 'additionalProperties': False}
delete_audience
Delete an audience from a user database
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['user_db_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'Audience ID'}, 'user_db_id': {'type': 'number', 'description': 'User database ID'}}, 'additionalProperties': False}
delete_audio_creative
Delete an audio creative
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Creative ID'}}, 'additionalProperties': False}
delete_beacon_signing_key
Delete a beacon signing key
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Beacon signing key ID'}}, 'additionalProperties': False}
delete_bidder
Delete a bidder
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Bidder ID'}}, 'additionalProperties': False}
delete_campaign
Delete a standard campaign
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Campaign ID'}}, 'additionalProperties': False}
delete_campaign_assignment
Delete a campaign assignment
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Campaign assignment ID'}}, 'additionalProperties': False}
delete_catalog_ad_item
Delete a catalog ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Ad item ID'}}, 'additionalProperties': False}
delete_catalog_zone
Delete a catalog zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Catalog zone ID'}}, 'additionalProperties': False}
delete_channel
Delete a channel
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Channel ID'}}, 'additionalProperties': False}
delete_channel_zone_assignment
Remove a zone from a channel
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Channel zone assignment ID'}}, 'additionalProperties': False}
delete_contact
Delete a contact
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Contact ID'}}, 'additionalProperties': False}
delete_contract
Delete a contract
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Contract ID'}}, 'additionalProperties': False}
delete_contract_document
Delete a contract document
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'Document ID'}, 'contract_id': {'type': 'number', 'description': 'Contract ID'}}, 'additionalProperties': False}
delete_contract_payment
Delete a contract payment
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'Payment ID'}, 'contract_id': {'type': 'number', 'description': 'Contract ID'}}, 'additionalProperties': False}
delete_contract_template
Delete a contract template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Contract template ID'}}, 'additionalProperties': False}
delete_creative
Delete an image creative
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Creative ID'}}, 'additionalProperties': False}
delete_custom_html_ad_item
Delete a custom HTML ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Ad item ID'}}, 'additionalProperties': False}
delete_custom_report
Delete a report configuration
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Report configuration ID'}}, 'additionalProperties': False}
delete_data_key
Delete a data key
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Data key ID'}}, 'additionalProperties': False}
delete_data_key_target
Delete a data key target
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Data key target ID'}}, 'additionalProperties': False}
delete_data_list
Delete a data list
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Data list ID'}}, 'additionalProperties': False}
delete_day_parting
Delete a day parting rule
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Day parting ID'}}, 'additionalProperties': False}
delete_demand_endpoint
Delete a demand endpoint
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Demand endpoint ID'}}, 'additionalProperties': False}
delete_demand_source
Delete a demand source
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Demand source ID'}}, 'additionalProperties': False}
delete_email_zone
Delete an email zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Email zone ID'}}, 'additionalProperties': False}
delete_event_log_upload_config
Delete an event log upload configuration
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Upload configuration ID'}}, 'additionalProperties': False}
delete_geo_target
Delete a geo target
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Geo target ID'}}, 'additionalProperties': False}
delete_image_ad_item
Delete an image ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Ad item ID'}}, 'additionalProperties': False}
delete_list_target
Delete a list target
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'List target ID'}}, 'additionalProperties': False}
delete_manager
Delete a manager
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Manager ID'}}, 'additionalProperties': False}
delete_media_group
Delete a media group
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Media group ID'}}, 'additionalProperties': False}
delete_native_ad_item
Delete a native ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Ad item ID'}}, 'additionalProperties': False}
delete_native_template
Delete a native template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Native template ID'}}, 'additionalProperties': False}
delete_ortb_native_data_asset
Delete a data asset from an ORTB native template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['template_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'Data asset ID'}, 'template_id': {'type': 'number', 'description': 'ORTB native template ID'}}, 'additionalProperties': False}
delete_ortb_native_image_asset
Delete an image asset from an ORTB native template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['template_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'Image asset ID'}, 'template_id': {'type': 'number', 'description': 'ORTB native template ID'}}, 'additionalProperties': False}
delete_ortb_native_template
Delete an OpenRTB native template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'ORTB native template ID'}}, 'additionalProperties': False}
delete_ortb_native_title_asset
Delete a title asset from an ORTB native template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['template_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'Title asset ID'}, 'template_id': {'type': 'number', 'description': 'ORTB native template ID'}}, 'additionalProperties': False}
delete_placement
Delete a placement (remove an ad item from a zone)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Placement ID'}}, 'additionalProperties': False}
delete_platform_target
Delete a platform target
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Platform target ID'}}, 'additionalProperties': False}
delete_pmp_deal
Delete a PMP deal
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'PMP deal ID'}}, 'additionalProperties': False}
delete_postal_code_target
Delete a postal code target
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Postal code target ID'}}, 'additionalProperties': False}
delete_product_source
Delete a product source
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['publisher_id', 'source_id'], 'properties': {'source_id': {'type': 'number', 'description': 'Source ID'}, 'publisher_id': {'type': 'number', 'description': 'Publisher ID'}}, 'additionalProperties': False}
delete_product_source_target
Delete a product source target
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['publisher_id', 'source_target_id'], 'properties': {'publisher_id': {'type': 'number', 'description': 'Publisher ID'}, 'source_target_id': {'type': 'number', 'description': 'Source target ID'}}, 'additionalProperties': False}
delete_publisher
Delete a publisher
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Publisher ID'}}, 'additionalProperties': False}
delete_report_schedule
Delete a report schedule
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['report_config_id', 'schedule_id'], 'properties': {'schedule_id': {'type': 'number', 'description': 'Schedule ID'}, 'report_config_id': {'type': 'number', 'description': 'Report configuration ID'}}, 'additionalProperties': False}
delete_rich_media_ad_item
Delete a rich media ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Ad item ID'}}, 'additionalProperties': False}
delete_rich_media_creative
Delete a rich media creative
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Creative ID'}}, 'additionalProperties': False}
delete_role
Delete a role
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Role ID'}}, 'additionalProperties': False}
delete_schedule
Delete a schedule
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Schedule ID'}}, 'additionalProperties': False}
delete_sftp_connection
Delete an SFTP connection
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'SFTP connection ID'}}, 'additionalProperties': False}
delete_signature_request
Delete a signature request
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'Signature request ID'}, 'contract_id': {'type': 'number', 'description': 'Contract ID'}}, 'additionalProperties': False}
delete_signature_request_recipient
Delete a recipient from a signature request
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id', 'request_id', 'recipient_id'], 'properties': {'request_id': {'type': 'number', 'description': 'Signature request ID'}, 'contract_id': {'type': 'number', 'description': 'Contract ID'}, 'recipient_id': {'type': 'number', 'description': 'Recipient ID'}}, 'additionalProperties': False}
delete_trusted_redirect_domain
Delete a trusted redirect domain
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Trusted redirect domain ID'}}, 'additionalProperties': False}
delete_user_attribute
Delete a user attribute from a user database
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['user_db_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'User attribute ID'}, 'user_db_id': {'type': 'number', 'description': 'User database ID'}}, 'additionalProperties': False}
delete_video_creative
Delete a video creative
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Creative ID'}}, 'additionalProperties': False}
delete_zone
Delete a standard zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Zone ID'}}, 'additionalProperties': False}
delete_zone_ortb_native_ad
Delete an ORTB native ad from a standard zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['zone_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'ORTB native ad ID'}, 'zone_id': {'type': 'number', 'description': 'Standard zone ID'}}, 'additionalProperties': False}
describe_adbutler_api
Get the full schema (parameters, request body shape, response shape) for one AdButler API endpoint. Use after search_adbutler_api to understand exactly what to send when you call it.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['method', 'path'], 'properties': {'path': {'type': 'string', 'description': 'Endpoint path with `{placeholder}` syntax for path params, e.g. "/campaigns/{id}". Must match the path returned by search_adbutler_api exactly.'}, 'method': {'type': 'string', 'description': 'HTTP method, e.g. "GET", "POST", "PUT", "DELETE".'}}, 'additionalProperties': False}
download_contract_document_file_revision
Download a file revision for a contract document
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id', 'document_id', 'revision_id'], 'properties': {'contract_id': {'type': 'number', 'description': 'Contract ID'}, 'document_id': {'type': 'number', 'description': 'Document ID'}, 'revision_id': {'type': 'number', 'description': 'File revision ID'}}, 'additionalProperties': False}
draft_create_campaign
Create a new draft standard campaign. Fields go inside a "draft" object wrapper.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['draft'], 'properties': {'draft': {'type': 'object', 'description': 'Object containing standard campaign fields (name, advertiser, etc.)', 'additionalProperties': {}}}, 'additionalProperties': False}
draft_create_campaign_assignment
Create a new draft campaign assignment
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['campaign_draft_id', 'ad_item_draft_id'], 'properties': {'draft': {'type': 'object', 'description': 'Object containing campaign assignment fields (campaign and advertisement auto-resolved)', 'additionalProperties': {}}, 'ad_item_draft_id': {'type': 'number', 'description': 'Draft ad item ID this assignment references'}, 'campaign_draft_id': {'type': 'number', 'description': 'Draft campaign ID this assignment belongs to'}}, 'additionalProperties': False}
draft_create_catalog_ad_item
Create a new draft catalog ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['campaign_draft_id', 'draft'], 'properties': {'draft': {'type': 'object', 'description': 'Object containing catalog ad item fields (name required)', 'additionalProperties': {}}, 'campaign_draft_id': {'type': 'number', 'description': 'Draft campaign ID this ad item belongs to'}}, 'additionalProperties': False}
draft_create_custom_html_ad_item
Create a new draft custom HTML ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['campaign_draft_id', 'draft'], 'properties': {'draft': {'type': 'object', 'description': 'Object containing custom HTML ad item fields (name, custom_html required)', 'additionalProperties': {}}, 'campaign_draft_id': {'type': 'number', 'description': 'Draft campaign ID this ad item belongs to'}}, 'additionalProperties': False}
draft_create_image_ad_item
Create a new draft image ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['campaign_draft_id', 'draft'], 'properties': {'draft': {'type': 'object', 'description': 'Object containing image ad item fields (name required)', 'additionalProperties': {}}, 'campaign_draft_id': {'type': 'number', 'description': 'Draft campaign ID this ad item belongs to'}}, 'additionalProperties': False}
draft_create_native_ad_item
Create a new draft native ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['campaign_draft_id', 'draft'], 'properties': {'draft': {'type': 'object', 'description': 'Object containing native ad item fields (name required, plus template, variables, etc.)', 'additionalProperties': {}}, 'campaign_draft_id': {'type': 'number', 'description': 'Draft campaign ID this ad item belongs to'}}, 'additionalProperties': False}
draft_create_placement
Create a new draft placement
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['campaign_draft_id', 'draft'], 'properties': {'draft': {'type': 'object', 'description': 'Object containing placement fields (zone, advertisement, etc.)', 'additionalProperties': {}}, 'campaign_draft_id': {'type': 'number', 'description': 'Draft campaign ID this placement belongs to'}}, 'additionalProperties': False}
draft_create_rich_media_ad_item
Create a new draft rich media ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['campaign_draft_id', 'draft'], 'properties': {'draft': {'type': 'object', 'description': 'Object containing rich media ad item fields (name required)', 'additionalProperties': {}}, 'campaign_draft_id': {'type': 'number', 'description': 'Draft campaign ID this ad item belongs to'}}, 'additionalProperties': False}
draft_create_schedule
Create a new draft schedule
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['campaign_draft_id', 'draft'], 'properties': {'draft': {'type': 'object', 'description': 'Object containing schedule fields', 'additionalProperties': {}}, 'campaign_draft_id': {'type': 'number', 'description': 'Draft campaign ID this schedule belongs to'}}, 'additionalProperties': False}
draft_delete_campaign
Delete a draft standard campaign
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft campaign ID'}}, 'additionalProperties': False}
draft_delete_campaign_assignment
Delete a draft campaign assignment
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft campaign assignment ID'}}, 'additionalProperties': False}
draft_delete_catalog_ad_item
Delete a draft catalog ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft ad item ID'}}, 'additionalProperties': False}
draft_delete_custom_html_ad_item
Delete a draft custom HTML ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft ad item ID'}}, 'additionalProperties': False}
draft_delete_image_ad_item
Delete a draft image ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft ad item ID'}}, 'additionalProperties': False}
draft_delete_native_ad_item
Delete a draft native ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft ad item ID'}}, 'additionalProperties': False}
draft_delete_placement
Delete a draft placement
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft placement ID'}}, 'additionalProperties': False}
draft_delete_rich_media_ad_item
Delete a draft rich media ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft ad item ID'}}, 'additionalProperties': False}
draft_delete_schedule
Delete a draft schedule
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft schedule ID'}}, 'additionalProperties': False}
draft_get_ad_item
Get a draft ad item of any type by ID
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft ad item ID'}}, 'additionalProperties': False}
draft_get_campaign
Get details of a specific draft standard campaign
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft campaign ID'}}, 'additionalProperties': False}
draft_get_campaign_assignment
Get details of a specific draft campaign assignment
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft campaign assignment ID'}}, 'additionalProperties': False}
draft_get_catalog_ad_item
Get details of a specific draft catalog ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft ad item ID'}}, 'additionalProperties': False}
draft_get_custom_html_ad_item
Get details of a specific draft custom HTML ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft ad item ID'}}, 'additionalProperties': False}
draft_get_image_ad_item
Get details of a specific draft image ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft ad item ID'}}, 'additionalProperties': False}
draft_get_native_ad_item
Get details of a specific draft native ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft ad item ID'}}, 'additionalProperties': False}
draft_get_placement
Get details of a specific draft placement
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft placement ID'}}, 'additionalProperties': False}
draft_get_rich_media_ad_item
Get details of a specific draft rich media ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft ad item ID'}}, 'additionalProperties': False}
draft_get_schedule
Get details of a specific draft schedule
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft schedule ID'}}, 'additionalProperties': False}
draft_list_ad_items
List all draft ad items across all types
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
draft_list_campaign_assignments
List all draft campaign assignments
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
draft_list_campaigns
List all draft standard campaigns
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
draft_list_catalog_ad_items
List all draft catalog ad items
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
draft_list_custom_html_ad_items
List all draft custom HTML ad items
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
draft_list_image_ad_items
List all draft image ad items
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
draft_list_native_ad_items
List all draft native ad items
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
draft_list_placements
List all draft placements
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
draft_list_rich_media_ad_items
List all draft rich media ad items
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
draft_list_schedules
List all draft schedules
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
draft_save_campaign
Save/publish a draft campaign (converts draft to live campaign)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft campaign ID'}}, 'additionalProperties': False}
draft_update_campaign
Update an existing draft standard campaign
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft campaign ID'}, 'draft': {'type': 'object', 'description': 'Object containing standard campaign fields to update', 'additionalProperties': {}}}, 'additionalProperties': False}
draft_update_campaign_assignment
Update an existing draft campaign assignment
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft campaign assignment ID'}, 'draft': {'type': 'object', 'description': 'Object containing campaign assignment fields to update', 'additionalProperties': {}}}, 'additionalProperties': False}
draft_update_catalog_ad_item
Update an existing draft catalog ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft ad item ID'}, 'draft': {'type': 'object', 'description': 'Object containing catalog ad item fields to update', 'additionalProperties': {}}}, 'additionalProperties': False}
draft_update_custom_html_ad_item
Update an existing draft custom HTML ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft ad item ID'}, 'draft': {'type': 'object', 'description': 'Object containing custom HTML ad item fields to update', 'additionalProperties': {}}}, 'additionalProperties': False}
draft_update_image_ad_item
Update an existing draft image ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft ad item ID'}, 'draft': {'type': 'object', 'description': 'Object containing image ad item fields to update', 'additionalProperties': {}}}, 'additionalProperties': False}
draft_update_native_ad_item
Update an existing draft native ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft ad item ID'}, 'draft': {'type': 'object', 'description': 'Object containing native ad item fields to update', 'additionalProperties': {}}}, 'additionalProperties': False}
draft_update_placement
Update an existing draft placement
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft placement ID'}, 'draft': {'type': 'object', 'description': 'Object containing placement fields to update', 'additionalProperties': {}}}, 'additionalProperties': False}
draft_update_rich_media_ad_item
Update an existing draft rich media ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft ad item ID'}, 'draft': {'type': 'object', 'description': 'Object containing rich media ad item fields to update', 'additionalProperties': {}}}, 'additionalProperties': False}
draft_update_schedule
Update an existing draft schedule
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Draft schedule ID'}, 'draft': {'type': 'object', 'description': 'Object containing schedule fields to update', 'additionalProperties': {}}}, 'additionalProperties': False}
generate_bulk_zone_tags
Generate ad serving tags for multiple zones at once
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['zone_ids'], 'properties': {'zone_ids': {'type': 'array', 'items': {'type': 'number'}, 'description': 'Array of zone IDs to generate tags for'}}, 'additionalProperties': False}
get_ad
Retrieve an ad via GET request. Same parameters as serve_ad but uses GET instead of POST.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['ID', 'setID', 'type'], 'properties': {'ID': {'type': 'number', 'description': 'Your AdButler account ID'}, 'ip': {'type': 'string', 'description': 'IPv4 address for geographic targeting (required for server-side requests)'}, 'kw': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Keywords for keyword targeting'}, 'rf': {'type': 'number', 'description': 'Pass 1 to include is_redirectable field in response'}, 'sh': {'type': 'number', 'description': 'Screen height for platform targeting'}, 'sw': {'type': 'number', 'description': 'Screen width for platform targeting'}, 'ua': {'type': 'string', 'description': 'User agent string for platform targeting'}, 'pid': {'type': 'number', 'description': 'Page ID for unique delivery/roadblocks (random number, same for all zones on page)'}, 'spr': {'type': 'number', 'description': 'Screen pixel ratio for platform targeting'}, 'size': {'type': 'string', 'description': 'Expected ad size (e.g. "300x250")'}, 'type': {'enum': ['json', 'jsonr'], 'type': 'string', 'description': 'Response type: "json" for most eligible ad, "jsonr" for all eligible ads ranked'}, 'place': {'type': 'number', 'description': 'Place counter for unique delivery (0, 1, 2, etc.)'}, 'setID': {'type': 'number', 'description': 'Zone ID to serve an ad from'}, 'referrer': {'type': 'string', 'description': 'Page URL for URL targeting (required for server-side requests)'}, '_abdk_json': {'type': 'object', 'description': 'Data key key-value pairs for data key targeting', 'additionalProperties': {}}, 'defer_signing': {'type': 'boolean', 'description': 'Defer beacon signing hash generation'}}, 'additionalProperties': False}
get_advertiser
Get details of a specific advertiser by ID
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Advertiser ID'}}, 'additionalProperties': False}
get_archived_advertiser
Get details of a specific archived advertiser
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived advertiser ID'}}, 'additionalProperties': False}
get_archived_campaign
Get details of a specific archived standard campaign
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived campaign ID'}}, 'additionalProperties': False}
get_archived_channel
Get details of a specific archived channel
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived channel ID'}}, 'additionalProperties': False}
get_archived_contract
Get details of a specific archived contract
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived contract ID'}}, 'additionalProperties': False}
get_archived_email_zone
Get details of a specific archived email zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived email zone ID'}}, 'additionalProperties': False}
get_archived_publisher
Get details of a specific archived publisher
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived publisher ID'}}, 'additionalProperties': False}
get_archived_zone
Get details of a specific archived standard zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived zone ID'}}, 'additionalProperties': False}
get_auction_placements_report
Get auction placement statistics report
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'preset': {'type': 'string', 'description': 'Date preset'}, 'timezone': {'type': 'string', 'description': 'Timezone'}}, 'additionalProperties': False}
get_audience
Get details of a specific audience in a user database
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['user_db_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'Audience ID'}, 'user_db_id': {'type': 'number', 'description': 'User database ID'}}, 'additionalProperties': False}
get_audio_creative
Get details of a specific audio creative
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Creative ID'}}, 'additionalProperties': False}
get_beacon_signing_key
Get details of a specific beacon signing key by ID
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Beacon signing key ID'}}, 'additionalProperties': False}
get_bidder
Get details of a specific bidder by ID
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Bidder ID'}}, 'additionalProperties': False}
get_campaign
Get details of a specific standard campaign
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Campaign ID'}}, 'additionalProperties': False}
get_campaign_assignment
Get details of a specific campaign assignment
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Campaign assignment ID'}}, 'additionalProperties': False}
get_campaign_conversion_tag
Get conversion tag for a campaign
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Campaign ID'}}, 'additionalProperties': False}
get_campaign_eligible_zones
Get eligible zones for a campaign
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Campaign ID'}}, 'additionalProperties': False}
get_catalog_ad_item
Get details of a specific catalog ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Ad item ID'}}, 'additionalProperties': False}
get_catalog_zone
Get details of a specific catalog zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Catalog zone ID'}}, 'additionalProperties': False}
get_catalog_zone_tag
Get the ad serving tag for a catalog zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Catalog zone ID'}}, 'additionalProperties': False}
get_channel
Get details of a specific channel
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Channel ID'}}, 'additionalProperties': False}
get_channel_zone_assignment
Get details of a specific channel zone assignment
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Channel zone assignment ID'}}, 'additionalProperties': False}
get_click_details_report
Get click details report
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'zones': {'type': 'string', 'description': 'Filter by zone IDs (comma-separated)'}, 'preset': {'type': 'string', 'description': 'Date preset'}, 'timezone': {'type': 'string', 'description': 'Timezone'}, 'campaigns': {'type': 'string', 'description': 'Filter by campaign IDs (comma-separated)'}, 'publishers': {'type': 'string', 'description': 'Filter by publisher IDs (comma-separated)'}, 'advertisers': {'type': 'string', 'description': 'Filter by advertiser IDs (comma-separated)'}}, 'additionalProperties': False}
get_contact
Get details of a specific contact by ID
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Contact ID'}}, 'additionalProperties': False}
get_contact_report_schedules
List report schedules for a contact
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Contact ID'}}, 'additionalProperties': False}
get_contract
Get details of a specific contract
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Contract ID'}}, 'additionalProperties': False}
get_contract_active_signature_request
Get the active signature request for a contract
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Contract ID'}}, 'additionalProperties': False}
get_contract_assigned_campaigns
Get campaigns assigned to a contract
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Contract ID'}}, 'additionalProperties': False}
get_contract_document
Get details of a specific contract document
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'Document ID'}, 'contract_id': {'type': 'number', 'description': 'Contract ID'}}, 'additionalProperties': False}
get_contract_document_file_revision
Get a specific file revision for a contract document
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id', 'document_id', 'revision_id'], 'properties': {'contract_id': {'type': 'number', 'description': 'Contract ID'}, 'document_id': {'type': 'number', 'description': 'Document ID'}, 'revision_id': {'type': 'number', 'description': 'File revision ID'}}, 'additionalProperties': False}
get_contract_payment
Get details of a specific contract payment
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'Payment ID'}, 'contract_id': {'type': 'number', 'description': 'Contract ID'}}, 'additionalProperties': False}
get_contract_template
Get details of a specific contract template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Contract template ID'}}, 'additionalProperties': False}
get_conversion_details_report
Get conversion details report
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'zones': {'type': 'string', 'description': 'Filter by zone IDs (comma-separated)'}, 'preset': {'type': 'string', 'description': 'Date preset'}, 'timezone': {'type': 'string', 'description': 'Timezone'}, 'campaigns': {'type': 'string', 'description': 'Filter by campaign IDs (comma-separated)'}, 'publishers': {'type': 'string', 'description': 'Filter by publisher IDs (comma-separated)'}, 'advertisers': {'type': 'string', 'description': 'Filter by advertiser IDs (comma-separated)'}}, 'additionalProperties': False}
get_creative
Get details of a specific image creative
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Creative ID'}}, 'additionalProperties': False}
get_custom_html_ad_item
Get details of a specific custom HTML ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Ad item ID'}}, 'additionalProperties': False}
get_custom_html_ad_item_conversion_tag
Get conversion tracking tag for a custom HTML ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Ad item ID'}}, 'additionalProperties': False}
get_custom_report
Get details of a specific report configuration
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Report configuration ID'}}, 'additionalProperties': False}
get_data_key
Get details of a specific data key
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Data key ID'}}, 'additionalProperties': False}
get_data_key_target
Get details of a specific data key target
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Data key target ID'}}, 'additionalProperties': False}
get_data_list
Get details of a specific data list by ID
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Data list ID'}}, 'additionalProperties': False}
get_day_parting
Get details of a specific day parting rule
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Day parting ID'}}, 'additionalProperties': False}
get_demand_endpoint
Get details of a specific demand endpoint by ID
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Demand endpoint ID'}}, 'additionalProperties': False}
get_demand_source
Get details of a specific demand source by ID
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Demand source ID'}}, 'additionalProperties': False}
get_demand_source_report
Get demand source statistics report
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'preset': {'type': 'string', 'description': 'Date preset'}, 'timezone': {'type': 'string', 'description': 'Timezone'}}, 'additionalProperties': False}
get_display_channel_forecast
Get display channel forecast report
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'preset': {'type': 'string', 'description': 'Date preset'}, 'timezone': {'type': 'string', 'description': 'Timezone'}}, 'additionalProperties': False}
get_display_forecast
Get display forecast report
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'preset': {'type': 'string', 'description': 'Date preset'}, 'timezone': {'type': 'string', 'description': 'Timezone'}}, 'additionalProperties': False}
get_display_platform_estimate
Get display platform estimate statistics
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'preset': {'type': 'string', 'description': 'Date preset'}, 'timezone': {'type': 'string', 'description': 'Timezone'}}, 'additionalProperties': False}
get_display_report
Get display advertising report with impressions, clicks, and CTR
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['type', 'period'], 'properties': {'type': {'type': 'string', 'description': 'Report type: overview, advertiser, publisher, zone, campaign, channel, geo-target, ad-item'}, 'zones': {'type': 'string', 'description': 'Filter by zone IDs (comma-separated)'}, 'period': {'type': 'string', 'description': 'Data grouping period: day, week, month, year'}, 'preset': {'type': 'string', 'description': 'Date preset: today, last-24-hours, yesterday, this-week, last-week, this-month, last-month, year-to-date, last-year, last-7-days, last-14-days, last-30-days, last-3-months, last-6-months, last-12-months'}, 'details': {'type': 'boolean', 'description': 'Include detailed breakdown'}, 'summary': {'type': 'boolean', 'description': 'Include summary data'}, 'timezone': {'type': 'string', 'description': 'Timezone for preset (e.g. "America/New_York")'}, 'breakdown': {'type': 'boolean', 'description': 'Include breakdown data'}, 'campaigns': {'type': 'string', 'description': 'Filter by campaign IDs (comma-separated)'}, 'financials': {'type': 'boolean', 'description': 'Include financial data'}, 'publishers': {'type': 'string', 'description': 'Filter by publisher IDs (comma-separated)'}, 'advertisers': {'type': 'string', 'description': 'Filter by advertiser IDs (comma-separated)'}, 'exclude_channel_stats': {'type': 'boolean', 'description': 'Exclude stats from channel-served ads'}, 'require_channel_stats': {'type': 'boolean', 'description': 'Only include stats from channel-served ads'}, 'exclude_campaign_ad_items': {'type': 'boolean', 'description': 'Exclude ad items in campaigns'}, 'exclude_publisher_ad_items': {'type': 'boolean', 'description': 'Exclude ad items directly in zones'}}, 'additionalProperties': False}
get_email_zone
Get details of a specific email zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Email zone ID'}}, 'additionalProperties': False}
get_email_zone_conversion_tag
Get the conversion tracking tag for an email zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Email zone ID'}}, 'additionalProperties': False}
get_email_zone_tag
Get the ad serving tag for an email zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Email zone ID'}}, 'additionalProperties': False}
get_event_logs
Get event logs for account activity (changes, logins, etc.)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['log_type'], 'properties': {'to': {'type': 'string', 'description': 'End date filter'}, 'from': {'type': 'string', 'description': 'Start date filter'}, 'log_type': {'type': 'string', 'description': 'Type of event log to retrieve'}}, 'additionalProperties': False}
get_event_log_upload_config
Get details of a specific event log upload configuration
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Upload configuration ID'}}, 'additionalProperties': False}
get_event_log_upload_log
Get details of a specific event log upload log entry
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Upload log ID'}}, 'additionalProperties': False}
get_geo_summary_report
Get geographic summary report
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'zones': {'type': 'string', 'description': 'Filter by zone IDs (comma-separated)'}, 'preset': {'type': 'string', 'description': 'Date preset'}, 'timezone': {'type': 'string', 'description': 'Timezone'}, 'campaigns': {'type': 'string', 'description': 'Filter by campaign IDs (comma-separated)'}, 'publishers': {'type': 'string', 'description': 'Filter by publisher IDs (comma-separated)'}, 'advertisers': {'type': 'string', 'description': 'Filter by advertiser IDs (comma-separated)'}}, 'additionalProperties': False}
get_geo_target
Get details of a specific geo target
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Geo target ID'}}, 'additionalProperties': False}
get_image_ad_item
Get details of a specific image ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Ad item ID'}}, 'additionalProperties': False}
get_image_ad_item_conversion_tag
Get conversion tracking tag for an image ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Ad item ID'}}, 'additionalProperties': False}
get_kogan_dashboard_report
Get the Kogan self-serve dashboard report, including overview and Value Catcher ad item stats. Kogan marketplace accounts only â requires the Kogan self-serve feature; other accounts receive a feature-not-enabled error.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['type', 'period'], 'properties': {'to': {'type': 'string', 'description': 'End date (required with "from" unless preset is set)'}, 'from': {'type': 'string', 'description': 'Start date (required with "to" unless preset is set)'}, 'type': {'type': 'string', 'description': 'Report type: overview, advertiser, zone, campaign, ad-item, value-catcher-ad-item'}, 'period': {'type': 'string', 'description': 'Data grouping period: day, week, month, year'}, 'portal': {'type': 'number', 'description': 'Marketplace portal ID â\x80\x94 report currency follows the portal (e.g. NZ portal reports in NZD); omit for the account default currency'}, 'preset': {'type': 'string', 'description': 'Date preset: today, last-24-hours, yesterday, this-week, last-7-days, last-week, last-14-days, this-month, last-30-days, last-month, last-3-months, last-6-months, last-12-months, year-to-date, last-year (required unless from/to are set)'}, 'details': {'type': 'boolean', 'description': 'Include detailed breakdown'}, 'summary': {'type': 'boolean', 'description': 'Include summary data'}, 'ad_items': {'type': 'string', 'description': 'Filter by ad item IDs (comma-separated)'}, 'channels': {'type': 'string', 'description': 'Filter by channel IDs (comma-separated)'}, 'timezone': {'type': 'string', 'description': 'Timezone for dates (default Australia/Melbourne)'}, 'breakdown': {'type': 'boolean', 'description': 'Include breakdown data'}, 'campaigns': {'type': 'string', 'description': 'Filter by campaign IDs (comma-separated)'}, 'financials': {'type': 'boolean', 'description': 'Include financial data'}, 'advertisers': {'type': 'string', 'description': 'Filter by advertiser IDs (comma-separated)'}, 'simple_stats': {'type': 'boolean', 'description': 'Return simplified stats'}}, 'additionalProperties': False}
get_kogan_product
Get a Kogan marketplace product by seller ID and SKU (title, brand, category, stock, offers, store URLs, images). Kogan marketplace accounts only â requires the Kogan self-serve feature; other accounts receive a feature-not-enabled error.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['seller_id', 'sku'], 'properties': {'sku': {'type': 'string', 'description': 'Product SKU'}, 'seller_id': {'type': 'string', 'description': 'Kogan seller ID'}}, 'additionalProperties': False}
get_kogan_report
Get a Kogan marketplace advertising report (includes Value Catcher stats merged with display stats). Kogan marketplace accounts only â requires the Kogan self-serve feature; other accounts receive a feature-not-enabled error.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['type', 'period'], 'properties': {'to': {'type': 'string', 'description': 'End date (required with "from" unless preset is set)'}, 'from': {'type': 'string', 'description': 'Start date (required with "to" unless preset is set)'}, 'type': {'type': 'string', 'description': 'Report type: advertiser, campaign, ad-item'}, 'zones': {'type': 'string', 'description': 'Filter by zone IDs (comma-separated)'}, 'period': {'type': 'string', 'description': 'Data grouping period: day, week, month, year'}, 'portal': {'type': 'number', 'description': 'Marketplace portal ID â\x80\x94 report currency follows the portal (e.g. NZ portal reports in NZD); omit for the account default currency'}, 'preset': {'type': 'string', 'description': 'Date preset: today, last-24-hours, yesterday, this-week, last-7-days, last-week, last-14-days, this-month, last-30-days, last-month, last-3-months, last-6-months, last-12-months, year-to-date, last-year (required unless from/to are set)'}, 'details': {'type': 'boolean', 'description': 'Include detailed breakdown'}, 'summary': {'type': 'boolean', 'description': 'Include summary data'}, 'ad_items': {'type': 'string', 'description': 'Filter by ad item IDs (comma-separated)'}, 'timezone': {'type': 'string', 'description': 'Timezone for dates (default Australia/Melbourne)'}, 'breakdown': {'type': 'boolean', 'description': 'Include breakdown data'}, 'campaigns': {'type': 'string', 'description': 'Filter by campaign IDs (comma-separated)'}, 'financials': {'type': 'boolean', 'description': 'Include financial data'}, 'advertisers': {'type': 'string', 'description': 'Filter by advertiser IDs (comma-separated)'}}, 'additionalProperties': False}
get_list_target
Get details of a specific list target
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'List target ID'}}, 'additionalProperties': False}
get_live_website_preview
Get live website preview URL
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'url': {'type': 'string', 'description': 'Website URL to preview'}, 'zone_id': {'type': 'number', 'description': 'Zone ID to preview'}}, 'additionalProperties': False}
get_manager
Get details of a specific manager by ID
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Manager ID'}}, 'additionalProperties': False}
get_manual_tracking_links
Generate manual tracking links for an ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'type': {'type': 'string', 'description': 'Ad item type'}, 'ad_item_id': {'type': 'number', 'description': 'Ad item ID'}}, 'additionalProperties': False}
get_media_group
Get details of a specific media group
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Media group ID'}}, 'additionalProperties': False}
get_native_ad_item
Get details of a specific native ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Ad item ID'}}, 'additionalProperties': False}
get_native_ad_item_conversion_tag
Get conversion tracking tag for a native ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Ad item ID'}}, 'additionalProperties': False}
get_native_template
Get details of a specific native template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Native template ID'}}, 'additionalProperties': False}
get_ortb_native_data_asset
Get details of a specific data asset for an ORTB native template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['template_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'Data asset ID'}, 'template_id': {'type': 'number', 'description': 'ORTB native template ID'}}, 'additionalProperties': False}
get_ortb_native_image_asset
Get details of a specific image asset for an ORTB native template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['template_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'Image asset ID'}, 'template_id': {'type': 'number', 'description': 'ORTB native template ID'}}, 'additionalProperties': False}
get_ortb_native_template
Get details of a specific OpenRTB native template by ID
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'ORTB native template ID'}}, 'additionalProperties': False}
get_ortb_native_title_asset
Get details of a specific title asset for an ORTB native template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['template_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'Title asset ID'}, 'template_id': {'type': 'number', 'description': 'ORTB native template ID'}}, 'additionalProperties': False}
get_placement
Get details of a specific placement
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Placement ID'}}, 'additionalProperties': False}
get_placement_conversion_tag
Get conversion tracking tag for a placement
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Placement ID'}}, 'additionalProperties': False}
get_placement_forecast
Get placement forecast report
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'preset': {'type': 'string', 'description': 'Date preset'}, 'timezone': {'type': 'string', 'description': 'Timezone'}}, 'additionalProperties': False}
get_platform_target
Get details of a specific platform target
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Platform target ID'}}, 'additionalProperties': False}
get_pmp_deal
Get details of a specific PMP deal by ID
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'PMP deal ID'}}, 'additionalProperties': False}
get_postal_code_target
Get details of a specific postal code target
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Postal code target ID'}}, 'additionalProperties': False}
get_product_catalog
Get details of a specific product catalog
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['publisher_id', 'catalog_id'], 'properties': {'catalog_id': {'type': 'number', 'description': 'Catalog ID'}, 'publisher_id': {'type': 'number', 'description': 'Publisher ID'}}, 'additionalProperties': False}
get_product_catalog_item
Get details of a specific product catalog item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['publisher_id', 'catalog_id', 'identifier'], 'properties': {'catalog_id': {'type': 'number', 'description': 'Catalog ID'}, 'identifier': {'type': 'string', 'description': 'Unique identifier for the catalog item'}, 'publisher_id': {'type': 'number', 'description': 'Publisher ID'}}, 'additionalProperties': False}
get_product_source
Get details of a specific product source
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['publisher_id', 'source_id'], 'properties': {'source_id': {'type': 'number', 'description': 'Source ID'}, 'publisher_id': {'type': 'number', 'description': 'Publisher ID'}}, 'additionalProperties': False}
get_product_source_target
Get details of a specific product source target
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['publisher_id', 'source_target_id'], 'properties': {'publisher_id': {'type': 'number', 'description': 'Publisher ID'}, 'source_target_id': {'type': 'number', 'description': 'Source target ID'}}, 'additionalProperties': False}
get_publisher
Get details of a specific publisher
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Publisher ID'}}, 'additionalProperties': False}
get_report_generated
Get a specific generated report
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['report_config_id', 'generated_id'], 'properties': {'generated_id': {'type': 'number', 'description': 'Generated report ID'}, 'report_config_id': {'type': 'number', 'description': 'Report configuration ID'}}, 'additionalProperties': False}
get_report_schedule
Get a specific report schedule
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['report_config_id', 'schedule_id'], 'properties': {'schedule_id': {'type': 'number', 'description': 'Schedule ID'}, 'report_config_id': {'type': 'number', 'description': 'Report configuration ID'}}, 'additionalProperties': False}
get_report_schedule_generated
Get a specific generated report from a schedule
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['report_config_id', 'schedule_id', 'generated_id'], 'properties': {'schedule_id': {'type': 'number', 'description': 'Schedule ID'}, 'generated_id': {'type': 'number', 'description': 'Generated report ID'}, 'report_config_id': {'type': 'number', 'description': 'Report configuration ID'}}, 'additionalProperties': False}
get_rich_media_ad_item
Get details of a specific rich media ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Ad item ID'}}, 'additionalProperties': False}
get_rich_media_ad_item_conversion_tag
Get conversion tracking tag for a rich media ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Ad item ID'}}, 'additionalProperties': False}
get_rich_media_creative
Get details of a specific rich media creative
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Creative ID'}}, 'additionalProperties': False}
get_role
Get details of a specific role by ID
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Role ID'}}, 'additionalProperties': False}
get_schedule
Get details of a specific schedule
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Schedule ID'}}, 'additionalProperties': False}
get_sftp_connection
Get details of a specific SFTP connection by ID
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'SFTP connection ID'}}, 'additionalProperties': False}
get_signature_request
Get details of a specific signature request
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'Signature request ID'}, 'contract_id': {'type': 'number', 'description': 'Contract ID'}}, 'additionalProperties': False}
get_signature_request_recipient
Get a specific recipient for a signature request
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id', 'request_id', 'recipient_id'], 'properties': {'request_id': {'type': 'number', 'description': 'Signature request ID'}, 'contract_id': {'type': 'number', 'description': 'Contract ID'}, 'recipient_id': {'type': 'number', 'description': 'Recipient ID'}}, 'additionalProperties': False}
get_trusted_redirect_domain
Get details of a specific trusted redirect domain by ID
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Trusted redirect domain ID'}}, 'additionalProperties': False}
get_user
Get a single user from a user database
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['user_db_id', 'user_id'], 'properties': {'user_id': {'type': 'string', 'description': 'User ID'}, 'user_db_id': {'type': 'number', 'description': 'User database ID'}}, 'additionalProperties': False}
get_user_attribute
Get details of a specific user attribute in a user database
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['user_db_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'User attribute ID'}, 'user_db_id': {'type': 'number', 'description': 'User database ID'}}, 'additionalProperties': False}
get_user_db
Get details of a specific user database by ID
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'User database ID'}}, 'additionalProperties': False}
get_vast_ad_item_conversion_tag
Get conversion tracking tag for a VAST ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST ad item ID'}}, 'additionalProperties': False}
get_vast_auction_placements_report
Get VAST auction placements report
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'preset': {'type': 'string', 'description': 'Date preset'}, 'timezone': {'type': 'string', 'description': 'Timezone'}}, 'additionalProperties': False}
get_vast_campaign_conversion_tag
Get conversion tracking tag for a VAST campaign
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST campaign ID'}}, 'additionalProperties': False}
get_vast_channel_forecast
Get VAST channel forecast report
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'preset': {'type': 'string', 'description': 'Date preset'}, 'timezone': {'type': 'string', 'description': 'Timezone'}}, 'additionalProperties': False}
get_vast_custom_report
Get a specific VAST report
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST report ID'}}, 'additionalProperties': False}
get_vast_forecast
Get VAST forecast report
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'preset': {'type': 'string', 'description': 'Date preset'}, 'timezone': {'type': 'string', 'description': 'Timezone'}}, 'additionalProperties': False}
get_vast_geo_summary_report
Get VAST geographic summary report
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'zones': {'type': 'string', 'description': 'Filter by zone IDs (comma-separated)'}, 'preset': {'type': 'string', 'description': 'Date preset'}, 'timezone': {'type': 'string', 'description': 'Timezone'}, 'campaigns': {'type': 'string', 'description': 'Filter by campaign IDs (comma-separated)'}, 'publishers': {'type': 'string', 'description': 'Filter by publisher IDs (comma-separated)'}, 'advertisers': {'type': 'string', 'description': 'Filter by advertiser IDs (comma-separated)'}}, 'additionalProperties': False}
get_vast_placement_conversion_tag
Get conversion tracking tag for a VAST placement
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST placement ID'}}, 'additionalProperties': False}
get_vast_platform_estimate
Get VAST platform estimate statistics
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'preset': {'type': 'string', 'description': 'Date preset'}, 'timezone': {'type': 'string', 'description': 'Timezone'}}, 'additionalProperties': False}
get_vast_report
Get VAST video advertising report
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['type', 'period'], 'properties': {'type': {'type': 'string', 'description': 'Report type: overview, advertiser, publisher, zone, campaign, ad-item'}, 'zones': {'type': 'string', 'description': 'Filter by zone IDs (comma-separated)'}, 'period': {'type': 'string', 'description': 'Data grouping period: day, week, month, year'}, 'preset': {'type': 'string', 'description': 'Date preset (same options as display report)'}, 'details': {'type': 'boolean', 'description': 'Include detailed breakdown'}, 'summary': {'type': 'boolean', 'description': 'Include summary data'}, 'timezone': {'type': 'string', 'description': 'Timezone for preset'}, 'breakdown': {'type': 'boolean', 'description': 'Include breakdown data'}, 'campaigns': {'type': 'string', 'description': 'Filter by campaign IDs (comma-separated)'}, 'financials': {'type': 'boolean', 'description': 'Include financial data'}, 'publishers': {'type': 'string', 'description': 'Filter by publisher IDs (comma-separated)'}, 'advertisers': {'type': 'string', 'description': 'Filter by advertiser IDs (comma-separated)'}}, 'additionalProperties': False}
get_vast_zone_conversion_tag
Get VAST zone conversion tracking tag
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST zone ID'}}, 'additionalProperties': False}
get_vast_zone_tags
Get VAST zone serving tags
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST zone ID'}}, 'additionalProperties': False}
get_video_creative
Get details of a specific video creative
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Creative ID'}}, 'additionalProperties': False}
get_zone
Get details of a specific standard zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Zone ID'}}, 'additionalProperties': False}
get_zone_conversion_tag
Get the conversion tracking tag for a standard zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Zone ID'}}, 'additionalProperties': False}
get_zone_ortb_native_ad
Get details of a specific ORTB native ad for a standard zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['zone_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'ORTB native ad ID'}, 'zone_id': {'type': 'number', 'description': 'Standard zone ID'}}, 'additionalProperties': False}
get_zone_tag
Get the ad serving tag (embed code) for a zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Zone ID'}}, 'additionalProperties': False}
list_ad_items
List all ad items (banners) across all types (image, custom HTML, rich media, native, catalog)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_advertisers
List all advertisers in your AdButler account
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_all_campaigns
List all campaigns across all types
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_all_creatives
List all creatives across all types (image, rich media, video, audio)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_all_generated_reports
List all generated reports across all configurations
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_all_report_schedules
List all report schedules across all configurations
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_all_zones
List all zones across all types (standard, email, catalog)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_archived_advertisers
List all archived advertisers
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_archived_campaigns
List all archived standard campaigns
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_archived_channels
List all archived channels
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_archived_contracts
List all archived contracts
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_archived_email_zones
List all archived email zones
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_archived_publishers
List all archived publishers
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_archived_zones
List all archived standard zones
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_audiences
List all audiences in a user database
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['user_db_id'], 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}, 'user_db_id': {'type': 'number', 'description': 'User database ID'}}, 'additionalProperties': False}
list_audio_creatives
List all audio creatives
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_beacon_signing_keys
List all beacon signing keys in your AdButler account
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_bidders
List all bidders in your AdButler account
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_campaign_assignments
List all campaign assignments (ad items assigned to campaigns)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_campaigns
List all standard campaigns
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_catalog_ad_items
List all catalog ad items
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_catalog_zones
List all catalog zones (for product/retail ad serving)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_channels
List all channels
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_channel_zone_assignments
List all channel zone assignments
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_contacts
List all contacts in your AdButler account
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_contract_document_file_revisions
List file revisions for a contract document
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id', 'document_id'], 'properties': {'contract_id': {'type': 'number', 'description': 'Contract ID'}, 'document_id': {'type': 'number', 'description': 'Document ID'}}, 'additionalProperties': False}
list_contract_documents
List all documents for a contract
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id'], 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}, 'contract_id': {'type': 'number', 'description': 'Contract ID'}}, 'additionalProperties': False}
list_contract_payments
List all payments for a contract
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id'], 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}, 'contract_id': {'type': 'number', 'description': 'Contract ID'}}, 'additionalProperties': False}
list_contracts
List all contracts
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_contract_templates
List all contract templates
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_creatives
List all image creatives
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_custom_html_ad_items
List all custom HTML ad items
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_custom_reports
List all saved report configurations
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_data_keys
List all data keys (custom key-value targeting variables)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_data_key_targets
List all data key targets (targeting rules using data key values)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_data_lists
List all data lists in your AdButler account
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_data_targets
List all data targets
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_day_partings
List all day parting rules (time-of-day targeting)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_demand_endpoints
List all demand endpoints in your AdButler account
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_demand_sources
List all demand sources in your AdButler account
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_email_zones
List all email zones
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_event_log_upload_configs
List all event log upload configurations
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_event_log_upload_logs
List all event log upload logs
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_geo_targets
List all geo targets (geographic targeting rules)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_image_ad_items
List all image ad items
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_list_targets
List all list targets (allowlist/blocklist targeting)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_managers
List all managers in your AdButler account
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_media_groups
List all media groups (collections of creatives)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_native_ad_items
List all native ad items
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_native_templates
List all native ad templates
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_ortb_native_data_assets
List all data assets for an ORTB native template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['template_id'], 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}, 'template_id': {'type': 'number', 'description': 'ORTB native template ID'}}, 'additionalProperties': False}
list_ortb_native_image_assets
List all image assets for an ORTB native template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['template_id'], 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}, 'template_id': {'type': 'number', 'description': 'ORTB native template ID'}}, 'additionalProperties': False}
list_ortb_native_templates
List all OpenRTB native templates in your AdButler account
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_ortb_native_title_assets
List all title assets for an ORTB native template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['template_id'], 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}, 'template_id': {'type': 'number', 'description': 'ORTB native template ID'}}, 'additionalProperties': False}
list_placements
List all placements (assignments of ad items to zones)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_platform_targets
List all platform targets (device/OS/browser targeting)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_pmp_deals
List all PMP deals in your AdButler account
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_postal_code_targets
List all postal code targets
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_product_catalogs
List all product catalogs for a publisher
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['publisher_id'], 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}, 'publisher_id': {'type': 'number', 'description': 'Publisher ID'}}, 'additionalProperties': False}
list_product_sources
List all product sources for a publisher
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['publisher_id'], 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}, 'publisher_id': {'type': 'number', 'description': 'Publisher ID'}}, 'additionalProperties': False}
list_product_source_targets
List all product source targets for a publisher
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['publisher_id'], 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}, 'publisher_id': {'type': 'number', 'description': 'Publisher ID'}}, 'additionalProperties': False}
list_publishers
List all publishers in your AdButler account
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_report_generated
List generated reports for a specific report configuration
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['report_config_id'], 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}, 'report_config_id': {'type': 'number', 'description': 'Report configuration ID'}}, 'additionalProperties': False}
list_report_schedule_generated
List generated reports for a specific schedule
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['report_config_id', 'schedule_id'], 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}, 'schedule_id': {'type': 'number', 'description': 'Schedule ID'}, 'report_config_id': {'type': 'number', 'description': 'Report configuration ID'}}, 'additionalProperties': False}
list_report_schedules
List schedules for a specific report configuration
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['report_config_id'], 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}, 'report_config_id': {'type': 'number', 'description': 'Report configuration ID'}}, 'additionalProperties': False}
list_rich_media_ad_items
List all rich media ad items
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_rich_media_creatives
List all rich media creatives
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_roles
List all roles in your AdButler account
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_schedules
List all schedules (time-based delivery rules for ad items)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_sftp_connections
List all SFTP connections in your AdButler account
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_signature_request_recipients
List all recipients for a signature request
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id', 'request_id'], 'properties': {'request_id': {'type': 'number', 'description': 'Signature request ID'}, 'contract_id': {'type': 'number', 'description': 'Contract ID'}}, 'additionalProperties': False}
list_signature_requests
List all signature requests for a contract
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id'], 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}, 'contract_id': {'type': 'number', 'description': 'Contract ID'}}, 'additionalProperties': False}
list_trusted_redirect_domains
List all trusted redirect domains in your AdButler account
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_user_attributes
List all user attributes in a user database
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['user_db_id'], 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}, 'user_db_id': {'type': 'number', 'description': 'User database ID'}}, 'additionalProperties': False}
list_user_dbs
List all user databases in your AdButler account
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_vast_custom_reports
List all VAST report data
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_video_creatives
List all video creatives
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
list_zone_ortb_native_ads
List all ORTB native ads for a standard zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['zone_id'], 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}, 'zone_id': {'type': 'number', 'description': 'Standard zone ID'}}, 'additionalProperties': False}
list_zones
List all standard zones
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
remove_list_target_usages
Remove all usages of a list target
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'List target ID'}}, 'additionalProperties': False}
remove_user_list_attribute_values
Remove values from a list attribute for a user
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['user_db_id', 'user_id', 'list_attribute_name'], 'properties': {'values': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Values to remove'}, 'user_id': {'type': 'string', 'description': 'User ID'}, 'user_db_id': {'type': 'number', 'description': 'User database ID'}, 'list_attribute_name': {'type': 'string', 'description': 'List attribute name'}}, 'additionalProperties': False}
replace_audio_creative_file
Replace the file on an audio creative
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Creative ID'}}, 'additionalProperties': False}
replace_contract_document_file
Replace the file on a contract document
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id', 'document_id'], 'properties': {'contract_id': {'type': 'number', 'description': 'Contract ID'}, 'document_id': {'type': 'number', 'description': 'Document ID'}}, 'additionalProperties': False}
replace_contract_document_file_from_template
Replace a contract document file from a template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id', 'document_id'], 'properties': {'contract_id': {'type': 'number', 'description': 'Contract ID'}, 'document_id': {'type': 'number', 'description': 'Document ID'}}, 'additionalProperties': False}
replace_image_creative_file
Replace the file on an image creative
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Creative ID'}}, 'additionalProperties': False}
replace_rich_media_creative_file
Replace the file on a rich media creative
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Creative ID'}}, 'additionalProperties': False}
replace_video_creative_file
Replace the file on a video creative
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Creative ID'}}, 'additionalProperties': False}
resend_signature_request
Resend a signature request
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id', 'request_id'], 'properties': {'request_id': {'type': 'number', 'description': 'Signature request ID'}, 'contract_id': {'type': 'number', 'description': 'Contract ID'}}, 'additionalProperties': False}
resend_verification_code
Resend the email verification code for a trial account. Use this if the user did not receive the code or it expired.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['email'], 'properties': {'email': {'type': 'string', 'description': 'The email address used to create the trial account'}}, 'additionalProperties': False}
revoke_report_schedule_historical_access
Revoke historical access for a report schedule
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['report_config_id', 'schedule_id'], 'properties': {'schedule_id': {'type': 'number', 'description': 'Schedule ID'}, 'report_config_id': {'type': 'number', 'description': 'Report configuration ID'}}, 'additionalProperties': False}
search_adbutler_api
Find AdButler API endpoints by keyword when no specific tool matches what you need. Returns matching endpoints with their HTTP method, path, and a brief summary. Use this when the user asks about a concept that is a *field* rather than a resource â e.g. 'priority', 'pacing', 'frequency cap', 'metadata', 'tracking pixel' â and you can't find a tool that handles it. Then call describe_adbutler_api on the most promising hit, then call_adbutler_api to invoke it.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['query'], 'properties': {'limit': {'type': 'integer', 'description': 'Max results to return (default 10, max 50).'}, 'query': {'type': 'string', 'description': 'Keyword(s) to search for. Single word works best.'}}, 'additionalProperties': False}
search_product_catalog_items
Search for items in a product catalog
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['publisher_id', 'catalog_id'], 'properties': {'query': {'type': 'string', 'description': 'Search query string'}, 'catalog_id': {'type': 'number', 'description': 'Catalog ID'}, 'publisher_id': {'type': 'number', 'description': 'Publisher ID'}}, 'additionalProperties': False}
serve_ad
Request ad delivery for a zone. Returns the ad(s) that would be served, useful for verifying ad setup. Uses POST /adserve.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['ID', 'setID', 'type'], 'properties': {'ID': {'type': 'number', 'description': 'Your AdButler account ID'}, 'ip': {'type': 'string', 'description': 'IPv4 address for geographic targeting (required for server-side requests)'}, 'kw': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Keywords for keyword targeting'}, 'rf': {'type': 'number', 'description': 'Pass 1 to include is_redirectable field in response'}, 'sh': {'type': 'number', 'description': 'Screen height for platform targeting'}, 'sw': {'type': 'number', 'description': 'Screen width for platform targeting'}, 'ua': {'type': 'string', 'description': 'User agent string for platform targeting'}, 'pid': {'type': 'number', 'description': 'Page ID for unique delivery/roadblocks (random number, same for all zones on page)'}, 'spr': {'type': 'number', 'description': 'Screen pixel ratio for platform targeting'}, 'size': {'type': 'string', 'description': 'Expected ad size (e.g. "300x250")'}, 'type': {'enum': ['json', 'jsonr'], 'type': 'string', 'description': 'Response type: "json" for most eligible ad, "jsonr" for all eligible ads ranked'}, 'place': {'type': 'number', 'description': 'Place counter for unique delivery (0, 1, 2, etc.)'}, 'setID': {'type': 'number', 'description': 'Zone ID to serve an ad from'}, 'referrer': {'type': 'string', 'description': 'Page URL for URL targeting (required for server-side requests)'}, '_abdk_json': {'type': 'object', 'description': 'Data key key-value pairs for data key targeting', 'additionalProperties': {}}, 'defer_signing': {'type': 'boolean', 'description': 'Defer beacon signing hash generation'}}, 'additionalProperties': False}
setup_api_key
Configure AdButler with an existing API key. Use this if the user already has an AdButler account and API key. Note: this configures the key for the current session only. For a persistent connection, the user should instead put the key in their MCP connection settings (an "Authorization: Bearer" header, or "?api_key=" appended to the server URL) â prefer suggesting that before asking the user to share their key in chat.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['api_key'], 'properties': {'api_key': {'type': 'string', 'description': 'The AdButler API key'}}, 'additionalProperties': False}
sync_kogan_stats
Push externally-tracked Kogan stats (impressions, clicks, conversions, quantity sold, sales) into AdButler for a set of ad items over a time window. Kogan marketplace accounts only â requires the Kogan self-serve feature; other accounts receive a feature-not-enabled error.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['data', 'meta'], 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'required': ['ad_item_id'], 'properties': {'sales': {'type': 'number', 'description': 'Sales value in the window (default 0.00)'}, 'clicks': {'type': 'number', 'description': 'Clicks in the window (default 0)'}, 'ad_item_id': {'type': ['number', 'string'], 'description': 'Numeric ad item ID, or a Value Catcher composite ID "seller_id,sku,wallet_id,zone_id" (e.g. "KoganSeller,OVMIASDBDWA,3,104446)"'}, 'conversions': {'type': 'number', 'description': 'Conversions in the window (default 0)'}, 'impressions': {'type': 'number', 'description': 'Impressions in the window (default 0)'}, 'quantity_sold': {'type': 'number', 'description': 'Units sold in the window (default 0)'}}, 'additionalProperties': False}, 'description': 'Per-ad-item stat rows to record'}, 'meta': {'type': 'object', 'required': ['from', 'to', 'timezone'], 'properties': {'to': {'type': 'string', 'description': 'Window end, ISO-8601'}, 'from': {'type': 'string', 'description': 'Window start, ISO-8601 (e.g. "2026-02-06T00:00:00+11:00")'}, 'timezone': {'type': 'string', 'description': 'Timezone of the window (e.g. "Australia/Melbourne")'}}, 'description': 'Time window the stat rows cover', 'additionalProperties': False}}, 'additionalProperties': False}
test_sftp_connection
Test an SFTP connection with the provided credentials
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'host': {'type': 'string', 'description': 'SFTP host'}, 'path': {'type': 'string', 'description': 'Remote path'}, 'port': {'type': 'number', 'description': 'SFTP port'}, 'password': {'type': 'string', 'description': 'SFTP password'}, 'username': {'type': 'string', 'description': 'SFTP username'}}, 'additionalProperties': False}
unarchive_advertiser
Restore an archived advertiser back to active status
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived advertiser ID'}}, 'additionalProperties': False}
unarchive_campaign
Restore an archived standard campaign back to active status
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived campaign ID'}}, 'additionalProperties': False}
unarchive_channel
Restore an archived channel back to active status
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived channel ID'}}, 'additionalProperties': False}
unarchive_contract
Unarchive a contract (restore from archive)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived contract ID'}}, 'additionalProperties': False}
unarchive_email_zone
Restore an archived email zone back to active status
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived email zone ID'}}, 'additionalProperties': False}
unarchive_publisher
Restore an archived publisher back to active status
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived publisher ID'}}, 'additionalProperties': False}
unarchive_zone
Restore an archived standard zone back to active status
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived zone ID'}}, 'additionalProperties': False}
update_advertiser
Update an existing advertiser
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Advertiser ID'}, 'name': {'type': 'string', 'description': 'Advertiser name'}, 'email': {'type': 'string', 'description': 'Contact email'}, 'metadata': {'type': 'object', 'description': 'Custom metadata key-value pairs', 'additionalProperties': {'type': 'string'}}, 'password': {'type': 'string', 'description': 'Password for advertiser portal (min 8 chars, must include upper, lower, number)'}, 'can_add_ad_items': {'type': 'boolean', 'description': 'Whether advertiser can submit advertisements for scheduling'}, 'can_change_password': {'type': 'boolean', 'description': 'Whether advertiser can change password'}}, 'additionalProperties': False}
update_audience
Update an existing audience in a user database
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['user_db_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'Audience ID'}, 'name': {'type': 'string', 'description': 'Audience name'}, 'attributes': {'type': 'object', 'description': 'Attribute targets defining the audience', 'additionalProperties': {'type': 'object', 'required': ['operator', 'operand'], 'properties': {'operand': {'type': 'string', 'description': 'Value to compare against'}, 'operator': {'type': 'string', 'description': 'Comparison operator'}}, 'additionalProperties': False}}, 'user_db_id': {'type': 'number', 'description': 'User database ID'}}, 'additionalProperties': False}
update_audio_creative
Update an existing audio creative
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Creative ID'}, 'name': {'type': 'string', 'description': 'Creative name'}, 'description': {'type': 'string', 'description': 'Creative description'}}, 'additionalProperties': False}
update_beacon_signing_key
Update an existing beacon signing key
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Beacon signing key ID'}, 'key_name': {'type': 'string', 'description': 'Beacon signing key name'}}, 'additionalProperties': False}
update_bidder
Update an existing bidder
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Bidder ID'}, 'name': {'type': 'string', 'description': 'Bidder name'}, 'status': {'enum': ['active', 'inactive'], 'type': 'string', 'description': 'Bidder status'}, 'bid_url': {'type': 'string', 'description': 'Bid endpoint URL'}}, 'additionalProperties': False}
update_campaign
Update an existing standard campaign
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Campaign ID'}, 'name': {'type': 'string', 'description': 'Campaign name'}, 'budget': {'type': 'object', 'properties': {'daily': {'type': 'number'}, 'weekly': {'type': 'number'}, 'monthly': {'type': 'number'}, 'lifetime': {'type': 'number'}}, 'description': 'Budget limits', 'additionalProperties': False}, 'contract': {'type': 'number', 'description': 'Contract ID'}, 'metadata': {'type': 'object', 'description': 'Custom metadata key-value pairs', 'additionalProperties': {'type': 'string'}}, 'advertiser': {'type': 'number', 'description': 'Advertiser ID'}, 'roadblock_tags': {'type': 'string', 'description': 'Roadblock tag'}, 'targeting_source': {'enum': ['CAMPAIGN', 'AD_ITEM'], 'type': 'string', 'description': 'Targeting level'}, 'scheduling_source': {'enum': ['CAMPAIGN', 'AD_ITEM'], 'type': 'string', 'description': 'Scheduling level'}, 'trusted_redirect_domains': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Trusted redirect domains'}}, 'additionalProperties': False}
update_campaign_assignment
Update an existing campaign assignment
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Campaign assignment ID'}, 'active': {'type': 'boolean', 'description': 'Whether assignment is active'}, 'weight': {'type': 'number', 'description': 'Relative delivery weight'}, 'keywords': {'type': 'string', 'description': 'Comma-separated keywords'}, 'schedule': {'type': 'number', 'description': 'Schedule ID'}, 'geo_target': {'type': 'number', 'description': 'Geo Target ID'}, 'list_target': {'type': 'number', 'description': 'List Target ID'}, 'data_key_target': {'type': 'number', 'description': 'Data Key Target ID'}, 'platform_target': {'type': 'number', 'description': 'Platform Target ID'}, 'keywords_match_method': {'enum': ['required', 'preferred', 'filtered'], 'type': 'string', 'description': 'Keyword matching method'}}, 'additionalProperties': False}
update_catalog_ad_item
Update an existing catalog ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Ad item ID'}, 'name': {'type': 'string', 'description': 'Ad item name'}, 'location': {'type': 'string', 'description': 'Click-through URL'}, 'metadata': {'type': 'object', 'description': 'Custom metadata key-value pairs', 'additionalProperties': {'type': 'string'}}, 'tracking_pixel': {'type': 'string', 'description': 'Third-party tracking pixel URL'}, 'tracking_pixels': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Array of tracking pixel URLs'}, 'catalog_item_identifier': {'type': 'string', 'description': 'Unique identifier for the catalog item'}}, 'additionalProperties': False}
update_catalog_zone
Update an existing catalog zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Catalog zone ID'}, 'name': {'type': 'string', 'description': 'Zone name'}, 'auction_type': {'enum': ['FIRST_PRICE', 'SECOND_PRICE'], 'type': 'string', 'description': 'Auction type'}, 'bid_floor_cpc': {'type': 'number', 'description': 'CPC bid floor'}, 'bid_floor_cpm': {'type': 'number', 'description': 'CPM bid floor'}, 'advertiser_cost_type': {'enum': ['CPM', 'CPC'], 'type': 'string', 'description': 'Billing model'}, 'click_cooldown_period': {'type': 'number', 'description': 'Click cooldown period in seconds'}, 'conversion_lookback_period': {'type': 'number', 'description': 'Conversion lookback period in seconds'}}, 'additionalProperties': False}
update_channel
Update an existing channel
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Channel ID'}, 'name': {'type': 'string', 'description': 'Channel name'}, 'priority': {'enum': ['sponsorship', 'standard', 'network', 'bulk', 'house'], 'type': 'string', 'description': 'Serving priority'}}, 'additionalProperties': False}
update_contact
Update an existing contact
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Contact ID'}, 'name': {'type': 'string', 'description': 'Contact name'}, 'email': {'type': 'string', 'description': 'Contact email address'}, 'notes': {'type': 'string', 'description': 'Additional notes'}}, 'additionalProperties': False}
update_contract
Update an existing contract
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Contract ID'}, 'name': {'type': 'string', 'description': 'Contract name'}, 'rate': {'type': 'number', 'description': 'Contract rate'}, 'end_at': {'type': 'string', 'description': 'Contract end date (YYYY-MM-DD)'}, 'status': {'enum': ['open', 'terminated', 'fulfilled', 'closed'], 'type': 'string', 'description': 'Contract status'}, 'start_at': {'type': 'string', 'description': 'Contract start date (YYYY-MM-DD)'}, 'advertiser': {'type': 'number', 'description': 'Advertiser ID'}, 'description': {'type': 'string', 'description': 'Contract description'}, 'payment_due_date': {'type': 'string', 'description': 'Payment due date (YYYY-MM-DD)'}}, 'additionalProperties': False}
update_contract_document
Update an existing contract document
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'Document ID'}, 'name': {'type': 'string', 'description': 'Document name'}, 'contract_id': {'type': 'number', 'description': 'Contract ID'}}, 'additionalProperties': False}
update_contract_template
Update an existing contract template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Contract template ID'}, 'name': {'type': 'string', 'description': 'Template name'}}, 'additionalProperties': False}
update_creative
Update an existing image creative
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Creative ID'}, 'name': {'type': 'string', 'description': 'Creative name'}, 'description': {'type': 'string', 'description': 'Creative description'}}, 'additionalProperties': False}
update_custom_html_ad_item
Update an existing custom HTML ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Ad item ID'}, 'name': {'type': 'string', 'description': 'Ad item name'}, 'width': {'type': 'number', 'description': 'Ad width in pixels'}, 'height': {'type': 'number', 'description': 'Ad height in pixels'}, 'location': {'type': 'string', 'description': 'Click-through URL'}, 'metadata': {'type': 'object', 'description': 'Custom metadata key-value pairs', 'additionalProperties': {'type': 'string'}}, 'custom_html': {'type': 'string', 'description': 'The HTML content'}, 'tracking_pixel': {'type': 'string', 'description': 'Third-party tracking pixel URL'}, 'tracking_pixels': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Array of tracking pixel URLs'}, 'html_content_below': {'type': 'string', 'description': 'HTML content below the ad item'}, 'trusted_redirect_domains': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Trusted redirect domains'}, 'expand_vertical_direction': {'enum': ['none', 'up', 'down'], 'type': 'string', 'description': 'Vertical expand direction'}, 'expand_horizontal_direction': {'enum': ['none', 'left', 'right'], 'type': 'string', 'description': 'Horizontal expand direction'}}, 'additionalProperties': False}
update_custom_report
Update an existing report configuration
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Report configuration ID'}, 'date': {'type': 'object', 'properties': {'end': {'type': 'string'}, 'start': {'type': 'string'}, 'preset': {'type': 'string'}, 'timezone': {'type': 'string'}}, 'description': 'Date configuration', 'additionalProperties': False}, 'name': {'type': 'string', 'description': 'Report name'}, 'type': {'enum': ['overview', 'advertiser', 'publisher', 'zone', 'campaign', 'channel', 'geo-target', 'ad-item'], 'type': 'string', 'description': 'Report type'}, 'period': {'enum': ['day', 'week', 'month', 'year'], 'type': 'string', 'description': 'Data grouping period'}, 'columns': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Columns to include'}, 'filters': {'type': 'object', 'description': 'Filter criteria', 'additionalProperties': {}}, 'exclude_channel_stats': {'type': 'boolean', 'description': 'Exclude stats from channel-served ads'}, 'require_channel_stats': {'type': 'boolean', 'description': 'Only include stats from channel-served ads'}, 'exclude_campaign_ad_items': {'type': 'boolean', 'description': 'Exclude ad items in campaigns'}, 'exclude_publisher_ad_items': {'type': 'boolean', 'description': 'Exclude ad items directly in zones'}}, 'additionalProperties': False}
update_data_key
Update an existing data key
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Data key ID'}, 'name': {'type': 'string', 'description': 'Data key name'}, 'type': {'enum': ['STRING', 'NUMBER', 'DATE', 'DATETIME', 'TIME'], 'type': 'string', 'description': 'Data key value type'}}, 'additionalProperties': False}
update_data_key_target
Update an existing data key target
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Data key target ID'}, 'name': {'type': 'string', 'description': 'Data key target name'}, 'target': {'type': 'string', 'description': 'JSON formatted target logic'}}, 'additionalProperties': False}
update_data_list
Update an existing data list
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Data list ID'}, 'label': {'type': 'string', 'description': 'Data list label/name'}}, 'additionalProperties': False}
update_day_parting
Update an existing day parting rule
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Day parting ID'}, 'name': {'type': 'string', 'description': 'Day parting name'}, 'ranges': {'type': 'object', 'description': 'Object mapping day names (monday-sunday) to arrays of time ranges', 'additionalProperties': {'type': 'array', 'items': {'type': 'string'}}}, 'is_template': {'type': 'boolean', 'description': 'If true, shown in UI when creating/editing schedules'}, 'use_member_timezone': {'type': 'boolean', 'description': 'If true, use account timezone; if false, use viewer timezone'}}, 'additionalProperties': False}
update_demand_endpoint
Update an existing demand endpoint
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Demand endpoint ID'}, 'name': {'type': 'string', 'description': 'Demand endpoint name'}, 'status': {'enum': ['active', 'inactive'], 'type': 'string', 'description': 'Whether to send bid requests'}, 'priority': {'enum': ['sponsorship', 'standard', 'network', 'bulk', 'house'], 'type': 'string', 'description': 'Serving priority'}, 'bid_floor': {'type': 'number', 'description': 'Default CPM bid floor'}, 'geo_target': {'type': 'number', 'description': 'Geo target ID'}, 'filter_type': {'enum': ['all', 'whitelist', 'blacklist'], 'type': 'string', 'description': 'Zone filtering type'}, 'allowed_sizes': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Allowed zone sizes'}, 'demand_source': {'type': 'number', 'description': 'Demand Source ID'}, 'revenue_share': {'type': 'number', 'description': 'Revenue share percentage'}, 'filtered_zones': {'type': 'array', 'items': {'type': 'number'}, 'description': 'Zone IDs for filter list'}, 'markup_percent': {'type': 'number', 'description': 'Markup percent'}, 'supported_formats': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Supported ad formats'}, 'default_parameters': {'type': 'object', 'description': 'Default parameters', 'additionalProperties': {}}, 'filtered_vast_zones': {'type': 'array', 'items': {'type': 'number'}, 'description': 'VAST zone IDs for filter list'}, 'native_json_encoded': {'type': 'boolean', 'description': 'Whether native JSON should be encoded'}}, 'additionalProperties': False}
update_demand_source
Update an existing demand source
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Demand source ID'}, 'name': {'type': 'string', 'description': 'Demand source name'}, 'status': {'enum': ['active', 'inactive'], 'type': 'string', 'description': 'Whether to send bid requests'}, 'spend_limit': {'type': 'number', 'description': 'Spend limit amount'}, 'spend_limit_end': {'type': 'string', 'description': 'Spend limit end date (ISO-8601)'}, 'spend_limit_start': {'type': 'string', 'description': 'Spend limit start date (ISO-8601)'}, 'spend_limit_period': {'enum': ['once', 'weekly', 'biweekly', 'monthly', 'quarterly'], 'type': 'string', 'description': 'Spend limit reset interval'}}, 'additionalProperties': False}
update_email_zone
Update an existing email zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Email zone ID'}, 'name': {'type': 'string', 'description': 'Zone name'}, 'width': {'type': 'number', 'description': 'Zone width in pixels'}, 'height': {'type': 'number', 'description': 'Zone height in pixels'}, 'metadata': {'type': 'object', 'description': 'Custom metadata key-value pairs', 'additionalProperties': {'type': 'string'}}, 'publisher': {'type': 'number', 'description': 'Publisher ID'}, 'uid_rotate': {'type': 'boolean', 'description': 'Serve different ads per user'}, 'rotate_timer': {'type': 'object', 'required': ['amount', 'interval'], 'properties': {'amount': {'type': 'number', 'description': 'Period amount'}, 'interval': {'enum': ['minutes', 'days'], 'type': 'string', 'description': 'Period interval'}}, 'description': 'Period after which user sees a new ad', 'additionalProperties': False}, 'auction_tie_break': {'enum': ['RANDOM', 'SCORE'], 'type': 'string', 'description': 'Tie-breaking method'}}, 'additionalProperties': False}
update_event_log_upload_config
Update an existing event log upload configuration
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Upload configuration ID'}, 'name': {'type': 'string', 'description': 'Configuration name'}, 'format': {'type': 'string', 'description': 'Log file format'}, 'enabled': {'type': 'boolean', 'description': 'Whether the upload configuration is enabled'}, 'frequency': {'type': 'string', 'description': 'Upload frequency (e.g. "daily", "hourly")'}, 'connection_id': {'type': 'number', 'description': 'SFTP connection ID to use for upload'}}, 'additionalProperties': False}
update_geo_target
Update an existing geo target
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Geo target ID'}, 'name': {'type': 'string', 'description': 'Geo target name'}, 'unit': {'enum': ['miles', 'kilometers'], 'type': 'string', 'description': 'Distance unit'}, 'areas': {'type': 'array', 'items': {'type': 'object', 'properties': {'city': {'type': 'string', 'description': 'City name'}, 'region': {'type': 'string', 'description': 'Region/state'}, 'country': {'type': 'string', 'description': 'Two-letter country code'}, 'continent': {'type': 'string', 'description': 'Continent name'}}, 'additionalProperties': False}, 'description': 'Array of geographic areas'}, 'range': {'type': 'number', 'description': 'Radius range'}, 'inclusive': {'type': 'boolean', 'description': 'If true, target users IN these areas; if false, EXCLUDE'}}, 'additionalProperties': False}
update_image_ad_item
Update an existing image ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Ad item ID'}, 'name': {'type': 'string', 'description': 'Ad item name'}, 'width': {'type': 'number', 'description': 'Ad width in pixels'}, 'height': {'type': 'number', 'description': 'Ad height in pixels'}, 'creative': {'type': 'number', 'description': 'Image creative ID'}, 'location': {'type': 'string', 'description': 'Click-through URL'}, 'metadata': {'type': 'object', 'description': 'Custom metadata key-value pairs', 'additionalProperties': {'type': 'string'}}, 'html_target': {'type': 'string', 'description': 'Window/frame for destination URL'}, 'creative_url': {'type': 'string', 'description': 'URL to image file'}, 'html_alt_text': {'type': 'string', 'description': 'Alt text for the image'}, 'tracking_pixel': {'type': 'string', 'description': 'Third-party tracking pixel URL'}, 'tracking_pixels': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Array of tracking pixel URLs'}, 'html_content_below': {'type': 'string', 'description': 'HTML content below the ad item'}, 'trusted_redirect_domains': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Trusted redirect domains'}}, 'additionalProperties': False}
update_kogan_product_category
Update the category and category slug of a Kogan marketplace product. Kogan marketplace accounts only â requires the Kogan self-serve feature; other accounts receive a feature-not-enabled error.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['seller_id', 'sku', 'category', 'category_slug'], 'properties': {'sku': {'type': 'string', 'description': 'Product SKU'}, 'category': {'type': 'string', 'description': 'New category name'}, 'seller_id': {'type': 'string', 'description': 'Kogan seller ID'}, 'category_slug': {'type': 'string', 'description': 'New category slug'}}, 'additionalProperties': False}
update_list_target
Update an existing list target
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'List target ID'}, 'label': {'type': 'string', 'description': 'List target name'}, 'data_list': {'type': 'number', 'description': 'Data list ID'}, 'inclusive': {'type': 'boolean', 'description': 'If true, inclusion; if false, exclusion'}}, 'additionalProperties': False}
update_manager
Update an existing manager
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Manager ID'}, 'name': {'type': 'string', 'description': 'Manager name'}, 'email': {'type': 'string', 'description': 'Manager email address'}, 'notes': {'type': 'string', 'description': 'Notes about the manager'}, 'password': {'type': 'string', 'description': 'Login password'}, 'position': {'type': 'string', 'description': 'Manager position'}, 'is_enabled': {'type': 'boolean', 'description': 'Whether the manager account is enabled'}, 'can_manage_links': {'type': 'boolean', 'description': 'Can manage tracking links'}, 'can_manage_media': {'type': 'boolean', 'description': 'Can manage creatives and media groups'}, 'can_manage_users': {'type': 'boolean', 'description': 'Can manage users'}, 'publisher_access': {'enum': ['none', 'specific', 'all'], 'type': 'string', 'description': 'Publisher access level'}, 'statistics_access': {'enum': ['none', 'specific', 'all'], 'type': 'string', 'description': 'Statistics access level'}, 'can_manage_bidders': {'type': 'boolean', 'description': 'Can manage bidders'}, 'can_manage_billing': {'type': 'boolean', 'description': 'Can manage billing'}, 'can_manage_targets': {'type': 'boolean', 'description': 'Can manage targets'}, 'can_manage_tickets': {'type': 'boolean', 'description': 'Can manage tickets'}, 'can_manage_contracts': {'type': 'boolean', 'description': 'Can manage contracts'}, 'can_manage_data_keys': {'type': 'boolean', 'description': 'Can manage data keys'}, 'can_manage_product_db': {'type': 'boolean', 'description': 'Can manage product catalogs'}, 'can_manage_self_serve': {'type': 'boolean', 'description': 'Can manage Self-Serve'}, 'publisher_access_list': {'type': 'array', 'items': {'type': 'number'}, 'description': 'Publisher IDs for specific access'}, 'can_manage_programmatic': {'type': 'boolean', 'description': 'Can manage programmatic'}, 'can_manage_admin_api_access': {'type': 'boolean', 'description': 'Can manage API keys'}, 'can_assign_campaigns_directly': {'type': 'boolean', 'description': 'Can assign campaigns directly'}, 'can_manage_native_ad_templates': {'type': 'boolean', 'description': 'Can manage native templates'}}, 'additionalProperties': False}
update_media_group
Update an existing media group
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Media group ID'}, 'name': {'type': 'string', 'description': 'Media group name'}}, 'additionalProperties': False}
update_native_ad_item
Update an existing native ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Ad item ID'}, 'name': {'type': 'string', 'description': 'Ad item name'}, 'location': {'type': 'string', 'description': 'Click-through URL'}, 'metadata': {'type': 'object', 'description': 'Custom metadata key-value pairs', 'additionalProperties': {'type': 'string'}}, 'template': {'type': 'number', 'description': 'Native template ID'}, 'variables': {'type': 'object', 'description': 'Template variables as key-value pairs', 'additionalProperties': {'type': 'string'}}, 'tracking_pixel': {'type': 'string', 'description': 'Third-party tracking pixel URL'}, 'tracking_pixels': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Array of tracking pixel URLs'}, 'trusted_redirect_domains': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Trusted redirect domains'}}, 'additionalProperties': False}
update_native_template
Update an existing native template. Variables uses add/remove format for updates.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Native template ID'}, 'name': {'type': 'string', 'description': 'Template name'}, 'raw_html': {'type': 'string', 'description': 'HTML template content with variable placeholders'}, 'variables': {'type': 'object', 'properties': {'add': {'type': 'array', 'items': {'type': 'object', 'required': ['name', 'placeholder', 'type'], 'properties': {'name': {'type': 'string', 'description': 'Variable name'}, 'type': {'enum': ['url', 'url_raw', 'text', 'file', 'number', 'image_url', 'dropdown', 'third_party_script'], 'type': 'string', 'description': 'Variable type'}, 'optional': {'type': 'boolean'}, 'max_length': {'type': 'number'}, 'placeholder': {'type': 'string', 'description': 'Placeholder in raw_html'}, 'dropdown_values': {'type': 'string'}}, 'additionalProperties': False}, 'description': 'Variables to add'}, 'remove': {'type': 'array', 'items': {'type': 'number'}, 'description': 'Variable IDs to remove'}}, 'description': 'Variables to add/remove', 'additionalProperties': False}}, 'additionalProperties': False}
update_ortb_native_data_asset
Update an existing data asset for an ORTB native template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['template_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'Data asset ID'}, 'len': {'type': 'number', 'description': 'Max length'}, 'type': {'type': 'number', 'description': 'Data asset type'}, 'template_id': {'type': 'number', 'description': 'ORTB native template ID'}}, 'additionalProperties': False}
update_ortb_native_image_asset
Update an existing image asset for an ORTB native template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['template_id', 'id'], 'properties': {'h': {'type': 'number', 'description': 'Height'}, 'w': {'type': 'number', 'description': 'Width'}, 'id': {'type': 'number', 'description': 'Image asset ID'}, 'hmin': {'type': 'number', 'description': 'Min height'}, 'type': {'type': 'number', 'description': 'Image asset type'}, 'wmin': {'type': 'number', 'description': 'Min width'}, 'template_id': {'type': 'number', 'description': 'ORTB native template ID'}}, 'additionalProperties': False}
update_ortb_native_template
Update an existing OpenRTB native template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'ORTB native template ID'}, 'name': {'type': 'string', 'description': 'ORTB native template name'}, 'html_template': {'type': 'string', 'description': 'HTML template for rendering the native ad'}}, 'additionalProperties': False}
update_ortb_native_title_asset
Update an existing title asset for an ORTB native template
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['template_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'Title asset ID'}, 'len': {'type': 'number', 'description': 'Max length of title'}, 'template_id': {'type': 'number', 'description': 'ORTB native template ID'}}, 'additionalProperties': False}
update_placement
Update an existing placement
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Placement ID'}, 'cost': {'type': 'object', 'properties': {'cpa': {'type': 'number'}, 'cpc': {'type': 'number'}, 'cpm': {'type': 'number'}, 'fixed_cost': {'type': 'number'}}, 'description': 'Pricing model', 'additionalProperties': False}, 'zone': {'type': 'object', 'required': ['id', 'type'], 'properties': {'id': {'type': 'number', 'description': 'Zone ID'}, 'type': {'enum': ['standard_zone', 'text_zone', 'email_zone'], 'type': 'string', 'description': 'Zone type'}}, 'description': 'Zone object (mutually exclusive with channel)', 'additionalProperties': False}, 'active': {'type': 'boolean', 'description': 'Whether placement is active'}, 'payout': {'type': 'object', 'properties': {'cpa': {'type': 'number'}, 'cpc': {'type': 'number'}, 'cpm': {'type': 'number'}, 'type': {'enum': ['rate', 'percent'], 'type': 'string'}, 'fixed': {'type': 'number'}}, 'description': 'Publisher payout configuration', 'additionalProperties': False}, 'weight': {'type': 'number', 'description': 'Relative delivery weight'}, 'channel': {'type': 'number', 'description': 'Channel ID (mutually exclusive with zone)'}, 'keywords': {'type': 'string', 'description': 'Comma-separated keywords'}, 'priority': {'enum': ['sponsorship', 'standard', 'network', 'bulk', 'house'], 'type': 'string', 'description': 'Serving priority level'}, 'schedule': {'type': 'number', 'description': 'Schedule ID'}, 'geo_target': {'type': 'number', 'description': 'Geotarget ID'}, 'list_target': {'type': 'number', 'description': 'List Target ID'}, 'serve_method': {'enum': ['weight', 'auction'], 'type': 'string', 'description': 'Serving system'}, 'advertisement': {'type': 'object', 'required': ['id', 'type'], 'properties': {'id': {'type': 'number', 'description': 'Ad item or campaign ID'}, 'type': {'type': 'string', 'description': 'Type: "image_ad_item", "custom_html_ad_item", "rich_media_ad_item", "native_ad_item", "standard_campaign"'}}, 'description': 'Advertisement object with id and type', 'additionalProperties': False}, 'share_of_voice': {'type': 'number', 'description': 'Share of voice percentage'}, 'platform_target': {'type': 'number', 'description': 'Platform target ID'}, 'data_key_target_id': {'type': 'number', 'description': 'Data Key Target ID'}, 'contextual_segments': {'type': 'array', 'items': {'type': 'number'}, 'description': 'Array of contextual segment IDs'}, 'keywords_match_method': {'enum': ['required', 'preferred', 'filtered'], 'type': 'string', 'description': 'Keyword matching method'}}, 'additionalProperties': False}
update_platform_target
Update an existing platform target
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Platform target ID'}, 'name': {'type': 'string', 'description': 'Platform target name'}, 'platform': {'enum': ['any', 'specific', 'mobile', 'tablet', 'mobile_and_tablet', 'desktop'], 'type': 'string', 'description': 'Preset platform target'}, 'device_targets': {'type': 'array', 'items': {'type': 'string'}, 'description': 'List of device patterns to target'}}, 'additionalProperties': False}
update_pmp_deal
Update an existing PMP deal
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'PMP deal ID'}, 'name': {'type': 'string', 'description': 'PMP deal name'}, 'bid_floor': {'type': 'number', 'description': 'Bid floor'}, 'geo_target': {'type': 'number', 'description': 'Geo target ID'}, 'audience_target': {'type': 'number', 'description': 'Audience target ID'}, 'whitelist_seats': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Seat IDs with access'}}, 'additionalProperties': False}
update_postal_code_target
Update an existing postal code target
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Postal code target ID'}, 'label': {'type': 'string', 'description': 'Postal code target name'}, 'inclusive': {'type': 'boolean', 'description': 'If true, inclusion target; if false, exclusion target'}, 'locations': {'type': 'array', 'items': {'type': 'object', 'required': ['country', 'postal_codes'], 'properties': {'country': {'type': 'string', 'description': 'Two-letter country code'}, 'postal_codes': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Array of postal codes'}}, 'additionalProperties': False}, 'description': 'Array of locations grouped by country'}}, 'additionalProperties': False}
update_product_catalog
Update an existing product catalog
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['publisher_id', 'catalog_id'], 'properties': {'name': {'type': 'string', 'description': 'Catalog name'}, 'catalog_id': {'type': 'number', 'description': 'Catalog ID'}, 'publisher_id': {'type': 'number', 'description': 'Publisher ID'}}, 'additionalProperties': False}
update_product_catalog_item
Update an existing product catalog item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['publisher_id', 'catalog_id', 'identifier'], 'properties': {'url': {'type': 'string', 'description': 'Item URL'}, 'name': {'type': 'string', 'description': 'Item name'}, 'price': {'type': 'string', 'description': 'Item price'}, 'category': {'type': 'string', 'description': 'Item category'}, 'image_url': {'type': 'string', 'description': 'Item image URL'}, 'catalog_id': {'type': 'number', 'description': 'Catalog ID'}, 'identifier': {'type': 'string', 'description': 'Unique identifier for the catalog item'}, 'description': {'type': 'string', 'description': 'Item description'}, 'publisher_id': {'type': 'number', 'description': 'Publisher ID'}}, 'additionalProperties': False}
update_product_source
Update an existing product source
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['publisher_id', 'source_id'], 'properties': {'url': {'type': 'string', 'description': 'Source URL'}, 'name': {'type': 'string', 'description': 'Source name'}, 'type': {'type': 'string', 'description': 'Source type'}, 'source_id': {'type': 'number', 'description': 'Source ID'}, 'publisher_id': {'type': 'number', 'description': 'Publisher ID'}}, 'additionalProperties': False}
update_product_source_target
Update an existing product source target
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['publisher_id', 'source_target_id'], 'properties': {'name': {'type': 'string', 'description': 'Source target name'}, 'source_id': {'type': 'number', 'description': 'Source ID to target'}, 'publisher_id': {'type': 'number', 'description': 'Publisher ID'}, 'source_target_id': {'type': 'number', 'description': 'Source target ID'}}, 'additionalProperties': False}
update_publisher
Update an existing publisher
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Publisher ID'}, 'name': {'type': 'string', 'description': 'Publisher name'}, 'email': {'type': 'string', 'description': 'Contact email'}, 'domain': {'type': 'string', 'description': 'Publisher domain'}, 'metadata': {'type': 'object', 'description': 'Custom metadata key-value pairs', 'additionalProperties': {'type': 'string'}}, 'timezone': {'type': 'string', 'description': 'Timezone'}, 'seller_type': {'enum': ['publisher', 'intermediary', 'both'], 'type': 'string', 'description': 'Seller type'}, 'default_payout': {'type': 'object', 'properties': {'cpa': {'type': 'number'}, 'cpc': {'type': 'number'}, 'cpm': {'type': 'number'}, 'type': {'enum': ['rate', 'percent'], 'type': 'string'}, 'fixed': {'type': 'number'}}, 'description': 'Default payout configuration', 'additionalProperties': False}, 'can_approve_ads': {'type': 'boolean', 'description': 'Allow publisher to approve/deny ad items'}, 'can_admin_account': {'type': 'boolean', 'description': 'Grant administrator privileges'}, 'can_change_password': {'type': 'boolean', 'description': 'Whether publisher can change password'}, 'can_view_wordpress_key': {'type': 'boolean', 'description': 'Allow publisher to view WordPress key'}}, 'additionalProperties': False}
update_report_schedule
Update a report schedule
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['report_config_id', 'schedule_id'], 'properties': {'frequency': {'type': 'string', 'description': 'Schedule frequency'}, 'recipients': {'type': 'array', 'items': {}, 'description': 'Array of recipient objects'}, 'schedule_id': {'type': 'number', 'description': 'Schedule ID'}, 'report_config_id': {'type': 'number', 'description': 'Report configuration ID'}}, 'additionalProperties': False}
update_rich_media_ad_item
Update an existing rich media ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Ad item ID'}, 'name': {'type': 'string', 'description': 'Ad item name'}, 'creative': {'type': 'number', 'description': 'Rich media creative ID'}, 'location': {'type': 'string', 'description': 'Click-through URL'}, 'metadata': {'type': 'object', 'description': 'Custom metadata key-value pairs', 'additionalProperties': {'type': 'string'}}, 'tracking_pixel': {'type': 'string', 'description': 'Third-party tracking pixel URL'}, 'tracking_pixels': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Array of tracking pixel URLs'}, 'html_content_below': {'type': 'string', 'description': 'HTML content below the ad item'}, 'trusted_redirect_domains': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Trusted redirect domains'}, 'expand_vertical_direction': {'enum': ['none', 'up', 'down'], 'type': 'string', 'description': 'Vertical expand direction'}, 'expand_horizontal_direction': {'enum': ['none', 'left', 'right'], 'type': 'string', 'description': 'Horizontal expand direction'}}, 'additionalProperties': False}
update_rich_media_creative
Update an existing rich media creative
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Creative ID'}, 'name': {'type': 'string', 'description': 'Creative name'}, 'description': {'type': 'string', 'description': 'Creative description'}}, 'additionalProperties': False}
update_role
Update an existing role
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Role ID'}, 'name': {'type': 'string', 'description': 'Role name'}, 'is_default_role': {'type': 'boolean', 'description': 'Auto-assign to new users'}, 'can_manage_links': {'type': 'boolean', 'description': 'Can manage tracking links'}, 'can_manage_media': {'type': 'boolean', 'description': 'Can manage creatives'}, 'can_manage_users': {'type': 'boolean', 'description': 'Can manage users'}, 'publisher_access': {'enum': ['none', 'specific', 'all'], 'type': 'string', 'description': 'Publisher access level'}, 'statistics_access': {'enum': ['none', 'specific', 'all'], 'type': 'string', 'description': 'Statistics access level'}, 'can_manage_bidders': {'type': 'boolean', 'description': 'Can manage bidders'}, 'can_manage_billing': {'type': 'boolean', 'description': 'Can manage billing'}, 'can_manage_targets': {'type': 'boolean', 'description': 'Can manage targets'}, 'can_manage_tickets': {'type': 'boolean', 'description': 'Can manage tickets'}, 'can_manage_contracts': {'type': 'boolean', 'description': 'Can manage contracts'}, 'can_manage_data_keys': {'type': 'boolean', 'description': 'Can manage data keys'}, 'can_manage_product_db': {'type': 'boolean', 'description': 'Can manage product catalogs'}, 'can_manage_self_serve': {'type': 'boolean', 'description': 'Can manage Self-Serve'}, 'publisher_access_list': {'type': 'array', 'items': {'type': 'number'}, 'description': 'Publisher IDs for specific access'}, 'can_manage_programmatic': {'type': 'boolean', 'description': 'Can manage programmatic'}, 'can_manage_admin_api_access': {'type': 'boolean', 'description': 'Can manage API keys'}, 'can_assign_campaigns_directly': {'type': 'boolean', 'description': 'Can assign campaigns directly'}, 'can_manage_native_ad_templates': {'type': 'boolean', 'description': 'Can manage native templates'}}, 'additionalProperties': False}
update_schedule
Update an existing schedule
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Schedule ID'}, 'end_at': {'type': 'string', 'description': 'End date/time in ISO-8601 format'}, 'end_date': {'type': 'string', 'description': 'End date (YYYY-MM-DD HH:MM:SS) â\x80\x94 deprecated, use end_at'}, 'start_at': {'type': 'string', 'description': 'Start date/time in ISO-8601 format'}, 'quota_type': {'enum': ['views', 'clicks'], 'type': 'string', 'description': 'Quota measurement type'}, 'start_date': {'type': 'string', 'description': 'Start date (YYYY-MM-DD HH:MM:SS) â\x80\x94 deprecated, use start_at'}, 'day_cap_type': {'enum': ['views', 'clicks'], 'type': 'string', 'description': 'Daily cap type'}, 'day_cap_limit': {'type': 'number', 'description': 'Daily cap limit'}, 'day_parting_id': {'type': 'number', 'description': 'Day parting ID for time-of-day targeting'}, 'quota_lifetime': {'type': 'number', 'description': 'Total quota amount (views or clicks, not per thousand)'}, 'delivery_method': {'enum': ['default', 'smooth'], 'type': 'string', 'description': 'Delivery pacing: "default" (ASAP) or "smooth" (evenly distributed)'}, 'end_at_timezone': {'type': 'string', 'description': 'IANA timezone for end_at'}, 'start_at_timezone': {'type': 'string', 'description': 'IANA timezone for start_at'}, 'per_user_view_limit': {'type': 'number', 'description': 'Per-user view frequency cap'}, 'per_user_view_period': {'type': 'number', 'description': 'Days before per-user view counter resets'}, 'under_delivery_behaviour': {'enum': ['endOnQuota', 'endOnDate'], 'type': 'string', 'description': 'Whether to keep serving until quota met or stop on end date'}}, 'additionalProperties': False}
update_sftp_connection
Update an existing SFTP connection
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'SFTP connection ID'}, 'host': {'type': 'string', 'description': 'SFTP host'}, 'name': {'type': 'string', 'description': 'Connection name'}, 'path': {'type': 'string', 'description': 'Remote path'}, 'port': {'type': 'number', 'description': 'SFTP port'}, 'password': {'type': 'string', 'description': 'SFTP password'}, 'username': {'type': 'string', 'description': 'SFTP username'}}, 'additionalProperties': False}
update_signature_request
Update an existing signature request
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'Signature request ID'}, 'contract_id': {'type': 'number', 'description': 'Contract ID'}}, 'additionalProperties': False}
update_signature_request_recipient
Update a recipient for a signature request
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['contract_id', 'request_id', 'recipient_id'], 'properties': {'name': {'type': 'string', 'description': 'Recipient name'}, 'email': {'type': 'string', 'description': 'Recipient email'}, 'request_id': {'type': 'number', 'description': 'Signature request ID'}, 'contract_id': {'type': 'number', 'description': 'Contract ID'}, 'recipient_id': {'type': 'number', 'description': 'Recipient ID'}}, 'additionalProperties': False}
update_trusted_redirect_domain
Update an existing trusted redirect domain
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Trusted redirect domain ID'}, 'domain': {'type': 'string', 'description': 'Trusted redirect domain (e.g. example.com)'}}, 'additionalProperties': False}
update_user_attribute
Update an existing user attribute in a user database
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['user_db_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'User attribute ID'}, 'type': {'enum': ['number', 'phone_number', 'email', 'text', 'date_time', 'timestamp'], 'type': 'string', 'description': 'Data type of the field'}, 'label': {'type': 'string', 'description': 'Descriptive label for the field'}, 'user_db_id': {'type': 'number', 'description': 'User database ID'}}, 'additionalProperties': False}
update_video_creative
Update an existing video creative
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Creative ID'}, 'name': {'type': 'string', 'description': 'Creative name'}, 'description': {'type': 'string', 'description': 'Creative description'}}, 'additionalProperties': False}
update_zone
Update an existing standard zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Zone ID'}, 'name': {'type': 'string', 'description': 'Zone name'}, 'width': {'type': 'number', 'description': 'Zone width in pixels'}, 'height': {'type': 'number', 'description': 'Zone height in pixels'}, 'metadata': {'type': 'object', 'description': 'Custom metadata key-value pairs', 'additionalProperties': {'type': 'string'}}, 'bid_floor': {'type': 'number', 'description': 'Default bid floor'}, 'pmp_deals': {'type': 'array', 'items': {'type': 'number'}, 'description': 'Allowed PMP Deal IDs'}, 'publisher': {'type': 'number', 'description': 'Publisher ID'}, 'dimensions': {'enum': ['fixed', 'dynamic'], 'type': 'string', 'description': 'Zone dimensions type'}, 'min_payout': {'type': 'number', 'description': 'Minimum payout per impression (CPM)'}, 'responsive': {'enum': ['fixed', 'auto', 'inherit'], 'type': 'string', 'description': 'Size behavior'}, 'burn_in_hours': {'type': 'number', 'description': 'Hours before eCPM confidence'}, 'refresh_limit': {'type': 'number', 'description': 'Total times zone will refresh'}, 'ad_size_filter': {'type': 'object', 'properties': {'type': {'enum': ['INCLUSIVE', 'EXCLUSIVE'], 'type': 'string'}, 'sizes': {'type': 'array', 'items': {'type': 'object', 'required': ['width', 'height'], 'properties': {'width': {'type': 'number'}, 'height': {'type': 'number'}}, 'additionalProperties': False}}}, 'description': 'Ad size filter (dynamic zones only)', 'additionalProperties': False}, 'api_frameworks': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Supported API frameworks'}, 'iab_categories': {'type': 'array', 'items': {'type': 'string'}, 'description': 'IAB category descriptors'}, 'private_auction': {'type': 'boolean', 'description': 'Ignore non-deal bids in auction'}, 'unique_delivery': {'type': 'boolean', 'description': 'Serve unique ads on each zone'}, 'rtb_placement_id': {'type': 'string', 'description': 'OpenRTB tagid identifier'}, 'auction_tie_break': {'enum': ['RANDOM', 'SCORE'], 'type': 'string', 'description': 'Tie-breaking method'}, 'refresh_frequency': {'type': 'number', 'description': 'Interval in seconds for serving new ads'}, 'burn_in_impressions': {'type': 'number', 'description': 'Impressions before eCPM confidence'}, 'allow_demand_sources': {'type': 'boolean', 'description': 'Allow requests to demand endpoints'}, 'serve_priority_order': {'enum': ['weight', 'auction'], 'type': 'string', 'description': 'Priority order'}, 'optimization_strategy': {'type': 'string', 'description': 'Zone optimization strategy'}, 'ecpm_testing_allowance': {'type': 'number', 'description': 'Percentage for eCPM recalculation'}, 'allowed_root_native_templates': {'type': 'array', 'items': {'type': 'number'}, 'description': 'Allowed root native template IDs'}}, 'additionalProperties': False}
update_zone_ortb_native_ad
Update an existing ORTB native ad for a standard zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['zone_id', 'id'], 'properties': {'id': {'type': 'number', 'description': 'ORTB native ad ID'}, 'name': {'type': 'string', 'description': 'ORTB native ad name'}, 'zone_id': {'type': 'number', 'description': 'Standard zone ID'}, 'template_id': {'type': 'number', 'description': 'ORTB native template ID'}}, 'additionalProperties': False}
validate_beacon_signing_key
Validate a beacon signing key
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'key': {'type': 'string', 'description': 'Beacon signing key to validate'}}, 'additionalProperties': False}
vast42_create_ad
Create a VAST 4.2 ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'name': {'type': 'string', 'description': 'Ad item name'}, 'active': {'type': 'boolean', 'description': 'Whether ad item is active'}, 'location': {'type': 'string', 'description': 'VAST tag URL or media location'}}, 'additionalProperties': False}
vast42_create_campaign_assignment
Create a VAST 4.2 campaign assignment
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'active': {'type': 'boolean', 'description': 'Whether assignment is active'}, 'ad_item': {'type': 'number', 'description': 'VAST ad item ID'}, 'campaign': {'type': 'number', 'description': 'VAST campaign ID'}}, 'additionalProperties': False}
vast42_create_closed_caption_file
Create a VAST 4.2 closed caption file
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'name': {'type': 'string', 'description': 'Closed caption file name'}, 'language': {'type': 'string', 'description': 'Language code'}}, 'additionalProperties': False}
vast42_create_companion
Create a VAST 4.2 companion
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'name': {'type': 'string', 'description': 'Companion name'}, 'width': {'type': 'number', 'description': 'Companion width in pixels'}, 'height': {'type': 'number', 'description': 'Companion height in pixels'}}, 'additionalProperties': False}
vast42_create_creative
Create a VAST 4.2 creative
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'name': {'type': 'string', 'description': 'Creative name'}, 'description': {'type': 'string', 'description': 'Creative description'}}, 'additionalProperties': False}
vast42_create_icon
Create a VAST 4.2 icon
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'name': {'type': 'string', 'description': 'Icon name'}, 'width': {'type': 'number', 'description': 'Icon width in pixels'}, 'height': {'type': 'number', 'description': 'Icon height in pixels'}}, 'additionalProperties': False}
vast42_create_icon_click_fallback_image
Create a VAST 4.2 icon click fallback image
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'name': {'type': 'string', 'description': 'Icon click fallback image name'}, 'width': {'type': 'number', 'description': 'Width in pixels'}, 'height': {'type': 'number', 'description': 'Height in pixels'}}, 'additionalProperties': False}
vast42_create_interactive_creative_file
Create a VAST 4.2 interactive creative file
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'name': {'type': 'string', 'description': 'Interactive creative file name'}, 'mime_type': {'type': 'string', 'description': 'MIME type'}}, 'additionalProperties': False}
vast42_create_linear
Create a VAST 4.2 linear media
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'name': {'type': 'string', 'description': 'Linear media name'}, 'bitrate': {'type': 'number', 'description': 'Bitrate in kbps'}, 'duration': {'type': 'number', 'description': 'Duration in seconds'}, 'mime_type': {'type': 'string', 'description': 'MIME type (e.g. video/mp4)'}}, 'additionalProperties': False}
vast42_create_media_file
Create a VAST 4.2 media file
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'name': {'type': 'string', 'description': 'Media file name'}, 'width': {'type': 'number', 'description': 'Width in pixels'}, 'height': {'type': 'number', 'description': 'Height in pixels'}, 'bitrate': {'type': 'number', 'description': 'Bitrate in kbps'}, 'mime_type': {'type': 'string', 'description': 'MIME type'}}, 'additionalProperties': False}
vast42_create_mezzanine
Create a VAST 4.2 mezzanine
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'name': {'type': 'string', 'description': 'Mezzanine name'}, 'mime_type': {'type': 'string', 'description': 'MIME type'}}, 'additionalProperties': False}
vast42_create_non_linear
Create a VAST 4.2 non-linear media
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'name': {'type': 'string', 'description': 'Non-linear media name'}, 'width': {'type': 'number', 'description': 'Width in pixels'}, 'height': {'type': 'number', 'description': 'Height in pixels'}, 'mime_type': {'type': 'string', 'description': 'MIME type'}}, 'additionalProperties': False}
vast42_create_placement
Create a VAST 4.2 placement
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['advertisement'], 'properties': {'zone': {'type': 'number', 'description': 'VAST zone ID'}, 'active': {'type': 'boolean', 'description': 'Whether placement is active'}, 'channel': {'type': 'number', 'description': 'VAST channel ID'}, 'priority': {'type': 'number', 'description': 'Priority level'}, 'schedule': {'type': 'number', 'description': 'Schedule ID'}, 'advertisement': {'type': 'object', 'required': ['id', 'type'], 'properties': {'id': {'type': 'number', 'description': 'VAST ad item or campaign ID'}, 'type': {'type': 'string', 'description': 'Advertisement type'}}, 'description': 'Advertisement object with id and type', 'additionalProperties': False}}, 'additionalProperties': False}
vast42_create_resource
Create a VAST 4.2 resource
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'name': {'type': 'string', 'description': 'Resource name'}, 'type': {'type': 'string', 'description': 'Resource type'}}, 'additionalProperties': False}
vast42_create_universal_ad_id
Create a VAST 4.2 universal ad ID
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'name': {'type': 'string', 'description': 'Universal ad ID name'}, 'id_value': {'type': 'string', 'description': 'ID value'}, 'id_registry': {'type': 'string', 'description': 'ID registry'}}, 'additionalProperties': False}
vast42_delete_ad
Delete a VAST 4.2 ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 ad item ID'}}, 'additionalProperties': False}
vast42_delete_campaign_assignment
Delete a VAST 4.2 campaign assignment
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 campaign assignment ID'}}, 'additionalProperties': False}
vast42_delete_closed_caption_file
Delete a VAST 4.2 closed caption file
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 closed caption file ID'}}, 'additionalProperties': False}
vast42_delete_companion
Delete a VAST 4.2 companion
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 companion ID'}}, 'additionalProperties': False}
vast42_delete_creative
Delete a VAST 4.2 creative
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 creative ID'}}, 'additionalProperties': False}
vast42_delete_icon
Delete a VAST 4.2 icon
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 icon ID'}}, 'additionalProperties': False}
vast42_delete_icon_click_fallback_image
Delete a VAST 4.2 icon click fallback image
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 icon click fallback image ID'}}, 'additionalProperties': False}
vast42_delete_interactive_creative_file
Delete a VAST 4.2 interactive creative file
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 interactive creative file ID'}}, 'additionalProperties': False}
vast42_delete_linear
Delete a VAST 4.2 linear media
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 linear media ID'}}, 'additionalProperties': False}
vast42_delete_media_file
Delete a VAST 4.2 media file
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 media file ID'}}, 'additionalProperties': False}
vast42_delete_mezzanine
Delete a VAST 4.2 mezzanine
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 mezzanine ID'}}, 'additionalProperties': False}
vast42_delete_non_linear
Delete a VAST 4.2 non-linear media
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 non-linear media ID'}}, 'additionalProperties': False}
vast42_delete_placement
Delete a VAST 4.2 placement
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 placement ID'}}, 'additionalProperties': False}
vast42_delete_resource
Delete a VAST 4.2 resource
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 resource ID'}}, 'additionalProperties': False}
vast42_delete_universal_ad_id
Delete a VAST 4.2 universal ad ID
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 universal ad ID'}}, 'additionalProperties': False}
vast42_get_ad
Get a single VAST 4.2 ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 ad item ID'}}, 'additionalProperties': False}
vast42_get_campaign_assignment
Get a single VAST 4.2 campaign assignment
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 campaign assignment ID'}}, 'additionalProperties': False}
vast42_get_closed_caption_file
Get a single VAST 4.2 closed caption file
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 closed caption file ID'}}, 'additionalProperties': False}
vast42_get_companion
Get a single VAST 4.2 companion
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 companion ID'}}, 'additionalProperties': False}
vast42_get_creative
Get a single VAST 4.2 creative
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 creative ID'}}, 'additionalProperties': False}
vast42_get_icon
Get a single VAST 4.2 icon
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 icon ID'}}, 'additionalProperties': False}
vast42_get_icon_click_fallback_image
Get a single VAST 4.2 icon click fallback image
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 icon click fallback image ID'}}, 'additionalProperties': False}
vast42_get_interactive_creative_file
Get a single VAST 4.2 interactive creative file
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 interactive creative file ID'}}, 'additionalProperties': False}
vast42_get_linear
Get a single VAST 4.2 linear media
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 linear media ID'}}, 'additionalProperties': False}
vast42_get_media_file
Get a single VAST 4.2 media file
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 media file ID'}}, 'additionalProperties': False}
vast42_get_mezzanine
Get a single VAST 4.2 mezzanine
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 mezzanine ID'}}, 'additionalProperties': False}
vast42_get_non_linear
Get a single VAST 4.2 non-linear media
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 non-linear media ID'}}, 'additionalProperties': False}
vast42_get_placement
Get a single VAST 4.2 placement
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 placement ID'}}, 'additionalProperties': False}
vast42_get_resource
Get a single VAST 4.2 resource
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 resource ID'}}, 'additionalProperties': False}
vast42_get_universal_ad_id
Get a single VAST 4.2 universal ad ID
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 universal ad ID'}}, 'additionalProperties': False}
vast42_list_ads
List all VAST 4.2 ad items
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast42_list_campaign_assignments
List all VAST 4.2 campaign assignments
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast42_list_closed_caption_files
List all VAST 4.2 closed caption files
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast42_list_companions
List all VAST 4.2 companions
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast42_list_creatives
List all VAST 4.2 creatives
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast42_list_icon_click_fallback_images
List all VAST 4.2 icon click fallback images
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast42_list_icons
List all VAST 4.2 icons
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast42_list_interactive_creative_files
List all VAST 4.2 interactive creative files
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast42_list_linears
List all VAST 4.2 linear media
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast42_list_media_files
List all VAST 4.2 media files
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast42_list_mezzanines
List all VAST 4.2 mezzanines
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast42_list_non_linears
List all VAST 4.2 non-linear media
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast42_list_placements
List all VAST 4.2 placements
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast42_list_resources
List all VAST 4.2 resources
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast42_list_universal_ad_ids
List all VAST 4.2 universal ad IDs
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast42_update_ad
Update a VAST 4.2 ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 ad item ID'}, 'name': {'type': 'string', 'description': 'Ad item name'}, 'active': {'type': 'boolean', 'description': 'Whether ad item is active'}, 'location': {'type': 'string', 'description': 'VAST tag URL or media location'}}, 'additionalProperties': False}
vast42_update_campaign_assignment
Update a VAST 4.2 campaign assignment
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 campaign assignment ID'}, 'active': {'type': 'boolean', 'description': 'Whether assignment is active'}, 'ad_item': {'type': 'number', 'description': 'VAST ad item ID'}, 'campaign': {'type': 'number', 'description': 'VAST campaign ID'}}, 'additionalProperties': False}
vast42_update_closed_caption_file
Update a VAST 4.2 closed caption file
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 closed caption file ID'}, 'name': {'type': 'string', 'description': 'Closed caption file name'}, 'language': {'type': 'string', 'description': 'Language code'}}, 'additionalProperties': False}
vast42_update_companion
Update a VAST 4.2 companion
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 companion ID'}, 'name': {'type': 'string', 'description': 'Companion name'}, 'width': {'type': 'number', 'description': 'Companion width in pixels'}, 'height': {'type': 'number', 'description': 'Companion height in pixels'}}, 'additionalProperties': False}
vast42_update_creative
Update a VAST 4.2 creative
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 creative ID'}, 'name': {'type': 'string', 'description': 'Creative name'}, 'description': {'type': 'string', 'description': 'Creative description'}}, 'additionalProperties': False}
vast42_update_icon
Update a VAST 4.2 icon
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 icon ID'}, 'name': {'type': 'string', 'description': 'Icon name'}, 'width': {'type': 'number', 'description': 'Icon width in pixels'}, 'height': {'type': 'number', 'description': 'Icon height in pixels'}}, 'additionalProperties': False}
vast42_update_icon_click_fallback_image
Update a VAST 4.2 icon click fallback image
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 icon click fallback image ID'}, 'name': {'type': 'string', 'description': 'Icon click fallback image name'}, 'width': {'type': 'number', 'description': 'Width in pixels'}, 'height': {'type': 'number', 'description': 'Height in pixels'}}, 'additionalProperties': False}
vast42_update_interactive_creative_file
Update a VAST 4.2 interactive creative file
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 interactive creative file ID'}, 'name': {'type': 'string', 'description': 'Interactive creative file name'}, 'mime_type': {'type': 'string', 'description': 'MIME type'}}, 'additionalProperties': False}
vast42_update_linear
Update a VAST 4.2 linear media
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 linear media ID'}, 'name': {'type': 'string', 'description': 'Linear media name'}, 'bitrate': {'type': 'number', 'description': 'Bitrate in kbps'}, 'duration': {'type': 'number', 'description': 'Duration in seconds'}, 'mime_type': {'type': 'string', 'description': 'MIME type (e.g. video/mp4)'}}, 'additionalProperties': False}
vast42_update_media_file
Update a VAST 4.2 media file
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 media file ID'}, 'name': {'type': 'string', 'description': 'Media file name'}, 'width': {'type': 'number', 'description': 'Width in pixels'}, 'height': {'type': 'number', 'description': 'Height in pixels'}, 'bitrate': {'type': 'number', 'description': 'Bitrate in kbps'}, 'mime_type': {'type': 'string', 'description': 'MIME type'}}, 'additionalProperties': False}
vast42_update_mezzanine
Update a VAST 4.2 mezzanine
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 mezzanine ID'}, 'name': {'type': 'string', 'description': 'Mezzanine name'}, 'mime_type': {'type': 'string', 'description': 'MIME type'}}, 'additionalProperties': False}
vast42_update_non_linear
Update a VAST 4.2 non-linear media
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 non-linear media ID'}, 'name': {'type': 'string', 'description': 'Non-linear media name'}, 'width': {'type': 'number', 'description': 'Width in pixels'}, 'height': {'type': 'number', 'description': 'Height in pixels'}, 'mime_type': {'type': 'string', 'description': 'MIME type'}}, 'additionalProperties': False}
vast42_update_placement
Update a VAST 4.2 placement
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 placement ID'}, 'zone': {'type': 'number', 'description': 'VAST zone ID'}, 'active': {'type': 'boolean', 'description': 'Whether placement is active'}, 'channel': {'type': 'number', 'description': 'VAST channel ID'}, 'priority': {'type': 'number', 'description': 'Priority level'}, 'schedule': {'type': 'number', 'description': 'Schedule ID'}, 'advertisement': {'type': 'object', 'required': ['id', 'type'], 'properties': {'id': {'type': 'number', 'description': 'VAST ad item or campaign ID'}, 'type': {'type': 'string', 'description': 'Advertisement type'}}, 'description': 'Advertisement object with id and type', 'additionalProperties': False}}, 'additionalProperties': False}
vast42_update_resource
Update a VAST 4.2 resource
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 resource ID'}, 'name': {'type': 'string', 'description': 'Resource name'}, 'type': {'type': 'string', 'description': 'Resource type'}}, 'additionalProperties': False}
vast42_update_universal_ad_id
Update a VAST 4.2 universal ad ID
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST 4.2 universal ad ID'}, 'name': {'type': 'string', 'description': 'Universal ad ID name'}, 'id_value': {'type': 'string', 'description': 'ID value'}, 'id_registry': {'type': 'string', 'description': 'ID registry'}}, 'additionalProperties': False}
vast_archive_campaign
Archive a VAST campaign (soft-delete, can be restored later)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST campaign ID'}}, 'additionalProperties': False}
vast_archive_channel
Archive a VAST channel (soft-delete, can be restored later)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST channel ID'}}, 'additionalProperties': False}
vast_archive_zone
Archive a VAST zone (soft-delete, can be restored later)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST zone ID'}}, 'additionalProperties': False}
vast_create_ad_item
Create a new VAST ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name', 'location'], 'properties': {'name': {'type': 'string', 'description': 'Ad item name'}, 'active': {'type': 'boolean', 'description': 'Whether ad item is active'}, 'location': {'type': 'string', 'description': 'VAST tag URL or media location'}}, 'additionalProperties': False}
vast_create_campaign
Create a new VAST campaign
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name', 'advertiser'], 'properties': {'name': {'type': 'string', 'description': 'Campaign name'}, 'contract': {'type': 'number', 'description': 'Contract ID (requires Contract Management add-on)'}, 'advertiser': {'type': 'number', 'description': 'Advertiser ID'}}, 'additionalProperties': False}
vast_create_campaign_assignment
Create a VAST campaign assignment (assign an ad item to a campaign)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['ad_item', 'campaign'], 'properties': {'active': {'type': 'boolean', 'description': 'Whether to actively serve ads (defaults to true)'}, 'ad_item': {'type': 'number', 'description': 'VAST ad item ID'}, 'campaign': {'type': 'number', 'description': 'VAST campaign ID'}}, 'additionalProperties': False}
vast_create_channel
Create a new VAST channel
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'name': {'type': 'string', 'description': 'Channel name'}, 'description': {'type': 'string', 'description': 'Channel description'}}, 'additionalProperties': False}
vast_create_channel_zone_assignment
Assign a VAST zone to a VAST channel
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['channel', 'zone'], 'properties': {'zone': {'type': 'number', 'description': 'VAST zone ID'}, 'channel': {'type': 'number', 'description': 'VAST channel ID'}}, 'additionalProperties': False}
vast_create_companion
Create a new VAST companion
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'name': {'type': 'string', 'description': 'Companion name'}, 'width': {'type': 'number', 'description': 'Companion width in pixels'}, 'height': {'type': 'number', 'description': 'Companion height in pixels'}}, 'additionalProperties': False}
vast_create_linear_media
Create a new VAST linear media
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'name': {'type': 'string', 'description': 'Linear media name'}, 'bitrate': {'type': 'number', 'description': 'Bitrate in kbps'}, 'duration': {'type': 'number', 'description': 'Duration in seconds'}, 'mime_type': {'type': 'string', 'description': 'MIME type (e.g. video/mp4)'}}, 'additionalProperties': False}
vast_create_non_linear_media
Create a new VAST non-linear media
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'name': {'type': 'string', 'description': 'Non-linear media name'}, 'width': {'type': 'number', 'description': 'Width in pixels'}, 'height': {'type': 'number', 'description': 'Height in pixels'}, 'mime_type': {'type': 'string', 'description': 'MIME type'}}, 'additionalProperties': False}
vast_create_placement
Create a new VAST placement (assign a VAST ad item or campaign to a VAST zone or channel)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['advertisement', 'schedule'], 'properties': {'cost': {'type': 'object', 'properties': {'cpa': {'type': 'number'}, 'cpc': {'type': 'number'}, 'cpm': {'type': 'number'}, 'fixed_cost': {'type': 'number'}}, 'description': 'Pricing model: fixed_cost OR cpm/cpc/cpa', 'additionalProperties': False}, 'zone': {'type': 'number', 'description': 'VAST zone ID (required if channel not set; mutually exclusive with channel)'}, 'active': {'type': 'boolean', 'description': 'Whether placement is active (defaults to true)'}, 'payout': {'type': 'object', 'properties': {'cpa': {'type': 'number'}, 'cpc': {'type': 'number'}, 'cpm': {'type': 'number'}, 'type': {'enum': ['rate', 'percent'], 'type': 'string'}, 'fixed': {'type': 'number'}}, 'description': 'Publisher payout configuration', 'additionalProperties': False}, 'channel': {'type': 'number', 'description': 'VAST channel ID (required if zone not set; mutually exclusive with zone)'}, 'priority': {'type': 'number', 'description': 'Priority level (sponsorship, standard, network, bulk, house)'}, 'schedule': {'type': 'number', 'description': 'VAST schedule ID'}, 'serve_method': {'enum': ['weight', 'auction'], 'type': 'string', 'description': 'Serving system: weight-based or auction-based'}, 'advertisement': {'type': 'object', 'required': ['id', 'type'], 'properties': {'id': {'type': 'number', 'description': 'VAST ad item or campaign ID'}, 'type': {'enum': ['vast_ad_item', 'vast_campaign'], 'type': 'string', 'description': 'Type of advertisement'}}, 'description': 'Advertisement object with id and type', 'additionalProperties': False}, 'max_frequency': {'type': 'number', 'description': 'Frequency cap limit'}, 'data_key_target_id': {'type': 'number', 'description': 'Data Key Target ID (Enterprise only)'}, 'max_frequency_type': {'enum': ['start', 'view', 'firstQuartile', 'midpoint', 'thirdQuartile', 'complete'], 'type': 'string', 'description': 'Event type to count for frequency capping'}, 'max_frequency_period': {'type': 'number', 'description': 'Days before frequency counter resets'}}, 'additionalProperties': False}
vast_create_schedule
Create a new VAST schedule for time-based ad delivery
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'end_date': {'type': 'string', 'description': 'End date (YYYY-MM-DD HH:MM:SS), null for indefinite'}, 'geo_target': {'type': 'number', 'description': 'Geotarget ID (0 = no targeting)'}, 'quota_type': {'enum': ['views', 'clicks'], 'type': 'string', 'description': 'Quota measurement type'}, 'start_date': {'type': 'string', 'description': 'Start date (YYYY-MM-DD HH:MM:SS)'}, 'day_parting_id': {'type': 'number', 'description': 'Day parting ID for time-of-day targeting'}, 'quota_lifetime': {'type': 'number', 'description': 'Total quota amount (views or clicks, not per thousand)'}, 'delivery_method': {'enum': ['default', 'smooth'], 'type': 'string', 'description': 'Delivery pacing: "default" (ASAP) or "smooth" (evenly distributed)'}}, 'additionalProperties': False}
vast_create_tracking
Create a new VAST tracking entry
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'url': {'type': 'string', 'description': 'Tracking URL'}, 'name': {'type': 'string', 'description': 'Tracking name'}, 'event': {'type': 'string', 'description': 'Tracking event type (e.g. start, firstQuartile, midpoint, thirdQuartile, complete)'}}, 'additionalProperties': False}
vast_create_zone
Create a new VAST zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name', 'publisher'], 'properties': {'name': {'type': 'string', 'description': 'Zone name'}, 'metadata': {'type': 'object', 'description': 'Custom metadata key-value pairs', 'additionalProperties': {'type': 'string'}}, 'publisher': {'type': 'number', 'description': 'Publisher ID'}, 'default_vast_ad_item': {'type': 'number', 'description': 'Default VAST ad item ID (mutually exclusive with default_vast_campaign)'}, 'serve_priority_order': {'enum': ['weight', 'auction'], 'type': 'string', 'description': 'Priority order for serving: "weight" or "auction"'}, 'default_vast_campaign': {'type': 'number', 'description': 'Default VAST campaign ID (mutually exclusive with default_vast_ad_item)'}}, 'additionalProperties': False}
vast_delete_ad_item
Delete a VAST ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST ad item ID'}}, 'additionalProperties': False}
vast_delete_archived_campaign
Permanently delete an archived VAST campaign
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived VAST campaign ID'}}, 'additionalProperties': False}
vast_delete_archived_channel
Permanently delete an archived VAST channel
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived VAST channel ID'}}, 'additionalProperties': False}
vast_delete_archived_zone
Permanently delete an archived VAST zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived VAST zone ID'}}, 'additionalProperties': False}
vast_delete_campaign
Delete a VAST campaign
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST campaign ID'}}, 'additionalProperties': False}
vast_delete_campaign_assignment
Delete a VAST campaign assignment
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST campaign assignment ID'}}, 'additionalProperties': False}
vast_delete_channel
Delete a VAST channel
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST channel ID'}}, 'additionalProperties': False}
vast_delete_channel_zone_assignment
Remove a VAST zone from a VAST channel
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST channel zone assignment ID'}}, 'additionalProperties': False}
vast_delete_companion
Delete a VAST companion
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST companion ID'}}, 'additionalProperties': False}
vast_delete_linear_media
Delete a VAST linear media
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST linear media ID'}}, 'additionalProperties': False}
vast_delete_non_linear_media
Delete a VAST non-linear media
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST non-linear media ID'}}, 'additionalProperties': False}
vast_delete_placement
Delete a VAST placement
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST placement ID'}}, 'additionalProperties': False}
vast_delete_schedule
Delete a VAST schedule
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST schedule ID'}}, 'additionalProperties': False}
vast_delete_tracking
Delete a VAST tracking entry
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST tracking ID'}}, 'additionalProperties': False}
vast_delete_zone
Delete a VAST zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST zone ID'}}, 'additionalProperties': False}
vast_get_ad_item
Get details of a specific VAST ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST ad item ID'}}, 'additionalProperties': False}
vast_get_archived_campaign
Get details of a specific archived VAST campaign
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived VAST campaign ID'}}, 'additionalProperties': False}
vast_get_archived_channel
Get details of a specific archived VAST channel
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived VAST channel ID'}}, 'additionalProperties': False}
vast_get_archived_zone
Get details of a specific archived VAST zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived VAST zone ID'}}, 'additionalProperties': False}
vast_get_campaign
Get details of a specific VAST campaign
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST campaign ID'}}, 'additionalProperties': False}
vast_get_campaign_assignment
Get details of a specific VAST campaign assignment
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST campaign assignment ID'}}, 'additionalProperties': False}
vast_get_channel
Get details of a specific VAST channel
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST channel ID'}}, 'additionalProperties': False}
vast_get_channel_zone_assignment
Get details of a specific VAST channel zone assignment
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST channel zone assignment ID'}}, 'additionalProperties': False}
vast_get_companion
Get details of a specific VAST companion
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST companion ID'}}, 'additionalProperties': False}
vast_get_linear_media
Get details of a specific VAST linear media
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST linear media ID'}}, 'additionalProperties': False}
vast_get_non_linear_media
Get details of a specific VAST non-linear media
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST non-linear media ID'}}, 'additionalProperties': False}
vast_get_placement
Get details of a specific VAST placement
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST placement ID'}}, 'additionalProperties': False}
vast_get_schedule
Get details of a specific VAST schedule
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST schedule ID'}}, 'additionalProperties': False}
vast_get_tracking
Get details of a specific VAST tracking entry
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST tracking ID'}}, 'additionalProperties': False}
vast_get_zone
Get details of a specific VAST zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST zone ID'}}, 'additionalProperties': False}
vast_list_ad_items
List all VAST ad items
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast_list_archived_campaigns
List all archived VAST campaigns
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast_list_archived_channels
List all archived VAST channels
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast_list_archived_zones
List all archived VAST zones
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast_list_campaign_assignments
List all VAST campaign assignments
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast_list_campaigns
List all VAST campaigns
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast_list_channels
List all VAST channels
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast_list_channel_zone_assignments
List all VAST channel zone assignments
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast_list_companions
List all VAST companions
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast_list_linear_media
List all VAST linear media
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast_list_media
List all VAST media (linear and non-linear)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast_list_non_linear_media
List all VAST non-linear media
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast_list_placements
List all VAST placements (assignments of VAST ad items to VAST zones)
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast_list_schedules
List all VAST schedules
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast_list_tracking
List all VAST tracking entries
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast_list_zones
List all VAST zones
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'number', 'description': 'Max results to return (default 100, max 100)'}, 'offset': {'type': 'number', 'description': 'Pagination offset'}}, 'additionalProperties': False}
vast_unarchive_campaign
Restore an archived VAST campaign back to active status
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived VAST campaign ID'}}, 'additionalProperties': False}
vast_unarchive_channel
Restore an archived VAST channel back to active status
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived VAST channel ID'}}, 'additionalProperties': False}
vast_unarchive_zone
Restore an archived VAST zone back to active status
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'Archived VAST zone ID'}}, 'additionalProperties': False}
vast_update_ad_item
Update an existing VAST ad item
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST ad item ID'}, 'name': {'type': 'string', 'description': 'Ad item name'}, 'active': {'type': 'boolean', 'description': 'Whether ad item is active'}, 'location': {'type': 'string', 'description': 'VAST tag URL or media location'}}, 'additionalProperties': False}
vast_update_campaign
Update an existing VAST campaign
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST campaign ID'}, 'name': {'type': 'string', 'description': 'Campaign name'}, 'contract': {'type': 'number', 'description': 'Contract ID (requires Contract Management add-on)'}, 'advertiser': {'type': 'number', 'description': 'Advertiser ID'}}, 'additionalProperties': False}
vast_update_campaign_assignment
Update a VAST campaign assignment
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST campaign assignment ID'}, 'active': {'type': 'boolean', 'description': 'Whether to actively serve ads'}, 'ad_item': {'type': 'number', 'description': 'VAST ad item ID'}, 'campaign': {'type': 'number', 'description': 'VAST campaign ID'}}, 'additionalProperties': False}
vast_update_channel
Update an existing VAST channel
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST channel ID'}, 'name': {'type': 'string', 'description': 'Channel name'}, 'description': {'type': 'string', 'description': 'Channel description'}}, 'additionalProperties': False}
vast_update_channel_zone_assignment
Update a VAST channel zone assignment
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST channel zone assignment ID'}, 'zone': {'type': 'number', 'description': 'VAST zone ID'}, 'channel': {'type': 'number', 'description': 'VAST channel ID'}}, 'additionalProperties': False}
vast_update_companion
Update an existing VAST companion
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST companion ID'}, 'name': {'type': 'string', 'description': 'Companion name'}, 'width': {'type': 'number', 'description': 'Companion width in pixels'}, 'height': {'type': 'number', 'description': 'Companion height in pixels'}}, 'additionalProperties': False}
vast_update_linear_media
Update an existing VAST linear media
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST linear media ID'}, 'name': {'type': 'string', 'description': 'Linear media name'}, 'bitrate': {'type': 'number', 'description': 'Bitrate in kbps'}, 'duration': {'type': 'number', 'description': 'Duration in seconds'}, 'mime_type': {'type': 'string', 'description': 'MIME type (e.g. video/mp4)'}}, 'additionalProperties': False}
vast_update_non_linear_media
Update an existing VAST non-linear media
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST non-linear media ID'}, 'name': {'type': 'string', 'description': 'Non-linear media name'}, 'width': {'type': 'number', 'description': 'Width in pixels'}, 'height': {'type': 'number', 'description': 'Height in pixels'}, 'mime_type': {'type': 'string', 'description': 'MIME type'}}, 'additionalProperties': False}
vast_update_placement
Update an existing VAST placement
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST placement ID'}, 'cost': {'type': 'object', 'properties': {'cpa': {'type': 'number'}, 'cpc': {'type': 'number'}, 'cpm': {'type': 'number'}, 'fixed_cost': {'type': 'number'}}, 'description': 'Pricing model: fixed_cost OR cpm/cpc/cpa', 'additionalProperties': False}, 'zone': {'type': 'number', 'description': 'VAST zone ID (mutually exclusive with channel)'}, 'active': {'type': 'boolean', 'description': 'Whether placement is active'}, 'payout': {'type': 'object', 'properties': {'cpa': {'type': 'number'}, 'cpc': {'type': 'number'}, 'cpm': {'type': 'number'}, 'type': {'enum': ['rate', 'percent'], 'type': 'string'}, 'fixed': {'type': 'number'}}, 'description': 'Publisher payout configuration', 'additionalProperties': False}, 'channel': {'type': 'number', 'description': 'VAST channel ID (mutually exclusive with zone)'}, 'priority': {'type': 'number', 'description': 'Priority level'}, 'schedule': {'type': 'number', 'description': 'VAST schedule ID'}, 'serve_method': {'enum': ['weight', 'auction'], 'type': 'string', 'description': 'Serving system: weight-based or auction-based'}, 'advertisement': {'type': 'object', 'required': ['id', 'type'], 'properties': {'id': {'type': 'number', 'description': 'VAST ad item or campaign ID'}, 'type': {'enum': ['vast_ad_item', 'vast_campaign'], 'type': 'string', 'description': 'Type of advertisement'}}, 'description': 'Advertisement object with id and type', 'additionalProperties': False}, 'max_frequency': {'type': 'number', 'description': 'Frequency cap limit'}, 'data_key_target_id': {'type': 'number', 'description': 'Data Key Target ID (Enterprise only)'}, 'max_frequency_type': {'enum': ['start', 'view', 'firstQuartile', 'midpoint', 'thirdQuartile', 'complete'], 'type': 'string', 'description': 'Event type for frequency capping'}, 'max_frequency_period': {'type': 'number', 'description': 'Days before frequency counter resets'}}, 'additionalProperties': False}
vast_update_schedule
Update an existing VAST schedule
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST schedule ID'}, 'end_date': {'type': 'string', 'description': 'End date (YYYY-MM-DD HH:MM:SS), null for indefinite'}, 'geo_target': {'type': 'number', 'description': 'Geotarget ID (0 = no targeting)'}, 'quota_type': {'enum': ['views', 'clicks'], 'type': 'string', 'description': 'Quota measurement type'}, 'start_date': {'type': 'string', 'description': 'Start date (YYYY-MM-DD HH:MM:SS)'}, 'day_parting_id': {'type': 'number', 'description': 'Day parting ID for time-of-day targeting'}, 'quota_lifetime': {'type': 'number', 'description': 'Total quota amount (views or clicks, not per thousand)'}, 'delivery_method': {'enum': ['default', 'smooth'], 'type': 'string', 'description': 'Delivery pacing: "default" (ASAP) or "smooth" (evenly distributed)'}}, 'additionalProperties': False}
vast_update_tracking
Update an existing VAST tracking entry
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST tracking ID'}, 'url': {'type': 'string', 'description': 'Tracking URL'}, 'name': {'type': 'string', 'description': 'Tracking name'}, 'event': {'type': 'string', 'description': 'Tracking event type'}}, 'additionalProperties': False}
vast_update_zone
Update an existing VAST zone
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'number', 'description': 'VAST zone ID'}, 'name': {'type': 'string', 'description': 'Zone name'}, 'metadata': {'type': 'object', 'description': 'Custom metadata key-value pairs', 'additionalProperties': {'type': 'string'}}, 'publisher': {'type': 'number', 'description': 'Publisher ID'}, 'default_vast_ad_item': {'type': 'number', 'description': 'Default VAST ad item ID (mutually exclusive with default_vast_campaign)'}, 'serve_priority_order': {'enum': ['weight', 'auction'], 'type': 'string', 'description': 'Priority order for serving: "weight" or "auction"'}, 'default_vast_campaign': {'type': 'number', 'description': 'Default VAST campaign ID (mutually exclusive with default_vast_ad_item)'}}, 'additionalProperties': False}
verify_trial_email
Verify a trial account email with the verification code sent to the user. Call this after create_trial_account. The user must provide the code from their email. On success, the API key is automatically configured.
Schéma d’entrée
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['email', 'verification_code'], 'properties': {'email': {'type': 'string', 'description': 'The email address used to create the trial account'}, 'verification_code': {'type': 'string', 'description': 'The verification code from the email'}}, 'additionalProperties': False}
Historique
Modifications récentes des outils
Ajouté
resend_verification_code
17 September 2026 12:33
Ajouté
verify_trial_email
17 September 2026 12:33
Ajouté
create_trial_account
17 September 2026 12:33
Ajouté
setup_api_key
17 September 2026 12:33
Ajouté
call_adbutler_api
17 September 2026 12:33
Ajouté
describe_adbutler_api
17 September 2026 12:33
Ajouté
search_adbutler_api
17 September 2026 12:33
Ajouté
update_kogan_product_category
17 September 2026 12:33
Ajouté
get_kogan_product
17 September 2026 12:33
Ajouté
sync_kogan_stats
17 September 2026 12:33
Ajouté
get_kogan_dashboard_report
17 September 2026 12:33
Ajouté
get_kogan_report
17 September 2026 12:33
Ajouté
delete_zone_ortb_native_ad
17 September 2026 12:33
Ajouté
update_zone_ortb_native_ad
17 September 2026 12:33
Ajouté
create_zone_ortb_native_ad
17 September 2026 12:33
Ajouté
get_zone_ortb_native_ad
17 September 2026 12:33
Ajouté
list_zone_ortb_native_ads
17 September 2026 12:33
Ajouté
delete_ortb_native_title_asset
17 September 2026 12:33
Ajouté
update_ortb_native_title_asset
17 September 2026 12:33
Ajouté
create_ortb_native_title_asset
17 September 2026 12:33
Ajouté
get_ortb_native_title_asset
17 September 2026 12:33
Ajouté
list_ortb_native_title_assets
17 September 2026 12:33
Ajouté
delete_ortb_native_image_asset
17 September 2026 12:33
Ajouté
update_ortb_native_image_asset
17 September 2026 12:33
Ajouté
create_ortb_native_image_asset
17 September 2026 12:33
Ajouté
get_ortb_native_image_asset
17 September 2026 12:33
Ajouté
list_ortb_native_image_assets
17 September 2026 12:33
Ajouté
delete_ortb_native_data_asset
17 September 2026 12:33
Ajouté
update_ortb_native_data_asset
17 September 2026 12:33
Ajouté
create_ortb_native_data_asset
17 September 2026 12:33
Découvrir
Serveurs MCP similaires
Meta Council
com.meta-council/decision-intelligence
Provides governed workflows for consulting, outreach, sales deals, invoices, marketing campaigns, content approvals, accounting a…
synter-ads
io.github.Synter-Media-AI/synter-ads
Manages cross-platform advertising campaigns, audiences, tracking, creative, landing pages, campaign audits, technology intellige…
synter-ads
io.github.jshorwitz/synter-ads
Manages cross-platform advertising campaigns, audiences, tracking, creative, landing pages, campaign audits, technology intellige…
Stratalize Intelligence
com.stratalize/intelligence
Provides vendor, market, SaaS, workforce, government contract, public company, regulatory, competitive, and AI-brand intelligence…
Neotic
app.neotic.www/neotic
Enables agents to create contextual in-app experiences, announcements, and triggers.
CorpusIQ
io.corpusiq/multi-source-mcp
Connects authenticated users to business systems such as CRM, ecommerce, advertising, analytics, email marketing, SEO, calendars,…
Riley Craig x402 Agent Store
io.github.rccola990-cloud/x402-agent-store
Provides paid blockchain data and transaction reads, AI brand-visibility research, and company or lead enrichment services.
GrowthKit Revenue Intelligence
tools.growthkit/revenue-intelligence
Supports B2B revenue operations with lead campaigns, ICP and company enrichment, CRM records and activities, outreach drafting, t…