TripleLift Prebid S2S Adapter #954

Kevin-P-Kerr · 2019-07-08T14:21:36Z

The TripleLift prebid S2S adapter.

request to prebid

{ "id": "some-request-id",
   "site": {
    "page": "https://www.123greetings.com/events/fathers_day/happy_fathers_day",
    "publisher": {
      "id": "pub-4627517680249670",
      "ext": {
        "country": "US"
      }
    } 
    },
    "imp": [
      {
        "tagid" : "makersalley_plain",
        "id": "some-impression-id",
        "banner": {
          "format": [
            {
              "w": 300,
              "h": 250
            },
            {
              "w": 300,
              "h": 600
            }
          ]
        },
        "ext": {
          "triplelift" : { "inventoryCode":"makersalley_main"} 
        }
      }
    ],
    "tmax": 500
  }

request from prebid to tl

"{
  "id": "some-request-id",
  "imp": [
    {
      "id": "some-impression-id",
      "banner": {
        "format": [
          {
            "w": 300,
            "h": 250
          },
          {
            "w": 300,
            "h": 600
          }
        ]
      },
      "tagid": "makersalley_plain",
      "ext": {
        "bidder": {
          "inventoryCode": "makersalley_main"
        }
      }
    }
  ],
  "site": {
    "page": "https://www.123greetings.com/events/fathers_day/happy_fathers_day",
    "publisher": {
      "id": "pub-4627517680249670",
      "ext": {
        "country": "US"
      }
    },
    "ext": {
      "amp": 0
    }
  },
  "device": {
    "ua": "curl/7.43.0",
    "ip": "::1"
  },
  "at": 1,
  "tmax": 500
}"

response from prebid

"{
  "id": "some-request-id",
  "seatbid": [
    {
      "bid": [
        {
          "id": "21524535241656531860",
          "impid": "some-impression-id",
          "price": 3.338,
          "adm": "<script>document.createElement('IMG').src=\"https://tlx.3lift.net/s2s/notify?px=1&ts=1560870964&aid=21524535241656531860&ec=260_9_2763332&n=GqsBaHR0cDovL2V4Y2hhbmdlLXRlc3Rlci50cmlwbGVsaWZ0Lm5ldDo4MDc3L25vdGlmeT9pZD0yMTUyNDUzNTI0MTY1NjUzMTg2MCZwcmljZT0ke0FVQ1RJT05fUFJJQ0V9JmFiaWQ9MTU2MzA5ODUzODIwODY3NjYwNyZhaW1waWQ9MTU2MzA5ODUzODIwODY3NjYwNy0xLW51bGwmdHlwZT1CaWQyMlNlYXRz8gKeAQgAEhQyMTUyNDUzNTI0MTY1NjUzMTg2MBgAIAEohAIwCUABSABQAGABaABwmKMFkAEAmAEAqAH%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BsAGPKLgBAMABihrIAY8o4AGKGvABAPgB0imAAogbiAKKGpECAAAAAAAA8D%2BZAmZmZmZmZtY%2FoQIAAAAAAAAAAKgCALACBMgCAtgCAPECZmZmZmZm5j%2F4AoQCkAMA%2BAITiAMAkgMEYmNkZQ%3D%3D\";window.tl_auction_response_644731={\"settings\":{\"advertiser_name\":\"TEST ADVERTISER NAME\",\"viewability\":{},\"impression_pixels\":[\"https:\\/\\/ad.doubleclick22222.net\\/ad\\/N4406.282142.ADARAMEDIAINC.\\/B8015471.114430570;sz=1x1;ord=142248259412135895294\"],\"type\":\"image\",\"additional_data\":{\"uid\":\"8947252401186410784\",\"brid\":\"86424\",\"bmid\":\"260\",\"aid\":\"21524535241656531860\",\"ts\":\"1560870964\",\"sid\":\"9\"},\"logo_image_url\":\"http:\\/\\/ep.yimg.com\\/ay\\/entirelypets\\/animal-planet-bat-dog-costume-large-21.jpg\",\"format_id\":1,\"render_options_bm\":0},\"assets\":[{\"image_id\":-1,\"image_url\":\"https:\\/\\/fublag.files.wordpress.com\\/2009\\/04\\/gen66337.png\",\"heading\":\"Renaissance Curacao Seat 3\",\"caption\":\"Discover the hidden gem of the Caribbean\",\"clickthrough_url\":\"http:\\/\\/ag.yieldoptimizer22222.com\\/ag\\/event?type=click&gi=vHH2MVL_SjnGKP62Cib00jK0s2o-vYF4fY9KN-ZMFBizsiWz6ErQ6BZVg_BuhEdSMwuOZFakknl2X_IMznDSZwult3EAcf-2t5bLa92B_a55wqXvj8LVNcUw5THdrYVDkzGglcgDIGNJBHMXOMtXE8627ymU1e3DANpWp1TQam6TMsQptW1GkKjvN34QhFK0&ref_url=123greetings.com\"}]};</script><script src=\"//ib.3lift.net/ttj?inv_code=makersalley_main\" data-auction-response-id=\"644731\"></script>",
          "adomain": [
            "marriott.com"
          ],
          "iurl": "https://fublag.files.wordpress.com/2009/04/gen66337.png",
          "crid": "260_9_2763332",
          "w": 300,
          "h": 250,
          "ext": {
            "prebid": {
              "type": "native"
            },
            "bidder": {
              "triplelift_pb": {
                "format": 1
              }
            }
          }
        }
      ],
      "seat": "triplelift"
    }
  ],
  "ext": {
    "responsetimemillis": {
      "triplelift": 121
    },
    "tmaxrequest": 500
  }
}"

Kevin-P-Kerr · 2019-07-17T14:44:07Z

@hhhjort I've added some tests into the triplelifttest/exemplary directory. can you take a look?

adapters/triplelift/triplelift.go

guscarreon · 2019-07-17T22:01:38Z

openrtb_ext/bidders.go

@@ -135,7 +137,7 @@ func NewBidderParamsValidator(schemaDirectory string) (BidderParamValidator, err
 	for _, fileInfo := range fileInfos {
 		bidderName := strings.TrimSuffix(fileInfo.Name(), ".json")
 		if _, isValid := BidderMap[bidderName]; !isValid {
-			return nil, fmt.Errorf("File %s/%s does not match a valid BidderName.", schemaDirectory, fileInfo.Name())
+			return nil, fmt.Errorf("File %s/%s does not match a valid BidderName.", schemaDirectory, bidderName)


Please change line 140 to

140 return nil, fmt.Errorf("File %s/%s does not match a valid BidderName.", schemaDirectory, fileInfo.Name())

guscarreon

Left a question regarding the banner's width and height properties and: Can we add more test cases so we get a 95% code coverage?

╰─➤  go test -coverprofile=c.out
PASS
coverage: 80.6% of statements
ok      github.com/prebid/prebid-server/adapters/triplelift     0.019s
╰─➤  go tool cover -func=c.out
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:26:   getBidType              100.0%
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:34:   processImp              76.9%
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:58:   MakeRequests            73.9%
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:96:   getBidCount             100.0%
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:104:  MakeBids                81.0%
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:144:  NewTripleliftBidder     100.0%
github.com/prebid/prebid-server/adapters/triplelift/usersync.go:10:     NewTripleliftSyncer     100.0%
total:                                                                  (statements)            80.6%

adapters/triplelift/triplelift.go

Kevin-P-Kerr · 2019-07-30T21:51:30Z

github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:58: MakeRequests 73.9%

will do

Kevin-P-Kerr · 2019-07-31T20:58:28Z

Hey, @guscarreon , it seems that most of the lines not covered by the unit tests cover error conditions, like

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

Even though it's just a few lines, since these functions are all so short, that they aren't covered by the test procedures reduces code coverage pretty significantly.
But if I were to add a broken a request to the test, the test would fail.
Do you have any insight into how to test error conditions?

guscarreon · 2019-08-01T15:02:08Z

Hey, @guscarreon , it seems that most of the lines not covered by the unit tests cover error conditions, like
 if response.StatusCode != http.StatusOK {
        return nil, []error{fmt.Errorf("Unexpected status code: %d. Run with request.debug = 1 for more info", response.StatusCode)}
    }
Even though it's just a few lines, since these functions are all so short, that they aren't covered by the test procedures reduces code coverage pretty significantly.
But if I were to add a broken a request to the test, the test would fail.
Do you have any insight into how to test error conditions?

Hi @Kevin-P-Kerr. I believe the EqualError() function is useful for this purpose. Some test cases throughout the code base use it extensively:

./config/config_test.go:        assert.EqualError(t, errs[0], message)
./openrtb_ext/device_test.go:   assert.EqualError(t, json.Unmarshal([]byte(`{"prebid":{"interstitial":{"minwidthperc":85,"minheightperc":"75"}}}`), &s), "request.device.ext.prebid.interstitial.minheightperc must be a number between 0 and 100")
./openrtb_ext/site_test.go:     assert.EqualError(t, json.Unmarshal([]byte(`{"amp":-1}`), &s), "request.site.ext.amp must be either 1, 0, or undefined")
./adapters/info_test.go:        assert.EqualError(t, errs[0], "this bidder does not support app requests")

Kevin-P-Kerr · 2019-08-02T22:45:04Z

@guscarreon cumulative test coverage is now 95 percent.

[kkerr_local triplelift]$ go test -coverprofile=c.out
PASS
coverage: 95.5% of statements
ok  	github.com/prebid/prebid-server/adapters/triplelift	0.017s
[kkerr_local triplelift]$ go tool cover -func=c.out
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:26:	getBidType		100.0%
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:34:	processImp		100.0%
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:58:	MakeRequests		91.3%
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:96:	getBidCount		100.0%
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:104:	MakeBids		95.2%
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:144:	NewTripleliftBidder	100.0%
github.com/prebid/prebid-server/adapters/triplelift/usersync.go:10:	NewTripleliftSyncer	100.0%
total:									(statements)		95.5%

guscarreon · 2019-08-05T15:45:18Z

@guscarreon cumulative test coverage is now 95 percent.

[kkerr_local triplelift]$ go test -coverprofile=c.out
PASS
coverage: 95.5% of statements
ok  	github.com/prebid/prebid-server/adapters/triplelift	0.017s
[kkerr_local triplelift]$ go tool cover -func=c.out
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:26:	getBidType		100.0%
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:34:	processImp		100.0%
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:58:	MakeRequests		91.3%
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:96:	getBidCount		100.0%
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:104:	MakeBids		95.2%
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:144:	NewTripleliftBidder	100.0%
github.com/prebid/prebid-server/adapters/triplelift/usersync.go:10:	NewTripleliftSyncer	100.0%
total:									(statements)		95.5%

Kevin, some Travis errors seem to have popped up with this last update, can we correct them?

Kevin-P-Kerr · 2019-08-05T18:02:26Z

@guscarreon cumulative test coverage is now 95 percent.

[kkerr_local triplelift]$ go test -coverprofile=c.out
PASS
coverage: 95.5% of statements
ok  	github.com/prebid/prebid-server/adapters/triplelift	0.017s
[kkerr_local triplelift]$ go tool cover -func=c.out
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:26:	getBidType		100.0%
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:34:	processImp		100.0%
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:58:	MakeRequests		91.3%
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:96:	getBidCount		100.0%
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:104:	MakeBids		95.2%
github.com/prebid/prebid-server/adapters/triplelift/triplelift.go:144:	NewTripleliftBidder	100.0%
github.com/prebid/prebid-server/adapters/triplelift/usersync.go:10:	NewTripleliftSyncer	100.0%
total:									(statements)		95.5%

Kevin, some Travis errors seem to have popped up with this last update, can we correct them?

hey @guscarreon I think github might have just froze up or something.

 Cloning into '/home/travis/gopath/pkg/dep/sources/https---github.com-stretchr-objx'...
485fatal: unable to access 'https://github.com/stretchr/objx/': Failed to connect to github.com port 443: Connection timed out
486: command failed: [git clone --recursive -v --progress https://github.com/stretchr/objx /home/travis/gopath/pkg/dep/sources/https---github.com-stretchr-objx]: exit status 128
487The command "$GOPATH/bin/dep ensure" failed and exited with 1 during .

seems like it couldn't access this strechr-objx dependency. Anyway we can retrigger?

guscarreon

@Kevin-P-Kerr seems like Github was having problems because for some reason the Travis build seems to have built correctly this time around. Thanks for your patience, your adapter looks awesome.

Kevin-P-Kerr · 2019-08-05T20:18:54Z

@Kevin-P-Kerr seems like Github was having problems because for some reason the Travis build seems to have built correctly this time around. Thanks for your patience, your adapter looks awesome.

Thanks! What are the next steps in this process?

hhhjort · 2019-08-06T12:46:50Z

adapters/triplelift/triplelift.go

+	}
+	imp.TagID = tlext.InvCode
+	// floor is optional
+	if tlext.Floor == nil {


Could just have if tlext.Floor != nil { imp.BidFloor = *tlext.Floor } as you return nil in either case

ah good point, that's a bit more parsimonious. but it seems this is already merged. if I have to patch later I'll take this idea and apply it though.

hhhjort

Looks good, one minor thing, but shouldn't block approval.

hhhjort · 2019-09-09T19:33:35Z

@Kevin-P-Kerr : Just noticed that the user sync URL makes no reference to the PBS URL ... there is no way for your usersync endpoint to send the user ID back to the particular PBS installation.

Kevin-P-Kerr · 2019-09-11T17:30:34Z

@hhhjort I'm not totally following. Can you elaborate? What steps should I take to rectify this?

hhhjort · 2019-09-11T18:19:06Z

Look at https://github.com/prebid/prebid-server/blob/master/docs/developers/cookie-syncs.md

Basically, your cookie sync endpoint needs to redirect back to the supplied URL and include the user's Triplelift ID so that PBS can populate user.id in the request with your ID. This will allow you to do user targeting. You cannot rely on your own cookie, as the bid request will come from the PBS machine, and it does not have access to the user's triplelift cookie.

Kevin-P-Kerr · 2019-09-13T19:48:20Z

Look at https://github.com/prebid/prebid-server/blob/master/docs/developers/cookie-syncs.md

Basically, your cookie sync endpoint needs to redirect back to the supplied URL and include the user's Triplelift ID so that PBS can populate user.id in the request with your ID. This will allow you to do user targeting. You cannot rely on your own cookie, as the bid request will come from the PBS machine, and it does not have access to the user's triplelift cookie.

Ok, thanks for the clarification. We'll schedule some time to get a fix in.

* ignore swp files * start small * start really small * add a user sync * justify * triplelift adapter * add our endpoint * fix syntax * config stuff * compiler fixes * more config * add params * making progress * make our ext more exty * start making responses * more logic * fix compilation errors * can we just nil this out? * augment our json * radically simplify our json * fix errs * infer the bid type * fix syntax * fix comilation errors * rename * fix compilation error * config stuff * simplify params * more config stuff * fixes * revert this * fix up the extension * getting closer * add a test * update config * update bidder params * add the floor here, too * add a usersync test * validation, ws, and a test * update tests * fix test * update email * why not * change email * preprocess requests * do some parsing * take care of some errors * floor is optional * ws * remove native * everything is either banner or video * this should be a float * floor to floor * fix compilation errors * add some tests * more tests * more tests * simplify * more progress * format * ws * rm * don't need this * fix test * fix test * don't ignore swap * change line back * report an error if there are no valid impressions for triplelift * check for either a Banner or Video object on the impression * more tests * mv * more tests

Kevin-P-Kerr added 30 commits June 13, 2019 15:51

ignore swp files

d2b2e19

start small

d210145

start really small

3acedbe

add a user sync

04a6137

justify

5babcb1

triplelift adapter

a55a9c1

add our endpoint

3c4ccbc

fix syntax

44f921b

config stuff

f9d30c4

compiler fixes

9f299fe

more config

bc3b636

add params

408c011

making progress

e7cb43d

make our ext more exty

cf6bbe8

start making responses

61f72b3

more logic

d9b8c59

fix compilation errors

c6e5f55

can we just nil this out?

a57cfde

augment our json

1707d8a

radically simplify our json

6d3a72e

fix errs

e1efc38

infer the bid type

0a25607

fix syntax

856f3ab

fix comilation errors

c46c510

rename

f49c552

fix compilation error

7bd8bb0

config stuff

2a6c2be

simplify params

dae5782

more config stuff

b1aa20d

fixes

796ab7a

Merge remote-tracking branch 'origin/master' into HEAD

329cbc1

guscarreon requested changes Jul 17, 2019

View reviewed changes

Kevin-P-Kerr added 3 commits July 23, 2019 15:28

change line back

88e4261

report an error if there are no valid impressions for triplelift

7898b4e

check for either a Banner or Video object on the impression

f83bdab

guscarreon reviewed Jul 29, 2019

View reviewed changes

adapters/triplelift/triplelift.go Show resolved Hide resolved

Kevin-P-Kerr added 3 commits August 2, 2019 18:24

more tests

45f6749

mv

7feeb75

more tests

f21041d

guscarreon approved these changes Aug 5, 2019

View reviewed changes

guscarreon assigned hhhjort and unassigned guscarreon Aug 5, 2019

hhhjort reviewed Aug 6, 2019

View reviewed changes

hhhjort approved these changes Aug 6, 2019

View reviewed changes

guscarreon merged commit 1de99fa into prebid:master Aug 6, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TripleLift Prebid S2S Adapter #954

TripleLift Prebid S2S Adapter #954

Kevin-P-Kerr commented Jul 8, 2019

Kevin-P-Kerr commented Jul 17, 2019

guscarreon Jul 17, 2019

guscarreon left a comment

Kevin-P-Kerr commented Jul 30, 2019

Kevin-P-Kerr commented Jul 31, 2019

guscarreon commented Aug 1, 2019

Kevin-P-Kerr commented Aug 2, 2019

guscarreon commented Aug 5, 2019

Kevin-P-Kerr commented Aug 5, 2019

guscarreon left a comment

Kevin-P-Kerr commented Aug 5, 2019

hhhjort Aug 6, 2019

Kevin-P-Kerr Aug 7, 2019

hhhjort left a comment

hhhjort commented Sep 9, 2019

Kevin-P-Kerr commented Sep 11, 2019

hhhjort commented Sep 11, 2019

Kevin-P-Kerr commented Sep 13, 2019

TripleLift Prebid S2S Adapter #954

TripleLift Prebid S2S Adapter #954

Conversation

Kevin-P-Kerr commented Jul 8, 2019

Kevin-P-Kerr commented Jul 17, 2019

guscarreon Jul 17, 2019

Choose a reason for hiding this comment

guscarreon left a comment

Choose a reason for hiding this comment

Kevin-P-Kerr commented Jul 30, 2019

Kevin-P-Kerr commented Jul 31, 2019

guscarreon commented Aug 1, 2019

Kevin-P-Kerr commented Aug 2, 2019

guscarreon commented Aug 5, 2019

Kevin-P-Kerr commented Aug 5, 2019

guscarreon left a comment

Choose a reason for hiding this comment

Kevin-P-Kerr commented Aug 5, 2019

hhhjort Aug 6, 2019

Choose a reason for hiding this comment

Kevin-P-Kerr Aug 7, 2019

Choose a reason for hiding this comment

hhhjort left a comment

Choose a reason for hiding this comment

hhhjort commented Sep 9, 2019

Kevin-P-Kerr commented Sep 11, 2019

hhhjort commented Sep 11, 2019

Kevin-P-Kerr commented Sep 13, 2019