AnalyticsData

import { AnalyticsData } from "https://googleapis.deno.dev/v1/analyticsdata:v1beta.ts";

Accesses report data in Google Analytics. Warning: Creating multiple Customer Applications, Accounts, or Projects to simulate or act as a single Customer Application, Account, or Project (respectively) or to circumvent Service-specific usage limits or quotas is a direct violation of Google Cloud Platform Terms of Service as well as Google APIs Terms of Service. These actions can result in immediate termination of your GCP project(s) without any warning.

class AnalyticsData {

constructor(client?: CredentialsClient, baseUrl?: string);

async propertiesAudienceExportsCreate(parent: string, req: AudienceExport): Promise<Operation>;

async propertiesAudienceExportsGet(name: string): Promise<AudienceExport>;

async propertiesAudienceExportsList(parent: string, opts?: PropertiesAudienceExportsListOptions): Promise<ListAudienceExportsResponse>;

async propertiesAudienceExportsQuery(name: string, req: QueryAudienceExportRequest): Promise<QueryAudienceExportResponse>;

async propertiesBatchRunPivotReports(property: string, req: BatchRunPivotReportsRequest): Promise<BatchRunPivotReportsResponse>;

async propertiesBatchRunReports(property: string, req: BatchRunReportsRequest): Promise<BatchRunReportsResponse>;

async propertiesCheckCompatibility(property: string, req: CheckCompatibilityRequest): Promise<CheckCompatibilityResponse>;

async propertiesGetMetadata(name: string): Promise<Metadata>;

async propertiesRunPivotReport(property: string, req: RunPivotReportRequest): Promise<RunPivotReportResponse>;

async propertiesRunRealtimeReport(property: string, req: RunRealtimeReportRequest): Promise<RunRealtimeReportResponse>;

async propertiesRunReport(property: string, req: RunReportRequest): Promise<RunReportResponse>;

}

§Constructors

new AnalyticsData(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

propertiesAudienceExportsCreate(parent: string, req: AudienceExport): Promise<Operation>

[src]

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.

@param parent

Required. The parent resource where this audience export will be created. Format: properties/{property}

propertiesAudienceExportsGet(name: string): Promise<AudienceExport>

[src]

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.

@param name

Required. The audience export resource name. Format: properties/{property}/audienceExports/{audience_export}

propertiesAudienceExportsList(parent: string, opts?: PropertiesAudienceExportsListOptions): Promise<ListAudienceExportsResponse>

[src]

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.

@param parent

Required. All audience exports for this property will be listed in the response. Format: properties/{property}

propertiesAudienceExportsQuery(name: string, req: QueryAudienceExportRequest): Promise<QueryAudienceExportResponse>

[src]

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.

@param name

Required. The name of the audience export to retrieve users from. Format: properties/{property}/audienceExports/{audience_export}

propertiesBatchRunPivotReports(property: string, req: BatchRunPivotReportsRequest): Promise<BatchRunPivotReportsResponse>

[src]

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

@param property

A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. This property must be specified for the batch. The property within RunPivotReportRequest may either be unspecified or consistent with this property. Example: properties/1234

propertiesBatchRunReports(property: string, req: BatchRunReportsRequest): Promise<BatchRunReportsResponse>

[src]

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

@param property

A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. This property must be specified for the batch. The property within RunReportRequest may either be unspecified or consistent with this property. Example: properties/1234

propertiesCheckCompatibility(property: string, req: CheckCompatibilityRequest): Promise<CheckCompatibilityResponse>

[src]

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.

@param property

A Google Analytics GA4 property identifier whose events are tracked. To learn more, see where to find your Property ID. property should be the same value as in your runReport request. Example: properties/1234

propertiesGetMetadata(name: string): Promise<Metadata>

[src]

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.

@param name

Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics GA4 Property identifier. To learn more, see where to find your Property ID. Example: properties/1234/metadata Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.

propertiesRunPivotReport(property: string, req: RunPivotReportRequest): Promise<RunPivotReportResponse>

[src]

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.

@param property

A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234

propertiesRunRealtimeReport(property: string, req: RunRealtimeReportRequest): Promise<RunRealtimeReportResponse>

[src]

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.

@param property

A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Example: properties/1234

propertiesRunReport(property: string, req: RunReportRequest): Promise<RunReportResponse>

[src]

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.

@param property