Class: Google::Apis::AnalyticsreportingV4::SearchUserActivityRequest

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

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

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) ⇒ SearchUserActivityRequest

Returns a new instance of SearchUserActivityRequest.



1634
1635
1636
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1634

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

Returns:

  • (Array<String>) 


1596
1597
1598
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1596

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

Returns:



1603
1604
1605
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1603

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

Returns:

  • (Fixnum) 


1610
1611
1612
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1610

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

Returns:

  • (String) 


1618
1619
1620
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1618

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

Returns:



1623
1624
1625
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1623

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

Returns:

  • (String) 


1632
1633
1634
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1632

def view_id
  @view_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1639
1640
1641
1642
1643
1644
1645
1646
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1639

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