Class BetaAnalyticsData.BetaAnalyticsDataBase

Base class for server-side implementations of BetaAnalyticsData

Inheritance

System.Object

BetaAnalyticsData.BetaAnalyticsDataBase

Inherited Members

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ToString()

Namespace: Google.Analytics.Data.V1Beta

Assembly: Google.Analytics.Data.V1Beta.dll

Syntax

[BindServiceMethod(typeof(BetaAnalyticsData), "BindService")]
public abstract class BetaAnalyticsDataBase

Methods

BatchRunPivotReports(BatchRunPivotReportsRequest, ServerCallContext)

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

Declaration

public virtual Task<BatchRunPivotReportsResponse> BatchRunPivotReports(BatchRunPivotReportsRequest request, ServerCallContext context)

Parameters

Type	Name	Description
BatchRunPivotReportsRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<BatchRunPivotReportsResponse>	The response to send back to the client (wrapped by a task).

BatchRunReports(BatchRunReportsRequest, ServerCallContext)

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

Declaration

public virtual Task<BatchRunReportsResponse> BatchRunReports(BatchRunReportsRequest request, ServerCallContext context)

Parameters

Type	Name	Description
BatchRunReportsRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<BatchRunReportsResponse>	The response to send back to the client (wrapped by a task).

CheckCompatibility(CheckCompatibilityRequest, ServerCallContext)

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.

Declaration

public virtual Task<CheckCompatibilityResponse> CheckCompatibility(CheckCompatibilityRequest request, ServerCallContext context)

Parameters

Type	Name	Description
CheckCompatibilityRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<CheckCompatibilityResponse>	The response to send back to the client (wrapped by a task).

GetMetadata(GetMetadataRequest, ServerCallContext)

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.

Declaration

public virtual Task<Metadata> GetMetadata(GetMetadataRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetMetadataRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<Metadata>	The response to send back to the client (wrapped by a task).

RunPivotReport(RunPivotReportRequest, ServerCallContext)

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.

Declaration

public virtual Task<RunPivotReportResponse> RunPivotReport(RunPivotReportRequest request, ServerCallContext context)

Parameters

Type	Name	Description
RunPivotReportRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<RunPivotReportResponse>	The response to send back to the client (wrapped by a task).

RunRealtimeReport(RunRealtimeReportRequest, ServerCallContext)

The Google Analytics Realtime API returns a customized report of realtime event data for your property. These reports show events and usage from the last 30 minutes.

Declaration

public virtual Task<RunRealtimeReportResponse> RunRealtimeReport(RunRealtimeReportRequest request, ServerCallContext context)

Parameters

Type	Name	Description
RunRealtimeReportRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<RunRealtimeReportResponse>	The response to send back to the client (wrapped by a task).

RunReport(RunReportRequest, ServerCallContext)

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.

Declaration

public virtual Task<RunReportResponse> RunReport(RunReportRequest request, ServerCallContext context)

Parameters

Type	Name	Description
RunReportRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<RunReportResponse>	The response to send back to the client (wrapped by a task).