Release: version 4.0.0

mopub · Oct 6, 2015 · 1415bfe0d65727adb44d396cdb78c60a29b11d60 · 1415bfe
1 parent ee0ed8c
commit 1415bfe0d65727adb44d396cdb78c60a29b11d60
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,22 @@
+  
+## Version 4.0.0 (October 6, 2015)
+  
+
+  
+Version 4.0.0 includes a number of improvements to our Native Ads systems under the hood. This means a few changes for publishers integrating the ads. The [Native Ads Integration Guide](https://github.com/mopub/mopub-android-sdk/wiki/Native-Ads-Integration) describes all the steps you'll need to integrate 4.0.0.
+  
+
+  
+**Native Ads Changes**
+  
+ - `MoPubNativeAdRenderer` has been replaced by `MoPubStaticNativeRenderer` 
+  
+ - When requesting ads using `MoPubNative`, you must instantiate and register a `MoPubStaticNativeAdRenderer`. See the [Integration Document](https://github.com/mopub/mopub-android-sdk/wiki/Legacy-Native-Ads-Integration) for more details.
+  
+ - `NativeResponse` has been replaced with `NativeAd`
+  
+ - `NativeAd` has a new API that supports creating and rendering `View`s for Native Ads.
+  
+   - `#createAdView` returns a `View` that can hold data for the `NativeAd`
+  
+   - `#renderAdView` will populate the `View` with ad data. 
+  
+   - Other lifecycle methods from `NativeResponse` remain:
+  
+     - `#prepare`, `#clear`, `#destroy`
+  
+ - The process of writing new `CustomEventNative` instances has changed. These changes will support more dynamic, flexible, and attractive Native Ad formats in the future. All bundled native Custom Event files have been updated to use the new API.
+  
+
+  
+**Removed Old Code**
+  
+ - Removed legacy banner/interestitial listeners, deprecated in 1.11
+  
+ - Removed legacy custom event implementation ("custom event methods") deprecated in 1.10
+  
+
 ## Version 3.13.0 (September 21, 2015)
 - **Android M Support** - Replaced usage of the now-deprecated HttpClient with HttpURLConnection.
diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@ The MoPub SDK is available via:
    }
    dependencies {
-  
-        compile('com.mopub:mopub-sdk:3.13.0@aar') {
+  
+        compile('com.mopub:mopub-sdk:4.0.0@aar') {
            transitive = true
        }
    }
@@ -61,9 +61,24 @@ The MoPub SDK is available via:
 ## New in this Version
-  
-Please view the [changelog](https://github.com/mopub/mopub-android-sdk/blob/master/CHANGELOG.md) for a complete list of additions, fixes, and enhancements in the lastest release..
+  
+Please view the [changelog](https://github.com/mopub/mopub-android-sdk/blob/master/CHANGELOG.md) for a complete list of additions, fixes, and enhancements in the latest release.
-  
- **Android M Support** - Replaced usage of the now-deprecated HttpClient with HttpURLConnection.
+  
+Version 4.0.0 includes a number of improvements to our Native Ads systems under the hood. This means a few changes for publishers integrating the ads. The [Native Ads Integration Guide](https://github.com/mopub/mopub-android-sdk/wiki/Native-Ads-Integration) describes all the steps you'll need to integrate 4.0.0.
+  
+
+  
+**Native Ads Changes**
+  
+ - `MoPubNativeAdRenderer` has been replaced by `MoPubStaticNativeRenderer` 
+  
+ - When requesting ads using `MoPubNative`, you must instantiate and register a `MoPubStaticNativeAdRenderer`. See the [Integration Document](https://github.com/mopub/mopub-android-sdk/wiki/Legacy-Native-Ads-Integration) for more details.
+  
+ - `NativeResponse` has been replaced with `NativeAd`
+  
+ - `NativeAd` has a new API that supports creating and rendering `View`s for Native Ads.
+  
+   - `#createAdView` returns a `View` that can hold data for the `NativeAd`
+  
+   - `#renderAdView` will populate the `View` with ad data. 
+  
+   - Other lifecycle methods from `NativeResponse` remain:
+  
+     - `#prepare`, `#clear`, `#destroy`
+  
+ - The process of writing new `CustomEventNative` instances has changed. These changes will support more dynamic, flexible, and attractive Native Ad formats in the future. All bundled native Custom Event files have been updated to use the new API.
+  
+
+  
+**Removed Old Code**
+  
+ - Removed legacy banner/interestitial listeners, deprecated in 1.11
+  
+ - Removed legacy custom event implementation ("custom event methods") deprecated in 1.10
 ## Requirements
diff --git a/extras/src/com/mopub/nativeads/FacebookNative.java b/extras/src/com/mopub/nativeads/FacebookNative.java
@@ -14,6 +14,8 @@
 import java.util.List;
 import java.util.Map;
+  
+import static com.mopub.nativeads.NativeImageHelper.preCacheImages;
+  
+
 /*
 * Tested with Facebook SDK 3.23.1
 */
@@ -35,25 +37,25 @@ protected void loadNativeAd(final Context context,
            return;
        }
-  
-        final FacebookForwardingNativeAd facebookForwardingNativeAd =
-  
-                new FacebookForwardingNativeAd(context,
+  
+        final FacebookStaticNativeAd facebookStaticNativeAd =
+  
+                new FacebookStaticNativeAd(context,
                        new NativeAd(context, placementId), customEventNativeListener);
-  
-        facebookForwardingNativeAd.loadAd();
+  
+        facebookStaticNativeAd.loadAd();
    }
    private boolean extrasAreValid(final Map<String, String> serverExtras) {
        final String placementId = serverExtras.get(PLACEMENT_ID_KEY);
        return (placementId != null && placementId.length() > 0);
    }
-  
-    static class FacebookForwardingNativeAd extends BaseForwardingNativeAd implements AdListener, ImpressionListener {
+  
+    static class FacebookStaticNativeAd extends StaticNativeAd implements AdListener, ImpressionListener {
        private static final String SOCIAL_CONTEXT_FOR_AD = "socialContextForAd";
        private final Context mContext;
        private final NativeAd mNativeAd;
        private final CustomEventNativeListener mCustomEventNativeListener;
-  
-        FacebookForwardingNativeAd(final Context context,
+  
+        FacebookStaticNativeAd(final Context context,
                final NativeAd nativeAd,
                final CustomEventNativeListener customEventNativeListener) {
            mContext = context.getApplicationContext();
@@ -101,10 +103,10 @@ public void onAdLoaded(final Ad ad) {
                imageUrls.add(getIconImageUrl());
            }
-  
-            preCacheImages(mContext, imageUrls, new ImageListener() {
+  
+            preCacheImages(mContext, imageUrls, new NativeImageHelper.ImageListener() {
                @Override
                public void onImagesCached() {
-  
-                    mCustomEventNativeListener.onNativeAdLoaded(FacebookForwardingNativeAd.this);
+  
+                    mCustomEventNativeListener.onNativeAdLoaded(FacebookStaticNativeAd.this);
                }
                @Override
@@ -142,8 +144,6 @@ public void onLoggingImpression(final Ad ad) {
        @Override
        public void prepare(final View view) {
            mNativeAd.registerViewForInteraction(view);
-  
-            setOverridingClickTracker(true);
-  
-            setOverridingImpressionTracker(true);
        }
        @Override
diff --git a/extras/src/com/mopub/nativeads/InMobiNative.java b/extras/src/com/mopub/nativeads/InMobiNative.java
@@ -10,6 +10,8 @@
 import com.inmobi.monetization.IMErrorCode;
 import com.inmobi.monetization.IMNative;
 import com.inmobi.monetization.IMNativeListener;
+  
+import com.mopub.common.logging.MoPubLog;
+  
+import com.mopub.network.TrackingRequest;
 import org.json.JSONException;
 import org.json.JSONObject;
@@ -21,6 +23,7 @@
 import static com.mopub.common.util.Json.getJsonValue;
 import static com.mopub.common.util.Numbers.parseDouble;
+  
+import static com.mopub.nativeads.NativeImageHelper.preCacheImages;
 /*
 * Tested with InMobi SDK 4.4.1
@@ -50,18 +53,21 @@ protected void loadNativeAd(final Context context,
        }
        InMobi.initialize(activity, appId);
-  
-        final InMobiForwardingNativeAd inMobiForwardingNativeAd =
-  
-                new InMobiForwardingNativeAd(context, customEventNativeListener);
-  
-        inMobiForwardingNativeAd.setIMNative(new IMNative(inMobiForwardingNativeAd));
-  
-        inMobiForwardingNativeAd.loadAd();
+  
+        final InMobiStaticNativeAd inMobiStaticNativeAd =
+  
+                new InMobiStaticNativeAd(context,
+  
+                        new ImpressionTracker(context),
+  
+                        new NativeClickHandler(context),
+  
+                        customEventNativeListener);
+  
+        inMobiStaticNativeAd.setIMNative(new IMNative(inMobiStaticNativeAd));
+  
+        inMobiStaticNativeAd.loadAd();
    }
    private boolean extrasAreValid(final Map<String, String> serverExtras) {
        final String placementId = serverExtras.get(APP_ID_KEY);
        return (placementId != null && placementId.length() > 0);
    }
-  
-    static class InMobiForwardingNativeAd extends BaseForwardingNativeAd implements IMNativeListener {
+  
+    static class InMobiStaticNativeAd extends StaticNativeAd implements IMNativeListener {
        static final int IMPRESSION_MIN_TIME_VIEWED = 0;
        // Modifiable keys
@@ -78,11 +84,17 @@ private boolean extrasAreValid(final Map<String, String> serverExtras) {
        private final Context mContext;
        private final CustomEventNativeListener mCustomEventNativeListener;
+  
+        private final ImpressionTracker mImpressionTracker;
+  
+        private final NativeClickHandler mNativeClickHandler;
        private IMNative mImNative;
-  
-        InMobiForwardingNativeAd(final Context context,
+  
+        InMobiStaticNativeAd(final Context context,
+  
+                final ImpressionTracker impressionTracker,
+  
+                final NativeClickHandler nativeClickHandler,
                final CustomEventNativeListener customEventNativeListener) {
            mContext = context.getApplicationContext();
+  
+            mImpressionTracker = impressionTracker;
+  
+            mNativeClickHandler = nativeClickHandler;
            mCustomEventNativeListener = customEventNativeListener;
        }
@@ -105,7 +117,7 @@ public void onNativeRequestSucceeded(final IMNative imNative) {
            try {
                parseJson(imNative);
            } catch (JSONException e) {
-  
-                mCustomEventNativeListener.onNativeAdFailed(NativeErrorCode.INVALID_JSON);
+  
+                mCustomEventNativeListener.onNativeAdFailed(NativeErrorCode.INVALID_RESPONSE);
                return;
            }
@@ -120,10 +132,10 @@ public void onNativeRequestSucceeded(final IMNative imNative) {
                imageUrls.add(iconUrl);
            }
-  
-            preCacheImages(mContext, imageUrls, new ImageListener() {
+  
+            preCacheImages(mContext, imageUrls, new NativeImageHelper.ImageListener() {
                @Override
                public void onImagesCached() {
-  
-                    mCustomEventNativeListener.onNativeAdLoaded(InMobiForwardingNativeAd.this);
+  
+                    mCustomEventNativeListener.onNativeAdLoaded(InMobiStaticNativeAd.this);
                }
                @Override
@@ -146,6 +158,7 @@ public void onNativeRequestFailed(final IMErrorCode errorCode) {
            }
        }
+  
+        // Lifecycle Handlers
        @Override
        public void prepare(final View view) {
            if (view != null && view instanceof ViewGroup) {
@@ -155,16 +168,33 @@ public void prepare(final View view) {
            } else {
                Log.e("MoPub", "InMobi did not receive ViewGroup to attachToView, unable to record impressions");
            }
+  
+            mImpressionTracker.addView(view, this);
+  
+            mNativeClickHandler.setOnClickListener(view, this);
        }
        @Override
-  
-        public void handleClick(final View view) {
-  
-            mImNative.handleClick(null);
+  
+        public void clear(final View view) {
+  
+            mImpressionTracker.removeView(view);
+  
+            mNativeClickHandler.clearOnClickListener(view);
        }
        @Override
        public void destroy() {
            mImNative.detachFromView();
+  
+            mImpressionTracker.destroy();
+  
+        }
+  
+
+  
+        // Event Handlers
+  
+        @Override
+  
+        public void recordImpression(final View view) {
+  
+            notifyAdImpressed();
+  
+        }
+  
+
+  
+        @Override
+  
+        public void handleClick(final View view) {
+  
+            notifyAdClicked();
+  
+            mNativeClickHandler.openClickDestinationUrl(getClickDestinationUrl(), view);
+  
+            mImNative.handleClick(null);
        }
        void parseJson(final IMNative imNative) throws JSONException  {
@@ -184,7 +214,15 @@ void parseJson(final IMNative imNative) throws JSONException  {
                setIconImageUrl(getJsonValue(iconJsonObject, URL, String.class));
            }
-  
-            setClickDestinationUrl(getJsonValue(jsonObject, LANDING_URL, String.class));
+  
+            final String clickDestinationUrl = getJsonValue(jsonObject, LANDING_URL, String.class);
+  
+            if (clickDestinationUrl == null) {
+  
+                final String errorMessage = "InMobi JSON response missing required key: "
+  
+                        + LANDING_URL + ". Failing over.";
+  
+                MoPubLog.d(errorMessage);
+  
+                throw new JSONException(errorMessage);
+  
+            }
+  
+
+  
+            setClickDestinationUrl(clickDestinationUrl);
            setCallToAction(getJsonValue(jsonObject, CTA, String.class));
            try {