इस गाइड में, इंटिग्रेशन को Content API for Shopping के RegionsService से Accounts sub-API के RegionsService में माइग्रेट करने का तरीका बताया गया है.
रीजन सेवा की मदद से, इस्तेमाल के उदाहरणों के लिए अपनी पसंद के मुताबिक भौगोलिक क्षेत्र तय किए जा सकते हैं. जैसे, क्षेत्र के हिसाब से कीमत तय करना और शिपिंग की जानकारी को बदलना. RegionalInventory और ShippingSettings जैसी सेवाओं के लिए, इलाकों का इस्तेमाल किया जा सकता है.
मुख्य अंतर
- एपीआई स्ट्रक्चर: Regions सेवा अब Merchant API के
Accountsसब-एपीआई का हिस्सा है. उदाहरण के लिए,merchantapi.googleapis.com/accounts/v1/.... - संसाधन के नाम: Merchant API, Get, Update, और Delete
ऑपरेशन के लिए यूआरएल पाथ में अलग-अलग
merchant_idऔरregion_idपैरामीटर के बजाय, संसाधन के नामों (accounts/{account}/regions/{region}) का इस्तेमाल करता है. - एआईपी का पालन करना: Merchant API के तरीके, एपीआई को बेहतर बनाने के सुझाव के स्टैंडर्ड पैटर्न का पालन करते हैं. जैसे, List/Create के लिए
parent, Get/Delete के लिएname, और स्टैंडर्डupdate_maskका इस्तेमाल करना. - रैपर टाइप: Content API में
google.protobuf.StringValueयाgoogle.protobuf.BoolValueका इस्तेमाल करने वाले फ़ील्ड, अब Merchant API में स्टैंडर्डoptionalफ़ील्ड का इस्तेमाल करते हैं. - नई सुविधाएं:
- Merchant API,
Regionरिसॉर्स मेंRadiusAreaटाइप पेश करता है. इससे किसी पॉइंट के आस-पास के दायरे के हिसाब से क्षेत्रों को तय किया जा सकता है. शुरुआत में, यहTRUST_TESTERकी उपलब्धता के साथ काम करेगा. - बैच के तरीके -
BatchCreateRegions,BatchUpdateRegions,BatchDeleteRegions- उपलब्ध हैं.
- Merchant API,
- गड़बड़ी को हैंडल करना: गड़बड़ी के कोड और मैसेज से, ज़्यादा सटीक फ़ीडबैक मिलता है.
अनुरोध
अनुरोध के पैटर्न में इस तरह बदलाव होता है:
| Item | Content API for Shopping | Merchant API | ब्यौरा |
|---|---|---|---|
| एंडपॉइंट | https://shoppingcontent.googleapis.com |
https://merchantapi.googleapis.com |
बेस डोमेन बदल जाता है. |
| Path का ऐक्सेस पाना | /content/v2.1/{merchant_id}/regions/{region_id} |
/accounts/v1/{name=accounts/*/regions/*} |
Merchant API, accounts सब-एपीआई और name रिसॉर्स का इस्तेमाल करता है. |
| सूची का पाथ | /content/v2.1/{merchant_id}/regions |
/accounts/v1/{parent=accounts/*}/regions |
Merchant API, खाते के बारे में बताने के लिए parent का इस्तेमाल करता है. |
| पाथ बनाएं | /content/v2.1/{merchant_id}/regions |
/accounts/v1/{parent=accounts/*}/regions |
Merchant API, parent का इस्तेमाल करता है. region_id, अनुरोध के मुख्य हिस्से में मौजूद एक फ़ील्ड है. |
| अपडेट पाथ | /content/v2.1/{merchant_id}/regions/{region_id} |
/accounts/v1/{name=accounts/*/regions/*} |
Merchant API में रिसॉर्स का नाम, बॉडी में मौजूद region ऑब्जेक्ट का हिस्सा होता है. |
| पाथ मिटाएं | /content/v2.1/{merchant_id}/regions/{region_id} |
/accounts/v1/{name=accounts/*/regions/*} |
संसाधन name का इस्तेमाल करता है. |
आइडेंटिफ़ायर
आइडेंटिफ़ायर के इस्तेमाल में ये बदलाव करें:
| Item | Content API for Shopping | Merchant API | ब्यौरा |
|---|---|---|---|
| खाता | merchant_id (पूर्णांक) |
account (पूर्णांक, name या parent स्ट्रिंग का हिस्सा) |
संसाधन के नाम वाली स्ट्रिंग में मौजूद खाता आईडी ढूंढें. उदाहरण के लिए, accounts/{account}. |
| क्षेत्र | region_id (string) |
{region} (string, name स्ट्रिंग का हिस्सा) |
संसाधन के नाम वाली स्ट्रिंग में एम्बेड किया गया क्षेत्र का आईडी ढूंढें. उदाहरण के लिए, accounts/{account}/regions/{region}. |
| संसाधन का नाम | इसका इस्तेमाल सिर्फ़ अनुरोधों के लिए नहीं किया जाता. | name: accounts/{account}/regions/{region} |
Get/Update/Delete अनुरोधों के लिए स्टैंडर्ड आइडेंटिफ़ायर. |
| अभिभावक का नाम | इसका इस्तेमाल सिर्फ़ अनुरोधों के लिए नहीं किया जाता. | parent: accounts/{account} |
सूची बनाने/बनाने के अनुरोधों के लिए स्टैंडर्ड आइडेंटिफ़ायर. |
संसाधन
Region संसाधन के स्ट्रक्चर में छोटे-मोटे बदलाव किए गए हैं:
| Item | Content API for Shopping | Merchant API | ब्यौरा |
|---|---|---|---|
| संसाधन का आइडेंटिफ़ायर | region_id (string), merchant_id (int64) |
name (string): 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 (सिर्फ़ आउटपुट) |
रैपर टाइप हटाया गया. |
तरीके
तरीकों के इस्तेमाल में ये बदलाव करें:
| Item | Content API for Shopping | Merchant API | ब्यौरा |
|---|---|---|---|
| Get Region | 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 |
यह एक नया तरीका है. |
नाम बदले गए फ़ील्ड
| Item | Content API for Shopping | Merchant API | ब्यौरा |
|---|---|---|---|
| खाता आईडी | merchant_id |
account (name या parent का हिस्सा) |
इन्हें संसाधन name स्ट्रिंग में इंटिग्रेट किया गया है. इससे Region (जवाब) और एपीआई के अनुरोधों के लिए इस्तेमाल किए जाने वाले प्रोटोबफ़ मैसेज पर असर पड़ता है. जैसे, CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest और ListRegionsRequest.
|
| क्षेत्र का आईडी | region_id |
region (name का हिस्सा), region_id |
ज़्यादातर लोगों के लिए, name में इंटिग्रेट किया गया है. CreateRegionRequest में अलग region_id फ़ील्ड. इसका असर Region
(जवाब) और एपीआई के अनुरोध करने के लिए इस्तेमाल किए जाने वाले Protobuf मैसेज पर पड़ता है. जैसे, 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 पर असर पड़ता है. |