adcp 2.12.0__py3-none-any.whl

adcp/types/generated_poc/media_buy/sync_creatives_response.py

@@ -0,0 +1,105 @@
+# generated by datamodel-codegen:
+#   filename:  media_buy/sync_creatives_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 AnyUrl, AwareDatetime, ConfigDict, Field, RootModel
+
+from ..core import context as context_1
+from ..core import error
+from ..core import ext as ext_1
+from ..enums import creative_action
+
+
+class Creative(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    action: Annotated[
+        creative_action.CreativeAction, Field(description='Action taken for this creative')
+    ]
+    assigned_to: Annotated[
+        list[str] | None,
+        Field(
+            description='Package IDs this creative was successfully assigned to (only present when assignments were requested)'
+        ),
+    ] = None
+    assignment_errors: Annotated[
+        dict[str, str] | None,
+        Field(
+            description='Assignment errors by package ID (only present when assignment failures occurred)'
+        ),
+    ] = None
+    changes: Annotated[
+        list[str] | None,
+        Field(description="Field names that were modified (only present when action='updated')"),
+    ] = None
+    creative_id: Annotated[str, Field(description='Creative ID from the request')]
+    errors: Annotated[
+        list[str] | None,
+        Field(description="Validation or processing errors (only present when action='failed')"),
+    ] = None
+    expires_at: Annotated[
+        AwareDatetime | None,
+        Field(
+            description='ISO 8601 timestamp when preview link expires (only present when preview_url exists)'
+        ),
+    ] = None
+    platform_id: Annotated[
+        str | None, Field(description='Platform-specific ID assigned to the creative')
+    ] = None
+    preview_url: Annotated[
+        AnyUrl | None,
+        Field(
+            description='Preview URL for generative creatives (only present for generative formats)'
+        ),
+    ] = None
+    warnings: Annotated[
+        list[str] | None, Field(description='Non-fatal warnings about this creative')
+    ] = None
+
+
+class SyncCreativesResponse1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context: context_1.ContextObject | None = None
+    creatives: Annotated[
+        list[Creative],
+        Field(
+            description="Results for each creative processed. Items with action='failed' indicate per-item validation/processing failures, not operation-level failures."
+        ),
+    ]
+    dry_run: Annotated[
+        bool | None, Field(description='Whether this was a dry run (no actual changes made)')
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+
+
+class SyncCreativesResponse2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context: context_1.ContextObject | None = None
+    errors: Annotated[
+        list[error.Error],
+        Field(
+            description='Operation-level errors that prevented processing any creatives (e.g., authentication failure, service unavailable, invalid request format)',
+            min_length=1,
+        ),
+    ]
+    ext: ext_1.ExtensionObject | None = None
+
+
+class SyncCreativesResponse(RootModel[SyncCreativesResponse1 | SyncCreativesResponse2]):
+    root: Annotated[
+        SyncCreativesResponse1 | SyncCreativesResponse2,
+        Field(
+            description='Response from creative sync operation. Returns either per-creative results (best-effort processing) OR operation-level errors (complete failure). This enforces atomic semantics at the operation level while allowing per-item failures within successful operations.',
+            title='Sync Creatives Response',
+        ),
+    ]

adcp/types/generated_poc/media_buy/update_media_buy_request.py

@@ -0,0 +1,195 @@
+# generated by datamodel-codegen:
+#   filename:  media_buy/update_media_buy_request.json
+#   timestamp: 2025-11-22T16:02:47+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AwareDatetime, ConfigDict, Field, RootModel
+
+from ..core import context as context_1
+from ..core import creative_asset, creative_assignment
+from ..core import ext as ext_1
+from ..core import push_notification_config as push_notification_config_1
+from ..core import targeting
+from ..enums import pacing as pacing_1
+
+
+class Packages(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    bid_price: Annotated[
+        float | None,
+        Field(
+            description='Updated bid price for auction-based pricing options (only applies when pricing_option is auction-based)',
+            ge=0.0,
+        ),
+    ] = None
+    budget: Annotated[
+        float | None,
+        Field(
+            description='Updated budget allocation for this package in the currency specified by the pricing option',
+            ge=0.0,
+        ),
+    ] = None
+    buyer_ref: Annotated[
+        str | None, Field(description="Buyer's reference for the package to update")
+    ] = None
+    creative_assignments: Annotated[
+        list[creative_assignment.CreativeAssignment] | None,
+        Field(
+            description='Full creative assignment objects with weights and placement targeting (alternative to creative_ids - provides granular control over weights and placement targeting). Uses replacement semantics like creative_ids.'
+        ),
+    ] = None
+    creative_ids: Annotated[
+        list[str] | None,
+        Field(description='Update creative assignments (references existing library creatives)'),
+    ] = None
+    creatives: Annotated[
+        list[creative_asset.CreativeAsset] | None,
+        Field(
+            description='Full creative objects to upload and assign to this package (alternative to creative_ids - creatives will be added to library). Supports both static and generative creatives.',
+            max_length=100,
+        ),
+    ] = None
+    pacing: pacing_1.Pacing | None = None
+    package_id: Annotated[str, Field(description="Publisher's ID of package to update")]
+    paused: Annotated[
+        bool | None,
+        Field(description='Pause/resume specific package (true = paused, false = active)'),
+    ] = None
+    targeting_overlay: targeting.TargetingOverlay | None = None
+
+
+class Packages1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    bid_price: Annotated[
+        float | None,
+        Field(
+            description='Updated bid price for auction-based pricing options (only applies when pricing_option is auction-based)',
+            ge=0.0,
+        ),
+    ] = None
+    budget: Annotated[
+        float | None,
+        Field(
+            description='Updated budget allocation for this package in the currency specified by the pricing option',
+            ge=0.0,
+        ),
+    ] = None
+    buyer_ref: Annotated[str, Field(description="Buyer's reference for the package to update")]
+    creative_assignments: Annotated[
+        list[creative_assignment.CreativeAssignment] | None,
+        Field(
+            description='Full creative assignment objects with weights and placement targeting (alternative to creative_ids - provides granular control over weights and placement targeting). Uses replacement semantics like creative_ids.'
+        ),
+    ] = None
+    creative_ids: Annotated[
+        list[str] | None,
+        Field(description='Update creative assignments (references existing library creatives)'),
+    ] = None
+    creatives: Annotated[
+        list[creative_asset.CreativeAsset] | None,
+        Field(
+            description='Full creative objects to upload and assign to this package (alternative to creative_ids - creatives will be added to library). Supports both static and generative creatives.',
+            max_length=100,
+        ),
+    ] = None
+    pacing: pacing_1.Pacing | None = None
+    package_id: Annotated[str | None, Field(description="Publisher's ID of package to update")] = (
+        None
+    )
+    paused: Annotated[
+        bool | None,
+        Field(description='Pause/resume specific package (true = paused, false = active)'),
+    ] = None
+    targeting_overlay: targeting.TargetingOverlay | None = None
+
+
+class UpdateMediaBuyRequest1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    buyer_ref: Annotated[
+        str | None, Field(description="Buyer's reference for the media buy to update")
+    ] = None
+    context: context_1.ContextObject | None = None
+    end_time: Annotated[
+        AwareDatetime | None, Field(description='New end date/time in ISO 8601 format')
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    media_buy_id: Annotated[str, Field(description="Publisher's ID of the media buy to update")]
+    packages: Annotated[
+        list[Packages | Packages1] | None, Field(description='Package-specific updates')
+    ] = None
+    paused: Annotated[
+        bool | None,
+        Field(description='Pause/resume the entire media buy (true = paused, false = active)'),
+    ] = None
+    push_notification_config: Annotated[
+        push_notification_config_1.PushNotificationConfig | None,
+        Field(
+            description='Optional webhook configuration for async update notifications. Publisher will send webhook when update completes if operation takes longer than immediate response time.'
+        ),
+    ] = None
+    start_time: Annotated[
+        str | AwareDatetime | None,
+        Field(
+            description="Campaign start timing: 'asap' or ISO 8601 date-time", title='Start Timing'
+        ),
+    ] = None
+
+
+Packages2 = Packages
+
+
+Packages3 = Packages1
+
+
+class UpdateMediaBuyRequest2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    buyer_ref: Annotated[str, Field(description="Buyer's reference for the media buy to update")]
+    context: context_1.ContextObject | None = None
+    end_time: Annotated[
+        AwareDatetime | None, Field(description='New end date/time in ISO 8601 format')
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    media_buy_id: Annotated[
+        str | None, Field(description="Publisher's ID of the media buy to update")
+    ] = None
+    packages: Annotated[
+        list[Packages2 | Packages3] | None, Field(description='Package-specific updates')
+    ] = None
+    paused: Annotated[
+        bool | None,
+        Field(description='Pause/resume the entire media buy (true = paused, false = active)'),
+    ] = None
+    push_notification_config: Annotated[
+        push_notification_config_1.PushNotificationConfig | None,
+        Field(
+            description='Optional webhook configuration for async update notifications. Publisher will send webhook when update completes if operation takes longer than immediate response time.'
+        ),
+    ] = None
+    start_time: Annotated[
+        str | AwareDatetime | None,
+        Field(
+            description="Campaign start timing: 'asap' or ISO 8601 date-time", title='Start Timing'
+        ),
+    ] = None
+
+
+class UpdateMediaBuyRequest(RootModel[UpdateMediaBuyRequest1 | UpdateMediaBuyRequest2]):
+    root: Annotated[
+        UpdateMediaBuyRequest1 | UpdateMediaBuyRequest2,
+        Field(
+            description='Request parameters for updating campaign and package settings',
+            title='Update Media Buy Request',
+        ),
+    ]

adcp/types/generated_poc/media_buy/update_media_buy_response.py

@@ -0,0 +1,55 @@
+# generated by datamodel-codegen:
+#   filename:  media_buy/update_media_buy_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 AwareDatetime, ConfigDict, Field, RootModel
+
+from ..core import context as context_1
+from ..core import error
+from ..core import ext as ext_1
+from ..core import package
+
+
+class UpdateMediaBuyResponse2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context: context_1.ContextObject | None = None
+    errors: Annotated[
+        list[error.Error],
+        Field(description='Array of errors explaining why the operation failed', min_length=1),
+    ]
+    ext: ext_1.ExtensionObject | None = None
+
+
+class UpdateMediaBuyResponse1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    affected_packages: Annotated[
+        list[package.Package] | None,
+        Field(description='Array of packages that were modified with complete state information'),
+    ] = None
+    buyer_ref: Annotated[str, Field(description="Buyer's reference identifier for the media buy")]
+    context: context_1.ContextObject | None = None
+    ext: ext_1.ExtensionObject | None = None
+    implementation_date: Annotated[
+        AwareDatetime | None,
+        Field(description='ISO 8601 timestamp when changes take effect (null if pending approval)'),
+    ] = None
+    media_buy_id: Annotated[str, Field(description="Publisher's identifier for the media buy")]
+
+
+class UpdateMediaBuyResponse(RootModel[UpdateMediaBuyResponse1 | UpdateMediaBuyResponse2]):
+    root: Annotated[
+        UpdateMediaBuyResponse1 | UpdateMediaBuyResponse2,
+        Field(
+            description='Response payload for update_media_buy task. Returns either complete success data OR error information, never both. This enforces atomic operation semantics - updates are either fully applied or not applied at all.',
+            title='Update Media Buy Response',
+        ),
+    ]

adcp/types/generated_poc/pricing_options/__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/pricing_options/cpc_option.py

@@ -0,0 +1,43 @@
+# generated by datamodel-codegen:
+#   filename:  pricing_options/cpc_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 CpcPricingOption(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['cpc'], Field(description='Cost per click')]
+    pricing_option_id: Annotated[
+        str,
+        Field(
+            description="Unique identifier for this pricing option within the product (e.g., 'cpc_usd_fixed')"
+        ),
+    ]
+    rate: Annotated[float, Field(description='Fixed CPC rate (cost per click)', ge=0.0)]

adcp/types/generated_poc/pricing_options/cpcv_option.py

@@ -0,0 +1,45 @@
+# generated by datamodel-codegen:
+#   filename:  pricing_options/cpcv_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 CpcvPricingOption(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['cpcv'], Field(description='Cost per completed view (100% completion)')
+    ]
+    pricing_option_id: Annotated[
+        str,
+        Field(
+            description="Unique identifier for this pricing option within the product (e.g., 'cpcv_usd_guaranteed')"
+        ),
+    ]
+    rate: Annotated[float, Field(description='Fixed CPCV rate (cost per 100% completion)', ge=0.0)]

adcp/types/generated_poc/pricing_options/cpm_auction_option.py

@@ -0,0 +1,58 @@
+# generated by datamodel-codegen:
+#   filename:  pricing_options/cpm_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 bid price - publisher will reject bids under this value', ge=0.0
+        ),
+    ]
+    p25: Annotated[float | None, Field(description='25th percentile winning price', ge=0.0)] = None
+    p50: Annotated[float | None, Field(description='Median winning price', ge=0.0)] = None
+    p75: Annotated[float | None, Field(description='75th percentile winning price', ge=0.0)] = None
+    p90: Annotated[float | None, Field(description='90th percentile winning price', ge=0.0)] = None
+
+
+class CpmAuctionPricingOption(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='Pricing guidance for auction-based CPM bidding')
+    ]
+    pricing_model: Annotated[Literal['cpm'], Field(description='Cost per 1,000 impressions')]
+    pricing_option_id: Annotated[
+        str,
+        Field(
+            description="Unique identifier for this pricing option within the product (e.g., 'cpm_usd_auction')"
+        ),
+    ]

adcp/types/generated_poc/pricing_options/cpm_fixed_option.py

@@ -0,0 +1,43 @@
+# generated by datamodel-codegen:
+#   filename:  pricing_options/cpm_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 CpmFixedRatePricingOption(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['cpm'], Field(description='Cost per 1,000 impressions')]
+    pricing_option_id: Annotated[
+        str,
+        Field(
+            description="Unique identifier for this pricing option within the product (e.g., 'cpm_usd_guaranteed')"
+        ),
+    ]
+    rate: Annotated[float, Field(description='Fixed CPM rate (cost per 1,000 impressions)', ge=0.0)]

adcp/types/generated_poc/pricing_options/cpp_option.py

@@ -0,0 +1,64 @@
+# generated by datamodel-codegen:
+#   filename:  pricing_options/cpp_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',
+    )
+    demographic: Annotated[
+        str,
+        Field(
+            description='Target demographic in Nielsen format: P/M/W/A/C + age range. Examples: P18-49 (Persons 18-49), M25-54 (Men 25-54), W35+ (Women 35+), A18-34 (Adults 18-34), C2-11 (Children 2-11)',
+            pattern='^[PMWAC][0-9]{2}(-[0-9]{2}|\\+)$',
+        ),
+    ]
+    min_points: Annotated[
+        float | None,
+        Field(description='Minimum GRPs/TRPs required for this pricing option', ge=0.0),
+    ] = None
+
+
+class CppPricingOption(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,
+        Field(description='CPP-specific parameters for demographic targeting and GRP requirements'),
+    ]
+    pricing_model: Annotated[Literal['cpp'], Field(description='Cost per Gross Rating Point')]
+    pricing_option_id: Annotated[
+        str,
+        Field(
+            description="Unique identifier for this pricing option within the product (e.g., 'cpp_usd_p18-49')"
+        ),
+    ]
+    rate: Annotated[float, Field(description='Fixed CPP rate (cost per rating point)', ge=0.0)]

adcp/types/generated_poc/pricing_options/cpv_option.py

@@ -0,0 +1,77 @@
+# generated by datamodel-codegen:
+#   filename:  pricing_options/cpv_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, RootModel
+
+
+class ViewThreshold(RootModel[float]):
+    root: Annotated[
+        float,
+        Field(
+            description='Percentage completion threshold for CPV pricing (0.0 to 1.0, e.g., 0.5 = 50% completion)',
+            ge=0.0,
+            le=1.0,
+        ),
+    ]
+
+
+class ViewThreshold1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    duration_seconds: Annotated[
+        int,
+        Field(
+            description="Seconds of viewing required (e.g., 30 for YouTube-style '30 seconds = view')",
+            ge=1,
+        ),
+    ]
+
+
+class Parameters(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    view_threshold: ViewThreshold | ViewThreshold1
+
+
+class CpvPricingOption(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, Field(description='CPV-specific parameters defining the view threshold')
+    ]
+    pricing_model: Annotated[Literal['cpv'], Field(description='Cost per view at threshold')]
+    pricing_option_id: Annotated[
+        str,
+        Field(
+            description="Unique identifier for this pricing option within the product (e.g., 'cpv_usd_50pct')"
+        ),
+    ]
+    rate: Annotated[float, Field(description='Fixed CPV rate (cost per view)', ge=0.0)]