Skip to content

docs(gmail): clarify Gmail web URL IDs#814

Open
Lubrsy706 wants to merge 1 commit into
googleworkspace:mainfrom
Lubrsy706:rescue/gmail-api-id-docs
Open

docs(gmail): clarify Gmail web URL IDs#814
Lubrsy706 wants to merge 1 commit into
googleworkspace:mainfrom
Lubrsy706:rescue/gmail-api-id-docs

Conversation

@Lubrsy706
Copy link
Copy Markdown

Summary

  • document that Gmail web URL sync IDs are not Gmail API message or thread IDs
  • add a concrete list-then-get workflow for finding API IDs from searchable message metadata
  • add the warning to the Gmail skill docs and README quick examples

Resubmits the focused docs fix from #792 after the stale bot closed that PR for inactivity. CLA is now passing on the earlier PR.

Testing

  • git diff origin/main..HEAD --check

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 19, 2026

🦋 Changeset detected

Latest commit: df4af2e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@googleworkspace/cli Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request improves the developer experience for the Gmail integration by explicitly documenting the distinction between browser-based sync IDs and Gmail API identifiers. By providing clear warnings and actionable search workflows, it helps users avoid common 'Invalid id value' errors when interacting with the Gmail API.

Highlights

  • Documentation Update: Clarified that Gmail web URL sync IDs (e.g., FMfcgz...) are not compatible with the Gmail API, which requires specific message or thread IDs.
  • Workflow Guidance: Added a recommended workflow for users to retrieve valid API IDs by performing a search or list operation when starting from a browser URL.
  • Improved Examples: Updated the README and skill documentation with concrete examples demonstrating how to search for messages to obtain the correct API identifiers.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Generative AI Prohibited Use Policy, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation across the README, skill definitions, and changesets to clarify that Gmail web URL sync IDs (e.g., FMfcgz...) are not compatible with the Gmail API. It provides guidance and examples on how to use search or list methods to retrieve the correct API message or thread IDs. I have no feedback to provide as there were no review comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants