google_api_analytics_reporting v0.2.0 GoogleApi.AnalyticsReporting.V4.Model.SearchUserActivityRequest View Source

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

Attributes

  • activityTypes ([String.t]): 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. Defaults to: null.

    • Enum - one of
  • dateRange (DateRange): Date range for which to retrieve the user activity. If a date range is not provided, the default date range is (startDate: current date - 7 days, endDate: current date - 1 day). Defaults to: null.
  • pageSize (integer()): 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. Defaults to: null.
  • pageToken (String.t): 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. Defaults to: null.
  • user (User): Required. Unique user Id to query for. Every SearchUserActivityRequest must contain this field. Defaults to: null.
  • viewId (String.t): Required. The Analytics view ID from which to retrieve data. Every SearchUserActivityRequest must contain the `viewId`. Defaults to: null.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t() View Source
t() :: %GoogleApi.AnalyticsReporting.V4.Model.SearchUserActivityRequest{
  activityTypes: [any()],
  dateRange: GoogleApi.AnalyticsReporting.V4.Model.DateRange.t(),
  pageSize: any(),
  pageToken: any(),
  user: GoogleApi.AnalyticsReporting.V4.Model.User.t(),
  viewId: any()
}

Link to this section Functions

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.