Merge pull request #108 from BingAds/v12-13-5

proxy updates

Author: Eric Urban

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "microsoft/bingads",
-    "description": "This project provides a set of PHP client libraries that make it easy to access Bing Ads service APIs.",
-    "keywords": [ "php", "bingads", "bing ads", "sdk" ],
+    "description": "This project provides the PHP client library for the SOAP-based Bing Ads API at Microsoft.",
+    "keywords": [ "php", "bingads", "bing ads", "microsoft advertising", "sdk" ],
     "license": "Apache-2.0",
     "type": "library",
     "homepage": "https://github.com/BingAds/BingAds-PHP-SDK",

samples/V13/CampaignManagementExampleHelper.php

@@ -671,7 +671,8 @@ static function GetAdExtensionsAssociations(
         $accountId,
         $adExtensionType,
         $associationType,
-        $entityIds)
+        $entityIds,
+        $returnAdditionalFields)
     {
         $GLOBALS['CampaignManagementProxy']->SetAuthorizationData($GLOBALS['AuthorizationData']);
         $GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
@@ -682,13 +683,15 @@ static function GetAdExtensionsAssociations(
         $request->AdExtensionType = $adExtensionType;
         $request->AssociationType = $associationType;
         $request->EntityIds = $entityIds;
+        $request->ReturnAdditionalFields = $returnAdditionalFields;
 
         return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdExtensionsAssociations($request);
     }
     static function GetAdExtensionsByIds(
         $accountId,
         $adExtensionIds,
-        $adExtensionType)
+        $adExtensionType,
+        $returnAdditionalFields)
     {
         $GLOBALS['CampaignManagementProxy']->SetAuthorizationData($GLOBALS['AuthorizationData']);
         $GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
@@ -698,6 +701,7 @@ static function GetAdExtensionsByIds(
         $request->AccountId = $accountId;
         $request->AdExtensionIds = $adExtensionIds;
         $request->AdExtensionType = $adExtensionType;
+        $request->ReturnAdditionalFields = $returnAdditionalFields;
 
         return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdExtensionsByIds($request);
     }
@@ -3699,6 +3703,7 @@ static function OutputImageAdExtension($dataObject)
             self::OutputStatusMessage(sprintf("AlternativeText: %s", $dataObject->AlternativeText));
             self::OutputStatusMessage(sprintf("Description: %s", $dataObject->Description));
             self::OutputStatusMessage(sprintf("DestinationUrl: %s", $dataObject->DestinationUrl));
+            self::OutputStatusMessage(sprintf("DisplayText: %s", $dataObject->DisplayText));
             self::OutputStatusMessage("FinalAppUrls:");
             self::OutputArrayOfAppUrl($dataObject->FinalAppUrls);
             self::OutputStatusMessage("FinalMobileUrls:");
@@ -3708,6 +3713,8 @@ static function OutputImageAdExtension($dataObject)
             self::OutputArrayOfString($dataObject->FinalUrls);
             self::OutputStatusMessage("ImageMediaIds:");
             self::OutputArrayOfLong($dataObject->ImageMediaIds);
+            self::OutputStatusMessage("Images:");
+            self::OutputArrayOfAssetLink($dataObject->Images);
             self::OutputStatusMessage(sprintf("TrackingUrlTemplate: %s", $dataObject->TrackingUrlTemplate));
             self::OutputStatusMessage("UrlCustomParameters:");
             self::OutputCustomParameters($dataObject->UrlCustomParameters);
@@ -6098,6 +6105,29 @@ static function OutputArrayOfAdExtensionsTypeFilter($valueSets)
         }
         self::OutputStatusMessage("* * * End OutputArrayOfAdExtensionsTypeFilter * * *");
     }
+    static function OutputAdExtensionAdditionalField($valueSet)
+    {
+        self::OutputStatusMessage("* * * Begin OutputAdExtensionAdditionalField * * *");
+        self::OutputStatusMessage(sprintf("Values in %s", $valueSet->type));
+        foreach ($valueSet->string as $value)
+        {
+            self::OutputStatusMessage($value);
+        }
+        self::OutputStatusMessage("* * * End OutputAdExtensionAdditionalField * * *");
+    }
+    static function OutputArrayOfAdExtensionAdditionalField($valueSets)
+    {
+        if(count((array)$valueSets) == 0)
+        {
+            return;
+        }
+        self::OutputStatusMessage("* * * Begin OutputArrayOfAdExtensionAdditionalField * * *");
+        foreach ($valueSets->AdExtensionAdditionalField as $valueSet)
+        {
+            self::OutputAdExtensionAdditionalField($valueSet);
+        }
+        self::OutputStatusMessage("* * * End OutputArrayOfAdExtensionAdditionalField * * *");
+    }
     static function OutputAssociationType($valueSet)
     {
         self::OutputStatusMessage("* * * Begin OutputAssociationType * * *");

samples/V13/ReportingExampleHelper.php

@@ -1525,6 +1525,53 @@ static function OutputArrayOfProductMatchCountReportRequest($dataObjects)
             self::OutputProductMatchCountReportRequest($dataObject);
         }
     }
+    static function OutputProductNegativeKeywordConflictReportFilter($dataObject)
+    {
+        if (!empty($dataObject))
+        {
+            self::OutputStatusMessage("* * * Begin OutputProductNegativeKeywordConflictReportFilter * * *");
+            self::OutputStatusMessage(sprintf("AccountStatus: %s", $dataObject->AccountStatus));
+            self::OutputStatusMessage(sprintf("AdGroupStatus: %s", $dataObject->AdGroupStatus));
+            self::OutputStatusMessage(sprintf("CampaignStatus: %s", $dataObject->CampaignStatus));
+            self::OutputStatusMessage("* * * End OutputProductNegativeKeywordConflictReportFilter * * *");
+        }
+    }
+    static function OutputArrayOfProductNegativeKeywordConflictReportFilter($dataObjects)
+    {
+        if(count((array)$dataObjects) == 0 || !isset($dataObjects->ProductNegativeKeywordConflictReportFilter))
+        {
+            return;
+        }
+        foreach ($dataObjects->ProductNegativeKeywordConflictReportFilter as $dataObject)
+        {
+            self::OutputProductNegativeKeywordConflictReportFilter($dataObject);
+        }
+    }
+    static function OutputProductNegativeKeywordConflictReportRequest($dataObject)
+    {
+        if (!empty($dataObject))
+        {
+            self::OutputStatusMessage("* * * Begin OutputProductNegativeKeywordConflictReportRequest * * *");
+            self::OutputStatusMessage("Columns:");
+            self::OutputArrayOfProductNegativeKeywordConflictReportColumn($dataObject->Columns);
+            self::OutputStatusMessage("Filter:");
+            self::OutputProductNegativeKeywordConflictReportFilter($dataObject->Filter);
+            self::OutputStatusMessage("Scope:");
+            self::OutputAccountThroughAdGroupReportScope($dataObject->Scope);
+            self::OutputStatusMessage("* * * End OutputProductNegativeKeywordConflictReportRequest * * *");
+        }
+    }
+    static function OutputArrayOfProductNegativeKeywordConflictReportRequest($dataObjects)
+    {
+        if(count((array)$dataObjects) == 0 || !isset($dataObjects->ProductNegativeKeywordConflictReportRequest))
+        {
+            return;
+        }
+        foreach ($dataObjects->ProductNegativeKeywordConflictReportRequest as $dataObject)
+        {
+            self::OutputProductNegativeKeywordConflictReportRequest($dataObject);
+        }
+    }
     static function OutputProductPartitionPerformanceReportFilter($dataObject)
     {
         if (!empty($dataObject))
@@ -1894,6 +1941,10 @@ static function OutputReportRequest($dataObject)
             {
                 self::OutputProductMatchCountReportRequest($dataObject);
             }
+            if($dataObject->Type === "ProductNegativeKeywordConflictReportRequest")
+            {
+                self::OutputProductNegativeKeywordConflictReportRequest($dataObject);
+            }
             if($dataObject->Type === "ProductPartitionPerformanceReportRequest")
             {
                 self::OutputProductPartitionPerformanceReportRequest($dataObject);
@@ -3288,6 +3339,29 @@ static function OutputArrayOfProductMatchCountReportColumn($valueSets)
         }
         self::OutputStatusMessage("* * * End OutputArrayOfProductMatchCountReportColumn * * *");
     }
+    static function OutputProductNegativeKeywordConflictReportColumn($valueSet)
+    {
+        self::OutputStatusMessage("* * * Begin OutputProductNegativeKeywordConflictReportColumn * * *");
+        self::OutputStatusMessage(sprintf("Values in %s", $valueSet->type));
+        foreach ($valueSet->string as $value)
+        {
+            self::OutputStatusMessage($value);
+        }
+        self::OutputStatusMessage("* * * End OutputProductNegativeKeywordConflictReportColumn * * *");
+    }
+    static function OutputArrayOfProductNegativeKeywordConflictReportColumn($valueSets)
+    {
+        if(count((array)$valueSets) == 0)
+        {
+            return;
+        }
+        self::OutputStatusMessage("* * * Begin OutputArrayOfProductNegativeKeywordConflictReportColumn * * *");
+        foreach ($valueSets->ProductNegativeKeywordConflictReportColumn as $valueSet)
+        {
+            self::OutputProductNegativeKeywordConflictReportColumn($valueSet);
+        }
+        self::OutputStatusMessage("* * * End OutputArrayOfProductNegativeKeywordConflictReportColumn * * *");
+    }
     static function OutputCallDetailReportColumn($valueSet)
     {
         self::OutputStatusMessage("* * * Begin OutputCallDetailReportColumn * * *");

src/Auth/ServiceClient.php

@@ -252,7 +252,7 @@ private function RefreshServiceProxy()
 			'features' => SOAP_SINGLE_ELEMENT_ARRAYS,
 			// Disable keep-alive to avoid 'Process open FD table is full'
 			'keep-alive' => FALSE, 
-			'user_agent' => 'BingAdsSDKPHP ' . '12.13.4 ' . PHP_VERSION, 
+			'user_agent' => 'BingAdsSDKPHP ' . '12.13.5 ' . PHP_VERSION, 
 
 			/** 
 			 * Map long type to string type. For details, see

src/V12/CampaignManagement/CoOpSetting.php

@@ -4,21 +4,21 @@
 
 {
     /**
-     * Defines the ad group level settings for feed-based cooperative bidding campaigns.
+     * Defines the ad group level settings for feed-based Microsoft Shopping Campaigns.
      * @link https://docs.microsoft.com/en-us/advertising/campaign-management-service/coopsetting?view=bingads-12 CoOpSetting Data Object
      * 
      * @uses BidOption
      */
     final class CoOpSetting extends Setting
     {
         /**
-         * The percentage (greater than zero) that allows your cooperative bid to flex.
+         * The default bid boost percentage that you'll see in the Microsoft Advertising web application for new product groups.
          * @var double
          */
         public $BidBoostValue;
 
         /**
-         * The flat amount of your cooperative bid.
+         * The flat amount of your Sponsored Products bid.
          * @var double
          */
         public $BidMaxValue;

src/V12/CustomerManagement/AccountInfo.php

@@ -4,7 +4,7 @@
 
 {
     /**
-     * Defines an account identification object that contains information that identifies an account.
+     * Defines an object that contains an account's identifier, name, and number.
      * @link https://docs.microsoft.com/en-us/advertising/customer-management-service/accountinfo?view=bingads-12 AccountInfo Data Object
      * 
      * @uses AccountLifeCycleStatus

src/V12/CustomerManagement/AddClientLinksRequest.php

@@ -4,7 +4,7 @@
 
 {
     /**
-     * Initiates the client link process to manage the account of another customer.
+     * Initiates the client link process to manage the accounts of another customer.
      * @link https://docs.microsoft.com/en-us/advertising/customer-management-service/addclientlinks?view=bingads-12 AddClientLinks Request Object
      * 
      * @uses ClientLink

src/V12/CustomerManagement/AddClientLinksResponse.php

@@ -4,7 +4,7 @@
 
 {
     /**
-     * Initiates the client link process to manage the account of another customer.
+     * Initiates the client link process to manage the accounts of another customer.
      * @link https://docs.microsoft.com/en-us/advertising/customer-management-service/addclientlinks?view=bingads-12 AddClientLinks Response Object
      * 
      * @uses OperationError

src/V12/CustomerManagement/ClientLink.php

@@ -58,7 +58,7 @@ final class ClientLink
         public $InviterEmail;
 
         /**
-         * The name of the parent customer of the user who  created the client link request.
+         * The name of the parent customer of the user who created the client link request.
          * @var string
          */
         public $InviterName;
@@ -70,7 +70,7 @@ final class ClientLink
         public $InviterPhone;
 
         /**
-         * Determines whether the owner of the client account or the managing customer is responsible for billing payments.
+         * Determines whether the owner of the client advertiser account or the managing customer is responsible for billing payments.
          * @var boolean
          */
         public $IsBillToClient;

src/V12/CustomerManagement/CustomerInfo.php

@@ -4,7 +4,7 @@
 
 {
     /**
-     * Defines a customer identification object that contains information that identifies a customer.
+     * Defines an object that contains a customer's identifier and name.
      * @link https://docs.microsoft.com/en-us/advertising/customer-management-service/customerinfo?view=bingads-12 CustomerInfo Data Object
      * 
      * @used-by AdvertiserAccount