Class BetaAnalyticsDataClientImpl

BetaAnalyticsData client wrapper implementation, for convenient use.

Inheritance

System.Object

BetaAnalyticsDataClient

BetaAnalyticsDataClientImpl

Inherited Members

BetaAnalyticsDataClient.DefaultEndpoint

BetaAnalyticsDataClient.DefaultScopes

BetaAnalyticsDataClient.CreateAsync(CancellationToken)

BetaAnalyticsDataClient.Create()

BetaAnalyticsDataClient.ShutdownDefaultChannelsAsync()

BetaAnalyticsDataClient.RunReportAsync(RunReportRequest, CancellationToken)

BetaAnalyticsDataClient.RunPivotReportAsync(RunPivotReportRequest, CancellationToken)

BetaAnalyticsDataClient.BatchRunReportsAsync(BatchRunReportsRequest, CancellationToken)

BetaAnalyticsDataClient.BatchRunPivotReportsAsync(BatchRunPivotReportsRequest, CancellationToken)

BetaAnalyticsDataClient.GetMetadataAsync(GetMetadataRequest, CancellationToken)

BetaAnalyticsDataClient.GetMetadata(String, CallSettings)

BetaAnalyticsDataClient.GetMetadataAsync(String, CallSettings)

BetaAnalyticsDataClient.GetMetadataAsync(String, CancellationToken)

BetaAnalyticsDataClient.GetMetadata(MetadataName, CallSettings)

BetaAnalyticsDataClient.GetMetadataAsync(MetadataName, CallSettings)

BetaAnalyticsDataClient.GetMetadataAsync(MetadataName, CancellationToken)

BetaAnalyticsDataClient.RunRealtimeReportAsync(RunRealtimeReportRequest, CancellationToken)

BetaAnalyticsDataClient.CheckCompatibilityAsync(CheckCompatibilityRequest, CancellationToken)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ToString()

Namespace: Google.Analytics.Data.V1Beta

Assembly: Google.Analytics.Data.V1Beta.dll

Syntax

public sealed class BetaAnalyticsDataClientImpl : BetaAnalyticsDataClient

Remarks

Google Analytics reporting data service.

Constructors

BetaAnalyticsDataClientImpl(BetaAnalyticsData.BetaAnalyticsDataClient, BetaAnalyticsDataSettings)

Constructs a client wrapper for the BetaAnalyticsData service, with the specified gRPC client and settings.

Declaration

public BetaAnalyticsDataClientImpl(BetaAnalyticsData.BetaAnalyticsDataClient grpcClient, BetaAnalyticsDataSettings settings)

Parameters

Type	Name	Description
BetaAnalyticsData.BetaAnalyticsDataClient	grpcClient	The underlying gRPC client.
BetaAnalyticsDataSettings	settings	The base BetaAnalyticsDataSettings used within this client.

Properties

GrpcClient

The underlying gRPC BetaAnalyticsData client

Declaration

public override BetaAnalyticsData.BetaAnalyticsDataClient GrpcClient { get; }

Property Value

Type	Description
BetaAnalyticsData.BetaAnalyticsDataClient

Overrides

BetaAnalyticsDataClient.GrpcClient

Methods

BatchRunPivotReports(BatchRunPivotReportsRequest, CallSettings)

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

Declaration

public override BatchRunPivotReportsResponse BatchRunPivotReports(BatchRunPivotReportsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
BatchRunPivotReportsRequest	request	The request object containing all of the parameters for the API call.
Google.Api.Gax.Grpc.CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
BatchRunPivotReportsResponse	The RPC response.

Overrides

BetaAnalyticsDataClient.BatchRunPivotReports(BatchRunPivotReportsRequest, CallSettings)

BatchRunPivotReportsAsync(BatchRunPivotReportsRequest, CallSettings)

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

Declaration

public override Task<BatchRunPivotReportsResponse> BatchRunPivotReportsAsync(BatchRunPivotReportsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
BatchRunPivotReportsRequest	request	The request object containing all of the parameters for the API call.
Google.Api.Gax.Grpc.CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
System.Threading.Tasks.Task<BatchRunPivotReportsResponse>	A Task containing the RPC response.

Overrides

BetaAnalyticsDataClient.BatchRunPivotReportsAsync(BatchRunPivotReportsRequest, CallSettings)

BatchRunReports(BatchRunReportsRequest, CallSettings)

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

Declaration

public override BatchRunReportsResponse BatchRunReports(BatchRunReportsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
BatchRunReportsRequest	request	The request object containing all of the parameters for the API call.
Google.Api.Gax.Grpc.CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
BatchRunReportsResponse	The RPC response.

Overrides

BetaAnalyticsDataClient.BatchRunReports(BatchRunReportsRequest, CallSettings)

BatchRunReportsAsync(BatchRunReportsRequest, CallSettings)

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

Declaration

public override Task<BatchRunReportsResponse> BatchRunReportsAsync(BatchRunReportsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
BatchRunReportsRequest	request	The request object containing all of the parameters for the API call.
Google.Api.Gax.Grpc.CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
System.Threading.Tasks.Task<BatchRunReportsResponse>	A Task containing the RPC response.

Overrides

BetaAnalyticsDataClient.BatchRunReportsAsync(BatchRunReportsRequest, CallSettings)

CheckCompatibility(CheckCompatibilityRequest, CallSettings)

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 override CheckCompatibilityResponse CheckCompatibility(CheckCompatibilityRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
CheckCompatibilityRequest	request	The request object containing all of the parameters for the API call.
Google.Api.Gax.Grpc.CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
CheckCompatibilityResponse	The RPC response.

Overrides

BetaAnalyticsDataClient.CheckCompatibility(CheckCompatibilityRequest, CallSettings)

CheckCompatibilityAsync(CheckCompatibilityRequest, CallSettings)

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 override Task<CheckCompatibilityResponse> CheckCompatibilityAsync(CheckCompatibilityRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
CheckCompatibilityRequest	request	The request object containing all of the parameters for the API call.
Google.Api.Gax.Grpc.CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
System.Threading.Tasks.Task<CheckCompatibilityResponse>	A Task containing the RPC response.

Overrides

BetaAnalyticsDataClient.CheckCompatibilityAsync(CheckCompatibilityRequest, CallSettings)

GetMetadata(GetMetadataRequest, CallSettings)

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 override Metadata GetMetadata(GetMetadataRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetMetadataRequest	request	The request object containing all of the parameters for the API call.
Google.Api.Gax.Grpc.CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Metadata	The RPC response.

Overrides

BetaAnalyticsDataClient.GetMetadata(GetMetadataRequest, CallSettings)

GetMetadataAsync(GetMetadataRequest, CallSettings)

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 override Task<Metadata> GetMetadataAsync(GetMetadataRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetMetadataRequest	request	The request object containing all of the parameters for the API call.
Google.Api.Gax.Grpc.CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
System.Threading.Tasks.Task<Metadata>	A Task containing the RPC response.

Overrides

BetaAnalyticsDataClient.GetMetadataAsync(GetMetadataRequest, CallSettings)

RunPivotReport(RunPivotReportRequest, CallSettings)

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 override RunPivotReportResponse RunPivotReport(RunPivotReportRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
RunPivotReportRequest	request	The request object containing all of the parameters for the API call.
Google.Api.Gax.Grpc.CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
RunPivotReportResponse	The RPC response.

Overrides

BetaAnalyticsDataClient.RunPivotReport(RunPivotReportRequest, CallSettings)

RunPivotReportAsync(RunPivotReportRequest, CallSettings)

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 override Task<RunPivotReportResponse> RunPivotReportAsync(RunPivotReportRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
RunPivotReportRequest	request	The request object containing all of the parameters for the API call.
Google.Api.Gax.Grpc.CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
System.Threading.Tasks.Task<RunPivotReportResponse>	A Task containing the RPC response.

Overrides

BetaAnalyticsDataClient.RunPivotReportAsync(RunPivotReportRequest, CallSettings)

RunRealtimeReport(RunRealtimeReportRequest, CallSettings)

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 override RunRealtimeReportResponse RunRealtimeReport(RunRealtimeReportRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
RunRealtimeReportRequest	request	The request object containing all of the parameters for the API call.
Google.Api.Gax.Grpc.CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
RunRealtimeReportResponse	The RPC response.

Overrides

BetaAnalyticsDataClient.RunRealtimeReport(RunRealtimeReportRequest, CallSettings)

RunRealtimeReportAsync(RunRealtimeReportRequest, CallSettings)

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 override Task<RunRealtimeReportResponse> RunRealtimeReportAsync(RunRealtimeReportRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
RunRealtimeReportRequest	request	The request object containing all of the parameters for the API call.
Google.Api.Gax.Grpc.CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
System.Threading.Tasks.Task<RunRealtimeReportResponse>	A Task containing the RPC response.

Overrides

BetaAnalyticsDataClient.RunRealtimeReportAsync(RunRealtimeReportRequest, CallSettings)

RunReport(RunReportRequest, CallSettings)

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 override RunReportResponse RunReport(RunReportRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
RunReportRequest	request	The request object containing all of the parameters for the API call.
Google.Api.Gax.Grpc.CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
RunReportResponse	The RPC response.

Overrides

BetaAnalyticsDataClient.RunReport(RunReportRequest, CallSettings)

RunReportAsync(RunReportRequest, CallSettings)

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 override Task<RunReportResponse> RunReportAsync(RunReportRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
RunReportRequest	request	The request object containing all of the parameters for the API call.
Google.Api.Gax.Grpc.CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
System.Threading.Tasks.Task<RunReportResponse>	A Task containing the RPC response.

Overrides

BetaAnalyticsDataClient.RunReportAsync(RunReportRequest, CallSettings)