Analytics.Data.Realtime.Get (Google Analytics API v3 (Rev. 204) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.analytics.AnalyticsRequest<RealtimeData>
        
        com.google.api.services.analytics.Analytics.Data.Realtime.Get

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Analytics.Data.Realtime
```
public class Analytics.Data.Realtime.Get
extends AnalyticsRequest<RealtimeData>
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected Get(java.lang.String ids, java.lang.String metrics)
Returns real time data for a view (profile).

Constructors
Modifier	Constructor and Description
`protected`	`Get(java.lang.String ids, java.lang.String metrics)` Returns real time data for a view (profile).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`java.lang.String`	`getDimensions()` A comma-separated list of real time dimensions.
`java.lang.String`	`getFilters()` A comma-separated list of dimension or metric filters to be applied to real time data.
`java.lang.String`	`getIds()` Unique table ID for retrieving real time data.
`java.lang.Integer`	`getMaxResults()` The maximum number of entries to include in this feed.
`java.lang.String`	`getMetrics()` A comma-separated list of real time metrics.
`java.lang.String`	`getSort()` A comma-separated list of dimensions or metrics that determine the sort order for real time data.
`Analytics.Data.Realtime.Get`	`set(java.lang.String parameterName, java.lang.Object value)`
`Analytics.Data.Realtime.Get`	`setAlt(java.lang.String alt)` Data format for the response.
`Analytics.Data.Realtime.Get`	`setDimensions(java.lang.String dimensions)` A comma-separated list of real time dimensions.
`Analytics.Data.Realtime.Get`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Analytics.Data.Realtime.Get`	`setFilters(java.lang.String filters)` A comma-separated list of dimension or metric filters to be applied to real time data.
`Analytics.Data.Realtime.Get`	`setIds(java.lang.String ids)` Unique table ID for retrieving real time data.
`Analytics.Data.Realtime.Get`	`setKey(java.lang.String key)` API key.
`Analytics.Data.Realtime.Get`	`setMaxResults(java.lang.Integer maxResults)` The maximum number of entries to include in this feed.
`Analytics.Data.Realtime.Get`	`setMetrics(java.lang.String metrics)` A comma-separated list of real time metrics.
`Analytics.Data.Realtime.Get`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Analytics.Data.Realtime.Get`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Analytics.Data.Realtime.Get`	`setQuotaUser(java.lang.String quotaUser)` An opaque string that represents a user for quota purposes.
`Analytics.Data.Realtime.Get`	`setSort(java.lang.String sort)` A comma-separated list of dimensions or metrics that determine the sort order for real time data.
`Analytics.Data.Realtime.Get`	`setUserIp(java.lang.String userIp)` Deprecated.

Methods inherited from class com.google.api.services.analytics.AnalyticsRequest
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, 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
  - Get
```
protected Get(java.lang.String ids,
              java.lang.String metrics)
```
    Returns real time data for a view (profile). Create a request for the method "realtime.get". This request holds the parameters needed by the the analytics server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Analytics.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    ids - Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.
    
    metrics - A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<RealtimeData>
    
    Throws:
    
    java.io.IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<RealtimeData>
    
    Throws:
    
    java.io.IOException
  - setAlt
```
public Analytics.Data.Realtime.Get setAlt(java.lang.String alt)
```
    Description copied from class: AnalyticsRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class AnalyticsRequest<RealtimeData>
  - setFields
```
public Analytics.Data.Realtime.Get setFields(java.lang.String fields)
```
    Description copied from class: AnalyticsRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class AnalyticsRequest<RealtimeData>
  - setKey
```
public Analytics.Data.Realtime.Get setKey(java.lang.String key)
```
    Description copied from class: AnalyticsRequest
    
    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    
    Overrides:
    
    setKey in class AnalyticsRequest<RealtimeData>
  - setOauthToken
```
public Analytics.Data.Realtime.Get setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: AnalyticsRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class AnalyticsRequest<RealtimeData>
  - setPrettyPrint
```
public Analytics.Data.Realtime.Get setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: AnalyticsRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class AnalyticsRequest<RealtimeData>
  - setQuotaUser
```
public Analytics.Data.Realtime.Get setQuotaUser(java.lang.String quotaUser)
```
    Description copied from class: AnalyticsRequest
    
    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class AnalyticsRequest<RealtimeData>
  - setUserIp
```
public Analytics.Data.Realtime.Get setUserIp(java.lang.String userIp)
```
    Description copied from class: AnalyticsRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp in class AnalyticsRequest<RealtimeData>
  - getIds
```
public java.lang.String getIds()
```
    Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.
  - setIds
```
public Analytics.Data.Realtime.Get setIds(java.lang.String ids)
```
    Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.
  - getMetrics
```
public java.lang.String getMetrics()
```
    A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified.
  - setMetrics
```
public Analytics.Data.Realtime.Get setMetrics(java.lang.String metrics)
```
    A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified.
  - getSort
```
public java.lang.String getSort()
```
    A comma-separated list of dimensions or metrics that determine the sort order for real time data.
  - setSort
```
public Analytics.Data.Realtime.Get setSort(java.lang.String sort)
```
    A comma-separated list of dimensions or metrics that determine the sort order for real time data.
  - getMaxResults
```
public java.lang.Integer getMaxResults()
```
    The maximum number of entries to include in this feed.
  - setMaxResults
```
public Analytics.Data.Realtime.Get setMaxResults(java.lang.Integer maxResults)
```
    The maximum number of entries to include in this feed.
  - getDimensions
```
public java.lang.String getDimensions()
```
    A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'.
  - setDimensions
```
public Analytics.Data.Realtime.Get setDimensions(java.lang.String dimensions)
```
    A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'.
  - getFilters
```
public java.lang.String getFilters()
```
    A comma-separated list of dimension or metric filters to be applied to real time data.
  - setFilters
```
public Analytics.Data.Realtime.Get setFilters(java.lang.String filters)
```
    A comma-separated list of dimension or metric filters to be applied to real time data.
  - set
```
public Analytics.Data.Realtime.Get set(java.lang.String parameterName,
                                       java.lang.Object value)
```
    Overrides:
    
    set in class AnalyticsRequest<RealtimeData>

Google Analytics API v3 (revision 204)

Class Analytics.Data.Realtime.Get

Nested Class Summary

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

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

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

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.analytics.AnalyticsRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Get

Method Detail

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getIds

setIds

getMetrics

setMetrics

getSort

setSort

getMaxResults

setMaxResults

getDimensions

setDimensions

getFilters

setFilters

set