Merge pull request #203 from BingAds/v13.0.21.1

v13.0.21.1

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.21 ' . PHP_VERSION, 
+			'user_agent' => 'BingAdsSDKPHP ' . '13.0.21.1 ' . PHP_VERSION, 
 			'cache_wsdl' => 'WSDL_CACHE_NONE',
 
 			/** 

src/V13/Bulk/DownloadEntity.php

@@ -546,19 +546,19 @@ final class DownloadEntity
         /** Reserved. */
         const AssetGroupSearchThemes = 'AssetGroupSearchThemes';
 
-        /** Reserved. */
+        /** Include Impression Based Remarketing List records in the download data. */
         const ImpressionBasedRemarketingList = 'ImpressionBasedRemarketingList';
 
-        /** Reserved. */
+        /** Include Ad Group Impression Based Remarketing List Association records in the download that each represent the association relationship between an ad group and an impression based remarketing list. */
         const AdGroupImpressionBasedRemarketingListAssociations = 'AdGroupImpressionBasedRemarketingListAssociations';
 
-        /** Reserved. */
+        /** Include Ad Group Negative Impression Based Remarketing List Association records in the download that each represent the association relationship between an ad group and an impression based remarketing list exclusion. */
         const AdGroupNegativeImpressionBasedRemarketingListAssociations = 'AdGroupNegativeImpressionBasedRemarketingListAssociations';
 
-        /** Reserved. */
+        /** Include Campaign Impression Based Remarketing List Association records in the download that each represent the association relationship between a campaign and an impression based remarketing list. */
         const CampaignImpressionBasedRemarketingListAssociations = 'CampaignImpressionBasedRemarketingListAssociations';
 
-        /** Reserved. */
+        /** Include Campaign Negative Impression Based Remarketing List Association records in the download that each represent the association relationship between a campaign and an impression based remarketing list exclusion. */
         const CampaignNegativeImpressionBasedRemarketingListAssociations = 'CampaignNegativeImpressionBasedRemarketingListAssociations';
     }
 

src/V13/CampaignManagement/AccountPropertyName.php

@@ -59,6 +59,9 @@ final class AccountPropertyName
 
         /** Reserved. */
         const NetflixTCAccepted = 'NetflixTCAccepted';
+
+        /** Reserved. */
+        const BlockedContentSegments = 'BlockedContentSegments';
     }
 
 }

src/V13/CampaignManagement/AdAdditionalField.php

@@ -25,7 +25,7 @@ final class AdAdditionalField
         /** The target dimension of an image asset. */
         const ImageTargetDimension = 'ImageTargetDimension';
 
-        /** Reserved. */
+        /** Defines the possible ad sub types. */
         const AdSubType = 'AdSubType';
     }
 

src/V13/CampaignManagement/AdExtensionsTypeFilter.php

@@ -58,7 +58,7 @@ final class AdExtensionsTypeFilter
         /** Reserved. */
         const DisclaimerAdExtension = 'DisclaimerAdExtension';
 
-        /** Reserved. */
+        /** An ad extension that contains the business logo. */
         const LogoAdExtension = 'LogoAdExtension';
     }
 

src/V13/CampaignManagement/AdGroupCriterionType.php

@@ -95,10 +95,10 @@ final class AdGroupCriterionType
         /** The ad group criterion is a genre criterion. */
         const Genre = 'Genre';
 
-        /** For internal use only. */
+        /** The ad group criterion is a customer list. */
         const CustomerList = 'CustomerList';
 
-        /** Reserved. */
+        /** The ad group criterion is an impression-based remarketing list. */
         const ImpressionBasedRemarketingList = 'ImpressionBasedRemarketingList';
     }
 

src/V13/CampaignManagement/AdSubType.php

@@ -4,17 +4,17 @@
 
 {
     /**
-     * Reserved.
+     * Defines the possible ad sub types.
      * @link https:/learn.microsoft.com/advertising/campaign-management-service/adsubtype?view=bingads-13 AdSubType Value Set
      * 
      * @used-by ResponsiveAd
      */
     final class AdSubType
     {
-        /** Reserved. */
+        /** The ad is a video ad. */
         const Video = 'Video';
 
-        /** Reserved. */
+        /** The ad is a display ad. */
         const Display = 'Display';
     }
 

src/V13/CampaignManagement/AssetGroupAdditionalField.php

@@ -4,15 +4,15 @@
 
 {
     /**
-     * Reserved.
+     * Defines the possible additional fields for an asset group.
      * @link https:/learn.microsoft.com/advertising/campaign-management-service/assetgroupadditionalfield?view=bingads-13 AssetGroupAdditionalField Value Set
      * 
      * @used-by GetAssetGroupsByCampaignIdRequest
      * @used-by GetAssetGroupsByIdsRequest
      */
     final class AssetGroupAdditionalField
     {
-        /** Reserved. */
+        /** Include the AssetGroupSearchThemes field. */
         const AssetGroupSearchThemes = 'AssetGroupSearchThemes';
     }
 

src/V13/CampaignManagement/AssetGroupSearchTheme.php

@@ -4,21 +4,21 @@
 
 {
     /**
-     * Reserved.
+     * Defines an AssetGroupSearchTheme data object.
      * @link https:/learn.microsoft.com/advertising/campaign-management-service/assetgroupsearchtheme?view=bingads-13 AssetGroupSearchTheme Data Object
      * 
      * @used-by AssetGroup
      */
     final class AssetGroupSearchTheme
     {
         /**
-         * Reserved.
+         * The identifier of the search theme.
          * @var integer
          */
         public $Id;
 
         /**
-         * Reserved.
+         * The type of search theme.
          * @var string
          */
         public $SearchTheme;

src/V13/CampaignManagement/AudienceAdditionalField.php

@@ -18,7 +18,7 @@ final class AudienceAdditionalField
         const NumberRuleItem = 'NumberRuleItem';
 
         /** Reserved. */
-        const ImpreesionBasedRemarketingList = 'ImpreesionBasedRemarketingList';
+        const ImpressionBasedRemarketingList = 'ImpressionBasedRemarketingList';
     }
 
 }

src/V13/CampaignManagement/AudienceType.php

@@ -32,10 +32,10 @@ final class AudienceType
         /** The audience is a combined list. */
         const CombinedList = 'CombinedList';
 
-        /** Reserved. */
+        /** The audience is a customer list. */
         const CustomerList = 'CustomerList';
 
-        /** Reserved. */
+        /** The audience is an impression-based remarketing list. */
         const ImpressionBasedRemarketingList = 'ImpressionBasedRemarketingList';
     }
 

src/V13/CampaignManagement/CallToActionSetting.php

@@ -4,13 +4,13 @@
 
 {
     /**
-     * Reserved.
+     * Defines the CallToActionSetting data object.
      * @link https:/learn.microsoft.com/advertising/campaign-management-service/calltoactionsetting?view=bingads-13 CallToActionSetting Data Object
      */
     final class CallToActionSetting extends Setting
     {
         /**
-         * Reserved.
+         * Determines whether to opt out of automatic selection of call to action ad asset for the multimedia ads in the campaign.
          * @var boolean
          */
         public $AutomatedCallToActionOptOut;

src/V13/CampaignManagement/Campaign.php

@@ -81,6 +81,12 @@ final class Campaign
          */
         public $Id;
 
+        /**
+         * Reserved.
+         * @var boolean
+         */
+        public $IsDealCampaign;
+
         /**
          * Reserved.
          * @var integer

src/V13/CampaignManagement/CampaignAdditionalField.php

@@ -83,6 +83,9 @@ final class CampaignAdditionalField
 
         /** Reserved. */
         const ManualCpi = 'ManualCpi';
+
+        /** Reserved. */
+        const IsDealCampaign = 'IsDealCampaign';
     }
 
 }

src/V13/CampaignManagement/CampaignCriterionType.php

@@ -77,10 +77,10 @@ final class CampaignCriterionType
         /** The campaign criterion is a combined list association. */
         const CombinedList = 'CombinedList';
 
-        /** For internal use only. */
+        /** The campaign criterion is a customer list. */
         const CustomerList = 'CustomerList';
 
-        /** Reserved. */
+        /** The campaign criterion is an impression-based remarketing list. */
         const ImpressionBasedRemarketingList = 'ImpressionBasedRemarketingList';
     }
 

src/V13/CampaignManagement/CampaignType.php

@@ -28,7 +28,7 @@ final class CampaignType
         /** The campaign is an Audience campaign. */
         const Audience = 'Audience';
 
-        /** The campaign is a Lodging campaign (formerly hotel campaigns). */
+        /** The campaign is a Lodging campaign (formerly Hotel campaigns). */
         const Hotel = 'Hotel';
 
         /** The campaign is a Performance max campaign. */

src/V13/CampaignManagement/GetAssetGroupsByCampaignIdRequest.php

@@ -19,7 +19,7 @@ final class GetAssetGroupsByCampaignIdRequest
         public $CampaignId;
 
         /**
-         * Reserved.
+         * The additional field values enable you to get the latest features using the current version of Campaign Management API, and in the next version the corresponding elements will be included by default.
          * @var AssetGroupAdditionalField
          */
         public $ReturnAdditionalFields;

src/V13/CampaignManagement/GetAssetGroupsByIdsRequest.php

@@ -25,7 +25,7 @@ final class GetAssetGroupsByIdsRequest
         public $AssetGroupIds;
 
         /**
-         * Reserved.
+         * The additional field values enable you to get the latest features using the current version of Campaign Management API, and in the next version the corresponding elements will be included by default.
          * @var AssetGroupAdditionalField
          */
         public $ReturnAdditionalFields;

src/V13/CampaignManagement/HotelAdGroupType.php

@@ -4,7 +4,7 @@
 
 {
     /**
-     * The ad group type for lodging campaigns (formerly hotel campaigns).
+     * The ad group type for Lodging campaigns (formerly Hotel campaigns).
      * @link https:/learn.microsoft.com/advertising/campaign-management-service/hoteladgrouptype?view=bingads-13 HotelAdGroupType Value Set
      * 
      * @used-by HotelSetting

src/V13/CampaignManagement/ImpressionBasedEntityType.php

@@ -4,20 +4,20 @@
 
 {
     /**
-     * Reserved.
+     * Defines a value set for ImpressionBasedEntityType.
      * @link https:/learn.microsoft.com/advertising/campaign-management-service/impressionbasedentitytype?view=bingads-13 ImpressionBasedEntityType Value Set
      * 
      * @used-by ImpressionBasedRemarketingList
      */
     final class ImpressionBasedEntityType
     {
-        /** Reserved. */
+        /** The impression-based remarketing list type is none. */
         const None = 'None';
 
-        /** Reserved. */
+        /** The impression-based remarketing list type is Campaign. */
         const Campaign = 'Campaign';
 
-        /** Reserved. */
+        /** The impression-based remarketing list type is AdGroup. */
         const AdGroup = 'AdGroup';
     }
 

src/V13/CampaignManagement/ImpressionBasedRemarketingList.php

@@ -4,27 +4,27 @@
 
 {
     /**
-     * Reserved.
+     * Defines a data object for ImpressionBasedRemarketingList.
      * @link https:/learn.microsoft.com/advertising/campaign-management-service/impressionbasedremarketinglist?view=bingads-13 ImpressionBasedRemarketingList Data Object
      * 
      * @uses ImpressionBasedEntityType
      */
     final class ImpressionBasedRemarketingList extends Audience
     {
         /**
-         * Reserved.
+         * The ad group identifier to associate with the impression-based remarketing list.
          * @var integer
          */
         public $AdGroupId;
 
         /**
-         * Reserved.
+         * The campaign identifier to associate with the impression-based remarketing list.
          * @var integer
          */
         public $CampaignId;
 
         /**
-         * Reserved.
+         * The entity type of an impression-based remarketing list.
          * @var ImpressionBasedEntityType
          */
         public $EntityType;

src/V13/CampaignManagement/LogoAdExtension.php

@@ -4,31 +4,31 @@
 
 {
     /**
-     * Reserved.
+     * Defines an ad extension that specifies a business logo.
      * @link https:/learn.microsoft.com/advertising/campaign-management-service/logoadextension?view=bingads-13 LogoAdExtension Data Object
      */
     final class LogoAdExtension extends AdExtension
     {
         /**
-         * Reserved.
+         * The asset ID for the business logo.
          * @var integer
          */
         public $BusinessLogo;
 
         /**
-         * Reserved.
+         * The URL of the business logo.
          * @var string
          */
         public $BusinessLogoUrl;
 
         /**
-         * Reserved.
+         * The business name.
          * @var string
          */
         public $BusinessName;
 
         /**
-         * Reserved.
+         * The domain name.
          * @var string
          */
         public $DomainName;

src/V13/CampaignManagement/MediaAdditionalField.php

@@ -4,7 +4,7 @@
 
 {
     /**
-     * Reserved.
+     * Defines a value set for MediaAdditionalField.
      * @link https:/learn.microsoft.com/advertising/campaign-management-service/mediaadditionalfield?view=bingads-13 MediaAdditionalField Value Set
      * 
      * @used-by GetMediaMetaDataByAccountIdRequest

src/V13/CampaignManagement/Network.php

@@ -17,7 +17,7 @@ final class Network
         /** Display ads on only owned and operated networks. */
         const OwnedAndOperatedOnly = 'OwnedAndOperatedOnly';
 
-        /** Display ads on only syndicated search networks. */
+        /** Note: SyndicatedSearchOnly is deprecated as of July 2024. */
         const SyndicatedSearchOnly = 'SyndicatedSearchOnly';
 
         /** Display ads on the Retailer Network only. */

src/V13/CampaignManagement/ResponsiveAd.php

@@ -16,7 +16,7 @@
     final class ResponsiveAd extends Ad
     {
         /**
-         * Reserved.
+         * The possible ad sub types.
          * @var AdSubType
          */
         public $AdSubType;

src/V13/CampaignManagement/VanityPharmaDisplayUrlMode.php

@@ -4,17 +4,17 @@
 
 {
     /**
-     * Reserved.
+     * Defines a value set for VanityPharmaDisplayUrlMode.
      * @link https:/learn.microsoft.com/advertising/campaign-management-service/vanitypharmadisplayurlmode?view=bingads-13 VanityPharmaDisplayUrlMode Value Set
      * 
      * @used-by VanityPharmaSetting
      */
     final class VanityPharmaDisplayUrlMode
     {
-        /** Reserved. */
+        /** Replace the vanity pharma URL with the manufacturer website URL. */
         const ManufacturerWebsiteUrl = 'ManufacturerWebsiteUrl';
 
-        /** Reserved. */
+        /** Replace the vanity pharma URL with a description of the website. */
         const WebsiteDescription = 'WebsiteDescription';
     }