Package com.google.ads.googleads.v18.services

Class DataLinkServiceClient

java.lang.Object
com.google.ads.googleads.v18.services.DataLinkServiceClient
All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class DataLinkServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: This service allows management of data links between a Google Ads customer and another data entity.

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: 


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLinkServiceClient dataLinkServiceClient = DataLinkServiceClient.create()) {
   String customerId = "customerId-1581184615";
   DataLink dataLink = DataLink.newBuilder().build();
   CreateDataLinkResponse response = dataLinkServiceClient.createDataLink(customerId, dataLink);
 }

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

Methods
Method Description Method Variants

CreateDataLink

Creates a data link. The requesting Google Ads account name and account ID will be shared with the third party (such as YouTube creators for video links) to whom you are creating the link with. Only customers on the allow-list can create data links.

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createDataLink(CreateDataLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createDataLink(String customerId, DataLink dataLink)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createDataLinkCallable()

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 DataLinkServiceSettings to create(). For example:

To customize credentials: 


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DataLinkServiceSettings dataLinkServiceSettings =
     DataLinkServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DataLinkServiceClient dataLinkServiceClient =
     DataLinkServiceClient.create(dataLinkServiceSettings);

To customize the endpoint: 


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DataLinkServiceSettings dataLinkServiceSettings =
     DataLinkServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DataLinkServiceClient dataLinkServiceClient =
     DataLinkServiceClient.create(dataLinkServiceSettings);

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

  • Constructor Details

    • DataLinkServiceClient

      protected DataLinkServiceClient(DataLinkServiceSettings settings) throws IOException
      Constructs an instance of DataLinkServiceClient, 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:
      IOException

    • DataLinkServiceClient

      protected DataLinkServiceClient(DataLinkServiceStub stub)

  • Method Details

    • create

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

    • create

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

    • create

      public static final DataLinkServiceClient create(DataLinkServiceStub stub)
      Constructs an instance of DataLinkServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(DataLinkServiceSettings).

    • getSettings

      public final DataLinkServiceSettings getSettings()

    • getStub

      public DataLinkServiceStub getStub()

    • createDataLink

      public final CreateDataLinkResponse createDataLink(String customerId, DataLink dataLink)
      Creates a data link. The requesting Google Ads account name and account ID will be shared with the third party (such as YouTube creators for video links) to whom you are creating the link with. Only customers on the allow-list can create data links.

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

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLinkServiceClient dataLinkServiceClient = DataLinkServiceClient.create()) {
   String customerId = "customerId-1581184615";
   DataLink dataLink = DataLink.newBuilder().build();
   CreateDataLinkResponse response = dataLinkServiceClient.createDataLink(customerId, dataLink);
 }
      Parameters:
      customerId - Required. The ID of the customer for which the data link is created.
      dataLink - Required. The data link to be created.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • createDataLink

      public final CreateDataLinkResponse createDataLink(CreateDataLinkRequest request)
      Creates a data link. The requesting Google Ads account name and account ID will be shared with the third party (such as YouTube creators for video links) to whom you are creating the link with. Only customers on the allow-list can create data links.

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

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLinkServiceClient dataLinkServiceClient = DataLinkServiceClient.create()) {
   CreateDataLinkRequest request =
       CreateDataLinkRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setDataLink(DataLink.newBuilder().build())
           .build();
   CreateDataLinkResponse response = dataLinkServiceClient.createDataLink(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

    • createDataLinkCallable

      public final com.google.api.gax.rpc.UnaryCallable<CreateDataLinkRequest,CreateDataLinkResponse> createDataLinkCallable()
      Creates a data link. The requesting Google Ads account name and account ID will be shared with the third party (such as YouTube creators for video links) to whom you are creating the link with. Only customers on the allow-list can create data links.

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

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLinkServiceClient dataLinkServiceClient = DataLinkServiceClient.create()) {
   CreateDataLinkRequest request =
       CreateDataLinkRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setDataLink(DataLink.newBuilder().build())
           .build();
   ApiFuture<CreateDataLinkResponse> future =
       dataLinkServiceClient.createDataLinkCallable().futureCall(request);
   // Do something.
   CreateDataLinkResponse response = future.get();
 }

    • close

      public final void close()
      Specified by:
      close in interface 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, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface com.google.api.gax.core.BackgroundResource
      Throws:
      InterruptedException