Upstream PR #4321: New Adapter: Nativery (#4321)

adapters/nativery/nativery.go

@@ -0,0 +1,267 @@
+package nativery
+
+import (
+	"fmt"
+	"maps"
+	"net/http"
+
+	"github.com/prebid/openrtb/v20/openrtb2"
+	"github.com/prebid/prebid-server/v3/adapters"
+	"github.com/prebid/prebid-server/v3/config"
+	"github.com/prebid/prebid-server/v3/errortypes"
+	"github.com/prebid/prebid-server/v3/metrics"
+	"github.com/prebid/prebid-server/v3/openrtb_ext"
+	"github.com/prebid/prebid-server/v3/util/jsonutil"
+)
+
+type adapter struct {
+	endpoint string
+}
+
+type bidReqExtNativery struct {
+	IsAMP    bool   `json:"isAmp"`
+	WidgetId string `json:"widgetId"`
+}
+
+type bidExtNativery struct {
+	BidType       string   `json:"bid_ad_media_type"`
+	BidAdvDomains []string `json:"bid_adv_domains"`
+
+	AdvertiserId  string `json:"adv_id,omitempty"`
+	BrandCategory int    `json:"brand_category_id,omitempty"`
+}
+
+type bidExt struct {
+	Nativery bidExtNativery `json:"nativery"`
+}
+
+func Builder(bidderName openrtb_ext.BidderName, config config.Adapter, server config.Server) (adapters.Bidder, error) {
+	bidder := &adapter{
+		endpoint: config.Endpoint,
+	}
+	return bidder, nil
+}
+
+func (a *adapter) MakeRequests(request *openrtb2.BidRequest, reqInfo *adapters.ExtraRequestInfo) ([]*adapters.RequestData, []error) {
+	reqCopy := *request
+	var errs []error
+
+	// check if the request come from AMP
+	var isAMP int
+	if reqInfo.PbsEntryPoint == metrics.ReqTypeAMP {
+		isAMP = 1
+	}
+
+	var widgetId string
+
+	// attach body request for all the impressions
+	validImps := make([]openrtb2.Imp, 0, len(request.Imp))
+	for i, imp := range request.Imp {
+		nativeryExt, err := buildNativeryExt(&imp)
+
+		if err != nil {
+			errs = append(errs, err)
+			continue
+		}
+
+		if i == 0 {
+			widgetId = nativeryExt.WidgetId
+		}
+
+		validImps = append(validImps, imp)
+	}
+
+	reqCopy.Imp = validImps
+	if len(reqCopy.Imp) == 0 {
+		return nil, errs
+	}
+
+	reqExt, err := getRequestExt(reqCopy.Ext)
+	if err != nil {
+		return nil, append(errs, err)
+	}
+
+	reqExtNativery, err := getNativeryExt(reqExt, isAMP, widgetId)
+	if err != nil {
+		return nil, append(errs, err)
+	}
+	adapterRequests, splitErrors := splitRequests(reqCopy.Imp, &reqCopy, reqExt, reqExtNativery, a.endpoint)
+
+	return adapterRequests, append(errs, splitErrors...)
+}
+
+func buildNativeryExt(imp *openrtb2.Imp) (openrtb_ext.ImpExtNativery, error) {
+	var bidderExt adapters.ExtImpBidder
+	if err := jsonutil.Unmarshal(imp.Ext, &bidderExt); err != nil {
+		return openrtb_ext.ImpExtNativery{}, err
+	}
+
+	var nativeryExt openrtb_ext.ImpExtNativery
+	if err := jsonutil.Unmarshal(bidderExt.Bidder, &nativeryExt); err != nil {
+		return openrtb_ext.ImpExtNativery{}, err
+	}
+
+	return nativeryExt, nil
+}
+
+func (a *adapter) MakeBids(internalRequest *openrtb2.BidRequest, externalRequest *adapters.RequestData, response *adapters.ResponseData) (*adapters.BidderResponse, []error) {
+	if adapters.IsResponseStatusCodeNoContent(response) {
+		nativeryError := response.Headers.Get("X-Nativery-Error")
+		if nativeryError != "" {
+			return nil, []error{&errortypes.BadInput{
+				Message: fmt.Sprintf("Nativery Error: %s.", nativeryError),
+			}}
+		}
+
+		return nil, []error{&errortypes.BadServerResponse{
+			Message: "No Content",
+		}}
+	}
+
+	if err := adapters.CheckResponseStatusCodeForErrors(response); err != nil {
+		return nil, []error{err}
+	}
+
+	var nativeryResponse openrtb2.BidResponse
+	if err := jsonutil.Unmarshal(response.Body, &nativeryResponse); err != nil {
+		return nil, []error{err}
+	}
+
+	var errs []error
+	bidderResponse := adapters.NewBidderResponseWithBidsCapacity(len(internalRequest.Imp))
+	for _, sb := range nativeryResponse.SeatBid {
+		for i := range sb.Bid {
+			bid := sb.Bid[i]
+
+			var bidExt bidExt
+			if err := jsonutil.Unmarshal(bid.Ext, &bidExt); err != nil {
+				errs = append(errs, err)
+				continue
+			}
+
+			bidType, err := getMediaTypeForBid(&bidExt)
+			if err != nil {
+				errs = append(errs, err)
+				continue
+			}
+			bidMeta := buildBidMeta(string(bidType), bidExt.Nativery.BidAdvDomains)
+
+			bidderResponse.Bids = append(bidderResponse.Bids, &adapters.TypedBid{
+				Bid:     &bid,
+				BidType: bidType,
+				BidMeta: bidMeta,
+			})
+		}
+
+	}
+
+	if nativeryResponse.Cur != "" {
+		bidderResponse.Currency = nativeryResponse.Cur
+	} else {
+		bidderResponse.Currency = "EUR"
+	}
+	return bidderResponse, errs
+
+}
+
+func getMediaTypeForBid(bid *bidExt) (openrtb_ext.BidType, error) {
+	switch bid.Nativery.BidType {
+	case "native":
+		return openrtb_ext.BidTypeNative, nil
+	case "display", "banner", "rich_media":
+		return openrtb_ext.BidTypeBanner, nil
+	case "video":
+		return openrtb_ext.BidTypeVideo, nil
+	default:
+		return "", fmt.Errorf("unrecognized bid_ad_media_type in response from nativery: %s", bid.Nativery.BidType)
+	}
+}
+
+func buildBidMeta(mediaType string, advDomain []string) *openrtb_ext.ExtBidPrebidMeta {
+
+	return &openrtb_ext.ExtBidPrebidMeta{
+		MediaType:         mediaType,
+		AdvertiserDomains: advDomain,
+	}
+}
+
+func splitRequests(
+	imps []openrtb2.Imp,
+	request *openrtb2.BidRequest,
+	requestExt map[string]jsonutil.RawMessage,
+	requestExtNativery bidReqExtNativery,
+	uri string,
+) ([]*adapters.RequestData, []error) {
+	var errs []error
+
+	resArr := make([]*adapters.RequestData, 0, len(imps))
+
+	headers := http.Header{}
+	headers.Add("Content-Type", "application/json;charset=utf-8")
+	headers.Add("Accept", "application/json")
+
+	nativeryExtJson, err := jsonutil.Marshal(requestExtNativery)
+	if err != nil {
+		errs = append(errs, err)
+	}
+
+	baseReq := *request
+
+	for _, imp := range imps {
+		extClone := maps.Clone(requestExt)
+		extClone["nativery"] = nativeryExtJson
+
+		reqCopy := baseReq
+
+		reqCopy.Ext, err = jsonutil.Marshal(extClone)
+		if err != nil {
+			errs = append(errs, err)
+			continue
+		}
+
+		reqCopy.Imp = []openrtb2.Imp{imp}
+
+		reqJSON, err := jsonutil.Marshal(&reqCopy)
+		if err != nil {
+			errs = append(errs, err)
+			continue
+		}
+
+		resArr = append(resArr, &adapters.RequestData{
+			Method:  "POST",
+			Uri:     uri,
+			Body:    reqJSON,
+			Headers: headers,
+			ImpIDs:  openrtb_ext.GetImpIDs(reqCopy.Imp),
+		})
+	}
+
+	return resArr, errs
+}
+
+func getRequestExt(ext jsonutil.RawMessage) (map[string]jsonutil.RawMessage, error) {
+	extMap := make(map[string]jsonutil.RawMessage)
+
+	if len(ext) > 0 {
+		if err := jsonutil.Unmarshal(ext, &extMap); err != nil {
+			return nil, err
+		}
+	}
+
+	return extMap, nil
+}
+
+func getNativeryExt(extMap map[string]jsonutil.RawMessage, isAMP int, widgetId string) (bidReqExtNativery, error) {
+	var nativeryExt bidReqExtNativery
+
+	if nativeryExtJson, exists := extMap["nativery"]; exists && len(nativeryExtJson) > 0 {
+		if err := jsonutil.Unmarshal(nativeryExtJson, &nativeryExt); err != nil {
+			return nativeryExt, err
+		}
+	}
+
+	nativeryExt.IsAMP = isAMP == 1
+	nativeryExt.WidgetId = widgetId
+
+	return nativeryExt, nil
+}

adapters/nativery/nativery_test.go

@@ -0,0 +1,20 @@
+package nativery
+
+import (
+	"testing"
+
+	"github.com/prebid/prebid-server/v3/adapters/adapterstest"
+	"github.com/prebid/prebid-server/v3/config"
+	"github.com/prebid/prebid-server/v3/openrtb_ext"
+)
+
+func TestJsonSamples(t *testing.T) {
+	bidder, buildErr := Builder(openrtb_ext.BidderNativery, config.Adapter{
+		Endpoint: "http://example.com/hb"}, config.Server{ExternalUrl: "http://hosturl.com", GvlID: 1, DataCenter: "2"})
+
+	if buildErr != nil {
+		t.Fatalf("Builder returned unexpected error %v", buildErr)
+	}
+
+	adapterstest.RunJSONBidderTest(t, "nativerytest", bidder)
+}