Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add details of visibility param for IG joins #61

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add details of visibility param for IG joins #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions API Details.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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': ...,
Expand All @@ -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).
Expand Down
7 changes: 4 additions & 3 deletions Life of an Ad Request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down