क्षेत्रों को मैनेज करने की सुविधा माइग्रेट करना

इस गाइड में, इंटिग्रेशन को Shopping के लिए Content API में मौजूद RegionsService से, Accounts सब-एपीआई में मौजूद RegionsService पर माइग्रेट करने का तरीका बताया गया है.

क्षेत्रों की सेवा की मदद से, अपनी पसंद के मुताबिक भौगोलिक इलाके तय किए जा सकते हैं. इनका इस्तेमाल, इलाके के हिसाब से कीमत तय करने और शिपिंग से जुड़े नियमों को बदलने जैसे कामों के लिए किया जा सकता है. RegionalInventory और ShippingSettings जैसी सेवाओं के साथ, क्षेत्रों का इस्तेमाल किया जा सकता है.

मुख्य अंतर

  • एपीआई का स्ट्रक्चर: क्षेत्रों की सेवा अब Merchant API में मौजूद Accounts सब-एपीआई का हिस्सा है. उदाहरण के लिए, merchantapi.googleapis.com/accounts/v1/....
  • संसाधन के नाम: Merchant API, Get, Update, और Delete कार्रवाइयों के लिए, यूआरएल पाथ में अलग-अलग merchant_id और region_id पैरामीटर के बजाय, संसाधन के नामों (accounts/{account}/regions/{region}) का इस्तेमाल करता है.
  • एआईपी के मुताबिक होना: Merchant API के तरीके, स्टैंडर्ड एपीआई को बेहतर बनाने के प्रस्ताव के पैटर्न के मुताबिक होते हैं. जैसे, parent का इस्तेमाल List/Create के लिए, name का इस्तेमाल Get/Delete के लिए, और स्टैंडर्ड update_mask का इस्तेमाल करना.
  • रैपर टाइप: Content API में, जिन फ़ील्ड के लिए पहले google.protobuf.StringValue या google.protobuf.BoolValue का इस्तेमाल किया जाता था उनके लिए अब Merchant API में, स्टैंडर्ड optional फ़ील्ड का इस्तेमाल किया जाता है.
  • नई सुविधाएं:
    • Merchant API, Region संसाधन में RadiusArea टाइप की सुविधा देता है. इसकी मदद से, किसी पॉइंट के आस-पास के दायरे के आधार पर इलाके तय किए जा सकते हैं. फ़िलहाल, यह सुविधा TRUST_TESTER के लिए उपलब्ध है.
    • बैच के तरीके - BatchCreateRegions, BatchUpdateRegions, BatchDeleteRegions - उपलब्ध हैं.
  • गड़बड़ी को ठीक करना: गड़बड़ी के कोड और मैसेज से, ज़्यादा सटीक सुझाव/राय मिलती है.

अनुरोध

अनुरोध के पैटर्न में इस तरह बदलाव होता है:

आइटम Shopping के लिए Content API Merchant API ब्यौरा
एंडपॉइंट https://shoppingcontent.googleapis.com https://merchantapi.googleapis.com बेस डोमेन बदलता है.
Get पाथ /content/v2.1/{merchant_id}/regions/{region_id} /accounts/v1/{name=accounts/*/regions/*} Merchant API, accounts सब-एपीआई और name संसाधन का इस्तेमाल करता है.
List पाथ /content/v2.1/{merchant_id}/regions /accounts/v1/{parent=accounts/*}/regions Merchant API, खाते की जानकारी देने के लिए parent का इस्तेमाल करता है.
Create पाथ /content/v2.1/{merchant_id}/regions /accounts/v1/{parent=accounts/*}/regions Merchant API, parent का इस्तेमाल करता है. region_id, अनुरोध के मुख्य भाग में मौजूद एक फ़ील्ड है.
Update पाथ /content/v2.1/{merchant_id}/regions/{region_id} /accounts/v1/{name=accounts/*/regions/*} Merchant API में, संसाधन का नाम मुख्य भाग में मौजूद region ऑब्जेक्ट का हिस्सा होता है.
Delete पाथ /content/v2.1/{merchant_id}/regions/{region_id} /accounts/v1/{name=accounts/*/regions/*} name संसाधन का इस्तेमाल करता है.

आइडेंटिफ़ायर

आइडेंटिफ़ायर के इस्तेमाल में इस तरह बदलाव करें:

आइटम Shopping के लिए Content API Merchant API ब्यौरा
खाता merchant_id (पूर्णांक) account (पूर्णांक, name या parent स्ट्रिंग का हिस्सा) संसाधन के नाम की स्ट्रिंग में एम्बेड किया गया खाता आईडी ढूंढें. उदाहरण के लिए, accounts/{account}.
क्षेत्र region_id (स्ट्रिंग) {region} (स्ट्रिंग, name स्ट्रिंग का हिस्सा) संसाधन के नाम की स्ट्रिंग में एम्बेड किया गया क्षेत्र का आईडी ढूंढें. उदाहरण के लिए, accounts/{account}/regions/{region}.
संसाधन का नाम अनुरोधों के लिए इसका इस्तेमाल करना ज़रूरी नहीं है. name: accounts/{account}/regions/{region} Get/Update/Delete अनुरोधों के लिए स्टैंडर्ड आइडेंटिफ़ायर.
पैरंट का नाम अनुरोधों के लिए इसका इस्तेमाल करना ज़रूरी नहीं है. parent: accounts/{account} List/Create अनुरोधों के लिए स्टैंडर्ड आइडेंटिफ़ायर.

संसाधन

Region संसाधन के स्ट्रक्चर में मामूली बदलाव किए गए हैं:

आइटम Shopping के लिए Content API Merchant API ब्यौरा
संसाधन आइडेंटिफ़ायर region_id (स्ट्रिंग), merchant_id (int64) name (स्ट्रिंग): accounts/{account}/regions/{region} Merchant API, संसाधन आइडेंटिफ़ायर के तौर पर सिर्फ़ name फ़ील्ड का इस्तेमाल करता है.
display_name google.protobuf.StringValue optional string रैपर टाइप हटाया गया.
radius_area उपलब्ध नहीं है RadiusArea इस नए टाइप से, दायरे के हिसाब से इलाके तय किए जा सकते हैं. इसमें region_code, lat_lng, radius, radius_units शामिल हैं. डिफ़ॉल्ट रूप से, दिखने की सेटिंग सीमित होती है.
regional_inventory_eligible google.protobuf.BoolValue (सिर्फ़ आउटपुट) optional bool (सिर्फ़ आउटपुट) रैपर टाइप हटाया गया.
shipping_eligible google.protobuf.BoolValue (सिर्फ़ आउटपुट) optional bool (सिर्फ़ आउटपुट) रैपर टाइप हटाया गया.

तरीके

तरीकों के इस्तेमाल में इस तरह बदलाव करें:

आइटम Shopping के लिए Content API Merchant API ब्यौरा
क्षेत्र की जानकारी पाना GetRegion GetRegion अनुरोध में name का इस्तेमाल किया जाता है.
क्षेत्र बनाना CreateRegion CreateRegion अनुरोध, यूआरएल से parent लेता है. वहीं, अनुरोध के मुख्य भाग में region ऑब्जेक्ट और region_id शामिल होता है.
क्षेत्र की जानकारी अपडेट करना UpdateRegion UpdateRegion अनुरोध में region (जिसमें region.name शामिल होना चाहिए) और update_mask का इस्तेमाल किया जाता है.
क्षेत्र मिटाना DeleteRegion DeleteRegion अनुरोध में name का इस्तेमाल किया जाता है.
क्षेत्रों की सूची पाना ListRegions ListRegions अनुरोध में parent का इस्तेमाल किया जाता है. page_size और page_token का व्यवहार एक जैसा होता है.
बैच में बनाना उपलब्ध नहीं है BatchCreateRegions यह एक नया तरीका है.
बैच में अपडेट करना उपलब्ध नहीं है BatchUpdateRegions यह एक नया तरीका है.
बैच में मिटाना उपलब्ध नहीं है BatchDeleteRegions यह एक नया तरीका है.

नाम बदले गए फ़ील्ड

आइटम Shopping के लिए Content API Merchant API ब्यौरा
खाता आईडी merchant_id account (name या parent का हिस्सा) संसाधन के name स्ट्रिंग में इंटिग्रेट किया गया. इसका असर Region (जवाब) और एपीआई अनुरोध करने के लिए इस्तेमाल किए जाने वाले प्रोटोबफ़ मैसेज पर पड़ता है. जैसे, CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest और ListRegionsRequest.
क्षेत्र का आईडी region_id region (name का हिस्सा), region_id ज़्यादातर के लिए name में इंटिग्रेट किया गया. region_id फ़ील्ड CreateRegionRequest में अलग. इसका असर Region (जवाब) और एपीआई अनुरोध करने के लिए इस्तेमाल किए जाने वाले प्रोटोबफ़ मैसेज पर पड़ता है. जैसे CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest और ListRegionsRequest.
क्षेत्र का नाम (आउटपुट) region_id name जवाब में मुख्य आइडेंटिफ़ायर फ़ील्ड अब पूरा संसाधन name है. इसका असर Region पर पड़ता है.
डिसप्ले नाम display_name display_name टाइप StringValue से बदलकर optional string किया गया. इसका असर Region पर पड़ता है.
ज़रूरी योग्यता के फ़्लैग ...eligible ...eligible टाइप BoolValue से बदलकर optional bool किया गया. इसका असर Region पर पड़ता है.
अपडेट मास्क update_mask update_mask Region फ़ील्ड पाथ. इसका असर UpdateRegionRequest पर पड़ता है.

ज़्यादा जानें

पीछे जाएं
Migrate homepage management
आगे बढ़ें
Migrate shipping settings management