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

Class UserInterestServiceClient

java.lang.Object

com.google.ads.googleads.v9.services.UserInterestServiceClient

All Implemented Interfaces:

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

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

Service Description: Service to fetch Google Ads User Interest.

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 (UserInterestServiceClient userInterestServiceClient = UserInterestServiceClient.create()) {
   UserInterestName resourceName = UserInterestName.of("[CUSTOMER_ID]", "[USER_INTEREST_ID]");
   UserInterest response = userInterestServiceClient.getUserInterest(resourceName);
 }
 

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

To customize credentials:

 UserInterestServiceSettings userInterestServiceSettings =
     UserInterestServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 UserInterestServiceClient userInterestServiceClient =
     UserInterestServiceClient.create(userInterestServiceSettings);
 

To customize the endpoint:

 UserInterestServiceSettings userInterestServiceSettings =
     UserInterestServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 UserInterestServiceClient userInterestServiceClient =
     UserInterestServiceClient.create(userInterestServiceSettings);
 

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UserInterestServiceClient(UserInterestServiceStub stub)
protected	UserInterestServiceClient(UserInterestServiceSettings settings)	Constructs an instance of UserInterestServiceClient, using the given settings.

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long duration, java.util.concurrent.TimeUnit unit)
void	close()
static UserInterestServiceClient	create()	Constructs an instance of UserInterestServiceClient with default settings.
static UserInterestServiceClient	create(UserInterestServiceStub stub)	Constructs an instance of UserInterestServiceClient, using the given stub for making calls.
static UserInterestServiceClient	create(UserInterestServiceSettings settings)	Constructs an instance of UserInterestServiceClient, using the given settings.
UserInterestServiceSettings	getSettings()
UserInterestServiceStub	getStub()
UserInterest	getUserInterest(UserInterestName resourceName)	Returns the requested user interest in full detail
UserInterest	getUserInterest(GetUserInterestRequest request)	Returns the requested user interest in full detail
UserInterest	getUserInterest(java.lang.String resourceName)	Returns the requested user interest in full detail
com.google.api.gax.rpc.UnaryCallable<GetUserInterestRequest,UserInterest>	getUserInterestCallable()	Returns the requested user interest in full detail
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

UserInterestServiceClient

protected UserInterestServiceClient(UserInterestServiceSettings settings)
                             throws java.io.IOException

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

UserInterestServiceClient

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

Method Detail

create

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

Constructs an instance of UserInterestServiceClient with default settings.

Throws:

java.io.IOException

create

public static final UserInterestServiceClient create(UserInterestServiceSettings settings)
                                              throws java.io.IOException

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

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

getSettings

public final UserInterestServiceSettings getSettings()

getStub

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

getUserInterest

public final UserInterest getUserInterest(UserInterestName resourceName)

Returns the requested user interest in full detail

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

Sample code:

 try (UserInterestServiceClient userInterestServiceClient = UserInterestServiceClient.create()) {
   UserInterestName resourceName = UserInterestName.of("[CUSTOMER_ID]", "[USER_INTEREST_ID]");
   UserInterest response = userInterestServiceClient.getUserInterest(resourceName);
 }
 

Parameters:

resourceName - Required. Resource name of the UserInterest to fetch.

Throws:

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

getUserInterest

public final UserInterest getUserInterest(java.lang.String resourceName)

Returns the requested user interest in full detail

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

Sample code:

 try (UserInterestServiceClient userInterestServiceClient = UserInterestServiceClient.create()) {
   String resourceName = UserInterestName.of("[CUSTOMER_ID]", "[USER_INTEREST_ID]").toString();
   UserInterest response = userInterestServiceClient.getUserInterest(resourceName);
 }
 

Parameters:

resourceName - Required. Resource name of the UserInterest to fetch.

Throws:

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

getUserInterest

public final UserInterest getUserInterest(GetUserInterestRequest request)

Returns the requested user interest in full detail

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

Sample code:

 try (UserInterestServiceClient userInterestServiceClient = UserInterestServiceClient.create()) {
   GetUserInterestRequest request =
       GetUserInterestRequest.newBuilder()
           .setResourceName(
               UserInterestName.of("[CUSTOMER_ID]", "[USER_INTEREST_ID]").toString())
           .build();
   UserInterest response = userInterestServiceClient.getUserInterest(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

getUserInterestCallable

public final com.google.api.gax.rpc.UnaryCallable<GetUserInterestRequest,UserInterest> getUserInterestCallable()

Returns the requested user interest in full detail

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

Sample code:

 try (UserInterestServiceClient userInterestServiceClient = UserInterestServiceClient.create()) {
   GetUserInterestRequest request =
       GetUserInterestRequest.newBuilder()
           .setResourceName(
               UserInterestName.of("[CUSTOMER_ID]", "[USER_INTEREST_ID]").toString())
           .build();
   ApiFuture<UserInterest> future =
       userInterestServiceClient.getUserInterestCallable().futureCall(request);
   // Do something.
   UserInterest 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