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

adcp/types/generated_poc/get_products_response.py

@@ -0,0 +1,29 @@
+# generated by datamodel-codegen:
+#   filename:  get-products-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
+
+from . import error, product
+
+
+class GetProductsResponse(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] | None,
+        Field(description="Task-specific errors and warnings (e.g., product filtering issues)"),
+    ] = None
+    products: Annotated[list[product.Product], Field(description="Array of matching products")]

adcp/types/generated_poc/get_signals_request.py

@@ -0,0 +1,77 @@
+# generated by datamodel-codegen:
+#   filename:  get-signals-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 ConfigDict, Field, RootModel
+
+from . import destination
+
+
+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)")
+    ]
+    destinations: Annotated[
+        list[destination.Destination1 | destination.Destination2],
+        Field(
+            description="List of destination platforms (DSPs, sales agents, etc.). If the authenticated caller matches one of these destinations, activation keys will be included in the response.",
+            min_length=1,
+        ),
+    ]
+
+
+class CatalogType(Enum):
+    marketplace = "marketplace"
+    custom = "custom"
+    owned = "owned"
+
+
+class Filters(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    catalog_types: Annotated[
+        list[CatalogType] | None, Field(description="Filter by catalog type")
+    ] = None
+    data_providers: Annotated[
+        list[str] | None, Field(description="Filter by specific data providers")
+    ] = None
+    max_cpm: Annotated[float | None, Field(description="Maximum CPM price filter", ge=0.0)] = None
+    min_coverage_percentage: Annotated[
+        float | None, Field(description="Minimum coverage requirement", ge=0.0, le=100.0)
+    ] = None
+
+
+class GetSignalsRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    context: Annotated[
+        dict[str, Any] | None,
+        Field(
+            description="Initiator-provided context included in the request payload. Agents must echo this value back unchanged in responses and webhooks. Use for UI/session hints, correlation tokens, or tracking metadata."
+        ),
+    ] = None
+    deliver_to: Annotated[
+        DeliverTo, Field(description="Destination platforms where signals need to be activated")
+    ]
+    filters: Annotated[Filters | None, Field(description="Filters to refine results")] = 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/get_signals_response.py

@@ -0,0 +1,65 @@
+# generated by datamodel-codegen:
+#   filename:  get-signals-response.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 ConfigDict, Field
+
+from . import deployment, error
+
+
+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 SignalType(Enum):
+    marketplace = "marketplace"
+    custom = "custom"
+    owned = "owned"
+
+
+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 destination deployments"),
+    ]
+    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[SignalType, Field(description="Type of signal")]
+
+
+class GetSignalsResponse(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] | None,
+        Field(
+            description="Task-specific errors and warnings (e.g., signal discovery or pricing issues)"
+        ),
+    ] = None
+    signals: Annotated[list[Signal], Field(description="Array of matching signals")]

adcp/types/generated_poc/html_asset.py

@@ -0,0 +1,18 @@
+# generated by datamodel-codegen:
+#   filename:  html-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 HtmlAsset(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    content: Annotated[str, Field(description="HTML content")]
+    version: Annotated[str | None, Field(description="HTML version (e.g., 'HTML5')")] = None

adcp/types/generated_poc/identifier_types.py

@@ -0,0 +1,29 @@
+# generated by datamodel-codegen:
+#   filename:  identifier-types.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class PropertyIdentifierTypes(Enum):
+    domain = "domain"
+    subdomain = "subdomain"
+    network_id = "network_id"
+    ios_bundle = "ios_bundle"
+    android_package = "android_package"
+    apple_app_store_id = "apple_app_store_id"
+    google_play_id = "google_play_id"
+    roku_store_id = "roku_store_id"
+    fire_tv_asin = "fire_tv_asin"
+    samsung_app_id = "samsung_app_id"
+    apple_tv_bundle = "apple_tv_bundle"
+    bundle_id = "bundle_id"
+    venue_id = "venue_id"
+    screen_id = "screen_id"
+    openooh_venue_type = "openooh_venue_type"
+    rss_url = "rss_url"
+    apple_podcast_id = "apple_podcast_id"
+    spotify_show_id = "spotify_show_id"
+    podcast_guid = "podcast_guid"

adcp/types/generated_poc/image_asset.py

@@ -0,0 +1,23 @@
+# generated by datamodel-codegen:
+#   filename:  image-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 AnyUrl, ConfigDict, Field
+
+
+class ImageAsset(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    alt_text: Annotated[str | None, Field(description="Alternative text for accessibility")] = None
+    format: Annotated[
+        str | None, Field(description="Image file format (jpg, png, gif, webp, etc.)")
+    ] = None
+    height: Annotated[int | None, Field(description="Image height in pixels", ge=1)] = None
+    url: Annotated[AnyUrl, Field(description="URL to the image asset")]
+    width: Annotated[int | None, Field(description="Image width in pixels", ge=1)] = None

adcp/types/generated_poc/index.py

@@ -0,0 +1,17 @@
+# generated by datamodel-codegen:
+#   filename:  json
+#   timestamp: 2025-11-15T17:40:38+00:00
+
+from __future__ import annotations
+
+from typing import Any
+
+from pydantic import Field, RootModel
+
+
+class AdcpAssetTypeRegistry(RootModel[Any]):
+    root: Any = Field(
+        ...,
+        description="Registry of asset types used in AdCP creative manifests. Each asset type defines the structure of actual content payloads (what you send), not requirements or constraints (which belong in format specifications).",
+        title="AdCP Asset Type Registry",
+    )

adcp/types/generated_poc/javascript_asset.py

@@ -0,0 +1,25 @@
+# generated by datamodel-codegen:
+#   filename:  javascript-asset.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 ModuleType(Enum):
+    esm = "esm"
+    commonjs = "commonjs"
+    script = "script"
+
+
+class JavascriptAsset(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    content: Annotated[str, Field(description="JavaScript content")]
+    module_type: Annotated[ModuleType | None, Field(description="JavaScript module type")] = None

adcp/types/generated_poc/list_authorized_properties_request.py

@@ -0,0 +1,39 @@
+# generated by datamodel-codegen:
+#   filename:  list-authorized-properties-request.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
+
+
+class PublisherDomain(RootModel[str]):
+    root: Annotated[
+        str,
+        Field(
+            description="Publisher domain to filter by (e.g., 'cnn.com', 'espn.com')",
+            pattern="^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$",
+        ),
+    ]
+
+
+class ListAuthorizedPropertiesRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    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
+    publisher_domains: Annotated[
+        list[PublisherDomain] | None,
+        Field(
+            description="Filter to specific publisher domains (optional). If omitted, returns all publishers this agent represents.",
+            min_length=1,
+        ),
+    ] = None

adcp/types/generated_poc/list_authorized_properties_response.py

@@ -0,0 +1,85 @@
+# generated by datamodel-codegen:
+#   filename:  list-authorized-properties-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 channels, error
+
+
+class PrimaryCountry(RootModel[str]):
+    root: Annotated[str, Field(pattern="^[A-Z]{2}$")]
+
+
+class PublisherDomain(RootModel[str]):
+    root: Annotated[
+        str,
+        Field(
+            description="Domain where publisher's adagents.json is hosted (e.g., 'cnn.com')",
+            pattern="^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$",
+        ),
+    ]
+
+
+class ListAuthorizedPropertiesResponse(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    advertising_policies: Annotated[
+        str | None,
+        Field(
+            description="Publisher's advertising content policies, restrictions, and guidelines in natural language. May include prohibited categories, blocked advertisers, restricted tactics, brand safety requirements, or links to full policy documentation.",
+            max_length=10000,
+            min_length=1,
+        ),
+    ] = None
+    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] | None,
+        Field(description="Task-specific errors and warnings (e.g., property availability issues)"),
+    ] = None
+    last_updated: Annotated[
+        AwareDatetime | None,
+        Field(
+            description="ISO 8601 timestamp of when the agent's publisher authorization list was last updated. Buyers can use this to determine if their cached publisher adagents.json files might be stale."
+        ),
+    ] = None
+    portfolio_description: Annotated[
+        str | None,
+        Field(
+            description="Markdown-formatted description of the property portfolio, including inventory types, audience characteristics, and special features.",
+            max_length=5000,
+            min_length=1,
+        ),
+    ] = None
+    primary_channels: Annotated[
+        list[channels.AdvertisingChannels] | None,
+        Field(
+            description="Primary advertising channels represented in this property portfolio. Helps buying agents quickly filter relevance.",
+            min_length=1,
+        ),
+    ] = None
+    primary_countries: Annotated[
+        list[PrimaryCountry] | None,
+        Field(
+            description="Primary countries (ISO 3166-1 alpha-2 codes) where properties are concentrated. Helps buying agents quickly filter relevance.",
+            min_length=1,
+        ),
+    ] = None
+    publisher_domains: Annotated[
+        list[PublisherDomain],
+        Field(
+            description="Publisher domains this agent is authorized to represent. Buyers should fetch each publisher's adagents.json to see property definitions and verify this agent is in their authorized_agents list with authorization scope.",
+            min_length=1,
+        ),
+    ]

adcp/types/generated_poc/list_creative_formats_request.py

@@ -0,0 +1,93 @@
+# generated by datamodel-codegen:
+#   filename:  list-creative-formats-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 ConfigDict, Field
+
+from . import format_id
+
+
+class AssetType(Enum):
+    image = "image"
+    video = "video"
+    audio = "audio"
+    text = "text"
+    html = "html"
+    javascript = "javascript"
+    url = "url"
+
+
+class Type(Enum):
+    audio = "audio"
+    video = "video"
+    display = "display"
+    dooh = "dooh"
+
+
+class ListCreativeFormatsRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    asset_types: Annotated[
+        list[AssetType] | None,
+        Field(
+            description="Filter to formats that include these asset types. For third-party tags, search for 'html' or 'javascript'. E.g., ['image', 'text'] returns formats with images and text, ['javascript'] returns formats accepting JavaScript tags."
+        ),
+    ] = None
+    context: Annotated[
+        dict[str, Any] | None,
+        Field(
+            description="Initiator-provided context included in the request payload. Agents must echo this value back unchanged in responses and webhooks. Use for UI/session hints, correlation tokens, or tracking metadata."
+        ),
+    ] = None
+    format_ids: Annotated[
+        list[format_id.FormatId] | None,
+        Field(
+            description="Return only these specific format IDs (e.g., from get_products response)"
+        ),
+    ] = None
+    is_responsive: Annotated[
+        bool | None,
+        Field(
+            description="Filter for responsive formats that adapt to container size. When true, returns formats without fixed dimensions."
+        ),
+    ] = None
+    max_height: Annotated[
+        int | None,
+        Field(
+            description="Maximum height in pixels (inclusive). Returns formats where ANY render has height <= this value. For multi-render formats, matches if at least one render fits."
+        ),
+    ] = None
+    max_width: Annotated[
+        int | None,
+        Field(
+            description="Maximum width in pixels (inclusive). Returns formats where ANY render has width <= this value. For multi-render formats, matches if at least one render fits."
+        ),
+    ] = None
+    min_height: Annotated[
+        int | None,
+        Field(
+            description="Minimum height in pixels (inclusive). Returns formats where ANY render has height >= this value."
+        ),
+    ] = None
+    min_width: Annotated[
+        int | None,
+        Field(
+            description="Minimum width in pixels (inclusive). Returns formats where ANY render has width >= this value."
+        ),
+    ] = None
+    name_search: Annotated[
+        str | None, Field(description="Search for formats by name (case-insensitive partial match)")
+    ] = None
+    type: Annotated[
+        Type | None,
+        Field(
+            description="Filter by format type (technical categories with distinct requirements)"
+        ),
+    ] = None

adcp/types/generated_poc/list_creative_formats_response.py

@@ -0,0 +1,63 @@
+# generated by datamodel-codegen:
+#   filename:  list-creative-formats-response.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, ConfigDict, Field
+
+from . import error, format
+
+
+class Capability(Enum):
+    validation = "validation"
+    assembly = "assembly"
+    generation = "generation"
+    preview = "preview"
+
+
+class CreativeAgent(AdCPBaseModel):
+    agent_name: Annotated[
+        str | None, Field(description="Human-readable name for the creative agent")
+    ] = None
+    agent_url: Annotated[
+        AnyUrl,
+        Field(
+            description="Base URL for the creative agent (e.g., 'https://reference.adcp.org', 'https://dco.example.com'). Call list_creative_formats on this URL to get its formats."
+        ),
+    ]
+    capabilities: Annotated[
+        list[Capability] | None, Field(description="Capabilities this creative agent provides")
+    ] = None
+
+
+class ListCreativeFormatsResponse(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_agents: Annotated[
+        list[CreativeAgent] | None,
+        Field(
+            description="Optional: Creative agents that provide additional formats. Buyers can recursively query these agents to discover more formats. No authentication required for list_creative_formats."
+        ),
+    ] = None
+    errors: Annotated[
+        list[error.Error] | None,
+        Field(description="Task-specific errors and warnings (e.g., format availability issues)"),
+    ] = None
+    formats: Annotated[
+        list[format.Format],
+        Field(
+            description="Full format definitions for all formats this agent supports. Each format's authoritative source is indicated by its agent_url field."
+        ),
+    ]