Skip to content

Conversation

@barbara-celi
Copy link
Contributor

@barbara-celi barbara-celi commented Nov 12, 2025

Types of changes

  • New content (guides, endpoints, app documentation)
  • Improvement (make a documentation even better)
  • Fix (fix a documentation error)
  • Spelling and grammar accuracy (self-explanatory)

EDU-15990

@barbara-celi barbara-celi self-assigned this Nov 12, 2025
@github-actions
Copy link
Contributor

Navigation Preview Link

No changes detected in the navigation.json file

@github-actions
Copy link
Contributor

Preview Links

Open this URL to set up the portal with this branch changes.

You can now access the edited pages with the following URLs:

@github-actions
Copy link
Contributor

github-actions bot commented Nov 12, 2025

Documentation feedback for docs/guides/vtex-io/Storefront-Guides/google-one-tap-login.md

General Feedback

The guide provides a good overview of setting up Google One-Tap Login in a VTEX store. However, there are several areas where it deviates from the specified rules, particularly in the "Before you begin" section, the imperative voice in instructions, and the overall structure. The guide also includes some descriptive content that could be more action-oriented.

Actionable Feedback

  1. Frontmatter: The frontmatter is missing the excerpt field, which is mandatory.
  2. Before you begin: The "Before you begin" section uses a <Steps> component, which is not standard for guides. It should be converted to a numbered list or bullet points. The imperative voice is also missing in the steps.
  3. Instructions:
    • Step titles should be in imperative form (e.g., "Configure Google OAuth 2.0 app" instead of "Setting up the Google OAuth 2.0 app").
    • Instructions should start with an imperative verb.
  4. Tone and Voice:
    • Ensure all instructions use the active voice and present tense.
    • Avoid using "we"; instead, focus on "you."
  5. Content Structure: The "Google One-tap flow" section is descriptive and doesn't fit the how-to guide format. Consider moving this to a separate reference document or integrating relevant parts into the instructions.
  6. Images: Ensure images are optimized and relevant to the instructions.

Suggested Revision

---
title: "Configuring Google One-Tap Login"
slug: "google-one-tap-login"
excerpt: "Learn how to set up the Google One-Tap login feature in your VTEX store to streamline the login experience for returning users."
hidden: false
createdAt: "2020-07-30T19:58:25.203Z"
updatedAt: "2025-11-12T20:00:32.997Z"
---

In this guide, you'll learn how to set up the Google One-tap login feature in your store.

Google One-tap authenticates users through a pop-up, creating a streamlined login experience. With this feature, a small pop-up appears, allowing returning users to sign in with a single click.

![google-one-tap](https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/google-one-tap-login-0.gif)

## Before you begin

To follow this guide, make sure you have:

1.  **A store using Store Framework**: Your store must have a Store Theme developed following the Storefront guide.
2.  **The `vtex.login` app installed**:
    1.  Open your terminal and log in to your VTEX account by running the command: `vtex login {{accountName}}`. Replace `{{accountName}}` with your account name.
    2.  Run `vtex install [email protected]` to install the `vtex.login` app in your store.
3.  **Configured the Google OAuth 2.0 integration**: The One-tap flow requires the store to have Google OAuth login set up. Refer to the guide [Adding a Client Id and a Client Secret to log in with Google](https://help.vtex.com/docs/tutorials/adding-a-client-id-and-a-client-secret-to-log-in-with-google?locale=en).

## Instructions

### Step 1 - Configure the Google OAuth 2.0 app

1.  Go to the [Google Developers Console](https://console.developers.google.com/) and navigate to the Google OAuth 2.0 configuration page.
2.  Add all your store domains to the **Authorized domains** list. For more information, see Google's guide [Authorized Domains](https://support.google.com/cloud/answer/15549257?visit_id=638985718078812310-3040234660&rd=1#authorized-domains).

    ![authorized-domains](https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/google-one-tap-login-1.png)

    > ℹ️ Include both the website domain and the `{{accountName}}.myvtex.com` domain. The restricted `.myvtex.com` domain may be used for testing purposes.

For more details on how to set up the Google OAuth app, refer to Google's documentation: [Configure your OAuth Consent Screen](https://developers.google.com/identity/one-tap/web/guides/get-google-api-clientid#configure_your_oauth_consent_screen) and [Setting up OAuth 2.0](https://support.google.com/cloud/answer/6158849).

### Step 2 - Configure One-tap on Site Editor

1.  In the VTEX Admin, go to **Storefront > Site Editor**.
2.  In the side menu, click the **Login** block. A new section for Google One-tap will be displayed.
3.  Check the **Enable Google One-tap sign up** toggle to enable the feature in your store's Site Editor.
4.  Configure the following settings:
    *   **Google One-tap alignment:** Choose which side of the page the pop-up appears on. Possible values: `Right` or `Left`.
    *   **Google One-tap top margin:** Set the top margin for the pop-up. This field accepts standard CSS [`top`](https://developer.mozilla.org/pt-PT/docs/Web/CSS/top) values (for example: `10px`, `4rem`).
5.  Click `Save`.

    ![one-tap-wiki-1](https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/google-one-tap-login-2.gif)

After following these steps, the Google One-tap feature will be active, and the pop-up will appear for signed-out users browsing your store.

## Next Steps

*   Test the Google One-Tap login flow on your storefront to ensure it's working as expected.
*   Monitor user feedback and adjust the configuration as needed to optimize the login experience.

Was this feedback useful?

  • Yes
  • No

@github-actions
Copy link
Contributor

Grammar review summary

Review for docs/guides/vtex-io/Storefront-Guides/google-one-tap-login.md

The document has several inconsistencies in capitalization, particularly for the 'Google One-Tap' feature name, which should be consistently capitalized. There are also minor grammatical improvements needed, such as adding articles, correcting prepositions, and ensuring proper title case for headings and guide names. A step numbering error was also identified.


Was this feedback useful?

  • Yes
  • No

@github-actions
Copy link
Contributor

Grammar review summary

Review for docs/guides/vtex-io/Storefront-Guides/google-one-tap-login.md

The document is generally well-written and clear. Minor issues include inconsistent capitalization for technical terms like 'Client ID', an incorrect step numbering, an informal heading, and a link to a non-English resource. Addressing these points will enhance the document's professionalism and clarity.


Was this feedback useful?

  • Yes
  • No

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@github-actions
Copy link
Contributor

Grammar review summary

Review for docs/guides/vtex-io/Storefront-Guides/google-one-tap-login.md

The document has several minor grammatical and stylistic issues, including inconsistent capitalization of technical terms like 'Client ID', awkward phrasing in headings and instructions, and less precise preposition usage. Corrections focus on improving clarity, conciseness, and adherence to standard technical writing conventions.


Was this feedback useful?

  • Yes
  • No

Updated the Google One-tap login guide with image placements and clarified settings options.
@github-actions
Copy link
Contributor

Grammar review summary

Review for docs/guides/vtex-io/Storefront-Guides/google-one-tap-login.md

The document contains several inconsistencies in capitalization, particularly regarding the 'Google One-Tap Login' feature name and linked document titles. There are also minor improvements suggested for step heading formatting and the use of backticks for domain names and acronyms.


Was this feedback useful?

  • Yes
  • No

Added installation instructions for the vtex.login app and updated the One-tap configuration steps.
@github-actions
Copy link
Contributor

Grammar review summary

Review for docs/guides/vtex-io/Storefront-Guides/google-one-tap-login.md

The document has several inconsistencies in capitalization, particularly with 'One-tap' and 'ID'. There are also minor grammatical and stylistic improvements that can enhance clarity and adherence to technical writing conventions.


Was this feedback useful?

  • Yes
  • No

updatedAt: "2025-11-12T20:00:32.997Z"
---

In this guide, you'll learn how to set up the Google One-tap login feature in your store.
Copy link
Contributor

Choose a reason for hiding this comment

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

📝 [Grammar reviewer] reported by reviewdog 🐶
For consistency, 'One-Tap' should be capitalized throughout the document as it refers to a specific feature name.

Suggested change
In this guide, you'll learn how to set up the Google One-tap login feature in your store.
In this guide, you'll learn how to set up the Google One-Tap login feature in your store.


In this guide, you'll learn how to set up the Google One-tap login feature in your store.

Google One-tap authenticates users through a pop-up, creating a streamlined login experience. With this feature, a small pop-up appears, allowing returning users to sign in with a single click.
Copy link
Contributor

Choose a reason for hiding this comment

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

📝 [Grammar reviewer] reported by reviewdog 🐶
For consistency, 'One-Tap' should be capitalized throughout the document as it refers to a specific feature name.

Suggested change
Google One-tap authenticates users through a pop-up, creating a streamlined login experience. With this feature, a small pop-up appears, allowing returning users to sign in with a single click.
Google One-Tap authenticates users through a pop-up, creating a streamlined login experience. With this feature, a small pop-up appears, allowing returning users to sign in with a single click.


### Have a store using Store Framework

Ensure your store has a Store Theme developed following the Storefront guide.
Copy link
Contributor

Choose a reason for hiding this comment

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

📝 [Grammar reviewer] reported by reviewdog 🐶
Capitalize 'Guide' as it likely refers to a specific, named guide.

Suggested change
Ensure your store has a Store Theme developed following the Storefront guide.
Ensure your store has a Store Theme developed following the Storefront Guide.


### Install the `vtex.login` app

1. In your terminal, log in to your account by running the `vtex login {{accountName}}` command. Replace the curly brackets with your account name.
Copy link
Contributor

Choose a reason for hiding this comment

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

📝 [Grammar reviewer] reported by reviewdog 🐶
Be more specific by referring to the actual placeholder {{accountName}} rather than just 'curly brackets'.

Suggested change
1. In your terminal, log in to your account by running the `vtex login {{accountName}}` command. Replace the curly brackets with your account name.
1. In your terminal, log in to your account by running the `vtex login {{accountName}}` command. Replace `{{accountName}}` with your account name.

### Install the `vtex.login` app

1. In your terminal, log in to your account by running the `vtex login {{accountName}}` command. Replace the curly brackets with your account name.
2. Run the `vtex install [email protected]` to install the `vtex.login` app in your store.
Copy link
Contributor

Choose a reason for hiding this comment

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

📝 [Grammar reviewer] reported by reviewdog 🐶
The definite article 'the' is generally omitted before a command name in technical instructions.

Suggested change
2. Run the `vtex install [email protected]` to install the `vtex.login` app in your store.
2. Run `vtex install [email protected]` to install the `vtex.login` app in your store.


## Google One-tap flow

Google One-tap flow is implemented by the [`vtex.login`](https://developers.vtex.com/docs/apps/vtex.login) app. The process is described below:
Copy link
Contributor

Choose a reason for hiding this comment

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

📝 [Grammar reviewer] reported by reviewdog 🐶
For consistency, 'One-Tap' should be capitalized throughout the document as it refers to a specific feature name.

Suggested change
Google One-tap flow is implemented by the [`vtex.login`](https://developers.vtex.com/docs/apps/vtex.login) app. The process is described below:
Google One-Tap flow is implemented by the [`vtex.login`](https://developers.vtex.com/docs/apps/vtex.login) app. The process is described below:


Google One-tap flow is implemented by the [`vtex.login`](https://developers.vtex.com/docs/apps/vtex.login) app. The process is described below:

1. `vtex.login` checks if the user is logged in. The One-tap flow only starts for logged-out users.
Copy link
Contributor

Choose a reason for hiding this comment

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

📝 [Grammar reviewer] reported by reviewdog 🐶
For consistency, 'One-Tap' should be capitalized throughout the document as it refers to a specific feature name.

Suggested change
1. `vtex.login` checks if the user is logged in. The One-tap flow only starts for logged-out users.
1. `vtex.login` checks if the user is logged in. The One-Tap flow only starts for logged-out users.

Google One-tap flow is implemented by the [`vtex.login`](https://developers.vtex.com/docs/apps/vtex.login) app. The process is described below:

1. `vtex.login` checks if the user is logged in. The One-tap flow only starts for logged-out users.
2. `vtex.login` calls the [VTEX ID API](https://developers.vtex.com/docs/guides/login-integration-guide-webstore-oauth2#vtex-id) to get the store's OAuth `clientId`.
Copy link
Contributor

Choose a reason for hiding this comment

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

📝 [Grammar reviewer] reported by reviewdog 🐶
'ID' is an acronym for 'Identifier' and should be capitalized for consistency and standard technical terminology.

Suggested change
2. `vtex.login` calls the [VTEX ID API](https://developers.vtex.com/docs/guides/login-integration-guide-webstore-oauth2#vtex-id) to get the store's OAuth `clientId`.
2. `vtex.login` calls the [VTEX ID API](https://developers.vtex.com/docs/guides/login-integration-guide-webstore-oauth2#vtex-id) to get the store's OAuth `client ID`.


1. `vtex.login` checks if the user is logged in. The One-tap flow only starts for logged-out users.
2. `vtex.login` calls the [VTEX ID API](https://developers.vtex.com/docs/guides/login-integration-guide-webstore-oauth2#vtex-id) to get the store's OAuth `clientId`.
3. `vtex.login` triggers the One-tap pop-up.
Copy link
Contributor

Choose a reason for hiding this comment

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

📝 [Grammar reviewer] reported by reviewdog 🐶
For consistency, 'One-Tap' should be capitalized throughout the document as it refers to a specific feature name.

Suggested change
3. `vtex.login` triggers the One-tap pop-up.
3. `vtex.login` triggers the One-Tap pop-up.

3. `vtex.login` triggers the One-tap pop-up.
4. The user clicks the **Continue as** button.
5. Google checks the user's identity and returns a JSON Web Token (JWT) to `vtex.login`.
6. `vtex.login` POSTs a form containing the JWT and redirects the user to an endpoint at the VTEX ID API.
Copy link
Contributor

Choose a reason for hiding this comment

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

📝 [Grammar reviewer] reported by reviewdog 🐶
'Of' is generally more appropriate than 'at' when referring to an endpoint that belongs to or is part of an API.

Suggested change
6. `vtex.login` POSTs a form containing the JWT and redirects the user to an endpoint at the VTEX ID API.
6. `vtex.login` POSTs a form containing the JWT and redirects the user to an endpoint of the VTEX ID API.

Copy link
Collaborator

@carolinamenezes carolinamenezes left a comment

Choose a reason for hiding this comment

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

Boa! Não deixa de criar o redirect e atualizar o navigation!

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants