How can I ensure that the extension ID remains the same when publishing my browser extension for the first time on Chrome and Edge?

Question

How can I ensure that the extension ID remains the same when publishing my browser extension for the first time on Chrome and Edge?

Sylvia lucy 20

I want to upload extension'zip with mainfest.json includes "key". But it show error. User's image

Dr. S. Gomathi 310 Reputation points MVP

2023-11-01T05:23:36.89+00:00
Hi Sylvia,

When publishing a browser extension for both Chrome and Edge, ensuring the extension ID remains consistent requires careful management of the key value in the manifest.json file. The issue you're facing appears to be related to this exact key parameter. Let's address the problem step-by-step:

Chrome Web Store:

When you first upload your extension to the Chrome Web Store Developer Dashboard, the store will generate a unique key for your extension. This key determines the extension's ID.

After uploading (even if it's a draft and not published), download the .crx file of your extension from the developer dashboard.

Extract the .crx file using a ZIP program. Inside, you'll find a file named manifest.json. Open this file to find the "key": "YOUR_KEY" field.

Save this key value. Use it in your manifest.json file for subsequent uploads to ensure the extension ID remains the same.

Edge Add-ons Store:

Edge uses the same mechanism as Chrome. However, it seems that the Edge store doesn't want you to include the key value directly when uploading for the first time.

For the initial upload, remove the "key": "YOUR_KEY" field from manifest.json.

Once the extension is accepted and has an ID, you can then keep the key in your manifest.json for subsequent updates, ensuring it matches the one you've used in the Chrome Web Store. This should keep your Edge extension ID the same as the Chrome extension ID.

To address the error:

Remove the key field from the manifest.json file when uploading the extension to the Edge Add-ons Store for the first time.

After the initial upload and once you have an extension ID from Edge, reintroduce the key field with the appropriate value (from Chrome) for future updates.

Hope it helps. Please upvote if you feel this solves your issue.

Regards,

Dr. Gomathi S
Sylvia lucy 20 Reputation points

2023-11-01T05:37:04.9866667+00:00

Are you saying that the extension ID can be updated through subsequent re-publishing of the extension? I meant to ask if it's possible to have the same extension ID on both Chrome and Edge stores. For example, if the extension ID on Chrome is "abc", I would like the extension ID on Edge to also be "abc", rather than having a different ID like "efg" on Edge.
Wenying Lu-MSFT 955 Reputation points Microsoft Vendor

2023-11-10T02:56:19.0933333+00:00

Hi @Sylvia lucy , May I know any update on this issue?

Dr. S. Gomathi 310 Reputation points MVP

2023-11-01T05:23:36.89+00:00

Hi Sylvia,

When publishing a browser extension for both Chrome and Edge, ensuring the extension ID remains consistent requires careful management of the key value in the manifest.json file. The issue you're facing appears to be related to this exact key parameter. Let's address the problem step-by-step:

Chrome Web Store:

When you first upload your extension to the Chrome Web Store Developer Dashboard, the store will generate a unique key for your extension. This key determines the extension's ID.

After uploading (even if it's a draft and not published), download the .crx file of your extension from the developer dashboard.

Extract the .crx file using a ZIP program. Inside, you'll find a file named manifest.json. Open this file to find the "key": "YOUR_KEY" field.

Save this key value. Use it in your manifest.json file for subsequent uploads to ensure the extension ID remains the same.

Edge Add-ons Store:

Edge uses the same mechanism as Chrome. However, it seems that the Edge store doesn't want you to include the key value directly when uploading for the first time.

For the initial upload, remove the "key": "YOUR_KEY" field from manifest.json.

Once the extension is accepted and has an ID, you can then keep the key in your manifest.json for subsequent updates, ensuring it matches the one you've used in the Chrome Web Store. This should keep your Edge extension ID the same as the Chrome extension ID.

To address the error:

Remove the key field from the manifest.json file when uploading the extension to the Edge Add-ons Store for the first time.

After the initial upload and once you have an extension ID from Edge, reintroduce the key field with the appropriate value (from Chrome) for future updates.

Hope it helps. Please upvote if you feel this solves your issue.

Regards,

Dr. Gomathi S
Sylvia lucy 20 Reputation points

2023-11-01T05:37:04.9866667+00:00

Are you saying that the extension ID can be updated through subsequent re-publishing of the extension? I meant to ask if it's possible to have the same extension ID on both Chrome and Edge stores. For example, if the extension ID on Chrome is "abc", I would like the extension ID on Edge to also be "abc", rather than having a different ID like "efg" on Edge.
Wenying Lu-MSFT 955 Reputation points Microsoft Vendor

2023-11-10T02:56:19.0933333+00:00

Hi @Sylvia lucy , May I know any update on this issue?

Answer 1

Hi @Sylvia lucy ,

1.Once uploaded extension, your extension ID is fixed and cannot be changed any more.

The ID is derived from the .pem file that was created the first time you packed the extension in a .crx file. When you load an extension in "unpacked mode", an ID is automatically generated in an unpredictable way.

The only way to control the extension ID during development is by setting the "key" field in the manifest file, as the doc.

2.You're ready to submit your app/extension to the extension Store, refer to the following steps:

1)Create a zip file containing your extension (important: manifest.json must be at the root, i.e. "directory/manifest.json" is bad, "manifest.json" is good).

Add the .pem file as key.pem!
(this is necessary to preserve the extension ID)
(Add) How to generate a key.pem! 1.Go to edge://extensions/ and enable Developer mode; 2.Click on "Pack extension...", select your app/extension's directory and confirm; 3.You've got a .crx file and a .pem file. Back up the private key (.pem file).

2)Upload the extension to the Store (without the "key" field in manifest.json will reject any upload that contains a "key" field).

For subsequent updates, "key.pem" should not be added to the zip file, because doesn't need it anymore.

If the answer is the right solution, please click "Accept Answer" and kindly upvote it. If you have extra questions about this answer, please click "Comment".

Note: Please follow the steps in our documentation to enable e-mail notifications if you want to receive the related email notification for this thread.

Regards,

Wenying Lu

How can I ensure that the extension ID remains the same when publishing my browser extension for the first time on Chrome and Edge?

1 answer

Activity