Skip to content

Commit 217f99d

Browse files
authored
Update add-new-bidder-java doc (prebid#5187)
1 parent fe004fc commit 217f99d

1 file changed

Lines changed: 2 additions & 44 deletions

File tree

prebid-server/developers/add-new-bidder-java.md

Lines changed: 2 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ OpenRTB Bid Requests contain one or more impression objects, each representing a
3333

3434
### Choose A Name
3535

36-
You will need to choose a unique name for your bid adapter. Names should be written in lower case and may not contain special characters or emoji. If you already have a Prebid.js bid adapter, we encourage you to use the same name with the same bidder parameters. You may not name your adapter `all`, `context`, `data`, `general`, `prebid`, `skadn` or `tid` as those have special meaning in various contexts. Existing bid adapter names are [maintained here](https://github.com/prebid/prebid-server-java/tree/master/src/main/java/org/prebid/server/bidder).
36+
You will need to choose a unique name for your bid adapter. Names should be written in lower case and may not contain special characters or emoji. If you already have a Prebid.js bid adapter, we encourage you to use the same name with the same bidder parameters. You may not name your adapter `all`, `context`, `data`, `general`, `prebid`, `skadn`, `tid`, `all` or `ae` as those have special meaning in various contexts. Existing bid adapter names are [maintained here](https://github.com/prebid/prebid-server-java/tree/master/src/main/java/org/prebid/server/bidder).
3737

3838
We ask that the first 6 letters of the name you choose be unique among the existing bid adapters. This consideration helps with generating targeting keys for use by some ad exchanges, such as Google Ad Manager.
3939

@@ -1026,7 +1026,7 @@ private static BidRequest givenBidRequest(
10261026
```
10271027

10281028
### Bidder Integration Tests
1029-
Go to `test-application.properties` file and add folowing properties
1029+
Go to `test-application.properties` file and add following properties
10301030

10311031
```yaml
10321032
adapters.{bidder}.enabled=true
@@ -1280,41 +1280,6 @@ Add files with content specific to your case:
12801280
}
12811281
```
12821282

1283-
5. `test-cache-{bidder}-request.json`
1284-
1285-
```json
1286-
{
1287-
"puts": [
1288-
{
1289-
"type": "json",
1290-
"value": {
1291-
"id": "bid001",
1292-
"impid": "impId001",
1293-
"price": 3.33,
1294-
"adm": "adm001",
1295-
"adid": "adid001",
1296-
"cid": "cid001",
1297-
"crid": "crid001",
1298-
"w": 300,
1299-
"h": 250
1300-
}
1301-
}
1302-
]
1303-
}
1304-
```
1305-
1306-
6. `test-cache-{bidder}-response.json`
1307-
1308-
```json
1309-
{
1310-
"responses": [
1311-
{
1312-
"uuid": "f0ab9105-cb21-4e59-b433-70f5ad6671cb"
1313-
}
1314-
]
1315-
}
1316-
```
1317-
13181283
Create class `{bidder}Test`in test directory in package `org.prebid.server.it`. Extend `IntegrationTest` class with following content
13191284

13201285
```java
@@ -1345,11 +1310,6 @@ public class {bidder}Test extends IntegrationTest {
13451310
.withRequestBody(equalToJson(jsonFrom("openrtb2/{bidder}/test-{bidder}-bid-request.json")))
13461311
.willReturn(aResponse().withBody(jsonFrom("openrtb2/{bidder}/test-{bidder}-bid-response.json"))));
13471312
1348-
// pre-bid cache
1349-
WIRE_MOCK_RULE.stubFor(post(urlPathEqualTo("/cache"))
1350-
.withRequestBody(equalToJson(jsonFrom("openrtb2/{bidder}/test-cache-{bidder}-request.json")))
1351-
.willReturn(aResponse().withBody(jsonFrom("openrtb2/{bidder}/test-cache-{bidder}-response.json"))));
1352-
13531313
// when
13541314
final Response response = responseFor("openrtb2/{bidder}/test-auction-{bidder}-request.json",
13551315
Endpoint.OPENRTB2_AUCTION);
@@ -1459,8 +1419,6 @@ Notes on the metadata fields:
14591419
- `resources/org/prebid/server/it/openrtb2/{bidder}/test-auction-{bidder}-response.json` (test directory)
14601420
- `resources/org/prebid/server/it/openrtb2/{bidder}/test-{bidder}-bid-request.json` (test directory)
14611421
- `resources/org/prebid/server/it/openrtb2/{bidder}/test-{bidder}-bid-response.json` (test directory)
1462-
- `resources/org/prebid/server/it/openrtb2/{bidder}/test-cache-{bidder}-request.json` (test directory)
1463-
- `resources/org/prebid/server/it/openrtb2/{bidder}/test-cache-{bidder}-response.json` (test directory)
14641422
- Register With The Core
14651423
- `org/prebid/server/spring/config/bidder/{bidder}Configuration.java`
14661424

0 commit comments

Comments
 (0)