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

adcp/types/generated_poc/performance_feedback.py

@@ -0,0 +1,89 @@
+# generated by datamodel-codegen:
+#   filename:  performance-feedback.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 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 Status(Enum):
+    accepted = "accepted"
+    queued = "queued"
+    applied = "applied"
+    rejected = "rejected"
+
+
+class PerformanceFeedback(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    applied_at: Annotated[
+        AwareDatetime | None,
+        Field(
+            description="ISO 8601 timestamp when feedback was applied to optimization algorithms"
+        ),
+    ] = None
+    creative_id: Annotated[
+        str | None, Field(description="Specific creative asset (if feedback is creative-specific)")
+    ] = None
+    feedback_id: Annotated[
+        str, Field(description="Unique identifier for this performance feedback submission")
+    ]
+    feedback_source: Annotated[FeedbackSource, Field(description="Source of the performance data")]
+    measurement_period: Annotated[
+        MeasurementPeriod, Field(description="Time period for performance measurement")
+    ]
+    media_buy_id: Annotated[str, Field(description="Publisher's media buy identifier")]
+    metric_type: Annotated[MetricType, Field(description="The business metric being measured")]
+    package_id: Annotated[
+        str | None,
+        Field(
+            description="Specific package within the media buy (if feedback is package-specific)"
+        ),
+    ] = None
+    performance_index: Annotated[
+        float,
+        Field(
+            description="Normalized performance score (0.0 = no value, 1.0 = expected, >1.0 = above expected)",
+            ge=0.0,
+        ),
+    ]
+    status: Annotated[Status, Field(description="Processing status of the performance feedback")]
+    submitted_at: Annotated[
+        AwareDatetime, Field(description="ISO 8601 timestamp when feedback was submitted")
+    ]

adcp/types/generated_poc/placement.py

@@ -0,0 +1,37 @@
+# generated by datamodel-codegen:
+#   filename:  placement.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
+
+from . import format_id
+
+
+class Placement(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    description: Annotated[
+        str | None, Field(description="Detailed description of where and how the placement appears")
+    ] = None
+    format_ids: Annotated[
+        list[format_id.FormatId] | None,
+        Field(
+            description="Format IDs supported by this specific placement (subset of product's formats)",
+            min_length=1,
+        ),
+    ] = None
+    name: Annotated[
+        str,
+        Field(
+            description="Human-readable name for the placement (e.g., 'Homepage Banner', 'Article Sidebar')"
+        ),
+    ]
+    placement_id: Annotated[
+        str, Field(description="Unique identifier for the placement within the product")
+    ]

adcp/types/generated_poc/preview_creative_request.py

@@ -0,0 +1,163 @@
+# generated by datamodel-codegen:
+#   filename:  preview-creative-request.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated, Any, Literal
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field, RootModel
+
+from . import creative_manifest as creative_manifest_1
+from . import format_id as format_id_1
+
+
+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 (e.g., 'User just searched for running shoes', 'Podcast discussing weather patterns', 'Article about electric vehicles')"
+        ),
+    ] = None
+    macros: Annotated[
+        dict[str, str] | None,
+        Field(
+            description="Macro values to use for this preview. Supports all universal macros from the format's supported_macros list. See docs/media-buy/creatives/universal-macros.md for available macros."
+        ),
+    ] = None
+    name: Annotated[
+        str,
+        Field(
+            description="Human-readable name for this input set (e.g., 'Sunny morning on mobile', 'Evening podcast ad', 'Desktop dark mode')"
+        ),
+    ]
+
+
+class OutputFormat(Enum):
+    url = "url"
+    html = "html"
+
+
+class Input2(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 use for this preview")
+    ] = None
+    name: Annotated[str, Field(description="Human-readable name for this input set")]
+
+
+class PreviewCreativeRequest1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    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
+    creative_manifest: Annotated[
+        creative_manifest_1.CreativeManifest,
+        Field(
+            description="Complete creative manifest with all required assets (including promoted_offerings if required by the format)"
+        ),
+    ]
+    format_id: Annotated[
+        format_id_1.FormatId, Field(description="Format identifier for rendering the preview")
+    ]
+    inputs: Annotated[
+        list[Input] | None,
+        Field(
+            description="Array of input sets for generating multiple preview variants. Each input set defines macros and context values for one preview rendering. If not provided, creative agent will generate default previews."
+        ),
+    ] = None
+    output_format: Annotated[
+        OutputFormat | None,
+        Field(
+            description="Output format for previews. 'url' returns preview_url (iframe-embeddable URL), 'html' returns preview_html (raw HTML for direct embedding). Default: 'url' for backward compatibility."
+        ),
+    ] = OutputFormat.url
+    request_type: Annotated[
+        Literal["single"],
+        Field(description="Discriminator indicating this is a single preview request"),
+    ]
+    template_id: Annotated[
+        str | None, Field(description="Specific template ID for custom format rendering")
+    ] = None
+
+
+class Request(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    creative_manifest: Annotated[
+        creative_manifest_1.CreativeManifest,
+        Field(description="Complete creative manifest with all required assets"),
+    ]
+    format_id: Annotated[
+        format_id_1.FormatId, Field(description="Format identifier for rendering the preview")
+    ]
+    inputs: Annotated[
+        list[Input2] | None,
+        Field(description="Array of input sets for generating multiple preview variants"),
+    ] = None
+    output_format: Annotated[
+        OutputFormat | None,
+        Field(
+            description="Output format for this preview. 'url' returns preview_url, 'html' returns preview_html."
+        ),
+    ] = OutputFormat.url
+    template_id: Annotated[
+        str | None, Field(description="Specific template ID for custom format rendering")
+    ] = None
+
+
+class PreviewCreativeRequest2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    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
+    output_format: Annotated[
+        OutputFormat | None,
+        Field(
+            description="Default output format for all requests in this batch. Individual requests can override this. 'url' returns preview_url (iframe-embeddable URL), 'html' returns preview_html (raw HTML for direct embedding)."
+        ),
+    ] = OutputFormat.url
+    request_type: Annotated[
+        Literal["batch"],
+        Field(description="Discriminator indicating this is a batch preview request"),
+    ]
+    requests: Annotated[
+        list[Request],
+        Field(
+            description="Array of preview requests (1-50 items). Each follows the single request structure.",
+            max_length=50,
+            min_length=1,
+        ),
+    ]
+
+
+class PreviewCreativeRequest(RootModel[PreviewCreativeRequest1 | PreviewCreativeRequest2]):
+    root: Annotated[
+        PreviewCreativeRequest1 | PreviewCreativeRequest2,
+        Field(
+            description="Request to generate previews of one or more creative manifests. Accepts either a single creative request or an array of requests for batch processing.",
+            title="Preview Creative Request",
+        ),
+    ]

adcp/types/generated_poc/preview_creative_response.py

@@ -0,0 +1,175 @@
+# generated by datamodel-codegen:
+#   filename:  preview-creative-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 AnyUrl, AwareDatetime, ConfigDict, Field, RootModel
+
+from . import preview_render
+
+
+class Input(AdCPBaseModel):
+    context_description: Annotated[
+        str | None, Field(description="Context description applied to this variant")
+    ] = None
+    macros: Annotated[
+        dict[str, str] | None, Field(description="Macro values applied to this variant")
+    ] = None
+    name: Annotated[str, Field(description="Human-readable name for this variant")]
+
+
+class Error(AdCPBaseModel):
+    code: Annotated[
+        str,
+        Field(
+            description="Error code (e.g., 'invalid_manifest', 'unsupported_format', 'missing_assets')"
+        ),
+    ]
+    details: Annotated[dict[str, Any] | None, Field(description="Additional error context")] = None
+    message: Annotated[str, Field(description="Human-readable error message")]
+
+
+class Input4(AdCPBaseModel):
+    context_description: str | None = None
+    macros: dict[str, str] | None = None
+    name: str
+
+
+class Preview(AdCPBaseModel):
+    input: Annotated[
+        Input,
+        Field(
+            description="The input parameters that generated this preview variant. Echoes back the request input or shows defaults used."
+        ),
+    ]
+    preview_id: Annotated[str, Field(description="Unique identifier for this preview variant")]
+    renders: Annotated[
+        list[
+            preview_render.PreviewRender1
+            | preview_render.PreviewRender2
+            | preview_render.PreviewRender3
+        ],
+        Field(
+            description="Array of rendered pieces for this preview variant. Most formats render as a single piece. Companion ad formats (video + banner), multi-placement formats, and adaptive formats render as multiple pieces.",
+            min_length=1,
+        ),
+    ]
+
+
+class PreviewCreativeResponse1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    context: Annotated[
+        dict[str, Any] | None,
+        Field(
+            description="Initiator-provided context echoed inside the preview payload. Opaque metadata such as UI/session hints, correlation tokens, or tracking identifiers."
+        ),
+    ] = None
+    expires_at: Annotated[
+        AwareDatetime, Field(description="ISO 8601 timestamp when preview links expire")
+    ]
+    interactive_url: Annotated[
+        AnyUrl | None,
+        Field(
+            description="Optional URL to an interactive testing page that shows all preview variants with controls to switch between them, modify macro values, and test different scenarios."
+        ),
+    ] = None
+    previews: Annotated[
+        list[Preview],
+        Field(
+            description="Array of preview variants. Each preview corresponds to an input set from the request. If no inputs were provided, returns a single default preview.",
+            min_length=1,
+        ),
+    ]
+    response_type: Annotated[
+        Literal["single"],
+        Field(description="Discriminator indicating this is a single preview response"),
+    ]
+
+
+class Preview1(AdCPBaseModel):
+    input: Input4
+    preview_id: str
+    renders: Annotated[
+        list[
+            preview_render.PreviewRender1
+            | preview_render.PreviewRender2
+            | preview_render.PreviewRender3
+        ],
+        Field(min_length=1),
+    ]
+
+
+class Response(AdCPBaseModel):
+    expires_at: AwareDatetime
+    interactive_url: AnyUrl | None = None
+    previews: Annotated[
+        list[Preview1],
+        Field(description="Array of preview variants for this creative", min_length=1),
+    ]
+
+
+class Results(AdCPBaseModel):
+    error: Annotated[Error | None, Field(description="Error information for failed requests")] = (
+        None
+    )
+    response: Annotated[Response, Field(description="Preview response for successful requests")]
+    success: Annotated[Literal[True], Field(description="Whether this preview request succeeded")]
+
+
+Preview2 = Preview1
+
+
+class Response1(AdCPBaseModel):
+    expires_at: AwareDatetime
+    interactive_url: AnyUrl | None = None
+    previews: Annotated[
+        list[Preview2],
+        Field(description="Array of preview variants for this creative", min_length=1),
+    ]
+
+
+class Results1(AdCPBaseModel):
+    error: Annotated[Error, Field(description="Error information for failed requests")]
+    response: Annotated[
+        Response1 | None, Field(description="Preview response for successful requests")
+    ] = None
+    success: Annotated[Literal[False], Field(description="Whether this preview request succeeded")]
+
+
+class PreviewCreativeResponse2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    context: Annotated[
+        dict[str, Any] | None,
+        Field(
+            description="Initiator-provided context echoed inside the preview payload. Opaque metadata such as UI/session hints, correlation tokens, or tracking identifiers."
+        ),
+    ] = None
+    response_type: Annotated[
+        Literal["batch"],
+        Field(description="Discriminator indicating this is a batch preview response"),
+    ]
+    results: Annotated[
+        list[Results | Results1],
+        Field(
+            description="Array of preview results corresponding to each request in the same order. results[0] is the result for requests[0], results[1] for requests[1], etc. Order is guaranteed even when some requests fail. Each result contains either a successful preview response or an error.",
+            min_length=1,
+        ),
+    ]
+
+
+class PreviewCreativeResponse(RootModel[PreviewCreativeResponse1 | PreviewCreativeResponse2]):
+    root: Annotated[
+        PreviewCreativeResponse1 | PreviewCreativeResponse2,
+        Field(
+            description="Response containing preview links for one or more creatives. Format matches the request: single preview response for single requests, batch results for batch requests.",
+            title="Preview Creative Response",
+        ),
+    ]

adcp/types/generated_poc/preview_render.py

@@ -0,0 +1,144 @@
+# generated by datamodel-codegen:
+#   filename:  preview-render.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, RootModel
+
+
+class Dimensions(AdCPBaseModel):
+    height: Annotated[float, Field(ge=0.0)]
+    width: Annotated[float, Field(ge=0.0)]
+
+
+class Embedding(AdCPBaseModel):
+    csp_policy: Annotated[
+        str | None, Field(description="Content Security Policy requirements for embedding")
+    ] = None
+    recommended_sandbox: Annotated[
+        str | None,
+        Field(
+            description="Recommended iframe sandbox attribute value (e.g., 'allow-scripts allow-same-origin')"
+        ),
+    ] = None
+    requires_https: Annotated[
+        bool | None, Field(description="Whether this output requires HTTPS for secure embedding")
+    ] = None
+    supports_fullscreen: Annotated[
+        bool | None, Field(description="Whether this output supports fullscreen mode")
+    ] = None
+
+
+class PreviewRender1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    dimensions: Annotated[
+        Dimensions | None, Field(description="Dimensions for this rendered piece")
+    ] = None
+    embedding: Annotated[
+        Embedding | None,
+        Field(description="Optional security and embedding metadata for safe iframe integration"),
+    ] = None
+    output_format: Annotated[
+        Literal["url"], Field(description="Discriminator indicating preview_url is provided")
+    ]
+    preview_url: Annotated[
+        AnyUrl,
+        Field(
+            description="URL to an HTML page that renders this piece. Can be embedded in an iframe."
+        ),
+    ]
+    render_id: Annotated[
+        str, Field(description="Unique identifier for this rendered piece within the variant")
+    ]
+    role: Annotated[
+        str,
+        Field(
+            description="Semantic role of this rendered piece. Use 'primary' for main content, 'companion' for associated banners, descriptive strings for device variants or custom roles."
+        ),
+    ]
+
+
+class PreviewRender2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    dimensions: Annotated[
+        Dimensions | None, Field(description="Dimensions for this rendered piece")
+    ] = None
+    embedding: Annotated[
+        Embedding | None, Field(description="Optional security and embedding metadata")
+    ] = None
+    output_format: Annotated[
+        Literal["html"], Field(description="Discriminator indicating preview_html is provided")
+    ]
+    preview_html: Annotated[
+        str,
+        Field(
+            description="Raw HTML for this rendered piece. Can be embedded directly in the page without iframe. Security warning: Only use with trusted creative agents as this bypasses iframe sandboxing."
+        ),
+    ]
+    render_id: Annotated[
+        str, Field(description="Unique identifier for this rendered piece within the variant")
+    ]
+    role: Annotated[
+        str,
+        Field(
+            description="Semantic role of this rendered piece. Use 'primary' for main content, 'companion' for associated banners, descriptive strings for device variants or custom roles."
+        ),
+    ]
+
+
+class PreviewRender3(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    dimensions: Annotated[
+        Dimensions | None, Field(description="Dimensions for this rendered piece")
+    ] = None
+    embedding: Annotated[
+        Embedding | None,
+        Field(description="Optional security and embedding metadata for safe iframe integration"),
+    ] = None
+    output_format: Annotated[
+        Literal["both"],
+        Field(
+            description="Discriminator indicating both preview_url and preview_html are provided"
+        ),
+    ]
+    preview_html: Annotated[
+        str,
+        Field(
+            description="Raw HTML for this rendered piece. Can be embedded directly in the page without iframe. Security warning: Only use with trusted creative agents as this bypasses iframe sandboxing."
+        ),
+    ]
+    preview_url: Annotated[
+        AnyUrl,
+        Field(
+            description="URL to an HTML page that renders this piece. Can be embedded in an iframe."
+        ),
+    ]
+    render_id: Annotated[
+        str, Field(description="Unique identifier for this rendered piece within the variant")
+    ]
+    role: Annotated[
+        str,
+        Field(
+            description="Semantic role of this rendered piece. Use 'primary' for main content, 'companion' for associated banners, descriptive strings for device variants or custom roles."
+        ),
+    ]
+
+
+class PreviewRender(RootModel[PreviewRender1 | PreviewRender2 | PreviewRender3]):
+    root: Annotated[
+        PreviewRender1 | PreviewRender2 | PreviewRender3,
+        Field(
+            description="A single rendered piece of a creative preview with discriminated output format",
+            title="Preview Render",
+        ),
+    ]

adcp/types/generated_poc/pricing_model.py

@@ -0,0 +1,17 @@
+# generated by datamodel-codegen:
+#   filename:  pricing-model.json
+#   timestamp: 2025-11-15T22:03:55+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"