admin  reports_v1
Public Types | Public Member Functions | Protected Member Functions | Properties | List of all members
Google.Apis.Admin.Reports.reports_v1.ActivitiesResource.ListRequest Class Reference

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. More...

Inheritance diagram for Google.Apis.Admin.Reports.reports_v1.ActivitiesResource.ListRequest:
Google.Apis.Admin.Reports.reports_v1.ReportsBaseServiceRequest< Google.Apis.Admin.Reports.reports_v1.Data.Activities >

Public Types

enum  ApplicationNameEnum {
  ApplicationNameEnum.AccessTransparency, ApplicationNameEnum.Admin, ApplicationNameEnum.Calendar, ApplicationNameEnum.Chat,
  ApplicationNameEnum.Drive, ApplicationNameEnum.Gcp, ApplicationNameEnum.Gplus, ApplicationNameEnum.Groups,
  ApplicationNameEnum.GroupsEnterprise, ApplicationNameEnum.Jamboard, ApplicationNameEnum.Login, ApplicationNameEnum.Meet,
  ApplicationNameEnum.Mobile, ApplicationNameEnum.Rules, ApplicationNameEnum.Saml, ApplicationNameEnum.Token,
  ApplicationNameEnum.UserAccounts
}
 Application name for which the events are to be retrieved. More...
 

Public Member Functions

 ListRequest (Google.Apis.Services.IClientService service, string userKey, ListRequest.ApplicationNameEnum applicationName)
 Constructs a new List request. More...
 

Protected Member Functions

override void InitParameters ()
 Initializes List parameter list. More...
 
- Protected Member Functions inherited from Google.Apis.Admin.Reports.reports_v1.ReportsBaseServiceRequest< Google.Apis.Admin.Reports.reports_v1.Data.Activities >
 ReportsBaseServiceRequest (Google.Apis.Services.IClientService service)
 Constructs a new ReportsBaseServiceRequest instance. More...
 
override void InitParameters ()
 Initializes Reports parameter list. More...
 

Properties

virtual string UserKey [get]
 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 G Suite profile ID or their primary email address. More...
 
virtual ApplicationNameEnum ApplicationName [get]
 Application name for which the events are to be retrieved. More...
 
virtual string ActorIpAddress [get, set]
 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. More...
 
virtual string CustomerId [get, set]
 The unique ID of the customer to retrieve data for. More...
 
virtual string EndTime [get, set]
 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. More...
 
virtual string EventName [get, set]
 The name of the event being queried by the API. Each eventName is related to a specific G Suite 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. More...
 
virtual string Filters [get, set]
 The filters query string is a comma-separated list. The list is composed of event parameters that are 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 filtered request's parameter does not belong to the eventName. For more information about eventName parameters, see the list of event names for various applications above in applicationName. More...
 
virtual System.Nullable< int > MaxResults [get, set]
 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. More...
 
virtual string OrgUnitID [get, set]
 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. More...
 
virtual string PageToken [get, set]
 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. More...
 
virtual string StartTime [get, set]
 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. More...
 
override string MethodName [get]
 summary>Gets the HTTP method. More...
 
override string HttpMethod [get]
 summary>Gets the REST path. More...
 
override string RestPath [get]
 
- Properties inherited from Google.Apis.Admin.Reports.reports_v1.ReportsBaseServiceRequest< Google.Apis.Admin.Reports.reports_v1.Data.Activities >
virtual System.Nullable< AltEnum > Alt [get, set]
 Data format for the response. More...
 
virtual string Fields [get, set]
 Selector specifying which fields to include in a partial response. More...
 
virtual string Key [get, set]
 API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. More...
 
virtual string OauthToken [get, set]
 OAuth 2.0 token for the current user. More...
 
virtual System.Nullable< bool > PrettyPrint [get, set]
 Returns response with indentations and line breaks. More...
 
virtual string QuotaUser [get, set]
 An opaque string that represents a user for quota purposes. Must not exceed 40 characters. More...
 
virtual string UserIp [get, set]
 Deprecated. Please use quotaUser instead. More...
 

Detailed Description

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.

Member Enumeration Documentation

◆ ApplicationNameEnum

Application name for which the events are to be retrieved.

Enumerator
AccessTransparency 

The G Suite Access Transparency activity reports return information about different types of Access Transparency activity events.

Admin 

The Admin console application's activity reports return account information about different types of administrator activity events.

Calendar 

The G Suite Calendar application's activity reports return information about various Calendar activity events.

Chat 

The Chat activity reports return information about various Chat activity events.

Drive 

The Google Drive application's activity reports return information about various Google Drive activity events. The Drive activity report is only available for G Suite Business customers.

Gcp 

The Google Cloud Platform application's activity reports return information about various GCP activity events.

Gplus 

The Google+ application's activity reports return information about various Google+ activity events.

Groups 

The Google Groups application's activity reports return information about various Groups activity events.

GroupsEnterprise 

The Enterprise Groups activity reports return information about various Enterprise group activity events.

Jamboard 

The Jamboard activity reports return information about various Jamboard activity events.

Login 

The Login application's activity reports return account information about different types of Login activity events.

Meet 

The Meet Audit activity report return information about different types of Meet Audit activity events.

Mobile 

The Mobile Audit activity report return information about different types of Mobile Audit activity events.

Rules 

The Rules activity report return information about different types of Rules activity events.

Saml 

The SAML activity report return information about different types of SAML activity events.

Token 

The Token application's activity reports return account information about different types of Token activity events.

UserAccounts 

The User Accounts application's activity reports return account information about different types of User Accounts activity events.

Constructor & Destructor Documentation

◆ ListRequest()

Google.Apis.Admin.Reports.reports_v1.ActivitiesResource.ListRequest.ListRequest ( Google.Apis.Services.IClientService  service,
string  userKey,
ListRequest.ApplicationNameEnum  applicationName 
)
inline

Constructs a new List request.

Member Function Documentation

◆ InitParameters()

override void Google.Apis.Admin.Reports.reports_v1.ActivitiesResource.ListRequest.InitParameters ( )
inlineprotected

Initializes List parameter list.

Property Documentation

◆ ActorIpAddress

virtual string Google.Apis.Admin.Reports.reports_v1.ActivitiesResource.ListRequest.ActorIpAddress
getset

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.

◆ ApplicationName

virtual ApplicationNameEnum Google.Apis.Admin.Reports.reports_v1.ActivitiesResource.ListRequest.ApplicationName
get

Application name for which the events are to be retrieved.

◆ CustomerId

virtual string Google.Apis.Admin.Reports.reports_v1.ActivitiesResource.ListRequest.CustomerId
getset

The unique ID of the customer to retrieve data for.

◆ EndTime

virtual string Google.Apis.Admin.Reports.reports_v1.ActivitiesResource.ListRequest.EndTime
getset

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.

◆ EventName

virtual string Google.Apis.Admin.Reports.reports_v1.ActivitiesResource.ListRequest.EventName
getset

The name of the event being queried by the API. Each eventName is related to a specific G Suite 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.

◆ Filters

virtual string Google.Apis.Admin.Reports.reports_v1.ActivitiesResource.ListRequest.Filters
getset

The filters query string is a comma-separated list. The list is composed of event parameters that are 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 filtered request's parameter does not belong to the eventName. For more information about eventName parameters, see the list of event names for various applications above in applicationName.

In the following Admin Activity example, the <> operator is URL-encoded in the request's query string (%3C%3E): GET...=CHANGE_CALENDAR_SETTING =NEW_VALUE%3C%3EREAD_ONLY_ACCESS

In the following Drive example, the list can be a view or edit event's doc_id parameter with a value that is manipulated by an 'equal to' (==) or 'not equal to' (<>) relational operator. In the first example, the report returns each edited document's doc_id. In the second example, the report returns each viewed document's doc_id that equals the value 12345 and does not return any viewed document's which have a doc_id value of 98765. The <> operator is URL-encoded in the request's query string (%3C%3E):

GET...=edit=doc_id GET...=view=doc_id==12345,doc_id%3C%3E98765

The relational operators include: - == - 'equal to'. - <> - 'not equal to'. It is URL-encoded (%3C%3E).

  • < - 'less than'. It is URL-encoded (%3C). - <= - 'less than or equal to'. It is URL-encoded (%3C=). -

  • 'greater than'. It is URL-encoded (%3E). - >= - 'greater than or equal to'. It is URL-encoded

(%3E=). Note: The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. If no parameters are requested, all parameters are returned.

◆ HttpMethod

override string Google.Apis.Admin.Reports.reports_v1.ActivitiesResource.ListRequest.HttpMethod
get

summary>Gets the REST path.

◆ MaxResults

virtual System.Nullable<int> Google.Apis.Admin.Reports.reports_v1.ActivitiesResource.ListRequest.MaxResults
getset

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.

[default: 1000] [minimum: 1] [maximum: 1000]

◆ MethodName

override string Google.Apis.Admin.Reports.reports_v1.ActivitiesResource.ListRequest.MethodName
get

summary>Gets the HTTP method.

◆ OrgUnitID

virtual string Google.Apis.Admin.Reports.reports_v1.ActivitiesResource.ListRequest.OrgUnitID
getset

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.

◆ PageToken

virtual string Google.Apis.Admin.Reports.reports_v1.ActivitiesResource.ListRequest.PageToken
getset

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.

◆ StartTime

virtual string Google.Apis.Admin.Reports.reports_v1.ActivitiesResource.ListRequest.StartTime
getset

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.

summary>Gets the method name.

◆ UserKey

virtual string Google.Apis.Admin.Reports.reports_v1.ActivitiesResource.ListRequest.UserKey
get

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 G Suite profile ID or their primary email address.


The documentation for this class was generated from the following file: