From 74081202c2c0beaa789860311479d7a4b92a9d3a Mon Sep 17 00:00:00 2001 From: Brandon Maslen Date: Wed, 1 May 2024 15:55:26 -0700 Subject: [PATCH] Add details of visibility param for IG joins --- API Details.md | 7 +++++-- Life of an Ad Request.md | 7 ++++--- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/API Details.md b/API Details.md index c25f0da..78e0875 100644 --- a/API Details.md +++ b/API Details.md @@ -22,17 +22,18 @@ To enable the advertiser to choose the most relevant ad for a specific user and const myGroup = { 'owner': 'https://www.example-dsp.site', 'name': 'womens-running-shoes', + 'visibleOnlyToOwner': false, 'priority': 0.0, 'priorityVector': { 'signal1': 2, 'signal2': -3.5, ... - } + }, 'prioritySignalsOverrides': { 'signal1': 4.5, 'signal2': 0, ... - } + }, 'enableBiddingSignalsPrioritization' : true, 'biddingLogicURL': ..., 'biddingWasmHelperURL': ..., @@ -49,6 +50,8 @@ The API allows data that would traditionally be collected and stored server side Additionally, there is a complementary `navigator.leaveAdInterestGroup(myGroup)` API and embedded browser controls to manage this data. See additional information at [Protected Audiences - Browsers Record Interest Groups](https://github.com/WICG/turtledove/blob/main/FLEDGE.md#1-browsers-record-interest-groups). +The addition of a `visibleOnlyToOwner` boolean parameter, with a default value of *true*, can be used to control if a given InterestGroup has broader, but still private-to-the-auction, visibility during a private auction. + ### 2.0 Ad auction/selection #### 2.1 Starting a server auction In order to start selecting an ad via an ad auction, a request must be made in a similar manner as described in [Protected Audiences - Bidding & Auction API](https://github.com/WICG/turtledove/blob/main/FLEDGE_browser_bidding_and_auction_API.md). diff --git a/Life of an Ad Request.md b/Life of an Ad Request.md index f3f6366..080c20a 100644 --- a/Life of an Ad Request.md +++ b/Life of an Ad Request.md @@ -13,13 +13,14 @@ When a consumer navigates to any site, the tech on that site can register data f const myGroup = { 'owner': 'https://www.dsp.site', 'name': 'athletes', + 'visibleOnlyToOwner': false, 'updateUrl': '.../update-IG?id=athletes', 'biddingLogicUrl': '.../biddingLogic.js', 'userBiddingSignals': ["Federer", "Schiffrin", "Ewing"], - 'trustedBiddingSignalsUrl': '.../real-time-lookups', - 'trustedBiddingSignalsKeys': ['CampaignOne', 'CampaignTwo'] + 'trustedBiddingSignalsUrl': '.../real-time-lookups', + 'trustedBiddingSignalsKeys': ['CampaignOne', 'CampaignTwo'] } - const joinPromise = navigator.joinAdInterestGroup(myGroup, TTLInSeconds); +const joinPromise = navigator.joinAdInterestGroup(myGroup, TTLInSeconds); ``` (See [API details](API%20Details.md) for a formal specification of the IG structure and joinAdInterestGroup signature. Note "..." in URLs is meant to reduce text; the entire URL is required).