Reports.Activities.Watch (Admin SDK API reports

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.reports.ReportsRequest<Channel>
        
        com.google.api.services.reports.Reports.Activities.Watch

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Reports.Activities
```
public class Reports.Activities.Watch
extends ReportsRequest<Channel>
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected Watch(String userKey, String applicationName, Channel content)
Start receiving notifications for account activities.

Constructors
Modifier	Constructor and Description
`protected`	`Watch(String userKey, String applicationName, Channel content)` Start receiving notifications for account activities.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getActorIpAddress()` The Internet Protocol (IP) Address of host where the event was performed.
`String`	`getApplicationName()` Application name for which the events are to be retrieved.
`String`	`getCustomerId()` The unique ID of the customer to retrieve data for.
`String`	`getEndTime()` Sets the end of the range of time shown in the report.
`String`	`getEventName()` The name of the event being queried by the API.
`String`	`getFilters()` The `filters` query string is a comma-separated list composed of event parameters manipulated by relational operators.
`String`	`getGroupIdFilter()` ` Deprecated`.
`Integer`	`getMaxResults()` Determines how many activity records are shown on each response page.
`String`	`getOrgUnitID()` ` Deprecated`.
`String`	`getPageToken()` The token to specify next page.
`String`	`getStartTime()` Sets the beginning of the range of time shown in the report.
`String`	`getUserKey()` Represents the profile ID or the user email for which the data should be filtered.
`Reports.Activities.Watch`	`set(String parameterName, Object value)`
`Reports.Activities.Watch`	`set$Xgafv(String $Xgafv)` V1 error format.
`Reports.Activities.Watch`	`setAccessToken(String accessToken)` OAuth access token.
`Reports.Activities.Watch`	`setActorIpAddress(String actorIpAddress)` The Internet Protocol (IP) Address of host where the event was performed.
`Reports.Activities.Watch`	`setAlt(String alt)` Data format for response.
`Reports.Activities.Watch`	`setApplicationName(String applicationName)` Application name for which the events are to be retrieved.
`Reports.Activities.Watch`	`setCallback(String callback)` JSONP
`Reports.Activities.Watch`	`setCustomerId(String customerId)` The unique ID of the customer to retrieve data for.
`Reports.Activities.Watch`	`setEndTime(String endTime)` Sets the end of the range of time shown in the report.
`Reports.Activities.Watch`	`setEventName(String eventName)` The name of the event being queried by the API.
`Reports.Activities.Watch`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Reports.Activities.Watch`	`setFilters(String filters)` The `filters` query string is a comma-separated list composed of event parameters manipulated by relational operators.
`Reports.Activities.Watch`	`setGroupIdFilter(String groupIdFilter)` `Deprecated`.
`Reports.Activities.Watch`	`setKey(String key)` API key.
`Reports.Activities.Watch`	`setMaxResults(Integer maxResults)` Determines how many activity records are shown on each response page.
`Reports.Activities.Watch`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Reports.Activities.Watch`	`setOrgUnitID(String orgUnitID)` `Deprecated`.
`Reports.Activities.Watch`	`setPageToken(String pageToken)` The token to specify next page.
`Reports.Activities.Watch`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Reports.Activities.Watch`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Reports.Activities.Watch`	`setStartTime(String startTime)` Sets the beginning of the range of time shown in the report.
`Reports.Activities.Watch`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Reports.Activities.Watch`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.
`Reports.Activities.Watch`	`setUserKey(String userKey)` Represents the profile ID or the user email for which the data should be filtered.

Methods inherited from class com.google.api.services.reports.ReportsRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Watch
```
protected Watch(String userKey,
                String applicationName,
                Channel content)
```
    Start receiving notifications for account activities. For more information, see Receiving Push Notifications. Create a request for the method "activities.watch". This request holds the parameters needed by the the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Reports.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    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`.
    
    applicationName - Application name for which the events are to be retrieved.
    
    content - the Channel
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public Reports.Activities.Watch set$Xgafv(String $Xgafv)
```
    Description copied from class: ReportsRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class ReportsRequest<Channel>
  - setAccessToken
```
public Reports.Activities.Watch setAccessToken(String accessToken)
```
    Description copied from class: ReportsRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class ReportsRequest<Channel>
  - setAlt
```
public Reports.Activities.Watch setAlt(String alt)
```
    Description copied from class: ReportsRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class ReportsRequest<Channel>
  - setCallback
```
public Reports.Activities.Watch setCallback(String callback)
```
    Description copied from class: ReportsRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class ReportsRequest<Channel>
  - setFields
```
public Reports.Activities.Watch setFields(String fields)
```
    Description copied from class: ReportsRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class ReportsRequest<Channel>
  - setKey
```
public Reports.Activities.Watch setKey(String key)
```
    Description copied from class: ReportsRequest
    
    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.
    
    Overrides:
    
    setKey in class ReportsRequest<Channel>
  - setOauthToken
```
public Reports.Activities.Watch setOauthToken(String oauthToken)
```
    Description copied from class: ReportsRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class ReportsRequest<Channel>
  - setPrettyPrint
```
public Reports.Activities.Watch setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: ReportsRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class ReportsRequest<Channel>
  - setQuotaUser
```
public Reports.Activities.Watch setQuotaUser(String quotaUser)
```
    Description copied from class: ReportsRequest
    
    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class ReportsRequest<Channel>
  - setUploadType
```
public Reports.Activities.Watch setUploadType(String uploadType)
```
    Description copied from class: ReportsRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class ReportsRequest<Channel>
  - setUploadProtocol
```
public Reports.Activities.Watch setUploadProtocol(String uploadProtocol)
```
    Description copied from class: ReportsRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class ReportsRequest<Channel>
  - getUserKey
```
public String getUserKey()
```
    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`.
  - setUserKey
```
public Reports.Activities.Watch setUserKey(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`.
  - getApplicationName
```
public String getApplicationName()
```
    Application name for which the events are to be retrieved.
  - setApplicationName
```
public Reports.Activities.Watch setApplicationName(String applicationName)
```
    Application name for which the events are to be retrieved.
  - getActorIpAddress
```
public String getActorIpAddress()
```
    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.
  - setActorIpAddress
```
public Reports.Activities.Watch setActorIpAddress(String 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.
  - getCustomerId
```
public String getCustomerId()
```
    The unique ID of the customer to retrieve data for.
  - setCustomerId
```
public Reports.Activities.Watch setCustomerId(String customerId)
```
    The unique ID of the customer to retrieve data for.
  - getEndTime
```
public String getEndTime()
```
    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.
  - setEndTime
```
public Reports.Activities.Watch setEndTime(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.
  - getEventName
```
public String getEventName()
```
    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`.
  - setEventName
```
public Reports.Activities.Watch setEventName(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`.
  - getFilters
```
public String getFilters()
```
    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](#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.
  - setFilters
```
public Reports.Activities.Watch setFilters(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](#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.
  - getGroupIdFilter
```
public String getGroupIdFilter()
```
    ` Deprecated`. This field is deprecated and is no longer supported. 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" *Important:* To filter by groups, you must explicitly add the groups to your ` filtering groups allowlist. For more information about adding groups to filtering groups ` allowlist, see [Filter results by Google Group](https://support.google.com/a/answer/11482175) `
  - setGroupIdFilter
```
public Reports.Activities.Watch setGroupIdFilter(String groupIdFilter)
```
    `Deprecated`. This field is deprecated and is no longer supported. 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" *Important:* To filter by groups, you must explicitly add the groups to your filtering groups allowlist. For more information about adding groups to filtering groups allowlist, see [Filter results by Google Group](https://support.google.com/a/answer/11482175)
  - getMaxResults
```
public Integer getMaxResults()
```
    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]
  - setMaxResults
```
public Reports.Activities.Watch setMaxResults(Integer 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.
  - getOrgUnitID
```
public String getOrgUnitID()
```
    ` Deprecated`. This field is deprecated and is no longer supported. 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. `
  - setOrgUnitID
```
public Reports.Activities.Watch setOrgUnitID(String orgUnitID)
```
    `Deprecated`. This field is deprecated and is no longer supported. 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.
  - getPageToken
```
public String getPageToken()
```
    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.
  - setPageToken
```
public Reports.Activities.Watch setPageToken(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.
  - getStartTime
```
public String getStartTime()
```
    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.
  - setStartTime
```
public Reports.Activities.Watch setStartTime(String 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.
  - set
```
public Reports.Activities.Watch set(String parameterName,
                                    Object value)
```
    Overrides:
    
    set in class ReportsRequest<Channel>

Class Reports.Activities.Watch

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.reports.ReportsRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Watch

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getUserKey

setUserKey

getApplicationName

setApplicationName

getActorIpAddress

setActorIpAddress

getCustomerId

setCustomerId

getEndTime

setEndTime

getEventName

setEventName

getFilters

setFilters

getGroupIdFilter

setGroupIdFilter

getMaxResults

setMaxResults

getOrgUnitID

setOrgUnitID

getPageToken

setPageToken

getStartTime

setStartTime

set