Preparing src for release 8.2.0

Author: fiboknacky

ChangeLog.md

@@ -1,3 +1,12 @@
+### 8.2.0
+
+AdWords:
+  - Fixed [issue #123](https://github.com/googleads/googleads-php-lib/issues/123).
+  - Added support and examples for v201603.
+
+DFP:
+  - Fixed [issue #126](https://github.com/googleads/googleads-php-lib/issues/126).
+
 ### 8.1.0
 
 AdWords:

examples/AdWords/v201509/CampaignManagement/AddCompleteCampaignsUsingBatchJob.php

@@ -115,7 +115,8 @@ function AddCompleteCampaignUsingBatchJobExample(AdWordsUser $user) {
 
     $pollAttempts++;
     if ($batchJob->status !== 'ACTIVE' &&
-        $batchJob->status !== 'AWAITING_FILE') {
+        $batchJob->status !== 'AWAITING_FILE' &&
+        $batchJob->status !== 'CANCELING') {
       $isPending = false;
     }
   } while ($isPending && $pollAttempts <= MAX_POLL_ATTEMPTS);
@@ -140,6 +141,8 @@ function AddCompleteCampaignUsingBatchJobExample(AdWordsUser $user) {
           $processingError->reason
       );
     }
+  } else {
+    printf("No processing errors found.\n");
   }
 
   if ($batchJob->downloadUrl !== null && $batchJob->downloadUrl->url !== null) {
@@ -156,6 +159,8 @@ function AddCompleteCampaignUsingBatchJobExample(AdWordsUser $user) {
         printf("  Operation [%d] - %s\n", $mutateResult->index, $outcome);
       }
     }
+  } else {
+    printf("No results available for download.\n");
   }
 }
 

examples/AdWords/v201509/CampaignManagement/AddKeywordsInBulk.php

@@ -70,40 +70,84 @@ function AddKeywordsUsingIncrementalBatchJob(AdWordsUser $user, $adGroupId) {
       buildAdGroupCriterionOperations($adGroupId);
   $batchJobUtils->UploadIncrementalBatchJobOperations(
       $adGroupCriterionOperations);
+  printf("Uploaded %d operations for batch job with ID %d.\n",
+      count($adGroupCriterionOperations), $batchJob->id);
 
   // Generate and upload the second set of operations.
   $adGroupCriterionOperations =
       buildAdGroupCriterionOperations($adGroupId);
   $batchJobUtils->UploadIncrementalBatchJobOperations(
       $adGroupCriterionOperations);
+  printf("Uploaded %d operations for batch job with ID %d.\n",
+      count($adGroupCriterionOperations), $batchJob->id);
 
   // Generate and upload the third and final set of operations.
   $adGroupCriterionOperations =
       buildAdGroupCriterionOperations($adGroupId);
   $batchJobUtils->UploadIncrementalBatchJobOperations(
       $adGroupCriterionOperations, true);
+  printf("Uploaded %d operations for batch job with ID %d.\n",
+      count($adGroupCriterionOperations), $batchJob->id);
 
   // Poll for completion of the batch job using an exponential back off.
   $pollAttempts = 0;
   $isPending = true;
+  $wasCancelRequested = false;
+
+  $selector = new Selector();
+  $selector->fields = array('Id', 'Status', 'DownloadUrl', 'ProcessingErrors',
+      'ProgressStats');
+  $selector->predicates[] = new Predicate('Id', 'EQUALS', $batchJob->id);
   do {
     $sleepSeconds = POLL_FREQUENCY_SECONDS * pow(2, $pollAttempts);
     printf("Sleeping %d seconds...\n", $sleepSeconds);
     sleep($sleepSeconds);
 
-    $selector = new Selector();
-    $selector->fields = array('Id', 'Status', 'DownloadUrl', 'ProcessingErrors',
-        'ProgressStats');
-    $selector->predicates[] = new Predicate('Id', 'EQUALS', $batchJob->id);
     $batchJob = $batchJobService->get($selector)->entries[0];
     printf("Batch job ID %d has status '%s'.\n", $batchJob->id,
         $batchJob->status);
 
     $pollAttempts++;
     if ($batchJob->status !== 'ACTIVE' &&
-        $batchJob->status !== 'AWAITING_FILE') {
+        $batchJob->status !== 'AWAITING_FILE' &&
+        $batchJob->status !== 'CANCELING') {
       $isPending = false;
     }
+
+    // Optional: Cancel the job if it has not completed after polling
+    // MAX_POLL_ATTEMPTS times.
+    if ($isPending && !$wasCancelRequested
+        && $pollAttempts == MAX_POLL_ATTEMPTS) {
+      $batchJob->status = 'CANCELING';
+      $batchJobSetOperation = new BatchJobOperation();
+      $batchJobSetOperation->operand = $batchJob;
+      $batchJobSetOperation->operator = 'SET';
+
+      // Only request cancellation once per job.
+      $wasCancelRequested = true;
+      try {
+        $operations[] = $batchJobSetOperation;
+        $batchJob = $batchJobService->mutate($operations)->value[0];
+        printf("Requested cancellation of batch job with ID %d.\n",
+            $batchJob->id);
+        // Reset the poll attempt counter to wait for cancellation.
+        $pollAttempts = 0;
+      } catch (Exception $e) {
+        $errors = $e->detail->ApiExceptionFault->errors;
+        if ($errors !== null
+            && $errors->enc_value instanceof BatchJobError) {
+          if ($errors->enc_value->reason === 'INVALID_STATE_CHANGE') {
+            printf("Attempt to cancel batch job with ID %d was rejected because"
+                . " the job already completed or was canceled.\n",
+                $batchJob->id);
+            // Reset the poll attempt counter to wait for cancellation.
+            $pollAttempts = 0;
+            continue;
+          }
+        }
+        throw $e;
+      }
+    }
   } while ($isPending && $pollAttempts <= MAX_POLL_ATTEMPTS);
 
   if ($isPending) {
@@ -126,6 +170,8 @@ function AddKeywordsUsingIncrementalBatchJob(AdWordsUser $user, $adGroupId) {
           $processingError->reason
       );
     }
+  } else {
+    printf("No processing errors found.\n");
   }
 
   if ($batchJob->downloadUrl !== null && $batchJob->downloadUrl->url !== null) {
@@ -142,6 +188,8 @@ function AddKeywordsUsingIncrementalBatchJob(AdWordsUser $user, $adGroupId) {
         printf("  Operation [%d] - %s\n", $mutateResult->index, $outcome);
       }
     }
+  } else {
+    printf("No results available for download.\n");
   }
 }
 

examples/AdWords/v201509/AdvancedOperations/AddKeywordsUsingIncrementalBatchJob.php renamed to examples/AdWords/v201509/CampaignManagement/AddKeywordsUsingIncrementalBatchJob.php

@@ -3,8 +3,6 @@
  * This example gets all available keyword bid simulations within an ad group.
  * To get ad groups, run BasicOperation/GetAdGroups.php.
  *
- * Restriction: adwords-only
- *
  * Copyright 2014, Google Inc. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -70,20 +68,17 @@ function GetKeywordBidSimulationsExample(AdWordsUser $user, $adGroupId) {
               $bidLandscapePoint->bid->microAmount,
               $bidLandscapePoint->clicks,
               $bidLandscapePoint->cost->microAmount,
-              $bidLandscapePoint->impressions);
+              $bidLandscapePoint->impressions
+          );
         }
         print "\n";
       }
+    } else if ($selector->paging->startIndex === 0) {
+      printf("No criterion bid landscapes were found.\n");
     }
-
     // Advance the paging index.
     $selector->paging->startIndex += AdWordsConstants::RECOMMENDED_PAGE_SIZE;
   } while (isset($page->entries) && count($page->entries) > 0);
-
-  if ($selector->paging->startIndex === 0) {
-    print "No criterion bid landscapes were found.\n";
-  }
-
 }
 
 // Don't run the example if the file is being included.