diff --git a/src/main/java/org/prebid/server/bidder/adplayx/AdplayxBidder.java b/src/main/java/org/prebid/server/bidder/adplayx/AdplayxBidder.java new file mode 100644 index 00000000000..be73a28f0e6 --- /dev/null +++ b/src/main/java/org/prebid/server/bidder/adplayx/AdplayxBidder.java @@ -0,0 +1,150 @@ +package org.prebid.server.bidder.adplayx; + +import com.fasterxml.jackson.core.type.TypeReference; +import com.iab.openrtb.request.BidRequest; +import com.iab.openrtb.request.Imp; +import com.iab.openrtb.response.Bid; +import com.iab.openrtb.response.BidResponse; +import com.iab.openrtb.response.SeatBid; +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.adplayx.ExtImpAdplayx; +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.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import java.util.Objects; + +public class AdplayxBidder implements Bidder { + + private static final TypeReference> ADPLAYX_EXT_TYPE_REFERENCE = + new TypeReference<>() { + }; + + private final Uri endpointUri; + private final JacksonMapper mapper; + + public AdplayxBidder(String endpointUrl, JacksonMapper mapper) { + this.endpointUri = Uri.of(HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl))); + this.mapper = Objects.requireNonNull(mapper); + } + + @Override + public Result>> makeHttpRequests(BidRequest request) { + final List errors = new ArrayList<>(); + final List> httpRequests = new ArrayList<>(); + + for (Imp imp : request.getImp()) { + try { + final ExtImpAdplayx extImp = parseImpExt(imp); + + if (StringUtils.isBlank(extImp.getApptoken())) { + errors.add(BidderError.badInput("apptoken is required")); + continue; + } + + final String uri = buildEndpointUrl(extImp); + + final BidRequest outgoingRequest = request.toBuilder() + .imp(Collections.singletonList(imp)) + .build(); + + httpRequests.add(BidderUtil.defaultRequest(outgoingRequest, uri, mapper)); + } catch (PreBidException e) { + errors.add(BidderError.badInput(e.getMessage())); + } + } + + return Result.of(httpRequests, errors); + } + + private ExtImpAdplayx parseImpExt(Imp imp) { + try { + return mapper.mapper().convertValue(imp.getExt(), ADPLAYX_EXT_TYPE_REFERENCE).getBidder(); + } catch (IllegalArgumentException e) { + throw new PreBidException("Error parsing imp.ext: " + e.getMessage()); + } + } + + private String buildEndpointUrl(ExtImpAdplayx extImp) { + return endpointUri.parameterized() + .addQueryParam("apptoken", extImp.getApptoken()) + .addQueryParam("placementid", StringUtils.trimToNull(extImp.getPlacementid())) + .toString(); + } + + @Override + public Result> makeBids(BidderCall httpCall, BidRequest bidRequest) { + final List errors = new ArrayList<>(); + try { + final BidResponse bidResponse = mapper.decodeValue(httpCall.getResponse().getBody(), BidResponse.class); + final List imps = httpCall.getRequest().getPayload().getImp(); + final List bidderBids = extractBids(bidResponse, errors, imps); + return Result.of(bidderBids, errors); + } catch (DecodeException e) { + return Result.withError(BidderError.badServerResponse(e.getMessage())); + } + } + + private List extractBids(BidResponse bidResponse, List errors, List imps) { + if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) { + return Collections.emptyList(); + } + + return bidResponse.getSeatbid().stream() + .filter(Objects::nonNull) + .map(SeatBid::getBid) + .filter(Objects::nonNull) + .flatMap(Collection::stream) + .filter(Objects::nonNull) + .map(bid -> resolveBidderBid(bidResponse.getCur(), imps, bid, errors)) + .filter(Objects::nonNull) + .toList(); + } + + private BidderBid resolveBidderBid(String currency, List imps, Bid bid, List errors) { + final BidType bidType; + try { + bidType = getBidType(bid.getImpid(), imps); + } catch (PreBidException e) { + errors.add(BidderError.badServerResponse(e.getMessage())); + return null; + } + return BidderBid.of(bid, bidType, currency); + } + + private BidType getBidType(String impId, List imps) { + for (Imp imp : imps) { + if (imp.getId().equals(impId)) { + if (imp.getBanner() != null) { + return BidType.banner; + } + if (imp.getVideo() != null) { + return BidType.video; + } + if (imp.getAudio() != null) { + return BidType.audio; + } + if (imp.getXNative() != null) { + return BidType.xNative; + } + } + } + throw new PreBidException("Failed to find impression \"%s\"".formatted(impId)); + } +} diff --git a/src/main/java/org/prebid/server/proto/openrtb/ext/request/adplayx/ExtImpAdplayx.java b/src/main/java/org/prebid/server/proto/openrtb/ext/request/adplayx/ExtImpAdplayx.java new file mode 100644 index 00000000000..de72164c28a --- /dev/null +++ b/src/main/java/org/prebid/server/proto/openrtb/ext/request/adplayx/ExtImpAdplayx.java @@ -0,0 +1,11 @@ +package org.prebid.server.proto.openrtb.ext.request.adplayx; + +import lombok.Value; + +@Value(staticConstructor = "of") +public class ExtImpAdplayx { + + String apptoken; + + String placementid; +} diff --git a/src/main/java/org/prebid/server/spring/config/bidder/AdplayxConfiguration.java b/src/main/java/org/prebid/server/spring/config/bidder/AdplayxConfiguration.java new file mode 100644 index 00000000000..6038580727c --- /dev/null +++ b/src/main/java/org/prebid/server/spring/config/bidder/AdplayxConfiguration.java @@ -0,0 +1,35 @@ +package org.prebid.server.spring.config.bidder; + +import org.prebid.server.bidder.BidderDeps; +import org.prebid.server.bidder.adplayx.AdplayxBidder; +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/adplayx.yaml", factory = YamlPropertySourceFactory.class) +public class AdplayxConfiguration { + + private static final String BIDDER_NAME = "adplayx"; + + @Bean("adplayxConfigurationProperties") + @ConfigurationProperties("adapters.adplayx") + BidderConfigurationProperties configurationProperties() { + return new BidderConfigurationProperties(); + } + + @Bean + BidderDeps adplayxBidderDeps(BidderConfigurationProperties adplayxConfigurationProperties, + JacksonMapper mapper) { + + return BidderDepsAssembler.forBidder(BIDDER_NAME) + .withConfig(adplayxConfigurationProperties) + .bidderCreator(config -> new AdplayxBidder(config.getEndpoint(), mapper)) + .assemble(); + } +} diff --git a/src/main/resources/bidder-config/adplayx.yaml b/src/main/resources/bidder-config/adplayx.yaml new file mode 100644 index 00000000000..c04a44db8da --- /dev/null +++ b/src/main/resources/bidder-config/adplayx.yaml @@ -0,0 +1,15 @@ +adapters: + adplayx: + endpoint: "https://api.adplayx.net/v1.0/ortb" + pbs-enforces-ccpa: true + modifying-vast-xml-allowed: true + meta-info: + maintainer-email: "support@adplayx.com" + app-media-types: + - banner + - video + site-media-types: + - banner + - video + supported-vendors: [] + vendor-id: 0 diff --git a/src/main/resources/static/bidder-params/adplayx.json b/src/main/resources/static/bidder-params/adplayx.json new file mode 100644 index 00000000000..a4f0933e823 --- /dev/null +++ b/src/main/resources/static/bidder-params/adplayx.json @@ -0,0 +1,16 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "AdPlayx Adapter Params", + "type": "object", + "properties": { + "apptoken": { + "type": "string", + "description": "Publisher app token" + }, + "placementid": { + "type": "string", + "description": "Placement ID (optional)" + } + }, + "required": ["apptoken"] +} diff --git a/src/test/java/org/prebid/server/bidder/adplayx/AdplayxBidderTest.java b/src/test/java/org/prebid/server/bidder/adplayx/AdplayxBidderTest.java new file mode 100644 index 00000000000..9bde0a88d64 --- /dev/null +++ b/src/test/java/org/prebid/server/bidder/adplayx/AdplayxBidderTest.java @@ -0,0 +1,192 @@ +package org.prebid.server.bidder.adplayx; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.iab.openrtb.request.Banner; +import com.iab.openrtb.request.BidRequest; +import com.iab.openrtb.request.Imp; +import com.iab.openrtb.request.Video; +import com.iab.openrtb.response.Bid; +import com.iab.openrtb.response.BidResponse; +import com.iab.openrtb.response.SeatBid; +import org.junit.jupiter.api.BeforeEach; +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.adplayx.ExtImpAdplayx; +import org.prebid.server.proto.openrtb.ext.response.BidType; + +import java.math.BigDecimal; +import java.util.List; +import java.util.function.Function; + +import static java.util.Collections.singletonList; +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; + +public class AdplayxBidderTest extends VertxTest { + + private static final String ENDPOINT_URL = "https://test.endpoint.com/v1.0/ortb"; + + private AdplayxBidder target; + + @BeforeEach + public void setUp() { + target = new AdplayxBidder(ENDPOINT_URL, jacksonMapper); + } + + @Test + public void creationShouldFailOnInvalidEndpoint() { + assertThatIllegalArgumentException().isThrownBy(() -> new AdplayxBidder("invalid_url", jacksonMapper)); + } + + @Test + public void makeHttpRequestsShouldReturnErrorWhenApptokenIsMissing() { + // given + final BidRequest bidRequest = givenBidRequest(imp -> imp + .ext(mapper.valueToTree(ExtPrebid.of(null, ExtImpAdplayx.of(null, "placement123"))))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).containsExactly(BidderError.badInput("apptoken is required")); + } + + @Test + public void makeHttpRequestsShouldCreateCorrectUriWithApptokenAndPlacementId() { + // given + final BidRequest bidRequest = givenBidRequest(imp -> imp + .ext(mapper.valueToTree(ExtPrebid.of(null, ExtImpAdplayx.of("test_token", "placement123"))))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1); + assertThat(result.getValue().get(0).getUri()) + .isEqualTo("https://test.endpoint.com/v1.0/ortb?apptoken=test_token&placementid=placement123"); + } + + @Test + public void makeHttpRequestsShouldCreateCorrectUriWithoutPlacementIdWhenMissing() { + // given + final BidRequest bidRequest = givenBidRequest(imp -> imp + .ext(mapper.valueToTree(ExtPrebid.of(null, ExtImpAdplayx.of("test_token", null))))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1); + assertThat(result.getValue().get(0).getUri()) + .isEqualTo("https://test.endpoint.com/v1.0/ortb?apptoken=test_token"); + } + + @Test + public void makeHttpRequestsShouldUrlEncodeSpecialCharactersWithoutDoubleEncoding() { + // given + final BidRequest bidRequest = givenBidRequest(imp -> imp + .ext(mapper.valueToTree(ExtPrebid.of(null, ExtImpAdplayx.of("token & 123", "placement 456"))))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1); + assertThat(result.getValue().get(0).getUri()) + .isEqualTo("https://test.endpoint.com/v1.0/ortb?apptoken=token%20%26%20123&placementid=placement%20456"); + } + + @Test + public void makeBidsShouldReturnEmptyListWhenResponseIsNull() { + // given + final BidderCall httpCall = givenHttpCall(null, null); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).isEmpty(); + } + + @Test + public void makeBidsShouldReturnBannerBid() throws JsonProcessingException { + // given + final BidRequest bidRequest = givenBidRequest(imp -> imp.id("imp_id_1").banner(Banner.builder().build())); + + final BidResponse bidResponse = givenBidResponse(bid -> bid + .impid("imp_id_1") + .price(BigDecimal.valueOf(1.5))); + + final BidderCall httpCall = givenHttpCall(bidRequest, mapper.writeValueAsString(bidResponse)); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + final BidderBid expectedBid = BidderBid.of( + Bid.builder().impid("imp_id_1").price(BigDecimal.valueOf(1.5)).build(), + BidType.banner, + "USD"); + + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).containsExactly(expectedBid); + } + + @Test + public void makeBidsShouldReturnVideoBid() throws JsonProcessingException { + // given + final BidRequest bidRequest = givenBidRequest(imp -> imp.id("imp_id_video").video(Video.builder().build())); + + final BidResponse bidResponse = givenBidResponse(bid -> bid + .impid("imp_id_video") + .price(BigDecimal.valueOf(2.0))); + + final BidderCall httpCall = givenHttpCall(bidRequest, mapper.writeValueAsString(bidResponse)); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + final BidderBid expectedBid = BidderBid.of( + Bid.builder().impid("imp_id_video").price(BigDecimal.valueOf(2.0)).build(), + BidType.video, + "USD"); + + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).containsExactly(expectedBid); + } + + private static BidRequest givenBidRequest(Function impCustomizer) { + return BidRequest.builder() + .imp(singletonList(impCustomizer.apply(Imp.builder().id("123")).build())) + .build(); + } + + private static BidResponse givenBidResponse(Function bidCustomizer) { + return BidResponse.builder() + .cur("USD") + .seatbid(singletonList(SeatBid.builder() + .bid(singletonList(bidCustomizer.apply(Bid.builder()).build())) + .build())) + .build(); + } + + private static BidderCall givenHttpCall(BidRequest bidRequest, String body) { + return BidderCall.succeededHttp( + HttpRequest.builder().payload(bidRequest).build(), + HttpResponse.of(200, null, body), + null); + } +} diff --git a/src/test/java/org/prebid/server/it/AdplayxTest.java b/src/test/java/org/prebid/server/it/AdplayxTest.java new file mode 100644 index 00000000000..2db70712a83 --- /dev/null +++ b/src/test/java/org/prebid/server/it/AdplayxTest.java @@ -0,0 +1,37 @@ +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.anyUrl; +import static com.github.tomakehurst.wiremock.client.WireMock.equalTo; +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 AdplayxTest extends IntegrationTest { + + @Test + public void openrtb2AuctionShouldRespondWithBidsFromAdplayx() throws IOException, JSONException { + // given + WIRE_MOCK_RULE.stubFor(post(urlPathEqualTo("/adplayx-exchange")) + .withQueryParam("apptoken", equalTo("test_app_token")) + .withQueryParam("placementid", equalTo("test_placement_id")) + .withRequestBody(equalToJson(jsonFrom("openrtb2/adplayx/test-adplayx-bid-request.json"))) + .willReturn(aResponse().withBody(jsonFrom("openrtb2/adplayx/test-adplayx-bid-response.json")))); + + // when + final Response response = responseFor("openrtb2/adplayx/test-auction-adplayx-request.json", + Endpoint.openrtb2_auction); + + // then + assertJsonEquals("openrtb2/adplayx/test-auction-adplayx-response.json", response, + singletonList("adplayx")); + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/adplayx/test-adplayx-bid-request.json b/src/test/resources/org/prebid/server/it/openrtb2/adplayx/test-adplayx-bid-request.json new file mode 100644 index 00000000000..e69bafaf976 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/adplayx/test-adplayx-bid-request.json @@ -0,0 +1,27 @@ +{ + "id": "test-request-id", + "imp": [ + { + "id": "test-imp-id", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "prebid": { + "bidder": { + "adplayx": { + "apptoken": "test_app_token", + "placementid": "test_placement_id" + } + } + } + } + } + ], + "tmax": 1000 +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/adplayx/test-adplayx-bid-response.json b/src/test/resources/org/prebid/server/it/openrtb2/adplayx/test-adplayx-bid-response.json new file mode 100644 index 00000000000..6c4c3f76cbf --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/adplayx/test-adplayx-bid-response.json @@ -0,0 +1,20 @@ +{ + "id": "test-request-id", + "seatbid": [ + { + "bid": [ + { + "id": "test-bid-id", + "impid": "test-imp-id", + "price": 2.50, + "adm": "
AdPlayx Creative Content
", + "crid": "test-creative-id", + "w": 300, + "h": 250 + } + ], + "seat": "adplayx" + } + ], + "cur": "USD" +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/adplayx/test-auction-adplayx-request.json b/src/test/resources/org/prebid/server/it/openrtb2/adplayx/test-auction-adplayx-request.json new file mode 100644 index 00000000000..e69bafaf976 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/adplayx/test-auction-adplayx-request.json @@ -0,0 +1,27 @@ +{ + "id": "test-request-id", + "imp": [ + { + "id": "test-imp-id", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "prebid": { + "bidder": { + "adplayx": { + "apptoken": "test_app_token", + "placementid": "test_placement_id" + } + } + } + } + } + ], + "tmax": 1000 +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/adplayx/test-auction-adplayx-response.json b/src/test/resources/org/prebid/server/it/openrtb2/adplayx/test-auction-adplayx-response.json new file mode 100644 index 00000000000..27ed7232bb9 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/adplayx/test-auction-adplayx-response.json @@ -0,0 +1,25 @@ +{ + "id": "test-request-id", + "seatbid": [ + { + "bid": [ + { + "id": "test-bid-id", + "impid": "test-imp-id", + "price": 2.5, + "adm": "
AdPlayx Creative Content
", + "crid": "test-creative-id", + "w": 300, + "h": 250, + "ext": { + "prebid": { + "type": "banner" + } + } + } + ], + "seat": "adplayx" + } + ], + "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 422675ce9f9..c5e9abfc016 100644 --- a/src/test/resources/org/prebid/server/it/test-application.properties +++ b/src/test/resources/org/prebid/server/it/test-application.properties @@ -78,6 +78,8 @@ adapters.adverxo.aliases.harrenmedia.enabled=true adapters.adverxo.aliases.harrenmedia.endpoint=http://localhost:8090/harrenmedia-exchange adapters.adview.enabled=true adapters.adview.endpoint=http://localhost:8090/adview-exchange +adapters.adplayx.enabled=true +adapters.adplayx.endpoint=http://localhost:8090/adplayx-exchange adapters.adprime.enabled=true adapters.adprime.endpoint=http://localhost:8090/adprime-exchange adapters.adquery.enabled=true