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

Class AccountLinkServiceClient

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

    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 (AccountLinkServiceClient accountLinkServiceClient = AccountLinkServiceClient.create()) {
   String customerId = "customerId-1581184615";
   AccountLink accountLink = AccountLink.newBuilder().build();
   CreateAccountLinkResponse response =
       accountLinkServiceClient.createAccountLink(customerId, accountLink);
 }

    Note: close() needs to be called on the AccountLinkServiceClient 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 AccountLinkServiceSettings to create(). For example:

    To customize credentials: 

    
 AccountLinkServiceSettings accountLinkServiceSettings =
     AccountLinkServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AccountLinkServiceClient accountLinkServiceClient =
     AccountLinkServiceClient.create(accountLinkServiceSettings);

    To customize the endpoint: 

    
 AccountLinkServiceSettings accountLinkServiceSettings =
     AccountLinkServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AccountLinkServiceClient accountLinkServiceClient =
     AccountLinkServiceClient.create(accountLinkServiceSettings);

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

    • Constructor Detail

      • AccountLinkServiceClient

        protected AccountLinkServiceClient​(AccountLinkServiceSettings settings)
                            throws java.io.IOException
        Constructs an instance of AccountLinkServiceClient, 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

      • AccountLinkServiceClient

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

    • Method Detail

      • create

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

      • create

        public static final AccountLinkServiceClient create​(AccountLinkServiceSettings settings)
                                             throws java.io.IOException
        Constructs an instance of AccountLinkServiceClient, 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 AccountLinkServiceClient create​(AccountLinkServiceStub stub)
        Constructs an instance of AccountLinkServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(AccountLinkServiceSettings).

      • getStub

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

      • createAccountLink

        public final CreateAccountLinkResponse createAccountLink​(java.lang.String customerId,
                                                         AccountLink accountLink)
        Creates an account link.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]() [ThirdPartyAppAnalyticsLinkError]()

        Sample code: 

        
 try (AccountLinkServiceClient accountLinkServiceClient = AccountLinkServiceClient.create()) {
   String customerId = "customerId-1581184615";
   AccountLink accountLink = AccountLink.newBuilder().build();
   CreateAccountLinkResponse response =
       accountLinkServiceClient.createAccountLink(customerId, accountLink);
 }
        Parameters:
        customerId - Required. The ID of the customer for which the account link is created.
        accountLink - Required. The account link to be created.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createAccountLink

        public final CreateAccountLinkResponse createAccountLink​(CreateAccountLinkRequest request)
        Creates an account link.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]() [ThirdPartyAppAnalyticsLinkError]()

        Sample code: 

        
 try (AccountLinkServiceClient accountLinkServiceClient = AccountLinkServiceClient.create()) {
   CreateAccountLinkRequest request =
       CreateAccountLinkRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setAccountLink(AccountLink.newBuilder().build())
           .build();
   CreateAccountLinkResponse response = accountLinkServiceClient.createAccountLink(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

      • createAccountLinkCallable

        public final com.google.api.gax.rpc.UnaryCallable<CreateAccountLinkRequest,​CreateAccountLinkResponse> createAccountLinkCallable()
        Creates an account link.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]() [ThirdPartyAppAnalyticsLinkError]()

        Sample code: 

        
 try (AccountLinkServiceClient accountLinkServiceClient = AccountLinkServiceClient.create()) {
   CreateAccountLinkRequest request =
       CreateAccountLinkRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setAccountLink(AccountLink.newBuilder().build())
           .build();
   ApiFuture<CreateAccountLinkResponse> future =
       accountLinkServiceClient.createAccountLinkCallable().futureCall(request);
   // Do something.
   CreateAccountLinkResponse response = future.get();
 }

      • mutateAccountLink

        public final MutateAccountLinkResponse mutateAccountLink​(java.lang.String customerId,
                                                         AccountLinkOperation operation)
        Creates or removes an account link. From V5, create is not supported through AccountLinkService.MutateAccountLink. Please use AccountLinkService.CreateAccountLink instead.

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

        Sample code: 

        
 try (AccountLinkServiceClient accountLinkServiceClient = AccountLinkServiceClient.create()) {
   String customerId = "customerId-1581184615";
   AccountLinkOperation operation = AccountLinkOperation.newBuilder().build();
   MutateAccountLinkResponse response =
       accountLinkServiceClient.mutateAccountLink(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

      • mutateAccountLink

        public final MutateAccountLinkResponse mutateAccountLink​(MutateAccountLinkRequest request)
        Creates or removes an account link. From V5, create is not supported through AccountLinkService.MutateAccountLink. Please use AccountLinkService.CreateAccountLink instead.

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

        Sample code: 

        
 try (AccountLinkServiceClient accountLinkServiceClient = AccountLinkServiceClient.create()) {
   MutateAccountLinkRequest request =
       MutateAccountLinkRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setOperation(AccountLinkOperation.newBuilder().build())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   MutateAccountLinkResponse response = accountLinkServiceClient.mutateAccountLink(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

      • mutateAccountLinkCallable

        public final com.google.api.gax.rpc.UnaryCallable<MutateAccountLinkRequest,​MutateAccountLinkResponse> mutateAccountLinkCallable()
        Creates or removes an account link. From V5, create is not supported through AccountLinkService.MutateAccountLink. Please use AccountLinkService.CreateAccountLink instead.

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

        Sample code: 

        
 try (AccountLinkServiceClient accountLinkServiceClient = AccountLinkServiceClient.create()) {
   MutateAccountLinkRequest request =
       MutateAccountLinkRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setOperation(AccountLinkOperation.newBuilder().build())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateAccountLinkResponse> future =
       accountLinkServiceClient.mutateAccountLinkCallable().futureCall(request);
   // Do something.
   MutateAccountLinkResponse 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