Chrome Web Store API 参考

本参考文档介绍了适用于 Chrome Web Store Publish API 的方法和资源表示形式。每种资源类型都有一种或多种数据表示形式以及一个或多个方法。有关实现详情,请参阅使用 Chrome Web Store Publish API

内容

如需详细了解 items 资源,请参阅资源表示形式。除非另有说明,否则 URI 相对于 https://www.googleapis.com

操作 HTTP 请求 说明
get GET
/chromewebstore/v1.1/items/itemId
获取 Chrome 网上应用店项。在网址中提供 projection="DRAFT"(区分大小写)。
插入 POST
/upload/chromewebstore/v1.1/items
插入新项。
publish POST
/chromewebstore/v1.1/
items/itemId/publish
发布某项内容。

可选的 publishTarget 查询参数用于指定商品的发布方式。有效值为 "trustedTesters""default"
update PUT
/upload/chromewebstore/v1.1/
items/itemId




PUT
/items/itemId
更新现有项。

资源表示法

{
  "kind": "chromewebstore#item",
  "id": string,
  "publicKey": string,
  "uploadState": string,
  "itemError": [
    (value)
  ]
}
属性名称说明
idstring商品的唯一 ID。
itemError[]list详细说明直观易懂的操作状态(仅提供英文版)。将应用上传到 Chrome 应用商店时,系统会显示相同的错误消息。
kindstring将该资源标识为项。值:固定字符串 "chromewebstore#item"
publicKeystring此项的公钥。
uploadStatestring操作的状态。

可接受的值为:
  • "FAILURE"
  • "IN_PROGRESS"
  • "NOT_FOUND"
  • "SUCCESS"

获取

获取 Chrome 网上应用店项。提供 projection="DRAFT"(区分大小写)作为网址参数。

请求

HTTP 请求

GET https://www.googleapis.com/chromewebstore/v1.1/items/itemId

参数

参数名称说明
路径参数
itemIdstring表示 Chrome 应用、Chrome 扩展程序或 Chrome 主题的唯一标识符。
可选的查询参数
projectionstring确定要返回哪个部分项信息。

可接受的值为:
  • DRAFT”:返回从当前草稿中提取的信息。
  • PUBLISHED”:返回从已发布内容草稿中提取的信息。
请注意,目前仅支持 "DRAFT"

授权

此请求需要获得以下范围的授权。

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

生成访问令牌时,上述网址会用作范围参数。如需详细了解 API 授权和身份验证,请参阅 OAuth 2.0 文档

请求正文

使用此方法时请勿提供请求正文。

响应

如果成功,此方法将在响应正文中返回 Items 资源

插入

插入新的

此方法支持上传 URI,并接受上传的媒体。

请求

HTTP 请求

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

参数

参数名称说明
必需的查询参数
uploadTypestring针对 /upload URI 的上传请求的类型。唯一可接受的值是 media:简单上传媒体数据。
可选的查询参数
publisherEmailstring拥有相应内容的发布商的电子邮件地址。默认为来电者的电子邮件地址。

授权

此请求需要获得以下范围的授权。

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

生成访问令牌时,上述网址会用作范围参数。如需详细了解 API 授权和身份验证,请参阅 OAuth 2.0 文档

请求正文

使用此方法时请勿提供请求正文。

响应

如果成功,此方法将在响应正文中返回 Items 资源

发布

发布。在网址中提供定义的 publishTarget(区分大小写):publishTarget = "trustedTesters" 或 publishTarget = "default"。

请求

HTTP 请求

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

参数

参数名称说明
路径参数
itemIdstring要发布的商品的 ID。
可选的查询参数
publishTargetstring在网址中提供定义的 publishTarget(区分大小写):publishTarget="trustedTesters"publishTarget="default"。默认设置为 publishTarget="default"

请求正文

在请求正文中,您可以选择提供以下结构的数据:

JSON

{
  "target": string
}
属性名称说明
targetstring此发布操作的发布目标。这与将 publishTarget 用作网址查询参数的效果相同。字符串值可以是 target="trustedTesters" 或 target="default"。如果未提供,则默认值为 target="default"。建议使用网址查询参数指定相应值。

授权

此请求需要获得以下范围的授权。

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

生成访问令牌时,上述网址会用作范围参数。如需详细了解 API 授权和身份验证,请参阅 OAuth 2.0 文档

响应

如果成功,此方法将返回采用以下结构的响应正文:

{
  "kind": "chromewebstore#item",
  "item_id": string,
  "status": [
    string
  ],
  "statusDetail": [
    string
  ]
}
属性名称说明
kindstring静态字符串值始终为 "chromewebstore#item"
item_idstring此商品的 ID。
status[]list此发布操作的状态代码。它可能包含以下列表中的多个元素:OKNOT_AUTHORIZEDINVALID_DEVELOPERDEVELOPER_NO_OWNERSHIPDEVELOPER_SUSPENDEDITEM_NOT_FOUNDITEM_PENDING_REVIEWITEM_TAKEN_DOWNPUBLISHER_SUSPENDED
statusDetail[]list针对上述状态代码提供易于理解的详细解释。

更新

更新现有

此方法支持上传 URI,并接受上传的媒体。

请求

HTTP 请求

此方法通过两个单独的 URI 提供媒体上传功能。

  • 上传 URI,用于媒体上传请求:

    PUT https://www.googleapis.com/upload/chromewebstore/v1.1/items/itemId
    
  • 元数据 URI,用于仅含元数据的请求:

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

参数

参数名称说明
路径参数
itemIdstring要上传的商品的 ID。
必需的查询参数
uploadTypestring针对 /upload URI 的上传请求的类型。可接受的值为:media - 简单上传。仅上传媒体内容,不含任何元数据。

请求正文

在请求正文中,提供 Items 资源作为元数据。

授权

此请求需要获得以下范围的授权。

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

生成访问令牌时,上述网址会用作范围参数。如需详细了解 API 授权和身份验证,请参阅 OAuth 2.0 文档

响应

如果成功,此方法将在响应正文中返回 Items 资源