Class CustomConversionGoalServiceClient
- java.lang.Object
-
- com.google.ads.googleads.v14.services.CustomConversionGoalServiceClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,java.lang.AutoCloseable
@Generated("by gapic-generator-java") public class CustomConversionGoalServiceClient extends java.lang.Object implements com.google.api.gax.core.BackgroundResource
Service Description: Service to manage custom conversion goal.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 (CustomConversionGoalServiceClient customConversionGoalServiceClient = CustomConversionGoalServiceClient.create()) { String customerId = "customerId-1581184615"; List<CustomConversionGoalOperation> operations = new ArrayList<>(); MutateCustomConversionGoalsResponse response = customConversionGoalServiceClient.mutateCustomConversionGoals(customerId, operations); }
Note: close() needs to be called on the CustomConversionGoalServiceClient 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 MutateCustomConversionGoals
Creates, updates or removes custom conversion goals. Operation statuses are returned.
Request object method variants only take one parameter, a request object, which must be constructed before the call.
mutateCustomConversionGoals(MutateCustomConversionGoalsRequest request)
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
mutateCustomConversionGoals(String customerId, List<CustomConversionGoalOperation> operations)
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
mutateCustomConversionGoalsCallable()
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 CustomConversionGoalServiceSettings 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 CustomConversionGoalServiceSettings customConversionGoalServiceSettings = CustomConversionGoalServiceSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); CustomConversionGoalServiceClient customConversionGoalServiceClient = CustomConversionGoalServiceClient.create(customConversionGoalServiceSettings);
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 CustomConversionGoalServiceSettings customConversionGoalServiceSettings = CustomConversionGoalServiceSettings.newBuilder().setEndpoint(myEndpoint).build(); CustomConversionGoalServiceClient customConversionGoalServiceClient = CustomConversionGoalServiceClient.create(customConversionGoalServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
CustomConversionGoalServiceClient(CustomConversionGoalServiceSettings settings)
Constructs an instance of CustomConversionGoalServiceClient, using the given settings.protected
CustomConversionGoalServiceClient(CustomConversionGoalServiceStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, java.util.concurrent.TimeUnit unit)
void
close()
static CustomConversionGoalServiceClient
create()
Constructs an instance of CustomConversionGoalServiceClient with default settings.static CustomConversionGoalServiceClient
create(CustomConversionGoalServiceSettings settings)
Constructs an instance of CustomConversionGoalServiceClient, using the given settings.static CustomConversionGoalServiceClient
create(CustomConversionGoalServiceStub stub)
Constructs an instance of CustomConversionGoalServiceClient, using the given stub for making calls.CustomConversionGoalServiceSettings
getSettings()
CustomConversionGoalServiceStub
getStub()
boolean
isShutdown()
boolean
isTerminated()
MutateCustomConversionGoalsResponse
mutateCustomConversionGoals(MutateCustomConversionGoalsRequest request)
Creates, updates or removes custom conversion goals.MutateCustomConversionGoalsResponse
mutateCustomConversionGoals(java.lang.String customerId, java.util.List<CustomConversionGoalOperation> operations)
Creates, updates or removes custom conversion goals.com.google.api.gax.rpc.UnaryCallable<MutateCustomConversionGoalsRequest,MutateCustomConversionGoalsResponse>
mutateCustomConversionGoalsCallable()
Creates, updates or removes custom conversion goals.void
shutdown()
void
shutdownNow()
-
-
-
Constructor Detail
-
CustomConversionGoalServiceClient
protected CustomConversionGoalServiceClient(CustomConversionGoalServiceSettings settings) throws java.io.IOException
Constructs an instance of CustomConversionGoalServiceClient, 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
-
CustomConversionGoalServiceClient
protected CustomConversionGoalServiceClient(CustomConversionGoalServiceStub stub)
-
-
Method Detail
-
create
public static final CustomConversionGoalServiceClient create() throws java.io.IOException
Constructs an instance of CustomConversionGoalServiceClient with default settings.- Throws:
java.io.IOException
-
create
public static final CustomConversionGoalServiceClient create(CustomConversionGoalServiceSettings settings) throws java.io.IOException
Constructs an instance of CustomConversionGoalServiceClient, 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 CustomConversionGoalServiceClient create(CustomConversionGoalServiceStub stub)
Constructs an instance of CustomConversionGoalServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(CustomConversionGoalServiceSettings).
-
getSettings
public final CustomConversionGoalServiceSettings getSettings()
-
getStub
public CustomConversionGoalServiceStub getStub()
-
mutateCustomConversionGoals
public final MutateCustomConversionGoalsResponse mutateCustomConversionGoals(java.lang.String customerId, java.util.List<CustomConversionGoalOperation> operations)
Creates, updates or removes custom conversion goals. Operation statuses are returned.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 (CustomConversionGoalServiceClient customConversionGoalServiceClient = CustomConversionGoalServiceClient.create()) { String customerId = "customerId-1581184615"; List<CustomConversionGoalOperation> operations = new ArrayList<>(); MutateCustomConversionGoalsResponse response = customConversionGoalServiceClient.mutateCustomConversionGoals(customerId, operations); }
- Parameters:
customerId
- Required. The ID of the customer whose custom conversion goals are being modified.operations
- Required. The list of operations to perform on individual custom conversion goal.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
mutateCustomConversionGoals
public final MutateCustomConversionGoalsResponse mutateCustomConversionGoals(MutateCustomConversionGoalsRequest request)
Creates, updates or removes custom conversion goals. Operation statuses are returned.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 (CustomConversionGoalServiceClient customConversionGoalServiceClient = CustomConversionGoalServiceClient.create()) { MutateCustomConversionGoalsRequest request = MutateCustomConversionGoalsRequest.newBuilder() .setCustomerId("customerId-1581184615") .addAllOperations(new ArrayList<CustomConversionGoalOperation>()) .setValidateOnly(true) .build(); MutateCustomConversionGoalsResponse response = customConversionGoalServiceClient.mutateCustomConversionGoals(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
-
mutateCustomConversionGoalsCallable
public final com.google.api.gax.rpc.UnaryCallable<MutateCustomConversionGoalsRequest,MutateCustomConversionGoalsResponse> mutateCustomConversionGoalsCallable()
Creates, updates or removes custom conversion goals. Operation statuses are returned.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 (CustomConversionGoalServiceClient customConversionGoalServiceClient = CustomConversionGoalServiceClient.create()) { MutateCustomConversionGoalsRequest request = MutateCustomConversionGoalsRequest.newBuilder() .setCustomerId("customerId-1581184615") .addAllOperations(new ArrayList<CustomConversionGoalOperation>()) .setValidateOnly(true) .build(); ApiFuture<MutateCustomConversionGoalsResponse> future = customConversionGoalServiceClient .mutateCustomConversionGoalsCallable() .futureCall(request); // Do something. MutateCustomConversionGoalsResponse response = future.get(); }
-
close
public final void close()
- Specified by:
close
in interfacejava.lang.AutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, java.util.concurrent.TimeUnit unit) throws java.lang.InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
java.lang.InterruptedException
-
-