Class google.gdata.analytics.DataQuery

Object
   |
   +--google.gdata.client.Query
         |
         +--google.gdata.analytics.DataQuery

class google.gdata.analytics.DataQuery

extends google.gdata.client.Query

Describes a query for the arbitrary data from an Analytics profile.
Defined in gdata.js

Constructor Detail

google.gdata.analytics.DataQuery

google.gdata.analytics.DataQuery(<string> feedUri)

Constructor.

Parameters:
feedUri - URI of feed.

getDimensions

String? getDimensions()

Returns the comma separated list of row keys.

Returns:
Comma separated list of row keys or null to indicate that the parameter is disabled.

getEndDate

String? getEndDate()

Returns the last day for which to retrieve data in form YYYY-MM-DD.

Returns:
Last day for which to retrieve data in form YYYY-MM-DD or null to indicate that the parameter is disabled.

getFilters

String? getFilters()

Returns the dimension and metric filters.

Returns:
Dimension and metric filters or null to indicate that the parameter is disabled.

getIds

String? getIds()

Returns the Google Analytics profile ID, prefixed by 'ga:'.

Returns:
Google Analytics profile ID, prefixed by 'ga:' or null to indicate that the parameter is disabled.

getMaxResults

Number? getMaxResults()

Returns the maximum number of results to be retrieved.

Returns:
Maximum number of results to be retrieved or null to indicate that the parameter is disabled.

getMetrics

String? getMetrics()

Returns the comma separated list of numeric value fields.

Returns:
Comma separated list of numeric value fields or null to indicate that the parameter is disabled.

getPrettyprint

Boolean? getPrettyprint()

Returns the whether to indent the elements.

Returns:
Whether to indent the elements or null to indicate that the parameter is disabled.

getSort

String? getSort()

Returns the comma separated list of sort parameters in order of importance.

Returns:
Comma separated list of sort parameters in order of importance or null to indicate that the parameter is disabled.

getStartDate

String? getStartDate()

Returns the first day for which to retrieve data in form YYYY-MM-DD.

Returns:
First day for which to retrieve data in form YYYY-MM-DD or null to indicate that the parameter is disabled.

getStartIndex

Number? getStartIndex()

Returns the 1-based index of the first result to be retrieved.

Returns:
1-based index of the first result to be retrieved or null to indicate that the parameter is disabled.

setDimensions

void setDimensions(<String?> dimensions)

Sets the comma separated list of row keys.

Parameters:
dimensions - Comma separated list of row keys or null to disable this parameter.

setEndDate

void setEndDate(<String?> endDate)

Sets the last day for which to retrieve data in form YYYY-MM-DD.

Parameters:
endDate - Last day for which to retrieve data in form YYYY-MM-DD or null to disable this parameter.

setFilters

void setFilters(<String?> filters)

Sets the dimension and metric filters.

Parameters:
filters - Dimension and metric filters or null to disable this parameter.

setIds

void setIds(<String?> ids)

Sets the Google Analytics profile ID, prefixed by 'ga:'.

Parameters:
ids - Google Analytics profile ID, prefixed by 'ga:' or null to disable this parameter.

setMaxResults

void setMaxResults(<Number|string|null> maxResults)

Sets the maximum number of results to be retrieved.

Parameters:
maxResults - Maximum number of results to be retrieved or an equivalent string value or null to disable this parameter.

setMetrics

void setMetrics(<String?> metrics)

Sets the comma separated list of numeric value fields.

Parameters:
metrics - Comma separated list of numeric value fields or null to disable this parameter.

setPrettyprint

void setPrettyprint(<Boolean|string|null> prettyprint)

Sets the whether to indent the elements. The default value is false.

Parameters:
prettyprint - Whether to indent the elements or an equivalent string value or null to disable this parameter.

setSort

void setSort(<String?> sort)

Sets the comma separated list of sort parameters in order of importance.

Parameters:
sort - Comma separated list of sort parameters in order of importance or null to disable this parameter.

setStartDate

void setStartDate(<String?> startDate)

Sets the first day for which to retrieve data in form YYYY-MM-DD.

Parameters:
startDate - First day for which to retrieve data in form YYYY-MM-DD or null to disable this parameter.

setStartIndex

void setStartIndex(<Number|string|null> startIndex)

Sets the 1-based index of the first result to be retrieved. The default value is 1.

Parameters:
startIndex - 1-based index of the first result to be retrieved or an equivalent string value or null to disable this parameter.