com.google.api.services.analytics.model

Class McfData

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.analytics.model.McfData

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class McfData
extends GenericJson

Multi-Channel Funnels data for a given view (profile).

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Analytics API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/JSON

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	McfData.ColumnHeaders Model definition for McfDataColumnHeaders.
static class	McfData.ProfileInfo Information for the view (profile), for which the Analytics data was requested.
static class	McfData.Query Analytics data request query parameters.
static class	McfData.Rows A union object representing a dimension or metric value.

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
McfData()

Method Summary

Methods

Modifier and Type	Method and Description
McfData	clone()
List<McfData.ColumnHeaders>	getColumnHeaders() Column headers that list dimension names followed by the metric names.
Boolean	getContainsSampledData() Determines if the Analytics data contains sampled data.
String	getId() Unique ID for this data response.
Integer	getItemsPerPage() The maximum number of rows the response can contain, regardless of the actual number of rows returned.
String	getKind() Resource type.
String	getNextLink() Link to next page for this Analytics data query.
String	getPreviousLink() Link to previous page for this Analytics data query.
McfData.ProfileInfo	getProfileInfo() Information for the view (profile), for which the Analytics data was requested.
McfData.Query	getQuery() Analytics data request query parameters.
List<List<McfData.Rows>>	getRows() Analytics data rows, where each row contains a list of dimension values followed by the metric values.
Long	getSampleSize() The number of samples used to calculate the result.
Long	getSampleSpace() Total size of the sample space from which the samples were selected.
String	getSelfLink() Link to this page.
Integer	getTotalResults() The total number of rows for the query, regardless of the number of rows in the response.
Map<String,String>	getTotalsForAllResults() Total values for the requested metrics over all the results, not just the results returned in this response.
McfData	set(String fieldName, Object value)
McfData	setColumnHeaders(List<McfData.ColumnHeaders> columnHeaders) Column headers that list dimension names followed by the metric names.
McfData	setContainsSampledData(Boolean containsSampledData) Determines if the Analytics data contains sampled data.
McfData	setId(String id) Unique ID for this data response.
McfData	setItemsPerPage(Integer itemsPerPage) The maximum number of rows the response can contain, regardless of the actual number of rows returned.
McfData	setKind(String kind) Resource type.
McfData	setNextLink(String nextLink) Link to next page for this Analytics data query.
McfData	setPreviousLink(String previousLink) Link to previous page for this Analytics data query.
McfData	setProfileInfo(McfData.ProfileInfo profileInfo) Information for the view (profile), for which the Analytics data was requested.
McfData	setQuery(McfData.Query query) Analytics data request query parameters.
McfData	setRows(List<List<McfData.Rows>> rows) Analytics data rows, where each row contains a list of dimension values followed by the metric values.
McfData	setSampleSize(Long sampleSize) The number of samples used to calculate the result.
McfData	setSampleSpace(Long sampleSpace) Total size of the sample space from which the samples were selected.
McfData	setSelfLink(String selfLink) Link to this page.
McfData	setTotalResults(Integer totalResults) The total number of rows for the query, regardless of the number of rows in the response.
McfData	setTotalsForAllResults(Map<String,String> totalsForAllResults) Total values for the requested metrics over all the results, not just the results returned in this response.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

McfData

public McfData()

Method Detail

getColumnHeaders

public List<McfData.ColumnHeaders> getColumnHeaders()

Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.

Returns:

value or null for none

setColumnHeaders

public McfData setColumnHeaders(List<McfData.ColumnHeaders> columnHeaders)

Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.

Parameters:

columnHeaders - columnHeaders or null for none

getContainsSampledData

public Boolean getContainsSampledData()

Determines if the Analytics data contains sampled data.

Returns:

value or null for none

setContainsSampledData

public McfData setContainsSampledData(Boolean containsSampledData)

Determines if the Analytics data contains sampled data.

Parameters:

containsSampledData - containsSampledData or null for none

getId

public String getId()

Unique ID for this data response.

Returns:

value or null for none

setId

public McfData setId(String id)

Unique ID for this data response.

Parameters:

id - id or null for none

getItemsPerPage

public Integer getItemsPerPage()

The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.

Returns:

value or null for none

setItemsPerPage

public McfData setItemsPerPage(Integer itemsPerPage)

The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.

Parameters:

itemsPerPage - itemsPerPage or null for none

getKind

public String getKind()

Resource type.

Returns:

value or null for none

setKind

public McfData setKind(String kind)

Resource type.

Parameters:

kind - kind or null for none

getNextLink

public String getNextLink()

Link to next page for this Analytics data query.

Returns:

value or null for none

setNextLink

public McfData setNextLink(String nextLink)

Link to next page for this Analytics data query.

Parameters:

nextLink - nextLink or null for none

getPreviousLink

public String getPreviousLink()

Link to previous page for this Analytics data query.

Returns:

value or null for none

setPreviousLink

public McfData setPreviousLink(String previousLink)

Link to previous page for this Analytics data query.

Parameters:

previousLink - previousLink or null for none

getProfileInfo

public McfData.ProfileInfo getProfileInfo()

Information for the view (profile), for which the Analytics data was requested.

Returns:

value or null for none

setProfileInfo

public McfData setProfileInfo(McfData.ProfileInfo profileInfo)

Information for the view (profile), for which the Analytics data was requested.

Parameters:

profileInfo - profileInfo or null for none

getQuery

public McfData.Query getQuery()

Analytics data request query parameters.

Returns:

value or null for none

setQuery

public McfData setQuery(McfData.Query query)

Analytics data request query parameters.

Parameters:

query - query or null for none

getRows

public List<List<McfData.Rows>> getRows()

Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.

Returns:

value or null for none

setRows

public McfData setRows(List<List<McfData.Rows>> rows)

Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.

Parameters:

rows - rows or null for none

getSampleSize

public Long getSampleSize()

The number of samples used to calculate the result.

Returns:

value or null for none

setSampleSize

public McfData setSampleSize(Long sampleSize)

The number of samples used to calculate the result.

Parameters:

sampleSize - sampleSize or null for none

getSampleSpace

public Long getSampleSpace()

Total size of the sample space from which the samples were selected.

Returns:

value or null for none

setSampleSpace

public McfData setSampleSpace(Long sampleSpace)

Total size of the sample space from which the samples were selected.

Parameters:

sampleSpace - sampleSpace or null for none

getSelfLink

public String getSelfLink()

Link to this page.

Returns:

value or null for none

setSelfLink

public McfData setSelfLink(String selfLink)

Link to this page.

Parameters:

selfLink - selfLink or null for none

getTotalResults

public Integer getTotalResults()

The total number of rows for the query, regardless of the number of rows in the response.

Returns:

value or null for none

setTotalResults

public McfData setTotalResults(Integer totalResults)

The total number of rows for the query, regardless of the number of rows in the response.

Parameters:

totalResults - totalResults or null for none

getTotalsForAllResults

public Map<String,String> getTotalsForAllResults()

Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.

Returns:

value or null for none

setTotalsForAllResults

public McfData setTotalsForAllResults(Map<String,String> totalsForAllResults)

Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.

Parameters:

totalsForAllResults - totalsForAllResults or null for none

set

public McfData set(String fieldName,
          Object value)

Overrides:

set in class GenericJson

clone

public McfData clone()

Overrides:

clone in class GenericJson