adcp 3.0.0__py3-none-any.whl → 3.2.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- adcp/ADCP_VERSION +1 -1
- adcp/__init__.py +13 -5
- adcp/__main__.py +4 -4
- adcp/adagents.py +5 -9
- adcp/client.py +14 -12
- adcp/protocols/a2a.py +3 -3
- adcp/protocols/base.py +2 -2
- adcp/protocols/mcp.py +3 -3
- adcp/server/base.py +6 -10
- adcp/server/content_standards.py +17 -49
- adcp/server/governance.py +20 -59
- adcp/server/mcp_tools.py +8 -4
- adcp/server/proposal.py +1 -3
- adcp/server/sponsored_intelligence.py +10 -28
- adcp/simple.py +10 -10
- adcp/types/__init__.py +14 -6
- adcp/types/_generated.py +44 -27
- adcp/types/aliases.py +55 -0
- adcp/types/base.py +7 -7
- adcp/types/generated_poc/{protocols → a2ui}/__init__.py +1 -1
- adcp/types/generated_poc/a2ui/component.py +24 -0
- adcp/types/generated_poc/a2ui/surface.py +33 -0
- adcp/types/generated_poc/account/__init__.py +3 -0
- adcp/types/generated_poc/account/list_accounts_request.py +30 -0
- adcp/types/generated_poc/account/list_accounts_response.py +30 -0
- adcp/types/generated_poc/adagents.py +192 -195
- adcp/types/generated_poc/content_standards/artifact.py +69 -69
- adcp/types/generated_poc/content_standards/artifact_webhook_payload.py +13 -13
- adcp/types/generated_poc/content_standards/calibrate_content_request.py +2 -2
- adcp/types/generated_poc/content_standards/calibrate_content_response.py +17 -17
- adcp/types/generated_poc/content_standards/content_standards.py +8 -8
- adcp/types/generated_poc/content_standards/create_content_standards_request.py +13 -13
- adcp/types/generated_poc/content_standards/create_content_standards_response.py +6 -6
- adcp/types/generated_poc/content_standards/get_content_standards_request.py +1 -1
- adcp/types/generated_poc/content_standards/get_content_standards_response.py +4 -4
- adcp/types/generated_poc/content_standards/get_media_buy_artifacts_request.py +14 -14
- adcp/types/generated_poc/content_standards/get_media_buy_artifacts_response.py +30 -30
- adcp/types/generated_poc/content_standards/list_content_standards_request.py +4 -4
- adcp/types/generated_poc/content_standards/list_content_standards_response.py +5 -5
- adcp/types/generated_poc/content_standards/update_content_standards_request.py +14 -14
- adcp/types/generated_poc/content_standards/update_content_standards_response.py +4 -4
- adcp/types/generated_poc/content_standards/validate_content_delivery_request.py +13 -13
- adcp/types/generated_poc/content_standards/validate_content_delivery_response.py +16 -16
- adcp/types/generated_poc/core/account.py +54 -0
- adcp/types/generated_poc/core/activation_key.py +8 -8
- adcp/types/generated_poc/core/assets/audio_asset.py +37 -8
- adcp/types/generated_poc/core/assets/css_asset.py +2 -2
- adcp/types/generated_poc/core/assets/daast_asset.py +18 -18
- adcp/types/generated_poc/core/assets/html_asset.py +2 -2
- adcp/types/generated_poc/core/assets/image_asset.py +6 -6
- adcp/types/generated_poc/core/assets/javascript_asset.py +3 -3
- adcp/types/generated_poc/core/assets/text_asset.py +2 -2
- adcp/types/generated_poc/core/assets/url_asset.py +3 -3
- adcp/types/generated_poc/core/assets/vast_asset.py +18 -18
- adcp/types/generated_poc/core/assets/video_asset.py +126 -10
- adcp/types/generated_poc/core/assets/webhook_asset.py +9 -9
- adcp/types/generated_poc/core/async_response_data.py +2 -2
- adcp/types/generated_poc/core/brand_manifest.py +66 -66
- adcp/types/generated_poc/core/brand_manifest_ref.py +9 -9
- adcp/types/generated_poc/core/context.py +1 -1
- adcp/types/generated_poc/core/creative_asset.py +12 -12
- adcp/types/generated_poc/core/creative_assignment.py +3 -3
- adcp/types/generated_poc/core/creative_filters.py +23 -17
- adcp/types/generated_poc/core/creative_manifest.py +4 -4
- adcp/types/generated_poc/core/creative_policy.py +4 -4
- adcp/types/generated_poc/core/delivery_metrics.py +32 -32
- adcp/types/generated_poc/core/deployment.py +20 -20
- adcp/types/generated_poc/core/destination.py +11 -11
- adcp/types/generated_poc/core/error.py +6 -6
- adcp/types/generated_poc/core/ext.py +1 -1
- adcp/types/generated_poc/core/format.py +49 -124
- adcp/types/generated_poc/core/format_id.py +5 -5
- adcp/types/generated_poc/core/frequency_cap.py +2 -2
- adcp/types/generated_poc/core/identifier.py +2 -2
- adcp/types/generated_poc/core/mcp_webhook_payload.py +10 -10
- adcp/types/generated_poc/core/measurement.py +8 -8
- adcp/types/generated_poc/core/media_buy.py +12 -8
- adcp/types/generated_poc/core/media_buy_features.py +3 -3
- adcp/types/generated_poc/core/offering.py +9 -9
- adcp/types/generated_poc/core/package.py +8 -8
- adcp/types/generated_poc/core/performance_feedback.py +18 -18
- adcp/types/generated_poc/core/placement.py +4 -4
- adcp/types/generated_poc/core/pricing_option.py +1 -1
- adcp/types/generated_poc/core/product.py +27 -21
- adcp/types/generated_poc/core/product_allocation.py +5 -5
- adcp/types/generated_poc/core/product_filters.py +27 -27
- adcp/types/generated_poc/core/promoted_offerings.py +18 -18
- adcp/types/generated_poc/core/promoted_products.py +2 -2
- adcp/types/generated_poc/core/property.py +10 -10
- adcp/types/generated_poc/core/property_id.py +4 -4
- adcp/types/generated_poc/core/property_list_ref.py +4 -4
- adcp/types/generated_poc/core/property_tag.py +4 -4
- adcp/types/generated_poc/core/proposal.py +13 -13
- adcp/types/generated_poc/core/protocol_envelope.py +8 -8
- adcp/types/generated_poc/core/publisher_property_selector.py +13 -13
- adcp/types/generated_poc/core/push_notification_config.py +5 -5
- adcp/types/generated_poc/core/reporting_capabilities.py +8 -8
- adcp/types/generated_poc/core/reporting_webhook.py +10 -10
- adcp/types/generated_poc/core/response.py +4 -4
- adcp/types/generated_poc/core/signal_filters.py +5 -5
- adcp/types/generated_poc/core/start_timing.py +3 -3
- adcp/types/generated_poc/core/sub_asset.py +14 -14
- adcp/types/generated_poc/core/targeting.py +17 -10
- adcp/types/generated_poc/creative/list_creative_formats_request.py +20 -20
- adcp/types/generated_poc/creative/list_creative_formats_response.py +5 -5
- adcp/types/generated_poc/creative/preview_creative_request.py +24 -24
- adcp/types/generated_poc/creative/preview_creative_response.py +28 -28
- adcp/types/generated_poc/creative/preview_render.py +25 -25
- adcp/types/generated_poc/enums/adcp_domain.py +4 -4
- adcp/types/generated_poc/enums/asset_content_type.py +13 -13
- adcp/types/generated_poc/enums/auth_scheme.py +2 -2
- adcp/types/generated_poc/enums/available_metric.py +9 -9
- adcp/types/generated_poc/enums/channels.py +19 -19
- adcp/types/generated_poc/enums/co_branding_requirement.py +3 -3
- adcp/types/generated_poc/enums/creative_action.py +5 -5
- adcp/types/generated_poc/enums/creative_agent_capability.py +4 -4
- adcp/types/generated_poc/enums/creative_sort_field.py +6 -6
- adcp/types/generated_poc/enums/creative_status.py +5 -5
- adcp/types/generated_poc/enums/daast_tracking_event.py +11 -11
- adcp/types/generated_poc/enums/daast_version.py +2 -2
- adcp/types/generated_poc/enums/delivery_type.py +2 -2
- adcp/types/generated_poc/enums/dimension_unit.py +4 -4
- adcp/types/generated_poc/enums/feed_format.py +3 -3
- adcp/types/generated_poc/enums/feedback_source.py +4 -4
- adcp/types/generated_poc/enums/format_category.py +7 -7
- adcp/types/generated_poc/enums/format_id_parameter.py +2 -2
- adcp/types/generated_poc/enums/frequency_cap_scope.py +3 -3
- adcp/types/generated_poc/enums/geo_level.py +4 -4
- adcp/types/generated_poc/enums/history_entry_type.py +2 -2
- adcp/types/generated_poc/enums/http_method.py +2 -2
- adcp/types/generated_poc/enums/identifier_types.py +19 -19
- adcp/types/generated_poc/enums/javascript_module_type.py +3 -3
- adcp/types/generated_poc/enums/landing_page_requirement.py +3 -3
- adcp/types/generated_poc/enums/markdown_flavor.py +2 -2
- adcp/types/generated_poc/enums/media_buy_status.py +4 -4
- adcp/types/generated_poc/enums/metric_type.py +8 -8
- adcp/types/generated_poc/enums/metro_system.py +5 -5
- adcp/types/generated_poc/enums/notification_type.py +4 -4
- adcp/types/generated_poc/enums/pacing.py +3 -3
- adcp/types/generated_poc/enums/postal_system.py +9 -9
- adcp/types/generated_poc/enums/preview_output_format.py +2 -2
- adcp/types/generated_poc/enums/pricing_model.py +7 -7
- adcp/types/generated_poc/enums/property_type.py +8 -8
- adcp/types/generated_poc/enums/publisher_identifier_types.py +5 -5
- adcp/types/generated_poc/enums/reporting_frequency.py +3 -3
- adcp/types/generated_poc/enums/signal_catalog_type.py +3 -3
- adcp/types/generated_poc/enums/sort_direction.py +2 -2
- adcp/types/generated_poc/enums/task_status.py +9 -9
- adcp/types/generated_poc/enums/task_type.py +11 -12
- adcp/types/generated_poc/enums/update_frequency.py +4 -4
- adcp/types/generated_poc/enums/url_asset_type.py +3 -3
- adcp/types/generated_poc/enums/validation_mode.py +2 -2
- adcp/types/generated_poc/enums/vast_tracking_event.py +16 -16
- adcp/types/generated_poc/enums/vast_version.py +5 -5
- adcp/types/generated_poc/enums/webhook_response_type.py +4 -4
- adcp/types/generated_poc/enums/webhook_security_method.py +3 -3
- adcp/types/generated_poc/extensions/extension_meta.py +14 -14
- adcp/types/generated_poc/media_buy/build_creative_request.py +4 -4
- adcp/types/generated_poc/media_buy/build_creative_response.py +6 -6
- adcp/types/generated_poc/media_buy/create_media_buy_async_response_input_required.py +5 -5
- adcp/types/generated_poc/media_buy/create_media_buy_async_response_submitted.py +1 -1
- adcp/types/generated_poc/media_buy/create_media_buy_async_response_working.py +5 -5
- adcp/types/generated_poc/media_buy/create_media_buy_request.py +27 -21
- adcp/types/generated_poc/media_buy/create_media_buy_response.py +15 -8
- adcp/types/generated_poc/media_buy/get_media_buy_delivery_request.py +8 -8
- adcp/types/generated_poc/media_buy/get_media_buy_delivery_response.py +51 -51
- adcp/types/generated_poc/media_buy/get_products_async_response_input_required.py +6 -6
- adcp/types/generated_poc/media_buy/get_products_async_response_submitted.py +2 -2
- adcp/types/generated_poc/media_buy/get_products_async_response_working.py +4 -4
- adcp/types/generated_poc/media_buy/get_products_request.py +11 -5
- adcp/types/generated_poc/media_buy/get_products_response.py +5 -5
- adcp/types/generated_poc/media_buy/list_creative_formats_request.py +9 -9
- adcp/types/generated_poc/media_buy/list_creative_formats_response.py +5 -5
- adcp/types/generated_poc/media_buy/list_creatives_request.py +23 -23
- adcp/types/generated_poc/media_buy/list_creatives_response.py +53 -49
- adcp/types/generated_poc/media_buy/package_request.py +8 -8
- adcp/types/generated_poc/media_buy/package_update.py +16 -16
- adcp/types/generated_poc/media_buy/provide_performance_feedback_request.py +19 -19
- adcp/types/generated_poc/media_buy/provide_performance_feedback_response.py +6 -6
- adcp/types/generated_poc/media_buy/sync_creatives_async_response_input_required.py +5 -5
- adcp/types/generated_poc/media_buy/sync_creatives_async_response_submitted.py +1 -1
- adcp/types/generated_poc/media_buy/sync_creatives_async_response_working.py +7 -7
- adcp/types/generated_poc/media_buy/sync_creatives_request.py +14 -8
- adcp/types/generated_poc/media_buy/sync_creatives_response.py +33 -29
- adcp/types/generated_poc/media_buy/update_media_buy_async_response_input_required.py +4 -4
- adcp/types/generated_poc/media_buy/update_media_buy_async_response_submitted.py +1 -1
- adcp/types/generated_poc/media_buy/update_media_buy_async_response_working.py +5 -5
- adcp/types/generated_poc/media_buy/update_media_buy_request.py +14 -14
- adcp/types/generated_poc/media_buy/update_media_buy_response.py +7 -7
- adcp/types/generated_poc/pricing_options/cpc_option.py +13 -26
- adcp/types/generated_poc/pricing_options/cpcv_option.py +13 -26
- adcp/types/generated_poc/pricing_options/cpm_option.py +13 -20
- adcp/types/generated_poc/pricing_options/cpp_option.py +19 -32
- adcp/types/generated_poc/pricing_options/cpv_option.py +19 -32
- adcp/types/generated_poc/pricing_options/flat_rate_option.py +23 -36
- adcp/types/generated_poc/pricing_options/price_guidance.py +26 -0
- adcp/types/generated_poc/pricing_options/vcpm_option.py +13 -26
- adcp/types/generated_poc/property/base_property_source.py +15 -15
- adcp/types/generated_poc/property/create_property_list_request.py +4 -4
- adcp/types/generated_poc/property/create_property_list_response.py +3 -3
- adcp/types/generated_poc/property/delete_property_list_request.py +2 -2
- adcp/types/generated_poc/property/delete_property_list_response.py +3 -3
- adcp/types/generated_poc/property/feature_requirement.py +8 -8
- adcp/types/generated_poc/property/get_property_list_request.py +5 -5
- adcp/types/generated_poc/property/get_property_list_response.py +11 -11
- adcp/types/generated_poc/property/list_property_lists_request.py +5 -5
- adcp/types/generated_poc/property/list_property_lists_response.py +8 -8
- adcp/types/generated_poc/property/property_error.py +10 -10
- adcp/types/generated_poc/property/property_feature.py +4 -4
- adcp/types/generated_poc/property/property_feature_definition.py +18 -18
- adcp/types/generated_poc/property/property_list.py +11 -11
- adcp/types/generated_poc/property/property_list_changed_webhook.py +11 -11
- adcp/types/generated_poc/property/property_list_filters.py +7 -7
- adcp/types/generated_poc/property/update_property_list_request.py +8 -8
- adcp/types/generated_poc/property/update_property_list_response.py +2 -2
- adcp/types/generated_poc/protocol/get_adcp_capabilities_request.py +8 -6
- adcp/types/generated_poc/protocol/get_adcp_capabilities_response.py +59 -58
- adcp/types/generated_poc/signals/activate_signal_request.py +3 -3
- adcp/types/generated_poc/signals/activate_signal_response.py +6 -6
- adcp/types/generated_poc/signals/get_signals_request.py +8 -8
- adcp/types/generated_poc/signals/get_signals_response.py +15 -15
- adcp/types/generated_poc/sponsored_intelligence/si_capabilities.py +45 -30
- adcp/types/generated_poc/sponsored_intelligence/si_get_offering_request.py +4 -4
- adcp/types/generated_poc/sponsored_intelligence/si_get_offering_response.py +23 -23
- adcp/types/generated_poc/sponsored_intelligence/si_identity.py +16 -16
- adcp/types/generated_poc/sponsored_intelligence/si_initiate_session_request.py +5 -5
- adcp/types/generated_poc/sponsored_intelligence/si_initiate_session_response.py +7 -7
- adcp/types/generated_poc/sponsored_intelligence/si_send_message_request.py +11 -11
- adcp/types/generated_poc/sponsored_intelligence/si_send_message_response.py +37 -23
- adcp/types/generated_poc/sponsored_intelligence/si_terminate_session_request.py +17 -17
- adcp/types/generated_poc/sponsored_intelligence/si_terminate_session_response.py +15 -15
- adcp/types/generated_poc/sponsored_intelligence/si_ui_element.py +11 -11
- adcp/utils/format_assets.py +32 -32
- {adcp-3.0.0.dist-info → adcp-3.2.0.dist-info}/METADATA +10 -5
- adcp-3.2.0.dist-info/RECORD +268 -0
- adcp/types/generated_poc/media_buy/list_authorized_properties_request.py +0 -38
- adcp/types/generated_poc/media_buy/list_authorized_properties_response.py +0 -84
- adcp/types/generated_poc/protocols/adcp_extension.py +0 -50
- adcp-3.0.0.dist-info/RECORD +0 -264
- {adcp-3.0.0.dist-info → adcp-3.2.0.dist-info}/WHEEL +0 -0
- {adcp-3.0.0.dist-info → adcp-3.2.0.dist-info}/entry_points.txt +0 -0
- {adcp-3.0.0.dist-info → adcp-3.2.0.dist-info}/licenses/LICENSE +0 -0
- {adcp-3.0.0.dist-info → adcp-3.2.0.dist-info}/top_level.txt +0 -0
|
@@ -19,49 +19,49 @@ from ..enums import pricing_model as pricing_model_1
|
|
|
19
19
|
|
|
20
20
|
class AggregatedTotals(AdCPBaseModel):
|
|
21
21
|
model_config = ConfigDict(
|
|
22
|
-
extra=
|
|
22
|
+
extra="allow",
|
|
23
23
|
)
|
|
24
24
|
clicks: Annotated[
|
|
25
25
|
float | None,
|
|
26
|
-
Field(description=
|
|
26
|
+
Field(description="Total clicks across all media buys (if applicable)", ge=0.0),
|
|
27
27
|
] = None
|
|
28
28
|
impressions: Annotated[
|
|
29
|
-
float, Field(description=
|
|
29
|
+
float, Field(description="Total impressions delivered across all media buys", ge=0.0)
|
|
30
30
|
]
|
|
31
31
|
media_buy_count: Annotated[
|
|
32
|
-
int, Field(description=
|
|
32
|
+
int, Field(description="Number of media buys included in the response", ge=0)
|
|
33
33
|
]
|
|
34
|
-
spend: Annotated[float, Field(description=
|
|
34
|
+
spend: Annotated[float, Field(description="Total amount spent across all media buys", ge=0.0)]
|
|
35
35
|
video_completions: Annotated[
|
|
36
36
|
float | None,
|
|
37
|
-
Field(description=
|
|
37
|
+
Field(description="Total video completions across all media buys (if applicable)", ge=0.0),
|
|
38
38
|
] = None
|
|
39
39
|
|
|
40
40
|
|
|
41
41
|
class DeliveryStatus(Enum):
|
|
42
|
-
delivering =
|
|
43
|
-
completed =
|
|
44
|
-
budget_exhausted =
|
|
45
|
-
flight_ended =
|
|
46
|
-
goal_met =
|
|
42
|
+
delivering = "delivering"
|
|
43
|
+
completed = "completed"
|
|
44
|
+
budget_exhausted = "budget_exhausted"
|
|
45
|
+
flight_ended = "flight_ended"
|
|
46
|
+
goal_met = "goal_met"
|
|
47
47
|
|
|
48
48
|
|
|
49
49
|
class DailyBreakdownItem(AdCPBaseModel):
|
|
50
50
|
model_config = ConfigDict(
|
|
51
|
-
extra=
|
|
51
|
+
extra="allow",
|
|
52
52
|
)
|
|
53
|
-
date: Annotated[str, Field(description=
|
|
54
|
-
impressions: Annotated[float, Field(description=
|
|
55
|
-
spend: Annotated[float, Field(description=
|
|
53
|
+
date: Annotated[str, Field(description="Date (YYYY-MM-DD)", pattern="^\\d{4}-\\d{2}-\\d{2}$")]
|
|
54
|
+
impressions: Annotated[float, Field(description="Daily impressions", ge=0.0)]
|
|
55
|
+
spend: Annotated[float, Field(description="Daily spend", ge=0.0)]
|
|
56
56
|
|
|
57
57
|
|
|
58
58
|
class Status(Enum):
|
|
59
|
-
pending =
|
|
60
|
-
active =
|
|
61
|
-
paused =
|
|
62
|
-
completed =
|
|
63
|
-
failed =
|
|
64
|
-
reporting_delayed =
|
|
59
|
+
pending = "pending"
|
|
60
|
+
active = "active"
|
|
61
|
+
paused = "paused"
|
|
62
|
+
completed = "completed"
|
|
63
|
+
failed = "failed"
|
|
64
|
+
reporting_delayed = "reporting_delayed"
|
|
65
65
|
|
|
66
66
|
|
|
67
67
|
class Totals(DeliveryMetrics):
|
|
@@ -76,23 +76,23 @@ class Totals(DeliveryMetrics):
|
|
|
76
76
|
|
|
77
77
|
|
|
78
78
|
class NotificationType(Enum):
|
|
79
|
-
scheduled =
|
|
80
|
-
final =
|
|
81
|
-
delayed =
|
|
82
|
-
adjusted =
|
|
79
|
+
scheduled = "scheduled"
|
|
80
|
+
final = "final"
|
|
81
|
+
delayed = "delayed"
|
|
82
|
+
adjusted = "adjusted"
|
|
83
83
|
|
|
84
84
|
|
|
85
85
|
class ReportingPeriod(AdCPBaseModel):
|
|
86
86
|
model_config = ConfigDict(
|
|
87
|
-
extra=
|
|
87
|
+
extra="allow",
|
|
88
88
|
)
|
|
89
89
|
end: Annotated[
|
|
90
90
|
AwareDatetime,
|
|
91
|
-
Field(description=
|
|
91
|
+
Field(description="ISO 8601 end timestamp in UTC (e.g., 2024-02-05T23:59:59Z)"),
|
|
92
92
|
]
|
|
93
93
|
start: Annotated[
|
|
94
94
|
AwareDatetime,
|
|
95
|
-
Field(description=
|
|
95
|
+
Field(description="ISO 8601 start timestamp in UTC (e.g., 2024-02-05T00:00:00Z)"),
|
|
96
96
|
]
|
|
97
97
|
|
|
98
98
|
|
|
@@ -104,33 +104,33 @@ class ByPackageItem(DeliveryMetrics):
|
|
|
104
104
|
str,
|
|
105
105
|
Field(
|
|
106
106
|
description="ISO 4217 currency code (e.g., USD, EUR, GBP) for this package's pricing. Indicates the currency in which the rate and spend values are denominated. Different packages can use different currencies when supported by the publisher.",
|
|
107
|
-
pattern=
|
|
107
|
+
pattern="^[A-Z]{3}$",
|
|
108
108
|
),
|
|
109
109
|
]
|
|
110
110
|
delivery_status: Annotated[
|
|
111
111
|
DeliveryStatus | None,
|
|
112
112
|
Field(
|
|
113
|
-
description=
|
|
113
|
+
description="System-reported operational state of this package. Reflects actual delivery state independent of buyer pause control."
|
|
114
114
|
),
|
|
115
115
|
] = None
|
|
116
116
|
pacing_index: Annotated[
|
|
117
117
|
float | None,
|
|
118
|
-
Field(description=
|
|
118
|
+
Field(description="Delivery pace (1.0 = on track, <1.0 = behind, >1.0 = ahead)", ge=0.0),
|
|
119
119
|
] = None
|
|
120
120
|
package_id: Annotated[str, Field(description="Publisher's package identifier")]
|
|
121
121
|
paused: Annotated[
|
|
122
|
-
bool | None, Field(description=
|
|
122
|
+
bool | None, Field(description="Whether this package is currently paused by the buyer")
|
|
123
123
|
] = None
|
|
124
124
|
pricing_model: Annotated[
|
|
125
125
|
pricing_model_1.PricingModel,
|
|
126
126
|
Field(
|
|
127
|
-
description=
|
|
127
|
+
description="The pricing model used for this package (e.g., cpm, cpcv, cpp). Indicates how the package is billed and which metrics are most relevant for optimization."
|
|
128
128
|
),
|
|
129
129
|
]
|
|
130
130
|
rate: Annotated[
|
|
131
131
|
float,
|
|
132
132
|
Field(
|
|
133
|
-
description=
|
|
133
|
+
description="The pricing rate for this package in the specified currency. For fixed-rate pricing, this is the agreed rate (e.g., CPM rate of 12.50 means $12.50 per 1,000 impressions). For auction-based pricing, this represents the effective rate based on actual delivery.",
|
|
134
134
|
ge=0.0,
|
|
135
135
|
),
|
|
136
136
|
]
|
|
@@ -139,36 +139,36 @@ class ByPackageItem(DeliveryMetrics):
|
|
|
139
139
|
|
|
140
140
|
class MediaBuyDelivery(AdCPBaseModel):
|
|
141
141
|
model_config = ConfigDict(
|
|
142
|
-
extra=
|
|
142
|
+
extra="allow",
|
|
143
143
|
)
|
|
144
144
|
buyer_ref: Annotated[
|
|
145
145
|
str | None, Field(description="Buyer's reference identifier for this media buy")
|
|
146
146
|
] = None
|
|
147
|
-
by_package: Annotated[list[ByPackageItem], Field(description=
|
|
147
|
+
by_package: Annotated[list[ByPackageItem], Field(description="Metrics broken down by package")]
|
|
148
148
|
daily_breakdown: Annotated[
|
|
149
|
-
list[DailyBreakdownItem] | None, Field(description=
|
|
149
|
+
list[DailyBreakdownItem] | None, Field(description="Day-by-day delivery")
|
|
150
150
|
] = None
|
|
151
151
|
expected_availability: Annotated[
|
|
152
152
|
AwareDatetime | None,
|
|
153
153
|
Field(
|
|
154
|
-
description=
|
|
154
|
+
description="When delayed data is expected to be available (only present when status is reporting_delayed)"
|
|
155
155
|
),
|
|
156
156
|
] = None
|
|
157
157
|
is_adjusted: Annotated[
|
|
158
158
|
bool | None,
|
|
159
159
|
Field(
|
|
160
|
-
description=
|
|
160
|
+
description="Indicates this delivery contains updated data for a previously reported period. Buyer should replace previous period data with these totals."
|
|
161
161
|
),
|
|
162
162
|
] = None
|
|
163
163
|
media_buy_id: Annotated[str, Field(description="Publisher's media buy identifier")]
|
|
164
164
|
pricing_model: Annotated[
|
|
165
165
|
pricing_model_1.PricingModel | None,
|
|
166
|
-
Field(description=
|
|
166
|
+
Field(description="Pricing model used for this media buy"),
|
|
167
167
|
] = None
|
|
168
168
|
status: Annotated[
|
|
169
169
|
Status,
|
|
170
170
|
Field(
|
|
171
|
-
description=
|
|
171
|
+
description="Current media buy status. In webhook context, reporting_delayed indicates data temporarily unavailable."
|
|
172
172
|
),
|
|
173
173
|
]
|
|
174
174
|
totals: Totals
|
|
@@ -176,27 +176,27 @@ class MediaBuyDelivery(AdCPBaseModel):
|
|
|
176
176
|
|
|
177
177
|
class GetMediaBuyDeliveryResponse(AdCPBaseModel):
|
|
178
178
|
model_config = ConfigDict(
|
|
179
|
-
extra=
|
|
179
|
+
extra="allow",
|
|
180
180
|
)
|
|
181
181
|
aggregated_totals: Annotated[
|
|
182
182
|
AggregatedTotals | None,
|
|
183
183
|
Field(
|
|
184
|
-
description=
|
|
184
|
+
description="Combined metrics across all returned media buys. Only included in API responses (get_media_buy_delivery), not in webhook notifications."
|
|
185
185
|
),
|
|
186
186
|
] = None
|
|
187
187
|
context: context_1.ContextObject | None = None
|
|
188
|
-
currency: Annotated[str, Field(description=
|
|
188
|
+
currency: Annotated[str, Field(description="ISO 4217 currency code", pattern="^[A-Z]{3}$")]
|
|
189
189
|
errors: Annotated[
|
|
190
190
|
list[error.Error] | None,
|
|
191
191
|
Field(
|
|
192
|
-
description=
|
|
192
|
+
description="Task-specific errors and warnings (e.g., missing delivery data, reporting platform issues)"
|
|
193
193
|
),
|
|
194
194
|
] = None
|
|
195
195
|
ext: ext_1.ExtensionObject | None = None
|
|
196
196
|
media_buy_deliveries: Annotated[
|
|
197
197
|
list[MediaBuyDelivery],
|
|
198
198
|
Field(
|
|
199
|
-
description=
|
|
199
|
+
description="Array of delivery data for media buys. When used in webhook notifications, may contain multiple media buys aggregated by publisher. When used in get_media_buy_delivery API responses, typically contains requested media buys."
|
|
200
200
|
),
|
|
201
201
|
]
|
|
202
202
|
next_expected_at: Annotated[
|
|
@@ -208,30 +208,30 @@ class GetMediaBuyDeliveryResponse(AdCPBaseModel):
|
|
|
208
208
|
notification_type: Annotated[
|
|
209
209
|
NotificationType | None,
|
|
210
210
|
Field(
|
|
211
|
-
description=
|
|
211
|
+
description="Type of webhook notification (only present in webhook deliveries): scheduled = regular periodic update, final = campaign completed, delayed = data not yet available, adjusted = resending period with updated data"
|
|
212
212
|
),
|
|
213
213
|
] = None
|
|
214
214
|
partial_data: Annotated[
|
|
215
215
|
bool | None,
|
|
216
216
|
Field(
|
|
217
|
-
description=
|
|
217
|
+
description="Indicates if any media buys in this webhook have missing/delayed data (only present in webhook deliveries)"
|
|
218
218
|
),
|
|
219
219
|
] = None
|
|
220
220
|
reporting_period: Annotated[
|
|
221
221
|
ReportingPeriod,
|
|
222
|
-
Field(description=
|
|
222
|
+
Field(description="Date range for the report. All periods use UTC timezone."),
|
|
223
223
|
]
|
|
224
224
|
sequence_number: Annotated[
|
|
225
225
|
int | None,
|
|
226
226
|
Field(
|
|
227
|
-
description=
|
|
227
|
+
description="Sequential notification number (only present in webhook deliveries, starts at 1)",
|
|
228
228
|
ge=1,
|
|
229
229
|
),
|
|
230
230
|
] = None
|
|
231
231
|
unavailable_count: Annotated[
|
|
232
232
|
int | None,
|
|
233
233
|
Field(
|
|
234
|
-
description=
|
|
234
|
+
description="Number of media buys with reporting_delayed or failed status (only present in webhook deliveries when partial_data is true)",
|
|
235
235
|
ge=0,
|
|
236
236
|
),
|
|
237
237
|
] = None
|
|
@@ -16,23 +16,23 @@ from ..core import product
|
|
|
16
16
|
|
|
17
17
|
|
|
18
18
|
class Reason(Enum):
|
|
19
|
-
CLARIFICATION_NEEDED =
|
|
20
|
-
BUDGET_REQUIRED =
|
|
19
|
+
CLARIFICATION_NEEDED = "CLARIFICATION_NEEDED"
|
|
20
|
+
BUDGET_REQUIRED = "BUDGET_REQUIRED"
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
class GetProductsInputRequired(AdCPBaseModel):
|
|
24
24
|
model_config = ConfigDict(
|
|
25
|
-
extra=
|
|
25
|
+
extra="allow",
|
|
26
26
|
)
|
|
27
27
|
context: context_1.ContextObject | None = None
|
|
28
28
|
ext: ext_1.ExtensionObject | None = None
|
|
29
29
|
partial_results: Annotated[
|
|
30
30
|
list[product.Product] | None,
|
|
31
|
-
Field(description=
|
|
31
|
+
Field(description="Partial product results that may help inform the clarification"),
|
|
32
32
|
] = None
|
|
33
33
|
reason: Annotated[
|
|
34
|
-
Reason | None, Field(description=
|
|
34
|
+
Reason | None, Field(description="Reason code indicating why input is needed")
|
|
35
35
|
] = None
|
|
36
36
|
suggestions: Annotated[
|
|
37
|
-
list[str] | None, Field(description=
|
|
37
|
+
list[str] | None, Field(description="Suggested values or options for the required input")
|
|
38
38
|
] = None
|
|
@@ -15,10 +15,10 @@ from ..core import ext as ext_1
|
|
|
15
15
|
|
|
16
16
|
class GetProductsSubmitted(AdCPBaseModel):
|
|
17
17
|
model_config = ConfigDict(
|
|
18
|
-
extra=
|
|
18
|
+
extra="allow",
|
|
19
19
|
)
|
|
20
20
|
context: context_1.ContextObject | None = None
|
|
21
21
|
estimated_completion: Annotated[
|
|
22
|
-
AwareDatetime | None, Field(description=
|
|
22
|
+
AwareDatetime | None, Field(description="Estimated completion time for the search")
|
|
23
23
|
] = None
|
|
24
24
|
ext: ext_1.ExtensionObject | None = None
|
|
@@ -15,7 +15,7 @@ from ..core import ext as ext_1
|
|
|
15
15
|
|
|
16
16
|
class GetProductsWorking(AdCPBaseModel):
|
|
17
17
|
model_config = ConfigDict(
|
|
18
|
-
extra=
|
|
18
|
+
extra="allow",
|
|
19
19
|
)
|
|
20
20
|
context: context_1.ContextObject | None = None
|
|
21
21
|
current_step: Annotated[
|
|
@@ -27,9 +27,9 @@ class GetProductsWorking(AdCPBaseModel):
|
|
|
27
27
|
ext: ext_1.ExtensionObject | None = None
|
|
28
28
|
percentage: Annotated[
|
|
29
29
|
float | None,
|
|
30
|
-
Field(description=
|
|
30
|
+
Field(description="Progress percentage of the search operation", ge=0.0, le=100.0),
|
|
31
31
|
] = None
|
|
32
|
-
step_number: Annotated[int | None, Field(description=
|
|
32
|
+
step_number: Annotated[int | None, Field(description="Current step number (1-indexed)")] = None
|
|
33
33
|
total_steps: Annotated[
|
|
34
|
-
int | None, Field(description=
|
|
34
|
+
int | None, Field(description="Total number of steps in the search process")
|
|
35
35
|
] = None
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# generated by datamodel-codegen:
|
|
2
2
|
# filename: media_buy/get_products_request.json
|
|
3
|
-
# timestamp: 2026-
|
|
3
|
+
# timestamp: 2026-02-02T17:45:21+00:00
|
|
4
4
|
|
|
5
5
|
from __future__ import annotations
|
|
6
6
|
|
|
@@ -17,12 +17,18 @@ from ..core import product_filters, property_list_ref
|
|
|
17
17
|
|
|
18
18
|
class GetProductsRequest(AdCPBaseModel):
|
|
19
19
|
model_config = ConfigDict(
|
|
20
|
-
extra=
|
|
20
|
+
extra="allow",
|
|
21
21
|
)
|
|
22
|
+
account_id: Annotated[
|
|
23
|
+
str | None,
|
|
24
|
+
Field(
|
|
25
|
+
description="Account context for product lookup. When provided, returns products with pricing specific to this account's rate card. Optional if the agent has a single account."
|
|
26
|
+
),
|
|
27
|
+
] = None
|
|
22
28
|
brand_manifest: Annotated[
|
|
23
29
|
brand_manifest_ref.BrandManifestReference | None,
|
|
24
30
|
Field(
|
|
25
|
-
description=
|
|
31
|
+
description="Brand information manifest providing brand context, assets, and product catalog. Can be provided inline or as a URL reference to a hosted manifest."
|
|
26
32
|
),
|
|
27
33
|
] = None
|
|
28
34
|
brief: Annotated[
|
|
@@ -37,12 +43,12 @@ class GetProductsRequest(AdCPBaseModel):
|
|
|
37
43
|
property_list: Annotated[
|
|
38
44
|
property_list_ref.PropertyListReference | None,
|
|
39
45
|
Field(
|
|
40
|
-
description=
|
|
46
|
+
description="[AdCP 3.0] Reference to an externally managed property list. When provided, the sales agent should filter products to only those available on properties in the list."
|
|
41
47
|
),
|
|
42
48
|
] = None
|
|
43
49
|
proposal_id: Annotated[
|
|
44
50
|
str | None,
|
|
45
51
|
Field(
|
|
46
|
-
description=
|
|
52
|
+
description="Optional proposal ID to refine. When provided with a brief, the publisher will use the brief as refinement instructions for the specified proposal and return an updated version."
|
|
47
53
|
),
|
|
48
54
|
] = None
|
|
@@ -17,24 +17,24 @@ from ..core import product, proposal
|
|
|
17
17
|
|
|
18
18
|
class GetProductsResponse(AdCPBaseModel):
|
|
19
19
|
model_config = ConfigDict(
|
|
20
|
-
extra=
|
|
20
|
+
extra="allow",
|
|
21
21
|
)
|
|
22
22
|
context: context_1.ContextObject | None = None
|
|
23
23
|
errors: Annotated[
|
|
24
24
|
list[error.Error] | None,
|
|
25
|
-
Field(description=
|
|
25
|
+
Field(description="Task-specific errors and warnings (e.g., product filtering issues)"),
|
|
26
26
|
] = None
|
|
27
27
|
ext: ext_1.ExtensionObject | None = None
|
|
28
|
-
products: Annotated[list[product.Product], Field(description=
|
|
28
|
+
products: Annotated[list[product.Product], Field(description="Array of matching products")]
|
|
29
29
|
property_list_applied: Annotated[
|
|
30
30
|
bool | None,
|
|
31
31
|
Field(
|
|
32
|
-
description=
|
|
32
|
+
description="[AdCP 3.0] Indicates whether property_list filtering was applied. True if the agent filtered products based on the provided property_list. Absent or false if property_list was not provided or not supported by this agent."
|
|
33
33
|
),
|
|
34
34
|
] = None
|
|
35
35
|
proposals: Annotated[
|
|
36
36
|
list[proposal.Proposal] | None,
|
|
37
37
|
Field(
|
|
38
|
-
description=
|
|
38
|
+
description="Optional array of proposed media plans with budget allocations across products. Publishers include proposals when they can provide strategic guidance based on the brief. Proposals are actionable - buyers can refine them via subsequent get_products calls or execute them directly via create_media_buy."
|
|
39
39
|
),
|
|
40
40
|
] = None
|
|
@@ -17,7 +17,7 @@ from ..enums import asset_content_type, format_category
|
|
|
17
17
|
|
|
18
18
|
class ListCreativeFormatsRequest(AdCPBaseModel):
|
|
19
19
|
model_config = ConfigDict(
|
|
20
|
-
extra=
|
|
20
|
+
extra="allow",
|
|
21
21
|
)
|
|
22
22
|
asset_types: Annotated[
|
|
23
23
|
list[asset_content_type.AssetContentType] | None,
|
|
@@ -30,45 +30,45 @@ class ListCreativeFormatsRequest(AdCPBaseModel):
|
|
|
30
30
|
format_ids: Annotated[
|
|
31
31
|
list[format_id.FormatId] | None,
|
|
32
32
|
Field(
|
|
33
|
-
description=
|
|
33
|
+
description="Return only these specific format IDs (e.g., from get_products response)"
|
|
34
34
|
),
|
|
35
35
|
] = None
|
|
36
36
|
is_responsive: Annotated[
|
|
37
37
|
bool | None,
|
|
38
38
|
Field(
|
|
39
|
-
description=
|
|
39
|
+
description="Filter for responsive formats that adapt to container size. When true, returns formats without fixed dimensions."
|
|
40
40
|
),
|
|
41
41
|
] = None
|
|
42
42
|
max_height: Annotated[
|
|
43
43
|
int | None,
|
|
44
44
|
Field(
|
|
45
|
-
description=
|
|
45
|
+
description="Maximum height in pixels (inclusive). Returns formats where ANY render has height <= this value. For multi-render formats, matches if at least one render fits."
|
|
46
46
|
),
|
|
47
47
|
] = None
|
|
48
48
|
max_width: Annotated[
|
|
49
49
|
int | None,
|
|
50
50
|
Field(
|
|
51
|
-
description=
|
|
51
|
+
description="Maximum width in pixels (inclusive). Returns formats where ANY render has width <= this value. For multi-render formats, matches if at least one render fits."
|
|
52
52
|
),
|
|
53
53
|
] = None
|
|
54
54
|
min_height: Annotated[
|
|
55
55
|
int | None,
|
|
56
56
|
Field(
|
|
57
|
-
description=
|
|
57
|
+
description="Minimum height in pixels (inclusive). Returns formats where ANY render has height >= this value."
|
|
58
58
|
),
|
|
59
59
|
] = None
|
|
60
60
|
min_width: Annotated[
|
|
61
61
|
int | None,
|
|
62
62
|
Field(
|
|
63
|
-
description=
|
|
63
|
+
description="Minimum width in pixels (inclusive). Returns formats where ANY render has width >= this value."
|
|
64
64
|
),
|
|
65
65
|
] = None
|
|
66
66
|
name_search: Annotated[
|
|
67
|
-
str | None, Field(description=
|
|
67
|
+
str | None, Field(description="Search for formats by name (case-insensitive partial match)")
|
|
68
68
|
] = None
|
|
69
69
|
type: Annotated[
|
|
70
70
|
format_category.FormatCategory | None,
|
|
71
71
|
Field(
|
|
72
|
-
description=
|
|
72
|
+
description="Filter by format type (technical categories with distinct requirements)"
|
|
73
73
|
),
|
|
74
74
|
] = None
|
|
@@ -18,7 +18,7 @@ from ..enums import creative_agent_capability
|
|
|
18
18
|
|
|
19
19
|
class CreativeAgent(AdCPBaseModel):
|
|
20
20
|
agent_name: Annotated[
|
|
21
|
-
str | None, Field(description=
|
|
21
|
+
str | None, Field(description="Human-readable name for the creative agent")
|
|
22
22
|
] = None
|
|
23
23
|
agent_url: Annotated[
|
|
24
24
|
AnyUrl,
|
|
@@ -28,24 +28,24 @@ class CreativeAgent(AdCPBaseModel):
|
|
|
28
28
|
]
|
|
29
29
|
capabilities: Annotated[
|
|
30
30
|
list[creative_agent_capability.CreativeAgentCapability] | None,
|
|
31
|
-
Field(description=
|
|
31
|
+
Field(description="Capabilities this creative agent provides"),
|
|
32
32
|
] = None
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
class ListCreativeFormatsResponse(AdCPBaseModel):
|
|
36
36
|
model_config = ConfigDict(
|
|
37
|
-
extra=
|
|
37
|
+
extra="allow",
|
|
38
38
|
)
|
|
39
39
|
context: context_1.ContextObject | None = None
|
|
40
40
|
creative_agents: Annotated[
|
|
41
41
|
list[CreativeAgent] | None,
|
|
42
42
|
Field(
|
|
43
|
-
description=
|
|
43
|
+
description="Optional: Creative agents that provide additional formats. Buyers can recursively query these agents to discover more formats. No authentication required for list_creative_formats."
|
|
44
44
|
),
|
|
45
45
|
] = None
|
|
46
46
|
errors: Annotated[
|
|
47
47
|
list[error.Error] | None,
|
|
48
|
-
Field(description=
|
|
48
|
+
Field(description="Task-specific errors and warnings (e.g., format availability issues)"),
|
|
49
49
|
] = None
|
|
50
50
|
ext: ext_1.ExtensionObject | None = None
|
|
51
51
|
formats: Annotated[
|
|
@@ -17,60 +17,60 @@ from ..enums import creative_sort_field, sort_direction
|
|
|
17
17
|
|
|
18
18
|
|
|
19
19
|
class FieldModel(Enum):
|
|
20
|
-
creative_id =
|
|
21
|
-
name =
|
|
22
|
-
format_ =
|
|
23
|
-
status =
|
|
24
|
-
created_date =
|
|
25
|
-
updated_date =
|
|
26
|
-
tags =
|
|
27
|
-
assignments =
|
|
28
|
-
performance =
|
|
29
|
-
sub_assets =
|
|
20
|
+
creative_id = "creative_id"
|
|
21
|
+
name = "name"
|
|
22
|
+
format_ = "format"
|
|
23
|
+
status = "status"
|
|
24
|
+
created_date = "created_date"
|
|
25
|
+
updated_date = "updated_date"
|
|
26
|
+
tags = "tags"
|
|
27
|
+
assignments = "assignments"
|
|
28
|
+
performance = "performance"
|
|
29
|
+
sub_assets = "sub_assets"
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
class Pagination(AdCPBaseModel):
|
|
33
33
|
model_config = ConfigDict(
|
|
34
|
-
extra=
|
|
34
|
+
extra="allow",
|
|
35
35
|
)
|
|
36
36
|
limit: Annotated[
|
|
37
|
-
int | None, Field(description=
|
|
37
|
+
int | None, Field(description="Maximum number of creatives to return", ge=1, le=100)
|
|
38
38
|
] = 50
|
|
39
|
-
offset: Annotated[int | None, Field(description=
|
|
39
|
+
offset: Annotated[int | None, Field(description="Number of creatives to skip", ge=0)] = 0
|
|
40
40
|
|
|
41
41
|
|
|
42
42
|
class Sort(AdCPBaseModel):
|
|
43
43
|
model_config = ConfigDict(
|
|
44
|
-
extra=
|
|
44
|
+
extra="allow",
|
|
45
45
|
)
|
|
46
46
|
direction: Annotated[
|
|
47
|
-
sort_direction.SortDirection | None, Field(description=
|
|
47
|
+
sort_direction.SortDirection | None, Field(description="Sort direction")
|
|
48
48
|
] = sort_direction.SortDirection.desc
|
|
49
49
|
field: Annotated[
|
|
50
|
-
creative_sort_field.CreativeSortField | None, Field(description=
|
|
50
|
+
creative_sort_field.CreativeSortField | None, Field(description="Field to sort by")
|
|
51
51
|
] = creative_sort_field.CreativeSortField.created_date
|
|
52
52
|
|
|
53
53
|
|
|
54
54
|
class ListCreativesRequest(AdCPBaseModel):
|
|
55
55
|
model_config = ConfigDict(
|
|
56
|
-
extra=
|
|
56
|
+
extra="allow",
|
|
57
57
|
)
|
|
58
58
|
context: context_1.ContextObject | None = None
|
|
59
59
|
ext: ext_1.ExtensionObject | None = None
|
|
60
60
|
fields: Annotated[
|
|
61
61
|
list[FieldModel] | None,
|
|
62
|
-
Field(description=
|
|
62
|
+
Field(description="Specific fields to include in response (omit for all fields)"),
|
|
63
63
|
] = None
|
|
64
64
|
filters: creative_filters.CreativeFilters | None = None
|
|
65
65
|
include_assignments: Annotated[
|
|
66
|
-
bool | None, Field(description=
|
|
66
|
+
bool | None, Field(description="Include package assignment information in response")
|
|
67
67
|
] = True
|
|
68
68
|
include_performance: Annotated[
|
|
69
|
-
bool | None, Field(description=
|
|
69
|
+
bool | None, Field(description="Include aggregated performance metrics in response")
|
|
70
70
|
] = False
|
|
71
71
|
include_sub_assets: Annotated[
|
|
72
72
|
bool | None,
|
|
73
|
-
Field(description=
|
|
73
|
+
Field(description="Include sub-assets (for carousel/native formats) in response"),
|
|
74
74
|
] = False
|
|
75
|
-
pagination: Annotated[Pagination | None, Field(description=
|
|
76
|
-
sort: Annotated[Sort | None, Field(description=
|
|
75
|
+
pagination: Annotated[Pagination | None, Field(description="Pagination parameters")] = None
|
|
76
|
+
sort: Annotated[Sort | None, Field(description="Sorting parameters")] = None
|