Release 32.0.0.

Author: Thang Duong

CHANGELOG.md

@@ -1,3 +1,24 @@
+### 32.0.0
+
+##### AdWords
+
+*   Fixed
+    [issue #378](https://github.com/googleads/googleads-php-lib/issues/378).
+
+##### DFP
+
+*   Added support and examples for v201711.
+*   Added CdnConfigurationService and examples.
+*   Removed support for v201611.
+*   Removed examples for v201702.
+
+##### Common
+
+*   Included WSDL files for all SOAP services and they're now used for making
+    SOAP calls instead of live WSDLs. Therefore, the WSDL caching feature is
+    deprecated (`wsdlCache` in `adsapi_php.ini` is now ignored). The feature
+    will be removed completely in the next major release.
+
 ### 31.0.0
 
 ##### AdWords

UPGRADING.md

@@ -180,7 +180,7 @@ DFP utilities have minor changes, most remain the same.
 
 |                  | Old library                                                                                                                                   | New library
 ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- | -----------
-Date times utility | Called [DateTimeUtils](https://github.com/googleads/googleads-php-lib/blob/deprecated/src/Google/Api/Ads/Dfp/Util/v201611/DateTimeUtils.php). | Split and renamed to [DfpDateTimes](https://github.com/googleads/googleads-php-lib/blob/master/src/Google/AdsApi/Dfp/Util/v201611/DfpDateTimes.php) and [DfpDates](https://github.com/googleads/googleads-php-lib/blob/master/src/Google/AdsApi/Dfp/Util/v201611/DfpDates.php), some obsolete methods removed.
+Date times utility | Called [DateTimeUtils](https://github.com/googleads/googleads-php-lib/blob/deprecated/src/Google/Api/Ads/Dfp/Util/v201711/DateTimeUtils.php). | Split and renamed to [DfpDateTimes](https://github.com/googleads/googleads-php-lib/blob/master/src/Google/AdsApi/Dfp/Util/v201711/DfpDateTimes.php) and [DfpDates](https://github.com/googleads/googleads-php-lib/blob/master/src/Google/AdsApi/Dfp/Util/v201711/DfpDates.php), some obsolete methods removed.
 Report downloader  | Uses Curl ext.                                                                                                                                | Uses Guzzle.
 
 ## Examples

composer.json

@@ -9,7 +9,7 @@
     "guzzlehttp/guzzle": "^6.0",
     "guzzlehttp/psr7": "^1.2",
     "monolog/monolog": "^1.17.1",
-    "phpdocumentor/reflection-docblock": "^4.0.0 || ^3.0.3",
+    "phpdocumentor/reflection-docblock": "^3.0.3",
     "symfony/serializer": "^2.8.0 || ^3.0.3"
   },
   "require-dev": {

examples/AdWords/adsapi_php.ini

@@ -40,7 +40,6 @@ clientCustomerId = "INSERT_CLIENT_CUSTOMER_ID_HERE"
 [SOAP]
 ; Optional SOAP settings. See SoapSettingsBuilder.php for more information.
 ; compressionLevel = <COMPRESSION_LEVEL>
-; wsdlCache = <WSDL_CACHE>
 
 [CONNECTION]
 ; Optional proxy settings to be used by requests.

examples/AdWords/v201702/Reporting/DownloadCriteriaReportWithAwql.php

@@ -38,8 +38,14 @@ public static function runExample(AdWordsSession $session, $reportFormat) {
 
     // Download report as a string.
     $reportDownloader = new ReportDownloader($session);
+    // Optional: If you need to adjust report settings just for this one
+    // request, you can create and supply the settings override here. Otherwise,
+    // default values from the configuration file (adsapi_php.ini) are used.
+    $reportSettingsOverride = (new ReportSettingsBuilder())
+        ->includeZeroImpressions(false)
+        ->build();
     $reportDownloadResult = $reportDownloader->downloadReportWithAwql(
-        $reportQuery, $reportFormat);
+        $reportQuery, $reportFormat, $reportSettingsOverride);
     print "Report was downloaded and printed below:\n";
     print $reportDownloadResult->getAsString();
   }
@@ -50,21 +56,13 @@ public static function main() {
         ->fromFile()
         ->build();
 
-    // See: ReportSettingsBuilder for more options (e.g., suppress headers)
-    // or set them in your adsapi_php.ini file.
-    $reportSettings = (new ReportSettingsBuilder())
-        ->fromFile()
-        ->includeZeroImpressions(false)
-        ->build();
-
     // See: AdWordsSessionBuilder for setting a client customer ID that is
     // different from that specified in your adsapi_php.ini file.
     // Construct an API session configured from a properties file and the OAuth2
     // credentials above.
     $session = (new AdWordsSessionBuilder())
         ->fromFile()
         ->withOAuth2Credential($oAuth2Credential)
-        ->withReportSettings($reportSettings)
         ->build();
 
     self::runExample($session, DownloadFormat::CSV);

examples/AdWords/v201702/Reporting/DownloadCriteriaReportWithSelector.php

@@ -59,8 +59,14 @@ public static function runExample(AdWordsSession $session, $filePath) {
 
     // Download report.
     $reportDownloader = new ReportDownloader($session);
-    $reportDownloadResult =
-        $reportDownloader->downloadReport($reportDefinition);
+    // Optional: If you need to adjust report settings just for this one
+    // request, you can create and supply the settings override here. Otherwise,
+    // default values from the configuration file (adsapi_php.ini) are used.
+    $reportSettingsOverride = (new ReportSettingsBuilder())
+        ->includeZeroImpressions(false)
+        ->build();
+    $reportDownloadResult = $reportDownloader->downloadReport(
+        $reportDefinition, $reportSettingsOverride);
     $reportDownloadResult->saveToFile($filePath);
     printf("Report with name '%s' was downloaded to '%s'.\n",
         $reportDefinition->getReportName(), $filePath);
@@ -72,21 +78,13 @@ public static function main() {
         ->fromFile()
         ->build();
 
-    // See: ReportSettingsBuilder for more options (e.g., suppress headers)
-    // or set them in your adsapi_php.ini file.
-    $reportSettings = (new ReportSettingsBuilder())
-        ->fromFile()
-        ->includeZeroImpressions(false)
-        ->build();
-
     // See: AdWordsSessionBuilder for setting a client customer ID that is
     // different from that specified in your adsapi_php.ini file.
     // Construct an API session configured from a properties file and the OAuth2
     // credentials above.
     $session = (new AdWordsSessionBuilder())
         ->fromFile()
         ->withOAuth2Credential($oAuth2Credential)
-        ->withReportSettings($reportSettings)
         ->build();
 
     $filePath = sprintf(

examples/AdWords/v201710/AdvancedOperations/FindAndRemoveCriteriaFromSharedSet.php

@@ -0,0 +1,196 @@
+<?php
+/**
+ * Copyright 2017 Google Inc. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+namespace Google\AdsApi\Examples\AdWords\v201710\AdvancedOperations;
+
+require __DIR__ . '/../../../../vendor/autoload.php';
+
+use Google\AdsApi\AdWords\AdWordsServices;
+use Google\AdsApi\AdWords\AdWordsSession;
+use Google\AdsApi\AdWords\AdWordsSessionBuilder;
+use Google\AdsApi\AdWords\v201710\cm\CampaignSharedSetService;
+use Google\AdsApi\AdWords\v201710\cm\Criterion;
+use Google\AdsApi\AdWords\v201710\cm\CriterionType;
+use Google\AdsApi\AdWords\v201710\cm\Operator;
+use Google\AdsApi\AdWords\v201710\cm\Predicate;
+use Google\AdsApi\AdWords\v201710\cm\PredicateOperator;
+use Google\AdsApi\AdWords\v201710\cm\Paging;
+use Google\AdsApi\AdWords\v201710\cm\Selector;
+use Google\AdsApi\AdWords\v201710\cm\SharedCriterion;
+use Google\AdsApi\AdWords\v201710\cm\SharedCriterionOperation;
+use Google\AdsApi\AdWords\v201710\cm\SharedCriterionService;
+use Google\AdsApi\AdWords\v201710\cm\SharedSetType;
+use Google\AdsApi\Common\OAuth2TokenBuilder;
+
+/**
+ * This example demonstrates how to find and remove shared sets and shared set
+ * criteria.
+ */
+class FindAndRemoveCriteriaFromSharedSet {
+
+  const CAMPAIGN_ID = 'INSERT_CAMPAIGN_ID_HERE';
+  const PAGE_LIMIT = 100;
+
+  public static function runExample(AdWordsServices $adWordsServices,
+      AdWordsSession $session, $campaignId) {
+    $campaignSharedSetService =
+        $adWordsServices->get($session, CampaignSharedSetService::class);
+
+    // Create selector.
+    $selector = new Selector();
+    $selector->setFields([
+        'SharedSetId', 'CampaignId', 'SharedSetName', 'SharedSetType']);
+    $selector->setPredicates([
+        new Predicate('CampaignId', PredicateOperator::EQUALS, [$campaignId]),
+        new Predicate('SharedSetType', PredicateOperator::IN, [
+            SharedSetType::NEGATIVE_KEYWORDS, SharedSetType::NEGATIVE_PLACEMENTS
+        ])
+    ]);
+    $selector->setPaging(new Paging(0, self::PAGE_LIMIT));
+
+    $sharedSetIds = [];
+    $totalNumEntries = 0;
+    do {
+      // Make the get request.
+      $page = $campaignSharedSetService->get($selector);
+
+      // Display results.
+      if ($page->getEntries() !== null) {
+        $totalNumEntries = $page->getTotalNumEntries();
+        foreach ($page->getEntries() as $campaignSharedSet) {
+          $sharedSetIds[] = strval($campaignSharedSet->getSharedSetId());
+          printf(
+              "Campaign shared set ID %d and name '%s' found for"
+                  . " campaign ID %d.\n",
+              $campaignSharedSet->getSharedSetId(),
+              $campaignSharedSet->getSharedSetName(),
+              $campaignSharedSet->getCampaignId()
+          );
+        }
+      }
+
+      // Advance the paging index.
+      $selector->getPaging()->setStartIndex(
+          $selector->getPaging()->getStartIndex() + self::PAGE_LIMIT);
+    } while ($selector->getPaging()->getStartIndex() < $totalNumEntries);
+
+    if (empty($sharedSetIds)) {
+      printf("No shared sets found for campaign ID %d.\n", $campaignId);
+      return;
+    }
+
+    // Next, retrieve criterion IDs for all found shared sets.
+    $sharedCriterionService = $adWordsServices->get($session,
+        SharedCriterionService::class);
+
+    // Create selector.
+    $selector = new Selector();
+    $selector->setFields([
+        'SharedSetId', 'Id', 'KeywordText', 'KeywordMatchType', 'PlacementUrl'
+    ]);
+    $selector->setPredicates([
+        new Predicate('SharedSetId', PredicateOperator::IN, $sharedSetIds)]);
+    $selector->setPaging(new Paging(0, self::PAGE_LIMIT));
+
+    $removeCriterionOperations = [];
+    $totalNumEntries = 0;
+    do {
+      // Make the get request.
+      $page = $sharedCriterionService->get($selector);
+
+      // Display results.
+      if ($page->getEntries() !== null) {
+        $totalNumEntries = $page->getTotalNumEntries();
+        foreach ($page->getEntries() as $sharedCriterion) {
+          if (CriterionType::KEYWORD
+              === $sharedCriterion->getCriterion()->getType()) {
+            $keyword = $sharedCriterion->getCriterion();
+            printf(
+                "Shared negative keyword with ID %d and text '%s' was found.\n",
+                $keyword->getId(),
+                $keyword->getText()
+            );
+          } else if (CriterionType::PLACEMENT
+              === $sharedCriterion->getCriterion()->getType()) {
+            $placement = $sharedCriterion->getCriterion();
+            printf(
+                "Shared negative placement with ID %d and URL '%s' was"
+                    . " found.\n",
+                $placement->getId(),
+                $placement->getUrl()
+            );
+          } else {
+            printf("Shared criterion with ID %d was found.\n",
+                $sharedCriterion->getCriterion()->getId());
+          }
+
+          $criterionToRemove = new Criterion();
+          $criterionToRemove->setId(
+              $sharedCriterion->getCriterion()->getId());
+
+          $sharedCriterionToRemove = new SharedCriterion();
+          $sharedCriterionToRemove->setCriterion($criterionToRemove);
+          $sharedCriterionToRemove->setSharedSetId(
+              $sharedCriterion->getSharedSetId());
+
+          // Create an operation to remove this criterion.
+          $removeCriterionOperation = new SharedCriterionOperation();
+          $removeCriterionOperation->setOperator(Operator::REMOVE);
+          $removeCriterionOperation->setOperand($sharedCriterionToRemove);
+
+          $removeCriterionOperations[] = $removeCriterionOperation;
+        }
+      }
+
+      // Advance the paging index.
+      $selector->getPaging()->setStartIndex(
+          $selector->getPaging()->getStartIndex() + self::PAGE_LIMIT);
+    } while ($selector->getPaging()->getStartIndex() < $totalNumEntries);
+
+    // Finally, remove the criteria.
+    if (empty($removeCriterionOperations)) {
+      printf("No shared criteria to remove.\n");
+    } else {
+      $result = $sharedCriterionService->mutate($removeCriterionOperations);
+      foreach ($result->getValue() as $removedCriterion) {
+        printf(
+            "Shared criterion ID %d was successfully removed from shared set"
+                . " ID %d.\n",
+            $removedCriterion->getCriterion()->getId(),
+            $removedCriterion->getSharedSetId()
+        );
+      }
+    }
+  }
+
+  public static function main() {
+    // Generate a refreshable OAuth2 credential for authentication.
+    $oAuth2Credential = (new OAuth2TokenBuilder())
+        ->fromFile()
+        ->build();
+
+    // Construct an API session configured from a properties file and the OAuth2
+    // credentials above.
+    $session = (new AdWordsSessionBuilder())
+        ->fromFile()
+        ->withOAuth2Credential($oAuth2Credential)
+        ->build();
+    self::runExample(
+        new AdWordsServices(), $session, intval(self::CAMPAIGN_ID));
+  }
+}
+
+FindAndRemoveCriteriaFromSharedSet::main();