Google Apps Script
Feedback on this document

Class GaDataQuery

From Analytics Services

Members:

MemberTypeDescription
getDimensionsStringList of analytics dimensions.
getEnd-dateStringEnd date.
getFiltersStringComma-separated list of dimension or metric filters.
getIdsStringUnique table ID.
getMax-resultsintMaximum results per page.
getMetricsString[]List of analytics metrics.
getSegmentStringAnalytics advanced segment.
getSortString[]List of dimensions or metrics based on which Analytics data is sorted.
getStart-dateStringStart date.
getStart-indexintStart index.
setDimensionsGaDataQuerySet the value for the field: dimensions
setEnd-dateGaDataQuerySet the value for the field: end-date
setFiltersGaDataQuerySet the value for the field: filters
setIdsGaDataQuerySet the value for the field: ids
setMax-resultsGaDataQuerySet the value for the field: max-results
setMetricsGaDataQuerySet the value for the field: metrics
setSegmentGaDataQuerySet the value for the field: segment
setSortGaDataQuerySet the value for the field: sort
setStart-dateGaDataQuerySet the value for the field: start-date
setStart-indexGaDataQuerySet the value for the field: start-index

method getDimensions()

List of analytics dimensions.

Return Values:

TypeDescription
StringThe current value for dimensions

method getEnd-date()

End date.

Return Values:

TypeDescription
StringThe current value for end-date

method getFilters()

Comma-separated list of dimension or metric filters.

Return Values:

TypeDescription
StringThe current value for filters

method getIds()

Unique table ID.

Return Values:

TypeDescription
StringThe current value for ids

method getMax-results()

Maximum results per page.

Return Values:

TypeDescription
intThe current value for max-results

method getMetrics()

List of analytics metrics.

Return Values:

TypeDescription
String[]The current value for metrics

method getSegment()

Analytics advanced segment.

Return Values:

TypeDescription
StringThe current value for segment

method getSort()

List of dimensions or metrics based on which Analytics data is sorted.

Return Values:

TypeDescription
String[]The current value for sort

method getStart-date()

Start date.

Return Values:

TypeDescription
StringThe current value for start-date

method getStart-index()

Start index.

Return Values:

TypeDescription
intThe current value for start-index

method setDimensions(dimensions)

Set the value for the field: dimensions

Arguments:

NameTypeDescription
dimensionsStringList of analytics dimensions.

Return Values:

TypeDescription
GaDataQueryThe bean object for chaining.

method setEnd-date(end-date)

Set the value for the field: end-date

Arguments:

NameTypeDescription
end-dateStringEnd date.

Return Values:

TypeDescription
GaDataQueryThe bean object for chaining.

method setFilters(filters)

Set the value for the field: filters

Arguments:

NameTypeDescription
filtersStringComma-separated list of dimension or metric filters.

Return Values:

TypeDescription
GaDataQueryThe bean object for chaining.

method setIds(ids)

Set the value for the field: ids

Arguments:

NameTypeDescription
idsStringUnique table ID.

Return Values:

TypeDescription
GaDataQueryThe bean object for chaining.

method setMax-results(max-results)

Set the value for the field: max-results

Arguments:

NameTypeDescription
max-resultsintMaximum results per page.

Return Values:

TypeDescription
GaDataQueryThe bean object for chaining.

method setMetrics(metrics)

Set the value for the field: metrics

Arguments:

NameTypeDescription
metricsString[]List of analytics metrics.

Return Values:

TypeDescription
GaDataQueryThe bean object for chaining.

method setSegment(segment)

Set the value for the field: segment

Arguments:

NameTypeDescription
segmentStringAnalytics advanced segment.

Return Values:

TypeDescription
GaDataQueryThe bean object for chaining.

method setSort(sort)

Set the value for the field: sort

Arguments:

NameTypeDescription
sortString[]List of dimensions or metrics based on which Analytics data is sorted.

Return Values:

TypeDescription
GaDataQueryThe bean object for chaining.

method setStart-date(start-date)

Set the value for the field: start-date

Arguments:

NameTypeDescription
start-dateStringStart date.

Return Values:

TypeDescription
GaDataQueryThe bean object for chaining.

method setStart-index(start-index)

Set the value for the field: start-index

Arguments:

NameTypeDescription
start-indexintStart index.

Return Values:

TypeDescription
GaDataQueryThe bean object for chaining.

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.