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