adcp 2.12.0__py3-none-any.whl

adcp/types/generated_poc/core/creative_assignment.py

@@ -0,0 +1,27 @@
+# generated by datamodel-codegen:
+#   filename:  core/creative_assignment.json
+#   timestamp: 2025-11-22T15:23:24+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

adcp/types/generated_poc/core/creative_filters.py

@@ -0,0 +1,86 @@
+# generated by datamodel-codegen:
+#   filename:  core/creative_filters.json
+#   timestamp: 2025-11-22T16:02:47+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AwareDatetime, ConfigDict, Field
+
+from ..enums import creative_status
+
+
+class CreativeFilters(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    assigned_to_package: Annotated[
+        str | None, Field(description='Filter creatives assigned to this specific package')
+    ] = None
+    assigned_to_packages: Annotated[
+        list[str] | None, Field(description='Filter creatives assigned to any of these packages')
+    ] = None
+    buyer_refs: Annotated[
+        list[str] | None,
+        Field(
+            description='Filter creatives assigned to media buys with any of these buyer references'
+        ),
+    ] = None
+    created_after: Annotated[
+        AwareDatetime | None,
+        Field(description='Filter creatives created after this date (ISO 8601)'),
+    ] = None
+    created_before: Annotated[
+        AwareDatetime | None,
+        Field(description='Filter creatives created before this date (ISO 8601)'),
+    ] = None
+    creative_ids: Annotated[
+        list[str] | None, Field(description='Filter by specific creative IDs', max_length=100)
+    ] = None
+    format: Annotated[
+        str | None,
+        Field(description='Filter by creative format type (e.g., video, audio, display)'),
+    ] = None
+    formats: Annotated[
+        list[str] | None, Field(description='Filter by multiple creative format types')
+    ] = None
+    has_performance_data: Annotated[
+        bool | None, Field(description='Filter creatives that have performance data when true')
+    ] = None
+    media_buy_ids: Annotated[
+        list[str] | None, Field(description='Filter creatives assigned to any of these media buys')
+    ] = None
+    name_contains: Annotated[
+        str | None,
+        Field(description='Filter by creative names containing this text (case-insensitive)'),
+    ] = None
+    status: Annotated[
+        creative_status.CreativeStatus | None,
+        Field(description='Filter by creative approval status'),
+    ] = None
+    statuses: Annotated[
+        list[creative_status.CreativeStatus] | None,
+        Field(description='Filter by multiple creative statuses'),
+    ] = None
+    tags: Annotated[
+        list[str] | None, Field(description='Filter by creative tags (all tags must match)')
+    ] = None
+    tags_any: Annotated[
+        list[str] | None, Field(description='Filter by creative tags (any tag must match)')
+    ] = None
+    unassigned: Annotated[
+        bool | None,
+        Field(
+            description='Filter for unassigned creatives when true, assigned creatives when false'
+        ),
+    ] = None
+    updated_after: Annotated[
+        AwareDatetime | None,
+        Field(description='Filter creatives last updated after this date (ISO 8601)'),
+    ] = None
+    updated_before: Annotated[
+        AwareDatetime | None,
+        Field(description='Filter creatives last updated before this date (ISO 8601)'),
+    ] = None

adcp/types/generated_poc/core/creative_manifest.py

@@ -0,0 +1,68 @@
+# generated by datamodel-codegen:
+#   filename:  core/creative_manifest.json
+#   timestamp: 2025-11-22T19:54:03+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+from . import ext as ext_1
+from . import format_id as format_id_1
+from . import promoted_offerings
+from .assets import (
+    audio_asset,
+    css_asset,
+    daast_asset,
+    html_asset,
+    image_asset,
+    javascript_asset,
+    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."
+        ),
+    ]
+    ext: ext_1.ExtensionObject | None = None
+    format_id: Annotated[
+        format_id_1.FormatId,
+        Field(
+            description="Format identifier this manifest is for. Can be a template format (id only) or a deterministic format (id + dimensions/duration). For dimension-specific creatives, include width/height/unit in the format_id to create a unique identifier (e.g., {id: 'display_static', width: 300, height: 250, unit: 'px'})."
+        ),
+    ]
+    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/core/creative_policy.py

@@ -0,0 +1,28 @@
+# generated by datamodel-codegen:
+#   filename:  core/creative_policy.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+from ..enums import co_branding_requirement, landing_page_requirement
+
+
+class CreativePolicy(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    co_branding: Annotated[
+        co_branding_requirement.CoBrandingRequirement, Field(description='Co-branding requirement')
+    ]
+    landing_page: Annotated[
+        landing_page_requirement.LandingPageRequirement,
+        Field(description='Landing page requirements'),
+    ]
+    templates_available: Annotated[
+        bool, Field(description='Whether creative templates are provided')
+    ]

adcp/types/generated_poc/core/delivery_metrics.py

@@ -0,0 +1,111 @@
+# generated by datamodel-codegen:
+#   filename:  core/delivery_metrics.json
+#   timestamp: 2025-11-22T15:23:24+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/core/deployment.py

@@ -0,0 +1,78 @@
+# generated by datamodel-codegen:
+#   filename:  core/deployment.json
+#   timestamp: 2025-11-22T15:23:24+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 deployment.',
+            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 deployment')
+    ]
+    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 deployment.',
+            title='Activation Key',
+        ),
+    ] = None
+    agent_url: Annotated[AnyUrl, Field(description='URL identifying the deployment 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 deployment')
+    ]
+    type: Annotated[
+        Literal['agent'],
+        Field(description='Discriminator indicating this is an agent URL-based deployment'),
+    ]

adcp/types/generated_poc/core/destination.py

@@ -0,0 +1,43 @@
+# generated by datamodel-codegen:
+#   filename:  core/destination.json
+#   timestamp: 2025-11-22T15:23:24+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 deployment'),
+    ]
+
+
+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 deployment agent (for sales agents, etc.)')
+    ]
+    type: Annotated[
+        Literal['agent'],
+        Field(description='Discriminator indicating this is an agent URL-based deployment'),
+    ]

adcp/types/generated_poc/core/dimensions.py

@@ -0,0 +1,18 @@
+# generated by datamodel-codegen:
+#   filename:  core/dimensions.json
+#   timestamp: 2025-11-22T19:16:02+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+
+class Dimensions(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    height: Annotated[int, Field(description='Height in pixels', ge=1)]
+    width: Annotated[int, Field(description='Width in pixels', ge=1)]

adcp/types/generated_poc/core/error.py

@@ -0,0 +1,29 @@
+# generated by datamodel-codegen:
+#   filename:  core/error.json
+#   timestamp: 2025-11-22T15:23:24+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/core/ext.py

@@ -0,0 +1,15 @@
+# generated by datamodel-codegen:
+#   filename:  core/ext.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict
+
+
+class ExtensionObject(AdCPBaseModel):
+    pass
+    model_config = ConfigDict(
+        extra='allow',
+    )