Activity (Analytics Reporting API v4-rev20210106-1.32.1)

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

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Activity
extends GenericJson
```
An Activity represents data for an activity of a user. Note that an Activity is different from a hit. A hit might result in multiple Activity's. For example, if a hit includes a transaction and a goal completion, there will be two Activity protos for this hit, one for ECOMMERCE and one for GOAL. Conversely, multiple hits can also construct one Activity. In classic e-commerce, data for one transaction might be sent through multiple hits. These hits will be merged into one ECOMMERCE Activity.
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

Activity()

Constructors
Constructor and Description
`Activity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Activity`	`clone()`
`String`	`getActivityTime()` Timestamp of the activity.
`String`	`getActivityType()` Type of this activity.
`ScreenviewData`	`getAppview()` This will be set if `activity_type` equals `SCREEN_VIEW`.
`String`	`getCampaign()` For manual campaign tracking, it is the value of the utm_campaign campaign tracking parameter.
`String`	`getChannelGrouping()` The Channel Group associated with an end user's session for this View (defined by the View's Channel Groupings).
`List<CustomDimension>`	`getCustomDimension()` A list of all custom dimensions associated with this activity.
`EcommerceData`	`getEcommerce()` This will be set if `activity_type` equals `ECOMMERCE`.
`EventData`	`getEvent()` This field contains all the details pertaining to an event and will be set if `activity_type` equals `EVENT`.
`GoalSetData`	`getGoals()` This field contains a list of all the goals that were reached in this activity when `activity_type` equals `GOAL`.
`String`	`getHostname()` The hostname from which the tracking request was made.
`String`	`getKeyword()` For manual campaign tracking, it is the value of the utm_term campaign tracking parameter.
`String`	`getLandingPagePath()` The first page in users' sessions, or the landing page.
`String`	`getMedium()` The type of referrals.
`PageviewData`	`getPageview()` This will be set if `activity_type` equals `PAGEVIEW`.
`String`	`getSource()` The source of referrals.
`Activity`	`set(String fieldName, Object value)`
`Activity`	`setActivityTime(String activityTime)` Timestamp of the activity.
`Activity`	`setActivityType(String activityType)` Type of this activity.
`Activity`	`setAppview(ScreenviewData appview)` This will be set if `activity_type` equals `SCREEN_VIEW`.
`Activity`	`setCampaign(String campaign)` For manual campaign tracking, it is the value of the utm_campaign campaign tracking parameter.
`Activity`	`setChannelGrouping(String channelGrouping)` The Channel Group associated with an end user's session for this View (defined by the View's Channel Groupings).
`Activity`	`setCustomDimension(List<CustomDimension> customDimension)` A list of all custom dimensions associated with this activity.
`Activity`	`setEcommerce(EcommerceData ecommerce)` This will be set if `activity_type` equals `ECOMMERCE`.
`Activity`	`setEvent(EventData event)` This field contains all the details pertaining to an event and will be set if `activity_type` equals `EVENT`.
`Activity`	`setGoals(GoalSetData goals)` This field contains a list of all the goals that were reached in this activity when `activity_type` equals `GOAL`.
`Activity`	`setHostname(String hostname)` The hostname from which the tracking request was made.
`Activity`	`setKeyword(String keyword)` For manual campaign tracking, it is the value of the utm_term campaign tracking parameter.
`Activity`	`setLandingPagePath(String landingPagePath)` The first page in users' sessions, or the landing page.
`Activity`	`setMedium(String medium)` The type of referrals.
`Activity`	`setPageview(PageviewData pageview)` This will be set if `activity_type` equals `PAGEVIEW`.
`Activity`	`setSource(String source)` The source of referrals.

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
  - Activity
```
public Activity()
```
- Method Detail
  - getActivityTime
```
public String getActivityTime()
```
    Timestamp of the activity. If activities for a visit cross midnight and occur in two separate dates, then two sessions (one per date) share the session identifier. For example, say session ID 113472 has activity within 2019-08-20, and session ID 243742 has activity within 2019-08-25 and 2019-08-26. Session ID 113472 is one session, and session ID 243742 is two sessions.
    
    Returns:
    
    value or null for none
  - setActivityTime
```
public Activity setActivityTime(String activityTime)
```
    Timestamp of the activity. If activities for a visit cross midnight and occur in two separate dates, then two sessions (one per date) share the session identifier. For example, say session ID 113472 has activity within 2019-08-20, and session ID 243742 has activity within 2019-08-25 and 2019-08-26. Session ID 113472 is one session, and session ID 243742 is two sessions.
    
    Parameters:
    
    activityTime - activityTime or null for none
  - getActivityType
```
public String getActivityType()
```
    Type of this activity.
    
    Returns:
    
    value or null for none
  - setActivityType
```
public Activity setActivityType(String activityType)
```
    Type of this activity.
    
    Parameters:
    
    activityType - activityType or null for none
  - getAppview
```
public ScreenviewData getAppview()
```
    This will be set if `activity_type` equals `SCREEN_VIEW`.
    
    Returns:
    
    value or null for none
  - setAppview
```
public Activity setAppview(ScreenviewData appview)
```
    This will be set if `activity_type` equals `SCREEN_VIEW`.
    
    Parameters:
    
    appview - appview or null for none
  - getCampaign
```
public String getCampaign()
```
    For manual campaign tracking, it is the value of the utm_campaign campaign tracking parameter. For AdWords autotagging, it is the name(s) of the online ad campaign(s) you use for the property. If you use neither, its value is (not set).
    
    Returns:
    
    value or null for none
  - setCampaign
```
public Activity setCampaign(String campaign)
```
    For manual campaign tracking, it is the value of the utm_campaign campaign tracking parameter. For AdWords autotagging, it is the name(s) of the online ad campaign(s) you use for the property. If you use neither, its value is (not set).
    
    Parameters:
    
    campaign - campaign or null for none
  - getChannelGrouping
```
public String getChannelGrouping()
```
    The Channel Group associated with an end user's session for this View (defined by the View's Channel Groupings).
    
    Returns:
    
    value or null for none
  - setChannelGrouping
```
public Activity setChannelGrouping(String channelGrouping)
```
    The Channel Group associated with an end user's session for this View (defined by the View's Channel Groupings).
    
    Parameters:
    
    channelGrouping - channelGrouping or null for none
  - getCustomDimension
```
public List<CustomDimension> getCustomDimension()
```
    A list of all custom dimensions associated with this activity.
    
    Returns:
    
    value or null for none
  - setCustomDimension
```
public Activity setCustomDimension(List<CustomDimension> customDimension)
```
    A list of all custom dimensions associated with this activity.
    
    Parameters:
    
    customDimension - customDimension or null for none
  - getEcommerce
```
public EcommerceData getEcommerce()
```
    This will be set if `activity_type` equals `ECOMMERCE`.
    
    Returns:
    
    value or null for none
  - setEcommerce
```
public Activity setEcommerce(EcommerceData ecommerce)
```
    This will be set if `activity_type` equals `ECOMMERCE`.
    
    Parameters:
    
    ecommerce - ecommerce or null for none
  - getEvent
```
public EventData getEvent()
```
    This field contains all the details pertaining to an event and will be set if `activity_type` equals `EVENT`.
    
    Returns:
    
    value or null for none
  - setEvent
```
public Activity setEvent(EventData event)
```
    This field contains all the details pertaining to an event and will be set if `activity_type` equals `EVENT`.
    
    Parameters:
    
    event - event or null for none
  - getGoals
```
public GoalSetData getGoals()
```
    This field contains a list of all the goals that were reached in this activity when `activity_type` equals `GOAL`.
    
    Returns:
    
    value or null for none
  - setGoals
```
public Activity setGoals(GoalSetData goals)
```
    This field contains a list of all the goals that were reached in this activity when `activity_type` equals `GOAL`.
    
    Parameters:
    
    goals - goals or null for none
  - getHostname
```
public String getHostname()
```
    The hostname from which the tracking request was made.
    
    Returns:
    
    value or null for none
  - setHostname
```
public Activity setHostname(String hostname)
```
    The hostname from which the tracking request was made.
    
    Parameters:
    
    hostname - hostname or null for none
  - getKeyword
```
public String getKeyword()
```
    For manual campaign tracking, it is the value of the utm_term campaign tracking parameter. For AdWords traffic, it contains the best matching targeting criteria. For the display network, where multiple targeting criteria could have caused the ad to show up, it returns the best matching targeting criteria as selected by Ads. This could be display_keyword, site placement, boomuserlist, user_interest, age, or gender. Otherwise its value is (not set).
    
    Returns:
    
    value or null for none
  - setKeyword
```
public Activity setKeyword(String keyword)
```
    For manual campaign tracking, it is the value of the utm_term campaign tracking parameter. For AdWords traffic, it contains the best matching targeting criteria. For the display network, where multiple targeting criteria could have caused the ad to show up, it returns the best matching targeting criteria as selected by Ads. This could be display_keyword, site placement, boomuserlist, user_interest, age, or gender. Otherwise its value is (not set).
    
    Parameters:
    
    keyword - keyword or null for none
  - getLandingPagePath
```
public String getLandingPagePath()
```
    The first page in users' sessions, or the landing page.
    
    Returns:
    
    value or null for none
  - setLandingPagePath
```
public Activity setLandingPagePath(String landingPagePath)
```
    The first page in users' sessions, or the landing page.
    
    Parameters:
    
    landingPagePath - landingPagePath or null for none
  - getMedium
```
public String getMedium()
```
    The type of referrals. For manual campaign tracking, it is the value of the utm_medium campaign tracking parameter. For AdWords autotagging, it is cpc. If users came from a search engine detected by Google Analytics, it is organic. If the referrer is not a search engine, it is referral. If users came directly to the property and document.referrer is empty, its value is (none).
    
    Returns:
    
    value or null for none
  - setMedium
```
public Activity setMedium(String medium)
```
    The type of referrals. For manual campaign tracking, it is the value of the utm_medium campaign tracking parameter. For AdWords autotagging, it is cpc. If users came from a search engine detected by Google Analytics, it is organic. If the referrer is not a search engine, it is referral. If users came directly to the property and document.referrer is empty, its value is (none).
    
    Parameters:
    
    medium - medium or null for none
  - getPageview
```
public PageviewData getPageview()
```
    This will be set if `activity_type` equals `PAGEVIEW`. This field contains all the details about the visitor and the page that was visited.
    
    Returns:
    
    value or null for none
  - setPageview
```
public Activity setPageview(PageviewData pageview)
```
    This will be set if `activity_type` equals `PAGEVIEW`. This field contains all the details about the visitor and the page that was visited.
    
    Parameters:
    
    pageview - pageview or null for none
  - getSource
```
public String getSource()
```
    The source of referrals. For manual campaign tracking, it is the value of the utm_source campaign tracking parameter. For AdWords autotagging, it is google. If you use neither, it is the domain of the source (e.g., document.referrer) referring the users. It may also contain a port address. If users arrived without a referrer, its value is (direct).
    
    Returns:
    
    value or null for none
  - setSource
```
public Activity setSource(String source)
```
    The source of referrals. For manual campaign tracking, it is the value of the utm_source campaign tracking parameter. For AdWords autotagging, it is google. If you use neither, it is the domain of the source (e.g., document.referrer) referring the users. It may also contain a port address. If users arrived without a referrer, its value is (direct).
    
    Parameters:
    
    source - source or null for none
  - set
```
public Activity set(String fieldName,
                    Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public Activity clone()
```
    Overrides:
    
    clone in class GenericJson

Class Activity

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

Constructor Summary

Method Summary

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

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

Activity

Method Detail

getActivityTime

setActivityTime

getActivityType

setActivityType

getAppview

setAppview

getCampaign

setCampaign

getChannelGrouping

setChannelGrouping

getCustomDimension

setCustomDimension

getEcommerce

setEcommerce

getEvent

setEvent

getGoals

setGoals

getHostname

setHostname

getKeyword

setKeyword

getLandingPagePath

setLandingPagePath

getMedium

setMedium

getPageview

setPageview

getSource

setSource

set

clone