grr
Provides tools for interacting with the Gmail API, enabling users to list messages, retrieve user profiles, and manage Gmail data from the command line.
grr
Google tools from the terminal, at maximum performance. grr-cli is one published Rust package built around the grr command-line binary. Fourteen Google APIs share one OAuth login and one command tree — generated straight from Google's own Discovery Service — while stdout stays clean and machine-readable.
Project site: grr-cli.pages.dev · Privacy
grr is an independent project and is not affiliated with or endorsed by Google.
grr auth login
grr gmail users messages list --user-id me --q "in:inbox" --max-results 5
grr drive files list --page-size 10
grr api describe calendar.events.list
grr schemaInstall
Prebuilt binaries — macOS arm64, Linux x86_64, Linux aarch64, Windows x86_64, and Windows on ARM (aarch64): GitHub Releases
Release binaries are zero-config — an OAuth client is compiled in, so grr auth login works immediately. Archives are .tar.zst (zstd level 22) on unix and .zip on Windows; binaries are UPX-packed with --best --lzma where the compressor supports it — the workflow verifies the packed copy still executes and falls back to the unpacked binary with a warning if not.
From source (the default CLI build requires Rust nightly — see Development):
cargo install --git https://github.com/debanjanbasu/grr-clior from a local clone at the repository root:
git clone https://github.com/debanjanbasu/grr-cli
cd grr-cli
cargo install --path .A source build has no OAuth client compiled in — see Authentication and configuration.
Package managers:
winget install debanjanbasu.grr # Windows (manifest not yet published — submission automated via REPO_WINGET_TOKEN; see Packaging & status)
cargo install grr-cli # crates.ioHomebrew (macOS + Linux), from the debanjanbasu/tap tap:
brew tap debanjanbasu/tap
brew trust debanjanbasu/tap
brew install grrbrew trust is required, not decorative: since Homebrew 4.4 third-party taps are untrusted by default, and brew install refuses to install a formula from an untrusted tap until you trust it once. Skipping that line is the most common first-run failure.
The crates.io CLI build needs nightly Rust and RUSTFLAGS="--cfg reqwest_unstable" for HTTP/3; the prebuilt releases avoid that source-build step. cargo install also produces a binary with no embedded OAuth client, so budget five minutes for grr auth setup (or a .env) on that path.
Shell completions — grr completions <shell> prints scripts from the same tree as grr --help. Bash and zsh: write the script once (refresh after upgrading); both load it lazily (the zsh script is ~2.6 MB). PowerShell and Elvish snippets below run the generator on each shell startup.
# zsh: any directory on $fpath; if ~/.zfunc is not on it yet, add
# `fpath=(~/.zfunc $fpath)` to ~/.zshrc ABOVE compinit (or oh-my-zsh's source line)
mkdir -p ~/.zfunc && grr completions zsh > ~/.zfunc/_grr
# bash (bash-completion 2.x loads this lazily)
mkdir -p ~/.local/share/bash-completion/completions
grr completions bash > ~/.local/share/bash-completion/completions/grr
# PowerShell: add to $PROFILE
grr completions powershell | Out-String | Invoke-Expression
# elvish: add to rc.elv
eval (grr completions elvish | slurp)Fish is not supported yet: clap_complete's fish generator stops below two levels of subcommand nesting, and grr's methods sit three to five levels deep.
Related MCP server: google-workspace-mcp-advanced
60-second quickstart
brew tap debanjanbasu/tap
brew trust debanjanbasu/tap
brew install grr
grr auth login
grr gmail users getProfile --user-id meThere is nothing to configure first: a release binary already carries an OAuth client, so grr auth login opens the browser, you consent, and every service works. Headless machine? grr auth login --device prints a URL + code instead of opening a browser — that flow authenticates as a separate client of type TVs and Limited Input devices (Google's device endpoint rejects the Desktop client with Invalid client type), which release binaries also carry; a source build supplies it with GRR_DEVICE_CLIENT_ID / GRR_DEVICE_CLIENT_SECRET. Google also caps what that flow may ask for: only drive.file, calendar, calendar.readonly, the legacy Calendar/Contacts feeds, userinfo and openid are grantable, so a device login asks for the same flag-derived set the browser flow would (--service / --all-scopes work here too) intersected with that allowlist — one scope outside it fails the whole request. Gmail, Chat, Docs, Sheets, Slides, Tasks, Forms, Apps Script, Analytics and the admin APIs still need the browser flow, and --device --all-scopes will not get them.
Building from source instead of installing a release? Read Authentication and configuration before your first grr invocation.
Authentication and configuration
Release binaries are zero-config. build.rs reads GRR_CLIENT_ID / GRR_CLIENT_SECRET from the build environment — GitHub Actions repo secrets for the official builds — and compiles them in, so GitHub Releases and Homebrew installs need no config file and no console visit.
Source builds bring their own client. cargo install grr-cli compiles the published sources with nothing in the build environment, so that binary has no embedded client. Any one of these fixes it:
A
.envnext toCargo.toml— copy.env.exampleto.env, fill in both values, rebuild.build.rsreads the environment first and.envsecond, so every build after that is zero-config too..envis gitignored; never commit it.Environment variables for a single build —
GRR_CLIENT_ID=… GRR_CLIENT_SECRET=… cargo build --release.grr auth setup— no rebuild required, because it writes~/.grr/config.toml(Windows:%USERPROFILE%\.grr\config.toml) instead.
grr auth setup
Create and store an OAuth client. Release builds ship with one, so this is only needed when using
your own client
Usage: grr auth setup [OPTIONS]
Options:
--client-id <CLIENT_ID> Google OAuth client id (…apps.googleusercontent.com).
Prompted for when omitted
--client-secret <CLIENT_SECRET> Google OAuth client secret. Prompted for when omitted
--print-only Print the instructions and the resolved path, but write
nothing. Useful for a first look, and for agents that only
want the recipe
--force Overwrite an existing ~/.grr/config.toml instead of refusing
--enable-apis Try `gcloud services enable` for the APIs when gcloud is on
PATH
-f, --format <FORMAT> Output format [default: json] [possible values: json, jsonl,
table, pretty]
--readonly Refuse every write method (POST/PATCH/PUT/DELETE); only reads
run
--deny-service <SERVICE> Refuse every method of this service (repeatable)
--deny-verb <VERB> Refuse this HTTP verb (repeatable)
-h, --help Print helpIt checks the client-id shape before writing anything (must end in .apps.googleusercontent.com, and a truncated paste is rejected), rejects a truncated secret, writes the file mode 0600 on unix, and refuses to clobber an existing config.toml without --force. It prints the exact Cloud Console URLs and the gcloud services enable line covering every API behind a command — gmail, calendar-json, drive, people, chat, forms, tasks, docs, sheets, slides, script, analyticsadmin, analyticsdata, and searchconsole …googleapis.com — and --print-only hands you that recipe without touching disk, which is the right first command when you have no client at all:
grr auth setup --print-onlyBecause it runs before any client is resolved, grr auth setup works even when nothing is configured yet: it is the escape hatch, not a last resort. Under a non-TTY stdin (CI, agents, pipes) it errors instead of hanging, so pass --client-id and --client-secret explicitly rather than relying on the prompts.
Resolution order at runtime: GRR_OAUTH__CLIENT_ID / GRR_OAUTH__CLIENT_SECRET → ~/.grr/config.toml → the client compiled into the binary (env wins over the file; the compiled-in client is the fallback). GRR_CONFIG_PATH moves the file; RUST_LOG sets the log level.
Embedding a client secret is acceptable here because Google treats installed-app client secrets as non-confidential — the flow is protected by PKCE, which is always on. The secret lives in GitHub Actions repo secrets and is compiled in at release time; it must never enter the repository or a CI log.
To create a client from scratch, follow docs/gcp-setup.md — you only need that if you are building from source or deliberately want your own client.
The project/fork is Google Rust Rewrite; the Google consent-screen application is named Rust Rewrite. The consent screen is where that shorter name appears.
grr ask and System One (JEV)
grr ask "<request>" routes plain words to a typed method + parameters and prints the plan; --run executes it through the same call path as grr api. Routing is three System One judgments — service, then method, then parameters — each a small HTTP request. The model only ever selects among candidates the CLI supplies: the 14 services, a service's methods, a parameter's enum values or spans found in your request. It cannot invent a method id or a value — the CLI decides what runs.
Set TYPESAFE_API_KEY and it works against TypeSafe's hosted Jev:
export TYPESAFE_API_KEY=...
grr ask "show my unread messages"The env route is preferred: a key in a config file can leak with the file. The [systemone] block in ~/.grr/config.toml is the only other surface:
Key | Default | Meaning |
|
| any provider speaking the System One contract (POST |
|
| model name sent to that endpoint |
| — | sent as |
|
| below this method-choice confidence the plan is flagged, never blocked |
Any key also accepts the generic GRR_SYSTEMONE__ENDPOINT / GRR_SYSTEMONE__MODEL / GRR_SYSTEMONE__API_KEY env form (the same GRR_ route as GRR_OAUTH__*), and TYPESAFE_API_KEY overrides api-key. The key never appears in the printed plan or in a request body — it rides only in the Authorization header.
Pointing endpoint/model at your own provider changes only which model ranks the CLI-supplied candidates; the candidate sets, the typed parameter fill, and what actually executes stay grr's. grr ask honors the global safety flags (--readonly, --deny-service <name>, --deny-verb <VERB>) whether or not you pass --run, and the gate runs as soon as the method is resolved — before the parameter-fill judgment and before any Google request is built or sent.
Usage highlights
grr gmail users messages list --user-id me --q "from:github.com" --max-results 10
grr gmail users messages get --user-id me --id 191f8ab2 --param-format metadata
grr gmail users threads list --user-id me --max-results 10
grr calendar events list --calendar-id primary --time-min 2026-10-01T00:00:00Z --max-results 10
grr drive files list --q "name contains 'report'" --page-size 10
grr drive files export --file-id <id> --mime-type application/pdf
grr chat spaces messages create --parent spaces/AAAA --body-file ./message.json
grr sheets spreadsheets values get --spreadsheet-id 1AbC… --range Sheet1!A1:B10
grr tasks tasklists list
grr transport
grr schemaEvery command that prints data takes -f/--format json|jsonl|table|pretty (default json); grr transport, grr completions and grr skills install print plain text instead. For gmail users messages get, the Gmail MIME parameter named format arrives as --param-format full|metadata|minimal|raw (see the collision rule below), while -f/--format still selects the printed output format. Logs go to stderr, so stdout is always parseable:
grr gmail users messages list --user-id me --q "in:inbox" --max-results 1 | jq -r '.[0].id'grr --version prints the semver on its first line (scripts depend on that), then the crab mascot: in full 24-bit-colour pixel art on a terminal that advertises COLORTERM/direct colour, and as plain ASCII everywhere else — a pipe, TERM=dumb, or NO_COLOR. Set CLICOLOR_FORCE=1 to force the colour logo through a pipe (grr --version | less -R); NO_COLOR still wins over it.
Command reference
The command tree is generated from the committed Discovery index by scripts/generate-commands.ts (CI-gated with --check), so this table is deliberately coarse: grr --help and grr schema are the source of truth, and every one of the 402 methods is a real, typed command.
Group | What it covers | Methods |
|
| — |
|
| - |
| an MCP (JSON-RPC over stdio) server exposing every method as a typed tool; speaks the stateless | - |
|
| 402 |
| the whole command tree as JSON | — |
|
| — |
| negotiated HTTP version + runtime features | — |
|
| — |
| messages, threads, drafts, labels, history, attachments, filters, forwarding, POP/IMAP, send-as, CSE, delegates, watches | 79 |
| calendars, events, instances, ACL, free/busy, colors, settings | 38 |
| files, permissions, comments, replies, revisions, changes, drives, apps, approvals | 64 |
| contacts, connections, contact groups, other contacts, directory people | 24 |
| spaces, members, messages, reactions, media, custom emoji, read state | 55 |
| form bodies, responses, watches, publish settings | 10 |
| tasklists and the tasks inside them | 14 |
| documents | 3 |
| spreadsheets, values, batch operations, developer metadata | 17 |
| presentations, pages, thumbnails | 5 |
| script projects, deployments, versions, processes, running functions | 16 |
| accounts, properties, data streams, custom dimensions and metrics, conversion events | 55 |
| standard, realtime, pivot and batch reports, audience exports | 11 |
| search analytics queries, sitemaps, sites, URL inspection | 11 |
Safety profiles. --readonly, --deny-service <name> and --deny-verb <VERB> are global flags honored by the generated tree, grr api call, grr ask and grr mcp alike — they parse before or after the subcommand, and turn destructive methods into actionable errors:
grr --readonly gmail users messages delete --user-id me --id abc # refused: DELETE
grr --deny-service chat chat spaces list # refused: the chat serviceThe generated tree
Every service command above is generated from the committed index by scripts/generate-commands.ts — there are no hand-written per-service commands and no hand-written per-service clients. scripts/generate-commands.ts reads the committed Discovery index (src/discovery/*.json, ~2.6 MiB across the 14 services) and emits the whole tree into src/commands/generated.rs — 402 leaves, 996 typed flags, using clap's builder API. A daily workflow refetches Google's Discovery Service, regenerates the index along with the command tree, the per-service agent skills, and the site's coverage table, and opens a PR, so new API surface reaches you without waiting for a grr release. The tree and the index are generated artifacts: never hand-edit them.
The rules, so you can predict any command without memorizing it:
The naming rule. A leaf mirrors its Discovery method id:
gmail.users.messages.list→grr gmail users messages list. Resources nest as subcommands; each leaf also carries its bare method name as a visible alias (list,get— camelCase methods keep their casing, e.g.getProfile).Typed flags per method. Parameter names come from the same ids:
userId→--user-id,maxResults→--max-results. Integers are parsed asi64, booleans are presence flags, repeated parameters repeat (--label-ids a --label-ids b), enum parameters validate their values, and required parameters are enforced by clap.The collision rule. A parameter named
format,query,params,body-file,dry-run, orhelpwould collide with the shared escape hatches, so it is exposed as--param-format/--param-query/ … (seeRESERVED_FLAG_IDSinscripts/script-utils.ts).Untyped bodies. Discovery's request schemas are not part of the index, so
POST/PATCH/PUTbodies pass through--params <JSON>(merged; typed flags win) or--body-file <PATH|->verbatim.Every leaf also carries the escape hatches:
--params <JSON>,--body-file, repeatable--query KEY=VALUE,--dry-run, and-f json|jsonl|table|pretty.
Dispatch resolves the leaf's id against the embedded index and funnels into one shared call path — the same engine grr api call uses. The two routes are interchangeable:
grr api call gmail.users.messages.list --param userId=me --dry-run
grr gmail users messages list --user-id me --dry-run
# byte-identical outputgrr api stays as the flat escape hatch: list [--service] [--filter] [--grouped] to browse, describe <id> for parameters and scopes, call <id> to invoke, refresh [--service] to pull the index forward between releases. Because the index is embedded rather than fetched, both grr api list and grr schema work with no network at all.
Consent starts small: grr auth login requests Gmail, Drive, Calendar, Tasks, Docs, Sheets, Slides and the sign-in scopes, and grr auth login --service <name> adds one service's scopes from the embedded index (--all-scopes asks for the whole ~112-scope union). That default exists because Google's consent screen stops submitting past roughly 27 ticked boxes on an unverified project — with no error at all — so asking for everything makes a first-time login impossible. Every login carries include_granted_scopes, so widening merges with what the account already granted instead of replacing it. Chat's app-authentication scopes (chat.bot, chat.app.*, chat.import) are never requested: a user consent screen cannot show them, and one of them fails the whole authorization with invalid_scope. Everything the index can express stays reachable that way, so a call is never refused for want of a narrower sibling. grr api describe still reports each method's least-privilege scope for a human deciding what a call touches. A 403 therefore means a scope outside the current grant (the message names it — run grr auth login --service <name> for that service) or an API that is not enabled on your Cloud project. Every API behind a command (tasks.googleapis.com, docs.googleapis.com, sheets.googleapis.com, slides.googleapis.com) must still be enabled on your Cloud project — see docs/gcp-setup.md.
Design philosophy
Zero-config. Release binaries carry an OAuth client compiled in by
build.rs, so a fresh install runsgrr auth loginwith nothing to configure.~/.grr/config.tomlis the override, not the prerequisite, and holds only the OAuth client (ID, optionally a secret) plus — if you pointgrr askat your own model — its[systemone]block (seegrr askand System One). Redirect URI, pool sizes, timeouts, and retry policy are compile-time constants tuned for Google's frontends (src/core/http.rs), and the consent set is derived from the embedded index rather than a knob.GRR_CONFIG_PATHoverrides the file location,RUST_LOGthe log level (GRR_OAUTH__*env vars exist for headless overrides) — nothing else is configurable, on purpose.Generated, namespaced services. The command tree is compiled from the Discovery index — the same machine-readable description Google publishes — so method additions land as a daily PR instead of a hand-written backlog. Mail is
grr gmail …; Calendar, Drive, People, Chat, Forms, Tasks, Docs, Sheets, and Slides live alongside it, and account-level concerns stay top-level (grr auth,grr api,grr ask,grr mcp,grr transport,grr schema,grr completions,grr skills). One login covers the default services;grr auth login --service <name>widens it to any other.Self-migrating installs. A newer binary brings the agent skills it installed up to date on its own: files you never touched are replaced, files you edited get a 3-way merge against the bytes grr last wrote, and a conflict leaves your file untouched with the incoming version beside it (
.grr-incoming). Files grr did not install are never touched. The check is lazy — a version compare; nothing is hashed until something actually needs merging.stdout purity. Logs go to stderr, results go to stdout, so
| jqalways works.-f jsonlstreams arrays one object per line.Keyring-first token storage. Tokens live in the OS keyring (Windows Credential Manager, macOS Keychain, Linux Secret Service via D-Bus), with automatic fallback to
<cache dir>/grr/token.jsonon headless systems. A token found in the fallback file auto-imports into the keyring on first sight.GRR_TOKEN_STORE=fileskips the keyring entirely — the switch for scripts, agents, and CI, where an OS approval prompt is a hang rather than a question.Agent-first.
grr schemadumps the complete command tree as JSON with zero configuration — the machine-readable contract for AI agents, discoverable without touching a config file or scraping--help. One fast CLI replaces per-service MCP servers: no MCP setup, justgrr schema. There is also a packaged agent skill at skills/grr/SKILL.md — see Agent skills.
Agent skills
grr ships a packaged agent skill: skills/grr/SKILL.md — the discovery-first discipline (schema → api list → api describe → --dry-run), the method-id naming rule, and the output contract in one file, written for any AI agent. The core skill plus the 14 generated per-service skills are compiled into the binary, so grr skills install writes them into ~/.agents/skills/ with no network (Codex, opencode, Cursor, Gemini CLI, Copilot CLI and omp all read that location; --claude mirrors into ~/.claude/skills/ for Claude Code, which reads nothing else):
grr skills install # all 16 files into ~/.agents/skills/ (idempotent; identical files are a no-op)
grr skills install --claude # also mirror into ~/.claude/skills/
grr skills install --force # replace files that differ from the packaged copy
grr skills list # the packaged set, and what each target directory holdsor install straight from the repository with the skills CLI:
npx skills add https://github.com/debanjanbasu/grr-cliThe site's agents guide carries the same contract for humans and harness authors.
Performance
HTTP/3 (QUIC) by default — prior-knowledge h3 with one authenticated probe at startup and silent HTTP/2 fallback;
grr transportshows what was actually negotiated.Tokio multi-threaded runtime, auto-sized to cores — no thread pool to tune.
In-flight request valve — a semaphore (not a thread pool) caps concurrent HTTP requests at 64, staying under Gmail's per-user rate limits so bursts don't self-DOS into 429s. 429s are retried honoring
Retry-After(waits capped at 30s) — a header-less 429 retries on the transient backoff (100–800 ms) instead of surfacing; aRetry-Afterpast the cap is reported (Rate limited: retry after Ns) rather than slept through, and HTTP-dateRetry-Aftervalues are honored. Whole-request timeout is 30s. API requests ride the same probed engine asgrr transport: one engine per service origin, probed once per process, HTTP/2-prior-knowledge fallback rebuilt automatically if the probe fails; a 401 on the data plane fails fast with thegrr auth loginhint.Compression always on — gzip, deflate, zstd, and brotli response decompression.
io_uring file I/O is a Linux-only target-specific dependency, auto-detected at runtime; it is not a Cargo feature.
Measured startup, binary size, and request-latency numbers against the other Google Workspace CLIs live at grr-cli.pages.dev/compare/, checked nightly by an automated workflow and re-measured whenever a new version ships.
Architecture
grr-cli is one published crate at the repository root. src/lib.rs builds the library target grr_cli; src/main.rs is a thin wrapper over src/cli.rs, and the binary is named grr.
.
├── src/
│ ├── core/ # auth/device/oauth/server/store, http.rs,
│ │ # config.rs, config_loader.rs, error.rs,
│ │ # runtime.rs (the io_uring probe)
│ ├── commands/ # auth.rs, api.rs, setup.rs, transport.rs,
│ │ # skills/, mcp.rs, ask.rs, completions.rs,
│ │ # safety.rs (the static
│ │ # + generated.rs (GENERATED — the
│ │ # whole service tree, ~470 KiB) and gen_dispatch.rs
│ │ # (resolves leaf ids, funnels into the shared path)
│ ├── discovery.rs # loader over the embedded index
│ ├── discovery/ # generated *.json index (~2.6 MiB, committed,
│ │ # refreshed daily by workflow PR)
│ ├── schema.rs
│ ├── output.rs
│ ├── cli.rs
│ ├── lib.rs
│ └── main.rs
└── tests/ # 5 integration test filesOne shared core, no per-service client modules: the CLI speaks Discovery through a single call path (src/commands/api.rs), and the typed request/response models of the 0.3.x library era are gone. The repository also contains the assets/, site/ (the Astro site at grr-cli.pages.dev, deployed from main by Cloudflare Pages), packaging/, and scripts/ material used for the project site and distribution.
Development
grr requires Rust nightly — the build script fails with a clear message on any other toolchain. rust-toolchain.toml floats on the latest nightly and supplies the components needed by the build, while .cargo/config.toml sets the reqwest_unstable cfg for HTTP/3.
cargo build
cargo test
cargo clippy --all-targets -- -D warnings
cargo fmt --all --check
cargo run -- api list
node scripts/fetch-discovery.ts # refresh the Discovery index
node scripts/generate-commands.ts # regenerate the service command tree
node scripts/generate-skills.ts # regenerate skills/<service>/SKILL.md
node scripts/generate-coverage.ts # regenerate the site coverage table
node scripts/generate-changelog.ts # regenerate CHANGELOG.md + site dataEach generator takes --check and exits 1 when its output is stale — that is the CI gate. Change the index or the generator, never src/commands/generated.rs by hand.
Tests never touch real credentials — token paths are injected, and wiremock serves the API endpoints.
RUST_LOG=debugtraces requests; the default level mutes quinn_udp's harmless IPv6 warnings (info,quinn_udp=error).A local build needs an OAuth client before a live call can work: copy
.env.exampleto.envand fill it in (compiled in bybuild.rs), or rungrr auth setupto write~/.grr/config.toml. See CONTRIBUTING.md.cargo run -- api listandcargo run -- schemaneed no client at all — the index is embedded.
Packaging & status
Channel | Install | Status |
GitHub Releases | 5-platform binaries (macOS arm64, Linux x86_64, Linux aarch64, Windows x86_64, Windows on ARM) built on | live — every push to main releases; releases always carries the newest |
crates.io |
| live — one crate, published on every release. Trusted publishing uses OIDC (no stored API tokens) |
winget |
| not yet published — |
Homebrew |
| live (arm64 macOS + x86_64/arm64 Linux) |
The project publishes one package, grr-cli, whose binary is grr. v* tags trigger the release workflow, and crates.io publishing is handled through trusted publishing.
License
MIT — see LICENSE.
Available Tools
402 toolsanalyticsadmin.accounts.deleteA
Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: get, getDataSharingSettings, list, patch, provisionAccountTicket, runAccessReport, searchChangeHistoryEvents.
Inputs: name (required), query, params, dry_run, +1 more. Returns: object
analyticsadmin.accounts.getB
Lookup for a single Account [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, getDataSharingSettings, list, patch, provisionAccountTicket, runAccessReport, searchChangeHistoryEvents.
Inputs: name (required), query, params, dry_run, +1 more. Returns: name, deleted, createTime, regionCode, +3 more
analyticsadmin.accounts.getDataSharingSettingsB
Get data sharing settings on an account. Data sharing settings are singletons [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, get, list, patch, provisionAccountTicket, runAccessReport, searchChangeHistoryEvents.
Inputs: name (required), query, params, dry_run, +1 more. Returns: name, sharingWithOthersEnabled, sharingWithGoogleSupportEnabled, sharingWithGoo…
analyticsadmin.accounts.listA
Returns all accounts accessible by the caller. Note that these accounts might not currently have GA properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found. Note: The easiest way to retrieve a list of all properties you have access to is by using ListAccountSummaries [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, get, getDataSharingSettings, patch, provisionAccountTicket, runAccessReport, searchChangeHistoryEvents.
Inputs: query, params, dry_run, pageSize, +3 more. Returns: accounts, nextPageToken
analyticsadmin.accounts.patchA
Updates an account [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaAccount object accepting createTime, deleted, displayName, gmpOrganization, name, regionCode, updateTime; pass it via params or whole via body_file Siblings over the same resource: delete, get, getDataSharingSettings, list, provisionAccountTicket, runAccessReport, searchChangeHistoryEvents.
Inputs: name (required), query, params, dry_run, +3 more. Returns: name, deleted, createTime, regionCode, +3 more
analyticsadmin.accounts.provisionAccountTicketA
Requests a ticket for creating an account [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest object accepting account, redirectUri; pass it via params or whole via body_file Siblings over the same resource: delete, get, getDataSharingSettings, list, patch, runAccessReport, searchChangeHistoryEvents.
Inputs: query, params, dry_run, body_file, +1 more. Returns: accountTicketId
analyticsadmin.accounts.runAccessReportA
Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analyti [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaRunAccessReportRequest object accepting dateRanges, dimensionFilter, dimensions, expandGroups, includeAllUsers, limit, metricFilter, metrics and 4 more fields; pass it via params or whole via body_file Siblings over the same resource: delete, get, getDataSharingSettings, list, patch, provisionAccountTicket, searchChangeHistoryEvents.
Inputs: entity (required), query, params, dry_run, +2 more. Returns: rows, quota, rowCount, metricHeaders, +1 more
analyticsadmin.accounts.searchChangeHistoryEventsB
Searches through all changes to an account or its children given the specified set of filters. Only returns the subset of changes supported by the API. The UI may return additional changes [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest object accepting action, actorEmail, earliestChangeTime, latestChangeTime, pageSize, pageToken, property, resourceType; pass it via params or whole via body_file Siblings over the same resource: delete, get, getDataSharingSettings, list, patch, provisionAccountTicket, runAccessReport.
Inputs: account (required), query, params, dry_run, +2 more. Returns: nextPageToken, changeHistoryEvents
analyticsadmin.accountSummaries.listB
Returns summaries of all accounts accessible by the caller [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file
Inputs: query, params, dry_run, pageSize, +2 more. Returns: nextPageToken, accountSummaries
analyticsadmin.properties.acknowledgeUserDataCollectionA
Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest object accepting acknowledgement; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, getDataRetentionSettings, list, patch, runAccessReport, updateDataRetentionSettings.
Inputs: property (required), query, params, dry_run, +2 more. Returns: object
analyticsadmin.properties.conversionEvents.createA
Deprecated: Use CreateKeyEvent instead. Creates a conversion event with the specified attributes [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaConversionEvent object accepting countingMethod, createTime, custom, defaultConversionValue, deletable, eventName, name; pass it via params or whole via body_file Siblings over the same resource: delete, get, list, patch.
Inputs: parent (required), query, params, dry_run, +2 more. Returns: name, custom, deletable, eventName, +3 more
analyticsadmin.properties.conversionEvents.deleteA
Deprecated: Use DeleteKeyEvent instead. Deletes a conversion event in a property [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get, list, patch.
Inputs: name (required), query, params, dry_run, +1 more. Returns: object
analyticsadmin.properties.conversionEvents.getA
Deprecated: Use GetKeyEvent instead. Retrieve a single conversion event [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, list, patch.
Inputs: name (required), query, params, dry_run, +1 more. Returns: name, custom, deletable, eventName, +3 more
analyticsadmin.properties.conversionEvents.listA
Deprecated: Use ListKeyEvents instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, patch.
Inputs: parent (required), query, params, dry_run, +3 more. Returns: nextPageToken, conversionEvents
analyticsadmin.properties.conversionEvents.patchA
Deprecated: Use UpdateKeyEvent instead. Updates a conversion event with the specified attributes [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaConversionEvent object accepting countingMethod, createTime, custom, defaultConversionValue, deletable, eventName, name; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list.
Inputs: name (required), query, params, dry_run, +3 more. Returns: name, custom, deletable, eventName, +3 more
analyticsadmin.properties.createA
Creates a Google Analytics property with the specified location and attributes [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaProperty object accepting account, createTime, currencyCode, deleteTime, displayName, expireTime, industryCategory, name and 5 more fields; pass it via params or whole via body_file Siblings over the same resource: acknowledgeUserDataCollection, delete, get, getDataRetentionSettings, list, patch, runAccessReport, updateDataRetentionSettings.
Inputs: query, params, dry_run, body_file, +1 more. Returns: name, parent, account, timeZone, +9 more
analyticsadmin.properties.customDimensions.archiveA
Archives a CustomDimension on a property [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest object; pass it via params or whole via body_file Siblings over the same resource: create, get, list, patch.
Inputs: name (required), query, params, dry_run, +2 more. Returns: object
analyticsadmin.properties.customDimensions.createA
Creates a CustomDimension. Warning: It's not permissible to use this method to collect data on individual users. In particular, sending user IDs in custom dimensions violates the Google Analytics Terms of Service [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaCustomDimension object accepting description, disallowAdsPersonalization, displayName, name, parameterName, scope; pass it via params or whole via body_file Siblings over the same resource: archive, get, list, patch.
Inputs: parent (required), query, params, dry_run, +2 more. Returns: name, scope, description, displayName, +2 more
analyticsadmin.properties.customDimensions.getA
Lookup for a single CustomDimension [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: archive, create, list, patch.
Inputs: name (required), query, params, dry_run, +1 more. Returns: name, scope, description, displayName, +2 more
analyticsadmin.properties.customDimensions.listA
Lists CustomDimensions on a property [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: archive, create, get, patch.
Inputs: parent (required), query, params, dry_run, +3 more. Returns: nextPageToken, customDimensions
analyticsadmin.properties.customDimensions.patchA
Updates a CustomDimension on a property [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaCustomDimension object accepting description, disallowAdsPersonalization, displayName, name, parameterName, scope; pass it via params or whole via body_file Siblings over the same resource: archive, create, get, list.
Inputs: name (required), query, params, dry_run, +3 more. Returns: name, scope, description, displayName, +2 more
analyticsadmin.properties.customMetrics.archiveA
Archives a CustomMetric on a property [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest object; pass it via params or whole via body_file Siblings over the same resource: create, get, list, patch.
Inputs: name (required), query, params, dry_run, +2 more. Returns: object
analyticsadmin.properties.customMetrics.createA
Creates a CustomMetric [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaCustomMetric object accepting description, displayName, measurementUnit, name, parameterName, restrictedMetricType, scope; pass it via params or whole via body_file Siblings over the same resource: archive, get, list, patch.
Inputs: parent (required), query, params, dry_run, +2 more. Returns: name, scope, description, displayName, +3 more
analyticsadmin.properties.customMetrics.getA
Lookup for a single CustomMetric [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: archive, create, list, patch.
Inputs: name (required), query, params, dry_run, +1 more. Returns: name, scope, description, displayName, +3 more
analyticsadmin.properties.customMetrics.listB
Lists CustomMetrics on a property [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: archive, create, get, patch.
Inputs: parent (required), query, params, dry_run, +3 more. Returns: customMetrics, nextPageToken
analyticsadmin.properties.customMetrics.patchA
Updates a CustomMetric on a property [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaCustomMetric object accepting description, displayName, measurementUnit, name, parameterName, restrictedMetricType, scope; pass it via params or whole via body_file Siblings over the same resource: archive, create, get, list.
Inputs: name (required), query, params, dry_run, +3 more. Returns: name, scope, description, displayName, +3 more
analyticsadmin.properties.dataStreams.createA
Creates a DataStream [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaDataStream object accepting androidAppStreamData, createTime, displayName, iosAppStreamData, name, type, updateTime, webStreamData; pass it via params or whole via body_file Siblings over the same resource: delete, get, list, patch.
Inputs: parent (required), query, params, dry_run, +2 more. Returns: name, type, createTime, updateTime, +4 more
analyticsadmin.properties.dataStreams.deleteA
Deletes a DataStream on a property [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get, list, patch.
Inputs: name (required), query, params, dry_run, +1 more. Returns: object
analyticsadmin.properties.dataStreams.getA
Lookup for a single DataStream [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, list, patch.
Inputs: name (required), query, params, dry_run, +1 more. Returns: name, type, createTime, updateTime, +4 more
analyticsadmin.properties.dataStreams.listA
Lists DataStreams on a property [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, patch.
Inputs: parent (required), query, params, dry_run, +3 more. Returns: dataStreams, nextPageToken
analyticsadmin.properties.dataStreams.measurementProtocolSecrets.createA
Creates a measurement protocol secret [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaMeasurementProtocolSecret object accepting displayName, name, secretValue; pass it via params or whole via body_file Siblings over the same resource: delete, get, list, patch.
Inputs: parent (required), query, params, dry_run, +2 more. Returns: name, displayName, secretValue
analyticsadmin.properties.dataStreams.measurementProtocolSecrets.deleteA
Deletes target MeasurementProtocolSecret [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get, list, patch.
Inputs: name (required), query, params, dry_run, +1 more. Returns: object
analyticsadmin.properties.dataStreams.measurementProtocolSecrets.getB
Lookup for a single MeasurementProtocolSecret [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, list, patch.
Inputs: name (required), query, params, dry_run, +1 more. Returns: name, displayName, secretValue
analyticsadmin.properties.dataStreams.measurementProtocolSecrets.listB
Returns child MeasurementProtocolSecrets under the specified parent Property [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, patch.
Inputs: parent (required), query, params, dry_run, +3 more. Returns: nextPageToken, measurementProtocolSecrets
analyticsadmin.properties.dataStreams.measurementProtocolSecrets.patchA
Updates a measurement protocol secret [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaMeasurementProtocolSecret object accepting displayName, name, secretValue; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list.
Inputs: name (required), query, params, dry_run, +3 more. Returns: name, displayName, secretValue
analyticsadmin.properties.dataStreams.patchA
Updates a DataStream on a property [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaDataStream object accepting androidAppStreamData, createTime, displayName, iosAppStreamData, name, type, updateTime, webStreamData; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list.
Inputs: name (required), query, params, dry_run, +3 more. Returns: name, type, createTime, updateTime, +4 more
analyticsadmin.properties.deleteA
Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: acknowledgeUserDataCollection, create, get, getDataRetentionSettings, list, patch, runAccessReport, updateDataRetentionSettings.
Inputs: name (required), query, params, dry_run, +1 more. Returns: name, parent, account, timeZone, +9 more
analyticsadmin.properties.firebaseLinks.createA
Creates a FirebaseLink. Properties can have at most one FirebaseLink [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaFirebaseLink object accepting createTime, name, project; pass it via params or whole via body_file Siblings over the same resource: delete, list.
Inputs: parent (required), query, params, dry_run, +2 more. Returns: name, project, createTime
analyticsadmin.properties.firebaseLinks.deleteA
Deletes a FirebaseLink on a property [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, list.
Inputs: name (required), query, params, dry_run, +1 more. Returns: object
analyticsadmin.properties.firebaseLinks.listA
Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete.
Inputs: parent (required), query, params, dry_run, +3 more. Returns: firebaseLinks, nextPageToken
analyticsadmin.properties.getB
Lookup for a single GA Property [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: acknowledgeUserDataCollection, create, delete, getDataRetentionSettings, list, patch, runAccessReport, updateDataRetentionSettings.
Inputs: name (required), query, params, dry_run, +1 more. Returns: name, parent, account, timeZone, +9 more
analyticsadmin.properties.getDataRetentionSettingsB
Returns the singleton data retention settings for this property [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: acknowledgeUserDataCollection, create, delete, get, list, patch, runAccessReport, updateDataRetentionSettings.
Inputs: name (required), query, params, dry_run, +1 more. Returns: name, userDataRetention, eventDataRetention, resetUserDataOnNewActivity
analyticsadmin.properties.googleAdsLinks.createA
Creates a GoogleAdsLink [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaGoogleAdsLink object accepting adsPersonalizationEnabled, canManageClients, createTime, creatorEmailAddress, customerId, name, updateTime; pass it via params or whole via body_file Siblings over the same resource: delete, list, patch.
Inputs: parent (required), query, params, dry_run, +2 more. Returns: name, createTime, customerId, updateTime, +3 more
analyticsadmin.properties.googleAdsLinks.deleteA
Deletes a GoogleAdsLink on a property [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, list, patch.
Inputs: name (required), query, params, dry_run, +1 more. Returns: object
analyticsadmin.properties.googleAdsLinks.listA
Lists GoogleAdsLinks on a property [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, patch.
Inputs: parent (required), query, params, dry_run, +3 more. Returns: nextPageToken, googleAdsLinks
analyticsadmin.properties.googleAdsLinks.patchA
Updates a GoogleAdsLink on a property [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaGoogleAdsLink object accepting adsPersonalizationEnabled, canManageClients, createTime, creatorEmailAddress, customerId, name, updateTime; pass it via params or whole via body_file Siblings over the same resource: create, delete, list.
Inputs: name (required), query, params, dry_run, +3 more. Returns: name, createTime, customerId, updateTime, +3 more
analyticsadmin.properties.keyEvents.createA
Creates a Key Event [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaKeyEvent object accepting countingMethod, createTime, custom, defaultValue, deletable, eventName, name; pass it via params or whole via body_file Siblings over the same resource: delete, get, list, patch.
Inputs: parent (required), query, params, dry_run, +2 more. Returns: name, custom, deletable, eventName, +3 more
analyticsadmin.properties.keyEvents.deleteA
Deletes a Key Event [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get, list, patch.
Inputs: name (required), query, params, dry_run, +1 more. Returns: object
analyticsadmin.properties.keyEvents.getB
Retrieves a single Key Event [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, list, patch.
Inputs: name (required), query, params, dry_run, +1 more. Returns: name, custom, deletable, eventName, +3 more
analyticsadmin.properties.keyEvents.listB
Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, patch.
Inputs: parent (required), query, params, dry_run, +3 more. Returns: keyEvents, nextPageToken
analyticsadmin.properties.keyEvents.patchA
Updates a Key Event [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaKeyEvent object accepting countingMethod, createTime, custom, defaultValue, deletable, eventName, name; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list.
Inputs: name (required), query, params, dry_run, +3 more. Returns: name, custom, deletable, eventName, +3 more
analyticsadmin.properties.listA
Returns child Properties under the specified parent Account. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: acknowledgeUserDataCollection, create, delete, get, getDataRetentionSettings, patch, runAccessReport, updateDataRetentionSettings.
Inputs: query, filter, params, dry_run, +4 more. Returns: properties, nextPageToken
analyticsadmin.properties.patchA
Updates a property [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaProperty object accepting account, createTime, currencyCode, deleteTime, displayName, expireTime, industryCategory, name and 5 more fields; pass it via params or whole via body_file Siblings over the same resource: acknowledgeUserDataCollection, create, delete, get, getDataRetentionSettings, list, runAccessReport, updateDataRetentionSettings.
Inputs: name (required), query, params, dry_run, +3 more. Returns: name, parent, account, timeZone, +9 more
analyticsadmin.properties.runAccessReportB
Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analyti [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaRunAccessReportRequest object accepting dateRanges, dimensionFilter, dimensions, expandGroups, includeAllUsers, limit, metricFilter, metrics and 4 more fields; pass it via params or whole via body_file Siblings over the same resource: acknowledgeUserDataCollection, create, delete, get, getDataRetentionSettings, list, patch, updateDataRetentionSettings.
Inputs: entity (required), query, params, dry_run, +2 more. Returns: rows, quota, rowCount, metricHeaders, +1 more
analyticsadmin.properties.updateDataRetentionSettingsB
Updates the singleton data retention settings for this property [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaDataRetentionSettings object accepting eventDataRetention, name, resetUserDataOnNewActivity, userDataRetention; pass it via params or whole via body_file Siblings over the same resource: acknowledgeUserDataCollection, create, delete, get, getDataRetentionSettings, list, patch, runAccessReport.
Inputs: name (required), query, params, dry_run, +3 more. Returns: name, userDataRetention, eventDataRetention, resetUserDataOnNewActivity
analyticsdata.properties.audienceExports.createA
Creates an audience export for later retrieval. This method quickly returns the audience export's resource name and initiates a long running asynchronous request to form an audience export. To export the users in an audience export, first create the audience export through this method and then send the audience resource name to the QueryAudienceExport method. See Creating an Audience Export for an introduction to Audience Exports with examples. An audience export is a snapshot of the users currently i [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON AudienceExport object accepting audience, audienceDisplayName, beginCreatingTime, creationQuotaTokensCharged, dimensions, errorMessage, name, percentageCompleted and 2 more fields; pass it via params or whole via body_file Siblings over the same resource: get, list, query.
Inputs: parent (required), query, params, dry_run, +2 more. Returns: done, name, error, metadata, +1 more
analyticsdata.properties.audienceExports.getB
Gets configuration metadata about a specific audience export. This method can be used to understand an audience export after it has been created. See Creating an Audience Export for an introduction to Audience Exports with examples. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https: [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, list, query.
Inputs: name (required), query, params, dry_run, +1 more. Returns: name, state, audience, rowCount, +6 more
analyticsdata.properties.audienceExports.listA
Lists all audience exports for a property. This method can be used for you to find and reuse existing audience exports rather than creating unnecessary new audience exports. The same audience can have multiple audience exports that represent the export of users that were in an audience on different days. See Creating an Audience Export for an introduction to Audience Exports with examples. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance me [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get, query.
Inputs: parent (required), query, params, dry_run, +3 more. Returns: nextPageToken, audienceExports
analyticsdata.properties.audienceExports.queryB
Retrieves an audience export of users. After creating an audience, the users are not immediately available for exporting. First, a request to CreateAudienceExport is necessary to create an audience export of users, and then second, this method is used to retrieve the users in the audience export. See Creating an Audience Export for an introduction to Audience Exports with examples. Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON QueryAudienceExportRequest object accepting limit, offset; pass it via params or whole via body_file Siblings over the same resource: create, get, list.
Inputs: name (required), query, params, dry_run, +2 more. Returns: rowCount, audienceRows, audienceExport
analyticsdata.properties.batchRunPivotReportsA
Returns multiple pivot reports in a batch. All reports must be for the same Google Analytics property [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON BatchRunPivotReportsRequest object accepting requests; pass it via params or whole via body_file Siblings over the same resource: batchRunReports, checkCompatibility, getMetadata, runPivotReport, runRealtimeReport, runReport.
Inputs: property (required), query, params, dry_run, +2 more. Returns: kind, pivotReports
analyticsdata.properties.batchRunReportsA
Returns multiple reports in a batch. All reports must be for the same Google Analytics property [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON BatchRunReportsRequest object accepting requests; pass it via params or whole via body_file Siblings over the same resource: batchRunPivotReports, checkCompatibility, getMetadata, runPivotReport, runRealtimeReport, runReport.
Inputs: property (required), query, params, dry_run, +2 more. Returns: kind, reports
analyticsdata.properties.checkCompatibilityA
This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility. This method fails if the request's dimensions and metrics are incompatible. In Google Analytics, reports fail if they request incompatible dimensions and/or metrics; in that case, you will need to remove dimensions and/or metrics from the incompatible report until the report is compatible. The Realtime and Core reports have different compatibility rules. This method checks compatibility for Core reports [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON CheckCompatibilityRequest object accepting compatibilityFilter, dimensionFilter, dimensions, metricFilter, metrics; pass it via params or whole via body_file Siblings over the same resource: batchRunPivotReports, batchRunReports, getMetadata, runPivotReport, runRealtimeReport, runReport.
Inputs: property (required), query, params, dry_run, +2 more. Returns: metricCompatibilities, dimensionCompatibilities
analyticsdata.properties.getMetadataA
Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics property identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name levels_unlocked is registered to a property, the Metadata response will contain customEvent:levels_unlocked. Universal metadata are dimensions and metrics applicable to any property such as country and totalUsers [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchRunPivotReports, batchRunReports, checkCompatibility, runPivotReport, runRealtimeReport, runReport.
Inputs: name (required), query, params, dry_run, +1 more. Returns: name, metrics, dimensions, comparisons
analyticsdata.properties.runPivotReportA
Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot. Multiple pivots can be specified to further dissect your data [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON RunPivotReportRequest object accepting cohortSpec, comparisons, currencyCode, dateRanges, dimensionFilter, dimensions, keepEmptyRows, metricFilter and 4 more fields; pass it via params or whole via body_file Siblings over the same resource: batchRunPivotReports, batchRunReports, checkCompatibility, getMetadata, runRealtimeReport, runReport.
Inputs: property (required), query, params, dry_run, +2 more. Returns: kind, rows, metadata, aggregates, +4 more
analyticsdata.properties.runRealtimeReportA
Returns a customized report of realtime event data for your property. Events appear in realtime reports seconds after they have been sent to the Google Analytics. Realtime reports show events and usage data for the periods of time ranging from the present moment to 30 minutes ago (up to 60 minutes for Google Analytics 360 properties). For a guide to constructing realtime requests & understanding responses, see Creating a Realtime Report [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON RunRealtimeReportRequest object accepting dimensionFilter, dimensions, limit, metricAggregations, metricFilter, metrics, minuteRanges, orderBys and 1 more fields; pass it via params or whole via body_file Siblings over the same resource: batchRunPivotReports, batchRunReports, checkCompatibility, getMetadata, runPivotReport, runReport.
Inputs: property (required), query, params, dry_run, +2 more. Returns: kind, rows, totals, maximums, +5 more
analyticsdata.properties.runReportB
Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name. For a guide to constructing requests & understanding responses, see [Creating a Report](https://developers.google.com/analytics/devguides/repor [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON RunReportRequest object accepting cohortSpec, comparisons, currencyCode, dateRanges, dimensionFilter, dimensions, keepEmptyRows, limit and 7 more fields; pass it via params or whole via body_file Siblings over the same resource: batchRunPivotReports, batchRunReports, checkCompatibility, getMetadata, runPivotReport, runRealtimeReport.
Inputs: property (required), query, params, dry_run, +2 more. Returns: kind, rows, totals, maximums, +6 more
calendar.acl.deleteA
Deletes an access control rule [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: get, insert, list, patch, update, watch.
Inputs: ruleId (required), calendarId (required), query, params, +2 more.
calendar.acl.getB
Returns an access control rule [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, insert, list, patch, update, watch.
Inputs: ruleId (required), calendarId (required), query, params, +2 more. Returns: id, etag, kind, role, +1 more
calendar.acl.insertA
Creates an access control rule [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON AclRule object accepting etag, id, kind, role, scope; pass it via params or whole via body_file Siblings over the same resource: delete, get, list, patch, update, watch.
Inputs: calendarId (required), query, params, dry_run, +3 more. Returns: id, etag, kind, role, +1 more
calendar.acl.listB
Returns the rules in the access control list for the calendar [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, get, insert, patch, update, watch.
Inputs: calendarId (required), query, params, dry_run, +5 more. Returns: etag, kind, items, nextPageToken, +1 more
calendar.acl.patchA
Updates an access control rule. This method supports patch semantics [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON AclRule object accepting etag, id, kind, role, scope; pass it via params or whole via body_file Siblings over the same resource: delete, get, insert, list, update, watch.
Inputs: ruleId (required), calendarId (required), query, params, +4 more. Returns: id, etag, kind, role, +1 more
calendar.acl.updateA
Updates an access control rule [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON AclRule object accepting etag, id, kind, role, scope; pass it via params or whole via body_file Siblings over the same resource: delete, get, insert, list, patch, watch.
Inputs: ruleId (required), calendarId (required), query, params, +4 more. Returns: id, etag, kind, role, +1 more
calendar.acl.watchA
Watch for changes to ACL resources [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Channel object accepting address, expiration, id, kind, params, payload, resourceId, resourceUri and 2 more fields; pass it via params or whole via body_file Siblings over the same resource: delete, get, insert, list, patch, update.
Inputs: calendarId (required), query, params, dry_run, +6 more. Returns: id, kind, type, token, +6 more
calendar.calendarList.deleteA
Removes a calendar from the user's calendar list [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: get, insert, list, patch, update, watch.
Inputs: calendarId (required), query, params, dry_run, +1 more.
calendar.calendarList.getB
Returns a calendar from the user's calendar list [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, insert, list, patch, update, watch.
Inputs: calendarId (required), query, params, dry_run, +1 more. Returns: id, etag, kind, hidden, +17 more
calendar.calendarList.insertA
Inserts an existing calendar into the user's calendar list [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON CalendarListEntry object accepting accessRole, autoAcceptInvitations, backgroundColor, colorId, conferenceProperties, dataOwner, defaultReminders, deleted and 13 more fields; pass it via params or whole via body_file Siblings over the same resource: delete, get, list, patch, update, watch.
Inputs: query, params, dry_run, body_file, +2 more. Returns: id, etag, kind, hidden, +17 more
calendar.calendarList.listB
Returns the calendars on the user's calendar list [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, get, insert, patch, update, watch.
Inputs: query, params, dry_run, body_file, +7 more. Returns: etag, kind, items, nextPageToken, +1 more
calendar.calendarList.patchB
Updates an existing calendar on the user's calendar list. This method supports patch semantics [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON CalendarListEntry object accepting accessRole, autoAcceptInvitations, backgroundColor, colorId, conferenceProperties, dataOwner, defaultReminders, deleted and 13 more fields; pass it via params or whole via body_file Siblings over the same resource: delete, get, insert, list, update, watch.
Inputs: calendarId (required), query, params, dry_run, +3 more. Returns: id, etag, kind, hidden, +17 more
calendar.calendarList.updateA
Updates an existing calendar on the user's calendar list [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON CalendarListEntry object accepting accessRole, autoAcceptInvitations, backgroundColor, colorId, conferenceProperties, dataOwner, defaultReminders, deleted and 13 more fields; pass it via params or whole via body_file Siblings over the same resource: delete, get, insert, list, patch, watch.
Inputs: calendarId (required), query, params, dry_run, +3 more. Returns: id, etag, kind, hidden, +17 more
calendar.calendarList.watchA
Watch for changes to CalendarList resources [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Channel object accepting address, expiration, id, kind, params, payload, resourceId, resourceUri and 2 more fields; pass it via params or whole via body_file Siblings over the same resource: delete, get, insert, list, patch, update.
Inputs: query, params, dry_run, body_file, +8 more. Returns: id, kind, type, token, +6 more
calendar.calendars.clearA
Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, get, insert, patch, transferOwnership, update.
Inputs: calendarId (required), query, params, dry_run, +1 more.
calendar.calendars.deleteA
Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: clear, get, insert, patch, transferOwnership, update.
Inputs: calendarId (required), query, params, dry_run, +1 more.
calendar.calendars.getB
Returns metadata for a calendar [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: clear, delete, insert, patch, transferOwnership, update.
Inputs: calendarId (required), query, params, dry_run, +1 more. Returns: id, etag, kind, summary, +7 more
calendar.calendars.insertA
Creates a secondary calendar. The authenticated user for the request is made the data owner of the new calendar. Note: We recommend to authenticate as the intended data owner of the calendar. You can use domain-wide delegation of authority to allow applications to act on behalf of a specific user. Don't use a service account for authentication. If you use a service account for authentication, the service account is the data owner, which can lead to unexpected behavior. For example, if a service account is the data owner, data ownership cannot be transferred [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Calendar object accepting autoAcceptInvitations, conferenceProperties, dataOwner, description, etag, id, kind, labelProperties and 3 more fields; pass it via params or whole via body_file Siblings over the same resource: clear, delete, get, patch, transferOwnership, update.
Inputs: query, params, dry_run, body_file, +1 more. Returns: id, etag, kind, summary, +7 more
calendar.calendars.patchA
Updates metadata for a calendar. This method supports patch semantics [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Calendar object accepting autoAcceptInvitations, conferenceProperties, dataOwner, description, etag, id, kind, labelProperties and 3 more fields; pass it via params or whole via body_file Siblings over the same resource: clear, delete, get, insert, transferOwnership, update.
Inputs: calendarId (required), query, params, dry_run, +2 more. Returns: id, etag, kind, summary, +7 more
calendar.calendars.transferOwnershipA
Transfers a secondary calendar between users within a Google Workspace organization. Requires user authentication with Manage Calendars administrator privilege, and one of the following authorization scopes: - https://www.googleapis.com/auth/calendar - https://www.googleapis.com/auth/calendar.calendars In the request, set useAdminAccess to true. The secondary calendar must be active to be transferred. Transferring disabled or deleted calendars isn't supported [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: clear, delete, get, insert, patch, update.
Inputs: calendarId (required), newDataOwner (required), useAdminAccess (required), query, +3 more.
calendar.calendars.updateA
Updates metadata for a calendar [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Calendar object accepting autoAcceptInvitations, conferenceProperties, dataOwner, description, etag, id, kind, labelProperties and 3 more fields; pass it via params or whole via body_file Siblings over the same resource: clear, delete, get, insert, patch, transferOwnership.
Inputs: calendarId (required), query, params, dry_run, +2 more. Returns: id, etag, kind, summary, +7 more
calendar.channels.stopA
Stop watching resources through this channel [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Channel object accepting address, expiration, id, kind, params, payload, resourceId, resourceUri and 2 more fields; pass it via params or whole via body_file
Inputs: query, params, dry_run, body_file, +1 more.
calendar.colors.getB
Returns the color definitions for calendars and events [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file
Inputs: query, params, dry_run, body_file. Returns: kind, event, updated, calendar
calendar.events.deleteA
Deletes an event [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: get, import, insert, instances, list, move, patch, quickAdd, update, watch.
Inputs: eventId (required), calendarId (required), query, params, +4 more.
calendar.events.getA
Returns an event based on its Google Calendar ID. To retrieve an event using its iCalendar ID, call the events.list method using the iCalUID parameter [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, import, insert, instances, list, move, patch, quickAdd, update, watch.
Inputs: eventId (required), calendarId (required), query, params, +5 more. Returns: id, end, etag, kind, +40 more
calendar.events.importA
Imports an event. This operation is used to add a private copy of an existing event to a calendar. Only events with an eventType of default may be imported. Deprecated behavior: If a non-default event is imported, its type will be changed to default and any event-type-specific properties it may have will be dropped [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Event object accepting anyoneCanAddSelf, attachments, attendees, attendeesOmitted, birthdayProperties, colorId, conferenceData, created and 36 more fields; pass it via params or whole via body_file Siblings over the same resource: delete, get, insert, instances, list, move, patch, quickAdd, update, watch.
Inputs: calendarId (required), query, params, dry_run, +5 more. Returns: id, end, etag, kind, +40 more
calendar.events.insertA
Creates an event [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Event object accepting anyoneCanAddSelf, attachments, attendees, attendeesOmitted, birthdayProperties, colorId, conferenceData, created and 36 more fields; pass it via params or whole via body_file Siblings over the same resource: delete, get, import, instances, list, move, patch, quickAdd, update, watch.
Inputs: calendarId (required), query, params, dry_run, +8 more. Returns: id, end, etag, kind, +40 more
calendar.events.instancesB
Returns instances of the specified recurring event [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, get, import, insert, list, move, patch, quickAdd, update, watch.
Inputs: eventId (required), calendarId (required), query, params, +11 more. Returns: etag, kind, items, summary, +7 more
calendar.events.listC
Returns events on the specified calendar [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, get, import, insert, instances, move, patch, quickAdd, update, watch.
Inputs: calendarId (required), q, query, params, +19 more. Returns: etag, kind, items, summary, +7 more
calendar.events.moveA
Moves an event to another calendar, i.e. changes an event's organizer. Note that only default events can be moved; birthday, focusTime, fromGmail, outOfOffice and workingLocation events cannot be moved [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, get, import, insert, instances, list, patch, quickAdd, update, watch.
Inputs: eventId (required), calendarId (required), destination (required), query, +5 more. Returns: id, end, etag, kind, +40 more
calendar.events.patchB
Updates an event. This method supports patch semantics [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Event object accepting anyoneCanAddSelf, attachments, attendees, attendeesOmitted, birthdayProperties, colorId, conferenceData, created and 36 more fields; pass it via params or whole via body_file Siblings over the same resource: delete, get, import, insert, instances, list, move, quickAdd, update, watch.
Inputs: eventId (required), calendarId (required), query, params, +10 more. Returns: id, end, etag, kind, +40 more
calendar.events.quickAddA
Creates an event based on a simple text string [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, get, import, insert, instances, list, move, patch, update, watch.
Inputs: text (required), calendarId (required), query, params, +4 more. Returns: id, end, etag, kind, +40 more
calendar.events.updateA
Updates an event [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Event object accepting anyoneCanAddSelf, attachments, attendees, attendeesOmitted, birthdayProperties, colorId, conferenceData, created and 36 more fields; pass it via params or whole via body_file Siblings over the same resource: delete, get, import, insert, instances, list, move, patch, quickAdd, watch.
Inputs: eventId (required), calendarId (required), query, params, +10 more. Returns: id, end, etag, kind, +40 more
calendar.events.watchA
Watch for changes to Events resources [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Channel object accepting address, expiration, id, kind, params, payload, resourceId, resourceUri and 2 more fields; pass it via params or whole via body_file Siblings over the same resource: delete, get, import, insert, instances, list, move, patch, quickAdd, update.
Inputs: calendarId (required), q, query, params, +20 more. Returns: id, kind, type, token, +6 more
calendar.freebusy.queryA
Returns free/busy information for a set of calendars [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON FreeBusyRequest object accepting calendarExpansionMax, groupExpansionMax, items, timeMax, timeMin, timeZone; pass it via params or whole via body_file
Inputs: query, params, dry_run, body_file, +1 more. Returns: kind, groups, timeMax, timeMin, +1 more
calendar.settings.getA
Returns a single user setting [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: list, watch.
Inputs: setting (required), query, params, dry_run, +1 more. Returns: id, etag, kind, value
calendar.settings.listA
Returns all user settings for the authenticated user [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: get, watch.
Inputs: query, params, dry_run, body_file, +3 more. Returns: etag, kind, items, nextPageToken, +1 more
calendar.settings.watchA
Watch for changes to Settings resources [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Channel object accepting address, expiration, id, kind, params, payload, resourceId, resourceUri and 2 more fields; pass it via params or whole via body_file Siblings over the same resource: get, list.
Inputs: query, params, dry_run, body_file, +4 more. Returns: id, kind, type, token, +6 more
chat.customEmojis.createA
Creates a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see Learn about custom emojis in Google Chat and Manage custom emoji permissions. Requires user authentication with the authorization scope: - https:// [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON CustomEmoji object accepting emojiName, name, payload, temporaryImageUri, uid; pass it via paramsor whole viabody_file` Siblings over the same resource: delete, get, list.
Inputs: query, params, dry_run, body_file, +1 more. Returns: uid, name, payload, emojiName, +1 more
chat.customEmojis.deleteA
Deletes a custom emoji. By default, users can only delete custom emoji they created. Emoji managers assigned by the administrator can delete any custom emoji in the organization. See Learn about custom emojis in Google Chat. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see Learn about custom emojis in Google Chat and [Manage custom emoj [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get, list.
Inputs: name (required), query, params, dry_run, +1 more. Returns: object
chat.customEmojis.getA
Returns details about a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see Learn about custom emojis in Google Chat and Manage custom emoji permissions. Requires user authentication with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authori [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, list.
Inputs: name (required), query, params, dry_run, +1 more. Returns: uid, name, payload, emojiName, +1 more
chat.customEmojis.listA
Lists custom emojis visible to the authenticated user. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see Learn about custom emojis in Google Chat and Manage custom emoji permissions. Requires user authentication with one of the following [authorization scopes](https://developers.google.com/workspace/chat/aut [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get.
Inputs: query, filter, params, dry_run, +3 more. Returns: customEmojis, nextPageToken
chat.media.downloadB
Downloads media. Download is supported on the URI /v1/media/{+name}?alt=media [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: upload.
Inputs: resourceName (required), query, params, dry_run, +1 more. Returns: resourceName
chat.media.uploadB
Uploads an attachment. For an example, see Upload media as a file attachment. Requires user authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.messages.create - https://www.googleapis.com/auth/chat.messages - https://www.googleapis.com/auth/chat.import (import mode spaces only) You can upload attachme [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON UploadAttachmentRequest object accepting filename; pass it via params or whole via body_file Siblings over the same resource: download.
Inputs: parent (required), query, params, dry_run, +2 more. Returns: attachmentDataRef
chat.spaces.completeImportA
Completes the import process for the specified space and makes it visible to users. Requires user authentication and domain-wide delegation with the authorization scope: - https://www.googleapis.com/auth/chat.import For more information, see Authorize Google Chat apps to import data [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON CompleteImportSpaceRequest object; pass it via params or whole via body_file Siblings over the same resource: create, delete, findDirectMessage, findGroupChats, get, list, patch, search, setup.
Inputs: name (required), query, params, dry_run, +2 more. Returns: space
chat.spaces.createB
Creates a space. Can be used to create a named space, or a group chat in Import mode. For an example, see Create a space. Supports the following types of authentication: - App authentication with administrator approval and one of the following authorization scopes: - https://www.googleapis.com/auth/chat.app.spaces.create - https://w [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Space object accepting accessSettings, adminInstalled, createTime, customer, displayName, externalUserAllowed, importMode, importModeExpireTime and 13 more fields; pass it via paramsor whole viabody_file` Siblings over the same resource: completeImport, delete, findDirectMessage, findGroupChats, get, list, patch, search, setup.
Inputs: query, params, dry_run, body_file, +2 more. Returns: name, type, customer, spaceUri, +17 more
chat.spaces.deleteA
Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see Delete a space. Supports the following types of authentication: - App authentication with administrator approval and the authorization [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: completeImport, create, findDirectMessage, findGroupChats, get, list, patch, search, setup.
Inputs: name (required), query, params, dry_run, +2 more. Returns: object
chat.spaces.findDirectMessageA
Returns the existing direct message with the specified user. If no direct message space is found, returns a 404 NOT_FOUND error. For an example, see Find a direct message. With app authentication, returns the direct message space between the specified user and the calling Chat app. With user authentication, returns the direct message space between the specified user and the authentica [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: completeImport, create, delete, findGroupChats, get, list, patch, search, setup.
Inputs: name, query, params, dry_run, +1 more. Returns: name, type, customer, spaceUri, +17 more
chat.spaces.findGroupChatsA
Returns all spaces with spaceType == GROUP_CHAT, whose human memberships contain exactly the calling user, and the users specified in FindGroupChatsRequest.users. Only members that have joined the conversation are supported. For an example, see Find group chats. If the calling user blocks, or is blocked by, some users, and no spaces with the entire specified set of users are found, this method returns spaces that don't include the blocked or blocking users. The specified set of users must contain only human (non-app) membersh [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: completeImport, create, delete, findDirectMessage, get, list, patch, search, setup.
Inputs: query, users, params, dry_run, +4 more. Returns: spaces, nextPageToken
chat.spaces.getA
Returns details about a space. For an example, see Get details about a space. Supports the following types of authentication: - App authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.bot - https://www.googleapis.com/auth/chat.app.spaces with administrator approval - [User authentication [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: completeImport, create, delete, findDirectMessage, findGroupChats, list, patch, search, setup.
Inputs: name (required), query, params, dry_run, +2 more. Returns: name, type, customer, spaceUri, +17 more
chat.spaces.listA
Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see List spaces. Supports the following types of authentication: - App authentication with the authorization scope: - https://www.googleapis.com/auth/chat.bot - User authentication wi [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: completeImport, create, delete, findDirectMessage, findGroupChats, get, patch, search, setup.
Inputs: query, filter, params, dry_run, +3 more. Returns: spaces, nextPageToken
chat.spaces.members.createA
Creates a membership for the calling Chat app, a user, or a Google Group. Creating memberships for other Chat apps isn't supported. When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Supports the following types of authentication: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Membership object accepting affiliation, createTime, deleteTime, groupMember, member, name, role, state; pass it via params or whole via body_file Siblings over the same resource: delete, get, list, patch.
Inputs: parent (required), query, params, dry_run, +3 more. Returns: name, role, state, member, +4 more
chat.spaces.members.deleteA
Deletes a membership. For an example, see Remove a user or a Google Chat app from a space. Supports the following types of authentication: - App authentication with administrator approval and the authorization scope: - https://www.googleapis.com/auth/chat.app.memberships - [User authentication](https://developers.google.com/workspace/ [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get, list, patch.
Inputs: name (required), query, params, dry_run, +2 more. Returns: name, role, state, member, +4 more
chat.spaces.members.getB
Returns details about a membership. For an example, see Get details about a user's or Google Chat app's membership. Supports the following types of authentication: - App authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.bot - https://www.googleapis.com/auth/chat.app.memberships (requires [administrator approval](https://support.goo [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, list, patch.
Inputs: name (required), query, params, dry_run, +2 more. Returns: name, role, state, member, +4 more
chat.spaces.members.listA
Lists memberships in a space. For an example, see List users and Google Chat apps in a space. Listing memberships with app authentication lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with User authentication lists memberships in spaces that the authenticated user has access to. Supports [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, patch.
Inputs: parent (required), query, filter, params, +7 more. Returns: memberships, nextPageToken
chat.spaces.members.patchA
Updates a membership. For an example, see Update a user's membership in a space. Supports the following types of authentication: - App authentication with administrator approval and the authorization scope: - https://www.googleapis.com/auth/chat.app.memberships (only in spaces the app created) - [User authentication](https://developer [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Membership object accepting affiliation, createTime, deleteTime, groupMember, member, name, role, state; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list.
Inputs: name (required), query, params, dry_run, +4 more. Returns: name, role, state, member, +4 more
chat.spaces.messagePins.createA
Creates a message pin. Requires user authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.spaces.pins - https://www.googleapis.com/auth/chat.spaces [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON MessagePin object accepting message, name; pass it via params or whole via body_file Siblings over the same resource: delete, list.
Inputs: parent (required), query, params, dry_run, +2 more. Returns: name, message
chat.spaces.messagePins.deleteA
Deletes a message pin. Requires user authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.spaces.pins - https://www.googleapis.com/auth/chat.spaces [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, list.
Inputs: name (required), query, params, dry_run, +1 more. Returns: object
chat.spaces.messagePins.listA
Lists message pins in a space. Users can pin important messages in spaces for easy access. For more information, see Pin or unpin a conversation in Google Chat. Requires user authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.spaces.pins.readonly - https://www.googleapis.com/auth/chat.spaces.pins - https://www.googleapis.co [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the paramsmap), or read whole frombody_file` Siblings over the same resource: create, delete.
Inputs: parent (required), query, params, dry_run, +3 more. Returns: messagePins, nextPageToken
chat.spaces.messages.attachments.getA
Gets the metadata of a message attachment. The attachment data is fetched using the media API. For an example, see Get metadata about a message attachment. Requires app authentication with the authorization scope: - https://www.googleapis.com/auth/chat.bot [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file
Inputs: name (required), query, params, dry_run, +1 more. Returns: name, source, contentName, contentType, +4 more
chat.spaces.messages.createA
Creates a message in a Google Chat space. For an example, see Send a message. Supports the following types of authentication: - App authentication with the authorization scope: - https://www.googleapis.com/auth/chat.bot - User authentication with one of the following authorization scopes: - https://w [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Message object accepting accessoryWidgets, actionResponse, annotations, argumentText, attachedGifs, attachment, cards, cardsV2 and 20 more fields; pass it via paramsor whole viabody_file` Siblings over the same resource: delete, get, list, patch, replaceCards, search, update.
Inputs: parent (required), query, params, dry_run, +7 more. Returns: name, text, cards, space, +24 more
chat.spaces.messages.deleteB
Deletes a message. For an example, see Delete a message. Supports the following types of authentication: - App authentication with the authorization scope: - https://www.googleapis.com/auth/chat.bot - User authentication with one of the following authorization scopes: - https://www.googleapis.com/aut [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the paramsmap), or read whole frombody_file` Siblings over the same resource: create, get, list, patch, replaceCards, search, update.
Inputs: name (required), force, query, params, +2 more. Returns: object
chat.spaces.messages.getB
Returns details about a message. For an example, see Get details about a message. Supports the following types of authentication: - App authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.bot: When using this authorization scope, this method returns details about a message the Chat app has access to, like direct messages and [slash co [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, list, patch, replaceCards, search, update.
Inputs: name (required), query, params, dry_run, +2 more. Returns: name, text, cards, space, +24 more
chat.spaces.messages.listB
Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. System messages, like those announcing new space members, aren't included. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, {}. For an example, see List messages. Supports the following types of authentication: - [App authentic [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, patch, replaceCards, search, update.
Inputs: parent (required), query, filter, params, +7 more. Returns: messages, nextPageToken
chat.spaces.messages.patchA
Updates a message. There's a difference between the patch and update methods. The patch method uses a patch request while the update method uses a put request. We recommend using the patch method. For an example, see Update a message. Supports the following types of authentication: - App authentication with the authorization scope: - https://www.googleapis.com/auth/ch [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Message object accepting accessoryWidgets, actionResponse, annotations, argumentText, attachedGifs, attachment, cards, cardsV2 and 20 more fields; pass it via paramsor whole viabody_file` Siblings over the same resource: create, delete, get, list, replaceCards, search, update.
Inputs: name (required), query, params, dry_run, +4 more. Returns: name, text, cards, space, +24 more
chat.spaces.messages.reactions.createA
Creates a reaction and adds it to a message. For an example, see Add a reaction to a message. Requires user authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.messages.reactions.create - https://www.googleapis.com/auth/chat.messages.reactions - https://www.googleapis.com/auth/chat.messages - https://www.goog [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Reaction object accepting emoji, name, user; pass it via paramsor whole viabody_file` Siblings over the same resource: delete, list.
Inputs: parent (required), query, params, dry_run, +2 more. Returns: name, user, emoji
chat.spaces.messages.reactions.deleteA
Deletes a reaction to a message. For an example, see Delete a reaction. Requires user authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.messages.reactions - https://www.googleapis.com/auth/chat.messages - https://www.googleapis.com/auth/chat.import (import mode spaces only) [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, list.
Inputs: name (required), query, params, dry_run, +1 more. Returns: object
chat.spaces.messages.reactions.listA
Lists reactions to a message. For an example, see List reactions for a message. Requires user authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.messages.reactions.readonly - https://www.googleapis.com/auth/chat.messages.reactions - https://www.googleapis.com/auth/chat.messages.readonly - https://www.googleapi [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the paramsmap), or read whole frombody_file` Siblings over the same resource: create, delete.
Inputs: parent (required), query, filter, params, +4 more. Returns: reactions, nextPageToken
chat.spaces.messages.replaceCardsA
Replaces the cards included in a message. A Chat app can only replace cards on a human-created message if the message already contains cards, and the cards were created by the app. If the app replaces the cards with an empty list, the cards are removed. After removing the cards, the app cannot add cards back to the message. Requires app authentication with the authorization scope: - https://www.googleapis.com/auth/chat.bot [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON ReplaceMessageCardsRequest object accepting cardsV2; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list, patch, search, update.
Inputs: name (required), query, params, dry_run, +2 more. Returns: object
chat.spaces.messages.searchA
Searches for messages in Google Chat that the calling user has access to. Returns a list of messages matching the search criteria. To search across all spaces the user has access to, set parent to spaces/-. Using any other value for parent results in an INVALID_ARGUMENT error. The returned messages have their name field populated with the full resource name, which includes the specific space in which the message resides. This API doesn't return all message types. The types of messages listed below aren't included in the response. Use ListMessages to list all messages. - Private Mes [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON SearchMessagesRequest object accepting filter, markupSyntax, orderBy, pageSize, pageToken, view; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list, patch, replaceCards, update.
Inputs: parent (required), query, params, dry_run, +2 more. Returns: results, nextPageToken
chat.spaces.messages.updateA
Updates a message. There's a difference between the patch and update methods. The patch method uses a patch request while the update method uses a put request. We recommend using the patch method. For an example, see Update a message. Supports the following types of authentication: - App authentication with the authorization scope: - https://www.googleapis.com/auth/ch [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Message object accepting accessoryWidgets, actionResponse, annotations, argumentText, attachedGifs, attachment, cards, cardsV2 and 20 more fields; pass it via paramsor whole viabody_file` Siblings over the same resource: create, delete, get, list, patch, replaceCards, search.
Inputs: name (required), query, params, dry_run, +4 more. Returns: name, text, cards, space, +24 more
chat.spaces.patchA
Updates a space. For an example, see Update a space. If you're updating the displayName field and receive the error message ALREADY_EXISTS, try a different display name.. An existing space within the Google Workspace organization might already use this display name. Supports the following types of authentication: - App authentication with [administrator approval](https://support.g [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Space object accepting accessSettings, adminInstalled, createTime, customer, displayName, externalUserAllowed, importMode, importModeExpireTime and 13 more fields; pass it via params or whole via body_file Siblings over the same resource: completeImport, create, delete, findDirectMessage, findGroupChats, get, list, search, setup.
Inputs: name (required), query, params, dry_run, +4 more. Returns: name, type, customer, spaceUri, +17 more
chat.spaces.searchB
Returns a list of spaces in a Google Workspace organization. For an example, see Search for and manage spaces. When use_admin_access is set to false, the results are limited to spaces where the calling user is a joined member. To search with administrator privileges, set use_admin_access to true. Supports the following types of authentication: - User authentication with [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: completeImport, create, delete, findDirectMessage, findGroupChats, get, list, patch, setup.
Inputs: query, params, dry_run, orderBy, +4 more. Returns: spaces, results, totalSize, nextPageToken
chat.spaces.setupA
Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see Set up a space with initial members. To specify the human members to add, add memberships with the appropriate membership.member.name. To add a human user, use users/{user}, where {user} can be the email address for the user. For users in the same Workspace organization {user} can also be the id for the person from the People API, or the id fo [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON SetUpSpaceRequest object accepting memberships, requestId, space; pass it via params or whole via body_file Siblings over the same resource: completeImport, create, delete, findDirectMessage, findGroupChats, get, list, patch, search.
Inputs: query, params, dry_run, body_file, +1 more. Returns: name, type, customer, spaceUri, +17 more
chat.spaces.spaceEvents.getB
Returns an event from a Google Chat space. The event payload contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated Message resource in the event payload. Note: The permissionSettings field is not returned in the Space object of the Space event data for this request. Supports the following types of [authentication](https://developers.google.c [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: list.
Inputs: name (required), query, params, dry_run, +1 more. Returns: name, eventTime, eventType, spaceUpdatedEventData, +17 more
chat.spaces.spaceEvents.listB
Lists events from a Google Chat space. For each event, the payload contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns Membership resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty Membership resource. Supports the following types of [authentication](https://developers.google.com/workspace/chat/auth [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: get.
Inputs: parent (required), query, filter, params, +4 more. Returns: spaceEvents, nextPageToken
chat.users.availability.getA
Returns availability information for a human user in Google Chat. For example, this can be used to check if a user is online or away, or to retrieve their custom status message. This method only retrieves the authenticated user's availability. Requires user authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.users.availability.readonly - https://www.googleapis.com/auth/chat.us [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the paramsmap), or read whole frombody_file` Siblings over the same resource: markAsActive, markAsAway, markAsDoNotDisturb, patch.
Inputs: name (required), query, params, dry_run, +1 more. Returns: name, state, customStatus, doNotDisturbMetadata
chat.users.availability.markAsActiveA
Marks user as ACTIVE in Google Chat. Sets the user's availability state to ACTIVE. The ACTIVE state lasts until the specified expiration, at which point the user's state becomes AWAY. Note that if the user is actively using Chat, the ACTIVE state duration may extend beyond the provided expiration. This method only updates the authenticated user's availability. Requires user authentication with authorization scope: - h [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON MarkAsActiveRequest object accepting expireTime, ttl; pass it via paramsor whole viabody_file` Siblings over the same resource: get, markAsAway, markAsDoNotDisturb, patch.
Inputs: name (required), query, params, dry_run, +2 more. Returns: name, state, customStatus, doNotDisturbMetadata
chat.users.availability.markAsAwayA
Marks user as AWAY in Google Chat. Sets the user's state to away and is not affected by the user's activity. This method only updates the authenticated user's availability. Requires user authentication with authorization scope: - https://www.googleapis.com/auth/chat.users.availability [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON MarkAsAwayRequest object; pass it via params or whole via body_file Siblings over the same resource: get, markAsActive, markAsDoNotDisturb, patch.
Inputs: name (required), query, params, dry_run, +2 more. Returns: name, state, customStatus, doNotDisturbMetadata
chat.users.availability.markAsDoNotDisturbA
Marks user as DO_NOT_DISTURB in Google Chat. Sets a user's availability state to DO_NOT_DISTURB until a specified expiration time. When in DO_NOT_DISTURB, users typically won't receive notifications. This method only updates the authenticated user's availability. Requires user authentication with authorization scope: - https://www.googleapis.com/auth/chat.users.availability [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON MarkAsDoNotDisturbRequest object accepting expireTime, ttl; pass it via params or whole via body_file Siblings over the same resource: get, markAsActive, markAsAway, patch.
Inputs: name (required), query, params, dry_run, +2 more. Returns: name, state, customStatus, doNotDisturbMetadata
chat.users.availability.patchA
Updates availability information for a human user. Only the custom_status field can be updated through this method. This method only updates the authenticated user's availability. Requires user authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.users.availability [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Availability object accepting customStatus, doNotDisturbMetadata, name, state; pass it via params or whole via body_file Siblings over the same resource: get, markAsActive, markAsAway, markAsDoNotDisturb.
Inputs: name (required), query, params, dry_run, +3 more. Returns: name, state, customStatus, doNotDisturbMetadata
chat.users.sections.createA
Creates a section in Google Chat. Sections help users group conversations and customize the list of spaces displayed in Chat navigation panel. Only sections of type CUSTOM_SECTION can be created. For details, see Create and organize sections in Google Chat. Requires user authentication with the authorization scope: - https://www.googleapis.com/auth/chat.users.sections [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleChatV1Section object accepting displayName, name, sortOrder, type; pass it via params or whole via body_file Siblings over the same resource: delete, list, patch, position.
Inputs: parent (required), query, params, dry_run, +2 more. Returns: name, type, sortOrder, displayName
chat.users.sections.deleteA
Deletes a section of type CUSTOM_SECTION. If the section contains items, such as spaces, the items are moved to Google Chat's default sections and are not deleted. For details, see Create and organize sections in Google Chat. Requires user authentication with the authorization scope: - https://www.googleapis.com/auth/chat.users.sections [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, list, patch, position.
Inputs: name (required), query, params, dry_run, +1 more. Returns: object
chat.users.sections.items.listB
Lists items in a section. Only spaces can be section items. For details, see Create and organize sections in Google Chat. Requires user authentication with the authorization scope: - https://www.googleapis.com/auth/chat.users.sections - https://www.googleapis.com/auth/chat.users.sections.readonly [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: move.
Inputs: parent (required), query, filter, params, +4 more. Returns: sectionItems, nextPageToken
chat.users.sections.items.moveA
Moves an item from one section to another. For example, if a section contains spaces, this method can be used to move a space to a different section. For details, see Create and organize sections in Google Chat. Requires user authentication with the authorization scope: - https://www.googleapis.com/auth/chat.users.sections [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON MoveSectionItemRequest object accepting targetSection; pass it via params or whole via body_file Siblings over the same resource: list.
Inputs: name (required), query, params, dry_run, +2 more. Returns: sectionItem
chat.users.sections.listA
Lists sections available to the Chat user. Sections help users group their conversations and customize the list of spaces displayed in Chat navigation panel. For details, see Create and organize sections in Google Chat. Requires user authentication with the authorization scope: - https://www.googleapis.com/auth/chat.users.sections - https://www.googleapis.com/auth/chat.users [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the paramsmap), or read whole frombody_file` Siblings over the same resource: create, delete, patch, position.
Inputs: parent (required), query, params, dry_run, +3 more. Returns: sections, nextPageToken
chat.users.sections.patchA
Updates a section. Only sections of type CUSTOM_SECTION can be updated. For details, see Create and organize sections in Google Chat. Requires user authentication with the authorization scope: - https://www.googleapis.com/auth/chat.users.sections [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleChatV1Section object accepting displayName, name, sortOrder, type; pass it via params or whole via body_file Siblings over the same resource: create, delete, list, position.
Inputs: name (required), query, params, dry_run, +3 more. Returns: name, type, sortOrder, displayName
chat.users.sections.positionA
Changes the sort order of a section. For details, see Create and organize sections in Google Chat. Requires user authentication with the authorization scope: - https://www.googleapis.com/auth/chat.users.sections [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON PositionSectionRequest object accepting relativePosition, sortOrder; pass it via params or whole via body_file Siblings over the same resource: create, delete, list, patch.
Inputs: name (required), query, params, dry_run, +2 more. Returns: section
chat.users.spaces.getSpaceReadStateA
Returns details about a user's read state within a space, used to identify read and unread messages. For an example, see Get details about a user's space read state. Requires user authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.users.readstate.readonly - https://www.googleapis.com/auth/chat.users.readstat [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the paramsmap), or read whole frombody_file` Siblings over the same resource: updateSpaceReadState.
Inputs: name (required), query, params, dry_run, +1 more. Returns: name, lastReadTime
chat.users.spaces.spaceNotificationSetting.getA
Gets the space notification setting. For an example, see Get the caller's space notification setting. Requires user authentication with the authorization scope: - https://www.googleapis.com/auth/chat.users.spacesettings [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: patch.
Inputs: name (required), query, params, dry_run, +1 more. Returns: name, muteSetting, notificationSetting
chat.users.spaces.spaceNotificationSetting.patchA
Updates the space notification setting. For an example, see Update the caller's space notification setting. Requires user authentication with the authorization scope: - https://www.googleapis.com/auth/chat.users.spacesettings [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON SpaceNotificationSetting object accepting muteSetting, name, notificationSetting; pass it via params or whole via body_file Siblings over the same resource: get.
Inputs: name (required), query, params, dry_run, +3 more. Returns: name, muteSetting, notificationSetting
chat.users.spaces.threads.getThreadReadStateA
Returns details about a user's read state within a thread, used to identify read and unread messages. For an example, see Get details about a user's thread read state. Requires user authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.users.readstate.readonly - https://www.googleapis.com/auth/chat.users.reads [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the paramsmap), or read whole frombody_file`
Inputs: name (required), query, params, dry_run, +1 more. Returns: name, lastReadTime
chat.users.spaces.updateSpaceReadStateA
Updates a user's read state within a space, used to identify read and unread messages. For an example, see Update a user's space read state. Requires user authentication with the authorization scope: - https://www.googleapis.com/auth/chat.users.readstate [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON SpaceReadState object accepting lastReadTime, name; pass it via params or whole via body_file Siblings over the same resource: getSpaceReadState.
Inputs: name (required), query, params, dry_run, +3 more. Returns: name, lastReadTime
docs.documents.batchUpdateA
Applies one or more updates to the document. Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies, the reply to the third request, and another empt [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON BatchUpdateDocumentRequest object accepting requests, writeControl; pass it via params or whole via body_file Siblings over the same resource: create, get.
Inputs: documentId (required), query, params, dry_run, +2 more. Returns: replies, documentId, writeControl, commentUpdateState, +1 more
docs.documents.createA
Creates a blank document using the title given in the request. Other fields in the request, including any provided content, are ignored. Returns the created document [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Document object accepting body, comments, commentsViewMode, documentId, documentStyle, footers, footnotes, headers and 12 more fields; pass it via params or whole via body_file Siblings over the same resource: batchUpdate, get.
Inputs: query, params, dry_run, body_file, +1 more. Returns: body, tabs, lists, title, +16 more
docs.documents.getB
Gets the latest version of the specified document [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchUpdate, create.
Inputs: documentId (required), query, params, dry_run, +4 more. Returns: body, tabs, lists, title, +16 more
drive.about.getC
Gets information about the user, the user's Drive, and system capabilities. For more information, see Return user info. Required: The fields parameter must be set. To return the exact fields you need, see Return specific fields [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file
Inputs: query, params, dry_run, body_file. Returns: kind, user, driveThemes, appInstalled, +9 more
drive.accessproposals.getA
Retrieves an access proposal by ID. For more information, see Manage pending access proposals [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: list, resolve.
Inputs: fileId (required), proposalId (required), query, params, +2 more. Returns: fileId, createTime, proposalId, rolesAndViews, +3 more
drive.accessproposals.listA
List the access proposals on a file. For more information, see Manage pending access proposals. Note: Only approvers are able to list access proposals on a file. If the user isn't an approver, a 403 error is returned [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: get, resolve.
Inputs: fileId (required), query, params, dry_run, +3 more. Returns: nextPageToken, accessProposals
drive.accessproposals.resolveA
Approves or denies an access proposal. For more information, see Manage pending access proposals [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON ResolveAccessProposalRequest object accepting action, role, sendNotification, view; pass it via params or whole via body_file Siblings over the same resource: get, list.
Inputs: fileId (required), proposalId (required), query, params, +3 more.
drive.approvals.approveA
Approves an approval. For more information, see Manage approvals. This is used to update the ReviewerResponse of the requesting user with a Response of APPROVED. If this is the last required reviewer response, this also completes the approval and sets the approval Status to APPROVED [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON ApproveApprovalRequest object accepting message; pass it via params or whole via body_file Siblings over the same resource: cancel, comment, decline, get, list, reassign, start.
Inputs: fileId (required), approvalId (required), query, params, +3 more. Returns: kind, status, dueTime, initiator, +7 more
drive.approvals.cancelA
Cancels an approval. For more information, see Manage approvals. Updates the approval Status to CANCELLED. This can be called by any user with the writer permission on the file while the approval Status is IN_PROGRESS [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON CancelApprovalRequest object accepting message; pass it via params or whole via body_file Siblings over the same resource: approve, comment, decline, get, list, reassign, start.
Inputs: fileId (required), approvalId (required), query, params, +3 more. Returns: kind, status, dueTime, initiator, +7 more
drive.approvals.commentA
Comments on an approval. For more information, see Manage approvals. This sends a notification to both the initiator and the reviewers. Additionally, a message is also added to the approval activity log [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON CommentApprovalRequest object accepting message; pass it via params or whole via body_file Siblings over the same resource: approve, cancel, decline, get, list, reassign, start.
Inputs: fileId (required), approvalId (required), query, params, +3 more. Returns: kind, status, dueTime, initiator, +7 more
drive.approvals.declineA
Declines an approval. For more information, see Manage approvals. This is used to update the ReviewerResponse of the requesting user with a Response of DECLINED. This also completes the approval and sets the approval Status to DECLINED [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON DeclineApprovalRequest object accepting message; pass it via params or whole via body_file Siblings over the same resource: approve, cancel, comment, get, list, reassign, start.
Inputs: fileId (required), approvalId (required), query, params, +3 more. Returns: kind, status, dueTime, initiator, +7 more
drive.approvals.getB
Gets an approval by ID. For more information, see Manage approvals [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: approve, cancel, comment, decline, list, reassign, start.
Inputs: fileId (required), approvalId (required), query, params, +2 more. Returns: kind, status, dueTime, initiator, +7 more
drive.approvals.listA
Lists the approvals on a file. For more information, see Manage approvals. By default, this method returns a minimal response that may not include the items array. To retrieve approval details, you must explicitly specify the fields you want using the fields query parameter. To return the exact fields you need, see Return specific fields [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: approve, cancel, comment, decline, get, reassign, start.
Inputs: fileId (required), query, params, dry_run, +3 more. Returns: kind, items, nextPageToken
drive.approvals.reassignA
Reassigns the reviewers on an approval. For more information, see Manage approvals. Adds or replaces reviewers in the ReviewerResponse of the approval. This can be called by any user with the writer permission on the file while the approval Status is IN_PROGRESS and the Response for the reviewer being reassigned is NO_RESPONSE. A user with the reader permission can only reassign an approval that's assigned to themselves. Removing a reviewer isn't allowed [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON ReassignApprovalRequest object accepting addReviewers, message, replaceReviewers; pass it via params or whole via body_file Siblings over the same resource: approve, cancel, comment, decline, get, list, start.
Inputs: fileId (required), approvalId (required), query, params, +3 more. Returns: kind, status, dueTime, initiator, +7 more
drive.approvals.startA
Starts an approval on a file. For more information, see Manage approvals [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON StartApprovalRequest object accepting dueTime, fileContentChangeBehavior, lockFile, message, reviewerEmails; pass it via params or whole via body_file Siblings over the same resource: approve, cancel, comment, decline, get, list, reassign.
Inputs: fileId (required), query, params, dry_run, +2 more. Returns: kind, status, dueTime, initiator, +7 more
drive.apps.getB
Gets a specific app. For more information, see Return user info [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: list.
Inputs: appId (required), query, params, dry_run, +1 more. Returns: id, kind, name, icons, +20 more
drive.apps.listC
Lists a user's installed apps. For more information, see Return user info [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: get.
Inputs: query, params, dry_run, body_file, +3 more. Returns: kind, items, selfLink, defaultAppIds
drive.changes.getStartPageTokenB
Gets the starting pageToken for listing future changes. For more information, see Retrieve changes [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: list, watch.
Inputs: query, params, driveId, dry_run, +4 more. Returns: kind, startPageToken
drive.changes.listB
Lists the changes for a user or shared drive. For more information, see Retrieve changes [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: getStartPageToken, watch.
Inputs: pageToken (required), query, params, spaces, +14 more. Returns: kind, changes, nextPageToken, newStartPageToken
drive.changes.watchA
Subscribes to changes for a user. For more information, see Notifications for resource changes [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Channel object accepting address, expiration, id, kind, params, payload, resourceId, resourceUri and 2 more fields; pass it via params or whole via body_file Siblings over the same resource: getStartPageToken, list.
Inputs: pageToken (required), query, params, spaces, +15 more. Returns: id, kind, type, token, +6 more
drive.channels.stopB
Stops watching resources through this channel. For more information, see Notifications for resource changes [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Channel object accepting address, expiration, id, kind, params, payload, resourceId, resourceUri and 2 more fields; pass it via params or whole via body_file
Inputs: query, params, dry_run, body_file, +1 more.
drive.comments.createA
Creates a comment on a file. For more information, see Manage comments and replies. Required: The fields parameter must be set. To return the exact fields you need, see Return specific fields [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Comment object accepting anchor, assigneeEmailAddress, author, content, createdTime, deleted, htmlContent, id and 6 more fields; pass it via params or whole via body_file Siblings over the same resource: delete, get, list, update.
Inputs: fileId (required), query, params, dry_run, +2 more. Returns: id, kind, anchor, author, +10 more
drive.comments.deleteA
Deletes a comment. For more information, see Manage comments and replies [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get, list, update.
Inputs: fileId (required), commentId (required), query, params, +2 more.
drive.comments.getA
Gets a comment by ID. For more information, see Manage comments and replies. Required: The fields parameter must be set. To return the exact fields you need, see Return specific fields [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, list, update.
Inputs: fileId (required), commentId (required), query, params, +3 more. Returns: id, kind, anchor, author, +10 more
drive.comments.listC
Lists a file's comments. For more information, see Manage comments and replies. Required: The fields parameter must be set. To return the exact fields you need, see Return specific fields [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, update.
Inputs: fileId (required), query, params, dry_run, +5 more. Returns: kind, comments, nextPageToken
drive.comments.updateA
Updates a comment with patch semantics. For more information, see Manage comments and replies. Required: The fields parameter must be set. To return the exact fields you need, see Return specific fields [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Comment object accepting anchor, assigneeEmailAddress, author, content, createdTime, deleted, htmlContent, id and 6 more fields; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list.
Inputs: fileId (required), commentId (required), query, params, +3 more. Returns: id, kind, anchor, author, +10 more
drive.drives.createA
Creates a shared drive. For more information, see Manage shared drives [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Drive object accepting backgroundImageFile, backgroundImageLink, capabilities, colorRgb, createdTime, hidden, id, kind and 4 more fields; pass it via params or whole via body_file Siblings over the same resource: delete, get, hide, list, unhide, update.
Inputs: requestId (required), query, params, dry_run, +2 more. Returns: id, kind, name, hidden, +8 more
drive.drives.deleteA
Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items. For more information, see Manage shared drives [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get, hide, list, unhide, update.
Inputs: driveId (required), query, params, dry_run, +3 more.
drive.drives.getA
Gets a shared drive's metadata by ID. For more information, see Manage shared drives [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, hide, list, unhide, update.
Inputs: driveId (required), query, params, dry_run, +2 more. Returns: id, kind, name, hidden, +8 more
drive.drives.hideA
Hides a shared drive from the default view. For more information, see Manage shared drives [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, list, unhide, update.
Inputs: driveId (required), query, params, dry_run, +1 more. Returns: id, kind, name, hidden, +8 more
drive.drives.listA
Lists the user's shared drives. This method accepts the q parameter, which is a search query combining one or more search terms. For more information, see the Search for shared drives guide [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, hide, unhide, update.
Inputs: q, query, params, dry_run, +4 more. Returns: kind, drives, nextPageToken
drive.drives.unhideA
Restores a shared drive to the default view. For more information, see Manage shared drives [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, hide, list, update.
Inputs: driveId (required), query, params, dry_run, +1 more. Returns: id, kind, name, hidden, +8 more
drive.drives.updateA
Updates the metadata for a shared drive. For more information, see Manage shared drives [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Drive object accepting backgroundImageFile, backgroundImageLink, capabilities, colorRgb, createdTime, hidden, id, kind and 4 more fields; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, hide, list, unhide.
Inputs: driveId (required), query, params, dry_run, +3 more. Returns: id, kind, name, hidden, +8 more
drive.files.copyA
Creates a copy of a file and applies any requested updates with patch semantics. For more information, see Create and manage files [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON File object accepting appProperties, capabilities, clientEncryptionDetails, contentHints, contentRestrictions, copyRequiresWriterPermission, createdTime, description and 57 more fields; pass it via params or whole via body_file Siblings over the same resource: create, delete, download, emptyTrash, export, generateCseToken, generateIds, get, list, listLabels, modifyLabels, update, watch.
Inputs: fileId (required), query, params, dry_run, +11 more. Returns: id, kind, name, size, +61 more
drive.files.createB
Creates a file. For more information, see Create and manage files. This method supports an /upload URI and accepts uploaded media with the following characteristics: - Maximum file size: 5,120 GB - Accepted Media MIME types: */* (Specify a valid MIME type, rather than the literal */* value. The literal */* is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](https://developers.google.com/workspace/drive/api/guides/m [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON File object accepting appProperties, capabilities, clientEncryptionDetails, contentHints, contentRestrictions, copyRequiresWriterPermission, createdTime, description and 57 more fields; pass it via params or whole via body_file Siblings over the same resource: copy, delete, download, emptyTrash, export, generateCseToken, generateIds, get, list, listLabels, modifyLabels, update, watch.
Inputs: query, params, dry_run, body_file, +10 more. Returns: id, kind, name, size, +61 more
drive.files.deleteA
Permanently deletes a file owned by the user without moving it to the trash. For more information, see Trash or delete files and folders. If the file belongs to a shared drive, the user must be an organizer on the parent folder. If the target is a folder, all descendants owned by the user are also deleted [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: copy, create, download, emptyTrash, export, generateCseToken, generateIds, get, list, listLabels, modifyLabels, update, watch.
Inputs: fileId (required), query, params, dry_run, +4 more.
drive.files.downloadC
Downloads the content of a file. For more information, see Download and export files. Operations are valid for 24 hours from the time of creation [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: copy, create, delete, emptyTrash, export, generateCseToken, generateIds, get, list, listLabels, modifyLabels, update, watch.
Inputs: fileId (required), query, params, dry_run, +3 more. Returns: done, name, error, metadata, +1 more
drive.files.emptyTrashA
Permanently deletes all of the user's trashed files. For more information, see Trash or delete files and folders [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: copy, create, delete, download, export, generateCseToken, generateIds, get, list, listLabels, modifyLabels, update, watch.
Inputs: query, params, driveId, dry_run, +2 more.
drive.files.exportA
Exports a Google Workspace document to the requested MIME type and returns exported byte content. For more information, see Download and export files. Note that the exported content is limited to 10 MB [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: copy, create, delete, download, emptyTrash, generateCseToken, generateIds, get, list, listLabels, modifyLabels, update, watch.
Inputs: fileId (required), mimeType (required), query, params, +2 more.
drive.files.generateCseTokenB
Generates a CSE token which can be used to create or update CSE files [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: copy, create, delete, download, emptyTrash, export, generateIds, get, list, listLabels, modifyLabels, update, watch.
Inputs: query, fileId, params, parent, +2 more. Returns: jwt, kind, fileId, currentKaclsId, +1 more
drive.files.generateIdsB
Generates a set of file IDs which can be provided in create or copy requests. For more information, see Create and manage files [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: copy, create, delete, download, emptyTrash, export, generateCseToken, get, list, listLabels, modifyLabels, update, watch.
Inputs: type, count, query, space, +3 more. Returns: ids, kind, space
drive.files.getA
Gets a file's metadata or content by ID. For more information, see Search for files and folders. If you provide the URL parameter alt=media, then the response includes the file contents in the response body. Downloading content with alt=media only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use files.export instead. For more information, see [Download and export files](https://developers.google.c [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: copy, create, delete, download, emptyTrash, export, generateCseToken, generateIds, list, listLabels, modifyLabels, update, watch.
Inputs: fileId (required), query, params, dry_run, +6 more. Returns: id, kind, name, size, +61 more
drive.files.listB
Lists the user's files. For more information, see Search for files and folders. This method accepts the q parameter, which is a search query combining one or more search terms. This method returns all files by default, including trashed files. If you don't want trashed files to appear in the list, use the trashed=false query parameter to remove trashed files from the results [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: copy, create, delete, download, emptyTrash, export, generateCseToken, generateIds, get, listLabels, modifyLabels, update, watch.
Inputs: q, query, corpus, params, +15 more. Returns: kind, files, nextPageToken, incompleteSearch
drive.files.listLabelsB
Lists the labels on a file. For more information, see List labels on a file [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: copy, create, delete, download, emptyTrash, export, generateCseToken, generateIds, get, list, modifyLabels, update, watch.
Inputs: fileId (required), query, params, dry_run, +3 more. Returns: kind, labels, nextPageToken
drive.files.modifyLabelsA
Modifies the set of labels applied to a file. For more information, see Set a label field on a file. Returns a list of the labels that were added or modified [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON ModifyLabelsRequest object accepting kind, labelModifications; pass it via params or whole via body_file Siblings over the same resource: copy, create, delete, download, emptyTrash, export, generateCseToken, generateIds, get, list, listLabels, update, watch.
Inputs: fileId (required), query, params, dry_run, +2 more. Returns: kind, modifiedLabels
drive.files.updateB
Updates a file's metadata, content, or both. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as modifiedDate. This method supports patch semantics. This method supports an /upload URI and accepts uploaded media with the following characteristics: - Maximum file size: 5,120 GB - Accepted Media MIME types: */* (Specify a valid MIME type, rather than the literal */* value. The literal */* is only used to indicate that any valid MIME type can be uploaded. For more information [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON File object accepting appProperties, capabilities, clientEncryptionDetails, contentHints, contentRestrictions, copyRequiresWriterPermission, createdTime, description and 57 more fields; pass it via params or whole via body_file Siblings over the same resource: copy, create, delete, download, emptyTrash, export, generateCseToken, generateIds, get, list, listLabels, modifyLabels, watch.
Inputs: fileId (required), query, params, dry_run, +12 more. Returns: id, kind, name, size, +61 more
drive.files.watchA
Subscribes to changes to a file. For more information, see Notifications for resource changes [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Channel object accepting address, expiration, id, kind, params, payload, resourceId, resourceUri and 2 more fields; pass it via params or whole via body_file Siblings over the same resource: copy, create, delete, download, emptyTrash, export, generateCseToken, generateIds, get, list, listLabels, modifyLabels, update.
Inputs: fileId (required), query, params, dry_run, +7 more. Returns: id, kind, type, token, +6 more
drive.operations.getB
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file
Inputs: name (required), query, params, dry_run, +1 more. Returns: done, name, error, metadata, +1 more
drive.permissions.createA
Creates a permission for a file or shared drive. For more information, see Share files, folders, and drives. Warning: Concurrent permission modifications (such as update or delete) on the same file, folder, or shared drive aren't supported across any users or clients; only the last update is applied [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Permission object accepting allowFileDiscovery, deleted, displayName, domain, emailAddress, expirationTime, id, inheritedPermissionsDisabled and 8 more fields; pass it via params or whole via body_file Siblings over the same resource: delete, get, list, update.
Inputs: fileId (required), query, params, dry_run, +11 more. Returns: id, kind, role, type, +12 more
drive.permissions.deleteA
Deletes a permission. For more information, see Share files, folders, and drives. Warning: Concurrent permission modifications (such as update or delete) on the same file, folder, or shared drive aren't supported across any users or clients; only the last update is applied [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get, list, update.
Inputs: fileId (required), permissionId (required), query, params, +6 more.
drive.permissions.getA
Gets a permission by ID. For more information, see Share files, folders, and drives [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, list, update.
Inputs: fileId (required), permissionId (required), query, params, +5 more. Returns: id, kind, role, type, +12 more
drive.permissions.listB
Lists a file's or shared drive's permissions. For more information, see Share files, folders, and drives [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, update.
Inputs: fileId (required), query, params, dry_run, +7 more. Returns: kind, permissions, nextPageToken
drive.permissions.updateA
Updates a permission with patch semantics. For more information, see Share files, folders, and drives. Warning: Concurrent permission modifications (such as update or delete) on the same file, folder, or shared drive aren't supported across any users or clients; only the last update is applied [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Permission object accepting allowFileDiscovery, deleted, displayName, domain, emailAddress, expirationTime, id, inheritedPermissionsDisabled and 8 more fields; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list.
Inputs: fileId (required), permissionId (required), query, params, +9 more. Returns: id, kind, role, type, +12 more
drive.replies.createA
Creates a reply to a comment. For more information, see Manage comments and replies [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Reply object accepting action, assigneeEmailAddress, author, content, createdTime, deleted, htmlContent, id and 3 more fields; pass it via params or whole via body_file Siblings over the same resource: delete, get, list, update.
Inputs: fileId (required), commentId (required), query, params, +3 more. Returns: id, kind, action, author, +7 more
drive.replies.deleteA
Deletes a reply. For more information, see Manage comments and replies [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get, list, update.
Inputs: fileId (required), replyId (required), commentId (required), query, +3 more.
drive.replies.getB
Gets a reply by ID. For more information, see Manage comments and replies [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, list, update.
Inputs: fileId (required), replyId (required), commentId (required), query, +4 more. Returns: id, kind, action, author, +7 more
drive.replies.listB
Lists a comment's replies. For more information, see Manage comments and replies [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, update.
Inputs: fileId (required), commentId (required), query, params, +5 more. Returns: kind, replies, nextPageToken
drive.replies.updateA
Updates a reply with patch semantics. For more information, see Manage comments and replies [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Reply object accepting action, assigneeEmailAddress, author, content, createdTime, deleted, htmlContent, id and 3 more fields; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list.
Inputs: fileId (required), replyId (required), commentId (required), query, +4 more. Returns: id, kind, action, author, +7 more
drive.revisions.deleteA
Permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted. For more information, see Manage file revisions [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: get, list, update.
Inputs: fileId (required), revisionId (required), query, params, +2 more.
drive.revisions.getB
Gets a revision's metadata or content by ID. For more information, see Manage file revisions [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, list, update.
Inputs: fileId (required), revisionId (required), query, params, +3 more. Returns: id, kind, size, mimeType, +10 more
drive.revisions.listB
Lists a file's revisions. For more information, see Manage file revisions. Important: The list of revisions returned by this method might be incomplete for files with a large revision history, including frequently edited Google Docs, Sheets, and Slides. Older revisions might be omitted from the response, meaning the first revision returned may not be the oldest existing revision. The revision history visible in the Workspace editor user interface might be more complete than the list returned by the API [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, get, update.
Inputs: fileId (required), query, params, dry_run, +3 more. Returns: kind, revisions, nextPageToken
drive.revisions.updateA
Updates a revision with patch semantics. For more information, see Manage file revisions [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Revision object accepting exportLinks, id, keepForever, kind, lastModifyingUser, md5Checksum, mimeType, modifiedTime and 6 more fields; pass it via params or whole via body_file Siblings over the same resource: delete, get, list.
Inputs: fileId (required), revisionId (required), query, params, +3 more. Returns: id, kind, size, mimeType, +10 more
drive.teamdrives.createA
Deprecated: Use drives.create instead [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON TeamDrive object accepting backgroundImageFile, backgroundImageLink, capabilities, colorRgb, createdTime, id, kind, name and 3 more fields; pass it via params or whole via body_file Siblings over the same resource: delete, get, list, update.
Inputs: requestId (required), query, params, dry_run, +2 more. Returns: id, kind, name, themeId, +7 more
drive.teamdrives.deleteA
Deprecated: Use drives.delete instead [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get, list, update.
Inputs: teamDriveId (required), query, params, dry_run, +1 more.
drive.teamdrives.getA
Deprecated: Use drives.get instead [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, list, update.
Inputs: teamDriveId (required), query, params, dry_run, +2 more. Returns: id, kind, name, themeId, +7 more
drive.teamdrives.listB
Deprecated: Use drives.list instead [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, update.
Inputs: q, query, params, dry_run, +4 more. Returns: kind, teamDrives, nextPageToken
drive.teamdrives.updateA
Deprecated: Use drives.update instead [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON TeamDrive object accepting backgroundImageFile, backgroundImageLink, capabilities, colorRgb, createdTime, id, kind, name and 3 more fields; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list.
Inputs: teamDriveId (required), query, params, dry_run, +3 more. Returns: id, kind, name, themeId, +7 more
forms.forms.batchUpdateA
Change the form with a batch of updates [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON BatchUpdateFormRequest object accepting includeFormInResponse, requests, writeControl; pass it via params or whole via body_file Siblings over the same resource: create, get, setPublishSettings.
Inputs: formId (required), query, params, dry_run, +2 more. Returns: form, replies, writeControl
forms.forms.createA
Create a new form using the title given in the provided form message in the request. Important: Only the form.info.title and form.info.document_title fields are copied to the new form. All other fields including the form description, items and settings are disallowed. To create a new form and add items, you must first call forms.create to create an empty form with a title and (optional) document title, and then call forms.update to add the items [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Form object accepting formId, info, items, linkedSheetId, publishSettings, responderUri, revisionId, settings; pass it via params or whole via body_file Siblings over the same resource: batchUpdate, get, setPublishSettings.
Inputs: query, params, dry_run, body_file, +2 more. Returns: info, items, formId, settings, +4 more
forms.forms.getA
Get a form [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchUpdate, create, setPublishSettings.
Inputs: formId (required), query, params, dry_run, +1 more. Returns: info, items, formId, settings, +4 more
forms.forms.responses.getB
Get one response from the form [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: list.
Inputs: formId (required), responseId (required), query, params, +2 more. Returns: formId, answers, createTime, responseId, +3 more
forms.forms.responses.listB
List a form's responses [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: get.
Inputs: formId (required), query, filter, params, +4 more. Returns: responses, nextPageToken
forms.forms.setPublishSettingsA
Updates the publish settings of a form. Legacy forms aren't supported because they don't have the publish_settings field [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON SetPublishSettingsRequest object accepting publishSettings, updateMask; pass it via params or whole via body_file Siblings over the same resource: batchUpdate, create, get.
Inputs: formId (required), query, params, dry_run, +2 more. Returns: formId, publishSettings
forms.forms.watches.createA
Create a new watch. If a watch ID is provided, it must be unused. For each invoking project, the per form limit is one watch per Watch.EventType. A watch expires seven days after it is created (see Watch.expire_time) [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON CreateWatchRequest object accepting watch, watchId; pass it via params or whole via body_file Siblings over the same resource: delete, list, renew.
Inputs: formId (required), query, params, dry_run, +2 more. Returns: id, state, target, errorType, +3 more
forms.forms.watches.deleteA
Delete a watch [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, list, renew.
Inputs: formId (required), watchId (required), query, params, +2 more. Returns: object
forms.forms.watches.listB
Return a list of the watches owned by the invoking project. The maximum number of watches is two: For each invoker, the limit is one for each event type per form [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, renew.
Inputs: formId (required), query, params, dry_run, +1 more. Returns: watches
forms.forms.watches.renewA
Renew an existing watch for seven days. The state of the watch after renewal is ACTIVE, and the expire_time is seven days from the renewal. Renewing a watch in an error state (e.g. SUSPENDED) succeeds if the error is no longer present, but fail otherwise. After a watch has expired, RenewWatch returns NOT_FOUND [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON RenewWatchRequest object; pass it via params or whole via body_file Siblings over the same resource: create, delete, list.
Inputs: formId (required), watchId (required), query, params, +3 more. Returns: id, state, target, errorType, +3 more
gmail.users.drafts.createA
Creates a draft with the DRAFT label. For more information, see Create and send draft emails [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Draft object accepting id, message; pass it via params or whole via body_file Siblings over the same resource: delete, get, list, send, update.
Inputs: userId (required), query, params, dry_run, +2 more. Returns: id, message
gmail.users.drafts.deleteA
Immediately and permanently deletes the specified draft. Does not simply trash it. For more information, see Create and send draft emails [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get, list, send, update.
Inputs: id (required), userId (required), query, params, +2 more.
gmail.users.drafts.getB
Gets the specified draft. For more information, see Create and send draft emails [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, list, send, update.
Inputs: id (required), userId (required), query, format, +3 more. Returns: id, message
gmail.users.drafts.listB
Lists the drafts in the user's mailbox. For more information, see Create and send draft emails [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, send, update.
Inputs: userId (required), q, query, params, +5 more. Returns: drafts, nextPageToken, resultSizeEstimate
gmail.users.drafts.sendA
Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers. For more information, see Create and send draft emails [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Draft object accepting id, message; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list, update.
Inputs: userId (required), query, params, dry_run, +2 more. Returns: id, raw, payload, snippet, +6 more
gmail.users.drafts.updateA
Replaces a draft's content. For more information, see Create and send draft emails [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Draft object accepting id, message; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list, send.
Inputs: id (required), userId (required), query, params, +3 more. Returns: id, message
gmail.users.getProfileC
Gets the current user's Gmail profile [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: stop, watch.
Inputs: userId (required), query, params, dry_run, +1 more. Returns: historyId, emailAddress, threadsTotal, messagesTotal
gmail.users.history.listA
Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId). For more information, see Synchronize clients with Gmail [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file
Inputs: userId (required), query, params, dry_run, +6 more. Returns: history, historyId, nextPageToken
gmail.users.labels.createA
Creates a label. For more information, see Manage labels [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Label object accepting color, id, labelListVisibility, messageListVisibility, messagesTotal, messagesUnread, name, threadsTotal and 2 more fields; pass it via params or whole via body_file Siblings over the same resource: delete, get, list, patch, update.
Inputs: userId (required), query, params, dry_run, +2 more. Returns: id, name, type, color, +6 more
gmail.users.labels.deleteA
Immediately and permanently deletes the specified label and removes it from any messages and threads that it's applied to. For more information, see Manage labels [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get, list, patch, update.
Inputs: id (required), userId (required), query, params, +2 more.
gmail.users.labels.getA
Gets the specified label. For more information, see Manage labels [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, list, patch, update.
Inputs: id (required), userId (required), query, params, +2 more. Returns: id, name, type, color, +6 more
gmail.users.labels.listB
Lists all labels in the user's mailbox. For more information, see Manage labels [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, patch, update.
Inputs: userId (required), query, params, dry_run, +1 more. Returns: labels
gmail.users.labels.patchA
Patch the specified label. For more information, see Manage labels [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Label object accepting color, id, labelListVisibility, messageListVisibility, messagesTotal, messagesUnread, name, threadsTotal and 2 more fields; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list, update.
Inputs: id (required), userId (required), query, params, +3 more. Returns: id, name, type, color, +6 more
gmail.users.labels.updateA
Updates the specified label. For more information, see Manage labels [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Label object accepting color, id, labelListVisibility, messageListVisibility, messagesTotal, messagesUnread, name, threadsTotal and 2 more fields; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list, patch.
Inputs: id (required), userId (required), query, params, +3 more. Returns: id, name, type, color, +6 more
gmail.users.messages.attachments.getC
Gets the specified message attachment [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file
Inputs: id (required), userId (required), messageId (required), query, +3 more. Returns: data, size, attachmentId
gmail.users.messages.batchDeleteA
Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON BatchDeleteMessagesRequest object accepting ids; pass it via params or whole via body_file Siblings over the same resource: batchModify, delete, get, import, insert, list, modify, send, trash, untrash.
Inputs: userId (required), query, params, dry_run, +2 more.
gmail.users.messages.batchModifyA
Modifies the labels and the Classification Label values on the specified messages. For administrators modifying messages for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https://www.googleapis.com/auth/gmail.modify.restricted scope [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON BatchModifyMessagesRequest object accepting addClassificationLabels, addLabelIds, ids, removeClassificationLabelIds, removeLabelIds; pass it via params or whole via body_file Siblings over the same resource: batchDelete, delete, get, import, insert, list, modify, send, trash, untrash.
Inputs: userId (required), query, params, dry_run, +2 more.
gmail.users.messages.deleteA
Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer messages.trash instead [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchDelete, batchModify, get, import, insert, list, modify, send, trash, untrash.
Inputs: id (required), userId (required), query, params, +2 more.
gmail.users.messages.getC
Gets the specified message [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchDelete, batchModify, delete, import, insert, list, modify, send, trash, untrash.
Inputs: id (required), userId (required), query, format, +4 more. Returns: id, raw, payload, snippet, +6 more
gmail.users.messages.importA
Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. This method doesn't perform SPF checks, so it might not work for some spam messages, such as those attempting to perform domain spoofing. This method does not send a message. Note that the maximum size of the message is 150 MB [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Message object accepting classificationLabelValues, historyId, id, internalDate, labelIds, payload, raw, sizeEstimate and 2 more fields; pass it via params or whole via body_file Siblings over the same resource: batchDelete, batchModify, delete, get, insert, list, modify, send, trash, untrash.
Inputs: userId (required), query, params, deleted, +6 more. Returns: id, raw, payload, snippet, +6 more
gmail.users.messages.insertA
Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message. For more information, see Create and send email messages [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Message object accepting classificationLabelValues, historyId, id, internalDate, labelIds, payload, raw, sizeEstimate and 2 more fields; pass it via params or whole via body_file Siblings over the same resource: batchDelete, batchModify, delete, get, import, list, modify, send, trash, untrash.
Inputs: userId (required), query, params, deleted, +4 more. Returns: id, raw, payload, snippet, +6 more
gmail.users.messages.listB
Lists the messages in the user's mailbox. For more information, see List Gmail messages [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchDelete, batchModify, delete, get, import, insert, modify, send, trash, untrash.
Inputs: userId (required), q, query, params, +6 more. Returns: messages, nextPageToken, resultSizeEstimate
gmail.users.messages.modifyA
Modifies the labels and the Classification Label values on the specified message. For administrators modifying message for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https://www.googleapis.com/auth/gmail.modify.restricted scope [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON ModifyMessageRequest object accepting addClassificationLabels, addLabelIds, removeClassificationLabelIds, removeLabelIds; pass it via params or whole via body_file Siblings over the same resource: batchDelete, batchModify, delete, get, import, insert, list, send, trash, untrash.
Inputs: id (required), userId (required), query, params, +3 more. Returns: id, raw, payload, snippet, +6 more
gmail.users.messages.sendA
Sends the specified message to the recipients in the To, Cc, and Bcc headers. For more information, see Create and send email messages [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Message object accepting classificationLabelValues, historyId, id, internalDate, labelIds, payload, raw, sizeEstimate and 2 more fields; pass it via params or whole via body_file Siblings over the same resource: batchDelete, batchModify, delete, get, import, insert, list, modify, trash, untrash.
Inputs: userId (required), query, params, dry_run, +2 more. Returns: id, raw, payload, snippet, +6 more
gmail.users.messages.trashA
Moves the specified message to the trash [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchDelete, batchModify, delete, get, import, insert, list, modify, send, untrash.
Inputs: id (required), userId (required), query, params, +2 more. Returns: id, raw, payload, snippet, +6 more
gmail.users.messages.untrashA
Removes the specified message from the trash [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchDelete, batchModify, delete, get, import, insert, list, modify, send, trash.
Inputs: id (required), userId (required), query, params, +2 more. Returns: id, raw, payload, snippet, +6 more
gmail.users.settings.cse.identities.createA
Creates and configures a client-side encryption identity that's authorized to send mail from the user account. Google publishes the S/MIME certificate to a shared domain-wide directory so that people within a Google Workspace organization can encrypt and send mail to the identity. For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2Service [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON CseIdentity object accepting emailAddress, primaryKeyPairId, signAndEncryptKeyPairs; pass it via params or whole via body_file Siblings over the same resource: delete, get, list, patch.
Inputs: userId (required), query, params, dry_run, +2 more. Returns: emailAddress, primaryKeyPairId, signAndEncryptKeyPairs
gmail.users.settings.cse.identities.deleteA
Deletes a client-side encryption identity. The authenticated user can no longer use the identity to send encrypted messages. You cannot restore the identity after you delete it. Instead, use the CreateCseIdentity method to create another identity with the same configuration. For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccoun [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get, list, patch.
Inputs: userId (required), cseEmailAddress (required), query, params, +2 more.
gmail.users.settings.cse.identities.getB
Retrieves a client-side encryption identity configuration. For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https://www.googleapis.com/auth/gmail.settings.basic scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, list, patch.
Inputs: userId (required), cseEmailAddress (required), query, params, +2 more. Returns: emailAddress, primaryKeyPairId, signAndEncryptKeyPairs
gmail.users.settings.cse.identities.listB
Lists the client-side encrypted identities for an authenticated user. For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https://www.googleapis.com/auth/gmail.settings.basic scope. For users managing their own identities and keypairs, requests require [hardware key encryp [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, patch.
Inputs: userId (required), query, params, dry_run, +3 more. Returns: cseIdentities, nextPageToken
gmail.users.settings.cse.identities.patchA
Associates a different key pair with an existing client-side encryption identity. The updated key pair must validate against Google's S/MIME certificate profiles. For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https://www [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON CseIdentity object accepting emailAddress, primaryKeyPairId, signAndEncryptKeyPairs; pass it via paramsor whole viabody_file` Siblings over the same resource: create, delete, get, list.
Inputs: userId (required), emailAddress (required), query, params, +3 more. Returns: emailAddress, primaryKeyPairId, signAndEncryptKeyPairs
gmail.users.settings.cse.keypairs.createA
Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user. For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https://www.googleapis.com/auth/gmail.settings.basic scope. For users managing their ow [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON CseKeyPair object accepting disableTime, enablementState, keyPairId, pem, pkcs7, privateKeyMetadata, subjectEmailAddresses; pass it via params or whole via body_file Siblings over the same resource: disable, enable, get, list, obliterate.
Inputs: userId (required), query, params, dry_run, +3 more. Returns: pem, pkcs7, keyPairId, disableTime, +3 more
gmail.users.settings.cse.keypairs.disableA
Turns off a client-side encryption key pair. The authenticated user can no longer use the key pair to decrypt incoming CSE message texts or sign outgoing CSE mail. To regain access, use the EnableCseKeyPair to turn on the key pair. After 30 days, you can permanently delete the key pair by using the ObliterateCseKeyPair method. For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has [domain-wide delegation authority](https://develop [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON DisableCseKeyPairRequest object; pass it via params or whole via body_file Siblings over the same resource: create, enable, get, list, obliterate.
Inputs: userId (required), keyPairId (required), query, params, +3 more. Returns: pem, pkcs7, keyPairId, disableTime, +3 more
gmail.users.settings.cse.keypairs.enableA
Turns on a client-side encryption key pair that was turned off. The key pair becomes active again for any associated client-side encryption identities. For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https://www.googleapis.com/auth/gmail.settings.basic scope. For users [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON EnableCseKeyPairRequest object; pass it via params or whole via body_file Siblings over the same resource: create, disable, get, list, obliterate.
Inputs: userId (required), keyPairId (required), query, params, +3 more. Returns: pem, pkcs7, keyPairId, disableTime, +3 more
gmail.users.settings.cse.keypairs.getA
Retrieves an existing client-side encryption key pair. For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https://www.googleapis.com/auth/gmail.settings.basic scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://s [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, disable, enable, list, obliterate.
Inputs: userId (required), keyPairId (required), query, params, +2 more. Returns: pem, pkcs7, keyPairId, disableTime, +3 more
gmail.users.settings.cse.keypairs.listA
Lists client-side encryption key pairs for an authenticated user. For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https://www.googleapis.com/auth/gmail.settings.basic scope. For users managing their own identities and keypairs, requests require [hardware key encryption [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, disable, enable, get, obliterate.
Inputs: userId (required), query, params, dry_run, +3 more. Returns: cseKeyPairs, nextPageToken
gmail.users.settings.cse.keypairs.obliterateA
Deletes a client-side encryption key pair permanently and immediately. You can only permanently delete key pairs that have been turned off for more than 30 days. To turn off a key pair, use the DisableCseKeyPair method. Gmail can't restore or decrypt any messages that were encrypted by an obliterated key. Authenticated users and Google Workspace administrators lose access to reading the encrypted messages. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/ [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON ObliterateCseKeyPairRequest object; pass it via params or whole via body_file Siblings over the same resource: create, disable, enable, get, list.
Inputs: userId (required), keyPairId (required), query, params, +3 more.
gmail.users.settings.delegates.createA
Adds a delegate with its verification status set directly to accepted, without sending any verification email. The delegate user must be a member of the same Google Workspace organization as the delegator user. For more information, see Manage delegates. Gmail imposes limitations on the number of delegates and delegators each user in a Google Workspace organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. A delegate user must b [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Delegate object accepting delegateEmail, verificationStatus; pass it via params or whole via body_file Siblings over the same resource: delete, get, list.
Inputs: userId (required), query, params, dry_run, +2 more. Returns: delegateEmail, verificationStatus
gmail.users.settings.delegates.deleteA
Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. For more information, see Manage delegates. A delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get, list.
Inputs: userId (required), delegateEmail (required), query, params, +2 more.
gmail.users.settings.delegates.getA
Gets the specified delegate. For more information, see Manage delegates. A delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, list.
Inputs: userId (required), delegateEmail (required), query, params, +2 more. Returns: delegateEmail, verificationStatus
gmail.users.settings.delegates.listA
Lists the delegates for the specified account. For more information, see Manage delegates. This method is only available to service account clients that have been delegated domain-wide authority [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get.
Inputs: userId (required), query, params, dry_run, +1 more. Returns: delegates
gmail.users.settings.filters.createA
Creates a filter. Note: you can only create a maximum of 1,000 filters. For more information, see Manage Gmail filters [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Filter object accepting action, criteria, id; pass it via params or whole via body_file Siblings over the same resource: delete, get, list.
Inputs: userId (required), query, params, dry_run, +2 more. Returns: id, action, criteria
gmail.users.settings.filters.deleteA
Immediately and permanently deletes the specified filter. For more information, see Manage Gmail filters [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get, list.
Inputs: id (required), userId (required), query, params, +2 more.
gmail.users.settings.filters.getB
Gets a filter. For more information, see Manage Gmail filters [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, list.
Inputs: id (required), userId (required), query, params, +2 more. Returns: id, action, criteria
gmail.users.settings.filters.listA
Lists the message filters of a Gmail user. For more information, see Manage Gmail filters [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get.
Inputs: userId (required), query, params, dry_run, +1 more. Returns: filter
gmail.users.settings.forwardingAddresses.createA
Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. For more information, see Manage email forwarding. This method is only available to service account clients that have been delegated domain-wide authority [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON ForwardingAddress object accepting forwardingEmail, verificationStatus; pass it via params or whole via body_file Siblings over the same resource: delete, get, list.
Inputs: userId (required), query, params, dry_run, +2 more. Returns: forwardingEmail, verificationStatus
gmail.users.settings.forwardingAddresses.deleteA
Deletes the specified forwarding address and revokes any verification that may have been required. For more information, see Manage email forwarding. This method is only available to service account clients that have been delegated domain-wide authority [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get, list.
Inputs: userId (required), forwardingEmail (required), query, params, +2 more.
gmail.users.settings.forwardingAddresses.getB
Gets the specified forwarding address. For more information, see Manage email forwarding [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, list.
Inputs: userId (required), forwardingEmail (required), query, params, +2 more. Returns: forwardingEmail, verificationStatus
gmail.users.settings.forwardingAddresses.listA
Lists the forwarding addresses for the specified account. For more information, see Manage email forwarding [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get.
Inputs: userId (required), query, params, dry_run, +1 more. Returns: forwardingAddresses
gmail.users.settings.getAutoForwardingA
Gets the auto-forwarding setting for the specified account. For more information, see Manage email forwarding [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: getImap, getLanguage, getPop, getVacation, updateAutoForwarding, updateImap, updateLanguage, updatePop, updateVacation.
Inputs: userId (required), query, params, dry_run, +1 more. Returns: enabled, disposition, emailAddress
gmail.users.settings.getImapB
Gets IMAP settings. For more information, see Configure POP and IMAP settings with the Gmail API [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: getAutoForwarding, getLanguage, getPop, getVacation, updateAutoForwarding, updateImap, updateLanguage, updatePop, updateVacation.
Inputs: userId (required), query, params, dry_run, +1 more. Returns: enabled, autoExpunge, maxFolderSize, expungeBehavior
gmail.users.settings.getLanguageB
Gets language settings. For more information, see Manage language settings [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: getAutoForwarding, getImap, getPop, getVacation, updateAutoForwarding, updateImap, updateLanguage, updatePop, updateVacation.
Inputs: userId (required), query, params, dry_run, +1 more. Returns: displayLanguage
gmail.users.settings.getPopB
Gets POP settings. For more information, see Configure POP and IMAP settings with the Gmail API [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: getAutoForwarding, getImap, getLanguage, getVacation, updateAutoForwarding, updateImap, updateLanguage, updatePop, updateVacation.
Inputs: userId (required), query, params, dry_run, +1 more. Returns: disposition, accessWindow
gmail.users.settings.getVacationB
Gets vacation responder settings. For more information, see Manage vacation settings with the Gmail API [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: getAutoForwarding, getImap, getLanguage, getPop, updateAutoForwarding, updateImap, updateLanguage, updatePop, updateVacation.
Inputs: userId (required), query, params, dry_run, +1 more. Returns: endTime, startTime, enableAutoReply, responseSubject, +4 more
gmail.users.settings.sendAs.createA
Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. For more information, see [Manage aliases and signatures with the Gmail API](https://deve [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON SendAs object accepting displayName, isDefault, isPrimary, replyToAddress, sendAsEmail, signature, smtpMsa, treatAsAlias and 1 more fields; pass it via params or whole via body_file Siblings over the same resource: delete, get, list, patch, update, verify.
Inputs: userId (required), query, params, dry_run, +2 more. Returns: smtpMsa, isDefault, isPrimary, signature, +5 more
gmail.users.settings.sendAs.deleteA
Deletes the specified send-as alias. Revokes any verification that may have been required for using it. For more information, see Manage aliases and signatures with the Gmail API. This method is only available to service account clients that have been delegated domain-wide authority [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get, list, patch, update, verify.
Inputs: userId (required), sendAsEmail (required), query, params, +2 more.
gmail.users.settings.sendAs.getA
Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection. For more information, see Manage aliases and signatures with the Gmail API [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, list, patch, update, verify.
Inputs: userId (required), sendAsEmail (required), query, params, +2 more. Returns: smtpMsa, isDefault, isPrimary, signature, +5 more
gmail.users.settings.sendAs.listA
Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases. For more information, see Manage aliases and signatures with the Gmail API [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, patch, update, verify.
Inputs: userId (required), query, params, dry_run, +1 more. Returns: sendAs
gmail.users.settings.sendAs.patchA
Patch the specified send-as alias. For more information, see Manage aliases and signatures with the Gmail API [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON SendAs object accepting displayName, isDefault, isPrimary, replyToAddress, sendAsEmail, signature, smtpMsa, treatAsAlias and 1 more fields; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list, update, verify.
Inputs: userId (required), sendAsEmail (required), query, params, +3 more. Returns: smtpMsa, isDefault, isPrimary, signature, +5 more
gmail.users.settings.sendAs.smimeInfo.deleteA
Deletes the specified S/MIME config for the specified send-as alias. For more information, see Manage S/MIME certificates with the Gmail API [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: get, insert, list, setDefault.
Inputs: id (required), userId (required), sendAsEmail (required), query, +3 more.
gmail.users.settings.sendAs.smimeInfo.getA
Gets the specified S/MIME config for the specified send-as alias. For more information, see Manage S/MIME certificates with the Gmail API [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, insert, list, setDefault.
Inputs: id (required), userId (required), sendAsEmail (required), query, +3 more. Returns: id, pem, pkcs12, issuerCn, +3 more
gmail.users.settings.sendAs.smimeInfo.insertA
Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key. For more information, see Manage S/MIME certificates with the Gmail API [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON SmimeInfo object accepting encryptedKeyPassword, expiration, id, isDefault, issuerCn, pem, pkcs12; pass it via params or whole via body_file Siblings over the same resource: delete, get, list, setDefault.
Inputs: userId (required), sendAsEmail (required), query, params, +3 more. Returns: id, pem, pkcs12, issuerCn, +3 more
gmail.users.settings.sendAs.smimeInfo.listB
Lists S/MIME configs for the specified send-as alias. For more information, see Manage S/MIME certificates with the Gmail API [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, get, insert, setDefault.
Inputs: userId (required), sendAsEmail (required), query, params, +2 more. Returns: smimeInfo
gmail.users.settings.sendAs.smimeInfo.setDefaultB
Sets the default S/MIME config for the specified send-as alias. For more information, see Manage S/MIME certificates with the Gmail API [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, get, insert, list.
Inputs: id (required), userId (required), sendAsEmail (required), query, +3 more.
gmail.users.settings.sendAs.updateA
Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. For more information, see Manage aliases and signatures with the Gmail API. Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON SendAs object accepting displayName, isDefault, isPrimary, replyToAddress, sendAsEmail, signature, smtpMsa, treatAsAlias and 1 more fields; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list, patch, verify.
Inputs: userId (required), sendAsEmail (required), query, params, +3 more. Returns: smtpMsa, isDefault, isPrimary, signature, +5 more
gmail.users.settings.sendAs.verifyA
Sends a verification email to the specified send-as alias address. The verification status must be pending. For more information, see Manage aliases and signatures with the Gmail API. This method is only available to service account clients that have been delegated domain-wide authority [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, list, patch, update.
Inputs: userId (required), sendAsEmail (required), query, params, +2 more.
gmail.users.settings.updateAutoForwardingA
Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. For more information, see Manage email forwarding. This method is only available to service account clients that have been delegated domain-wide authority [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON AutoForwarding object accepting disposition, emailAddress, enabled; pass it via params or whole via body_file Siblings over the same resource: getAutoForwarding, getImap, getLanguage, getPop, getVacation, updateImap, updateLanguage, updatePop, updateVacation.
Inputs: userId (required), query, params, dry_run, +2 more. Returns: enabled, disposition, emailAddress
gmail.users.settings.updateImapA
Updates IMAP settings. For more information, see Configure POP and IMAP settings with the Gmail API [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON ImapSettings object accepting autoExpunge, enabled, expungeBehavior, maxFolderSize; pass it via params or whole via body_file Siblings over the same resource: getAutoForwarding, getImap, getLanguage, getPop, getVacation, updateAutoForwarding, updateLanguage, updatePop, updateVacation.
Inputs: userId (required), query, params, dry_run, +2 more. Returns: enabled, autoExpunge, maxFolderSize, expungeBehavior
gmail.users.settings.updateLanguageA
Updates language settings. For more information, see Manage language settings. If successful, the return object contains the displayLanguage that was saved for the user, which may differ from the value passed into the request. This is because the requested displayLanguage may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON LanguageSettings object accepting displayLanguage; pass it via params or whole via body_file Siblings over the same resource: getAutoForwarding, getImap, getLanguage, getPop, getVacation, updateAutoForwarding, updateImap, updatePop, updateVacation.
Inputs: userId (required), query, params, dry_run, +2 more. Returns: displayLanguage
gmail.users.settings.updatePopA
Updates POP settings. For more information, see Configure POP and IMAP settings with the Gmail API [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON PopSettings object accepting accessWindow, disposition; pass it via params or whole via body_file Siblings over the same resource: getAutoForwarding, getImap, getLanguage, getPop, getVacation, updateAutoForwarding, updateImap, updateLanguage, updateVacation.
Inputs: userId (required), query, params, dry_run, +2 more. Returns: disposition, accessWindow
gmail.users.settings.updateVacationA
Updates vacation responder settings. For more information, see Manage vacation settings with the Gmail API [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON VacationSettings object accepting enableAutoReply, endTime, responseBodyHtml, responseBodyPlainText, responseSubject, restrictToContacts, restrictToDomain, startTime; pass it via params or whole via body_file Siblings over the same resource: getAutoForwarding, getImap, getLanguage, getPop, getVacation, updateAutoForwarding, updateImap, updateLanguage, updatePop.
Inputs: userId (required), query, params, dry_run, +2 more. Returns: endTime, startTime, enableAutoReply, responseSubject, +4 more
gmail.users.stopA
Turn off push notification delivery for the given user mailbox. For more information, see Configure push notifications in Gmail API [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: getProfile, watch.
Inputs: userId (required), query, params, dry_run, +1 more.
gmail.users.threads.deleteA
Immediately and permanently deletes the specified thread. Any messages that belong to the thread are also deleted. This operation cannot be undone. Prefer threads.trash instead. For more information, see Manage threads [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: get, list, modify, trash, untrash.
Inputs: id (required), userId (required), query, params, +2 more.
gmail.users.threads.getB
Gets the specified thread. For more information, see Manage threads [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, list, modify, trash, untrash.
Inputs: id (required), userId (required), query, format, +4 more. Returns: id, snippet, messages, historyId
gmail.users.threads.listB
Lists the threads in the user's mailbox. For more information, see Manage threads [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, get, modify, trash, untrash.
Inputs: userId (required), q, query, params, +6 more. Returns: threads, nextPageToken, resultSizeEstimate
gmail.users.threads.modifyA
Modifies the labels applied to the thread. This applies to all messages in the thread. For more information, see Manage threads [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON ModifyThreadRequest object accepting addLabelIds, removeLabelIds; pass it via params or whole via body_file Siblings over the same resource: delete, get, list, trash, untrash.
Inputs: id (required), userId (required), query, params, +3 more. Returns: id, snippet, messages, historyId
gmail.users.threads.trashA
Moves the specified thread to the trash. Any messages that belong to the thread are also moved to the trash. For more information, see Manage threads [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, get, list, modify, untrash.
Inputs: id (required), userId (required), query, params, +2 more. Returns: id, snippet, messages, historyId
gmail.users.threads.untrashA
Removes the specified thread from the trash. Any messages that belong to the thread are also removed from the trash. For more information, see Manage threads [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, get, list, modify, trash.
Inputs: id (required), userId (required), query, params, +2 more. Returns: id, snippet, messages, historyId
gmail.users.watchA
Set up or update a push notification watch on the given user mailbox. For more information, see Configure push notifications in Gmail API [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON WatchRequest object accepting labelFilterAction, labelFilterBehavior, labelIds, topicName; pass it via params or whole via body_file Siblings over the same resource: getProfile, stop.
Inputs: userId (required), query, params, dry_run, +2 more. Returns: historyId, expiration
people.contactGroups.batchGetB
Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, list, update.
Inputs: query, params, dry_run, body_file, +3 more. Returns: responses
people.contactGroups.createA
Create a new contact group owned by the authenticated user. Created contact group names must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON CreateContactGroupRequest object accepting contactGroup, readGroupFields; pass it via params or whole via body_file Siblings over the same resource: batchGet, delete, get, list, update.
Inputs: query, params, dry_run, body_file, +1 more. Returns: etag, name, metadata, groupType, +5 more
people.contactGroups.deleteA
Delete an existing contact group owned by the authenticated user by specifying a contact group resource name. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchGet, create, get, list, update.
Inputs: resourceName (required), query, params, dry_run, +2 more. Returns: object
people.contactGroups.getA
Get a specific contact group owned by the authenticated user by specifying a contact group resource name [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchGet, create, delete, list, update.
Inputs: resourceName (required), query, params, dry_run, +3 more. Returns: etag, name, metadata, groupType, +5 more
people.contactGroups.listB
List all contact groups owned by the authenticated user. Members of the contact groups are not populated [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchGet, create, delete, get, update.
Inputs: query, params, dry_run, pageSize, +4 more. Returns: totalItems, contactGroups, nextPageToken, nextSyncToken
people.contactGroups.members.modifyA
Modify the members of a contact group owned by the authenticated user. The only system contact groups that can have members added are contactGroups/myContacts and contactGroups/starred. Other system contact groups are deprecated and can only have contacts removed [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON ModifyContactGroupMembersRequest object accepting resourceNamesToAdd, resourceNamesToRemove; pass it via params or whole via body_file
Inputs: resourceName (required), query, params, dry_run, +2 more. Returns: notFoundResourceNames, canNotRemoveLastContactGroupResourceNames
people.contactGroups.updateA
Update the name of an existing contact group owned by the authenticated user. Updated contact group names must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON UpdateContactGroupRequest object accepting contactGroup, readGroupFields, updateGroupFields; pass it via params or whole via body_file Siblings over the same resource: batchGet, create, delete, get, list.
Inputs: resourceName (required), query, params, dry_run, +2 more. Returns: etag, name, metadata, groupType, +5 more
people.otherContacts.copyOtherContactToMyContactsGroupA
Copies an "Other contact" to a new contact in the user's "myContacts" group Mutate requests for the same user should be sent sequentially to avoid increased latency and failures [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON CopyOtherContactToMyContactsGroupRequest object accepting copyMask, readMask, sources; pass it via params or whole via body_file Siblings over the same resource: list, search.
Inputs: resourceName (required), query, params, dry_run, +2 more. Returns: etag, urls, names, events, +34 more
people.otherContacts.listA
List all "Other contacts", that is contacts that are not in a contact group. "Other contacts" are typically auto created contacts from interactions. Sync tokens expire 7 days after the full sync. A request with an expired sync token will get an error with an google.rpc.ErrorInfo with reason "EXPIRED_SYNC_TOKEN". In the case of such an error clients should make a full sync request without a sync_token. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fi [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: copyOtherContactToMyContactsGroup, search.
Inputs: query, params, dry_run, sources, +6 more. Returns: totalSize, nextPageToken, nextSyncToken, otherContacts
people.otherContacts.searchA
Provides a list of contacts in the authenticated user's other contacts that matches the search query. The query matches on a contact's names, emailAddresses, and phoneNumbers fields that are from the OTHER_CONTACT source. IMPORTANT: Before searching, clients should send a warmup request with an empty query to update the cache. See https://developers.google.com/people/v1/other-contacts#search_the_users_other_contacts [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: copyOtherContactToMyContactsGroup, list.
Inputs: query, params, dry_run, pageSize, +2 more. Returns: results
people.people.batchCreateContactsA
Create a batch of new contacts and return the PersonResponses for the newly Mutate requests for the same user should be sent sequentially to avoid increased latency and failures [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON BatchCreateContactsRequest object accepting contacts, readMask, sources; pass it via params or whole via body_file Siblings over the same resource: batchDeleteContacts, batchUpdateContacts, createContact, deleteContact, deleteContactPhoto, get, getBatchGet, listDirectoryPeople, searchContacts, searchDirectoryPeople, updateContact, updateContactPhoto.
Inputs: query, params, dry_run, body_file, +1 more. Returns: createdPeople
people.people.batchDeleteContactsA
Delete a batch of contacts. Any non-contact data will not be deleted. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON BatchDeleteContactsRequest object accepting resourceNames; pass it via params or whole via body_file Siblings over the same resource: batchCreateContacts, batchUpdateContacts, createContact, deleteContact, deleteContactPhoto, get, getBatchGet, listDirectoryPeople, searchContacts, searchDirectoryPeople, updateContact, updateContactPhoto.
Inputs: query, params, dry_run, body_file, +1 more. Returns: object
people.people.batchUpdateContactsA
Update a batch of contacts and return a map of resource names to PersonResponses for the updated contacts. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON BatchUpdateContactsRequest object accepting contacts, readMask, sources, updateMask; pass it via params or whole via body_file Siblings over the same resource: batchCreateContacts, batchDeleteContacts, createContact, deleteContact, deleteContactPhoto, get, getBatchGet, listDirectoryPeople, searchContacts, searchDirectoryPeople, updateContact, updateContactPhoto.
Inputs: query, params, dry_run, body_file, +1 more. Returns: updateResult
people.people.connections.listB
Provides a list of the authenticated user's contacts. Sync tokens expire 7 days after the full sync. A request with an expired sync token will get an error with an google.rpc.ErrorInfo with reason "EXPIRED_SYNC_TOKEN". In the case of such an error clients should make a full sync request without a sync_token. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. When the sync_token is specified, resources deleted since the l [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file
Inputs: resourceName (required), query, params, dry_run, +9 more. Returns: totalItems, connections, totalPeople, nextPageToken, +1 more
people.people.createContactA
Create a new contact and return the person resource for that contact. The request returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names Mutate requests for the same user should be sent sequentially to avoid increased latency and failures [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Person object accepting addresses, ageRange, ageRanges, biographies, birthdays, braggingRights, calendarUrls, clientData and 30 more fields; pass it via params or whole via body_file Siblings over the same resource: batchCreateContacts, batchDeleteContacts, batchUpdateContacts, deleteContact, deleteContactPhoto, get, getBatchGet, listDirectoryPeople, searchContacts, searchDirectoryPeople, updateContact, updateContactPhoto.
Inputs: query, params, dry_run, sources, +3 more. Returns: etag, urls, names, events, +34 more
people.people.deleteContactA
Delete a contact person. Any non-contact data will not be deleted. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchCreateContacts, batchDeleteContacts, batchUpdateContacts, createContact, deleteContactPhoto, get, getBatchGet, listDirectoryPeople, searchContacts, searchDirectoryPeople, updateContact, updateContactPhoto.
Inputs: resourceName (required), query, params, dry_run, +1 more. Returns: object
people.people.deleteContactPhotoA
Delete a contact's photo. Mutate requests for the same user should be done sequentially to avoid // lock contention [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchCreateContacts, batchDeleteContacts, batchUpdateContacts, createContact, deleteContact, get, getBatchGet, listDirectoryPeople, searchContacts, searchDirectoryPeople, updateContact, updateContactPhoto.
Inputs: resourceName (required), query, params, dry_run, +3 more. Returns: person
people.people.getA
Provides information about a person by specifying a resource name. Use people/me to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchCreateContacts, batchDeleteContacts, batchUpdateContacts, createContact, deleteContact, deleteContactPhoto, getBatchGet, listDirectoryPeople, searchContacts, searchDirectoryPeople, updateContact, updateContactPhoto.
Inputs: resourceName (required), query, params, dry_run, +4 more. Returns: etag, urls, names, events, +34 more
people.people.getBatchGetB
Provides information about a list of specific people by specifying a list of requested resource names. Use people/me to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchCreateContacts, batchDeleteContacts, batchUpdateContacts, createContact, deleteContact, deleteContactPhoto, get, listDirectoryPeople, searchContacts, searchDirectoryPeople, updateContact, updateContactPhoto.
Inputs: query, params, dry_run, sources, +4 more. Returns: responses
people.people.listDirectoryPeopleA
Provides a list of domain profiles and domain contacts in the authenticated user's domain directory. When the sync_token is specified, resources deleted since the last sync will be returned as a person with PersonMetadata.deleted set to true. When the page_token or sync_token is specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at [List the directory people that have changed](/people/v1/directory#list_the_directo [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchCreateContacts, batchDeleteContacts, batchUpdateContacts, createContact, deleteContact, deleteContactPhoto, get, getBatchGet, searchContacts, searchDirectoryPeople, updateContact, updateContactPhoto.
Inputs: query, params, dry_run, sources, +7 more. Returns: people, nextPageToken, nextSyncToken
people.people.searchContactsA
Provides a list of contacts in the authenticated user's grouped contacts that matches the search query. The query matches on a contact's names, nickNames, emailAddresses, phoneNumbers, and organizations fields that are from the CONTACT source. IMPORTANT: Before searching, clients should send a warmup request with an empty query to update the cache. See https://developers.google.com/people/v1/contacts#search_the_users_contacts [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchCreateContacts, batchDeleteContacts, batchUpdateContacts, createContact, deleteContact, deleteContactPhoto, get, getBatchGet, listDirectoryPeople, searchDirectoryPeople, updateContact, updateContactPhoto.
Inputs: query, params, dry_run, sources, +3 more. Returns: results
people.people.searchDirectoryPeopleB
Provides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchCreateContacts, batchDeleteContacts, batchUpdateContacts, createContact, deleteContact, deleteContactPhoto, get, getBatchGet, listDirectoryPeople, searchContacts, updateContact, updateContactPhoto.
Inputs: query, params, dry_run, sources, +5 more. Returns: people, totalSize, nextPageToken
people.people.updateContactA
Update contact data for an existing contact person. Any non-contact data will not be modified. Any non-contact data in the person to update will be ignored. All fields specified in the update_mask will be replaced. The server returns a 400 error if person.metadata.sources is not specified for the contact to be updated or if there is no contact source. The server returns a 400 error with reason "failedPrecondition" if person.metadata.sources.etag is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person an [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Person object accepting addresses, ageRange, ageRanges, biographies, birthdays, braggingRights, calendarUrls, clientData and 30 more fields; pass it via params or whole via body_file Siblings over the same resource: batchCreateContacts, batchDeleteContacts, batchUpdateContacts, createContact, deleteContact, deleteContactPhoto, get, getBatchGet, listDirectoryPeople, searchContacts, searchDirectoryPeople, updateContactPhoto.
Inputs: resourceName (required), query, params, dry_run, +5 more. Returns: etag, urls, names, events, +34 more
people.people.updateContactPhotoA
Update a contact's photo. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON UpdateContactPhotoRequest object accepting personFields, photoBytes, sources; pass it via params or whole via body_file Siblings over the same resource: batchCreateContacts, batchDeleteContacts, batchUpdateContacts, createContact, deleteContact, deleteContactPhoto, get, getBatchGet, listDirectoryPeople, searchContacts, searchDirectoryPeople, updateContact.
Inputs: resourceName (required), query, params, dry_run, +2 more. Returns: person
script.processes.listB
List information about processes made by or on behalf of a user, such as process type and current status [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: listScriptProcesses.
Inputs: query, params, dry_run, pageSize, +11 more. Returns: processes, nextPageToken
script.processes.listScriptProcessesB
List information about a script's executed processes, such as process type and current status [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: list.
Inputs: query, params, dry_run, pageSize, +10 more. Returns: processes, nextPageToken
script.projects.createA
Creates a new, empty script project with no script files and a base manifest file [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON CreateProjectRequest object accepting parentId, title; pass it via params or whole via body_file Siblings over the same resource: get, getContent, getMetrics, updateContent.
Inputs: query, params, dry_run, body_file, +1 more. Returns: title, creator, parentId, scriptId, +3 more
script.projects.deployments.createA
Creates a deployment of an Apps Script project [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON DeploymentConfig object accepting description, manifestFileName, scriptId, versionNumber; pass it via params or whole via body_file Siblings over the same resource: delete, get, list, update.
Inputs: scriptId (required), query, params, dry_run, +2 more. Returns: updateTime, entryPoints, deploymentId, deploymentConfig
script.projects.deployments.deleteA
Deletes a deployment of an Apps Script project [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get, list, update.
Inputs: scriptId (required), deploymentId (required), query, params, +2 more. Returns: object
script.projects.deployments.getA
Gets a deployment of an Apps Script project [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, list, update.
Inputs: scriptId (required), deploymentId (required), query, params, +2 more. Returns: updateTime, entryPoints, deploymentId, deploymentConfig
script.projects.deployments.listB
Lists the deployments of an Apps Script project [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, update.
Inputs: scriptId (required), query, params, dry_run, +3 more. Returns: deployments, nextPageToken
script.projects.deployments.updateA
Updates a deployment of an Apps Script project [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON UpdateDeploymentRequest object accepting deploymentConfig; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list.
Inputs: scriptId (required), deploymentId (required), query, params, +3 more. Returns: updateTime, entryPoints, deploymentId, deploymentConfig
script.projects.getA
Gets a script project's metadata [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, getContent, getMetrics, updateContent.
Inputs: scriptId (required), query, params, dry_run, +1 more. Returns: title, creator, parentId, scriptId, +3 more
script.projects.getContentB
Gets the content of the script project, including the code source and metadata for each script file [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get, getMetrics, updateContent.
Inputs: scriptId (required), query, params, dry_run, +2 more. Returns: files, scriptId
script.projects.getMetricsA
Get metrics data for scripts, such as number of executions and active users [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get, getContent, updateContent.
Inputs: scriptId (required), query, params, dry_run, +3 more. Returns: activeUsers, totalExecutions, failedExecutions
script.projects.updateContentA
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 [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Content object accepting files, scriptId; pass it via params or whole via body_file Siblings over the same resource: create, get, getContent, getMetrics.
Inputs: scriptId (required), query, params, dry_run, +2 more. Returns: files, scriptId
script.projects.versions.createA
Creates a new immutable version using the current code, with a unique version number [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Version object accepting createTime, description, scriptId, versionNumber; pass it via params or whole via body_file Siblings over the same resource: get, list.
Inputs: scriptId (required), query, params, dry_run, +2 more. Returns: scriptId, createTime, description, versionNumber
script.projects.versions.getA
Gets a version of a script project [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, list.
Inputs: scriptId (required), versionNumber (required), query, params, +2 more. Returns: scriptId, createTime, description, versionNumber
script.projects.versions.listB
List the versions of a script project [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, get.
Inputs: scriptId (required), query, params, dry_run, +3 more. Returns: versions, nextPageToken
script.scripts.runA
Executes a function in an Apps Script project (Apps Script API script.run). The script runs headlessly with the scopes its manifest declares — review them before calling: arbitrary script code executes with your authorization. Returns the script function's response (OPS_ERROR / ops for failures); script-side failures come back as tool errors, not dead servers. Prefer script processes list to observe running executions and script projects get to read a project's source before running it [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON ExecutionRequest object accepting devMode, function, parameters, sessionState; pass it via params or whole via body_file
Inputs: scriptId (required), query, params, dry_run, +2 more. Returns: done, error, response
searchconsole.searchanalytics.queryA
Query your data with filters and parameters that you define. Returns zero or more rows grouped by the row keys that you define. You must define a date range of one or more days. When date is one of the group by values, any days without data are omitted from the result list. If you need to know which days have data, issue a broad date range query grouped by date for any metric, and see which day rows are returned [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON SearchAnalyticsQueryRequest object accepting aggregationType, dataState, dimensionFilterGroups, dimensions, endDate, rowLimit, searchType, startDate and 2 more fields; pass it via params or whole via body_file
Inputs: siteUrl (required), query, params, dry_run, +2 more. Returns: rows, metadata, responseAggregationType
searchconsole.sitemaps.deleteA
Deletes a sitemap from the Sitemaps report. Does not stop Google from crawling this sitemap or the URLs that were previously crawled in the deleted sitemap [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: get, list, submit.
Inputs: siteUrl (required), feedpath (required), query, params, +2 more.
searchconsole.sitemaps.getA
Retrieves information about a specific sitemap [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, list, submit.
Inputs: siteUrl (required), feedpath (required), query, params, +2 more. Returns: path, type, errors, contents, +5 more
searchconsole.sitemaps.listA
Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request) [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, get, submit.
Inputs: siteUrl (required), query, params, dry_run, +2 more. Returns: sitemap
searchconsole.sitemaps.submitA
Submits a sitemap for a site [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, get, list.
Inputs: siteUrl (required), feedpath (required), query, params, +2 more.
searchconsole.sites.addA
Adds a site to the set of the user's sites in Search Console [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, get, list.
Inputs: siteUrl (required), query, params, dry_run, +1 more.
searchconsole.sites.deleteA
Removes a site from the set of the user's Search Console sites [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: add, get, list.
Inputs: siteUrl (required), query, params, dry_run, +1 more.
searchconsole.sites.getB
Retrieves information about specific site [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: add, delete, list.
Inputs: siteUrl (required), query, params, dry_run, +1 more. Returns: siteUrl, permissionLevel
searchconsole.sites.listA
Lists the user's Search Console sites [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: add, delete, get.
Inputs: query, params, dry_run, body_file. Returns: siteEntry
searchconsole.urlInspection.index.inspectA
Index inspection [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON InspectUrlIndexRequest object accepting inspectionUrl, languageCode, siteUrl; pass it via params or whole via body_file
Inputs: query, params, dry_run, body_file, +1 more. Returns: inspectionResult
searchconsole.urlTestingTools.mobileFriendlyTest.runA
Runs Mobile-Friendly Test for a given URL [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON RunMobileFriendlyTestRequest object accepting requestScreenshot, url; pass it via params or whole via body_file
Inputs: query, params, dry_run, body_file, +1 more. Returns: screenshot, testStatus, resourceIssues, mobileFriendliness, +1 more
sheets.spreadsheets.batchUpdateB
Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your chan [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON BatchUpdateSpreadsheetRequest object accepting commentsViewMode, includeSpreadsheetInResponse, requests, responseIncludeGridData, responseRanges; pass it via params or whole via body_file Siblings over the same resource: create, get, getByDataFilter.
Inputs: spreadsheetId (required), query, params, dry_run, +2 more. Returns: replies, spreadsheetId, commentUpdateState, updatedSpreadsheet
sheets.spreadsheets.createA
Creates a spreadsheet, returning the newly created spreadsheet [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Spreadsheet object accepting comments, commentsViewMode, dataSourceSchedules, dataSources, developerMetadata, namedRanges, properties, sheets and 2 more fields; pass it via params or whole via body_file Siblings over the same resource: batchUpdate, get, getByDataFilter.
Inputs: query, params, dry_run, body_file, +1 more. Returns: sheets, comments, properties, dataSources, +6 more
sheets.spreadsheets.developerMetadata.getA
Returns the developer metadata with the specified ID. The caller must specify the spreadsheet ID and the developer metadata's unique metadataId. For more information, see Read, write, and search metadata [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: search.
Inputs: metadataId (required), spreadsheetId (required), query, params, +2 more. Returns: location, metadataId, visibility, metadataKey, +1 more
sheets.spreadsheets.developerMetadata.searchB
Returns all developer metadata matching the specified DataFilter. For more information, see Read, write, and search metadata. If the provided DataFilter represents a DeveloperMetadataLookup object, this will return all DeveloperMetadata entries selected by it. If the DataFilter represents a location in a spreadsheet, this will return all developer metadata associated with locations intersecting that region [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON SearchDeveloperMetadataRequest object accepting dataFilters; pass it via params or whole via body_file Siblings over the same resource: get.
Inputs: spreadsheetId (required), query, params, dry_run, +2 more. Returns: matchedDeveloperMetadata
sheets.spreadsheets.getA
Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 ways: * Specify a field mask listing your desired fields using the fields URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the includeGridData parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. To retrieve only subsets of spreadshee [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchUpdate, create, getByDataFilter.
Inputs: spreadsheetId (required), query, params, ranges, +5 more. Returns: sheets, comments, properties, dataSources, +6 more
sheets.spreadsheets.getByDataFilterA
Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. For more information, see Read, write, and search metadata. This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include gri [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GetSpreadsheetByDataFilterRequest object accepting commentsViewMode, dataFilters, excludeTablesInBandedRanges, includeGridData; pass it via params or whole via body_file Siblings over the same resource: batchUpdate, create, get.
Inputs: spreadsheetId (required), query, params, dry_run, +2 more. Returns: sheets, comments, properties, dataSources, +6 more
sheets.spreadsheets.sheets.copyToA
Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON CopySheetToAnotherSpreadsheetRequest object accepting destinationSpreadsheetId; pass it via params or whole via body_file
Inputs: sheetId (required), spreadsheetId (required), query, params, +3 more. Returns: index, title, hidden, sheetId, +6 more
sheets.spreadsheets.values.appendA
Appends values to a spreadsheet. The input range is used to search for existing data and find a "table" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the guide and sample code for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The valueInputOption only contro [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON ValueRange object accepting majorDimension, range, values; pass it via params or whole via body_file Siblings over the same resource: batchClear, batchClearByDataFilter, batchGet, batchGetByDataFilter, batchUpdate, batchUpdateByDataFilter, clear, get, update.
Inputs: range (required), spreadsheetId (required), query, params, +8 more. Returns: updates, tableRange, spreadsheetId
sheets.spreadsheets.values.batchClearA
Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. Only values are cleared -- all other properties of the cell (such as formatting and data validation) are kept [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON BatchClearValuesRequest object accepting ranges; pass it via params or whole via body_file Siblings over the same resource: append, batchClearByDataFilter, batchGet, batchGetByDataFilter, batchUpdate, batchUpdateByDataFilter, clear, get, update.
Inputs: spreadsheetId (required), query, params, dry_run, +2 more. Returns: clearedRanges, spreadsheetId
sheets.spreadsheets.values.batchClearByDataFilterA
Clears one or more ranges of values from a spreadsheet. For more information, see Read, write, and search metadata. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc.) are kept [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON BatchClearValuesByDataFilterRequest object accepting dataFilters; pass it via params or whole via body_file Siblings over the same resource: append, batchClear, batchGet, batchGetByDataFilter, batchUpdate, batchUpdateByDataFilter, clear, get, update.
Inputs: spreadsheetId (required), query, params, dry_run, +2 more. Returns: clearedRanges, spreadsheetId
sheets.spreadsheets.values.batchGetB
Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: append, batchClear, batchClearByDataFilter, batchGetByDataFilter, batchUpdate, batchUpdateByDataFilter, clear, get, update.
Inputs: spreadsheetId (required), query, params, ranges, +5 more. Returns: valueRanges, spreadsheetId
sheets.spreadsheets.values.batchGetByDataFilterC
Returns one or more ranges of values that match the specified data filters. For more information, see Read, write, and search metadata. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges that match any of the data filters in the request will be returned [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON BatchGetValuesByDataFilterRequest object accepting dataFilters, dateTimeRenderOption, majorDimension, valueRenderOption; pass it via params or whole via body_file Siblings over the same resource: append, batchClear, batchClearByDataFilter, batchGet, batchUpdate, batchUpdateByDataFilter, clear, get, update.
Inputs: spreadsheetId (required), query, params, dry_run, +2 more. Returns: valueRanges, spreadsheetId
sheets.spreadsheets.values.batchUpdateA
Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON BatchUpdateValuesRequest object accepting data, includeValuesInResponse, responseDateTimeRenderOption, responseValueRenderOption, valueInputOption; pass it via params or whole via body_file Siblings over the same resource: append, batchClear, batchClearByDataFilter, batchGet, batchGetByDataFilter, batchUpdateByDataFilter, clear, get, update.
Inputs: spreadsheetId (required), query, params, dry_run, +2 more. Returns: responses, spreadsheetId, totalUpdatedRows, totalUpdatedCells, +2 more
sheets.spreadsheets.values.batchUpdateByDataFilterA
Sets values in one or more ranges of a spreadsheet. For more information, see Read, write, and search metadata. The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON BatchUpdateValuesByDataFilterRequest object accepting data, includeValuesInResponse, responseDateTimeRenderOption, responseValueRenderOption, valueInputOption; pass it via params or whole via body_file Siblings over the same resource: append, batchClear, batchClearByDataFilter, batchGet, batchGetByDataFilter, batchUpdate, clear, get, update.
Inputs: spreadsheetId (required), query, params, dry_run, +2 more. Returns: responses, spreadsheetId, totalUpdatedRows, totalUpdatedCells, +2 more
sheets.spreadsheets.values.clearA
Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON ClearValuesRequest object; pass it via params or whole via body_file Siblings over the same resource: append, batchClear, batchClearByDataFilter, batchGet, batchGetByDataFilter, batchUpdate, batchUpdateByDataFilter, get, update.
Inputs: range (required), spreadsheetId (required), query, params, +3 more. Returns: clearedRange, spreadsheetId
sheets.spreadsheets.values.getB
Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: append, batchClear, batchClearByDataFilter, batchGet, batchGetByDataFilter, batchUpdate, batchUpdateByDataFilter, clear, update.
Inputs: range (required), spreadsheetId (required), query, params, +5 more. Returns: range, values, majorDimension
sheets.spreadsheets.values.updateB
Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON ValueRange object accepting majorDimension, range, values; pass it via params or whole via body_file Siblings over the same resource: append, batchClear, batchClearByDataFilter, batchGet, batchGetByDataFilter, batchUpdate, batchUpdateByDataFilter, clear, get.
Inputs: range (required), spreadsheetId (required), query, params, +7 more. Returns: updatedData, updatedRows, updatedCells, updatedRange, +2 more
slides.presentations.batchUpdateA
Applies one or more updates to the presentation. Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies: the reply to the third request, and another [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON BatchUpdatePresentationRequest object accepting requests, writeControl; pass it via params or whole via body_file Siblings over the same resource: create, get.
Inputs: presentationId (required), query, params, dry_run, +2 more. Returns: replies, writeControl, presentationId, commentUpdateState
slides.presentations.createA
Creates a blank presentation using the title given in the request. If a presentationId is provided, it is used as the ID of the new presentation. Otherwise, a new ID is generated. Other fields in the request, including any provided content, are ignored. Returns the created presentation [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Presentation object accepting comments, commentsViewMode, layouts, locale, masters, notesMaster, pageSize, presentationId and 3 more fields; pass it via params or whole via body_file Siblings over the same resource: batchUpdate, get.
Inputs: query, params, dry_run, body_file, +1 more. Returns: title, locale, slides, layouts, +7 more
slides.presentations.getB
Gets the latest version of the specified presentation [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchUpdate, create.
Inputs: presentationId (required), query, params, dry_run, +2 more. Returns: title, locale, slides, layouts, +7 more
slides.presentations.pages.getB
Gets the latest version of the specified page in the presentation [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: getThumbnail.
Inputs: pageObjectId (required), presentationId (required), query, params, +3 more. Returns: comments, objectId, pageType, revisionId, +8 more
slides.presentations.pages.getThumbnailA
Generates a thumbnail of the latest version of the specified page in the presentation and returns a URL to the thumbnail image. This request counts as an expensive read request for quota purposes [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: get.
Inputs: pageObjectId (required), presentationId (required), query, params, +4 more. Returns: width, height, contentUrl
tasks.tasklists.deleteA
Deletes the authenticated user's specified task list. If the list contains assigned tasks, both the assigned tasks and the original tasks in the assignment surface (Docs, Chat Spaces) are deleted [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: get, insert, list, patch, update.
Inputs: tasklist (required), query, params, dry_run, +1 more.
tasks.tasklists.getB
Returns the authenticated user's specified task list [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, insert, list, patch, update.
Inputs: tasklist (required), query, params, dry_run, +1 more. Returns: id, etag, kind, title, +2 more
tasks.tasklists.insertA
Creates a new task list and adds it to the authenticated user's task lists. A user can have up to 2000 lists at a time [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON TaskList object accepting etag, id, kind, selfLink, title, updated; pass it via params or whole via body_file Siblings over the same resource: delete, get, list, patch, update.
Inputs: query, params, dry_run, body_file, +1 more. Returns: id, etag, kind, title, +2 more
tasks.tasklists.listB
Returns all the authenticated user's task lists. A user can have up to 2000 lists at a time [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, get, insert, patch, update.
Inputs: query, params, dry_run, body_file, +2 more. Returns: etag, kind, items, nextPageToken
tasks.tasklists.patchA
Updates the authenticated user's specified task list. This method supports patch semantics [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON TaskList object accepting etag, id, kind, selfLink, title, updated; pass it via params or whole via body_file Siblings over the same resource: delete, get, insert, list, update.
Inputs: tasklist (required), query, params, dry_run, +2 more. Returns: id, etag, kind, title, +2 more
tasks.tasklists.updateA
Updates the authenticated user's specified task list [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON TaskList object accepting etag, id, kind, selfLink, title, updated; pass it via params or whole via body_file Siblings over the same resource: delete, get, insert, list, patch.
Inputs: tasklist (required), query, params, dry_run, +2 more. Returns: id, etag, kind, title, +2 more
tasks.tasks.clearA
Clears all completed tasks from the specified task list. The affected tasks will be marked as 'hidden' and no longer be returned by default when retrieving all tasks for a task list [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, get, insert, list, move, patch, update.
Inputs: tasklist (required), query, params, dry_run, +1 more.
tasks.tasks.deleteA
Deletes the specified task from the task list. If the task is assigned, both the assigned task and the original task (in Docs, Chat Spaces) are deleted. To delete the assigned task only, navigate to the assignment surface and unassign the task from there [HTTP DELETE] — removes the resource; irreversible unless the API documents a trash/undo flow; refused under --readonly safety profiles. Returns the post-delete resource state (or empty) as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: clear, get, insert, list, move, patch, update.
Inputs: task (required), tasklist (required), query, params, +2 more.
tasks.tasks.getC
Returns the specified task [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: clear, delete, insert, list, move, patch, update.
Inputs: task (required), tasklist (required), query, params, +2 more. Returns: id, due, etag, kind, +13 more
tasks.tasks.insertA
Creates a new task on the specified task list. Tasks assigned from Docs or Chat Spaces cannot be inserted from Tasks Public API; they can only be created by assigning them from Docs or Chat Spaces. A user can have up to 20,000 non-hidden tasks per list and up to 100,000 tasks in total at a time [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Task object accepting assignmentInfo, completed, deleted, due, etag, hidden, id, kind and 9 more fields; pass it via params or whole via body_file Siblings over the same resource: clear, delete, get, list, move, patch, update.
Inputs: tasklist (required), query, params, parent, +4 more. Returns: id, due, etag, kind, +13 more
tasks.tasks.listB
Returns all tasks in the specified task list. Doesn't return assigned tasks by default (from Docs, Chat Spaces). A user can have up to 20,000 non-hidden tasks per list and up to 100,000 tasks in total at a time [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: clear, delete, get, insert, move, patch, update.
Inputs: tasklist (required), query, dueMax, dueMin, +12 more. Returns: etag, kind, items, nextPageToken
tasks.tasks.moveA
Moves the specified task to another position in the destination task list. If the destination list is not specified, the task is moved within its current list. This can include putting it as a child task under a new parent and/or move it to a different position among its sibling tasks. A user can have up to 2,000 subtasks per task [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: clear, delete, get, insert, list, patch, update.
Inputs: task (required), tasklist (required), query, params, +5 more. Returns: id, due, etag, kind, +13 more
tasks.tasks.patchA
Updates the specified task. This method supports patch semantics [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Task object accepting assignmentInfo, completed, deleted, due, etag, hidden, id, kind and 9 more fields; pass it via params or whole via body_file Siblings over the same resource: clear, delete, get, insert, list, move, update.
Inputs: task (required), tasklist (required), query, params, +3 more. Returns: id, due, etag, kind, +13 more
tasks.tasks.updateB
Updates the specified task [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Task object accepting assignmentInfo, completed, deleted, due, etag, hidden, id, kind and 9 more fields; pass it via params or whole via body_file Siblings over the same resource: clear, delete, get, insert, list, move, patch.
Inputs: task (required), tasklist (required), query, params, +3 more. Returns: id, due, etag, kind, +13 more
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 402 tools
Tools are generally distinguishable because names encode service, resource, and action (e.g. calendar.events.list vs gmail.users.messages.list). Overlap remains in a few places: deprecated drive.teamdrives.* duplicates drive.drives.*, conversionEvents mirrors keyEvents, and patch/update pairs require attention to descriptions.
The naming scheme is highly systematic: service.resource.action with dotted hierarchy and API-derived action names. Consistency is slightly weakened by mixed verb conventions across services (create vs insert vs add) and legacy aliases, but the pattern is still predictable.
402 tools is an extreme mismatch for an agent-facing MCP server; even a broad Google Workspace surface does not need every REST method exposed as a separate tool. The count is far beyond the 3-15 well-scoped range and creates a huge selection burden.
Coverage is very deep across Calendar, Drive, Gmail, Chat, Docs, Sheets, Slides, Forms, Tasks, People, Analytics, Search Console, and Apps Script, with full CRUD/lifecycle operations for many resources. Minor gaps remain for adjacent Workspace products such as Meet, Admin SDK, Keep, and Classroom, but core workflows are covered.
Maintenance
Related MCP Connectors
Go MCP server for GitLab: 2 dynamic tools reach 1000+ REST/GraphQL actions. Free/CE, no paid tier.
Read and edit GA4, Search Console and Google Tag Manager from any MCP client. 29 tools.
Permissioned access to Gmail, Drive and Calendar via the user's own Google account
214 tools for AI agents over one MCP endpoint: image, video, audio, 3D, data, storage, mail, GPUs.
Related MCP Servers
- AlicenseAqualityDmaintenanceMost Google Workspace MCPs let you read. This one lets you write — 28 authoring tools on top of taylorwilsdon/google_workspace_mcp, including markdown-to-Docs, smart chips, and recursive Drive copy.1002MIT
- AlicenseBqualityDmaintenanceProduction-ready MCP server for Google Workspace providing broad coverage across Gmail, Drive, Calendar, Docs, Sheets, and more, with safe-by-default write operations and markdown-to-Google-Docs support.10035 PyPIMIT
- FlicenseNot gradedqualityBmaintenanceLightweight MCP server for Google Workspace (Calendar, Gmail, Drive) designed for Hermes Agent in Docker, enabling tools to list events, messages, and files via CLI.-
- AlicenseAqualityBmaintenanceLocal-first Microsoft Outlook MCP server: a single Go binary that manages calendar events and mail through the Microsoft Graph API over stdio, with tokens stored in the OS keychain and no Entra ID app registration required. Exposes four aggregate tools (calendar, mail, account, system) dispatched by an operation verb, with multi-account support and read-only and mail-gating modes.445MIT