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

Class CustomerSkAdNetworkConversionValueSchemaServiceClient

java.lang.Object
com.google.ads.googleads.v18.services.CustomerSkAdNetworkConversionValueSchemaServiceClient
All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class CustomerSkAdNetworkConversionValueSchemaServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: Service to manage CustomerSkAdNetworkConversionValueSchema.

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 (CustomerSkAdNetworkConversionValueSchemaServiceClient
     customerSkAdNetworkConversionValueSchemaServiceClient =
         CustomerSkAdNetworkConversionValueSchemaServiceClient.create()) {
   MutateCustomerSkAdNetworkConversionValueSchemaRequest request =
       MutateCustomerSkAdNetworkConversionValueSchemaRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setOperation(CustomerSkAdNetworkConversionValueSchemaOperation.newBuilder().build())
           .setValidateOnly(true)
           .setEnableWarnings(true)
           .build();
   MutateCustomerSkAdNetworkConversionValueSchemaResponse response =
       customerSkAdNetworkConversionValueSchemaServiceClient
           .mutateCustomerSkAdNetworkConversionValueSchema(request);
 }

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

MutateCustomerSkAdNetworkConversionValueSchema

Creates or updates the CustomerSkAdNetworkConversionValueSchema.

List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [InternalError]() [MutateError]()

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

  • mutateCustomerSkAdNetworkConversionValueSchema(MutateCustomerSkAdNetworkConversionValueSchemaRequest request)

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

  • mutateCustomerSkAdNetworkConversionValueSchemaCallable()

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 CustomerSkAdNetworkConversionValueSchemaServiceSettings 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
 CustomerSkAdNetworkConversionValueSchemaServiceSettings
     customerSkAdNetworkConversionValueSchemaServiceSettings =
         CustomerSkAdNetworkConversionValueSchemaServiceSettings.newBuilder()
             .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
             .build();
 CustomerSkAdNetworkConversionValueSchemaServiceClient
     customerSkAdNetworkConversionValueSchemaServiceClient =
         CustomerSkAdNetworkConversionValueSchemaServiceClient.create(
             customerSkAdNetworkConversionValueSchemaServiceSettings);

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
 CustomerSkAdNetworkConversionValueSchemaServiceSettings
     customerSkAdNetworkConversionValueSchemaServiceSettings =
         CustomerSkAdNetworkConversionValueSchemaServiceSettings.newBuilder()
             .setEndpoint(myEndpoint)
             .build();
 CustomerSkAdNetworkConversionValueSchemaServiceClient
     customerSkAdNetworkConversionValueSchemaServiceClient =
         CustomerSkAdNetworkConversionValueSchemaServiceClient.create(
             customerSkAdNetworkConversionValueSchemaServiceSettings);

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

  • Constructor Details

  • Method Details

    • create

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

    • create

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

    • getSettings

      public final CustomerSkAdNetworkConversionValueSchemaServiceSettings getSettings()

    • getStub

      public CustomerSkAdNetworkConversionValueSchemaServiceStub getStub()

    • mutateCustomerSkAdNetworkConversionValueSchema

      public final MutateCustomerSkAdNetworkConversionValueSchemaResponse mutateCustomerSkAdNetworkConversionValueSchema(MutateCustomerSkAdNetworkConversionValueSchemaRequest request)
      Creates or updates the CustomerSkAdNetworkConversionValueSchema.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [InternalError]() [MutateError]()

      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 (CustomerSkAdNetworkConversionValueSchemaServiceClient
     customerSkAdNetworkConversionValueSchemaServiceClient =
         CustomerSkAdNetworkConversionValueSchemaServiceClient.create()) {
   MutateCustomerSkAdNetworkConversionValueSchemaRequest request =
       MutateCustomerSkAdNetworkConversionValueSchemaRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setOperation(CustomerSkAdNetworkConversionValueSchemaOperation.newBuilder().build())
           .setValidateOnly(true)
           .setEnableWarnings(true)
           .build();
   MutateCustomerSkAdNetworkConversionValueSchemaResponse response =
       customerSkAdNetworkConversionValueSchemaServiceClient
           .mutateCustomerSkAdNetworkConversionValueSchema(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

    • mutateCustomerSkAdNetworkConversionValueSchemaCallable

      public final com.google.api.gax.rpc.UnaryCallable<MutateCustomerSkAdNetworkConversionValueSchemaRequest,MutateCustomerSkAdNetworkConversionValueSchemaResponse> mutateCustomerSkAdNetworkConversionValueSchemaCallable()
      Creates or updates the CustomerSkAdNetworkConversionValueSchema.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [InternalError]() [MutateError]()

      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 (CustomerSkAdNetworkConversionValueSchemaServiceClient
     customerSkAdNetworkConversionValueSchemaServiceClient =
         CustomerSkAdNetworkConversionValueSchemaServiceClient.create()) {
   MutateCustomerSkAdNetworkConversionValueSchemaRequest request =
       MutateCustomerSkAdNetworkConversionValueSchemaRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setOperation(CustomerSkAdNetworkConversionValueSchemaOperation.newBuilder().build())
           .setValidateOnly(true)
           .setEnableWarnings(true)
           .build();
   ApiFuture<MutateCustomerSkAdNetworkConversionValueSchemaResponse> future =
       customerSkAdNetworkConversionValueSchemaServiceClient
           .mutateCustomerSkAdNetworkConversionValueSchemaCallable()
           .futureCall(request);
   // Do something.
   MutateCustomerSkAdNetworkConversionValueSchemaResponse 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