Class BetaAnalyticsData.BetaAnalyticsDataClient

Client for BetaAnalyticsData

Inheritance

object

ClientBase

ClientBase<BetaAnalyticsData.BetaAnalyticsDataClient>

BetaAnalyticsData.BetaAnalyticsDataClient

Inherited Members

ClientBase<BetaAnalyticsData.BetaAnalyticsDataClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Analytics.Data.V1Beta

Assembly: Google.Analytics.Data.V1Beta.dll

Syntax

public class BetaAnalyticsData.BetaAnalyticsDataClient : ClientBase<BetaAnalyticsData.BetaAnalyticsDataClient>

Constructors

BetaAnalyticsDataClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration

protected BetaAnalyticsDataClient()

BetaAnalyticsDataClient(CallInvoker)

Creates a new client for BetaAnalyticsData that uses a custom CallInvoker.

Declaration

public BetaAnalyticsDataClient(CallInvoker callInvoker)

Parameters

Type	Name	Description
CallInvoker	callInvoker	The callInvoker to use to make remote calls.

BetaAnalyticsDataClient(ChannelBase)

Creates a new client for BetaAnalyticsData

Declaration

public BetaAnalyticsDataClient(ChannelBase channel)

Parameters

Type	Name	Description
ChannelBase	channel	The channel to use to make remote calls.

BetaAnalyticsDataClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration

protected BetaAnalyticsDataClient(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration	The client configuration.

Methods

BatchRunPivotReports(BatchRunPivotReportsRequest, CallOptions)

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

Declaration

public virtual BatchRunPivotReportsResponse BatchRunPivotReports(BatchRunPivotReportsRequest request, CallOptions options)

Parameters

Type	Name	Description
BatchRunPivotReportsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
BatchRunPivotReportsResponse	The response received from the server.

BatchRunPivotReports(BatchRunPivotReportsRequest, Metadata, DateTime?, CancellationToken)

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

Declaration

public virtual BatchRunPivotReportsResponse BatchRunPivotReports(BatchRunPivotReportsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchRunPivotReportsRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
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 GA4 Property.

Declaration

public virtual AsyncUnaryCall<BatchRunPivotReportsResponse> BatchRunPivotReportsAsync(BatchRunPivotReportsRequest request, CallOptions options)

Parameters

Type	Name	Description
BatchRunPivotReportsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<BatchRunPivotReportsResponse>	The call object.

BatchRunPivotReportsAsync(BatchRunPivotReportsRequest, Metadata, DateTime?, CancellationToken)

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

Declaration

public virtual AsyncUnaryCall<BatchRunPivotReportsResponse> BatchRunPivotReportsAsync(BatchRunPivotReportsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchRunPivotReportsRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<BatchRunPivotReportsResponse>	The call object.

BatchRunReports(BatchRunReportsRequest, CallOptions)

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

Declaration

public virtual BatchRunReportsResponse BatchRunReports(BatchRunReportsRequest request, CallOptions options)

Parameters

Type	Name	Description
BatchRunReportsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
BatchRunReportsResponse	The response received from the server.

BatchRunReports(BatchRunReportsRequest, Metadata, DateTime?, CancellationToken)

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

Declaration

public virtual BatchRunReportsResponse BatchRunReports(BatchRunReportsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchRunReportsRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
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 GA4 Property.

Declaration

public virtual AsyncUnaryCall<BatchRunReportsResponse> BatchRunReportsAsync(BatchRunReportsRequest request, CallOptions options)

Parameters

Type	Name	Description
BatchRunReportsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<BatchRunReportsResponse>	The call object.

BatchRunReportsAsync(BatchRunReportsRequest, Metadata, DateTime?, CancellationToken)

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

Declaration

public virtual AsyncUnaryCall<BatchRunReportsResponse> BatchRunReportsAsync(BatchRunReportsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchRunReportsRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<BatchRunReportsResponse>	The call object.

CheckCompatibility(CheckCompatibilityRequest, CallOptions)

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 CheckCompatibilityResponse CheckCompatibility(CheckCompatibilityRequest request, CallOptions options)

Parameters

Type	Name	Description
CheckCompatibilityRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
CheckCompatibilityResponse	The response received from the server.

CheckCompatibility(CheckCompatibilityRequest, Metadata, DateTime?, CancellationToken)

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.

The Realtime and Core reports have different compatibility rules. This method checks compatibility for Core reports.

Declaration

public virtual CheckCompatibilityResponse CheckCompatibility(CheckCompatibilityRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CheckCompatibilityRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
CheckCompatibilityResponse	The response received from the server.

CheckCompatibilityAsync(CheckCompatibilityRequest, CallOptions)

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.

The Realtime and Core reports have different compatibility rules. This method checks compatibility for Core reports.

Declaration

public virtual AsyncUnaryCall<CheckCompatibilityResponse> CheckCompatibilityAsync(CheckCompatibilityRequest request, CallOptions options)

Parameters

Type	Name	Description
CheckCompatibilityRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<CheckCompatibilityResponse>	The call object.

CheckCompatibilityAsync(CheckCompatibilityRequest, Metadata, DateTime?, CancellationToken)

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.

The Realtime and Core reports have different compatibility rules. This method checks compatibility for Core reports.

Declaration

public virtual AsyncUnaryCall<CheckCompatibilityResponse> CheckCompatibilityAsync(CheckCompatibilityRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CheckCompatibilityRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<CheckCompatibilityResponse>	The call object.

CreateAudienceExport(CreateAudienceExportRequest, CallOptions)

Creates an audience export for later retrieval. This method quickly returns the audience export's resource name and initiates a long running asynchronous request to form an audience export. To export the users in an audience export, first create the audience export through this method and then send the audience resource name to the QueryAudienceExport method.

See Creating an Audience Export for an introduction to Audience Exports with examples.

An audience export is a snapshot of the users currently in the audience at the time of audience export creation. Creating audience exports for one audience on different days will return different results as users enter and exit the audience.

Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. Audience exports contain the users in each audience.

Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form.

Declaration

public virtual Operation CreateAudienceExport(CreateAudienceExportRequest request, CallOptions options)

Parameters

Type	Name	Description
CreateAudienceExportRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Operation	The response received from the server.

CreateAudienceExport(CreateAudienceExportRequest, Metadata, DateTime?, CancellationToken)

See Creating an Audience Export for an introduction to Audience Exports with examples.

Declaration

public virtual Operation CreateAudienceExport(CreateAudienceExportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateAudienceExportRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
Operation	The response received from the server.

CreateAudienceExportAsync(CreateAudienceExportRequest, CallOptions)

See Creating an Audience Export for an introduction to Audience Exports with examples.

Declaration

public virtual AsyncUnaryCall<Operation> CreateAudienceExportAsync(CreateAudienceExportRequest request, CallOptions options)

Parameters

Type	Name	Description
CreateAudienceExportRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	The call object.

CreateAudienceExportAsync(CreateAudienceExportRequest, Metadata, DateTime?, CancellationToken)

See Creating an Audience Export for an introduction to Audience Exports with examples.

Declaration

public virtual AsyncUnaryCall<Operation> CreateAudienceExportAsync(CreateAudienceExportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateAudienceExportRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	The call object.

CreateOperationsClient()

Creates a new instance of Google.LongRunning.Operations.OperationsClient using the same call invoker as this client.

Declaration

public virtual Operations.OperationsClient CreateOperationsClient()

Returns

Type	Description
Operations.OperationsClient	A new Operations client for the same target as this client.

GetAudienceExport(GetAudienceExportRequest, CallOptions)

Gets configuration metadata about a specific audience export. This method can be used to understand an audience export after it has been created.

See Creating an Audience Export for an introduction to Audience Exports with examples.

Declaration

public virtual AudienceExport GetAudienceExport(GetAudienceExportRequest request, CallOptions options)

Parameters

Type	Name	Description
GetAudienceExportRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AudienceExport	The response received from the server.

GetAudienceExport(GetAudienceExportRequest, Metadata, DateTime?, CancellationToken)

Gets configuration metadata about a specific audience export. This method can be used to understand an audience export after it has been created.

See Creating an Audience Export for an introduction to Audience Exports with examples.

Declaration

public virtual AudienceExport GetAudienceExport(GetAudienceExportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetAudienceExportRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AudienceExport	The response received from the server.

GetAudienceExportAsync(GetAudienceExportRequest, CallOptions)

Gets configuration metadata about a specific audience export. This method can be used to understand an audience export after it has been created.

See Creating an Audience Export for an introduction to Audience Exports with examples.

Declaration

public virtual AsyncUnaryCall<AudienceExport> GetAudienceExportAsync(GetAudienceExportRequest request, CallOptions options)

Parameters

Type	Name	Description
GetAudienceExportRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<AudienceExport>	The call object.

GetAudienceExportAsync(GetAudienceExportRequest, Metadata, DateTime?, CancellationToken)

Gets configuration metadata about a specific audience export. This method can be used to understand an audience export after it has been created.

See Creating an Audience Export for an introduction to Audience Exports with examples.

Declaration

public virtual AsyncUnaryCall<AudienceExport> GetAudienceExportAsync(GetAudienceExportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetAudienceExportRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<AudienceExport>	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.
CallOptions	options	The options for the call.

Returns

Type	Description
Metadata	The response received from the server.

GetMetadata(GetMetadataRequest, Metadata, DateTime?, CancellationToken)

Declaration

public virtual Metadata GetMetadata(GetMetadataRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetMetadataRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
Metadata	The response received from the server.

GetMetadataAsync(GetMetadataRequest, CallOptions)

Declaration

public virtual AsyncUnaryCall<Metadata> GetMetadataAsync(GetMetadataRequest request, CallOptions options)

Parameters

Type	Name	Description
GetMetadataRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Metadata>	The call object.

GetMetadataAsync(GetMetadataRequest, Metadata, DateTime?, CancellationToken)

Declaration

public virtual AsyncUnaryCall<Metadata> GetMetadataAsync(GetMetadataRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetMetadataRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Metadata>	The call object.

ListAudienceExports(ListAudienceExportsRequest, CallOptions)

Lists all audience exports for a property. This method can be used for you to find and reuse existing audience exports rather than creating unnecessary new audience exports. The same audience can have multiple audience exports that represent the export of users that were in an audience on different days.

See Creating an Audience Export for an introduction to Audience Exports with examples.

Declaration

public virtual ListAudienceExportsResponse ListAudienceExports(ListAudienceExportsRequest request, CallOptions options)

Parameters

Type	Name	Description
ListAudienceExportsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
ListAudienceExportsResponse	The response received from the server.

ListAudienceExports(ListAudienceExportsRequest, Metadata, DateTime?, CancellationToken)

See Creating an Audience Export for an introduction to Audience Exports with examples.

Declaration

public virtual ListAudienceExportsResponse ListAudienceExports(ListAudienceExportsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListAudienceExportsRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
ListAudienceExportsResponse	The response received from the server.

ListAudienceExportsAsync(ListAudienceExportsRequest, CallOptions)

See Creating an Audience Export for an introduction to Audience Exports with examples.

Declaration

public virtual AsyncUnaryCall<ListAudienceExportsResponse> ListAudienceExportsAsync(ListAudienceExportsRequest request, CallOptions options)

Parameters

Type	Name	Description
ListAudienceExportsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<ListAudienceExportsResponse>	The call object.

ListAudienceExportsAsync(ListAudienceExportsRequest, Metadata, DateTime?, CancellationToken)

See Creating an Audience Export for an introduction to Audience Exports with examples.

Declaration

public virtual AsyncUnaryCall<ListAudienceExportsResponse> ListAudienceExportsAsync(ListAudienceExportsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListAudienceExportsRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<ListAudienceExportsResponse>	The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration

protected override BetaAnalyticsData.BetaAnalyticsDataClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration

Returns

Type	Description
BetaAnalyticsData.BetaAnalyticsDataClient

Overrides

Grpc.Core.ClientBase<Google.Analytics.Data.V1Beta.BetaAnalyticsData.BetaAnalyticsDataClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

QueryAudienceExport(QueryAudienceExportRequest, CallOptions)

Retrieves an audience export of users. After creating an audience, the users are not immediately available for exporting. First, a request to CreateAudienceExport is necessary to create an audience export of users, and then second, this method is used to retrieve the users in the audience export.

See Creating an Audience Export for an introduction to Audience Exports with examples.

Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572.

Declaration

public virtual QueryAudienceExportResponse QueryAudienceExport(QueryAudienceExportRequest request, CallOptions options)

Parameters

Type	Name	Description
QueryAudienceExportRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
QueryAudienceExportResponse	The response received from the server.

QueryAudienceExport(QueryAudienceExportRequest, Metadata, DateTime?, CancellationToken)

See Creating an Audience Export for an introduction to Audience Exports with examples.

Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572.

Declaration

public virtual QueryAudienceExportResponse QueryAudienceExport(QueryAudienceExportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
QueryAudienceExportRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
QueryAudienceExportResponse	The response received from the server.

QueryAudienceExportAsync(QueryAudienceExportRequest, CallOptions)

See Creating an Audience Export for an introduction to Audience Exports with examples.

Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572.

Declaration

public virtual AsyncUnaryCall<QueryAudienceExportResponse> QueryAudienceExportAsync(QueryAudienceExportRequest request, CallOptions options)

Parameters

Type	Name	Description
QueryAudienceExportRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<QueryAudienceExportResponse>	The call object.

QueryAudienceExportAsync(QueryAudienceExportRequest, Metadata, DateTime?, CancellationToken)

See Creating an Audience Export for an introduction to Audience Exports with examples.

Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572.

Declaration

public virtual AsyncUnaryCall<QueryAudienceExportResponse> QueryAudienceExportAsync(QueryAudienceExportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
QueryAudienceExportRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<QueryAudienceExportResponse>	The call object.

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.
CallOptions	options	The options for the call.

Returns

Type	Description
RunPivotReportResponse	The response received from the server.

RunPivotReport(RunPivotReportRequest, Metadata, DateTime?, CancellationToken)

Declaration

public virtual RunPivotReportResponse RunPivotReport(RunPivotReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
RunPivotReportRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
RunPivotReportResponse	The response received from the server.

RunPivotReportAsync(RunPivotReportRequest, CallOptions)

Declaration

public virtual AsyncUnaryCall<RunPivotReportResponse> RunPivotReportAsync(RunPivotReportRequest request, CallOptions options)

Parameters

Type	Name	Description
RunPivotReportRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<RunPivotReportResponse>	The call object.

RunPivotReportAsync(RunPivotReportRequest, Metadata, DateTime?, CancellationToken)

Declaration

public virtual AsyncUnaryCall<RunPivotReportResponse> RunPivotReportAsync(RunPivotReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
RunPivotReportRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<RunPivotReportResponse>	The call object.

RunRealtimeReport(RunRealtimeReportRequest, CallOptions)

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.

Declaration

public virtual RunRealtimeReportResponse RunRealtimeReport(RunRealtimeReportRequest request, CallOptions options)

Parameters

Type	Name	Description
RunRealtimeReportRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
RunRealtimeReportResponse	The response received from the server.

RunRealtimeReport(RunRealtimeReportRequest, Metadata, DateTime?, CancellationToken)

For a guide to constructing realtime requests & understanding responses, see Creating a Realtime Report.

Declaration

public virtual RunRealtimeReportResponse RunRealtimeReport(RunRealtimeReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
RunRealtimeReportRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
RunRealtimeReportResponse	The response received from the server.

RunRealtimeReportAsync(RunRealtimeReportRequest, CallOptions)

For a guide to constructing realtime requests & understanding responses, see Creating a Realtime Report.

Declaration

public virtual AsyncUnaryCall<RunRealtimeReportResponse> RunRealtimeReportAsync(RunRealtimeReportRequest request, CallOptions options)

Parameters

Type	Name	Description
RunRealtimeReportRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<RunRealtimeReportResponse>	The call object.

RunRealtimeReportAsync(RunRealtimeReportRequest, Metadata, DateTime?, CancellationToken)

For a guide to constructing realtime requests & understanding responses, see Creating a Realtime Report.

Declaration

public virtual AsyncUnaryCall<RunRealtimeReportResponse> RunRealtimeReportAsync(RunRealtimeReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
RunRealtimeReportRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
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.

For a guide to constructing requests & understanding responses, see Creating a Report.

Declaration

public virtual RunReportResponse RunReport(RunReportRequest request, CallOptions options)

Parameters

Type	Name	Description
RunReportRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
RunReportResponse	The response received from the server.

RunReport(RunReportRequest, Metadata, DateTime?, CancellationToken)

For a guide to constructing requests & understanding responses, see Creating a Report.

Declaration

public virtual RunReportResponse RunReport(RunReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
RunReportRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
RunReportResponse	The response received from the server.

RunReportAsync(RunReportRequest, CallOptions)

For a guide to constructing requests & understanding responses, see Creating a Report.

Declaration

public virtual AsyncUnaryCall<RunReportResponse> RunReportAsync(RunReportRequest request, CallOptions options)

Parameters

Type	Name	Description
RunReportRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<RunReportResponse>	The call object.

RunReportAsync(RunReportRequest, Metadata, DateTime?, CancellationToken)

For a guide to constructing requests & understanding responses, see Creating a Report.

Declaration

public virtual AsyncUnaryCall<RunReportResponse> RunReportAsync(RunReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
RunReportRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<RunReportResponse>	The call object.