@adcp/sdk 6.0.0 → 6.2.0

package/dist/lib/schemas-data/v2.5/core/activation-key.json

@@ -0,0 +1,50 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/activation-key.json",
+  "title": "Activation Key",
+  "description": "Universal identifier for using a signal on a destination platform. Can be either a segment ID or a key-value pair depending on the platform's targeting mechanism.",
+  "type": "object",
+  "oneOf": [
+    {
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "segment_id",
+          "description": "Segment ID based targeting"
+        },
+        "segment_id": {
+          "type": "string",
+          "description": "The platform-specific segment identifier to use in campaign targeting"
+        }
+      },
+      "required": [
+        "type",
+        "segment_id"
+      ],
+      "additionalProperties": true
+    },
+    {
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "key_value",
+          "description": "Key-value pair based targeting"
+        },
+        "key": {
+          "type": "string",
+          "description": "The targeting parameter key"
+        },
+        "value": {
+          "type": "string",
+          "description": "The targeting parameter value"
+        }
+      },
+      "required": [
+        "type",
+        "key",
+        "value"
+      ],
+      "additionalProperties": true
+    }
+  ]
+}

package/dist/lib/schemas-data/v2.5/core/assets/audio-asset.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/assets/audio-asset.json",
+  "title": "Audio Asset",
+  "description": "Audio asset with URL and specifications",
+  "type": "object",
+  "properties": {
+    "url": {
+      "type": "string",
+      "format": "uri",
+      "description": "URL to the audio asset"
+    },
+    "duration_ms": {
+      "type": "integer",
+      "description": "Audio duration in milliseconds",
+      "minimum": 0
+    },
+    "format": {
+      "type": "string",
+      "description": "Audio file format (mp3, wav, aac, etc.)"
+    },
+    "bitrate_kbps": {
+      "type": "integer",
+      "description": "Audio bitrate in kilobits per second",
+      "minimum": 1
+    }
+  },
+  "required": [
+    "url"
+  ],
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/core/assets/css-asset.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/assets/css-asset.json",
+  "title": "CSS Asset",
+  "description": "CSS stylesheet asset",
+  "type": "object",
+  "properties": {
+    "content": {
+      "type": "string",
+      "description": "CSS content"
+    },
+    "media": {
+      "type": "string",
+      "description": "CSS media query context (e.g., 'screen', 'print')"
+    }
+  },
+  "required": [
+    "content"
+  ],
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/core/assets/daast-asset.json

@@ -0,0 +1,87 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/assets/daast-asset.json",
+  "title": "DAAST Asset",
+  "description": "DAAST (Digital Audio Ad Serving Template) tag for third-party audio ad serving",
+  "oneOf": [
+    {
+      "type": "object",
+      "properties": {
+        "delivery_type": {
+          "type": "string",
+          "const": "url",
+          "description": "Discriminator indicating DAAST is delivered via URL endpoint"
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "description": "URL endpoint that returns DAAST XML"
+        },
+        "daast_version": {
+          "$ref": "/schemas/enums/daast-version.json",
+          "description": "DAAST specification version"
+        },
+        "duration_ms": {
+          "type": "integer",
+          "description": "Expected audio duration in milliseconds (if known)",
+          "minimum": 0
+        },
+        "tracking_events": {
+          "type": "array",
+          "items": {
+            "$ref": "/schemas/enums/daast-tracking-event.json"
+          },
+          "description": "Tracking events supported by this DAAST tag"
+        },
+        "companion_ads": {
+          "type": "boolean",
+          "description": "Whether companion display ads are included"
+        }
+      },
+      "required": [
+        "delivery_type",
+        "url"
+      ],
+      "additionalProperties": true
+    },
+    {
+      "type": "object",
+      "properties": {
+        "delivery_type": {
+          "type": "string",
+          "const": "inline",
+          "description": "Discriminator indicating DAAST is delivered as inline XML content"
+        },
+        "content": {
+          "type": "string",
+          "description": "Inline DAAST XML content"
+        },
+        "daast_version": {
+          "$ref": "/schemas/enums/daast-version.json",
+          "description": "DAAST specification version"
+        },
+        "duration_ms": {
+          "type": "integer",
+          "description": "Expected audio duration in milliseconds (if known)",
+          "minimum": 0
+        },
+        "tracking_events": {
+          "type": "array",
+          "items": {
+            "$ref": "/schemas/enums/daast-tracking-event.json"
+          },
+          "description": "Tracking events supported by this DAAST tag"
+        },
+        "companion_ads": {
+          "type": "boolean",
+          "description": "Whether companion display ads are included"
+        }
+      },
+      "required": [
+        "delivery_type",
+        "content"
+      ],
+      "additionalProperties": true
+    }
+  ]
+}

package/dist/lib/schemas-data/v2.5/core/assets/html-asset.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/assets/html-asset.json",
+  "title": "HTML Asset",
+  "description": "HTML content asset",
+  "type": "object",
+  "properties": {
+    "content": {
+      "type": "string",
+      "description": "HTML content"
+    },
+    "version": {
+      "type": "string",
+      "description": "HTML version (e.g., 'HTML5')"
+    }
+  },
+  "required": [
+    "content"
+  ],
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/core/assets/image-asset.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/assets/image-asset.json",
+  "title": "Image Asset",
+  "description": "Image asset with URL and dimensions",
+  "type": "object",
+  "properties": {
+    "url": {
+      "type": "string",
+      "format": "uri",
+      "description": "URL to the image asset"
+    },
+    "width": {
+      "type": "integer",
+      "minimum": 1,
+      "description": "Width in pixels"
+    },
+    "height": {
+      "type": "integer",
+      "minimum": 1,
+      "description": "Height in pixels"
+    },
+    "format": {
+      "type": "string",
+      "description": "Image file format (jpg, png, gif, webp, etc.)"
+    },
+    "alt_text": {
+      "type": "string",
+      "description": "Alternative text for accessibility"
+    }
+  },
+  "required": [
+    "url",
+    "width",
+    "height"
+  ],
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/core/assets/javascript-asset.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/assets/javascript-asset.json",
+  "title": "JavaScript Asset",
+  "description": "JavaScript code asset",
+  "type": "object",
+  "properties": {
+    "content": {
+      "type": "string",
+      "description": "JavaScript content"
+    },
+    "module_type": {
+      "$ref": "/schemas/enums/javascript-module-type.json",
+      "description": "JavaScript module type"
+    }
+  },
+  "required": [
+    "content"
+  ],
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/core/assets/markdown-asset.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/assets/markdown-asset.json",
+  "title": "Markdown Asset",
+  "description": "Markdown-formatted text content following CommonMark specification",
+  "type": "object",
+  "properties": {
+    "content": {
+      "type": "string",
+      "description": "Markdown content following CommonMark spec with optional GitHub Flavored Markdown extensions"
+    },
+    "language": {
+      "type": "string",
+      "description": "Language code (e.g., 'en', 'es', 'fr')"
+    },
+    "markdown_flavor": {
+      "$ref": "/schemas/enums/markdown-flavor.json",
+      "default": "commonmark",
+      "description": "Markdown flavor used. CommonMark for strict compatibility, GFM for tables/task lists/strikethrough."
+    },
+    "allow_raw_html": {
+      "type": "boolean",
+      "default": false,
+      "description": "Whether raw HTML blocks are allowed in the markdown. False recommended for security."
+    }
+  },
+  "required": [
+    "content"
+  ],
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/core/assets/text-asset.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/assets/text-asset.json",
+  "title": "Text Asset",
+  "description": "Text content asset",
+  "type": "object",
+  "properties": {
+    "content": {
+      "type": "string",
+      "description": "Text content"
+    },
+    "language": {
+      "type": "string",
+      "description": "Language code (e.g., 'en', 'es', 'fr')"
+    }
+  },
+  "required": [
+    "content"
+  ],
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/core/assets/url-asset.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/assets/url-asset.json",
+  "title": "URL Asset",
+  "description": "URL reference asset",
+  "type": "object",
+  "properties": {
+    "url": {
+      "type": "string",
+      "format": "uri",
+      "description": "URL reference"
+    },
+    "url_type": {
+      "$ref": "/schemas/enums/url-asset-type.json",
+      "description": "Type of URL asset: 'clickthrough' for user click destination (landing page), 'tracker_pixel' for impression/event tracking via HTTP request (fires GET, expects pixel/204 response), 'tracker_script' for measurement SDKs that must load as <script> tag (OMID verification, native event trackers using method:2)"
+    },
+    "description": {
+      "type": "string",
+      "description": "Description of what this URL points to"
+    }
+  },
+  "required": [
+    "url"
+  ],
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/core/assets/vast-asset.json

@@ -0,0 +1,87 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/assets/vast-asset.json",
+  "title": "VAST Asset",
+  "description": "VAST (Video Ad Serving Template) tag for third-party video ad serving",
+  "oneOf": [
+    {
+      "type": "object",
+      "properties": {
+        "delivery_type": {
+          "type": "string",
+          "const": "url",
+          "description": "Discriminator indicating VAST is delivered via URL endpoint"
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "description": "URL endpoint that returns VAST XML"
+        },
+        "vast_version": {
+          "$ref": "/schemas/enums/vast-version.json",
+          "description": "VAST specification version"
+        },
+        "vpaid_enabled": {
+          "type": "boolean",
+          "description": "Whether VPAID (Video Player-Ad Interface Definition) is supported"
+        },
+        "duration_ms": {
+          "type": "integer",
+          "description": "Expected video duration in milliseconds (if known)",
+          "minimum": 0
+        },
+        "tracking_events": {
+          "type": "array",
+          "items": {
+            "$ref": "/schemas/enums/vast-tracking-event.json"
+          },
+          "description": "Tracking events supported by this VAST tag"
+        }
+      },
+      "required": [
+        "delivery_type",
+        "url"
+      ],
+      "additionalProperties": true
+    },
+    {
+      "type": "object",
+      "properties": {
+        "delivery_type": {
+          "type": "string",
+          "const": "inline",
+          "description": "Discriminator indicating VAST is delivered as inline XML content"
+        },
+        "content": {
+          "type": "string",
+          "description": "Inline VAST XML content"
+        },
+        "vast_version": {
+          "$ref": "/schemas/enums/vast-version.json",
+          "description": "VAST specification version"
+        },
+        "vpaid_enabled": {
+          "type": "boolean",
+          "description": "Whether VPAID (Video Player-Ad Interface Definition) is supported"
+        },
+        "duration_ms": {
+          "type": "integer",
+          "description": "Expected video duration in milliseconds (if known)",
+          "minimum": 0
+        },
+        "tracking_events": {
+          "type": "array",
+          "items": {
+            "$ref": "/schemas/enums/vast-tracking-event.json"
+          },
+          "description": "Tracking events supported by this VAST tag"
+        }
+      },
+      "required": [
+        "delivery_type",
+        "content"
+      ],
+      "additionalProperties": true
+    }
+  ]
+}

package/dist/lib/schemas-data/v2.5/core/assets/video-asset.json

@@ -0,0 +1,44 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/assets/video-asset.json",
+  "title": "Video Asset",
+  "description": "Video asset with URL and specifications",
+  "type": "object",
+  "properties": {
+    "url": {
+      "type": "string",
+      "format": "uri",
+      "description": "URL to the video asset"
+    },
+    "width": {
+      "type": "integer",
+      "minimum": 1,
+      "description": "Width in pixels"
+    },
+    "height": {
+      "type": "integer",
+      "minimum": 1,
+      "description": "Height in pixels"
+    },
+    "duration_ms": {
+      "type": "integer",
+      "description": "Video duration in milliseconds",
+      "minimum": 1
+    },
+    "format": {
+      "type": "string",
+      "description": "Video file format (mp4, webm, mov, etc.)"
+    },
+    "bitrate_kbps": {
+      "type": "integer",
+      "description": "Video bitrate in kilobits per second",
+      "minimum": 1
+    }
+  },
+  "required": [
+    "url",
+    "width",
+    "height"
+  ],
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/core/assets/webhook-asset.json

@@ -0,0 +1,71 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/assets/webhook-asset.json",
+  "title": "Webhook Asset",
+  "description": "Webhook for server-side dynamic content rendering (DCO)",
+  "type": "object",
+  "properties": {
+    "url": {
+      "type": "string",
+      "format": "uri",
+      "description": "Webhook URL to call for dynamic content"
+    },
+    "method": {
+      "$ref": "/schemas/enums/http-method.json",
+      "default": "POST",
+      "description": "HTTP method"
+    },
+    "timeout_ms": {
+      "type": "integer",
+      "minimum": 10,
+      "maximum": 5000,
+      "default": 500,
+      "description": "Maximum time to wait for response in milliseconds"
+    },
+    "supported_macros": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "Universal macros that can be passed to webhook (e.g., {DEVICE_TYPE}, {COUNTRY})"
+    },
+    "required_macros": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "Universal macros that must be provided for webhook to function"
+    },
+    "response_type": {
+      "$ref": "/schemas/enums/webhook-response-type.json",
+      "description": "Expected content type of webhook response"
+    },
+    "security": {
+      "type": "object",
+      "description": "Security configuration for webhook calls",
+      "properties": {
+        "method": {
+          "$ref": "/schemas/enums/webhook-security-method.json",
+          "description": "Authentication method"
+        },
+        "hmac_header": {
+          "type": "string",
+          "description": "Header name for HMAC signature (e.g., 'X-Signature')"
+        },
+        "api_key_header": {
+          "type": "string",
+          "description": "Header name for API key (e.g., 'X-API-Key')"
+        }
+      },
+      "required": [
+        "method"
+      ]
+    }
+  },
+  "required": [
+    "url",
+    "response_type",
+    "security"
+  ],
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/core/async-response-data.json

@@ -0,0 +1,88 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/async-response-data.json",
+  "title": "AdCP Async Response Data",
+  "description": "Union of all possible data payloads for async task webhook responses. For completed/failed statuses, use the main task response schema. For working/input-required/submitted, use the status-specific schemas.",
+  "anyOf": [
+    {
+      "title": "GetProductsResponse",
+      "description": "Response for completed or failed get_products",
+      "$ref": "/schemas/media-buy/get-products-response.json"
+    },
+    {
+      "title": "GetProductsAsyncWorking",
+      "description": "Progress data for working get_products",
+      "$ref": "/schemas/media-buy/get-products-async-response-working.json"
+    },
+    {
+      "title": "GetProductsAsyncInputRequired",
+      "description": "Input requirements for get_products needing clarification",
+      "$ref": "/schemas/media-buy/get-products-async-response-input-required.json"
+    },
+    {
+      "title": "GetProductsAsyncSubmitted",
+      "description": "Acknowledgment for submitted get_products (custom curation)",
+      "$ref": "/schemas/media-buy/get-products-async-response-submitted.json"
+    },
+    {
+      "title": "CreateMediaBuyResponse",
+      "description": "Response for completed or failed create_media_buy",
+      "$ref": "/schemas/media-buy/create-media-buy-response.json"
+    },
+    {
+      "title": "CreateMediaBuyAsyncWorking",
+      "description": "Progress data for working create_media_buy",
+      "$ref": "/schemas/media-buy/create-media-buy-async-response-working.json"
+    },
+    {
+      "title": "CreateMediaBuyAsyncInputRequired",
+      "description": "Input requirements for create_media_buy needing user input",
+      "$ref": "/schemas/media-buy/create-media-buy-async-response-input-required.json"
+    },
+    {
+      "title": "CreateMediaBuyAsyncSubmitted",
+      "description": "Acknowledgment for submitted create_media_buy",
+      "$ref": "/schemas/media-buy/create-media-buy-async-response-submitted.json"
+    },
+    {
+      "title": "UpdateMediaBuyResponse",
+      "description": "Response for completed or failed update_media_buy",
+      "$ref": "/schemas/media-buy/update-media-buy-response.json"
+    },
+    {
+      "title": "UpdateMediaBuyAsyncWorking",
+      "description": "Progress data for working update_media_buy",
+      "$ref": "/schemas/media-buy/update-media-buy-async-response-working.json"
+    },
+    {
+      "title": "UpdateMediaBuyAsyncInputRequired",
+      "description": "Input requirements for update_media_buy needing user input",
+      "$ref": "/schemas/media-buy/update-media-buy-async-response-input-required.json"
+    },
+    {
+      "title": "UpdateMediaBuyAsyncSubmitted",
+      "description": "Acknowledgment for submitted update_media_buy",
+      "$ref": "/schemas/media-buy/update-media-buy-async-response-submitted.json"
+    },
+    {
+      "title": "SyncCreativesResponse",
+      "description": "Response for completed or failed sync_creatives",
+      "$ref": "/schemas/media-buy/sync-creatives-response.json"
+    },
+    {
+      "title": "SyncCreativesAsyncWorking",
+      "description": "Progress data for working sync_creatives",
+      "$ref": "/schemas/media-buy/sync-creatives-async-response-working.json"
+    },
+    {
+      "title": "SyncCreativesAsyncInputRequired",
+      "description": "Input requirements for sync_creatives needing user input",
+      "$ref": "/schemas/media-buy/sync-creatives-async-response-input-required.json"
+    },
+    {
+      "title": "SyncCreativesAsyncSubmitted",
+      "description": "Acknowledgment for submitted sync_creatives",
+      "$ref": "/schemas/media-buy/sync-creatives-async-response-submitted.json"
+    }
+  ]
+}