- 0.63.0 (latest)
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
public class AlphaAnalyticsDataClient implements BackgroundResourceService Description: Google Analytics reporting data service.
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 (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
RunFunnelReportRequest request =
RunFunnelReportRequest.newBuilder()
.setProperty("property-993141291")
.addAllDateRanges(new ArrayList<DateRange>())
.setFunnel(Funnel.newBuilder().build())
.setFunnelBreakdown(FunnelBreakdown.newBuilder().build())
.setFunnelNextAction(FunnelNextAction.newBuilder().build())
.addAllSegments(new ArrayList<Segment>())
.setLimit(102976443)
.setDimensionFilter(FilterExpression.newBuilder().build())
.setReturnPropertyQuota(true)
.build();
RunFunnelReportResponse response = alphaAnalyticsDataClient.runFunnelReport(request);
}
Note: close() needs to be called on the AlphaAnalyticsDataClient 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:
- 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.
- 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.
- 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 AlphaAnalyticsDataSettings 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
AlphaAnalyticsDataSettings alphaAnalyticsDataSettings =
AlphaAnalyticsDataSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AlphaAnalyticsDataClient alphaAnalyticsDataClient =
AlphaAnalyticsDataClient.create(alphaAnalyticsDataSettings);
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
AlphaAnalyticsDataSettings alphaAnalyticsDataSettings =
AlphaAnalyticsDataSettings.newBuilder().setEndpoint(myEndpoint).build();
AlphaAnalyticsDataClient alphaAnalyticsDataClient =
AlphaAnalyticsDataClient.create(alphaAnalyticsDataSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
AlphaAnalyticsDataSettings alphaAnalyticsDataSettings =
AlphaAnalyticsDataSettings.newHttpJsonBuilder().build();
AlphaAnalyticsDataClient alphaAnalyticsDataClient =
AlphaAnalyticsDataClient.create(alphaAnalyticsDataSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final AlphaAnalyticsDataClient create()Constructs an instance of AlphaAnalyticsDataClient with default settings.
| Type | Description |
| AlphaAnalyticsDataClient |
| Type | Description |
| IOException |
create(AlphaAnalyticsDataSettings settings)
public static final AlphaAnalyticsDataClient create(AlphaAnalyticsDataSettings settings)Constructs an instance of AlphaAnalyticsDataClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
| Name | Description |
| settings | AlphaAnalyticsDataSettings |
| Type | Description |
| AlphaAnalyticsDataClient |
| Type | Description |
| IOException |
create(AlphaAnalyticsDataStub stub)
public static final AlphaAnalyticsDataClient create(AlphaAnalyticsDataStub stub)Constructs an instance of AlphaAnalyticsDataClient, using the given stub for making calls. This is for advanced usage - prefer using create(AlphaAnalyticsDataSettings).
| Name | Description |
| stub | AlphaAnalyticsDataStub |
| Type | Description |
| AlphaAnalyticsDataClient |
Constructors
AlphaAnalyticsDataClient(AlphaAnalyticsDataSettings settings)
protected AlphaAnalyticsDataClient(AlphaAnalyticsDataSettings settings)Constructs an instance of AlphaAnalyticsDataClient, 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.
| Name | Description |
| settings | AlphaAnalyticsDataSettings |
AlphaAnalyticsDataClient(AlphaAnalyticsDataStub stub)
protected AlphaAnalyticsDataClient(AlphaAnalyticsDataStub stub)| Name | Description |
| stub | AlphaAnalyticsDataStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)| Name | Description |
| duration | long |
| unit | TimeUnit |
| Type | Description |
| boolean |
| Type | Description |
| InterruptedException |
close()
public final void close()getSettings()
public final AlphaAnalyticsDataSettings getSettings()| Type | Description |
| AlphaAnalyticsDataSettings |
getStub()
public AlphaAnalyticsDataStub getStub()| Type | Description |
| AlphaAnalyticsDataStub |
isShutdown()
public boolean isShutdown()| Type | Description |
| boolean |
isTerminated()
public boolean isTerminated()| Type | Description |
| boolean |
runFunnelReport(RunFunnelReportRequest request)
public final RunFunnelReportResponse runFunnelReport(RunFunnelReportRequest request)Returns a customized funnel report of your Google Analytics event data. The data returned from the API is as a table with columns for the requested dimensions and metrics.
Funnel exploration lets you visualize the steps your users take to complete a task and quickly see how well they are succeeding or failing at each step. For example, how do prospects become shoppers and then become buyers? How do one time buyers become repeat buyers? With this information, you can improve inefficient or abandoned customer journeys. To learn more, see GA4 Funnel Explorations.
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 (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
RunFunnelReportRequest request =
RunFunnelReportRequest.newBuilder()
.setProperty("property-993141291")
.addAllDateRanges(new ArrayList<DateRange>())
.setFunnel(Funnel.newBuilder().build())
.setFunnelBreakdown(FunnelBreakdown.newBuilder().build())
.setFunnelNextAction(FunnelNextAction.newBuilder().build())
.addAllSegments(new ArrayList<Segment>())
.setLimit(102976443)
.setDimensionFilter(FilterExpression.newBuilder().build())
.setReturnPropertyQuota(true)
.build();
RunFunnelReportResponse response = alphaAnalyticsDataClient.runFunnelReport(request);
}
| Name | Description |
| request | RunFunnelReportRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| RunFunnelReportResponse |
runFunnelReportCallable()
public final UnaryCallable<RunFunnelReportRequest,RunFunnelReportResponse> runFunnelReportCallable()Returns a customized funnel report of your Google Analytics event data. The data returned from the API is as a table with columns for the requested dimensions and metrics.
Funnel exploration lets you visualize the steps your users take to complete a task and quickly see how well they are succeeding or failing at each step. For example, how do prospects become shoppers and then become buyers? How do one time buyers become repeat buyers? With this information, you can improve inefficient or abandoned customer journeys. To learn more, see GA4 Funnel Explorations.
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 (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
RunFunnelReportRequest request =
RunFunnelReportRequest.newBuilder()
.setProperty("property-993141291")
.addAllDateRanges(new ArrayList<DateRange>())
.setFunnel(Funnel.newBuilder().build())
.setFunnelBreakdown(FunnelBreakdown.newBuilder().build())
.setFunnelNextAction(FunnelNextAction.newBuilder().build())
.addAllSegments(new ArrayList<Segment>())
.setLimit(102976443)
.setDimensionFilter(FilterExpression.newBuilder().build())
.setReturnPropertyQuota(true)
.build();
ApiFuture<RunFunnelReportResponse> future =
alphaAnalyticsDataClient.runFunnelReportCallable().futureCall(request);
// Do something.
RunFunnelReportResponse response = future.get();
}
| Type | Description |
| UnaryCallable<RunFunnelReportRequest,RunFunnelReportResponse> |
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()