com.google.api.services.analyticsdata.v1beta

Class AnalyticsData.Properties

java.lang.Object

com.google.api.services.analyticsdata.v1beta.AnalyticsData.Properties

Enclosing class:

AnalyticsData

public class AnalyticsData.Properties
extends Object

The "properties" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AnalyticsData.Properties.BatchRunPivotReports
class	AnalyticsData.Properties.BatchRunReports
class	AnalyticsData.Properties.CheckCompatibility
class	AnalyticsData.Properties.GetMetadata
class	AnalyticsData.Properties.RunPivotReport
class	AnalyticsData.Properties.RunRealtimeReport
class	AnalyticsData.Properties.RunReport

Constructor Summary

Constructors

Constructor and Description
Properties()

Method Summary

Modifier and Type	Method and Description
AnalyticsData.Properties.BatchRunPivotReports	batchRunPivotReports(String property, BatchRunPivotReportsRequest content) Returns multiple pivot reports in a batch.
AnalyticsData.Properties.BatchRunReports	batchRunReports(String property, BatchRunReportsRequest content) Returns multiple reports in a batch.
AnalyticsData.Properties.CheckCompatibility	checkCompatibility(String property, CheckCompatibilityRequest content) This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility.
AnalyticsData.Properties.GetMetadata	getMetadata(String name) Returns metadata for dimensions and metrics available in reporting methods.
AnalyticsData.Properties.RunPivotReport	runPivotReport(String property, RunPivotReportRequest content) Returns a customized pivot report of your Google Analytics event data.
AnalyticsData.Properties.RunRealtimeReport	runRealtimeReport(String property, RunRealtimeReportRequest content) Returns a customized report of realtime event data for your property.
AnalyticsData.Properties.RunReport	runReport(String property, RunReportRequest content) Returns a customized report of your Google Analytics event data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Properties

public Properties()

Method Detail

batchRunPivotReports

public AnalyticsData.Properties.BatchRunPivotReports batchRunPivotReports(String property,
                                                                          BatchRunPivotReportsRequest content)
                                                                   throws IOException

Returns multiple pivot reports in a batch. All reports must be for the same GA4 Property. Create a request for the method "properties.batchRunPivotReports". This request holds the parameters needed by the analyticsdata server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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](https://developers.google.com/analytics/devguides/reporting/data/v1/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

content - the BatchRunPivotReportsRequest

Returns:

the request

Throws:

IOException

batchRunReports

public AnalyticsData.Properties.BatchRunReports batchRunReports(String property,
                                                                BatchRunReportsRequest content)
                                                         throws IOException

Returns multiple reports in a batch. All reports must be for the same GA4 Property. Create a request for the method "properties.batchRunReports". This request holds the parameters needed by the analyticsdata server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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](https://developers.google.com/analytics/devguides/reporting/data/v1/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

content - the BatchRunReportsRequest

Returns:

the request

Throws:

IOException

checkCompatibility

public AnalyticsData.Properties.CheckCompatibility checkCompatibility(String property,
                                                                      CheckCompatibilityRequest content)
                                                               throws IOException

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. Create a request for the method "properties.checkCompatibility". This request holds the parameters needed by the analyticsdata server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

property - A Google Analytics GA4 property identifier whose events are tracked. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1 /property-id). `property` should be the same value as in your `runReport` request. Example: properties/1234

content - the CheckCompatibilityRequest

Returns:

the request

Throws:

IOException

getMetadata

public AnalyticsData.Properties.GetMetadata getMetadata(String name)
                                                 throws IOException

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`. Create a request for the method "properties.getMetadata". This request holds the parameters needed by the analyticsdata server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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](https://developers.google.com/analytics/devguides/reporting/data/v1/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.

Returns:

the request

Throws:

IOException

runPivotReport

public AnalyticsData.Properties.RunPivotReport runPivotReport(String property,
                                                              RunPivotReportRequest content)
                                                       throws IOException

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. Create a request for the method "properties.runPivotReport". This request holds the parameters needed by the analyticsdata server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234

content - the RunPivotReportRequest

Returns:

the request

Throws:

IOException

runRealtimeReport

public AnalyticsData.Properties.RunRealtimeReport runRealtimeReport(String property,
                                                                    RunRealtimeReportRequest content)
                                                             throws IOException

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](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics). Create a request for the method "properties.runRealtimeReport". This request holds the parameters needed by the analyticsdata server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: properties/1234

content - the RunRealtimeReportRequest

Returns:

the request

Throws:

IOException

runReport

public AnalyticsData.Properties.RunReport runReport(String property,
                                                    RunReportRequest content)
                                             throws IOException

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](https://developers.google.com/analytics/devguides/reporting/data/v1/basics). Create a request for the method "properties.runReport". This request holds the parameters needed by the analyticsdata server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234

content - the RunReportRequest

Returns:

the request

Throws:

IOException