Server can control multiple publisher placements #786
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ericholscher
approved these changes
Sep 25, 2023
adserver/api/serializers.py
Outdated
| @@ -60,6 +60,10 @@ class AdDecisionSerializer(serializers.Serializer): | |||
| # This purposefully doesn't use a URLField so we can disregard invalid values rather than rejecting them | |||
| url = serializers.CharField(max_length=256, required=False) | |||
|
|
|||
| # The placement index (0-indexed) | |||
| # 1 or more means there's multiple placements on this page | |||
| index = serializers.IntegerField(required=False, min_value=0, max_value=9) | |||
There was a problem hiding this comment.
Can we not have a max here? It seems unlikely, but I know the PSF has a use case where they're showing more than 9 images in a page.
There was a problem hiding this comment.
Sure. I can remove it. I'd rather have a very large max (99 or even 999) than no max at all though if that makes sense though.
adserver/api/views.py
Outdated
| @@ -296,6 +296,7 @@ def decision(self, request, data): | |||
| keywords=keywords, | |||
| campaign_types=serializer.validated_data.get("campaign_types"), | |||
| url=url, | |||
| placement_index=serializer.validated_data.get("index"), | |||
There was a problem hiding this comment.
Should we call the incoming variable placement_index as well to keep it consistent?
There was a problem hiding this comment.
|
I updated based on the feedback. |
|
Looks good 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is based on #782 so as not to have conflicting migrations.
This change allows the server to control whether a publisher is allowed to have multiple placements (which the client sends since readthedocs/ethical-ad-client#170). When merged, this will automatically reject multiple placements and we will need to turn it on per publisher.