Home

Awesome

How to generate Google API keys

Guide and OAuth helper to generate keys

Companion to Web Store Upload.

You can follow this complete guide or the official-but-partial one at: https://developer.chrome.com/docs/webstore/using-api

[!TIP] The names you enter here don't really matter. It's an app that only you will have access to. This will take approximately 10 minutes and Google likes to change these screens often. Sorry.

  1. Visit https://console.developers.google.com/apis/credentials

  2. Create a project:

    <img width="772" alt="Google APIs: Create project" src="https://user-images.githubusercontent.com/1402241/77865620-9a8a3680-722f-11ea-99cb-b09e5c0c11ec.png">

  3. Enter chrome-webstore-upload and Create

  4. Visit https://console.cloud.google.com/apis/credentials/consent

  5. Select on External and Create

    <img width="804" alt="OAuth Consent Screen" src="https://user-images.githubusercontent.com/1402241/133878019-f159f035-2b76-4686-a461-0e0005355da6.png">

  6. Only enter the Application name (e.g. chrome-webstore-upload) and required email fields, and click Save

    <img width="475" alt="Consent screen configuration" src="https://user-images.githubusercontent.com/1402241/77865809-82ff7d80-7230-11ea-8a96-e381d55524c5.png">

  7. On the 3rd screen, add your own email address:

    <img width="632" alt="Test users selection" src="https://user-images.githubusercontent.com/1402241/106213510-7c180300-6192-11eb-97b4-b4ae92424bf1.png">

  8. Visit https://console.developers.google.com/apis/library/chromewebstore.googleapis.com

  9. Click Enable

  10. Visit https://console.developers.google.com/apis/credentials

  11. Click Create credentials > OAuth client ID:

    <img width="771" alt="Create credentials" src="https://user-images.githubusercontent.com/1402241/77865679-e89f3a00-722f-11ea-942d-5245091f22b8.png">

  12. Select Desktop app, enter Chrome Webstore Upload and click Create

    <img width="568" alt="Create OAuth client ID" src="https://user-images.githubusercontent.com/1402241/163124196-c4bb4f26-9766-4766-bb81-3982875d3a84.png">

  13. Save your ✅ clientId and ✅ clientSecret:

    <img width="554" alt="OAuth client created" src="https://user-images.githubusercontent.com/1402241/228934028-1ef55a41-cc92-4ecf-967a-1984a363c21d.png">

  14. Visit https://console.cloud.google.com/apis/credentials/consent

  15. Click PUBLISH APP and confirm

    <img width="771" alt="Publish app" src="https://user-images.githubusercontent.com/27696701/114265946-2da2a280-9a26-11eb-9567-c4e00f572500.png">

  16. Run this CLI tool to generate the required refreshToken

    npx chrome-webstore-upload-keys

    or

    bunx chrome-webstore-upload-keys
    <img width="771" alt="chrome-webstore-upload-keys demo" src="./demo.gif">

  17. Done. Now you should have ✅ clientId, ✅ clientSecret and ✅ refreshToken. You can use these for all your extensions, but don't share them!

What the CLI tool does

  1. Requests the two keys you have
  2. Opens a local server to handle the OAuth redirect from Google's servers with an approvalCode
  3. Uses Google's oauth2 API to request a refreshToken