Class AlphaAnalyticsData.AlphaAnalyticsDataClient
Client for AlphaAnalyticsData
Inheritance
Inherited Members
Namespace: Google.Analytics.Data.V1Alpha
Assembly: Google.Analytics.Data.V1Alpha.dll
Syntax
public class AlphaAnalyticsDataClient : ClientBase<AlphaAnalyticsData.AlphaAnalyticsDataClient>
Constructors
AlphaAnalyticsDataClient()
Protected parameterless constructor to allow creation of test doubles.
Declaration
protected AlphaAnalyticsDataClient()
AlphaAnalyticsDataClient(CallInvoker)
Creates a new client for AlphaAnalyticsData that uses a custom CallInvoker
.
Declaration
public AlphaAnalyticsDataClient(CallInvoker callInvoker)
Parameters
Type | Name | Description |
---|---|---|
Grpc.Core.CallInvoker | callInvoker | The callInvoker to use to make remote calls. |
AlphaAnalyticsDataClient(ChannelBase)
Creates a new client for AlphaAnalyticsData
Declaration
public AlphaAnalyticsDataClient(ChannelBase channel)
Parameters
Type | Name | Description |
---|---|---|
Grpc.Core.ChannelBase | channel | The channel to use to make remote calls. |
AlphaAnalyticsDataClient(ClientBase.ClientBaseConfiguration)
Protected constructor to allow creation of configured clients.
Declaration
protected AlphaAnalyticsDataClient(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type | Name | Description |
---|---|---|
Grpc.Core.ClientBase.ClientBaseConfiguration | configuration | The client configuration. |
Methods
BatchRunPivotReports(BatchRunPivotReportsRequest, CallOptions)
Returns multiple pivot reports in a batch. All reports must be for the same Entity.
Declaration
public virtual BatchRunPivotReportsResponse BatchRunPivotReports(BatchRunPivotReportsRequest request, CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
BatchRunPivotReportsRequest | request | The request to send to the server. |
Grpc.Core.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
BatchRunPivotReportsResponse | The response received from the server. |
BatchRunPivotReports(BatchRunPivotReportsRequest, Metadata, Nullable<DateTime>, CancellationToken)
Returns multiple pivot reports in a batch. All reports must be for the same Entity.
Declaration
public virtual BatchRunPivotReportsResponse BatchRunPivotReports(BatchRunPivotReportsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
BatchRunPivotReportsRequest | request | The request to send to the server. |
Grpc.Core.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<System.DateTime> | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
System.Threading.CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
BatchRunPivotReportsResponse | The response received from the server. |
BatchRunPivotReportsAsync(BatchRunPivotReportsRequest, CallOptions)
Returns multiple pivot reports in a batch. All reports must be for the same Entity.
Declaration
public virtual AsyncUnaryCall<BatchRunPivotReportsResponse> BatchRunPivotReportsAsync(BatchRunPivotReportsRequest request, CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
BatchRunPivotReportsRequest | request | The request to send to the server. |
Grpc.Core.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
Grpc.Core.AsyncUnaryCall<BatchRunPivotReportsResponse> | The call object. |
BatchRunPivotReportsAsync(BatchRunPivotReportsRequest, Metadata, Nullable<DateTime>, CancellationToken)
Returns multiple pivot reports in a batch. All reports must be for the same Entity.
Declaration
public virtual AsyncUnaryCall<BatchRunPivotReportsResponse> BatchRunPivotReportsAsync(BatchRunPivotReportsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
BatchRunPivotReportsRequest | request | The request to send to the server. |
Grpc.Core.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<System.DateTime> | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
System.Threading.CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
Grpc.Core.AsyncUnaryCall<BatchRunPivotReportsResponse> | The call object. |
BatchRunReports(BatchRunReportsRequest, CallOptions)
Returns multiple reports in a batch. All reports must be for the same Entity.
Declaration
public virtual BatchRunReportsResponse BatchRunReports(BatchRunReportsRequest request, CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
BatchRunReportsRequest | request | The request to send to the server. |
Grpc.Core.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
BatchRunReportsResponse | The response received from the server. |
BatchRunReports(BatchRunReportsRequest, Metadata, Nullable<DateTime>, CancellationToken)
Returns multiple reports in a batch. All reports must be for the same Entity.
Declaration
public virtual BatchRunReportsResponse BatchRunReports(BatchRunReportsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
BatchRunReportsRequest | request | The request to send to the server. |
Grpc.Core.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<System.DateTime> | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
System.Threading.CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
BatchRunReportsResponse | The response received from the server. |
BatchRunReportsAsync(BatchRunReportsRequest, CallOptions)
Returns multiple reports in a batch. All reports must be for the same Entity.
Declaration
public virtual AsyncUnaryCall<BatchRunReportsResponse> BatchRunReportsAsync(BatchRunReportsRequest request, CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
BatchRunReportsRequest | request | The request to send to the server. |
Grpc.Core.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
Grpc.Core.AsyncUnaryCall<BatchRunReportsResponse> | The call object. |
BatchRunReportsAsync(BatchRunReportsRequest, Metadata, Nullable<DateTime>, CancellationToken)
Returns multiple reports in a batch. All reports must be for the same Entity.
Declaration
public virtual AsyncUnaryCall<BatchRunReportsResponse> BatchRunReportsAsync(BatchRunReportsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
BatchRunReportsRequest | request | The request to send to the server. |
Grpc.Core.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<System.DateTime> | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
System.Threading.CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
Grpc.Core.AsyncUnaryCall<BatchRunReportsResponse> | The call object. |
GetMetadata(GetMetadataRequest, CallOptions)
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 Metadata GetMetadata(GetMetadataRequest request, CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
GetMetadataRequest | request | The request to send to the server. |
Grpc.Core.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
Metadata | The response received from the server. |
GetMetadata(GetMetadataRequest, Metadata, Nullable<DateTime>, CancellationToken)
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 Metadata GetMetadata(GetMetadataRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
GetMetadataRequest | request | The request to send to the server. |
Grpc.Core.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<System.DateTime> | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
System.Threading.CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
Metadata | The response received from the server. |
GetMetadataAsync(GetMetadataRequest, CallOptions)
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 AsyncUnaryCall<Metadata> GetMetadataAsync(GetMetadataRequest request, CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
GetMetadataRequest | request | The request to send to the server. |
Grpc.Core.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
Grpc.Core.AsyncUnaryCall<Metadata> | The call object. |
GetMetadataAsync(GetMetadataRequest, Metadata, Nullable<DateTime>, CancellationToken)
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 AsyncUnaryCall<Metadata> GetMetadataAsync(GetMetadataRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
GetMetadataRequest | request | The request to send to the server. |
Grpc.Core.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<System.DateTime> | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
System.Threading.CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
Grpc.Core.AsyncUnaryCall<Metadata> | The call object. |
NewInstance(ClientBase.ClientBaseConfiguration)
Creates a new instance of client from given ClientBaseConfiguration
.
Declaration
protected override AlphaAnalyticsData.AlphaAnalyticsDataClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type | Name | Description |
---|---|---|
Grpc.Core.ClientBase.ClientBaseConfiguration | configuration |
Returns
Type | Description |
---|---|
AlphaAnalyticsData.AlphaAnalyticsDataClient |
Overrides
RunPivotReport(RunPivotReportRequest, CallOptions)
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 RunPivotReportResponse RunPivotReport(RunPivotReportRequest request, CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
RunPivotReportRequest | request | The request to send to the server. |
Grpc.Core.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
RunPivotReportResponse | The response received from the server. |
RunPivotReport(RunPivotReportRequest, Metadata, Nullable<DateTime>, CancellationToken)
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 RunPivotReportResponse RunPivotReport(RunPivotReportRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
RunPivotReportRequest | request | The request to send to the server. |
Grpc.Core.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<System.DateTime> | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
System.Threading.CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
RunPivotReportResponse | The response received from the server. |
RunPivotReportAsync(RunPivotReportRequest, CallOptions)
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 AsyncUnaryCall<RunPivotReportResponse> RunPivotReportAsync(RunPivotReportRequest request, CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
RunPivotReportRequest | request | The request to send to the server. |
Grpc.Core.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
Grpc.Core.AsyncUnaryCall<RunPivotReportResponse> | The call object. |
RunPivotReportAsync(RunPivotReportRequest, Metadata, Nullable<DateTime>, CancellationToken)
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 AsyncUnaryCall<RunPivotReportResponse> RunPivotReportAsync(RunPivotReportRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
RunPivotReportRequest | request | The request to send to the server. |
Grpc.Core.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<System.DateTime> | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
System.Threading.CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
Grpc.Core.AsyncUnaryCall<RunPivotReportResponse> | The call object. |
RunRealtimeReport(RunRealtimeReportRequest, CallOptions)
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 RunRealtimeReportResponse RunRealtimeReport(RunRealtimeReportRequest request, CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
RunRealtimeReportRequest | request | The request to send to the server. |
Grpc.Core.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
RunRealtimeReportResponse | The response received from the server. |
RunRealtimeReport(RunRealtimeReportRequest, Metadata, Nullable<DateTime>, CancellationToken)
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 RunRealtimeReportResponse RunRealtimeReport(RunRealtimeReportRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
RunRealtimeReportRequest | request | The request to send to the server. |
Grpc.Core.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<System.DateTime> | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
System.Threading.CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
RunRealtimeReportResponse | The response received from the server. |
RunRealtimeReportAsync(RunRealtimeReportRequest, CallOptions)
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 AsyncUnaryCall<RunRealtimeReportResponse> RunRealtimeReportAsync(RunRealtimeReportRequest request, CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
RunRealtimeReportRequest | request | The request to send to the server. |
Grpc.Core.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
Grpc.Core.AsyncUnaryCall<RunRealtimeReportResponse> | The call object. |
RunRealtimeReportAsync(RunRealtimeReportRequest, Metadata, Nullable<DateTime>, CancellationToken)
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 AsyncUnaryCall<RunRealtimeReportResponse> RunRealtimeReportAsync(RunRealtimeReportRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
RunRealtimeReportRequest | request | The request to send to the server. |
Grpc.Core.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<System.DateTime> | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
System.Threading.CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
Grpc.Core.AsyncUnaryCall<RunRealtimeReportResponse> | The call object. |
RunReport(RunReportRequest, CallOptions)
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 RunReportResponse RunReport(RunReportRequest request, CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
RunReportRequest | request | The request to send to the server. |
Grpc.Core.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
RunReportResponse | The response received from the server. |
RunReport(RunReportRequest, Metadata, Nullable<DateTime>, CancellationToken)
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 RunReportResponse RunReport(RunReportRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
RunReportRequest | request | The request to send to the server. |
Grpc.Core.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<System.DateTime> | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
System.Threading.CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
RunReportResponse | The response received from the server. |
RunReportAsync(RunReportRequest, CallOptions)
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 AsyncUnaryCall<RunReportResponse> RunReportAsync(RunReportRequest request, CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
RunReportRequest | request | The request to send to the server. |
Grpc.Core.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
Grpc.Core.AsyncUnaryCall<RunReportResponse> | The call object. |
RunReportAsync(RunReportRequest, Metadata, Nullable<DateTime>, CancellationToken)
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 AsyncUnaryCall<RunReportResponse> RunReportAsync(RunReportRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
RunReportRequest | request | The request to send to the server. |
Grpc.Core.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<System.DateTime> | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
System.Threading.CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
Grpc.Core.AsyncUnaryCall<RunReportResponse> | The call object. |