Merge pull request #210 from BingAds/v13.0.24.1

v13.0.24.1

Author: xinyuwen2

src/Auth/OAuthAuthorization.php

@@ -43,6 +43,12 @@ abstract class OAuthAuthorization extends Authentication
      */
     public $Tenant = "common";
 
+    /**
+     * Determines if use msa production accounts on sandbox.
+     * @var bool
+     */
+    public $UseMsaProd = true;
+
     public function __construct() {}
 
     /** 
@@ -97,7 +103,8 @@ public function withOAuthTokens($oauthTokens) {
      */
     public function withEnvironment($environment) {
         $this->Environment = $environment;
-        $this->RedirectUri=UriOAuthService::GetRedirectUrl($environment, $this->OAuthScope);
+        $this->OAuthScope = ($environment == ApiEnvironment::Sandbox && $this->UseMsaProd) ? OAuthScope::MSA_PROD : $this->OAuthScope;
+        $this->RedirectUri=UriOAuthService::GetRedirectUrl($environment, ($environment == ApiEnvironment::Sandbox && $this->UseMsaProd) ? OAuthScope::MSA_PROD : $this->OAuthScope);
         return $this;
     }
 
@@ -108,8 +115,8 @@ public function withEnvironment($environment) {
      * @return OAuthAuthorization this builder
      */
     public function withOAuthScope($oauthScope) {
-        $this->OAuthScope = $oauthScope;
-        $this->RedirectUri=UriOAuthService::GetRedirectUrl($this->Environment, $oauthScope);
+        $this->OAuthScope = ($this->Environment == ApiEnvironment::Sandbox && $this->UseMsaProd) ? OAuthScope::MSA_PROD : $oauthScope;
+        $this->RedirectUri=UriOAuthService::GetRedirectUrl($this->Environment, ($this->Environment == ApiEnvironment::Sandbox && $this->UseMsaProd) ? OAuthScope::MSA_PROD : $oauthScope);
         return $this;
     }
 
@@ -124,6 +131,17 @@ public function withTenant($tenant) {
         return $this;
     }
 
+    /**
+     * Includes the UseMsaProd flag.
+     *
+     * @param bool $useMsaProd
+     * @return OAuthAuthorization this builder
+     */
+    public function withUseMsaProd($useMsaProd) {
+        $this->UseMsaProd = $useMsaProd;
+        return $this;
+    }
+
     /** 
      * Implementations of this abstract method will get the Microsoft Account authorization endpoint 
      * where the user should be navigated to give their consent.

src/Auth/OAuthEndpointType.php

@@ -26,4 +26,9 @@ final class OAuthEndpointType
      * Sandbox for Live Connect
      */
     const Sandbox = 'Sandbox';
+
+    /**
+     * Sandbox for Msa Production
+     */
+    const MsaProd = 'MsaProd';
 }

src/Auth/OAuthScope.php

@@ -21,4 +21,9 @@ final class OAuthScope
      * Represents ads.manage OAuth scope
      */
     const ADS_MANAGE = 'ads.manage';
+
+    /**
+     * Represents msa.prod OAuth scope
+     */
+    const MSA_PROD = 'msa.prod';
 }

src/Auth/ServiceClient.php

@@ -242,7 +242,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 ' . '13.0.24 ' . PHP_VERSION, 
+			'user_agent' => 'BingAdsSDKPHP ' . '13.0.24.1 ' . PHP_VERSION, 
 			'cache_wsdl' => 'WSDL_CACHE_NONE',
 
 			/** 

src/Auth/UriOAuthService.php

@@ -32,6 +32,12 @@ class UriOAuthService extends IOAuthService
             'AuthorizationEndpointUrl' => 'https://login.windows-ppe.net/consumers/oauth2/v2.0/authorize?scope=https://api.ads.microsoft.com/msads.manage+offline_access&prompt=login',
             'Scope' => 'https://api.ads.microsoft.com/msads.manage offline_access'
         ),
+        'MsaProd' => array(
+            'RedirectUrl' => 'https://login.microsoftonline.com/common/oauth2/nativeclient',
+            'OAuthTokenUrl' => 'https://login.microsoftonline.com/common/oauth2/v2.0/token',
+            'AuthorizationEndpointUrl' => 'https://login.microsoftonline.com/common/oauth2/v2.0/authorize?scope=https://si.ads.microsoft.com/msads.manage+offline_access&prompt=login',
+            'Scope' => 'https://si.ads.microsoft.com/msads.manage offline_access'
+        ),
     );
 
     private $httpService;
@@ -185,9 +191,16 @@ private static function GetOAuthEndpointType($environment, $oauthScope)
                     $endpointType = OAuthEndpointType::ProductionMSIdentityV2_MSScope; 
             }
         }
-        else
+        else if ($environment == ApiEnvironment::Sandbox)
         {
-            $endpointType = OAuthEndpointType::Sandbox;
+            if ($oauthScope == OAuthScope::MSA_PROD)
+            {
+                $endpointType = OAuthEndpointType::MsaProd;
+            }
+            else
+            {
+                $endpointType = OAuthEndpointType::Sandbox;
+            }
         }
         return $endpointType;
     }

src/V13/Bulk/DownloadEntity.php

@@ -578,6 +578,15 @@ final class DownloadEntity
 
         /** Reserved. */
         const CampaignAccountPlacementExclusionListAssociation = 'CampaignAccountPlacementExclusionListAssociation';
+
+        /** Reserved. */
+        const AccountPlacementInclusionList = 'AccountPlacementInclusionList';
+
+        /** Reserved. */
+        const AccountPlacementInclusionListItem = 'AccountPlacementInclusionListItem';
+
+        /** Reserved. */
+        const CampaignAccountPlacementInclusionListAssociation = 'CampaignAccountPlacementInclusionListAssociation';
     }
 
 }

src/V13/CampaignManagement/AdRecommendationAdditionalField.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Microsoft\BingAds\V13\CampaignManagement;
+
+{
+    /**
+     * Reserved.
+     * @link https:/learn.microsoft.com/advertising/campaign-management-service/adrecommendationadditionalfield?view=bingads-13 AdRecommendationAdditionalField Value Set
+     * 
+     * @used-by CreateAssetGroupRecommendationRequest
+     * @used-by CreateResponsiveAdRecommendationRequest
+     * @used-by RefineAssetGroupRecommendationRequest
+     * @used-by RefineResponsiveAdRecommendationRequest
+     */
+    final class AdRecommendationAdditionalField
+    {
+        /** Reserved. */
+        const ImageSuggestionMetadata = 'ImageSuggestionMetadata';
+
+        /** Reserved. */
+        const MediaRefineResults = 'MediaRefineResults';
+
+        /** Reserved. */
+        const PromptBrandWarning = 'PromptBrandWarning';
+    }
+
+}

src/V13/CampaignManagement/AdRecommendationCustomizedProperty.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Microsoft\BingAds\V13\CampaignManagement;
+
+{
+    /**
+     * Reserved.
+     * @link https:/learn.microsoft.com/advertising/campaign-management-service/adrecommendationcustomizedproperty?view=bingads-13 AdRecommendationCustomizedProperty Data Object
+     * 
+     * @used-by AdRecommendationImageSuggestionMetadata
+     */
+    final class AdRecommendationCustomizedProperty
+    {
+        /**
+         * Reserved.
+         * @var string
+         */
+        public $AssetTypeName;
+
+        /**
+         * Reserved.
+         * @var string
+         */
+        public $PropertyName;
+
+        /**
+         * Reserved.
+         * @var string
+         */
+        public $PropertyValue;
+    }
+
+}

src/V13/CampaignManagement/AdRecommendationImageAssetProperty.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace Microsoft\BingAds\V13\CampaignManagement;
+
+{
+    /**
+     * Reserved.
+     * @link https:/learn.microsoft.com/advertising/campaign-management-service/adrecommendationimageassetproperty?view=bingads-13 AdRecommendationImageAssetProperty Data Object
+     * 
+     * @uses AdRecommendationImageField
+     * @used-by AdRecommendationImageSuggestionMetadata
+     */
+    final class AdRecommendationImageAssetProperty
+    {
+        /**
+         * Reserved.
+         * @var integer
+         */
+        public $CropHeight;
+
+        /**
+         * Reserved.
+         * @var integer
+         */
+        public $CropWidth;
+
+        /**
+         * Reserved.
+         * @var integer
+         */
+        public $CropX;
+
+        /**
+         * Reserved.
+         * @var integer
+         */
+        public $CropY;
+
+        /**
+         * Reserved.
+         * @var AdRecommendationImageField
+         */
+        public $ImageField;
+
+        /**
+         * Reserved.
+         * @var string
+         */
+        public $ImageUrl;
+    }
+
+}

src/V13/CampaignManagement/AdRecommendationImageField.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Microsoft\BingAds\V13\CampaignManagement;
+
+{
+    /**
+     * Reserved.
+     * @link https:/learn.microsoft.com/advertising/campaign-management-service/adrecommendationimagefield?view=bingads-13 AdRecommendationImageField Value Set
+     * 
+     * @used-by AdRecommendationImageAssetProperty
+     */
+    final class AdRecommendationImageField
+    {
+        /** Reserved. */
+        const Image = 'Image';
+
+        /** Reserved. */
+        const Logo = 'Logo';
+    }
+
+}