इस दस्तावेज़ में, CSS API का इस्तेमाल करने के कुछ सबसे सही तरीकों के बारे में बताया गया है. इस पेज पर दी गई सलाह का पालन करना, एपीआई का इस्तेमाल करने के लिए ज़रूरी नहीं है. हालांकि, इससे आपको एपीआई के इस्तेमाल के बारे में कुछ जानकारी मिल सकती है.
अपना एनवायरमेंट सेट अप करना
डेवलपमेंट एनवायरमेंट सेट अप करने के लिए, क्विकस्टार्ट दस्तावेज़ में दिया गया तरीका अपनाएं.
- Google Cloud Console पर, उपयोगकर्ता और अनुमतियों की JSON फ़ाइल जनरेट करना
- Google Cloud Console में CSS API चालू करना
- उस उपयोगकर्ता को अपने सीएसएस खाते (सीएसएस ग्रुप या सीएसएस डोमेन) में एडमिन की अनुमतियों के साथ जोड़ें
- पुष्टि करें कि आपने सही OAuth स्कोप का इस्तेमाल किया है:
https://www.googleapis.com/auth/content
क्लाइंट लाइब्रेरी अब ज़्यादातर प्रोग्रामिंग भाषाओं के लिए स्टैंडर्ड रिपॉज़िटरी में उपलब्ध हैं. इनकी सूची देखने के लिए, हमारे क्लाइंट लाइब्रेरी पेज पर जाएं.
सही आईडी का इस्तेमाल करना
सही एपीआई एंडपॉइंट के साथ सही आईडी इस्तेमाल करें:
- CSS API (
css.googleapis.com
): सीएसएस प्रॉडक्ट (जैसे,accounts/{cssDomainId}/cssProductInputs:insert
). - Merchant API (
merchantapi.googleapis.com
): Merchant API का इस्तेमाल, कारोबारी या कंपनी के स्टैंडर्ड प्रॉडक्ट के लिए करें.
इनकी जगह बदलने से गड़बड़ियां होंगी. ज़्यादा जानकारी के लिए, CSS API की खास जानकारी देखें.
शुरू करने के लिए सबसे सही तरीके
हमारा सुझाव है कि आप इन तरीकों से जांच करें:
ListChildAccounts
ListChildAccounts सिर्फ़ पढ़ने के लिए उपलब्ध कॉल है. यह आपके सभी सीएसएस डोमेन (अगर किसी सीएसएस ग्रुप के लिए कॉल किया गया है) या आपके कारोबारियों या कंपनियों (अगर किसी सीएसएस डोमेन के लिए कॉल किया गया है) को लिस्ट करता है. इसलिए, यह जांच करने का एक अच्छा तरीका है कि सब कुछ सही तरीके से सेट अप किया गया है या नहीं.
किसी प्रॉडक्ट को जोड़ना/सूचीबद्ध करना/अपडेट करना/मिटाना
जब आपको पता चल जाए कि एपीआई काम कर रहा है, तब कोई प्रॉडक्ट जोड़ें. पक्का करें कि आपने ऐसा raw_provided_id
इस्तेमाल किया हो जो आपको याद रहे.
- InsertCssProductInput का इस्तेमाल करके, टेस्ट प्रॉडक्ट डालें. अगर आपको यह जानने में मदद चाहिए कि कौनसे एट्रिब्यूट भेजने हैं, तो हमारे पास सैंपल कोड है.
- ListCssProducts का इस्तेमाल करके, अपने सभी प्रॉडक्ट लिस्ट करें. प्रॉडक्ट डालने के बाद, उसे दिखने में कुछ समय लगता है. इसलिए, अगर आपको वह नहीं दिखता है, तो कुछ सेकंड बाद फिर से कोशिश करें.
- अपने
cssproductinput.name
का इस्तेमाल करके, UpdateCssProductInput का इस्तेमाल करके किसी एक प्रॉडक्ट को अपडेट करें. आपको सिर्फ़ वे एट्रिब्यूट भेजने होंगे जिन्हें अपडेट करना है. सैंपल कोड यहां देखें. - DeleteCssProductInput का इस्तेमाल करके, टेस्ट प्रॉडक्ट मिटाएं.
आपको
raw_provided_id
का इस्तेमाल करना होगा.
परफ़ॉर्मेंस को बेहतर बनाने के लिए, Async का इस्तेमाल करना
CSS API को पैरलल कॉल के लिए डिज़ाइन किया गया है. आपको पता चलेगा कि एक बार में किए जाने वाले ऑपरेशन की परफ़ॉर्मेंस धीमी हो सकती है. हालांकि, एक ही ऑपरेशन को कई बार एक साथ कॉल करने पर, परफ़ॉर्मेंस काफ़ी तेज़ हो जाएगी. इस सुविधा का सबसे सही तरीके से इस्तेमाल करने के लिए, अपनी प्रोग्रामिंग भाषा की एसिंक सुविधा का इस्तेमाल करें.
कुछ प्रोग्रामिंग भाषाओं के उदाहरण:
- Java के लिए, insertCssProductInputCallable().futureCall() का इस्तेमाल करें
- Python के लिए, CssProductInputsServiceAsyncClient का इस्तेमाल करें
- C# के लिए, InsertCssProductInputAsync का इस्तेमाल करें
एक साथ कई प्रॉडक्ट डालने के लिए, अपनी प्रोग्रामिंग भाषा की एसिंक सुविधा ढूंढें और उसका इस्तेमाल करें. आपको हमारे सिस्टम पर ज़्यादा लोड पड़ने की चिंता करने की ज़रूरत नहीं है. इसके लिए, कोटा सीमाएं तय की गई हैं.
ज़्यादा जानकारी के लिए, हमारे परफ़ॉर्मेंस पेज पर जाएं.
अपने पेलोड की पुष्टि करना
सामान्य गड़बड़ियों से बचने के लिए, पुष्टि करें कि आपके JSON पेलोड सही फ़ॉर्मैट में हैं:
- आधिकारिक दस्तावेज़ देखें: फ़ील्ड की परिभाषाओं, इनम, डेटा टाइप, और पेलोड स्ट्रक्चर के लिए, हमेशा CSS API के नए रेफ़रंस देखें.
- पे लोड के सैंपल की समीक्षा करें: अपने पे लोड की तुलना, उपलब्ध कराए गए कोड के सैंपल से करें. इससे आपको अंतर का पता चलेगा.
- डेटा टाइप: पक्का करें कि आपने दस्तावेज़ में बताए गए सही डेटा टाइप (जैसे, स्ट्रिंग, ऑब्जेक्ट, ऐरे) का इस्तेमाल किया हो.
- धीरे-धीरे टेस्ट करें: बुनियादी कनेक्टिविटी की पुष्टि करने के लिए, कम से कम मान्य पेलोड से शुरुआत करें और धीरे-धीरे ज़्यादा एट्रिब्यूट जोड़ें.
किसी प्रॉडक्ट को अपडेट करना
किसी प्रॉडक्ट को अपलोड करने के बाद, वह हमारे सिस्टम में तब तक मौजूद रहेगा, जब तक उसे अपडेट, मिटाया या उसकी समयसीमा खत्म नहीं हो जाती.
- आपने जिस
raw_provided_id
का इस्तेमाल करके शुरुआत में अनुरोध भेजा था उसी का इस्तेमाल करके,InsertCssProductInput
फिर से अनुरोध भेजकर पूरे प्रॉडक्ट को अपडेट किया जा सकता है. फ़िलहाल, आपको पूरा प्रॉडक्ट डेटा भेजना होगा. भले ही, सिर्फ़ कुछ एट्रिब्यूट (जैसे, कीमत/खरीदारी के लिए उपलब्धता) में बदलाव हुआ हो. - PATCH तरीके
UpdateCssProductInput
का इस्तेमाल करके, किसी प्रॉडक्ट के कुछ हिस्सों को अपडेट किया जा सकता है. इसके लिए, प्रॉडक्ट का नाम और JSON फ़ॉर्मैट में वह डेटा दें जिसे आपको प्रॉडक्ट के लिए अपडेट करना है.InsertCssProductInput
के उलट,UpdateCssProductInput
में सिर्फ़ उन फ़ील्ड की जानकारी देनी होती है जिनमें आपको बदलाव करना है.InsertCssProductInput
में, लागू होने वाले सभी फ़ील्ड की जानकारी देना ज़रूरी होता है. - किसी प्रॉडक्ट को मिटाने के लिए, उसी
DeleteCssProductInput
के साथDeleteCssProductInput
को कॉल करें.raw_provided_id
- प्रॉडक्ट की जानकारी को आखिरी बार अपडेट करने के करीब एक महीने बाद, प्रॉडक्ट अपने-आप हट जाते हैं.
लगातार ऑपरेशन मोड
लगातार ऑपरेशन मोड ऐसा दिख सकता है:
- अपने इंटरनल आईडी को
raw_provided_id
के तौर पर इस्तेमाल करें. - सभी प्रॉडक्ट को नियमित तौर पर फिर से अपलोड करें. ऐसा हर हफ़्ते किया जा सकता है. इससे यह पक्का होगा कि ऐक्टिव प्रॉडक्ट की समयसीमा खत्म न हो.
- कारोबारियों या कंपनियों से अपडेट किया गया डेटा मिलने के तुरंत बाद, अलग-अलग प्रॉडक्ट की जानकारी अपडेट करें.
- अगर बदलावों पर तुरंत प्रतिक्रिया नहीं दी जा सकती, तो बदले गए सभी प्रॉडक्ट को बार-बार (शायद हर घंटे) ढूंढें और सिर्फ़ उन प्रॉडक्ट को फिर से अपलोड करें.
- जो प्रॉडक्ट अब उपलब्ध नहीं हैं उनके लिए, मिटाने वाले कॉल का इस्तेमाल किया जा सकता है. इसके अलावा, उपलब्ध ऑफ़र की संख्या को 0 पर सेट किया जा सकता है.
- हमें ऐसे प्रॉडक्ट बार-बार न भेजें जिनमें कोई बदलाव नहीं हुआ है. इन कॉल को आपके एपीआई कोटे में गिना जाएगा. हर हफ़्ते रीफ़्रेश करना काफ़ी है.
हेडलाइन ऑफ़र चुनने की सुविधा
यह ज़रूरी नहीं है कि हेडलाइन ऑफ़र, आपकी साइट पर सबसे ऊपर दिखने वाला या सबसे सस्ता ऑफ़र हो. हालांकि, यह ज़रूरी है कि इसे प्रमुखता से दिखाया जाए. इसका इस्तेमाल उन मामलों में किया जा सकता है जहां आपका सबसे अच्छा ऑफ़र तेज़ी से बदल रहा है: यहां आपके पास कोई ऐसा दूसरा ऑफ़र चुनने का विकल्प होता है जो ज़्यादा स्थिर हो.
इस दस्तावेज़ को समय-समय पर फिर से देखें
हमें इस एपीआई को बेहतर बनाने के बारे में सुझाव मिले हैं. हम इनमें से कुछ सुझावों को लागू करने पर काम कर रहे हैं. जब हमारे पास नई सुविधाएं उपलब्ध होंगी, तब हम इस पेज को अपडेट करेंगे. इन सुविधाओं की मदद से, CSS API का इस्तेमाल करना आसान हो जाएगा.