Class BetaAnalyticsDataClientImpl
BetaAnalyticsData client wrapper implementation, for convenient use.
Inherited Members
Namespace: Google.Analytics.Data.V1Beta
Assembly: Google.Analytics.Data.V1Beta.dll
Syntax
public sealed class BetaAnalyticsDataClientImpl : BetaAnalyticsDataClientRemarks
Google Analytics reporting data service.
Constructors
BetaAnalyticsDataClientImpl(BetaAnalyticsDataClient, BetaAnalyticsDataSettings, ILogger)
Constructs a client wrapper for the BetaAnalyticsData service, with the specified gRPC client and settings.
Declaration
public BetaAnalyticsDataClientImpl(BetaAnalyticsData.BetaAnalyticsDataClient grpcClient, BetaAnalyticsDataSettings settings, ILogger logger)Parameters
| Type | Name | Description |
|---|---|---|
| BetaAnalyticsData.BetaAnalyticsDataClient | grpcClient | The underlying gRPC client. |
| BetaAnalyticsDataSettings | settings | The base BetaAnalyticsDataSettings used within this client. |
| ILogger | logger | Optional ILogger to use within this client. |
Properties
CreateAudienceExportOperationsClient
The long-running operations client for CreateAudienceExport.
Declaration
public override OperationsClient CreateAudienceExportOperationsClient { get; }Property Value
| Type | Description |
|---|---|
| OperationsClient |
Overrides
GrpcClient
The underlying gRPC BetaAnalyticsData client
Declaration
public override BetaAnalyticsData.BetaAnalyticsDataClient GrpcClient { get; }Property Value
| Type | Description |
|---|---|
| BetaAnalyticsData.BetaAnalyticsDataClient |
Overrides
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. |
| 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 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. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| 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 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. |
| 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 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. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<BatchRunReportsResponse> | A Task containing the RPC response. |
Overrides
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. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| CheckCompatibilityResponse | The RPC response. |
Overrides
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. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<CheckCompatibilityResponse> | A Task containing the RPC response. |
Overrides
CreateAudienceExport(CreateAudienceExportRequest, CallSettings)
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 override Operation<AudienceExport, AudienceExportMetadata> CreateAudienceExport(CreateAudienceExportRequest request, CallSettings callSettings = null)Parameters
| Type | Name | Description |
|---|---|---|
| CreateAudienceExportRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Operation<AudienceExport, AudienceExportMetadata> | The RPC response. |
Overrides
CreateAudienceExportAsync(CreateAudienceExportRequest, CallSettings)
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 override Task<Operation<AudienceExport, AudienceExportMetadata>> CreateAudienceExportAsync(CreateAudienceExportRequest request, CallSettings callSettings = null)Parameters
| Type | Name | Description |
|---|---|---|
| CreateAudienceExportRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<Operation<AudienceExport, AudienceExportMetadata>> | A Task containing the RPC response. |
Overrides
GetAudienceExport(GetAudienceExportRequest, CallSettings)
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.
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 override AudienceExport GetAudienceExport(GetAudienceExportRequest request, CallSettings callSettings = null)Parameters
| Type | Name | Description |
|---|---|---|
| GetAudienceExportRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| AudienceExport | The RPC response. |
Overrides
GetAudienceExportAsync(GetAudienceExportRequest, CallSettings)
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.
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 override Task<AudienceExport> GetAudienceExportAsync(GetAudienceExportRequest request, CallSettings callSettings = null)Parameters
| Type | Name | Description |
|---|---|---|
| GetAudienceExportRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<AudienceExport> | 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. |
| 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. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<Metadata> | A Task containing the RPC response. |
Overrides
ListAudienceExports(ListAudienceExportsRequest, CallSettings)
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.
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 override PagedEnumerable<ListAudienceExportsResponse, AudienceExport> ListAudienceExports(ListAudienceExportsRequest request, CallSettings callSettings = null)Parameters
| Type | Name | Description |
|---|---|---|
| ListAudienceExportsRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedEnumerable<ListAudienceExportsResponse, AudienceExport> | A pageable sequence of AudienceExport resources. |
Overrides
ListAudienceExportsAsync(ListAudienceExportsRequest, CallSettings)
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.
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 override PagedAsyncEnumerable<ListAudienceExportsResponse, AudienceExport> ListAudienceExportsAsync(ListAudienceExportsRequest request, CallSettings callSettings = null)Parameters
| Type | Name | Description |
|---|---|---|
| ListAudienceExportsRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedAsyncEnumerable<ListAudienceExportsResponse, AudienceExport> | A pageable asynchronous sequence of AudienceExport resources. |
Overrides
QueryAudienceExport(QueryAudienceExportRequest, CallSettings)
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.
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 override QueryAudienceExportResponse QueryAudienceExport(QueryAudienceExportRequest request, CallSettings callSettings = null)Parameters
| Type | Name | Description |
|---|---|---|
| QueryAudienceExportRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| QueryAudienceExportResponse | The RPC response. |
Overrides
QueryAudienceExportAsync(QueryAudienceExportRequest, CallSettings)
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.
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 override Task<QueryAudienceExportResponse> QueryAudienceExportAsync(QueryAudienceExportRequest request, CallSettings callSettings = null)Parameters
| Type | Name | Description |
|---|---|---|
| QueryAudienceExportRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<QueryAudienceExportResponse> | 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. |
| 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. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<RunPivotReportResponse> | A Task containing the RPC response. |
Overrides
RunRealtimeReport(RunRealtimeReportRequest, CallSettings)
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 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. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| RunRealtimeReportResponse | The RPC response. |
Overrides
RunRealtimeReportAsync(RunRealtimeReportRequest, CallSettings)
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 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. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| 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.
For a guide to constructing requests & understanding responses, see Creating a Report.
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. |
| 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.
For a guide to constructing requests & understanding responses, see Creating a Report.
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. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<RunReportResponse> | A Task containing the RPC response. |