adcp 1.6.1__py3-none-any.whl → 2.1.0__py3-none-any.whl

adcp/types/generated_poc/build_creative_response.py

@@ -0,0 +1,57 @@
+# generated by datamodel-codegen:
+#   filename:  build-creative-response.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field, RootModel
+
+from . import creative_manifest as creative_manifest_1
+from . import error
+
+
+class BuildCreativeResponse2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    context: Annotated[
+        dict[str, Any] | None,
+        Field(
+            description="Initiator-provided context echoed inside the task payload. Opaque metadata such as UI/session hints, correlation tokens, or tracking identifiers."
+        ),
+    ] = None
+    errors: Annotated[
+        list[error.Error],
+        Field(
+            description="Array of errors explaining why creative generation failed", min_length=1
+        ),
+    ]
+
+
+class BuildCreativeResponse1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    context: Annotated[
+        dict[str, Any] | None,
+        Field(
+            description="Initiator-provided context echoed inside the task payload. Opaque metadata such as UI/session hints, correlation tokens, or tracking identifiers."
+        ),
+    ] = None
+    creative_manifest: Annotated[
+        creative_manifest_1.CreativeManifest,
+        Field(description="The generated or transformed creative manifest"),
+    ]
+
+
+class BuildCreativeResponse(RootModel[BuildCreativeResponse1 | BuildCreativeResponse2]):
+    root: Annotated[
+        BuildCreativeResponse1 | BuildCreativeResponse2,
+        Field(
+            description="Response containing the transformed or generated creative manifest, ready for use with preview_creative or sync_creatives. Returns either the complete creative manifest OR error information, never both.",
+            title="Build Creative Response",
+        ),
+    ]

adcp/types/generated_poc/channels.py

@@ -0,0 +1,19 @@
+# generated by datamodel-codegen:
+#   filename:  channels.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class AdvertisingChannels(Enum):
+    display = "display"
+    video = "video"
+    audio = "audio"
+    native = "native"
+    dooh = "dooh"
+    ctv = "ctv"
+    podcast = "podcast"
+    retail = "retail"
+    social = "social"

adcp/types/generated_poc/cpc_option.py

@@ -0,0 +1,39 @@
+# generated by datamodel-codegen:
+#   filename:  cpc-option.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Literal
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+
+class CpcPricingOption(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    currency: Annotated[
+        str,
+        Field(
+            description="ISO 4217 currency code",
+            examples=["USD", "EUR", "GBP", "JPY"],
+            pattern="^[A-Z]{3}$",
+        ),
+    ]
+    min_spend_per_package: Annotated[
+        float | None,
+        Field(
+            description="Minimum spend requirement per package using this pricing option, in the specified currency",
+            ge=0.0,
+        ),
+    ] = None
+    pricing_model: Annotated[Literal["cpc"], Field(description="Cost per click")]
+    pricing_option_id: Annotated[
+        str,
+        Field(
+            description="Unique identifier for this pricing option within the product (e.g., 'cpc_usd_fixed')"
+        ),
+    ]
+    rate: Annotated[float, Field(description="Fixed CPC rate (cost per click)", ge=0.0)]

adcp/types/generated_poc/cpcv_option.py

@@ -0,0 +1,41 @@
+# generated by datamodel-codegen:
+#   filename:  cpcv-option.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Literal
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+
+class CpcvPricingOption(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    currency: Annotated[
+        str,
+        Field(
+            description="ISO 4217 currency code",
+            examples=["USD", "EUR", "GBP", "JPY"],
+            pattern="^[A-Z]{3}$",
+        ),
+    ]
+    min_spend_per_package: Annotated[
+        float | None,
+        Field(
+            description="Minimum spend requirement per package using this pricing option, in the specified currency",
+            ge=0.0,
+        ),
+    ] = None
+    pricing_model: Annotated[
+        Literal["cpcv"], Field(description="Cost per completed view (100% completion)")
+    ]
+    pricing_option_id: Annotated[
+        str,
+        Field(
+            description="Unique identifier for this pricing option within the product (e.g., 'cpcv_usd_guaranteed')"
+        ),
+    ]
+    rate: Annotated[float, Field(description="Fixed CPCV rate (cost per 100% completion)", ge=0.0)]

adcp/types/generated_poc/cpm_auction_option.py

@@ -0,0 +1,54 @@
+# generated by datamodel-codegen:
+#   filename:  cpm-auction-option.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Literal
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+
+class PriceGuidance(AdCPBaseModel):
+    floor: Annotated[
+        float,
+        Field(
+            description="Minimum bid price - publisher will reject bids under this value", ge=0.0
+        ),
+    ]
+    p25: Annotated[float | None, Field(description="25th percentile winning price", ge=0.0)] = None
+    p50: Annotated[float | None, Field(description="Median winning price", ge=0.0)] = None
+    p75: Annotated[float | None, Field(description="75th percentile winning price", ge=0.0)] = None
+    p90: Annotated[float | None, Field(description="90th percentile winning price", ge=0.0)] = None
+
+
+class CpmAuctionPricingOption(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    currency: Annotated[
+        str,
+        Field(
+            description="ISO 4217 currency code",
+            examples=["USD", "EUR", "GBP", "JPY"],
+            pattern="^[A-Z]{3}$",
+        ),
+    ]
+    min_spend_per_package: Annotated[
+        float | None,
+        Field(
+            description="Minimum spend requirement per package using this pricing option, in the specified currency",
+            ge=0.0,
+        ),
+    ] = None
+    price_guidance: Annotated[
+        PriceGuidance, Field(description="Pricing guidance for auction-based CPM bidding")
+    ]
+    pricing_model: Annotated[Literal["cpm"], Field(description="Cost per 1,000 impressions")]
+    pricing_option_id: Annotated[
+        str,
+        Field(
+            description="Unique identifier for this pricing option within the product (e.g., 'cpm_usd_auction')"
+        ),
+    ]

adcp/types/generated_poc/cpm_fixed_option.py

@@ -0,0 +1,39 @@
+# generated by datamodel-codegen:
+#   filename:  cpm-fixed-option.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Literal
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+
+class CpmFixedRatePricingOption(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    currency: Annotated[
+        str,
+        Field(
+            description="ISO 4217 currency code",
+            examples=["USD", "EUR", "GBP", "JPY"],
+            pattern="^[A-Z]{3}$",
+        ),
+    ]
+    min_spend_per_package: Annotated[
+        float | None,
+        Field(
+            description="Minimum spend requirement per package using this pricing option, in the specified currency",
+            ge=0.0,
+        ),
+    ] = None
+    pricing_model: Annotated[Literal["cpm"], Field(description="Cost per 1,000 impressions")]
+    pricing_option_id: Annotated[
+        str,
+        Field(
+            description="Unique identifier for this pricing option within the product (e.g., 'cpm_usd_guaranteed')"
+        ),
+    ]
+    rate: Annotated[float, Field(description="Fixed CPM rate (cost per 1,000 impressions)", ge=0.0)]

adcp/types/generated_poc/cpp_option.py

@@ -0,0 +1,60 @@
+# generated by datamodel-codegen:
+#   filename:  cpp-option.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Literal
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+
+class Parameters(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    demographic: Annotated[
+        str,
+        Field(
+            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)",
+            pattern="^[PMWAC][0-9]{2}(-[0-9]{2}|\\+)$",
+        ),
+    ]
+    min_points: Annotated[
+        float | None,
+        Field(description="Minimum GRPs/TRPs required for this pricing option", ge=0.0),
+    ] = None
+
+
+class CppPricingOption(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    currency: Annotated[
+        str,
+        Field(
+            description="ISO 4217 currency code",
+            examples=["USD", "EUR", "GBP", "JPY"],
+            pattern="^[A-Z]{3}$",
+        ),
+    ]
+    min_spend_per_package: Annotated[
+        float | None,
+        Field(
+            description="Minimum spend requirement per package using this pricing option, in the specified currency",
+            ge=0.0,
+        ),
+    ] = None
+    parameters: Annotated[
+        Parameters,
+        Field(description="CPP-specific parameters for demographic targeting and GRP requirements"),
+    ]
+    pricing_model: Annotated[Literal["cpp"], Field(description="Cost per Gross Rating Point")]
+    pricing_option_id: Annotated[
+        str,
+        Field(
+            description="Unique identifier for this pricing option within the product (e.g., 'cpp_usd_p18-49')"
+        ),
+    ]
+    rate: Annotated[float, Field(description="Fixed CPP rate (cost per rating point)", ge=0.0)]

adcp/types/generated_poc/cpv_option.py

@@ -0,0 +1,73 @@
+# generated by datamodel-codegen:
+#   filename:  cpv-option.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Literal
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field, RootModel
+
+
+class ViewThreshold(RootModel[float]):
+    root: Annotated[
+        float,
+        Field(
+            description="Percentage completion threshold for CPV pricing (0.0 to 1.0, e.g., 0.5 = 50% completion)",
+            ge=0.0,
+            le=1.0,
+        ),
+    ]
+
+
+class ViewThreshold1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    duration_seconds: Annotated[
+        int,
+        Field(
+            description="Seconds of viewing required (e.g., 30 for YouTube-style '30 seconds = view')",
+            ge=1,
+        ),
+    ]
+
+
+class Parameters(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    view_threshold: ViewThreshold | ViewThreshold1
+
+
+class CpvPricingOption(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    currency: Annotated[
+        str,
+        Field(
+            description="ISO 4217 currency code",
+            examples=["USD", "EUR", "GBP", "JPY"],
+            pattern="^[A-Z]{3}$",
+        ),
+    ]
+    min_spend_per_package: Annotated[
+        float | None,
+        Field(
+            description="Minimum spend requirement per package using this pricing option, in the specified currency",
+            ge=0.0,
+        ),
+    ] = None
+    parameters: Annotated[
+        Parameters, Field(description="CPV-specific parameters defining the view threshold")
+    ]
+    pricing_model: Annotated[Literal["cpv"], Field(description="Cost per view at threshold")]
+    pricing_option_id: Annotated[
+        str,
+        Field(
+            description="Unique identifier for this pricing option within the product (e.g., 'cpv_usd_50pct')"
+        ),
+    ]
+    rate: Annotated[float, Field(description="Fixed CPV rate (cost per view)", ge=0.0)]

adcp/types/generated_poc/create_media_buy_request.py

@@ -0,0 +1,96 @@
+# generated by datamodel-codegen:
+#   filename:  create-media-buy-request.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AnyUrl, AwareDatetime, ConfigDict, Field
+
+from . import brand_manifest_ref as brand_manifest_1
+from . import package_request
+from .push_notification_config import PushNotificationConfig
+
+
+class ReportingFrequency(Enum):
+    hourly = "hourly"
+    daily = "daily"
+    monthly = "monthly"
+
+
+class RequestedMetric(Enum):
+    impressions = "impressions"
+    spend = "spend"
+    clicks = "clicks"
+    ctr = "ctr"
+    video_completions = "video_completions"
+    completion_rate = "completion_rate"
+    conversions = "conversions"
+    viewability = "viewability"
+    engagement_rate = "engagement_rate"
+
+
+class ReportingWebhook(PushNotificationConfig):
+    reporting_frequency: Annotated[
+        ReportingFrequency,
+        Field(
+            description="Frequency for automated reporting delivery. Must be supported by all products in the media buy."
+        ),
+    ]
+    requested_metrics: Annotated[
+        list[RequestedMetric] | None,
+        Field(
+            description="Optional list of metrics to include in webhook notifications. If omitted, all available metrics are included. Must be subset of product's available_metrics."
+        ),
+    ] = None
+
+
+class CreateMediaBuyRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    brand_manifest: Annotated[
+        brand_manifest_1.BrandManifest | AnyUrl,
+        Field(
+            description="Brand information manifest serving as the namespace and identity for this media buy. Provides brand context, assets, and product catalog. Can be provided inline or as a URL reference to a hosted manifest. Can be cached and reused across multiple requests.",
+            examples=[
+                {
+                    "data": {
+                        "colors": {"primary": "#FF6B35"},
+                        "name": "ACME Corporation",
+                        "url": "https://acmecorp.com",
+                    },
+                    "description": "Inline brand manifest",
+                },
+                {
+                    "data": "https://cdn.acmecorp.com/brand-manifest.json",
+                    "description": "URL string reference to hosted manifest",
+                },
+            ],
+            title="Brand Manifest Reference",
+        ),
+    ]
+    buyer_ref: Annotated[str, Field(description="Buyer's reference identifier for this media buy")]
+    context: Annotated[
+        dict[str, Any] | None,
+        Field(
+            description="Initiator-provided context included in the request payload. Agentsmust echo this value back unchanged in responses and webhooks. Use for UI/session hints, correlation tokens, or tracking metadata."
+        ),
+    ] = None
+    end_time: Annotated[
+        AwareDatetime, Field(description="Campaign end date/time in ISO 8601 format")
+    ]
+    packages: Annotated[
+        list[package_request.PackageRequest], Field(description="Array of package configurations")
+    ]
+    po_number: Annotated[str | None, Field(description="Purchase order number for tracking")] = None
+    reporting_webhook: ReportingWebhook | None = None
+    start_time: Annotated[
+        str | AwareDatetime,
+        Field(
+            description="Campaign start timing: 'asap' or ISO 8601 date-time", title="Start Timing"
+        ),
+    ]

adcp/types/generated_poc/create_media_buy_response.py

@@ -0,0 +1,66 @@
+# generated by datamodel-codegen:
+#   filename:  create-media-buy-response.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AwareDatetime, ConfigDict, Field, RootModel
+
+from . import error
+
+
+class Package(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    buyer_ref: Annotated[str, Field(description="Buyer's reference identifier for the package")]
+    package_id: Annotated[str, Field(description="Publisher's unique identifier for the package")]
+
+
+class CreateMediaBuyResponse1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    buyer_ref: Annotated[str, Field(description="Buyer's reference identifier for this media buy")]
+    context: Annotated[
+        dict[str, Any] | None,
+        Field(
+            description="Initiator-provided context echoed inside the task payload. Opaque metadata such as UI/session hints, correlation tokens, or tracking identifiers."
+        ),
+    ] = None
+    creative_deadline: Annotated[
+        AwareDatetime | None, Field(description="ISO 8601 timestamp for creative upload deadline")
+    ] = None
+    media_buy_id: Annotated[
+        str, Field(description="Publisher's unique identifier for the created media buy")
+    ]
+    packages: Annotated[list[Package], Field(description="Array of created packages")]
+
+
+class CreateMediaBuyResponse2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    context: Annotated[
+        dict[str, Any] | None,
+        Field(
+            description="Initiator-provided context echoed inside the task payload. Opaque metadata such as UI/session hints, correlation tokens, or tracking identifiers."
+        ),
+    ] = None
+    errors: Annotated[
+        list[error.Error],
+        Field(description="Array of errors explaining why the operation failed", min_length=1),
+    ]
+
+
+class CreateMediaBuyResponse(RootModel[CreateMediaBuyResponse1 | CreateMediaBuyResponse2]):
+    root: Annotated[
+        CreateMediaBuyResponse1 | CreateMediaBuyResponse2,
+        Field(
+            description="Response payload for create_media_buy task. Returns either complete success data OR error information, never both. This enforces atomic operation semantics - the media buy is either fully created or not created at all.",
+            title="Create Media Buy Response",
+        ),
+    ]

adcp/types/generated_poc/creative_asset.py

@@ -0,0 +1,83 @@
+# generated by datamodel-codegen:
+#   filename:  creative-asset.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+from . import audio_asset, css_asset, daast_asset
+from . import format_id as format_id_1
+from . import (
+    html_asset,
+    image_asset,
+    javascript_asset,
+    promoted_offerings,
+    text_asset,
+    url_asset,
+    vast_asset,
+    video_asset,
+)
+
+
+class Input(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    context_description: Annotated[
+        str | None,
+        Field(description="Natural language description of the context for AI-generated content"),
+    ] = None
+    macros: Annotated[
+        dict[str, str] | None, Field(description="Macro values to apply for this preview")
+    ] = None
+    name: Annotated[str, Field(description="Human-readable name for this preview variant")]
+
+
+class CreativeAsset(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    approved: Annotated[
+        bool | None,
+        Field(
+            description="For generative creatives: set to true to approve and finalize, false to request regeneration with updated assets/message. Omit for non-generative creatives."
+        ),
+    ] = None
+    assets: Annotated[
+        dict[
+            str,
+            image_asset.ImageAsset
+            | video_asset.VideoAsset
+            | audio_asset.AudioAsset
+            | text_asset.TextAsset
+            | html_asset.HtmlAsset
+            | css_asset.CssAsset
+            | javascript_asset.JavascriptAsset
+            | promoted_offerings.PromotedOfferings
+            | url_asset.UrlAsset
+            | vast_asset.VastAsset1
+            | vast_asset.VastAsset2
+            | daast_asset.DaastAsset1
+            | daast_asset.DaastAsset2,
+        ],
+        Field(description="Assets required by the format, keyed by asset_role"),
+    ]
+    creative_id: Annotated[str, Field(description="Unique identifier for the creative")]
+    format_id: Annotated[
+        format_id_1.FormatId,
+        Field(description="Format identifier specifying which format this creative conforms to"),
+    ]
+    inputs: Annotated[
+        list[Input] | None,
+        Field(
+            description="Preview contexts for generative formats - defines what scenarios to generate previews for"
+        ),
+    ] = None
+    name: Annotated[str, Field(description="Human-readable creative name")]
+    tags: Annotated[
+        list[str] | None, Field(description="User-defined tags for organization and searchability")
+    ] = None

adcp/types/generated_poc/creative_assignment.py

@@ -0,0 +1,27 @@
+# generated by datamodel-codegen:
+#   filename:  creative-assignment.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+
+class CreativeAssignment(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    creative_id: Annotated[str, Field(description="Unique identifier for the creative")]
+    placement_ids: Annotated[
+        list[str] | None,
+        Field(
+            description="Optional array of placement IDs where this creative should run. When omitted, the creative runs on all placements in the package. References placement_id values from the product's placements array.",
+            min_length=1,
+        ),
+    ] = None
+    weight: Annotated[
+        float | None, Field(description="Delivery weight for this creative", ge=0.0, le=100.0)
+    ] = None