Class BetaAnalyticsDataClient (0.31.0)
Stay organized with collections Save and categorize content based on your preferences.

public class BetaAnalyticsDataClient implements BackgroundResource

Service 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 (BetaAnalyticsDataClient betaAnalyticsDataClient = BetaAnalyticsDataClient.create()) {
   RunReportRequest request =
       RunReportRequest.newBuilder()
           .setProperty("property-993141291")
           .addAllDimensions(new ArrayList<Dimension>())
           .addAllMetrics(new ArrayList<Metric>())
           .addAllDateRanges(new ArrayList<DateRange>())
           .setDimensionFilter(FilterExpression.newBuilder().build())
           .setMetricFilter(FilterExpression.newBuilder().build())
           .setOffset(-1019779949)
           .setLimit(102976443)
           .addAllMetricAggregations(new ArrayList<MetricAggregation>())
           .addAllOrderBys(new ArrayList<OrderBy>())
           .setCurrencyCode("currencyCode1004773790")
           .setCohortSpec(CohortSpec.newBuilder().build())
           .setKeepEmptyRows(true)
           .setReturnPropertyQuota(true)
           .build();
   RunReportResponse response = betaAnalyticsDataClient.runReport(request);
 }

Note: close() needs to be called on the BetaAnalyticsDataClient 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 BetaAnalyticsDataSettings 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
 BetaAnalyticsDataSettings betaAnalyticsDataSettings =
     BetaAnalyticsDataSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BetaAnalyticsDataClient betaAnalyticsDataClient =
     BetaAnalyticsDataClient.create(betaAnalyticsDataSettings);

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
 BetaAnalyticsDataSettings betaAnalyticsDataSettings =
     BetaAnalyticsDataSettings.newBuilder().setEndpoint(myEndpoint).build();
 BetaAnalyticsDataClient betaAnalyticsDataClient =
     BetaAnalyticsDataClient.create(betaAnalyticsDataSettings);

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
 BetaAnalyticsDataSettings betaAnalyticsDataSettings =
     BetaAnalyticsDataSettings.newHttpJsonBuilder().build();
 BetaAnalyticsDataClient betaAnalyticsDataClient =
     BetaAnalyticsDataClient.create(betaAnalyticsDataSettings);

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

Inheritance

java.lang.Object > BetaAnalyticsDataClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final BetaAnalyticsDataClient create()

Constructs an instance of BetaAnalyticsDataClient with default settings.

Returns
Type	Description
`BetaAnalyticsDataClient`

Exceptions
Type	Description
`IOException`

create(BetaAnalyticsDataSettings settings)

public static final BetaAnalyticsDataClient create(BetaAnalyticsDataSettings settings)

Constructs an instance of BetaAnalyticsDataClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
`settings`	`BetaAnalyticsDataSettings`

Returns
Type	Description
`BetaAnalyticsDataClient`

Exceptions
Type	Description
`IOException`

create(BetaAnalyticsDataStub stub)

public static final BetaAnalyticsDataClient create(BetaAnalyticsDataStub stub)

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

Parameter
Name	Description
`stub`	`BetaAnalyticsDataStub`

Returns
Type	Description
`BetaAnalyticsDataClient`

Constructors

BetaAnalyticsDataClient(BetaAnalyticsDataSettings settings)

protected BetaAnalyticsDataClient(BetaAnalyticsDataSettings settings)

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

Parameter
Name	Description
`settings`	`BetaAnalyticsDataSettings`

BetaAnalyticsDataClient(BetaAnalyticsDataStub stub)

protected BetaAnalyticsDataClient(BetaAnalyticsDataStub stub)

Parameter
Name	Description
`stub`	`BetaAnalyticsDataStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

batchRunPivotReports(BatchRunPivotReportsRequest request)

public final BatchRunPivotReportsResponse batchRunPivotReports(BatchRunPivotReportsRequest request)

Returns multiple pivot reports in a batch. All reports must be for the same GA4 Property.

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 (BetaAnalyticsDataClient betaAnalyticsDataClient = BetaAnalyticsDataClient.create()) {
   BatchRunPivotReportsRequest request =
       BatchRunPivotReportsRequest.newBuilder()
           .setProperty("property-993141291")
           .addAllRequests(new ArrayList<RunPivotReportRequest>())
           .build();
   BatchRunPivotReportsResponse response = betaAnalyticsDataClient.batchRunPivotReports(request);
 }

Parameter
Name	Description
`request`	`BatchRunPivotReportsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BatchRunPivotReportsResponse`

batchRunPivotReportsCallable()

public final UnaryCallable<BatchRunPivotReportsRequest,BatchRunPivotReportsResponse> batchRunPivotReportsCallable()

Returns multiple pivot reports in a batch. All reports must be for the same GA4 Property.

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 (BetaAnalyticsDataClient betaAnalyticsDataClient = BetaAnalyticsDataClient.create()) {
   BatchRunPivotReportsRequest request =
       BatchRunPivotReportsRequest.newBuilder()
           .setProperty("property-993141291")
           .addAllRequests(new ArrayList<RunPivotReportRequest>())
           .build();
   ApiFuture<BatchRunPivotReportsResponse> future =
       betaAnalyticsDataClient.batchRunPivotReportsCallable().futureCall(request);
   // Do something.
   BatchRunPivotReportsResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<BatchRunPivotReportsRequest,BatchRunPivotReportsResponse>`

batchRunReports(BatchRunReportsRequest request)

public final BatchRunReportsResponse batchRunReports(BatchRunReportsRequest request)

Returns multiple reports in a batch. All reports must be for the same GA4 Property.

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 (BetaAnalyticsDataClient betaAnalyticsDataClient = BetaAnalyticsDataClient.create()) {
   BatchRunReportsRequest request =
       BatchRunReportsRequest.newBuilder()
           .setProperty("property-993141291")
           .addAllRequests(new ArrayList<RunReportRequest>())
           .build();
   BatchRunReportsResponse response = betaAnalyticsDataClient.batchRunReports(request);
 }

Parameter
Name	Description
`request`	`BatchRunReportsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BatchRunReportsResponse`

batchRunReportsCallable()

public final UnaryCallable<BatchRunReportsRequest,BatchRunReportsResponse> batchRunReportsCallable()

Returns multiple reports in a batch. All reports must be for the same GA4 Property.

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 (BetaAnalyticsDataClient betaAnalyticsDataClient = BetaAnalyticsDataClient.create()) {
   BatchRunReportsRequest request =
       BatchRunReportsRequest.newBuilder()
           .setProperty("property-993141291")
           .addAllRequests(new ArrayList<RunReportRequest>())
           .build();
   ApiFuture<BatchRunReportsResponse> future =
       betaAnalyticsDataClient.batchRunReportsCallable().futureCall(request);
   // Do something.
   BatchRunReportsResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<BatchRunReportsRequest,BatchRunReportsResponse>`

checkCompatibility(CheckCompatibilityRequest request)

public final CheckCompatibilityResponse checkCompatibility(CheckCompatibilityRequest request)

This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility. This method fails if the request's dimensions and metrics are incompatible.

In Google Analytics, reports fail if they request incompatible dimensions and/or metrics; in that case, you will need to remove dimensions and/or metrics from the incompatible report until the report is compatible.

The Realtime and Core reports have different compatibility rules. This method checks compatibility for Core reports.

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 (BetaAnalyticsDataClient betaAnalyticsDataClient = BetaAnalyticsDataClient.create()) {
   CheckCompatibilityRequest request =
       CheckCompatibilityRequest.newBuilder()
           .setProperty("property-993141291")
           .addAllDimensions(new ArrayList<Dimension>())
           .addAllMetrics(new ArrayList<Metric>())
           .setDimensionFilter(FilterExpression.newBuilder().build())
           .setMetricFilter(FilterExpression.newBuilder().build())
           .setCompatibilityFilter(Compatibility.forNumber(0))
           .build();
   CheckCompatibilityResponse response = betaAnalyticsDataClient.checkCompatibility(request);
 }

Parameter
Name	Description
`request`	`CheckCompatibilityRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CheckCompatibilityResponse`

checkCompatibilityCallable()

public final UnaryCallable<CheckCompatibilityRequest,CheckCompatibilityResponse> checkCompatibilityCallable()

This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility. This method fails if the request's dimensions and metrics are incompatible.

The Realtime and Core reports have different compatibility rules. This method checks compatibility for Core reports.

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 (BetaAnalyticsDataClient betaAnalyticsDataClient = BetaAnalyticsDataClient.create()) {
   CheckCompatibilityRequest request =
       CheckCompatibilityRequest.newBuilder()
           .setProperty("property-993141291")
           .addAllDimensions(new ArrayList<Dimension>())
           .addAllMetrics(new ArrayList<Metric>())
           .setDimensionFilter(FilterExpression.newBuilder().build())
           .setMetricFilter(FilterExpression.newBuilder().build())
           .setCompatibilityFilter(Compatibility.forNumber(0))
           .build();
   ApiFuture<CheckCompatibilityResponse> future =
       betaAnalyticsDataClient.checkCompatibilityCallable().futureCall(request);
   // Do something.
   CheckCompatibilityResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CheckCompatibilityRequest,CheckCompatibilityResponse>`

close()

public final void close()

getMetadata(GetMetadataRequest request)

public final Metadata getMetadata(GetMetadataRequest request)

Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics GA4 Property Identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata.

For example if a custom metric with parameter name levels_unlocked is registered to a property, the Metadata response will contain customEvent:levels_unlocked. Universal metadata are dimensions and metrics applicable to any property such as country and totalUsers.

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 (BetaAnalyticsDataClient betaAnalyticsDataClient = BetaAnalyticsDataClient.create()) {
   GetMetadataRequest request =
       GetMetadataRequest.newBuilder().setName(MetadataName.of("[PROPERTY]").toString()).build();
   Metadata response = betaAnalyticsDataClient.getMetadata(request);
 }

Parameter
Name	Description
`request`	`GetMetadataRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Metadata`

getMetadata(MetadataName name)

public final Metadata getMetadata(MetadataName name)

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 (BetaAnalyticsDataClient betaAnalyticsDataClient = BetaAnalyticsDataClient.create()) {
   MetadataName name = MetadataName.of("[PROPERTY]");
   Metadata response = betaAnalyticsDataClient.getMetadata(name);
 }

Parameter

Name Description

name

MetadataName

Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics GA4 Property identifier. To learn more, see where to find your Property ID.

Example: properties/1234/metadata

Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.

Returns
Type	Description
`Metadata`

getMetadata(String name)

public final Metadata getMetadata(String name)

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 (BetaAnalyticsDataClient betaAnalyticsDataClient = BetaAnalyticsDataClient.create()) {
   String name = MetadataName.of("[PROPERTY]").toString();
   Metadata response = betaAnalyticsDataClient.getMetadata(name);
 }

Parameter

Name Description

name

String

Example: properties/1234/metadata

Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.

Returns
Type	Description
`Metadata`

getMetadataCallable()

public final UnaryCallable<GetMetadataRequest,Metadata> getMetadataCallable()

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 (BetaAnalyticsDataClient betaAnalyticsDataClient = BetaAnalyticsDataClient.create()) {
   GetMetadataRequest request =
       GetMetadataRequest.newBuilder().setName(MetadataName.of("[PROPERTY]").toString()).build();
   ApiFuture<Metadata> future =
       betaAnalyticsDataClient.getMetadataCallable().futureCall(request);
   // Do something.
   Metadata response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetMetadataRequest,Metadata>`

getSettings()

public final BetaAnalyticsDataSettings getSettings()

Returns
Type	Description
`BetaAnalyticsDataSettings`

getStub()

public BetaAnalyticsDataStub getStub()

Returns
Type	Description
`BetaAnalyticsDataStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

runPivotReport(RunPivotReportRequest request)

public final RunPivotReportResponse runPivotReport(RunPivotReportRequest request)

Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot. Multiple pivots can be specified to further dissect your data.

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 (BetaAnalyticsDataClient betaAnalyticsDataClient = BetaAnalyticsDataClient.create()) {
   RunPivotReportRequest request =
       RunPivotReportRequest.newBuilder()
           .setProperty("property-993141291")
           .addAllDimensions(new ArrayList<Dimension>())
           .addAllMetrics(new ArrayList<Metric>())
           .addAllDateRanges(new ArrayList<DateRange>())
           .addAllPivots(new ArrayList<Pivot>())
           .setDimensionFilter(FilterExpression.newBuilder().build())
           .setMetricFilter(FilterExpression.newBuilder().build())
           .setCurrencyCode("currencyCode1004773790")
           .setCohortSpec(CohortSpec.newBuilder().build())
           .setKeepEmptyRows(true)
           .setReturnPropertyQuota(true)
           .build();
   RunPivotReportResponse response = betaAnalyticsDataClient.runPivotReport(request);
 }

Parameter
Name	Description
`request`	`RunPivotReportRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`RunPivotReportResponse`

runPivotReportCallable()

public final UnaryCallable<RunPivotReportRequest,RunPivotReportResponse> runPivotReportCallable()

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 (BetaAnalyticsDataClient betaAnalyticsDataClient = BetaAnalyticsDataClient.create()) {
   RunPivotReportRequest request =
       RunPivotReportRequest.newBuilder()
           .setProperty("property-993141291")
           .addAllDimensions(new ArrayList<Dimension>())
           .addAllMetrics(new ArrayList<Metric>())
           .addAllDateRanges(new ArrayList<DateRange>())
           .addAllPivots(new ArrayList<Pivot>())
           .setDimensionFilter(FilterExpression.newBuilder().build())
           .setMetricFilter(FilterExpression.newBuilder().build())
           .setCurrencyCode("currencyCode1004773790")
           .setCohortSpec(CohortSpec.newBuilder().build())
           .setKeepEmptyRows(true)
           .setReturnPropertyQuota(true)
           .build();
   ApiFuture<RunPivotReportResponse> future =
       betaAnalyticsDataClient.runPivotReportCallable().futureCall(request);
   // Do something.
   RunPivotReportResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<RunPivotReportRequest,RunPivotReportResponse>`

runRealtimeReport(RunRealtimeReportRequest request)

public final RunRealtimeReportResponse runRealtimeReport(RunRealtimeReportRequest request)

Returns a customized report of realtime event data for your property. Events appear in realtime reports seconds after they have been sent to the Google Analytics. Realtime reports show events and usage data for the periods of time ranging from the present moment to 30 minutes ago (up to 60 minutes for Google Analytics 360 properties).

For a guide to constructing realtime requests & understanding responses, see Creating a Realtime Report.

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 (BetaAnalyticsDataClient betaAnalyticsDataClient = BetaAnalyticsDataClient.create()) {
   RunRealtimeReportRequest request =
       RunRealtimeReportRequest.newBuilder()
           .setProperty("property-993141291")
           .addAllDimensions(new ArrayList<Dimension>())
           .addAllMetrics(new ArrayList<Metric>())
           .setDimensionFilter(FilterExpression.newBuilder().build())
           .setMetricFilter(FilterExpression.newBuilder().build())
           .setLimit(102976443)
           .addAllMetricAggregations(new ArrayList<MetricAggregation>())
           .addAllOrderBys(new ArrayList<OrderBy>())
           .setReturnPropertyQuota(true)
           .addAllMinuteRanges(new ArrayList<MinuteRange>())
           .build();
   RunRealtimeReportResponse response = betaAnalyticsDataClient.runRealtimeReport(request);
 }

Parameter
Name	Description
`request`	`RunRealtimeReportRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`RunRealtimeReportResponse`

runRealtimeReportCallable()

public final UnaryCallable<RunRealtimeReportRequest,RunRealtimeReportResponse> runRealtimeReportCallable()

For a guide to constructing realtime requests & understanding responses, see Creating a Realtime Report.

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 (BetaAnalyticsDataClient betaAnalyticsDataClient = BetaAnalyticsDataClient.create()) {
   RunRealtimeReportRequest request =
       RunRealtimeReportRequest.newBuilder()
           .setProperty("property-993141291")
           .addAllDimensions(new ArrayList<Dimension>())
           .addAllMetrics(new ArrayList<Metric>())
           .setDimensionFilter(FilterExpression.newBuilder().build())
           .setMetricFilter(FilterExpression.newBuilder().build())
           .setLimit(102976443)
           .addAllMetricAggregations(new ArrayList<MetricAggregation>())
           .addAllOrderBys(new ArrayList<OrderBy>())
           .setReturnPropertyQuota(true)
           .addAllMinuteRanges(new ArrayList<MinuteRange>())
           .build();
   ApiFuture<RunRealtimeReportResponse> future =
       betaAnalyticsDataClient.runRealtimeReportCallable().futureCall(request);
   // Do something.
   RunRealtimeReportResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<RunRealtimeReportRequest,RunRealtimeReportResponse>`

runReport(RunReportRequest request)

public final RunReportResponse runReport(RunReportRequest request)

Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name.

For a guide to constructing requests & understanding responses, see Creating a Report.

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 (BetaAnalyticsDataClient betaAnalyticsDataClient = BetaAnalyticsDataClient.create()) {
   RunReportRequest request =
       RunReportRequest.newBuilder()
           .setProperty("property-993141291")
           .addAllDimensions(new ArrayList<Dimension>())
           .addAllMetrics(new ArrayList<Metric>())
           .addAllDateRanges(new ArrayList<DateRange>())
           .setDimensionFilter(FilterExpression.newBuilder().build())
           .setMetricFilter(FilterExpression.newBuilder().build())
           .setOffset(-1019779949)
           .setLimit(102976443)
           .addAllMetricAggregations(new ArrayList<MetricAggregation>())
           .addAllOrderBys(new ArrayList<OrderBy>())
           .setCurrencyCode("currencyCode1004773790")
           .setCohortSpec(CohortSpec.newBuilder().build())
           .setKeepEmptyRows(true)
           .setReturnPropertyQuota(true)
           .build();
   RunReportResponse response = betaAnalyticsDataClient.runReport(request);
 }

Parameter
Name	Description
`request`	`RunReportRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`RunReportResponse`

runReportCallable()

public final UnaryCallable<RunReportRequest,RunReportResponse> runReportCallable()

For a guide to constructing requests & understanding responses, see Creating a Report.

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 (BetaAnalyticsDataClient betaAnalyticsDataClient = BetaAnalyticsDataClient.create()) {
   RunReportRequest request =
       RunReportRequest.newBuilder()
           .setProperty("property-993141291")
           .addAllDimensions(new ArrayList<Dimension>())
           .addAllMetrics(new ArrayList<Metric>())
           .addAllDateRanges(new ArrayList<DateRange>())
           .setDimensionFilter(FilterExpression.newBuilder().build())
           .setMetricFilter(FilterExpression.newBuilder().build())
           .setOffset(-1019779949)
           .setLimit(102976443)
           .addAllMetricAggregations(new ArrayList<MetricAggregation>())
           .addAllOrderBys(new ArrayList<OrderBy>())
           .setCurrencyCode("currencyCode1004773790")
           .setCohortSpec(CohortSpec.newBuilder().build())
           .setKeepEmptyRows(true)
           .setReturnPropertyQuota(true)
           .build();
   ApiFuture<RunReportResponse> future =
       betaAnalyticsDataClient.runReportCallable().futureCall(request);
   // Do something.
   RunReportResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<RunReportRequest,RunReportResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

Class BetaAnalyticsDataClient (0.31.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Implements

Inherited Members

Static Methods

create()

create(BetaAnalyticsDataSettings settings)

create(BetaAnalyticsDataStub stub)

Constructors

BetaAnalyticsDataClient(BetaAnalyticsDataSettings settings)

BetaAnalyticsDataClient(BetaAnalyticsDataStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

batchRunPivotReports(BatchRunPivotReportsRequest request)

batchRunPivotReportsCallable()

batchRunReports(BatchRunReportsRequest request)

batchRunReportsCallable()

checkCompatibility(CheckCompatibilityRequest request)

checkCompatibilityCallable()

close()

getMetadata(GetMetadataRequest request)

getMetadata(MetadataName name)

getMetadata(String name)

getMetadataCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

runPivotReport(RunPivotReportRequest request)

runPivotReportCallable()

runRealtimeReport(RunRealtimeReportRequest request)

runRealtimeReportCallable()

runReport(RunReportRequest request)

runReportCallable()

shutdown()

shutdownNow()

Class BetaAnalyticsDataClient (0.31.0)
Stay organized with collections Save and categorize content based on your preferences.