@adcp/sdk 5.25.1 → 6.1.0

package/dist/lib/schemas-data/v2.5/core/creative-manifest.json

@@ -0,0 +1,72 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/creative-manifest.json",
+  "title": "Creative Manifest",
+  "description": "Complete specification of a creative with all assets needed for rendering in a specific format. Each asset is typed according to its asset_role from the format specification and contains the actual content/URL that fulfills the format requirements.",
+  "type": "object",
+  "properties": {
+    "format_id": {
+      "$ref": "/schemas/core/format-id.json",
+      "description": "Format identifier this manifest is for. Can be a template format (id only) or a deterministic format (id + dimensions/duration). For dimension-specific creatives, include width/height/unit in the format_id to create a unique identifier (e.g., {id: 'display_static', width: 300, height: 250, unit: 'px'})."
+    },
+    "promoted_offering": {
+      "type": "string",
+      "description": "Product name or offering being advertised. Maps to promoted_offerings in create_media_buy request to associate creative with the product being promoted."
+    },
+    "assets": {
+      "type": "object",
+      "description": "Map of asset IDs to actual asset content. Each key MUST match an asset_id from the format's assets_required array (e.g., 'banner_image', 'clickthrough_url', 'video_file', 'vast_tag'). The asset_id is the technical identifier used to match assets to format requirements.\n\nIMPORTANT: Creative manifest validation MUST be performed in the context of the format specification. The format defines what type each asset_id should be, which eliminates any validation ambiguity.",
+      "patternProperties": {
+        "^[a-z0-9_]+$": {
+          "oneOf": [
+            {
+              "$ref": "/schemas/core/assets/image-asset.json"
+            },
+            {
+              "$ref": "/schemas/core/assets/video-asset.json"
+            },
+            {
+              "$ref": "/schemas/core/assets/audio-asset.json"
+            },
+            {
+              "$ref": "/schemas/core/assets/vast-asset.json"
+            },
+            {
+              "$ref": "/schemas/core/assets/text-asset.json"
+            },
+            {
+              "$ref": "/schemas/core/assets/url-asset.json"
+            },
+            {
+              "$ref": "/schemas/core/assets/html-asset.json"
+            },
+            {
+              "$ref": "/schemas/core/assets/javascript-asset.json"
+            },
+            {
+              "$ref": "/schemas/core/assets/webhook-asset.json"
+            },
+            {
+              "$ref": "/schemas/core/assets/css-asset.json"
+            },
+            {
+              "$ref": "/schemas/core/assets/daast-asset.json"
+            },
+            {
+              "$ref": "/schemas/core/promoted-offerings.json"
+            }
+          ]
+        }
+      },
+      "additionalProperties": true
+    },
+    "ext": {
+      "$ref": "/schemas/core/ext.json"
+    }
+  },
+  "required": [
+    "format_id",
+    "assets"
+  ],
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/core/creative-policy.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/creative-policy.json",
+  "title": "Creative Policy",
+  "description": "Creative requirements and restrictions for a product",
+  "type": "object",
+  "properties": {
+    "co_branding": {
+      "$ref": "/schemas/enums/co-branding-requirement.json",
+      "description": "Co-branding requirement"
+    },
+    "landing_page": {
+      "$ref": "/schemas/enums/landing-page-requirement.json",
+      "description": "Landing page requirements"
+    },
+    "templates_available": {
+      "type": "boolean",
+      "description": "Whether creative templates are provided"
+    }
+  },
+  "required": [
+    "co_branding",
+    "landing_page",
+    "templates_available"
+  ],
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/core/delivery-metrics.json

@@ -0,0 +1,171 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/delivery-metrics.json",
+  "title": "Delivery Metrics",
+  "description": "Standard delivery metrics that can be reported at media buy, package, or creative level",
+  "type": "object",
+  "properties": {
+    "impressions": {
+      "type": "number",
+      "description": "Impressions delivered",
+      "minimum": 0
+    },
+    "spend": {
+      "type": "number",
+      "description": "Amount spent",
+      "minimum": 0
+    },
+    "clicks": {
+      "type": "number",
+      "description": "Total clicks",
+      "minimum": 0
+    },
+    "ctr": {
+      "type": "number",
+      "description": "Click-through rate (clicks/impressions)",
+      "minimum": 0,
+      "maximum": 1
+    },
+    "views": {
+      "type": "number",
+      "description": "Views at threshold (for CPV)",
+      "minimum": 0
+    },
+    "completed_views": {
+      "type": "number",
+      "description": "100% completions (for CPCV)",
+      "minimum": 0
+    },
+    "completion_rate": {
+      "type": "number",
+      "description": "Completion rate (completed_views/impressions)",
+      "minimum": 0,
+      "maximum": 1
+    },
+    "conversions": {
+      "type": "number",
+      "description": "Conversions (reserved for future CPA pricing support)",
+      "minimum": 0
+    },
+    "leads": {
+      "type": "number",
+      "description": "Leads generated (reserved for future CPL pricing support)",
+      "minimum": 0
+    },
+    "grps": {
+      "type": "number",
+      "description": "Gross Rating Points delivered (for CPP)",
+      "minimum": 0
+    },
+    "reach": {
+      "type": "number",
+      "description": "Unique reach - units depend on measurement provider (e.g., individuals, households, devices, cookies). See delivery_measurement.provider for methodology.",
+      "minimum": 0
+    },
+    "frequency": {
+      "type": "number",
+      "description": "Average frequency per individual (typically measured over campaign duration, but can vary by measurement provider)",
+      "minimum": 0
+    },
+    "quartile_data": {
+      "type": "object",
+      "description": "Video quartile completion data",
+      "properties": {
+        "q1_views": {
+          "type": "number",
+          "description": "25% completion views",
+          "minimum": 0
+        },
+        "q2_views": {
+          "type": "number",
+          "description": "50% completion views",
+          "minimum": 0
+        },
+        "q3_views": {
+          "type": "number",
+          "description": "75% completion views",
+          "minimum": 0
+        },
+        "q4_views": {
+          "type": "number",
+          "description": "100% completion views",
+          "minimum": 0
+        }
+      }
+    },
+    "dooh_metrics": {
+      "type": "object",
+      "description": "DOOH-specific metrics (only included for DOOH campaigns)",
+      "properties": {
+        "loop_plays": {
+          "type": "integer",
+          "description": "Number of times ad played in rotation",
+          "minimum": 0
+        },
+        "screens_used": {
+          "type": "integer",
+          "description": "Number of unique screens displaying the ad",
+          "minimum": 0
+        },
+        "screen_time_seconds": {
+          "type": "integer",
+          "description": "Total display time in seconds",
+          "minimum": 0
+        },
+        "sov_achieved": {
+          "type": "number",
+          "description": "Actual share of voice delivered (0.0 to 1.0)",
+          "minimum": 0,
+          "maximum": 1
+        },
+        "calculation_notes": {
+          "type": "string",
+          "description": "Explanation of how DOOH impressions were calculated"
+        },
+        "venue_breakdown": {
+          "type": "array",
+          "description": "Per-venue performance breakdown",
+          "items": {
+            "type": "object",
+            "properties": {
+              "venue_id": {
+                "type": "string",
+                "description": "Venue identifier"
+              },
+              "venue_name": {
+                "type": "string",
+                "description": "Human-readable venue name"
+              },
+              "venue_type": {
+                "type": "string",
+                "description": "Venue type (e.g., 'airport', 'transit', 'retail', 'billboard')"
+              },
+              "impressions": {
+                "type": "integer",
+                "description": "Impressions delivered at this venue",
+                "minimum": 0
+              },
+              "loop_plays": {
+                "type": "integer",
+                "description": "Loop plays at this venue",
+                "minimum": 0
+              },
+              "screens_used": {
+                "type": "integer",
+                "description": "Number of screens used at this venue",
+                "minimum": 0
+              }
+            },
+            "required": [
+              "venue_id",
+              "impressions"
+            ],
+            "additionalProperties": true
+          }
+        }
+      },
+      "additionalProperties": true
+    }
+  },
+  "additionalProperties": true
+}

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

@@ -0,0 +1,93 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/deployment.json",
+  "title": "Deployment",
+  "description": "A signal deployment to a specific deployment target with activation status and key",
+  "oneOf": [
+    {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "platform",
+          "description": "Discriminator indicating this is a platform-based deployment"
+        },
+        "platform": {
+          "type": "string",
+          "description": "Platform identifier for DSPs"
+        },
+        "account": {
+          "type": "string",
+          "description": "Account identifier if applicable"
+        },
+        "is_live": {
+          "type": "boolean",
+          "description": "Whether signal is currently active on this deployment"
+        },
+        "activation_key": {
+          "$ref": "/schemas/core/activation-key.json",
+          "description": "The key to use for targeting. Only present if is_live=true AND requester has access to this deployment."
+        },
+        "estimated_activation_duration_minutes": {
+          "type": "number",
+          "description": "Estimated time to activate if not live, or to complete activation if in progress",
+          "minimum": 0
+        },
+        "deployed_at": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Timestamp when activation completed (if is_live=true)"
+        }
+      },
+      "required": [
+        "type",
+        "platform",
+        "is_live"
+      ],
+      "additionalProperties": true
+    },
+    {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "agent",
+          "description": "Discriminator indicating this is an agent URL-based deployment"
+        },
+        "agent_url": {
+          "type": "string",
+          "format": "uri",
+          "description": "URL identifying the deployment agent"
+        },
+        "account": {
+          "type": "string",
+          "description": "Account identifier if applicable"
+        },
+        "is_live": {
+          "type": "boolean",
+          "description": "Whether signal is currently active on this deployment"
+        },
+        "activation_key": {
+          "$ref": "/schemas/core/activation-key.json",
+          "description": "The key to use for targeting. Only present if is_live=true AND requester has access to this deployment."
+        },
+        "estimated_activation_duration_minutes": {
+          "type": "number",
+          "description": "Estimated time to activate if not live, or to complete activation if in progress",
+          "minimum": 0
+        },
+        "deployed_at": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Timestamp when activation completed (if is_live=true)"
+        }
+      },
+      "required": [
+        "type",
+        "agent_url",
+        "is_live"
+      ],
+      "additionalProperties": true
+    }
+  ]
+}

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

@@ -0,0 +1,53 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/destination.json",
+  "title": "Destination",
+  "description": "A deployment target where signals can be activated (DSP, sales agent, etc.)",
+  "oneOf": [
+    {
+      "type": "object",
+      "properties": {
+        "type": {
+          "const": "platform",
+          "description": "Discriminator indicating this is a platform-based deployment"
+        },
+        "platform": {
+          "type": "string",
+          "description": "Platform identifier for DSPs (e.g., 'the-trade-desk', 'amazon-dsp')"
+        },
+        "account": {
+          "type": "string",
+          "description": "Optional account identifier on the platform"
+        }
+      },
+      "required": [
+        "type",
+        "platform"
+      ],
+      "additionalProperties": true
+    },
+    {
+      "type": "object",
+      "properties": {
+        "type": {
+          "const": "agent",
+          "description": "Discriminator indicating this is an agent URL-based deployment"
+        },
+        "agent_url": {
+          "type": "string",
+          "format": "uri",
+          "description": "URL identifying the deployment agent (for sales agents, etc.)"
+        },
+        "account": {
+          "type": "string",
+          "description": "Optional account identifier on the agent"
+        }
+      },
+      "required": [
+        "type",
+        "agent_url"
+      ],
+      "additionalProperties": true
+    }
+  ]
+}

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

@@ -0,0 +1,40 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/error.json",
+  "title": "Error",
+  "description": "Standard error structure for task-specific errors and warnings",
+  "type": "object",
+  "properties": {
+    "code": {
+      "type": "string",
+      "description": "Error code for programmatic handling"
+    },
+    "message": {
+      "type": "string",
+      "description": "Human-readable error message"
+    },
+    "field": {
+      "type": "string",
+      "description": "Field path associated with the error (e.g., 'packages[0].targeting')"
+    },
+    "suggestion": {
+      "type": "string",
+      "description": "Suggested fix for the error"
+    },
+    "retry_after": {
+      "type": "number",
+      "description": "Seconds to wait before retrying the operation",
+      "minimum": 0
+    },
+    "details": {
+      "type": "object",
+      "description": "Additional task-specific error details",
+      "additionalProperties": true
+    }
+  },
+  "required": [
+    "code",
+    "message"
+  ],
+  "additionalProperties": true
+}

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

@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/ext.json",
+  "title": "Extension Object",
+  "description": "Extension object for platform-specific, vendor-namespaced parameters. Extensions are always optional and must be namespaced under a vendor/platform key (e.g., ext.gam, ext.roku). Used for custom capabilities, partner-specific configuration, and features being proposed for standardization.",
+  "type": "object",
+  "additionalProperties": true
+}

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

@@ -0,0 +1,47 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/format-id.json",
+  "title": "Format ID",
+  "description": "Structured format identifier with agent URL and format name. Can reference: (1) a concrete format with fixed dimensions (id only), (2) a template format without parameters (id only), or (3) a template format with parameters (id + dimensions/duration). Template formats accept parameters in format_id while concrete formats have fixed dimensions in their definition. Parameterized format IDs create unique, specific format variants.",
+  "type": "object",
+  "properties": {
+    "agent_url": {
+      "type": "string",
+      "format": "uri",
+      "description": "URL of the agent that defines this format (e.g., 'https://creatives.adcontextprotocol.org' for standard formats, or 'https://publisher.com/.well-known/adcp/sales' for custom formats)"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9_-]+$",
+      "description": "Format identifier within the agent's namespace (e.g., 'display_static', 'video_hosted', 'audio_standard'). When used alone, references a template format. When combined with dimension/duration fields, creates a parameterized format ID for a specific variant."
+    },
+    "width": {
+      "type": "integer",
+      "minimum": 1,
+      "description": "Width in pixels for visual formats. When specified, height must also be specified. Both fields together create a parameterized format ID for dimension-specific variants."
+    },
+    "height": {
+      "type": "integer",
+      "minimum": 1,
+      "description": "Height in pixels for visual formats. When specified, width must also be specified. Both fields together create a parameterized format ID for dimension-specific variants."
+    },
+    "duration_ms": {
+      "type": "number",
+      "minimum": 1,
+      "description": "Duration in milliseconds for time-based formats (video, audio). When specified, creates a parameterized format ID. Omit to reference a template format without parameters."
+    }
+  },
+  "required": [
+    "agent_url",
+    "id"
+  ],
+  "additionalProperties": true,
+  "dependencies": {
+    "width": [
+      "height"
+    ],
+    "height": [
+      "width"
+    ]
+  }
+}