Merge pull request #54 from BingAds/march-updates

Updated to support Microsoft Account authentication in sandbox
BingAds · Mar 13, 2018 · 4c9212b · 4c9212b
2 parents 0d7d5e8 + a50b804
commit 4c9212b
Show file tree

Hide file tree

Showing 70 changed files with 658 additions and 167 deletions.
diff --git a/samples/AuthHelper.php b/samples/AuthHelper.php
@@ -29,7 +29,6 @@ final class AuthHelper {
     const OAuthRefreshTokenPath = 'refresh.txt';
     const ClientId = 'ClientIdGoesHere'; 
     const ClientSecret = 'ClientSecretGoesHere'; 
-    const RedirectUri = "https://login.live.com/oauth20_desktop.srf"; 
 
     // Sets the global authorization data instance with PasswordAuthentication.
 
@@ -49,8 +48,8 @@ static function AuthenticateWithUserName()
     static function AuthenticateWithOAuth() 
     {
         $authentication = (new OAuthDesktopMobileAuthCodeGrant())
-            ->withClientId(AuthHelper::ClientId)
-            ->withRedirectUri(AuthHelper::RedirectUri);
+            ->withEnvironment(AuthHelper::ApiEnvironment)
+            ->withClientId(AuthHelper::ClientId);
 
         $GLOBALS['AuthorizationData'] = (new AuthorizationData())
             ->withAuthentication($authentication)

diff --git a/samples/V11/AdExtensions.php b/samples/V11/AdExtensions.php
@@ -71,15 +71,14 @@
 
 try
 {
-    // You should authenticate for Bing Ads production services with a Microsoft Account, 
+    // You should authenticate for Bing Ads services with a Microsoft Account, 
     // instead of providing the Bing Ads username and password set. 
 
-    //AuthHelper::AuthenticateWithOAuth();
+    AuthHelper::AuthenticateWithOAuth();
 
-    // However, authentication with a Microsoft Account is currently not supported in Sandbox,
-    // so it is recommended that you set the UserName and Password in sandbox for testing.
-
-    AuthHelper::AuthenticateWithUserName();
+    // Bing Ads API Version 11 is the last version to support UserName and Password authentication,
+    // so this function is deprecated.
+    //AuthHelper::AuthenticateWithUserName();
 
     $GLOBALS['CustomerProxy'] = new ServiceClient(ServiceClientType::CustomerManagementVersion11, $GLOBALS['AuthorizationData'], AuthHelper::GetApiEnvironment());
 

diff --git a/samples/V11/BudgetOpportunities.php b/samples/V11/BudgetOpportunities.php
@@ -38,15 +38,14 @@
 
 try
 {
-    // You should authenticate for Bing Ads production services with a Microsoft Account, 
+    // You should authenticate for Bing Ads services with a Microsoft Account, 
     // instead of providing the Bing Ads username and password set. 
 
-    //AuthHelper::AuthenticateWithOAuth();
+    AuthHelper::AuthenticateWithOAuth();
 
-    // However, authentication with a Microsoft Account is currently not supported in Sandbox,
-    // so it is recommended that you set the UserName and Password in sandbox for testing.
-
-    AuthHelper::AuthenticateWithUserName();
+    // Bing Ads API Version 11 is the last version to support UserName and Password authentication,
+    // so this function is deprecated.
+    //AuthHelper::AuthenticateWithUserName();
 
     $GLOBALS['CustomerProxy'] = new ServiceClient(ServiceClientType::CustomerManagementVersion11, $GLOBALS['AuthorizationData'], AuthHelper::GetApiEnvironment());
 

diff --git a/samples/V11/BulkDownloadUpload.php b/samples/V11/BulkDownloadUpload.php
@@ -82,15 +82,14 @@
 
 try
 {
-    // You should authenticate for Bing Ads production services with a Microsoft Account, 
+    // You should authenticate for Bing Ads services with a Microsoft Account, 
     // instead of providing the Bing Ads username and password set. 
 
-    //AuthHelper::AuthenticateWithOAuth();
+    AuthHelper::AuthenticateWithOAuth();
 
-    // However, authentication with a Microsoft Account is currently not supported in Sandbox,
-    // so it is recommended that you set the UserName and Password in sandbox for testing.
-
-    AuthHelper::AuthenticateWithUserName();
+    // Bing Ads API Version 11 is the last version to support UserName and Password authentication,
+    // so this function is deprecated.
+    //AuthHelper::AuthenticateWithUserName();
 
     $GLOBALS['CustomerProxy'] = new ServiceClient(ServiceClientType::CustomerManagementVersion11, $GLOBALS['AuthorizationData'], AuthHelper::GetApiEnvironment());
 

diff --git a/samples/V11/ConversionGoals.php b/samples/V11/ConversionGoals.php
@@ -53,15 +53,14 @@
 
 try
 {
-    // You should authenticate for Bing Ads production services with a Microsoft Account, 
+    // You should authenticate for Bing Ads services with a Microsoft Account, 
     // instead of providing the Bing Ads username and password set. 
 
-    //AuthHelper::AuthenticateWithOAuth();
+    AuthHelper::AuthenticateWithOAuth();
 
-    // However, authentication with a Microsoft Account is currently not supported in Sandbox,
-    // so it is recommended that you set the UserName and Password in sandbox for testing.
-
-    AuthHelper::AuthenticateWithUserName();
+    // Bing Ads API Version 11 is the last version to support UserName and Password authentication,
+    // so this function is deprecated.
+    //AuthHelper::AuthenticateWithUserName();
 
     $GLOBALS['CustomerProxy'] = new ServiceClient(ServiceClientType::CustomerManagementVersion11, $GLOBALS['AuthorizationData'], AuthHelper::GetApiEnvironment());
 

diff --git a/samples/V11/CustomerSignup.php b/samples/V11/CustomerSignup.php
@@ -45,15 +45,14 @@
 
 try
 {
-    // You should authenticate for Bing Ads production services with a Microsoft Account, 
+    // You should authenticate for Bing Ads services with a Microsoft Account, 
     // instead of providing the Bing Ads username and password set. 
 
-    //AuthHelper::AuthenticateWithOAuth();
+    AuthHelper::AuthenticateWithOAuth();
 
-    // However, authentication with a Microsoft Account is currently not supported in Sandbox,
-    // so it is recommended that you set the UserName and Password in sandbox for testing.
-
-    AuthHelper::AuthenticateWithUserName();
+    // Bing Ads API Version 11 is the last version to support UserName and Password authentication,
+    // so this function is deprecated.
+    //AuthHelper::AuthenticateWithUserName();
 
     $GLOBALS['CustomerProxy'] = new ServiceClient(ServiceClientType::CustomerManagementVersion11, $GLOBALS['AuthorizationData'], AuthHelper::GetApiEnvironment());
 

diff --git a/samples/V11/DynamicSearchAds.php b/samples/V11/DynamicSearchAds.php
@@ -71,15 +71,14 @@
 
 try
 {
-    // You should authenticate for Bing Ads production services with a Microsoft Account, 
+    // You should authenticate for Bing Ads services with a Microsoft Account, 
     // instead of providing the Bing Ads username and password set. 
 
-    //AuthHelper::AuthenticateWithOAuth();
+    AuthHelper::AuthenticateWithOAuth();
 
-    // However, authentication with a Microsoft Account is currently not supported in Sandbox,
-    // so it is recommended that you set the UserName and Password in sandbox for testing.
-
-    AuthHelper::AuthenticateWithUserName();
+    // Bing Ads API Version 11 is the last version to support UserName and Password authentication,
+    // so this function is deprecated.
+    //AuthHelper::AuthenticateWithUserName();
 
     $GLOBALS['CustomerProxy'] = new ServiceClient(ServiceClientType::CustomerManagementVersion11, $GLOBALS['AuthorizationData'], AuthHelper::GetApiEnvironment());
 

diff --git a/samples/V11/GeographicalLocations.php b/samples/V11/GeographicalLocations.php
@@ -55,15 +55,14 @@
 
 try
 {
-    // You should authenticate for Bing Ads production services with a Microsoft Account, 
+    // You should authenticate for Bing Ads services with a Microsoft Account, 
     // instead of providing the Bing Ads username and password set. 
 
-    //AuthHelper::AuthenticateWithOAuth();
+    AuthHelper::AuthenticateWithOAuth();
 
-    // However, authentication with a Microsoft Account is currently not supported in Sandbox,
-    // so it is recommended that you set the UserName and Password in sandbox for testing.
-
-    AuthHelper::AuthenticateWithUserName();
+    // Bing Ads API Version 11 is the last version to support UserName and Password authentication,
+    // so this function is deprecated.
+    //AuthHelper::AuthenticateWithUserName();
 
     $GLOBALS['CustomerProxy'] = new ServiceClient(ServiceClientType::CustomerManagementVersion11, $GLOBALS['AuthorizationData'], AuthHelper::GetApiEnvironment());
 

diff --git a/samples/V11/KeywordPlanner.php b/samples/V11/KeywordPlanner.php
@@ -73,15 +73,14 @@
 
 try
 {
-    // You should authenticate for Bing Ads production services with a Microsoft Account, 
+    // You should authenticate for Bing Ads services with a Microsoft Account, 
     // instead of providing the Bing Ads username and password set. 
 
-    //AuthHelper::AuthenticateWithOAuth();
+    AuthHelper::AuthenticateWithOAuth();
 
-    // However, authentication with a Microsoft Account is currently not supported in Sandbox,
-    // so it is recommended that you set the UserName and Password in sandbox for testing.
-
-    AuthHelper::AuthenticateWithUserName();
+    // Bing Ads API Version 11 is the last version to support UserName and Password authentication,
+    // so this function is deprecated.
+    //AuthHelper::AuthenticateWithUserName();
 
     $GLOBALS['CustomerProxy'] = new ServiceClient(ServiceClientType::CustomerManagementVersion11, $GLOBALS['AuthorizationData'], AuthHelper::GetApiEnvironment());
 

diff --git a/samples/V11/KeywordsAds.php b/samples/V11/KeywordsAds.php
@@ -60,15 +60,14 @@
 
 try
 {
-    // You should authenticate for Bing Ads production services with a Microsoft Account, 
+    // You should authenticate for Bing Ads services with a Microsoft Account, 
     // instead of providing the Bing Ads username and password set. 
 
-    //AuthHelper::AuthenticateWithOAuth();
+    AuthHelper::AuthenticateWithOAuth();
 
-    // However, authentication with a Microsoft Account is currently not supported in Sandbox,
-    // so it is recommended that you set the UserName and Password in sandbox for testing.
-
-    AuthHelper::AuthenticateWithUserName();
+    // Bing Ads API Version 11 is the last version to support UserName and Password authentication,
+    // so this function is deprecated.
+    //AuthHelper::AuthenticateWithUserName();
 
     $GLOBALS['CustomerProxy'] = new ServiceClient(ServiceClientType::CustomerManagementVersion11, $GLOBALS['AuthorizationData'], AuthHelper::GetApiEnvironment());
 

diff --git a/samples/V11/ManageClient.php b/samples/V11/ManageClient.php
@@ -62,15 +62,14 @@
 
 try
 {
-    // You should authenticate for Bing Ads production services with a Microsoft Account, 
+    // You should authenticate for Bing Ads services with a Microsoft Account, 
     // instead of providing the Bing Ads username and password set. 
 
-    //AuthHelper::AuthenticateWithOAuth();
+    AuthHelper::AuthenticateWithOAuth();
 
-    // However, authentication with a Microsoft Account is currently not supported in Sandbox,
-    // so it is recommended that you set the UserName and Password in sandbox for testing.
-
-    AuthHelper::AuthenticateWithUserName();
+    // Bing Ads API Version 11 is the last version to support UserName and Password authentication,
+    // so this function is deprecated.
+    //AuthHelper::AuthenticateWithUserName();
 
     $GLOBALS['CustomerProxy'] = new ServiceClient(ServiceClientType::CustomerManagementVersion11, $GLOBALS['AuthorizationData'], AuthHelper::GetApiEnvironment());
 

diff --git a/samples/V11/NegativeKeywords.php b/samples/V11/NegativeKeywords.php
@@ -48,15 +48,14 @@
 
 try
 {
-    // You should authenticate for Bing Ads production services with a Microsoft Account, 
+    // You should authenticate for Bing Ads services with a Microsoft Account, 
     // instead of providing the Bing Ads username and password set. 
 
-    //AuthHelper::AuthenticateWithOAuth();
+    AuthHelper::AuthenticateWithOAuth();
 
-    // However, authentication with a Microsoft Account is currently not supported in Sandbox,
-    // so it is recommended that you set the UserName and Password in sandbox for testing.
-
-    AuthHelper::AuthenticateWithUserName();
+    // Bing Ads API Version 11 is the last version to support UserName and Password authentication,
+    // so this function is deprecated.
+    //AuthHelper::AuthenticateWithUserName();
 
     $GLOBALS['CustomerProxy'] = new ServiceClient(ServiceClientType::CustomerManagementVersion11, $GLOBALS['AuthorizationData'], AuthHelper::GetApiEnvironment());
 

diff --git a/samples/V11/RemarketingLists.php b/samples/V11/RemarketingLists.php
@@ -60,15 +60,14 @@
 
 try
 {
-    // You should authenticate for Bing Ads production services with a Microsoft Account, 
+    // You should authenticate for Bing Ads services with a Microsoft Account, 
     // instead of providing the Bing Ads username and password set. 
 
-    //AuthHelper::AuthenticateWithOAuth();
+    AuthHelper::AuthenticateWithOAuth();
 
-    // However, authentication with a Microsoft Account is currently not supported in Sandbox,
-    // so it is recommended that you set the UserName and Password in sandbox for testing.
-
-    AuthHelper::AuthenticateWithUserName();
+    // Bing Ads API Version 11 is the last version to support UserName and Password authentication,
+    // so this function is deprecated.
+    //AuthHelper::AuthenticateWithUserName();
 
     $GLOBALS['CustomerProxy'] = new ServiceClient(ServiceClientType::CustomerManagementVersion11, $GLOBALS['AuthorizationData'], AuthHelper::GetApiEnvironment());
 

diff --git a/samples/V11/ReportRequests.php b/samples/V11/ReportRequests.php
@@ -56,15 +56,14 @@
 
 try
 {
-    // You should authenticate for Bing Ads production services with a Microsoft Account, 
+    // You should authenticate for Bing Ads services with a Microsoft Account, 
     // instead of providing the Bing Ads username and password set. 
 
-    //AuthHelper::AuthenticateWithOAuth();
+    AuthHelper::AuthenticateWithOAuth();
 
-    // However, authentication with a Microsoft Account is currently not supported in Sandbox,
-    // so it is recommended that you set the UserName and Password in sandbox for testing.
-
-    AuthHelper::AuthenticateWithUserName();
+    // Bing Ads API Version 11 is the last version to support UserName and Password authentication,
+    // so this function is deprecated.
+    //AuthHelper::AuthenticateWithUserName();
 
     $GLOBALS['CustomerProxy'] = new ServiceClient(ServiceClientType::CustomerManagementVersion11, $GLOBALS['AuthorizationData'], AuthHelper::GetApiEnvironment());
 

diff --git a/samples/V11/SearchUserAccounts.php b/samples/V11/SearchUserAccounts.php
@@ -40,15 +40,14 @@
 
 try
 {
-    // You should authenticate for Bing Ads production services with a Microsoft Account, 
+    // You should authenticate for Bing Ads services with a Microsoft Account, 
     // instead of providing the Bing Ads username and password set. 
 
-    //AuthHelper::AuthenticateWithOAuth();
+    AuthHelper::AuthenticateWithOAuth();
 
-    // However, authentication with a Microsoft Account is currently not supported in Sandbox,
-    // so it is recommended that you set the UserName and Password in sandbox for testing.
-
-    AuthHelper::AuthenticateWithUserName();
+    // Bing Ads API Version 11 is the last version to support UserName and Password authentication,
+    // so this function is deprecated.
+    //AuthHelper::AuthenticateWithUserName();
 
     $GLOBALS['CustomerProxy'] = new ServiceClient(ServiceClientType::CustomerManagementVersion11, $GLOBALS['AuthorizationData'], AuthHelper::GetApiEnvironment());
 

diff --git a/samples/V11/ShoppingCampaigns.php b/samples/V11/ShoppingCampaigns.php
@@ -66,15 +66,14 @@
 
 try
 {
-    // You should authenticate for Bing Ads production services with a Microsoft Account, 
+    // You should authenticate for Bing Ads services with a Microsoft Account, 
     // instead of providing the Bing Ads username and password set. 
 
-    //AuthHelper::AuthenticateWithOAuth();
+    AuthHelper::AuthenticateWithOAuth();
 
-    // However, authentication with a Microsoft Account is currently not supported in Sandbox,
-    // so it is recommended that you set the UserName and Password in sandbox for testing.
-
-    AuthHelper::AuthenticateWithUserName();
+    // Bing Ads API Version 11 is the last version to support UserName and Password authentication,
+    // so this function is deprecated.
+    //AuthHelper::AuthenticateWithUserName();
 
     $GLOBALS['CustomerProxy'] = new ServiceClient(ServiceClientType::CustomerManagementVersion11, $GLOBALS['AuthorizationData'], AuthHelper::GetApiEnvironment());
 

diff --git a/samples/V11/TargetCriterions.php b/samples/V11/TargetCriterions.php
@@ -57,15 +57,14 @@
 
 try
 {
-    // You should authenticate for Bing Ads production services with a Microsoft Account, 
+    // You should authenticate for Bing Ads services with a Microsoft Account, 
     // instead of providing the Bing Ads username and password set. 
 
-    //AuthHelper::AuthenticateWithOAuth();
+    AuthHelper::AuthenticateWithOAuth();
 
-    // However, authentication with a Microsoft Account is currently not supported in Sandbox,
-    // so it is recommended that you set the UserName and Password in sandbox for testing.
-
-    AuthHelper::AuthenticateWithUserName();
+    // Bing Ads API Version 11 is the last version to support UserName and Password authentication,
+    // so this function is deprecated.
+    //AuthHelper::AuthenticateWithUserName();
 
     $GLOBALS['CustomerProxy'] = new ServiceClient(ServiceClientType::CustomerManagementVersion11, $GLOBALS['AuthorizationData'], AuthHelper::GetApiEnvironment());
 

diff --git a/src/Auth/HttpService.php b/src/Auth/HttpService.php
@@ -10,7 +10,7 @@
  */
 class HttpService 
 {
-     public function post($url, $postData) {
+    public function post($url, $postData) {
         $ch = curl_init();
 
         $query = "";

diff --git a/src/Auth/IOAuthService.php b/src/Auth/IOAuthService.php
@@ -11,5 +11,8 @@ abstract class IOAuthService
      * Implementations of this abstract method must call the authorization server with the oauthRequestParameters passed in, 
      * deserialize the response, and return back OAuth tokens.
      */
-    abstract function GetAccessTokens(OAuthRequestParameters $oauthParameters);
+    abstract function GetAccessTokens(OAuthRequestParameters $oauthParameters, $environment);
+
+    abstract static function getRedirectUrl($environment);
+
 }