adcp 2.12.0__py3-none-any.whl

adcp/types/generated_poc/core/assets/css_asset.py

@@ -0,0 +1,20 @@
+# generated by datamodel-codegen:
+#   filename:  core/assets/css_asset.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 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/core/assets/daast_asset.py

@@ -0,0 +1,61 @@
+# generated by datamodel-codegen:
+#   filename:  core/assets/daast_asset.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
+
+from ...enums import daast_tracking_event
+from ...enums import daast_version as daast_version_1
+
+
+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[
+        daast_version_1.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[daast_tracking_event.DaastTrackingEvent] | 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[
+        daast_version_1.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[daast_tracking_event.DaastTrackingEvent] | None,
+        Field(description='Tracking events supported by this DAAST tag'),
+    ] = None

adcp/types/generated_poc/core/assets/html_asset.py

@@ -0,0 +1,18 @@
+# generated by datamodel-codegen:
+#   filename:  core/assets/html_asset.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 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/core/assets/image_asset.py

@@ -0,0 +1,19 @@
+# generated by datamodel-codegen:
+#   filename:  core/assets/image_asset.json
+#   timestamp: 2025-11-22T19:16:02+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from pydantic import AnyUrl, Field
+
+from ..dimensions import Dimensions
+
+
+class ImageAsset(Dimensions):
+    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
+    url: Annotated[AnyUrl, Field(description='URL to the image asset')]

adcp/types/generated_poc/core/assets/javascript_asset.py

@@ -0,0 +1,23 @@
+# generated by datamodel-codegen:
+#   filename:  core/assets/javascript_asset.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 javascript_module_type
+
+
+class JavascriptAsset(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    content: Annotated[str, Field(description='JavaScript content')]
+    module_type: Annotated[
+        javascript_module_type.JavascriptModuleType | None,
+        Field(description='JavaScript module type'),
+    ] = None

adcp/types/generated_poc/core/assets/text_asset.py

@@ -0,0 +1,20 @@
+# generated by datamodel-codegen:
+#   filename:  core/assets/text_asset.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 TextAsset(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    content: Annotated[str, Field(description='Text content')]
+    language: Annotated[str | None, Field(description="Language code (e.g., 'en', 'es', 'fr')")] = (
+        None
+    )

adcp/types/generated_poc/core/assets/url_asset.py

@@ -0,0 +1,28 @@
+# generated by datamodel-codegen:
+#   filename:  core/assets/url_asset.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 AnyUrl, ConfigDict, Field
+
+from ...enums import url_asset_type
+
+
+class UrlAsset(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    description: Annotated[
+        str | None, Field(description='Description of what this URL points to')
+    ] = None
+    url: Annotated[AnyUrl, Field(description='URL reference')]
+    url_type: Annotated[
+        url_asset_type.UrlAssetType | None,
+        Field(
+            description="Type of URL asset: 'clickthrough' for user click destination (landing page), 'tracker_pixel' for impression/event tracking via HTTP request (fires GET, expects pixel/204 response), 'tracker_script' for measurement SDKs that must load as <script> tag (OMID verification, native event trackers using method:2)"
+        ),
+    ] = None

adcp/types/generated_poc/core/assets/vast_asset.py

@@ -0,0 +1,63 @@
+# generated by datamodel-codegen:
+#   filename:  core/assets/vast_asset.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
+
+from ...enums import vast_tracking_event
+from ...enums import vast_version as vast_version_1
+
+
+class VastAsset1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    delivery_type: Annotated[
+        Literal['url'],
+        Field(description='Discriminator indicating VAST is delivered via URL endpoint'),
+    ]
+    duration_ms: Annotated[
+        int | None, Field(description='Expected video duration in milliseconds (if known)', ge=0)
+    ] = None
+    tracking_events: Annotated[
+        list[vast_tracking_event.VastTrackingEvent] | None,
+        Field(description='Tracking events supported by this VAST tag'),
+    ] = None
+    url: Annotated[AnyUrl, Field(description='URL endpoint that returns VAST XML')]
+    vast_version: Annotated[
+        vast_version_1.VastVersion | None, Field(description='VAST specification version')
+    ] = None
+    vpaid_enabled: Annotated[
+        bool | None,
+        Field(description='Whether VPAID (Video Player-Ad Interface Definition) is supported'),
+    ] = None
+
+
+class VastAsset2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    content: Annotated[str, Field(description='Inline VAST XML content')]
+    delivery_type: Annotated[
+        Literal['inline'],
+        Field(description='Discriminator indicating VAST is delivered as inline XML content'),
+    ]
+    duration_ms: Annotated[
+        int | None, Field(description='Expected video duration in milliseconds (if known)', ge=0)
+    ] = None
+    tracking_events: Annotated[
+        list[vast_tracking_event.VastTrackingEvent] | None,
+        Field(description='Tracking events supported by this VAST tag'),
+    ] = None
+    vast_version: Annotated[
+        vast_version_1.VastVersion | None, Field(description='VAST specification version')
+    ] = None
+    vpaid_enabled: Annotated[
+        bool | None,
+        Field(description='Whether VPAID (Video Player-Ad Interface Definition) is supported'),
+    ] = None

adcp/types/generated_poc/core/assets/video_asset.py

@@ -0,0 +1,24 @@
+# generated by datamodel-codegen:
+#   filename:  core/assets/video_asset.json
+#   timestamp: 2025-11-22T19:16:02+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from pydantic import AnyUrl, Field
+
+from ..dimensions import Dimensions
+
+
+class VideoAsset(Dimensions):
+    bitrate_kbps: Annotated[
+        int | None, Field(description='Video bitrate in kilobits per second', ge=1)
+    ] = None
+    duration_ms: Annotated[
+        int | None, Field(description='Video duration in milliseconds', ge=1)
+    ] = None
+    format: Annotated[str | None, Field(description='Video file format (mp4, webm, mov, etc.)')] = (
+        None
+    )
+    url: Annotated[AnyUrl, Field(description='URL to the video asset')]

adcp/types/generated_poc/core/assets/webhook_asset.py

@@ -0,0 +1,53 @@
+# generated by datamodel-codegen:
+#   filename:  core/assets/webhook_asset.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 AnyUrl, ConfigDict, Field
+
+from ...enums import http_method, webhook_response_type, webhook_security_method
+
+
+class Security(AdCPBaseModel):
+    api_key_header: Annotated[
+        str | None, Field(description="Header name for API key (e.g., 'X-API-Key')")
+    ] = None
+    hmac_header: Annotated[
+        str | None, Field(description="Header name for HMAC signature (e.g., 'X-Signature')")
+    ] = None
+    method: Annotated[
+        webhook_security_method.WebhookSecurityMethod, Field(description='Authentication method')
+    ]
+
+
+class WebhookAsset(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    method: Annotated[http_method.HttpMethod | None, Field(description='HTTP method')] = (
+        http_method.HttpMethod.POST
+    )
+    required_macros: Annotated[
+        list[str] | None,
+        Field(description='Universal macros that must be provided for webhook to function'),
+    ] = None
+    response_type: Annotated[
+        webhook_response_type.WebhookResponseType,
+        Field(description='Expected content type of webhook response'),
+    ]
+    security: Annotated[Security, Field(description='Security configuration for webhook calls')]
+    supported_macros: Annotated[
+        list[str] | None,
+        Field(
+            description='Universal macros that can be passed to webhook (e.g., {DEVICE_TYPE}, {COUNTRY})'
+        ),
+    ] = None
+    timeout_ms: Annotated[
+        int | None,
+        Field(description='Maximum time to wait for response in milliseconds', ge=10, le=5000),
+    ] = 500
+    url: Annotated[AnyUrl, Field(description='Webhook URL to call for dynamic content')]

adcp/types/generated_poc/core/brand_manifest.py

@@ -0,0 +1,201 @@
+# generated by datamodel-codegen:
+#   filename:  core/brand_manifest.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, AwareDatetime, ConfigDict, EmailStr, Field
+
+from ..enums import asset_content_type
+
+
+class Asset(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    asset_id: Annotated[str, Field(description='Unique identifier for this asset')]
+    asset_type: Annotated[
+        asset_content_type.AssetContentType,
+        Field(
+            description='Type of asset. Note: Brand manifests typically contain basic media assets (image, video, audio, text). Code assets (html, javascript, css) and ad markup (vast, daast) are usually not part of brand asset libraries.'
+        ),
+    ]
+    description: Annotated[str | None, Field(description='Asset description or usage notes')] = None
+    duration_seconds: Annotated[
+        float | None, Field(description='Video/audio duration in seconds')
+    ] = None
+    file_size_bytes: Annotated[int | None, Field(description='File size in bytes')] = None
+    format: Annotated[str | None, Field(description="File format (e.g., 'jpg', 'mp4', 'mp3')")] = (
+        None
+    )
+    height: Annotated[int | None, Field(description='Image/video height in pixels')] = None
+    metadata: Annotated[
+        dict[str, Any] | None, Field(description='Additional asset-specific metadata')
+    ] = None
+    name: Annotated[str | None, Field(description='Human-readable asset name')] = None
+    tags: Annotated[
+        list[str] | None,
+        Field(
+            description="Tags for asset discovery (e.g., 'holiday', 'lifestyle', 'product_shot')"
+        ),
+    ] = None
+    url: Annotated[AnyUrl, Field(description='URL to CDN-hosted asset file')]
+    width: Annotated[int | None, Field(description='Image/video width in pixels')] = None
+
+
+class Colors(AdCPBaseModel):
+    accent: Annotated[
+        str | None, Field(description='Accent color (hex format)', pattern='^#[0-9A-Fa-f]{6}$')
+    ] = None
+    background: Annotated[
+        str | None, Field(description='Background color (hex format)', pattern='^#[0-9A-Fa-f]{6}$')
+    ] = None
+    primary: Annotated[
+        str | None,
+        Field(description='Primary brand color (hex format)', pattern='^#[0-9A-Fa-f]{6}$'),
+    ] = None
+    secondary: Annotated[
+        str | None,
+        Field(description='Secondary brand color (hex format)', pattern='^#[0-9A-Fa-f]{6}$'),
+    ] = None
+    text: Annotated[
+        str | None, Field(description='Text color (hex format)', pattern='^#[0-9A-Fa-f]{6}$')
+    ] = None
+
+
+class Contact(AdCPBaseModel):
+    email: Annotated[EmailStr | None, Field(description='Contact email')] = None
+    phone: Annotated[str | None, Field(description='Contact phone number')] = None
+
+
+class Disclaimer(AdCPBaseModel):
+    context: Annotated[
+        str | None,
+        Field(
+            description="When this disclaimer applies (e.g., 'financial_products', 'health_claims', 'all')"
+        ),
+    ] = None
+    required: Annotated[bool | None, Field(description='Whether this disclaimer must appear')] = (
+        True
+    )
+    text: Annotated[str, Field(description='Disclaimer text')]
+
+
+class Fonts(AdCPBaseModel):
+    font_urls: Annotated[
+        list[AnyUrl] | None, Field(description='URLs to web font files if using custom fonts')
+    ] = None
+    primary: Annotated[str | None, Field(description='Primary font family name')] = None
+    secondary: Annotated[str | None, Field(description='Secondary font family name')] = None
+
+
+class Logo(AdCPBaseModel):
+    height: Annotated[int | None, Field(description='Logo height in pixels')] = None
+    tags: Annotated[
+        list[str] | None,
+        Field(
+            description="Semantic tags describing the logo variant (e.g., 'dark', 'light', 'square', 'horizontal', 'icon')"
+        ),
+    ] = None
+    url: Annotated[AnyUrl, Field(description='URL to the logo asset')]
+    width: Annotated[int | None, Field(description='Logo width in pixels')] = None
+
+
+class Metadata(AdCPBaseModel):
+    created_date: Annotated[
+        AwareDatetime | None, Field(description='When this brand manifest was created')
+    ] = None
+    updated_date: Annotated[
+        AwareDatetime | None, Field(description='When this brand manifest was last updated')
+    ] = None
+    version: Annotated[str | None, Field(description='Brand card version number')] = None
+
+
+class FeedFormat(Enum):
+    google_merchant_center = 'google_merchant_center'
+    facebook_catalog = 'facebook_catalog'
+    custom = 'custom'
+
+
+class UpdateFrequency(Enum):
+    realtime = 'realtime'
+    hourly = 'hourly'
+    daily = 'daily'
+    weekly = 'weekly'
+
+
+class ProductCatalog(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    categories: Annotated[
+        list[str] | None,
+        Field(description='Product categories available in the catalog (for filtering)'),
+    ] = None
+    feed_format: Annotated[FeedFormat | None, Field(description='Format of the product feed')] = (
+        FeedFormat.google_merchant_center
+    )
+    feed_url: Annotated[AnyUrl, Field(description='URL to product catalog feed')]
+    last_updated: Annotated[
+        AwareDatetime | None, Field(description='When the product catalog was last updated')
+    ] = None
+    update_frequency: Annotated[
+        UpdateFrequency | None, Field(description='How frequently the product catalog is updated')
+    ] = None
+
+
+class BrandManifest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    assets: Annotated[
+        list[Asset] | None,
+        Field(
+            description='Brand asset library with explicit assets and tags. Assets are referenced inline with URLs pointing to CDN-hosted files.'
+        ),
+    ] = None
+    colors: Annotated[Colors | None, Field(description='Brand color palette')] = None
+    contact: Annotated[Contact | None, Field(description='Brand contact information')] = None
+    disclaimers: Annotated[
+        list[Disclaimer] | None,
+        Field(description='Legal disclaimers or required text that must appear in creatives'),
+    ] = None
+    fonts: Annotated[Fonts | None, Field(description='Brand typography guidelines')] = None
+    industry: Annotated[
+        str | None,
+        Field(
+            description="Industry or vertical (e.g., 'retail', 'automotive', 'finance', 'healthcare')"
+        ),
+    ] = None
+    logos: Annotated[
+        list[Logo] | None,
+        Field(description='Brand logo assets with semantic tags for different use cases'),
+    ] = None
+    metadata: Annotated[Metadata | None, Field(description='Additional brand metadata')] = None
+    name: Annotated[str, Field(description='Brand or business name')]
+    product_catalog: Annotated[
+        ProductCatalog | None,
+        Field(
+            description='Product catalog information for e-commerce advertisers. Enables SKU-level creative generation and product selection.'
+        ),
+    ] = None
+    tagline: Annotated[str | None, Field(description='Brand tagline or slogan')] = None
+    target_audience: Annotated[
+        str | None, Field(description='Primary target audience description')
+    ] = None
+    tone: Annotated[
+        str | None,
+        Field(
+            description="Brand voice and messaging tone (e.g., 'professional', 'casual', 'humorous', 'trustworthy', 'innovative')"
+        ),
+    ] = None
+    url: Annotated[
+        AnyUrl | None,
+        Field(
+            description='Primary brand URL for context and asset discovery. Creative agents can infer brand information from this URL.'
+        ),
+    ] = None

adcp/types/generated_poc/core/context.py

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

adcp/types/generated_poc/core/creative_asset.py

@@ -0,0 +1,102 @@
+# generated by datamodel-codegen:
+#   filename:  core/creative_asset.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 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,
+)
+
+
+class Input(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context_description: Annotated[
+        str | None,
+        Field(description='Natural language description of the context for AI-generated content'),
+    ] = None
+    macros: Annotated[
+        dict[str, str] | None, Field(description='Macro values to apply for this preview')
+    ] = None
+    name: Annotated[str, Field(description='Human-readable name for this preview variant')]
+
+
+class CreativeAsset(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    approved: Annotated[
+        bool | None,
+        Field(
+            description='For generative creatives: set to true to approve and finalize, false to request regeneration with updated assets/message. Omit for non-generative creatives.'
+        ),
+    ] = None
+    assets: Annotated[
+        dict[
+            str,
+            image_asset.ImageAsset
+            | video_asset.VideoAsset
+            | audio_asset.AudioAsset
+            | text_asset.TextAsset
+            | html_asset.HtmlAsset
+            | css_asset.CssAsset
+            | javascript_asset.JavascriptAsset
+            | promoted_offerings.PromotedOfferings
+            | url_asset.UrlAsset
+            | vast_asset.VastAsset1
+            | vast_asset.VastAsset2
+            | daast_asset.DaastAsset1
+            | daast_asset.DaastAsset2,
+        ],
+        Field(description='Assets required by the format, keyed by asset_role'),
+    ]
+    creative_id: Annotated[str, Field(description='Unique identifier for the creative')]
+    format_id: Annotated[
+        format_id_1.FormatId,
+        Field(
+            description='Format identifier specifying which format this creative conforms to. Can be: (1) concrete format_id referencing a format with fixed dimensions, (2) template format_id referencing a template format, or (3) parameterized format_id with dimensions/duration parameters for template formats.'
+        ),
+    ]
+    inputs: Annotated[
+        list[Input] | None,
+        Field(
+            description='Preview contexts for generative formats - defines what scenarios to generate previews for'
+        ),
+    ] = None
+    name: Annotated[str, Field(description='Human-readable creative name')]
+    placement_ids: Annotated[
+        list[str] | None,
+        Field(
+            description="Optional array of placement IDs where this creative should run when uploading via create_media_buy or update_media_buy. References placement_id values from the product's placements array. If omitted, creative runs on all placements. Only used during upload to media buy - not stored in creative library.",
+            min_length=1,
+        ),
+    ] = None
+    tags: Annotated[
+        list[str] | None, Field(description='User-defined tags for organization and searchability')
+    ] = None
+    weight: Annotated[
+        float | None,
+        Field(
+            description='Optional delivery weight for creative rotation when uploading via create_media_buy or update_media_buy (0-100). If omitted, platform determines rotation. Only used during upload to media buy - not stored in creative library.',
+            ge=0.0,
+            le=100.0,
+        ),
+    ] = None