Chrome Web Store API Reference

This reference describes the methods and resource representation available for the Chrome Web StorePublish API. Each resource type has one or more data representations and oneor more methods.

SeeUsing the Chrome Web Store Publish API for aguide on how to authenticate with and make requests to the API.

Authorization

All endpoints are authenticated usingOAuth 2.0.

Valid scopes:

  • https://www.googleapis.com/auth/chromewebstore
  • https://www.googleapis.com/auth/chromewebstore.readonly

API endpoints

For Item Resource details, see theresource representation.

All URIs are relative to https://www.googleapis.com.

OperationHTTP requestDescription
getGET
/chromewebstore/v1.1/items/itemId
Gets a Chrome Web Store item. Provideprojection="DRAFT" in URL (case sensitive).
insertPOST
/upload/chromewebstore/v1.1/items
Inserts a new item.
publishPOST
/chromewebstore/v1.1/
items/itemId/publish
Publishes an item.

The optionalpublishTarget query parameter specifies how the item will be published. Valid values are"trustedTesters" and"default".
updatePUT
/upload/chromewebstore/v1.1/
items/itemId


and

PUT
/items/itemId
Updates an existing item.

Get

Gets a Chrome Web Store item. Provideprojection="DRAFT" (case sensitive) as a URL Parameter.

HTTP request

GEThttps://www.googleapis.com/chromewebstore/v1.1/items/EXTENSION_ID?projection=DRAFT

Parameters

Parameter nameValueDescription
Path parameters
itemIdstringUnique identifier representing the Chrome App, Chrome Extension, or the Chrome Theme.
Required query parameters
projectionstringDetermines which subset of the item information to return.

Acceptable values are:
  • "DRAFT": Return information extracted from the current draft.

Authorization

This request requires authorization with the following scope.

https://www.googleapis.com/auth/chromewebstore.readonly

The above URL is used as the scope parameter when generating an access token. For more details on API authorization and authentication, consult theOAuth 2.0 documentation.

Request body

Don't supply a request body with this method.

Response

If successful, this method returns anItems resource in the response body.

Insert

Inserts a newitem.

This method supports an upload URI and accepts uploaded media.

HTTP request

POSThttps://www.googleapis.com/upload/chromewebstore/v1.1/items

Parameters

Parameter nameValueDescription
Required query parameters
uploadTypestringThe type of upload request to the/upload URI. The only accepted value ismedia: a simple upload of the media data.
Optional query parameters
publisherEmailstringThe email of the publisher who owns the items. Defaults to the caller's email address.

Authorization

This request requires authorization with the following scope.

https://www.googleapis.com/auth/chromewebstore

The above URL is used as the scope parameter when generating an access token. For more details on API authorization and authentication, consult theOAuth 2.0 documentation.

Request body

Don't supply a request body with this method.

Response

If successful, this method returns anItems resource in the response body.

Publish

Publishes anitem. The item will first be sent for review. If theitem is already under review, calling publish will fail.

You can optionally provide apublishTarget in the URL (case sensitive), forexample:

  • ?publishTarget="trustedTesters" to publish to trusted testers.
  • ?publishTarget="default"

HTTP request

POSThttps://www.googleapis.com/chromewebstore/v1.1/items/EXTENSION_ID/publish

Parameters

Parameter nameValueDescription
Path parameters
itemIdstringThe ID of the item to publish.
Optional query parameters
publishTargetstringProvide definedpublishTarget in URL (case sensitive):publishTarget="trustedTesters" orpublishTarget="default". Defaults topublishTarget="default".
deployPercentagestringProvidedeployPercentage for percentage of users who will receive an update to this version. Valid values are non negative integers between 0 and 100. Regardless of value provided, 100% of new user installs receive the latest version. Once provided, this value can only be increased for any given release. Note that using this API endpoint always triggers review, even if only the deploy percentage has been changed.
reviewExemptionbooleanIf set to true, attempts to use theexpedited review process. If the draft does not qualify and this is set to true, the API call will fail.

Request body

In the request body, you can optionally supply data with the following structure:

JSON
{"target":string,"deployPercentage":string,"reviewExemption":boolean}
Property nameValueDescription
targetstringThe publish target of this publish operation. This is the same as using publishTarget as a URL query parameter. The string value can either be or. The default value, if none is supplied, is. Recommended usage is to use the URL query parameter to specify the value.
deployPercentagestringProvidedeployPercentage for percentage of users who will receive an update to this version. Valid values are non negative integers between 0 and 100. Regardless of value provided, 100% of new user installs receive the latest version. Once provided, this value can only be increased for any given release. Note that using this API endpoint always triggers review, even if only the deploy percentage has been changed.
reviewExemptionbooleanIf set to true, attempts to use theexpedited review process. If the draft does not qualify and this is set to true, the API call will fail.

Authorization

This request requires authorization with the following scope.

https://www.googleapis.com/auth/chromewebstore

The above URL is used as the scope parameter when generating an access token. For more details on API authorization and authentication, consult theOAuth 2.0 documentation.

Response

If successful, this method returns a response body with the following structure:

{"kind":"chromewebstore#item","item_id":string,"status":[string],"statusDetail":[string]}
Property nameValueDescription
kindstringStatic string value is always"chromewebstore#item".
item_idstringThe ID of this item.
status[]listThe status code of this publish operation. It may contain multiple elements from the following list:OK,NOT_AUTHORIZED,INVALID_DEVELOPER,DEVELOPER_NO_OWNERSHIP,DEVELOPER_SUSPENDED,ITEM_NOT_FOUND,ITEM_PENDING_REVIEW,ITEM_TAKEN_DOWN,PUBLISHER_SUSPENDED.
statusDetail[]listDetailed human-comprehensible explanation of the status code above.

Update

Updates an existingitem. The draft revision of the item will beupdated but it won't be sent for review until you callpublish.

This method supports an upload URI and accepts uploaded media.

HTTP request

This method provides media upload functionality through two separate URIs.

  • Upload URI, for media upload requests:

    PUThttps://www.googleapis.com/upload/chromewebstore/v1.1/items/EXTENSION_ID
  • Metadata URI, for metadata-only requests:

    PUThttps://www.googleapis.com/chromewebstore/v1.1/items/EXTENSION_ID

Parameters

Parameter nameValueDescription
Path parameters
itemIdstringThe ID of the item to upload.
Required query parameters
uploadTypestringThe type of upload request to the/upload URI. Acceptable values are:media - Simple upload. Upload the media only, without any metadata.

Request body

In the request body, supply anItems resource as the metadata.

Authorization

This request requires authorization with the following scope.

https://www.googleapis.com/auth/chromewebstore

The above URL is used as the scope parameter when generating an access token. For more details on API authorization and authentication, consult theOAuth 2.0 documentation.

Response

If successful, this method returns anItems resource in the response body.

Item Resource

{"kind":"chromewebstore#item","id":string,"publicKey":string,"uploadState":string,"itemError":[(value)]}
Property nameValueDescription
idstringUnique ID of the item.
itemError[]listDetail human-readable status of the operation, in English only. Same error messages are displayed when you upload your app to the Chrome Web Store.
kindstringIdentifies this resource as an Item. Value: the fixed string"chromewebstore#item".
publicKeystringPublic key of this item.
uploadStatestringStatus of the most recent draft uploaded within the last 24 hours. Only upload attempts which initially returnIN_PROGRESS are considered.

Acceptable values are:
  • "FAILURE"
  • "IN_PROGRESS"
  • "NOT_FOUND"
  • "SUCCESS"

NOT_FOUND indicates there has not been an upload in the last 24 hours.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-15 UTC.