Package com.google.ads.googleads.v9.services

Class ConversionCustomVariableServiceClient

java.lang.Object

com.google.ads.googleads.v9.services.ConversionCustomVariableServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, java.lang.AutoCloseable

@Generated("by gapic-generator-java")
public class ConversionCustomVariableServiceClient
extends java.lang.Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service to manage conversion custom variables.

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 (ConversionCustomVariableServiceClient conversionCustomVariableServiceClient =
     ConversionCustomVariableServiceClient.create()) {
   ConversionCustomVariableName resourceName =
       ConversionCustomVariableName.of("[CUSTOMER_ID]", "[CONVERSION_CUSTOM_VARIABLE_ID]");
   ConversionCustomVariable response =
       conversionCustomVariableServiceClient.getConversionCustomVariable(resourceName);
 }
 

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

To customize credentials:

 ConversionCustomVariableServiceSettings conversionCustomVariableServiceSettings =
     ConversionCustomVariableServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ConversionCustomVariableServiceClient conversionCustomVariableServiceClient =
     ConversionCustomVariableServiceClient.create(conversionCustomVariableServiceSettings);
 

To customize the endpoint:

 ConversionCustomVariableServiceSettings conversionCustomVariableServiceSettings =
     ConversionCustomVariableServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ConversionCustomVariableServiceClient conversionCustomVariableServiceClient =
     ConversionCustomVariableServiceClient.create(conversionCustomVariableServiceSettings);
 

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConversionCustomVariableServiceClient(ConversionCustomVariableServiceSettings settings)	Constructs an instance of ConversionCustomVariableServiceClient, using the given settings.
protected	ConversionCustomVariableServiceClient(ConversionCustomVariableServiceStub stub)

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long duration, java.util.concurrent.TimeUnit unit)
void	close()
static ConversionCustomVariableServiceClient	create()	Constructs an instance of ConversionCustomVariableServiceClient with default settings.
static ConversionCustomVariableServiceClient	create(ConversionCustomVariableServiceSettings settings)	Constructs an instance of ConversionCustomVariableServiceClient, using the given settings.
static ConversionCustomVariableServiceClient	create(ConversionCustomVariableServiceStub stub)	Constructs an instance of ConversionCustomVariableServiceClient, using the given stub for making calls.
ConversionCustomVariable	getConversionCustomVariable(ConversionCustomVariableName resourceName)	Returns the requested conversion custom variable.
ConversionCustomVariable	getConversionCustomVariable(GetConversionCustomVariableRequest request)	Returns the requested conversion custom variable.
ConversionCustomVariable	getConversionCustomVariable(java.lang.String resourceName)	Returns the requested conversion custom variable.
com.google.api.gax.rpc.UnaryCallable<GetConversionCustomVariableRequest,ConversionCustomVariable>	getConversionCustomVariableCallable()	Returns the requested conversion custom variable.
ConversionCustomVariableServiceSettings	getSettings()
ConversionCustomVariableServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
MutateConversionCustomVariablesResponse	mutateConversionCustomVariables(MutateConversionCustomVariablesRequest request)	Creates or updates conversion custom variables.
MutateConversionCustomVariablesResponse	mutateConversionCustomVariables(java.lang.String customerId, java.util.List<ConversionCustomVariableOperation> operations)	Creates or updates conversion custom variables.
com.google.api.gax.rpc.UnaryCallable<MutateConversionCustomVariablesRequest,MutateConversionCustomVariablesResponse>	mutateConversionCustomVariablesCallable()	Creates or updates conversion custom variables.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConversionCustomVariableServiceClient

protected ConversionCustomVariableServiceClient(ConversionCustomVariableServiceSettings settings)
                                         throws java.io.IOException

Constructs an instance of ConversionCustomVariableServiceClient, 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

ConversionCustomVariableServiceClient

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

Method Detail

create

public static final ConversionCustomVariableServiceClient create()
                                                          throws java.io.IOException

Constructs an instance of ConversionCustomVariableServiceClient with default settings.

Throws:

java.io.IOException

create

public static final ConversionCustomVariableServiceClient create(ConversionCustomVariableServiceSettings settings)
                                                          throws java.io.IOException

Constructs an instance of ConversionCustomVariableServiceClient, 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 ConversionCustomVariableServiceClient create(ConversionCustomVariableServiceStub stub)

Constructs an instance of ConversionCustomVariableServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ConversionCustomVariableServiceSettings).

getSettings

public final ConversionCustomVariableServiceSettings getSettings()

getStub

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

getConversionCustomVariable

public final ConversionCustomVariable getConversionCustomVariable(ConversionCustomVariableName resourceName)

Returns the requested conversion custom variable.

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

Sample code:

 try (ConversionCustomVariableServiceClient conversionCustomVariableServiceClient =
     ConversionCustomVariableServiceClient.create()) {
   ConversionCustomVariableName resourceName =
       ConversionCustomVariableName.of("[CUSTOMER_ID]", "[CONVERSION_CUSTOM_VARIABLE_ID]");
   ConversionCustomVariable response =
       conversionCustomVariableServiceClient.getConversionCustomVariable(resourceName);
 }
 

Parameters:

resourceName - Required. The resource name of the conversion custom variable to fetch.

Throws:

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

getConversionCustomVariable

public final ConversionCustomVariable getConversionCustomVariable(java.lang.String resourceName)

Returns the requested conversion custom variable.

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

Sample code:

 try (ConversionCustomVariableServiceClient conversionCustomVariableServiceClient =
     ConversionCustomVariableServiceClient.create()) {
   String resourceName =
       ConversionCustomVariableName.of("[CUSTOMER_ID]", "[CONVERSION_CUSTOM_VARIABLE_ID]")
           .toString();
   ConversionCustomVariable response =
       conversionCustomVariableServiceClient.getConversionCustomVariable(resourceName);
 }
 

Parameters:

resourceName - Required. The resource name of the conversion custom variable to fetch.

Throws:

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

getConversionCustomVariable

public final ConversionCustomVariable getConversionCustomVariable(GetConversionCustomVariableRequest request)

Returns the requested conversion custom variable.

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

Sample code:

 try (ConversionCustomVariableServiceClient conversionCustomVariableServiceClient =
     ConversionCustomVariableServiceClient.create()) {
   GetConversionCustomVariableRequest request =
       GetConversionCustomVariableRequest.newBuilder()
           .setResourceName(
               ConversionCustomVariableName.of(
                       "[CUSTOMER_ID]", "[CONVERSION_CUSTOM_VARIABLE_ID]")
                   .toString())
           .build();
   ConversionCustomVariable response =
       conversionCustomVariableServiceClient.getConversionCustomVariable(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

getConversionCustomVariableCallable

public final com.google.api.gax.rpc.UnaryCallable<GetConversionCustomVariableRequest,ConversionCustomVariable> getConversionCustomVariableCallable()

Returns the requested conversion custom variable.

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

Sample code:

 try (ConversionCustomVariableServiceClient conversionCustomVariableServiceClient =
     ConversionCustomVariableServiceClient.create()) {
   GetConversionCustomVariableRequest request =
       GetConversionCustomVariableRequest.newBuilder()
           .setResourceName(
               ConversionCustomVariableName.of(
                       "[CUSTOMER_ID]", "[CONVERSION_CUSTOM_VARIABLE_ID]")
                   .toString())
           .build();
   ApiFuture<ConversionCustomVariable> future =
       conversionCustomVariableServiceClient
           .getConversionCustomVariableCallable()
           .futureCall(request);
   // Do something.
   ConversionCustomVariable response = future.get();
 }
 

mutateConversionCustomVariables

public final MutateConversionCustomVariablesResponse mutateConversionCustomVariables(java.lang.String customerId,
                                                                                     java.util.List<ConversionCustomVariableOperation> operations)

Creates or updates conversion custom variables. Operation statuses are returned.

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

Sample code:

 try (ConversionCustomVariableServiceClient conversionCustomVariableServiceClient =
     ConversionCustomVariableServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<ConversionCustomVariableOperation> operations = new ArrayList<>();
   MutateConversionCustomVariablesResponse response =
       conversionCustomVariableServiceClient.mutateConversionCustomVariables(
           customerId, operations);
 }
 

Parameters:

customerId - Required. The ID of the customer whose conversion custom variables are being modified.

operations - Required. The list of operations to perform on individual conversion custom variables.

Throws:

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

mutateConversionCustomVariables

public final MutateConversionCustomVariablesResponse mutateConversionCustomVariables(MutateConversionCustomVariablesRequest request)

Creates or updates conversion custom variables. Operation statuses are returned.

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

Sample code:

 try (ConversionCustomVariableServiceClient conversionCustomVariableServiceClient =
     ConversionCustomVariableServiceClient.create()) {
   MutateConversionCustomVariablesRequest request =
       MutateConversionCustomVariablesRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<ConversionCustomVariableOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   MutateConversionCustomVariablesResponse response =
       conversionCustomVariableServiceClient.mutateConversionCustomVariables(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

mutateConversionCustomVariablesCallable

public final com.google.api.gax.rpc.UnaryCallable<MutateConversionCustomVariablesRequest,MutateConversionCustomVariablesResponse> mutateConversionCustomVariablesCallable()

Creates or updates conversion custom variables. Operation statuses are returned.

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

Sample code:

 try (ConversionCustomVariableServiceClient conversionCustomVariableServiceClient =
     ConversionCustomVariableServiceClient.create()) {
   MutateConversionCustomVariablesRequest request =
       MutateConversionCustomVariablesRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<ConversionCustomVariableOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateConversionCustomVariablesResponse> future =
       conversionCustomVariableServiceClient
           .mutateConversionCustomVariablesCallable()
           .futureCall(request);
   // Do something.
   MutateConversionCustomVariablesResponse 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