adcp 2.12.0__py3-none-any.whl

adcp/types/generated_poc/media_buy/list_creatives_request.py

@@ -0,0 +1,76 @@
+# generated by datamodel-codegen:
+#   filename:  media_buy/list_creatives_request.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+from ..core import context as context_1
+from ..core import creative_filters
+from ..core import ext as ext_1
+from ..enums import creative_sort_field, sort_direction
+
+
+class FieldModel(Enum):
+    creative_id = 'creative_id'
+    name = 'name'
+    format = 'format'
+    status = 'status'
+    created_date = 'created_date'
+    updated_date = 'updated_date'
+    tags = 'tags'
+    assignments = 'assignments'
+    performance = 'performance'
+    sub_assets = 'sub_assets'
+
+
+class Pagination(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    limit: Annotated[
+        int | None, Field(description='Maximum number of creatives to return', ge=1, le=100)
+    ] = 50
+    offset: Annotated[int | None, Field(description='Number of creatives to skip', ge=0)] = 0
+
+
+class Sort(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    direction: Annotated[
+        sort_direction.SortDirection | None, Field(description='Sort direction')
+    ] = sort_direction.SortDirection.desc
+    field: Annotated[
+        creative_sort_field.CreativeSortField | None, Field(description='Field to sort by')
+    ] = creative_sort_field.CreativeSortField.created_date
+
+
+class ListCreativesRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context: context_1.ContextObject | None = None
+    ext: ext_1.ExtensionObject | None = None
+    fields: Annotated[
+        list[FieldModel] | None,
+        Field(description='Specific fields to include in response (omit for all fields)'),
+    ] = None
+    filters: creative_filters.CreativeFilters | None = None
+    include_assignments: Annotated[
+        bool | None, Field(description='Include package assignment information in response')
+    ] = True
+    include_performance: Annotated[
+        bool | None, Field(description='Include aggregated performance metrics in response')
+    ] = False
+    include_sub_assets: Annotated[
+        bool | None,
+        Field(description='Include sub-assets (for carousel/native formats) in response'),
+    ] = False
+    pagination: Annotated[Pagination | None, Field(description='Pagination parameters')] = None
+    sort: Annotated[Sort | None, Field(description='Sorting parameters')] = None

adcp/types/generated_poc/media_buy/list_creatives_response.py

@@ -0,0 +1,214 @@
+# generated by datamodel-codegen:
+#   filename:  media_buy/list_creatives_response.json
+#   timestamp: 2025-11-22T19:54:03+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AwareDatetime, ConfigDict, Field
+
+from ..core import context as context_1
+from ..core import ext as ext_1
+from ..core import format_id as format_id_1
+from ..core import promoted_offerings, sub_asset
+from ..core.assets import (
+    audio_asset,
+    css_asset,
+    daast_asset,
+    html_asset,
+    image_asset,
+    javascript_asset,
+    text_asset,
+    url_asset,
+    vast_asset,
+    video_asset,
+)
+from ..enums import creative_status, sort_direction
+
+
+class Status(Enum):
+    active = 'active'
+    paused = 'paused'
+    ended = 'ended'
+
+
+class AssignedPackage(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    assigned_date: Annotated[AwareDatetime, Field(description='When this assignment was created')]
+    package_id: Annotated[str, Field(description='Package identifier')]
+    package_name: Annotated[str | None, Field(description='Human-readable package name')] = None
+    status: Annotated[Status, Field(description='Status of this specific assignment')]
+
+
+class Assignments(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    assigned_packages: Annotated[
+        list[AssignedPackage] | None,
+        Field(description='List of packages this creative is assigned to'),
+    ] = None
+    assignment_count: Annotated[
+        int, Field(description='Total number of active package assignments', ge=0)
+    ]
+
+
+class Performance(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    clicks: Annotated[
+        int | None, Field(description='Total clicks across all assignments', ge=0)
+    ] = None
+    conversion_rate: Annotated[
+        float | None, Field(description='Conversion rate across all assignments', ge=0.0, le=1.0)
+    ] = None
+    ctr: Annotated[
+        float | None, Field(description='Click-through rate (clicks/impressions)', ge=0.0, le=1.0)
+    ] = None
+    impressions: Annotated[
+        int | None, Field(description='Total impressions across all assignments', ge=0)
+    ] = None
+    last_updated: Annotated[
+        AwareDatetime, Field(description='When performance data was last updated')
+    ]
+    performance_score: Annotated[
+        float | None, Field(description='Aggregated performance score (0-100)', ge=0.0, le=100.0)
+    ] = None
+
+
+class Pagination(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    current_page: Annotated[
+        int | None, Field(description='Current page number (1-based)', ge=1)
+    ] = None
+    has_more: Annotated[bool, Field(description='Whether more results are available')]
+    limit: Annotated[int, Field(description='Maximum number of results requested', ge=1)]
+    offset: Annotated[int, Field(description='Number of results skipped', ge=0)]
+    total_pages: Annotated[
+        int | None, Field(description='Total number of pages available', ge=0)
+    ] = None
+
+
+class StatusSummary(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    approved: Annotated[int | None, Field(description='Number of approved creatives', ge=0)] = None
+    archived: Annotated[int | None, Field(description='Number of archived creatives', ge=0)] = None
+    pending_review: Annotated[
+        int | None, Field(description='Number of creatives pending review', ge=0)
+    ] = None
+    rejected: Annotated[int | None, Field(description='Number of rejected creatives', ge=0)] = None
+
+
+class SortApplied(AdCPBaseModel):
+    direction: sort_direction.SortDirection | None = None
+    field: str | None = None
+
+
+class QuerySummary(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    filters_applied: Annotated[
+        list[str] | None, Field(description='List of filters that were applied to the query')
+    ] = None
+    returned: Annotated[
+        int, Field(description='Number of creatives returned in this response', ge=0)
+    ]
+    sort_applied: Annotated[
+        SortApplied | None, Field(description='Sort order that was applied')
+    ] = None
+    total_matching: Annotated[
+        int,
+        Field(description='Total number of creatives matching filters (across all pages)', ge=0),
+    ]
+
+
+class Creative(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    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,
+        ]
+        | None,
+        Field(description='Assets for this creative, keyed by asset_role'),
+    ] = None
+    assignments: Annotated[
+        Assignments | None,
+        Field(description='Current package assignments (included when include_assignments=true)'),
+    ] = None
+    created_date: Annotated[
+        AwareDatetime, Field(description='When the creative was uploaded to the library')
+    ]
+    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'),
+    ]
+    name: Annotated[str, Field(description='Human-readable creative name')]
+    performance: Annotated[
+        Performance | None,
+        Field(
+            description='Aggregated performance metrics (included when include_performance=true)'
+        ),
+    ] = None
+    status: Annotated[
+        creative_status.CreativeStatus, Field(description='Current approval status of the creative')
+    ]
+    sub_assets: Annotated[
+        list[sub_asset.SubAsset1 | sub_asset.SubAsset2] | None,
+        Field(
+            description='Sub-assets for multi-asset formats (included when include_sub_assets=true)'
+        ),
+    ] = None
+    tags: Annotated[
+        list[str] | None, Field(description='User-defined tags for organization and searchability')
+    ] = None
+    updated_date: Annotated[AwareDatetime, Field(description='When the creative was last modified')]
+
+
+class ListCreativesResponse(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context: context_1.ContextObject | None = None
+    creatives: Annotated[
+        list[Creative], Field(description='Array of creative assets matching the query')
+    ]
+    ext: ext_1.ExtensionObject | None = None
+    format_summary: Annotated[
+        dict[str, int] | None, Field(description='Breakdown of creatives by format type')
+    ] = None
+    pagination: Annotated[
+        Pagination, Field(description='Pagination information for navigating results')
+    ]
+    query_summary: Annotated[
+        QuerySummary, Field(description='Summary of the query that was executed')
+    ]
+    status_summary: Annotated[
+        StatusSummary | None, Field(description='Breakdown of creatives by status')
+    ] = None

adcp/types/generated_poc/media_buy/package_request.py

@@ -0,0 +1,63 @@
+# generated by datamodel-codegen:
+#   filename:  media_buy/package_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 creative_asset
+from ..core import ext as ext_1
+from ..core import format_id, targeting
+from ..enums import pacing as pacing_1
+
+
+class PackageRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    bid_price: Annotated[
+        float | None,
+        Field(
+            description='Bid price for auction-based CPM pricing (required if using cpm-auction-option)',
+            ge=0.0,
+        ),
+    ] = None
+    budget: Annotated[
+        float,
+        Field(description="Budget allocation for this package in the media buy's currency", ge=0.0),
+    ]
+    buyer_ref: Annotated[str, Field(description="Buyer's reference identifier for this package")]
+    creative_ids: Annotated[
+        list[str] | None,
+        Field(
+            description='Creative IDs to assign to this package at creation time (references existing library creatives)'
+        ),
+    ] = None
+    creatives: Annotated[
+        list[creative_asset.CreativeAsset] | None,
+        Field(
+            description='Full creative objects to upload and assign to this package at creation time (alternative to creative_ids - creatives will be added to library). Supports both static and generative creatives.',
+            max_length=100,
+        ),
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    format_ids: Annotated[
+        list[format_id.FormatId] | None,
+        Field(
+            description='Array of format IDs that will be used for this package - must be supported by the product. If omitted, defaults to all formats supported by the product.',
+            min_length=1,
+        ),
+    ] = None
+    pacing: pacing_1.Pacing | None = None
+    pricing_option_id: Annotated[
+        str,
+        Field(
+            description="ID of the selected pricing option from the product's pricing_options array"
+        ),
+    ]
+    product_id: Annotated[str, Field(description='Product ID for this package')]
+    targeting_overlay: targeting.TargetingOverlay | None = None

adcp/types/generated_poc/media_buy/provide_performance_feedback_request.py

@@ -0,0 +1,125 @@
+# generated by datamodel-codegen:
+#   filename:  media_buy/provide_performance_feedback_request.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 AwareDatetime, ConfigDict, Field, RootModel
+
+from ..core import context as context_1
+from ..core import ext as ext_1
+from ..enums import feedback_source as feedback_source_1
+from ..enums import metric_type as metric_type_1
+
+
+class MeasurementPeriod(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    end: Annotated[
+        AwareDatetime, Field(description='ISO 8601 end timestamp for measurement period')
+    ]
+    start: Annotated[
+        AwareDatetime, Field(description='ISO 8601 start timestamp for measurement period')
+    ]
+
+
+class ProvidePerformanceFeedbackRequest1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    buyer_ref: Annotated[
+        str | None, Field(description="Buyer's reference for the media buy", min_length=1)
+    ] = None
+    context: context_1.ContextObject | None = None
+    creative_id: Annotated[
+        str | None,
+        Field(
+            description='Specific creative asset (if feedback is creative-specific)', min_length=1
+        ),
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    feedback_source: Annotated[
+        feedback_source_1.FeedbackSource | None, Field(description='Source of the performance data')
+    ] = feedback_source_1.FeedbackSource.buyer_attribution
+    measurement_period: Annotated[
+        MeasurementPeriod, Field(description='Time period for performance measurement')
+    ]
+    media_buy_id: Annotated[
+        str, Field(description="Publisher's media buy identifier", min_length=1)
+    ]
+    metric_type: Annotated[
+        metric_type_1.MetricType | None, Field(description='The business metric being measured')
+    ] = metric_type_1.MetricType.overall_performance
+    package_id: Annotated[
+        str | None,
+        Field(
+            description='Specific package within the media buy (if feedback is package-specific)',
+            min_length=1,
+        ),
+    ] = None
+    performance_index: Annotated[
+        float,
+        Field(
+            description='Normalized performance score (0.0 = no value, 1.0 = expected, >1.0 = above expected)',
+            ge=0.0,
+        ),
+    ]
+
+
+class ProvidePerformanceFeedbackRequest2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    buyer_ref: Annotated[
+        str, Field(description="Buyer's reference for the media buy", min_length=1)
+    ]
+    context: context_1.ContextObject | None = None
+    creative_id: Annotated[
+        str | None,
+        Field(
+            description='Specific creative asset (if feedback is creative-specific)', min_length=1
+        ),
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    feedback_source: Annotated[
+        feedback_source_1.FeedbackSource | None, Field(description='Source of the performance data')
+    ] = feedback_source_1.FeedbackSource.buyer_attribution
+    measurement_period: Annotated[
+        MeasurementPeriod, Field(description='Time period for performance measurement')
+    ]
+    media_buy_id: Annotated[
+        str | None, Field(description="Publisher's media buy identifier", min_length=1)
+    ] = None
+    metric_type: Annotated[
+        metric_type_1.MetricType | None, Field(description='The business metric being measured')
+    ] = metric_type_1.MetricType.overall_performance
+    package_id: Annotated[
+        str | None,
+        Field(
+            description='Specific package within the media buy (if feedback is package-specific)',
+            min_length=1,
+        ),
+    ] = None
+    performance_index: Annotated[
+        float,
+        Field(
+            description='Normalized performance score (0.0 = no value, 1.0 = expected, >1.0 = above expected)',
+            ge=0.0,
+        ),
+    ]
+
+
+class ProvidePerformanceFeedbackRequest(
+    RootModel[ProvidePerformanceFeedbackRequest1 | ProvidePerformanceFeedbackRequest2]
+):
+    root: Annotated[
+        ProvidePerformanceFeedbackRequest1 | ProvidePerformanceFeedbackRequest2,
+        Field(
+            description='Request payload for provide_performance_feedback task',
+            title='Provide Performance Feedback Request',
+        ),
+    ]

adcp/types/generated_poc/media_buy/provide_performance_feedback_response.py

@@ -0,0 +1,53 @@
+# generated by datamodel-codegen:
+#   filename:  media_buy/provide_performance_feedback_response.json
+#   timestamp: 2025-11-22T19:16:02+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Literal
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field, RootModel
+
+from ..core import context as context_1
+from ..core import error
+from ..core import ext as ext_1
+
+
+class ProvidePerformanceFeedbackResponse1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context: context_1.ContextObject | None = None
+    ext: ext_1.ExtensionObject | None = None
+    success: Annotated[
+        Literal[True],
+        Field(description='Whether the performance feedback was successfully received'),
+    ]
+
+
+class ProvidePerformanceFeedbackResponse2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context: context_1.ContextObject | None = None
+    errors: Annotated[
+        list[error.Error],
+        Field(
+            description='Array of errors explaining why feedback was rejected (e.g., invalid measurement period, missing campaign data)',
+            min_length=1,
+        ),
+    ]
+    ext: ext_1.ExtensionObject | None = None
+
+
+class ProvidePerformanceFeedbackResponse(
+    RootModel[ProvidePerformanceFeedbackResponse1 | ProvidePerformanceFeedbackResponse2]
+):
+    root: Annotated[
+        ProvidePerformanceFeedbackResponse1 | ProvidePerformanceFeedbackResponse2,
+        Field(
+            description='Response payload for provide_performance_feedback task. Returns either success confirmation OR error information, never both.',
+            title='Provide Performance Feedback Response',
+        ),
+    ]

adcp/types/generated_poc/media_buy/sync_creatives_request.py

@@ -0,0 +1,63 @@
+# generated by datamodel-codegen:
+#   filename:  media_buy/sync_creatives_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 ConfigDict, Field
+
+from ..core import context as context_1
+from ..core import creative_asset
+from ..core import ext as ext_1
+from ..core import push_notification_config as push_notification_config_1
+from ..enums import validation_mode as validation_mode_1
+
+
+class SyncCreativesRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    assignments: Annotated[
+        dict[str, list[str]] | None,
+        Field(description='Optional bulk assignment of creatives to packages'),
+    ] = None
+    context: context_1.ContextObject | None = None
+    creative_ids: Annotated[
+        list[str] | None,
+        Field(
+            description='Optional filter to limit sync scope to specific creative IDs. When provided, only these creatives will be created/updated. Other creatives in the library are unaffected. Useful for partial updates and error recovery.',
+            max_length=100,
+        ),
+    ] = None
+    creatives: Annotated[
+        list[creative_asset.CreativeAsset],
+        Field(description='Array of creative assets to sync (create or update)', max_length=100),
+    ]
+    delete_missing: Annotated[
+        bool | None,
+        Field(
+            description='When true, creatives not included in this sync will be archived. Use with caution for full library replacement.'
+        ),
+    ] = False
+    dry_run: Annotated[
+        bool | None,
+        Field(
+            description='When true, preview changes without applying them. Returns what would be created/updated/deleted.'
+        ),
+    ] = False
+    ext: ext_1.ExtensionObject | None = None
+    push_notification_config: Annotated[
+        push_notification_config_1.PushNotificationConfig | None,
+        Field(
+            description='Optional webhook configuration for async sync notifications. Publisher will send webhook when sync completes if operation takes longer than immediate response time (typically for large bulk operations or manual approval/HITL).'
+        ),
+    ] = None
+    validation_mode: Annotated[
+        validation_mode_1.ValidationMode | None,
+        Field(
+            description="Validation strictness. 'strict' fails entire sync on any validation error. 'lenient' processes valid creatives and reports errors."
+        ),
+    ] = validation_mode_1.ValidationMode.strict