From bfc7fed8e42fd7870d2e28fc14abc1a683fac00c Mon Sep 17 00:00:00 2001 From: Oleksandr Zhevedenko <720803+Net-burst@users.noreply.github.com> Date: Sun, 14 Sep 2025 15:59:13 +0200 Subject: [PATCH 1/3] Documentation: Local dev request examples --- sample/configs/localdev-config.yaml | 34 +++++++++++++++ sample/requests/localdev-test-request.http | 36 ++++++++++++++++ ...localdev-test-stored-auction-response.http | 36 ++++++++++++++++ .../localdev-test-stored-bidder-response.http | 42 +++++++++++++++++++ .../sample-stored-auction-response.json | 14 +++++++ .../stored/sample-stored-bidder-response.json | 17 ++++++++ 6 files changed, 179 insertions(+) create mode 100644 sample/configs/localdev-config.yaml create mode 100644 sample/requests/localdev-test-request.http create mode 100644 sample/requests/localdev-test-stored-auction-response.http create mode 100644 sample/requests/localdev-test-stored-bidder-response.http create mode 100644 sample/stored/sample-stored-auction-response.json create mode 100644 sample/stored/sample-stored-bidder-response.json diff --git a/sample/configs/localdev-config.yaml b/sample/configs/localdev-config.yaml new file mode 100644 index 00000000000..92973d9fae5 --- /dev/null +++ b/sample/configs/localdev-config.yaml @@ -0,0 +1,34 @@ +status-response: "ok" +adapters: + generic: + enabled: true + endpoint: http://localhost +metrics: + prefix: prebid +cache: + scheme: http + host: localhost + path: /cache + query: uuid= +settings: + enforce-valid-account: false + generate-storedrequest-bidrequest-id: true + filesystem: + settings-filename: sample/configs/sample-app-settings.yaml + stored-requests-dir: sample/stored + stored-imps-dir: sample/stored + stored-responses-dir: sample/stored + categories-dir: +gdpr: + default-value: 1 + vendorlist: + v2: + cache-dir: /var/tmp/vendor2 + v3: + cache-dir: /var/tmp/vendor3 +admin-endpoints: + logging-changelevel: + enabled: true + path: /logging/changelevel + on-application-port: true + protected: false diff --git a/sample/requests/localdev-test-request.http b/sample/requests/localdev-test-request.http new file mode 100644 index 00000000000..eb5da3d7b35 --- /dev/null +++ b/sample/requests/localdev-test-request.http @@ -0,0 +1,36 @@ +POST http://localhost:8080/openrtb2/auction +Content-Type: application/json + +{ + "id": "test-bid-request-id", + "site": { + "id": "test-site-id", + "name": "Test site", + "domain": "test.com", + "publisher": { + "id": "1001" + } + }, + "regs": { + "gdpr": 0 + }, + "imp": [ + { + "id": "test-imp-id", + "banner": { + "w": 300, + "h": 250 + }, + "ext": { + "prebid": { + "bidder": { + "generic": {} + } + } + } + } + ], + "test": 1 +} + +### diff --git a/sample/requests/localdev-test-stored-auction-response.http b/sample/requests/localdev-test-stored-auction-response.http new file mode 100644 index 00000000000..45509e61570 --- /dev/null +++ b/sample/requests/localdev-test-stored-auction-response.http @@ -0,0 +1,36 @@ +POST http://localhost:8080/openrtb2/auction +Content-Type: application/json + +{ + "id": "test-bid-request-id", + "site": { + "id": "test-site-id", + "name": "Test site", + "domain": "test.com", + "publisher": { + "id": "1001" + } + }, + "regs": { + "gdpr": 0 + }, + "imp": [ + { + "id": "test-imp-id", + "banner": { + "w": 300, + "h": 250 + } + } + ], + "ext": { + "prebid": { + "storedauctionresponse": { + "id": "sample-stored-auction-response" + } + } + }, + "test": 1 +} + +### diff --git a/sample/requests/localdev-test-stored-bidder-response.http b/sample/requests/localdev-test-stored-bidder-response.http new file mode 100644 index 00000000000..eec448271e5 --- /dev/null +++ b/sample/requests/localdev-test-stored-bidder-response.http @@ -0,0 +1,42 @@ +POST http://localhost:8080/openrtb2/auction +Content-Type: application/json + +{ + "id": "test-bid-request-id", + "site": { + "id": "test-site-id", + "name": "Test site", + "domain": "test.com", + "publisher": { + "id": "1001" + } + }, + "regs": { + "gdpr": 0 + }, + "imp": [ + { + "id": "test-imp-id", + "banner": { + "w": 300, + "h": 250 + }, + "ext": { + "prebid": { + "bidder": { + "generic": {} + }, + "storedbidresponse": [ + { + "bidder": "generic", + "id": "sample-stored-bidder-response" + } + ] + } + } + } + ], + "test": 1 +} + +### diff --git a/sample/stored/sample-stored-auction-response.json b/sample/stored/sample-stored-auction-response.json new file mode 100644 index 00000000000..34887d0fbb5 --- /dev/null +++ b/sample/stored/sample-stored-auction-response.json @@ -0,0 +1,14 @@ +{ + "bid": [ + { + "id": "1", + "impid": "test-imp-id", + "price": 0.5, + "adm": "
Ad Content
", + "crid": "creative123", + "w": 300, + "h": 250 + } + ], + "seat": "stored-auction-response-seat" +} diff --git a/sample/stored/sample-stored-bidder-response.json b/sample/stored/sample-stored-bidder-response.json new file mode 100644 index 00000000000..e1dba2b29d1 --- /dev/null +++ b/sample/stored/sample-stored-bidder-response.json @@ -0,0 +1,17 @@ +{ + "seatbid": [ + { + "bid": [ + { + "id": "1", + "impid": "test-imp-id", + "price": 0.5, + "adm": "
Ad Content
", + "crid": "creative123", + "w": 300, + "h": 250 + } + ] + } + ] +} From 61765bc0fe3422e4f7a731e8db2d8151c2d390c7 Mon Sep 17 00:00:00 2001 From: Oleksandr Zhevedenko <720803+Net-burst@users.noreply.github.com> Date: Mon, 15 Sep 2025 15:57:30 +0200 Subject: [PATCH 2/3] Documentation: remove unneeded config block --- sample/configs/localdev-config.yaml | 9 --------- 1 file changed, 9 deletions(-) diff --git a/sample/configs/localdev-config.yaml b/sample/configs/localdev-config.yaml index 92973d9fae5..c5bcce5de06 100644 --- a/sample/configs/localdev-config.yaml +++ b/sample/configs/localdev-config.yaml @@ -3,8 +3,6 @@ adapters: generic: enabled: true endpoint: http://localhost -metrics: - prefix: prebid cache: scheme: http host: localhost @@ -12,7 +10,6 @@ cache: query: uuid= settings: enforce-valid-account: false - generate-storedrequest-bidrequest-id: true filesystem: settings-filename: sample/configs/sample-app-settings.yaml stored-requests-dir: sample/stored @@ -26,9 +23,3 @@ gdpr: cache-dir: /var/tmp/vendor2 v3: cache-dir: /var/tmp/vendor3 -admin-endpoints: - logging-changelevel: - enabled: true - path: /logging/changelevel - on-application-port: true - protected: false From fa25c04c2257eff0df28b9b7984bd4ca8aab1d4a Mon Sep 17 00:00:00 2001 From: Oleksandr Zhevedenko <720803+Net-burst@users.noreply.github.com> Date: Wed, 17 Sep 2025 08:29:32 +0200 Subject: [PATCH 3/3] Documentation: add profiles dir --- sample/configs/localdev-config.yaml | 1 + sample/profiles/README.md | 2 ++ 2 files changed, 3 insertions(+) create mode 100644 sample/profiles/README.md diff --git a/sample/configs/localdev-config.yaml b/sample/configs/localdev-config.yaml index c5bcce5de06..c2991cdf3b6 100644 --- a/sample/configs/localdev-config.yaml +++ b/sample/configs/localdev-config.yaml @@ -14,6 +14,7 @@ settings: settings-filename: sample/configs/sample-app-settings.yaml stored-requests-dir: sample/stored stored-imps-dir: sample/stored + profiles-dir: sample/profiles stored-responses-dir: sample/stored categories-dir: gdpr: diff --git a/sample/profiles/README.md b/sample/profiles/README.md new file mode 100644 index 00000000000..ff7afdd219b --- /dev/null +++ b/sample/profiles/README.md @@ -0,0 +1,2 @@ +### This is a directory to store profiles for file-based configuration. +### Please put only valid OpenRTB JSON files here.