adcp 2.19.0__py3-none-any.whl → 3.1.0__py3-none-any.whl

adcp/types/generated_poc/content_standards/__init__.py

@@ -0,0 +1,3 @@
+# generated by datamodel-codegen:
+#   filename:  .schema_temp
+#   timestamp: 2026-01-25T21:17:54+00:00

adcp/types/generated_poc/content_standards/artifact.py

@@ -0,0 +1,208 @@
+# generated by datamodel-codegen:
+#   filename:  content_standards/artifact.json
+#   timestamp: 2026-01-25T21:17:54+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 AnyUrl, AwareDatetime, ConfigDict, Field, RootModel
+
+from ..core import format_id as format_id_1
+from ..core import identifier
+
+
+class Role(Enum):
+    title_ = 'title'
+    paragraph = 'paragraph'
+    heading = 'heading'
+    caption = 'caption'
+    quote = 'quote'
+    list_item = 'list_item'
+    description = 'description'
+
+
+class Assets(AdCPBaseModel):
+    content: Annotated[str, Field(description='Text content')]
+    heading_level: Annotated[
+        int | None, Field(description='Heading level (1-6), only for role=heading', ge=1, le=6)
+    ] = None
+    language: Annotated[
+        str | None,
+        Field(
+            description="BCP 47 language tag for this text (e.g., 'en', 'es-MX'). Useful when artifact contains mixed-language content."
+        ),
+    ] = None
+    role: Annotated[
+        Role | None,
+        Field(
+            description="Role of this text in the document. Use 'title' for the main artifact title, 'description' for summaries."
+        ),
+    ] = None
+    type: Literal['text']
+
+
+class TranscriptSource(Enum):
+    original_script = 'original_script'
+    subtitles = 'subtitles'
+    closed_captions = 'closed_captions'
+    dub = 'dub'
+    generated = 'generated'
+
+
+class TranscriptSource1(Enum):
+    original_script = 'original_script'
+    closed_captions = 'closed_captions'
+    generated = 'generated'
+
+
+class Identifiers(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    apple_podcast_id: Annotated[str | None, Field(description='Apple Podcasts ID')] = None
+    podcast_guid: Annotated[str | None, Field(description='Podcast GUID (from RSS feed)')] = None
+    rss_url: Annotated[AnyUrl | None, Field(description='RSS feed URL')] = None
+    spotify_show_id: Annotated[str | None, Field(description='Spotify show ID')] = None
+    youtube_video_id: Annotated[str | None, Field(description='YouTube video ID')] = None
+
+
+class Metadata(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    author: Annotated[str | None, Field(description='Artifact author name')] = None
+    canonical: Annotated[AnyUrl | None, Field(description='Canonical URL')] = None
+    json_ld: Annotated[
+        list[dict[str, Any]] | None, Field(description='JSON-LD structured data (schema.org)')
+    ] = None
+    keywords: Annotated[str | None, Field(description='Artifact keywords')] = None
+    open_graph: Annotated[
+        dict[str, Any] | None, Field(description='Open Graph protocol metadata')
+    ] = None
+    twitter_card: Annotated[dict[str, Any] | None, Field(description='Twitter Card metadata')] = (
+        None
+    )
+
+
+class AssetAccess1(AdCPBaseModel):
+    method: Literal['bearer_token']
+    token: Annotated[str, Field(description='OAuth2 bearer token for Authorization header')]
+
+
+class Provider(Enum):
+    gcp = 'gcp'
+    aws = 'aws'
+
+
+class AssetAccess2(AdCPBaseModel):
+    credentials: Annotated[
+        dict[str, Any] | None, Field(description='Service account credentials')
+    ] = None
+    method: Literal['service_account']
+    provider: Annotated[Provider, Field(description='Cloud provider')]
+
+
+class AssetAccess3(AdCPBaseModel):
+    method: Literal['signed_url']
+
+
+class AssetAccess(RootModel[AssetAccess1 | AssetAccess2 | AssetAccess3]):
+    root: Annotated[
+        AssetAccess1 | AssetAccess2 | AssetAccess3,
+        Field(description='Authentication for accessing secured asset URLs'),
+    ]
+
+
+class Assets1(AdCPBaseModel):
+    access: Annotated[AssetAccess | None, Field(description='Authentication for secured URLs')] = (
+        None
+    )
+    alt_text: Annotated[str | None, Field(description='Alt text or image description')] = None
+    caption: Annotated[str | None, Field(description='Image caption')] = None
+    height: Annotated[int | None, Field(description='Image height in pixels')] = None
+    type: Literal['image']
+    url: Annotated[AnyUrl, Field(description='Image URL')]
+    width: Annotated[int | None, Field(description='Image width in pixels')] = None
+
+
+class Assets2(AdCPBaseModel):
+    access: Annotated[AssetAccess | None, Field(description='Authentication for secured URLs')] = (
+        None
+    )
+    duration_ms: Annotated[int | None, Field(description='Video duration in milliseconds')] = None
+    thumbnail_url: Annotated[AnyUrl | None, Field(description='Video thumbnail URL')] = None
+    transcript: Annotated[str | None, Field(description='Video transcript')] = None
+    transcript_source: Annotated[
+        TranscriptSource | None, Field(description='How the transcript was generated')
+    ] = None
+    type: Literal['video']
+    url: Annotated[AnyUrl, Field(description='Video URL')]
+
+
+class Assets3(AdCPBaseModel):
+    access: Annotated[AssetAccess | None, Field(description='Authentication for secured URLs')] = (
+        None
+    )
+    duration_ms: Annotated[int | None, Field(description='Audio duration in milliseconds')] = None
+    transcript: Annotated[str | None, Field(description='Audio transcript')] = None
+    transcript_source: Annotated[
+        TranscriptSource1 | None, Field(description='How the transcript was generated')
+    ] = None
+    type: Literal['audio']
+    url: Annotated[AnyUrl, Field(description='Audio URL')]
+
+
+class Artifact(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    artifact_id: Annotated[
+        str,
+        Field(
+            description="Identifier for this artifact within the property. The property owner defines the scheme (e.g., 'article_12345', 'episode_42_segment_3', 'post_abc123')."
+        ),
+    ]
+    assets: Annotated[
+        list[Assets | Assets1 | Assets2 | Assets3],
+        Field(
+            description='Artifact assets in document flow order - text blocks, images, video, audio'
+        ),
+    ]
+    format_id: Annotated[
+        format_id_1.FormatId | None,
+        Field(
+            description='Optional reference to a format definition. Uses the same format registry as creative formats.'
+        ),
+    ] = None
+    identifiers: Annotated[
+        Identifiers | None, Field(description='Platform-specific identifiers for this artifact')
+    ] = None
+    last_update_time: Annotated[
+        AwareDatetime | None,
+        Field(description='When the artifact was last modified (ISO 8601 format)'),
+    ] = None
+    metadata: Annotated[
+        Metadata | None, Field(description='Rich metadata extracted from the artifact')
+    ] = None
+    property_id: Annotated[
+        identifier.Identifier,
+        Field(description='Identifier for the property where this artifact appears'),
+    ]
+    published_time: Annotated[
+        AwareDatetime | None, Field(description='When the artifact was published (ISO 8601 format)')
+    ] = None
+    url: Annotated[
+        AnyUrl | None,
+        Field(
+            description='Optional URL for this artifact (web page, podcast feed, video page). Not all artifacts have URLs (e.g., Instagram content, podcast segments, TV scenes).'
+        ),
+    ] = None
+    variant_id: Annotated[
+        str | None,
+        Field(
+            description="Identifies a specific variant of this artifact. Use for A/B tests, translations, or temporal versions. Examples: 'en', 'es-MX', 'v2', 'headline_test_b'. The combination of artifact_id + variant_id must be unique."
+        ),
+    ] = None

adcp/types/generated_poc/content_standards/artifact_webhook_payload.py

@@ -0,0 +1,64 @@
+# generated by datamodel-codegen:
+#   filename:  content_standards/artifact_webhook_payload.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AwareDatetime, ConfigDict, Field
+
+from ..core import ext as ext_1
+from . import artifact as artifact_1
+
+
+class Pagination(AdCPBaseModel):
+    batch_number: Annotated[int | None, Field(description='Current batch number (1-indexed)')] = (
+        None
+    )
+    total_artifacts: Annotated[
+        int | None, Field(description='Total artifacts in the delivery period')
+    ] = None
+    total_batches: Annotated[
+        int | None, Field(description='Total batches for this delivery period')
+    ] = None
+
+
+class Artifact(AdCPBaseModel):
+    artifact: Annotated[artifact_1.Artifact, Field(description='The content artifact')]
+    delivered_at: Annotated[
+        AwareDatetime, Field(description='When the impression was delivered (ISO 8601)')
+    ]
+    impression_id: Annotated[
+        str | None,
+        Field(description='Optional impression identifier for correlation with delivery reports'),
+    ] = None
+    package_id: Annotated[
+        str | None, Field(description='Package within the media buy this artifact relates to')
+    ] = None
+
+
+class ArtifactWebhookPayload(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    artifacts: Annotated[
+        list[Artifact], Field(description='Content artifacts from delivered impressions')
+    ]
+    batch_id: Annotated[
+        str,
+        Field(
+            description='Unique identifier for this batch of artifacts. Use for deduplication and acknowledgment.'
+        ),
+    ]
+    ext: ext_1.ExtensionObject | None = None
+    media_buy_id: Annotated[
+        str, Field(description='Media buy identifier these artifacts belong to')
+    ]
+    pagination: Annotated[
+        Pagination | None, Field(description='Pagination info when batching large artifact sets')
+    ] = None
+    timestamp: Annotated[
+        AwareDatetime, Field(description='When this batch was generated (ISO 8601)')
+    ]

adcp/types/generated_poc/content_standards/calibrate_content_request.py

@@ -0,0 +1,17 @@
+# generated by datamodel-codegen:
+#   filename:  content_standards/calibrate_content_request.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import Field
+
+from . import artifact as artifact_1
+
+
+class CalibrateContentRequest(AdCPBaseModel):
+    artifact: Annotated[artifact_1.Artifact, Field(description='Artifact to evaluate')]
+    standards_id: Annotated[str, Field(description='Standards configuration to calibrate against')]

adcp/types/generated_poc/content_standards/calibrate_content_response.py

@@ -0,0 +1,74 @@
+# generated by datamodel-codegen:
+#   filename:  content_standards/calibrate_content_response.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import Field, RootModel
+
+from ..core import error
+
+
+class Status(Enum):
+    passed = 'passed'
+    failed = 'failed'
+    warning = 'warning'
+    unevaluated = 'unevaluated'
+
+
+class Feature(AdCPBaseModel):
+    explanation: Annotated[
+        str | None,
+        Field(description='Human-readable explanation of why this feature passed or failed'),
+    ] = None
+    feature_id: Annotated[
+        str,
+        Field(
+            description='Which feature was evaluated (e.g., brand_safety, brand_suitability, competitor_adjacency)'
+        ),
+    ]
+    status: Annotated[Status, Field(description='Evaluation status for this feature')]
+
+
+class Verdict(Enum):
+    pass_ = 'pass'
+    fail = 'fail'
+
+
+class CalibrateContentResponse1(AdCPBaseModel):
+    confidence: Annotated[
+        float | None, Field(description='Model confidence in the verdict (0-1)', ge=0.0, le=1.0)
+    ] = None
+    errors: Annotated[
+        Any | None, Field(description='Field must not be present in success response')
+    ] = None
+    explanation: Annotated[
+        str | None, Field(description='Detailed natural language explanation of the decision')
+    ] = None
+    features: Annotated[
+        list[Feature] | None, Field(description='Per-feature breakdown with explanations')
+    ] = None
+    verdict: Annotated[
+        Verdict, Field(description='Overall pass/fail verdict for the content evaluation')
+    ]
+
+
+class CalibrateContentResponse2(AdCPBaseModel):
+    errors: list[error.Error]
+    verdict: Annotated[
+        Any | None, Field(description='Field must not be present in error response')
+    ] = None
+
+
+class CalibrateContentResponse(RootModel[CalibrateContentResponse1 | CalibrateContentResponse2]):
+    root: Annotated[
+        CalibrateContentResponse1 | CalibrateContentResponse2,
+        Field(
+            description='Response payload with verdict and detailed explanations for collaborative calibration',
+            title='Calibrate Content Response',
+        ),
+    ]

adcp/types/generated_poc/content_standards/content_standards.py

@@ -0,0 +1,66 @@
+# generated by datamodel-codegen:
+#   filename:  content_standards/content_standards.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import Field
+
+from ..core import ext as ext_1
+from ..enums import channels
+from . import artifact
+
+
+class CalibrationExemplars(AdCPBaseModel):
+    fail: Annotated[
+        list[artifact.Artifact] | None,
+        Field(description='Artifacts that fail the content standards'),
+    ] = None
+    pass_: Annotated[
+        list[artifact.Artifact] | None,
+        Field(alias='pass', description='Artifacts that pass the content standards'),
+    ] = None
+
+
+class ContentStandards(AdCPBaseModel):
+    calibration_exemplars: Annotated[
+        CalibrationExemplars | None,
+        Field(
+            description='Training/test set to calibrate policy interpretation. Provides concrete examples of pass/fail decisions.'
+        ),
+    ] = None
+    channels_any: Annotated[
+        list[channels.MediaChannel] | None,
+        Field(
+            description='Advertising channels. Standards apply to ANY of the listed channels (OR logic).'
+        ),
+    ] = None
+    countries_all: Annotated[
+        list[str] | None,
+        Field(
+            description='ISO 3166-1 alpha-2 country codes. Standards apply in ALL listed countries (AND logic).'
+        ),
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    languages_any: Annotated[
+        list[str] | None,
+        Field(
+            description="BCP 47 language tags (e.g., 'en', 'de', 'fr'). Standards apply to content in ANY of these languages (OR logic). Content in unlisted languages is not covered by these standards.",
+            min_length=1,
+        ),
+    ] = None
+    name: Annotated[
+        str | None, Field(description='Human-readable name for this standards configuration')
+    ] = None
+    policy: Annotated[
+        str | None,
+        Field(
+            description='Natural language policy describing acceptable and unacceptable content contexts. Used by LLMs and human reviewers to make judgments.'
+        ),
+    ] = None
+    standards_id: Annotated[
+        str, Field(description='Unique identifier for this standards configuration')
+    ]

adcp/types/generated_poc/content_standards/create_content_standards_request.py

@@ -0,0 +1,97 @@
+# generated by datamodel-codegen:
+#   filename:  content_standards/create_content_standards_request.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Literal
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AnyUrl, ConfigDict, Field
+
+from ..core import context as context_1
+from ..core import ext as ext_1
+from ..enums import channels
+from . import artifact
+
+
+class Fail(AdCPBaseModel):
+    language: Annotated[
+        str | None, Field(description='BCP 47 language tag for content at this URL')
+    ] = None
+    type: Annotated[Literal['url'], Field(description='Indicates this is a URL reference')]
+    value: Annotated[
+        AnyUrl,
+        Field(
+            description="Full URL to a specific page (e.g., 'https://news.example.com/controversial-article')"
+        ),
+    ]
+
+
+class Pass(AdCPBaseModel):
+    language: Annotated[
+        str | None, Field(description='BCP 47 language tag for content at this URL')
+    ] = None
+    type: Annotated[Literal['url'], Field(description='Indicates this is a URL reference')]
+    value: Annotated[
+        AnyUrl,
+        Field(
+            description="Full URL to a specific page (e.g., 'https://espn.com/nba/story/_/id/12345/lakers-win')"
+        ),
+    ]
+
+
+class Scope(AdCPBaseModel):
+    channels_any: Annotated[
+        list[channels.MediaChannel] | None,
+        Field(
+            description='Advertising channels. Standards apply to ANY of the listed channels (OR logic).'
+        ),
+    ] = None
+    countries_all: Annotated[
+        list[str] | None,
+        Field(
+            description='ISO 3166-1 alpha-2 country codes. Standards apply in ALL listed countries (AND logic).'
+        ),
+    ] = None
+    description: Annotated[
+        str | None, Field(description='Human-readable description of this scope')
+    ] = None
+    languages_any: Annotated[
+        list[str],
+        Field(
+            description="BCP 47 language tags (e.g., 'en', 'de', 'fr'). Standards apply to content in ANY of these languages (OR logic). Content in unlisted languages is not covered by these standards.",
+            min_length=1,
+        ),
+    ]
+
+
+class CalibrationExemplars(AdCPBaseModel):
+    fail: Annotated[
+        list[Fail | artifact.Artifact] | None, Field(description='Content that fails the standards')
+    ] = None
+    pass_: Annotated[
+        list[Pass | artifact.Artifact] | None,
+        Field(alias='pass', description='Content that passes the standards'),
+    ] = None
+
+
+class CreateContentStandardsRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    calibration_exemplars: Annotated[
+        CalibrationExemplars | None,
+        Field(
+            description='Training/test set to calibrate policy interpretation. Use URL references for pages to be fetched and analyzed, or full artifacts for pre-extracted content.'
+        ),
+    ] = None
+    context: context_1.ContextObject | None = None
+    ext: ext_1.ExtensionObject | None = None
+    policy: Annotated[
+        str,
+        Field(
+            description='Natural language policy describing acceptable and unacceptable content contexts. Used by LLMs and human reviewers to make judgments.'
+        ),
+    ]
+    scope: Annotated[Scope, Field(description='Where this standards configuration applies')]

adcp/types/generated_poc/content_standards/create_content_standards_response.py

@@ -0,0 +1,52 @@
+# generated by datamodel-codegen:
+#   filename:  content_standards/create_content_standards_response.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import Field, RootModel
+
+from ..core import context as context_1
+from ..core import error
+from ..core import ext as ext_1
+
+
+class CreateContentStandardsResponse1(AdCPBaseModel):
+    context: context_1.ContextObject | None = None
+    errors: Annotated[
+        Any | None, Field(description='Field must not be present in success response')
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    standards_id: Annotated[
+        str, Field(description='Unique identifier for the created standards configuration')
+    ]
+
+
+class CreateContentStandardsResponse2(AdCPBaseModel):
+    conflicting_standards_id: Annotated[
+        str | None,
+        Field(
+            description='If the error is a scope conflict, the ID of the existing standards that conflict'
+        ),
+    ] = None
+    context: context_1.ContextObject | None = None
+    errors: list[error.Error]
+    ext: ext_1.ExtensionObject | None = None
+    standards_id: Annotated[
+        Any | None, Field(description='Field must not be present in error response')
+    ] = None
+
+
+class CreateContentStandardsResponse(
+    RootModel[CreateContentStandardsResponse1 | CreateContentStandardsResponse2]
+):
+    root: Annotated[
+        CreateContentStandardsResponse1 | CreateContentStandardsResponse2,
+        Field(
+            description='Response payload for creating a content standards configuration',
+            title='Create Content Standards Response',
+        ),
+    ]

adcp/types/generated_poc/content_standards/get_content_standards_request.py

@@ -0,0 +1,21 @@
+# generated by datamodel-codegen:
+#   filename:  content_standards/get_content_standards_request.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import Field
+
+from ..core import context as context_1
+from ..core import ext as ext_1
+
+
+class GetContentStandardsRequest(AdCPBaseModel):
+    context: context_1.ContextObject | None = None
+    ext: ext_1.ExtensionObject | None = None
+    standards_id: Annotated[
+        str, Field(description='Identifier for the standards configuration to retrieve')
+    ]

adcp/types/generated_poc/content_standards/get_content_standards_response.py

@@ -0,0 +1,43 @@
+# generated by datamodel-codegen:
+#   filename:  content_standards/get_content_standards_response.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import Field, RootModel
+
+from ..core import context as context_1
+from ..core import error
+from ..core import ext as ext_1
+from .content_standards import ContentStandards
+
+
+class GetContentStandardsResponse2(AdCPBaseModel):
+    context: context_1.ContextObject | None = None
+    errors: list[error.Error]
+    ext: ext_1.ExtensionObject | None = None
+    standards_id: Annotated[
+        Any | None, Field(description='Field must not be present in error response')
+    ] = None
+
+
+class GetContentStandardsResponse1(ContentStandards):
+    context: context_1.ContextObject | None = None
+    errors: Annotated[
+        Any | None, Field(description='Field must not be present in success response')
+    ] = None
+
+
+class GetContentStandardsResponse(
+    RootModel[GetContentStandardsResponse1 | GetContentStandardsResponse2]
+):
+    root: Annotated[
+        GetContentStandardsResponse1 | GetContentStandardsResponse2,
+        Field(
+            description='Response payload with content safety policies',
+            title='Get Content Standards Response',
+        ),
+    ]