Class ActivitiesResource.ListRequest
Retrieves a list of activities for a specific customer's account and application such as the Admin console application or the Google Drive application. For more information, see the guides for administrator and Google Drive activity reports. For more information about the activity report's parameters, see the activity parameters reference guides.
Inheritance
Inherited Members
Namespace: Google.Apis.Admin.Reports.reports_v1
Assembly: Google.Apis.Admin.Reports.reports_v1.dll
Syntax
public class ActivitiesResource.ListRequest : ReportsBaseServiceRequest<Activities>, IClientServiceRequest<Activities>, IClientServiceRequestConstructors
ListRequest(IClientService, string, ApplicationNameEnum)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, string userKey, ActivitiesResource.ListRequest.ApplicationNameEnum applicationName)Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service | |
| string | userKey | |
| ActivitiesResource.ListRequest.ApplicationNameEnum | applicationName |
Properties
ActorIpAddress
The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions.
Declaration
[RequestParameter("actorIpAddress", RequestParameterType.Query)]
public virtual string ActorIpAddress { get; set; }Property Value
| Type | Description |
|---|---|
| string |
ApplicationName
Application name for which the events are to be retrieved.
Declaration
[RequestParameter("applicationName", RequestParameterType.Path)]
public virtual ActivitiesResource.ListRequest.ApplicationNameEnum ApplicationName { get; }Property Value
| Type | Description |
|---|---|
| ActivitiesResource.ListRequest.ApplicationNameEnum |
CustomerId
The unique ID of the customer to retrieve data for.
Declaration
[RequestParameter("customerId", RequestParameterType.Query)]
public virtual string CustomerId { get; set; }Property Value
| Type | Description |
|---|---|
| string |
EndTime
Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example
2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report
has three basic time concepts: - Date of the API's request for a report: When the API created and
retrieved the report. - Report's start time: The beginning of the timespan shown in the report. The
startTime must be before the endTime (if specified) and the current time when the request is made,
or the API returns an error. - Report's end time: The end of the timespan shown in the report. For
example, the timespan of events summarized in a report can start in April and end in May. The report
itself can be requested in August. If the endTime is not specified, the report returns all activities
from the startTime until the current time or the most recent 180 days if the startTime is more than
180 days in the past.
Declaration
[RequestParameter("endTime", RequestParameterType.Query)]
public virtual string EndTime { get; set; }Property Value
| Type | Description |
|---|---|
| string |
EventName
The name of the event being queried by the API. Each eventName is related to a specific Google
Workspace service or feature which the API organizes into types of events. An example is the Google
Calendar events in the Admin console application's reports. The Calendar Settings type structure has
all of the Calendar eventName activities reported by the API. When an administrator changes a Calendar
setting, the API reports this activity in the Calendar Settings type and eventName parameters. For
more information about eventName query strings and parameters, see the list of event names for various
applications above in applicationName.
Declaration
[RequestParameter("eventName", RequestParameterType.Query)]
public virtual string EventName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Filters
The filters query string is a comma-separated list composed of event parameters manipulated by
relational operators. Event parameters are in the form {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},... These event
parameters are associated with a specific eventName. An empty report is returned if the request's
parameter doesn't belong to the eventName. For more information about the available eventName fields
for each application and their associated parameters, go to the ApplicationName
table, then click through to the Activity Events page in the Appendix for the application you want. In
the following Drive activity examples, the returned list consists of all edit events where the
doc_id parameter value matches the conditions defined by the relational operator. In the first
example, the request returns all edited documents with a doc_id value equal to 12345. In the second
example, the report returns any edited documents where the doc_id value is not equal to 98765. The
<> operator is URL-encoded in the request's query string (%3C%3E):
GET...&eventName=edit&filters=doc_id==12345
GET...&eventName=edit&filters=doc_id%3C%3E98765
A filters query supports these
relational operators: * ==—'equal to'. * <>—'not equal to'. Must be URL-encoded
(%3C%3E). * <—'less than'. Must be URL-encoded (%3C). * <=—'less than or equal to'.
Must be URL-encoded (%3C=). * >—'greater than'. Must be URL-encoded (%3E). *
>=—'greater than or equal to'. Must be URL-encoded (%3E=). Note: The API doesn't accept
multiple values of the same parameter. If a parameter is supplied more than once in the API request, the
API only accepts the last value of that parameter. In addition, if an invalid parameter is supplied in
the API request, the API ignores that parameter and returns the response corresponding to the remaining
valid parameters. If no parameters are requested, all parameters are returned.
Declaration
[RequestParameter("filters", RequestParameterType.Query)]
public virtual string Filters { get; set; }Property Value
| Type | Description |
|---|---|
| string |
GroupIdFilter
Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: "id:abc123,id:xyz456"
Declaration
[RequestParameter("groupIdFilter", RequestParameterType.Query)]
public virtual string GroupIdFilter { get; set; }Property Value
| Type | Description |
|---|---|
| string |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
MaxResults
Determines how many activity records are shown on each response page. For example, if the request sets
maxResults=1 and the report has two activities, the report has two pages. The response's
nextPageToken property has the token to the second page. The maxResults query string is optional in
the request. The default value is 1000.
Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual int? MaxResults { get; set; }Property Value
| Type | Description |
|---|---|
| int? |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
OrgUnitID
ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.
Declaration
[RequestParameter("orgUnitID", RequestParameterType.Query)]
public virtual string OrgUnitID { get; set; }Property Value
| Type | Description |
|---|---|
| string |
PageToken
The token to specify next page. A report with multiple pages has a nextPageToken property in the
response. In your follow-on request getting the next page of the report, enter the nextPageToken value
in the pageToken query string.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }Property Value
| Type | Description |
|---|---|
| string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
StartTime
Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for
example 2010-10-28T10:26:35.000Z. The report returns all activities from startTime until endTime.
The startTime must be before the endTime (if specified) and the current time when the request is
made, or the API returns an error.
Declaration
[RequestParameter("startTime", RequestParameterType.Query)]
public virtual string StartTime { get; set; }Property Value
| Type | Description |
|---|---|
| string |
UserKey
Represents the profile ID or the user email for which the data should be filtered. Can be all for all
information, or userKey for a user's unique Google Workspace profile ID or their primary email
address. Must not be a deleted user. For a deleted user, call users.list in Directory API with
showDeleted=true, then use the returned ID as the userKey.
Declaration
[RequestParameter("userKey", RequestParameterType.Path)]
public virtual string UserKey { get; }Property Value
| Type | Description |
|---|---|
| string |
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()