target.apidocs.com.google.api.services.analytics.model.RealtimeData.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-analytics Show documentation

There is a newer version: v3-rev20190807-2.0.0

Show newest version







RealtimeData (Google Analytics API v3-rev20190807-1.31.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.analytics.model
Class RealtimeData



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.RealtimeData













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class RealtimeData
extends GenericJson
Real time 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:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


static class 
RealtimeData.ColumnHeaders
Model definition for RealtimeDataColumnHeaders.



static class 
RealtimeData.ProfileInfo
Information for the view (profile), for which the real time data was requested.



static class 
RealtimeData.Query
Real time data request query parameters.







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


RealtimeData() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


RealtimeData
clone() 


List<RealtimeData.ColumnHeaders>
getColumnHeaders()
Column headers that list dimension names followed by the metric names.



String
getId()
Unique ID for this data response.



String
getKind()
Resource type.



RealtimeData.ProfileInfo
getProfileInfo()
Information for the view (profile), for which the real time data was requested.



RealtimeData.Query
getQuery()
Real time data request query parameters.



List<List<String>>
getRows()
Real time data rows, where each row contains a list of dimension values followed by the metric
 values.



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.



RealtimeData
set(String fieldName,
   Object value) 


RealtimeData
setColumnHeaders(List<RealtimeData.ColumnHeaders> columnHeaders)
Column headers that list dimension names followed by the metric names.



RealtimeData
setId(String id)
Unique ID for this data response.



RealtimeData
setKind(String kind)
Resource type.



RealtimeData
setProfileInfo(RealtimeData.ProfileInfo profileInfo)
Information for the view (profile), for which the real time data was requested.



RealtimeData
setQuery(RealtimeData.Query query)
Real time data request query parameters.



RealtimeData
setRows(List<List<String>> rows)
Real time data rows, where each row contains a list of dimension values followed by the metric
 values.



RealtimeData
setSelfLink(String selfLink)
Link to this page.



RealtimeData
setTotalResults(Integer totalResults)
The total number of rows for the query, regardless of the number of rows in the response.



RealtimeData
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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





RealtimeData
public RealtimeData()









Method Detail





getColumnHeaders
public List<RealtimeData.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 RealtimeData setColumnHeaders(List<RealtimeData.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








getId
public String getId()
Unique ID for this data response.

Returns:
value or null for none








setId
public RealtimeData setId(String id)
Unique ID for this data response.

Parameters:
id - id or null for none








getKind
public String getKind()
Resource type.

Returns:
value or null for none








setKind
public RealtimeData setKind(String kind)
Resource type.

Parameters:
kind - kind or null for none








getProfileInfo
public RealtimeData.ProfileInfo getProfileInfo()
Information for the view (profile), for which the real time data was requested.

Returns:
value or null for none








setProfileInfo
public RealtimeData setProfileInfo(RealtimeData.ProfileInfo profileInfo)
Information for the view (profile), for which the real time data was requested.

Parameters:
profileInfo - profileInfo or null for none








getQuery
public RealtimeData.Query getQuery()
Real time data request query parameters.

Returns:
value or null for none








setQuery
public RealtimeData setQuery(RealtimeData.Query query)
Real time data request query parameters.

Parameters:
query - query or null for none








getRows
public List<List<String>> getRows()
Real time 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 RealtimeData setRows(List<List<String>> rows)
Real time 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








getSelfLink
public String getSelfLink()
Link to this page.

Returns:
value or null for none








setSelfLink
public RealtimeData 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 RealtimeData 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 RealtimeData 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 RealtimeData set(String fieldName,
                        Object value)

Overrides:
set in class GenericJson








clone
public RealtimeData clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2020 Google. All rights reserved.

Modifier and Type	Class and Description
`static class`	`RealtimeData.ColumnHeaders` Model definition for RealtimeDataColumnHeaders.
`static class`	`RealtimeData.ProfileInfo` Information for the view (profile), for which the real time data was requested.
`static class`	`RealtimeData.Query` Real time data request query parameters.

Modifier and Type	Method and Description
`RealtimeData`	`clone()`
`List<RealtimeData.ColumnHeaders>`	`getColumnHeaders()` Column headers that list dimension names followed by the metric names.
`String`	`getId()` Unique ID for this data response.
`String`	`getKind()` Resource type.
`RealtimeData.ProfileInfo`	`getProfileInfo()` Information for the view (profile), for which the real time data was requested.
`RealtimeData.Query`	`getQuery()` Real time data request query parameters.
`List<List<String>>`	`getRows()` Real time data rows, where each row contains a list of dimension values followed by the metric values.
`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.
`RealtimeData`	`set(String fieldName, Object value)`
`RealtimeData`	`setColumnHeaders(List<RealtimeData.ColumnHeaders> columnHeaders)` Column headers that list dimension names followed by the metric names.
`RealtimeData`	`setId(String id)` Unique ID for this data response.
`RealtimeData`	`setKind(String kind)` Resource type.
`RealtimeData`	`setProfileInfo(RealtimeData.ProfileInfo profileInfo)` Information for the view (profile), for which the real time data was requested.
`RealtimeData`	`setQuery(RealtimeData.Query query)` Real time data request query parameters.
`RealtimeData`	`setRows(List<List<String>> rows)` Real time data rows, where each row contains a list of dimension values followed by the metric values.
`RealtimeData`	`setSelfLink(String selfLink)` Link to this page.
`RealtimeData`	`setTotalResults(Integer totalResults)` The total number of rows for the query, regardless of the number of rows in the response.
`RealtimeData`	`setTotalsForAllResults(Map<String,String> totalsForAllResults)` Total values for the requested metrics over all the results, not just the results returned in this response.