Changes for release v5.0. (#330)

Author: nwbirnie

CHANGELOG.md

@@ -1,3 +1,8 @@
+9.0.0 - 2020-09-01
+------------------
+- Added support and examples for Google Ads API v5_0.
+- Switched internal catalog implementation default to use annotation processor.
+
 8.0.0 - 2020-07-31
 ------------------
 - Removed v1 from the library.

README.md

@@ -18,7 +18,7 @@ This project hosts the Java client library for the Google Ads API.
     <dependency>
       <groupId>com.google.api-ads</groupId>
       <artifactId>google-ads</artifactId>
-      <version>8.0.0</version>
+      <version>9.0.0</version>
     </dependency>
 
 ## Documentation

google-ads-examples/src/main/java/com/google/ads/googleads/examples/accountmanagement/ApproveMerchantCenterLink.java

@@ -19,16 +19,16 @@
 import com.google.ads.googleads.examples.utils.CodeSampleParams;
 import com.google.ads.googleads.lib.GoogleAdsClient;
 import com.google.ads.googleads.lib.utils.FieldMasks;
-import com.google.ads.googleads.v4.enums.MerchantCenterLinkStatusEnum.MerchantCenterLinkStatus;
-import com.google.ads.googleads.v4.errors.GoogleAdsError;
-import com.google.ads.googleads.v4.errors.GoogleAdsException;
-import com.google.ads.googleads.v4.resources.MerchantCenterLink;
-import com.google.ads.googleads.v4.services.ListMerchantCenterLinksRequest;
-import com.google.ads.googleads.v4.services.ListMerchantCenterLinksResponse;
-import com.google.ads.googleads.v4.services.MerchantCenterLinkOperation;
-import com.google.ads.googleads.v4.services.MerchantCenterLinkServiceClient;
-import com.google.ads.googleads.v4.services.MutateMerchantCenterLinkResponse;
-import com.google.ads.googleads.v4.services.MutateMerchantCenterLinkResult;
+import com.google.ads.googleads.v5.enums.MerchantCenterLinkStatusEnum.MerchantCenterLinkStatus;
+import com.google.ads.googleads.v5.errors.GoogleAdsError;
+import com.google.ads.googleads.v5.errors.GoogleAdsException;
+import com.google.ads.googleads.v5.resources.MerchantCenterLink;
+import com.google.ads.googleads.v5.services.ListMerchantCenterLinksRequest;
+import com.google.ads.googleads.v5.services.ListMerchantCenterLinksResponse;
+import com.google.ads.googleads.v5.services.MerchantCenterLinkOperation;
+import com.google.ads.googleads.v5.services.MerchantCenterLinkServiceClient;
+import com.google.ads.googleads.v5.services.MutateMerchantCenterLinkResponse;
+import com.google.ads.googleads.v5.services.MutateMerchantCenterLinkResult;
 import java.io.FileNotFoundException;
 import java.io.IOException;
 
@@ -61,16 +61,16 @@ public static void main(String[] args) {
       params.merchantCenterAccountId = Long.parseLong("INSERT_MERCHANT_CENTER_ACCOUNT_ID_HERE");
     }
 
-    GoogleAdsClient googleAdsClient;
+    GoogleAdsClient googleAdsClient = null;
     try {
       googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
     } catch (FileNotFoundException fnfe) {
       System.err.printf(
           "Failed to load GoogleAdsClient configuration from file. Exception: %s%n", fnfe);
-      return;
+      System.exit(1);
     } catch (IOException ioe) {
       System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
-      return;
+      System.exit(1);
     }
 
     try {
@@ -88,6 +88,7 @@ public static void main(String[] args) {
       for (GoogleAdsError googleAdsError : gae.getGoogleAdsFailure().getErrorsList()) {
         System.err.printf("  Error %d: %s%n", i++, googleAdsError);
       }
+      System.exit(1);
     }
   }
 
@@ -124,7 +125,7 @@ private void runExample(
 
         // Checks if there is a link for the Merchant Center account we are looking for, then only
         // approves the link if it is in a 'PENDING' state.
-        if (merchantCenterAccountId == merchantCenterLink.getId().getValue()
+        if (merchantCenterAccountId == merchantCenterLink.getId()
             && merchantCenterLink.getStatus() == MerchantCenterLinkStatus.PENDING) {
           // Updates the status of Merchant Center link to 'ENABLED' to approve the link.
           updateMerchantCenterLinkStatus(

google-ads-examples/src/main/java/com/google/ads/googleads/examples/accountmanagement/CreateCustomer.java

@@ -18,13 +18,11 @@
 import com.google.ads.googleads.examples.utils.ArgumentNames;
 import com.google.ads.googleads.examples.utils.CodeSampleParams;
 import com.google.ads.googleads.lib.GoogleAdsClient;
-import com.google.ads.googleads.v4.errors.GoogleAdsError;
-import com.google.ads.googleads.v4.errors.GoogleAdsException;
-import com.google.ads.googleads.v4.resources.Customer;
-import com.google.ads.googleads.v4.services.CreateCustomerClientResponse;
-import com.google.ads.googleads.v4.services.CustomerServiceClient;
-import com.google.protobuf.BoolValue;
-import com.google.protobuf.StringValue;
+import com.google.ads.googleads.v5.errors.GoogleAdsError;
+import com.google.ads.googleads.v5.errors.GoogleAdsException;
+import com.google.ads.googleads.v5.resources.Customer;
+import com.google.ads.googleads.v5.services.CreateCustomerClientResponse;
+import com.google.ads.googleads.v5.services.CustomerServiceClient;
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.time.ZonedDateTime;
@@ -54,16 +52,16 @@ public static void main(String[] args) {
       params.managerAccountId = Long.valueOf("INSERT_MANAGER_ID_HERE");
     }
 
-    GoogleAdsClient googleAdsClient;
+    GoogleAdsClient googleAdsClient = null;
     try {
       googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
     } catch (FileNotFoundException fnfe) {
       System.err.printf(
           "Failed to load GoogleAdsClient configuration from file. Exception: %s%n", fnfe);
-      return;
+      System.exit(1);
     } catch (IOException ioe) {
       System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
-      return;
+      System.exit(1);
     }
 
     try {
@@ -80,6 +78,7 @@ public static void main(String[] args) {
       for (GoogleAdsError googleAdsError : gae.getGoogleAdsFailure().getErrorsList()) {
         System.err.printf("  Error %d: %s%n", i++, googleAdsError);
       }
+      System.exit(1);
     }
   }
 
@@ -90,15 +89,13 @@ private void runExample(GoogleAdsClient googleAdsClient, Long managerId) {
     // Initializes a Customer object to be created.
     Customer customer =
         Customer.newBuilder()
-            .setDescriptiveName(
-                StringValue.of("Account created with CustomerService on '" + dateTime + "'"))
-            .setCurrencyCode(StringValue.of("USD"))
-            .setTimeZone(StringValue.of("America/New_York"))
+            .setDescriptiveName("Account created with CustomerService on '" + dateTime + "'")
+            .setCurrencyCode("USD")
+            .setTimeZone("America/New_York")
             // Optional: Sets additional attributes of the customer.
-            .setTrackingUrlTemplate(StringValue.of("{lpurl}?device={device}"))
-            .setFinalUrlSuffix(
-                StringValue.of("keyword={keyword}&matchtype={matchtype}&adgroupid={adgroupid}"))
-            .setHasPartnersBadge(BoolValue.of(false))
+            .setTrackingUrlTemplate("{lpurl}?device={device}")
+            .setFinalUrlSuffix("keyword={keyword}&matchtype={matchtype}&adgroupid={adgroupid}")
+            .setHasPartnersBadge(false)
             .build();
 
     // Sends the request to create the customer.

google-ads-examples/src/main/java/com/google/ads/googleads/examples/accountmanagement/GetAccountChanges.java

@@ -18,12 +18,12 @@
 import com.google.ads.googleads.examples.utils.ArgumentNames;
 import com.google.ads.googleads.examples.utils.CodeSampleParams;
 import com.google.ads.googleads.lib.GoogleAdsClient;
-import com.google.ads.googleads.v4.errors.GoogleAdsError;
-import com.google.ads.googleads.v4.errors.GoogleAdsException;
-import com.google.ads.googleads.v4.resources.ChangeStatus;
-import com.google.ads.googleads.v4.services.GoogleAdsRow;
-import com.google.ads.googleads.v4.services.GoogleAdsServiceClient;
-import com.google.ads.googleads.v4.services.GoogleAdsServiceClient.SearchPagedResponse;
+import com.google.ads.googleads.v5.errors.GoogleAdsError;
+import com.google.ads.googleads.v5.errors.GoogleAdsException;
+import com.google.ads.googleads.v5.resources.ChangeStatus;
+import com.google.ads.googleads.v5.services.GoogleAdsRow;
+import com.google.ads.googleads.v5.services.GoogleAdsServiceClient;
+import com.google.ads.googleads.v5.services.GoogleAdsServiceClient.SearchPagedResponse;
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.util.Optional;
@@ -46,16 +46,16 @@ public static void main(String[] args) {
       params.customerId = Long.parseLong("INSERT_CUSTOMER_ID_HERE");
     }
 
-    GoogleAdsClient googleAdsClient;
+    GoogleAdsClient googleAdsClient = null;
     try {
       googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
     } catch (FileNotFoundException fnfe) {
       System.err.printf(
           "Failed to load GoogleAdsClient configuration from file. Exception: %s%n", fnfe);
-      return;
+      System.exit(1);
     } catch (IOException ioe) {
       System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
-      return;
+      System.exit(1);
     }
 
     try {
@@ -72,6 +72,7 @@ public static void main(String[] args) {
       for (GoogleAdsError googleAdsError : gae.getGoogleAdsFailure().getErrorsList()) {
         System.err.printf("  Error %d: %s%n", i++, googleAdsError);
       }
+      System.exit(1);
     }
   }
 
@@ -135,7 +136,7 @@ private static Optional<String> getResourceNameForResourceType(ChangeStatus chan
     // See https://developers.google.com/google-ads/api/docs/change-status for a description.
     switch (changeStatus.getResourceType()) {
       case AD_GROUP:
-        resourceName = changeStatus.getAdGroup().getValue();
+        resourceName = changeStatus.getAdGroup();
         break;
       case AD_GROUP_AD:
         resourceName = changeStatus.getAdGroupAd().getValue();
@@ -144,13 +145,13 @@ private static Optional<String> getResourceNameForResourceType(ChangeStatus chan
         resourceName = changeStatus.getAdGroupBidModifier().getValue();
         break;
       case AD_GROUP_CRITERION:
-        resourceName = changeStatus.getAdGroup().getValue();
+        resourceName = changeStatus.getAdGroup();
         break;
       case AD_GROUP_FEED:
         resourceName = changeStatus.getAdGroupFeed().getValue();
         break;
       case CAMPAIGN:
-        resourceName = changeStatus.getCampaign().getValue();
+        resourceName = changeStatus.getCampaign();
         break;
       case CAMPAIGN_CRITERION:
         resourceName = changeStatus.getCampaignCriterion().getValue();

google-ads-examples/src/main/java/com/google/ads/googleads/examples/accountmanagement/GetAccountHierarchy.java

@@ -18,17 +18,17 @@
 import com.google.ads.googleads.examples.utils.ArgumentNames;
 import com.google.ads.googleads.examples.utils.CodeSampleParams;
 import com.google.ads.googleads.lib.GoogleAdsClient;
-import com.google.ads.googleads.v4.errors.GoogleAdsError;
-import com.google.ads.googleads.v4.errors.GoogleAdsException;
-import com.google.ads.googleads.v4.resources.CustomerClient;
-import com.google.ads.googleads.v4.services.CustomerName;
-import com.google.ads.googleads.v4.services.CustomerServiceClient;
-import com.google.ads.googleads.v4.services.GoogleAdsRow;
-import com.google.ads.googleads.v4.services.GoogleAdsServiceClient;
-import com.google.ads.googleads.v4.services.GoogleAdsServiceClient.SearchPagedResponse;
-import com.google.ads.googleads.v4.services.ListAccessibleCustomersRequest;
-import com.google.ads.googleads.v4.services.ListAccessibleCustomersResponse;
-import com.google.ads.googleads.v4.services.SearchGoogleAdsRequest;
+import com.google.ads.googleads.v5.errors.GoogleAdsError;
+import com.google.ads.googleads.v5.errors.GoogleAdsException;
+import com.google.ads.googleads.v5.resources.CustomerClient;
+import com.google.ads.googleads.v5.services.CustomerName;
+import com.google.ads.googleads.v5.services.CustomerServiceClient;
+import com.google.ads.googleads.v5.services.GoogleAdsRow;
+import com.google.ads.googleads.v5.services.GoogleAdsServiceClient;
+import com.google.ads.googleads.v5.services.GoogleAdsServiceClient.SearchPagedResponse;
+import com.google.ads.googleads.v5.services.ListAccessibleCustomersRequest;
+import com.google.ads.googleads.v5.services.ListAccessibleCustomersResponse;
+import com.google.ads.googleads.v5.services.SearchGoogleAdsRequest;
 import com.google.common.base.Strings;
 import com.google.common.collect.ArrayListMultimap;
 import com.google.common.collect.Multimap;
@@ -53,7 +53,7 @@ public class GetAccountHierarchy {
 
   private static class GetAccountHierarchyParams extends CodeSampleParams {
 
-    @Parameter(names = ArgumentNames.MANAGER_ID)
+    @Parameter(names = ArgumentNames.MANAGER_CUSTOMER_ID)
     private Long managerId;
 
     @Parameter(names = ArgumentNames.LOGIN_CUSTOMER_ID)
@@ -84,16 +84,16 @@ public static void main(String[] args) {
       return;
     }
 
-    GoogleAdsClient googleAdsClient;
+    GoogleAdsClient googleAdsClient = null;
     try {
       googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
     } catch (FileNotFoundException fnfe) {
       System.err.printf(
           "Failed to load GoogleAdsClient configuration from file. Exception: %s%n", fnfe);
-      return;
+      System.exit(1);
     } catch (IOException ioe) {
       System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
-      return;
+      System.exit(1);
     }
 
     try {
@@ -111,8 +111,10 @@ public static void main(String[] args) {
       for (GoogleAdsError googleAdsError : gae.getGoogleAdsFailure().getErrorsList()) {
         System.err.printf("  Error %d: %s%n", i++, googleAdsError);
       }
+      System.exit(1);
     } catch (IOException ioe) {
       System.err.printf("Request failed. Exception: %s%n", ioe);
+      System.exit(1);
     }
   }
 
@@ -259,6 +261,7 @@ private Map<CustomerClient, Multimap<Long, CustomerClient>> createCustomerClient
           System.out.printf(
               "Unable to retrieve hierarchy for customer ID %d: %s%n",
               customerIdToSearchFrom, gae.getGoogleAdsFailure().getErrors(0).getMessage());
+          return null;
         }
       }
 

google-ads-examples/src/main/java/com/google/ads/googleads/examples/accountmanagement/GetAccountInformation.java

@@ -18,11 +18,11 @@
 import com.google.ads.googleads.examples.utils.ArgumentNames;
 import com.google.ads.googleads.examples.utils.CodeSampleParams;
 import com.google.ads.googleads.lib.GoogleAdsClient;
-import com.google.ads.googleads.v4.errors.GoogleAdsError;
-import com.google.ads.googleads.v4.errors.GoogleAdsException;
-import com.google.ads.googleads.v4.resources.Customer;
-import com.google.ads.googleads.v4.services.CustomerServiceClient;
-import com.google.ads.googleads.v4.utils.ResourceNames;
+import com.google.ads.googleads.v5.errors.GoogleAdsError;
+import com.google.ads.googleads.v5.errors.GoogleAdsException;
+import com.google.ads.googleads.v5.resources.Customer;
+import com.google.ads.googleads.v5.services.CustomerServiceClient;
+import com.google.ads.googleads.v5.utils.ResourceNames;
 import java.io.FileNotFoundException;
 import java.io.IOException;
 
@@ -47,16 +47,16 @@ public static void main(String[] args) {
       params.customerId = Long.parseLong("INSERT_CUSTOMER_ID_HERE");
     }
 
-    GoogleAdsClient googleAdsClient;
+    GoogleAdsClient googleAdsClient = null;
     try {
       googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
     } catch (FileNotFoundException fnfe) {
       System.err.printf(
           "Failed to load GoogleAdsClient configuration from file. Exception: %s%n", fnfe);
-      return;
+      System.exit(1);
     } catch (IOException ioe) {
       System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
-      return;
+      System.exit(1);
     }
 
     try {
@@ -73,6 +73,7 @@ public static void main(String[] args) {
       for (GoogleAdsError googleAdsError : gae.getGoogleAdsFailure().getErrorsList()) {
         System.err.printf("  Error %d: %s%n", i++, googleAdsError);
       }
+      System.exit(1);
     }
   }
 
@@ -92,12 +93,12 @@ private void runExample(GoogleAdsClient googleAdsClient, long customerId) {
       System.out.printf(
           "Customer with ID %d, descriptive name '%s', currency code '%s', timezone '%s', "
               + "tracking URL template '%s' and auto tagging enabled '%s' was retrieved.%n",
-          customer.getId().getValue(),
-          customer.getDescriptiveName().getValue(),
-          customer.getCurrencyCode().getValue(),
-          customer.getTimeZone().getValue(),
-          customer.getTrackingUrlTemplate().getValue(),
-          customer.getAutoTaggingEnabled().getValue());
+          customer.getId(),
+          customer.getDescriptiveName(),
+          customer.getCurrencyCode(),
+          customer.getTimeZone(),
+          customer.getTrackingUrlTemplate(),
+          customer.getAutoTaggingEnabled());
     }
   }
 }