adcp 2.12.0__py3-none-any.whl

adcp/types/generated_poc/pricing_options/flat_rate_option.py

@@ -0,0 +1,93 @@
+# generated by datamodel-codegen:
+#   filename:  pricing_options/flat_rate_option.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 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)]

adcp/types/generated_poc/pricing_options/vcpm_auction_option.py

@@ -0,0 +1,61 @@
+# generated by datamodel-codegen:
+#   filename:  pricing_options/vcpm_auction_option.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 ConfigDict, Field
+
+
+class PriceGuidance(AdCPBaseModel):
+    floor: Annotated[float, Field(description='Minimum acceptable bid price', ge=0.0)]
+    p25: Annotated[
+        float | None, Field(description='25th percentile of recent winning bids', ge=0.0)
+    ] = None
+    p50: Annotated[float | None, Field(description='Median of recent winning bids', ge=0.0)] = None
+    p75: Annotated[
+        float | None, Field(description='75th percentile of recent winning bids', ge=0.0)
+    ] = None
+    p90: Annotated[
+        float | None, Field(description='90th percentile of recent winning bids', ge=0.0)
+    ] = None
+
+
+class VcpmAuctionPricingOption(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[False],
+        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
+    price_guidance: Annotated[
+        PriceGuidance, Field(description='Statistical guidance for auction pricing')
+    ]
+    pricing_model: Annotated[
+        Literal['vcpm'], Field(description='Cost per 1,000 viewable impressions (MRC standard)')
+    ]
+    pricing_option_id: Annotated[
+        str,
+        Field(
+            description="Unique identifier for this pricing option within the product (e.g., 'vcpm_usd_auction')"
+        ),
+    ]

adcp/types/generated_poc/pricing_options/vcpm_fixed_option.py

@@ -0,0 +1,47 @@
+# generated by datamodel-codegen:
+#   filename:  pricing_options/vcpm_fixed_option.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 ConfigDict, Field
+
+
+class VcpmFixedRatePricingOption(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
+    pricing_model: Annotated[
+        Literal['vcpm'], Field(description='Cost per 1,000 viewable impressions (MRC standard)')
+    ]
+    pricing_option_id: Annotated[
+        str,
+        Field(
+            description="Unique identifier for this pricing option within the product (e.g., 'vcpm_usd_guaranteed')"
+        ),
+    ]
+    rate: Annotated[
+        float, Field(description='Fixed vCPM rate (cost per 1,000 viewable impressions)', ge=0.0)
+    ]

adcp/types/generated_poc/protocols/__init__.py

@@ -0,0 +1,3 @@
+# generated by datamodel-codegen:
+#   filename:  .schema_temp
+#   timestamp: 2025-11-22T16:02:47+00:00

adcp/types/generated_poc/protocols/adcp_extension.py

@@ -0,0 +1,37 @@
+# generated by datamodel-codegen:
+#   filename:  protocols/adcp_extension.json
+#   timestamp: 2025-11-22T16:02:47+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 ProtocolsSupportedEnum(Enum):
+    media_buy = 'media_buy'
+    creative = 'creative'
+    signals = 'signals'
+
+
+class AdcpAgentCardExtension(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    adcp_version: Annotated[
+        str,
+        Field(
+            description="Semantic version of the AdCP specification this agent implements (e.g., '2.4.0')",
+            pattern='^\\d+\\.\\d+\\.\\d+$',
+        ),
+    ]
+    protocols_supported: Annotated[
+        list[ProtocolsSupportedEnum],
+        Field(
+            description='AdCP protocol domains supported by this agent. At least one must be specified.',
+            min_length=1,
+        ),
+    ]

adcp/types/generated_poc/signals/__init__.py

@@ -0,0 +1,3 @@
+# generated by datamodel-codegen:
+#   filename:  .schema_temp
+#   timestamp: 2025-11-22T15:23:24+00:00

adcp/types/generated_poc/signals/activate_signal_request.py

@@ -0,0 +1,32 @@
+# generated by datamodel-codegen:
+#   filename:  signals/activate_signal_request.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 ..core import context as context_1
+from ..core import destination
+from ..core import ext as ext_1
+
+
+class ActivateSignalRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context: context_1.ContextObject | None = None
+    deployments: Annotated[
+        list[destination.Destination1 | destination.Destination2],
+        Field(
+            description='Target deployment(s) for activation. If the authenticated caller matches one of these deployment targets, activation keys will be included in the response.',
+            min_length=1,
+        ),
+    ]
+    ext: ext_1.ExtensionObject | None = None
+    signal_agent_segment_id: Annotated[
+        str, Field(description='The universal identifier for the signal to activate')
+    ]

adcp/types/generated_poc/signals/activate_signal_response.py

@@ -0,0 +1,51 @@
+# generated by datamodel-codegen:
+#   filename:  signals/activate_signal_response.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, RootModel
+
+from ..core import context as context_1
+from ..core import deployment, error
+from ..core import ext as ext_1
+
+
+class ActivateSignalResponse1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context: context_1.ContextObject | None = None
+    deployments: Annotated[
+        list[deployment.Deployment1 | deployment.Deployment2],
+        Field(description='Array of deployment results for each deployment target'),
+    ]
+    ext: ext_1.ExtensionObject | None = None
+
+
+class ActivateSignalResponse2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context: context_1.ContextObject | None = None
+    errors: Annotated[
+        list[error.Error],
+        Field(
+            description='Array of errors explaining why activation failed (e.g., platform connectivity issues, signal definition problems, authentication failures)',
+            min_length=1,
+        ),
+    ]
+    ext: ext_1.ExtensionObject | None = None
+
+
+class ActivateSignalResponse(RootModel[ActivateSignalResponse1 | ActivateSignalResponse2]):
+    root: Annotated[
+        ActivateSignalResponse1 | ActivateSignalResponse2,
+        Field(
+            description='Response payload for activate_signal task. Returns either complete success data OR error information, never both. This enforces atomic operation semantics - the signal is either fully activated or not activated at all.',
+            title='Activate Signal Response',
+        ),
+    ]

adcp/types/generated_poc/signals/get_signals_request.py

@@ -0,0 +1,53 @@
+# generated by datamodel-codegen:
+#   filename:  signals/get_signals_request.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, RootModel
+
+from ..core import context as context_1
+from ..core import destination
+from ..core import ext as ext_1
+from ..core import signal_filters
+
+
+class Country(RootModel[str]):
+    root: Annotated[str, Field(pattern='^[A-Z]{2}$')]
+
+
+class DeliverTo(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    countries: Annotated[
+        list[Country], Field(description='Countries where signals will be used (ISO codes)')
+    ]
+    deployments: Annotated[
+        list[destination.Destination1 | destination.Destination2],
+        Field(
+            description='List of deployment targets (DSPs, sales agents, etc.). If the authenticated caller matches one of these deployment targets, activation keys will be included in the response.',
+            min_length=1,
+        ),
+    ]
+
+
+class GetSignalsRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context: context_1.ContextObject | None = None
+    deliver_to: Annotated[
+        DeliverTo, Field(description='Deployment targets where signals need to be activated')
+    ]
+    ext: ext_1.ExtensionObject | None = None
+    filters: signal_filters.SignalFilters | None = None
+    max_results: Annotated[
+        int | None, Field(description='Maximum number of results to return', ge=1)
+    ] = None
+    signal_spec: Annotated[
+        str, Field(description='Natural language description of the desired signals')
+    ]

adcp/types/generated_poc/signals/get_signals_response.py

@@ -0,0 +1,59 @@
+# generated by datamodel-codegen:
+#   filename:  signals/get_signals_response.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 ..core import context as context_1
+from ..core import deployment, error
+from ..core import ext as ext_1
+from ..enums import signal_catalog_type
+
+
+class Pricing(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    cpm: Annotated[float, Field(description='Cost per thousand impressions', ge=0.0)]
+    currency: Annotated[str, Field(description='Currency code', pattern='^[A-Z]{3}$')]
+
+
+class Signal(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    coverage_percentage: Annotated[
+        float, Field(description='Percentage of audience coverage', ge=0.0, le=100.0)
+    ]
+    data_provider: Annotated[str, Field(description='Name of the data provider')]
+    deployments: Annotated[
+        list[deployment.Deployment1 | deployment.Deployment2],
+        Field(description='Array of deployment targets'),
+    ]
+    description: Annotated[str, Field(description='Detailed signal description')]
+    name: Annotated[str, Field(description='Human-readable signal name')]
+    pricing: Annotated[Pricing, Field(description='Pricing information')]
+    signal_agent_segment_id: Annotated[str, Field(description='Unique identifier for the signal')]
+    signal_type: Annotated[
+        signal_catalog_type.SignalCatalogType, Field(description='Type of signal')
+    ]
+
+
+class GetSignalsResponse(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context: context_1.ContextObject | None = None
+    errors: Annotated[
+        list[error.Error] | None,
+        Field(
+            description='Task-specific errors and warnings (e.g., signal discovery or pricing issues)'
+        ),
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    signals: Annotated[list[Signal], Field(description='Array of matching signals')]

adcp/utils/__init__.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+"""Utility functions."""
+
+from adcp.utils.operation_id import create_operation_id
+
+__all__ = ["create_operation_id"]

adcp/utils/operation_id.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+"""Operation ID generation utilities."""
+
+from uuid import uuid4
+
+
+def create_operation_id() -> str:
+    """
+    Generate a unique operation ID.
+
+    Returns:
+        A unique operation ID in the format 'op_{hex}'
+    """
+    return f"op_{uuid4().hex[:12]}"