Referensi ini menjelaskan metode dan representasi resource yang tersedia untuk Chrome Web Store Publish API. Setiap jenis resource memiliki satu atau beberapa representasi data dan satu atau beberapa metode. Lihat Menggunakan Chrome Web Store Publish API untuk detail implementasi.
Item
Untuk mengetahui detail Resource Item, lihat representasi resource. URI terkait dengan https://www.googleapis.com, kecuali jika dinyatakan lain
Operasi | Permintaan HTTP | Deskripsi |
---|---|---|
dapatkan |
GET/chromewebstore/v1.1/items/itemId
|
Mendapatkan item Chrome Web Store. Berikan projection="DRAFT" di URL (peka huruf besar/kecil). |
sisipkan |
POST/upload/chromewebstore/v1.1/items
|
Menyisipkan item baru. |
publish |
POST/chromewebstore/v1.1/
|
Memublikasikan item. Parameter kueri publishTarget opsional menentukan cara item akan dipublikasikan. Nilai yang valid adalah "trustedTesters" dan "default" .
|
pembaruan |
PUT/upload/chromewebstore/v1.1/ dan PUT /items/itemId
|
Memperbarui item yang ada. |
Representasi resource
{
"kind": "chromewebstore#item",
"id": string,
"publicKey": string,
"uploadState": string,
"itemError": [
(value)
]
}
Nama properti | Nilai | Deskripsi |
---|---|---|
id | string | ID unik item. |
itemError[] | list | Detail status operasi yang dapat dibaca manusia, hanya dalam bahasa Inggris. Pesan error yang sama akan ditampilkan saat Anda mengupload aplikasi ke Chrome Web Store. |
kind | string | Mengidentifikasi resource ini sebagai Item. Nilai: string tetap "chromewebstore#item" . |
publicKey | string | Kunci publik item ini. |
uploadState | string | Status operasi. Nilai yang dapat diterima adalah:
|
Dapatkan
Mendapatkan item Chrome Web Store. Berikan projection="DRAFT"
(peka huruf besar/kecil) sebagai Parameter URL.
Permintaan
Permintaan HTTP
GET https://www.googleapis.com/chromewebstore/v1.1/items/itemId
Parameter
Nama parameter | Nilai | Deskripsi |
---|---|---|
Parameter jalur | ||
itemId | string | ID unik yang mewakili Aplikasi Chrome, Ekstensi Chrome, atau Tema Chrome. |
Parameter kueri opsional | ||
projection | string | Menentukan subset informasi item mana yang akan ditampilkan. Nilai yang dapat diterima adalah:
"DRAFT" yang didukung. |
Otorisasi
Permintaan ini memerlukan otorisasi dengan cakupan berikut.
https://www.googleapis.com/auth/chromewebstore.readonly
URL di atas digunakan sebagai parameter cakupan saat membuat token akses. Untuk detail selengkapnya tentang otorisasi dan autentikasi API, lihat dokumentasi OAuth 2.0.
Isi permintaan
Jangan berikan isi permintaan dengan metode ini.
Respons
Jika berhasil, metode ini akan menampilkan resource Item dalam isi respons.
Sisipkan
Menyisipkan item baru.
Metode ini mendukung URI upload dan menerima media yang diupload.
Permintaan
Permintaan HTTP
POST https://www.googleapis.com/upload/chromewebstore/v1.1/items
Parameter
Nama parameter | Nilai | Deskripsi |
---|---|---|
Parameter kueri yang diperlukan | ||
uploadType | string | Jenis permintaan upload ke URI /upload. Satu-satunya nilai yang diterima adalah media : upload sederhana data media. |
Parameter kueri opsional | ||
publisherEmail | string | Email penerbit yang memiliki item tersebut. Default-nya adalah alamat email penelepon. |
Otorisasi
Permintaan ini memerlukan otorisasi dengan cakupan berikut.
https://www.googleapis.com/auth/chromewebstore
URL di atas digunakan sebagai parameter cakupan saat membuat token akses. Untuk detail selengkapnya tentang otorisasi dan autentikasi API, lihat dokumentasi OAuth 2.0.
Isi permintaan
Jangan berikan isi permintaan dengan metode ini.
Respons
Jika berhasil, metode ini akan menampilkan resource Item dalam isi respons.
Publikasikan
Memublikasikan item. Berikan publishTarget yang ditentukan di URL (peka huruf besar/kecil): publishTarget = "trustedTesters" atau publishTarget = "default".
Permintaan
Permintaan HTTP
POST https://www.googleapis.com/chromewebstore/v1.1/items/itemId/publish
Parameter
Nama parameter | Nilai | Deskripsi |
---|---|---|
Parameter jalur | ||
itemId | string | ID item yang akan dipublikasikan. |
Parameter kueri opsional | ||
publishTarget | string | Berikan publishTarget yang ditentukan di URL (peka huruf besar/kecil): publishTarget="trustedTesters" atau publishTarget="default" . Defaultnya adalah publishTarget="default" . |
Isi permintaan
Dalam isi permintaan, Anda dapat secara opsional menyediakan data dengan struktur berikut:
JSON
{
"target": string
}
Nama properti | Nilai | Deskripsi |
---|---|---|
target | string | Target publikasi dari operasi publikasi ini. Hal ini sama seperti menggunakan publishTarget sebagai parameter kueri URL. Nilai string dapat berupa target="trustedTesters" atau target="default". Nilai default, jika tidak ada yang diberikan, adalah target="default". Penggunaan yang direkomendasikan adalah menggunakan parameter kueri URL untuk menentukan nilai. |
Otorisasi
Permintaan ini memerlukan otorisasi dengan cakupan berikut.
https://www.googleapis.com/auth/chromewebstore
URL di atas digunakan sebagai parameter cakupan saat membuat token akses. Untuk detail selengkapnya tentang otorisasi dan autentikasi API, lihat dokumentasi OAuth 2.0.
Respons
Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:
{
"kind": "chromewebstore#item",
"item_id": string,
"status": [
string
],
"statusDetail": [
string
]
}
Nama properti | Nilai | Deskripsi |
---|---|---|
kind | string | Nilai string statis selalu "chromewebstore#item" . |
item_id | string | ID item ini. |
status[] | list | Kode status operasi publikasi ini. File dapat berisi beberapa elemen dari daftar berikut: OK , NOT_AUTHORIZED , INVALID_DEVELOPER , DEVELOPER_NO_OWNERSHIP , DEVELOPER_SUSPENDED , ITEM_NOT_FOUND , ITEM_PENDING_REVIEW , ITEM_TAKEN_DOWN , PUBLISHER_SUSPENDED . |
statusDetail[] | list | Penjelasan mendetail yang dapat dipahami manusia tentang kode status di atas. |
Update
Memperbarui item yang sudah ada.
Metode ini mendukung URI upload dan menerima media yang diupload.
Permintaan
Permintaan HTTP
Metode ini menyediakan fungsi upload media melalui dua URI terpisah.
URI upload, untuk permintaan upload media:
PUT https://www.googleapis.com/upload/chromewebstore/v1.1/items/itemId
URI Metadata, untuk permintaan metadata saja:
PUT https://www.googleapis.com/chromewebstore/v1.1/items/itemId
Parameter
Nama parameter | Nilai | Deskripsi |
---|---|---|
Parameter jalur | ||
itemId | string | ID item yang akan diupload. |
Parameter kueri yang diperlukan | ||
uploadType | string | Jenis permintaan upload ke URI /upload. Nilai yang dapat diterima adalah: media - Upload sederhana. Upload media saja, tanpa metadata apa pun. |
Isi permintaan
Dalam isi permintaan, sediakan resource Item sebagai metadata.
Otorisasi
Permintaan ini memerlukan otorisasi dengan cakupan berikut.
https://www.googleapis.com/auth/chromewebstore
URL di atas digunakan sebagai parameter cakupan saat membuat token akses. Untuk detail selengkapnya tentang otorisasi dan autentikasi API, lihat dokumentasi OAuth 2.0.
Respons
Jika berhasil, metode ini akan menampilkan resource Item dalam isi respons.