@adcp/sdk 5.25.1 → 6.1.0

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

@@ -0,0 +1,166 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/tasks-get-response.json",
+  "title": "Tasks Get Response",
+  "description": "Response containing detailed information about a specific task including status and optional conversation history across all AdCP domains",
+  "type": "object",
+  "properties": {
+    "task_id": {
+      "type": "string",
+      "description": "Unique identifier for this task"
+    },
+    "task_type": {
+      "$ref": "/schemas/enums/task-type.json",
+      "description": "Type of AdCP operation"
+    },
+    "domain": {
+      "type": "string",
+      "description": "AdCP domain this task belongs to",
+      "enum": [
+        "media-buy",
+        "signals"
+      ]
+    },
+    "status": {
+      "$ref": "/schemas/enums/task-status.json",
+      "description": "Current task status"
+    },
+    "created_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the task was initially created (ISO 8601)"
+    },
+    "updated_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the task was last updated (ISO 8601)"
+    },
+    "completed_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the task completed (ISO 8601, only for completed/failed/canceled tasks)"
+    },
+    "has_webhook": {
+      "type": "boolean",
+      "description": "Whether this task has webhook configuration"
+    },
+    "progress": {
+      "type": "object",
+      "description": "Progress information for long-running tasks",
+      "properties": {
+        "percentage": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 100,
+          "description": "Completion percentage (0-100)"
+        },
+        "current_step": {
+          "type": "string",
+          "description": "Current step or phase of the operation"
+        },
+        "total_steps": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Total number of steps in the operation"
+        },
+        "step_number": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Current step number"
+        }
+      },
+      "additionalProperties": true
+    },
+    "error": {
+      "type": "object",
+      "description": "Error details for failed tasks",
+      "properties": {
+        "code": {
+          "type": "string",
+          "description": "Error code for programmatic handling"
+        },
+        "message": {
+          "type": "string",
+          "description": "Detailed error message"
+        },
+        "details": {
+          "type": "object",
+          "description": "Additional error context",
+          "properties": {
+            "domain": {
+              "type": "string",
+              "description": "AdCP domain where error occurred",
+              "enum": [
+                "media-buy",
+                "signals"
+              ]
+            },
+            "operation": {
+              "type": "string",
+              "description": "Specific operation that failed"
+            },
+            "specific_context": {
+              "type": "object",
+              "description": "Domain-specific error context",
+              "additionalProperties": true
+            }
+          },
+          "additionalProperties": true
+        }
+      },
+      "required": [
+        "code",
+        "message"
+      ],
+      "additionalProperties": true
+    },
+    "history": {
+      "type": "array",
+      "description": "Complete conversation history for this task (only included if include_history was true in request)",
+      "items": {
+        "type": "object",
+        "properties": {
+          "timestamp": {
+            "type": "string",
+            "format": "date-time",
+            "description": "When this exchange occurred (ISO 8601)"
+          },
+          "type": {
+            "type": "string",
+            "enum": [
+              "request",
+              "response"
+            ],
+            "description": "Whether this was a request from client or response from server"
+          },
+          "data": {
+            "type": "object",
+            "description": "The full request or response payload",
+            "additionalProperties": true
+          }
+        },
+        "required": [
+          "timestamp",
+          "type",
+          "data"
+        ],
+        "additionalProperties": true
+      }
+    },
+    "context": {
+      "$ref": "/schemas/core/context.json"
+    },
+    "ext": {
+      "$ref": "/schemas/core/ext.json"
+    }
+  },
+  "required": [
+    "task_id",
+    "task_type",
+    "domain",
+    "status",
+    "created_at",
+    "updated_at"
+  ],
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/core/tasks-list-request.json

@@ -0,0 +1,192 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/tasks-list-request.json",
+  "title": "Tasks List Request",
+  "description": "Request parameters for listing and filtering async tasks across all AdCP domains with state reconciliation capabilities",
+  "type": "object",
+  "properties": {
+    "filters": {
+      "type": "object",
+      "description": "Filter criteria for querying tasks",
+      "properties": {
+        "domain": {
+          "$ref": "/schemas/enums/adcp-domain.json",
+          "description": "Filter by single AdCP domain"
+        },
+        "domains": {
+          "type": "array",
+          "description": "Filter by multiple AdCP domains",
+          "items": {
+            "$ref": "/schemas/enums/adcp-domain.json"
+          }
+        },
+        "status": {
+          "$ref": "/schemas/enums/task-status.json",
+          "description": "Filter by single task status"
+        },
+        "statuses": {
+          "type": "array",
+          "description": "Filter by multiple task statuses",
+          "items": {
+            "$ref": "/schemas/enums/task-status.json"
+          }
+        },
+        "task_type": {
+          "$ref": "/schemas/enums/task-type.json",
+          "description": "Filter by single task type"
+        },
+        "task_types": {
+          "type": "array",
+          "description": "Filter by multiple task types",
+          "items": {
+            "$ref": "/schemas/enums/task-type.json"
+          }
+        },
+        "created_after": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Filter tasks created after this date (ISO 8601)"
+        },
+        "created_before": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Filter tasks created before this date (ISO 8601)"
+        },
+        "updated_after": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Filter tasks last updated after this date (ISO 8601)"
+        },
+        "updated_before": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Filter tasks last updated before this date (ISO 8601)"
+        },
+        "task_ids": {
+          "type": "array",
+          "description": "Filter by specific task IDs",
+          "items": {
+            "type": "string"
+          },
+          "maxItems": 100
+        },
+        "context_contains": {
+          "type": "string",
+          "description": "Filter tasks where context contains this text (searches buyer_ref, media_buy_id, signal_id, etc.)"
+        },
+        "has_webhook": {
+          "type": "boolean",
+          "description": "Filter tasks that have webhook configuration when true"
+        }
+      },
+      "additionalProperties": true
+    },
+    "sort": {
+      "type": "object",
+      "description": "Sorting parameters",
+      "properties": {
+        "field": {
+          "type": "string",
+          "enum": [
+            "created_at",
+            "updated_at",
+            "status",
+            "task_type",
+            "domain"
+          ],
+          "default": "created_at",
+          "description": "Field to sort by"
+        },
+        "direction": {
+          "$ref": "/schemas/enums/sort-direction.json",
+          "default": "desc",
+          "description": "Sort direction"
+        }
+      },
+      "additionalProperties": true
+    },
+    "pagination": {
+      "type": "object",
+      "description": "Pagination parameters",
+      "properties": {
+        "limit": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 100,
+          "default": 50,
+          "description": "Maximum number of tasks to return"
+        },
+        "offset": {
+          "type": "integer",
+          "minimum": 0,
+          "default": 0,
+          "description": "Number of tasks to skip"
+        }
+      },
+      "additionalProperties": true
+    },
+    "include_history": {
+      "type": "boolean",
+      "default": false,
+      "description": "Include full conversation history for each task (may significantly increase response size)"
+    },
+    "context": {
+      "$ref": "/schemas/core/context.json"
+    },
+    "ext": {
+      "$ref": "/schemas/core/ext.json"
+    }
+  },
+  "additionalProperties": true,
+  "examples": [
+    {
+      "description": "List all pending tasks across domains",
+      "data": {
+        "filters": {
+          "statuses": [
+            "submitted",
+            "working",
+            "input-required"
+          ]
+        }
+      }
+    },
+    {
+      "description": "Find media-buy tasks requiring attention",
+      "data": {
+        "filters": {
+          "domain": "media-buy",
+          "statuses": [
+            "input-required",
+            "failed"
+          ]
+        },
+        "sort": {
+          "field": "updated_at",
+          "direction": "asc"
+        }
+      }
+    },
+    {
+      "description": "Recent signal operations",
+      "data": {
+        "filters": {
+          "domain": "signals",
+          "created_after": "2025-01-01T00:00:00Z"
+        },
+        "pagination": {
+          "limit": 20
+        }
+      }
+    },
+    {
+      "description": "State reconciliation for specific campaign",
+      "data": {
+        "filters": {
+          "context_contains": "nike_q1_2025"
+        },
+        "include_history": true
+      }
+    }
+  ]
+}

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

@@ -0,0 +1,183 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/tasks-list-response.json",
+  "title": "Tasks List Response",
+  "description": "Response from task listing query with filtered results and state reconciliation data across all AdCP domains",
+  "type": "object",
+  "properties": {
+    "query_summary": {
+      "type": "object",
+      "description": "Summary of the query that was executed",
+      "properties": {
+        "total_matching": {
+          "type": "integer",
+          "description": "Total number of tasks matching filters (across all pages)",
+          "minimum": 0
+        },
+        "returned": {
+          "type": "integer",
+          "description": "Number of tasks returned in this response",
+          "minimum": 0
+        },
+        "domain_breakdown": {
+          "type": "object",
+          "description": "Count of tasks by domain",
+          "properties": {
+            "media-buy": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Number of media-buy tasks in results"
+            },
+            "signals": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Number of signals tasks in results"
+            }
+          },
+          "additionalProperties": true
+        },
+        "status_breakdown": {
+          "type": "object",
+          "description": "Count of tasks by status",
+          "additionalProperties": {
+            "type": "integer",
+            "minimum": 0
+          }
+        },
+        "filters_applied": {
+          "type": "array",
+          "description": "List of filters that were applied to the query",
+          "items": {
+            "type": "string"
+          }
+        },
+        "sort_applied": {
+          "type": "object",
+          "description": "Sort order that was applied",
+          "properties": {
+            "field": {
+              "type": "string"
+            },
+            "direction": {
+              "type": "string",
+              "enum": [
+                "asc",
+                "desc"
+              ]
+            }
+          },
+          "required": [
+            "field",
+            "direction"
+          ],
+          "additionalProperties": true
+        }
+      },
+      "required": [
+        "total_matching",
+        "returned"
+      ],
+      "additionalProperties": true
+    },
+    "tasks": {
+      "type": "array",
+      "description": "Array of tasks matching the query criteria",
+      "items": {
+        "type": "object",
+        "properties": {
+          "task_id": {
+            "type": "string",
+            "description": "Unique identifier for this task"
+          },
+          "task_type": {
+            "$ref": "/schemas/enums/task-type.json",
+            "description": "Type of AdCP operation"
+          },
+          "domain": {
+            "type": "string",
+            "description": "AdCP domain this task belongs to",
+            "enum": [
+              "media-buy",
+              "signals"
+            ]
+          },
+          "status": {
+            "$ref": "/schemas/enums/task-status.json",
+            "description": "Current task status"
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time",
+            "description": "When the task was initially created (ISO 8601)"
+          },
+          "updated_at": {
+            "type": "string",
+            "format": "date-time",
+            "description": "When the task was last updated (ISO 8601)"
+          },
+          "completed_at": {
+            "type": "string",
+            "format": "date-time",
+            "description": "When the task completed (ISO 8601, only for completed/failed/canceled tasks)"
+          },
+          "has_webhook": {
+            "type": "boolean",
+            "description": "Whether this task has webhook configuration"
+          }
+        },
+        "required": [
+          "task_id",
+          "task_type",
+          "domain",
+          "status",
+          "created_at",
+          "updated_at"
+        ],
+        "additionalProperties": true
+      }
+    },
+    "pagination": {
+      "type": "object",
+      "description": "Pagination information",
+      "properties": {
+        "limit": {
+          "type": "integer",
+          "description": "Limit that was applied to this query",
+          "minimum": 1
+        },
+        "offset": {
+          "type": "integer",
+          "description": "Offset that was applied to this query",
+          "minimum": 0
+        },
+        "has_more": {
+          "type": "boolean",
+          "description": "Whether there are more tasks beyond this page"
+        },
+        "next_offset": {
+          "type": "integer",
+          "description": "Offset to use for next page (only present if has_more is true)",
+          "minimum": 0
+        }
+      },
+      "required": [
+        "limit",
+        "offset",
+        "has_more"
+      ],
+      "additionalProperties": true
+    },
+    "context": {
+      "$ref": "/schemas/core/context.json"
+    },
+    "ext": {
+      "$ref": "/schemas/core/ext.json"
+    }
+  },
+  "required": [
+    "query_summary",
+    "tasks",
+    "pagination"
+  ],
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/creative/asset-types/index.json

@@ -0,0 +1,101 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/creative/asset-types/index.json",
+  "title": "AdCP Asset Type Registry",
+  "description": "Registry of asset types used in AdCP creative manifests. Each asset type defines the structure of actual content payloads (what you send), not requirements or constraints (which belong in format specifications).",
+  "version": "1.0.0",
+  "lastUpdated": "2025-10-19",
+  "asset_types": {
+    "image": {
+      "description": "Static image asset (JPG, PNG, GIF, WebP, SVG)",
+      "schema": "/schemas/core/assets/image-asset.json",
+      "typical_use": "Hero images, logos, product photos, backgrounds"
+    },
+    "video": {
+      "description": "Hosted video file asset (MP4, WebM, MOV)",
+      "schema": "/schemas/core/assets/video-asset.json",
+      "typical_use": "Video ads, product demos, brand stories"
+    },
+    "audio": {
+      "description": "Audio file asset (MP3, AAC, M4A, WAV, OGG)",
+      "schema": "/schemas/core/assets/audio-asset.json",
+      "typical_use": "Audio ads for streaming, podcasts, radio"
+    },
+    "vast": {
+      "description": "VAST XML tag for third-party video ad serving",
+      "schema": "/schemas/core/assets/vast-asset.json",
+      "typical_use": "Third-party served video ads with VAST 2.0-4.2"
+    },
+    "daast": {
+      "description": "DAAST XML tag for third-party audio ad serving",
+      "schema": "/schemas/core/assets/daast-asset.json",
+      "typical_use": "Third-party served audio ads with DAAST 1.0-1.1"
+    },
+    "text": {
+      "description": "Plain text content asset",
+      "schema": "/schemas/core/assets/text-asset.json",
+      "typical_use": "Headlines, descriptions, CTAs, body copy, disclaimers"
+    },
+    "markdown": {
+      "description": "Markdown-formatted text content (CommonMark/GFM)",
+      "schema": "/schemas/core/assets/markdown-asset.json",
+      "typical_use": "Product specifications, format documentation, rich descriptions, structured content"
+    },
+    "url": {
+      "description": "URL asset for clickthrough, tracking, landing pages",
+      "schema": "/schemas/core/assets/url-asset.json",
+      "typical_use": "Clickthrough URLs, tracking pixels, impression trackers"
+    },
+    "html": {
+      "description": "HTML5 creative asset for interactive ads",
+      "schema": "/schemas/core/assets/html-asset.json",
+      "typical_use": "HTML5 display banners, rich media, interactive ads"
+    },
+    "css": {
+      "description": "CSS stylesheet asset for styling",
+      "schema": "/schemas/core/assets/css-asset.json",
+      "typical_use": "Stylesheets for HTML5 creatives, custom styling"
+    },
+    "webhook": {
+      "description": "Server-side webhook for dynamic creative rendering",
+      "schema": "/schemas/core/assets/webhook-asset.json",
+      "typical_use": "DCO (Dynamic Creative Optimization), real-time personalization, server-side rendering"
+    },
+    "javascript": {
+      "description": "JavaScript code for dynamic creative logic",
+      "schema": "/schemas/core/assets/javascript-asset.json",
+      "typical_use": "Third-party tags, custom interaction logic, analytics"
+    },
+    "promoted_offerings": {
+      "description": "Brand manifest and product selectors for generative creative formats",
+      "schema": "/schemas/core/promoted-offerings.json",
+      "typical_use": "AI-generated creatives that need brand context and product information"
+    }
+  },
+  "architecture": {
+    "payload_vs_requirements": {
+      "description": "Asset schemas define PAYLOAD structure (what you send), not constraints or requirements",
+      "payload_examples": [
+        "url, width, height, content, duration_ms, format"
+      ],
+      "requirement_examples": [
+        "max_file_size, required: true/false, min_duration, max_duration"
+      ],
+      "where_requirements_go": "Format specifications contain all constraints in the 'requirements' field of each asset_required item"
+    },
+    "format_aware_validation": {
+      "description": "Creative manifests are validated in the context of their format specification",
+      "process": [
+        "1. Read format_id from manifest",
+        "2. Fetch format specification",
+        "3. For each asset in manifest, look up asset_id in format's assets_required",
+        "4. Validate asset matches the type and requirements defined in the format"
+      ]
+    }
+  },
+  "usage_notes": {
+    "format_specs": "Format specifications define what asset_ids are required (e.g., 'hero_image', 'logo'). Each defines its asset type and constraints (dimensions, file size, etc.).",
+    "creative_manifests": "Creative manifests provide actual asset content, keyed by asset_id from the format. Asset type is determined by the format specification, not declared in the payload.",
+    "example_flow": "Format says 'hero_image' must be type 'image' with width 1200, height 627. Manifest provides hero_image: {url: '...', width: 1200, height: 627}. The format spec tells us it's an image type."
+  }
+}