analytics  v3
Public Types | Public Member Functions | Protected Member Functions | Properties | List of all members
Google.Apis.Analytics.v3.DataResource.GaResource.GetRequest Class Reference

Returns Analytics data for a view (profile). More...

Inheritance diagram for Google.Apis.Analytics.v3.DataResource.GaResource.GetRequest:
Google.Apis.Analytics.v3.AnalyticsBaseServiceRequest< Google.Apis.Analytics.v3.Data.GaData >

Public Types

enum  SamplingLevelEnum { SamplingLevelEnum.DEFAULT__, SamplingLevelEnum.FASTER, SamplingLevelEnum.HIGHERPRECISION }
 The desired sampling level. More...
 
enum  OutputEnum { OutputEnum.DataTable, OutputEnum.Json }
 The selected format for the response. Default format is JSON. More...
 

Public Member Functions

 GetRequest (Google.Apis.Services.IClientService service, string ids, string startDate, string endDate, string metrics)
 Constructs a new Get request. More...
 

Protected Member Functions

override void InitParameters ()
 Initializes Get parameter list. More...
 
- Protected Member Functions inherited from Google.Apis.Analytics.v3.AnalyticsBaseServiceRequest< Google.Apis.Analytics.v3.Data.GaData >
 AnalyticsBaseServiceRequest (Google.Apis.Services.IClientService service)
 Constructs a new AnalyticsBaseServiceRequest instance. More...
 
override void InitParameters ()
 Initializes Analytics parameter list. More...
 

Properties

virtual string Ids [get]
 Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. More...
 
virtual string StartDate [get]
 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. More...
 
virtual string EndDate [get]
 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. More...
 
virtual string Metrics [get]
 A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified. More...
 
virtual System.Nullable< int > StartIndex [get, set]
 An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. More...
 
virtual System.Nullable< SamplingLevelEnumSamplingLevel [get, set]
 The desired sampling level. More...
 
virtual string Dimensions [get, set]
 A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'. More...
 
virtual string Filters [get, set]
 A comma-separated list of dimension or metric filters to be applied to Analytics data. More...
 
virtual string Sort [get, set]
 A comma-separated list of dimensions or metrics that determine the sort order for Analytics data. More...
 
virtual System.Nullable< bool > IncludeEmptyRows [get, set]
 The response will include empty rows if this parameter is set to true, the default is true More...
 
virtual string Segment [get, set]
 An Analytics segment to be applied to data. More...
 
virtual System.Nullable< OutputEnumOutput [get, set]
 The selected format for the response. Default format is JSON. More...
 
virtual System.Nullable< int > MaxResults [get, set]
 The maximum number of entries to include in this feed. More...
 
override string MethodName [get]
 summary>Gets the HTTP method. More...
 
override string HttpMethod [get]
 summary>Gets the REST path. More...
 
override string RestPath [get]
 
- Properties inherited from Google.Apis.Analytics.v3.AnalyticsBaseServiceRequest< Google.Apis.Analytics.v3.Data.GaData >
virtual System.Nullable< AltEnum > Alt [get, set]
 Data format for the response. More...
 
virtual string Fields [get, set]
 Selector specifying which fields to include in a partial response. More...
 
virtual string Key [get, set]
 API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. More...
 
virtual string OauthToken [get, set]
 OAuth 2.0 token for the current user. More...
 
virtual System.Nullable< bool > PrettyPrint [get, set]
 Returns response with indentations and line breaks. More...
 
virtual string QuotaUser [get, set]
 An opaque string that represents a user for quota purposes. Must not exceed 40 characters. More...
 
virtual string UserIp [get, set]
 Deprecated. Please use quotaUser instead. More...
 

Detailed Description

Returns Analytics data for a view (profile).

Member Enumeration Documentation

◆ OutputEnum

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

Enumerator
DataTable 

Returns the response in Google Charts Data Table format. This is useful in creating visualization using Google Charts.

Json 

Returns the response in standard JSON format.

◆ SamplingLevelEnum

The desired sampling level.

Enumerator
DEFAULT__ 

Returns response with a sample size that balances speed and accuracy.

FASTER 

Returns a fast response with a smaller sample size.

HIGHERPRECISION 

Returns a more accurate response using a large sample size, but this may result in the response being slower.

Constructor & Destructor Documentation

◆ GetRequest()

Google.Apis.Analytics.v3.DataResource.GaResource.GetRequest.GetRequest ( Google.Apis.Services.IClientService  service,
string  ids,
string  startDate,
string  endDate,
string  metrics 
)
inline

Constructs a new Get request.

Member Function Documentation

◆ InitParameters()

override void Google.Apis.Analytics.v3.DataResource.GaResource.GetRequest.InitParameters ( )
inlineprotected

Initializes Get parameter list.

Property Documentation

◆ Dimensions

virtual string Google.Apis.Analytics.v3.DataResource.GaResource.GetRequest.Dimensions
getset

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

◆ EndDate

virtual string Google.Apis.Analytics.v3.DataResource.GaResource.GetRequest.EndDate
get

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.

◆ Filters

virtual string Google.Apis.Analytics.v3.DataResource.GaResource.GetRequest.Filters
getset

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

◆ HttpMethod

override string Google.Apis.Analytics.v3.DataResource.GaResource.GetRequest.HttpMethod
get

summary>Gets the REST path.

◆ Ids

virtual string Google.Apis.Analytics.v3.DataResource.GaResource.GetRequest.Ids
get

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

◆ IncludeEmptyRows

virtual System.Nullable<bool> Google.Apis.Analytics.v3.DataResource.GaResource.GetRequest.IncludeEmptyRows
getset

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

◆ MaxResults

virtual System.Nullable<int> Google.Apis.Analytics.v3.DataResource.GaResource.GetRequest.MaxResults
getset

The maximum number of entries to include in this feed.

summary>Gets the method name.

◆ MethodName

override string Google.Apis.Analytics.v3.DataResource.GaResource.GetRequest.MethodName
get

summary>Gets the HTTP method.

◆ Metrics

virtual string Google.Apis.Analytics.v3.DataResource.GaResource.GetRequest.Metrics
get

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

◆ Output

virtual System.Nullable<OutputEnum> Google.Apis.Analytics.v3.DataResource.GaResource.GetRequest.Output
getset

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

◆ SamplingLevel

virtual System.Nullable<SamplingLevelEnum> Google.Apis.Analytics.v3.DataResource.GaResource.GetRequest.SamplingLevel
getset

The desired sampling level.

◆ Segment

virtual string Google.Apis.Analytics.v3.DataResource.GaResource.GetRequest.Segment
getset

An Analytics segment to be applied to data.

◆ Sort

virtual string Google.Apis.Analytics.v3.DataResource.GaResource.GetRequest.Sort
getset

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

◆ StartDate

virtual string Google.Apis.Analytics.v3.DataResource.GaResource.GetRequest.StartDate
get

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.

◆ StartIndex

virtual System.Nullable<int> Google.Apis.Analytics.v3.DataResource.GaResource.GetRequest.StartIndex
getset

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

[minimum: 1]


The documentation for this class was generated from the following file: