Chrome 線上應用程式商店 API 參考資料

本參考資料說明 Chrome 線上應用程式商店 Publish API 可用的方法和資源表示法。每個資源類型都具有一或多個資料表示法，以及一或多種方法。如要瞭解實作詳情，請參閱使用 Chrome 線上應用程式商店 Publish API。

項目

如需項目資源詳細資料，請參閱資源表示法。除非另有註明，否則 URI 是與 https://www.googleapis.com 相對的

作業 HTTP 要求 說明
取得 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"。
更新 PUT
/upload/chromewebstore/v1.1/
items/itemId

和

PUT
/items/itemId 		更新現有項目。

資源表示法

{
  "kind": "chromewebstore#item",
  "id": string,
  "publicKey": string,
  "uploadState": string,
  "itemError": [
    (value)
  ]
}
資源名稱值說明
id字串商品的專屬 ID。
itemError[]list提供使用者可理解的作業狀態詳細資料 (僅限英文)。將應用程式上傳到 Chrome 線上應用程式商店時，系統顯示的錯誤訊息相同。
kind字串將此資源識別為項目。值：固定字串 "chromewebstore#item"。
publicKey字串這個項目的公開金鑰。
uploadState字串作業狀態。

可接受的值為：
  • "FAILURE"
  • "IN_PROGRESS"
  • "NOT_FOUND"
  • "SUCCESS"

取得

取得 Chrome 線上應用程式商店商品。提供 projection="DRAFT" (區分大小寫) 做為網址參數。

要求

HTTP 要求

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

參數

參數名稱值說明
路徑參數
itemId字串代表 Chrome 應用程式、Chrome 擴充功能或 Chrome 主題的專屬 ID。
選用查詢參數
projection字串決定要傳回哪些項目資訊。

可接受的值如下：
  • 「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

參數

參數名稱值說明
必要的查詢參數
uploadType字串/upload URI 的上傳要求類型。唯一接受的值為 media：簡易的媒體資料上傳。
選用查詢參數
publisherEmail字串商品所屬發布商的電子郵件。預設是來電者的電子郵件地址。

授權

這項要求需要下列範圍的授權。

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

參數

參數名稱值說明
路徑參數
itemId字串要發布的商品 ID。
選用查詢參數
publishTarget字串請在網址中提供已定義的「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這個發布作業的狀態碼。此清單可能包含下列清單中的多個元素：OK、NOT_AUTHORIZED、INVALID_DEVELOPER、DEVELOPER_NO_OWNERSHIP、DEVELOPER_SUSPENDED、ITEM_NOT_FOUND、ITEM_PENDING_REVIEW、ITEM_TAKEN_DOWN、PUBLISHER_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 資源。