adcp 2.3.0__py3-none-any.whl → 2.4.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/__init__.py +1 -1
- adcp/types/generated.py +36 -531
- adcp/types/generated_poc/__init__.py +1 -1
- adcp/types/generated_poc/activate_signal_request.py +5 -5
- adcp/types/generated_poc/activate_signal_response.py +9 -9
- adcp/types/generated_poc/activation_key.py +8 -8
- adcp/types/generated_poc/adagents.py +46 -46
- adcp/types/generated_poc/asset_type.py +19 -19
- adcp/types/generated_poc/audio_asset.py +6 -6
- adcp/types/generated_poc/brand_manifest.py +73 -73
- adcp/types/generated_poc/build_creative_request.py +6 -6
- adcp/types/generated_poc/build_creative_response.py +9 -9
- adcp/types/generated_poc/channels.py +10 -10
- adcp/types/generated_poc/cpc_option.py +12 -8
- adcp/types/generated_poc/cpcv_option.py +12 -8
- adcp/types/generated_poc/cpm_auction_option.py +17 -13
- adcp/types/generated_poc/cpm_fixed_option.py +12 -8
- adcp/types/generated_poc/cpp_option.py +17 -13
- adcp/types/generated_poc/cpv_option.py +16 -12
- adcp/types/generated_poc/create_media_buy_request.py +29 -29
- adcp/types/generated_poc/create_media_buy_response.py +11 -11
- adcp/types/generated_poc/creative_asset.py +13 -13
- adcp/types/generated_poc/creative_assignment.py +4 -4
- adcp/types/generated_poc/creative_manifest.py +4 -4
- adcp/types/generated_poc/creative_policy.py +11 -11
- adcp/types/generated_poc/creative_status.py +5 -5
- adcp/types/generated_poc/css_asset.py +3 -3
- adcp/types/generated_poc/daast_asset.py +30 -30
- adcp/types/generated_poc/delivery_metrics.py +33 -33
- adcp/types/generated_poc/delivery_type.py +3 -3
- adcp/types/generated_poc/deployment.py +21 -21
- adcp/types/generated_poc/destination.py +10 -10
- adcp/types/generated_poc/error.py +7 -7
- adcp/types/generated_poc/flat_rate_option.py +16 -16
- adcp/types/generated_poc/format.py +70 -70
- adcp/types/generated_poc/format_id.py +3 -3
- adcp/types/generated_poc/frequency_cap.py +3 -3
- adcp/types/generated_poc/frequency_cap_scope.py +4 -4
- adcp/types/generated_poc/get_media_buy_delivery_request.py +21 -21
- adcp/types/generated_poc/get_media_buy_delivery_response.py +46 -46
- adcp/types/generated_poc/get_products_request.py +23 -23
- adcp/types/generated_poc/get_products_response.py +5 -5
- adcp/types/generated_poc/get_signals_request.py +19 -19
- adcp/types/generated_poc/get_signals_response.py +20 -20
- adcp/types/generated_poc/html_asset.py +3 -3
- adcp/types/generated_poc/identifier_types.py +20 -20
- adcp/types/generated_poc/image_asset.py +7 -7
- adcp/types/generated_poc/javascript_asset.py +7 -7
- adcp/types/generated_poc/list_authorized_properties_request.py +5 -5
- adcp/types/generated_poc/list_authorized_properties_response.py +9 -9
- adcp/types/generated_poc/list_creative_formats_request.py +22 -22
- adcp/types/generated_poc/list_creative_formats_response.py +11 -11
- adcp/types/generated_poc/list_creatives_request.py +51 -51
- adcp/types/generated_poc/list_creatives_response.py +61 -61
- adcp/types/generated_poc/markdown_asset.py +7 -7
- adcp/types/generated_poc/measurement.py +9 -9
- adcp/types/generated_poc/media_buy.py +8 -8
- adcp/types/generated_poc/media_buy_status.py +5 -5
- adcp/types/generated_poc/pacing.py +4 -4
- adcp/types/generated_poc/package.py +8 -8
- adcp/types/generated_poc/package_request.py +7 -7
- adcp/types/generated_poc/package_status.py +5 -5
- adcp/types/generated_poc/performance_feedback.py +31 -31
- adcp/types/generated_poc/placement.py +4 -4
- adcp/types/generated_poc/preview_creative_request.py +28 -28
- adcp/types/generated_poc/preview_creative_response.py +31 -31
- adcp/types/generated_poc/preview_render.py +36 -28
- adcp/types/generated_poc/pricing_model.py +8 -8
- adcp/types/generated_poc/product.py +32 -31
- adcp/types/generated_poc/promoted_offerings.py +29 -29
- adcp/types/generated_poc/promoted_products.py +3 -3
- adcp/types/generated_poc/property.py +18 -18
- adcp/types/generated_poc/protocol_envelope.py +9 -9
- adcp/types/generated_poc/provide_performance_feedback_request.py +24 -24
- adcp/types/generated_poc/provide_performance_feedback_response.py +9 -9
- adcp/types/generated_poc/publisher_identifier_types.py +6 -6
- adcp/types/generated_poc/push_notification_config.py +9 -9
- adcp/types/generated_poc/reporting_capabilities.py +21 -21
- adcp/types/generated_poc/response.py +5 -5
- adcp/types/generated_poc/standard_format_ids.py +36 -36
- adcp/types/generated_poc/sub_asset.py +13 -13
- adcp/types/generated_poc/sync_creatives_request.py +11 -11
- adcp/types/generated_poc/sync_creatives_response.py +23 -23
- adcp/types/generated_poc/targeting.py +9 -9
- adcp/types/generated_poc/task_status.py +10 -10
- adcp/types/generated_poc/task_type.py +6 -6
- adcp/types/generated_poc/tasks_get_request.py +5 -5
- adcp/types/generated_poc/tasks_get_response.py +35 -35
- adcp/types/generated_poc/tasks_list_request.py +36 -36
- adcp/types/generated_poc/tasks_list_response.py +35 -35
- adcp/types/generated_poc/text_asset.py +3 -3
- adcp/types/generated_poc/update_media_buy_request.py +27 -27
- adcp/types/generated_poc/update_media_buy_response.py +11 -11
- adcp/types/generated_poc/url_asset.py +7 -7
- adcp/types/generated_poc/vast_asset.py +38 -38
- adcp/types/generated_poc/vcpm_auction_option.py +17 -13
- adcp/types/generated_poc/vcpm_fixed_option.py +12 -8
- adcp/types/generated_poc/video_asset.py +8 -8
- adcp/types/generated_poc/webhook_asset.py +19 -19
- adcp/types/generated_poc/webhook_payload.py +18 -18
- {adcp-2.3.0.dist-info → adcp-2.4.0.dist-info}/METADATA +1 -1
- adcp-2.4.0.dist-info/RECORD +132 -0
- adcp-2.3.0.dist-info/RECORD +0 -132
- {adcp-2.3.0.dist-info → adcp-2.4.0.dist-info}/WHEEL +0 -0
- {adcp-2.3.0.dist-info → adcp-2.4.0.dist-info}/entry_points.txt +0 -0
- {adcp-2.3.0.dist-info → adcp-2.4.0.dist-info}/licenses/LICENSE +0 -0
- {adcp-2.3.0.dist-info → adcp-2.4.0.dist-info}/top_level.txt +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# generated by datamodel-codegen:
|
|
2
2
|
# filename: get-media-buy-delivery-response.json
|
|
3
|
-
# timestamp: 2025-11-
|
|
3
|
+
# timestamp: 2025-11-18T03:04:10+00:00
|
|
4
4
|
|
|
5
5
|
from __future__ import annotations
|
|
6
6
|
|
|
@@ -17,41 +17,41 @@ from .delivery_metrics import DeliveryMetrics
|
|
|
17
17
|
|
|
18
18
|
class AggregatedTotals(AdCPBaseModel):
|
|
19
19
|
model_config = ConfigDict(
|
|
20
|
-
extra=
|
|
20
|
+
extra='forbid',
|
|
21
21
|
)
|
|
22
22
|
clicks: Annotated[
|
|
23
23
|
float | None,
|
|
24
|
-
Field(description=
|
|
24
|
+
Field(description='Total clicks across all media buys (if applicable)', ge=0.0),
|
|
25
25
|
] = None
|
|
26
26
|
impressions: Annotated[
|
|
27
|
-
float, Field(description=
|
|
27
|
+
float, Field(description='Total impressions delivered across all media buys', ge=0.0)
|
|
28
28
|
]
|
|
29
29
|
media_buy_count: Annotated[
|
|
30
|
-
int, Field(description=
|
|
30
|
+
int, Field(description='Number of media buys included in the response', ge=0)
|
|
31
31
|
]
|
|
32
|
-
spend: Annotated[float, Field(description=
|
|
32
|
+
spend: Annotated[float, Field(description='Total amount spent across all media buys', ge=0.0)]
|
|
33
33
|
video_completions: Annotated[
|
|
34
34
|
float | None,
|
|
35
|
-
Field(description=
|
|
35
|
+
Field(description='Total video completions across all media buys (if applicable)', ge=0.0),
|
|
36
36
|
] = None
|
|
37
37
|
|
|
38
38
|
|
|
39
39
|
class DailyBreakdownItem(AdCPBaseModel):
|
|
40
40
|
model_config = ConfigDict(
|
|
41
|
-
extra=
|
|
41
|
+
extra='forbid',
|
|
42
42
|
)
|
|
43
|
-
date: Annotated[str, Field(description=
|
|
44
|
-
impressions: Annotated[float, Field(description=
|
|
45
|
-
spend: Annotated[float, Field(description=
|
|
43
|
+
date: Annotated[str, Field(description='Date (YYYY-MM-DD)', pattern='^\\d{4}-\\d{2}-\\d{2}$')]
|
|
44
|
+
impressions: Annotated[float, Field(description='Daily impressions', ge=0.0)]
|
|
45
|
+
spend: Annotated[float, Field(description='Daily spend', ge=0.0)]
|
|
46
46
|
|
|
47
47
|
|
|
48
48
|
class Status(Enum):
|
|
49
|
-
pending =
|
|
50
|
-
active =
|
|
51
|
-
paused =
|
|
52
|
-
completed =
|
|
53
|
-
failed =
|
|
54
|
-
reporting_delayed =
|
|
49
|
+
pending = 'pending'
|
|
50
|
+
active = 'active'
|
|
51
|
+
paused = 'paused'
|
|
52
|
+
completed = 'completed'
|
|
53
|
+
failed = 'failed'
|
|
54
|
+
reporting_delayed = 'reporting_delayed'
|
|
55
55
|
|
|
56
56
|
|
|
57
57
|
class Totals(DeliveryMetrics):
|
|
@@ -65,23 +65,23 @@ class Totals(DeliveryMetrics):
|
|
|
65
65
|
|
|
66
66
|
|
|
67
67
|
class NotificationType(Enum):
|
|
68
|
-
scheduled =
|
|
69
|
-
final =
|
|
70
|
-
delayed =
|
|
71
|
-
adjusted =
|
|
68
|
+
scheduled = 'scheduled'
|
|
69
|
+
final = 'final'
|
|
70
|
+
delayed = 'delayed'
|
|
71
|
+
adjusted = 'adjusted'
|
|
72
72
|
|
|
73
73
|
|
|
74
74
|
class ReportingPeriod(AdCPBaseModel):
|
|
75
75
|
model_config = ConfigDict(
|
|
76
|
-
extra=
|
|
76
|
+
extra='forbid',
|
|
77
77
|
)
|
|
78
78
|
end: Annotated[
|
|
79
79
|
AwareDatetime,
|
|
80
|
-
Field(description=
|
|
80
|
+
Field(description='ISO 8601 end timestamp in UTC (e.g., 2024-02-05T23:59:59Z)'),
|
|
81
81
|
]
|
|
82
82
|
start: Annotated[
|
|
83
83
|
AwareDatetime,
|
|
84
|
-
Field(description=
|
|
84
|
+
Field(description='ISO 8601 start timestamp in UTC (e.g., 2024-02-05T00:00:00Z)'),
|
|
85
85
|
]
|
|
86
86
|
|
|
87
87
|
|
|
@@ -93,24 +93,24 @@ class ByPackageItem(DeliveryMetrics):
|
|
|
93
93
|
str,
|
|
94
94
|
Field(
|
|
95
95
|
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.",
|
|
96
|
-
pattern=
|
|
96
|
+
pattern='^[A-Z]{3}$',
|
|
97
97
|
),
|
|
98
98
|
]
|
|
99
99
|
pacing_index: Annotated[
|
|
100
100
|
float | None,
|
|
101
|
-
Field(description=
|
|
101
|
+
Field(description='Delivery pace (1.0 = on track, <1.0 = behind, >1.0 = ahead)', ge=0.0),
|
|
102
102
|
] = None
|
|
103
103
|
package_id: Annotated[str, Field(description="Publisher's package identifier")]
|
|
104
104
|
pricing_model: Annotated[
|
|
105
105
|
pricing_model_1.PricingModel,
|
|
106
106
|
Field(
|
|
107
|
-
description=
|
|
107
|
+
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.'
|
|
108
108
|
),
|
|
109
109
|
]
|
|
110
110
|
rate: Annotated[
|
|
111
111
|
float,
|
|
112
112
|
Field(
|
|
113
|
-
description=
|
|
113
|
+
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.',
|
|
114
114
|
ge=0.0,
|
|
115
115
|
),
|
|
116
116
|
]
|
|
@@ -118,36 +118,36 @@ class ByPackageItem(DeliveryMetrics):
|
|
|
118
118
|
|
|
119
119
|
class MediaBuyDelivery(AdCPBaseModel):
|
|
120
120
|
model_config = ConfigDict(
|
|
121
|
-
extra=
|
|
121
|
+
extra='forbid',
|
|
122
122
|
)
|
|
123
123
|
buyer_ref: Annotated[
|
|
124
124
|
str | None, Field(description="Buyer's reference identifier for this media buy")
|
|
125
125
|
] = None
|
|
126
|
-
by_package: Annotated[list[ByPackageItem], Field(description=
|
|
126
|
+
by_package: Annotated[list[ByPackageItem], Field(description='Metrics broken down by package')]
|
|
127
127
|
daily_breakdown: Annotated[
|
|
128
|
-
list[DailyBreakdownItem] | None, Field(description=
|
|
128
|
+
list[DailyBreakdownItem] | None, Field(description='Day-by-day delivery')
|
|
129
129
|
] = None
|
|
130
130
|
expected_availability: Annotated[
|
|
131
131
|
AwareDatetime | None,
|
|
132
132
|
Field(
|
|
133
|
-
description=
|
|
133
|
+
description='When delayed data is expected to be available (only present when status is reporting_delayed)'
|
|
134
134
|
),
|
|
135
135
|
] = None
|
|
136
136
|
is_adjusted: Annotated[
|
|
137
137
|
bool | None,
|
|
138
138
|
Field(
|
|
139
|
-
description=
|
|
139
|
+
description='Indicates this delivery contains updated data for a previously reported period. Buyer should replace previous period data with these totals.'
|
|
140
140
|
),
|
|
141
141
|
] = None
|
|
142
142
|
media_buy_id: Annotated[str, Field(description="Publisher's media buy identifier")]
|
|
143
143
|
pricing_model: Annotated[
|
|
144
144
|
pricing_model_1.PricingModel | None,
|
|
145
|
-
Field(description=
|
|
145
|
+
Field(description='Pricing model used for this media buy'),
|
|
146
146
|
] = None
|
|
147
147
|
status: Annotated[
|
|
148
148
|
Status,
|
|
149
149
|
Field(
|
|
150
|
-
description=
|
|
150
|
+
description='Current media buy status. In webhook context, reporting_delayed indicates data temporarily unavailable.'
|
|
151
151
|
),
|
|
152
152
|
]
|
|
153
153
|
totals: Totals
|
|
@@ -155,31 +155,31 @@ class MediaBuyDelivery(AdCPBaseModel):
|
|
|
155
155
|
|
|
156
156
|
class GetMediaBuyDeliveryResponse(AdCPBaseModel):
|
|
157
157
|
model_config = ConfigDict(
|
|
158
|
-
extra=
|
|
158
|
+
extra='forbid',
|
|
159
159
|
)
|
|
160
160
|
aggregated_totals: Annotated[
|
|
161
161
|
AggregatedTotals | None,
|
|
162
162
|
Field(
|
|
163
|
-
description=
|
|
163
|
+
description='Combined metrics across all returned media buys. Only included in API responses (get_media_buy_delivery), not in webhook notifications.'
|
|
164
164
|
),
|
|
165
165
|
] = None
|
|
166
166
|
context: Annotated[
|
|
167
167
|
dict[str, Any] | None,
|
|
168
168
|
Field(
|
|
169
|
-
description=
|
|
169
|
+
description='Initiator-provided context echoed inside the task payload. Opaque metadata such as UI/session hints, correlation tokens, or tracking identifiers.'
|
|
170
170
|
),
|
|
171
171
|
] = None
|
|
172
|
-
currency: Annotated[str, Field(description=
|
|
172
|
+
currency: Annotated[str, Field(description='ISO 4217 currency code', pattern='^[A-Z]{3}$')]
|
|
173
173
|
errors: Annotated[
|
|
174
174
|
list[error.Error] | None,
|
|
175
175
|
Field(
|
|
176
|
-
description=
|
|
176
|
+
description='Task-specific errors and warnings (e.g., missing delivery data, reporting platform issues)'
|
|
177
177
|
),
|
|
178
178
|
] = None
|
|
179
179
|
media_buy_deliveries: Annotated[
|
|
180
180
|
list[MediaBuyDelivery],
|
|
181
181
|
Field(
|
|
182
|
-
description=
|
|
182
|
+
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.'
|
|
183
183
|
),
|
|
184
184
|
]
|
|
185
185
|
next_expected_at: Annotated[
|
|
@@ -191,30 +191,30 @@ class GetMediaBuyDeliveryResponse(AdCPBaseModel):
|
|
|
191
191
|
notification_type: Annotated[
|
|
192
192
|
NotificationType | None,
|
|
193
193
|
Field(
|
|
194
|
-
description=
|
|
194
|
+
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'
|
|
195
195
|
),
|
|
196
196
|
] = None
|
|
197
197
|
partial_data: Annotated[
|
|
198
198
|
bool | None,
|
|
199
199
|
Field(
|
|
200
|
-
description=
|
|
200
|
+
description='Indicates if any media buys in this webhook have missing/delayed data (only present in webhook deliveries)'
|
|
201
201
|
),
|
|
202
202
|
] = None
|
|
203
203
|
reporting_period: Annotated[
|
|
204
204
|
ReportingPeriod,
|
|
205
|
-
Field(description=
|
|
205
|
+
Field(description='Date range for the report. All periods use UTC timezone.'),
|
|
206
206
|
]
|
|
207
207
|
sequence_number: Annotated[
|
|
208
208
|
int | None,
|
|
209
209
|
Field(
|
|
210
|
-
description=
|
|
210
|
+
description='Sequential notification number (only present in webhook deliveries, starts at 1)',
|
|
211
211
|
ge=1,
|
|
212
212
|
),
|
|
213
213
|
] = None
|
|
214
214
|
unavailable_count: Annotated[
|
|
215
215
|
int | None,
|
|
216
216
|
Field(
|
|
217
|
-
description=
|
|
217
|
+
description='Number of media buys with reporting_delayed or failed status (only present in webhook deliveries when partial_data is true)',
|
|
218
218
|
ge=0,
|
|
219
219
|
),
|
|
220
220
|
] = None
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# generated by datamodel-codegen:
|
|
2
2
|
# filename: get-products-request.json
|
|
3
|
-
# timestamp: 2025-11-
|
|
3
|
+
# timestamp: 2025-11-18T03:04:10+00:00
|
|
4
4
|
|
|
5
5
|
from __future__ import annotations
|
|
6
6
|
|
|
@@ -16,68 +16,68 @@ from . import format_id
|
|
|
16
16
|
|
|
17
17
|
|
|
18
18
|
class FormatType(Enum):
|
|
19
|
-
video =
|
|
20
|
-
display =
|
|
21
|
-
audio =
|
|
19
|
+
video = 'video'
|
|
20
|
+
display = 'display'
|
|
21
|
+
audio = 'audio'
|
|
22
22
|
|
|
23
23
|
|
|
24
24
|
class Filters(AdCPBaseModel):
|
|
25
25
|
model_config = ConfigDict(
|
|
26
|
-
extra=
|
|
26
|
+
extra='forbid',
|
|
27
27
|
)
|
|
28
28
|
delivery_type: delivery_type_1.DeliveryType | None = None
|
|
29
29
|
format_ids: Annotated[
|
|
30
|
-
list[format_id.FormatId] | None, Field(description=
|
|
30
|
+
list[format_id.FormatId] | None, Field(description='Filter by specific format IDs')
|
|
31
31
|
] = None
|
|
32
32
|
format_types: Annotated[
|
|
33
|
-
list[FormatType] | None, Field(description=
|
|
33
|
+
list[FormatType] | None, Field(description='Filter by format types')
|
|
34
34
|
] = None
|
|
35
35
|
is_fixed_price: Annotated[
|
|
36
|
-
bool | None, Field(description=
|
|
36
|
+
bool | None, Field(description='Filter for fixed price vs auction products')
|
|
37
37
|
] = None
|
|
38
38
|
min_exposures: Annotated[
|
|
39
39
|
int | None,
|
|
40
|
-
Field(description=
|
|
40
|
+
Field(description='Minimum exposures/impressions needed for measurement validity', ge=1),
|
|
41
41
|
] = None
|
|
42
42
|
standard_formats_only: Annotated[
|
|
43
|
-
bool | None, Field(description=
|
|
43
|
+
bool | None, Field(description='Only return products accepting IAB standard formats')
|
|
44
44
|
] = None
|
|
45
45
|
|
|
46
46
|
|
|
47
47
|
class GetProductsRequest(AdCPBaseModel):
|
|
48
48
|
model_config = ConfigDict(
|
|
49
|
-
extra=
|
|
49
|
+
extra='forbid',
|
|
50
50
|
)
|
|
51
51
|
brand_manifest: Annotated[
|
|
52
52
|
brand_manifest_1.BrandManifest | AnyUrl | None,
|
|
53
53
|
Field(
|
|
54
|
-
description=
|
|
54
|
+
description='Brand information manifest providing brand context, assets, and product catalog. Can be provided inline or as a URL reference to a hosted manifest.',
|
|
55
55
|
examples=[
|
|
56
56
|
{
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
57
|
+
'data': {
|
|
58
|
+
'colors': {'primary': '#FF6B35'},
|
|
59
|
+
'name': 'ACME Corporation',
|
|
60
|
+
'url': 'https://acmecorp.com',
|
|
61
61
|
},
|
|
62
|
-
|
|
62
|
+
'description': 'Inline brand manifest',
|
|
63
63
|
},
|
|
64
64
|
{
|
|
65
|
-
|
|
66
|
-
|
|
65
|
+
'data': 'https://cdn.acmecorp.com/brand-manifest.json',
|
|
66
|
+
'description': 'URL string reference to hosted manifest',
|
|
67
67
|
},
|
|
68
68
|
],
|
|
69
|
-
title=
|
|
69
|
+
title='Brand Manifest Reference',
|
|
70
70
|
),
|
|
71
71
|
] = None
|
|
72
72
|
brief: Annotated[
|
|
73
|
-
str | None, Field(description=
|
|
73
|
+
str | None, Field(description='Natural language description of campaign requirements')
|
|
74
74
|
] = None
|
|
75
75
|
context: Annotated[
|
|
76
76
|
dict[str, Any] | None,
|
|
77
77
|
Field(
|
|
78
|
-
description=
|
|
78
|
+
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.'
|
|
79
79
|
),
|
|
80
80
|
] = None
|
|
81
81
|
filters: Annotated[
|
|
82
|
-
Filters | None, Field(description=
|
|
82
|
+
Filters | None, Field(description='Structured filters for product discovery')
|
|
83
83
|
] = None
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# generated by datamodel-codegen:
|
|
2
2
|
# filename: get-products-response.json
|
|
3
|
-
# timestamp: 2025-11-
|
|
3
|
+
# timestamp: 2025-11-18T03:04:10+00:00
|
|
4
4
|
|
|
5
5
|
from __future__ import annotations
|
|
6
6
|
|
|
@@ -14,16 +14,16 @@ from . import error, product
|
|
|
14
14
|
|
|
15
15
|
class GetProductsResponse(AdCPBaseModel):
|
|
16
16
|
model_config = ConfigDict(
|
|
17
|
-
extra=
|
|
17
|
+
extra='forbid',
|
|
18
18
|
)
|
|
19
19
|
context: Annotated[
|
|
20
20
|
dict[str, Any] | None,
|
|
21
21
|
Field(
|
|
22
|
-
description=
|
|
22
|
+
description='Initiator-provided context echoed inside the task payload. Opaque metadata such as UI/session hints, correlation tokens, or tracking identifiers.'
|
|
23
23
|
),
|
|
24
24
|
] = None
|
|
25
25
|
errors: Annotated[
|
|
26
26
|
list[error.Error] | None,
|
|
27
|
-
Field(description=
|
|
27
|
+
Field(description='Task-specific errors and warnings (e.g., product filtering issues)'),
|
|
28
28
|
] = None
|
|
29
|
-
products: Annotated[list[product.Product], Field(description=
|
|
29
|
+
products: Annotated[list[product.Product], Field(description='Array of matching products')]
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# generated by datamodel-codegen:
|
|
2
2
|
# filename: get-signals-request.json
|
|
3
|
-
# timestamp: 2025-11-
|
|
3
|
+
# timestamp: 2025-11-18T03:04:10+00:00
|
|
4
4
|
|
|
5
5
|
from __future__ import annotations
|
|
6
6
|
|
|
@@ -14,64 +14,64 @@ from . import destination
|
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
class Country(RootModel[str]):
|
|
17
|
-
root: Annotated[str, Field(pattern=
|
|
17
|
+
root: Annotated[str, Field(pattern='^[A-Z]{2}$')]
|
|
18
18
|
|
|
19
19
|
|
|
20
20
|
class DeliverTo(AdCPBaseModel):
|
|
21
21
|
model_config = ConfigDict(
|
|
22
|
-
extra=
|
|
22
|
+
extra='forbid',
|
|
23
23
|
)
|
|
24
24
|
countries: Annotated[
|
|
25
|
-
list[Country], Field(description=
|
|
25
|
+
list[Country], Field(description='Countries where signals will be used (ISO codes)')
|
|
26
26
|
]
|
|
27
27
|
destinations: Annotated[
|
|
28
28
|
list[destination.Destination1 | destination.Destination2],
|
|
29
29
|
Field(
|
|
30
|
-
description=
|
|
30
|
+
description='List of destination platforms (DSPs, sales agents, etc.). If the authenticated caller matches one of these destinations, activation keys will be included in the response.',
|
|
31
31
|
min_length=1,
|
|
32
32
|
),
|
|
33
33
|
]
|
|
34
34
|
|
|
35
35
|
|
|
36
36
|
class CatalogType(Enum):
|
|
37
|
-
marketplace =
|
|
38
|
-
custom =
|
|
39
|
-
owned =
|
|
37
|
+
marketplace = 'marketplace'
|
|
38
|
+
custom = 'custom'
|
|
39
|
+
owned = 'owned'
|
|
40
40
|
|
|
41
41
|
|
|
42
42
|
class Filters(AdCPBaseModel):
|
|
43
43
|
model_config = ConfigDict(
|
|
44
|
-
extra=
|
|
44
|
+
extra='forbid',
|
|
45
45
|
)
|
|
46
46
|
catalog_types: Annotated[
|
|
47
|
-
list[CatalogType] | None, Field(description=
|
|
47
|
+
list[CatalogType] | None, Field(description='Filter by catalog type')
|
|
48
48
|
] = None
|
|
49
49
|
data_providers: Annotated[
|
|
50
|
-
list[str] | None, Field(description=
|
|
50
|
+
list[str] | None, Field(description='Filter by specific data providers')
|
|
51
51
|
] = None
|
|
52
|
-
max_cpm: Annotated[float | None, Field(description=
|
|
52
|
+
max_cpm: Annotated[float | None, Field(description='Maximum CPM price filter', ge=0.0)] = None
|
|
53
53
|
min_coverage_percentage: Annotated[
|
|
54
|
-
float | None, Field(description=
|
|
54
|
+
float | None, Field(description='Minimum coverage requirement', ge=0.0, le=100.0)
|
|
55
55
|
] = None
|
|
56
56
|
|
|
57
57
|
|
|
58
58
|
class GetSignalsRequest(AdCPBaseModel):
|
|
59
59
|
model_config = ConfigDict(
|
|
60
|
-
extra=
|
|
60
|
+
extra='forbid',
|
|
61
61
|
)
|
|
62
62
|
context: Annotated[
|
|
63
63
|
dict[str, Any] | None,
|
|
64
64
|
Field(
|
|
65
|
-
description=
|
|
65
|
+
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.'
|
|
66
66
|
),
|
|
67
67
|
] = None
|
|
68
68
|
deliver_to: Annotated[
|
|
69
|
-
DeliverTo, Field(description=
|
|
69
|
+
DeliverTo, Field(description='Destination platforms where signals need to be activated')
|
|
70
70
|
]
|
|
71
|
-
filters: Annotated[Filters | None, Field(description=
|
|
71
|
+
filters: Annotated[Filters | None, Field(description='Filters to refine results')] = None
|
|
72
72
|
max_results: Annotated[
|
|
73
|
-
int | None, Field(description=
|
|
73
|
+
int | None, Field(description='Maximum number of results to return', ge=1)
|
|
74
74
|
] = None
|
|
75
75
|
signal_spec: Annotated[
|
|
76
|
-
str, Field(description=
|
|
76
|
+
str, Field(description='Natural language description of the desired signals')
|
|
77
77
|
]
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# generated by datamodel-codegen:
|
|
2
2
|
# filename: get-signals-response.json
|
|
3
|
-
# timestamp: 2025-11-
|
|
3
|
+
# timestamp: 2025-11-18T03:04:10+00:00
|
|
4
4
|
|
|
5
5
|
from __future__ import annotations
|
|
6
6
|
|
|
@@ -15,51 +15,51 @@ from . import deployment, error
|
|
|
15
15
|
|
|
16
16
|
class Pricing(AdCPBaseModel):
|
|
17
17
|
model_config = ConfigDict(
|
|
18
|
-
extra=
|
|
18
|
+
extra='forbid',
|
|
19
19
|
)
|
|
20
|
-
cpm: Annotated[float, Field(description=
|
|
21
|
-
currency: Annotated[str, Field(description=
|
|
20
|
+
cpm: Annotated[float, Field(description='Cost per thousand impressions', ge=0.0)]
|
|
21
|
+
currency: Annotated[str, Field(description='Currency code', pattern='^[A-Z]{3}$')]
|
|
22
22
|
|
|
23
23
|
|
|
24
24
|
class SignalType(Enum):
|
|
25
|
-
marketplace =
|
|
26
|
-
custom =
|
|
27
|
-
owned =
|
|
25
|
+
marketplace = 'marketplace'
|
|
26
|
+
custom = 'custom'
|
|
27
|
+
owned = 'owned'
|
|
28
28
|
|
|
29
29
|
|
|
30
30
|
class Signal(AdCPBaseModel):
|
|
31
31
|
model_config = ConfigDict(
|
|
32
|
-
extra=
|
|
32
|
+
extra='forbid',
|
|
33
33
|
)
|
|
34
34
|
coverage_percentage: Annotated[
|
|
35
|
-
float, Field(description=
|
|
35
|
+
float, Field(description='Percentage of audience coverage', ge=0.0, le=100.0)
|
|
36
36
|
]
|
|
37
|
-
data_provider: Annotated[str, Field(description=
|
|
37
|
+
data_provider: Annotated[str, Field(description='Name of the data provider')]
|
|
38
38
|
deployments: Annotated[
|
|
39
39
|
list[deployment.Deployment1 | deployment.Deployment2],
|
|
40
|
-
Field(description=
|
|
40
|
+
Field(description='Array of destination deployments'),
|
|
41
41
|
]
|
|
42
|
-
description: Annotated[str, Field(description=
|
|
43
|
-
name: Annotated[str, Field(description=
|
|
44
|
-
pricing: Annotated[Pricing, Field(description=
|
|
45
|
-
signal_agent_segment_id: Annotated[str, Field(description=
|
|
46
|
-
signal_type: Annotated[SignalType, Field(description=
|
|
42
|
+
description: Annotated[str, Field(description='Detailed signal description')]
|
|
43
|
+
name: Annotated[str, Field(description='Human-readable signal name')]
|
|
44
|
+
pricing: Annotated[Pricing, Field(description='Pricing information')]
|
|
45
|
+
signal_agent_segment_id: Annotated[str, Field(description='Unique identifier for the signal')]
|
|
46
|
+
signal_type: Annotated[SignalType, Field(description='Type of signal')]
|
|
47
47
|
|
|
48
48
|
|
|
49
49
|
class GetSignalsResponse(AdCPBaseModel):
|
|
50
50
|
model_config = ConfigDict(
|
|
51
|
-
extra=
|
|
51
|
+
extra='forbid',
|
|
52
52
|
)
|
|
53
53
|
context: Annotated[
|
|
54
54
|
dict[str, Any] | None,
|
|
55
55
|
Field(
|
|
56
|
-
description=
|
|
56
|
+
description='Initiator-provided context echoed inside the task payload. Opaque metadata such as UI/session hints, correlation tokens, or tracking identifiers.'
|
|
57
57
|
),
|
|
58
58
|
] = None
|
|
59
59
|
errors: Annotated[
|
|
60
60
|
list[error.Error] | None,
|
|
61
61
|
Field(
|
|
62
|
-
description=
|
|
62
|
+
description='Task-specific errors and warnings (e.g., signal discovery or pricing issues)'
|
|
63
63
|
),
|
|
64
64
|
] = None
|
|
65
|
-
signals: Annotated[list[Signal], Field(description=
|
|
65
|
+
signals: Annotated[list[Signal], Field(description='Array of matching signals')]
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# generated by datamodel-codegen:
|
|
2
2
|
# filename: html-asset.json
|
|
3
|
-
# timestamp: 2025-11-
|
|
3
|
+
# timestamp: 2025-11-18T03:04:10+00:00
|
|
4
4
|
|
|
5
5
|
from __future__ import annotations
|
|
6
6
|
|
|
@@ -12,7 +12,7 @@ from pydantic import ConfigDict, Field
|
|
|
12
12
|
|
|
13
13
|
class HtmlAsset(AdCPBaseModel):
|
|
14
14
|
model_config = ConfigDict(
|
|
15
|
-
extra=
|
|
15
|
+
extra='forbid',
|
|
16
16
|
)
|
|
17
|
-
content: Annotated[str, Field(description=
|
|
17
|
+
content: Annotated[str, Field(description='HTML content')]
|
|
18
18
|
version: Annotated[str | None, Field(description="HTML version (e.g., 'HTML5')")] = None
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# generated by datamodel-codegen:
|
|
2
2
|
# filename: identifier-types.json
|
|
3
|
-
# timestamp: 2025-11-
|
|
3
|
+
# timestamp: 2025-11-18T03:04:10+00:00
|
|
4
4
|
|
|
5
5
|
from __future__ import annotations
|
|
6
6
|
|
|
@@ -8,22 +8,22 @@ from enum import Enum
|
|
|
8
8
|
|
|
9
9
|
|
|
10
10
|
class PropertyIdentifierTypes(Enum):
|
|
11
|
-
domain =
|
|
12
|
-
subdomain =
|
|
13
|
-
network_id =
|
|
14
|
-
ios_bundle =
|
|
15
|
-
android_package =
|
|
16
|
-
apple_app_store_id =
|
|
17
|
-
google_play_id =
|
|
18
|
-
roku_store_id =
|
|
19
|
-
fire_tv_asin =
|
|
20
|
-
samsung_app_id =
|
|
21
|
-
apple_tv_bundle =
|
|
22
|
-
bundle_id =
|
|
23
|
-
venue_id =
|
|
24
|
-
screen_id =
|
|
25
|
-
openooh_venue_type =
|
|
26
|
-
rss_url =
|
|
27
|
-
apple_podcast_id =
|
|
28
|
-
spotify_show_id =
|
|
29
|
-
podcast_guid =
|
|
11
|
+
domain = 'domain'
|
|
12
|
+
subdomain = 'subdomain'
|
|
13
|
+
network_id = 'network_id'
|
|
14
|
+
ios_bundle = 'ios_bundle'
|
|
15
|
+
android_package = 'android_package'
|
|
16
|
+
apple_app_store_id = 'apple_app_store_id'
|
|
17
|
+
google_play_id = 'google_play_id'
|
|
18
|
+
roku_store_id = 'roku_store_id'
|
|
19
|
+
fire_tv_asin = 'fire_tv_asin'
|
|
20
|
+
samsung_app_id = 'samsung_app_id'
|
|
21
|
+
apple_tv_bundle = 'apple_tv_bundle'
|
|
22
|
+
bundle_id = 'bundle_id'
|
|
23
|
+
venue_id = 'venue_id'
|
|
24
|
+
screen_id = 'screen_id'
|
|
25
|
+
openooh_venue_type = 'openooh_venue_type'
|
|
26
|
+
rss_url = 'rss_url'
|
|
27
|
+
apple_podcast_id = 'apple_podcast_id'
|
|
28
|
+
spotify_show_id = 'spotify_show_id'
|
|
29
|
+
podcast_guid = 'podcast_guid'
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# generated by datamodel-codegen:
|
|
2
2
|
# filename: image-asset.json
|
|
3
|
-
# timestamp: 2025-11-
|
|
3
|
+
# timestamp: 2025-11-18T03:04:10+00:00
|
|
4
4
|
|
|
5
5
|
from __future__ import annotations
|
|
6
6
|
|
|
@@ -12,12 +12,12 @@ from pydantic import AnyUrl, ConfigDict, Field
|
|
|
12
12
|
|
|
13
13
|
class ImageAsset(AdCPBaseModel):
|
|
14
14
|
model_config = ConfigDict(
|
|
15
|
-
extra=
|
|
15
|
+
extra='forbid',
|
|
16
16
|
)
|
|
17
|
-
alt_text: Annotated[str | None, Field(description=
|
|
17
|
+
alt_text: Annotated[str | None, Field(description='Alternative text for accessibility')] = None
|
|
18
18
|
format: Annotated[
|
|
19
|
-
str | None, Field(description=
|
|
19
|
+
str | None, Field(description='Image file format (jpg, png, gif, webp, etc.)')
|
|
20
20
|
] = None
|
|
21
|
-
height: Annotated[int | None, Field(description=
|
|
22
|
-
url: Annotated[AnyUrl, Field(description=
|
|
23
|
-
width: Annotated[int | None, Field(description=
|
|
21
|
+
height: Annotated[int | None, Field(description='Image height in pixels', ge=1)] = None
|
|
22
|
+
url: Annotated[AnyUrl, Field(description='URL to the image asset')]
|
|
23
|
+
width: Annotated[int | None, Field(description='Image width in pixels', ge=1)] = None
|