Chrome वेब स्टोर API संदर्भ

इस संदर्भ में, Chrome Web Store पब्लिश API के लिए उपलब्ध तरीके और संसाधन के बारे में बताया गया है. हर तरह के संसाधन में एक या उससे ज़्यादा डेटा को दिखाया जाता है और एक या उससे ज़्यादा तरीके होते हैं. लागू करने से जुड़ी जानकारी के लिए, Chrome Web Store Publish API का इस्तेमाल करना देखें.

आइटम

आइटम से जुड़े संसाधन की जानकारी के लिए, संसाधन दिखाना देखें. यूआरआई, https://www.googleapis.com से जुड़े हों, जब तक कि अलग से न बताया गया हो

कार्रवाई एचटीटीपी अनुरोध ब्यौरा
पाएं GET
/chromewebstore/v1.1/items/itemId
Chrome वेब स्टोर का आइटम मिलता है. यूआरएल में projection="DRAFT" डालें (केस संवेदनशील).
डालें 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" (केस-सेंसिटिव) को यूआरएल पैरामीटर के तौर पर दें.

अनुरोध

एचटीटीपी अनुरोध

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

ऐक्सेस टोकन जनरेट करते समय, ऊपर दिए गए यूआरएल का इस्तेमाल स्कोप पैरामीटर के तौर पर किया जाता है. एपीआई की अनुमति और पुष्टि करने के बारे में ज़्यादा जानकारी के लिए, OAuth 2.0 दस्तावेज़ देखें.

अनुरोध का मुख्य भाग

इस तरीके का इस्तेमाल करके, अनुरोध का मुख्य हिस्सा न दें.

जवाब

अगर सफलता मिलती है, तो यह तरीका रिस्पॉन्स के मुख्य भाग में आइटम रिसॉर्स दिखाता है.

शामिल करें

नया आइटम डालता है.

यह तरीका, अपलोड यूआरआई के साथ काम करता है और अपलोड किए गए मीडिया को स्वीकार करता है.

अनुरोध

एचटीटीपी अनुरोध

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

पैरामीटर

पैरामीटर का नामवैल्यूब्यौरा
ज़रूरी क्वेरी पैरामीटर
uploadTypeस्ट्रिंग/upload यूआरआई पर अपलोड करने के अनुरोध का टाइप. सिर्फ़ media की वैल्यू ही स्वीकार की जाती है: मीडिया डेटा को आसानी से अपलोड किया जा सकता है.
वैकल्पिक क्वेरी पैरामीटर
publisherEmailस्ट्रिंगउस पब्लिशर का ईमेल पता जिसके पास आइटम का मालिकाना हक है. डिफ़ॉल्ट रूप से, कॉलर का ईमेल पता होता है.

अनुमति दें

इस अनुरोध के लिए, नीचे बताए गए स्कोप से अनुमति देना ज़रूरी है.

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

ऐक्सेस टोकन जनरेट करते समय, ऊपर दिए गए यूआरएल का इस्तेमाल स्कोप पैरामीटर के तौर पर किया जाता है. एपीआई की अनुमति और पुष्टि करने के बारे में ज़्यादा जानकारी के लिए, OAuth 2.0 दस्तावेज़ देखें.

अनुरोध का मुख्य भाग

इस तरीके का इस्तेमाल करके, अनुरोध का मुख्य हिस्सा न दें.

जवाब

अगर सफलता मिलती है, तो यह तरीका रिस्पॉन्स के मुख्य भाग में आइटम रिसॉर्स दिखाता है.

पब्लिश करें

कोई आइटम पब्लिश करता है. यूआरएल में तय किया गया publishTarget डालें (केस-सेंसिटिव): publishTarget = "भरोसेमंदटेस्टर" या publishTarget = "डिफ़ॉल्ट".

अनुरोध

एचटीटीपी अनुरोध

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

पैरामीटर

पैरामीटर का नामवैल्यूब्यौरा
पाथ पैरामीटर
itemIdस्ट्रिंगपब्लिश करने के लिए आइटम का आईडी.
वैकल्पिक क्वेरी पैरामीटर
publishTargetस्ट्रिंगयूआरएल में तय किया गया publishTarget डालें (केस-सेंसिटिव): publishTarget="trustedTesters" या publishTarget="default". डिफ़ॉल्ट वैल्यू publishTarget="default" होती है.

अनुरोध का मुख्य भाग

अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर के साथ डेटा दिया जा सकता है. हालांकि, ऐसा करना ज़रूरी नहीं है:

JSON

{
  "target": string
}
प्रॉपर्टी का नामवैल्यूब्यौरा
targetstringइस पब्लिश करने से जुड़ी कार्रवाई का टारगेट, पब्लिश करें. यह यूआरएल क्वेरी पैरामीटर के तौर पर publishTarget का इस्तेमाल करने जैसा ही है. स्ट्रिंग की वैल्यू target="TrustTesters" या target="default" हो सकती है. अगर कोई डिफ़ॉल्ट वैल्यू नहीं दी जाती है, तो target="default" होता है. वैल्यू के बारे में बताने के लिए, यूआरएल क्वेरी पैरामीटर का इस्तेमाल करने का सुझाव दिया जाता है.

अनुमति दें

इस अनुरोध के लिए, नीचे बताए गए स्कोप से अनुमति देना ज़रूरी है.

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

ऐक्सेस टोकन जनरेट करते समय, ऊपर दिए गए यूआरएल का इस्तेमाल स्कोप पैरामीटर के तौर पर किया जाता है. एपीआई की अनुमति और पुष्टि करने के बारे में ज़्यादा जानकारी के लिए, 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ऊपर दिए गए स्टेटस कोड की पूरी जानकारी, जिसे कोई भी व्यक्ति आसानी से समझ सकता है.

अपडेट करें

किसी मौजूदा आइटम को अपडेट करता है.

यह तरीका, अपलोड यूआरआई के साथ काम करता है और अपलोड किए गए मीडिया को स्वीकार करता है.

अनुरोध

एचटीटीपी अनुरोध

यह तरीका दो अलग-अलग यूआरआई के ज़रिए मीडिया अपलोड करने की सुविधा देता है.

  • मीडिया अपलोड के अनुरोधों के लिए यूआरआई अपलोड करें:

    PUT https://www.googleapis.com/upload/chromewebstore/v1.1/items/itemId
    
  • सिर्फ़ मेटाडेटा वाले अनुरोधों के लिए, मेटाडेटा यूआरआई:

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

पैरामीटर

पैरामीटर का नामवैल्यूब्यौरा
पाथ पैरामीटर
itemIdstringअपलोड किए जाने वाले आइटम का आईडी.
ज़रूरी क्वेरी पैरामीटर
uploadTypestring/upload यूआरआई पर अपलोड करने के अनुरोध का टाइप. स्वीकार किए जाने वाले वैल्यू हैं: media - आसान अपलोड. बिना किसी मेटाडेटा के सिर्फ़ मीडिया अपलोड करें.

अनुरोध का मुख्य भाग

अनुरोध के मुख्य हिस्से में, मेटाडेटा के तौर पर आइटम के संसाधन उपलब्ध कराएं.

अनुमति दें

इस अनुरोध के लिए, नीचे बताए गए स्कोप से अनुमति देना ज़रूरी है.

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

ऐक्सेस टोकन जनरेट करते समय, ऊपर दिए गए यूआरएल का इस्तेमाल स्कोप पैरामीटर के तौर पर किया जाता है. एपीआई की अनुमति और पुष्टि करने के बारे में ज़्यादा जानकारी के लिए, OAuth 2.0 दस्तावेज़ देखें.

जवाब

अगर सफलता मिलती है, तो यह तरीका रिस्पॉन्स के मुख्य भाग में आइटम रिसॉर्स दिखाता है.