Merge pull request #4 from shyTNT/BingAds/master

Release .NET SDK 10.4.5

BingAdsApiSDK/BingAdsApiSDK.csproj

@@ -319,6 +319,7 @@
     <Compile Include="V10\Bulk\Entities\AdExtensions\BulkSiteLink.cs" />
     <Compile Include="V10\Bulk\Entities\AdExtensions\BulkSiteLinkAdExtension.cs" />
     <Compile Include="V10\Bulk\Entities\Ads\BulkProductAd.cs" />
+    <Compile Include="V10\Bulk\Entities\Ads\BulkAppInstallAd.cs" />
     <Compile Include="V10\Bulk\Entities\Ads\BulkTextAd.cs" />
     <Compile Include="V10\Bulk\Entities\BidSuggestionData.cs" />
     <Compile Include="V10\Bulk\Entities\BulkAccount.cs" />

BingAdsApiSDK/Internal/ErrorMessages.cs

@@ -59,6 +59,10 @@ internal static class ErrorMessages
 
         public const string UriDoesntContainExpiresIn = "Uri passed doesn't contain expires_in param. Please make sure the has an expires_in param in it";
 
+        public const string UriDoesntContainState = "Uri passed doesn't contain state param while authentication requires a state verification. Please make sure the uri has a state in it, for example http://myurl.com?code=123&state=MyState";
+
+        public const string UriDoesntMatchState = "The state passed in Uri does not match the state value specified in authentication";
+
         public const string UserDataAuthenticationIsNull = "UserData object has the Authentication property set to null. Please make sure it's not null before calling this method";
         public const string UserDataDeveloperTokenIsNull = "UserData object has the DeveloperToken property set to null. Please make sure it's not null before calling this method";
 

BingAdsApiSDK/Internal/OAuth/LiveComOAuthService.cs

@@ -125,7 +125,7 @@ public static Uri GetAuthorizationEndpoint(OAuthUrlParameters parameters)
                 "https://login.live.com/oauth20_authorize.srf?client_id={0}&scope=bingads.manage&response_type={1}&redirect_uri={2}",
                 parameters.ClientId,
                 parameters.ResponseType,
-                parameters.RedirectUri)
+                parameters.RedirectUri) + (string.IsNullOrEmpty(parameters.State) ? "": string.Format("&state={0}", parameters.State))
             );
         }
     }

BingAdsApiSDK/Internal/OAuth/OAuthUrlParameters.cs

@@ -58,5 +58,7 @@ internal class OAuthUrlParameters
         public string ResponseType { get; set; }
 
         public Uri RedirectUri { get; set; }
+
+        public string State { get; set; }
     }
 }

BingAdsApiSDK/Internal/OAuthWithAuthorizationCode.cs

@@ -72,6 +72,11 @@ public abstract class OAuthWithAuthorizationCode : OAuthAuthorization
 
         private readonly IOAuthService _oauthService;
 
+        /// <summary>
+        /// An opaque value used by the client to maintain state between the request and callback. 
+        /// </summary>
+        public string State { get; set; }
+
         /// <summary>
         /// Reserved for internal use.
         /// </summary>
@@ -129,6 +134,42 @@ protected OAuthWithAuthorizationCode(string clientId, string optionalClientSecre
             OAuthTokens = new OAuthTokens(null, 0, refreshToken);
         }
 
+        /// <summary>
+        /// Initializes a new instance of the OAuthWebAuthCodeGrant class.
+        /// </summary>
+        /// <param name="clientId">
+        /// The client identifier corresponding to your registered application. 
+        /// </param>
+        /// <param name="optionalClientSecret">
+        /// The client secret corresponding to your registered application, or null if your app is a desktop or mobile app.
+        /// </param>
+        /// <param name="redirectionUri">
+        /// The URI to which the user of the app will be redirected after receiving user consent.
+        /// </param>
+        /// <param name="oauthTokens">
+        /// Contains information about OAuth access tokens received from the Microsoft Account authorization service.
+        /// </param>
+        /// <remarks>
+        /// <para>
+        /// For more information about using a client identifier for authentication, see 
+        /// <see href="http://tools.ietf.org/html/draft-ietf-oauth-v2-15#section-3.1">Client Password Authentication section of the OAuth 2.0 spec</see>.
+        /// </para>
+        /// <para>
+        /// For web applications, redirectionUri must be within the same domain of your registered application.  
+        /// For more information, see <see href="http://tools.ietf.org/html/draft-ietf-oauth-v2-15#section-2.1.1">Redirection Uri section of the OAuth 2.0 spec</see>.
+        /// </para>
+        /// </remarks>
+        protected OAuthWithAuthorizationCode(string clientId, string optionalClientSecret, Uri redirectionUri, OAuthTokens oauthTokens)
+            : this(clientId, optionalClientSecret, redirectionUri, new LiveComOAuthService())
+        {
+            if (oauthTokens == null || oauthTokens.RefreshToken == null)
+            {
+                throw new ArgumentNullException("oAuthTokens");
+            }
+
+            OAuthTokens = new OAuthTokens(null, 0, oauthTokens.RefreshToken);
+        }
+
         /// <summary>
         /// Initializes a new instance of the OAuthWithAuthorizationCode class.
         /// </summary>
@@ -179,7 +220,8 @@ public override Uri GetAuthorizationEndpoint()
             {
                 ClientId = ClientId,
                 ResponseType = "code",
-                RedirectUri = RedirectionUri
+                RedirectUri = RedirectionUri,
+                State = State
             });
         }
 

BingAdsApiSDK/OAuthDesktopMobileAuthCodeGrant.cs

@@ -106,6 +106,24 @@ public OAuthDesktopMobileAuthCodeGrant(string clientId, string refreshToken)
 
         }
 
+        /// <summary>
+        /// Initializes a new instance of the OAuthDesktopMobileAuthCodeGrant class with the specified ClientId.
+        /// </summary>
+        /// <param name="clientId">
+        /// The client identifier corresponding to your registered application.  
+        /// </param>
+        /// <param name="oauthTokens">
+        /// Contains information about OAuth access tokens received from the Microsoft Account authorization service.
+        /// </param>
+        /// <remarks>
+        /// For more information about using a client identifier for authentication, see <see href="http://tools.ietf.org/html/draft-ietf-oauth-v2-15#section-3.1">Client Password Authentication section of the OAuth 2.0 spec</see>.
+        /// </remarks>
+        public OAuthDesktopMobileAuthCodeGrant(string clientId, OAuthTokens oauthTokens)
+            : base(clientId, null, LiveComOAuthService.DesktopRedirectUri, oauthTokens)
+        {
+
+        }
+
         internal OAuthDesktopMobileAuthCodeGrant(string clientId, IOAuthService oauthService)
             : base(clientId, null, LiveComOAuthService.DesktopRedirectUri, oauthService)
         {

BingAdsApiSDK/OAuthDesktopMobileImplicitGrant.cs

@@ -71,7 +71,12 @@ namespace Microsoft.BingAds
     /// </para>
     /// </remarks>
     public class OAuthDesktopMobileImplicitGrant : OAuthAuthorization
-    {   
+    {
+        /// <summary>
+        /// An opaque value used by the client to maintain state between the request and callback. 
+        /// </summary>
+        public string State { get; set; }
+
         /// <summary>
         /// The URI to which your client browser will be redirected after receiving user consent.
         /// </summary>
@@ -94,7 +99,25 @@ public OAuthDesktopMobileImplicitGrant(string clientId)
             : base(clientId)
         {            
 
-        }        
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the OAuthDesktopMobileImplicitGrant class.
+        /// </summary>
+        /// <param name="clientId">
+        /// The client identifier corresponding to your registered application.
+        /// </param>
+        /// <param name="oAuthTokens">
+        /// Contains information about OAuth access tokens received from the Microsoft Account authorization service.
+        /// </param>
+        /// /// <remarks>
+        /// For more information about using a client identifier for authentication, see <see href="http://tools.ietf.org/html/draft-ietf-oauth-v2-15#section-3.1">Client Password Authentication section of the OAuth 2.0 spec</see>.
+        /// </remarks>
+        public OAuthDesktopMobileImplicitGrant(string clientId, OAuthTokens oAuthTokens)
+            : base(clientId)
+        {
+            OAuthTokens = oAuthTokens;
+        }
 
         /// <summary>
         /// Gets the Microsoft Account authorization endpoint where the user should be navigated to give his or her consent.
@@ -106,7 +129,8 @@ public override Uri GetAuthorizationEndpoint()
             {
                 ClientId = ClientId,
                 ResponseType = "token",
-                RedirectUri = LiveComOAuthService.DesktopRedirectUri
+                RedirectUri = LiveComOAuthService.DesktopRedirectUri,
+                State = State
             });
         }
 
@@ -129,7 +153,7 @@ public OAuthTokens ExtractAccessTokenFromUri(Uri redirectUri)
 
             if (!fragmentParts.ContainsKey("expires_in"))
             {
-                throw new InvalidOperationException(ErrorMessages.UriDoesntContainAccessToken);
+                throw new InvalidOperationException(ErrorMessages.UriDoesntContainExpiresIn);
             }
 
             return OAuthTokens = new OAuthTokens(fragmentParts["access_token"], int.Parse(fragmentParts["expires_in"]), null);            

BingAdsApiSDK/OAuthWebAuthCodeGrant.cs

@@ -143,6 +143,40 @@ public OAuthWebAuthCodeGrant(string clientId, string clientSecret, Uri redirecti
             }
         }
 
+        /// <summary>
+        /// Initializes a new instance of the OAuthWebAuthCodeGrant class.
+        /// </summary>
+        /// <param name="clientId">
+        /// The client identifier corresponding to your registered application. 
+        /// </param>
+        /// <param name="clientSecret">
+        /// The client secret corresponding to your registered application, or null if your app is a desktop or mobile app.
+        /// </param>
+        /// <param name="redirectionUri">
+        /// The URI to which the user of the app will be redirected after receiving user consent.
+        /// </param>
+        /// <param name="oAuthTokens">
+        /// Contains information about OAuth access tokens received from the Microsoft Account authorization service.
+        /// </param>
+        /// <remarks>
+        /// <para>
+        /// For more information about using a client identifier for authentication, see 
+        /// <see href="http://tools.ietf.org/html/draft-ietf-oauth-v2-15#section-3.1">Client Password Authentication section of the OAuth 2.0 spec</see>.
+        /// </para>
+        /// <para>
+        /// For web applications, redirectionUri must be within the same domain of your registered application.  
+        /// For more information, see <see href="http://tools.ietf.org/html/draft-ietf-oauth-v2-15#section-2.1.1">Redirection Uri section of the OAuth 2.0 spec</see>.
+        /// </para>
+        /// </remarks>
+        public OAuthWebAuthCodeGrant(string clientId, string clientSecret, Uri redirectionUri, OAuthTokens oAuthTokens)
+            : base(clientId, clientSecret, redirectionUri, oAuthTokens)
+        {
+            if (clientSecret == null)
+            {
+                throw new ArgumentNullException("clientSecret");
+            }
+        }
+
         internal OAuthWebAuthCodeGrant(string clientId, string clientSecret, Uri redirectionUri, IOAuthService oauthService)
             : base(clientId, clientSecret, redirectionUri, oauthService)
         {