@adcp/sdk 5.25.1 → 6.1.0

package/dist/lib/schemas-data/v2.5/pricing-options/flat-rate-option.json

@@ -0,0 +1,93 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/pricing-options/flat-rate-option.json",
+  "title": "Flat Rate Pricing Option",
+  "description": "Flat rate pricing for DOOH, sponsorships, and time-based campaigns - fixed cost regardless of delivery volume",
+  "type": "object",
+  "properties": {
+    "pricing_option_id": {
+      "type": "string",
+      "description": "Unique identifier for this pricing option within the product (e.g., 'flat_rate_usd_24h_takeover')"
+    },
+    "pricing_model": {
+      "type": "string",
+      "const": "flat_rate",
+      "description": "Fixed cost regardless of delivery volume"
+    },
+    "rate": {
+      "type": "number",
+      "description": "Flat rate cost",
+      "minimum": 0
+    },
+    "currency": {
+      "type": "string",
+      "description": "ISO 4217 currency code",
+      "pattern": "^[A-Z]{3}$",
+      "examples": [
+        "USD",
+        "EUR",
+        "GBP",
+        "JPY"
+      ]
+    },
+    "is_fixed": {
+      "type": "boolean",
+      "description": "Whether this is a fixed rate (true) or auction-based (false)",
+      "const": true
+    },
+    "parameters": {
+      "type": "object",
+      "description": "Flat rate parameters for DOOH and time-based campaigns",
+      "properties": {
+        "duration_hours": {
+          "type": "number",
+          "description": "Duration in hours for time-based flat rate pricing (DOOH)",
+          "minimum": 0
+        },
+        "sov_percentage": {
+          "type": "number",
+          "description": "Guaranteed share of voice as percentage (DOOH, 0-100)",
+          "minimum": 0,
+          "maximum": 100
+        },
+        "loop_duration_seconds": {
+          "type": "integer",
+          "description": "Duration of ad loop rotation in seconds (DOOH)",
+          "minimum": 1
+        },
+        "min_plays_per_hour": {
+          "type": "integer",
+          "description": "Minimum number of times ad plays per hour (DOOH frequency guarantee)",
+          "minimum": 0
+        },
+        "venue_package": {
+          "type": "string",
+          "description": "Named venue package identifier for DOOH (e.g., 'times_square_network', 'airport_terminals')"
+        },
+        "estimated_impressions": {
+          "type": "integer",
+          "description": "Estimated impressions for this flat rate option (informational, commonly used with SOV or time-based DOOH)",
+          "minimum": 0
+        },
+        "daypart": {
+          "type": "string",
+          "description": "Specific daypart for time-based pricing (e.g., 'morning_commute', 'evening_prime', 'overnight')"
+        }
+      },
+      "additionalProperties": true
+    },
+    "min_spend_per_package": {
+      "type": "number",
+      "description": "Minimum spend requirement per package using this pricing option, in the specified currency",
+      "minimum": 0
+    }
+  },
+  "required": [
+    "pricing_option_id",
+    "pricing_model",
+    "currency",
+    "is_fixed",
+    "rate"
+  ],
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/pricing-options/vcpm-auction-option.json

@@ -0,0 +1,81 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/pricing-options/vcpm-auction-option.json",
+  "title": "vCPM Auction Pricing Option",
+  "description": "Viewable Cost Per Mille (cost per 1,000 viewable impressions) with auction-based pricing - impressions meeting MRC viewability standard (50% pixels in-view for 1 second for display, 2 seconds for video)",
+  "type": "object",
+  "properties": {
+    "pricing_option_id": {
+      "type": "string",
+      "description": "Unique identifier for this pricing option within the product (e.g., 'vcpm_usd_auction')"
+    },
+    "pricing_model": {
+      "type": "string",
+      "const": "vcpm",
+      "description": "Cost per 1,000 viewable impressions (MRC standard)"
+    },
+    "currency": {
+      "type": "string",
+      "description": "ISO 4217 currency code",
+      "pattern": "^[A-Z]{3}$",
+      "examples": [
+        "USD",
+        "EUR",
+        "GBP",
+        "JPY"
+      ]
+    },
+    "is_fixed": {
+      "type": "boolean",
+      "description": "Whether this is a fixed rate (true) or auction-based (false)",
+      "const": false
+    },
+    "price_guidance": {
+      "type": "object",
+      "description": "Statistical guidance for auction pricing",
+      "properties": {
+        "floor": {
+          "type": "number",
+          "description": "Minimum acceptable bid price",
+          "minimum": 0
+        },
+        "p25": {
+          "type": "number",
+          "description": "25th percentile of recent winning bids",
+          "minimum": 0
+        },
+        "p50": {
+          "type": "number",
+          "description": "Median of recent winning bids",
+          "minimum": 0
+        },
+        "p75": {
+          "type": "number",
+          "description": "75th percentile of recent winning bids",
+          "minimum": 0
+        },
+        "p90": {
+          "type": "number",
+          "description": "90th percentile of recent winning bids",
+          "minimum": 0
+        }
+      },
+      "required": [
+        "floor"
+      ]
+    },
+    "min_spend_per_package": {
+      "type": "number",
+      "description": "Minimum spend requirement per package using this pricing option, in the specified currency",
+      "minimum": 0
+    }
+  },
+  "required": [
+    "pricing_option_id",
+    "pricing_model",
+    "currency",
+    "price_guidance",
+    "is_fixed"
+  ],
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/pricing-options/vcpm-fixed-option.json

@@ -0,0 +1,52 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/pricing-options/vcpm-fixed-option.json",
+  "title": "vCPM Fixed Rate Pricing Option",
+  "description": "Viewable Cost Per Mille (cost per 1,000 viewable impressions) with guaranteed fixed rate - impressions meeting MRC viewability standard (50% pixels in-view for 1 second for display, 2 seconds for video)",
+  "type": "object",
+  "properties": {
+    "pricing_option_id": {
+      "type": "string",
+      "description": "Unique identifier for this pricing option within the product (e.g., 'vcpm_usd_guaranteed')"
+    },
+    "pricing_model": {
+      "type": "string",
+      "const": "vcpm",
+      "description": "Cost per 1,000 viewable impressions (MRC standard)"
+    },
+    "rate": {
+      "type": "number",
+      "description": "Fixed vCPM rate (cost per 1,000 viewable impressions)",
+      "minimum": 0
+    },
+    "currency": {
+      "type": "string",
+      "description": "ISO 4217 currency code",
+      "pattern": "^[A-Z]{3}$",
+      "examples": [
+        "USD",
+        "EUR",
+        "GBP",
+        "JPY"
+      ]
+    },
+    "is_fixed": {
+      "type": "boolean",
+      "description": "Whether this is a fixed rate (true) or auction-based (false)",
+      "const": true
+    },
+    "min_spend_per_package": {
+      "type": "number",
+      "description": "Minimum spend requirement per package using this pricing option, in the specified currency",
+      "minimum": 0
+    }
+  },
+  "required": [
+    "pricing_option_id",
+    "pricing_model",
+    "rate",
+    "currency",
+    "is_fixed"
+  ],
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/protocols/adcp-extension.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/protocols/adcp-extension.json",
+  "title": "AdCP Agent Card Extension",
+  "description": "Extension metadata for agent cards (MCP and A2A) declaring AdCP version and supported protocol domains",
+  "type": "object",
+  "properties": {
+    "adcp_version": {
+      "type": "string",
+      "pattern": "^\\d+\\.\\d+\\.\\d+$",
+      "description": "Semantic version of the AdCP specification this agent implements (e.g., '2.4.0')"
+    },
+    "protocols_supported": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": [
+          "media_buy",
+          "creative",
+          "signals"
+        ]
+      },
+      "minItems": 1,
+      "uniqueItems": true,
+      "description": "AdCP protocol domains supported by this agent. At least one must be specified."
+    }
+  },
+  "required": [
+    "adcp_version",
+    "protocols_supported"
+  ],
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/signals/activate-signal-request.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/signals/activate-signal-request.json",
+  "title": "Activate Signal Request",
+  "description": "Request parameters for activating a signal on a specific deployment target",
+  "type": "object",
+  "properties": {
+    "signal_agent_segment_id": {
+      "type": "string",
+      "description": "The universal identifier for the signal to activate"
+    },
+    "deployments": {
+      "type": "array",
+      "description": "Target deployment(s) for activation. If the authenticated caller matches one of these deployment targets, activation keys will be included in the response.",
+      "items": {
+        "$ref": "/schemas/core/destination.json"
+      },
+      "minItems": 1
+    },
+    "context": {
+      "$ref": "/schemas/core/context.json"
+    },
+    "ext": {
+      "$ref": "/schemas/core/ext.json"
+    }
+  },
+  "required": [
+    "signal_agent_segment_id",
+    "deployments"
+  ],
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/signals/activate-signal-response.json

@@ -0,0 +1,68 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/signals/activate-signal-response.json",
+  "title": "Activate Signal Response",
+  "description": "Response payload for activate_signal task. Returns either complete success data OR error information, never both. This enforces atomic operation semantics - the signal is either fully activated or not activated at all.",
+  "type": "object",
+  "oneOf": [
+    {
+      "title": "ActivateSignalSuccess",
+      "description": "Success response - signal activated successfully to one or more deployment targets",
+      "type": "object",
+      "properties": {
+        "deployments": {
+          "type": "array",
+          "description": "Array of deployment results for each deployment target",
+          "items": {
+            "$ref": "/schemas/core/deployment.json"
+          }
+        },
+        "context": {
+          "$ref": "/schemas/core/context.json"
+        },
+        "ext": {
+          "$ref": "/schemas/core/ext.json"
+        }
+      },
+      "required": [
+        "deployments"
+      ],
+      "additionalProperties": true,
+      "not": {
+        "required": [
+          "errors"
+        ]
+      }
+    },
+    {
+      "title": "ActivateSignalError",
+      "description": "Error response - operation failed, signal not activated",
+      "type": "object",
+      "properties": {
+        "errors": {
+          "type": "array",
+          "description": "Array of errors explaining why activation failed (e.g., platform connectivity issues, signal definition problems, authentication failures)",
+          "items": {
+            "$ref": "/schemas/core/error.json"
+          },
+          "minItems": 1
+        },
+        "context": {
+          "$ref": "/schemas/core/context.json"
+        },
+        "ext": {
+          "$ref": "/schemas/core/ext.json"
+        }
+      },
+      "required": [
+        "errors"
+      ],
+      "additionalProperties": true,
+      "not": {
+        "required": [
+          "deployments"
+        ]
+      }
+    }
+  ]
+}

package/dist/lib/schemas-data/v2.5/signals/get-signals-request.json

@@ -0,0 +1,59 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/signals/get-signals-request.json",
+  "title": "Get Signals Request",
+  "description": "Request parameters for discovering signals based on description",
+  "type": "object",
+  "properties": {
+    "signal_spec": {
+      "type": "string",
+      "description": "Natural language description of the desired signals"
+    },
+    "deliver_to": {
+      "type": "object",
+      "description": "Deployment targets where signals need to be activated",
+      "properties": {
+        "deployments": {
+          "type": "array",
+          "description": "List of deployment targets (DSPs, sales agents, etc.). If the authenticated caller matches one of these deployment targets, activation keys will be included in the response.",
+          "items": {
+            "$ref": "/schemas/core/destination.json"
+          },
+          "minItems": 1
+        },
+        "countries": {
+          "type": "array",
+          "description": "Countries where signals will be used (ISO codes)",
+          "items": {
+            "type": "string",
+            "pattern": "^[A-Z]{2}$"
+          }
+        }
+      },
+      "required": [
+        "deployments",
+        "countries"
+      ],
+      "additionalProperties": true
+    },
+    "filters": {
+      "$ref": "/schemas/core/signal-filters.json"
+    },
+    "max_results": {
+      "type": "integer",
+      "description": "Maximum number of results to return",
+      "minimum": 1
+    },
+    "context": {
+      "$ref": "/schemas/core/context.json"
+    },
+    "ext": {
+      "$ref": "/schemas/core/ext.json"
+    }
+  },
+  "required": [
+    "signal_spec",
+    "deliver_to"
+  ],
+  "additionalProperties": true
+}

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

@@ -0,0 +1,100 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/signals/get-signals-response.json",
+  "title": "Get Signals Response",
+  "description": "Response payload for get_signals task",
+  "type": "object",
+  "properties": {
+    "signals": {
+      "type": "array",
+      "description": "Array of matching signals",
+      "items": {
+        "type": "object",
+        "properties": {
+          "signal_agent_segment_id": {
+            "type": "string",
+            "description": "Unique identifier for the signal"
+          },
+          "name": {
+            "type": "string",
+            "description": "Human-readable signal name"
+          },
+          "description": {
+            "type": "string",
+            "description": "Detailed signal description"
+          },
+          "signal_type": {
+            "$ref": "/schemas/enums/signal-catalog-type.json",
+            "description": "Type of signal"
+          },
+          "data_provider": {
+            "type": "string",
+            "description": "Name of the data provider"
+          },
+          "coverage_percentage": {
+            "type": "number",
+            "description": "Percentage of audience coverage",
+            "minimum": 0,
+            "maximum": 100
+          },
+          "deployments": {
+            "type": "array",
+            "description": "Array of deployment targets",
+            "items": {
+              "$ref": "/schemas/core/deployment.json"
+            }
+          },
+          "pricing": {
+            "type": "object",
+            "description": "Pricing information",
+            "properties": {
+              "cpm": {
+                "type": "number",
+                "description": "Cost per thousand impressions",
+                "minimum": 0
+              },
+              "currency": {
+                "type": "string",
+                "description": "Currency code",
+                "pattern": "^[A-Z]{3}$"
+              }
+            },
+            "required": [
+              "cpm",
+              "currency"
+            ],
+            "additionalProperties": true
+          }
+        },
+        "required": [
+          "signal_agent_segment_id",
+          "name",
+          "description",
+          "signal_type",
+          "data_provider",
+          "coverage_percentage",
+          "deployments",
+          "pricing"
+        ],
+        "additionalProperties": true
+      }
+    },
+    "errors": {
+      "type": "array",
+      "description": "Task-specific errors and warnings (e.g., signal discovery or pricing issues)",
+      "items": {
+        "$ref": "/schemas/core/error.json"
+      }
+    },
+    "context": {
+      "$ref": "/schemas/core/context.json"
+    },
+    "ext": {
+      "$ref": "/schemas/core/ext.json"
+    }
+  },
+  "required": [
+    "signals"
+  ],
+  "additionalProperties": true
+}