Class: Google::Apis::AnalyticsreportingV4::Activity

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/analyticsreporting_v4/classes.rb,
generated/google/apis/analyticsreporting_v4/representations.rb,
generated/google/apis/analyticsreporting_v4/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Activity

Returns a new instance of Activity



132
133
134
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 132

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#activity_time ⇒ String

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. Corresponds to the JSON property activityTime

Returns:

  • (String) 


41
42
43
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 41

def activity_time
  @activity_time
end

#activity_type ⇒ String

Type of this activity. Corresponds to the JSON property activityType

Returns:

  • (String) 


46
47
48
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 46

def activity_type
  @activity_type
end

#appview ⇒ Google::Apis::AnalyticsreportingV4::ScreenviewData

This will be set if activity_type equals SCREEN_VIEW. Corresponds to the JSON property appview

Returns:



51
52
53
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 51

def appview
  @appview
end

#campaign ⇒ String

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

Returns:

  • (String) 


59
60
61
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 59

def campaign
  @campaign
end

#channel_grouping ⇒ String

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

Returns:

  • (String) 


65
66
67
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 65

def channel_grouping
  @channel_grouping
end

#custom_dimension ⇒ Array<Google::Apis::AnalyticsreportingV4::CustomDimension>

A list of all custom dimensions associated with this activity. Corresponds to the JSON property customDimension

Returns:



70
71
72
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 70

def custom_dimension
  @custom_dimension
end

#ecommerce ⇒ Google::Apis::AnalyticsreportingV4::EcommerceData

E-commerce details associated with the user activity. Corresponds to the JSON property ecommerce

Returns:



75
76
77
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 75

def ecommerce
  @ecommerce
end

#event ⇒ Google::Apis::AnalyticsreportingV4::EventData

Represents all the details pertaining to an event. Corresponds to the JSON property event

Returns:



80
81
82
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 80

def event
  @event
end

#goals ⇒ Google::Apis::AnalyticsreportingV4::GoalSetData

Represents a set of goals that were reached in an activity. Corresponds to the JSON property goals

Returns:



85
86
87
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 85

def goals
  @goals
end

#hostname ⇒ String

The hostname from which the tracking request was made. Corresponds to the JSON property hostname

Returns:

  • (String) 


90
91
92
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 90

def hostname
  @hostname
end

#keyword ⇒ String

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

Returns:

  • (String) 


101
102
103
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 101

def keyword
  @keyword
end

#landing_page_path ⇒ String

The first page in users' sessions, or the landing page. Corresponds to the JSON property landingPagePath

Returns:

  • (String) 


106
107
108
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 106

def landing_page_path
  @landing_page_path
end

#medium ⇒ String

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

Returns:

  • (String) 


116
117
118
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 116

def medium
  @medium
end

#pageview ⇒ Google::Apis::AnalyticsreportingV4::PageviewData

Represents details collected when the visitor views a page. Corresponds to the JSON property pageview

Returns:



121
122
123
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 121

def pageview
  @pageview
end

#source ⇒ String

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

Returns:

  • (String) 


130
131
132
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 130

def source
  @source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 137

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