Class PropertiesResource

The "properties" collection of methods.

Inheritance

object

PropertiesResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.AnalyticsData.v1beta

Assembly: Google.Apis.AnalyticsData.v1beta.dll

Syntax

public class PropertiesResource

Constructors

PropertiesResource(IClientService)

Constructs a new resource.

Declaration

public PropertiesResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

AudienceExports

Gets the AudienceExports resource.

Declaration

public virtual PropertiesResource.AudienceExportsResource AudienceExports { get; }

Property Value

Type	Description
PropertiesResource.AudienceExportsResource

Methods

BatchRunPivotReports(BatchRunPivotReportsRequest, string)

Returns multiple pivot reports in a batch. All reports must be for the same Google Analytics property.

Declaration

public virtual PropertiesResource.BatchRunPivotReportsRequest BatchRunPivotReports(BatchRunPivotReportsRequest body, string property)

Parameters

Type	Name	Description
BatchRunPivotReportsRequest	body	The body of the request.
string	property	A Google Analytics 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

Returns

Type	Description
PropertiesResource.BatchRunPivotReportsRequest

BatchRunReports(BatchRunReportsRequest, string)

Returns multiple reports in a batch. All reports must be for the same Google Analytics property.

Declaration

public virtual PropertiesResource.BatchRunReportsRequest BatchRunReports(BatchRunReportsRequest body, string property)

Parameters

Type	Name	Description
BatchRunReportsRequest	body	The body of the request.
string	property	A Google Analytics 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

Returns

Type	Description
PropertiesResource.BatchRunReportsRequest

CheckCompatibility(CheckCompatibilityRequest, string)

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 PropertiesResource.CheckCompatibilityRequest CheckCompatibility(CheckCompatibilityRequest body, string property)

Parameters

Type	Name	Description
CheckCompatibilityRequest	body	The body of the request.
string	property	A Google Analytics 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

Returns

Type	Description
PropertiesResource.CheckCompatibilityRequest

GetMetadata(string)

Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics 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 PropertiesResource.GetMetadataRequest GetMetadata(string name)

Parameters

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

Returns

Type	Description
PropertiesResource.GetMetadataRequest

RunPivotReport(RunPivotReportRequest, string)

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 PropertiesResource.RunPivotReportRequest RunPivotReport(RunPivotReportRequest body, string property)

Parameters

Type	Name	Description
RunPivotReportRequest	body	The body of the request.
string	property	A Google Analytics 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

Returns

Type	Description
PropertiesResource.RunPivotReportRequest

RunRealtimeReport(RunRealtimeReportRequest, string)

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 PropertiesResource.RunRealtimeReportRequest RunRealtimeReport(RunRealtimeReportRequest body, string property)

Parameters

Type	Name	Description
RunRealtimeReportRequest	body	The body of the request.
string	property	A Google Analytics 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

Returns

Type	Description
PropertiesResource.RunRealtimeReportRequest

RunReport(RunReportRequest, string)

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 PropertiesResource.RunReportRequest RunReport(RunReportRequest body, string property)

Parameters

Type	Name	Description
RunReportRequest	body	The body of the request.
string	property	A Google Analytics 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

Returns

Type	Description
PropertiesResource.RunReportRequest