Skip to content

Commit 4b63741

Browse files
committed
demo docs fixes :
- fix issue #624 - fix issue #623 - fix issue #622 - fix issue #621
1 parent ff68148 commit 4b63741

File tree

4 files changed

+16
-15
lines changed

4 files changed

+16
-15
lines changed

services/home/docs/demos/bidding-and-auction.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,9 @@ components of the system work together to complete an auction.
8989

9090
#### User Journey
9191

92-
```bash
92+
```mermaid
9393
sequenceDiagram
94+
9495
Browser->>+Advertiser: User visits a shop site and clicks on a product
9596
DSP -->>DSP: DSP implements payload optimization
9697
DSP-->>Browser: DSP calls navigator.joinAdInterestGroup(...)
@@ -110,7 +111,7 @@ sequenceDiagram
110111
Publisher Page-->>Browser: Top level seller runs navigator.runAdAuction(auctionConfig) on-device
111112
```
112113

113-
#TODO: add valid permalink ![User Journey](../demos/img/bidding-and-auction-flow.png)
114+
[Full-sized diagram](./img/bidding-and-auction-flow.png)
114115

115116
</TabItem>
116117

@@ -632,7 +633,7 @@ sspYRouter.get('/construct-component-auction.js', async (req, res) => {
632633
```
633634
634635
7. The
635-
[construct-component-auction.ts](https://github.com/privacysandbox/privacy-sandbox-demos/blob/dev/services/ad-tech/src/public/js/ssp/usecase/bidding-and-auction/ssp-y/construct-component-auction.ts#L35)
636+
[construct-component-auction.ts](https://github.com/privacysandbox/privacy-sandbox-demos/blob/ff68148e0987979ecdac2f0183b9ca2a1b847bcc/services/ad-tech/src/public/js/ssp/usecase/bidding-and-auction/ssp-y/construct-component-auction.ts#L35)
636637
file will first build the auction config.
637638
638639
```typescript
@@ -755,10 +756,10 @@ async #runComponentAdAuction(request: number[]) {
755756
The selectAd request can also be sent with a REST API call. This
756757
[proto file](https://github.com/privacysandbox/privacy-sandbox-demos/blob/e9b604243b99c4629b78a578844d054770f9d660/services/ad-tech/src/routes/ssp/usecase/bidding-and-auction/server/proto/sfe-client.proto#L3)
757758
defines the interface for interacting with the seller frontend service. The `ciphertextShaHash` uses the response from the seller front end and
758-
generates a SHA-256 hash with base64 encoding. This is to ensure payload security between the seller ad service and the browser.
759-
The ciphertext is then set as the value for the `Ad-Auction-Result` header to be passed back to the browser. The `onDeviceAuctionConfig` field is
760-
set to define the auction configuration for the on-device component of mixed mode. This will be passed to the browser along with the bidding and
761-
auction result, but it will appear as a separate component auction in the browser.
759+
generates a SHA-256 hash with base64 encoding. This is to ensure payload security between the seller ad service and the browser. The ciphertext is
760+
then set as the value for the `Ad-Auction-Result` header to be passed back to the browser. The `onDeviceAuctionConfig` field is set to define the
761+
auction configuration for the on-device component of mixed mode. This will be passed to the browser along with the bidding and auction result, but
762+
it will appear as a separate component auction in the browser.
762763
763764
```typescript
764765
mixedModeClientSFE.selectAd(

services/home/docs/demos/instream-video-ad.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ const interestGroup = {
213213

214214
SSPs indicate the supported ad type in `auctionConfig.auctionSignals` which is made available to the DSP's `generateBid()` method at auction time.
215215
Using this information, DSPs can filter for the appropriate ad types in their
216-
[bidding logic :arrow_upper_right:](https://github.com/privacysandbox/privacy-sandbox-demos/blob/dev/services/ad-tech/src/public/js/dsp/default/auction-bidding-logic.js#L261-264);
216+
[bidding logic :arrow_upper_right:](https://github.com/privacysandbox/privacy-sandbox-demos/blob/ff68148e0987979ecdac2f0183b9ca2a1b847bcc/services/ad-tech/src/public/js/dsp/usecase/default/auction-bidding-logic.js#L261-264);
217217

218218
#### What does the interest group ad creative do?
219219

@@ -232,11 +232,11 @@ includes a single
232232
wrapping the VAST XML.
233233

234234
This script starts by
235-
[parsing :arrow_upper_right:](https://github.com/privacysandbox/privacy-sandbox-demos/blob/67d4c6368ff422ad9e952961352b5ac74ee9f500/services/ad-tech/src/public/js/video-ad-frame.js#L38-48)
235+
[parsing :arrow_upper_right:](https://github.com/privacysandbox/privacy-sandbox-demos/blob/ff68148e0987979ecdac2f0183b9ca2a1b847bcc/services/ad-tech/src/public/js/video-ads.js#L38)
236236
the SSP's VAST wrapping endpoint including in the URL. Then the scripts proceeds to
237-
[fetch the finalized VAST XML from this SSP endpoint :arrow_upper_right:](https://github.com/privacysandbox/privacy-sandbox-demos/blob/67d4c6368ff422ad9e952961352b5ac74ee9f500/services/ad-tech/src/public/js/video-ad-frame.js#L51-69)
237+
[fetch the finalized VAST XML from this SSP endpoint :arrow_upper_right:](https://github.com/privacysandbox/privacy-sandbox-demos/blob/ff68148e0987979ecdac2f0183b9ca2a1b847bcc/services/ad-tech/src/public/js/video-ads.js#L51)
238238
before
239-
[post-messaging the XML content to the top frame :arrow_upper_right:](https://github.com/privacysandbox/privacy-sandbox-demos/blob/dev/services/ad-tech/src/public/js/video-ad-frame.js#L107-115).
239+
[post-messaging the XML content to the top frame :arrow_upper_right:](https://github.com/privacysandbox/privacy-sandbox-demos/blob/ff68148e0987979ecdac2f0183b9ca2a1b847bcc/services/ad-tech/src/public/js/video-ads.js#L108).
240240

241241
```js title="Winning PA ad iframe assembles and post-messages the finalized VAST to the top frame"
242242
// ...

services/home/docs/demos/multi-piece-ad.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ through a template 'container' with customizable product slots.
3636
### Goals
3737

3838
In this demo, the auction setup and execution is similar to the
39-
[sequential setup of Protected Audience with contextual ad auction](https://privacy-sandbox-demos.dev/docs/demos/sequential-auction-setup/) demo. So,
40-
please check this use case implementation first if you want to learn about the Protected Audience auction setup.
39+
[sequential setup of Protected Audience with contextual ad auction](./sequential-auction-setup) demo. So, please check this use case implementation
40+
first if you want to learn about the Protected Audience auction setup.
4141

4242
The only incremental difference in this use-case is that the advertiser can provide more than one product that the user interacted with in the same ad
4343
slot.

services/home/docs/demos/sequential-auction-setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ More specifically, the `ad-server-tag.js` injects an iframe for each ad unit whe
237237
Protected Audience auction to choose an ad. This iframe loads:
238238
[`https://privacy-sandbox-demos-ad-server.dev/ssp/run-sequential-ad-auction.html` :arrow_upper_right:](https://github.com/privacysandbox/privacy-sandbox-demos/blob/67d4c6368ff422ad9e952961352b5ac74ee9f500/services/ad-tech/src/views/ssp/run-sequential-ad-auction.ejs),
239239
which contains a single script:
240-
[`https://privacy-sandbox-demos-ad-server.dev/js/ssp/run-sequential-ad-auction.js` :arrow_upper_right:](https://github.com/privacysandbox/privacy-sandbox-demos/blob/dev/services/ad-tech/src/public/js/ssp/run-sequential-ad-auction.js).
240+
[`https://privacy-sandbox-demos-ad-server.dev/js/ssp/run-sequential-ad-auction.js` :arrow_upper_right:](https://github.com/privacysandbox/privacy-sandbox-demos/blob/ff68148e0987979ecdac2f0183b9ca2a1b847bcc/services/ad-tech/src/public/js/ssp/run-sequential-ad-auction.js).
241241
This iframe expects a post-message from `ad-server-tag.js` containing the ad unit configuration as well as the list of other sellers involved in the
242242
ad delivery process.
243243

@@ -341,7 +341,7 @@ SellerContextualBidderRouter.get('/', async (req: Request, res: Response) => {
341341
342342
The publisher ad servers collates the contextual bid responses from all the sellers before assembling the combined auction configuration for Protected
343343
Audience. In the following code snippet from
344-
[`run-sequential-ad-auction.js` :arrow_upper_right:](https://github.com/privacysandbox/privacy-sandbox-demos/blob/dev/services/ad-tech/src/public/js/ssp/run-sequential-ad-auction.js#L145-182),
344+
[`run-sequential-ad-auction.js` :arrow_upper_right:](https://github.com/privacysandbox/privacy-sandbox-demos/blob/ff68148e0987979ecdac2f0183b9ca2a1b847bcc/services/ad-tech/src/public/js/ssp/run-sequential-ad-auction.js#L154),
345345
the winning contextual bid is chosen purely on the bid price. Along with the contextual bid response, the additional sellers or SSPs also respond with
346346
their Protected Audience component auction configuration. The publisher ad server also assembles the final Protected Audience auction configuration
347347
which includes these component auction configurations from other sellers as well as its own component auction.

0 commit comments

Comments
 (0)