@adcp/sdk 6.0.0 → 6.1.0

package/dist/lib/schemas-data/v2.5/media-buy/update-media-buy-request.json

@@ -0,0 +1,129 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/media-buy/update-media-buy-request.json",
+  "title": "Update Media Buy Request",
+  "description": "Request parameters for updating campaign and package settings",
+  "type": "object",
+  "properties": {
+    "media_buy_id": {
+      "type": "string",
+      "description": "Publisher's ID of the media buy to update"
+    },
+    "buyer_ref": {
+      "type": "string",
+      "description": "Buyer's reference for the media buy to update"
+    },
+    "paused": {
+      "type": "boolean",
+      "description": "Pause/resume the entire media buy (true = paused, false = active)"
+    },
+    "start_time": {
+      "$ref": "/schemas/core/start-timing.json"
+    },
+    "end_time": {
+      "type": "string",
+      "format": "date-time",
+      "description": "New end date/time in ISO 8601 format"
+    },
+    "packages": {
+      "type": "array",
+      "description": "Package-specific updates",
+      "items": {
+        "type": "object",
+        "properties": {
+          "package_id": {
+            "type": "string",
+            "description": "Publisher's ID of package to update"
+          },
+          "buyer_ref": {
+            "type": "string",
+            "description": "Buyer's reference for the package to update"
+          },
+          "budget": {
+            "type": "number",
+            "description": "Updated budget allocation for this package in the currency specified by the pricing option",
+            "minimum": 0
+          },
+          "pacing": {
+            "$ref": "/schemas/enums/pacing.json"
+          },
+          "bid_price": {
+            "type": "number",
+            "description": "Updated bid price for auction-based pricing options (only applies when pricing_option is auction-based)",
+            "minimum": 0
+          },
+          "impressions": {
+            "type": "number",
+            "description": "Updated impression goal for this package",
+            "minimum": 0
+          },
+          "paused": {
+            "type": "boolean",
+            "description": "Pause/resume specific package (true = paused, false = active)"
+          },
+          "targeting_overlay": {
+            "$ref": "/schemas/core/targeting.json"
+          },
+          "creative_ids": {
+            "type": "array",
+            "description": "Update creative assignments (references existing library creatives)",
+            "items": {
+              "type": "string"
+            }
+          },
+          "creatives": {
+            "type": "array",
+            "description": "Full creative objects to upload and assign to this package (alternative to creative_ids - creatives will be added to library). Supports both static and generative creatives.",
+            "items": {
+              "$ref": "/schemas/core/creative-asset.json"
+            },
+            "maxItems": 100
+          },
+          "creative_assignments": {
+            "type": "array",
+            "description": "Full creative assignment objects with weights and placement targeting (alternative to creative_ids - provides granular control over weights and placement targeting). Uses replacement semantics like creative_ids.",
+            "items": {
+              "$ref": "/schemas/core/creative-assignment.json"
+            }
+          }
+        },
+        "oneOf": [
+          {
+            "required": [
+              "package_id"
+            ]
+          },
+          {
+            "required": [
+              "buyer_ref"
+            ]
+          }
+        ],
+        "additionalProperties": true
+      }
+    },
+    "push_notification_config": {
+      "$ref": "/schemas/core/push-notification-config.json",
+      "description": "Optional webhook configuration for async update notifications. Publisher will send webhook when update completes if operation takes longer than immediate response time."
+    },
+    "context": {
+      "$ref": "/schemas/core/context.json"
+    },
+    "ext": {
+      "$ref": "/schemas/core/ext.json"
+    }
+  },
+  "oneOf": [
+    {
+      "required": [
+        "media_buy_id"
+      ]
+    },
+    {
+      "required": [
+        "buyer_ref"
+      ]
+    }
+  ],
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/media-buy/update-media-buy-response.json

@@ -0,0 +1,99 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/media-buy/update-media-buy-response.json",
+  "title": "Update Media Buy Response",
+  "description": "Response payload for update_media_buy task. Returns either complete success data OR error information, never both. This enforces atomic operation semantics - updates are either fully applied or not applied at all.",
+  "type": "object",
+  "oneOf": [
+    {
+      "title": "UpdateMediaBuySuccess",
+      "description": "Success response - media buy updated successfully",
+      "type": "object",
+      "properties": {
+        "media_buy_id": {
+          "type": "string",
+          "description": "Publisher's identifier for the media buy"
+        },
+        "buyer_ref": {
+          "type": "string",
+          "description": "Buyer's reference identifier for the media buy"
+        },
+        "implementation_date": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "format": "date-time",
+          "description": "ISO 8601 timestamp when changes take effect (null if pending approval)"
+        },
+        "affected_packages": {
+          "type": "array",
+          "description": "Array of packages that were modified with complete state information",
+          "items": {
+            "$ref": "/schemas/core/package.json"
+          }
+        },
+        "context": {
+          "$ref": "/schemas/core/context.json"
+        },
+        "ext": {
+          "$ref": "/schemas/core/ext.json"
+        }
+      },
+      "required": [
+        "media_buy_id",
+        "buyer_ref"
+      ],
+      "additionalProperties": true,
+      "not": {
+        "required": [
+          "errors"
+        ]
+      }
+    },
+    {
+      "title": "UpdateMediaBuyError",
+      "description": "Error response - operation failed, no changes applied",
+      "type": "object",
+      "properties": {
+        "errors": {
+          "type": "array",
+          "description": "Array of errors explaining why the operation failed",
+          "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": {
+        "anyOf": [
+          {
+            "required": [
+              "media_buy_id"
+            ]
+          },
+          {
+            "required": [
+              "buyer_ref"
+            ]
+          },
+          {
+            "required": [
+              "affected_packages"
+            ]
+          }
+        ]
+      }
+    }
+  ]
+}

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

@@ -0,0 +1,52 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/pricing-options/cpc-option.json",
+  "title": "CPC Pricing Option",
+  "description": "Cost Per Click fixed-rate pricing for performance-driven advertising campaigns",
+  "type": "object",
+  "properties": {
+    "pricing_option_id": {
+      "type": "string",
+      "description": "Unique identifier for this pricing option within the product (e.g., 'cpc_usd_fixed')"
+    },
+    "pricing_model": {
+      "type": "string",
+      "const": "cpc",
+      "description": "Cost per click"
+    },
+    "rate": {
+      "type": "number",
+      "description": "Fixed CPC rate (cost per click)",
+      "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/pricing-options/cpcv-option.json

@@ -0,0 +1,52 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/pricing-options/cpcv-option.json",
+  "title": "CPCV Pricing Option",
+  "description": "Cost Per Completed View (100% video/audio completion) fixed-rate pricing",
+  "type": "object",
+  "properties": {
+    "pricing_option_id": {
+      "type": "string",
+      "description": "Unique identifier for this pricing option within the product (e.g., 'cpcv_usd_guaranteed')"
+    },
+    "pricing_model": {
+      "type": "string",
+      "const": "cpcv",
+      "description": "Cost per completed view (100% completion)"
+    },
+    "rate": {
+      "type": "number",
+      "description": "Fixed CPCV rate (cost per 100% completion)",
+      "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/pricing-options/cpm-auction-option.json

@@ -0,0 +1,81 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/pricing-options/cpm-auction-option.json",
+  "title": "CPM Auction Pricing Option",
+  "description": "Cost Per Mille (cost per 1,000 impressions) with auction-based pricing - common for programmatic/non-guaranteed inventory",
+  "type": "object",
+  "properties": {
+    "pricing_option_id": {
+      "type": "string",
+      "description": "Unique identifier for this pricing option within the product (e.g., 'cpm_usd_auction')"
+    },
+    "pricing_model": {
+      "type": "string",
+      "const": "cpm",
+      "description": "Cost per 1,000 impressions"
+    },
+    "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": "Pricing guidance for auction-based CPM bidding",
+      "properties": {
+        "floor": {
+          "type": "number",
+          "description": "Minimum bid price - publisher will reject bids under this value",
+          "minimum": 0
+        },
+        "p25": {
+          "type": "number",
+          "description": "25th percentile winning price",
+          "minimum": 0
+        },
+        "p50": {
+          "type": "number",
+          "description": "Median winning price",
+          "minimum": 0
+        },
+        "p75": {
+          "type": "number",
+          "description": "75th percentile winning price",
+          "minimum": 0
+        },
+        "p90": {
+          "type": "number",
+          "description": "90th percentile winning price",
+          "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",
+    "price_guidance",
+    "currency",
+    "is_fixed"
+  ],
+  "additionalProperties": true
+}

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

@@ -0,0 +1,52 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/pricing-options/cpm-fixed-option.json",
+  "title": "CPM Fixed Rate Pricing Option",
+  "description": "Cost Per Mille (cost per 1,000 impressions) with guaranteed fixed rate - common for direct/guaranteed deals",
+  "type": "object",
+  "properties": {
+    "pricing_option_id": {
+      "type": "string",
+      "description": "Unique identifier for this pricing option within the product (e.g., 'cpm_usd_guaranteed')"
+    },
+    "pricing_model": {
+      "type": "string",
+      "const": "cpm",
+      "description": "Cost per 1,000 impressions"
+    },
+    "rate": {
+      "type": "number",
+      "description": "Fixed CPM rate (cost per 1,000 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/pricing-options/cpp-option.json

@@ -0,0 +1,73 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/pricing-options/cpp-option.json",
+  "title": "CPP Pricing Option",
+  "description": "Cost Per Point (Gross Rating Point) fixed-rate pricing for TV and audio campaigns requiring demographic measurement",
+  "type": "object",
+  "properties": {
+    "pricing_option_id": {
+      "type": "string",
+      "description": "Unique identifier for this pricing option within the product (e.g., 'cpp_usd_p18-49')"
+    },
+    "pricing_model": {
+      "type": "string",
+      "const": "cpp",
+      "description": "Cost per Gross Rating Point"
+    },
+    "rate": {
+      "type": "number",
+      "description": "Fixed CPP rate (cost per rating point)",
+      "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": "CPP-specific parameters for demographic targeting and GRP requirements",
+      "properties": {
+        "demographic": {
+          "type": "string",
+          "pattern": "^[PMWAC][0-9]{2}(-[0-9]{2}|\\+)$",
+          "description": "Target demographic in Nielsen format: P/M/W/A/C + age range. Examples: P18-49 (Persons 18-49), M25-54 (Men 25-54), W35+ (Women 35+), A18-34 (Adults 18-34), C2-11 (Children 2-11)"
+        },
+        "min_points": {
+          "type": "number",
+          "description": "Minimum GRPs/TRPs required for this pricing option",
+          "minimum": 0
+        }
+      },
+      "required": [
+        "demographic"
+      ],
+      "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",
+    "rate",
+    "currency",
+    "is_fixed",
+    "parameters"
+  ],
+  "additionalProperties": true
+}

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

@@ -0,0 +1,88 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/pricing-options/cpv-option.json",
+  "title": "CPV Pricing Option",
+  "description": "Cost Per View (at publisher-defined threshold) fixed-rate pricing for video/audio",
+  "type": "object",
+  "properties": {
+    "pricing_option_id": {
+      "type": "string",
+      "description": "Unique identifier for this pricing option within the product (e.g., 'cpv_usd_50pct')"
+    },
+    "pricing_model": {
+      "type": "string",
+      "const": "cpv",
+      "description": "Cost per view at threshold"
+    },
+    "rate": {
+      "type": "number",
+      "description": "Fixed CPV rate (cost per view)",
+      "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": "CPV-specific parameters defining the view threshold",
+      "properties": {
+        "view_threshold": {
+          "oneOf": [
+            {
+              "type": "number",
+              "description": "Percentage completion threshold for CPV pricing (0.0 to 1.0, e.g., 0.5 = 50% completion)",
+              "minimum": 0,
+              "maximum": 1
+            },
+            {
+              "type": "object",
+              "description": "Time-based view threshold for CPV pricing",
+              "properties": {
+                "duration_seconds": {
+                  "type": "integer",
+                  "description": "Seconds of viewing required (e.g., 30 for YouTube-style '30 seconds = view')",
+                  "minimum": 1
+                }
+              },
+              "required": [
+                "duration_seconds"
+              ],
+              "additionalProperties": true
+            }
+          ]
+        }
+      },
+      "required": [
+        "view_threshold"
+      ],
+      "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",
+    "rate",
+    "currency",
+    "is_fixed",
+    "parameters"
+  ],
+  "additionalProperties": true
+}