github.com/prebid/prebid-server@v0.275.0/adapters/improvedigital/improvedigital.go

package improvedigital

import (
	"encoding/json"
	"fmt"
	"net/http"
	"strconv"
	"strings"

	"github.com/prebid/openrtb/v19/openrtb2"
	"github.com/prebid/prebid-server/adapters"
	"github.com/prebid/prebid-server/config"
	"github.com/prebid/prebid-server/errortypes"
	"github.com/prebid/prebid-server/openrtb_ext"
)

const (
	buyingTypeRTB                    = "rtb"
	isRewardedInventory              = "is_rewarded_inventory"
	stateRewardedInventoryEnable     = "1"
	consentProvidersSettingsInputKey = "ConsentedProvidersSettings"
	consentProvidersSettingsOutKey   = "consented_providers_settings"
	consentedProvidersKey            = "consented_providers"
	publisherEndpointParam           = "{PublisherId}"
)

type ImprovedigitalAdapter struct {
	endpoint string
}

// BidExt represents Improved Digital bid extension with line item ID and buying type values
type BidExt struct {
	Improvedigital struct {
		LineItemID int    `json:"line_item_id"`
		BuyingType string `json:"buying_type"`
	}
}

// ImpExtBidder represents Improved Digital bid extension with Publisher ID
type ImpExtBidder struct {
	Bidder struct {
		PublisherID int `json:"publisherId"`
	}
}

// MakeRequests makes the HTTP requests which should be made to fetch bids.
func (a *ImprovedigitalAdapter) MakeRequests(request *openrtb2.BidRequest, reqInfo *adapters.ExtraRequestInfo) ([]*adapters.RequestData, []error) {
	numRequests := len(request.Imp)
	errors := make([]error, 0)
	adapterRequests := make([]*adapters.RequestData, 0, numRequests)

	// Split multi-imp request into multiple ad server requests. SRA is currently not recommended.
	for i := 0; i < numRequests; i++ {
		if adapterReq, err := a.makeRequest(*request, request.Imp[i]); err == nil {
			adapterRequests = append(adapterRequests, adapterReq)
		} else {
			errors = append(errors, err)
		}
	}

	return adapterRequests, errors
}

func (a *ImprovedigitalAdapter) makeRequest(request openrtb2.BidRequest, imp openrtb2.Imp) (*adapters.RequestData, error) {
	// Handle Rewarded Inventory
	impExt, err := getImpExtWithRewardedInventory(imp)
	if err != nil {
		return nil, err
	}
	if impExt != nil {
		imp.Ext = impExt
	}

	request.Imp = []openrtb2.Imp{imp}

	userExtAddtlConsent, err := a.getAdditionalConsentProvidersUserExt(request)
	if err != nil {
		return nil, err
	}

	if len(userExtAddtlConsent) > 0 {
		userCopy := *request.User
		userCopy.Ext = userExtAddtlConsent
		request.User = &userCopy
	}

	reqJSON, err := json.Marshal(request)
	if err != nil {
		return nil, err
	}

	headers := http.Header{}
	headers.Add("Content-Type", "application/json;charset=utf-8")

	return &adapters.RequestData{
		Method:  "POST",
		Uri:     a.buildEndpointURL(imp),
		Body:    reqJSON,
		Headers: headers,
	}, nil
}

// MakeBids unpacks the server's response into Bids.
func (a *ImprovedigitalAdapter) MakeBids(internalRequest *openrtb2.BidRequest, externalRequest *adapters.RequestData, response *adapters.ResponseData) (*adapters.BidderResponse, []error) {
	if response.StatusCode == http.StatusNoContent {
		return nil, nil
	}

	if response.StatusCode == http.StatusBadRequest {
		return nil, []error{&errortypes.BadInput{
			Message: fmt.Sprintf("Unexpected status code: %d. Run with request.debug = 1 for more info", response.StatusCode),
		}}
	}

	if response.StatusCode != http.StatusOK {
		return nil, []error{&errortypes.BadServerResponse{
			Message: fmt.Sprintf("Unexpected status code: %d. Run with request.debug = 1 for more info", response.StatusCode),
		}}
	}

	var bidResp openrtb2.BidResponse
	if err := json.Unmarshal(response.Body, &bidResp); err != nil {
		return nil, []error{err}
	}

	if len(bidResp.SeatBid) == 0 {
		return nil, nil
	}

	if len(bidResp.SeatBid) > 1 {
		return nil, []error{&errortypes.BadServerResponse{
			Message: fmt.Sprintf("Unexpected SeatBid! Must be only one but have: %d", len(bidResp.SeatBid)),
		}}
	}

	seatBid := bidResp.SeatBid[0]

	if len(seatBid.Bid) == 0 {
		return nil, nil
	}

	bidResponse := adapters.NewBidderResponseWithBidsCapacity(len(seatBid.Bid))
	bidResponse.Currency = bidResp.Cur

	for i := range seatBid.Bid {
		bid := seatBid.Bid[i]

		bidType, err := getMediaTypeForImp(bid.ImpID, internalRequest.Imp)
		if err != nil {
			return nil, []error{err}
		}

		if bid.Ext != nil {
			var bidExt BidExt
			err = json.Unmarshal(bid.Ext, &bidExt)
			if err != nil {
				return nil, []error{err}
			}

			bidExtImprovedigital := bidExt.Improvedigital
			if bidExtImprovedigital.LineItemID != 0 && bidExtImprovedigital.BuyingType != "" && bidExtImprovedigital.BuyingType != buyingTypeRTB {
				bid.DealID = strconv.Itoa(bidExtImprovedigital.LineItemID)
			}
		}

		bidResponse.Bids = append(bidResponse.Bids, &adapters.TypedBid{
			Bid:     &bid,
			BidType: bidType,
		})
	}
	return bidResponse, nil

}

// Builder builds a new instance of the Improvedigital adapter for the given bidder with the given config.
func Builder(bidderName openrtb_ext.BidderName, config config.Adapter, server config.Server) (adapters.Bidder, error) {
	bidder := &ImprovedigitalAdapter{
		endpoint: config.Endpoint,
	}
	return bidder, nil
}

func getMediaTypeForImp(impID string, imps []openrtb2.Imp) (openrtb_ext.BidType, error) {
	for _, imp := range imps {
		if imp.ID == impID {
			if imp.Banner != nil {
				return openrtb_ext.BidTypeBanner, nil
			}

			if imp.Video != nil {
				return openrtb_ext.BidTypeVideo, nil
			}

			if imp.Native != nil {
				return openrtb_ext.BidTypeNative, nil
			}

			return "", &errortypes.BadServerResponse{
				Message: fmt.Sprintf("Unknown impression type for ID: \"%s\"", impID),
			}
		}
	}

	// This shouldnt happen. Lets handle it just incase by returning an error.
	return "", &errortypes.BadServerResponse{
		Message: fmt.Sprintf("Failed to find impression for ID: \"%s\"", impID),
	}
}

// This method responsible to clone request and convert additional consent providers string to array when additional consent provider found
func (a *ImprovedigitalAdapter) getAdditionalConsentProvidersUserExt(request openrtb2.BidRequest) ([]byte, error) {
	var cpStr string

	// If user/user.ext not defined, no need to parse additional consent
	if request.User == nil || request.User.Ext == nil {
		return nil, nil
	}

	// Start validating additional consent
	// Check key exist user.ext.ConsentedProvidersSettings
	var userExtMap = make(map[string]json.RawMessage)
	if err := json.Unmarshal(request.User.Ext, &userExtMap); err != nil {
		return nil, err
	}

	cpsMapValue, cpsJSONFound := userExtMap[consentProvidersSettingsInputKey]
	if !cpsJSONFound {
		return nil, nil
	}

	// Check key exist user.ext.ConsentedProvidersSettings.consented_providers
	var cpMap = make(map[string]json.RawMessage)
	if err := json.Unmarshal(cpsMapValue, &cpMap); err != nil {
		return nil, err
	}

	cpMapValue, cpJSONFound := cpMap[consentedProvidersKey]
	if !cpJSONFound {
		return nil, nil
	}
	// End validating additional consent

	// Check if string contain ~, then substring after ~ to end of string
	consentStr := string(cpMapValue)
	var tildaPosition int
	if tildaPosition = strings.Index(consentStr, "~"); tildaPosition == -1 {
		return nil, nil
	}
	cpStr = consentStr[tildaPosition+1 : len(consentStr)-1]

	// Prepare consent providers string
	cpStr = fmt.Sprintf("[%s]", strings.Replace(cpStr, ".", ",", -1))
	cpMap[consentedProvidersKey] = json.RawMessage(cpStr)

	cpJSON, err := json.Marshal(cpMap)
	if err != nil {
		return nil, err
	}
	userExtMap[consentProvidersSettingsOutKey] = cpJSON

	extJson, err := json.Marshal(userExtMap)
	if err != nil {
		return nil, err
	}

	return extJson, nil
}

func getImpExtWithRewardedInventory(imp openrtb2.Imp) ([]byte, error) {
	var ext = make(map[string]json.RawMessage)
	if err := json.Unmarshal(imp.Ext, &ext); err != nil {
		return nil, err
	}

	prebidJSONValue, prebidJSONFound := ext["prebid"]
	if !prebidJSONFound {
		return nil, nil
	}

	var prebidMap = make(map[string]json.RawMessage)
	if err := json.Unmarshal(prebidJSONValue, &prebidMap); err != nil {
		return nil, err
	}

	if rewardedInventory, foundRewardedInventory := prebidMap[isRewardedInventory]; foundRewardedInventory && string(rewardedInventory) == stateRewardedInventoryEnable {
		ext[isRewardedInventory] = json.RawMessage(`true`)
		impExt, err := json.Marshal(ext)
		if err != nil {
			return nil, err
		}

		return impExt, nil
	}

	return nil, nil
}

func (a *ImprovedigitalAdapter) buildEndpointURL(imp openrtb2.Imp) string {
	publisherEndpoint := ""
	var impBidder ImpExtBidder

	err := json.Unmarshal(imp.Ext, &impBidder)
	if err == nil && impBidder.Bidder.PublisherID != 0 {
		publisherEndpoint = strconv.Itoa(impBidder.Bidder.PublisherID) + "/"
	}

	return strings.Replace(a.endpoint, publisherEndpointParam, publisherEndpoint, -1)
}