Class AlphaAnalyticsDataClientImpl
AlphaAnalyticsData client wrapper implementation, for convenient use.
Inherited Members
Namespace: Google.Analytics.Data.V1Alpha
Assembly: Google.Analytics.Data.V1Alpha.dll
Syntax
public sealed class AlphaAnalyticsDataClientImpl : AlphaAnalyticsDataClient
Remarks
Google Analytics reporting data service.
Constructors
AlphaAnalyticsDataClientImpl(AlphaAnalyticsData.AlphaAnalyticsDataClient, AlphaAnalyticsDataSettings)
Constructs a client wrapper for the AlphaAnalyticsData service, with the specified gRPC client and settings.
Declaration
public AlphaAnalyticsDataClientImpl(AlphaAnalyticsData.AlphaAnalyticsDataClient grpcClient, AlphaAnalyticsDataSettings settings)
Parameters
Type | Name | Description |
---|---|---|
AlphaAnalyticsData.AlphaAnalyticsDataClient | grpcClient | The underlying gRPC client. |
AlphaAnalyticsDataSettings | settings | The base AlphaAnalyticsDataSettings used within this client. |
Properties
GrpcClient
The underlying gRPC AlphaAnalyticsData client
Declaration
public override AlphaAnalyticsData.AlphaAnalyticsDataClient GrpcClient { get; }
Property Value
Type | Description |
---|---|
AlphaAnalyticsData.AlphaAnalyticsDataClient |
Overrides
Methods
BatchRunPivotReports(BatchRunPivotReportsRequest, CallSettings)
Returns multiple pivot reports in a batch. All reports must be for the same Entity.
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
BatchRunPivotReportsAsync(BatchRunPivotReportsRequest, CallSettings)
Returns multiple pivot reports in a batch. All reports must be for the same Entity.
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
BatchRunReports(BatchRunReportsRequest, CallSettings)
Returns multiple reports in a batch. All reports must be for the same Entity.
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
BatchRunReportsAsync(BatchRunReportsRequest, CallSettings)
Returns multiple reports in a batch. All reports must be for the same Entity.
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
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
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
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
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
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
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
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
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. |