class Google::Apis::AnalyticsreportingV4::Activity

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.

Attributes

activity_time[RW]

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. Corresponds to the JSON property `activityTime` @return [String]

activity_type[RW]

Type of this activity. Corresponds to the JSON property `activityType` @return [String]

appview[RW]

This will be set if `activity_type` equals `SCREEN_VIEW`. Corresponds to the JSON property `appview` @return [Google::Apis::AnalyticsreportingV4::ScreenviewData]

campaign[RW]

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). Corresponds to the JSON property `campaign` @return [String]

channel_grouping[RW]

The Channel Group associated with an end user's session for this View (defined by the View's Channel Groupings). Corresponds to the JSON property `channelGrouping` @return [String]

custom_dimension[RW]

A list of all custom dimensions associated with this activity. Corresponds to the JSON property `customDimension` @return [Array<Google::Apis::AnalyticsreportingV4::CustomDimension>]

ecommerce[RW]

E-commerce details associated with the user activity. Corresponds to the JSON property `ecommerce` @return [Google::Apis::AnalyticsreportingV4::EcommerceData]

event[RW]

Represents all the details pertaining to an event. Corresponds to the JSON property `event` @return [Google::Apis::AnalyticsreportingV4::EventData]

goals[RW]

Represents a set of goals that were reached in an activity. Corresponds to the JSON property `goals` @return [Google::Apis::AnalyticsreportingV4::GoalSetData]

hostname[RW]

The hostname from which the tracking request was made. Corresponds to the JSON property `hostname` @return [String]

keyword[RW]

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). Corresponds to the JSON property `keyword` @return [String]

landing_page_path[RW]

The first page in users' sessions, or the landing page. Corresponds to the JSON property `landingPagePath` @return [String]

medium[RW]

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). Corresponds to the JSON property `medium` @return [String]

pageview[RW]

Represents details collected when the visitor views a page. Corresponds to the JSON property `pageview` @return [Google::Apis::AnalyticsreportingV4::PageviewData]

source[RW]

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). Corresponds to the JSON property `source` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/analyticsreporting_v4/classes.rb, line 131
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/analyticsreporting_v4/classes.rb, line 136
def update!(**args)
  @activity_time = args[:activity_time] if args.key?(:activity_time)
  @activity_type = args[:activity_type] if args.key?(:activity_type)
  @appview = args[:appview] if args.key?(:appview)
  @campaign = args[:campaign] if args.key?(:campaign)
  @channel_grouping = args[:channel_grouping] if args.key?(:channel_grouping)
  @custom_dimension = args[:custom_dimension] if args.key?(:custom_dimension)
  @ecommerce = args[:ecommerce] if args.key?(:ecommerce)
  @event = args[:event] if args.key?(:event)
  @goals = args[:goals] if args.key?(:goals)
  @hostname = args[:hostname] if args.key?(:hostname)
  @keyword = args[:keyword] if args.key?(:keyword)
  @landing_page_path = args[:landing_page_path] if args.key?(:landing_page_path)
  @medium = args[:medium] if args.key?(:medium)
  @pageview = args[:pageview] if args.key?(:pageview)
  @source = args[:source] if args.key?(:source)
end