Export (0) Print
Expand All

What's New

Updated: May 1, 2014

Published: May 1, 2014

Some of the major changes in this version of the SDK are described below. For more information or to ask a question about the version you are using, please go to the Microsoft Ads in Apps for Windows Phone Support Forum at http://social.msdn.microsoft.com/Forums/en-US/home?forum=aiaforwinphone.

April 2014 Release

The version numbers for this release are (updated May 9th, 2014):

  • Windows Phone 8.1 XAML: 8.1.40505.0

  • Windows Phone 8.1 Silverlight: 8.1.40502.0

  • Windows Phone 8.0 Silverlight: 6.2.40501.0

This release of the Advertising SDK for Windows Phone incorporates bug fixes and improvements to the AdControl. This release is available for Windows Phone 7.x (Silverlight and XNA), 8.0 (Silverlight) and 8.1 (XAML).

The distinction between a XAML and a Silverlight based app is new to the Windows Phone 8.1 platform. This release of the Advertising SDK is designed to accommodate apps built with either framework.

Several improvements bring the Advertising SDK in line with International Advertising Bureau (IAB) standards and MRAID specifications. These improvements accommodate advertisers that develop and deliver ads.

Ad Sizes for XAML (not Silverlight) based apps

pubCenter now accommodates the industry standard 320x50 ad size. It is recommended all XAML app developers choose this size for their pubCenter ad units.

The Windows Phone 8.1 operating system now accommodates much larger screen sizes than prior versions of the operating system did. This requires developers to understand how Windows 8.1 displays the UI and scales according to the underlying hardware. For more information about Windows Phone 8.1 and scaling/screen size issues, see the topic Guidelines for scaling to pixel density

For Windows Phone 8.1 apps developed using the new XAML based UI, you should use the recommended pubCenter ad unit size of 320x50. Remember to set the size of your AdControl to 320x50 or greater. If you set your AdControl size to less than the size of the pubCenter ad unit, no ad will display.

New APIs

This release adds these new APIs:

Additional Silverlight Library (.dll files)

For Silverlight apps targeting Windows Phone 8 (8.0 and 8.1) there is an additional library installed with this release.

The libraries required in a build for a Windows Phone 8 (8.0 and 8.1) Silverlight App using the Advertising SDK (Silverlight) are:

  • Microsoft.Advertising.Mobile.dll

  • Microsoft.Advertising.Mobile.UI.dll

  • Microsoft.Advertising.Mobile.Common.dll

Windows Phone 7 Development:

If you want to develop apps for Windows Phone 7, along with the Windows Phone 7 SDK, install the Windows Phone 8.0 (Silverlight) Advertising SDK. You must develop on Visual Studio 2012 because Visual Studio 2013 with Update 2 does not target the Windows Phone 7 platform. The Windows Phone 8.0 (Silverlight) Advertising SDK installs a version of the AdControl that is compatible with Windows Phone 7 apps. The file version for the Windows Phone 7 Advertising SDK is 6.1.524.0. When targeting Windows Phone 7 in Visual Studio 2012, the Reference Manager will show file version 6.1.524.0. Use the 6.1.524.0 file version of the Advertising SDK for Windows Phone 7.

There is no XNA support in Windows Phone 8. For backwards compatibility with Windows Phone 7 development, the advertising classes that supported XNA are included. However, there have been no updates or fixes to the code since the 6.1.320 release.

September 2013 Release - Version 6.2.960.0

This release of the Advertising SDK for Windows Phone 8 incorporates bug fixes and improvements to the AdControl, including support for rich-media ad formats.

Also, this release adds these new APIs:

November 2012 Release – Version 6.2.909

This release targets the Windows Phone 8 platform for managed apps. There is no native support at this time.

This version of the AdControl is designed for use in Visual Studio 2012.

For Windows Phone 7.1 Apps: The SDK installs a version of the AdControl that is compatible with Windows Phone 7.1 apps. The file version for Windows Phone 7.1 is 6.1.524.0. When targeting Windows Phone 7.1 in Visual Studio 2012, the Reference Manager will show file version 6.1.524.0. Use the 6.1.524.0 file version of the Advertising SDK for Windows Phone 7.1.

There is no XNA support in Windows Phone 8. For backwards compatibility the advertising classes that supported XNA are included. However, there have been no updates or fixes to the code since the 6.1.320 release.

March 2012 Hotfix – Version 6.1.320

This version fixes issues in the AdComponent class (hybrid XNA/Silverlight apps) related to input handling.

March 2012 Release – Version 6.1.307

This release targets the Windows Phone 7.1 platform.

Error Handling

In the prior 5.2 versions, the error handling functionality was available in the platform specific .dll file (either Microsoft.Advertising.Mobile.UI for Silverlight or Microsoft.Advertising.Mobile.XNA for XNA.)

The error handling functionality is now in its own .dll file, Microsoft.Advertising.Mobile.dll. You must reference that .dll in your project and include the Microsoft.Advertising namespace in your code.

For more information, see Error Handling.

Hybrid Silverlight/XNA Apps

Hybrid apps can now use the AdComponent class to manage the DrawableAd object. The AdComponent class is in the Microsoft.Advertising.Mobile.XNA namespace. For a simple walkthrough, see Integrating Ads into a Hybrid Silverlight/XNA App.

No Live Ads in the Emulator

Live ads are not available in the emulator. You must use test values for the ApplicationId and AdUnitId when running in the emulator. To verify live ads, you will have to run the app on a device. If the ApplicationId is NOT set to the value test_client when the app is running in the emulator, the app will throw an error with the following message: "You cannot use pubCenter IDs for testing from the emulator. If you want to test with these IDs, please deploy your application to a device. Otherwise, change your ApplicationId to test_client and the AdUnitId to one of the supported ad types as outlined in the documentation." For more information, see Test Values for AdUnitId and ApplicationId.

November 2011 Release – Version 5.2.1027.0

The release fixed a bug caused when users navigated outside of the application at the same time the AdControl was fetching a new ad.

Crashes could occur if you installed this update over a pre-5.2.0.xxx build, as they are not compatible side by side.

If you upgraded from a beta-version of the 5.2.0.xxx AdControl AND you were instantiating the AdControl in the code-behind without setting the width and height explicitly you will see no ads.

Prior 5.2 Releases (June 2011 – September 2011)

Changes to the Microsoft.Advertising.Mobile.UI Namespace

The Microsoft.Advertising.Mobile.UI namespace is used to create Silverlight apps. Changes to this namespace are as follows:

Reduction of Elements

With this release, the following classes, enumerations, and structures are deprecated.

AdClientException

The need for the custom exception class has been eliminated.

AdModel

At this time, support for premium ads is limited. Given the low use, the AdModel has been removed.

BirthDate

This class supported targeted advertising. It has been removed based on developer feedback about the use of targeted advertisements.

Location

Classes derived from GeoCoordinate have been removed. This is due to a number of different issues—including concerns of end users, difficulty of getting these apps certified for release, and regulatory matters. This feature may return, but for now it is not included.

The properties Latitude and Longitude remain available.

AdControl Class

The functionality of the AdControl class has been simplified. Changes to this class include:

InitializeComponent()

Removed. This method is no longer necessary.

RequestNextAd()

Removed. This operation is replaced by the new Refresh() method.

BirthDate

Gender

IncomeRange

Location

SearchRadius

WindowsLiveANID

These properties were designed to be used for targeted advertising. These have been removed based on developer feedback.

TestMode

Using test ads during development has been simplified. This property has been removed.

For more information about how to receive test ads during development see Test Values for AdUnitId and ApplicationId

AdControlError event

AdDisengaged event

AdEngaged event

NewAd event

Simplifying the AdControl class has made these methods unnecessary.

Required ID_CAP Capabilities

Silverlight apps will now require the ID_CAP_MEDIALIB capability to be set in the project’s manifest file. For more information, see Required Manifest Capabilities.

Changes to the Microsoft.Advertising.Mobile.Xna Namespace

Changes to these classes mirror the changes to the Silverlight classes. For example, all the same advertising location targeting APIs have been removed.

These classes have been further optimized to improve game performance.

Required ID_CAP capabilities.

Double-check your XNA apps to ensure the necessary ID_CAP properties are set in the project’s manifest file. For more information, see Required Manifest Capabilities.

TestMode has Been Removed

TestMode has been removed. When the applicationId of an AdGameComponent object is instantiated using the string “test_client”, the ad control will be in test mode. Since the “test_client” string is used as the applicationId, there is no need for a separate property. Developers should use an #if behavior around the code that sets the applicationId and adUnitId to enable easy switching during testing.

For example:

// Insert real values from pubCenter before
// submitting your app to Windows Phone Marketplace!
#if SHOW_TEST_ADS
adControl.ApplicationId = "test_client";
adControl.AdUnitId = "Image480_80";
#else
// Use your real Application ID and Ad Unit ID here.
adControl.ApplicationId = "12ab456c-de7f-89ab-0123-4567890c1d23";
adControl.AdUnitId = "12345";
#endif

Use one AdGameComponent for Your Game

It is also not necessary to create more than one AdGameComponent for your game. There should be only one, so use a factory pattern with the AdGameComponent.Initialize(game, applicationId) and an AdGameComponent.Current to create and get a reference to the AdGameComponent object.

The AdGameComponent.Current will now always refer to the same AdGameComponent object. For example:

AdGameComponent.Initialize(this, "test_client");
Components.Add(AdGameComponent.Current);
DrawableAd drawableAd = AdGameComponent.Current.CreateAd("Image480_80", new Rectangle(0, 0, 480, 80));

Rotation mode changes

RotationMode is not about the orientation of the phone. The purpose of the API was to determine how to “refresh” ads shown in the application. The autoRefreshEnabled parameter in the AdGameComponent.CreateAd method now controls this. Setting the autoRefreshEnabled property to true means that new ads will get loaded into your application about every minute, given an ad is available.

Properties and Methods Changes

September 2010 SDK

July 2011 SDK

Ad class

Changed to DrawableAd. DrawableAd is now specific to what kind of object the CreateAd call creates; it is an ad that is ready to be drawn onto the game screen.

AdManager class

Changed to AdGameComponent. The class name now refers to the GameComponent class it is derived from.

UnitId

Changed to DrawableAd.AdUnitId.

SelectionKeywords

Changed to DrawableAd.Keywords.

NewAdAcquired

Use the DrawableAd.AdRefreshed event.

RotationMode

Changed to DrawableAd.AutoRefreshEnabled.

RequestNextAd

Changed to DrawableAd.Refresh().

AdManager Constructor

Use AdGameComponent.Initialize().

ErrorEventArgs

ErrorEventArgs is renamed to AdErrorEventArgs and contains the error as a property.

Location

Removed. Latitude and longitude values can be set directly on the DrawableAd class using the LocationLatitude and LocationLongitude properties.

ErrorCode

There is no longer an ErrorCode to decode why an ad was not returned. The exception will contain all the information.

BirthDate

Most advertising targeting properties have been removed for this version of the SDK.

Gender

Most advertising targeting properties have been removed for this version of the SDK.

IncomeRange

Most advertising targeting properties have been removed for this version of the SDK.

SearchRadius

Most advertising targeting properties have been removed for this version of the SDK.

WindowsLiveANID

This has been removed for this version of the SDK.

Premium

The logic handling for this value has changed. It is not necessary for premium publishers to use this property.

Support and Feedback

Get product support or report a bug in the product by visiting the Windows Phone Dev Center support page (scroll down to the section "Microsoft Advertising support").

Send feedback about this documentation to adsfdbk@microsoft.com. There is no product support through this alias. Documentation feedback only.

Community Additions

ADD
Show:
© 2015 Microsoft