Merchant API में,
Homepage
के लिए एक अलग संसाधन जोड़ा गया है. इस संसाधन की मदद से, होम पेज पर किए गए दावे को मैनेज करने के नए तरीके मिलते हैं. साथ ही, यह Content API for Shopping की क्लासिक सुविधाओं के अलावा भी कई सुविधाएं उपलब्ध कराता है.
ऑनलाइन स्टोर के लिए सुविधाएं ऐक्सेस करने की प्रोसेस दो चरणों में पूरी होती है: पहले मालिकाना हक की पुष्टि करना और फिर अपने खाते के लिए साइट पर दावा करना. आखिरी चरण पूरा करने के लिए,
इस्तेमाल करें
accounts.homepage.claim.
मुख्य अंतर
Content API for Shopping की तुलना में, Merchant API में होम पेज से जुड़े कई बदलाव किए गए हैं:
- अलग संसाधन: 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 | 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 में, संसाधन की पहचान करने की प्रोसेस को आसान बनाया गया है.
| आइडेंटिफ़ायर का ब्यौरा | Content API for Shopping | 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 संसाधन का इस्तेमाल किया जाता है.
| Content API for Shopping | 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) को अपडेट किया जा रहा है. |