github.com/prebid/prebid-server/v2@v2.18.0/adapters/madvertise/madvertise.go (about)

     1  package madvertise
     2  
     3  import (
     4  	"encoding/json"
     5  	"fmt"
     6  	"net/http"
     7  	"text/template"
     8  
     9  	"github.com/prebid/openrtb/v20/adcom1"
    10  	"github.com/prebid/openrtb/v20/openrtb2"
    11  	"github.com/prebid/prebid-server/v2/adapters"
    12  	"github.com/prebid/prebid-server/v2/config"
    13  	"github.com/prebid/prebid-server/v2/errortypes"
    14  	"github.com/prebid/prebid-server/v2/macros"
    15  	"github.com/prebid/prebid-server/v2/openrtb_ext"
    16  )
    17  
    18  type adapter struct {
    19  	endpointTemplate *template.Template
    20  }
    21  
    22  func Builder(bidderName openrtb_ext.BidderName, config config.Adapter, server config.Server) (adapters.Bidder, error) {
    23  	template, err := template.New("endpointTemplate").Parse(config.Endpoint)
    24  	if err != nil {
    25  		return nil, fmt.Errorf("unable to parse endpoint url template: %v", err)
    26  	}
    27  
    28  	bidder := &adapter{
    29  		endpointTemplate: template,
    30  	}
    31  
    32  	return bidder, nil
    33  }
    34  
    35  func getHeaders(request *openrtb2.BidRequest) http.Header {
    36  	headers := http.Header{}
    37  	headers.Add("Content-Type", "application/json;charset=utf-8")
    38  	headers.Add("Accept", "application/json")
    39  	headers.Add("X-Openrtb-Version", "2.5")
    40  
    41  	if request.Device != nil {
    42  		if len(request.Device.UA) > 0 {
    43  			headers.Add("User-Agent", request.Device.UA)
    44  		}
    45  
    46  		if len(request.Device.IP) > 0 {
    47  			headers.Add("X-Forwarded-For", request.Device.IP)
    48  		}
    49  	}
    50  
    51  	return headers
    52  }
    53  
    54  func (a *adapter) MakeRequests(request *openrtb2.BidRequest, requestInfo *adapters.ExtraRequestInfo) ([]*adapters.RequestData, []error) {
    55  	zoneID := ""
    56  	for _, imp := range request.Imp {
    57  		madvertiseExt, err := getImpressionExt(imp)
    58  		if err != nil {
    59  			return nil, []error{err}
    60  		}
    61  		if len(madvertiseExt.ZoneID) < 7 {
    62  			return nil, []error{&errortypes.BadInput{
    63  				Message: fmt.Sprintf("The minLength of zone ID is 7; ImpID=%s", imp.ID),
    64  			}}
    65  		}
    66  		if zoneID == "" {
    67  			zoneID = madvertiseExt.ZoneID
    68  		} else if zoneID != madvertiseExt.ZoneID {
    69  			return nil, []error{&errortypes.BadInput{
    70  				Message: "There must be only one zone ID",
    71  			}}
    72  		}
    73  	}
    74  	url, err := a.buildEndpointURL(zoneID)
    75  	if err != nil {
    76  		return nil, []error{err}
    77  	}
    78  	requestJSON, err := json.Marshal(request)
    79  	if err != nil {
    80  		return nil, []error{err}
    81  	}
    82  
    83  	requestData := &adapters.RequestData{
    84  		Method:  "POST",
    85  		Uri:     url,
    86  		Body:    requestJSON,
    87  		Headers: getHeaders(request),
    88  		ImpIDs:  openrtb_ext.GetImpIDs(request.Imp),
    89  	}
    90  
    91  	return []*adapters.RequestData{requestData}, nil
    92  }
    93  
    94  func getImpressionExt(imp openrtb2.Imp) (*openrtb_ext.ExtImpMadvertise, error) {
    95  	var bidderExt adapters.ExtImpBidder
    96  	if err := json.Unmarshal(imp.Ext, &bidderExt); err != nil {
    97  		return nil, &errortypes.BadInput{
    98  			Message: fmt.Sprintf("%s; ImpID=%s", err.Error(), imp.ID),
    99  		}
   100  	}
   101  	var madvertiseExt openrtb_ext.ExtImpMadvertise
   102  	if err := json.Unmarshal(bidderExt.Bidder, &madvertiseExt); err != nil {
   103  		return nil, &errortypes.BadInput{
   104  			Message: fmt.Sprintf("%s; ImpID=%s", err.Error(), imp.ID),
   105  		}
   106  	}
   107  	if madvertiseExt.ZoneID == "" {
   108  		return nil, &errortypes.BadInput{
   109  			Message: fmt.Sprintf("ext.bidder.zoneId not provided; ImpID=%s", imp.ID),
   110  		}
   111  	}
   112  
   113  	return &madvertiseExt, nil
   114  }
   115  
   116  func (a *adapter) buildEndpointURL(zoneID string) (string, error) {
   117  	endpointParams := macros.EndpointTemplateParams{ZoneID: zoneID}
   118  	return macros.ResolveMacros(a.endpointTemplate, endpointParams)
   119  }
   120  
   121  func (a *adapter) MakeBids(request *openrtb2.BidRequest, requestData *adapters.RequestData, responseData *adapters.ResponseData) (*adapters.BidderResponse, []error) {
   122  	if responseData.StatusCode == http.StatusNoContent {
   123  		return nil, nil
   124  	}
   125  
   126  	if responseData.StatusCode != http.StatusOK {
   127  		err := &errortypes.BadServerResponse{
   128  			Message: fmt.Sprintf("Unexpected status code: %d. Run with request.debug = 1 for more info", responseData.StatusCode),
   129  		}
   130  		return nil, []error{err}
   131  	}
   132  
   133  	var response openrtb2.BidResponse
   134  	if err := json.Unmarshal(responseData.Body, &response); err != nil {
   135  		return nil, []error{err}
   136  	}
   137  
   138  	bidResponse := adapters.NewBidderResponseWithBidsCapacity(len(request.Imp))
   139  	bidResponse.Currency = response.Cur
   140  	for _, seatBid := range response.SeatBid {
   141  		for i := range seatBid.Bid {
   142  			bid := seatBid.Bid[i]
   143  			bidMediaType := getMediaTypeForBid(bid.Attr)
   144  			b := &adapters.TypedBid{
   145  				Bid:     &bid,
   146  				BidType: bidMediaType,
   147  			}
   148  			bidResponse.Bids = append(bidResponse.Bids, b)
   149  		}
   150  	}
   151  	return bidResponse, nil
   152  }
   153  
   154  func getMediaTypeForBid(attr []adcom1.CreativeAttribute) openrtb_ext.BidType {
   155  	for i := 0; i < len(attr); i++ {
   156  		if attr[i] == adcom1.AttrHasSkipButton {
   157  			return openrtb_ext.BidTypeVideo
   158  		} else if attr[i] == adcom1.AttrVideoAuto {
   159  			return openrtb_ext.BidTypeVideo
   160  		} else if attr[i] == adcom1.AttrVideoUser {
   161  			return openrtb_ext.BidTypeVideo
   162  		}
   163  	}
   164  	return openrtb_ext.BidTypeBanner
   165  }