From c2e16f264437ab42c5d7929297c29fa78c9f99a3 Mon Sep 17 00:00:00 2001 From: Jan Date: Tue, 6 Oct 2026 15:58:45 +0200 Subject: [PATCH 1/3] New Adapter: GoAdserver Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01Logb1f3FNVSzPCTMtqNc8A --- .../bidder/goadserver/GoadserverBidder.java | 244 +++++++++++ .../request/goadserver/ExtImpGoadserver.java | 18 + .../bidder/GoadserverConfiguration.java | 35 ++ .../resources/bidder-config/goadserver.yaml | 12 + .../static/bidder-params/goadserver.json | 30 ++ .../goadserver/GoadserverBidderTest.java | 410 ++++++++++++++++++ .../org/prebid/server/it/GoadserverTest.java | 34 ++ .../test-auction-goadserver-request.json | 25 ++ .../test-auction-goadserver-response.json | 43 ++ .../test-goadserver-bid-request.json | 57 +++ .../test-goadserver-bid-response.json | 31 ++ .../server/it/test-application.properties | 2 + 12 files changed, 941 insertions(+) create mode 100644 src/main/java/org/prebid/server/bidder/goadserver/GoadserverBidder.java create mode 100644 src/main/java/org/prebid/server/proto/openrtb/ext/request/goadserver/ExtImpGoadserver.java create mode 100644 src/main/java/org/prebid/server/spring/config/bidder/GoadserverConfiguration.java create mode 100644 src/main/resources/bidder-config/goadserver.yaml create mode 100644 src/main/resources/static/bidder-params/goadserver.json create mode 100644 src/test/java/org/prebid/server/bidder/goadserver/GoadserverBidderTest.java create mode 100644 src/test/java/org/prebid/server/it/GoadserverTest.java create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-auction-goadserver-request.json create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-auction-goadserver-response.json create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-goadserver-bid-request.json create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-goadserver-bid-response.json diff --git a/src/main/java/org/prebid/server/bidder/goadserver/GoadserverBidder.java b/src/main/java/org/prebid/server/bidder/goadserver/GoadserverBidder.java new file mode 100644 index 00000000000..61099609ef9 --- /dev/null +++ b/src/main/java/org/prebid/server/bidder/goadserver/GoadserverBidder.java @@ -0,0 +1,244 @@ +package org.prebid.server.bidder.goadserver; + +import com.fasterxml.jackson.core.type.TypeReference; +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.node.ObjectNode; +import com.iab.openrtb.request.BidRequest; +import com.iab.openrtb.request.Imp; +import com.iab.openrtb.request.Publisher; +import com.iab.openrtb.request.Site; +import com.iab.openrtb.response.Bid; +import com.iab.openrtb.response.BidResponse; +import com.iab.openrtb.response.SeatBid; +import io.vertx.core.MultiMap; +import org.apache.commons.collections4.CollectionUtils; +import org.apache.commons.lang3.StringUtils; +import org.prebid.server.bidder.Bidder; +import org.prebid.server.bidder.model.BidderBid; +import org.prebid.server.bidder.model.BidderCall; +import org.prebid.server.bidder.model.BidderError; +import org.prebid.server.bidder.model.HttpRequest; +import org.prebid.server.bidder.model.Result; +import org.prebid.server.exception.PreBidException; +import org.prebid.server.json.DecodeException; +import org.prebid.server.json.JacksonMapper; +import org.prebid.server.proto.openrtb.ext.ExtPrebid; +import org.prebid.server.proto.openrtb.ext.request.goadserver.ExtImpGoadserver; +import org.prebid.server.proto.openrtb.ext.response.BidType; +import org.prebid.server.util.BidderUtil; +import org.prebid.server.util.HttpUtil; +import org.prebid.server.util.Uri; + +import java.math.BigDecimal; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.Objects; +import java.util.regex.Pattern; + +/** + * GoAdserver is a self-hosted, multi-tenant ad server. Every deployment runs under its own domain, so the + * endpoint host and the publisher token are per-impression params. Impressions are grouped by (host, token) + * and each group is sent to https://{host}/openrtb2/auction with the token in site.publisher.id. + */ +public class GoadserverBidder implements Bidder { + + private static final TypeReference> GOADSERVER_EXT_TYPE_REFERENCE = + new TypeReference<>() { + }; + + private static final String HOST_MACRO = "Host"; + private static final String DEFAULT_CURRENCY = "USD"; + private static final String DSA_FIELD = "dsa"; + + // A bare hostname only: no scheme, port, path or userinfo, and no IP literal. + private static final Pattern HOST_PATTERN = + Pattern.compile("^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$"); + + private final Uri endpointUrl; + private final JacksonMapper mapper; + + public GoadserverBidder(String endpointUrl, JacksonMapper mapper) { + this.endpointUrl = Uri.of(endpointUrl); + this.mapper = Objects.requireNonNull(mapper); + } + + @Override + public Result>> makeHttpRequests(BidRequest request) { + if (request.getSite() == null) { + return Result.withError(BidderError.badInput("goadserver supports site requests only")); + } + + final List errors = new ArrayList<>(); + final Map> impsByGroup = new LinkedHashMap<>(); + + for (Imp imp : request.getImp()) { + try { + final ExtImpGoadserver extImp = parseImpExt(imp); + final GroupKey key = new GroupKey(normalizeHost(extImp.getHost(), imp.getId()), + validateToken(extImp.getToken(), imp.getId())); + impsByGroup.computeIfAbsent(key, _ -> new ArrayList<>()).add(modifyImp(imp, extImp)); + } catch (PreBidException e) { + errors.add(BidderError.badInput(e.getMessage())); + } + } + + final List> httpRequests = impsByGroup.entrySet().stream() + .map(entry -> makeHttpRequest(request, entry.getKey(), entry.getValue())) + .toList(); + + return Result.of(httpRequests, errors); + } + + private ExtImpGoadserver parseImpExt(Imp imp) { + try { + final ExtImpGoadserver extImp = mapper.mapper() + .convertValue(imp.getExt(), GOADSERVER_EXT_TYPE_REFERENCE) + .getBidder(); + if (extImp == null) { + throw new PreBidException("imp %s: missing ext.bidder".formatted(imp.getId())); + } + return extImp; + } catch (IllegalArgumentException e) { + throw new PreBidException("imp %s: invalid ext.bidder".formatted(imp.getId())); + } + } + + private static String normalizeHost(String host, String impId) { + final String normalized = StringUtils.trimToEmpty(host).toLowerCase(Locale.ROOT); + if (!HOST_PATTERN.matcher(normalized).matches()) { + throw new PreBidException("imp %s: invalid host".formatted(impId)); + } + return normalized; + } + + private static String validateToken(String token, String impId) { + if (StringUtils.isBlank(token)) { + throw new PreBidException("imp %s: missing token".formatted(impId)); + } + return token; + } + + private Imp modifyImp(Imp imp, ExtImpGoadserver extImp) { + final Imp.ImpBuilder builder = imp.toBuilder().ext(makeImpExt(extImp.getSubid())); + + final BigDecimal floor = extImp.getFloor(); + if (BidderUtil.isValidPrice(floor) && !BidderUtil.isValidPrice(imp.getBidfloor())) { + builder.bidfloor(floor).bidfloorcur(DEFAULT_CURRENCY); + } + return builder.build(); + } + + // The GoAdserver endpoint reads an optional sub-identifier from imp.ext.goadserver.subid. + private ObjectNode makeImpExt(JsonNode subid) { + final String subidValue = subid == null || subid.isNull() ? null : subid.asText(); + if (StringUtils.isEmpty(subidValue)) { + return null; + } + final ObjectNode impExt = mapper.mapper().createObjectNode(); + impExt.putObject("goadserver").put("subid", subidValue); + return impExt; + } + + private HttpRequest makeHttpRequest(BidRequest request, GroupKey key, List imps) { + final BidRequest outgoingRequest = request.toBuilder() + .imp(imps) + .site(modifySite(request.getSite(), key.token())) + .build(); + + final MultiMap headers = HttpUtil.headers() + .add(HttpUtil.X_OPENRTB_VERSION_HEADER, "2.5"); + + return BidderUtil.defaultRequest(outgoingRequest, headers, resolveEndpoint(key.host()), mapper); + } + + private static Site modifySite(Site site, String token) { + final Publisher publisher = site.getPublisher(); + final Publisher modifiedPublisher = publisher != null + ? publisher.toBuilder().id(token).build() + : Publisher.builder().id(token).build(); + return site.toBuilder().publisher(modifiedPublisher).build(); + } + + private String resolveEndpoint(String host) { + return endpointUrl.replaceMacro(HOST_MACRO, host).expand(); + } + + @Override + public Result> makeBids(BidderCall httpCall, BidRequest bidRequest) { + try { + final BidResponse bidResponse = mapper.decodeValue(httpCall.getResponse().getBody(), BidResponse.class); + final List errors = new ArrayList<>(); + return Result.of(extractBids(bidResponse, errors), errors); + } catch (DecodeException e) { + return Result.withError(BidderError.badServerResponse(e.getMessage())); + } + } + + private List extractBids(BidResponse bidResponse, List errors) { + if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) { + return Collections.emptyList(); + } + final String currency = StringUtils.defaultIfEmpty(bidResponse.getCur(), DEFAULT_CURRENCY); + return bidResponse.getSeatbid().stream() + .filter(Objects::nonNull) + .map(SeatBid::getBid) + .filter(Objects::nonNull) + .flatMap(Collection::stream) + .filter(Objects::nonNull) + .map(bid -> makeBidderBid(bid, currency, errors)) + .filter(Objects::nonNull) + .toList(); + } + + private BidderBid makeBidderBid(Bid bid, String currency, List errors) { + final BidType bidType = getBidType(bid); + if (bidType == null) { + errors.add(BidderError.badServerResponse( + "unsupported media type for bid %s on imp %s".formatted(bid.getId(), bid.getImpid()))); + return null; + } + return BidderBid.of(bid.toBuilder().ext(keepDsa(bid.getExt())).build(), bidType, currency); + } + + // Prefers bid.mtype and falls back to bid.ext.prebid.type, which GoAdserver sets on every bid. + private static BidType getBidType(Bid bid) { + final BidType byMtype = switch (bid.getMtype()) { + case 1 -> BidType.banner; + case 2 -> BidType.video; + case 4 -> BidType.xNative; + case null, default -> null; + }; + if (byMtype != null) { + return byMtype; + } + + final ObjectNode ext = bid.getExt(); + final String type = ext != null ? ext.path("prebid").path("type").asText(null) : null; + return switch (StringUtils.defaultString(type)) { + case "banner" -> BidType.banner; + case "video" -> BidType.video; + case "native" -> BidType.xNative; + default -> null; + }; + } + + // Drops the Prebid.js targeting GoAdserver adds for its direct integration and keeps only the + // DSA transparency object, which Prebid Server validates and relays. + private ObjectNode keepDsa(ObjectNode ext) { + final JsonNode dsa = ext != null ? ext.get(DSA_FIELD) : null; + if (dsa == null || dsa.isNull()) { + return null; + } + final ObjectNode modifiedExt = mapper.mapper().createObjectNode(); + modifiedExt.set(DSA_FIELD, dsa); + return modifiedExt; + } + + private record GroupKey(String host, String token) { + } +} diff --git a/src/main/java/org/prebid/server/proto/openrtb/ext/request/goadserver/ExtImpGoadserver.java b/src/main/java/org/prebid/server/proto/openrtb/ext/request/goadserver/ExtImpGoadserver.java new file mode 100644 index 00000000000..60488dd5841 --- /dev/null +++ b/src/main/java/org/prebid/server/proto/openrtb/ext/request/goadserver/ExtImpGoadserver.java @@ -0,0 +1,18 @@ +package org.prebid.server.proto.openrtb.ext.request.goadserver; + +import com.fasterxml.jackson.databind.JsonNode; +import lombok.Value; + +import java.math.BigDecimal; + +@Value(staticConstructor = "of") +public class ExtImpGoadserver { + + String host; + + String token; + + BigDecimal floor; + + JsonNode subid; +} diff --git a/src/main/java/org/prebid/server/spring/config/bidder/GoadserverConfiguration.java b/src/main/java/org/prebid/server/spring/config/bidder/GoadserverConfiguration.java new file mode 100644 index 00000000000..0a43641a823 --- /dev/null +++ b/src/main/java/org/prebid/server/spring/config/bidder/GoadserverConfiguration.java @@ -0,0 +1,35 @@ +package org.prebid.server.spring.config.bidder; + +import org.prebid.server.bidder.BidderDeps; +import org.prebid.server.bidder.goadserver.GoadserverBidder; +import org.prebid.server.json.JacksonMapper; +import org.prebid.server.spring.config.bidder.model.BidderConfigurationProperties; +import org.prebid.server.spring.config.bidder.util.BidderDepsAssembler; +import org.prebid.server.spring.env.YamlPropertySourceFactory; +import org.springframework.boot.context.properties.ConfigurationProperties; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.PropertySource; + +@Configuration +@PropertySource(value = "classpath:/bidder-config/goadserver.yaml", factory = YamlPropertySourceFactory.class) +public class GoadserverConfiguration { + + private static final String BIDDER_NAME = "goadserver"; + + @Bean("goadserverConfigurationProperties") + @ConfigurationProperties("adapters.goadserver") + BidderConfigurationProperties configurationProperties() { + return new BidderConfigurationProperties(); + } + + @Bean + BidderDeps goadserverBidderDeps(BidderConfigurationProperties goadserverConfigurationProperties, + JacksonMapper mapper) { + + return BidderDepsAssembler.forBidder(BIDDER_NAME) + .withConfig(goadserverConfigurationProperties) + .bidderCreator(config -> new GoadserverBidder(config.getEndpoint(), mapper)) + .assemble(); + } +} diff --git a/src/main/resources/bidder-config/goadserver.yaml b/src/main/resources/bidder-config/goadserver.yaml new file mode 100644 index 00000000000..ba6dc464b0e --- /dev/null +++ b/src/main/resources/bidder-config/goadserver.yaml @@ -0,0 +1,12 @@ +adapters: + goadserver: + endpoint: https://{Host}/openrtb2/auction + meta-info: + maintainer-email: support@goadserver.com + app-media-types: + site-media-types: + - banner + - video + - native + supported-vendors: + vendor-id: 0 diff --git a/src/main/resources/static/bidder-params/goadserver.json b/src/main/resources/static/bidder-params/goadserver.json new file mode 100644 index 00000000000..f65234a3946 --- /dev/null +++ b/src/main/resources/static/bidder-params/goadserver.json @@ -0,0 +1,30 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "GoAdserver Adapter Params", + "description": "A schema which validates params accepted by the GoAdserver adapter", + "type": "object", + "properties": { + "host": { + "type": "string", + "description": "Public domain of the publisher's GoAdserver deployment. Requests are sent to https://{host}/openrtb2/auction", + "pattern": "^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$" + }, + "token": { + "type": "string", + "description": "SSP campaign authentication token from the publisher's GoAdserver panel", + "minLength": 1, + "maxLength": 128, + "pattern": "^[A-Za-z0-9_-]+$" + }, + "floor": { + "type": "number", + "description": "Bid floor in USD CPM, applied when the impression has no bidfloor of its own", + "minimum": 0 + }, + "subid": { + "type": ["string", "integer"], + "description": "Sub-identifier for stats attribution (page section, A/B group, etc.)" + } + }, + "required": ["host", "token"] +} diff --git a/src/test/java/org/prebid/server/bidder/goadserver/GoadserverBidderTest.java b/src/test/java/org/prebid/server/bidder/goadserver/GoadserverBidderTest.java new file mode 100644 index 00000000000..b299e66761a --- /dev/null +++ b/src/test/java/org/prebid/server/bidder/goadserver/GoadserverBidderTest.java @@ -0,0 +1,410 @@ +package org.prebid.server.bidder.goadserver; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.node.IntNode; +import com.fasterxml.jackson.databind.node.ObjectNode; +import com.fasterxml.jackson.databind.node.TextNode; +import com.iab.openrtb.request.Banner; +import com.iab.openrtb.request.BidRequest; +import com.iab.openrtb.request.Imp; +import com.iab.openrtb.request.Publisher; +import com.iab.openrtb.request.Site; +import com.iab.openrtb.response.Bid; +import com.iab.openrtb.response.BidResponse; +import com.iab.openrtb.response.SeatBid; +import org.junit.jupiter.api.Test; +import org.prebid.server.VertxTest; +import org.prebid.server.bidder.model.BidderBid; +import org.prebid.server.bidder.model.BidderCall; +import org.prebid.server.bidder.model.BidderError; +import org.prebid.server.bidder.model.HttpRequest; +import org.prebid.server.bidder.model.HttpResponse; +import org.prebid.server.bidder.model.Result; +import org.prebid.server.proto.openrtb.ext.ExtPrebid; +import org.prebid.server.proto.openrtb.ext.request.goadserver.ExtImpGoadserver; +import org.prebid.server.proto.openrtb.ext.response.BidType; +import org.prebid.server.util.HttpUtil; + +import java.math.BigDecimal; +import java.util.List; +import java.util.function.UnaryOperator; + +import static java.util.Collections.singletonList; +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; +import static org.assertj.core.api.Assertions.tuple; +import static org.prebid.server.bidder.model.BidderError.badInput; +import static org.prebid.server.bidder.model.BidderError.badServerResponse; + +public class GoadserverBidderTest extends VertxTest { + + private static final String ENDPOINT_URL = "https://{Host}/openrtb2/auction"; + + private final GoadserverBidder target = new GoadserverBidder(ENDPOINT_URL, jacksonMapper); + + @Test + public void creationShouldFailOnInvalidEndpointUrl() { + assertThatIllegalArgumentException().isThrownBy(() -> new GoadserverBidder("invalid_url", jacksonMapper)); + } + + @Test + public void makeHttpRequestsShouldReturnErrorWhenSiteIsAbsent() { + // given + final BidRequest bidRequest = givenBidRequest(request -> request.site(null), givenImp("imp1", identity())); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).containsExactly(badInput("goadserver supports site requests only")); + } + + @Test + public void makeHttpRequestsShouldGroupImpsByHostAndToken() { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp("imp1", identity()), + givenImp("imp2", ext -> ExtImpGoadserver.of("ads.other.example", "tokB", null, null)), + givenImp("imp3", identity()), + givenImp("imp4", ext -> ExtImpGoadserver.of("ADS.Example.com", "tokC", null, null))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getUri, request -> request.getImpIds().stream().sorted().toList(), + request -> request.getPayload().getSite().getPublisher().getId()) + .containsExactly( + tuple("https://ads.example.com/openrtb2/auction", List.of("imp1", "imp3"), "tok123"), + tuple("https://ads.other.example/openrtb2/auction", List.of("imp2"), "tokB"), + tuple("https://ads.example.com/openrtb2/auction", List.of("imp4"), "tokC")); + } + + @Test + public void makeHttpRequestsShouldReplacePublisherIdAndKeepOtherPublisherFields() { + // given + final BidRequest bidRequest = givenBidRequest(givenImp("imp1", identity())); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .extracting(BidRequest::getSite) + .extracting(Site::getPublisher, Site::getPage) + .containsExactly(tuple(Publisher.builder().id("tok123").name("Publisher").build(), + "https://publisher.example/article")); + } + + @Test + public void makeHttpRequestsShouldCreatePublisherWhenAbsent() { + // given + final BidRequest bidRequest = givenBidRequest( + request -> request.site(Site.builder().page("https://publisher.example").build()), + givenImp("imp1", identity())); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()) + .extracting(request -> request.getPayload().getSite().getPublisher()) + .containsExactly(Publisher.builder().id("tok123").build()); + } + + @Test + public void makeHttpRequestsShouldApplyFloorOnlyWhenImpHasNone() { + // given + final Imp withoutFloor = givenImp("imp1", + ext -> ExtImpGoadserver.of("ads.example.com", "tok123", new BigDecimal("0.5"), null)); + final Imp withFloor = givenImp("imp2", + ext -> ExtImpGoadserver.of("ads.example.com", "tok123", new BigDecimal("0.5"), null)) + .toBuilder().bidfloor(new BigDecimal("1.2")).bidfloorcur("EUR").build(); + + // when + final Result>> result = + target.makeHttpRequests(givenBidRequest(withoutFloor, withFloor)); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .flatExtracting(request -> request.getPayload().getImp()) + .extracting(Imp::getId, Imp::getBidfloor, Imp::getBidfloorcur) + .containsExactly( + tuple("imp1", new BigDecimal("0.5"), "USD"), + tuple("imp2", new BigDecimal("1.2"), "EUR")); + } + + @Test + public void makeHttpRequestsShouldReplaceImpExtWithSubid() { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp("imp1", ext -> ExtImpGoadserver.of("ads.example.com", "tok123", null, + TextNode.valueOf("sports"))), + givenImp("imp2", ext -> ExtImpGoadserver.of("ads.example.com", "tok123", null, + IntNode.valueOf(42))), + givenImp("imp3", identity())); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .flatExtracting(request -> request.getPayload().getImp()) + .extracting(Imp::getExt) + .containsExactly(givenSubidExt("sports"), givenSubidExt("42"), null); + } + + @Test + public void makeHttpRequestsShouldRejectUnsafeHosts() { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp("imp1", ext -> ExtImpGoadserver.of("evil.example/path?x=1", "tok", null, null)), + givenImp("imp2", ext -> ExtImpGoadserver.of("ads.example.com:8080", "tok", null, null)), + givenImp("imp3", ext -> ExtImpGoadserver.of("user@ads.example.com", "tok", null, null)), + givenImp("imp4", ext -> ExtImpGoadserver.of("203.0.113.42", "tok", null, null)), + givenImp("imp5", ext -> ExtImpGoadserver.of("https://ads.example.com", "tok", null, null)), + givenImp("imp6", ext -> ExtImpGoadserver.of(null, "tok", null, null))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).containsExactly( + badInput("imp imp1: invalid host"), + badInput("imp imp2: invalid host"), + badInput("imp imp3: invalid host"), + badInput("imp imp4: invalid host"), + badInput("imp imp5: invalid host"), + badInput("imp imp6: invalid host")); + } + + @Test + public void makeHttpRequestsShouldReturnErrorForMissingTokenAndKeepValidImps() { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp("imp1", ext -> ExtImpGoadserver.of("ads.example.com", " ", null, null)), + givenImp("imp2", identity())); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).containsExactly(badInput("imp imp1: missing token")); + assertThat(result.getValue()).flatExtracting(HttpRequest::getImpIds).containsExactly("imp2"); + } + + @Test + public void makeHttpRequestsShouldReturnErrorForInvalidImpExt() { + // given + final Imp imp = Imp.builder().id("imp1").banner(Banner.builder().build()) + .ext(mapper.createObjectNode().put("bidder", "invalid")).build(); + + // when + final Result>> result = target.makeHttpRequests(givenBidRequest(imp)); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).containsExactly(badInput("imp imp1: invalid ext.bidder")); + } + + @Test + public void makeHttpRequestsShouldReturnErrorForMissingBidderExt() { + // given + final Imp imp = Imp.builder().id("imp1").banner(Banner.builder().build()) + .ext(mapper.createObjectNode()).build(); + + // when + final Result>> result = target.makeHttpRequests(givenBidRequest(imp)); + + // then + assertThat(result.getErrors()).containsExactly(badInput("imp imp1: missing ext.bidder")); + } + + @Test + public void makeHttpRequestsShouldSetOpenRtbVersionHeader() { + // when + final Result>> result = + target.makeHttpRequests(givenBidRequest(givenImp("imp1", identity()))); + + // then + assertThat(result.getValue()).singleElement() + .extracting(request -> request.getHeaders().get(HttpUtil.X_OPENRTB_VERSION_HEADER)) + .isEqualTo("2.5"); + } + + @Test + public void makeBidsShouldReturnErrorForInvalidResponse() { + // when + final Result> result = target.makeBids(givenHttpCall("invalid"), null); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).singleElement() + .extracting(BidderError::getType) + .isEqualTo(BidderError.Type.bad_server_response); + } + + @Test + public void makeBidsShouldReturnEmptyListForEmptySeatbid() throws JsonProcessingException { + // given + final String response = mapper.writeValueAsString(BidResponse.builder().cur("USD").build()); + + // when + final Result> result = target.makeBids(givenHttpCall(response), null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeBidsShouldResolveTypeFromMtype() throws JsonProcessingException { + // given + final String response = givenBidResponse("USD", + givenBid("b1", 1, null), givenBid("b2", 2, null), givenBid("b3", 4, null)); + + // when + final Result> result = target.makeBids(givenHttpCall(response), null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(BidderBid::getType) + .containsExactly(BidType.banner, BidType.video, BidType.xNative); + } + + @Test + public void makeBidsShouldFallBackToExtPrebidTypeAndStripTargeting() throws JsonProcessingException { + // given + final String response = givenBidResponse("USD", + givenBid("b1", null, givenPrebidExt("banner")), + givenBid("b2", null, givenPrebidExt("video")), + givenBid("b3", null, givenPrebidExt("native"))); + + // when + final Result> result = target.makeBids(givenHttpCall(response), null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(BidderBid::getType, bidderBid -> bidderBid.getBid().getExt()) + .containsExactly( + tuple(BidType.banner, null), + tuple(BidType.video, null), + tuple(BidType.xNative, null)); + } + + @Test + public void makeBidsShouldKeepOnlyDsaInBidExt() throws JsonProcessingException { + // given + final ObjectNode ext = givenPrebidExt("banner"); + final ObjectNode dsa = mapper.createObjectNode().put("behalf", "Advertiser").put("paid", "Advertiser"); + ext.set("dsa", dsa); + final String response = givenBidResponse("USD", givenBid("b1", null, ext)); + + // when + final Result> result = target.makeBids(givenHttpCall(response), null); + + // then + final ObjectNode expectedExt = mapper.createObjectNode(); + expectedExt.set("dsa", dsa); + assertThat(result.getValue()).singleElement() + .extracting(bidderBid -> bidderBid.getBid().getExt()) + .isEqualTo(expectedExt); + } + + @Test + public void makeBidsShouldReturnErrorForUnsupportedTypeAndKeepValidBids() throws JsonProcessingException { + // given + final Bid validBid = givenBid("b2", 1, null); + final String response = givenBidResponse("EUR", + givenBid("b1", 3, givenPrebidExt("audio")), validBid); + + // when + final Result> result = target.makeBids(givenHttpCall(response), null); + + // then + assertThat(result.getErrors()) + .containsExactly(badServerResponse("unsupported media type for bid b1 on imp imp1")); + assertThat(result.getValue()).containsExactly(BidderBid.of(validBid, BidType.banner, "EUR")); + } + + @Test + public void makeBidsShouldDefaultCurrencyToUsd() throws JsonProcessingException { + // given + final String response = givenBidResponse(null, givenBid("b1", 1, null)); + + // when + final Result> result = target.makeBids(givenHttpCall(response), null); + + // then + assertThat(result.getValue()).extracting(BidderBid::getBidCurrency).containsExactly("USD"); + } + + private static UnaryOperator identity() { + return ext -> ext; + } + + private static BidRequest givenBidRequest(Imp... imps) { + return givenBidRequest(request -> request, imps); + } + + private static BidRequest givenBidRequest(UnaryOperator requestCustomizer, + Imp... imps) { + + final Site site = Site.builder() + .page("https://publisher.example/article") + .publisher(Publisher.builder().id("pbs-account").name("Publisher").build()) + .build(); + return requestCustomizer.apply(BidRequest.builder().id("request-id").site(site).imp(List.of(imps))) + .build(); + } + + private static Imp givenImp(String impId, UnaryOperator extCustomizer) { + final ExtImpGoadserver ext = extCustomizer.apply(ExtImpGoadserver.of("ads.example.com", "tok123", null, null)); + return Imp.builder() + .id(impId) + .banner(Banner.builder().w(300).h(250).build()) + .ext(mapper.valueToTree(ExtPrebid.of(null, ext))) + .build(); + } + + private static ObjectNode givenSubidExt(String subid) { + final ObjectNode ext = mapper.createObjectNode(); + ext.putObject("goadserver").put("subid", subid); + return ext; + } + + private static ObjectNode givenPrebidExt(String type) { + final ObjectNode ext = mapper.createObjectNode(); + final ObjectNode prebid = ext.putObject("prebid").put("type", type); + prebid.putObject("targeting").put("hb_pb", "1.25").put("hb_bidder", "goadserver"); + return ext; + } + + private static Bid givenBid(String id, Integer mtype, ObjectNode ext) { + return Bid.builder().id(id).impid("imp1").price(BigDecimal.ONE).mtype(mtype).ext(ext).build(); + } + + private static String givenBidResponse(String currency, Bid... bids) throws JsonProcessingException { + return mapper.writeValueAsString(BidResponse.builder() + .cur(currency) + .seatbid(singletonList(SeatBid.builder().bid(List.of(bids)).build())) + .build()); + } + + private static BidderCall givenHttpCall(String body) { + return BidderCall.succeededHttp( + HttpRequest.builder().build(), + HttpResponse.of(200, null, body), + null); + } +} diff --git a/src/test/java/org/prebid/server/it/GoadserverTest.java b/src/test/java/org/prebid/server/it/GoadserverTest.java new file mode 100644 index 00000000000..e8560d634fe --- /dev/null +++ b/src/test/java/org/prebid/server/it/GoadserverTest.java @@ -0,0 +1,34 @@ +package org.prebid.server.it; + +import io.restassured.response.Response; +import org.json.JSONException; +import org.junit.jupiter.api.Test; +import org.prebid.server.model.Endpoint; + +import java.io.IOException; + +import static com.github.tomakehurst.wiremock.client.WireMock.aResponse; +import static com.github.tomakehurst.wiremock.client.WireMock.equalToJson; +import static com.github.tomakehurst.wiremock.client.WireMock.post; +import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; +import static java.util.Collections.singletonList; + +public class GoadserverTest extends IntegrationTest { + + @Test + public void openrtb2AuctionShouldRespondWithBidsFromGoadserver() throws IOException, JSONException { + // given + WIRE_MOCK_RULE.stubFor(post(urlPathEqualTo("/goadserver-exchange")) + .withRequestBody(equalToJson(jsonFrom("openrtb2/goadserver/test-goadserver-bid-request.json"))) + .willReturn(aResponse() + .withBody(jsonFrom("openrtb2/goadserver/test-goadserver-bid-response.json")))); + + // when + final Response response = responseFor("openrtb2/goadserver/test-auction-goadserver-request.json", + Endpoint.openrtb2_auction); + + // then + assertJsonEquals("openrtb2/goadserver/test-auction-goadserver-response.json", response, + singletonList("goadserver")); + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-auction-goadserver-request.json b/src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-auction-goadserver-request.json new file mode 100644 index 00000000000..9849be8a645 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-auction-goadserver-request.json @@ -0,0 +1,25 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "banner": { + "w": 300, + "h": 250 + }, + "ext": { + "goadserver": { + "host": "ads.example.com", + "token": "test-token", + "subid": "sports" + } + } + } + ], + "tmax": 5000, + "regs": { + "ext": { + "gdpr": 0 + } + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-auction-goadserver-response.json b/src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-auction-goadserver-response.json new file mode 100644 index 00000000000..cbdc3722b22 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-auction-goadserver-response.json @@ -0,0 +1,43 @@ +{ + "id": "request_id", + "seatbid": [ + { + "bid": [ + { + "id": "bid_id", + "impid": "imp_id", + "exp": 300, + "price": 3.33, + "adm": "adm001", + "adid": "adid", + "cid": "cid", + "crid": "crid", + "w": 300, + "h": 250, + "ext": { + "prebid": { + "type": "banner", + "meta": { + "adaptercode": "goadserver" + } + }, + "origbidcpm": 3.33, + "origbidcur": "USD" + } + } + ], + "seat": "goadserver", + "group": 0 + } + ], + "cur": "USD", + "ext": { + "responsetimemillis": { + "goadserver": "{{ goadserver.response_time_ms }}" + }, + "prebid": { + "auctiontimestamp": 0 + }, + "tmaxrequest": 5000 + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-goadserver-bid-request.json b/src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-goadserver-bid-request.json new file mode 100644 index 00000000000..f03653dc1ec --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-goadserver-bid-request.json @@ -0,0 +1,57 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "secure": 1, + "banner": { + "w": 300, + "h": 250 + }, + "ext": { + "goadserver": { + "subid": "sports" + } + } + } + ], + "site": { + "domain": "www.example.com", + "page": "http://www.example.com", + "publisher": { + "id": "test-token", + "domain": "example.com" + }, + "ext": { + "amp": 0 + } + }, + "device": { + "ua": "userAgent", + "ip": "193.168.244.1" + }, + "at": 1, + "tmax": "${json-unit.any-number}", + "cur": [ + "USD" + ], + "source": { + "tid": "${json-unit.any-string}" + }, + "regs": { + "ext": { + "gdpr": 0 + } + }, + "ext": { + "prebid": { + "server": { + "externalurl": "http://localhost:8080", + "gvlid": 1, + "datacenter": "local", + "http_method" : "POST", + "endpoint": "/openrtb2/auction" + } + } + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-goadserver-bid-response.json b/src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-goadserver-bid-response.json new file mode 100644 index 00000000000..268934ecba7 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-goadserver-bid-response.json @@ -0,0 +1,31 @@ +{ + "id": "request_id", + "seatbid": [ + { + "seat": "goadserver", + "bid": [ + { + "id": "bid_id", + "impid": "imp_id", + "price": 3.33, + "adid": "adid", + "crid": "crid", + "cid": "cid", + "adm": "adm001", + "h": 250, + "w": 300, + "ext": { + "prebid": { + "type": "banner", + "targeting": { + "hb_pb": "3.33", + "hb_bidder": "goadserver" + } + } + } + } + ] + } + ], + "cur": "USD" +} diff --git a/src/test/resources/org/prebid/server/it/test-application.properties b/src/test/resources/org/prebid/server/it/test-application.properties index cc1a749d4ba..7229c55faef 100644 --- a/src/test/resources/org/prebid/server/it/test-application.properties +++ b/src/test/resources/org/prebid/server/it/test-application.properties @@ -290,6 +290,8 @@ adapters.gamoshi.enabled=true adapters.gamoshi.endpoint=http://localhost:8090/gamoshi-exchange adapters.globalsun.enabled=true adapters.globalsun.endpoint=http://localhost:8090/globalsun-exchange +adapters.goadserver.enabled=true +adapters.goadserver.endpoint=http://localhost:8090/goadserver-exchange adapters.gothamads.enabled=true adapters.gothamads.endpoint=http://localhost:8090/gothamads-exchange adapters.gothamads.aliases.intenze.enabled=true From bc664aa7bfaefa3e7d5c70e42cae286bca1a1bb2 Mon Sep 17 00:00:00 2001 From: Jan Date: Tue, 6 Oct 2026 16:19:17 +0200 Subject: [PATCH 2/3] GoAdserver: send to the fixed GoAdserver gateway instead of a host param Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01Logb1f3FNVSzPCTMtqNc8A --- .../bidder/goadserver/GoadserverBidder.java | 50 +++++------------ .../request/goadserver/ExtImpGoadserver.java | 2 - .../resources/bidder-config/goadserver.yaml | 2 +- .../static/bidder-params/goadserver.json | 9 +--- .../goadserver/GoadserverBidderTest.java | 54 +++++-------------- .../test-auction-goadserver-request.json | 1 - 6 files changed, 30 insertions(+), 88 deletions(-) diff --git a/src/main/java/org/prebid/server/bidder/goadserver/GoadserverBidder.java b/src/main/java/org/prebid/server/bidder/goadserver/GoadserverBidder.java index 61099609ef9..1f56626e343 100644 --- a/src/main/java/org/prebid/server/bidder/goadserver/GoadserverBidder.java +++ b/src/main/java/org/prebid/server/bidder/goadserver/GoadserverBidder.java @@ -27,7 +27,6 @@ import org.prebid.server.proto.openrtb.ext.response.BidType; import org.prebid.server.util.BidderUtil; import org.prebid.server.util.HttpUtil; -import org.prebid.server.util.Uri; import java.math.BigDecimal; import java.util.ArrayList; @@ -35,15 +34,13 @@ import java.util.Collections; import java.util.LinkedHashMap; import java.util.List; -import java.util.Locale; import java.util.Map; import java.util.Objects; -import java.util.regex.Pattern; /** - * GoAdserver is a self-hosted, multi-tenant ad server. Every deployment runs under its own domain, so the - * endpoint host and the publisher token are per-impression params. Impressions are grouped by (host, token) - * and each group is sent to https://{host}/openrtb2/auction with the token in site.publisher.id. + * GoAdserver is a self-hosted, multi-tenant ad server. All requests go to one fixed GoAdserver gateway, which + * routes each to the publisher's deployment by the publisher token. Impressions are grouped by token and each + * group is sent with its token in site.publisher.id. */ public class GoadserverBidder implements Bidder { @@ -51,19 +48,14 @@ public class GoadserverBidder implements Bidder { new TypeReference<>() { }; - private static final String HOST_MACRO = "Host"; private static final String DEFAULT_CURRENCY = "USD"; private static final String DSA_FIELD = "dsa"; - // A bare hostname only: no scheme, port, path or userinfo, and no IP literal. - private static final Pattern HOST_PATTERN = - Pattern.compile("^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$"); - - private final Uri endpointUrl; + private final String endpointUrl; private final JacksonMapper mapper; public GoadserverBidder(String endpointUrl, JacksonMapper mapper) { - this.endpointUrl = Uri.of(endpointUrl); + this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl)); this.mapper = Objects.requireNonNull(mapper); } @@ -74,20 +66,19 @@ public Result>> makeHttpRequests(BidRequest request } final List errors = new ArrayList<>(); - final Map> impsByGroup = new LinkedHashMap<>(); + final Map> impsByToken = new LinkedHashMap<>(); for (Imp imp : request.getImp()) { try { final ExtImpGoadserver extImp = parseImpExt(imp); - final GroupKey key = new GroupKey(normalizeHost(extImp.getHost(), imp.getId()), - validateToken(extImp.getToken(), imp.getId())); - impsByGroup.computeIfAbsent(key, _ -> new ArrayList<>()).add(modifyImp(imp, extImp)); + final String token = validateToken(extImp.getToken(), imp.getId()); + impsByToken.computeIfAbsent(token, _ -> new ArrayList<>()).add(modifyImp(imp, extImp)); } catch (PreBidException e) { errors.add(BidderError.badInput(e.getMessage())); } } - final List> httpRequests = impsByGroup.entrySet().stream() + final List> httpRequests = impsByToken.entrySet().stream() .map(entry -> makeHttpRequest(request, entry.getKey(), entry.getValue())) .toList(); @@ -108,19 +99,11 @@ private ExtImpGoadserver parseImpExt(Imp imp) { } } - private static String normalizeHost(String host, String impId) { - final String normalized = StringUtils.trimToEmpty(host).toLowerCase(Locale.ROOT); - if (!HOST_PATTERN.matcher(normalized).matches()) { - throw new PreBidException("imp %s: invalid host".formatted(impId)); - } - return normalized; - } - private static String validateToken(String token, String impId) { if (StringUtils.isBlank(token)) { throw new PreBidException("imp %s: missing token".formatted(impId)); } - return token; + return token.trim(); } private Imp modifyImp(Imp imp, ExtImpGoadserver extImp) { @@ -144,16 +127,16 @@ private ObjectNode makeImpExt(JsonNode subid) { return impExt; } - private HttpRequest makeHttpRequest(BidRequest request, GroupKey key, List imps) { + private HttpRequest makeHttpRequest(BidRequest request, String token, List imps) { final BidRequest outgoingRequest = request.toBuilder() .imp(imps) - .site(modifySite(request.getSite(), key.token())) + .site(modifySite(request.getSite(), token)) .build(); final MultiMap headers = HttpUtil.headers() .add(HttpUtil.X_OPENRTB_VERSION_HEADER, "2.5"); - return BidderUtil.defaultRequest(outgoingRequest, headers, resolveEndpoint(key.host()), mapper); + return BidderUtil.defaultRequest(outgoingRequest, headers, endpointUrl, mapper); } private static Site modifySite(Site site, String token) { @@ -164,10 +147,6 @@ private static Site modifySite(Site site, String token) { return site.toBuilder().publisher(modifiedPublisher).build(); } - private String resolveEndpoint(String host) { - return endpointUrl.replaceMacro(HOST_MACRO, host).expand(); - } - @Override public Result> makeBids(BidderCall httpCall, BidRequest bidRequest) { try { @@ -238,7 +217,4 @@ private ObjectNode keepDsa(ObjectNode ext) { modifiedExt.set(DSA_FIELD, dsa); return modifiedExt; } - - private record GroupKey(String host, String token) { - } } diff --git a/src/main/java/org/prebid/server/proto/openrtb/ext/request/goadserver/ExtImpGoadserver.java b/src/main/java/org/prebid/server/proto/openrtb/ext/request/goadserver/ExtImpGoadserver.java index 60488dd5841..64bd5cfa4d2 100644 --- a/src/main/java/org/prebid/server/proto/openrtb/ext/request/goadserver/ExtImpGoadserver.java +++ b/src/main/java/org/prebid/server/proto/openrtb/ext/request/goadserver/ExtImpGoadserver.java @@ -8,8 +8,6 @@ @Value(staticConstructor = "of") public class ExtImpGoadserver { - String host; - String token; BigDecimal floor; diff --git a/src/main/resources/bidder-config/goadserver.yaml b/src/main/resources/bidder-config/goadserver.yaml index ba6dc464b0e..588e8af0acb 100644 --- a/src/main/resources/bidder-config/goadserver.yaml +++ b/src/main/resources/bidder-config/goadserver.yaml @@ -1,6 +1,6 @@ adapters: goadserver: - endpoint: https://{Host}/openrtb2/auction + endpoint: https://pbs.goadserver.com/openrtb2/auction meta-info: maintainer-email: support@goadserver.com app-media-types: diff --git a/src/main/resources/static/bidder-params/goadserver.json b/src/main/resources/static/bidder-params/goadserver.json index f65234a3946..a93c32a745b 100644 --- a/src/main/resources/static/bidder-params/goadserver.json +++ b/src/main/resources/static/bidder-params/goadserver.json @@ -4,14 +4,9 @@ "description": "A schema which validates params accepted by the GoAdserver adapter", "type": "object", "properties": { - "host": { - "type": "string", - "description": "Public domain of the publisher's GoAdserver deployment. Requests are sent to https://{host}/openrtb2/auction", - "pattern": "^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$" - }, "token": { "type": "string", - "description": "SSP campaign authentication token from the publisher's GoAdserver panel", + "description": "Publisher token from the GoAdserver panel. The GoAdserver gateway routes the request to the publisher's deployment by this token", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$" @@ -26,5 +21,5 @@ "description": "Sub-identifier for stats attribution (page section, A/B group, etc.)" } }, - "required": ["host", "token"] + "required": ["token"] } diff --git a/src/test/java/org/prebid/server/bidder/goadserver/GoadserverBidderTest.java b/src/test/java/org/prebid/server/bidder/goadserver/GoadserverBidderTest.java index b299e66761a..b554d1b6ac9 100644 --- a/src/test/java/org/prebid/server/bidder/goadserver/GoadserverBidderTest.java +++ b/src/test/java/org/prebid/server/bidder/goadserver/GoadserverBidderTest.java @@ -27,6 +27,7 @@ import java.math.BigDecimal; import java.util.List; +import java.util.Set; import java.util.function.UnaryOperator; import static java.util.Collections.singletonList; @@ -38,7 +39,7 @@ public class GoadserverBidderTest extends VertxTest { - private static final String ENDPOINT_URL = "https://{Host}/openrtb2/auction"; + private static final String ENDPOINT_URL = "https://pbs.goadserver.com/openrtb2/auction"; private final GoadserverBidder target = new GoadserverBidder(ENDPOINT_URL, jacksonMapper); @@ -61,13 +62,12 @@ public void makeHttpRequestsShouldReturnErrorWhenSiteIsAbsent() { } @Test - public void makeHttpRequestsShouldGroupImpsByHostAndToken() { + public void makeHttpRequestsShouldGroupImpsByToken() { // given final BidRequest bidRequest = givenBidRequest( givenImp("imp1", identity()), - givenImp("imp2", ext -> ExtImpGoadserver.of("ads.other.example", "tokB", null, null)), - givenImp("imp3", identity()), - givenImp("imp4", ext -> ExtImpGoadserver.of("ADS.Example.com", "tokC", null, null))); + givenImp("imp2", ext -> ExtImpGoadserver.of("tokB", null, null)), + givenImp("imp3", identity())); // when final Result>> result = target.makeHttpRequests(bidRequest); @@ -75,12 +75,11 @@ public void makeHttpRequestsShouldGroupImpsByHostAndToken() { // then assertThat(result.getErrors()).isEmpty(); assertThat(result.getValue()) - .extracting(HttpRequest::getUri, request -> request.getImpIds().stream().sorted().toList(), + .extracting(HttpRequest::getUri, HttpRequest::getImpIds, request -> request.getPayload().getSite().getPublisher().getId()) .containsExactly( - tuple("https://ads.example.com/openrtb2/auction", List.of("imp1", "imp3"), "tok123"), - tuple("https://ads.other.example/openrtb2/auction", List.of("imp2"), "tokB"), - tuple("https://ads.example.com/openrtb2/auction", List.of("imp4"), "tokC")); + tuple(ENDPOINT_URL, Set.of("imp1", "imp3"), "tok123"), + tuple(ENDPOINT_URL, Set.of("imp2"), "tokB")); } @Test @@ -121,9 +120,9 @@ public void makeHttpRequestsShouldCreatePublisherWhenAbsent() { public void makeHttpRequestsShouldApplyFloorOnlyWhenImpHasNone() { // given final Imp withoutFloor = givenImp("imp1", - ext -> ExtImpGoadserver.of("ads.example.com", "tok123", new BigDecimal("0.5"), null)); + ext -> ExtImpGoadserver.of("tok123", new BigDecimal("0.5"), null)); final Imp withFloor = givenImp("imp2", - ext -> ExtImpGoadserver.of("ads.example.com", "tok123", new BigDecimal("0.5"), null)) + ext -> ExtImpGoadserver.of("tok123", new BigDecimal("0.5"), null)) .toBuilder().bidfloor(new BigDecimal("1.2")).bidfloorcur("EUR").build(); // when @@ -144,9 +143,9 @@ public void makeHttpRequestsShouldApplyFloorOnlyWhenImpHasNone() { public void makeHttpRequestsShouldReplaceImpExtWithSubid() { // given final BidRequest bidRequest = givenBidRequest( - givenImp("imp1", ext -> ExtImpGoadserver.of("ads.example.com", "tok123", null, + givenImp("imp1", ext -> ExtImpGoadserver.of("tok123", null, TextNode.valueOf("sports"))), - givenImp("imp2", ext -> ExtImpGoadserver.of("ads.example.com", "tok123", null, + givenImp("imp2", ext -> ExtImpGoadserver.of("tok123", null, IntNode.valueOf(42))), givenImp("imp3", identity())); @@ -161,36 +160,11 @@ public void makeHttpRequestsShouldReplaceImpExtWithSubid() { .containsExactly(givenSubidExt("sports"), givenSubidExt("42"), null); } - @Test - public void makeHttpRequestsShouldRejectUnsafeHosts() { - // given - final BidRequest bidRequest = givenBidRequest( - givenImp("imp1", ext -> ExtImpGoadserver.of("evil.example/path?x=1", "tok", null, null)), - givenImp("imp2", ext -> ExtImpGoadserver.of("ads.example.com:8080", "tok", null, null)), - givenImp("imp3", ext -> ExtImpGoadserver.of("user@ads.example.com", "tok", null, null)), - givenImp("imp4", ext -> ExtImpGoadserver.of("203.0.113.42", "tok", null, null)), - givenImp("imp5", ext -> ExtImpGoadserver.of("https://ads.example.com", "tok", null, null)), - givenImp("imp6", ext -> ExtImpGoadserver.of(null, "tok", null, null))); - - // when - final Result>> result = target.makeHttpRequests(bidRequest); - - // then - assertThat(result.getValue()).isEmpty(); - assertThat(result.getErrors()).containsExactly( - badInput("imp imp1: invalid host"), - badInput("imp imp2: invalid host"), - badInput("imp imp3: invalid host"), - badInput("imp imp4: invalid host"), - badInput("imp imp5: invalid host"), - badInput("imp imp6: invalid host")); - } - @Test public void makeHttpRequestsShouldReturnErrorForMissingTokenAndKeepValidImps() { // given final BidRequest bidRequest = givenBidRequest( - givenImp("imp1", ext -> ExtImpGoadserver.of("ads.example.com", " ", null, null)), + givenImp("imp1", ext -> ExtImpGoadserver.of(" ", null, null)), givenImp("imp2", identity())); // when @@ -369,7 +343,7 @@ private static BidRequest givenBidRequest(UnaryOperator extCustomizer) { - final ExtImpGoadserver ext = extCustomizer.apply(ExtImpGoadserver.of("ads.example.com", "tok123", null, null)); + final ExtImpGoadserver ext = extCustomizer.apply(ExtImpGoadserver.of("tok123", null, null)); return Imp.builder() .id(impId) .banner(Banner.builder().w(300).h(250).build()) diff --git a/src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-auction-goadserver-request.json b/src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-auction-goadserver-request.json index 9849be8a645..bba60f28413 100644 --- a/src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-auction-goadserver-request.json +++ b/src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-auction-goadserver-request.json @@ -9,7 +9,6 @@ }, "ext": { "goadserver": { - "host": "ads.example.com", "token": "test-token", "subid": "sports" } From af61faee1bc47cdcdb22d6084e5383a10e839a06 Mon Sep 17 00:00:00 2001 From: Jan Date: Fri, 16 Oct 2026 17:22:50 +0200 Subject: [PATCH 3/3] GoAdserver: support app requests The GoAdserver endpoint accepts OpenRTB app requests (bundle, store url, device.ifa/lmt, instl, rwdd) on the same gateway, so the bidder now takes a site or an app: the publisher token goes on app.publisher.id when there is no site. Bidder config declares app banner, video and native. Co-Authored-By: Claude Opus 5.5 --- .../bidder/goadserver/GoadserverBidder.java | 30 ++++++---- .../resources/bidder-config/goadserver.yaml | 3 + .../goadserver/GoadserverBidderTest.java | 47 +++++++++++++++- .../org/prebid/server/it/GoadserverTest.java | 17 ++++++ .../test-auction-goadserver-app-request.json | 33 +++++++++++ .../test-goadserver-app-bid-request.json | 56 +++++++++++++++++++ 6 files changed, 174 insertions(+), 12 deletions(-) create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-auction-goadserver-app-request.json create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-goadserver-app-bid-request.json diff --git a/src/main/java/org/prebid/server/bidder/goadserver/GoadserverBidder.java b/src/main/java/org/prebid/server/bidder/goadserver/GoadserverBidder.java index 1f56626e343..828c4444df8 100644 --- a/src/main/java/org/prebid/server/bidder/goadserver/GoadserverBidder.java +++ b/src/main/java/org/prebid/server/bidder/goadserver/GoadserverBidder.java @@ -3,6 +3,7 @@ import com.fasterxml.jackson.core.type.TypeReference; import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.node.ObjectNode; +import com.iab.openrtb.request.App; import com.iab.openrtb.request.BidRequest; import com.iab.openrtb.request.Imp; import com.iab.openrtb.request.Publisher; @@ -40,7 +41,7 @@ /** * GoAdserver is a self-hosted, multi-tenant ad server. All requests go to one fixed GoAdserver gateway, which * routes each to the publisher's deployment by the publisher token. Impressions are grouped by token and each - * group is sent with its token in site.publisher.id. + * group is sent with its token in site.publisher.id, or app.publisher.id for in-app requests. */ public class GoadserverBidder implements Bidder { @@ -61,8 +62,8 @@ public GoadserverBidder(String endpointUrl, JacksonMapper mapper) { @Override public Result>> makeHttpRequests(BidRequest request) { - if (request.getSite() == null) { - return Result.withError(BidderError.badInput("goadserver supports site requests only")); + if (request.getSite() == null && request.getApp() == null) { + return Result.withError(BidderError.badInput("goadserver needs a site or an app object")); } final List errors = new ArrayList<>(); @@ -128,10 +129,13 @@ private ObjectNode makeImpExt(JsonNode subid) { } private HttpRequest makeHttpRequest(BidRequest request, String token, List imps) { - final BidRequest outgoingRequest = request.toBuilder() - .imp(imps) - .site(modifySite(request.getSite(), token)) - .build(); + final BidRequest.BidRequestBuilder builder = request.toBuilder().imp(imps); + if (request.getSite() != null) { + builder.site(modifySite(request.getSite(), token)); + } else { + builder.app(modifyApp(request.getApp(), token)); + } + final BidRequest outgoingRequest = builder.build(); final MultiMap headers = HttpUtil.headers() .add(HttpUtil.X_OPENRTB_VERSION_HEADER, "2.5"); @@ -140,11 +144,17 @@ private HttpRequest makeHttpRequest(BidRequest request, String token } private static Site modifySite(Site site, String token) { - final Publisher publisher = site.getPublisher(); - final Publisher modifiedPublisher = publisher != null + return site.toBuilder().publisher(withToken(site.getPublisher(), token)).build(); + } + + private static App modifyApp(App app, String token) { + return app.toBuilder().publisher(withToken(app.getPublisher(), token)).build(); + } + + private static Publisher withToken(Publisher publisher, String token) { + return publisher != null ? publisher.toBuilder().id(token).build() : Publisher.builder().id(token).build(); - return site.toBuilder().publisher(modifiedPublisher).build(); } @Override diff --git a/src/main/resources/bidder-config/goadserver.yaml b/src/main/resources/bidder-config/goadserver.yaml index 588e8af0acb..761385344fe 100644 --- a/src/main/resources/bidder-config/goadserver.yaml +++ b/src/main/resources/bidder-config/goadserver.yaml @@ -4,6 +4,9 @@ adapters: meta-info: maintainer-email: support@goadserver.com app-media-types: + - banner + - video + - native site-media-types: - banner - video diff --git a/src/test/java/org/prebid/server/bidder/goadserver/GoadserverBidderTest.java b/src/test/java/org/prebid/server/bidder/goadserver/GoadserverBidderTest.java index b554d1b6ac9..3cebefa3357 100644 --- a/src/test/java/org/prebid/server/bidder/goadserver/GoadserverBidderTest.java +++ b/src/test/java/org/prebid/server/bidder/goadserver/GoadserverBidderTest.java @@ -4,6 +4,7 @@ import com.fasterxml.jackson.databind.node.IntNode; import com.fasterxml.jackson.databind.node.ObjectNode; import com.fasterxml.jackson.databind.node.TextNode; +import com.iab.openrtb.request.App; import com.iab.openrtb.request.Banner; import com.iab.openrtb.request.BidRequest; import com.iab.openrtb.request.Imp; @@ -49,7 +50,7 @@ public void creationShouldFailOnInvalidEndpointUrl() { } @Test - public void makeHttpRequestsShouldReturnErrorWhenSiteIsAbsent() { + public void makeHttpRequestsShouldReturnErrorWhenSiteAndAppAreAbsent() { // given final BidRequest bidRequest = givenBidRequest(request -> request.site(null), givenImp("imp1", identity())); @@ -58,7 +59,49 @@ public void makeHttpRequestsShouldReturnErrorWhenSiteIsAbsent() { // then assertThat(result.getValue()).isEmpty(); - assertThat(result.getErrors()).containsExactly(badInput("goadserver supports site requests only")); + assertThat(result.getErrors()).containsExactly(badInput("goadserver needs a site or an app object")); + } + + @Test + public void makeHttpRequestsShouldPutTokenOnAppPublisherForAppRequests() { + // given + final App app = App.builder() + .bundle("com.example.trails") + .publisher(Publisher.builder().id("pbs-account").name("Example Apps").build()) + .build(); + final BidRequest bidRequest = givenBidRequest( + request -> request.site(null).app(app), + givenImp("imp1", identity())); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .extracting(BidRequest::getSite, BidRequest::getApp) + .containsExactly(tuple(null, App.builder() + .bundle("com.example.trails") + .publisher(Publisher.builder().id("tok123").name("Example Apps").build()) + .build())); + assertThat(app.getPublisher().getId()).isEqualTo("pbs-account"); + } + + @Test + public void makeHttpRequestsShouldCreateAppPublisherWhenAbsent() { + // given + final BidRequest bidRequest = givenBidRequest( + request -> request.site(null).app(App.builder().bundle("com.example.trails").build()), + givenImp("imp1", identity())); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()) + .extracting(request -> request.getPayload().getApp().getPublisher()) + .containsExactly(Publisher.builder().id("tok123").build()); } @Test diff --git a/src/test/java/org/prebid/server/it/GoadserverTest.java b/src/test/java/org/prebid/server/it/GoadserverTest.java index e8560d634fe..00a235119be 100644 --- a/src/test/java/org/prebid/server/it/GoadserverTest.java +++ b/src/test/java/org/prebid/server/it/GoadserverTest.java @@ -31,4 +31,21 @@ public void openrtb2AuctionShouldRespondWithBidsFromGoadserver() throws IOExcept assertJsonEquals("openrtb2/goadserver/test-auction-goadserver-response.json", response, singletonList("goadserver")); } + + @Test + public void openrtb2AuctionShouldRespondWithBidsFromGoadserverForAppRequest() throws IOException, JSONException { + // given + WIRE_MOCK_RULE.stubFor(post(urlPathEqualTo("/goadserver-exchange")) + .withRequestBody(equalToJson(jsonFrom("openrtb2/goadserver/test-goadserver-app-bid-request.json"))) + .willReturn(aResponse() + .withBody(jsonFrom("openrtb2/goadserver/test-goadserver-bid-response.json")))); + + // when + final Response response = responseFor("openrtb2/goadserver/test-auction-goadserver-app-request.json", + Endpoint.openrtb2_auction); + + // then + assertJsonEquals("openrtb2/goadserver/test-auction-goadserver-response.json", response, + singletonList("goadserver")); + } } diff --git a/src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-auction-goadserver-app-request.json b/src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-auction-goadserver-app-request.json new file mode 100644 index 00000000000..0f3e66e44bb --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-auction-goadserver-app-request.json @@ -0,0 +1,33 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "banner": { + "w": 300, + "h": 250 + }, + "ext": { + "goadserver": { + "token": "test-token", + "subid": "sports" + } + } + } + ], + "tmax": 5000, + "regs": { + "ext": { + "gdpr": 0 + } + }, + "app": { + "bundle": "com.example.trails", + "publisher": { + "id": "pbs-account" + } + }, + "device": { + "ifa": "87857b31-8942-4646-ae80-ab9c95bf3fab" + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-goadserver-app-bid-request.json b/src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-goadserver-app-bid-request.json new file mode 100644 index 00000000000..a7530447e92 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/goadserver/test-goadserver-app-bid-request.json @@ -0,0 +1,56 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "secure": 1, + "banner": { + "w": 300, + "h": 250 + }, + "ext": { + "goadserver": { + "subid": "sports" + } + } + } + ], + "app": { + "bundle": "com.example.trails", + "publisher": { + "id": "test-token" + } + }, + "device": { + "ua": "userAgent", + "ip": "193.168.244.1", + "ifa": "87857b31-8942-4646-ae80-ab9c95bf3fab" + }, + "at": 1, + "tmax": "${json-unit.any-number}", + "cur": [ + "USD" + ], + "source": { + "tid": "${json-unit.any-string}" + }, + "regs": { + "ext": { + "gdpr": 0 + } + }, + "ext": { + "prebid": { + "channel": { + "name": "app" + }, + "server": { + "externalurl": "http://localhost:8080", + "gvlid": 1, + "datacenter": "local", + "http_method": "POST", + "endpoint": "/openrtb2/auction" + } + } + } +}