adcp 1.6.0__py3-none-any.whl → 2.0.0__py3-none-any.whl

adcp/types/generated_poc/creative_manifest.py

@@ -0,0 +1,61 @@
+# generated by datamodel-codegen:
+#   filename:  creative-manifest.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,
+    webhook_asset,
+)
+
+
+class CreativeManifest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    assets: Annotated[
+        dict[
+            str,
+            image_asset.ImageAsset
+            | video_asset.VideoAsset
+            | audio_asset.AudioAsset
+            | text_asset.TextAsset
+            | url_asset.UrlAsset
+            | html_asset.HtmlAsset
+            | javascript_asset.JavascriptAsset
+            | webhook_asset.WebhookAsset
+            | css_asset.CssAsset
+            | promoted_offerings.PromotedOfferings
+            | vast_asset.VastAsset1
+            | vast_asset.VastAsset2
+            | daast_asset.DaastAsset1
+            | daast_asset.DaastAsset2,
+        ],
+        Field(
+            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."
+        ),
+    ]
+    format_id: Annotated[
+        format_id_1.FormatId, Field(description="Format identifier this manifest is for")
+    ]
+    promoted_offering: Annotated[
+        str | None,
+        Field(
+            description="Product name or offering being advertised. Maps to promoted_offerings in create_media_buy request to associate creative with the product being promoted."
+        ),
+    ] = None

adcp/types/generated_poc/creative_policy.py

@@ -0,0 +1,34 @@
+# generated by datamodel-codegen:
+#   filename:  creative-policy.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+
+class CoBranding(Enum):
+    required = "required"
+    optional = "optional"
+    none = "none"
+
+
+class LandingPage(Enum):
+    any = "any"
+    retailer_site_only = "retailer_site_only"
+    must_include_retailer = "must_include_retailer"
+
+
+class CreativePolicy(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    co_branding: Annotated[CoBranding, Field(description="Co-branding requirement")]
+    landing_page: Annotated[LandingPage, Field(description="Landing page requirements")]
+    templates_available: Annotated[
+        bool, Field(description="Whether creative templates are provided")
+    ]

adcp/types/generated_poc/creative_status.py

@@ -0,0 +1,14 @@
+# generated by datamodel-codegen:
+#   filename:  creative-status.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class CreativeStatus(Enum):
+    processing = "processing"
+    approved = "approved"
+    rejected = "rejected"
+    pending_review = "pending_review"

adcp/types/generated_poc/css_asset.py

@@ -0,0 +1,20 @@
+# generated by datamodel-codegen:
+#   filename:  css-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
+
+
+class CssAsset(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    content: Annotated[str, Field(description="CSS content")]
+    media: Annotated[
+        str | None, Field(description="CSS media query context (e.g., 'screen', 'print')")
+    ] = None

adcp/types/generated_poc/daast_asset.py

@@ -0,0 +1,76 @@
+# generated by datamodel-codegen:
+#   filename:  daast-asset.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated, Literal
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AnyUrl, ConfigDict, Field
+
+
+class DaastVersion(Enum):
+    field_1_0 = "1.0"
+    field_1_1 = "1.1"
+
+
+class TrackingEvent(Enum):
+    start = "start"
+    firstQuartile = "firstQuartile"
+    midpoint = "midpoint"
+    thirdQuartile = "thirdQuartile"
+    complete = "complete"
+    impression = "impression"
+    pause = "pause"
+    resume = "resume"
+    skip = "skip"
+    mute = "mute"
+    unmute = "unmute"
+
+
+class DaastAsset1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    companion_ads: Annotated[
+        bool | None, Field(description="Whether companion display ads are included")
+    ] = None
+    daast_version: Annotated[
+        DaastVersion | None, Field(description="DAAST specification version")
+    ] = None
+    delivery_type: Annotated[
+        Literal["url"],
+        Field(description="Discriminator indicating DAAST is delivered via URL endpoint"),
+    ]
+    duration_ms: Annotated[
+        int | None, Field(description="Expected audio duration in milliseconds (if known)", ge=0)
+    ] = None
+    tracking_events: Annotated[
+        list[TrackingEvent] | None, Field(description="Tracking events supported by this DAAST tag")
+    ] = None
+    url: Annotated[AnyUrl, Field(description="URL endpoint that returns DAAST XML")]
+
+
+class DaastAsset2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    companion_ads: Annotated[
+        bool | None, Field(description="Whether companion display ads are included")
+    ] = None
+    content: Annotated[str, Field(description="Inline DAAST XML content")]
+    daast_version: Annotated[
+        DaastVersion | None, Field(description="DAAST specification version")
+    ] = None
+    delivery_type: Annotated[
+        Literal["inline"],
+        Field(description="Discriminator indicating DAAST is delivered as inline XML content"),
+    ]
+    duration_ms: Annotated[
+        int | None, Field(description="Expected audio duration in milliseconds (if known)", ge=0)
+    ] = None
+    tracking_events: Annotated[
+        list[TrackingEvent] | None, Field(description="Tracking events supported by this DAAST tag")
+    ] = None

adcp/types/generated_poc/delivery_metrics.py

@@ -0,0 +1,111 @@
+# generated by datamodel-codegen:
+#   filename:  delivery-metrics.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 VenueBreakdownItem(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    impressions: Annotated[int, Field(description="Impressions delivered at this venue", ge=0)]
+    loop_plays: Annotated[int | None, Field(description="Loop plays at this venue", ge=0)] = None
+    screens_used: Annotated[
+        int | None, Field(description="Number of screens used at this venue", ge=0)
+    ] = None
+    venue_id: Annotated[str, Field(description="Venue identifier")]
+    venue_name: Annotated[str | None, Field(description="Human-readable venue name")] = None
+    venue_type: Annotated[
+        str | None,
+        Field(description="Venue type (e.g., 'airport', 'transit', 'retail', 'billboard')"),
+    ] = None
+
+
+class DoohMetrics(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    calculation_notes: Annotated[
+        str | None, Field(description="Explanation of how DOOH impressions were calculated")
+    ] = None
+    loop_plays: Annotated[
+        int | None, Field(description="Number of times ad played in rotation", ge=0)
+    ] = None
+    screen_time_seconds: Annotated[
+        int | None, Field(description="Total display time in seconds", ge=0)
+    ] = None
+    screens_used: Annotated[
+        int | None, Field(description="Number of unique screens displaying the ad", ge=0)
+    ] = None
+    sov_achieved: Annotated[
+        float | None,
+        Field(description="Actual share of voice delivered (0.0 to 1.0)", ge=0.0, le=1.0),
+    ] = None
+    venue_breakdown: Annotated[
+        list[VenueBreakdownItem] | None, Field(description="Per-venue performance breakdown")
+    ] = None
+
+
+class QuartileData(AdCPBaseModel):
+    q1_views: Annotated[float | None, Field(description="25% completion views", ge=0.0)] = None
+    q2_views: Annotated[float | None, Field(description="50% completion views", ge=0.0)] = None
+    q3_views: Annotated[float | None, Field(description="75% completion views", ge=0.0)] = None
+    q4_views: Annotated[float | None, Field(description="100% completion views", ge=0.0)] = None
+
+
+class DeliveryMetrics(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    clicks: Annotated[float | None, Field(description="Total clicks", ge=0.0)] = None
+    completed_views: Annotated[
+        float | None, Field(description="100% completions (for CPCV)", ge=0.0)
+    ] = None
+    completion_rate: Annotated[
+        float | None,
+        Field(description="Completion rate (completed_views/impressions)", ge=0.0, le=1.0),
+    ] = None
+    conversions: Annotated[
+        float | None,
+        Field(description="Conversions (reserved for future CPA pricing support)", ge=0.0),
+    ] = None
+    ctr: Annotated[
+        float | None, Field(description="Click-through rate (clicks/impressions)", ge=0.0, le=1.0)
+    ] = None
+    dooh_metrics: Annotated[
+        DoohMetrics | None,
+        Field(description="DOOH-specific metrics (only included for DOOH campaigns)"),
+    ] = None
+    frequency: Annotated[
+        float | None,
+        Field(
+            description="Average frequency per individual (typically measured over campaign duration, but can vary by measurement provider)",
+            ge=0.0,
+        ),
+    ] = None
+    grps: Annotated[
+        float | None, Field(description="Gross Rating Points delivered (for CPP)", ge=0.0)
+    ] = None
+    impressions: Annotated[float | None, Field(description="Impressions delivered", ge=0.0)] = None
+    leads: Annotated[
+        float | None,
+        Field(description="Leads generated (reserved for future CPL pricing support)", ge=0.0),
+    ] = None
+    quartile_data: Annotated[
+        QuartileData | None, Field(description="Video quartile completion data")
+    ] = None
+    reach: Annotated[
+        float | None,
+        Field(
+            description="Unique reach - units depend on measurement provider (e.g., individuals, households, devices, cookies). See delivery_measurement.provider for methodology.",
+            ge=0.0,
+        ),
+    ] = None
+    spend: Annotated[float | None, Field(description="Amount spent", ge=0.0)] = None
+    views: Annotated[float | None, Field(description="Views at threshold (for CPV)", ge=0.0)] = None

adcp/types/generated_poc/delivery_type.py

@@ -0,0 +1,12 @@
+# generated by datamodel-codegen:
+#   filename:  delivery-type.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class DeliveryType(Enum):
+    guaranteed = "guaranteed"
+    non_guaranteed = "non_guaranteed"

adcp/types/generated_poc/deployment.py

@@ -0,0 +1,78 @@
+# generated by datamodel-codegen:
+#   filename:  deployment.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 AnyUrl, AwareDatetime, ConfigDict, Field
+
+from . import activation_key as activation_key_1
+
+
+class Deployment1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    account: Annotated[str | None, Field(description="Account identifier if applicable")] = None
+    activation_key: Annotated[
+        activation_key_1.ActivationKey1 | activation_key_1.ActivationKey2 | None,
+        Field(
+            description="The key to use for targeting. Only present if is_live=true AND requester has access to this destination.",
+            title="Activation Key",
+        ),
+    ] = None
+    deployed_at: Annotated[
+        AwareDatetime | None,
+        Field(description="Timestamp when activation completed (if is_live=true)"),
+    ] = None
+    estimated_activation_duration_minutes: Annotated[
+        float | None,
+        Field(
+            description="Estimated time to activate if not live, or to complete activation if in progress",
+            ge=0.0,
+        ),
+    ] = None
+    is_live: Annotated[
+        bool, Field(description="Whether signal is currently active on this destination")
+    ]
+    platform: Annotated[str, Field(description="Platform identifier for DSPs")]
+    type: Annotated[
+        Literal["platform"],
+        Field(description="Discriminator indicating this is a platform-based deployment"),
+    ]
+
+
+class Deployment2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    account: Annotated[str | None, Field(description="Account identifier if applicable")] = None
+    activation_key: Annotated[
+        activation_key_1.ActivationKey1 | activation_key_1.ActivationKey2 | None,
+        Field(
+            description="The key to use for targeting. Only present if is_live=true AND requester has access to this destination.",
+            title="Activation Key",
+        ),
+    ] = None
+    agent_url: Annotated[AnyUrl, Field(description="URL identifying the destination agent")]
+    deployed_at: Annotated[
+        AwareDatetime | None,
+        Field(description="Timestamp when activation completed (if is_live=true)"),
+    ] = None
+    estimated_activation_duration_minutes: Annotated[
+        float | None,
+        Field(
+            description="Estimated time to activate if not live, or to complete activation if in progress",
+            ge=0.0,
+        ),
+    ] = None
+    is_live: Annotated[
+        bool, Field(description="Whether signal is currently active on this destination")
+    ]
+    type: Annotated[
+        Literal["agent"],
+        Field(description="Discriminator indicating this is an agent URL-based deployment"),
+    ]

adcp/types/generated_poc/destination.py

@@ -0,0 +1,43 @@
+# generated by datamodel-codegen:
+#   filename:  destination.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 AnyUrl, ConfigDict, Field
+
+
+class Destination1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    account: Annotated[
+        str | None, Field(description="Optional account identifier on the platform")
+    ] = None
+    platform: Annotated[
+        str,
+        Field(description="Platform identifier for DSPs (e.g., 'the-trade-desk', 'amazon-dsp')"),
+    ]
+    type: Annotated[
+        Literal["platform"],
+        Field(description="Discriminator indicating this is a platform-based destination"),
+    ]
+
+
+class Destination2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    account: Annotated[
+        str | None, Field(description="Optional account identifier on the agent")
+    ] = None
+    agent_url: Annotated[
+        AnyUrl, Field(description="URL identifying the destination agent (for sales agents, etc.)")
+    ]
+    type: Annotated[
+        Literal["agent"],
+        Field(description="Discriminator indicating this is an agent URL-based destination"),
+    ]

adcp/types/generated_poc/error.py

@@ -0,0 +1,29 @@
+# generated by datamodel-codegen:
+#   filename:  error.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
+
+
+class Error(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    code: Annotated[str, Field(description="Error code for programmatic handling")]
+    details: Annotated[Any | None, Field(description="Additional task-specific error details")] = (
+        None
+    )
+    field: Annotated[
+        str | None,
+        Field(description="Field path associated with the error (e.g., 'packages[0].targeting')"),
+    ] = None
+    message: Annotated[str, Field(description="Human-readable error message")]
+    retry_after: Annotated[
+        float | None, Field(description="Seconds to wait before retrying the operation", ge=0.0)
+    ] = None
+    suggestion: Annotated[str | None, Field(description="Suggested fix for the error")] = None

adcp/types/generated_poc/flat_rate_option.py

@@ -0,0 +1,93 @@
+# generated by datamodel-codegen:
+#   filename:  flat-rate-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",
+    )
+    daypart: Annotated[
+        str | None,
+        Field(
+            description="Specific daypart for time-based pricing (e.g., 'morning_commute', 'evening_prime', 'overnight')"
+        ),
+    ] = None
+    duration_hours: Annotated[
+        float | None,
+        Field(description="Duration in hours for time-based flat rate pricing (DOOH)", ge=0.0),
+    ] = None
+    estimated_impressions: Annotated[
+        int | None,
+        Field(
+            description="Estimated impressions for this flat rate option (informational, commonly used with SOV or time-based DOOH)",
+            ge=0,
+        ),
+    ] = None
+    loop_duration_seconds: Annotated[
+        int | None, Field(description="Duration of ad loop rotation in seconds (DOOH)", ge=1)
+    ] = None
+    min_plays_per_hour: Annotated[
+        int | None,
+        Field(
+            description="Minimum number of times ad plays per hour (DOOH frequency guarantee)", ge=0
+        ),
+    ] = None
+    sov_percentage: Annotated[
+        float | None,
+        Field(
+            description="Guaranteed share of voice as percentage (DOOH, 0-100)", ge=0.0, le=100.0
+        ),
+    ] = None
+    venue_package: Annotated[
+        str | None,
+        Field(
+            description="Named venue package identifier for DOOH (e.g., 'times_square_network', 'airport_terminals')"
+        ),
+    ] = None
+
+
+class FlatRatePricingOption(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    currency: Annotated[
+        str,
+        Field(
+            description="ISO 4217 currency code",
+            examples=["USD", "EUR", "GBP", "JPY"],
+            pattern="^[A-Z]{3}$",
+        ),
+    ]
+    is_fixed: Annotated[
+        Literal[True],
+        Field(description="Whether this is a fixed rate (true) or auction-based (false)"),
+    ]
+    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 | None,
+        Field(description="Flat rate parameters for DOOH and time-based campaigns"),
+    ] = None
+    pricing_model: Annotated[
+        Literal["flat_rate"], Field(description="Fixed cost regardless of delivery volume")
+    ]
+    pricing_option_id: Annotated[
+        str,
+        Field(
+            description="Unique identifier for this pricing option within the product (e.g., 'flat_rate_usd_24h_takeover')"
+        ),
+    ]
+    rate: Annotated[float, Field(description="Flat rate cost", ge=0.0)]