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.


1564
1565
1566
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1564

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

Instance Attribute Details

#activity_typesArray<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>)

1528
1529
1530
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1528

def activity_types
  @activity_types
end

#date_rangeGoogle::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


1535
1536
1537
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1535

def date_range
  @date_range
end

#page_sizeFixnum

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)

1542
1543
1544
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1542

def page_size
  @page_size
end

#page_tokenString

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)

1550
1551
1552
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1550

def page_token
  @page_token
end

#userGoogle::Apis::AnalyticsreportingV4::User

Contains information to identify a particular user uniquely. Corresponds to the JSON property user


1555
1556
1557
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1555

def user
  @user
end

#view_idString

Required. The Analytics view ID from which to retrieve data. Every SearchUserActivityRequest must contain the viewId. Corresponds to the JSON property viewId

Returns:

  • (String)

1562
1563
1564
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1562

def view_id
  @view_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1569
1570
1571
1572
1573
1574
1575
1576
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1569

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