@adcp/sdk 5.25.1 → 6.1.0

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

@@ -0,0 +1,90 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/performance-feedback.json",
+  "title": "Performance Feedback",
+  "description": "Represents performance feedback data for a media buy or package",
+  "type": "object",
+  "properties": {
+    "feedback_id": {
+      "type": "string",
+      "description": "Unique identifier for this performance feedback submission"
+    },
+    "media_buy_id": {
+      "type": "string",
+      "description": "Publisher's media buy identifier"
+    },
+    "package_id": {
+      "type": "string",
+      "description": "Specific package within the media buy (if feedback is package-specific)"
+    },
+    "creative_id": {
+      "type": "string",
+      "description": "Specific creative asset (if feedback is creative-specific)"
+    },
+    "measurement_period": {
+      "type": "object",
+      "description": "Time period for performance measurement",
+      "properties": {
+        "start": {
+          "type": "string",
+          "format": "date-time",
+          "description": "ISO 8601 start timestamp for measurement period"
+        },
+        "end": {
+          "type": "string",
+          "format": "date-time",
+          "description": "ISO 8601 end timestamp for measurement period"
+        }
+      },
+      "required": [
+        "start",
+        "end"
+      ],
+      "additionalProperties": true
+    },
+    "performance_index": {
+      "type": "number",
+      "description": "Normalized performance score (0.0 = no value, 1.0 = expected, >1.0 = above expected)",
+      "minimum": 0
+    },
+    "metric_type": {
+      "$ref": "/schemas/enums/metric-type.json",
+      "description": "The business metric being measured"
+    },
+    "feedback_source": {
+      "$ref": "/schemas/enums/feedback-source.json",
+      "description": "Source of the performance data"
+    },
+    "status": {
+      "type": "string",
+      "description": "Processing status of the performance feedback",
+      "enum": [
+        "accepted",
+        "queued",
+        "applied",
+        "rejected"
+      ]
+    },
+    "submitted_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when feedback was submitted"
+    },
+    "applied_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when feedback was applied to optimization algorithms"
+    }
+  },
+  "required": [
+    "feedback_id",
+    "media_buy_id",
+    "measurement_period",
+    "performance_index",
+    "metric_type",
+    "feedback_source",
+    "status",
+    "submitted_at"
+  ],
+  "additionalProperties": true
+}

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

@@ -0,0 +1,34 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/placement.json",
+  "title": "Placement",
+  "description": "Represents a specific ad placement within a product's inventory",
+  "type": "object",
+  "properties": {
+    "placement_id": {
+      "type": "string",
+      "description": "Unique identifier for the placement within the product"
+    },
+    "name": {
+      "type": "string",
+      "description": "Human-readable name for the placement (e.g., 'Homepage Banner', 'Article Sidebar')"
+    },
+    "description": {
+      "type": "string",
+      "description": "Detailed description of where and how the placement appears"
+    },
+    "format_ids": {
+      "type": "array",
+      "description": "Format IDs supported by this specific placement. Can include: (1) concrete format_ids (fixed dimensions), (2) template format_ids without parameters (accepts any dimensions/duration), or (3) parameterized format_ids (specific dimension/duration constraints).",
+      "items": {
+        "$ref": "/schemas/core/format-id.json"
+      },
+      "minItems": 1
+    }
+  },
+  "required": [
+    "placement_id",
+    "name"
+  ],
+  "additionalProperties": true
+}

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

@@ -0,0 +1,35 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/pricing-option.json",
+  "title": "Pricing Option",
+  "description": "A pricing model option offered by a publisher for a product. Each pricing model has its own schema with model-specific requirements.",
+  "oneOf": [
+    {
+      "$ref": "/schemas/pricing-options/cpm-fixed-option.json"
+    },
+    {
+      "$ref": "/schemas/pricing-options/cpm-auction-option.json"
+    },
+    {
+      "$ref": "/schemas/pricing-options/vcpm-fixed-option.json"
+    },
+    {
+      "$ref": "/schemas/pricing-options/vcpm-auction-option.json"
+    },
+    {
+      "$ref": "/schemas/pricing-options/cpc-option.json"
+    },
+    {
+      "$ref": "/schemas/pricing-options/cpcv-option.json"
+    },
+    {
+      "$ref": "/schemas/pricing-options/cpv-option.json"
+    },
+    {
+      "$ref": "/schemas/pricing-options/cpp-option.json"
+    },
+    {
+      "$ref": "/schemas/pricing-options/flat-rate-option.json"
+    }
+  ]
+}

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

@@ -0,0 +1,102 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/product-filters.json",
+  "title": "Product Filters",
+  "description": "Structured filters for product discovery",
+  "type": "object",
+  "properties": {
+    "delivery_type": {
+      "$ref": "/schemas/enums/delivery-type.json"
+    },
+    "is_fixed_price": {
+      "type": "boolean",
+      "description": "Filter for fixed price vs auction products"
+    },
+    "format_types": {
+      "type": "array",
+      "description": "Filter by format types",
+      "items": {
+        "$ref": "/schemas/enums/format-category.json"
+      }
+    },
+    "format_ids": {
+      "type": "array",
+      "description": "Filter by specific format IDs",
+      "items": {
+        "$ref": "/schemas/core/format-id.json"
+      }
+    },
+    "standard_formats_only": {
+      "type": "boolean",
+      "description": "Only return products accepting IAB standard formats"
+    },
+    "min_exposures": {
+      "type": "integer",
+      "description": "Minimum exposures/impressions needed for measurement validity",
+      "minimum": 1
+    },
+    "start_date": {
+      "type": "string",
+      "format": "date",
+      "description": "Campaign start date (ISO 8601 date format: YYYY-MM-DD) for availability checks"
+    },
+    "end_date": {
+      "type": "string",
+      "format": "date",
+      "description": "Campaign end date (ISO 8601 date format: YYYY-MM-DD) for availability checks"
+    },
+    "budget_range": {
+      "type": "object",
+      "description": "Budget range to filter appropriate products",
+      "properties": {
+        "min": {
+          "type": "number",
+          "description": "Minimum budget amount",
+          "minimum": 0
+        },
+        "max": {
+          "type": "number",
+          "description": "Maximum budget amount",
+          "minimum": 0
+        },
+        "currency": {
+          "type": "string",
+          "description": "ISO 4217 currency code (e.g., 'USD', 'EUR', 'GBP')",
+          "pattern": "^[A-Z]{3}$"
+        }
+      },
+      "required": [
+        "currency"
+      ],
+      "anyOf": [
+        {
+          "required": [
+            "min"
+          ]
+        },
+        {
+          "required": [
+            "max"
+          ]
+        }
+      ],
+      "additionalProperties": true
+    },
+    "countries": {
+      "type": "array",
+      "description": "Filter by target countries using ISO 3166-1 alpha-2 country codes (e.g., ['US', 'CA', 'GB'])",
+      "items": {
+        "type": "string",
+        "pattern": "^[A-Z]{2}$"
+      }
+    },
+    "channels": {
+      "type": "array",
+      "description": "Filter by advertising channels (e.g., ['display', 'video', 'dooh'])",
+      "items": {
+        "$ref": "/schemas/enums/channels.json"
+      }
+    }
+  },
+  "additionalProperties": true
+}

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

@@ -0,0 +1,153 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/product.json",
+  "title": "Product",
+  "description": "Represents available advertising inventory",
+  "type": "object",
+  "properties": {
+    "product_id": {
+      "type": "string",
+      "description": "Unique identifier for the product"
+    },
+    "name": {
+      "type": "string",
+      "description": "Human-readable product name"
+    },
+    "description": {
+      "type": "string",
+      "description": "Detailed description of the product and its inventory"
+    },
+    "publisher_properties": {
+      "type": "array",
+      "description": "Publisher properties covered by this product. Buyers fetch actual property definitions from each publisher's adagents.json and validate agent authorization. Selection patterns mirror the authorization patterns in adagents.json for consistency.",
+      "items": {
+        "$ref": "/schemas/core/publisher-property-selector.json"
+      },
+      "minItems": 1
+    },
+    "format_ids": {
+      "type": "array",
+      "description": "Array of supported creative format IDs - structured format_id objects with agent_url and id",
+      "items": {
+        "$ref": "/schemas/core/format-id.json"
+      }
+    },
+    "placements": {
+      "type": "array",
+      "description": "Optional array of specific placements within this product. When provided, buyers can target specific placements when assigning creatives.",
+      "items": {
+        "$ref": "/schemas/core/placement.json"
+      },
+      "minItems": 1
+    },
+    "delivery_type": {
+      "$ref": "/schemas/enums/delivery-type.json"
+    },
+    "pricing_options": {
+      "type": "array",
+      "description": "Available pricing models for this product",
+      "items": {
+        "$ref": "/schemas/core/pricing-option.json"
+      },
+      "minItems": 1
+    },
+    "estimated_exposures": {
+      "type": "integer",
+      "description": "Estimated exposures/impressions for guaranteed products",
+      "minimum": 0
+    },
+    "measurement": {
+      "$ref": "/schemas/core/measurement.json"
+    },
+    "delivery_measurement": {
+      "type": "object",
+      "description": "Measurement provider and methodology for delivery metrics. The buyer accepts the declared provider as the source of truth for the buy. REQUIRED for all products.",
+      "properties": {
+        "provider": {
+          "type": "string",
+          "description": "Measurement provider(s) used for this product (e.g., 'Google Ad Manager with IAS viewability', 'Nielsen DAR', 'Geopath for DOOH impressions')"
+        },
+        "notes": {
+          "type": "string",
+          "description": "Additional details about measurement methodology in plain language (e.g., 'MRC-accredited viewability. 50% in-view for 1s display / 2s video', 'Panel-based demographic measurement updated monthly')"
+        }
+      },
+      "required": [
+        "provider"
+      ]
+    },
+    "reporting_capabilities": {
+      "$ref": "/schemas/core/reporting-capabilities.json"
+    },
+    "creative_policy": {
+      "$ref": "/schemas/core/creative-policy.json"
+    },
+    "is_custom": {
+      "type": "boolean",
+      "description": "Whether this is a custom product"
+    },
+    "brief_relevance": {
+      "type": "string",
+      "description": "Explanation of why this product matches the brief (only included when brief is provided)"
+    },
+    "expires_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Expiration timestamp for custom products"
+    },
+    "product_card": {
+      "type": "object",
+      "description": "Optional standard visual card (300x400px) for displaying this product in user interfaces. Can be rendered via preview_creative or pre-generated.",
+      "properties": {
+        "format_id": {
+          "$ref": "/schemas/core/format-id.json",
+          "description": "Creative format defining the card layout (typically product_card_standard)"
+        },
+        "manifest": {
+          "type": "object",
+          "description": "Asset manifest for rendering the card, structure defined by the format",
+          "additionalProperties": true
+        }
+      },
+      "required": [
+        "format_id",
+        "manifest"
+      ],
+      "additionalProperties": true
+    },
+    "product_card_detailed": {
+      "type": "object",
+      "description": "Optional detailed card with carousel and full specifications. Provides rich product presentation similar to media kit pages.",
+      "properties": {
+        "format_id": {
+          "$ref": "/schemas/core/format-id.json",
+          "description": "Creative format defining the detailed card layout (typically product_card_detailed)"
+        },
+        "manifest": {
+          "type": "object",
+          "description": "Asset manifest for rendering the detailed card, structure defined by the format",
+          "additionalProperties": true
+        }
+      },
+      "required": [
+        "format_id",
+        "manifest"
+      ],
+      "additionalProperties": true
+    },
+    "ext": {
+      "$ref": "/schemas/core/ext.json"
+    }
+  },
+  "required": [
+    "product_id",
+    "name",
+    "description",
+    "publisher_properties",
+    "format_ids",
+    "delivery_type",
+    "delivery_measurement",
+    "pricing_options"
+  ],
+  "additionalProperties": true
+}

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

@@ -0,0 +1,115 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/promoted-offerings.json",
+  "title": "Promoted Offerings",
+  "description": "Complete offering specification combining brand manifest, product selectors, and asset filters. Provides all context needed for creative generation about what is being promoted.",
+  "type": "object",
+  "properties": {
+    "brand_manifest": {
+      "$ref": "/schemas/core/brand-manifest-ref.json",
+      "description": "Brand information manifest containing assets, themes, and guidelines. Can be provided inline or as a URL reference to a hosted manifest."
+    },
+    "product_selectors": {
+      "$ref": "/schemas/core/promoted-products.json",
+      "description": "Selectors to choose which products/offerings from the brand manifest product catalog to promote"
+    },
+    "offerings": {
+      "type": "array",
+      "description": "Inline offerings for campaigns without a product catalog. Each offering has a name, description, and associated assets.",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "Offering name (e.g., 'Winter Sale', 'New Product Launch')"
+          },
+          "description": {
+            "type": "string",
+            "description": "Description of what's being offered"
+          },
+          "assets": {
+            "type": "array",
+            "description": "Assets specific to this offering",
+            "items": {
+              "type": "object",
+              "description": "Asset definition using standard asset structure",
+              "additionalProperties": true
+            }
+          }
+        },
+        "required": [
+          "name"
+        ],
+        "additionalProperties": true
+      }
+    },
+    "asset_selectors": {
+      "type": "object",
+      "description": "Selectors to choose specific assets from the brand manifest",
+      "properties": {
+        "tags": {
+          "type": "array",
+          "description": "Select assets with specific tags (e.g., ['holiday', 'premium'])",
+          "items": {
+            "type": "string"
+          }
+        },
+        "asset_types": {
+          "type": "array",
+          "description": "Filter by asset type (e.g., ['image', 'video'])",
+          "items": {
+            "type": "string",
+            "enum": [
+              "image",
+              "video",
+              "audio",
+              "vast",
+              "daast",
+              "text",
+              "url",
+              "html",
+              "css",
+              "javascript",
+              "webhook"
+            ]
+          }
+        },
+        "exclude_tags": {
+          "type": "array",
+          "description": "Exclude assets with these tags",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": true
+    }
+  },
+  "required": [
+    "brand_manifest"
+  ],
+  "additionalProperties": true,
+  "examples": [
+    {
+      "brand_manifest": {
+        "name": "Brand Name",
+        "url": "https://brand.com"
+      },
+      "product_selectors": {
+        "manifest_skus": [
+          "SKU-123",
+          "SKU-456"
+        ]
+      },
+      "asset_selectors": {
+        "tags": [
+          "holiday"
+        ],
+        "asset_types": [
+          "image",
+          "video"
+        ]
+      }
+    }
+  ]
+}

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

@@ -0,0 +1,67 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/promoted-products.json",
+  "title": "Promoted Products",
+  "description": "Specification of products or offerings being promoted in a campaign. Supports multiple selection methods from the brand manifest that can be combined using UNION (OR) logic. When multiple selection methods are provided, products matching ANY of the criteria are selected (logical OR, not AND).",
+  "type": "object",
+  "properties": {
+    "manifest_skus": {
+      "type": "array",
+      "description": "Direct product SKU references from the brand manifest product catalog",
+      "items": {
+        "type": "string"
+      }
+    },
+    "manifest_tags": {
+      "type": "array",
+      "description": "Select products by tags from the brand manifest product catalog (e.g., 'organic', 'sauces', 'holiday')",
+      "items": {
+        "type": "string"
+      }
+    },
+    "manifest_category": {
+      "type": "string",
+      "description": "Select products from a specific category in the brand manifest product catalog (e.g., 'beverages/soft-drinks', 'food/sauces')"
+    },
+    "manifest_query": {
+      "type": "string",
+      "description": "Natural language query to select products from the brand manifest (e.g., 'all Kraft Heinz pasta sauces', 'organic products under $20')"
+    }
+  },
+  "additionalProperties": true,
+  "examples": [
+    {
+      "description": "Direct SKU selection for specific products from brand manifest",
+      "data": {
+        "manifest_skus": [
+          "SKU-12345",
+          "SKU-67890"
+        ]
+      }
+    },
+    {
+      "description": "UNION selection: products tagged 'organic' OR 'sauces' OR in 'food/condiments' category from brand manifest",
+      "data": {
+        "manifest_tags": [
+          "organic",
+          "sauces"
+        ],
+        "manifest_category": "food/condiments"
+      }
+    },
+    {
+      "description": "Natural language product selection from brand manifest",
+      "data": {
+        "manifest_query": "all Kraft Heinz pasta sauces under $5"
+      }
+    },
+    {
+      "description": "Select products by tags",
+      "data": {
+        "manifest_tags": [
+          "holiday"
+        ]
+      }
+    }
+  ]
+}

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

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/property-id.json",
+  "title": "Property ID",
+  "description": "Identifier for a publisher property. Must be lowercase alphanumeric with underscores only.",
+  "type": "string",
+  "pattern": "^[a-z0-9_]+$",
+  "examples": [
+    "cnn_ctv_app",
+    "homepage",
+    "mobile_ios",
+    "instagram"
+  ]
+}

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

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/core/property-tag.json",
+  "title": "Property Tag",
+  "description": "Tag for categorizing publisher properties. Must be lowercase alphanumeric with underscores only.",
+  "type": "string",
+  "pattern": "^[a-z0-9_]+$",
+  "examples": [
+    "ctv",
+    "premium",
+    "news",
+    "sports",
+    "meta_network",
+    "social_media"
+  ]
+}