adcp 2.12.0__py3-none-any.whl

adcp/types/generated_poc/core/product.py

@@ -0,0 +1,164 @@
+# generated by datamodel-codegen:
+#   filename:  core/product.json
+#   timestamp: 2025-11-22T19:54:03+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AwareDatetime, ConfigDict, Field
+
+from ..enums import delivery_type as delivery_type_1
+from ..pricing_options import (
+    cpc_option,
+    cpcv_option,
+    cpm_auction_option,
+    cpm_fixed_option,
+    cpp_option,
+    cpv_option,
+    flat_rate_option,
+    vcpm_auction_option,
+    vcpm_fixed_option,
+)
+from . import creative_policy as creative_policy_1
+from . import ext as ext_1
+from . import format_id as format_id_1
+from . import measurement as measurement_1
+from . import placement, publisher_property_selector
+from . import reporting_capabilities as reporting_capabilities_1
+
+
+class DeliveryMeasurement(AdCPBaseModel):
+    notes: Annotated[
+        str | None,
+        Field(
+            description="Additional details about measurement methodology in plain language (e.g., 'MRC-accredited viewability. 50% in-view for 1s display / 2s video', 'Panel-based demographic measurement updated monthly')"
+        ),
+    ] = None
+    provider: Annotated[
+        str,
+        Field(
+            description="Measurement provider(s) used for this product (e.g., 'Google Ad Manager with IAS viewability', 'Nielsen DAR', 'Geopath for DOOH impressions')"
+        ),
+    ]
+
+
+class ProductCard(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    format_id: Annotated[
+        format_id_1.FormatId,
+        Field(
+            description='Creative format defining the card layout (typically product_card_standard)'
+        ),
+    ]
+    manifest: Annotated[
+        dict[str, Any],
+        Field(description='Asset manifest for rendering the card, structure defined by the format'),
+    ]
+
+
+class ProductCardDetailed(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    format_id: Annotated[
+        format_id_1.FormatId,
+        Field(
+            description='Creative format defining the detailed card layout (typically product_card_detailed)'
+        ),
+    ]
+    manifest: Annotated[
+        dict[str, Any],
+        Field(
+            description='Asset manifest for rendering the detailed card, structure defined by the format'
+        ),
+    ]
+
+
+class Product(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    brief_relevance: Annotated[
+        str | None,
+        Field(
+            description='Explanation of why this product matches the brief (only included when brief is provided)'
+        ),
+    ] = None
+    creative_policy: creative_policy_1.CreativePolicy | None = None
+    delivery_measurement: Annotated[
+        DeliveryMeasurement,
+        Field(
+            description='Measurement provider and methodology for delivery metrics. The buyer accepts the declared provider as the source of truth for the buy. REQUIRED for all products.'
+        ),
+    ]
+    delivery_type: delivery_type_1.DeliveryType
+    description: Annotated[
+        str, Field(description='Detailed description of the product and its inventory')
+    ]
+    estimated_exposures: Annotated[
+        int | None,
+        Field(description='Estimated exposures/impressions for guaranteed products', ge=0),
+    ] = None
+    expires_at: Annotated[
+        AwareDatetime | None, Field(description='Expiration timestamp for custom products')
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    format_ids: Annotated[
+        list[format_id_1.FormatId],
+        Field(
+            description='Array of supported creative format IDs - structured format_id objects with agent_url and id'
+        ),
+    ]
+    is_custom: Annotated[bool | None, Field(description='Whether this is a custom product')] = None
+    measurement: measurement_1.Measurement | None = None
+    name: Annotated[str, Field(description='Human-readable product name')]
+    placements: Annotated[
+        list[placement.Placement] | None,
+        Field(
+            description='Optional array of specific placements within this product. When provided, buyers can target specific placements when assigning creatives.',
+            min_length=1,
+        ),
+    ] = None
+    pricing_options: Annotated[
+        list[
+            cpm_fixed_option.CpmFixedRatePricingOption
+            | cpm_auction_option.CpmAuctionPricingOption
+            | vcpm_fixed_option.VcpmFixedRatePricingOption
+            | vcpm_auction_option.VcpmAuctionPricingOption
+            | cpc_option.CpcPricingOption
+            | cpcv_option.CpcvPricingOption
+            | cpv_option.CpvPricingOption
+            | cpp_option.CppPricingOption
+            | flat_rate_option.FlatRatePricingOption
+        ],
+        Field(description='Available pricing models for this product', min_length=1),
+    ]
+    product_card: Annotated[
+        ProductCard | None,
+        Field(
+            description='Optional standard visual card (300x400px) for displaying this product in user interfaces. Can be rendered via preview_creative or pre-generated.'
+        ),
+    ] = None
+    product_card_detailed: Annotated[
+        ProductCardDetailed | None,
+        Field(
+            description='Optional detailed card with carousel and full specifications. Provides rich product presentation similar to media kit pages.'
+        ),
+    ] = None
+    product_id: Annotated[str, Field(description='Unique identifier for the product')]
+    publisher_properties: Annotated[
+        list[
+            publisher_property_selector.PublisherPropertySelector1
+            | publisher_property_selector.PublisherPropertySelector2
+            | publisher_property_selector.PublisherPropertySelector3
+        ],
+        Field(
+            description="Publisher properties covered by this product. Buyers fetch actual property definitions from each publisher's adagents.json and validate agent authorization. Selection patterns mirror the authorization patterns in adagents.json for consistency.",
+            min_length=1,
+        ),
+    ]
+    reporting_capabilities: reporting_capabilities_1.ReportingCapabilities | None = None

adcp/types/generated_poc/core/product_filters.py

@@ -0,0 +1,97 @@
+# generated by datamodel-codegen:
+#   filename:  core/product_filters.json
+#   timestamp: 2025-11-22T19:54:03+00:00
+
+from __future__ import annotations
+
+from datetime import date
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field, RootModel
+
+from ..enums import channels as channels_1
+from ..enums import delivery_type as delivery_type_1
+from ..enums import format_category
+from . import format_id
+
+
+class BudgetRange(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    currency: Annotated[
+        str,
+        Field(
+            description="ISO 4217 currency code (e.g., 'USD', 'EUR', 'GBP')", pattern='^[A-Z]{3}$'
+        ),
+    ]
+    max: Annotated[float | None, Field(description='Maximum budget amount', ge=0.0)] = None
+    min: Annotated[float, Field(description='Minimum budget amount', ge=0.0)]
+
+
+class BudgetRange1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    currency: Annotated[
+        str,
+        Field(
+            description="ISO 4217 currency code (e.g., 'USD', 'EUR', 'GBP')", pattern='^[A-Z]{3}$'
+        ),
+    ]
+    max: Annotated[float, Field(description='Maximum budget amount', ge=0.0)]
+    min: Annotated[float | None, Field(description='Minimum budget amount', ge=0.0)] = None
+
+
+class Country(RootModel[str]):
+    root: Annotated[str, Field(pattern='^[A-Z]{2}$')]
+
+
+class ProductFilters(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    budget_range: Annotated[
+        BudgetRange | BudgetRange1 | None,
+        Field(description='Budget range to filter appropriate products'),
+    ] = None
+    channels: Annotated[
+        list[channels_1.AdvertisingChannels] | None,
+        Field(description="Filter by advertising channels (e.g., ['display', 'video', 'dooh'])"),
+    ] = None
+    countries: Annotated[
+        list[Country] | None,
+        Field(
+            description="Filter by target countries using ISO 3166-1 alpha-2 country codes (e.g., ['US', 'CA', 'GB'])"
+        ),
+    ] = None
+    delivery_type: delivery_type_1.DeliveryType | None = None
+    end_date: Annotated[
+        date | None,
+        Field(
+            description='Campaign end date (ISO 8601 date format: YYYY-MM-DD) for availability checks'
+        ),
+    ] = None
+    format_ids: Annotated[
+        list[format_id.FormatId] | None, Field(description='Filter by specific format IDs')
+    ] = None
+    format_types: Annotated[
+        list[format_category.FormatCategory] | None, Field(description='Filter by format types')
+    ] = None
+    is_fixed_price: Annotated[
+        bool | None, Field(description='Filter for fixed price vs auction products')
+    ] = None
+    min_exposures: Annotated[
+        int | None,
+        Field(description='Minimum exposures/impressions needed for measurement validity', ge=1),
+    ] = None
+    standard_formats_only: Annotated[
+        bool | None, Field(description='Only return products accepting IAB standard formats')
+    ] = None
+    start_date: Annotated[
+        date | None,
+        Field(
+            description='Campaign start date (ISO 8601 date format: YYYY-MM-DD) for availability checks'
+        ),
+    ] = None

adcp/types/generated_poc/core/promoted_offerings.py

@@ -0,0 +1,102 @@
+# generated by datamodel-codegen:
+#   filename:  core/promoted_offerings.json
+#   timestamp: 2025-11-22T15:23:24+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 brand_manifest as brand_manifest_1
+from . import promoted_products
+
+
+class AssetType(Enum):
+    image = 'image'
+    video = 'video'
+    audio = 'audio'
+    vast = 'vast'
+    daast = 'daast'
+    text = 'text'
+    url = 'url'
+    html = 'html'
+    css = 'css'
+    javascript = 'javascript'
+    webhook = 'webhook'
+
+
+class AssetSelectors(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    asset_types: Annotated[
+        list[AssetType] | None, Field(description="Filter by asset type (e.g., ['image', 'video'])")
+    ] = None
+    exclude_tags: Annotated[
+        list[str] | None, Field(description='Exclude assets with these tags')
+    ] = None
+    tags: Annotated[
+        list[str] | None,
+        Field(description="Select assets with specific tags (e.g., ['holiday', 'premium'])"),
+    ] = None
+
+
+class Offering(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    assets: Annotated[
+        list[dict[str, Any]] | None, Field(description='Assets specific to this offering')
+    ] = None
+    description: Annotated[str | None, Field(description="Description of what's being offered")] = (
+        None
+    )
+    name: Annotated[
+        str, Field(description="Offering name (e.g., 'Winter Sale', 'New Product Launch')")
+    ]
+
+
+class PromotedOfferings(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    asset_selectors: Annotated[
+        AssetSelectors | None,
+        Field(description='Selectors to choose specific assets from the brand manifest'),
+    ] = None
+    brand_manifest: Annotated[
+        brand_manifest_1.BrandManifest | AnyUrl,
+        Field(
+            description='Brand information manifest containing assets, themes, and guidelines. Can be provided inline or as a URL reference to a hosted manifest.',
+            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',
+        ),
+    ]
+    offerings: Annotated[
+        list[Offering] | None,
+        Field(
+            description='Inline offerings for campaigns without a product catalog. Each offering has a name, description, and associated assets.'
+        ),
+    ] = None
+    product_selectors: Annotated[
+        promoted_products.PromotedProducts | None,
+        Field(
+            description='Selectors to choose which products/offerings from the brand manifest product catalog to promote'
+        ),
+    ] = None

adcp/types/generated_poc/core/promoted_products.py

@@ -0,0 +1,38 @@
+# generated by datamodel-codegen:
+#   filename:  core/promoted_products.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 PromotedProducts(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    manifest_category: Annotated[
+        str | None,
+        Field(
+            description="Select products from a specific category in the brand manifest product catalog (e.g., 'beverages/soft-drinks', 'food/sauces')"
+        ),
+    ] = None
+    manifest_query: Annotated[
+        str | None,
+        Field(
+            description="Natural language query to select products from the brand manifest (e.g., 'all Kraft Heinz pasta sauces', 'organic products under $20')"
+        ),
+    ] = None
+    manifest_skus: Annotated[
+        list[str] | None,
+        Field(description='Direct product SKU references from the brand manifest product catalog'),
+    ] = None
+    manifest_tags: Annotated[
+        list[str] | None,
+        Field(
+            description="Select products by tags from the brand manifest product catalog (e.g., 'organic', 'sauces', 'holiday')"
+        ),
+    ] = None

adcp/types/generated_poc/core/property.py

@@ -0,0 +1,64 @@
+# generated by datamodel-codegen:
+#   filename:  core/property.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 identifier_types
+from ..enums import property_type as property_type_1
+from . import property_tag
+
+
+class Identifier(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    type: Annotated[
+        identifier_types.PropertyIdentifierTypes,
+        Field(description='Type of identifier for this property'),
+    ]
+    value: Annotated[
+        str,
+        Field(
+            description="The identifier value. For domain type: 'example.com' matches base domain plus www and m subdomains; 'edition.example.com' matches that specific subdomain; '*.example.com' matches ALL subdomains but NOT base domain"
+        ),
+    ]
+
+
+class Property(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    identifiers: Annotated[
+        list[Identifier], Field(description='Array of identifiers for this property', min_length=1)
+    ]
+    name: Annotated[str, Field(description='Human-readable property name')]
+    property_id: Annotated[
+        str | None,
+        Field(
+            description='Unique identifier for this property (optional). Enables referencing properties by ID instead of repeating full objects.',
+            examples=['cnn_ctv_app', 'homepage', 'mobile_ios', 'instagram'],
+            pattern='^[a-z0-9_]+$',
+            title='Property ID',
+        ),
+    ] = None
+    property_type: Annotated[
+        property_type_1.PropertyType, Field(description='Type of advertising property')
+    ]
+    publisher_domain: Annotated[
+        str | None,
+        Field(
+            description='Domain where adagents.json should be checked for authorization validation. Required for list_authorized_properties response. Optional in adagents.json (file location implies domain).'
+        ),
+    ] = None
+    tags: Annotated[
+        list[property_tag.PropertyTag] | None,
+        Field(
+            description='Tags for categorization and grouping (e.g., network membership, content categories)'
+        ),
+    ] = None

adcp/types/generated_poc/core/property_id.py

@@ -0,0 +1,21 @@
+# generated by datamodel-codegen:
+#   filename:  core/property_id.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from pydantic import Field, RootModel
+
+
+class PropertyId(RootModel[str]):
+    root: Annotated[
+        str,
+        Field(
+            description='Identifier for a publisher property. Must be lowercase alphanumeric with underscores only.',
+            examples=['cnn_ctv_app', 'homepage', 'mobile_ios', 'instagram'],
+            pattern='^[a-z0-9_]+$',
+            title='Property ID',
+        ),
+    ]

adcp/types/generated_poc/core/property_tag.py

@@ -0,0 +1,21 @@
+# generated by datamodel-codegen:
+#   filename:  core/property_tag.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from pydantic import Field, RootModel
+
+
+class PropertyTag(RootModel[str]):
+    root: Annotated[
+        str,
+        Field(
+            description='Tag for categorizing publisher properties. Must be lowercase alphanumeric with underscores only.',
+            examples=['ctv', 'premium', 'news', 'sports', 'meta_network', 'social_media'],
+            pattern='^[a-z0-9_]+$',
+            title='Property Tag',
+        ),
+    ]

adcp/types/generated_poc/core/protocol_envelope.py

@@ -0,0 +1,61 @@
+# generated by datamodel-codegen:
+#   filename:  core/protocol_envelope.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 AwareDatetime, ConfigDict, Field
+
+from ..enums import task_status
+from . import push_notification_config as push_notification_config_1
+
+
+class ProtocolEnvelope(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context_id: Annotated[
+        str | None,
+        Field(
+            description='Session/conversation identifier for tracking related operations across multiple task invocations. Managed by the protocol layer to maintain conversational context.'
+        ),
+    ] = None
+    message: Annotated[
+        str | None,
+        Field(
+            description='Human-readable summary of the task result. Provides natural language explanation of what happened, suitable for display to end users or for AI agent comprehension. Generated by the protocol layer based on the task response.'
+        ),
+    ] = None
+    payload: Annotated[
+        dict[str, Any],
+        Field(
+            description='The actual task-specific response data. This is the content defined in individual task response schemas (e.g., get-products-response.json, create-media-buy-response.json). Contains only domain-specific data without protocol-level fields.'
+        ),
+    ]
+    push_notification_config: Annotated[
+        push_notification_config_1.PushNotificationConfig | None,
+        Field(
+            description='Push notification configuration for async task updates (A2A and REST protocols). Echoed from the request to confirm webhook settings. Specifies URL, authentication scheme (Bearer or HMAC-SHA256), and credentials. MCP uses progress notifications instead of webhooks.'
+        ),
+    ] = None
+    status: Annotated[
+        task_status.TaskStatus,
+        Field(
+            description='Current task execution state. Indicates whether the task is completed, in progress (working), submitted for async processing, failed, or requires user input. Managed by the protocol layer.'
+        ),
+    ]
+    task_id: Annotated[
+        str | None,
+        Field(
+            description='Unique identifier for tracking asynchronous operations. Present when a task requires extended processing time. Used to query task status and retrieve results when complete.'
+        ),
+    ] = None
+    timestamp: Annotated[
+        AwareDatetime | None,
+        Field(
+            description='ISO 8601 timestamp when the response was generated. Useful for debugging, logging, cache validation, and tracking async operation progress.'
+        ),
+    ] = None

adcp/types/generated_poc/core/publisher_property_selector.py

@@ -0,0 +1,75 @@
+# generated by datamodel-codegen:
+#   filename:  core/publisher_property_selector.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
+
+from . import property_id, property_tag
+
+
+class PublisherPropertySelector1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    publisher_domain: 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])?)*$',
+        ),
+    ]
+    selection_type: Annotated[
+        Literal['all'],
+        Field(
+            description='Discriminator indicating all properties from this publisher are included'
+        ),
+    ]
+
+
+class PublisherPropertySelector2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    property_ids: Annotated[
+        list[property_id.PropertyId],
+        Field(description="Specific property IDs from the publisher's adagents.json", min_length=1),
+    ]
+    publisher_domain: 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])?)*$',
+        ),
+    ]
+    selection_type: Annotated[
+        Literal['by_id'],
+        Field(description='Discriminator indicating selection by specific property IDs'),
+    ]
+
+
+class PublisherPropertySelector3(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    property_tags: Annotated[
+        list[property_tag.PropertyTag],
+        Field(
+            description="Property tags from the publisher's adagents.json. Selector covers all properties with these tags",
+            min_length=1,
+        ),
+    ]
+    publisher_domain: 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])?)*$',
+        ),
+    ]
+    selection_type: Annotated[
+        Literal['by_tag'], Field(description='Discriminator indicating selection by property tags')
+    ]