adcp 2.12.0__py3-none-any.whl

adcp/types/generated_poc/enums/identifier_types.py

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

@@ -0,0 +1,13 @@
+# generated by datamodel-codegen:
+#   filename:  enums/javascript_module_type.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class JavascriptModuleType(Enum):
+    esm = 'esm'
+    commonjs = 'commonjs'
+    script = 'script'

adcp/types/generated_poc/enums/landing_page_requirement.py

@@ -0,0 +1,13 @@
+# generated by datamodel-codegen:
+#   filename:  enums/landing_page_requirement.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class LandingPageRequirement(Enum):
+    any = 'any'
+    retailer_site_only = 'retailer_site_only'
+    must_include_retailer = 'must_include_retailer'

adcp/types/generated_poc/enums/markdown_flavor.py

@@ -0,0 +1,12 @@
+# generated by datamodel-codegen:
+#   filename:  enums/markdown_flavor.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class MarkdownFlavor(Enum):
+    commonmark = 'commonmark'
+    gfm = 'gfm'

adcp/types/generated_poc/enums/media_buy_status.py

@@ -0,0 +1,14 @@
+# generated by datamodel-codegen:
+#   filename:  enums/media_buy_status.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class MediaBuyStatus(Enum):
+    pending_activation = 'pending_activation'
+    active = 'active'
+    paused = 'paused'
+    completed = 'completed'

adcp/types/generated_poc/enums/metric_type.py

@@ -0,0 +1,18 @@
+# generated by datamodel-codegen:
+#   filename:  enums/metric_type.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class MetricType(Enum):
+    overall_performance = 'overall_performance'
+    conversion_rate = 'conversion_rate'
+    brand_lift = 'brand_lift'
+    click_through_rate = 'click_through_rate'
+    completion_rate = 'completion_rate'
+    viewability = 'viewability'
+    brand_safety = 'brand_safety'
+    cost_efficiency = 'cost_efficiency'

adcp/types/generated_poc/enums/notification_type.py

@@ -0,0 +1,14 @@
+# generated by datamodel-codegen:
+#   filename:  enums/notification_type.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class NotificationType(Enum):
+    scheduled = 'scheduled'
+    final = 'final'
+    delayed = 'delayed'
+    adjusted = 'adjusted'

adcp/types/generated_poc/enums/pacing.py

@@ -0,0 +1,13 @@
+# generated by datamodel-codegen:
+#   filename:  enums/pacing.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class Pacing(Enum):
+    even = 'even'
+    asap = 'asap'
+    front_loaded = 'front_loaded'

adcp/types/generated_poc/enums/preview_output_format.py

@@ -0,0 +1,12 @@
+# generated by datamodel-codegen:
+#   filename:  enums/preview_output_format.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class PreviewOutputFormat(Enum):
+    url = 'url'
+    html = 'html'

adcp/types/generated_poc/enums/pricing_model.py

@@ -0,0 +1,17 @@
+# generated by datamodel-codegen:
+#   filename:  enums/pricing_model.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class PricingModel(Enum):
+    cpm = 'cpm'
+    vcpm = 'vcpm'
+    cpc = 'cpc'
+    cpcv = 'cpcv'
+    cpv = 'cpv'
+    cpp = 'cpp'
+    flat_rate = 'flat_rate'

adcp/types/generated_poc/enums/property_type.py

@@ -0,0 +1,17 @@
+# generated by datamodel-codegen:
+#   filename:  enums/property_type.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class PropertyType(Enum):
+    website = 'website'
+    mobile_app = 'mobile_app'
+    ctv_app = 'ctv_app'
+    dooh = 'dooh'
+    podcast = 'podcast'
+    radio = 'radio'
+    streaming_audio = 'streaming_audio'

adcp/types/generated_poc/enums/publisher_identifier_types.py

@@ -0,0 +1,15 @@
+# generated by datamodel-codegen:
+#   filename:  enums/publisher_identifier_types.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class PublisherIdentifierTypes(Enum):
+    tag_id = 'tag_id'
+    duns = 'duns'
+    lei = 'lei'
+    seller_id = 'seller_id'
+    gln = 'gln'

adcp/types/generated_poc/enums/reporting_frequency.py

@@ -0,0 +1,13 @@
+# generated by datamodel-codegen:
+#   filename:  enums/reporting_frequency.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class ReportingFrequency(Enum):
+    hourly = 'hourly'
+    daily = 'daily'
+    monthly = 'monthly'

adcp/types/generated_poc/enums/signal_catalog_type.py

@@ -0,0 +1,13 @@
+# generated by datamodel-codegen:
+#   filename:  enums/signal_catalog_type.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class SignalCatalogType(Enum):
+    marketplace = 'marketplace'
+    custom = 'custom'
+    owned = 'owned'

adcp/types/generated_poc/enums/sort_direction.py

@@ -0,0 +1,12 @@
+# generated by datamodel-codegen:
+#   filename:  enums/sort_direction.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class SortDirection(Enum):
+    asc = 'asc'
+    desc = 'desc'

adcp/types/generated_poc/enums/standard_format_ids.py

@@ -0,0 +1,45 @@
+# generated by datamodel-codegen:
+#   filename:  enums/standard_format_ids.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class StandardFormatIds(Enum):
+    display_300x250 = 'display_300x250'
+    display_728x90 = 'display_728x90'
+    display_320x50 = 'display_320x50'
+    display_160x600 = 'display_160x600'
+    display_970x250 = 'display_970x250'
+    display_336x280 = 'display_336x280'
+    display_expandable_300x250 = 'display_expandable_300x250'
+    display_expandable_728x90 = 'display_expandable_728x90'
+    display_interstitial_320x480 = 'display_interstitial_320x480'
+    display_interstitial_desktop = 'display_interstitial_desktop'
+    display_dynamic_300x250 = 'display_dynamic_300x250'
+    display_responsive = 'display_responsive'
+    native_in_feed = 'native_in_feed'
+    native_content_recommendation = 'native_content_recommendation'
+    native_product = 'native_product'
+    video_skippable_15s = 'video_skippable_15s'
+    video_skippable_30s = 'video_skippable_30s'
+    video_non_skippable_15s = 'video_non_skippable_15s'
+    video_non_skippable_30s = 'video_non_skippable_30s'
+    video_outstream_autoplay = 'video_outstream_autoplay'
+    video_vertical_story = 'video_vertical_story'
+    video_rewarded_30s = 'video_rewarded_30s'
+    video_pause_ad = 'video_pause_ad'
+    video_ctv_non_skippable_30s = 'video_ctv_non_skippable_30s'
+    audio_standard_15s = 'audio_standard_15s'
+    audio_standard_30s = 'audio_standard_30s'
+    audio_podcast_host_read = 'audio_podcast_host_read'
+    audio_programmatic = 'audio_programmatic'
+    universal_carousel = 'universal_carousel'
+    universal_canvas = 'universal_canvas'
+    universal_takeover = 'universal_takeover'
+    universal_gallery = 'universal_gallery'
+    universal_reveal = 'universal_reveal'
+    dooh_landscape_static = 'dooh_landscape_static'
+    dooh_portrait_video = 'dooh_portrait_video'

adcp/types/generated_poc/enums/task_status.py

@@ -0,0 +1,19 @@
+# generated by datamodel-codegen:
+#   filename:  enums/task_status.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class TaskStatus(Enum):
+    submitted = 'submitted'
+    working = 'working'
+    input_required = 'input-required'
+    completed = 'completed'
+    canceled = 'canceled'
+    failed = 'failed'
+    rejected = 'rejected'
+    auth_required = 'auth-required'
+    unknown = 'unknown'

adcp/types/generated_poc/enums/task_type.py

@@ -0,0 +1,15 @@
+# generated by datamodel-codegen:
+#   filename:  enums/task_type.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class TaskType(Enum):
+    create_media_buy = 'create_media_buy'
+    update_media_buy = 'update_media_buy'
+    sync_creatives = 'sync_creatives'
+    activate_signal = 'activate_signal'
+    get_signals = 'get_signals'

adcp/types/generated_poc/enums/update_frequency.py

@@ -0,0 +1,14 @@
+# generated by datamodel-codegen:
+#   filename:  enums/update_frequency.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class UpdateFrequency(Enum):
+    realtime = 'realtime'
+    hourly = 'hourly'
+    daily = 'daily'
+    weekly = 'weekly'

adcp/types/generated_poc/enums/url_asset_type.py

@@ -0,0 +1,13 @@
+# generated by datamodel-codegen:
+#   filename:  enums/url_asset_type.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class UrlAssetType(Enum):
+    clickthrough = 'clickthrough'
+    tracker_pixel = 'tracker_pixel'
+    tracker_script = 'tracker_script'

adcp/types/generated_poc/enums/validation_mode.py

@@ -0,0 +1,12 @@
+# generated by datamodel-codegen:
+#   filename:  enums/validation_mode.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class ValidationMode(Enum):
+    strict = 'strict'
+    lenient = 'lenient'

adcp/types/generated_poc/enums/vast_tracking_event.py

@@ -0,0 +1,26 @@
+# generated by datamodel-codegen:
+#   filename:  enums/vast_tracking_event.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class VastTrackingEvent(Enum):
+    start = 'start'
+    firstQuartile = 'firstQuartile'
+    midpoint = 'midpoint'
+    thirdQuartile = 'thirdQuartile'
+    complete = 'complete'
+    impression = 'impression'
+    click = 'click'
+    pause = 'pause'
+    resume = 'resume'
+    skip = 'skip'
+    mute = 'mute'
+    unmute = 'unmute'
+    fullscreen = 'fullscreen'
+    exitFullscreen = 'exitFullscreen'
+    playerExpand = 'playerExpand'
+    playerCollapse = 'playerCollapse'

adcp/types/generated_poc/enums/vast_version.py

@@ -0,0 +1,15 @@
+# generated by datamodel-codegen:
+#   filename:  enums/vast_version.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class VastVersion(Enum):
+    field_2_0 = '2.0'
+    field_3_0 = '3.0'
+    field_4_0 = '4.0'
+    field_4_1 = '4.1'
+    field_4_2 = '4.2'

adcp/types/generated_poc/enums/webhook_response_type.py

@@ -0,0 +1,14 @@
+# generated by datamodel-codegen:
+#   filename:  enums/webhook_response_type.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class WebhookResponseType(Enum):
+    html = 'html'
+    json = 'json'
+    xml = 'xml'
+    javascript = 'javascript'

adcp/types/generated_poc/enums/webhook_security_method.py

@@ -0,0 +1,13 @@
+# generated by datamodel-codegen:
+#   filename:  enums/webhook_security_method.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class WebhookSecurityMethod(Enum):
+    hmac_sha256 = 'hmac_sha256'
+    api_key = 'api_key'
+    none = 'none'

adcp/types/generated_poc/media_buy/__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/media_buy/build_creative_request.py

@@ -0,0 +1,41 @@
+# generated by datamodel-codegen:
+#   filename:  media_buy/build_creative_request.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 ..core import context as context_1
+from ..core import creative_manifest as creative_manifest_1
+from ..core import ext as ext_1
+from ..core import format_id
+
+
+class BuildCreativeRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context: context_1.ContextObject | None = None
+    creative_manifest: Annotated[
+        creative_manifest_1.CreativeManifest | None,
+        Field(
+            description='Creative manifest to transform or generate from. For pure generation, this should include the target format_id and any required input assets (e.g., promoted_offerings for generative formats). For transformation (e.g., resizing, reformatting), this is the complete creative to adapt.'
+        ),
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    message: Annotated[
+        str | None,
+        Field(
+            description='Natural language instructions for the transformation or generation. For pure generation, this is the creative brief. For transformation, this provides guidance on how to adapt the creative.'
+        ),
+    ] = None
+    target_format_id: Annotated[
+        format_id.FormatId,
+        Field(
+            description='Format ID to generate. The format definition specifies required input assets and output structure.'
+        ),
+    ]

adcp/types/generated_poc/media_buy/build_creative_response.py

@@ -0,0 +1,51 @@
+# generated by datamodel-codegen:
+#   filename:  media_buy/build_creative_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 creative_manifest as creative_manifest_1
+from ..core import error
+from ..core import ext as ext_1
+
+
+class BuildCreativeResponse2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context: context_1.ContextObject | None = None
+    errors: Annotated[
+        list[error.Error],
+        Field(
+            description='Array of errors explaining why creative generation failed', min_length=1
+        ),
+    ]
+    ext: ext_1.ExtensionObject | None = None
+
+
+class BuildCreativeResponse1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context: context_1.ContextObject | None = None
+    creative_manifest: Annotated[
+        creative_manifest_1.CreativeManifest,
+        Field(description='The generated or transformed creative manifest'),
+    ]
+    ext: ext_1.ExtensionObject | None = None
+
+
+class BuildCreativeResponse(RootModel[BuildCreativeResponse1 | BuildCreativeResponse2]):
+    root: Annotated[
+        BuildCreativeResponse1 | BuildCreativeResponse2,
+        Field(
+            description='Response containing the transformed or generated creative manifest, ready for use with preview_creative or sync_creatives. Returns either the complete creative manifest OR error information, never both.',
+            title='Build Creative Response',
+        ),
+    ]

adcp/types/generated_poc/media_buy/create_media_buy_request.py

@@ -0,0 +1,94 @@
+# generated by datamodel-codegen:
+#   filename:  media_buy/create_media_buy_request.json
+#   timestamp: 2025-11-22T15:29:34+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AnyUrl, AwareDatetime, ConfigDict, Field
+
+from ..core import brand_manifest as brand_manifest_1
+from ..core import context as context_1
+from ..core import ext as ext_1
+from ..core.push_notification_config import PushNotificationConfig
+from . import package_request
+
+
+class ReportingFrequency(Enum):
+    hourly = 'hourly'
+    daily = 'daily'
+    monthly = 'monthly'
+
+
+class RequestedMetric(Enum):
+    impressions = 'impressions'
+    spend = 'spend'
+    clicks = 'clicks'
+    ctr = 'ctr'
+    video_completions = 'video_completions'
+    completion_rate = 'completion_rate'
+    conversions = 'conversions'
+    viewability = 'viewability'
+    engagement_rate = 'engagement_rate'
+
+
+class ReportingWebhook(PushNotificationConfig):
+    reporting_frequency: Annotated[
+        ReportingFrequency,
+        Field(
+            description='Frequency for automated reporting delivery. Must be supported by all products in the media buy.'
+        ),
+    ]
+    requested_metrics: Annotated[
+        list[RequestedMetric] | None,
+        Field(
+            description="Optional list of metrics to include in webhook notifications. If omitted, all available metrics are included. Must be subset of product's available_metrics."
+        ),
+    ] = None
+
+
+class CreateMediaBuyRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    brand_manifest: Annotated[
+        brand_manifest_1.BrandManifest | AnyUrl,
+        Field(
+            description='Brand information manifest serving as the namespace and identity for this media buy. Provides brand context, assets, and product catalog. Can be provided inline or as a URL reference to a hosted manifest. Can be cached and reused across multiple requests.',
+            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',
+        ),
+    ]
+    buyer_ref: Annotated[str, Field(description="Buyer's reference identifier for this media buy")]
+    context: context_1.ContextObject | None = None
+    end_time: Annotated[
+        AwareDatetime, Field(description='Campaign end date/time in ISO 8601 format')
+    ]
+    ext: ext_1.ExtensionObject | None = None
+    packages: Annotated[
+        list[package_request.PackageRequest], Field(description='Array of package configurations')
+    ]
+    po_number: Annotated[str | None, Field(description='Purchase order number for tracking')] = None
+    reporting_webhook: ReportingWebhook | None = None
+    start_time: Annotated[
+        str | AwareDatetime,
+        Field(
+            description="Campaign start timing: 'asap' or ISO 8601 date-time", title='Start Timing'
+        ),
+    ]