इस गाइड में, Content API for Shopping में मौजूद RegionsService से, Accounts सब-एपीआई में मौजूद RegionsService पर इंटिग्रेशन को माइग्रेट करने का तरीका बताया गया है.
क्षेत्रों की सेवा का इस्तेमाल करके, अपनी पसंद के मुताबिक भौगोलिक क्षेत्र तय किए जा सकते हैं. इनका इस्तेमाल, क्षेत्र के हिसाब से कीमत तय करने और शिपिंग की जानकारी बदलने जैसे कामों के लिए किया जा सकता है. RegionalInventory और ShippingSettings जैसी सेवाओं के साथ, रीजन का इस्तेमाल किया जा सकता है.
मुख्य अंतर
- एपीआई का स्ट्रक्चर: क्षेत्र सेवा अब Merchant API में
Accountsसब-एपीआई का हिस्सा है. उदाहरण के लिए,merchantapi.googleapis.com/accounts/v1/.... - संसाधन के नाम: Merchant API, यूआरएल पाथ में अलग-अलग
merchant_idऔरregion_idपैरामीटर के बजाय, संसाधन के नाम (accounts/{account}/regions/{region}) का इस्तेमाल करता है. ऐसा, डेटा पाने, अपडेट करने, और मिटाने के लिए किया जाता है. - एआईपी का पालन करना: Merchant API के तरीके, स्टैंडर्ड एपीआई में सुधार के प्रस्ताव के पैटर्न का पालन करते हैं. जैसे, सूची बनाने/बनाने के लिए
parent, पाने/मिटाने के लिए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 |
बेस डोमेन बदल जाता है. |
| पाथ पाना | /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 (स्ट्रिंग) |
{region} (स्ट्रिंग, 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 (स्ट्रिंग), merchant_id (int64) |
name (स्ट्रिंग): accounts/{account}/regions/{region} |
Merchant API, संसाधन आइडेंटिफ़ायर के तौर पर एक name फ़ील्ड का इस्तेमाल करता है. |
display_name |
google.protobuf.StringValue |
optional string |
रैपर टाइप हटाया गया. |
radius_area |
लागू नहीं (N/A) | 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 | ब्यौरा |
|---|---|---|---|
| क्षेत्र की जानकारी पाना | 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 (रिस्पॉन्स) और एपीआई अनुरोध करने के लिए इस्तेमाल किए जाने वाले protobuf मैसेज पर पड़ता है. जैसे, 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 पर पड़ता है. |