Package com.google.ads.googleads.v14.services

Class ProductLinkServiceClient

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

    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 (ProductLinkServiceClient productLinkServiceClient = ProductLinkServiceClient.create()) {
   String customerId = "customerId-1581184615";
   ProductLink productLink = ProductLink.newBuilder().build();
   CreateProductLinkResponse response =
       productLinkServiceClient.createProductLink(customerId, productLink);
 }

    Note: close() needs to be called on the ProductLinkServiceClient 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

    CreateProductLink

    Creates a product link.

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

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

    • createProductLink(CreateProductLinkRequest request)

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

    • createProductLink(String customerId, ProductLink productLink)

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

    • createProductLinkCallable()

    RemoveProductLink

    Removes a product link.

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

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

    • removeProductLink(RemoveProductLinkRequest request)

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

    • removeProductLink(String customerId, ProductLinkName resourceName)

    • removeProductLink(String customerId, String resourceName)

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

    • removeProductLinkCallable()

    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 ProductLinkServiceSettings 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
 ProductLinkServiceSettings productLinkServiceSettings =
     ProductLinkServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ProductLinkServiceClient productLinkServiceClient =
     ProductLinkServiceClient.create(productLinkServiceSettings);

    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
 ProductLinkServiceSettings productLinkServiceSettings =
     ProductLinkServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ProductLinkServiceClient productLinkServiceClient =
     ProductLinkServiceClient.create(productLinkServiceSettings);

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

    • Constructor Detail

      • ProductLinkServiceClient

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

    • Method Detail

      • create

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

      • create

        public static final ProductLinkServiceClient create​(ProductLinkServiceSettings settings)
                                             throws java.io.IOException
        Constructs an instance of ProductLinkServiceClient, 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

        public static final ProductLinkServiceClient create​(ProductLinkServiceStub stub)
        Constructs an instance of ProductLinkServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ProductLinkServiceSettings).

      • createProductLink

        public final CreateProductLinkResponse createProductLink​(java.lang.String customerId,
                                                         ProductLink productLink)
        Creates a product link.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [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 (ProductLinkServiceClient productLinkServiceClient = ProductLinkServiceClient.create()) {
   String customerId = "customerId-1581184615";
   ProductLink productLink = ProductLink.newBuilder().build();
   CreateProductLinkResponse response =
       productLinkServiceClient.createProductLink(customerId, productLink);
 }
        Parameters:
        customerId - Required. The ID of the customer for which the product link is created.
        productLink - Required. The product link to be created.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createProductLink

        public final CreateProductLinkResponse createProductLink​(CreateProductLinkRequest request)
        Creates a product link.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [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 (ProductLinkServiceClient productLinkServiceClient = ProductLinkServiceClient.create()) {
   CreateProductLinkRequest request =
       CreateProductLinkRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setProductLink(ProductLink.newBuilder().build())
           .build();
   CreateProductLinkResponse response = productLinkServiceClient.createProductLink(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

      • createProductLinkCallable

        public final com.google.api.gax.rpc.UnaryCallable<CreateProductLinkRequest,​CreateProductLinkResponse> createProductLinkCallable()
        Creates a product link.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [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 (ProductLinkServiceClient productLinkServiceClient = ProductLinkServiceClient.create()) {
   CreateProductLinkRequest request =
       CreateProductLinkRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setProductLink(ProductLink.newBuilder().build())
           .build();
   ApiFuture<CreateProductLinkResponse> future =
       productLinkServiceClient.createProductLinkCallable().futureCall(request);
   // Do something.
   CreateProductLinkResponse response = future.get();
 }

      • removeProductLink

        public final RemoveProductLinkResponse removeProductLink​(java.lang.String customerId,
                                                         ProductLinkName resourceName)
        Removes a product link.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldMaskError]() [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 (ProductLinkServiceClient productLinkServiceClient = ProductLinkServiceClient.create()) {
   String customerId = "customerId-1581184615";
   ProductLinkName resourceName = ProductLinkName.of("[CUSTOMER_ID]", "[PRODUCT_LINK_ID]");
   RemoveProductLinkResponse response =
       productLinkServiceClient.removeProductLink(customerId, resourceName);
 }
        Parameters:
        customerId - Required. The ID of the customer being modified.
        resourceName - Required. Remove operation: A resource name for the product link to remove is expected, in this format:

        `customers/{customer_id}/productLinks/{product_link_id} `

        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • removeProductLink

        public final RemoveProductLinkResponse removeProductLink​(java.lang.String customerId,
                                                         java.lang.String resourceName)
        Removes a product link.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldMaskError]() [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 (ProductLinkServiceClient productLinkServiceClient = ProductLinkServiceClient.create()) {
   String customerId = "customerId-1581184615";
   String resourceName = ProductLinkName.of("[CUSTOMER_ID]", "[PRODUCT_LINK_ID]").toString();
   RemoveProductLinkResponse response =
       productLinkServiceClient.removeProductLink(customerId, resourceName);
 }
        Parameters:
        customerId - Required. The ID of the customer being modified.
        resourceName - Required. Remove operation: A resource name for the product link to remove is expected, in this format:

        `customers/{customer_id}/productLinks/{product_link_id} `

        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • removeProductLink

        public final RemoveProductLinkResponse removeProductLink​(RemoveProductLinkRequest request)
        Removes a product link.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldMaskError]() [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 (ProductLinkServiceClient productLinkServiceClient = ProductLinkServiceClient.create()) {
   RemoveProductLinkRequest request =
       RemoveProductLinkRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setResourceName(ProductLinkName.of("[CUSTOMER_ID]", "[PRODUCT_LINK_ID]").toString())
           .setValidateOnly(true)
           .build();
   RemoveProductLinkResponse response = productLinkServiceClient.removeProductLink(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

      • removeProductLinkCallable

        public final com.google.api.gax.rpc.UnaryCallable<RemoveProductLinkRequest,​RemoveProductLinkResponse> removeProductLinkCallable()
        Removes a product link.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldMaskError]() [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 (ProductLinkServiceClient productLinkServiceClient = ProductLinkServiceClient.create()) {
   RemoveProductLinkRequest request =
       RemoveProductLinkRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setResourceName(ProductLinkName.of("[CUSTOMER_ID]", "[PRODUCT_LINK_ID]").toString())
           .setValidateOnly(true)
           .build();
   ApiFuture<RemoveProductLinkResponse> future =
       productLinkServiceClient.removeProductLinkCallable().futureCall(request);
   // Do something.
   RemoveProductLinkResponse 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