Merge pull request #129 from BingAds/v13-0-3

proxy updates

Author: Eric Urban

samples/V13/CampaignManagementExampleHelper.php

@@ -136,7 +136,8 @@
     print("-----\r\nAddSharedEntity:\r\n");
     $addSharedEntityResponse = CampaignManagementExampleHelper::AddSharedEntity(
         $encodedNegativeKeywordList, 
-        $negativeKeywords
+        $negativeKeywords,
+        null
     );
     $sharedEntityId = $addSharedEntityResponse->SharedEntityId;
     $listItemIds = $addSharedEntityResponse->ListItemIds;
@@ -157,7 +158,8 @@
 
     print("-----\r\nSetSharedEntityAssociations:\r\n");
     $partialErrors = CampaignManagementExampleHelper::SetSharedEntityAssociations(
-        $associations
+        $associations,
+        null
     );
     printf(
         "Associated CampaignId %s with Negative Keyword List Id %s.\r\n", 
@@ -178,7 +180,8 @@
 
     print("-----\r\nDeleteSharedEntities:\r\n");
     $partialErrors = CampaignManagementExampleHelper::DeleteSharedEntities(
-        array($encodedNegativeKeywordList)
+        array($encodedNegativeKeywordList),
+        null
     );
     printf("Deleted Negative Keyword List Id %s\r\n", $sharedEntityId);
 }

samples/V13/NegativeKeywords.php

@@ -201,13 +201,13 @@ final class DownloadEntity
         /** Include Ad Group Negative In Market Audience Association records in the download that each represent the association relationship between an ad group and an in-market audience exclusion. */
         const AdGroupNegativeInMarketAudienceAssociations = 'AdGroupNegativeInMarketAudienceAssociations';
 
-        /** Include Custom Audience, In Market Audience, Product Audience, Remarketing List, and Similar Remarketing List records in the download data. */
+        /** Include Combined List, Custom Audience, In Market Audience, Product Audience, Remarketing List, and Similar Remarketing List records in the download data. */
         const Audiences = 'Audiences';
 
-        /** Include Ad Group Custom Audience Association, Ad Group In Market Audience Association, Ad Group Product Audience Association, Ad Group Remarketing List Association, and Ad Group Similar Remarketing List Association records in the download data. */
+        /** Include Ad Group Combined List Association, Ad Group Custom Audience Association, Ad Group In Market Audience Association, Ad Group Product Audience Association, Ad Group Remarketing List Association, and Ad Group Similar Remarketing List Association records in the download data. */
         const AdGroupAudienceAssociations = 'AdGroupAudienceAssociations';
 
-        /** Include Ad Group Negative Custom Audience Association, Ad Group Negative In Market Audience Association, Ad Group Negative Product Audience Association, Ad Group Negative Remarketing List Association, and Ad Group Negative Similar Remarketing List Association records in the download data. */
+        /** Include Ad Group Negative Combined List Association, Ad Group Negative Custom Audience Association, Ad Group Negative In Market Audience Association, Ad Group Negative Product Audience Association, Ad Group Negative Remarketing List Association, and Ad Group Negative Similar Remarketing List Association records in the download data. */
         const AdGroupNegativeAudienceAssociations = 'AdGroupNegativeAudienceAssociations';
 
         /** Include Product Ad Label records in the download that each represent a label applied to a product ad. */
@@ -291,10 +291,10 @@ final class DownloadEntity
         /** Include Responsive Search Ad Label records in the download that each represent a label applied to a responsive search ad. */
         const ResponsiveSearchAdLabels = 'ResponsiveSearchAdLabels';
 
-        /** Include Campaign Custom Audience Association, Campaign In Market Audience Association, Campaign Product Audience Association, Campaign Remarketing List Association, and Campaign Similar Remarketing List Association records in the download data. */
+        /** Include Campaign Combined List Association, Campaign Custom Audience Association, Campaign In Market Audience Association, Campaign Product Audience Association, Campaign Remarketing List Association, and Campaign Similar Remarketing List Association records in the download data. */
         const CampaignAudienceAssociations = 'CampaignAudienceAssociations';
 
-        /** Include Campaign Negative Custom Audience Association, Campaign Negative In Market Audience Association, Campaign Negative Product Audience Association, Campaign Negative Remarketing List Association, and Campaign Negative Similar Remarketing List Association records in the download data. */
+        /** Include Campaign Negative Combined List Association, Campaign Negative Custom Audience Association, Campaign Negative In Market Audience Association, Campaign Negative Product Audience Association, Campaign Negative Remarketing List Association, and Campaign Negative Similar Remarketing List Association records in the download data. */
         const CampaignNegativeAudienceAssociations = 'CampaignNegativeAudienceAssociations';
 
         /** Include Campaign Custom Audience Association records in the download that each represent the association relationship between a campaign and a custom audience. */
@@ -332,6 +332,36 @@ final class DownloadEntity
 
         /** Include Feed Item records in the download data. */
         const FeedItems = 'FeedItems';
+
+        /** Reserved. */
+        const CampaignNegativeStoreCriterions = 'CampaignNegativeStoreCriterions';
+
+        /** Include Promotion Ad Extension records in the download data. */
+        const PromotionAdExtensions = 'PromotionAdExtensions';
+
+        /** Include Account Promotion Ad Extension records in the download that represents the association relationship between an account and a promotion ad extension. */
+        const AccountPromotionAdExtensions = 'AccountPromotionAdExtensions';
+
+        /** Include Campaign Promotion Ad Extension records in the download that represents the association relationship between a campaign and a promotion ad extension. */
+        const CampaignPromotionAdExtensions = 'CampaignPromotionAdExtensions';
+
+        /** Include Ad Group Promotion Ad Extension records in the download that each represent the association relationship between an ad group and a promotion ad extension. */
+        const AdGroupPromotionAdExtensions = 'AdGroupPromotionAdExtensions';
+
+        /** Include Combined List records in the download data. */
+        const CombinedLists = 'CombinedLists';
+
+        /** Include Ad Group Combined List Association records in the download that each represent the association relationship between an ad group and a combined list. */
+        const AdGroupCombinedListAssociations = 'AdGroupCombinedListAssociations';
+
+        /** Include Ad Group Negative Combined List Association records in the download that each represent the association relationship between an ad group and a combined list exclusion. */
+        const AdGroupNegativeCombinedListAssociations = 'AdGroupNegativeCombinedListAssociations';
+
+        /** Include Campaign Combined List Association records in the download that each represent the association relationship between a campaign and a combined list. */
+        const CampaignCombinedListAssociations = 'CampaignCombinedListAssociations';
+
+        /** Include Campaign Negative Combined List Association records in the download that each represent the association relationship between a campaign and a combined list exclusion. */
+        const CampaignNegativeCombinedListAssociations = 'CampaignNegativeCombinedListAssociations';
     }
 
 }

src/V13/Bulk/DownloadEntity.php

@@ -11,7 +11,7 @@
      */
     final class ActionAdExtensionActionType
     {
-        /** Reserved for future use. */
+        /** The action type is either RenewNow or Reorder. */
         const Unknown = 'Unknown';
 
         /** Use the translated version of ActNow in the action ad extension. */
@@ -35,7 +35,7 @@ final class ActionAdExtensionActionType
         /** Use the translated version of BookNow in the action ad extension. */
         const BookNow = 'BookNow';
 
-        /** Use the translated version of Browse in the action ad extension. */
+        /** Use the translated version of LearnMore in the action ad extension. */
         const Browse = 'Browse';
 
         /** Use the translated version of BuyNow in the action ad extension. */
@@ -65,7 +65,7 @@ final class ActionAdExtensionActionType
         /** Use the translated version of EnrollNow in the action ad extension. */
         const EnrollNow = 'EnrollNow';
 
-        /** Use the translated version of Explore in the action ad extension. */
+        /** Use the translated version of LearnMore in the action ad extension. */
         const Explore = 'Explore';
 
         /** Use the translated version of FileNow in the action ad extension. */
@@ -104,10 +104,10 @@ final class ActionAdExtensionActionType
         /** Use the translated version of LogIn in the action ad extension. */
         const LogIn = 'LogIn';
 
-        /** Use the translated version of Message in the action ad extension. */
+        /** Use the translated version of ContactUs in the action ad extension. */
         const Message = 'Message';
 
-        /** Use the translated version of NewCars in the action ad extension. */
+        /** Use the translated version of ViewCars in the action ad extension. */
         const NewCars = 'NewCars';
 
         /** Use the translated version of OrderNow in the action ad extension. */
@@ -146,7 +146,7 @@ final class ActionAdExtensionActionType
         /** Use the translated version of SeeMenu in the action ad extension. */
         const SeeMenu = 'SeeMenu';
 
-        /** Use the translated version of SeeMore in the action ad extension. */
+        /** Use the translated version of LearnMore in the action ad extension. */
         const SeeMore = 'SeeMore';
 
         /** Use the translated version of SeeOffer in the action ad extension. */
@@ -167,7 +167,7 @@ final class ActionAdExtensionActionType
         /** Use the translated version of SignUp in the action ad extension. */
         const SignUp = 'SignUp';
 
-        /** Use the translated version of StartFree in the action ad extension. */
+        /** Use the translated version of FreeTrial in the action ad extension. */
         const StartFree = 'StartFree';
 
         /** Use the translated version of StartNow in the action ad extension. */
@@ -182,19 +182,19 @@ final class ActionAdExtensionActionType
         /** Use the translated version of TryNow in the action ad extension. */
         const TryNow = 'TryNow';
 
-        /** Use the translated version of UsedCars in the action ad extension. */
+        /** Use the translated version of ViewCars in the action ad extension. */
         const UsedCars = 'UsedCars';
 
         /** Use the translated version of ViewCars in the action ad extension. */
         const ViewCars = 'ViewCars';
 
-        /** Use the translated version of ViewNow in the action ad extension. */
+        /** Use the translated version of LearnMore in the action ad extension. */
         const ViewNow = 'ViewNow';
 
         /** Use the translated version of ViewPlans in the action ad extension. */
         const ViewPlans = 'ViewPlans';
 
-        /** Use the translated version of VisitSite in the action ad extension. */
+        /** Use the translated version of LearnMore in the action ad extension. */
         const VisitSite = 'VisitSite';
 
         /** Use the translated version of VoteNow in the action ad extension. */
@@ -220,6 +220,12 @@ final class ActionAdExtensionActionType
 
         /** Use the translated version of VisitStore in the action ad extension. */
         const VisitStore = 'VisitStore';
+
+        /** Use the translated version of RenewNow in the action ad extension. */
+        const RenewNow = 'RenewNow';
+
+        /** Use the translated version of Reorder in the action ad extension. */
+        const Reorder = 'Reorder';
     }
 
 }

src/V13/CampaignManagement/ActionAdExtensionActionType.php

@@ -54,7 +54,7 @@ class AdExtension
         public $Type;
 
         /**
-         * The number of times the contents of the ad extension has been updated.
+         * Tracks the number of times the ad extension has been updated.
          * @var integer
          */
         public $Version;

src/V13/CampaignManagement/AdExtension.php

@@ -17,6 +17,12 @@ final class AdExtensionAdditionalField
 
         /** Request that the DisplayText element be included within each returned ImageAdExtension object. */
         const DisplayText = 'DisplayText';
+
+        /** Request that the Layouts element be included within each returned ImageAdExtension object. */
+        const Layouts = 'Layouts';
+
+        /** Request that the latest ActionAdExtensionActionType values be included within each returned ActionAdExtension. */
+        const ActionTypesPhase3 = 'ActionTypesPhase3';
     }
 
 }

src/V13/CampaignManagement/AdExtensionAdditionalField.php

@@ -42,6 +42,9 @@ final class AdExtensionsTypeFilter
 
         /** An ad extension that contains a call-to-action button. */
         const ActionAdExtension = 'ActionAdExtension';
+
+        /** An ad extension that highlights special sales and offers in your text ads. */
+        const PromotionAdExtension = 'PromotionAdExtension';
     }
 
 }

src/V13/CampaignManagement/AdExtensionsTypeFilter.php

@@ -125,6 +125,12 @@ final class AdGroup
          * @var CustomParameters
          */
         public $UrlCustomParameters;
+
+        /**
+         * Determines whether to use the account time zone or the time zone of the search user where the ads could be delivered.
+         * @var boolean
+         */
+        public $AdScheduleUseSearcherTimeZone;
     }
 
 }

src/V13/CampaignManagement/AdGroup.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Microsoft\BingAds\V13\CampaignManagement;
+
+{
+    /**
+     * Defines a list of optional ad group properties that you can request when calling GetAdGroupsByCampaignId and GetAdGroupsByIds.
+     * @link https://docs.microsoft.com/en-us/advertising/campaign-management-service/adgroupadditionalfield?view=bingads-13 AdGroupAdditionalField Value Set
+     * 
+     * @used-by GetAdGroupsByCampaignIdRequest
+     * @used-by GetAdGroupsByIdsRequest
+     */
+    final class AdGroupAdditionalField
+    {
+        /** Request that the AdScheduleUseSearcherTimeZone element be included within each returned AdGroup object. */
+        const AdScheduleUseSearcherTimeZone = 'AdScheduleUseSearcherTimeZone';
+    }
+
+}

src/V13/CampaignManagement/AdGroupAdditionalField.php

@@ -70,6 +70,9 @@ final class AdGroupCriterionType
 
         /** The ad group criterion is a similar remarketing list association. */
         const SimilarRemarketingList = 'SimilarRemarketingList';
+
+        /** The ad group criterion is a combined list association. */
+        const CombinedList = 'CombinedList';
     }
 
 }