Merge pull request #115 from BingAds/v13-0-1

sunset v12 update v13 proxies

Author: Eric Urban

composer.json

@@ -11,11 +11,6 @@
         "ext-openssl": "*",
         "ext-soap": "*"
     },
-    "require-dev": {
-        "ext-curl": "*",
-        "ext-openssl": "*",
-        "ext-soap": "*"
-    },
     "autoload": {
         "psr-4": {
             "Microsoft\\BingAds\\": "/src/"

samples/V13/AdExtensions.php

@@ -380,7 +380,8 @@
     $adExtensions = CampaignManagementExampleHelper::GetAdExtensionsByIds(
     	$GLOBALS['AuthorizationData']->AccountId,
     	$adExtensionIds,
-    	$adExtensionsTypeFilter
+        $adExtensionsTypeFilter,
+        null
     )->AdExtensions;
     print("AdExtensions:\r\n");
     CampaignManagementExampleHelper::OutputArrayOfAdExtension($adExtensions);
@@ -426,7 +427,8 @@
     $adExtensions = CampaignManagementExampleHelper::GetAdExtensionsByIds(
     	$GLOBALS['AuthorizationData']->AccountId,
     	$adExtensionIds,
-    	$adExtensionsTypeFilter
+        $adExtensionsTypeFilter,
+        null
     )->AdExtensions;
     print("AdExtensions:\r\n");
     CampaignManagementExampleHelper::OutputArrayOfAdExtension($adExtensions);

samples/V13/AuthHelper.php

@@ -197,10 +197,10 @@ static function AuthenticateWithOAuth()
 
     static function RequestUserConsent()
     {
-        print "You need to provide consent for the application to access your Bing Ads Bing Ads accounts. " .
+        print "You need to provide consent for the application to access your Microsoft Advertising accounts. " .
               "Copy and paste this authorization endpoint into a web browser and sign in with a Microsoft account " . 
-              "with access to a Bing Ads account: \n\n" . $GLOBALS['AuthorizationData']->Authentication->GetAuthorizationEndpoint() .
-              "\n\nAfter you have granted consent in the web browser for the application to access your Bing Ads accounts, " .
+              "with access to a Microsoft Advertising account: \n\n" . $GLOBALS['AuthorizationData']->Authentication->GetAuthorizationEndpoint() .
+              "\n\nAfter you have granted consent in the web browser for the application to access your Microsoft Advertising accounts, " .
               "please enter the response URI that includes the authorization 'code' parameter: \n\n";
 
         $responseUri = fgets(STDIN);

samples/V13/CampaignManagementExampleHelper.php

@@ -915,7 +915,8 @@ static function GetCampaignsByIds(
     }
     static function GetConversionGoalsByIds(
         $conversionGoalIds,
-        $conversionGoalTypes)
+        $conversionGoalTypes,
+        $returnAdditionalFields)
     {
         $GLOBALS['CampaignManagementProxy']->SetAuthorizationData($GLOBALS['AuthorizationData']);
         $GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
@@ -924,12 +925,14 @@ static function GetConversionGoalsByIds(
 
         $request->ConversionGoalIds = $conversionGoalIds;
         $request->ConversionGoalTypes = $conversionGoalTypes;
+        $request->ReturnAdditionalFields = $returnAdditionalFields;
 
         return $GLOBALS['CampaignManagementProxy']->GetService()->GetConversionGoalsByIds($request);
     }
     static function GetConversionGoalsByTagIds(
         $tagIds,
-        $conversionGoalTypes)
+        $conversionGoalTypes,
+        $returnAdditionalFields)
     {
         $GLOBALS['CampaignManagementProxy']->SetAuthorizationData($GLOBALS['AuthorizationData']);
         $GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
@@ -938,6 +941,7 @@ static function GetConversionGoalsByTagIds(
 
         $request->TagIds = $tagIds;
         $request->ConversionGoalTypes = $conversionGoalTypes;
+        $request->ReturnAdditionalFields = $returnAdditionalFields;
 
         return $GLOBALS['CampaignManagementProxy']->GetService()->GetConversionGoalsByTagIds($request);
     }
@@ -2821,6 +2825,7 @@ static function OutputConversionGoal($dataObject)
             self::OutputStatusMessage(sprintf("TagId: %s", $dataObject->TagId));
             self::OutputStatusMessage(sprintf("TrackingStatus: %s", $dataObject->TrackingStatus));
             self::OutputStatusMessage(sprintf("Type: %s", $dataObject->Type));
+            self::OutputStatusMessage(sprintf("ViewThroughConversionWindowInMinutes: %s", $dataObject->ViewThroughConversionWindowInMinutes));
             if($dataObject->Type === "AppInstallGoal")
             {
                 self::OutputAppInstallGoal($dataObject);
@@ -6680,6 +6685,29 @@ static function OutputArrayOfConversionGoalType($valueSets)
         }
         self::OutputStatusMessage("* * * End OutputArrayOfConversionGoalType * * *");
     }
+    static function OutputConversionGoalAdditionalField($valueSet)
+    {
+        self::OutputStatusMessage("* * * Begin OutputConversionGoalAdditionalField * * *");
+        self::OutputStatusMessage(sprintf("Values in %s", $valueSet->type));
+        foreach ($valueSet->string as $value)
+        {
+            self::OutputStatusMessage($value);
+        }
+        self::OutputStatusMessage("* * * End OutputConversionGoalAdditionalField * * *");
+    }
+    static function OutputArrayOfConversionGoalAdditionalField($valueSets)
+    {
+        if(count((array)$valueSets) == 0)
+        {
+            return;
+        }
+        self::OutputStatusMessage("* * * Begin OutputArrayOfConversionGoalAdditionalField * * *");
+        foreach ($valueSets->ConversionGoalAdditionalField as $valueSet)
+        {
+            self::OutputConversionGoalAdditionalField($valueSet);
+        }
+        self::OutputStatusMessage("* * * End OutputArrayOfConversionGoalAdditionalField * * *");
+    }
     static function OutputConversionGoalCountType($valueSet)
     {
         self::OutputStatusMessage("* * * Begin OutputConversionGoalCountType * * *");

samples/V13/ConversionGoals.php

@@ -66,7 +66,7 @@
     // the tracking script that you should add to your website is included in a corresponding 
     // UetTag within the response message. 
 
-    if ($uetTags == null || count($uetTags) < 1)
+    if ($uetTags == null || count($uetTags->UetTag) < 1)
     {
         $addUetTags = array();
         $uetTag = new UetTag();
@@ -85,7 +85,7 @@
         CampaignManagementExampleHelper::OutputArrayOfBatchError($addUetTagsResponse->PartialErrors);
     }
 
-    if ($uetTags == null || count($uetTags) < 1)
+    if ($uetTags == null || count($uetTags->UetTag) < 1)
     {
         printf(
             "You do not have any UET tags registered for CustomerId %s.\r\n", 
@@ -262,7 +262,8 @@
     print("-----\r\nGetConversionGoalsByIds:\r\n");
     $getConversionGoalsByIdsResponse = CampaignManagementExampleHelper::GetConversionGoalsByIds(
         $conversionGoalIds, 
-        $conversionGoalTypes
+        $conversionGoalTypes,
+        null
     );
     $getConversionGoals = $getConversionGoalsByIdsResponse->ConversionGoals;
     print("ConversionGoals:\r\n");
@@ -385,7 +386,8 @@
     print("-----\r\nGetConversionGoalsByIds:\r\n");
     $getConversionGoalsByIdsResponse = CampaignManagementExampleHelper::GetConversionGoalsByIds(
         $conversionGoalIds, 
-        $conversionGoalTypes
+        $conversionGoalTypes,
+        null
     );
     $getConversionGoals = $getConversionGoalsByIdsResponse->ConversionGoals;
     print("ConversionGoals:\r\n");

samples/WebAuthentication/CallBingAdsServices.php

@@ -52,14 +52,14 @@
         WebAuthHelper::GetApiEnvironment());
 
     // Set the GetUser request parameter to an empty user identifier to get the current 
-    // authenticated Bing Ads user, and then search for all accounts the user may access.
+    // authenticated Microsoft Advertising user, and then search for all accounts the user can access.
 
     $getUserRequest = new GetUserRequest();
     $getUserRequest->UserId = null;
 
     $user = $GLOBALS['CustomerManagementProxy']->GetService()->GetUser($getUserRequest)->User;
 
-    // Search for the Bing Ads accounts that the user can access.
+    // Search for the Microsoft Advertising accounts that the user can access.
 
     $pageInfo = new Paging();
     $pageInfo->Index = 0;    // The first page

samples/WebAuthentication/Index.php

@@ -16,7 +16,7 @@
 -->
 <h2>Bing Ads OAuth Demo</h2>
 
-<p>This application would like to manage your Bing Ads data. Click below to login and authorize this application.</p>
+<p>This application would like to manage your Microsoft Advertising data. Click below to login and authorize this application.</p>
 
 <p>When you click OK below, you'll be redirected to the following URI:</p>
 <p><?php echo WebAuthHelper::RedirectUri ?></p>

samples/WebAuthentication/OAuth2Callback.php

@@ -38,7 +38,7 @@
 
         $_SESSION['state'] = $_SESSION['AuthorizationData']->Authentication->State;
 
-        // The user needs to provide consent for the application to access their Bing Ads accounts.
+        // The user needs to provide consent for the application to access their Microsoft Advertising accounts.
         header('Location: '. $_SESSION['AuthorizationData']->Authentication->GetAuthorizationEndpoint());
     }
 

src/Auth/Authentication.php

@@ -8,7 +8,7 @@
 abstract class Authentication
 {
     /** 
-     * The Authentication type, for example OAuthDesktopMobileImplicitGrant.
+     * The Authentication type, for example OAuthDesktopMobileAuthCodeGrant.
      */
     public $Type;
 }

src/Auth/AuthorizationData.php

@@ -8,22 +8,26 @@
 class AuthorizationData
 {
     /** 
-     * An object representing the authentication headers that should be used in calls to the Bing Ads web services.
+     * An object representing the authentication headers that should be used in calls to the Bing Ads API.
+     * @var OAuthAuthorization
      */
     public $Authentication;
 
     /** 
-     * The identifier of the account that owns the entities in the request. Used as the CustomerAccountId header element in calls to the Bing Ads web services.
+     * The identifier of the account that owns the entities in the request. Used as the CustomerAccountId header element in calls to the Bing Ads API.
+     * @var string
      */
     public $AccountId;
 
     /** 
-     * The identifier of the customer that owns the account. Used as the CustomerId header element in calls to the Bing Ads web services.
+     * The identifier of the customer that owns the account. Used as the CustomerId header element in calls to the Bing Ads API.
+     * @var string
      */
     public $CustomerId;
 
     /** 
-     * The Bing Ads developer access token. Used as the DeveloperToken header element in calls to the Bing Ads web services.
+     * The Bing Ads developer access token. Used as the DeveloperToken header element in calls to the Bing Ads API.
+     * @var string
      */
     public $DeveloperToken;