Chrome Web Store API Reference

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

See Using the Chrome Web Store Publish API for a guide on how to authenticate with and make requests to the API.

Authorization

All endpoints are authenticated using OAuth 2.0.

Valid scopes:

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

API endpoints

For Item Resource details, see the resource representation.

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

Get

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

HTTP request

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

Parameters

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 the OAuth 2.0 documentation.

Request body

Don't supply a request body with this method.

Response

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

Insert

Inserts a new item.

This method supports an upload URI and accepts uploaded media.

HTTP request

POST https://www.googleapis.com/upload/chromewebstore/v1.1/items

Parameters

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 the OAuth 2.0 documentation.

Request body

Don't supply a request body with this method.

Response

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

Publish

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

You can optionally provide a publishTarget in the URL (case sensitive), for example:

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

HTTP request

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

Parameters

Request body

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

JSON

{
  "target": string,
  "deployPercentage": string,
  "reviewExemption": boolean
}

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 the OAuth 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
  ]
}

Update

Updates an existing item. The draft revision of the item will be updated but it won't be sent for review until you call publish.

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:

  PUT https://www.googleapis.com/upload/chromewebstore/v1.1/items/EXTENSION_ID
  

• Metadata URI, for metadata-only requests:

  PUT https://www.googleapis.com/chromewebstore/v1.1/items/EXTENSION_ID
  

Parameters

Request body

In the request body, supply an Items 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 the OAuth 2.0 documentation.

Response

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

Item Resource

{
  "kind": "chromewebstore#item",
  "id": string,
  "publicKey": string,
  "uploadState": string,
  "itemError": [
    (value)
  ]
}