|
1 | | -# Media Kit Discovery |
| 1 | +# Media Kit API Reference |
2 | 2 |
|
3 | | -The media kit is a seller's **inventory catalog** — a curated collection of ad packages that buyer agents browse to discover available inventory. The buyer agent includes a dedicated `MediaKitClient` for consuming seller media kits. |
| 3 | +The media kit is a seller's **inventory catalog** --- a curated collection of ad packages that buyer agents browse to discover available inventory. The buyer agent includes a dedicated `MediaKitClient` for consuming seller media kits. This page documents the client's methods, parameters, data models, and error handling. |
| 4 | + |
| 5 | +!!! tip "Looking for usage patterns?" |
| 6 | + For practical guidance on browsing strategies, progressive identity revelation, cross-seller comparison, and connecting discovery to the buying workflow, see the [Media Kit Browsing Guide](../guides/media-kit.md). |
4 | 7 |
|
5 | 8 | ## Overview |
6 | 9 |
|
@@ -198,38 +201,6 @@ Sellers apply tier-based discounts. Higher identity revelation unlocks better pr |
198 | 201 | !!! tip "Progressive Identity Revelation" |
199 | 202 | Start with public browsing to evaluate inventory, then authenticate to see exact pricing. Provide agency/advertiser identity during search to unlock the best rates. |
200 | 203 |
|
201 | | -## Identity-Based Access |
202 | | - |
203 | | -Beyond the API key, the buyer can reveal its identity for seller-side tier resolution. The `SearchFilter` supports this: |
204 | | - |
205 | | -```python |
206 | | -# Search with full identity context |
207 | | -results = await client.search_packages( |
208 | | - seller_url, |
209 | | - query="premium video", |
210 | | - filters=SearchFilter( |
211 | | - buyer_tier="advertiser", |
212 | | - agency_id="omnicom-456", |
213 | | - advertiser_id="coca-cola", |
214 | | - ), |
215 | | -) |
216 | | -``` |
217 | | - |
218 | | -Alternatively, the `BuyerIdentity` model can generate identity headers for direct HTTP calls: |
219 | | - |
220 | | -```python |
221 | | -from ad_buyer.models.buyer_identity import BuyerIdentity |
222 | | - |
223 | | -identity = BuyerIdentity( |
224 | | - seat_id="ttd-seat-123", |
225 | | - agency_id="omnicom-456", |
226 | | - advertiser_id="coca-cola", |
227 | | -) |
228 | | - |
229 | | -# Produces: {"X-DSP-Seat-ID": "...", "X-Agency-ID": "...", "X-Advertiser-ID": "..."} |
230 | | -headers = identity.to_header_dict() |
231 | | -``` |
232 | | - |
233 | 204 | ## Data Models |
234 | 205 |
|
235 | 206 | ### PackageSummary (Public) |
@@ -322,31 +293,10 @@ Common error scenarios: |
322 | 293 | | HTTP 4xx/5xx | `MediaKitError` with status code | |
323 | 294 | | Failed seller in aggregation | Silently skipped, warning logged | |
324 | 295 |
|
325 | | -## Workflow: From Media Kit to Booking |
326 | | - |
327 | | -The media kit is the first step in the deal lifecycle: |
328 | | - |
329 | | -```mermaid |
330 | | -graph LR |
331 | | - A[Browse Media Kit] --> B[Select Package] |
332 | | - B --> C[Get Exact Pricing] |
333 | | - C --> D[Request Quote] |
334 | | - D --> E[Negotiate] |
335 | | - E --> F[Book Deal] |
336 | | -``` |
337 | | - |
338 | | -1. **Browse** the seller's media kit (public or authenticated) |
339 | | -2. **Select** a package that matches campaign requirements |
340 | | -3. **Get exact pricing** by authenticating with your API key |
341 | | -4. **Request a quote** via the [OpenDirect](https://iabtechlab.com/standards/opendirect/) API for specific products in the package |
342 | | -5. **Negotiate** if your tier allows it (Agency/Advertiser) |
343 | | -6. **Book** the deal through the standard booking flow |
344 | | - |
345 | | -See [Booking Lifecycle](bookings.md) and [Seller Agent Integration](../integration/seller-agent.md) for the full workflow. |
346 | | - |
347 | 296 | ## Related |
348 | 297 |
|
349 | | -- [Seller Agent Media Kit Setup](https://iabtechlab.github.io/seller-agent/guides/media-kit/) — How publishers configure their media kit |
350 | | -- [Authentication](authentication.md) — API key setup for authenticated access |
351 | | -- [Products](products.md) — Product search endpoint |
352 | | -- [Seller Agent Integration](../integration/seller-agent.md) — Full integration guide |
| 298 | +- [Media Kit Browsing Guide](../guides/media-kit.md) --- Practical patterns for browsing, cross-seller comparison, and connecting discovery to the buying workflow |
| 299 | +- [Seller Agent Media Kit Setup](https://iabtechlab.github.io/seller-agent/guides/media-kit/) --- How publishers configure their media kit |
| 300 | +- [Authentication](authentication.md) --- API key setup for authenticated access |
| 301 | +- [Products](products.md) --- Product search endpoint |
| 302 | +- [Seller Agent Integration](../integration/seller-agent.md) --- Full integration guide |
0 commit comments