Preparing release 2.2.0

Author: jradcliff

ChangeLog

@@ -1,3 +1,19 @@
+2.2.0 - 06/26/2015
+-------------------
+AdWords:
+  - Added support and examples for v201506.
+  - Fix to avoid ArrayStoreException in ProductPartitionTree.createAdGroupTree.
+  - Added support for the new includeZeroImpressions HTTP header for reporting.
+
+DFA:
+  - No changes.
+
+DFP:
+  - No changes.
+
+Common:
+  - No changes.
+
 2.1.0 - 06/10/2015
 -------------------
 AdWords:

README.md

@@ -167,7 +167,7 @@ $ mvn -X compile
 
 This command runs the ``GetCampaigns`` example, but you can update the ``-Dexec.mainClass`` argument with the example of your choice.
 ```
-$ mvn -X exec:java -Dexec.mainClass="adwords.axis.v201502.basicoperations.GetCampaigns"
+$ mvn -X exec:java -Dexec.mainClass="adwords.axis.v201506.basicoperations.GetCampaigns"
 ```
 
 ## Basic usage
@@ -177,7 +177,7 @@ to all products and frameworks.
 
 ```java
 // Contains the data classes and service classes.
-import com.google.api.ads.adwords.axis.v201502.*;
+import com.google.api.ads.adwords.axis.v201506.*;
 
 import com.google.api.ads.adwords.lib.client.AdWordsSession;
 import com.google.api.ads.adwords.lib.axis.factory.AdWordsServices;

examples/adwords_axis/pom.xml

@@ -23,7 +23,7 @@
 
   <groupId>com.google.api-ads.examples</groupId>
   <artifactId>adwords-axis-examples</artifactId>
-  <version>2.1.0</version>
+  <version>2.2.0</version>
 
   <packaging>jar</packaging>
 
@@ -36,7 +36,7 @@
 
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-    <smokeMainClass>adwords.axis.v201502.basicoperations.GetCampaigns</smokeMainClass>
+    <smokeMainClass>adwords.axis.v201506.basicoperations.GetCampaigns</smokeMainClass>
   </properties>
 
   <build>
@@ -121,12 +121,12 @@
     <dependency>
       <groupId>com.google.api-ads</groupId>
       <artifactId>ads-lib</artifactId>
-      <version>2.1.0</version>
+      <version>2.2.0</version>
     </dependency>
     <dependency>
       <groupId>com.google.api-ads</groupId>
       <artifactId>adwords-axis</artifactId>
-      <version>2.1.0</version>
+      <version>2.2.0</version>
     </dependency>
 
     <!-- Third party dependencies -->

examples/adwords_axis/src/main/java/adwords/axis/v201506/accountmanagement/CreateAccount.java

@@ -0,0 +1,96 @@
+// Copyright 2015 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.
+
+package adwords.axis.v201506.accountmanagement;
+
+import com.google.api.ads.adwords.axis.factory.AdWordsServices;
+import com.google.api.ads.adwords.axis.v201506.cm.Operator;
+import com.google.api.ads.adwords.axis.v201506.mcm.ManagedCustomer;
+import com.google.api.ads.adwords.axis.v201506.mcm.ManagedCustomerOperation;
+import com.google.api.ads.adwords.axis.v201506.mcm.ManagedCustomerReturnValue;
+import com.google.api.ads.adwords.axis.v201506.mcm.ManagedCustomerServiceInterface;
+import com.google.api.ads.adwords.lib.client.AdWordsSession;
+import com.google.api.ads.common.lib.auth.OfflineCredentials;
+import com.google.api.ads.common.lib.auth.OfflineCredentials.Api;
+import com.google.api.client.auth.oauth2.Credential;
+
+import org.joda.time.DateTime;
+
+/**
+ * This example creates a new account under an MCC account.
+ *
+ * Note: this example must be run using the credentials of an MCC account, and
+ * by default the new account will only be accessible via the parent MCC
+ * account.
+ *
+ * Credentials and properties in {@code fromFile()} are pulled from the
+ * "ads.properties" file. See README for more info.
+ *
+ * Tags: ManagedCustomerService.mutate
+ *
+ * Category: adx-exclude
+ *
+ * @author Adam Rogal
+ */
+public class CreateAccount {
+
+  public static void main(String[] args) throws Exception {
+    // Generate a refreshable OAuth2 credential similar to a ClientLogin token
+    // and can be used in place of a service account.
+    Credential oAuth2Credential = new OfflineCredentials.Builder()
+        .forApi(Api.ADWORDS)
+        .fromFile()
+        .build()
+        .generateCredential();
+
+    // Construct an AdWordsSession.
+    AdWordsSession session = new AdWordsSession.Builder()
+        .fromFile()
+        .withOAuth2Credential(oAuth2Credential)
+        .build();
+
+    AdWordsServices adWordsServices = new AdWordsServices();
+
+    runExample(adWordsServices, session);
+  }
+
+  public static void runExample(
+      AdWordsServices adWordsServices, AdWordsSession session) throws Exception {
+    // Get the CampaignService.
+    ManagedCustomerServiceInterface managedCustomerService =
+        adWordsServices.get(session, ManagedCustomerServiceInterface.class);
+
+    // Create account.
+    ManagedCustomer customer = new ManagedCustomer();
+    customer.setName("Customer created with ManagedCustomerService on " + new DateTime());
+    customer.setCurrencyCode("EUR");
+    customer.setDateTimeZone("Europe/London");
+
+    // Create operations.
+    ManagedCustomerOperation operation = new ManagedCustomerOperation();
+    operation.setOperand(customer);
+    operation.setOperator(Operator.ADD);
+
+    ManagedCustomerOperation[] operations = new ManagedCustomerOperation[] {operation};
+
+    // Add account.
+    ManagedCustomerReturnValue result = managedCustomerService.mutate(operations);
+
+    // Display accounts.
+    for (ManagedCustomer customerResult : result.getValue()) {
+      System.out.println("Account with customer ID \"" + customerResult.getCustomerId()
+          + "\" was created.");
+    }
+  }
+}

examples/adwords_axis/src/main/java/adwords/axis/v201506/accountmanagement/GetAccountChanges.java

@@ -0,0 +1,166 @@
+// Copyright 2015 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.
+
+package adwords.axis.v201506.accountmanagement;
+
+import com.google.api.ads.adwords.axis.factory.AdWordsServices;
+import com.google.api.ads.adwords.axis.utils.v201506.SelectorBuilder;
+import com.google.api.ads.adwords.axis.v201506.ch.AdGroupChangeData;
+import com.google.api.ads.adwords.axis.v201506.ch.CampaignChangeData;
+import com.google.api.ads.adwords.axis.v201506.ch.ChangeStatus;
+import com.google.api.ads.adwords.axis.v201506.ch.CustomerChangeData;
+import com.google.api.ads.adwords.axis.v201506.ch.CustomerSyncSelector;
+import com.google.api.ads.adwords.axis.v201506.ch.CustomerSyncServiceInterface;
+import com.google.api.ads.adwords.axis.v201506.cm.Campaign;
+import com.google.api.ads.adwords.axis.v201506.cm.CampaignPage;
+import com.google.api.ads.adwords.axis.v201506.cm.CampaignServiceInterface;
+import com.google.api.ads.adwords.axis.v201506.cm.DateTimeRange;
+import com.google.api.ads.adwords.axis.v201506.cm.Selector;
+import com.google.api.ads.adwords.lib.client.AdWordsSession;
+import com.google.api.ads.adwords.lib.selectorfields.v201506.cm.CampaignField;
+import com.google.api.ads.common.lib.auth.OfflineCredentials;
+import com.google.api.ads.common.lib.auth.OfflineCredentials.Api;
+import com.google.api.client.auth.oauth2.Credential;
+
+import org.apache.commons.lang.ArrayUtils;
+import org.apache.commons.lang.StringUtils;
+
+import java.text.SimpleDateFormat;
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.List;
+
+/**
+ * This example gets the changes in the account during the last 24 hours.
+ *
+ * Tags: CustomerSyncService.get
+ *
+ * @author Kevin Winter
+ */
+public class GetAccountChanges {
+
+  public static void main(String[] args) throws Exception {
+    // Generate a refreshable OAuth2 credential similar to a ClientLogin token
+    // and can be used in place of a service account.
+    Credential oAuth2Credential = new OfflineCredentials.Builder()
+        .forApi(Api.ADWORDS)
+        .fromFile()
+        .build()
+        .generateCredential();
+
+    // Construct an AdWordsSession.
+    AdWordsSession session = new AdWordsSession.Builder()
+        .fromFile()
+        .withOAuth2Credential(oAuth2Credential)
+        .build();
+
+    AdWordsServices adWordsServices = new AdWordsServices();
+
+    runExample(adWordsServices, session);
+  }
+
+  public static void runExample(AdWordsServices adWordsServices, AdWordsSession session)
+      throws Exception {
+    // Get the CampaignService.
+    CampaignServiceInterface campaignService =
+        adWordsServices.get(session, CampaignServiceInterface.class);
+
+    // Get the CustomerSyncService.
+    CustomerSyncServiceInterface customerSyncService =
+        adWordsServices.get(session, CustomerSyncServiceInterface.class);
+
+    // Get a list of all campaign IDs.
+    List<Long> campaignIds = new ArrayList<Long>();
+    Selector selector = new SelectorBuilder()
+        .fields(CampaignField.Id)
+        .build();
+    CampaignPage campaigns = campaignService.get(selector);
+    if (campaigns.getEntries() != null) {
+      for (Campaign campaign : campaigns.getEntries()) {
+        campaignIds.add(campaign.getId());
+      }
+    }
+
+    // Create date time range for the past 24 hours.
+    DateTimeRange dateTimeRange = new DateTimeRange();
+    dateTimeRange.setMin(new SimpleDateFormat("yyyyMMdd HHmmss").format(new Date(System
+        .currentTimeMillis() - 1000L * 60 * 60 * 24)));
+    dateTimeRange.setMax(new SimpleDateFormat("yyyyMMdd HHmmss").format(new Date()));
+
+    // Create selector.
+    CustomerSyncSelector customerSyncSelector = new CustomerSyncSelector();
+    customerSyncSelector.setDateTimeRange(dateTimeRange);
+    customerSyncSelector
+        .setCampaignIds(ArrayUtils.toPrimitive(campaignIds.toArray(new Long[] {})));
+
+    // Get all account changes for campaign.
+    CustomerChangeData accountChanges = customerSyncService.get(customerSyncSelector);
+
+    // Display changes.
+    if (accountChanges != null && accountChanges.getChangedCampaigns() != null) {
+      System.out.println("Most recent change: "
+          + accountChanges.getLastChangeTimestamp() + "\n");
+      for (CampaignChangeData campaignChanges : accountChanges.getChangedCampaigns()) {
+        System.out.println("Campaign with id \"" + campaignChanges.getCampaignId()
+            + "\" was changed: ");
+        System.out.println("\tCampaign changed status: "
+            + campaignChanges.getCampaignChangeStatus());
+        if (campaignChanges.getCampaignChangeStatus() != ChangeStatus.NEW) {
+          System.out.println("\tAdded ad extensions: "
+              + getFormattedList(campaignChanges.getAddedAdExtensions()));
+          System.out.println("\tAdded campaign criteria: "
+              + getFormattedList(campaignChanges.getAddedCampaignCriteria()));
+          System.out.println("\tRemoved ad extensions: "
+              + getFormattedList(campaignChanges.getRemovedAdExtensions()));
+          System.out.println("\tRemoved campaign criteria: "
+              + getFormattedList(campaignChanges.getRemovedCampaignCriteria()));
+
+          if (campaignChanges.getChangedAdGroups() != null) {
+            for (AdGroupChangeData adGroupChanges : campaignChanges.getChangedAdGroups()) {
+              System.out.println("\tAd goup with id \"" + adGroupChanges.getAdGroupId()
+                  + "\" was changed: ");
+              System.out.println("\t\tAd goup changed status: "
+                  + adGroupChanges.getAdGroupChangeStatus());
+              if (adGroupChanges.getAdGroupChangeStatus() != ChangeStatus.NEW) {
+                System.out.println("\t\tAds changed: "
+                    + getFormattedList(adGroupChanges.getChangedAds()));
+                System.out.println("\t\tCriteria changed: "
+                    + getFormattedList(adGroupChanges.getChangedCriteria()));
+                System.out.println("\t\tCriteria removed: "
+                    + getFormattedList(adGroupChanges.getRemovedCriteria()));
+              }
+            }
+          }
+        }
+        System.out.println("");
+      }
+    } else {
+      System.out.println("No account changes were found.");
+    }
+  }
+
+  /**
+   * Gets a formatted list of a long array in the form {1,2,3}.
+   * @param idList the long array
+   * @return the formatted list
+   */
+  private static String getFormattedList(long[] idList) {
+    if (idList == null) {
+      idList = new long[]{};
+    }
+    return new StringBuilder().append("{")
+        .append(StringUtils.join(ArrayUtils.toObject(idList), ','))
+        .append("}").toString();
+  }
+}