דף זה תורגם על ידי Cloud Translation API.

הפניית API של חנות האינטרנט של Chrome

בהפניה הזו מתוארות השיטות וייצוג המשאבים הזמינים ל-Chrome Web Store לפרסום API. לכל סוג של משאב יש ייצוג אחד או יותר של נתונים, ושיטה אחת או יותר. פרטים על ההטמעה זמינים במאמר שימוש ב-Chrome Web Store Publish API.

פריטים

למידע על פרטי משאב של פריטים, ראו ייצוג משאבים. מזהי URI הם יחסיים לכתובת https://www.googleapis.com, אלא אם צוין אחרת

פעולה	בקשת HTTP	התיאור
get	GET `/chromewebstore/v1.1/items/itemId`	מקבל פריט מחנות האינטרנט של Chrome. צריך לציין `projection="DRAFT"` בכתובת ה-URL (תלוי אותיות רישיות).
הוספה	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`	מחרוזת	המזהה הייחודי של הפריט.
`itemError[]`	list	יש לתאר את סטטוס הפעולה קריא (לבני אדם), באנגלית בלבד. אותן הודעות שגיאה מוצגות כשמעלים את האפליקציה לחנות האינטרנט של Chrome.
`kind`	מחרוזת	מזהה את המשאב הזה כפריט. ערך: המחרוזת הקבועה `"chromewebstore#item"`.
`publicKey`	מחרוזת	המפתח הציבורי של הפריט הזה.
`uploadState`	מחרוזת	סטטוס הפעולה. הערכים הקבילים הם: "`FAILURE`" "`IN_PROGRESS`" "`NOT_FOUND`" "`SUCCESS`"

הורדה

מקבל פריט מחנות האינטרנט של Chrome. צריך לציין projection="DRAFT" (תלוי אותיות רישיות) כפרמטר של כתובת URL.

בקשה

בקשת HTTP

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

פרמטרים

שם הפרמטר	ערך	התיאור
פרמטרים של נתיב
`itemId`	מחרוזת	מזהה ייחודי שמייצג את אפליקציית Chrome, את התוסף ל-Chrome או את עיצוב Chrome.
פרמטרים אופציונליים של שאילתה
`projection`	מחרוזת	קובעת איזו קבוצת משנה של פרטי הפריט להחזיר. הערכים הקבילים הם: '`DRAFT`': החזרת מידע שחולץ מהטיוטה הנוכחית. '`PUBLISHED`': החזרת מידע שחולץ מטיוטת הפריט שפורסמה. לתשומת ליבכם: בשלב הזה יש תמיכה רק ב-`"DRAFT"`.

הרשאות

בקשה זו מחייבת הרשאה עם ההיקף הבא.

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

כתובת ה-URL שצוינה למעלה משמשת כפרמטר של ההיקף כשיוצרים אסימון גישה. לפרטים נוספים על הרשאה ואימות של ממשקי API, ניתן לעיין בתיעוד של OAuth 2.0.

תוכן הבקשה

אין לציין גוף בקשה בשיטה הזו.

תשובה

אם הפעולה בוצעה ללא שגיאות, השיטה מחזירה משאב פריטים בגוף התגובה.

הוספה

הוספת פריט חדש.

שיטה זו תומכת ב-URI להעלאה ומקבלת מדיה שהועלתה.

בקשה

בקשת HTTP

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

פרמטרים

שם הפרמטר	ערך	התיאור
פרמטרים נדרשים של שאילתה
`uploadType`	מחרוזת	הסוג של בקשת ההעלאה ל-URI /upload. הערך הקביל היחיד הוא `media`: העלאה פשוטה של נתוני המדיה.
פרמטרים אופציונליים של שאילתה
`publisherEmail`	מחרוזת	האימייל של בעל התוכן הדיגיטלי שבבעלותו הפריטים. ברירת המחדל היא כתובת האימייל של המתקשר.

הרשאות

בקשה זו מחייבת הרשאה עם ההיקף הבא.

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

תוכן הבקשה

אין לציין גוף בקשה בשיטה הזו.

תשובה

אם הפעולה בוצעה ללא שגיאות, השיטה מחזירה משאב פריטים בגוף התגובה.

פרסום

מפרסם פריט. צריך לספק את הפרמטר publishTarget בכתובת URL (תלוי אותיות רישיות): publishTarget = "trustedtesters" או "publishTarget = "default".

בקשה

בקשת 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`	יעד הפרסום של פעולת הפרסום הזו. הדבר זהה לשימוש ב-publishTarget כפרמטר של שאילתה בכתובת URL. ערך המחרוזת יכול להיות target="trustedtesters" או target="default". אם לא סופק ערך ברירת מחדל, ערך ברירת המחדל הוא target="default". מומלץ להשתמש בפרמטר השאילתה של כתובת ה-URL כדי לציין את הערך.

הרשאות

בקשה זו מחייבת הרשאה עם ההיקף הבא.

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

תשובה

אם הפעולה מצליחה, השיטה הזו מחזירה גוף תגובה במבנה הבא:

{
  "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`	הסוג של בקשת ההעלאה ל-URI /upload. הערכים הקבילים הם: `media` – העלאה פשוטה. יש להעלות את המדיה בלבד, ללא מטא-נתונים.

תוכן הבקשה

בגוף הבקשה, מציינים משאב פריטים בתור המטא-נתונים.

הרשאות

בקשה זו מחייבת הרשאה עם ההיקף הבא.

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

תשובה

אם הפעולה בוצעה ללא שגיאות, השיטה מחזירה משאב פריטים בגוף התגובה.