مرجع واجهة برمجة التطبيقات في "سوق Chrome الإلكتروني"

يصف هذا المرجع الطرق وتمثيل الموارد المتاحة لواجهة برمجة التطبيقات Publish API في سوق Chrome الإلكتروني. يحتوي كل نوع مورد على تمثيل بيانات واحد أو أكثر وطريقة أو أكثر. راجع استخدام واجهة برمجة تطبيقات النشر في سوق Chrome الإلكتروني للحصول على تفاصيل التنفيذ.

السلع

لمعرفة تفاصيل مورد العناصر، يُرجى الاطّلاع على تمثيل الموارد. ترتبط معرّفات الموارد المنتظمة (URI) بالموقع https://www.googleapis.com، ما لم يُذكر خلاف ذلك.

العملية طلب HTTP الوصف
الحصول على 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[]قائمةتفصيل حالة العملية التي يمكن لشخص عادي قراءتها، باللغة الإنجليزية فقط تظهر رسائل الخطأ نفسها عند تحميل تطبيقك إلى "سوق 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 أعلاه كمعلَمة النطاق عند إنشاء رمز دخول. لمزيد من التفاصيل حول تفويض واجهة برمجة التطبيقات والمصادقة، يمكنك الرجوع إلى وثائق 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

يتم استخدام عنوان URL أعلاه كمعلَمة النطاق عند إنشاء رمز دخول. لمزيد من التفاصيل حول تفويض واجهة برمجة التطبيقات والمصادقة، يمكنك الرجوع إلى وثائق OAuth 2.0.

نص الطلب

لا توفر نص طلب بهذه الطريقة.

الإجابة

في حال نجاحها، ستعرض هذه الطريقة مورد العناصر في نص الاستجابة.

نشر

نشر عنصر. قم بتقديم 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
}
اسم الموقعالقيمةالوصف
targetstringهدف النشر لعملية النشر هذه ويشبه هذا الإجراء استخدام publishTarget كمَعلمة طلب بحث عن عنوان URL. ويمكن أن تكون قيمة السلسلة target="trustedTesters" أو target="default". وتكون القيمة التلقائية في حال عدم تقديم أيّ قيمة هي target="default". في الاستخدام المقترَح استخدام مَعلمة طلب البحث عن عنوان URL لتحديد القيمة.

التفويض

يتطلب هذا الطلب تفويضًا بالنطاق التالي.

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

يتم استخدام عنوان URL أعلاه كمعلَمة النطاق عند إنشاء رمز دخول. لمزيد من التفاصيل حول تفويض واجهة برمجة التطبيقات والمصادقة، يمكنك الرجوع إلى وثائق OAuth 2.0.

الإجابة

إذا نجحت هذه الطريقة، ستعرض نص استجابة بالبنية التالية:

{
  "kind": "chromewebstore#item",
  "item_id": string,
  "status": [
    string
  ],
  "statusDetail": [
    string
  ]
}
اسم الموقعالقيمةالوصف
kindstringقيمة السلسلة الثابتة هي "chromewebstore#item" دائمًا.
item_idstringرقم تعريف هذه السلعة
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رقم تعريف العنصر المطلوب تحميله.
مَعلمات طلب البحث المطلوبة
uploadTypestringنوع طلب التحميل إلى معرّف الموارد المنتظم (URI) /upload. القيم المقبولة هي: media - تحميل بسيط. تحميل الوسائط فقط، بدون أي بيانات وصفية

نص الطلب

في نص الطلب، أدخِل مورد العناصر باعتباره بيانات وصفية.

التفويض

يتطلب هذا الطلب تفويضًا بالنطاق التالي.

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

يتم استخدام عنوان URL أعلاه كمعلَمة النطاق عند إنشاء رمز دخول. لمزيد من التفاصيل حول تفويض واجهة برمجة التطبيقات والمصادقة، يمكنك الرجوع إلى وثائق OAuth 2.0.

الإجابة

في حال نجاحها، ستعرض هذه الطريقة مورد العناصر في نص الاستجابة.