wehub-resource-sync
108 lines
3.7 KiB
Markdown
108 lines
3.7 KiB
Markdown
---
|
|
allowed-tools: Bash, Read, Write, Edit
|
|
argument-hint: [resource] [method] [flags]
|
|
description: Google Workspace Admin SDK: Audit logs and usage reports.
|
|
---
|
|
|
|
# Google Workspace Admin Reports
|
|
|
|
Execute Google Workspace Admin Reports operations: $ARGUMENTS
|
|
|
|
## Prerequisites
|
|
|
|
- Google Workspace CLI (`gws`) must be installed
|
|
- Authentication configured: Run `gws auth status` to verify
|
|
- Review `gws admin-reports --help` for all available commands
|
|
|
|
## Available Resources and Methods
|
|
|
|
# admin-reports (reports_v1)
|
|
|
|
> **PREREQUISITE:** Read `../gws-shared/SKILL.md` for auth, global flags, and security rules. If missing, run `gws generate-skills` to create it.
|
|
|
|
```bash
|
|
gws admin-reports <resource> <method> [flags]
|
|
```
|
|
|
|
## API Resources
|
|
|
|
### activities
|
|
|
|
- `list` — 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.
|
|
- `watch` — Start receiving notifications for account activities. For more information, see Receiving Push Notifications.
|
|
|
|
### channels
|
|
|
|
- `stop` — Stop watching resources through this channel.
|
|
|
|
### customerUsageReports
|
|
|
|
- `get` — Retrieves a report which is a collection of properties and statistics for a specific customer's account. For more information, see the Customers Usage Report guide. For more information about the customer report's parameters, see the Customers Usage parameters reference guides.
|
|
|
|
### entityUsageReports
|
|
|
|
- `get` — Retrieves a report which is a collection of properties and statistics for entities used by users within the account. For more information, see the Entities Usage Report guide. For more information about the entities report's parameters, see the Entities Usage parameters reference guides.
|
|
|
|
### userUsageReport
|
|
|
|
- `get` — Retrieves a report which is a collection of properties and statistics for a set of users with the account. For more information, see the User Usage Report guide. For more information about the user report's parameters, see the Users Usage parameters reference guides.
|
|
|
|
## Discovering Commands
|
|
|
|
Before calling any API method, inspect it:
|
|
|
|
```bash
|
|
# Browse resources and methods
|
|
gws admin-reports --help
|
|
|
|
# Inspect a method's required params, types, and defaults
|
|
gws schema admin-reports.<resource>.<method>
|
|
```
|
|
|
|
Use `gws schema` output to build your `--params` and `--json` flags.
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
# List available resources and methods
|
|
gws admin-reports --help
|
|
|
|
# Inspect method schema before calling
|
|
gws schema admin-reports.<resource>.<method>
|
|
|
|
# Execute command with arguments
|
|
gws admin-reports $ARGUMENTS
|
|
```
|
|
|
|
## Task
|
|
|
|
Execute the requested Admin Reports operation: $ARGUMENTS
|
|
|
|
1. **Verify Prerequisites**
|
|
- Check `gws` is installed: `gws --version`
|
|
- Verify authentication: `gws auth status`
|
|
- Review available commands: `gws admin-reports --help`
|
|
|
|
2. **Inspect Method Schema**
|
|
- Before calling any method, inspect its parameters
|
|
- Use `gws schema` to understand required fields
|
|
- Review parameter types and constraints
|
|
|
|
3. **Execute Operation**
|
|
- Build command with appropriate flags
|
|
- Use `--params` for query/path parameters
|
|
- Use `--json` for request body
|
|
- Handle pagination with `--max-results` or `--page-token`
|
|
|
|
4. **Error Handling**
|
|
- Check command output for errors
|
|
- Review API quotas and rate limits
|
|
- Handle authentication issues
|
|
- Retry transient failures
|
|
|
|
---
|
|
|
|
**License**: Apache License 2.0
|
|
**Source**: [Google Workspace CLI](https://github.com/googleworkspace/cli)
|
|
**Original Skill**: `gws-admin-reports`
|