Class ThirdPartyAppAnalyticsLinkServiceClient
- java.lang.Object
-
- com.google.ads.googleads.v14.services.ThirdPartyAppAnalyticsLinkServiceClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,java.lang.AutoCloseable
@Generated("by gapic-generator-java") public class ThirdPartyAppAnalyticsLinkServiceClient extends java.lang.Object implements com.google.api.gax.core.BackgroundResource
Service Description: This service allows management of links between Google Ads and third party app analytics.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 (ThirdPartyAppAnalyticsLinkServiceClient thirdPartyAppAnalyticsLinkServiceClient = ThirdPartyAppAnalyticsLinkServiceClient.create()) { RegenerateShareableLinkIdRequest request = RegenerateShareableLinkIdRequest.newBuilder() .setResourceName( ThirdPartyAppAnalyticsLinkName.of("[CUSTOMER_ID]", "[CUSTOMER_LINK_ID]") .toString()) .build(); RegenerateShareableLinkIdResponse response = thirdPartyAppAnalyticsLinkServiceClient.regenerateShareableLinkId(request); }
Note: close() needs to be called on the ThirdPartyAppAnalyticsLinkServiceClient 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 RegenerateShareableLinkId
Regenerate ThirdPartyAppAnalyticsLink.shareable_link_id that should be provided to the third party when setting up app analytics.
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
Request object method variants only take one parameter, a request object, which must be constructed before the call.
regenerateShareableLinkId(RegenerateShareableLinkIdRequest request)
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
regenerateShareableLinkIdCallable()
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 ThirdPartyAppAnalyticsLinkServiceSettings 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 ThirdPartyAppAnalyticsLinkServiceSettings thirdPartyAppAnalyticsLinkServiceSettings = ThirdPartyAppAnalyticsLinkServiceSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); ThirdPartyAppAnalyticsLinkServiceClient thirdPartyAppAnalyticsLinkServiceClient = ThirdPartyAppAnalyticsLinkServiceClient.create(thirdPartyAppAnalyticsLinkServiceSettings);
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 ThirdPartyAppAnalyticsLinkServiceSettings thirdPartyAppAnalyticsLinkServiceSettings = ThirdPartyAppAnalyticsLinkServiceSettings.newBuilder().setEndpoint(myEndpoint).build(); ThirdPartyAppAnalyticsLinkServiceClient thirdPartyAppAnalyticsLinkServiceClient = ThirdPartyAppAnalyticsLinkServiceClient.create(thirdPartyAppAnalyticsLinkServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
ThirdPartyAppAnalyticsLinkServiceClient(ThirdPartyAppAnalyticsLinkServiceStub stub)
protected
ThirdPartyAppAnalyticsLinkServiceClient(ThirdPartyAppAnalyticsLinkServiceSettings settings)
Constructs an instance of ThirdPartyAppAnalyticsLinkServiceClient, using the given settings.
-
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 ThirdPartyAppAnalyticsLinkServiceClient
create()
Constructs an instance of ThirdPartyAppAnalyticsLinkServiceClient with default settings.static ThirdPartyAppAnalyticsLinkServiceClient
create(ThirdPartyAppAnalyticsLinkServiceStub stub)
Constructs an instance of ThirdPartyAppAnalyticsLinkServiceClient, using the given stub for making calls.static ThirdPartyAppAnalyticsLinkServiceClient
create(ThirdPartyAppAnalyticsLinkServiceSettings settings)
Constructs an instance of ThirdPartyAppAnalyticsLinkServiceClient, using the given settings.ThirdPartyAppAnalyticsLinkServiceSettings
getSettings()
ThirdPartyAppAnalyticsLinkServiceStub
getStub()
boolean
isShutdown()
boolean
isTerminated()
RegenerateShareableLinkIdResponse
regenerateShareableLinkId(RegenerateShareableLinkIdRequest request)
Regenerate ThirdPartyAppAnalyticsLink.shareable_link_id that should be provided to the third party when setting up app analytics.com.google.api.gax.rpc.UnaryCallable<RegenerateShareableLinkIdRequest,RegenerateShareableLinkIdResponse>
regenerateShareableLinkIdCallable()
Regenerate ThirdPartyAppAnalyticsLink.shareable_link_id that should be provided to the third party when setting up app analytics.void
shutdown()
void
shutdownNow()
-
-
-
Constructor Detail
-
ThirdPartyAppAnalyticsLinkServiceClient
protected ThirdPartyAppAnalyticsLinkServiceClient(ThirdPartyAppAnalyticsLinkServiceSettings settings) throws java.io.IOException
Constructs an instance of ThirdPartyAppAnalyticsLinkServiceClient, 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
-
ThirdPartyAppAnalyticsLinkServiceClient
protected ThirdPartyAppAnalyticsLinkServiceClient(ThirdPartyAppAnalyticsLinkServiceStub stub)
-
-
Method Detail
-
create
public static final ThirdPartyAppAnalyticsLinkServiceClient create() throws java.io.IOException
Constructs an instance of ThirdPartyAppAnalyticsLinkServiceClient with default settings.- Throws:
java.io.IOException
-
create
public static final ThirdPartyAppAnalyticsLinkServiceClient create(ThirdPartyAppAnalyticsLinkServiceSettings settings) throws java.io.IOException
Constructs an instance of ThirdPartyAppAnalyticsLinkServiceClient, 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 ThirdPartyAppAnalyticsLinkServiceClient create(ThirdPartyAppAnalyticsLinkServiceStub stub)
Constructs an instance of ThirdPartyAppAnalyticsLinkServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ThirdPartyAppAnalyticsLinkServiceSettings).
-
getSettings
public final ThirdPartyAppAnalyticsLinkServiceSettings getSettings()
-
getStub
public ThirdPartyAppAnalyticsLinkServiceStub getStub()
-
regenerateShareableLinkId
public final RegenerateShareableLinkIdResponse regenerateShareableLinkId(RegenerateShareableLinkIdRequest request)
Regenerate ThirdPartyAppAnalyticsLink.shareable_link_id that should be provided to the third party when setting up app analytics.List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
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 (ThirdPartyAppAnalyticsLinkServiceClient thirdPartyAppAnalyticsLinkServiceClient = ThirdPartyAppAnalyticsLinkServiceClient.create()) { RegenerateShareableLinkIdRequest request = RegenerateShareableLinkIdRequest.newBuilder() .setResourceName( ThirdPartyAppAnalyticsLinkName.of("[CUSTOMER_ID]", "[CUSTOMER_LINK_ID]") .toString()) .build(); RegenerateShareableLinkIdResponse response = thirdPartyAppAnalyticsLinkServiceClient.regenerateShareableLinkId(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
-
regenerateShareableLinkIdCallable
public final com.google.api.gax.rpc.UnaryCallable<RegenerateShareableLinkIdRequest,RegenerateShareableLinkIdResponse> regenerateShareableLinkIdCallable()
Regenerate ThirdPartyAppAnalyticsLink.shareable_link_id that should be provided to the third party when setting up app analytics.List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
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 (ThirdPartyAppAnalyticsLinkServiceClient thirdPartyAppAnalyticsLinkServiceClient = ThirdPartyAppAnalyticsLinkServiceClient.create()) { RegenerateShareableLinkIdRequest request = RegenerateShareableLinkIdRequest.newBuilder() .setResourceName( ThirdPartyAppAnalyticsLinkName.of("[CUSTOMER_ID]", "[CUSTOMER_LINK_ID]") .toString()) .build(); ApiFuture<RegenerateShareableLinkIdResponse> future = thirdPartyAppAnalyticsLinkServiceClient .regenerateShareableLinkIdCallable() .futureCall(request); // Do something. RegenerateShareableLinkIdResponse 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
-
-