Merchant API में एक खास Homepage रिसॉर्स उपलब्ध है. इस संसाधन में, होम पेज पर किए गए दावे को मैनेज करने के नए तरीके बताए गए हैं. साथ ही, इसमें Content API for Shopping के क्लासिक वर्शन से ज़्यादा सुविधाएं उपलब्ध हैं.
अपने ऑनलाइन स्टोर के लिए सुविधाओं को ऐक्सेस करने की प्रोसेस दो चरणों में पूरी होती है: पहले मालिकाना हक की पुष्टि करना और फिर साइट पर अपने खाते के लिए दावा करना. आखिरी चरण पूरा करने के लिए, accounts.homepage.claim का इस्तेमाल करें.
मुख्य अंतर
Merchant API, Content API for Shopping की तुलना में होम पेज से जुड़े कई बदलाव करता है:
- खास संसाधन: Merchant API, होम पेज से जुड़ी सभी कार्रवाइयों के लिए, अलग
Homepageसंसाधन (accounts.homepage) उपलब्ध कराता है. (Content API for Shopping में, दावा करने की कार्रवाई करने के लिएaccounts.claimwebsiteका इस्तेमाल किया जाता था. होम पेज का यूआरएलwebsite_url,Accountसंसाधन का हिस्सा था. साथ ही, दावे की स्थितिwebsite_claimed,AccountStatusसंसाधन का हिस्सा थी.) - ज़्यादा जानकारी वाले तरीके: Merchant API, इन कामों के लिए खास तरीके उपलब्ध कराता है:
- होम पेज की जानकारी वापस पाएं:
accounts.homepage.getHomepage - होम पेज का यूआरआई अपडेट करें:
accounts.homepage.updateHomepage - होम पेज पर दावा करें:
accounts.homepage.claim - होम पेज का मालिकाना हक छोड़ना:
accounts.homepage.unclaimContent API for Shopping ने दावा करने की कार्रवाई के लिएaccounts.claimwebsiteका इस्तेमाल किया. साथ ही, यूआरएल सेट करने के लिएaccounts.updateका इस्तेमाल किया. इससे, खाली यूआरएल सेट करके मालिकाना हक छोड़ा जा सकता है. इसके अलावा, यूआरएल और दावे की स्थिति को वापस पाने के लिए,accounts.get/accountstatuses.getका इस्तेमाल किया.
- होम पेज की जानकारी वापस पाएं:
- एक जगह पर मौजूद जानकारी: Merchant API
Homepageसंसाधन में,uri(होम पेज का यूआरएल) औरclaimedस्टेटस, दोनों की जानकारी सीधे तौर पर मौजूद होती है.Homepageसंसाधन पर काम करने वाले सभी तरीके, इस संसाधन को दिखाते हैं. इससे मौजूदा स्थिति के बारे में तुरंत जानकारी मिलती है. Content API for Shopping में,accounts.claimwebsiteअपडेट की गई स्थिति नहीं दिखाई गई; इसके लिए अलग-अलग कॉल की ज़रूरत पड़ी. - साफ़ तौर पर अस्वीकार करना: Content API for Shopping में, आम तौर पर
Account.website_urlको खाली स्ट्रिंग पर अपडेट करके अस्वीकार किया जाता था. Merchant API, इसके लिए एक खासhomepage.unclaimतरीका उपलब्ध कराता है. - दावे को बदलना: दोनों एपीआई, दावा करने की प्रोसेस के दौरान
overwriteपैरामीटर का इस्तेमाल करते हैं. इससे, किसी दूसरे खाते से किए गए दावे को बदला जा सकता है. हालांकि, इसके लिए मालिकाना हक की पुष्टि होना ज़रूरी है.
अनुरोध
Merchant API, होम पेज के अलग-अलग पहलुओं को मैनेज करने के लिए, अलग-अलग RESTful एंडपॉइंट का इस्तेमाल करता है.
| अनुरोध का ब्यौरा | Content API for Shopping for Shopping | Merchant API |
|---|---|---|
| होम पेज की जानकारी पाना | accounts.get (Account.website_url को पढ़ने के लिए), accountstatuses.get (AccountStatus.website_claimed को पढ़ने के लिए) |
GET /accounts/v1/accounts/{account}/homepage |
| होमपेज का यूआरआई अपडेट करना | accounts.update (Account.website_url सेटिंग) |
PATCH /accounts/v1/accounts/{account}/homepage |
| होम पेज पर दावा करना या उसकी फिर से पुष्टि करना | POST /content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite (accounts.update का इस्तेमाल करके सेट किए गए Account.website_url पर कार्रवाई की गई) |
POST /accounts/v1/accounts/{account}/homepage:claim |
| होम पेज को अस्वीकार करना | accounts.update (Account.website_url को खाली स्ट्रिंग पर सेट करना) |
POST /accounts/v1/accounts/{account}/homepage:unclaim |
आइडेंटिफ़ायर
Merchant API में संसाधन की पहचान करने की प्रोसेस को आसान बना दिया गया है.
| आइडेंटिफ़ायर के बारे में जानकारी | Shopping के लिए Content API | Merchant API |
|---|---|---|
| संसाधन को ऐक्सेस करने के लिए खाता आइडेंटिफ़ायर | पाथ में merchantId (ऐडवांस खाता) और accountId (उप-खाता) |
account (name फ़ील्ड का हिस्सा, जैसे कि accounts/{account_id}/homepage) |
| होम पेज के संसाधन का आइडेंटिफ़ायर | लागू नहीं (Account संसाधन के लिए डिफ़ॉल्ट रूप से लागू होता है) |
name: accounts/{account_id}/homepage (Homepage सब-रिसोर्स की पहचान करता है) |
तरीके
Content API for Shopping का accounts.claimwebsite तरीका, दावा करने की कार्रवाई पर फ़ोकस करता था. अब यह Merchant API के Homepage संसाधन में, ज़्यादा फ़ंक्शन के सेट का हिस्सा है.
| Content API for Shopping का तरीका | Merchant API का तरीका | उपलब्धता और नोट |
|---|---|---|
accounts.claimwebsite |
accounts.homepage.claim |
यह सीधे तौर पर वेबसाइट पर किए गए दावे की पुष्टि करता है या उसकी फिर से पुष्टि करता है. यह homepage.update का इस्तेमाल करके पहले से सेट किए गए uri पर काम करता है. इसमें overwrite पैरामीटर शामिल है. यह फ़ंक्शन, Homepage संसाधन को उसकी मौजूदा uri और claimed स्थिति के साथ दिखाता है. |
accounts.get (Account.website_url को पढ़ने के लिए), accountstatuses.get (AccountStatus.website_claimed को पढ़ने के लिए) |
accounts.homepage.getHomepage |
एक ही कॉल में, मौजूदा होम पेज uri और उसके claimed स्टेटस को वापस पाने का नया तरीका. |
accounts.update (Account.website_url सेट करने के लिए) |
accounts.homepage.updateHomepage |
होम पेज सेट करने या बदलने का नया तरीका uri. |
accounts.update (Account.website_url को खाली स्ट्रिंग पर सेट किया गया है, ताकि दावा हटाया जा सके) |
accounts.homepage.unclaim |
होम पेज से दावा हटाने का नया तरीका. |
फ़ील्ड में किए गए बदलावों की ज़्यादा जानकारी
होम पेज पर मौजूद जानकारी को ऐक्सेस करने और उसे व्यवस्थित करने के तरीके में काफ़ी बदलाव हुआ है. अब यह जानकारी, Merchant API में मौजूद Homepage रिसॉर्स के ज़रिए ऐक्सेस की जा सकती है.
| Shopping के लिए Content API | Merchant API | ब्यौरा |
|---|---|---|
merchantId (accounts.claimwebsite के लिए पाथ पैरामीटर) |
name (Homepage तरीकों के लिए पाथ पैरामीटर, फ़ॉर्मैट: accounts/{account}/homepage) |
Merchant API में मौजूद name स्ट्रिंग का account हिस्सा, Content API for Shopping में मौजूद accountId से मेल खाता है. |
accountId (accounts.claimwebsite के लिए पाथ पैरामीटर) |
name (Homepage तरीकों के लिए पाथ पैरामीटर, फ़ॉर्मैट: accounts/{account}/homepage) |
यह उस खाते का आइडेंटिफ़ायर है जिसके होम पेज को मैनेज किया जा रहा है. |
overwrite (ContentAccountsClaimwebsiteRequest बॉडी में बूलियन और AccountsCustomBatchRequestEntry) |
ClaimHomepageRequest.overwrite (homepage.claim अनुरोध के मुख्य हिस्से में बूलियन) |
ज़रूरी नहीं. अगर true, वेबसाइट पर दावा करने की कोशिश करता है, तो हो सकता है कि वह किसी दूसरे खाते से किए गए मौजूदा दावे को हटा दे. ऐसा तब होगा, जब अनुरोध करने वाला खाता मालिकाना हक की पुष्टि कर पाएगा. |
Account.website_url (Account संसाधन में मौजूद फ़ील्ड, accounts.update का इस्तेमाल करके सेट किया गया, accounts.get का इस्तेमाल करके पढ़ा गया) |
Homepage.uri (Homepage संसाधन में मौजूद फ़ील्ड) |
स्टोर के होम पेज का यूआरआई (यूआरएल). Merchant API में, यह Homepage संसाधन के अंदर मौजूद एक फ़ील्ड है. इसे accounts.homepage.updateHomepage का इस्तेमाल करके सेट किया जाता है और यह सभी Homepage तरीकों से मिलता है. |
AccountStatus.website_claimed (AccountStatus संसाधन में मौजूद फ़ील्ड, accountstatuses.get का इस्तेमाल करके पढ़ा गया) |
Homepage.claimed (Homepage संसाधन में output_only बूलियन फ़ील्ड) |
इससे पता चलता है कि uri पर दावा किया गया है और उसकी पुष्टि हो चुकी है. यह स्टेटस, सीधे तौर पर Homepage संसाधन में उपलब्ध होता है. यह संसाधन, Merchant API से जुड़े सभी तरीकों से मिलता है. |
| लागू नहीं | UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage अनुरोध के मुख्य हिस्से का पैरामीटर) |
homepage.update के लिए फ़ील्ड मास्क का इस्तेमाल करना ज़रूरी नहीं है. इससे यह तय किया जा सकता है कि कौनसे फ़ील्ड (जैसे, Homepage संसाधन के uri) को अपडेट किया जा रहा है. |