New Adapter: Aax #2219

product-aax · 2022-04-13T07:19:42Z

Adds Aax Bidder Adapter.
Vendor ID: 720
Maintainer Email: product@aax.media

AlexBVolcy

Could you re-name this pull request to: "New Adapter: Aax"

Just to follow naming conventions with how we handle new adapters PRs.

VeronikaSolovei9

LGTM

AlexBVolcy · 2022-04-14T03:33:46Z

adapters/aax/aax.go

+		for i := range sb.Bid {
+			bidType, err := getMediaTypeForImp(sb.Bid[i].ImpID, internalRequest.Imp)
+			if err != nil {
+				errs = append(errs, err)


Could you add a test case for this error

Added, Thanks.

AlexBVolcy · 2022-04-14T03:34:36Z

adapters/aax/aax.go

+
+	bidResponse := adapters.NewBidderResponse()
+
+	for _, sb := range bidResp.SeatBid {


Nitpick: could you rename sb to be seatBid

VeronikaSolovei9 · 2022-04-14T20:48:29Z

adapters/aax/aax.go

+	}, nil
+}
+
+func getMediaTypeForImp(impID string, imps []openrtb2.Imp) (openrtb_ext.BidType, error) {


We discussed this PR with a team. There is one thing for you to consider. I case if imp has multi format this function may return incorrect bid type. We recommend to extract mediaType from response. Here is the example for reference:

prebid-server/adapters/algorix/algorix.go

Line 190 in 74d2199

func getBidType(bid openrtb2.Bid, imps []openrtb2.Imp) (openrtb_ext.BidType, error) {

Other than this this PR loos good to me.

Want to second what @VeronikaSolovei9 stated above. This PR also looks good to me, but just want to bring up this update.

Done, Thanks !

This is not really what is needed. You need to pass bid openrtb2.Bid and take media type from bidExtention.MediaType if you support this. If you modified this function to verify impression had multi format and throw error - then this should be done in MakeRequests function.

Noted, Let me fix it.

I'm confused, did you change it? I'm looking for something like this:

type aaxResponseBidExt struct { // Aax specific bid ext if yu know the format and return bid type in bid.ext MediaType string `json:"mediaType"` } //pass bid itself to the function, should be seatBid.Bid[i] func getMediaTypeForImp(bid openrtb2.Bid, imps []openrtb2.Imp) (openrtb_ext.BidType, error) { var bidExt aaxResponseBidExt err := json.Unmarshal(bid.Ext, &bidExt) //unmarshall bid ext to struct and extract bid type from it if err == nil { switch bidExt.MediaType { case "banner": return openrtb_ext.BidTypeBanner, nil case "native": return openrtb_ext.BidTypeNative, nil case "video": return openrtb_ext.BidTypeVideo, nil } } // if type was not returned till this moment - extract it from imp, you have this part already var mediaType openrtb_ext.BidType var typeCnt = 0 for _, imp := range imps { if imp.ID == bid.ImpID { //bid has imp id in it, you don't need to pass it to function separately if imp.Banner != nil { typeCnt += 1 mediaType = openrtb_ext.BidTypeBanner } if imp.Native != nil { typeCnt += 1 mediaType = openrtb_ext.BidTypeNative } if imp.Video != nil { typeCnt += 1 mediaType = openrtb_ext.BidTypeVideo } } } if typeCnt == 1 { return mediaType, nil } return mediaType, fmt.Errorf("unable to fetch mediaType in multi-format: %s", bid.ImpID) }

No No, Have not pushed anything yet.

Now I have pushed the changes.

Oh right, it looks good now, thank you for the update!

SyntaxNode · 2022-04-20T15:56:57Z

static/bidder-info/aax.yaml

+userSync:
+  redirect:
+    url: https://c.aaxads.com/aacxc.php?fv=1&wbsh=psa&ryvlg=setstatuscode&bidder=aax&gdpr={{.GDPR}}&gdpr_consent={{.GDPRConsent}}&us_privacy={{.USPrivacy}}&redirect={{.RedirectURL}}
+    userMacro: ${UUID}


When I test this user sync url, I get a 200 response instead of a redirect.

Isn't that the case with every bidder as well ?

Nope. The expectation is for the user sync endpoint to apply the appropriate privacy policies, decode the redirect url from url encoded, replace the user macro with the user's id, and then perform a 302 redirect to the url. PBS will be the target of the redirect and update the user sync cookie.

@SyntaxNode Can you post any ref. of bidder adapter .yaml where we can see this behaviour ? Because when I am hitting /cookie_sync endpoint I am getting redirect URL.

@product-aax Certainly. You can look at appnexus.yaml and visx.yaml for fully compliant examples. For appnexus.yaml:

This is what they define in as their user sync:

redirect: url: "https://ib.adnxs.com/getuid?{{.RedirectURL}}" userMacro: "$UID"

Here is an example of the generated url by the cookie sync endpoint. This example comes from the AppNexus Prebid Server host.

https://ib.adnxs.com/getuid?https%3A%2F%2Fprebid.adnxs.com%2Fpbs%2Fv1%2Fsetuid%3Fbidder%3Dadnxs%26gdpr%3D0%26gdpr_consent%3D%26f%3Di%26uid%3D%24UID

The redirect url looks like the following when it is url decoded:

https://prebid.adnxs.com/pbs/v1/setuid?bidder=adnxs&gdpr=0&gdpr_consent=&f=i&uid=$UID

The AppNexus user sync endpoint will decode the redirect url, replace the $UID macro with a the user's value from the AppNexus cookie and respond with the following redirect:

https://ib.adnxs.com/prebid/setuid?bidder=visx&gdpr=0&gdpr_consent=&uid=c8b707fe-bb40-4862-a12c-c0603bfaeb0f

The redirect endpoint (which is usually the same as the PBS host address, but not in this case) will then update the Prebid Server User Sync Cookie. For more information, check out our new adapter doc and our cookie sync spec.

It is common for adapters to use an allow list for the redirect domain name to protect against abuse, although that's not a requirement we have for Prebid Server.

ok @SyntaxNode, I got it. So see, at out end we have domain whitelisting, so that was the reason when you tried hitting the endpoint you got 200 and not 302 because that redirect url domain was not in our whitelist. I tried hitting the endpoint with rubicon redirect url and it worked. You can now test it with appnexus as well since we have added it in our list. Basically we are providing redirect link to selective domains who are in aax list.

Ah, ok. That makes sense and is a common approach. Could you please:

Document that behavior in Adding Aax bidder adapter doc prebid.github.io#3696

Consider commenting out the cookie sync by default in the yaml file so hosts would not get a broken cookie sync out of the box. You can add a comment instructing hosts to contact you to be added to the allow list. Something like:

userSync: supports: - redirect # Aax support user syncing, but requires your host to be added to our allow list, please # contact us directly at the email address in this file to be added. # #redirect: # url: https://c.aaxads.com/aacxc.php?fv=1&wbsh=psa&ryvlg=setstatuscode&bidder=aax&gdpr={{.GDPR}}&gdpr_consent={{.GDPRConsent}}&us_privacy={{.USPrivacy}}&redirect={{.RedirectURL}} # userMacro: ${UUID}

@SyntaxNode, We have removed the whitelisting service from our end. I think we are good to go. Thanks.

I tried to test user sync URL and it returns just http 200, no redirects. On the screenshot you provided earlier I see the redirect URL is not encoded, it's uses as is. @SyntaxNode is this a valid case?
My test URL looks like this:

https://c.aaxads.com/aacxc.php?fv=1&wbsh=psa&ryvlg=setstatuscode&bidder=aax&gdpr=&gdpr_consent=&us_privacy=&redirect=https%3A%2F%2Fprebid.adnxs.com%2Fpbs%2Fv1%2Fsetuid%3Fbidder%3Daax%26gdpr%3D%26gdpr_consent%3D%26f%3Di%26uid%3D%24%7BUUID%7D

Other than this code looks good to me.

Good point @VeronikaSolovei9. I can confirm it works perfectly if the redirect url is not encoded, but it always will be encoded for security. @product-aax looks like you need to support url encoded redirects.

product-aax · 2022-04-28T03:56:07Z

Hi @VeronikaSolovei9, Can we merge this now ?

VeronikaSolovei9 · 2022-04-28T07:26:20Z

Added a comment in User sync discussion

AlexBVolcy · 2022-04-28T16:13:32Z

I think this code looks good and I'm almost ready to approve, but just want to ensure the user sync discussion is resolved.

product-aax · 2022-04-29T09:34:25Z

Sorry for the inconvenience, while updating whitelisting service at our end we updated userMacro and forgot to push change in this PR. Now user sync issue is resolved. Thanks for pointing out.

e.g. https://c.aaxads.com/aacxc.php?fv=1&wbsh=psa&ryvlg=setstatuscode&bidder=aax&gdpr=0&gdpr_consent=&us_privacy=&redirect=http%3A%2F%2Fprebid-server.rubiconproject.com%2Fsetuid%3Fbidder%3Daax%26gdpr%3D0%26gdpr_consent%3D%26f%3Di%26uid%3D%3Cvsid%3E

VeronikaSolovei9

LGTM
I used this URL:
https://c.aaxads.com/aacxc.php?fv=1&wbsh=psa&ryvlg=setstatuscode&bidder=aax&gdpr=&gdpr_consent=&us_privacy=&redirect=https%3A%2F%2Fprebid.adnxs.com%2Fpbs%2Fv1%2Fsetuid%3Fbidder%3Daax%26gdpr%3D%26gdpr_consent%3D%26f%3Di%26uid%3D%3Cvsid%3E
Prebid returns 400 but I think this is because this is a new adapter.

mansinahar · 2022-05-02T14:58:31Z

static/bidder-info/aax.yaml

+capabilities:
+  app:
+    mediaTypes:
+      - banner


I see that in the docs PR you have mentioned support only for banner and native but here you've video as well. Can you please confirm if it's the docs PR that needs to be updated or does this PR needs an update to remove video from this list?

@mansinahar We have added video media type in doc as well. Thanks

AlexBVolcy

LGTM

Adding Aax Adapter

57f2265

hhhjort requested review from AlexBVolcy and VeronikaSolovei9 April 13, 2022 17:11

hhhjort assigned VeronikaSolovei9 and AlexBVolcy Apr 13, 2022

AlexBVolcy reviewed Apr 13, 2022

View reviewed changes

product-aax changed the title ~~Adding Aax Adapter~~ New Adapter: Aax Apr 14, 2022

VeronikaSolovei9 previously approved these changes Apr 14, 2022

View reviewed changes

AlexBVolcy reviewed Apr 14, 2022

View reviewed changes

Adding test case for invalid imp id

325b7b6

product-aax dismissed VeronikaSolovei9’s stale review via 325b7b6 April 14, 2022 14:03

VeronikaSolovei9 reviewed Apr 14, 2022

View reviewed changes

product-aax added 2 commits April 18, 2022 10:55

changing muti format adtype logic

d4bc060

Resolving PR Comment

6a06759

SyntaxNode reviewed Apr 20, 2022

View reviewed changes

Merge branch 'master' into adding-aax-adapter

05828be

Updating userMacro

a54803e

VeronikaSolovei9 approved these changes May 2, 2022

View reviewed changes

mansinahar reviewed May 2, 2022

View reviewed changes

AlexBVolcy approved these changes May 3, 2022

View reviewed changes

guscarreon merged commit 3dd6540 into prebid:master May 3, 2022

marki1an mentioned this pull request Jul 7, 2022

Aax Bidder: Update prebid/prebid-server-java#1937

Merged

jorgeluisrocha pushed a commit to jwplayer/prebid-server that referenced this pull request Sep 28, 2022

New Adapter: Aax (prebid#2219)

eb5170f

shunj-nb pushed a commit to ParticleMedia/prebid-server that referenced this pull request Nov 8, 2022

New Adapter: Aax (prebid#2219)

47f46bc

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New Adapter: Aax #2219

New Adapter: Aax #2219

product-aax commented Apr 13, 2022 •

edited

Loading

AlexBVolcy left a comment

VeronikaSolovei9 left a comment

AlexBVolcy Apr 14, 2022

product-aax Apr 14, 2022

AlexBVolcy Apr 14, 2022

product-aax Apr 14, 2022

VeronikaSolovei9 Apr 14, 2022

VeronikaSolovei9 Apr 14, 2022

AlexBVolcy Apr 14, 2022

product-aax Apr 18, 2022

VeronikaSolovei9 Apr 18, 2022

product-aax Apr 19, 2022

VeronikaSolovei9 Apr 19, 2022 •

edited

Loading

product-aax Apr 20, 2022

product-aax Apr 20, 2022

VeronikaSolovei9 Apr 21, 2022

SyntaxNode Apr 20, 2022

product-aax Apr 20, 2022

SyntaxNode Apr 20, 2022

product-aax Apr 21, 2022 •

edited

Loading

SyntaxNode Apr 21, 2022 •

edited

Loading

product-aax Apr 22, 2022 •

edited

Loading

SyntaxNode Apr 22, 2022

product-aax Apr 26, 2022

VeronikaSolovei9 Apr 28, 2022

SyntaxNode Apr 28, 2022 •

edited

Loading

product-aax commented Apr 28, 2022

VeronikaSolovei9 commented Apr 28, 2022

AlexBVolcy commented Apr 28, 2022

product-aax commented Apr 29, 2022 •

edited

Loading

VeronikaSolovei9 left a comment •

edited

Loading

mansinahar May 2, 2022

product-aax May 3, 2022

AlexBVolcy left a comment


		bidResponse := adapters.NewBidderResponse()

		for _, sb := range bidResp.SeatBid {

New Adapter: Aax #2219

New Adapter: Aax #2219

Conversation

product-aax commented Apr 13, 2022 • edited Loading

AlexBVolcy left a comment

Choose a reason for hiding this comment

VeronikaSolovei9 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

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

VeronikaSolovei9 Apr 19, 2022 • 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

product-aax Apr 21, 2022 • edited Loading

Choose a reason for hiding this comment

SyntaxNode Apr 21, 2022 • edited Loading

Choose a reason for hiding this comment

product-aax Apr 22, 2022 • 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

SyntaxNode Apr 28, 2022 • edited Loading

Choose a reason for hiding this comment

product-aax commented Apr 28, 2022

VeronikaSolovei9 commented Apr 28, 2022

AlexBVolcy commented Apr 28, 2022

product-aax commented Apr 29, 2022 • edited Loading

VeronikaSolovei9 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AlexBVolcy left a comment

Choose a reason for hiding this comment

product-aax commented Apr 13, 2022 •

edited

Loading

VeronikaSolovei9 Apr 19, 2022 •

edited

Loading

product-aax Apr 21, 2022 •

edited

Loading

SyntaxNode Apr 21, 2022 •

edited

Loading

product-aax Apr 22, 2022 •

edited

Loading

SyntaxNode Apr 28, 2022 •

edited

Loading

product-aax commented Apr 29, 2022 •

edited

Loading

VeronikaSolovei9 left a comment •

edited

Loading