public class

DataQuery

extends Query

java.lang.Object
↳	com.google.gdata.client.Query
	↳	com.google.gdata.client.analytics.DataQuery

Class Overview

Describes a query for the arbitrary data from an Analytics profile.

Summary

[Expand]

Inherited Constants

From class com.google.gdata.client.Query

Fields
private String	dimensions	Comma separated list of row keys.
private String	endDate	Last day for which to retrieve data in form YYYY-MM-DD.
private String	filters	Dimension and metric filters.
private String	ids	Google Analytics profile ID, prefixed by 'ga:'.
private String	metrics	Comma separated list of numeric value fields.
private String	segment	Segment to be applied.
private String	sort	Comma separated list of sort parameters in order of importance.
private String	startDate	First day for which to retrieve data in form YYYY-MM-DD.

[Expand]

Inherited Fields

From class com.google.gdata.client.Query

private String	author	Author name or e-mail address for matched entries.
private List<Query.CategoryFilter>	categoryFilters	The list of category filters associate with the query.
private List<Query.CustomParameter>	customParameters	The list of custom parameters associated with the query.
private URL	feedUrl	Base feed URL against which the query will be applied.
private String	fields	Fields partial selection query parameter
private int	maxResults	The maximum number of results to return for the query.
private DateTime	publishedMax	Maximum published timestamp for matched entries.
private DateTime	publishedMin	Minimum published timestamp for matched entries.
private String	queryString	Full-text search query string.
private Query.ResultFormat	resultFormat	The expected result format for the query.
private int	startIndex	The start index for query results.
private boolean	strict	The strictness of the query parameter parsing on the server.
private DateTime	updatedMax	Maximum updated timestamp for matched entries.
private DateTime	updatedMin	Minimum updated timestamp for matched entries.

Public Constructors
	DataQuery(URL feedUrl) Constructs a new query object that targets a feed.

Public Methods
String	getDimensions() Returns the comma separated list of row keys.
String	getEndDate() Returns the last day for which to retrieve data in form YYYY-MM-DD.
String	getFilters() Returns the dimension and metric filters.
String	getIds() Returns the Google Analytics profile ID, prefixed by 'ga:'.
String	getMetrics() Returns the comma separated list of numeric value fields.
String	getSegment() Returns the segment to be applied.
String	getSort() Returns the comma separated list of sort parameters in order of importance.
String	getStartDate() Returns the first day for which to retrieve data in form YYYY-MM-DD.
void	setDimensions(String dimensions) Sets the comma separated list of row keys.
void	setEndDate(String endDate) Sets the last day for which to retrieve data in form YYYY-MM-DD.
void	setFilters(String filters) Sets the dimension and metric filters.
void	setIds(String ids) Sets the Google Analytics profile ID, prefixed by 'ga:'.
void	setMetrics(String metrics) Sets the comma separated list of numeric value fields.
void	setSegment(String segment) Sets the segment to be applied.
void	setSort(String sort) Sets the comma separated list of sort parameters in order of importance.
void	setStartDate(String startDate) Sets the first day for which to retrieve data in form YYYY-MM-DD.

[Expand]

Inherited Methods

From class com.google.gdata.client.Query

void	addCategoryFilter(Query.CategoryFilter categoryFilter) Adds a new CategoryFilter to the query.
void	addCustomParameter(Query.CustomParameter customParameter) Adds a new CustomParameter.
void	appendQueryParameter(StringBuilder queryBuf, String paramName, String paramValue) Appends specified query (parameter, value) to provided query URL buffer.
String	getAuthor() Returns the author name or email address used for the query.
List<Query.CategoryFilter>	getCategoryFilters() Returns the current list of CategoryFilters associated with the query.
List<Query.CustomParameter>	getCustomParameters() Returns the list of custom parameters.
List<Query.CustomParameter>	getCustomParameters(String name) Returns the list of custom parameters that match a specified name.
URL	getFeedUrl() Returns the feed URL of this query.
String	getFields() Returns the fields query string that will be used for the query.
String	getFullTextQuery() Returns the full text query string that will be used for the query.
final Integer	getIntegerCustomParameter(String name) Gets an existing Integer custom paramter, with null signifying that the parameter is not specified or not an integer.
int	getMaxResults() Returns the maximum number of results to return for the query, or `UNDEFINED` if max results has not been set.
DateTime	getPublishedMax() Returns the maximum published timestamp used for this query.
DateTime	getPublishedMin() Returns the minimum published timestamp used for this query.
URI	getQueryUri() Returns the relative query URI that represents only the query parameters without any components related to the target feed.
Query.ResultFormat	getResultFormat() Returns the query result format.
int	getStartIndex() Returns the current start index value for the query, or `UNDEFINED` if start index has not been set.
final String	getStringCustomParameter(String name) Gets an existing String custom parameter, with null signifying that the parameter is not specified.
DateTime	getUpdatedMax() Returns the maximum updated timestamp used for this query.
DateTime	getUpdatedMin() Returns the minimum updated timestamp used for this query.
URL	getUrl() Returns the Query URL that encapsulates the current state of this query object.
boolean	isStrict() Returns the strictness setting for query parameter parsing on the server.
boolean	isValidState() Check if current query state is supported.
void	setAuthor(String author) Sets the author name or email address used for the query.
void	setFields(String fields) Sets the "fields" partial selection query parameter.
void	setFullTextQuery(String query) Sets the full text query string that will be used for the query.
final void	setIntegerCustomParameter(String name, Integer value) Sets an integer custom paramter, with null signifying to clear the parameter.
void	setMaxResults(int maxResults) Sets the maximum number of results to return for the query.
void	setPublishedMax(DateTime publishedMax) Sets the maximum published timestamp used for the query.
void	setPublishedMin(DateTime publishedMin) Sets the minimum published timestamp used for the query.
void	setResultFormat(Query.ResultFormat resultFormat) Sets the expected query result format.
void	setStartIndex(int startIndex) Sets the start index for query results.
void	setStrict(boolean strict) Sets the strictness of parameter parsing.
final void	setStringCustomParameter(String name, String value) Sets a string custom parameter, with null signifying to clear the parameter.
void	setUpdatedMax(DateTime updatedMax) Sets the maximum updated timestamp used for the query.
void	setUpdatedMin(DateTime updatedMin) Sets the minimum updated timestamp used for the query.

From class java.lang.Object

Fields

private String dimensions

Comma separated list of row keys.

private String endDate

Last day for which to retrieve data in form YYYY-MM-DD.

private String filters

Dimension and metric filters.

private String ids

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

private String metrics

Comma separated list of numeric value fields.

private String segment

Segment to be applied.

private String sort

Comma separated list of sort parameters in order of importance.

private String startDate

First day for which to retrieve data in form YYYY-MM-DD.

Public Constructors

public DataQuery (URL feedUrl)

Constructs a new query object that targets a feed. The initial state of the query contains no parameters, meaning all entries in the feed would be returned if the query was executed immediately after construction.

Parameters

feedUrl	The URL of the feed against which queries will be executed.

Public Methods

public 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 not set.

public 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 not set.

public String getFilters ()

Returns the dimension and metric filters.

Returns

dimension and metric filters or null to indicate that the parameter is not set.

public 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 not set.

public 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 not set.

public String getSegment ()

Returns the segment to be applied.

Returns

segment to be applied or null to indicate that the parameter is not set.

public 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 not set.

public 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 not set.

public void setDimensions (String dimensions)

Sets the comma separated list of row keys.

Parameters

dimensions	Comma separated list of row keys or `null` to remove this parameter if set.

public 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 remove this parameter if set.

public void setFilters (String filters)

Sets the dimension and metric filters.

Parameters

filters	Dimension and metric filters or `null` to remove this parameter if set.

public 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 remove this parameter if set.

public 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 remove this parameter if set.

public void setSegment (String segment)

Sets the segment to be applied.

Parameters

segment	Segment to be applied or `null` to remove this parameter if set.

public 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 remove this parameter if set.

public 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 remove this parameter if set.

Classes

DataQuery

Class Overview

Summary

Fields

private String dimensions

private String endDate

private String filters

private String ids

private String metrics

private String segment

private String sort

private String startDate

Public Constructors

public DataQuery (URL feedUrl)

Parameters

Public Methods

public String getDimensions ()

Returns

public String getEndDate ()

Returns

public String getFilters ()

Returns

public String getIds ()

Returns

public String getMetrics ()

Returns

public String getSegment ()

Returns

public String getSort ()

Returns

public String getStartDate ()

Returns

public void setDimensions (String dimensions)

Parameters

public void setEndDate (String endDate)

Parameters

public void setFilters (String filters)

Parameters

public void setIds (String ids)

Parameters

public void setMetrics (String metrics)

Parameters

public void setSegment (String segment)

Parameters

public void setSort (String sort)

Parameters

public void setStartDate (String startDate)

Parameters