Update all references of Google My Business to Business Profile (#521)

devchas · web-flow · commit 83b3bb471e46 · 2021-12-06T12:18:06.000-05:00
Change-Id: Ia8c7b2207aa2b411cc2cf2f7dced0be724625238
diff --git a/google-ads-examples/src/main/java/com/google/ads/googleads/examples/advancedoperations/AddLocalCampaign.java b/google-ads-examples/src/main/java/com/google/ads/googleads/examples/advancedoperations/AddLocalCampaign.java
@@ -72,7 +72,7 @@
  * Adds an Local campaign.
  *
  * <p>Prerequisite: To create a Local campaign, you need to define the store locations you want to
- * promote by linking your Google My Business account or selecting affiliate locations. More
+ * promote by linking your Business Profile account or selecting affiliate locations. More
  * information about Local campaigns can be found at:
  * https://support.google.com/google-ads/answer/9118422.
  */
@@ -208,7 +208,7 @@ private String createLocalCampaign(
             // Configures the Local campaign setting.
             .setLocalCampaignSetting(
                 LocalCampaignSetting.newBuilder()
-                    // Use the locations associated with the customer's linked Google My Business
+                    // Use the locations associated with the customer's linked Business Profile
                     // account.
                     .setLocationSourceType(LocationSourceType.GOOGLE_MY_BUSINESS))
             .setOptimizationGoalSetting(
diff --git a/google-ads-examples/src/main/java/com/google/ads/googleads/examples/advancedoperations/AddSmartCampaign.java b/google-ads-examples/src/main/java/com/google/ads/googleads/examples/advancedoperations/AddSmartCampaign.java
@@ -112,15 +112,15 @@ private static class AddSmartCampaignParams extends CodeSampleParams {
     @Parameter(
         names = ArgumentNames.BUSINESS_LOCATION_ID,
         description =
-            "The ID of a Google My Business (GMB) location. This is required if a business name is"
-                + " not provided. It can be retrieved using the GMB API, for details see:"
+            "The ID of a Business Profile location. This is required if a business name is not"
+                + " provided. It can be retrieved using the Business Profile API, for details see:"
                 + " https://developers.google.com/my-business/reference/rest/v4/accounts.locations")
     private String locationId;
 
     @Parameter(
         names = ArgumentNames.BUSINESS_NAME,
         description =
-            "The name of a Google My Business (GMB) business. This is required if a business"
+            "The name of a Business Profile business. This is required if a business"
                 + " location ID is not provided.")
     private String businessName;
   }
diff --git a/google-ads-examples/src/main/java/com/google/ads/googleads/examples/extensions/AddAffiliateLocationExtensions.java b/google-ads-examples/src/main/java/com/google/ads/googleads/examples/extensions/AddAffiliateLocationExtensions.java
@@ -187,7 +187,8 @@ private void removeLocationExtensionFeeds(GoogleAdsClient googleAdsClient, long
     // Removes a location extension feed. Does this with the following steps:
     //   1. Retrieves the existing CustomerFeed links.
     //   2. Removes the CustomerFeed so that the location extensions from the feed stop serving.
-    //   3. Removes the feed so that Google Ads will no longer sync from the GMB account.
+    //   3. Removes the feed so that Google Ads will no longer sync from the Business Profile
+    // account.
     List<CustomerFeed> oldCustomerFeeds =
         getLocationExtensionCustomerFeeds(googleAdsClient, customerId);
     if (oldCustomerFeeds.isEmpty()) {
diff --git a/google-ads-examples/src/main/java/com/google/ads/googleads/examples/extensions/AddBusinessProfileLocationExtensions.java b/google-ads-examples/src/main/java/com/google/ads/googleads/examples/extensions/AddBusinessProfileLocationExtensions.java
@@ -43,43 +43,43 @@
 import java.io.IOException;
 
 /**
- * Adds a feed that syncs feed items from a Google My Business (GMB) account and associates the feed
- * with a customer.
+ * Adds a feed that syncs feed items from a Business Profile account and associates the feed with a
+ * customer.
  */
-public class AddGoogleMyBusinessLocationExtensions {
+public class AddBusinessProfileLocationExtensions {
   // The required scope for setting the OAuth info.
   private final String GOOGLE_ADS_SCOPE = "https://www.googleapis.com/auth/adwords";
 
   // The maximum number of CustomerFeed ADD operation attempts to make before throwing an exception.
   private static final int MAX_CUSTOMER_FEED_ADD_ATTEMPTS = 10;
 
-  private static class AddGoogleMyBusinessLocationExtensionsParams extends CodeSampleParams {
+  private static class AddBusinessProfileLocationExtensionsParams extends CodeSampleParams {
 
     @Parameter(names = ArgumentNames.CUSTOMER_ID, required = true)
     private Long customerId;
 
-    @Parameter(names = ArgumentNames.GMB_EMAIL_ADDRESS, required = true)
-    private String gmbEmailAddress;
+    @Parameter(names = ArgumentNames.BUSINESS_PROFILE_EMAIL_ADDRESS, required = true)
+    private String businessProfileEmailAddress;
 
     @Parameter(names = ArgumentNames.BUSINESS_ACCOUNT_IDENTIFIER)
     private String businessAccountIdentifier;
 
-    @Parameter(names = ArgumentNames.GMB_ACCESS_TOKEN, required = true)
-    private String gmbAccessToken;
+    @Parameter(names = ArgumentNames.BUSINESS_PROFILE_ACCESS_TOKEN, required = true)
+    private String businessProfileAccessToken;
   }
 
   public static void main(String[] args) throws InterruptedException, IOException {
-    AddGoogleMyBusinessLocationExtensionsParams params =
-        new AddGoogleMyBusinessLocationExtensionsParams();
+    AddBusinessProfileLocationExtensionsParams params =
+        new AddBusinessProfileLocationExtensionsParams();
 
     if (!params.parseArguments(args)) {
 
       // Either pass the required parameters for this example on the command line, or insert them
       // into the code here. See the parameter class definition above for descriptions.
       params.customerId = Long.parseLong("INSERT_CUSTOMER_ID_HERE");
-      params.gmbEmailAddress = "INSERT_GMB_EMAIL_ADDRESS_HERE";
+      params.businessProfileEmailAddress = "INSERT_BUSINESS_PROFILE_EMAIL_ADDRESS_HERE";
       params.businessAccountIdentifier = "INSERT_BUSINESS_ACCOUNT_IDENTIFIER_HERE";
-      params.gmbAccessToken = "INSERT_GMB_ACCESS_TOKEN_HERE";
+      params.businessProfileAccessToken = "INSERT_BUSINESS_PROFILE_ACCESS_TOKEN_HERE";
     }
 
     GoogleAdsClient googleAdsClient = null;
@@ -95,13 +95,13 @@ public static void main(String[] args) throws InterruptedException, IOException
     }
 
     try {
-      new AddGoogleMyBusinessLocationExtensions()
+      new AddBusinessProfileLocationExtensions()
           .runExample(
               googleAdsClient,
               params.customerId,
-              params.gmbEmailAddress,
+              params.businessProfileEmailAddress,
               params.businessAccountIdentifier,
-              params.gmbAccessToken);
+              params.businessProfileAccessToken);
     } catch (GoogleAdsException gae) {
       // GoogleAdsException is the base class for most exceptions thrown by an API request.
       // Instances of this exception have a message and a GoogleAdsFailure that contains a
@@ -123,61 +123,62 @@ public static void main(String[] args) throws InterruptedException, IOException
    *
    * @param googleAdsClient the Google Ads API client.
    * @param customerId the client customer ID.
-   * @param gmbEmailAddress email address associated with the GMB account.
-   * @param businessAccountIdentifier the account number of the GMB account (optional).
-   * @param gmbAccessToken the access token created using the 'AdWords' scope and the client ID and
-   *     client secret of with the Cloud project associated with the GMB account.
+   * @param businessProfileEmailAddress email address associated with the Business Profile account.
+   * @param businessAccountIdentifier the account number of the Business Profile account (optional).
+   * @param businessProfileAccessToken the access token created using the 'AdWords' scope and the
+   *     client ID and client secret of with the Cloud project associated with the Business Profile
+   *     account.
    * @throws GoogleAdsException if an API request failed with one or more service errors.
    * @throws InterruptedException if the Thread.sleep operation is interrupted.
    */
   private void runExample(
       GoogleAdsClient googleAdsClient,
       long customerId,
-      String gmbEmailAddress,
+      String businessProfileEmailAddress,
       String businessAccountIdentifier,
-      String gmbAccessToken)
+      String businessProfileAccessToken)
       throws InterruptedException {
-    // Creates a PlacesLocationFeedData object to identify the Google My Business account, specify
+    // Creates a PlacesLocationFeedData object to identify the Business Profile account, specify
     // location filters, and provide authorization for Google Ads to retrieve locations from the
-    // account on behalf of the user identified by gmbEmailAddress.
+    // account on behalf of the user identified by businessProfileEmailAddress.
     PlacesLocationFeedData.Builder placesLocationFeedData =
         PlacesLocationFeedData.newBuilder()
-            .setEmailAddress(gmbEmailAddress)
-            // Used to filter Google My Business listings by labels. If entries exist in
+            .setEmailAddress(businessProfileEmailAddress)
+            // Used to filter Business Profile listings by labels. If entries exist in
             // label_filters, only listings that have at least one of the labels set are
             // candidates to be synchronized into FeedItems. If no entries exist in
             // label_filters, then all listings are candidates for syncing.
             .addLabelFilters("Stores in New York")
-            // Sets the authentication info to be able to connect Google Ads to the GMB
+            // Sets the authentication info to be able to connect Google Ads to the Business Profile
             // account.
             .setOauthInfo(
                 OAuthInfo.newBuilder()
                     .setHttpMethod("GET")
                     .setHttpRequestUrl(GOOGLE_ADS_SCOPE)
-                    .setHttpAuthorizationHeader("Bearer " + gmbAccessToken)
+                    .setHttpAuthorizationHeader("Bearer " + businessProfileAccessToken)
                     .build());
 
     if (businessAccountIdentifier != null) {
       placesLocationFeedData.setBusinessAccountId(businessAccountIdentifier);
     }
 
-    // [START add_google_my_business_location_extensions]
-    // Creates a feed that will sync to the Google My Business account. Do not add FeedAttributes to
+    // [START add_business_profile_location_extensions]
+    // Creates a feed that will sync to the Business Profile account. Do not add FeedAttributes to
     // this object as Google Ads will add them automatically because this will be a system generated
     // feed.
-    Feed.Builder gmbFeed =
+    Feed.Builder businessProfileFeed =
         Feed.newBuilder()
-            .setName("Google My Business feed #" + getPrintableDateTime())
-            // Configures the location feed populated from Google My Business Locations.
+            .setName("Business Profile feed #" + getPrintableDateTime())
+            // Configures the location feed populated from Business Profile Locations.
             .setPlacesLocationFeedData(placesLocationFeedData)
             // Since this feed's feed items will be managed by Google,
             // you must set its origin to GOOGLE.
             .setOrigin(FeedOrigin.GOOGLE);
 
-    FeedOperation operation = FeedOperation.newBuilder().setCreate(gmbFeed).build();
-    // [END add_google_my_business_location_extensions]
+    FeedOperation operation = FeedOperation.newBuilder().setCreate(businessProfileFeed).build();
+    // [END add_business_profile_location_extensions]
 
-    // [START add_google_my_business_location_extensions_1]
+    // [START add_business_profile_location_extensions_1]
     try (FeedServiceClient feedServiceClient =
         googleAdsClient.getLatestVersion().createFeedServiceClient()) {
       // Adds the feed. Since it is a system generated feed, Google Ads will automatically:
@@ -186,16 +187,18 @@ private void runExample(
       // with the placeholder fields of the LOCATION placeholder type.
       MutateFeedsResponse response =
           feedServiceClient.mutateFeeds(Long.toString(customerId), ImmutableList.of(operation));
-      String gmbFeedResourceName = response.getResults(0).getResourceName();
-      System.out.printf("GMB feed created with resource name: %s%n", gmbFeedResourceName);
-      // [END add_google_my_business_location_extensions_1]
+      String businessProfileFeedResourceName = response.getResults(0).getResourceName();
+      System.out.printf(
+          "Business Profile feed created with resource name: %s%n",
+          businessProfileFeedResourceName);
+      // [END add_business_profile_location_extensions_1]
 
-      // [START add_google_my_business_location_extensions_2]
+      // [START add_business_profile_location_extensions_2]
       // Adds a CustomerFeed that associates the feed with this customer for
       // the LOCATION placeholder type.
       CustomerFeed customerFeed =
           CustomerFeed.newBuilder()
-              .setFeed(gmbFeedResourceName)
+              .setFeed(businessProfileFeedResourceName)
               .addPlaceholderTypes(PlaceholderType.LOCATION)
               // Creates a matching function that will always evaluate to true.
               .setMatchingFunction(
@@ -212,14 +215,15 @@ private void runExample(
 
       CustomerFeedOperation customerFeedOperation =
           CustomerFeedOperation.newBuilder().setCreate(customerFeed).build();
-      // [END add_google_my_business_location_extensions_2]
+      // [END add_business_profile_location_extensions_2]
 
-      // [START add_google_my_business_location_extensions_3]
+      // [START add_business_profile_location_extensions_3]
       try (CustomerFeedServiceClient customerFeedServiceClient =
           googleAdsClient.getLatestVersion().createCustomerFeedServiceClient()) {
 
         // After the completion of the Feed ADD operation above the added feed will not be available
-        // for usage in a CustomerFeed until the sync between the Google Ads and GMB accounts
+        // for usage in a CustomerFeed until the sync between the Google Ads and Business Profile
+        // accounts
         // completes. The loop below will retry adding the CustomerFeed up to ten times with an
         // exponential back-off policy.
         String addedCustomerFeed = null;
@@ -249,7 +253,7 @@ private void runExample(
             Thread.sleep(sleepSeconds * 1000);
           }
         } while (numberOfAttempts < MAX_CUSTOMER_FEED_ADD_ATTEMPTS && addedCustomerFeed == null);
-        // [END add_google_my_business_location_extensions_3]
+        // [END add_business_profile_location_extensions_3]
 
         if (addedCustomerFeed == null) {
           throw new RuntimeException(
diff --git a/google-ads-examples/src/main/java/com/google/ads/googleads/examples/utils/ArgumentNames.java b/google-ads-examples/src/main/java/com/google/ads/googleads/examples/utils/ArgumentNames.java
@@ -71,8 +71,8 @@ public final class ArgumentNames {
   public static final String FREEFORM_KEYWORD_TEXT = "--freeformKeywordText";
   public static final String GCLID = "--gclid";
   public static final String GEO_TARGET_CONSTANT_ID = "--geoTargetConstantId";
-  public static final String GMB_ACCESS_TOKEN = "--gmbAccessToken";
-  public static final String GMB_EMAIL_ADDRESS = "--gmbEmailAddress";
+  public static final String BUSINESS_PROFILE_ACCESS_TOKEN = "--businessProfileAccessToken";
+  public static final String BUSINESS_PROFILE_EMAIL_ADDRESS = "--businessProfileEmailAddress";
   public static final String HOTEL_CENTER_ACCOUNT_ID = "--hotelCenterAccountId";
   public static final String IMAGE_ASSET_ID = "--imageAssetId";
   public static final String ITEM_ID = "--itemId";
