Chrome ウェブストア API リファレンス

このリファレンスでは、Chrome Web Store Publish API で使用できるメソッドとリソース表現について説明します。各リソースタイプには、1 つ以上のデータ表現と 1 つ以上のメソッドがあります。実装について詳しくは、Chrome Web Store Publish API を使用するをご覧ください。

項目

Items リソースの詳細については、リソース表現をご覧ください。URI は、特に明記されていない限り、https://www.googleapis.com を基準とします。

オペレーション HTTP リクエスト 説明
get GET
/chromewebstore/v1.1/items/itemId 		Chrome ウェブストアのアイテムを取得します。URL で 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このリソースを Item として識別します。値: 固定文字列 "chromewebstore#item"。
publicKeystringこのアイテムの公開鍵。
uploadStatestringオペレーションのステータス。

有効な値は次のとおりです。
  • "FAILURE"
  • "IN_PROGRESS"
  • "NOT_FOUND"
  • "SUCCESS"

Get

Chrome ウェブストアのアイテムを取得します。URL パラメータとして projection="DRAFT"（大文字と小文字を区別）を指定します。

リクエスト

HTTP リクエスト

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

パラメータ

パラメータ名値説明
パスパラメータ
itemIdstringChrome アプリ、Chrome 拡張機能、Chrome テーマを表す一意の識別子。
省略可能なクエリ パラメータ
projectionstring商品アイテム情報のうち、どれを返すかを指定します。

有効な値は次のとおりです。
  • 「DRAFT」: 現在の下書きから抽出した情報を返します。
  • 「PUBLISHED」: 公開済みのアイテムの下書きから抽出した情報を返します。
現時点では、"DRAFT" のみがサポートされています。

承認

このリクエストには、次のスコープの承認が必要です。

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

上記の URL は、アクセス トークンの生成時に scope パラメータとして使用されます。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

上記の URL は、アクセス トークンの生成時に scope パラメータとして使用されます。API の承認と認証について詳しくは、OAuth 2.0 のドキュメントをご覧ください。

リクエスト本文

このメソッドをリクエストの本文に含めないでください。

レスポンス

成功すると、このメソッドはレスポンスの本文で Items リソースを返します。

公開する

item を公開します。URL に定義された publishTarget を指定します（大文字と小文字は区別されます）。 publishTarget = "trustedTesters" または publishTarget = "default" を指定します。

リクエスト

HTTP リクエスト

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

パラメータ

パラメータ名値説明
パスパラメータ
itemIdstring公開するアイテムの ID。
省略可能なクエリ パラメータ
publishTargetstringURL に定義済みの publishTarget を指定します（大文字と小文字は区別されます）: publishTarget="trustedTesters" または publishTarget="default"。デフォルトは publishTarget="default" です。

リクエスト本文

リクエストの本文には、必要に応じて次の構造のデータを指定できます。

JSON

{
  "target": string
}
プロパティ名値説明
targetstringこのパブリッシュ オペレーションのパブリッシュ ターゲットです。これは、URL クエリ パラメータとして publishTarget を使用する場合と同じです。文字列値は target="trustedTesters" または target="default" のいずれかです。指定しない場合のデフォルト値は target="default" です。URL クエリ パラメータを使用して値を指定することをおすすめします。

承認

このリクエストには、次のスコープの承認が必要です。

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

上記の URL は、アクセス トークンの生成時に scope パラメータとして使用されます。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 リクエスト

このメソッドは、2 つの異なる 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

上記の URL は、アクセス トークンの生成時に scope パラメータとして使用されます。API の承認と認証について詳しくは、OAuth 2.0 のドキュメントをご覧ください。

レスポンス

成功すると、このメソッドはレスポンスの本文で Items リソースを返します。