wehub-resource-sync
112 lines
3.4 KiB
Markdown
112 lines
3.4 KiB
Markdown
---
|
|
allowed-tools: Bash, Read, Write, Edit
|
|
argument-hint: [resource] [method] [flags]
|
|
description: Google Apps Script: Manage and execute Apps Script projects.
|
|
---
|
|
|
|
# Google Workspace Apps Script
|
|
|
|
Execute Google Workspace Apps Script operations: $ARGUMENTS
|
|
|
|
## Prerequisites
|
|
|
|
- Google Workspace CLI (`gws`) must be installed
|
|
- Authentication configured: Run `gws auth status` to verify
|
|
- Review `gws apps-script --help` for all available commands
|
|
|
|
## Available Resources and Methods
|
|
|
|
# apps-script (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 apps-script <resource> <method> [flags]
|
|
```
|
|
|
|
## Helper Commands
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| [`+push`](../gws-apps-script-push/SKILL.md) | Upload local files to an Apps Script project |
|
|
|
|
## API Resources
|
|
|
|
### processes
|
|
|
|
- `list` — List information about processes made by or on behalf of a user, such as process type and current status.
|
|
- `listScriptProcesses` — List information about a script's executed processes, such as process type and current status.
|
|
|
|
### projects
|
|
|
|
- `create` — Creates a new, empty script project with no script files and a base manifest file.
|
|
- `get` — Gets a script project's metadata.
|
|
- `getContent` — Gets the content of the script project, including the code source and metadata for each script file.
|
|
- `getMetrics` — Get metrics data for scripts, such as number of executions and active users.
|
|
- `updateContent` — Updates the content of the specified script project. This content is stored as the HEAD version, and is used when the script is executed as a trigger, in the script editor, in add-on preview mode, or as a web app or Apps Script API in development mode. This clears all the existing files in the project.
|
|
- `deployments` — Operations on the 'deployments' resource
|
|
- `versions` — Operations on the 'versions' resource
|
|
|
|
### scripts
|
|
|
|
- `run` —
|
|
|
|
## Discovering Commands
|
|
|
|
Before calling any API method, inspect it:
|
|
|
|
```bash
|
|
# Browse resources and methods
|
|
gws apps-script --help
|
|
|
|
# Inspect a method's required params, types, and defaults
|
|
gws schema apps-script.<resource>.<method>
|
|
```
|
|
|
|
Use `gws schema` output to build your `--params` and `--json` flags.
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
# List available resources and methods
|
|
gws apps-script --help
|
|
|
|
# Inspect method schema before calling
|
|
gws schema apps-script.<resource>.<method>
|
|
|
|
# Execute command with arguments
|
|
gws apps-script $ARGUMENTS
|
|
```
|
|
|
|
## Task
|
|
|
|
Execute the requested Apps Script operation: $ARGUMENTS
|
|
|
|
1. **Verify Prerequisites**
|
|
- Check `gws` is installed: `gws --version`
|
|
- Verify authentication: `gws auth status`
|
|
- Review available commands: `gws apps-script --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-apps-script`
|