RejectMerchantCenterLink.java

// Copyright 2020 Google LLC
//
// 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
//
//     https://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 com.google.ads.googleads.examples.accountmanagement;

import com.beust.jcommander.Parameter;
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.v14.errors.GoogleAdsError;
import com.google.ads.googleads.v14.errors.GoogleAdsException;
import com.google.ads.googleads.v14.resources.MerchantCenterLink;
import com.google.ads.googleads.v14.services.ListMerchantCenterLinksRequest;
import com.google.ads.googleads.v14.services.ListMerchantCenterLinksResponse;
import com.google.ads.googleads.v14.services.MerchantCenterLinkOperation;
import com.google.ads.googleads.v14.services.MerchantCenterLinkServiceClient;
import com.google.ads.googleads.v14.services.MutateMerchantCenterLinkResponse;
import com.google.ads.googleads.v14.services.MutateMerchantCenterLinkResult;
import java.io.FileNotFoundException;
import java.io.IOException;

/**
 * Demonstrates how to reject a Merchant Center link request.
 *
 * <p>Prerequisite: You need to have access to a Merchant Center account. You can find instructions
 * to create a Merchant Center account here: https://support.google.com/merchants/answer/188924.
 *
 * <p>To run this example, you must use the Merchant Center UI or the Content API for Shopping to
 * send a link request between your Merchant Center and Google Ads accounts.
 *
 * <p>This code example uses version v14 of the Google Ads API. Version v15 of the Google Ads API
 * replaces MerchantCenterLinkService with ProductLinkInvitationService and ProductLinkService. We
 * will add new code examples using these services shortly.
 */
public class RejectMerchantCenterLink {

  private static class RejectMerchantCenterLinkParams extends CodeSampleParams {

    @Parameter(names = ArgumentNames.CUSTOMER_ID, required = true)
    private Long customerId;

    @Parameter(names = ArgumentNames.MERCHANT_CENTER_ACCOUNT_ID, required = true)
    private Long merchantCenterAccountId;
  }

  public static void main(String[] args) {
    RejectMerchantCenterLinkParams params = new RejectMerchantCenterLinkParams();
    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.merchantCenterAccountId = Long.parseLong("INSERT_MERCHANT_CENTER_ACCOUNT_ID_HERE");
    }

    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);
      System.exit(1);
    } catch (IOException ioe) {
      System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
      System.exit(1);
    }

    try {
      new RejectMerchantCenterLink()
          .runExample(googleAdsClient, params.customerId, params.merchantCenterAccountId);
    } 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
      // collection of GoogleAdsErrors that indicate the underlying causes of the
      // GoogleAdsException.
      System.err.printf(
          "Request ID %s failed due to GoogleAdsException. Underlying errors:%n",
          gae.getRequestId());
      int i = 0;
      for (GoogleAdsError googleAdsError : gae.getGoogleAdsFailure().getErrorsList()) {
        System.err.printf("  Error %d: %s%n", i++, googleAdsError);
      }
      System.exit(1);
    }
  }

  /**
   * Runs the example.
   *
   * @param googleAdsClient the Google Ads API client.
   * @param customerId the client customer ID of the Google Ads account to reject the link request.
   * @param merchantCenterAccountId the Merchant Center account ID for the account requesting to
   *     link.
   * @throws GoogleAdsException if an API request failed with one or more service errors.
   */
  private void runExample(
      GoogleAdsClient googleAdsClient, long customerId, long merchantCenterAccountId) {

    // Rejects a pending link request or unlinks an enabled link for a Google Ads account with
    // customerId from a Merchant Center account with merchantCenterAccountId.
    try (MerchantCenterLinkServiceClient merchantCenterLinkService =
        googleAdsClient.getVersion14().createMerchantCenterLinkServiceClient()) {
      ListMerchantCenterLinksResponse response =
          merchantCenterLinkService.listMerchantCenterLinks(
              ListMerchantCenterLinksRequest.newBuilder()
                  .setCustomerId(Long.toString(customerId))
                  .build());

      System.out.printf(
          "%d Merchant Center link(s) found with the following details:%n",
          response.getMerchantCenterLinksCount());

      for (MerchantCenterLink merchantCenterLink : response.getMerchantCenterLinksList()) {
        System.out.printf(
            "Link '%s' has status '%s'.%n",
            merchantCenterLink.getResourceName(), merchantCenterLink.getStatus());

        // Checks if there is a link for the Merchant Center account we are looking for.
        if (merchantCenterAccountId == merchantCenterLink.getId()) {
          // If the Merchant Center link is pending, reject it by removing the link.
          // If the Merchant Center link is enabled, unlink Merchant Center from Google Ads by
          // removing the link.
          // In both cases, the remove action is the same.
          removeMerchantCenterLink(merchantCenterLinkService, customerId, merchantCenterLink);
          // There is only one MerchantCenterLink object for a given Google Ads account and Merchant
          // Center account, so we can break early.
          break;
        }
      }
    }
  }

  /**
   * Removes a Merchant Center link from a Google Ads client customer account.
   *
   * @param merchantCenterLinkServiceClient the MerchantCenterLinkService client.
   * @param customerId the client customer ID of the Google Ads account that has the link request.
   * @param merchantCenterLink the MerchantCenterLink object to remove.
   * @throws GoogleAdsException if an API request failed with one or more service errors.
   */
  // [START reject_merchant_center_link]
  private void removeMerchantCenterLink(
      MerchantCenterLinkServiceClient merchantCenterLinkServiceClient,
      long customerId,
      MerchantCenterLink merchantCenterLink) {
    // Creates a single remove operation, specifying the Merchant Center link resource name.
    MerchantCenterLinkOperation operation =
        MerchantCenterLinkOperation.newBuilder()
            .setRemove(merchantCenterLink.getResourceName())
            .build();

    // Sends the operation in a mutate request.
    MutateMerchantCenterLinkResponse response =
        merchantCenterLinkServiceClient.mutateMerchantCenterLink(
            Long.toString(customerId), operation);
    MutateMerchantCenterLinkResult result = response.getResult();
    System.out.printf(
        "Removed Merchant Center link with resource name: '%s'.%n", result.getResourceName());
  }
  // [END reject_merchant_center_link]
}