Interface BetaAnalyticsDataGrpc.AsyncService (0.30.0)

Version 0.30.0

• 0.66.0 (latest)
• 0.65.0
• 0.64.0
• 0.63.0
• 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 static interface BetaAnalyticsDataGrpc.AsyncService

Google Analytics reporting data service.

Methods

batchRunPivotReports(BatchRunPivotReportsRequest request, StreamObserver<BatchRunPivotReportsResponse> responseObserver)

public default void batchRunPivotReports(BatchRunPivotReportsRequest request, StreamObserver<BatchRunPivotReportsResponse> responseObserver)

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

Parameters
Name	Description
request	BatchRunPivotReportsRequest
responseObserver	io.grpc.stub.StreamObserver<BatchRunPivotReportsResponse>

batchRunReports(BatchRunReportsRequest request, StreamObserver<BatchRunReportsResponse> responseObserver)

public default void batchRunReports(BatchRunReportsRequest request, StreamObserver<BatchRunReportsResponse> responseObserver)

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

Parameters
Name	Description
request	BatchRunReportsRequest
responseObserver	io.grpc.stub.StreamObserver<BatchRunReportsResponse>

checkCompatibility(CheckCompatibilityRequest request, StreamObserver<CheckCompatibilityResponse> responseObserver)

public default void checkCompatibility(CheckCompatibilityRequest request, StreamObserver<CheckCompatibilityResponse> responseObserver)

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.

Parameters
Name	Description
request	CheckCompatibilityRequest
responseObserver	io.grpc.stub.StreamObserver<CheckCompatibilityResponse>

getMetadata(GetMetadataRequest request, StreamObserver<Metadata> responseObserver)

public default void getMetadata(GetMetadataRequest request, StreamObserver<Metadata> responseObserver)

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.

Parameters
Name	Description
request	GetMetadataRequest
responseObserver	io.grpc.stub.StreamObserver<Metadata>

runPivotReport(RunPivotReportRequest request, StreamObserver<RunPivotReportResponse> responseObserver)

public default void runPivotReport(RunPivotReportRequest request, StreamObserver<RunPivotReportResponse> responseObserver)

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.

Parameters
Name	Description
request	RunPivotReportRequest
responseObserver	io.grpc.stub.StreamObserver<RunPivotReportResponse>

runRealtimeReport(RunRealtimeReportRequest request, StreamObserver<RunRealtimeReportResponse> responseObserver)

public default void runRealtimeReport(RunRealtimeReportRequest request, StreamObserver<RunRealtimeReportResponse> responseObserver)

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.

Parameters
Name	Description
request	RunRealtimeReportRequest
responseObserver	io.grpc.stub.StreamObserver<RunRealtimeReportResponse>

runReport(RunReportRequest request, StreamObserver<RunReportResponse> responseObserver)

public default void runReport(RunReportRequest request, StreamObserver<RunReportResponse> responseObserver)

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.

Parameters
Name	Description
request	RunReportRequest
responseObserver	io.grpc.stub.StreamObserver<RunReportResponse>