feat: add Deals protocol documentation and schemas#1547
feat: add Deals protocol documentation and schemas#1547pm-pramod-baddurkar wants to merge 1 commit into
Conversation
IPR Policy Agreement RequiredThank you for your contribution! Before we can accept your pull request, you must agree to our Intellectual Property Rights Policy. By making a Contribution, you agree that:
To agree, please comment below with the exact phrase: You can read the full IPR Policy here. I have read the IPR Policy You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot. |
| |------|---------| | ||
| | **`create_deal`** | Create a logical deal (starts in PROPOSED or DRAFT) | | ||
| | **`list_deals`** | Browse/filter deals; use `deal_ids` for single-deal fetch | | ||
| | **`update_deal_terms`** | Negotiate or counter-offer (versioned terms) | |
There was a problem hiding this comment.
why not just update_deal?
| | **`create_deal`** | Create a logical deal (starts in PROPOSED or DRAFT) | | ||
| | **`list_deals`** | Browse/filter deals; use `deal_ids` for single-deal fetch | | ||
| | **`update_deal_terms`** | Negotiate or counter-offer (versioned terms) | | ||
| | **`transition_deal_state`** | Move deal through states (e.g. PROPOSED → ACCEPTED → SCHEDULED → LIVE → COMPLETED) | |
There was a problem hiding this comment.
why is a transition call necessary? any deal returned in get products would be proposed. calling create deal would be accepted (this could be a status) and then the seller would transition to completed or rejected asynchronously. I don't think scheduled vs live needs a state, nor completed, but open to that discussion (and whatever we do should be the same as create media buy). Generally the state and structure here should be identical to media buy
| - **Product discovery**: Use **`get_products`** (Media Buy) with `filters.transaction_type` set to `PMP`, `PG`, or `AP` to find products that can be turned into deals. Products may include `supported_transaction_types`, `transaction_terms_by_type`, and `deal_capabilities`. | ||
| - **Single product**: Call `get_products` with filters that target one product (e.g. by product_id in filters or selection) to get full product detail for deal creation. | ||
|
|
||
| ## Deal Lifecycle |
There was a problem hiding this comment.
curious how we think a deal, as described here, is different than a media buy
|
Hi @pm-pramod-baddurkar — this PR has been quiet since March 19, and the protocol has moved substantially since then (3.0 GA is imminent — see #2302). A Deals protocol is interesting but it hasn't come up as a community priority yet, and the existing Two paths forward:
If we don't hear back by 2026-05-15 we'll close as inactive. Thanks for the contribution either way. |
|
@bokelley , Deals working group is meeting tomorrow and we will discuss the use cases if we still want to pursue this or not. I will update this PR in any case by end of this week. |
This commit introduces comprehensive support for the Deals protocol, including: - New sections in `docs.json` for Deals and Task Reference pages. - Updates to `README.md` to include Deals protocol overview and key tasks. - Enhancements in schema files to define request/response structures for deal-related tasks such as creating, listing, and activating deals. - Modifications to existing schemas to incorporate deal transaction types and capabilities. These changes aim to provide a robust framework for managing deal lifecycles and diagnostics within the AdCP ecosystem.
pm-pramod-baddurkar
force-pushed
the
feature/pmp-deals-protocol
branch
from
1998d47 to
0bbb056
Compare
|
Hi @pm-pramod-baddurkar — thanks for this contribution. Closing as the deals direction has shifted since March: buy-terms negotiation now lives in #1962 (performance standards, measurement terms, cancellation, makegoods for guaranteed buys), and PMP-style flows are being absorbed into the broader media-buy lifecycle work rather than a standalone Deals protocol. If you'd like to bring forward specific schema ideas from this PR, the WG would welcome them as smaller, focused PRs against the current direction. The capabilities explorer in #3841 is also a good place to see how we're framing protocol surfaces today. |
2 participants
This commit introduces comprehensive support for the Deals protocol, including:
docs.jsonfor Deals and Task Reference pages.README.mdto include Deals protocol overview and key tasks.These changes aim to provide a robust framework for managing deal lifecycles and diagnostics within the AdCP ecosystem.