این مرجع روشها و نمایش منابع موجود برای API انتشارات فروشگاه وب Chrome را شرح میدهد. هر نوع منبع دارای یک یا چند نمایش داده و یک یا چند روش است. برای جزئیات پیاده سازی به استفاده از Chrome Web Store Publish API مراجعه کنید.
موارد
برای جزئیات منابع آیتم ها، به نمایش منبع مراجعه کنید. URI ها مربوط به https://www.googleapis.com هستند، مگر اینکه غیر از این ذکر شده باشد
عمل | درخواست HTTP | شرح |
---|---|---|
گرفتن | گرفتن/chromewebstore/v1.1/items/ itemId | مورد فروشگاه وب Chrome را دریافت می کند. ارائه projection="DRAFT" در URL (حساس به حروف کوچک و بزرگ). |
درج کنید | پست/upload/chromewebstore/v1.1/items | یک مورد جدید درج می کند. |
انتشار | پست/chromewebstore/v1.1/ | یک مورد را منتشر می کند. پارامتر پرس و جو اختیاری publishTarget نحوه انتشار آیتم را مشخص می کند. مقادیر معتبر "trustedTesters" و "default" هستند. |
به روز رسانی | قرار دادن/upload/chromewebstore/v1.1/ و قرار دادن /items/ itemId | یک مورد موجود را به روز می کند. |
نمایندگی منابع
{
"kind": "chromewebstore#item",
"id": string,
"publicKey": string,
"uploadState": string,
"itemError": [
(value)
]
}
نام ملک | ارزش | شرح |
---|---|---|
id | رشته | شناسه منحصر به فرد کالا |
itemError[] | فهرست | جزئیات وضعیت عملیات قابل خواندن توسط انسان، فقط به زبان انگلیسی. هنگامی که برنامه خود را در فروشگاه وب Chrome آپلود می کنید، همان پیام های خطا نمایش داده می شود. |
kind | رشته | این منبع را به عنوان یک آیتم شناسایی می کند. مقدار: رشته ثابت "chromewebstore#item" . |
publicKey | رشته | کلید عمومی این مورد |
uploadState | رشته | وضعیت عملیات. مقادیر قابل قبول عبارتند از:
|
گرفتن
مورد فروشگاه وب Chrome را دریافت می کند. projection="DRAFT"
(حساس به حروف بزرگ) به عنوان پارامتر URL ارائه دهید.
درخواست
درخواست HTTP
GET https://www.googleapis.com/chromewebstore/v1.1/items/itemId
مولفه های
نام پارامتر | ارزش | شرح |
---|---|---|
پارامترهای مسیر | ||
itemId | رشته | شناسه منحصربهفرد نشاندهنده برنامه Chrome، برنامه افزودنی Chrome یا طرح زمینه Chrome. |
پارامترهای پرس و جو اختیاری | ||
projection | رشته | تعیین می کند که کدام زیرمجموعه از اطلاعات مورد بازگردانده شود. مقادیر قابل قبول عبارتند از:
"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
مولفه های
نام پارامتر | ارزش | شرح |
---|---|---|
پارامترهای پرس و جو مورد نیاز | ||
uploadType | رشته | نوع درخواست آپلود به /upload URI. تنها مقدار پذیرفته شده media است: آپلود ساده داده های رسانه. |
پارامترهای پرس و جو اختیاری | ||
publisherEmail | رشته | ایمیل ناشر صاحب اقلام. پیشفرض آدرس ایمیل تماسگیرنده است. |
مجوز
این درخواست نیاز به مجوز با محدوده زیر دارد.
https://www.googleapis.com/auth/chromewebstore
URL بالا به عنوان پارامتر scope هنگام ایجاد یک نشانه دسترسی استفاده می شود. برای جزئیات بیشتر در مورد مجوز API و احراز هویت، به اسناد OAuth 2.0 مراجعه کنید.
درخواست بدن
با این روش بدنه درخواستی ارائه نکنید.
واکنش
در صورت موفقیت آمیز بودن، این روش یک منبع Items را در بدنه پاسخ برمی گرداند.
انتشار
یک مورد را منتشر می کند. انتشارTarget تعریف شده را در URL (حساس به حروف کوچک و بزرگ) ارائه دهید: publishTarget = "trustedTesters" یا publishTarget = "پیش فرض".
درخواست
درخواست HTTP
POST https://www.googleapis.com/chromewebstore/v1.1/items/itemId/publish
مولفه های
نام پارامتر | ارزش | شرح |
---|---|---|
پارامترهای مسیر | ||
itemId | رشته | شناسه مورد برای انتشار. |
پارامترهای پرس و جو اختیاری | ||
publishTarget | رشته | publishTarget تعریف شده را در URL (حساس به حروف کوچک و بزرگ) ارائه دهید: publishTarget="trustedTesters" یا publishTarget="default" . پیشفرضها به publishTarget="default" . |
درخواست بدن
در بدنه درخواست، می توانید به صورت اختیاری داده هایی را با ساختار زیر ارائه دهید:
JSON
{
"target": string
}
نام ملک | ارزش | شرح |
---|---|---|
target | string | هدف انتشار این عملیات انتشار. این همان استفاده از publicTarget به عنوان پارامتر کوئری URL است. مقدار رشته می تواند target="trustedTesters" یا target="default" باشد. مقدار پیشفرض، اگر هیچ کدام ارائه نشده باشد، target="default" است. استفاده توصیه شده استفاده از پارامتر query URL برای تعیین مقدار است. |
مجوز
این درخواست نیاز به مجوز با محدوده زیر دارد.
https://www.googleapis.com/auth/chromewebstore
URL بالا به عنوان پارامتر scope هنگام ایجاد یک نشانه دسترسی استفاده می شود. برای جزئیات بیشتر در مورد مجوز API و احراز هویت، به اسناد OAuth 2.0 مراجعه کنید.
واکنش
در صورت موفقیت آمیز بودن، این روش یک بدنه پاسخ با ساختار زیر را برمی گرداند:
{
"kind": "chromewebstore#item",
"item_id": string,
"status": [
string
],
"statusDetail": [
string
]
}
نام ملک | ارزش | شرح |
---|---|---|
kind | string | مقدار رشته ایستا همیشه "chromewebstore#item" است. |
item_id | string | شناسه این کالا |
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
مولفه های
نام پارامتر | ارزش | شرح |
---|---|---|
پارامترهای مسیر | ||
itemId | string | شناسه مورد برای آپلود. |
پارامترهای پرس و جو مورد نیاز | ||
uploadType | string | نوع درخواست آپلود به /upload URI. مقادیر قابل قبول عبارتند از: media - آپلود ساده. فقط رسانه را بارگذاری کنید، بدون هیچ گونه ابرداده. |
درخواست بدن
در بدنه درخواست، یک منبع Items به عنوان ابرداده ارائه کنید.
مجوز
این درخواست نیاز به مجوز با محدوده زیر دارد.
https://www.googleapis.com/auth/chromewebstore
URL بالا به عنوان پارامتر scope هنگام ایجاد یک نشانه دسترسی استفاده می شود. برای جزئیات بیشتر در مورد مجوز API و احراز هویت، به اسناد OAuth 2.0 مراجعه کنید.
واکنش
در صورت موفقیت آمیز بودن، این روش یک منبع Items را در بدنه پاسخ برمی گرداند.