Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ad position parameter for Original API ad unit #806

Merged
merged 3 commits into from
Dec 5, 2024
Merged

Ad position parameter for Original API ad unit #806

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bb4e153
feat: remove BannerAdPosition to use only AdPosition
ValentinPostindustria Nov 27, 2024
864bd43
feat: add new ad position according to the standard
ValentinPostindustria Nov 27, 2024
2b7d671
feat: ad position for video original API ad unit
ValentinPostindustria Nov 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions PrebidMobile/PrebidMobile-core/src/main/java/org/prebid/mobile/BannerAdUnit.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

import org.prebid.mobile.api.data.AdFormat;
import org.prebid.mobile.api.data.AdUnitFormat;
import org.prebid.mobile.rendering.models.AdPosition;

import java.util.EnumSet;
import java.util.HashSet;
Expand Down Expand Up @@ -77,4 +78,8 @@ public void setOrtbConfig(@Nullable String ortbConfig) {
configuration.setOrtbConfig(ortbConfig);
}

public void setAdPosition(AdPosition adPosition) {
configuration.setAdPosition(adPosition);
}

}
63 changes: 0 additions & 63 deletions ...idMobile/PrebidMobile-core/src/main/java/org/prebid/mobile/api/data/BannerAdPosition.java
View file
Open in desktop

This file was deleted.

8 changes: 3 additions & 5 deletions ...rebidMobile-core/src/main/java/org/prebid/mobile/api/mediation/MediationBannerAdUnit.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
import org.prebid.mobile.AdSize;
import org.prebid.mobile.LogUtil;
import org.prebid.mobile.api.data.AdFormat;
import org.prebid.mobile.api.data.BannerAdPosition;
import org.prebid.mobile.api.mediation.listeners.OnFetchCompleteListener;
import org.prebid.mobile.rendering.bidding.display.PrebidMediationDelegate;
import org.prebid.mobile.rendering.models.AdPosition;
Expand Down Expand Up @@ -115,13 +114,12 @@ public final void setRefreshInterval(int seconds) {
adUnitConfig.setAutoRefreshDelay(seconds);
}

public void setAdPosition(BannerAdPosition bannerAdPosition) {
final AdPosition adPosition = BannerAdPosition.mapToAdPosition(bannerAdPosition);
public void setAdPosition(AdPosition adPosition) {
adUnitConfig.setAdPosition(adPosition);
}

public BannerAdPosition getAdPosition() {
return BannerAdPosition.mapToDisplayAdPosition(adUnitConfig.getAdPositionValue());
public AdPosition getAdPosition() {
return adUnitConfig.getAdPosition();
}

public void stopRefresh() {
Expand Down
8 changes: 3 additions & 5 deletions PrebidMobile/PrebidMobile-core/src/main/java/org/prebid/mobile/api/rendering/BannerView.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
import org.prebid.mobile.LogUtil;
import org.prebid.mobile.PrebidMobile;
import org.prebid.mobile.api.data.AdFormat;
import org.prebid.mobile.api.data.BannerAdPosition;
import org.prebid.mobile.api.data.VideoPlacementType;
import org.prebid.mobile.api.exceptions.AdException;
import org.prebid.mobile.api.rendering.listeners.BannerVideoListener;
Expand Down Expand Up @@ -529,13 +528,12 @@ public void clearExtKeywords() {
}


public void setAdPosition(BannerAdPosition bannerAdPosition) {
final AdPosition adPosition = BannerAdPosition.mapToAdPosition(bannerAdPosition);
public void setAdPosition(AdPosition adPosition) {
adUnitConfig.setAdPosition(adPosition);
}

public BannerAdPosition getAdPosition() {
return BannerAdPosition.mapToDisplayAdPosition(adUnitConfig.getAdPositionValue());
public AdPosition getAdPosition() {
return adUnitConfig.getAdPosition();
}

public void setPbAdSlot(String adSlot) {
Expand Down
14 changes: 11 additions & 3 deletions .../PrebidMobile-core/src/main/java/org/prebid/mobile/configuration/AdUnitConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@ public class AdUnitConfiguration {
private Position skipButtonPosition = Position.TOP_RIGHT;
private AdSize minSizePercentage;
private PlacementType placementType;
private AdPosition adPosition;
@NonNull
private AdPosition adPosition = AdPosition.UNDEFINED;
@Nullable
private ContentObject appContent;
private BannerParameters bannerParameters;
Expand Down Expand Up @@ -483,12 +484,19 @@ public boolean isPlacementTypeValid() {
return getPlacementTypeValue() != PlacementType.UNDEFINED.getValue();
}

public void setAdPosition(@Nullable AdPosition adPosition) {
public void setAdPosition(AdPosition adPosition) {
if (adPosition == null) return;

this.adPosition = adPosition;
}

@NonNull
public AdPosition getAdPosition() {
return adPosition;
}

public int getAdPositionValue() {
return adPosition != null ? adPosition.getValue() : AdPosition.UNDEFINED.getValue();
return adPosition.getValue();
}

public boolean isAdPositionValid() {
Expand Down
8 changes: 8 additions & 0 deletions ...Mobile/PrebidMobile-core/src/main/java/org/prebid/mobile/rendering/models/AdPosition.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,16 @@

package org.prebid.mobile.rendering.models;

/**
* The ad position for additional targeting.
*/
public enum AdPosition {

UNDEFINED(-1),
UNKNOWN(0),
ABOVE_THE_FOLD(1),
LOCKED(2),
BELOW_THE_FOLD(3),
HEADER(4),
FOOTER(5),
SIDEBAR(6),
Expand All @@ -33,4 +40,5 @@ public enum AdPosition {
public int getValue() {
return value;
}

}
9 changes: 5 additions & 4 deletions ...rc/main/java/org/prebid/mobile/rendering/networking/parameters/BasicParameterBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,11 @@ private void appendUserTargetingParameters(AdRequestInput adRequestInput) {

private void setVideoImpValues(Imp imp) {
Video video = new Video();

if (adConfiguration.isAdPositionValid()) {
video.pos = adConfiguration.getAdPositionValue();
}

if (adConfiguration.isOriginalAdUnit()) {
VideoParameters videoParameters = adConfiguration.getVideoParameters();
if (videoParameters != null) {
Expand Down Expand Up @@ -293,10 +298,6 @@ private void setVideoImpValues(Imp imp) {
//Interstitial video specific values
video.playbackend = VIDEO_INTERSTITIAL_PLAYBACK_END;//On Leaving Viewport or when Terminated by User

if (adConfiguration.isAdPositionValid()) {
video.pos = adConfiguration.getAdPositionValue();
}

if (!adConfiguration.isPlacementTypeValid()) {
video.placement = PlacementType.INTERSTITIAL.getValue();
} else {
Expand Down
22 changes: 22 additions & 0 deletions PrebidMobile/PrebidMobile-core/src/test/java/org/prebid/mobile/AdUnitSuccessorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
import org.prebid.mobile.configuration.AdUnitConfiguration;
import org.prebid.mobile.reflection.AdUnitReflection;
import org.prebid.mobile.rendering.bidding.loader.BidLoader;
import org.prebid.mobile.rendering.models.AdPosition;
import org.prebid.mobile.testutils.BaseSetup;
import org.robolectric.RobolectricTestRunner;
import org.robolectric.annotation.Config;
Expand Down Expand Up @@ -100,6 +101,27 @@ public void testGpidParameter() {
assertEquals(expectedGpid, configuration.getGpid());
}

@Test
public void adPosition_empty() {
BannerAdUnit adUnit = new BannerAdUnit(testConfigId, width, height);

AdUnitConfiguration configuration = adUnit.getConfiguration();
assertEquals(AdPosition.UNDEFINED, configuration.getAdPosition());
assertEquals(AdPosition.UNDEFINED.getValue(), configuration.getAdPositionValue());
}

@Test
public void adPosition() {
BannerAdUnit adUnit = new BannerAdUnit(testConfigId, width, height);
adUnit.setAdPosition(AdPosition.SIDEBAR);

AdUnitConfiguration configuration = adUnit.getConfiguration();
assertEquals(AdPosition.SIDEBAR, configuration.getAdPosition());
assertEquals(AdPosition.SIDEBAR.getValue(), configuration.getAdPositionValue());
}



@Test
public void testBannerParametersCreation() {
//given
Expand Down
22 changes: 11 additions & 11 deletions ...dMobile-core/src/test/java/org/prebid/mobile/api/mediation/MediationBannerAdUnitTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@
import org.prebid.mobile.AdSize;
import org.prebid.mobile.PrebidMobile;
import org.prebid.mobile.api.data.AdFormat;
import org.prebid.mobile.api.data.BannerAdPosition;
import org.prebid.mobile.configuration.AdUnitConfiguration;
import org.prebid.mobile.rendering.bidding.config.MockMediationUtils;
import org.prebid.mobile.rendering.bidding.loader.BidLoader;
import org.prebid.mobile.rendering.models.AdPosition;
import org.prebid.mobile.rendering.utils.broadcast.ScreenStateReceiver;
import org.prebid.mobile.test.utils.WhiteBox;
import org.robolectric.Robolectric;
Expand Down Expand Up @@ -64,7 +64,7 @@ public void setUp() throws Exception {
WhiteBox.setInternalState(mediationBannerAdUnit, "bidLoader", mockBidLoader);
WhiteBox.setInternalState(mediationBannerAdUnit, "screenStateReceiver", mockScreenStateReceiver);

assertEquals(BannerAdPosition.UNDEFINED.getValue(), mediationBannerAdUnit.getAdPosition().getValue());
assertEquals(AdPosition.UNDEFINED.getValue(), mediationBannerAdUnit.getAdPosition().getValue());
}

@After
Expand Down Expand Up @@ -106,19 +106,19 @@ public void whenStopRefresh_BidLoaderCancelRefresh() {
@Test
public void setAdPosition_EqualsGetAdPosition() {
mediationBannerAdUnit.setAdPosition(null);
assertEquals(BannerAdPosition.UNDEFINED, mediationBannerAdUnit.getAdPosition());
assertEquals(AdPosition.UNDEFINED, mediationBannerAdUnit.getAdPosition());

mediationBannerAdUnit.setAdPosition(BannerAdPosition.FOOTER);
assertEquals(BannerAdPosition.FOOTER, mediationBannerAdUnit.getAdPosition());
mediationBannerAdUnit.setAdPosition(AdPosition.FOOTER);
assertEquals(AdPosition.FOOTER, mediationBannerAdUnit.getAdPosition());

mediationBannerAdUnit.setAdPosition(BannerAdPosition.HEADER);
assertEquals(BannerAdPosition.HEADER, mediationBannerAdUnit.getAdPosition());
mediationBannerAdUnit.setAdPosition(AdPosition.HEADER);
assertEquals(AdPosition.HEADER, mediationBannerAdUnit.getAdPosition());

mediationBannerAdUnit.setAdPosition(BannerAdPosition.SIDEBAR);
assertEquals(BannerAdPosition.SIDEBAR, mediationBannerAdUnit.getAdPosition());
mediationBannerAdUnit.setAdPosition(AdPosition.SIDEBAR);
assertEquals(AdPosition.SIDEBAR, mediationBannerAdUnit.getAdPosition());

mediationBannerAdUnit.setAdPosition(BannerAdPosition.UNKNOWN);
assertEquals(BannerAdPosition.UNKNOWN, mediationBannerAdUnit.getAdPosition());
mediationBannerAdUnit.setAdPosition(AdPosition.UNKNOWN);
assertEquals(AdPosition.UNKNOWN, mediationBannerAdUnit.getAdPosition());
}

}
4 changes: 2 additions & 2 deletions ...bidMobile-core/src/test/java/org/prebid/mobile/api/mediation/MediationBaseAdUnitTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@
import org.prebid.mobile.AdSize;
import org.prebid.mobile.Host;
import org.prebid.mobile.PrebidMobile;
import org.prebid.mobile.api.data.BannerAdPosition;
import org.prebid.mobile.api.data.FetchDemandResult;
import org.prebid.mobile.api.exceptions.AdException;
import org.prebid.mobile.api.mediation.listeners.OnFetchCompleteListener;
import org.prebid.mobile.rendering.bidding.config.MockMediationUtils;
import org.prebid.mobile.rendering.bidding.loader.BidLoader;
import org.prebid.mobile.rendering.models.AdPosition;
import org.prebid.mobile.test.utils.WhiteBox;
import org.robolectric.Robolectric;
import org.robolectric.RobolectricTestRunner;
Expand Down Expand Up @@ -68,7 +68,7 @@ public void setUp() throws Exception {
baseAdUnit = createAdUnit("config");
PrebidMobile.setPrebidServerHost(Host.APPNEXUS);

assertEquals(BannerAdPosition.UNDEFINED.getValue(), baseAdUnit.adUnitConfig.getAdPositionValue());
assertEquals(AdPosition.UNDEFINED.getValue(), baseAdUnit.adUnitConfig.getAdPositionValue());
}

@After
Expand Down
22 changes: 11 additions & 11 deletions ...obile/PrebidMobile-core/src/test/java/org/prebid/mobile/api/rendering/BannerViewTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
import org.mockito.MockitoAnnotations;
import org.prebid.mobile.AdSize;
import org.prebid.mobile.api.data.AdFormat;
import org.prebid.mobile.api.data.BannerAdPosition;
import org.prebid.mobile.api.data.VideoPlacementType;
import org.prebid.mobile.api.exceptions.AdException;
import org.prebid.mobile.api.rendering.listeners.BannerVideoListener;
Expand All @@ -43,6 +42,7 @@
import org.prebid.mobile.rendering.bidding.listeners.DisplayVideoListener;
import org.prebid.mobile.rendering.bidding.listeners.DisplayViewListener;
import org.prebid.mobile.rendering.bidding.loader.BidLoader;
import org.prebid.mobile.rendering.models.AdPosition;
import org.prebid.mobile.rendering.utils.broadcast.ScreenStateReceiver;
import org.prebid.mobile.test.utils.WhiteBox;
import org.robolectric.Robolectric;
Expand Down Expand Up @@ -94,7 +94,7 @@ public void setup() throws Exception {
bannerView.setBannerListener(mockBannerListener);
bannerView.setBannerVideoListener(mockBannerVideoListener);

assertEquals(BannerAdPosition.UNDEFINED.getValue(), bannerView.getAdPosition().getValue());
assertEquals(AdPosition.UNDEFINED.getValue(), bannerView.getAdPosition().getValue());
}

@Test
Expand Down Expand Up @@ -496,19 +496,19 @@ public void addRemoveContextKeywords_EqualsGetContextKeyWordsSet() {
@Test
public void setAdPosition_EqualsGetAdPosition() {
bannerView.setAdPosition(null);
assertEquals(BannerAdPosition.UNDEFINED, bannerView.getAdPosition());
assertEquals(AdPosition.UNDEFINED, bannerView.getAdPosition());

bannerView.setAdPosition(BannerAdPosition.FOOTER);
assertEquals(BannerAdPosition.FOOTER, bannerView.getAdPosition());
bannerView.setAdPosition(AdPosition.FOOTER);
assertEquals(AdPosition.FOOTER, bannerView.getAdPosition());

bannerView.setAdPosition(BannerAdPosition.HEADER);
assertEquals(BannerAdPosition.HEADER, bannerView.getAdPosition());
bannerView.setAdPosition(AdPosition.HEADER);
assertEquals(AdPosition.HEADER, bannerView.getAdPosition());

bannerView.setAdPosition(BannerAdPosition.SIDEBAR);
assertEquals(BannerAdPosition.SIDEBAR, bannerView.getAdPosition());
bannerView.setAdPosition(AdPosition.SIDEBAR);
assertEquals(AdPosition.SIDEBAR, bannerView.getAdPosition());

bannerView.setAdPosition(BannerAdPosition.UNKNOWN);
assertEquals(BannerAdPosition.UNKNOWN, bannerView.getAdPosition());
bannerView.setAdPosition(AdPosition.UNKNOWN);
assertEquals(AdPosition.UNKNOWN, bannerView.getAdPosition());
}

@Test
Expand Down