Package com.google.ads.googleads.v10.services

Class MerchantCenterLinkServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, java.lang.AutoCloseable
    @Generated("by gapic-generator-java")
public class MerchantCenterLinkServiceClient
extends java.lang.Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: This service allows management of links between Google Ads and Google Merchant Center.

    This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started: 

    
 try (MerchantCenterLinkServiceClient merchantCenterLinkServiceClient =
     MerchantCenterLinkServiceClient.create()) {
   String customerId = "customerId-1581184615";
   ListMerchantCenterLinksResponse response =
       merchantCenterLinkServiceClient.listMerchantCenterLinks(customerId);
 }

    Note: close() needs to be called on the MerchantCenterLinkServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

    The surface of this class includes several types of Java methods for each of the API's methods:

    1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
    2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
    3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

    See the individual methods for example code.

    Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

    This class can be customized by passing in a custom instance of MerchantCenterLinkServiceSettings to create(). For example:

    To customize credentials: 

    
 MerchantCenterLinkServiceSettings merchantCenterLinkServiceSettings =
     MerchantCenterLinkServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 MerchantCenterLinkServiceClient merchantCenterLinkServiceClient =
     MerchantCenterLinkServiceClient.create(merchantCenterLinkServiceSettings);

    To customize the endpoint: 

    
 MerchantCenterLinkServiceSettings merchantCenterLinkServiceSettings =
     MerchantCenterLinkServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 MerchantCenterLinkServiceClient merchantCenterLinkServiceClient =
     MerchantCenterLinkServiceClient.create(merchantCenterLinkServiceSettings);

    Please refer to the GitHub repository's samples for more quickstart code snippets.

    • Constructor Detail

      • MerchantCenterLinkServiceClient

        protected MerchantCenterLinkServiceClient​(MerchantCenterLinkServiceSettings settings)
                                   throws java.io.IOException
        Constructs an instance of MerchantCenterLinkServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
        Throws:
        java.io.IOException

      • MerchantCenterLinkServiceClient

        @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected MerchantCenterLinkServiceClient​(MerchantCenterLinkServiceStub stub)

    • Method Detail

      • create

        public static final MerchantCenterLinkServiceClient create()
                                                    throws java.io.IOException
        Constructs an instance of MerchantCenterLinkServiceClient with default settings.
        Throws:
        java.io.IOException

      • create

        public static final MerchantCenterLinkServiceClient create​(MerchantCenterLinkServiceSettings settings)
                                                    throws java.io.IOException
        Constructs an instance of MerchantCenterLinkServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
        Throws:
        java.io.IOException

      • create

        @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final MerchantCenterLinkServiceClient create​(MerchantCenterLinkServiceStub stub)
        Constructs an instance of MerchantCenterLinkServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(MerchantCenterLinkServiceSettings).

      • getStub

        @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public MerchantCenterLinkServiceStub getStub()

      • listMerchantCenterLinks

        public final ListMerchantCenterLinksResponse listMerchantCenterLinks​(java.lang.String customerId)
        Returns Merchant Center links available for this customer.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

        Sample code: 

        
 try (MerchantCenterLinkServiceClient merchantCenterLinkServiceClient =
     MerchantCenterLinkServiceClient.create()) {
   String customerId = "customerId-1581184615";
   ListMerchantCenterLinksResponse response =
       merchantCenterLinkServiceClient.listMerchantCenterLinks(customerId);
 }
        Parameters:
        customerId - Required. The ID of the customer onto which to apply the Merchant Center link list operation.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listMerchantCenterLinks

        public final ListMerchantCenterLinksResponse listMerchantCenterLinks​(ListMerchantCenterLinksRequest request)
        Returns Merchant Center links available for this customer.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

        Sample code: 

        
 try (MerchantCenterLinkServiceClient merchantCenterLinkServiceClient =
     MerchantCenterLinkServiceClient.create()) {
   ListMerchantCenterLinksRequest request =
       ListMerchantCenterLinksRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .build();
   ListMerchantCenterLinksResponse response =
       merchantCenterLinkServiceClient.listMerchantCenterLinks(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listMerchantCenterLinksCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListMerchantCenterLinksRequest,​ListMerchantCenterLinksResponse> listMerchantCenterLinksCallable()
        Returns Merchant Center links available for this customer.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

        Sample code: 

        
 try (MerchantCenterLinkServiceClient merchantCenterLinkServiceClient =
     MerchantCenterLinkServiceClient.create()) {
   ListMerchantCenterLinksRequest request =
       ListMerchantCenterLinksRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .build();
   ApiFuture<ListMerchantCenterLinksResponse> future =
       merchantCenterLinkServiceClient.listMerchantCenterLinksCallable().futureCall(request);
   // Do something.
   ListMerchantCenterLinksResponse response = future.get();
 }

      • getMerchantCenterLink

        public final MerchantCenterLink getMerchantCenterLink​(MerchantCenterLinkName resourceName)
        Returns the Merchant Center link in full detail.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

        Sample code: 

        
 try (MerchantCenterLinkServiceClient merchantCenterLinkServiceClient =
     MerchantCenterLinkServiceClient.create()) {
   MerchantCenterLinkName resourceName =
       MerchantCenterLinkName.of("[CUSTOMER_ID]", "[MERCHANT_CENTER_ID]");
   MerchantCenterLink response =
       merchantCenterLinkServiceClient.getMerchantCenterLink(resourceName);
 }
        Parameters:
        resourceName - Required. Resource name of the Merchant Center link.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getMerchantCenterLink

        public final MerchantCenterLink getMerchantCenterLink​(java.lang.String resourceName)
        Returns the Merchant Center link in full detail.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

        Sample code: 

        
 try (MerchantCenterLinkServiceClient merchantCenterLinkServiceClient =
     MerchantCenterLinkServiceClient.create()) {
   String resourceName =
       MerchantCenterLinkName.of("[CUSTOMER_ID]", "[MERCHANT_CENTER_ID]").toString();
   MerchantCenterLink response =
       merchantCenterLinkServiceClient.getMerchantCenterLink(resourceName);
 }
        Parameters:
        resourceName - Required. Resource name of the Merchant Center link.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getMerchantCenterLink

        public final MerchantCenterLink getMerchantCenterLink​(GetMerchantCenterLinkRequest request)
        Returns the Merchant Center link in full detail.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

        Sample code: 

        
 try (MerchantCenterLinkServiceClient merchantCenterLinkServiceClient =
     MerchantCenterLinkServiceClient.create()) {
   GetMerchantCenterLinkRequest request =
       GetMerchantCenterLinkRequest.newBuilder()
           .setResourceName(
               MerchantCenterLinkName.of("[CUSTOMER_ID]", "[MERCHANT_CENTER_ID]").toString())
           .build();
   MerchantCenterLink response = merchantCenterLinkServiceClient.getMerchantCenterLink(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getMerchantCenterLinkCallable

        public final com.google.api.gax.rpc.UnaryCallable<GetMerchantCenterLinkRequest,​MerchantCenterLink> getMerchantCenterLinkCallable()
        Returns the Merchant Center link in full detail.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

        Sample code: 

        
 try (MerchantCenterLinkServiceClient merchantCenterLinkServiceClient =
     MerchantCenterLinkServiceClient.create()) {
   GetMerchantCenterLinkRequest request =
       GetMerchantCenterLinkRequest.newBuilder()
           .setResourceName(
               MerchantCenterLinkName.of("[CUSTOMER_ID]", "[MERCHANT_CENTER_ID]").toString())
           .build();
   ApiFuture<MerchantCenterLink> future =
       merchantCenterLinkServiceClient.getMerchantCenterLinkCallable().futureCall(request);
   // Do something.
   MerchantCenterLink response = future.get();
 }

      • mutateMerchantCenterLink

        public final MutateMerchantCenterLinkResponse mutateMerchantCenterLink​(java.lang.String customerId,
                                                                       MerchantCenterLinkOperation operation)
        Updates status or removes a Merchant Center link.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldMaskError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

        Sample code: 

        
 try (MerchantCenterLinkServiceClient merchantCenterLinkServiceClient =
     MerchantCenterLinkServiceClient.create()) {
   String customerId = "customerId-1581184615";
   MerchantCenterLinkOperation operation = MerchantCenterLinkOperation.newBuilder().build();
   MutateMerchantCenterLinkResponse response =
       merchantCenterLinkServiceClient.mutateMerchantCenterLink(customerId, operation);
 }
        Parameters:
        customerId - Required. The ID of the customer being modified.
        operation - Required. The operation to perform on the link
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • mutateMerchantCenterLink

        public final MutateMerchantCenterLinkResponse mutateMerchantCenterLink​(MutateMerchantCenterLinkRequest request)
        Updates status or removes a Merchant Center link.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldMaskError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

        Sample code: 

        
 try (MerchantCenterLinkServiceClient merchantCenterLinkServiceClient =
     MerchantCenterLinkServiceClient.create()) {
   MutateMerchantCenterLinkRequest request =
       MutateMerchantCenterLinkRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setOperation(MerchantCenterLinkOperation.newBuilder().build())
           .setValidateOnly(true)
           .build();
   MutateMerchantCenterLinkResponse response =
       merchantCenterLinkServiceClient.mutateMerchantCenterLink(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • mutateMerchantCenterLinkCallable

        public final com.google.api.gax.rpc.UnaryCallable<MutateMerchantCenterLinkRequest,​MutateMerchantCenterLinkResponse> mutateMerchantCenterLinkCallable()
        Updates status or removes a Merchant Center link.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldMaskError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

        Sample code: 

        
 try (MerchantCenterLinkServiceClient merchantCenterLinkServiceClient =
     MerchantCenterLinkServiceClient.create()) {
   MutateMerchantCenterLinkRequest request =
       MutateMerchantCenterLinkRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setOperation(MerchantCenterLinkOperation.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateMerchantCenterLinkResponse> future =
       merchantCenterLinkServiceClient.mutateMerchantCenterLinkCallable().futureCall(request);
   // Do something.
   MutateMerchantCenterLinkResponse response = future.get();
 }

      • close

        public final void close()
        Specified by:
        close in interface java.lang.AutoCloseable

      • shutdown

        public void shutdown()
        Specified by:
        shutdown in interface com.google.api.gax.core.BackgroundResource

      • isShutdown

        public boolean isShutdown()
        Specified by:
        isShutdown in interface com.google.api.gax.core.BackgroundResource

      • isTerminated

        public boolean isTerminated()
        Specified by:
        isTerminated in interface com.google.api.gax.core.BackgroundResource

      • shutdownNow

        public void shutdownNow()
        Specified by:
        shutdownNow in interface com.google.api.gax.core.BackgroundResource

      • awaitTermination

        public boolean awaitTermination​(long duration,
                                java.util.concurrent.TimeUnit unit)
                         throws java.lang.InterruptedException
        Specified by:
        awaitTermination in interface com.google.api.gax.core.BackgroundResource
        Throws:
        java.lang.InterruptedException