Release dev to main branch + production environment

.demos

@@ -0,0 +1,16 @@
+# list of use case demos
+DEMOS=("uc-single-touch-conversion" "uc-remarketing" "uc-vast-video-paapi" "uc-video-multi-seller-seq-auction-paapi")
+
+# For each use case we need their Cloud Function Entry Point
+typeset -A DEMO_MONITORING_ENTRYPOINT
+DEMO_MONITORING_ENTRYPOINT[uc-single-touch-conversion]=MonitorUcSingleTouchConversion
+DEMO_MONITORING_ENTRYPOINT[uc-remarketing]=MonitorUcRemarketing
+DEMO_MONITORING_ENTRYPOINT[uc-vast-video-paapi]=MonitorUcVastVideoPaapi
+DEMO_MONITORING_ENTRYPOINT[uc-video-multi-seller-seq-auction-paapi]=MonitorUcVideoMultiSellerSeqAuctionPaapi
+
+# For each use case we need to define the Synethtic Monitor Title
+typeset -A DEMO_TITLE
+DEMO_TITLE[uc-single-touch-conversion]="Single-touch conversion Attribution"
+DEMO_TITLE[uc-remarketing]="Remarketing"
+DEMO_TITLE[uc-vast-video-paapi]="Instream VAST video ad in a Protected Audience single-seller auction"
+DEMO_TITLE[uc-video-multi-seller-seq-auction-paapi]="Instream video ad in a Protected Audience multi-seller sequential auction setup"

.env

@@ -5,28 +5,37 @@ EXTERNAL_PORT=443
 PORT=8080
 
 # list of service names
-SERVICES=("home" "news" "shop" "travel" "dsp" "dsp-a" "dsp-b" "ssp" "ssp-a" "ssp-b" "idp" "topics" "topics-server" "ad-server")
+SERVICES=("home" "news" "shop" "travel" "dsp" "dsp-a" "dsp-b" "ssp" "ssp-a" "ssp-b" "idp" "ad-server")
+
+DEMO_HOST_PREFIX=privacy-sandbox-demos-
 
 # home
 HOME_HOST=privacy-sandbox-demos-home.dev
+HOME_URI=http://privacy-sandbox-demos-home.dev:8080
 HOME_TOKEN=""
 HOME_DETAIL="Home page of Privacy Sandbox Demos"
+# Measurement ID for Google Analytics
+HOME_MEASUREMENT_ID="G-12345ABCDE"
+# Container ID for Google Tag Manager
+HOME_TAG_CONTAINER_ID="GTM-12345ABC"
 
 # Publisher
 ## news
 NEWS_HOST=privacy-sandbox-demos-news.dev
+NEWS_URI=http://privacy-sandbox-demos-news.dev:8080
 NEWS_TOKEN=""
 NEWS_DETAIL="Publisher: News media site"
 
-
 # Advertizer
 ## shop
 SHOP_HOST=privacy-sandbox-demos-shop.dev
+SHOP_URI=http://privacy-sandbox-demos-shop.dev:8080
 SHOP_TOKEN=""
 SHOP_DETAIL="Advertiser: EC shopping site"
 
 ## travel
 TRAVEL_HOST=privacy-sandbox-demos-travel.dev
+TRAVEL_URI=http://privacy-sandbox-demos-travel.dev:8080
 TRAVEL_TOKEN=""
 TRAVEL_DETAIL="Advertiser: EC travel site"
 
@@ -78,16 +87,14 @@ IDP_DETAIL="Identity Provider for relying parties. Also Issuing Private State To
 
 ## Topics related
 ## site to observe topics
-TOPICS_MOTO_HOST=motorcycles.privacy-sandbox-demos-news.dev
-TOPICS_SOCCER_HOST=soccer.privacy-sandbox-demos-news.dev
-TOPICS_GARDENING_HOST=gardening.privacy-sandbox-demos-news.dev
+MOTO_NEWS_HOST=motorcycles.privacy-sandbox-demos-news.dev
+MOTO_NEWS_URI=http://motorcycles.privacy-sandbox-demos-news.dev:8080
+SOCCER_NEWS_HOST=soccer.privacy-sandbox-demos-news.dev
+SOCCER_NEWS_URI=http://soccer.privacy-sandbox-demos-news.dev:8080
+GARDENING_NEWS_HOST=gardening.privacy-sandbox-demos-news.dev
+GARDENING_NEWS_URI=http://gardening.privacy-sandbox-demos-news.dev:8080
 TOPICS_DETAIL="Topics page"
 
-## server to request topics with headers
-TOPICS_SERVER_HOST=topics-server.privacy-sandbox-demos-news.dev
-TOPICS_SERVER_URI=http://topics-server.privacy-sandbox-demos-news.dev:8080
-TOPICS_SERVER_DETAIL="Topics server"
-
 ## ad server
 AD_SERVER_HOST=privacy-sandbox-demos-ad-server.dev
 AD_SERVER_URI=http://privacy-sandbox-demos-ad-server.dev:8080

.env.deploy.template

@@ -1,3 +1,5 @@
-# Deployment
+# Deployment env vars used by shell scripts
 GCP_PROJECT_NAME=
-FIREBASE_HOSTING_DOMAIN=
+FIREBASE_HOSTING_DOMAIN=
+GCP_REGION=us-central1
+ENV_FILE=cicd/.env.dev

.gcloudignore

@@ -1,13 +1,7 @@
 # ref : https://cloud.google.com/sdk/gcloud/reference/topic/gcloudignore
 
-#!include:.gitignore
-
 .gcloudignore
 .git
 .gitignore
-services/home/.docusaurus
-services/shop/.next
 
-# include services/home/build/* files into `gcloud builds submit` command
-# DEPRECATED as we now build html files with ci/cd
-# !services/home/build
+#!include:.gitignore

.github/dependabot.yml

@@ -85,57 +85,3 @@ updates:
       prefix: "[home] "
       include: "scope"
     open-pull-requests-limit: 3
-  - package-ecosystem: npm
-    directory: "/services/dsp"
-    schedule:
-      interval: "monthly"
-    rebase-strategy: disabled
-    commit-message:
-      prefix: "[dsp] "
-      include: "scope"
-    open-pull-requests-limit: 3
-  - package-ecosystem: npm
-    directory: "/services/ssp"
-    schedule:
-      interval: "monthly"
-    rebase-strategy: disabled
-    commit-message:
-      prefix: "[ssp] "
-      include: "scope"
-    open-pull-requests-limit: 3
-  - package-ecosystem: npm
-    directory: "/services/news"
-    schedule:
-      interval: "monthly"
-    rebase-strategy: disabled
-    commit-message:
-      prefix: "[news] "
-      include: "scope"
-    open-pull-requests-limit: 3
-  - package-ecosystem: npm
-    directory: "/services/shop"
-    schedule:
-      interval: "monthly"
-    rebase-strategy: disabled
-    commit-message:
-      prefix: "[shop] "
-      include: "scope"
-    open-pull-requests-limit: 3
-  - package-ecosystem: npm
-    directory: "/services/travel"
-    schedule:
-      interval: "monthly"
-    rebase-strategy: disabled
-    commit-message:
-      prefix: "[travel] "
-      include: "scope"
-    open-pull-requests-limit: 3
-  - package-ecosystem: gomod
-    directory: "/services/collector/src"
-    schedule:
-      interval: "monthly"
-    rebase-strategy: disabled
-    commit-message:
-      prefix: "[collector] "
-      include: "scope"
-    open-pull-requests-limit: 3

.github/workflows/github-repo-stats.yml

@@ -0,0 +1,19 @@
+name: github-repo-stats
+
+on:
+  schedule:
+    # Run this once per day, towards the end of the day for keeping the most
+    # recent data point most meaningful (hours are interpreted in UTC).
+    - cron: "0 23 * * *"
+  workflow_dispatch: # Allow for running this manually.
+
+jobs:
+  j1:
+    name: github-repo-stats
+    runs-on: ubuntu-latest
+    steps:
+      - name: run-ghrs
+        # Use latest release.
+        uses: jgehrcke/github-repo-stats@RELEASE
+        with:
+          ghtoken: ${{ secrets.ghrs_github_api_token }}

.github/workflows/scorecard.yml

@@ -51,7 +51,7 @@ jobs:
       # uploads of run results in SARIF format to the repository Actions tab.
       # https://docs.github.com/en/actions/advanced-guides/storing-workflow-data-as-artifacts
       - name: "Upload artifact"
-        uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
+        uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0
         with:
           name: SARIF file
           path: results.sarif
@@ -60,6 +60,6 @@ jobs:
       # Upload the results to GitHub's code scanning dashboard (optional).
       # Commenting out will disable upload of results to your repo's Code Scanning dashboard
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@4355270be187e1b672a7a1c7c7bae5afdc1ab94a # v3.24.10
+        uses: github/codeql-action/upload-sarif@48ab28a6f5dbc2a99bf1e0131198dd8f1df78169 # v3.28.0
         with:
           sarif_file: results.sarif

.gitignore

@@ -4,4 +4,4 @@ build
 *pem
 .firebase
 .firebaserc
-.env.deploy
+.env.deploy

.pre-commit-config.yaml

@@ -32,7 +32,7 @@ repos:
           - yaml
 
   - repo: https://github.com/DavidAnson/markdownlint-cli2
-    rev: v0.13.0
+    rev: v0.17.1
     hooks:
       - id: markdownlint-cli2
         name: lint markdown

README.md

@@ -1,6 +1,6 @@
 # Privacy Sandbox Demos
 
-A use case demo library for [Privacy Sandbox APIs](https://developer.chrome.com/en/docs/privacy-sandbox/) on the web.
+A use case demo library for the [Privacy Sandbox APIs](https://developer.chrome.com/en/docs/privacy-sandbox/) on the web.
 
 ## Motivation
 
@@ -25,6 +25,7 @@ This repository contains :
 - Deployment scripts
 - [Instructions for deploying and running the demos in your local environment with Docker](docs/deploy-to-linux-docker.md)
 - [Instructions for deploying and running the demos on Google Cloud Platform](docs/deploy-to-gcp.md)
+- [A list of codebase dependencies to prepare for development](docs/dependencies.md)
 - Development framework to contribute to the project
 
 If you are a developer we recommend you follow the [deployment instructions](docs/deploy-to-linux-docker.md). If you are simply curious, we recommend
@@ -34,12 +35,13 @@ you have a look at our [Google-hosted instances](https://privacy-sandbox-demos.d
 
 The current release supports the following use cases:
 
-|         **Category**          |                                                           **Use Case**                                                            |            **Privacy Sandbox APIs**            |              **Relevant for**              |
-| :---------------------------: | :-------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------: | :----------------------------------------: |
-|    Show Relevant Video Ads    | [Instream VAST video ad in a Protected Audience multi-seller auction](services/home/docs/demos/instream-video-ad-multi-seller.md) |             Protected Audience API             | Publisher, Ad Server, SSP, Advertiser, DSP |
-|    Show Relevant Video Ads    | [Instream VAST video ad in a Protected Audience single-seller auction](services/home/docs/demos/vast-video-protected-audience.md) |             Protected Audience API             |      Publisher, SSP, Advertiser, DSP       |
-| Show Relevant Content and Ads |                         [Retargeting / Remarketing](services/home/docs/demos/retargeting-remarketing.md)                          |             Protected Audience API             |      Publisher, SSP, Advertiser, DSP       |
-|      Measure Digital Ads      |              [Single-touch conversion Attribution](services/home/docs/demos/single-touch-conversion-attribution.md)               | Attribution Reporting API, Aggregation Service |      Publisher, SSP, Advertiser, DSP       |
+|         **Category**          |                                                           **Use Case**                                                            |                 **Privacy Sandbox APIs**                 |              **Relevant for**              |
+| :---------------------------: | :-------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------: | :----------------------------------------: |
+|    Show Relevant Video Ads    | [Instream VAST video ad in a Protected Audience multi-seller auction](services/home/docs/demos/instream-video-ad-multi-seller.md) |                  Protected Audience API                  | Publisher, Ad Server, SSP, Advertiser, DSP |
+|    Show Relevant Video Ads    | [Instream VAST video ad in a Protected Audience single-seller auction](services/home/docs/demos/vast-video-protected-audience.md) |                  Protected Audience API                  |      Publisher, SSP, Advertiser, DSP       |
+| Show Relevant Content and Ads |                         [Retargeting / Remarketing](services/home/docs/demos/retargeting-remarketing.md)                          |                  Protected Audience API                  |      Publisher, SSP, Advertiser, DSP       |
+|      Measure Digital Ads      |              [Single-touch conversion Attribution](services/home/docs/demos/single-touch-conversion-attribution.md)               |      Attribution Reporting API, Aggregation Service      |      Publisher, SSP, Advertiser, DSP       |
+|      Measure Digital Ads      |               [Multi-touch conversion Attribution](services/home/docs/demos/multi-touch-conversion-attribution.md)                | Private Aggregation, Shared Storage, Aggregation Service |         Publisher, Advertiser, DSP         |
 
 These use cases are based on a set of demo apps and services that we have developed to simulate the actors in the ad tech ecosystem :
 

cicd/.env.dev

@@ -5,28 +5,38 @@ EXTERNAL_PORT=443
 PORT=8080
 
 # list of service names
-SERVICES=("home" "news" "shop" "travel" "dsp" "dsp-a" "dsp-b" "ssp" "ssp-a" "ssp-b" "idp" "topics" "topics-server" "ad-server")
+SERVICES=("home" "news" "shop" "travel" "dsp" "dsp-a" "dsp-b" "ssp" "ssp-a" "ssp-b" "idp" "ad-server")
+
+DEMO_HOST_PREFIX=privacy-sandcastle-dev-
 
 # home
 HOME_HOST=privacy-sandcastle-dev-home.web.app
+HOME_URI=https://privacy-sandcastle-dev-home.web.app
 HOME_TOKEN=""
 HOME_DETAIL="Home page of Privacy Sandbox Demos"
+# Measurement ID for Google Analytics
+HOME_MEASUREMENT_ID="G-6V8T201H6F"
+# Container ID for Google Tag Manager
+HOME_TAG_CONTAINER_ID="GTM-5BJSXX2D"
 
 # Publisher
 ## news
 NEWS_HOST=privacy-sandcastle-dev-news.web.app
+NEWS_URI=https://privacy-sandcastle-dev-news.web.app
 NEWS_TOKEN=""
 NEWS_DETAIL="Publisher: News media site"
 
 
 # Advertizer
 ## shop
 SHOP_HOST=privacy-sandcastle-dev-shop.web.app
+SHOP_URI=https://privacy-sandcastle-dev-shop.web.app
 SHOP_TOKEN=""
 SHOP_DETAIL="Advertiser: EC shopping site"
 
 ## travel
 TRAVEL_HOST=privacy-sandcastle-dev-travel.web.app
+TRAVEL_URI=https://privacy-sandcastle-dev-travel.web.app
 TRAVEL_TOKEN=""
 TRAVEL_DETAIL="Advertiser: EC travel site"
 
@@ -35,7 +45,7 @@ TRAVEL_DETAIL="Advertiser: EC travel site"
 ## dsp
 DSP_HOST=privacy-sandcastle-dev-dsp.web.app
 DSP_URI=https://privacy-sandcastle-dev-dsp.web.app
-DSP_TOKEN="A0nDunxZWFAhYvrWCRTblhlyK3D9m0czMNY/m9t2+pG3i1JHkMDasm8m66CwZS54qMeOepb+d9DYjawtBDbDrQgAAACYeyJvcmlnaW4iOiJodHRwczovL3ByaXZhY3ktc2FuZGNhc3RsZS1kZXYtZHNwLndlYi5hcHA6NDQzIiwiZmVhdHVyZSI6IlByaXZhY3lTYW5kYm94QWRzQVBJcyIsImV4cGlyeSI6MTY5NTE2Nzk5OSwiaXNTdWJkb21haW4iOnRydWUsImlzVGhpcmRQYXJ0eSI6dHJ1ZX0="
+DSP_TOKEN=""
 DSP_DETAIL="Ad-Platform: DSP for advertiser"
 
 DSP_A_HOST=privacy-sandcastle-dev-dsp-a1.web.app
@@ -51,7 +61,7 @@ DSP_B_DETAIL="Ad-Platform: DSP-B for advertiser"
 ## ssp
 SSP_HOST=privacy-sandcastle-dev-ssp.web.app
 SSP_URI=https://privacy-sandcastle-dev-ssp.web.app
-SSP_TOKEN="A3Jo3gcicBIWHTI+QzCeb2h+B4TJX/y8PSngoHtoHeCpnRi2Ny/TFjJ/QtSQhBeS+2x43Jtd5GfksanOOglcVgIAAACYeyJvcmlnaW4iOiJodHRwczovL3ByaXZhY3ktc2FuZGNhc3RsZS1kZXYtc3NwLndlYi5hcHA6NDQzIiwiZmVhdHVyZSI6IlByaXZhY3lTYW5kYm94QWRzQVBJcyIsImV4cGlyeSI6MTY5NTE2Nzk5OSwiaXNTdWJkb21haW4iOnRydWUsImlzVGhpcmRQYXJ0eSI6dHJ1ZX0="
+SSP_TOKEN=""
 SSP_DETAIL="Ad-Platform: SSP for publisher"
 
 SSP_A_HOST=privacy-sandcastle-dev-ssp-a.web.app
@@ -78,16 +88,14 @@ IDP_DETAIL="Identity Provider for relying parties. Also Issuing Private State To
 
 ## Topics related
 ## site to observe topics
-TOPICS_MOTO_HOST=privacy-sandcastle-dev-motorcycles.web.app
-TOPICS_SOCCER_HOST=privacy-sandcastle-dev-soccer-foot.web.app
-TOPICS_GARDENING_HOST=privacy-sandcastle-dev-gardening-potager.web.app
+MOTO_NEWS_HOST=privacy-sandcastle-dev-motorcycles.web.app
+MOTO_NEWS_URI=https://privacy-sandcastle-dev-motorcycles.web.app
+SOCCER_NEWS_HOST=privacy-sandcastle-dev-soccer-foot.web.app
+SOCCER_NEWS_URI=https://privacy-sandcastle-dev-soccer-foot.web
+GARDENING_NEWS_HOST=privacy-sandcastle-dev-gardening-potager.web.app
+GARDENING_NEWS_URI=https://privacy-sandcastle-dev-gardening-potager
 TOPICS_DETAIL="Topics page"
 
-## server to request topics with headers
-TOPICS_SERVER_HOST=privacy-sandcastle-dev-topics-server.web.app
-TOPICS_SERVER_URI=https://privacy-sandcastle-dev-topics-server.web.app
-TOPICS_SERVER_DETAIL="Topics server"
-
 ## ad server
 AD_SERVER_HOST=privacy-sandcastle-dev-ad-server.web.app
 AD_SERVER_URI=https://privacy-sandcastle-dev-ad-server.web.app

cicd/.env.prod

@@ -5,28 +5,38 @@ EXTERNAL_PORT=443
 PORT=8080
 
 # list of service names
-SERVICES=("home" "news" "shop" "travel" "dsp" "dsp-a" "dsp-b" "ssp" "ssp-a" "ssp-b" "idp" "topics" "topics-server" "ad-server")
+SERVICES=("home" "news" "shop" "travel" "dsp" "dsp-a" "dsp-b" "ssp" "ssp-a" "ssp-b" "idp" "ad-server")
+
+DEMO_HOST_PREFIX=privacy-sandbox-demos-
 
 # home
-HOME_HOST=privacy-sandbox-demos-home.dev
+HOME_HOST=privacy-sandbox-demos.dev
+HOME_URI=https://privacy-sandbox-demos.dev
 HOME_TOKEN=""
 HOME_DETAIL="Home page of Privacy Sandbox Demos"
+# Measurement ID for Google Analytics
+HOME_MEASUREMENT_ID="G-2M6L90WK9X"
+# Container ID for Google Tag Manager
+HOME_TAG_CONTAINER_ID="GTM-TNT5ND8K"
 
 # Publisher
 ## news
 NEWS_HOST=privacy-sandbox-demos-news.dev
+NEWS_URI=https://privacy-sandbox-demos-news.dev
 NEWS_TOKEN=""
 NEWS_DETAIL="Publisher: News media site"
 
 
 # Advertizer
 ## shop
 SHOP_HOST=privacy-sandbox-demos-shop.dev
+SHOP_URI=https://privacy-sandbox-demos-shop.dev
 SHOP_TOKEN=""
 SHOP_DETAIL="Advertiser: EC shopping site"
 
 ## travel
 TRAVEL_HOST=privacy-sandbox-demos-travel.dev
+TRAVEL_URI=https://privacy-sandbox-demos-travel.dev
 TRAVEL_TOKEN=""
 TRAVEL_DETAIL="Advertiser: EC travel site"
 
@@ -78,16 +88,14 @@ IDP_DETAIL="Identity Provider for relying parties. Also Issuing Private State To
 
 ## Topics related
 ## site to observe topics
-TOPICS_MOTO_HOST=motorcycles.privacy-sandbox-demos-news.dev
-TOPICS_SOCCER_HOST=soccer.privacy-sandbox-demos-news.dev
-TOPICS_GARDENING_HOST=gardening.privacy-sandbox-demos-news.dev
+MOTO_NEWS_HOST=motorcycles.privacy-sandbox-demos-news.dev
+MOTO_NEWS_URI=https://motorcycles.privacy-sandbox-demos-news.dev
+SOCCER_NEWS_HOST=soccer.privacy-sandbox-demos-news.dev
+SOCCER_NEWS_URI=https://soccer.privacy-sandbox-demos-news.dev
+GARDENING_NEWS_HOST=gardening.privacy-sandbox-demos-news.dev
+GARDENING_NEWS_URI=https://gardening.privacy-sandbox-demos-news.dev
 TOPICS_DETAIL="Topics page"
 
-## server to request topics with headers
-TOPICS_SERVER_HOST=topics-server.privacy-sandbox-demos-news.dev
-TOPICS_SERVER_URI=https://topics-server.privacy-sandbox-demos-news.dev
-TOPICS_SERVER_DETAIL="Topics server"
-
 ## ad server
 AD_SERVER_HOST=privacy-sandbox-demos-ad-server.dev
 AD_SERVER_URI=https://privacy-sandbox-demos-ad-server.dev