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.

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 about server orchestrated multi seller flow for PAS auctions #184

Closed
wants to merge 33 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
faa3f4b
Add details about server orchestrated multi seller flow for PAS auctions
jasarora-google Dec 11, 2024
1813f51
Update inference_api.md (#185)
mihnjong-l Dec 17, 2024
69ef14b
Update inference API explainer for model deletion (#186)
steveganzy Dec 19, 2024
aa3fc8c
correct cpu metric as one metric with different labels (#188)
xinggao01 Jan 8, 2025
f5ef2f6
Add note that Protected Auctions from Android require PA KV service (…
cshmerling Jan 8, 2025
fbf3ee5
Update bidding_auction_services_api.md (#190)
cshmerling Jan 8, 2025
d362156
Add explainer for experiment with randomly split traffic (#169)
xinggao01 Jan 9, 2025
ebe27eb
link to GCP doc for traffic splitting (#192)
xinggao01 Jan 9, 2025
d31a0b6
Add FAQ for UDF log (#191)
xinggao01 Jan 9, 2025
fd1c55a
Create release_compatibility_bidding_auction_key_value_services.md (#…
lusayaa Jan 15, 2025
e85b1ac
Update timeline info for B&A Azure support and PAS egress noising
dankocoj-google Jan 15, 2025
18de4a2
Update release_compatibility_bidding_auction_key_value_services.md (#…
emmafu2022 Jan 23, 2025
bd89583
Cost tool explainer (#199)
akshaypundle Jan 29, 2025
6f1631e
Update Cost tool Readme link and authors (#201)
akshaypundle Jan 29, 2025
9fff625
Move testing phases to a dedicated doc (#200)
peiwenhu Jan 31, 2025
21464c9
Updated Readme link to be from main branch (#202)
akshaypundle Feb 3, 2025
ca58d6f
update AWS ssh instructions to use session manager
dankocoj-google Feb 4, 2025
20b6da4
Update key_value_service_user_defined_functions.md (#205)
lusayaa Feb 14, 2025
9760add
Add hybrid bna explainer for kv server (#206)
lx3-g Feb 14, 2025
6ceef4d
hybrid doc fix (#207)
lx3-g Feb 14, 2025
92eb0e0
B&A KAnon integration (#208)
chatterjee-priyanka Feb 18, 2025
00861a1
Create b&a-kanon-integration.md (#209)
chatterjee-priyanka Feb 19, 2025
24107a2
Update README.md (#210)
chatterjee-priyanka Feb 19, 2025
2b545f3
Update protected_auction_services_launch_testing_phases.md (#211)
chatterjee-priyanka Feb 19, 2025
1e2e093
Update Explainer with Custom Metric Configuration (#212)
chau-huynh Feb 19, 2025
3d6c469
Mark emeritus status on authors (mostly myself) of certains docs (#215)
peiwenhu Feb 20, 2025
4563606
Update custom metric explainer (#213)
xinggao01 Feb 20, 2025
fdf73b3
Update guidance about first party identifier (#187)
chatterjee-priyanka Feb 24, 2025
f9de9eb
Updated the B&A Self Serve explainer by adding a "Supported Architect…
roopalna Feb 24, 2025
7136aea
add bucket_fetch metric info
dankocoj-google Feb 4, 2025
9356ede
Add PV section to system design explainer (#217)
neilv-g Feb 27, 2025
670a60e
docs: Add Parc API overview (#218)
pmeric Feb 28, 2025
336d9e8
Update roma_bring_your_own_binary.md (#219)
a-shruti Mar 4, 2025
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
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,13 @@ ad targeting products.

* [Overview of trust model / Coordinators](trusted_services_overview.md)
* [Public cloud TEE requirements](public_cloud_tees.md)
* [Cross Cloud Coordinators](cross_cloud_coordinators.md)

## Protected Audience auctions mixed mode

* [Protected audience auctions mixed mode](protected_audience_auctions_mixed_mode.md)

## Bidding and Auction services
## Bidding and Auction services (B&A)

* [Bidding and Auction services](bidding_auction_services_api.md)
* Self-serve guide
Expand All @@ -39,6 +41,10 @@ ad targeting products.
* Protected App Signals
* [Bidding and Auction services: Protected App Signals](bidding_auction_services_protected_app_signals.md)
* [Protected App Signals egress format](https://github.com/privacysandbox/protected-auction-services-docs/blob/main/bidding_auction_services_protected_app_signals_egress.md)
* B&A and K-Anonymity integration
* [Bidding-Auction services and K-Anonymity integration](bidding-auction-services-kanon-integration.md)
* B&A experiment support
* [Bidding and Auction services experiment](bidding_auction_experiment.md)
* Cloud support
* AWS: [Bidding and Auction services AWS cloud support and deployment guide](bidding_auction_services_aws_guide.md)
* GCP: [Bidding and Auction services GCP cloud support and deployment guide](bidding_auction_services_gcp_guide.md)
Expand All @@ -50,12 +56,18 @@ ad targeting products.
* [Key/Value service user-defined functions (UDFs)](key_value_service_user_defined_functions.md)
* [Key/Value sharding](key_value_service_sharding.md)
* [K/V Server Instance Sizing Guide](key_value_service_instance_sizing_guide.md)
* [Key/Value Service Cost](key_value_service_cost.md)
* [Key/Value service Cost](key_value_service_cost.md)
* [Key/Value service hybrid mode](key_value_service_hybrid_mode.md)
* [Passing buyer signals from B&A to TEE KV for PA flow](key_value_service_contextual_signals_propagation.md)

## Ad Retrieval service

* [Protected App Signals: Ad Retrieval service](https://github.com/privacysandbox/protected-auction-key-value-service/blob/main/docs/protected_app_signals/ad_retrieval_overview.md)

## B&A and TEE KV / Retrieval version compatibility

* [B&A and TEE KV / Retrieval version compatibility](release_compatibility_bidding_auction_key_value_services.md)

## User Defined Function Execution
* [Roma Bring-Your-Own-Binary](roma_bring_your_own_binary.md)

Expand All @@ -73,6 +85,11 @@ ad targeting products.

* [Bidding and Auction services: Cost](bidding_auction_cost.md)
* [Protected App Signals cost](protected_app_signals_cost.md)
* [Bidding and Auction Cost Estimation Tool](bidding_auction_cost_estimation_tool.md)

## Protected Auction services launch phases

* [Protected Auction services launch and testing phases](protected_auction_services_launch_testing_phases.md)

## Client and server integration

Expand Down
421 changes: 421 additions & 0 deletions bidding-auction-services-kanon-integration.md

Large diffs are not rendered by default.

15 changes: 7 additions & 8 deletions bidding-auction-services-payload-optimization.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,12 +116,12 @@ compressed [`ProtectedAuctionInput`][5] request payload.

#### Step 1

**The buyer creates `interest groups` based on `first party advertiser cookie`**
**The buyer creates `interest groups`**

Buyers running B&A services must ensure that `trustedBiddingSignalKeys` in
each `interest group` only include a `first party (1p) advertiser cookie`. This
would facilitate fetching data required by generateBid() for the interest group in
`trustedBiddingSignals` from buyer's key / value service.
It is recommended to buyers running B&A services to use a first party identifier (for example `first party user ID for
advertiser site or app`) for `trustedBiddingSignalKeys` and / or `interest group name`.
This would facilitate fetching data required by generateBid() for the
interest group in `trustedBiddingSignals` from buyer's key / value service.

#### Step 2

Expand Down Expand Up @@ -182,7 +182,7 @@ The only information included in each interest group are the following. Note tha
browser will not include `adRenderId(s)` or `adComponentRenderId(s)` or `userBiddingSignals`
or any other information in interest groups.
* interest group `name`
* `trustedBiddingSignalKeys`: Note that this must be a first party advertiser cookie
* `trustedBiddingSignalKeys`: It is recommended to be an identifier such as `first party user identifier per advertiser site (or app)`
* [browserSignals][18]

##### Specification for browser signals
Expand Down Expand Up @@ -246,8 +246,7 @@ The browser will not include `userBiddingSignals` information in `interest group
are sent in `ProtectedAuctionInput` request payload.

The `userBiddingSignals` information per `interest group` can be made available in
`trustedBiddingSignals`, if `first party advertiser cookie` is used as
`trustedBiddingSignalKeys`.
`trustedBiddingSignals`.


#### Step 8
Expand Down
15 changes: 5 additions & 10 deletions bidding_auction_cost.md
Original file line number Diff line number Diff line change
Expand Up @@ -496,6 +496,10 @@ ghz \

_Example command line call to start a two-day test run at 60 QPS_

A cost estimation tool is available to help estimate B&A costs using a shorter
duration load test (about 1 hour). See the [cost estimation tool explainer][33]
for more details.

## Compiling costs for the test

After the test is completed the results may be found in the billing explorer of
Expand Down Expand Up @@ -568,16 +572,6 @@ Note that this assumes a production architecture similar to that under test.
More complex architectures to handle higher loads, such as a fan-out load
balancing scheme, may yield different results.

# Future work

Enabling accurate cost estimation is an important area that the Privacy Sandbox
team wants to support ad tech partners. To this effect, we have the current
plan:

- Publish a load generator tool that can be used by ad techs for cost analysis
in conjunction with methods mentioned above
- Work with ad tech partners to measure and optimize cost

[1]: http://goto.google.com/relevance-cost
[2]: http://go/cma-notice
[3]: https://github.com/privacysandbox/fledge-docs/blob/main/bidding_auction_services_api.md
Expand Down Expand Up @@ -610,3 +604,4 @@ plan:
[30]: https://cloud.google.com/skus
[31]: https://github.com/akshaypundle
[32]: https://github.com/dave-garred
[33]: https://github.com/privacysandbox/protected-auction-services-docs/blob/main/bidding_auction_cost_estimation_tool.md
Loading