Merge pull request #95 from BingAds/v12-0-3

V12 0 3

samples/V12/CampaignManagementExampleHelper.php

@@ -1604,31 +1604,31 @@ static function OutputAd($dataObject)
             self::OutputStatusMessage(sprintf("TrackingUrlTemplate: %s", $dataObject->TrackingUrlTemplate));
             self::OutputStatusMessage(sprintf("Type: %s", $dataObject->Type));
             self::OutputCustomParameters($dataObject->UrlCustomParameters);
-            if($dataObject->Type === "AppInstallAd")
+            if($dataObject->Type === "AppInstall")
             {
                 self::OutputAppInstallAd($dataObject);
             }
-            if($dataObject->Type === "DynamicSearchAd")
+            if($dataObject->Type === "DynamicSearch")
             {
                 self::OutputDynamicSearchAd($dataObject);
             }
-            if($dataObject->Type === "ExpandedTextAd")
+            if($dataObject->Type === "ExpandedText")
             {
                 self::OutputExpandedTextAd($dataObject);
             }
-            if($dataObject->Type === "ProductAd")
+            if($dataObject->Type === "Product")
             {
                 self::OutputProductAd($dataObject);
             }
             if($dataObject->Type === "ResponsiveAd")
             {
                 self::OutputResponsiveAd($dataObject);
             }
-            if($dataObject->Type === "ResponsiveSearchAd")
+            if($dataObject->Type === "ResponsiveSearch")
             {
                 self::OutputResponsiveSearchAd($dataObject);
             }
-            if($dataObject->Type === "TextAd")
+            if($dataObject->Type === "Text")
             {
                 self::OutputTextAd($dataObject);
             }
@@ -2331,15 +2331,15 @@ static function OutputAudience($dataObject)
             self::OutputStatusMessage(sprintf("SearchSize: %s", $dataObject->SearchSize));
             self::OutputArrayOfString($dataObject->SupportedCampaignTypes);
             self::OutputStatusMessage(sprintf("Type: %s", $dataObject->Type));
-            if($dataObject->Type === "CustomAudience")
+            if($dataObject->Type === "Custom")
             {
                 self::OutputCustomAudience($dataObject);
             }
-            if($dataObject->Type === "InMarketAudience")
+            if($dataObject->Type === "InMarket")
             {
                 self::OutputInMarketAudience($dataObject);
             }
-            if($dataObject->Type === "ProductAudience")
+            if($dataObject->Type === "Product")
             {
                 self::OutputProductAudience($dataObject);
             }

src/V12/AdInsight/AuctionInsightResult.php

@@ -20,7 +20,7 @@ final class AuctionInsightResult
         public $Segments;
 
         /**
-         * One or more auction insight entries i.
+         * One or more auction insight entries i.e., one result per domain that you competed with in the auction.
          * @var AuctionInsightEntry[]
          */
         public $Entries;

src/V12/AdInsight/DomainCategory.php

@@ -24,7 +24,7 @@ final class DomainCategory
         public $CategoryName;
 
         /**
-         * A score from 0.
+         * A score from 0.0 to 1.0 that indicates the percentage of pages in the requested language that belong to a particular domain out of all the pages that Bing has indexed for the same language your website's domain.
          * @var double
          */
         public $Coverage;

src/V12/AdInsight/GetKeywordIdeasRequest.php

@@ -20,7 +20,7 @@ final class GetKeywordIdeasRequest
         public $ExpandIdeas;
 
         /**
-         * The keyword idea attributes that you want included in the response e.
+         * The keyword idea attributes that you want included in the response e.g., Keyword, Competition, MonthlySearchCounts, and SuggestedBid.
          * @var KeywordIdeaAttribute[]
          */
         public $IdeaAttributes;

src/V12/AdInsight/GetKeywordTrafficEstimatesRequest.php

@@ -4,7 +4,7 @@
 
 {
     /**
-     * Provides traffic estimates for keywords e.
+     * Provides traffic estimates for keywords e.g., average CPC, average position, clicks, CTR, impressions, and total cost.
      * @link https://docs.microsoft.com/en-us/bingads/ad-insight-service/getkeywordtrafficestimates?view=bingads-12 GetKeywordTrafficEstimates Request Object
      * 
      * @uses CampaignEstimator

src/V12/AdInsight/GetKeywordTrafficEstimatesResponse.php

@@ -4,7 +4,7 @@
 
 {
     /**
-     * Provides traffic estimates for keywords e.
+     * Provides traffic estimates for keywords e.g., average CPC, average position, clicks, CTR, impressions, and total cost.
      * @link https://docs.microsoft.com/en-us/bingads/ad-insight-service/getkeywordtrafficestimates?view=bingads-12 GetKeywordTrafficEstimates Response Object
      * 
      * @uses CampaignEstimate

src/V12/AdInsight/KeywordAndConfidence.php

@@ -19,7 +19,7 @@ final class KeywordAndConfidence
         public $SuggestedKeyword;
 
         /**
-         * A score from 0.
+         * A score from 0.0 to 1.0 that indicates the probability that the keyword would match a user's search query.
          * @var double
          */
         public $ConfidenceScore;

src/V12/AdInsight/KeywordCategory.php

@@ -18,7 +18,7 @@ final class KeywordCategory
         public $Category;
 
         /**
-         * A score from 0.
+         * A score from 0.0 to 1.0 that indicates the likelihood that the keyword belongs to the category.
          * @var double
          */
         public $ConfidenceScore;

src/V12/Bulk/DataScope.php

@@ -12,16 +12,16 @@
      */
     final class DataScope
     {
-        /** Download the entity attributes records. */
+        /** Download entity records e.g., campaigns and ad groups. */
         const EntityData = 'EntityData';
 
         /** This value is not supported in Bing Ads API Version 12, and will be removed in a future version. */
         const EntityPerformanceData = 'EntityPerformanceData';
 
-        /** Download the quality score fields for the corresponding entity records. */
+        /** Download the quality score fields i.e., Quality Score, Keyword Relevance, Landing Page Relevance, and Landing Page User Experience in the Ad Group, Campaign, and Keyword records. */
         const QualityScoreData = 'QualityScoreData';
 
-        /** Download the bid suggestions records. */
+        /** Download the keyword bid suggestion records. */
         const BidSuggestionsData = 'BidSuggestionsData';
     }
 

src/V12/Bulk/DownloadEntity.php

@@ -210,13 +210,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, and Remarketing List records in the download data. */
+        /** Include 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, and Ad Group Remarketing List Association records in the download data. */
+        /** 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. */
         const AdGroupAudienceAssociations = 'AdGroupAudienceAssociations';
 
-        /** Include Ad Group Negative Custom Audience Association, Ad Group Negative In Market Audience Association, Ad Group Negative Product Audience Association, and Ad Group Negative Remarketing List Association records in the download data. */
+        /** 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. */
         const AdGroupNegativeAudienceAssociations = 'AdGroupNegativeAudienceAssociations';
 
         /** Include Product Ad Label records in the download that each represent a label applied to a product ad. */
@@ -302,6 +302,42 @@ 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. */
+        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. */
+        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. */
+        const CampaignCustomAudienceAssociations = 'CampaignCustomAudienceAssociations';
+
+        /** Include Campaign Negative Custom Audience Association records in the download that each represent the association relationship between a campaign and a custom audience exclusion. */
+        const CampaignNegativeCustomAudienceAssociations = 'CampaignNegativeCustomAudienceAssociations';
+
+        /** Include Campaign In Market Audience Association records in the download that each represent the association relationship between a campaign and an in-market audience. */
+        const CampaignInMarketAudienceAssociations = 'CampaignInMarketAudienceAssociations';
+
+        /** Include Campaign Negative In Market Audience Association records in the download that each represent the association relationship between a campaign and an in-market audience exclusion. */
+        const CampaignNegativeInMarketAudienceAssociations = 'CampaignNegativeInMarketAudienceAssociations';
+
+        /** Include Campaign Product Audience Association records in the download that each represent the association relationship between a campaign and a product audience. */
+        const CampaignProductAudienceAssociations = 'CampaignProductAudienceAssociations';
+
+        /** Include Campaign Negative Product Audience Association records in the download that each represent the association relationship between a campaign and a product audience exclusion. */
+        const CampaignNegativeProductAudienceAssociations = 'CampaignNegativeProductAudienceAssociations';
+
+        /** Include Campaign Remarketing List Association records in the download that each represent the association relationship between a campaign and a remarketing list. */
+        const CampaignRemarketingListAssociations = 'CampaignRemarketingListAssociations';
+
+        /** Include Campaign Negative Remarketing List Association records in the download that each represent the association relationship between a campaign and a remarketing list exclusion. */
+        const CampaignNegativeRemarketingListAssociations = 'CampaignNegativeRemarketingListAssociations';
+
+        /** Include Campaign Similar Remarketing List Association records in the download that each represent the association relationship between a campaign and a similar remarketing list. */
+        const CampaignSimilarRemarketingListAssociations = 'CampaignSimilarRemarketingListAssociations';
+
+        /** Include Campaign Negative Similar Remarketing List Association records in the download that each represent the association relationship between a campaign and a similar remarketing list exclusion. */
+        const CampaignNegativeSimilarRemarketingListAssociations = 'CampaignNegativeSimilarRemarketingListAssociations';
     }
 
 }

src/V12/CampaignManagement/AdGroup.php

@@ -25,7 +25,7 @@
     final class AdGroup
     {
         /**
-         * Determines how often you'd like the ads in your ad group to show in relation to one another.
+         * Ad rotation sets how often Bing Ads selects which ads to serve, if you have multiple ads within an ad group.
          * @var AdRotation
          */
         public $AdRotation;
@@ -85,7 +85,7 @@ final class AdGroup
         public $Network;
 
         /**
-         * Indicates whether or not your ad group target criteria e.
+         * Indicates whether or not your ad group target criteria e.g., ProfileCriterion are too narrow for ad groups in Audience campaigns.
          * @var AdGroupPrivacyStatus
          */
         public $PrivacyStatus;

src/V12/CampaignManagement/AdGroupPrivacyStatus.php

@@ -17,7 +17,7 @@ final class AdGroupPrivacyStatus
         /** The ad group is eligible to serve. */
         const Active = 'Active';
 
-        /** The ad group is not eligible to serve because your ad group target criteria e. */
+        /** The ad group is not eligible to serve because your ad group target criteria e.g., ProfileCriterion are too narrowly defined. */
         const TargetingTooNarrow = 'TargetingTooNarrow';
 
         /** The privacy evaluation is still in progress, and the ad group is not yet eligible to serve. */

src/V12/CampaignManagement/AdRotationType.php

@@ -11,10 +11,10 @@
      */
     final class AdRotationType
     {
-        /** Favor the best performing ads. */
+        /** Bing Ads prioritizes the ad from the ad group that appears to have the best chance of performing well, based on auction characteristics or factors, such as keyword, search term, device or location. */
         const OptimizeForClicks = 'OptimizeForClicks';
 
-        /** Rotate ads evenly into the auction. */
+        /** Bing Ads provides more balance in rotation between your ads. */
         const RotateAdsEvenly = 'RotateAdsEvenly';
     }
 

src/V12/CampaignManagement/ImageAsset.php

@@ -4,37 +4,37 @@
 
 {
     /**
-     * Reserved.
+     * Applies crop settings to stored image media for a specific aspect ratio.
      * @link https://docs.microsoft.com/en-us/bingads/campaign-management-service/imageasset?view=bingads-12 ImageAsset Data Object
      */
     final class ImageAsset extends Asset
     {
         /**
-         * Reserved.
+         * The number of pixels to use from the image asset source, starting from the CropY position and moving upwards.
          * @var integer
          */
         public $CropHeight;
 
         /**
-         * Reserved.
+         * The number of pixels to use from the image asset source, starting from the CropX position and moving to the right.
          * @var integer
          */
         public $CropWidth;
 
         /**
-         * Reserved.
+         * Starting from the lower left corner of image asset source, this is the number of pixels to skip to the right on the x-axis before applying the CropWidth.
          * @var integer
          */
         public $CropX;
 
         /**
-         * Reserved.
+         * Starting from the lower left corner of image asset source, this is the number of pixels to skip upwards on the y-axis before applying the CropHeight.
          * @var integer
          */
         public $CropY;
 
         /**
-         * Reserved.
+         * Represents the aspect ratio for this image asset.
          * @var string
          */
         public $SubType;

src/V12/CampaignManagement/InheritFromParentBiddingScheme.php

@@ -10,7 +10,7 @@
     final class InheritFromParentBiddingScheme extends BiddingScheme
     {
         /**
-         * The type of bidding scheme (a.
+         * The type of bidding scheme (a.k.a.
          * @var string
          */
         public $InheritedBidStrategyType;

src/V12/CampaignManagement/PriceQualifier.php

@@ -14,16 +14,16 @@ final class PriceQualifier
         /** Reserved for forward compatibility. */
         const Unknown = 'Unknown';
 
-        /** The price of the PriceAdExtension is prefixed with price qualifier text From, for example From $9. */
+        /** The price of the PriceAdExtension is prefixed with price qualifier text From, for example From $9.99. */
         const From = 'From';
 
-        /** The price of the PriceAdExtension is prefixed with the price qualifier text Up to, for example Up to $9. */
+        /** The price of the PriceAdExtension is prefixed with the price qualifier text Up to, for example Up to $9.99. */
         const UpTo = 'UpTo';
 
         /** The price of the PriceAdExtension is not prefixed with price qualifier text. */
         const None = 'None';
 
-        /** The price of the PriceAdExtension is prefixed with price qualifier text Average, for example Average $9. */
+        /** The price of the PriceAdExtension is prefixed with price qualifier text Average, for example Average $9.99. */
         const Average = 'Average';
     }
 

src/V12/CampaignManagement/PriceTableRow.php

@@ -50,7 +50,7 @@ final class PriceTableRow
         public $Price;
 
         /**
-         * The price qualifier for a given product or service e.
+         * The price qualifier for a given product or service e.g., starting from a specific price and up to a maximum price.
          * @var PriceQualifier
          */
         public $PriceQualifier;

src/V12/CampaignManagement/PriceUnit.php

@@ -14,25 +14,25 @@ final class PriceUnit
         /** Reserved for forward compatibility. */
         const Unknown = 'Unknown';
 
-        /** The Per Hour price unit text will be appended to the price of the PriceAdExtension, for example $9. */
+        /** The Per Hour price unit text will be appended to the price of the PriceAdExtension, for example $9.99 Per Hour. */
         const PerHour = 'PerHour';
 
-        /** The Per Day price unit text will be appended to the price of the PriceAdExtension, for example $9. */
+        /** The Per Day price unit text will be appended to the price of the PriceAdExtension, for example $9.99 Per Day. */
         const PerDay = 'PerDay';
 
-        /** The Per Week price unit text will be appended to the price of the PriceAdExtension, for example $9. */
+        /** The Per Week price unit text will be appended to the price of the PriceAdExtension, for example $9.99 Per Week. */
         const PerWeek = 'PerWeek';
 
-        /** The Per Month price unit text will be appended to the price of the PriceAdExtension, for example $9. */
+        /** The Per Month price unit text will be appended to the price of the PriceAdExtension, for example $9.99 Per Month. */
         const PerMonth = 'PerMonth';
 
-        /** The Per Year price unit text will be appended to the price of the PriceAdExtension, for example $9. */
+        /** The Per Year price unit text will be appended to the price of the PriceAdExtension, for example $9.99 Per Year. */
         const PerYear = 'PerYear';
 
         /** The price of the PriceAdExtension will not be appended with price unit text. */
         const None = 'None';
 
-        /** The Per Night price unit text will be appended to the price of the PriceAdExtension, for example $9. */
+        /** The Per Night price unit text will be appended to the price of the PriceAdExtension, for example $9.99 Per Night. */
         const PerNight = 'PerNight';
     }
 

src/V12/CampaignManagement/ProductScope.php

@@ -12,7 +12,7 @@
     final class ProductScope extends Criterion
     {
         /**
-         * A list of up to product conditions that helps determine whether a product from the Bing Merchant Center store gets served as an ad.
+         * A list of up to 7 product conditions that helps determine whether a product from the Bing Merchant Center store gets served as an ad.
          * @var ProductCondition[]
          */
         public $Conditions;