adcp 1.6.1__py3-none-any.whl → 2.0.0__py3-none-any.whl

adcp/types/generated_poc/promoted_products.py

@@ -0,0 +1,38 @@
+# generated by datamodel-codegen:
+#   filename:  promoted-products.json
+#   timestamp: 2025-11-15T22:03:55+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/property.py

@@ -0,0 +1,79 @@
+# generated by datamodel-codegen:
+#   filename:  property.json
+#   timestamp: 2025-11-15T22:03:55+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, RootModel
+
+from . import identifier_types
+
+
+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 PropertyType(Enum):
+    website = "website"
+    mobile_app = "mobile_app"
+    ctv_app = "ctv_app"
+    dooh = "dooh"
+    podcast = "podcast"
+    radio = "radio"
+    streaming_audio = "streaming_audio"
+
+
+class Tag(RootModel[str]):
+    root: Annotated[
+        str,
+        Field(
+            description="Lowercase tag with underscores (e.g., 'conde_nast_network', 'premium_content')",
+            pattern="^[a-z0-9_]+$",
+        ),
+    ]
+
+
+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. Recommended format: lowercase with underscores (e.g., 'cnn_ctv_app', 'instagram_mobile')",
+            pattern="^[a-z0-9_]+$",
+        ),
+    ] = None
+    property_type: Annotated[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[Tag] | None,
+        Field(
+            description="Tags for categorization and grouping (e.g., network membership, content categories)"
+        ),
+    ] = None

adcp/types/generated_poc/protocol_envelope.py

@@ -0,0 +1,61 @@
+# generated by datamodel-codegen:
+#   filename:  protocol-envelope.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AwareDatetime, ConfigDict, Field
+
+from . import push_notification_config as push_notification_config_1
+from . import task_status
+
+
+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/provide_performance_feedback_request.py

@@ -0,0 +1,85 @@
+# generated by datamodel-codegen:
+#   filename:  provide-performance-feedback-request.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AwareDatetime, ConfigDict, Field
+
+
+class FeedbackSource(Enum):
+    buyer_attribution = "buyer_attribution"
+    third_party_measurement = "third_party_measurement"
+    platform_analytics = "platform_analytics"
+    verification_partner = "verification_partner"
+
+
+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 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"
+
+
+class ProvidePerformanceFeedbackRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    context: Annotated[
+        dict[str, Any] | None,
+        Field(
+            description="Initiator-provided context included in the request payload. Agentsmust echo this value back unchanged in responses and webhooks. Use for UI/session hints, correlation tokens, or tracking metadata."
+        ),
+    ] = None
+    creative_id: Annotated[
+        str | None,
+        Field(
+            description="Specific creative asset (if feedback is creative-specific)", min_length=1
+        ),
+    ] = None
+    feedback_source: Annotated[
+        FeedbackSource | None, Field(description="Source of the performance data")
+    ] = 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[
+        MetricType | None, Field(description="The business metric being measured")
+    ] = 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,
+        ),
+    ]

adcp/types/generated_poc/provide_performance_feedback_response.py

@@ -0,0 +1,59 @@
+# generated by datamodel-codegen:
+#   filename:  provide-performance-feedback-response.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Any, Literal
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field, RootModel
+
+from . import error
+
+
+class ProvidePerformanceFeedbackResponse1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    context: Annotated[
+        dict[str, Any] | None,
+        Field(
+            description="Initiator-provided context echoed inside the task payload. Opaque metadata such as UI/session hints, correlation tokens, or tracking identifiers."
+        ),
+    ] = None
+    success: Annotated[
+        Literal[True],
+        Field(description="Whether the performance feedback was successfully received"),
+    ]
+
+
+class ProvidePerformanceFeedbackResponse2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    context: Annotated[
+        dict[str, Any] | None,
+        Field(
+            description="Initiator-provided context echoed inside the task payload. Opaque metadata such as UI/session hints, correlation tokens, or tracking identifiers."
+        ),
+    ] = 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,
+        ),
+    ]
+
+
+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/publisher_identifier_types.py

@@ -0,0 +1,15 @@
+# generated by datamodel-codegen:
+#   filename:  publisher-identifier-types.json
+#   timestamp: 2025-11-15T22:03:55+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/push_notification_config.py

@@ -0,0 +1,55 @@
+# generated by datamodel-codegen:
+#   filename:  push-notification-config.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AnyUrl, ConfigDict, Field
+
+
+class Scheme(Enum):
+    Bearer = "Bearer"
+    HMAC_SHA256 = "HMAC-SHA256"
+
+
+class Authentication(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    credentials: Annotated[
+        str,
+        Field(
+            description="Credentials for authentication. For Bearer: token sent in Authorization header. For HMAC-SHA256: shared secret used to generate signature. Minimum 32 characters. Exchanged out-of-band during onboarding.",
+            min_length=32,
+        ),
+    ]
+    schemes: Annotated[
+        list[Scheme],
+        Field(
+            description="Array of authentication schemes. Supported: ['Bearer'] for simple token auth, ['HMAC-SHA256'] for signature verification (recommended for production)",
+            max_length=1,
+            min_length=1,
+        ),
+    ]
+
+
+class PushNotificationConfig(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    authentication: Annotated[
+        Authentication,
+        Field(description="Authentication configuration for webhook delivery (A2A-compatible)"),
+    ]
+    token: Annotated[
+        str | None,
+        Field(
+            description="Optional client-provided token for webhook validation. Echoed back in webhook payload to validate request authenticity.",
+            min_length=16,
+        ),
+    ] = None
+    url: Annotated[AnyUrl, Field(description="Webhook endpoint URL for task status notifications")]

adcp/types/generated_poc/reporting_capabilities.py

@@ -0,0 +1,68 @@
+# generated by datamodel-codegen:
+#   filename:  reporting-capabilities.json
+#   timestamp: 2025-11-15T22:03:55+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
+
+
+class AvailableMetric(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 AvailableReportingFrequency(Enum):
+    hourly = "hourly"
+    daily = "daily"
+    monthly = "monthly"
+
+
+class ReportingCapabilities(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    available_metrics: Annotated[
+        list[AvailableMetric],
+        Field(
+            description="Metrics available in reporting. Impressions and spend are always implicitly included.",
+            examples=[
+                ["impressions", "spend", "clicks", "video_completions"],
+                ["impressions", "spend", "conversions"],
+            ],
+        ),
+    ]
+    available_reporting_frequencies: Annotated[
+        list[AvailableReportingFrequency],
+        Field(description="Supported reporting frequency options", min_length=1),
+    ]
+    expected_delay_minutes: Annotated[
+        int,
+        Field(
+            description="Expected delay in minutes before reporting data becomes available (e.g., 240 for 4-hour delay)",
+            examples=[240, 300, 1440],
+            ge=0,
+        ),
+    ]
+    supports_webhooks: Annotated[
+        bool,
+        Field(description="Whether this product supports webhook-based reporting notifications"),
+    ]
+    timezone: Annotated[
+        str,
+        Field(
+            description="Timezone for reporting periods. Use 'UTC' or IANA timezone (e.g., 'America/New_York'). Critical for daily/monthly frequency alignment.",
+            examples=["UTC", "America/New_York", "Europe/London", "America/Los_Angeles"],
+        ),
+    ]

adcp/types/generated_poc/response.py

@@ -0,0 +1,24 @@
+# generated by datamodel-codegen:
+#   filename:  response.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+
+class ProtocolResponse(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    context_id: Annotated[str | None, Field(description="Session continuity identifier")] = None
+    data: Annotated[
+        Any | None,
+        Field(
+            description="AdCP task-specific response data (see individual task response schemas)"
+        ),
+    ] = None
+    message: Annotated[str, Field(description="Human-readable summary")]

adcp/types/generated_poc/standard_format_ids.py

@@ -0,0 +1,45 @@
+# generated by datamodel-codegen:
+#   filename:  standard-format-ids.json
+#   timestamp: 2025-11-15T22:03:55+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/start_timing.py

@@ -0,0 +1,13 @@
+# generated by datamodel-codegen:
+#   filename:  start-timing.json
+#   timestamp: 2025-11-15T17:41:18+00:00
+
+from __future__ import annotations
+
+from pydantic import AwareDatetime, Field, RootModel
+
+
+class StartTiming(RootModel[str | AwareDatetime]):
+    root: str | AwareDatetime = Field(
+        ..., description="Campaign start timing: 'asap' or ISO 8601 date-time", title="Start Timing"
+    )

adcp/types/generated_poc/sub_asset.py

@@ -0,0 +1,55 @@
+# generated by datamodel-codegen:
+#   filename:  sub-asset.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Literal
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AnyUrl, ConfigDict, Field
+
+
+class SubAsset1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    asset_id: Annotated[
+        str, Field(description="Unique identifier for the asset within the creative")
+    ]
+    asset_kind: Annotated[
+        Literal["media"],
+        Field(description="Discriminator indicating this is a media asset with content_uri"),
+    ]
+    asset_type: Annotated[
+        str,
+        Field(
+            description="Type of asset. Common types: thumbnail_image, product_image, featured_image, logo"
+        ),
+    ]
+    content_uri: Annotated[AnyUrl, Field(description="URL for media assets (images, videos, etc.)")]
+
+
+class SubAsset2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    asset_id: Annotated[
+        str, Field(description="Unique identifier for the asset within the creative")
+    ]
+    asset_kind: Annotated[
+        Literal["text"],
+        Field(description="Discriminator indicating this is a text asset with content"),
+    ]
+    asset_type: Annotated[
+        str,
+        Field(
+            description="Type of asset. Common types: headline, body_text, cta_text, price_text, sponsor_name, author_name, click_url"
+        ),
+    ]
+    content: Annotated[
+        str | list[str],
+        Field(
+            description="Text content for text-based assets like headlines, body text, CTA text, etc."
+        ),
+    ]

adcp/types/generated_poc/sync_creatives_request.py

@@ -0,0 +1,69 @@
+# generated by datamodel-codegen:
+#   filename:  sync-creatives-request.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+from . import creative_asset
+from . import push_notification_config as push_notification_config_1
+
+
+class ValidationMode(Enum):
+    strict = "strict"
+    lenient = "lenient"
+
+
+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: Annotated[
+        dict[str, Any] | None,
+        Field(
+            description="Initiator-provided context included in the request payload. Agents must echo this value back unchanged in responses and webhooks. Use for UI/session hints, correlation tokens, or tracking metadata."
+        ),
+    ] = 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
+    patch: Annotated[
+        bool | None,
+        Field(
+            description="When true, only provided fields are updated (partial update). When false, entire creative is replaced (full upsert)."
+        ),
+    ] = False
+    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[
+        ValidationMode | None,
+        Field(
+            description="Validation strictness. 'strict' fails entire sync on any validation error. 'lenient' processes valid creatives and reports errors."
+        ),
+    ] = ValidationMode.strict