Class BetaAnalyticsData.BetaAnalyticsDataBase
Base class for server-side implementations of BetaAnalyticsData
Namespace: Google.Analytics.Data.V1Beta
Assembly: Google.Analytics.Data.V1Beta.dll
Syntax
[BindServiceMethod(typeof(BetaAnalyticsData), "BindService")]
public abstract class BetaAnalyticsData.BetaAnalyticsDataBaseMethods
BatchRunPivotReports(BatchRunPivotReportsRequest, ServerCallContext)
Returns multiple pivot reports in a batch. All reports must be for the same GA4 Property.
Declaration
public virtual Task<BatchRunPivotReportsResponse> BatchRunPivotReports(BatchRunPivotReportsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| BatchRunPivotReportsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<BatchRunPivotReportsResponse> | The response to send back to the client (wrapped by a task). |
BatchRunReports(BatchRunReportsRequest, ServerCallContext)
Returns multiple reports in a batch. All reports must be for the same GA4 Property.
Declaration
public virtual Task<BatchRunReportsResponse> BatchRunReports(BatchRunReportsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| BatchRunReportsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<BatchRunReportsResponse> | The response to send back to the client (wrapped by a task). |
CheckCompatibility(CheckCompatibilityRequest, ServerCallContext)
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 Task<CheckCompatibilityResponse> CheckCompatibility(CheckCompatibilityRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| CheckCompatibilityRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<CheckCompatibilityResponse> | The response to send back to the client (wrapped by a task). |
CreateAudienceExport(CreateAudienceExportRequest, ServerCallContext)
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 Task<Operation> CreateAudienceExport(CreateAudienceExportRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| CreateAudienceExportRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<Operation> | The response to send back to the client (wrapped by a task). |
GetAudienceExport(GetAudienceExportRequest, ServerCallContext)
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 virtual Task<AudienceExport> GetAudienceExport(GetAudienceExportRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetAudienceExportRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<AudienceExport> | The response to send back to the client (wrapped by a task). |
GetMetadata(GetMetadataRequest, ServerCallContext)
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 Task<Metadata> GetMetadata(GetMetadataRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetMetadataRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<Metadata> | The response to send back to the client (wrapped by a task). |
ListAudienceExports(ListAudienceExportsRequest, ServerCallContext)
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 virtual Task<ListAudienceExportsResponse> ListAudienceExports(ListAudienceExportsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListAudienceExportsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<ListAudienceExportsResponse> | The response to send back to the client (wrapped by a task). |
QueryAudienceExport(QueryAudienceExportRequest, ServerCallContext)
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 virtual Task<QueryAudienceExportResponse> QueryAudienceExport(QueryAudienceExportRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| QueryAudienceExportRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<QueryAudienceExportResponse> | The response to send back to the client (wrapped by a task). |
RunPivotReport(RunPivotReportRequest, ServerCallContext)
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 Task<RunPivotReportResponse> RunPivotReport(RunPivotReportRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| RunPivotReportRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<RunPivotReportResponse> | The response to send back to the client (wrapped by a task). |
RunRealtimeReport(RunRealtimeReportRequest, ServerCallContext)
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 Task<RunRealtimeReportResponse> RunRealtimeReport(RunRealtimeReportRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| RunRealtimeReportRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<RunRealtimeReportResponse> | The response to send back to the client (wrapped by a task). |
RunReport(RunReportRequest, ServerCallContext)
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 Task<RunReportResponse> RunReport(RunReportRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| RunReportRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| Task<RunReportResponse> | The response to send back to the client (wrapped by a task). |