Class BetaAnalyticsDataGrpc.BetaAnalyticsDataFutureStub (0.22.0)

public static final class BetaAnalyticsDataGrpc.BetaAnalyticsDataFutureStub extends AbstractFutureStub<BetaAnalyticsDataGrpc.BetaAnalyticsDataFutureStub>

Google Analytics reporting data service.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > BetaAnalyticsDataGrpc.BetaAnalyticsDataFutureStub

Methods

batchRunPivotReports(BatchRunPivotReportsRequest request)

public ListenableFuture<BatchRunPivotReportsResponse> batchRunPivotReports(BatchRunPivotReportsRequest request)

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

Parameter
NameDescription
requestBatchRunPivotReportsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<BatchRunPivotReportsResponse>

batchRunReports(BatchRunReportsRequest request)

public ListenableFuture<BatchRunReportsResponse> batchRunReports(BatchRunReportsRequest request)

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

Parameter
NameDescription
requestBatchRunReportsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<BatchRunReportsResponse>

build(Channel channel, CallOptions callOptions)

protected BetaAnalyticsDataGrpc.BetaAnalyticsDataFutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
BetaAnalyticsDataGrpc.BetaAnalyticsDataFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

checkCompatibility(CheckCompatibilityRequest request)

public ListenableFuture<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.

Parameter
NameDescription
requestCheckCompatibilityRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<CheckCompatibilityResponse>

getMetadata(GetMetadataRequest request)

public ListenableFuture<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.

Parameter
NameDescription
requestGetMetadataRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Metadata>

runPivotReport(RunPivotReportRequest request)

public ListenableFuture<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.

Parameter
NameDescription
requestRunPivotReportRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<RunPivotReportResponse>

runRealtimeReport(RunRealtimeReportRequest request)

public ListenableFuture<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.

Parameter
NameDescription
requestRunRealtimeReportRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<RunRealtimeReportResponse>

runReport(RunReportRequest request)

public ListenableFuture<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.

Parameter
NameDescription
requestRunReportRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<RunReportResponse>