@adcp/sdk 5.25.1 → 6.1.0

package/dist/lib/schemas-data/v2.5/creative/list-creative-formats-request.json

@@ -0,0 +1,73 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/creative/list-creative-formats-request.json",
+  "title": "List Creative Formats Request (Creative Agent)",
+  "description": "Request parameters for discovering creative formats provided by this creative agent",
+  "type": "object",
+  "properties": {
+    "format_ids": {
+      "type": "array",
+      "description": "Return only these specific format IDs",
+      "items": {
+        "$ref": "/schemas/core/format-id.json"
+      }
+    },
+    "type": {
+      "type": "string",
+      "description": "Filter by format type (technical categories with distinct requirements)",
+      "enum": [
+        "audio",
+        "video",
+        "display",
+        "dooh"
+      ]
+    },
+    "asset_types": {
+      "type": "array",
+      "description": "Filter to formats that include these asset types. For third-party tags, search for 'html' or 'javascript'. E.g., ['image', 'text'] returns formats with images and text, ['javascript'] returns formats accepting JavaScript tags.",
+      "items": {
+        "type": "string",
+        "enum": [
+          "image",
+          "video",
+          "audio",
+          "text",
+          "html",
+          "javascript",
+          "url"
+        ]
+      }
+    },
+    "max_width": {
+      "type": "integer",
+      "description": "Maximum width in pixels (inclusive). Returns formats with width <= this value. Omit for responsive/fluid formats."
+    },
+    "max_height": {
+      "type": "integer",
+      "description": "Maximum height in pixels (inclusive). Returns formats with height <= this value. Omit for responsive/fluid formats."
+    },
+    "min_width": {
+      "type": "integer",
+      "description": "Minimum width in pixels (inclusive). Returns formats with width >= this value."
+    },
+    "min_height": {
+      "type": "integer",
+      "description": "Minimum height in pixels (inclusive). Returns formats with height >= this value."
+    },
+    "is_responsive": {
+      "type": "boolean",
+      "description": "Filter for responsive formats that adapt to container size. When true, returns formats without fixed dimensions."
+    },
+    "name_search": {
+      "type": "string",
+      "description": "Search for formats by name (case-insensitive partial match)"
+    },
+    "context": {
+      "$ref": "/schemas/core/context.json"
+    },
+    "ext": {
+      "$ref": "/schemas/core/ext.json"
+    }
+  },
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/creative/list-creative-formats-response.json

@@ -0,0 +1,61 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/creative/list-creative-formats-response.json",
+  "title": "List Creative Formats Response (Creative Agent)",
+  "description": "Response payload for list_creative_formats task from creative agent - returns full format definitions",
+  "type": "object",
+  "properties": {
+    "formats": {
+      "type": "array",
+      "description": "Full format definitions for all formats this agent supports. Each format's authoritative source is indicated by its agent_url field.",
+      "items": {
+        "$ref": "/schemas/core/format.json"
+      }
+    },
+    "creative_agents": {
+      "type": "array",
+      "description": "Optional: Creative agents that provide additional formats. Buyers can recursively query these agents to discover more formats. No authentication required for list_creative_formats.",
+      "items": {
+        "type": "object",
+        "properties": {
+          "agent_url": {
+            "type": "string",
+            "format": "uri",
+            "description": "Base URL for the creative agent (e.g., 'https://reference.adcp.org', 'https://dco.example.com'). Call list_creative_formats on this URL to get its formats."
+          },
+          "agent_name": {
+            "type": "string",
+            "description": "Human-readable name for the creative agent"
+          },
+          "capabilities": {
+            "type": "array",
+            "description": "Capabilities this creative agent provides",
+            "items": {
+              "$ref": "/schemas/enums/creative-agent-capability.json"
+            }
+          }
+        },
+        "required": [
+          "agent_url"
+        ]
+      }
+    },
+    "errors": {
+      "type": "array",
+      "description": "Task-specific errors and warnings",
+      "items": {
+        "$ref": "/schemas/core/error.json"
+      }
+    },
+    "context": {
+      "$ref": "/schemas/core/context.json"
+    },
+    "ext": {
+      "$ref": "/schemas/core/ext.json"
+    }
+  },
+  "required": [
+    "formats"
+  ],
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/creative/preview-creative-request.json

@@ -0,0 +1,164 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/creative/preview-creative-request.json",
+  "title": "Preview Creative Request",
+  "description": "Request to generate previews of one or more creative manifests. Accepts either a single creative request or an array of requests for batch processing.",
+  "oneOf": [
+    {
+      "type": "object",
+      "description": "Single creative preview request",
+      "properties": {
+        "request_type": {
+          "type": "string",
+          "const": "single",
+          "description": "Discriminator indicating this is a single preview request"
+        },
+        "format_id": {
+          "$ref": "/schemas/core/format-id.json",
+          "description": "Format identifier for rendering the preview"
+        },
+        "creative_manifest": {
+          "$ref": "/schemas/core/creative-manifest.json",
+          "description": "Complete creative manifest with all required assets (including promoted_offerings if required by the format)"
+        },
+        "inputs": {
+          "type": "array",
+          "description": "Array of input sets for generating multiple preview variants. Each input set defines macros and context values for one preview rendering. If not provided, creative agent will generate default previews.",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "Human-readable name for this input set (e.g., 'Sunny morning on mobile', 'Evening podcast ad', 'Desktop dark mode')"
+              },
+              "macros": {
+                "type": "object",
+                "description": "Macro values to use for this preview. Supports all universal macros from the format's supported_macros list. See docs/creative/universal-macros.md for available macros.",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "context_description": {
+                "type": "string",
+                "description": "Natural language description of the context for AI-generated content (e.g., 'User just searched for running shoes', 'Podcast discussing weather patterns', 'Article about electric vehicles')"
+              }
+            },
+            "required": [
+              "name"
+            ],
+            "additionalProperties": true
+          }
+        },
+        "template_id": {
+          "type": "string",
+          "description": "Specific template ID for custom format rendering"
+        },
+        "output_format": {
+          "$ref": "/schemas/enums/preview-output-format.json",
+          "default": "url",
+          "description": "Output format for previews. 'url' returns preview_url (iframe-embeddable URL), 'html' returns preview_html (raw HTML for direct embedding). Default: 'url' for backward compatibility."
+        },
+        "context": {
+          "$ref": "/schemas/core/context.json"
+        },
+        "ext": {
+          "$ref": "/schemas/core/ext.json"
+        }
+      },
+      "required": [
+        "request_type",
+        "format_id",
+        "creative_manifest"
+      ],
+      "additionalProperties": true
+    },
+    {
+      "type": "object",
+      "description": "Batch preview request for multiple creatives (5-10x faster than individual calls)",
+      "properties": {
+        "request_type": {
+          "type": "string",
+          "const": "batch",
+          "description": "Discriminator indicating this is a batch preview request"
+        },
+        "requests": {
+          "type": "array",
+          "description": "Array of preview requests (1-50 items). Each follows the single request structure.",
+          "items": {
+            "type": "object",
+            "properties": {
+              "format_id": {
+                "$ref": "/schemas/core/format-id.json",
+                "description": "Format identifier for rendering the preview"
+              },
+              "creative_manifest": {
+                "$ref": "/schemas/core/creative-manifest.json",
+                "description": "Complete creative manifest with all required assets"
+              },
+              "inputs": {
+                "type": "array",
+                "description": "Array of input sets for generating multiple preview variants",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "name": {
+                      "type": "string",
+                      "description": "Human-readable name for this input set"
+                    },
+                    "macros": {
+                      "type": "object",
+                      "description": "Macro values to use for this preview",
+                      "additionalProperties": {
+                        "type": "string"
+                      }
+                    },
+                    "context_description": {
+                      "type": "string",
+                      "description": "Natural language description of the context for AI-generated content"
+                    }
+                  },
+                  "required": [
+                    "name"
+                  ],
+                  "additionalProperties": true
+                }
+              },
+              "template_id": {
+                "type": "string",
+                "description": "Specific template ID for custom format rendering"
+              },
+              "output_format": {
+                "$ref": "/schemas/enums/preview-output-format.json",
+                "default": "url",
+                "description": "Output format for this preview. 'url' returns preview_url, 'html' returns preview_html."
+              }
+            },
+            "required": [
+              "format_id",
+              "creative_manifest"
+            ],
+            "additionalProperties": true
+          },
+          "minItems": 1,
+          "maxItems": 50
+        },
+        "output_format": {
+          "$ref": "/schemas/enums/preview-output-format.json",
+          "default": "url",
+          "description": "Default output format for all requests in this batch. Individual requests can override this. 'url' returns preview_url (iframe-embeddable URL), 'html' returns preview_html (raw HTML for direct embedding)."
+        },
+        "context": {
+          "$ref": "/schemas/core/context.json"
+        },
+        "ext": {
+          "$ref": "/schemas/core/ext.json"
+        }
+      },
+      "required": [
+        "request_type",
+        "requests"
+      ],
+      "additionalProperties": true
+    }
+  ]
+}

package/dist/lib/schemas-data/v2.5/creative/preview-creative-response.json

@@ -0,0 +1,245 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/creative/preview-creative-response.json",
+  "title": "Preview Creative Response",
+  "description": "Response containing preview links for one or more creatives. Format matches the request: single preview response for single requests, batch results for batch requests.",
+  "oneOf": [
+    {
+      "title": "PreviewCreativeSingleResponse",
+      "type": "object",
+      "description": "Single preview response - each preview URL returns an HTML page that can be embedded in an iframe",
+      "properties": {
+        "response_type": {
+          "type": "string",
+          "const": "single",
+          "description": "Discriminator indicating this is a single preview response"
+        },
+        "previews": {
+          "type": "array",
+          "description": "Array of preview variants. Each preview corresponds to an input set from the request. If no inputs were provided, returns a single default preview.",
+          "items": {
+            "type": "object",
+            "properties": {
+              "preview_id": {
+                "type": "string",
+                "description": "Unique identifier for this preview variant"
+              },
+              "renders": {
+                "type": "array",
+                "description": "Array of rendered pieces for this preview variant. Most formats render as a single piece. Companion ad formats (video + banner), multi-placement formats, and adaptive formats render as multiple pieces.",
+                "items": {
+                  "$ref": "/schemas/creative/preview-render.json"
+                },
+                "minItems": 1
+              },
+              "input": {
+                "type": "object",
+                "description": "The input parameters that generated this preview variant. Echoes back the request input or shows defaults used.",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "Human-readable name for this variant"
+                  },
+                  "macros": {
+                    "type": "object",
+                    "description": "Macro values applied to this variant",
+                    "additionalProperties": {
+                      "type": "string"
+                    }
+                  },
+                  "context_description": {
+                    "type": "string",
+                    "description": "Context description applied to this variant"
+                  }
+                },
+                "required": [
+                  "name"
+                ]
+              }
+            },
+            "required": [
+              "preview_id",
+              "renders",
+              "input"
+            ]
+          },
+          "minItems": 1
+        },
+        "interactive_url": {
+          "type": "string",
+          "format": "uri",
+          "description": "Optional URL to an interactive testing page that shows all preview variants with controls to switch between them, modify macro values, and test different scenarios."
+        },
+        "expires_at": {
+          "type": "string",
+          "format": "date-time",
+          "description": "ISO 8601 timestamp when preview links expire"
+        },
+        "context": {
+          "$ref": "/schemas/core/context.json"
+        },
+        "ext": {
+          "$ref": "/schemas/core/ext.json"
+        }
+      },
+      "required": [
+        "response_type",
+        "previews",
+        "expires_at"
+      ],
+      "additionalProperties": true
+    },
+    {
+      "title": "PreviewCreativeBatchResponse",
+      "type": "object",
+      "description": "Batch preview response - contains results for multiple creative requests",
+      "properties": {
+        "response_type": {
+          "type": "string",
+          "const": "batch",
+          "description": "Discriminator indicating this is a batch preview response"
+        },
+        "results": {
+          "type": "array",
+          "description": "Array of preview results corresponding to each request in the same order. results[0] is the result for requests[0], results[1] for requests[1], etc. Order is guaranteed even when some requests fail. Each result contains either a successful preview response or an error.",
+          "items": {
+            "type": "object",
+            "properties": {
+              "success": {
+                "type": "boolean",
+                "description": "Whether this preview request succeeded"
+              },
+              "response": {
+                "type": "object",
+                "description": "Preview response for successful requests",
+                "properties": {
+                  "previews": {
+                    "type": "array",
+                    "description": "Array of preview variants for this creative",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "preview_id": {
+                          "type": "string"
+                        },
+                        "renders": {
+                          "type": "array",
+                          "items": {
+                            "$ref": "/schemas/creative/preview-render.json"
+                          },
+                          "minItems": 1
+                        },
+                        "input": {
+                          "type": "object",
+                          "properties": {
+                            "name": {
+                              "type": "string"
+                            },
+                            "macros": {
+                              "type": "object",
+                              "additionalProperties": {
+                                "type": "string"
+                              }
+                            },
+                            "context_description": {
+                              "type": "string"
+                            }
+                          },
+                          "required": [
+                            "name"
+                          ]
+                        }
+                      },
+                      "required": [
+                        "preview_id",
+                        "renders",
+                        "input"
+                      ]
+                    },
+                    "minItems": 1
+                  },
+                  "interactive_url": {
+                    "type": "string",
+                    "format": "uri"
+                  },
+                  "expires_at": {
+                    "type": "string",
+                    "format": "date-time"
+                  }
+                },
+                "required": [
+                  "previews",
+                  "expires_at"
+                ]
+              },
+              "error": {
+                "type": "object",
+                "description": "Error information for failed requests",
+                "properties": {
+                  "code": {
+                    "type": "string",
+                    "description": "Error code (e.g., 'invalid_manifest', 'unsupported_format', 'missing_assets')"
+                  },
+                  "message": {
+                    "type": "string",
+                    "description": "Human-readable error message"
+                  },
+                  "details": {
+                    "type": "object",
+                    "description": "Additional error context",
+                    "additionalProperties": true
+                  }
+                },
+                "required": [
+                  "code",
+                  "message"
+                ]
+              }
+            },
+            "required": [
+              "success"
+            ],
+            "oneOf": [
+              {
+                "title": "PreviewBatchResultSuccess",
+                "properties": {
+                  "success": {
+                    "type": "boolean",
+                    "const": true
+                  }
+                },
+                "required": [
+                  "response"
+                ]
+              },
+              {
+                "title": "PreviewBatchResultError",
+                "properties": {
+                  "success": {
+                    "type": "boolean",
+                    "const": false
+                  }
+                },
+                "required": [
+                  "error"
+                ]
+              }
+            ]
+          },
+          "minItems": 1
+        },
+        "context": {
+          "$ref": "/schemas/core/context.json"
+        },
+        "ext": {
+          "$ref": "/schemas/core/ext.json"
+        }
+      },
+      "required": [
+        "response_type",
+        "results"
+      ],
+      "additionalProperties": true
+    }
+  ]
+}