Class: Google::Apis::AnalyticsreportingV4::SearchUserActivityRequest
- Inherits:
-
Object
- Object
- Google::Apis::AnalyticsreportingV4::SearchUserActivityRequest
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/analyticsreporting_v4/classes.rb,
lib/google/apis/analyticsreporting_v4/representations.rb,
lib/google/apis/analyticsreporting_v4/representations.rb more...
Overview
The request to fetch User Report from Reporting API userActivity:get
call.
Instance Attribute Summary collapse
-
#activity_types ⇒ Array<String>
Set of all activity types being requested.
-
#date_range ⇒ Google::Apis::AnalyticsreportingV4::DateRange
A contiguous set of days: startDate, startDate + 1 day, ..., endDate.
-
#page_size ⇒ Fixnum
Page size is for paging and specifies the maximum number of returned rows.
-
#page_token ⇒ String
A continuation token to get the next page of the results.
-
#user ⇒ Google::Apis::AnalyticsreportingV4::User
Contains information to identify a particular user uniquely.
-
#view_id ⇒ String
Required.
Instance Method Summary collapse
-
#initialize(**args) ⇒ SearchUserActivityRequest
constructor
A new instance of SearchUserActivityRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ SearchUserActivityRequest
Returns a new instance of SearchUserActivityRequest.
1570 1571 1572 |
# File 'lib/google/apis/analyticsreporting_v4/classes.rb', line 1570 def initialize(**args) update!(**args) end |
Instance Attribute Details
#activity_types ⇒ Array<String>
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.
Corresponds to the JSON property activityTypes
1534 1535 1536 |
# File 'lib/google/apis/analyticsreporting_v4/classes.rb', line 1534 def activity_types @activity_types end |
#date_range ⇒ Google::Apis::AnalyticsreportingV4::DateRange
A contiguous set of days: startDate, startDate + 1 day, ..., endDate. The
start and end dates are specified in ISO8601 date format YYYY-MM-DD
.
Corresponds to the JSON property dateRange
1541 1542 1543 |
# File 'lib/google/apis/analyticsreporting_v4/classes.rb', line 1541 def date_range @date_range end |
#page_size ⇒ Fixnum
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.
Corresponds to the JSON property pageSize
1548 1549 1550 |
# File 'lib/google/apis/analyticsreporting_v4/classes.rb', line 1548 def page_size @page_size end |
#page_token ⇒ String
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 request.
Corresponds to the JSON property pageToken
1556 1557 1558 |
# File 'lib/google/apis/analyticsreporting_v4/classes.rb', line 1556 def page_token @page_token end |
#user ⇒ Google::Apis::AnalyticsreportingV4::User
Contains information to identify a particular user uniquely.
Corresponds to the JSON property user
1561 1562 1563 |
# File 'lib/google/apis/analyticsreporting_v4/classes.rb', line 1561 def user @user end |
#view_id ⇒ String
Required. The Analytics view ID from which to retrieve data. Every SearchUserActivityRequest must contain the viewId
.
Corresponds to the JSON property viewId
1568 1569 1570 |
# File 'lib/google/apis/analyticsreporting_v4/classes.rb', line 1568 def view_id @view_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1575 1576 1577 1578 1579 1580 1581 1582 |
# File 'lib/google/apis/analyticsreporting_v4/classes.rb', line 1575 def update!(**args) @activity_types = args[:activity_types] if args.key?(:activity_types) @date_range = args[:date_range] if args.key?(:date_range) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) @user = args[:user] if args.key?(:user) @view_id = args[:view_id] if args.key?(:view_id) end |