@adcp/sdk 5.25.1 → 6.1.0

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

@@ -0,0 +1,225 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/creative/preview-render.json",
+  "title": "Preview Render",
+  "description": "A single rendered piece of a creative preview with discriminated output format",
+  "oneOf": [
+    {
+      "type": "object",
+      "description": "URL-only preview format",
+      "properties": {
+        "render_id": {
+          "type": "string",
+          "description": "Unique identifier for this rendered piece within the variant"
+        },
+        "output_format": {
+          "type": "string",
+          "const": "url",
+          "description": "Discriminator indicating preview_url is provided"
+        },
+        "preview_url": {
+          "type": "string",
+          "format": "uri",
+          "description": "URL to an HTML page that renders this piece. Can be embedded in an iframe."
+        },
+        "role": {
+          "type": "string",
+          "description": "Semantic role of this rendered piece. Use 'primary' for main content, 'companion' for associated banners, descriptive strings for device variants or custom roles."
+        },
+        "dimensions": {
+          "type": "object",
+          "description": "Dimensions for this rendered piece",
+          "properties": {
+            "width": {
+              "type": "number",
+              "minimum": 0
+            },
+            "height": {
+              "type": "number",
+              "minimum": 0
+            }
+          },
+          "required": [
+            "width",
+            "height"
+          ]
+        },
+        "embedding": {
+          "type": "object",
+          "description": "Optional security and embedding metadata for safe iframe integration",
+          "properties": {
+            "recommended_sandbox": {
+              "type": "string",
+              "description": "Recommended iframe sandbox attribute value (e.g., 'allow-scripts allow-same-origin')"
+            },
+            "requires_https": {
+              "type": "boolean",
+              "description": "Whether this output requires HTTPS for secure embedding"
+            },
+            "supports_fullscreen": {
+              "type": "boolean",
+              "description": "Whether this output supports fullscreen mode"
+            },
+            "csp_policy": {
+              "type": "string",
+              "description": "Content Security Policy requirements for embedding"
+            }
+          }
+        }
+      },
+      "required": [
+        "render_id",
+        "output_format",
+        "preview_url",
+        "role"
+      ],
+      "additionalProperties": true
+    },
+    {
+      "type": "object",
+      "description": "HTML-only preview format",
+      "properties": {
+        "render_id": {
+          "type": "string",
+          "description": "Unique identifier for this rendered piece within the variant"
+        },
+        "output_format": {
+          "type": "string",
+          "const": "html",
+          "description": "Discriminator indicating preview_html is provided"
+        },
+        "preview_html": {
+          "type": "string",
+          "description": "Raw HTML for this rendered piece. Can be embedded directly in the page without iframe. Security warning: Only use with trusted creative agents as this bypasses iframe sandboxing."
+        },
+        "role": {
+          "type": "string",
+          "description": "Semantic role of this rendered piece. Use 'primary' for main content, 'companion' for associated banners, descriptive strings for device variants or custom roles."
+        },
+        "dimensions": {
+          "type": "object",
+          "description": "Dimensions for this rendered piece",
+          "properties": {
+            "width": {
+              "type": "number",
+              "minimum": 0
+            },
+            "height": {
+              "type": "number",
+              "minimum": 0
+            }
+          },
+          "required": [
+            "width",
+            "height"
+          ]
+        },
+        "embedding": {
+          "type": "object",
+          "description": "Optional security and embedding metadata",
+          "properties": {
+            "recommended_sandbox": {
+              "type": "string",
+              "description": "Recommended iframe sandbox attribute value (e.g., 'allow-scripts allow-same-origin')"
+            },
+            "requires_https": {
+              "type": "boolean",
+              "description": "Whether this output requires HTTPS for secure embedding"
+            },
+            "supports_fullscreen": {
+              "type": "boolean",
+              "description": "Whether this output supports fullscreen mode"
+            },
+            "csp_policy": {
+              "type": "string",
+              "description": "Content Security Policy requirements for embedding"
+            }
+          }
+        }
+      },
+      "required": [
+        "render_id",
+        "output_format",
+        "preview_html",
+        "role"
+      ],
+      "additionalProperties": true
+    },
+    {
+      "type": "object",
+      "description": "Both URL and HTML preview format",
+      "properties": {
+        "render_id": {
+          "type": "string",
+          "description": "Unique identifier for this rendered piece within the variant"
+        },
+        "output_format": {
+          "type": "string",
+          "const": "both",
+          "description": "Discriminator indicating both preview_url and preview_html are provided"
+        },
+        "preview_url": {
+          "type": "string",
+          "format": "uri",
+          "description": "URL to an HTML page that renders this piece. Can be embedded in an iframe."
+        },
+        "preview_html": {
+          "type": "string",
+          "description": "Raw HTML for this rendered piece. Can be embedded directly in the page without iframe. Security warning: Only use with trusted creative agents as this bypasses iframe sandboxing."
+        },
+        "role": {
+          "type": "string",
+          "description": "Semantic role of this rendered piece. Use 'primary' for main content, 'companion' for associated banners, descriptive strings for device variants or custom roles."
+        },
+        "dimensions": {
+          "type": "object",
+          "description": "Dimensions for this rendered piece",
+          "properties": {
+            "width": {
+              "type": "number",
+              "minimum": 0
+            },
+            "height": {
+              "type": "number",
+              "minimum": 0
+            }
+          },
+          "required": [
+            "width",
+            "height"
+          ]
+        },
+        "embedding": {
+          "type": "object",
+          "description": "Optional security and embedding metadata for safe iframe integration",
+          "properties": {
+            "recommended_sandbox": {
+              "type": "string",
+              "description": "Recommended iframe sandbox attribute value (e.g., 'allow-scripts allow-same-origin')"
+            },
+            "requires_https": {
+              "type": "boolean",
+              "description": "Whether this output requires HTTPS for secure embedding"
+            },
+            "supports_fullscreen": {
+              "type": "boolean",
+              "description": "Whether this output supports fullscreen mode"
+            },
+            "csp_policy": {
+              "type": "string",
+              "description": "Content Security Policy requirements for embedding"
+            }
+          }
+        }
+      },
+      "required": [
+        "render_id",
+        "output_format",
+        "preview_url",
+        "preview_html",
+        "role"
+      ],
+      "additionalProperties": true
+    }
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/adcp-domain.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/adcp-domain.json",
+  "title": "AdCP Domain",
+  "description": "AdCP protocol domains for task categorization",
+  "type": "string",
+  "enum": [
+    "media-buy",
+    "signals"
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/asset-content-type.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/asset-content-type.json",
+  "title": "Asset Content Type",
+  "description": "Types of content that can be used as creative assets. Describes what KIND of content an asset contains (image, video, code, etc.), not where it displays.",
+  "type": "string",
+  "enum": [
+    "image",
+    "video",
+    "audio",
+    "text",
+    "markdown",
+    "html",
+    "css",
+    "javascript",
+    "vast",
+    "daast",
+    "promoted_offerings",
+    "url",
+    "webhook"
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/auth-scheme.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/auth-scheme.json",
+  "title": "Authentication Scheme",
+  "description": "Authentication schemes for push notification endpoints",
+  "type": "string",
+  "enum": [
+    "Bearer",
+    "HMAC-SHA256"
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/available-metric.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/available-metric.json",
+  "title": "Available Metric",
+  "description": "Standard delivery and performance metrics available for reporting",
+  "type": "string",
+  "enum": [
+    "impressions",
+    "spend",
+    "clicks",
+    "ctr",
+    "video_completions",
+    "completion_rate",
+    "conversions",
+    "viewability",
+    "engagement_rate"
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/channels.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/channels.json",
+  "title": "Advertising Channels",
+  "description": "Standard advertising channels supported by AdCP",
+  "type": "string",
+  "enum": [
+    "display",
+    "video",
+    "audio",
+    "native",
+    "dooh",
+    "ctv",
+    "podcast",
+    "retail",
+    "social"
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/co-branding-requirement.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/co-branding-requirement.json",
+  "title": "Co-Branding Requirement",
+  "description": "Co-branding policy for creatives (retailer/publisher brand inclusion)",
+  "type": "string",
+  "enum": [
+    "required",
+    "optional",
+    "none"
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/creative-action.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/creative-action.json",
+  "title": "Creative Action",
+  "description": "Action taken on a creative during sync operation",
+  "type": "string",
+  "enum": [
+    "created",
+    "updated",
+    "unchanged",
+    "failed",
+    "deleted"
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/creative-agent-capability.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/creative-agent-capability.json",
+  "title": "Creative Agent Capability",
+  "description": "Capabilities supported by creative agents for format handling",
+  "type": "string",
+  "enum": [
+    "validation",
+    "assembly",
+    "generation",
+    "preview"
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/creative-sort-field.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/creative-sort-field.json",
+  "title": "Creative Sort Field",
+  "description": "Fields available for sorting creative library listings",
+  "type": "string",
+  "enum": [
+    "created_date",
+    "updated_date",
+    "name",
+    "status",
+    "assignment_count",
+    "performance_score"
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/creative-status.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/creative-status.json",
+  "title": "Creative Status",
+  "description": "Status of a creative asset",
+  "type": "string",
+  "enum": [
+    "processing",
+    "approved",
+    "rejected",
+    "pending_review"
+  ],
+  "enumDescriptions": {
+    "processing": "Creative is being processed or transcoded",
+    "approved": "Creative has been approved and is ready for delivery",
+    "rejected": "Creative has been rejected due to policy or technical issues",
+    "pending_review": "Creative is under review"
+  }
+}

package/dist/lib/schemas-data/v2.5/enums/daast-tracking-event.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/daast-tracking-event.json",
+  "title": "DAAST Tracking Event",
+  "description": "Standard DAAST tracking events for audio ad playback and interaction",
+  "type": "string",
+  "enum": [
+    "start",
+    "firstQuartile",
+    "midpoint",
+    "thirdQuartile",
+    "complete",
+    "impression",
+    "pause",
+    "resume",
+    "skip",
+    "mute",
+    "unmute"
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/daast-version.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/daast-version.json",
+  "title": "DAAST Version",
+  "description": "Supported DAAST (Digital Audio Ad Serving Template) specification versions",
+  "type": "string",
+  "enum": [
+    "1.0",
+    "1.1"
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/delivery-type.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/delivery-type.json",
+  "title": "Delivery Type",
+  "description": "Type of inventory delivery",
+  "type": "string",
+  "enum": [
+    "guaranteed",
+    "non_guaranteed"
+  ],
+  "enumDescriptions": {
+    "guaranteed": "Reserved inventory with guaranteed delivery",
+    "non_guaranteed": "Auction-based inventory without delivery guarantees"
+  }
+}

package/dist/lib/schemas-data/v2.5/enums/dimension-unit.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/dimension-unit.json",
+  "title": "Dimension Unit",
+  "description": "Units of measurement for creative format dimensions",
+  "type": "string",
+  "enum": [
+    "px",
+    "dp",
+    "inches",
+    "cm"
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/feed-format.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/feed-format.json",
+  "title": "Feed Format",
+  "description": "Product catalog feed format types",
+  "type": "string",
+  "enum": [
+    "google_merchant_center",
+    "facebook_catalog",
+    "custom"
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/feedback-source.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/feedback-source.json",
+  "title": "Feedback Source",
+  "description": "Source of performance feedback data",
+  "type": "string",
+  "enum": [
+    "buyer_attribution",
+    "third_party_measurement",
+    "platform_analytics",
+    "verification_partner"
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/format-category.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/format-category.json",
+  "title": "Format Category",
+  "description": "High-level categories for creative formats based on media type and delivery channel. Describes WHERE and HOW a creative displays, not what content it contains.",
+  "type": "string",
+  "enum": [
+    "audio",
+    "video",
+    "display",
+    "native",
+    "dooh",
+    "rich_media",
+    "universal"
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/format-id-parameter.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/format-id-parameter.json",
+  "title": "Format ID Parameter",
+  "description": "Types of parameters that template formats accept in format_id objects to create parameterized format identifiers",
+  "type": "string",
+  "enum": [
+    "dimensions",
+    "duration"
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/frequency-cap-scope.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/frequency-cap-scope.json",
+  "title": "Frequency Cap Scope",
+  "description": "Scope for frequency cap application",
+  "type": "string",
+  "enum": [
+    "package"
+  ],
+  "enumDescriptions": {
+    "package": "Apply frequency cap at the package level"
+  }
+}

package/dist/lib/schemas-data/v2.5/enums/history-entry-type.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/history-entry-type.json",
+  "title": "History Entry Type",
+  "description": "Type of entry in task execution history",
+  "type": "string",
+  "enum": [
+    "request",
+    "response"
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/http-method.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/http-method.json",
+  "title": "HTTP Method",
+  "description": "HTTP methods supported for webhook requests",
+  "type": "string",
+  "enum": [
+    "GET",
+    "POST"
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/identifier-types.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/identifier-types.json",
+  "title": "Property Identifier Types",
+  "description": "Valid identifier types for property identification across different media types",
+  "type": "string",
+  "enum": [
+    "domain",
+    "subdomain",
+    "network_id",
+    "ios_bundle",
+    "android_package",
+    "apple_app_store_id",
+    "google_play_id",
+    "roku_store_id",
+    "fire_tv_asin",
+    "samsung_app_id",
+    "apple_tv_bundle",
+    "bundle_id",
+    "venue_id",
+    "screen_id",
+    "openooh_venue_type",
+    "rss_url",
+    "apple_podcast_id",
+    "spotify_show_id",
+    "podcast_guid"
+  ],
+  "examples": [
+    "domain",
+    "ios_bundle",
+    "venue_id",
+    "apple_podcast_id"
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/javascript-module-type.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/javascript-module-type.json",
+  "title": "JavaScript Module Type",
+  "description": "JavaScript module format types for creative assets",
+  "type": "string",
+  "enum": [
+    "esm",
+    "commonjs",
+    "script"
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/landing-page-requirement.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/landing-page-requirement.json",
+  "title": "Landing Page Requirement",
+  "description": "Landing page policy for creative click-through destinations",
+  "type": "string",
+  "enum": [
+    "any",
+    "retailer_site_only",
+    "must_include_retailer"
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/markdown-flavor.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/markdown-flavor.json",
+  "title": "Markdown Flavor",
+  "description": "Markdown specification flavors supported for text assets",
+  "type": "string",
+  "enum": [
+    "commonmark",
+    "gfm"
+  ]
+}

package/dist/lib/schemas-data/v2.5/enums/media-buy-status.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/enums/media-buy-status.json",
+  "title": "Media Buy Status",
+  "description": "Status of a media buy",
+  "type": "string",
+  "enum": [
+    "pending_activation",
+    "active",
+    "paused",
+    "completed"
+  ],
+  "enumDescriptions": {
+    "pending_activation": "Media buy created but not yet activated",
+    "active": "Media buy is currently running",
+    "paused": "Media buy is temporarily paused",
+    "completed": "Media buy has finished running"
+  }
+}