Skip to content

docs: document Gmail web link vs API ID mismatch (#858)#873

Open
MeGaurav4 wants to merge 2 commits into
googleworkspace:mainfrom
MeGaurav4:docs/gmail-web-link-858
Open

docs: document Gmail web link vs API ID mismatch (#858)#873
MeGaurav4 wants to merge 2 commits into
googleworkspace:mainfrom
MeGaurav4:docs/gmail-web-link-858

Conversation

@MeGaurav4

Copy link
Copy Markdown

Closes #858.

Documents that:

  • The Gmail API returns hex thread/message IDs (e.g. 19e1acd465710c93)
  • There is no supported way to turn these into durable Gmail web URLs
  • '#all/' is unofficial and unreliable on cold loads
  • '#search/rfc822msgid:' is the closest API-derivable option,
    though it is a search URL, not a direct permalink
  • The inverse problem (web URL IDs not accepted by the API) tracked in Feature: helper to resolve Gmail web URL (sync ID, FMfcgz...) to an API thread #790

Files changed:

  • README.md - note under the helpers table
  • skills/gws-gmail/SKILL.md - note after the helper commands table

The API returns hex IDs that cannot be converted into durable Gmail web
URLs. The '#all/<hexId>' alias is unofficial and breaks on cold loads.
Document this gap and cross-reference googleworkspace#790.
@changeset-bot

changeset-bot Bot commented Jul 12, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 422b5e8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@google-cla

google-cla Bot commented Jul 12, 2026

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@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 documentation for the Gmail integration by clarifying the limitations of converting Gmail API hex IDs into functional web URLs. It aims to manage user expectations by explaining why direct permalinks are not supported and provides guidance on the reliability of existing URL patterns.

Highlights

  • Documentation Update: Added clarifying notes regarding the mismatch between Gmail API hex IDs and web-based URLs.
  • Clarification on URL Reliability: Explicitly documented that '#all/' is unofficial and unreliable for direct linking.
  • Issue Reference: Linked to issue Feature: helper to resolve Gmail web URL (sync ID, FMfcgz...) to an API thread #790 for context regarding the inverse problem where web URL IDs are not accepted by the API.
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.

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

Copy link
Copy Markdown
Contributor

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 README.md and skills/gws-gmail/SKILL.md to document the limitations of converting Gmail API hex thread/message IDs into durable web URLs. The reviewer pointed out that the workaround using #search/rfc822msgid:<Message-ID>, which was mentioned in the pull request description, was omitted from the documentation in both files, and provided code suggestions to include it.

Comment thread README.md Outdated
Comment thread skills/gws-gmail/SKILL.md Outdated
@googleworkspace-bot

Copy link
Copy Markdown
Collaborator

/gemini review

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

Copy link
Copy Markdown
Contributor

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 in README.md and skills/gws-gmail/SKILL.md to add a note explaining the differences and limitations between Gmail web links and API IDs, specifically addressing the lack of a supported way to convert hex thread/message IDs into durable Gmail web URLs. There are no review comments, so I have no feedback to provide.

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.

Docs: no supported way to build a Gmail web link from an API ID (inverse of #790)

2 participants