Gcp/admin
@swamp/gcp/adminv2026.05.25.1
01README
Google Cloud admin infrastructure models
02Release Notes
- Updated: activities, customerusagereports, entityusagereports, userusagereport
03Models
@swamp/gcp/admin/activitiesv2026.05.25.1activities.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a activities
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the activities |
fn sync()
Sync activities state from GCP
fn list(actorIpAddress?: string, applicationInfoFilter?: string, customerId?: string, endTime?: string, eventName?: string, filters?: string, groupIdFilter?: string, includeSensitiveData?: boolean, maxResults?: number, networkInfoFilter?: string, orgUnitID?: string, resourceDetailsFilter?: string, startTime?: string, statusFilter?: string, maxPages?: number)
List activities resources
| Argument | Type | Description |
|---|---|---|
| actorIpAddress? | string | 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. |
| applicationInfoFilter? | string | Optional. Used to filter on the `oAuthClientId` field present in [`ApplicationInfo`](#applicationinfo) message. **Usage** ``` GET...&applicationInfoFilter=oAuthClientId="clientId" GET...&applicationInfoFilter=oAuthClientId=%22clientId%22 ``` |
| customerId? | string | The unique ID of the customer to retrieve data for. |
| endTime? | string | 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 |
| eventName? | string | 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` paramete |
| filters? | string | 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 ap |
| groupIdFilter? | string | 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) |
| includeSensitiveData? | boolean | Optional. When set to `true`, this field allows sensitive user-generated content to be included in the returned audit logs. This parameter is supported only for Rules (DLP) and Chat applications; using it with any other application will result in a permission error. |
| maxResults? | number | 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. |
| networkInfoFilter? | string | Optional. Used to filter on the `regionCode` field present in [`NetworkInfo`](#networkinfo) message. **Usage** ``` GET...&networkInfoFilter=regionCode="IN" GET...&networkInfoFilter=regionCode=%22IN%22 ``` |
| orgUnitID? | string | 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. |
| resourceDetailsFilter? | string | Optional. The `resourceDetailsFilter` query string is an AND separated list composed of [Resource Details](#resourcedetails) fields manipulated by relational operators. Resource Details Filters are in the form `{resourceDetails.field1}{relational operator}{field1 value} AND {resourceDetails.field2}{relational operator}{field2 value}...` All the inner fields are traversed using the `.` operator, as shown in the following example: ``` resourceDetails.id = "resourceId" AND resourceDetails.appliedLa |
| startTime? | string | 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. For Gmail requests, `startTime` and `endTime` must be provided and the difference must not be greater than 30 days. |
| statusFilter? | string | Optional. Used to filter on the `statusCode` field present in [`Status`](#status) message. **Usage** ``` GET...&statusFilter=statusCode="200" GET...&statusFilter=statusCode=%22200%22 ``` |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn watch(address?: any, expiration?: any, id?: any, kind?: any, params?: any, payload?: any, resourceId?: any, resourceUri?: any, token?: any, type?: any)
watch
| Argument | Type | Description |
|---|---|---|
| address? | any | |
| expiration? | any | |
| id? | any | |
| kind? | any | |
| params? | any | |
| payload? | any | |
| resourceId? | any | |
| resourceUri? | any | |
| token? | any | |
| type? | any |
Resources
state(infinite)— JSON template for the activity resource.
@swamp/gcp/admin/customerusagereportsv2026.05.25.1customerusagereports.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a customerUsageReports
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the customerUsageReports |
fn sync()
Sync customerUsageReports state from GCP
Resources
state(infinite)— Retrieves a report which is a collection of properties and statistics for a s...
@swamp/gcp/admin/entityusagereportsv2026.05.25.1entityusagereports.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a entityUsageReports
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the entityUsageReports |
fn sync()
Sync entityUsageReports state from GCP
Resources
state(infinite)— Retrieves a report which is a collection of properties and statistics for ent...
@swamp/gcp/admin/userusagereportv2026.05.25.1userusagereport.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a userUsageReport
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the userUsageReport |
fn sync()
Sync userUsageReport state from GCP
Resources
state(infinite)— Retrieves a report which is a collection of properties and statistics for a s...
04Previous Versions
2026.05.24.1May 24, 2026
- Updated: activities, customerusagereports, entityusagereports, userusagereport
2026.05.21.2May 21, 2026
- Updated: activities, customerusagereports, entityusagereports, userusagereport
2026.05.21.1May 21, 2026
2026.05.19.2May 19, 2026
2026.05.19.1May 19, 2026
2026.04.23.1Apr 23, 2026
2026.04.04.1Apr 4, 2026
- Updated: activities, customerusagereports, entityusagereports, userusagereport
2026.04.03.3Apr 3, 2026
- Updated: activities, customerusagereports, entityusagereports, userusagereport
2026.04.03.1Apr 3, 2026
- Updated: activities, customerusagereports, entityusagereports, userusagereport
2026.04.02.2Apr 2, 2026
2026.03.27.1Mar 27, 2026
- Added: activities, customerusagereports, entityusagereports, userusagereport
05Stats
A
100 / 100
Downloads
3
Archive size
35.0 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels