New Adapter: FeedAd #4104

andwun · 2024-12-13T15:39:02Z

This PR adds the FeedAd PBS adapter
Docs PR: prebid/prebid.github.io#5776

github-actions · 2024-12-13T15:39:52Z

Code coverage summary

Note:

Prebid team doesn't anticipate tests covering code paths that might result in marshal and unmarshal errors
Coverage summary encompasses all commits leading up to the latest one, 67f84c8

feedad

Refer here for heat map coverage report

github.com/prebid/prebid-server/v3/adapters/feedad/feedad.go:17:	getHeaders	90.9%
github.com/prebid/prebid-server/v3/adapters/feedad/feedad.go:41:	MakeBids	66.7%
github.com/prebid/prebid-server/v3/adapters/feedad/feedad.go:84:	MakeRequests	80.0%
github.com/prebid/prebid-server/v3/adapters/feedad/feedad.go:100:	Builder		100.0%
total:									(statements)	77.8%

SyntaxNode · 2024-12-13T19:28:44Z

adapters/feedad/feedad.go

+	headers.Add("Accept", "application/json")
+	headers.Add("Content-Type", "application/json;charset=utf-8")
+	headers.Add("X-FA-PBS-Adapter-Version", feedAdAdapterVersion)
+	headers.Add("X-Openrtb-Version", "2.5")


Are you able to support OpenRTB 2.6 instead?

I’m afraid, we don’t have support for oRTB 2.6, yet, but it’s on our roadmap for next year.
Can we please start with oRTB 2.5 for now?

adapters/feedad/feedadtest/exemplary/banner-web.json

adapters/feedad/params_test.go

…son/

github-actions · 2024-12-17T12:01:30Z

Code coverage summary

Note:

Prebid team doesn't anticipate tests covering code paths that might result in marshal and unmarshal errors
Coverage summary encompasses all commits leading up to the latest one, 842aee5

feedad

Refer here for heat map coverage report

github.com/prebid/prebid-server/v3/adapters/feedad/feedad.go:17:	getHeaders	90.9%
github.com/prebid/prebid-server/v3/adapters/feedad/feedad.go:41:	MakeBids	66.7%
github.com/prebid/prebid-server/v3/adapters/feedad/feedad.go:84:	MakeRequests	80.0%
github.com/prebid/prebid-server/v3/adapters/feedad/feedad.go:100:	Builder		100.0%
total:									(statements)	77.8%

bsardo · 2025-01-22T19:31:37Z

@Rothalack can you please review?

Rothalack · 2025-01-27T16:02:24Z

I've sent a verification email to your maintainer email.

andwun · 2025-01-27T16:40:48Z

Hi @Rothalack , you should have received a response to your confirmation email.

Rothalack · 2025-01-27T17:06:03Z

I got the response, thank you!

bsardo · 2025-01-28T19:30:54Z

adapters/feedad/params_test.go

+var invalidParams = []string{
+	`{}`,
+	`{"clientToken":"","placementId":"some-placementid"}`,
+	`{"clientToken":"some-clienttoken","placementId":""}`,
+	`{"clientToken":"some-clienttoken","placementId":"some-placementid","sdkOptions":"complete-garbage"}`,
+	`{"clientToken":"some-clienttoken","placementId":"some-placementid","sdkOptions":{"advertising_id":{}}}`,
+	`{"clientToken":"some-clienttoken","placementId":"some-placementid","sdkOptions":{"advertising_id":{}}}`,
+	`{"clientToken":"some-clienttoken","placementId":"some-placementid","sdkOptions":{"app_name":{}}}`,
+	`{"clientToken":"some-clienttoken","placementId":"some-placementid","sdkOptions":{"bundle_id":{}}}`,
+	`{"clientToken":"some-clienttoken","placementId":"some-placementid","sdkOptions":{"hybrid_platform":{}}}`,
+	`{"clientToken":"some-clienttoken","placementId":"some-placementid","sdkOptions":{"limit_ad_tracking":{}}}`,


I suggest adding some more invalid param test cases to ensure that your regex for placementId is correct.

bsardo · 2025-01-28T19:31:06Z

adapters/feedad/params_test.go

+var validParams = []string{
+	`{"clientToken":"some-clienttoken","placementId":"some-placementid"}`,
+	`{"clientToken":"some-clienttoken","placementId":"some-placementid","sdkOptions":{}}`,
+	`{"clientToken":"some-clienttoken","placementId":"some-placementid","sdkOptions":{"hybrid_platform":"ios"}}`,
+	`{"clientToken":"some-clienttoken","placementId":"some-placementid","sdkOptions":{"hybrid_platform":"windows"}}`,
+	`{"clientToken":"some-clienttoken","decoration":"some-decoration","placementId":"some-placementid","sdkOptions":{"advertising_id":"","app_name":"","bundle_id":"","hybrid_app":false,"hybrid_platform":"","limit_ad_tracking":false}}`,
+	`{"clientToken":"some-clienttoken","decoration":"some-decoration","placementId":"some-placementid","sdkOptions":{"advertising_id":"some-advertisingid","app_name":"some-appname","bundle_id":"some-bundleid","hybrid_app":true,"hybrid_platform":"android","limit_ad_tracking":true}}`,
+}


I suggest adding some more valid param test cases to ensure that your regex for placementId is correct.

bsardo · 2025-01-28T19:36:21Z

static/bidder-info/feedad.yaml

@@ -0,0 +1,17 @@
+endpoint: "https://ortb.feedad.com/1/prebid/requests"


Verified endpoint is reachable:

curl -i --location --request POST https://ortb.feedad.com/1/prebid/requests HTTP/2 400 cache-control: private, no-cache, no-store content-type: text/plain; charset=utf-8 x-cloud-trace-context: 1330f4943e1c24fead2cd0c791a59b3d date: Tue, 28 Jan 2025 19:35:58 GMT server: Google Frontend content-length: 15 via: 1.1 google alt-svc: h3=":443"; ma=2592000,h3-29=":443"; ma=2592000 400 Bad Request

bsardo · 2025-01-28T19:38:49Z

static/bidder-info/feedad.yaml

+endpointCompression: gzip
+maintainer:
+  email: support@feedad.com
+gvlVendorID: 781


Verified GVL ID

curl https://vendor-list.consensu.org/v3/vendor-list.json | jq '.vendors."781"' % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 100 658k 100 658k 0 0 3647k 0 --:--:-- --:--:-- --:--:-- 3640k { "id": 781, "name": "FeedAd GmbH", "purposes": [ 1, 3, 4, 5, 6, 8, 9 ], "legIntPurposes": [ 2, 7, 10 ], "flexiblePurposes": [ 2, 7, 10 ], "specialPurposes": [ 1, 2, 3 ], "features": [ 2, 3 ], "specialFeatures": [ 1, 2 ], "overflow": { "httpGetLimit": 128 }, "cookieMaxAgeSeconds": 2592000, "usesCookies": true, "cookieRefresh": true, "urls": [ { "langId": "en", "privacy": "https://feedad.com/privacy/", "legIntClaim": "https://feedad.com/privacy/#legal-basis" } ], "usesNonCookieAccess": true, "dataRetention": { "stdRetention": 30, "purposes": {}, "specialPurposes": { "3": 4320 } }, "dataDeclaration": [ 1, 2, 3, 6, 7, 8, 9, 10, 11 ], "deviceStorageDisclosureUrl": "https://api.feedad.com/tcf-device-disclosures.json" }

bsardo · 2025-01-28T20:14:43Z

static/bidder-info/feedad.yaml

+  iframe:
+    url: https://ortb.feedad.com/1/usersyncs/supply?gdpr={{.GDPR}}&gdpr_consent={{.GDPRConsent}}&gpp={{.GPP}}&gpp_sid={{.GPPSID}}&us_privacy={{.USPrivacy}}&redirect={{.RedirectURL}}
+    userMacro: $UID


I'm getting a 404 using this URL generated by my localhost cookie_sync endpoint: https://ortb.feedad.com/1/usersyncs/supply?gdpr=0&gdpr_consent=CQL_D2nQL_D2nPjAAAENCZCAAP_AAH_AAAAAGGwAQGGgYbABAYaAAA.II7Nd_X__bX9n-_7_6ft0eY1f9_r37uQzDhfNs-8F3L_W_LwX32E7NF36tq4KmR4ku1bBIQNtHMnUDUmxaolVrzHsak2cpyNKJ_JkknsZe2dYGF9Pn9lD-YKZ7_5_9_f52T_9_9_-39z3_9f___dv_-__-vjf_599n_v9fV_78_Kf9______-____________8A&gpp=&gpp_sid=&us_privacy=&redirect=http%3A%2F%2Flocalhost%3A8000%2Fsetuid%3Fbidder%3Dfeedad%26gdpr%3D0%26gdpr_consent%3DCQL_D2nQL_D2nPjAAAENCZCAAP_AAH_AAAAAGGwAQGGgYbABAYaAAA.II7Nd_X__bX9n-_7_6ft0eY1f9_r37uQzDhfNs-8F3L_W_LwX32E7NF36tq4KmR4ku1bBIQNtHMnUDUmxaolVrzHsak2cpyNKJ_JkknsZe2dYGF9Pn9lD-YKZ7_5_9_f52T_9_9_-39z3_9f___dv_-__-vjf_599n_v9fV_78_Kf9______-____________8A%26gpp%3D%26gpp_sid%3D%26f%3Db%26uid%3D%24UID

Yes, actually you should be getting a 400 Bad Request, since we only allow the scheme https in redirect urls.

Quick curl example with example.com:

curl -i --location 'https://ortb.feedad.com/1/usersyncs/supply?gdpr=0&gdpr_consent=CQL_D2nQL_D2nPjAAAENCZCAAP_AAH_AAAAAGGwAQGGgYbABAYaAAA.II7Nd_X__bX9n-_7_6ft0eY1f9_r37uQzDhfNs-8F3L_W_LwX32E7NF36tq4KmR4ku1bBIQNtHMnUDUmxaolVrzHsak2cpyNKJ_JkknsZe2dYGF9Pn9lD-YKZ7_5_9_f52T_9_9_-39z3_9f___dv_-__-vjf_599n_v9fV_78_Kf9______-____________8A&gpp=&gpp_sid=&us_privacy=&redirect=https%3A%2F%2Fexample.com%2F%24UID' HTTP/2 200 cache-control: private, no-cache, no-store content-type: text/html; charset=utf-8 x-cloud-trace-context: f012169dfb1e168d52f044ad1f228369 date: Wed, 29 Jan 2025 11:19:14 GMT server: Google Frontend content-length: 150 via: 1.1 google alt-svc: h3=":443"; ma=2592000,h3-29=":443"; ma=2592000 <!DOCTYPE html> <html lang="en"> <iframe src="https://example.com/23f687c1-f025-434f-b26b-b6773d1b3a5f" style="display: none;"></iframe> </html>

Verified cookie sync iframe works by sending a request generated by my localhost cookie sync endpoint with https://localhost:8000/setuid as the redirect param. Received 200 response with iframe html element. Modified the iframe url from https to http and manually triggered that url to verify it hit my localhost setuid endpoint where the cookie was verified to contain the feedad id.

bsardo · 2025-01-28T21:37:49Z

adapters/feedad/feedad.go

+
+	if request.Device != nil {
+		if len(request.Device.IPv6) > 0 {
+			headers.Add("X-Forwarded-For", request.Device.IPv6)


Please either modify your banner-app.json or banner-site.json test to have an ipv6 instead of ip or add a supplemental JSON test that has ipv6 set to cover this case.

bsardo · 2025-01-28T21:41:48Z

adapters/feedad/feedad.go

+	if responseData.StatusCode == http.StatusNoContent {
+		return nil, nil
+	}
+
+	if responseData.StatusCode == http.StatusBadRequest {
+		err := &errortypes.BadInput{
+			Message: "Unexpected status code: 400. Bad request from publisher. Run with request.debug = 1 for more info.",
+		}
+		return nil, []error{err}
+	}
+
+	if responseData.StatusCode != http.StatusOK {
+		err := &errortypes.BadServerResponse{
+			Message: fmt.Sprintf("Unexpected status code: %d. Run with request.debug = 1 for more info.", responseData.StatusCode),
+		}
+		return nil, []error{err}
+	}


I understand that the prebid docs do not reflect this yet but please use the adapter utility functions adapters/response.go#IsResponseStatusCodeNoContent and adapters/response.go#CheckResponseStatusCodeForErrors to handle invalid status codes.

bsardo · 2025-01-28T21:43:46Z

adapters/feedad/feedad.go

+	if responseData.StatusCode == http.StatusNoContent {
+		return nil, nil
+	}
+
+	if responseData.StatusCode == http.StatusBadRequest {
+		err := &errortypes.BadInput{
+			Message: "Unexpected status code: 400. Bad request from publisher. Run with request.debug = 1 for more info.",
+		}
+		return nil, []error{err}
+	}
+
+	if responseData.StatusCode != http.StatusOK {
+		err := &errortypes.BadServerResponse{
+			Message: fmt.Sprintf("Unexpected status code: %d. Run with request.debug = 1 for more info.", responseData.StatusCode),
+		}
+		return nil, []error{err}
+	}


Please add supplemental JSON tests for status codes 204, 400 and 500.

bsardo · 2025-01-28T21:44:36Z

adapters/feedad/feedad.go

+	var response openrtb2.BidResponse
+	err := jsonutil.Unmarshal(responseData.Body, &response)
+	if err != nil {
+		return nil, []error{err}


Please add a supplemental JSON test case where the response is malformed. This can be done by simply setting the mock response body to a string instead of a JSON object.

bsardo · 2025-01-28T21:51:41Z

adapters/feedad/feedad.go

+	}
+
+	requestData := &adapters.RequestData{
+		Method:  "POST",


Nitpick: I suggest using http.MethodPost instead of "POST".

… device.ip, added field device.ipv6

…o-device.json test case

…eStatusCodeNoContent,CheckResponseStatusCodeForErrors}()

…0 and 500 responses

…d response

github-actions · 2025-01-29T14:01:50Z

Code coverage summary

Note:

Prebid team doesn't anticipate tests covering code paths that might result in marshal and unmarshal errors
Coverage summary encompasses all commits leading up to the latest one, 770ffd8

feedad

Refer here for heat map coverage report

github.com/prebid/prebid-server/v3/adapters/feedad/feedad.go:15:	getHeaders	100.0%
github.com/prebid/prebid-server/v3/adapters/feedad/feedad.go:39:	MakeBids	100.0%
github.com/prebid/prebid-server/v3/adapters/feedad/feedad.go:72:	MakeRequests	80.0%
github.com/prebid/prebid-server/v3/adapters/feedad/feedad.go:88:	Builder		100.0%
total:									(statements)	96.9%

andwun · 2025-01-29T14:01:57Z

Thank you @bsardo for reviewing this PR.
All your feedback should be addressed by the new commits.

bsardo

LGTM!

guscarreon · 2025-01-29T22:28:32Z

adapters/feedad/feedad.go

+			headers.Add("X-Forwarded-For", request.Device.IPv6)
+		}
+
+		if len(request.Device.IP) > 0 {


Under this logic, if a request comes with both root.device.ip and root.device.ipv6, ipv4 would get prioritized over ipv6. Is this convenient? Or should the order of the if statements be reversed to prioritize ipv6 into the X-Forwarded-For header if a request with both values comes in?

. . "device": { "ua": "test-user-agent", "ip": "123.123.123.123", "ipv6": "2001:db8:3333:4444:5555:6666:7777:8888", "language": "en", "dnt": 0 }, . .

For us, this doesn't really matter.
The only real use case I can think of for looking at the header, would be filtering traffic before it reaches our API.
When processing in the API, we still have both fields ip and ipv6 in the request payload.

Can this really happen that both fields are filled anyway?
Isn't the client IP usually taken from the IP connection the device is connecting to the server?
How can it connect with both IPv4 and IPv6?

Anyway, I don't see a real issue here to be honest.

guscarreon · 2025-01-29T22:30:42Z

adapters/feedad/feedad.go

+				bidResponse.Bids,
+				&adapters.TypedBid{
+					Bid:     &seatBid.Bid[i],
+					BidType: openrtb_ext.BidTypeBanner,


Do we expect all of the bids to be banners? Is there a possibility now or in the future that we get Video, Native or Audio? If so, should we grab the type from the response instead of hard-coding the banner value?

57 for _, seatBid := range response.SeatBid { 58 for i := range seatBid.Bid { + mediaType, err := getMediaTypeForBid(&seatBid.Bid[i]) + if err != nil { + continue + } 59 bidResponse.Bids = append( 60 bidResponse.Bids, 61 &adapters.TypedBid{ 62 Bid: &seatBid.Bid[i], 63 - BidType: openrtb_ext.BidTypeBanner, + mediaType, 64 }, 65 ) 66 } 67 } adapters/feedad/feedad.go

Yes, we only support banners right now.
See feedad.yaml:

capabilities: app: mediaTypes: - banner site: mediaTypes: - banner

andwun · 2025-01-29T23:08:39Z

Thank you @guscarreon for reviewing.
I tried to address your comments inline.
Please take another look and let me know what you think.

guscarreon

LGTM. Thanks @andwun

andwun added 2 commits December 13, 2024 16:25

Import initial version of FeedAd PBS adapter

0b0bf7b

static.bidder-info: feedad.yaml: Added GPP macros to user sync URL

67f84c8

andwun mentioned this pull request Dec 13, 2024

FeedAd: Update docs for PBS, GPP and USP support prebid/prebid.github.io#5776

Merged

8 tasks

bsardo changed the title ~~FeedAd: Initial version of PBS adapter~~ New Adapter: FeedAd Dec 13, 2024

SyntaxNode reviewed Dec 13, 2024

View reviewed changes

andwun added 2 commits December 17, 2024 11:50

adapters.feedad.feedadtest.exemplary: s/banner-web.json/banner-site.j…

29a94e9

…son/

adapters.feedad: params_test.go: Updated tests to match Prebid template

842aee5

andwun requested a review from SyntaxNode December 17, 2024 12:03

bsardo added the adapter label Jan 6, 2025

bsardo self-assigned this Jan 20, 2025

bsardo assigned guscarreon and unassigned guscarreon Jan 24, 2025

bsardo assigned guscarreon Jan 28, 2025

bsardo reviewed Jan 28, 2025

View reviewed changes

andwun added 8 commits January 29, 2025 12:08

adapters.feedad: Added more test cases for param placementId

56414de

adapters.feedad: TestJsonSamples: Swapped to fake endpoint

8a62f12

adapters.feedad.feedadtest.exemplary: banner-site.json: Removed field…

f41630f

… device.ip, added field device.ipv6

adapters.feedad.feedadtest: Added supplemental dir with banner-site-n…

3c9cd9e

…o-device.json test case

adapters.feedad: adapter.MakeBids: Updated to use adapters.{IsRespons…

8e1dcfe

…eStatusCodeNoContent,CheckResponseStatusCodeForErrors}()

adapters.feedad.feedadtest.supplemental: Added test cases for 204, 40…

4092931

…0 and 500 responses

adapters.feedad.feedadtest.supplemental: Added test case for malforme…

acb6af1

…d response

adapters.feedad: MakeRequests: Use http.MethodPost

770ffd8

bsardo approved these changes Jan 29, 2025

View reviewed changes

guscarreon reviewed Jan 29, 2025

View reviewed changes

guscarreon approved these changes Jan 30, 2025

View reviewed changes

bsardo merged commit a266557 into prebid:master Jan 30, 2025
6 checks passed

cross-repo-issue-creation bot mentioned this pull request Jan 30, 2025

Port PR from PBS-Go: New Adapter: FeedAd prebid/prebid-server-java#3718

Open

		@@ -0,0 +1,17 @@
		endpoint: "https://ortb.feedad.com/1/prebid/requests"

New Adapter: FeedAd #4104

New Adapter: FeedAd #4104

Conversation

andwun commented Dec 13, 2024 • edited Loading

github-actions bot commented Dec 13, 2024

Code coverage summary

feedad

Choose a reason for hiding this comment

andwun Dec 17, 2024 • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Dec 17, 2024

Code coverage summary

feedad

bsardo commented Jan 22, 2025

Rothalack commented Jan 27, 2025

andwun commented Jan 27, 2025

Rothalack commented Jan 27, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bsardo Jan 29, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jan 29, 2025

Code coverage summary

feedad

andwun commented Jan 29, 2025

bsardo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andwun commented Jan 29, 2025

guscarreon left a comment

Choose a reason for hiding this comment

andwun commented Dec 13, 2024 •

edited

Loading

andwun Dec 17, 2024 •

edited

Loading

bsardo Jan 29, 2025 •

edited

Loading