com.google.api.services.analyticsreporting.v4.model

Class SearchUserActivityRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.analyticsreporting.v4.model.SearchUserActivityRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class SearchUserActivityRequest
extends GenericJson

The request to fetch User Report from Reporting API `userActivity:get` call.

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 Analytics Reporting 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/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
SearchUserActivityRequest()

Method Summary

Modifier and Type	Method and Description
SearchUserActivityRequest	clone()
List<String>	getActivityTypes() Set of all activity types being requested.
DateRange	getDateRange() Date range for which to retrieve the user activity.
Integer	getPageSize() Page size is for paging and specifies the maximum number of returned rows.
String	getPageToken() A continuation token to get the next page of the results.
User	getUser() Required.
String	getViewId() Required.
SearchUserActivityRequest	set(String fieldName, Object value)
SearchUserActivityRequest	setActivityTypes(List<String> activityTypes) Set of all activity types being requested.
SearchUserActivityRequest	setDateRange(DateRange dateRange) Date range for which to retrieve the user activity.
SearchUserActivityRequest	setPageSize(Integer pageSize) Page size is for paging and specifies the maximum number of returned rows.
SearchUserActivityRequest	setPageToken(String pageToken) A continuation token to get the next page of the results.
SearchUserActivityRequest	setUser(User user) Required.
SearchUserActivityRequest	setViewId(String viewId) Required.

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

SearchUserActivityRequest

public SearchUserActivityRequest()

Method Detail

getActivityTypes

public List<String> getActivityTypes()

Set of all activity types being requested. Only acvities matching these types will be returned in the response. If empty, all activies will be returned.

Returns:

value or null for none

setActivityTypes

public SearchUserActivityRequest setActivityTypes(List<String> activityTypes)

Set of all activity types being requested. Only acvities matching these types will be returned in the response. If empty, all activies will be returned.

Parameters:

activityTypes - activityTypes or null for none

getDateRange

public DateRange getDateRange()

Date range for which to retrieve the user activity. If a date range is not provided, the default date range is (startDate: current date - 7 days, endDate: current date - 1 day).

Returns:

value or null for none

setDateRange

public SearchUserActivityRequest setDateRange(DateRange dateRange)

Date range for which to retrieve the user activity. If a date range is not provided, the default date range is (startDate: current date - 7 days, endDate: current date - 1 day).

Parameters:

dateRange - dateRange or null for none

getPageSize

public Integer getPageSize()

Page size is for paging and specifies the maximum number of returned rows. Page size should be > 0. If the value is 0 or if the field isn't specified, the request returns the default of 1000 rows per page.

Returns:

value or null for none

setPageSize

public SearchUserActivityRequest setPageSize(Integer pageSize)

Page size is for paging and specifies the maximum number of returned rows. Page size should be > 0. If the value is 0 or if the field isn't specified, the request returns the default of 1000 rows per page.

Parameters:

pageSize - pageSize or null for none

getPageToken

public String getPageToken()

A continuation token to get the next page of the results. Adding this to the request will return the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the [SearchUserActivityRequest](#SearchUserActivityRequest) request.

Returns:

value or null for none

setPageToken

public SearchUserActivityRequest setPageToken(String pageToken)

A continuation token to get the next page of the results. Adding this to the request will return the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the [SearchUserActivityRequest](#SearchUserActivityRequest) request.

Parameters:

pageToken - pageToken or null for none

getUser

public User getUser()

Required. Unique user Id to query for. Every [SearchUserActivityRequest](#SearchUserActivityRequest) must contain this field.

Returns:

value or null for none

setUser

public SearchUserActivityRequest setUser(User user)

Required. Unique user Id to query for. Every [SearchUserActivityRequest](#SearchUserActivityRequest) must contain this field.

Parameters:

user - user or null for none

getViewId

public String getViewId()

Required. The Analytics [view ID](https://support.google.com/analytics/answer/1009618) from which to retrieve data. Every [SearchUserActivityRequest](#SearchUserActivityRequest) must contain the `viewId`.

Returns:

value or null for none

setViewId

public SearchUserActivityRequest setViewId(String viewId)

Required. The Analytics [view ID](https://support.google.com/analytics/answer/1009618) from which to retrieve data. Every [SearchUserActivityRequest](#SearchUserActivityRequest) must contain the `viewId`.

Parameters:

viewId - viewId or null for none

set

public SearchUserActivityRequest set(String fieldName,
                                     Object value)

Overrides:

set in class GenericJson

clone

public SearchUserActivityRequest clone()

Overrides:

clone in class GenericJson