Class DataResource.GaResource.GetRequest

Returns Analytics data for a view (profile).

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GaData>
AnalyticsBaseServiceRequest<GaData>
DataResource.GaResource.GetRequest
Implements
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Analytics.v3
Assembly: Google.Apis.Analytics.v3.dll
Syntax
public class DataResource.GaResource.GetRequest : AnalyticsBaseServiceRequest<GaData>, IClientServiceRequest<GaData>, IClientServiceRequest

Constructors

GetRequest(IClientService, string, string, string, string)

Constructs a new Get request.

Declaration
public GetRequest(IClientService service, string ids, string startDate, string endDate, string metrics)
Parameters
Type Name Description
IClientService service
string ids
string startDate
string endDate
string metrics

Properties

Dimensions

A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.

Declaration
[RequestParameter("dimensions", RequestParameterType.Query)]
public virtual string Dimensions { get; set; }
Property Value
Type Description
string

EndDate

End date for fetching Analytics data. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday.

Declaration
[RequestParameter("end-date", RequestParameterType.Query)]
public virtual string EndDate { get; }
Property Value
Type Description
string

Filters

A comma-separated list of dimension or metric filters to be applied to Analytics data.

Declaration
[RequestParameter("filters", RequestParameterType.Query)]
public virtual string Filters { get; set; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Analytics.v3.Data.GaData>.HttpMethod

Ids

Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.

Declaration
[RequestParameter("ids", RequestParameterType.Query)]
public virtual string Ids { get; }
Property Value
Type Description
string

IncludeEmptyRows

The response will include empty rows if this parameter is set to true, the default is true

Declaration
[RequestParameter("include-empty-rows", RequestParameterType.Query)]
public virtual bool? IncludeEmptyRows { get; set; }
Property Value
Type Description
bool?

MaxResults

The maximum number of entries to include in this feed.

Declaration
[RequestParameter("max-results", RequestParameterType.Query)]
public virtual int? MaxResults { get; set; }
Property Value
Type Description
int?

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Analytics.v3.Data.GaData>.MethodName

Metrics

A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified.

Declaration
[RequestParameter("metrics", RequestParameterType.Query)]
public virtual string Metrics { get; }
Property Value
Type Description
string

Output

The selected format for the response. Default format is JSON.

Declaration
[RequestParameter("output", RequestParameterType.Query)]
public virtual DataResource.GaResource.GetRequest.OutputEnum? Output { get; set; }
Property Value
Type Description
DataResource.GaResource.GetRequest.OutputEnum?

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Analytics.v3.Data.GaData>.RestPath

SamplingLevel

The desired sampling level.

Declaration
[RequestParameter("samplingLevel", RequestParameterType.Query)]
public virtual DataResource.GaResource.GetRequest.SamplingLevelEnum? SamplingLevel { get; set; }
Property Value
Type Description
DataResource.GaResource.GetRequest.SamplingLevelEnum?

Segment

An Analytics segment to be applied to data.

Declaration
[RequestParameter("segment", RequestParameterType.Query)]
public virtual string Segment { get; set; }
Property Value
Type Description
string

Sort

A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.

Declaration
[RequestParameter("sort", RequestParameterType.Query)]
public virtual string Sort { get; set; }
Property Value
Type Description
string

StartDate

Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.

Declaration
[RequestParameter("start-date", RequestParameterType.Query)]
public virtual string StartDate { get; }
Property Value
Type Description
string

StartIndex

An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

Declaration
[RequestParameter("start-index", RequestParameterType.Query)]
public virtual int? StartIndex { get; set; }
Property Value
Type Description
int?

Methods

InitParameters()

Initializes Get parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Analytics.v3.AnalyticsBaseServiceRequest<Google.Apis.Analytics.v3.Data.GaData>.InitParameters()

Implements