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

Class ProductLinkInvitationServiceClient

java.lang.Object
com.google.ads.googleads.v18.services.ProductLinkInvitationServiceClient
All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class ProductLinkInvitationServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: This service allows management of product link invitations from Google Ads accounts to 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: 


 // 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 (ProductLinkInvitationServiceClient productLinkInvitationServiceClient =
     ProductLinkInvitationServiceClient.create()) {
   String customerId = "customerId-1581184615";
   ProductLinkInvitation productLinkInvitation = ProductLinkInvitation.newBuilder().build();
   CreateProductLinkInvitationResponse response =
       productLinkInvitationServiceClient.createProductLinkInvitation(
           customerId, productLinkInvitation);
 }

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

CreateProductLinkInvitation

Creates a product link invitation.

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

  • createProductLinkInvitation(CreateProductLinkInvitationRequest request)

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

  • createProductLinkInvitation(String customerId, ProductLinkInvitation productLinkInvitation)

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

  • createProductLinkInvitationCallable()

UpdateProductLinkInvitation

Update a product link invitation.

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

  • updateProductLinkInvitation(UpdateProductLinkInvitationRequest request)

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

  • updateProductLinkInvitation(String customerId, ProductLinkInvitationStatusEnum.ProductLinkInvitationStatus productLinkInvitationStatus, ProductLinkInvitationName resourceName)

  • updateProductLinkInvitation(String customerId, ProductLinkInvitationStatusEnum.ProductLinkInvitationStatus productLinkInvitationStatus, 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.

  • updateProductLinkInvitationCallable()

RemoveProductLinkInvitation

Remove a product link invitation.

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

  • removeProductLinkInvitation(RemoveProductLinkInvitationRequest request)

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

  • removeProductLinkInvitation(String customerId, ProductLinkInvitationName resourceName)

  • removeProductLinkInvitation(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.

  • removeProductLinkInvitationCallable()

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 ProductLinkInvitationServiceSettings 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
 ProductLinkInvitationServiceSettings productLinkInvitationServiceSettings =
     ProductLinkInvitationServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ProductLinkInvitationServiceClient productLinkInvitationServiceClient =
     ProductLinkInvitationServiceClient.create(productLinkInvitationServiceSettings);

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
 ProductLinkInvitationServiceSettings productLinkInvitationServiceSettings =
     ProductLinkInvitationServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ProductLinkInvitationServiceClient productLinkInvitationServiceClient =
     ProductLinkInvitationServiceClient.create(productLinkInvitationServiceSettings);

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

  • Constructor Details

    • ProductLinkInvitationServiceClient

      protected ProductLinkInvitationServiceClient(ProductLinkInvitationServiceSettings settings) throws IOException
      Constructs an instance of ProductLinkInvitationServiceClient, 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

    • ProductLinkInvitationServiceClient

      protected ProductLinkInvitationServiceClient(ProductLinkInvitationServiceStub stub)

  • Method Details

    • create

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

    • create

      public static final ProductLinkInvitationServiceClient create(ProductLinkInvitationServiceSettings settings) throws IOException
      Constructs an instance of ProductLinkInvitationServiceClient, 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 ProductLinkInvitationServiceClient create(ProductLinkInvitationServiceStub stub)
      Constructs an instance of ProductLinkInvitationServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ProductLinkInvitationServiceSettings).

    • getSettings

      public final ProductLinkInvitationServiceSettings getSettings()

    • getStub

      public ProductLinkInvitationServiceStub getStub()

    • createProductLinkInvitation

      public final CreateProductLinkInvitationResponse createProductLinkInvitation(String customerId, ProductLinkInvitation productLinkInvitation)
      Creates a product link invitation.

      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 (ProductLinkInvitationServiceClient productLinkInvitationServiceClient =
     ProductLinkInvitationServiceClient.create()) {
   String customerId = "customerId-1581184615";
   ProductLinkInvitation productLinkInvitation = ProductLinkInvitation.newBuilder().build();
   CreateProductLinkInvitationResponse response =
       productLinkInvitationServiceClient.createProductLinkInvitation(
           customerId, productLinkInvitation);
 }
      Parameters:
      customerId - Required. The ID of the customer being modified.
      productLinkInvitation - Required. The product link invitation to be created.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • createProductLinkInvitation

      public final CreateProductLinkInvitationResponse createProductLinkInvitation(CreateProductLinkInvitationRequest request)
      Creates a product link invitation.

      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 (ProductLinkInvitationServiceClient productLinkInvitationServiceClient =
     ProductLinkInvitationServiceClient.create()) {
   CreateProductLinkInvitationRequest request =
       CreateProductLinkInvitationRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setProductLinkInvitation(ProductLinkInvitation.newBuilder().build())
           .build();
   CreateProductLinkInvitationResponse response =
       productLinkInvitationServiceClient.createProductLinkInvitation(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

    • createProductLinkInvitationCallable

      public final com.google.api.gax.rpc.UnaryCallable<CreateProductLinkInvitationRequest,CreateProductLinkInvitationResponse> createProductLinkInvitationCallable()
      Creates a product link invitation.

      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 (ProductLinkInvitationServiceClient productLinkInvitationServiceClient =
     ProductLinkInvitationServiceClient.create()) {
   CreateProductLinkInvitationRequest request =
       CreateProductLinkInvitationRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setProductLinkInvitation(ProductLinkInvitation.newBuilder().build())
           .build();
   ApiFuture<CreateProductLinkInvitationResponse> future =
       productLinkInvitationServiceClient
           .createProductLinkInvitationCallable()
           .futureCall(request);
   // Do something.
   CreateProductLinkInvitationResponse response = future.get();
 }

    • updateProductLinkInvitation

      public final UpdateProductLinkInvitationResponse updateProductLinkInvitation(String customerId, ProductLinkInvitationStatusEnum.ProductLinkInvitationStatus productLinkInvitationStatus, ProductLinkInvitationName resourceName)
      Update a product link invitation.

      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 (ProductLinkInvitationServiceClient productLinkInvitationServiceClient =
     ProductLinkInvitationServiceClient.create()) {
   String customerId = "customerId-1581184615";
   ProductLinkInvitationStatusEnum.ProductLinkInvitationStatus productLinkInvitationStatus =
       ProductLinkInvitationStatusEnum.ProductLinkInvitationStatus.forNumber(0);
   ProductLinkInvitationName resourceName =
       ProductLinkInvitationName.of("[CUSTOMER_ID]", "[CUSTOMER_INVITATION_ID]");
   UpdateProductLinkInvitationResponse response =
       productLinkInvitationServiceClient.updateProductLinkInvitation(
           customerId, productLinkInvitationStatus, resourceName);
 }
      Parameters:
      customerId - Required. The ID of the customer being modified.
      productLinkInvitationStatus - Required. The product link invitation to be created.
      resourceName - Required. Resource name of the product link invitation.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • updateProductLinkInvitation

      public final UpdateProductLinkInvitationResponse updateProductLinkInvitation(String customerId, ProductLinkInvitationStatusEnum.ProductLinkInvitationStatus productLinkInvitationStatus, String resourceName)
      Update a product link invitation.

      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 (ProductLinkInvitationServiceClient productLinkInvitationServiceClient =
     ProductLinkInvitationServiceClient.create()) {
   String customerId = "customerId-1581184615";
   ProductLinkInvitationStatusEnum.ProductLinkInvitationStatus productLinkInvitationStatus =
       ProductLinkInvitationStatusEnum.ProductLinkInvitationStatus.forNumber(0);
   String resourceName =
       ProductLinkInvitationName.of("[CUSTOMER_ID]", "[CUSTOMER_INVITATION_ID]").toString();
   UpdateProductLinkInvitationResponse response =
       productLinkInvitationServiceClient.updateProductLinkInvitation(
           customerId, productLinkInvitationStatus, resourceName);
 }
      Parameters:
      customerId - Required. The ID of the customer being modified.
      productLinkInvitationStatus - Required. The product link invitation to be created.
      resourceName - Required. Resource name of the product link invitation.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • updateProductLinkInvitation

      public final UpdateProductLinkInvitationResponse updateProductLinkInvitation(UpdateProductLinkInvitationRequest request)
      Update a product link invitation.

      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 (ProductLinkInvitationServiceClient productLinkInvitationServiceClient =
     ProductLinkInvitationServiceClient.create()) {
   UpdateProductLinkInvitationRequest request =
       UpdateProductLinkInvitationRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setResourceName(
               ProductLinkInvitationName.of("[CUSTOMER_ID]", "[CUSTOMER_INVITATION_ID]")
                   .toString())
           .build();
   UpdateProductLinkInvitationResponse response =
       productLinkInvitationServiceClient.updateProductLinkInvitation(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

    • updateProductLinkInvitationCallable

      public final com.google.api.gax.rpc.UnaryCallable<UpdateProductLinkInvitationRequest,UpdateProductLinkInvitationResponse> updateProductLinkInvitationCallable()
      Update a product link invitation.

      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 (ProductLinkInvitationServiceClient productLinkInvitationServiceClient =
     ProductLinkInvitationServiceClient.create()) {
   UpdateProductLinkInvitationRequest request =
       UpdateProductLinkInvitationRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setResourceName(
               ProductLinkInvitationName.of("[CUSTOMER_ID]", "[CUSTOMER_INVITATION_ID]")
                   .toString())
           .build();
   ApiFuture<UpdateProductLinkInvitationResponse> future =
       productLinkInvitationServiceClient
           .updateProductLinkInvitationCallable()
           .futureCall(request);
   // Do something.
   UpdateProductLinkInvitationResponse response = future.get();
 }

    • removeProductLinkInvitation

      public final RemoveProductLinkInvitationResponse removeProductLinkInvitation(String customerId, ProductLinkInvitationName resourceName)
      Remove a product link invitation.

      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 (ProductLinkInvitationServiceClient productLinkInvitationServiceClient =
     ProductLinkInvitationServiceClient.create()) {
   String customerId = "customerId-1581184615";
   ProductLinkInvitationName resourceName =
       ProductLinkInvitationName.of("[CUSTOMER_ID]", "[CUSTOMER_INVITATION_ID]");
   RemoveProductLinkInvitationResponse response =
       productLinkInvitationServiceClient.removeProductLinkInvitation(customerId, resourceName);
 }
      Parameters:
      customerId - Required. The ID of the product link invitation being removed.
      resourceName - Required. The resource name of the product link invitation being removed. expected, in this format:

      ` `

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

    • removeProductLinkInvitation

      public final RemoveProductLinkInvitationResponse removeProductLinkInvitation(String customerId, String resourceName)
      Remove a product link invitation.

      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 (ProductLinkInvitationServiceClient productLinkInvitationServiceClient =
     ProductLinkInvitationServiceClient.create()) {
   String customerId = "customerId-1581184615";
   String resourceName =
       ProductLinkInvitationName.of("[CUSTOMER_ID]", "[CUSTOMER_INVITATION_ID]").toString();
   RemoveProductLinkInvitationResponse response =
       productLinkInvitationServiceClient.removeProductLinkInvitation(customerId, resourceName);
 }
      Parameters:
      customerId - Required. The ID of the product link invitation being removed.
      resourceName - Required. The resource name of the product link invitation being removed. expected, in this format:

      ` `

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

    • removeProductLinkInvitation

      public final RemoveProductLinkInvitationResponse removeProductLinkInvitation(RemoveProductLinkInvitationRequest request)
      Remove a product link invitation.

      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 (ProductLinkInvitationServiceClient productLinkInvitationServiceClient =
     ProductLinkInvitationServiceClient.create()) {
   RemoveProductLinkInvitationRequest request =
       RemoveProductLinkInvitationRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setResourceName(
               ProductLinkInvitationName.of("[CUSTOMER_ID]", "[CUSTOMER_INVITATION_ID]")
                   .toString())
           .build();
   RemoveProductLinkInvitationResponse response =
       productLinkInvitationServiceClient.removeProductLinkInvitation(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

    • removeProductLinkInvitationCallable

      public final com.google.api.gax.rpc.UnaryCallable<RemoveProductLinkInvitationRequest,RemoveProductLinkInvitationResponse> removeProductLinkInvitationCallable()
      Remove a product link invitation.

      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 (ProductLinkInvitationServiceClient productLinkInvitationServiceClient =
     ProductLinkInvitationServiceClient.create()) {
   RemoveProductLinkInvitationRequest request =
       RemoveProductLinkInvitationRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setResourceName(
               ProductLinkInvitationName.of("[CUSTOMER_ID]", "[CUSTOMER_INVITATION_ID]")
                   .toString())
           .build();
   ApiFuture<RemoveProductLinkInvitationResponse> future =
       productLinkInvitationServiceClient
           .removeProductLinkInvitationCallable()
           .futureCall(request);
   // Do something.
   RemoveProductLinkInvitationResponse 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