Region Lookup API का इस्तेमाल करना

यह प्रॉडक्ट या सुविधा, एक्सपेरिमेंट के तौर पर उपलब्ध है (pre-GA). हो सकता है कि Pre-GA के तहत आने वाले प्रॉडक्ट और सुविधाओं के लिए, आपको पूरी सहायता न मिले. साथ ही, ऐसा हो सकता है कि Pre-GA के तहत आने वाले प्रॉडक्ट और सुविधाओं में किए गए बदलाव, Pre-GA के अन्य वर्शन के साथ काम न करें. Pre-GA ऑफ़र पर, Google Maps Platform की सेवा से जुड़ी खास शर्तें लागू होती हैं. ज़्यादा जानकारी के लिए, लॉन्च के चरणों की जानकारी देखें.

Region Lookup API की मदद से, इलाकों के लिए जगह के आईडी ढूंढे जा सकते हैं. इनका इस्तेमाल, सीमाओं के लिए डेटा-ड्रिवन स्टाइलिंग में बाउंड्री पॉलीगॉन को स्टाइल करने के लिए किया जा सकता है. Region Lookup API दो तरह के अनुरोधों के साथ काम करता है:

• Region lookup, जगह के नाम, FIPS कोड (सिर्फ़ अमेरिका के राज्यों और काउंटी के लिए) या ISO-3166-1 देश के कोड के हिसाब से किसी क्षेत्र को खोजता है.
• क्षेत्र की खोज सुविधा, उस क्षेत्र को खोजती है जिसमें कोई खास जगह मौजूद होती है. इस जगह की जानकारी, पते, LatLng या जगह के आईडी से दी जाती है.

उपलब्धता वाले देश या इलाकों के लिए इस्तेमाल किए जा सकने वाले प्लेस टाइप

इलाके के लिए, इन प्लेस टाइप का इस्तेमाल किया जा सकता है: country, administrative_area_level_1, administrative_area_level_2, postal_code, locality.

लाइब्रेरी इंस्टॉल करना

Region Lookup API का इस्तेमाल करने के लिए, यह तरीका अपनाएं:

1. कंसोल में Region Lookup API को चालू करें.
2. ओपन सोर्स लाइब्रेरी इंस्टॉल करें: npm install @googlemaps/region-lookup

लाइब्रेरी से डिपेंडेंसी इंपोर्ट करना

रीजन लुकअप ओपन सोर्स लाइब्रेरी, फ़ंक्शन और TypeScript टाइपिंग का एक सेट उपलब्ध कराती है. इसे आपको अपने कोड में इंपोर्ट करना होगा.

• क्षेत्र की जानकारी खोजने के अनुरोधों के लिए, इन्हें इंपोर्ट करें:

  import {
    lookupRegion,
    LookupRegionRequestData,
    LookupRegionResponseData,
    LookupRegionResponse,
    RegionIdentifier
  } from "@googlemaps/region-lookup";
  

• इलाके के हिसाब से खोज के अनुरोधों के लिए, इन्हें इंपोर्ट करें:

  import {
    searchRegion,
    RegionSearchValue,
    SearchRegionRequestData,
    SearchRegionResponse
  } from "@googlemaps/region-lookup";
  

चेतावनी: Region Lookup API और Javascript के लिए ओपन सोर्स लाइब्रेरी, एक्सपेरिमेंट के तौर पर उपलब्ध हैं.

क्षेत्र की जानकारी देखने के अनुरोध

इलाके की जानकारी पाने के अनुरोध में, जगह का नाम या आइडेंटिफ़ायर कोड शामिल होता है. इसके बाद, जगह का आईडी मिलता है. किसी क्षेत्र को खोजने के लिए, lookupRegion() को कॉल करें. इसके लिए, यहां दिए गए पैरामीटर के साथ LookupRegionRequestData की जानकारी दें:

• place या unit_code (ज़रूरी है) जगह के इलाके का नाम (place) या unit_code. unit_code, FIPS कोड (सिर्फ़ अमेरिका के राज्यों और काउंटी के लिए) या ISO-3166-1 देश का कोड हो सकता है.
• place_type (ज़रूरी है) जिस तरह की जगह को खोजना है उसके लिए जगह के टाइप की वैल्यू.
• region_code मैच करने के लिए, जगह का दो अक्षरों वाला ISO-3166 देश/इलाके का कोड. अगर place_type की वैल्यू COUNTRY है, तो region_code ज़रूरी नहीं है.
• language BCP-47 भाषा कोड, जैसे कि "en-US" या "sr-Latn". अगर कोई भाषा तय नहीं की गई है, तो डिफ़ॉल्ट रूप से en-US का इस्तेमाल किया जाता है.

यहां दिए गए उदाहरण में, न्यू जर्सी के न्यूर्क के लिए लुकअप अनुरोध दिखाया गया है.

// Headers
const headers = {
  "X-Goog-Api-Key": "YOUR API KEY",
};
const data: LookupRegionRequestData = {
  identifiers: [
    {
      "place": "newark",
      "place_type": "locality",
      "region_code": "us",
      "language": "en",
    },
  ],
};
const response: LookupRegionResponse = await RegionLookup.lookupRegion({ headers, data });

place या unit_code पैरामीटर में से किसी एक की वैल्यू देना ज़रूरी है. अगर इनमें से कोई भी वैल्यू नहीं दी जाती है, तो गड़बड़ी का मैसेज दिखता है.

region_code पैरामीटर ज़रूरी है. हालांकि, अगर place_type की वैल्यू COUNTRY है, तो यह पैरामीटर ज़रूरी नहीं है.

place और unit_code, जगह के आईडी से मैच करने वाली जगह की जानकारी देते हैं. उदाहरण के लिए, अगर place "California" है और place_type ADMINISTRATIVE_AREA_LEVEL_1 है, तो एपीआई, matched_place_id के तौर पर कैलिफ़ोर्निया की जगह का आईडी दिखाता है:

• place_type: ADMINISTRATIVE_AREA_LEVEL_1

  matched_place_id के नतीजे: कैलिफ़ोर्निया का जगह का आईडी. इस्तेमाल किए जा सकने वाले अन्य सभी टाइप के लिए, कोई मैच नहीं मिलता.

अगर unit_code "6" (कैलिफ़ोर्निया का एफ़आईपीएस कोड) है, place_type ADMINISTRATIVE_AREA_LEVEL_1 है, और region_code "US" है, तो एपीआई कैलिफ़ोर्निया की जगह का आईडी दिखाता है:

• place_type: ADMINISTRATIVE_AREA_LEVEL_1

• region_code: US

  matched_place_id नतीजे: कैलिफ़ोर्निया के लिए जगह का आईडी. इस्तेमाल किए जा सकने वाले अन्य सभी टाइप के लिए, कोई मैच नहीं मिलता.

अगर unit_code "US" है, तो एपीआई ये नतीजे दिखाता है. ऐसा तब होता है, जब ये place_types तय किए गए हों:

• place_type: COUNTRY

  matched_place_id नतीजे: अमेरिका के लिए जगह का आईडी. इस्तेमाल किए जा सकने वाले अन्य सभी टाइप के लिए, कोई मैच नहीं मिलता.

अगर कोई मैच नहीं मिलता है, तो matched_place_id सेट नहीं किया जाता है.

अगर जगह के आईडी की जानकारी साफ़ तौर पर नहीं दी गई है, तो संभावित जगह के आईडी दिखाए जाते हैं. उदाहरण के लिए, अगर place "सैंटा क्लारा काउंटी" है और place_type LOCALITY है, तो सैंटा क्लारा काउंटी की जगह का आईडी, संभावित जगह के तौर पर दिखाया जाता है.

क्षेत्र की जानकारी खोजने का जवाब

अगर कोई नतीजा मिलता है, तो LookupRegionResponse ऑब्जेक्ट में matched_place_id शामिल होता है. अगर कोई नतीजा नहीं मिलता है, तो कम कॉन्फ़िडेंस वाली जगह के आईडी, कैंडिडेट आईडी के तौर पर दिखाए जाते हैं. साथ ही, डीबग करने की जानकारी वाला गड़बड़ी का कोड भी दिखाया जाता है.

{
  "matches": [
    {
      "matchedPlaceId": "ChIJPV4oX_65j4ARVW8IJ6IJUYs"
    }
  ]
}

इमेज के किसी हिस्से के बारे में खोजने के अनुरोध

किसी खास जगह वाले इलाके को ढूंढने के लिए, searchRegion को कॉल करें. साथ ही, इन पैरामीटर के साथ SearchRegionRequestData की जानकारी दें:

• address या latlng या place_id (ज़रूरी है) इसमें, बिना स्ट्रक्चर वाली पते की स्ट्रिंग, latlng या इलाके में मौजूद जगह का आईडी (उदाहरण के लिए, लोकप्रिय जगह, इमारत वगैरह) शामिल होता है. अगर कोई भी वैल्यू नहीं दी जाती है, तो गड़बड़ी का मैसेज दिखता है.
• place_type (ज़रूरी है) जिस तरह के इलाके को खोजना है उसके लिए जगह के टाइप की वैल्यू.
• region_code मैच करने के लिए, जगह का दो अक्षरों वाला ISO-3166 देश/इलाके का कोड. address की जानकारी देने पर, region_code की जानकारी देना ज़रूरी है.
• language BCP-47 भाषा कोड, जैसे कि "en-US" या "sr-Latn". अगर कोई भाषा तय नहीं की गई है, तो डिफ़ॉल्ट रूप से en-US का इस्तेमाल किया जाता है.

यहां दिए गए उदाहरण में, कैलिफ़ोर्निया के बर्बैंक के लिए लुकअप अनुरोध दिखाया गया है.

// Headers
const headers = {
  "X-Goog-Api-Key": "YOUR API KEY",
};

const data: SearchRegionRequestData = {
  search_values: [
    {
      "address": "2627 N Hollywood Way, Burbank, CA" ,
      "place_type": "locality" as const,
      "region_code": "us"
    },
  ],
};
const response = await regionLookupClient.searchRegion({ headers, data });

इमेज के किसी हिस्से के बारे में खोजने पर मिलने वाला जवाब

अगर कोई नतीजा मिलता है, तो SearchRegionResponse ऑब्जेक्ट में matched_place_id शामिल होता है. अगर कोई मैच नहीं मिलता है, तो जवाब में एक या उससे ज़्यादा संभावित जगह के आईडी और गड़बड़ी का कोड शामिल होता है.

{
  "matches": [
    {
      "matchedPlaceId": "ChIJPV4oX_65j4ARVW8IJ6IJUYs"
    }
  ]
}

रेफ़रंस

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

फ़ील्ड	टाइप	ब्यौरा
place	स्ट्रिंग	जगह के आईडी से मैच करने वाले क्षेत्र का नाम. क्षेत्र की जगह का आईडी देखने के लिए, place_type के साथ place फ़ील्ड का इस्तेमाल करें. उदाहरण के लिए, अगर place_type "locality" है, तो place की मान्य वैल्यू "Palo Alto, CA" हो सकती है. अगर place_type, `POSTAL_CODE` है, तो जगह का मान्य नाम "94109" हो सकता है. अगर place_type की वैल्यू `COUNTRY` है, तो place की मान्य वैल्यू "United States" वगैरह हो सकती है. place की वैल्यू देने पर, region_code की वैल्यू देना ज़रूरी है. हालांकि, अगर place_type की वैल्यू `COUNTRY` है, तो ऐसा करना ज़रूरी नहीं है.
unit_code	स्ट्रिंग	FIPs राज्य या काउंटी कोड (सिर्फ़ अमेरिका के लिए) या ISO-3166-1 देश का कोड, जिससे मैच करना है. unit_code फ़ील्ड का इस्तेमाल, place_type के साथ किया जाता है, ताकि क्षेत्र की जगह का आईडी ढूंढा जा सके. उदाहरण के लिए: अगर place_type की वैल्यू COUNTRY है, तो unit_code की मान्य वैल्यू "US" (अमेरिका के लिए ISO-3166-1 Alpha-2 कोड) या "BR" (ब्राज़ील के लिए ISO-3166-1 Alpha-2 कोड) हो सकती है. अगर place_type की वैल्यू ADMINISTRATIVE_AREA_LEVEL_1 (राज्य) है और region_code की वैल्यू "US" है, तो unit_code की मान्य वैल्यू "6" (कैलिफ़ोर्निया के लिए एफ़आईपीएस कोड) या "12"(फ़्लोरिडा के लिए एफ़आईपीएस कोड) हो सकती है. अगर place_type ADMINISTRATIVE_AREA_LEVEL_2 (काउंटी) है और region_code "US" है, तो मान्य unit_code "6001" (कैलिफ़ोर्निया में अलमेडा काउंटी के लिए एफ़आईपीएस कोड) या "12086" (फ़्लोरिडा में मियामी-डेड काउंटी के लिए एफ़आईपीएस कोड) हो सकता है. FIPs कोड की जानकारी देते समय, region_code की जानकारी देना ज़रूरी है. region_code को ISO-3166-1 देश के कोड के लिए अनदेखा किया जाता है.
place_type	PlaceType	ज़रूरी है. मैच करने के लिए क्षेत्र का टाइप.
region_code	स्ट्रिंग	उस जगह के लिए दो अक्षर वाला ISO-3166 देश/इलाका कोड जिससे आपको मैच करना है. अगर place_type, `COUNTRY` है, तो region_code ज़रूरी नहीं है.
language_code	स्ट्रिंग	BCP-47 भाषा कोड, जैसे कि "en-US" या "sr-Latn". यह उस भाषा के मुताबिक होता है जिसमें जगह का नाम और पता मांगा गया है. अगर कोई भाषा नहीं चुनी जाती है, तो डिफ़ॉल्ट रूप से अंग्रेज़ी को चुना जाता है.

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

ज़रूरी है: address, latlng या place_id में से कोई एक.

फ़ील्ड	टाइप	ब्यौरा
address	स्ट्रिंग	मोहल्ले का ऐसा पता जो स्ट्रक्चर्ड नहीं है और मैच करने के लिए किसी इलाके में मौजूद है. address की जानकारी देने पर, region_code की जानकारी देना ज़रूरी है.
latlng	LatLng	मैच करने के लिए, किसी इलाके में मौजूद अक्षांश और देशांतर.
place_id	स्ट्रिंग	जगह का ऐसा आईडी जो मैच करने के लिए किसी इलाके में मौजूद हो.
place_type	जगह का टाइप	ज़रूरी है. मैच करने के लिए क्षेत्र का टाइप.
language_code	स्ट्रिंग	BCP-47 भाषा कोड, जैसे कि "en-US" या "sr-Latn". यह उस भाषा के मुताबिक होता है जिसमें जगह के नाम और पते का अनुरोध किया जाता है. अगर कोई भाषा नहीं चुनी जाती है, तो डिफ़ॉल्ट रूप से अंग्रेज़ी को चुना जाता है.
region_code	स्ट्रिंग	मैच करने वाली जगह के लिए, दो अक्षरों वाला ISO-3166 देश/इलाके का कोड. पता डालने पर, region_code डालना ज़रूरी है.

जगह के टाइप

वैल्यू	ब्यौरा
POSTAL_CODE	पिन कोड, जिसका इस्तेमाल देश में डाक भेजने के लिए किया जाता है.
ADMINISTRATIVE_AREA_LEVEL_1	'देश' स्तर से नीचे, पहले क्रम की नागरिक इकाई. अमेरिका में, इन प्रशासनिक स्तरों को राज्य कहा जाता है.
ADMINISTRATIVE_AREA_LEVEL_2	देश के स्तर से नीचे, दूसरे क्रम की नागरिक इकाई. अमेरिका में, इन प्रशासनिक स्तरों को काउंटी कहा जाता है.
LOCALITY	कोई शहर या कस्बा, जो एक राजनैतिक इकाई है.
COUNTRY	राष्ट्रीय राजनैतिक इकाई, आम तौर पर सबसे ऊंचे क्रम की इकाई होती है.

LatLng

अक्षांश/देशांतर के जोड़े को दिखाने वाला ऑब्जेक्ट. इसे अक्षांश और देशांतर की डिग्री दिखाने के लिए, डबल के पेयर के तौर पर दिखाया जाता है. जब तक कोई और जानकारी न दी गई हो, तब तक इस ऑब्जेक्ट को WGS84 स्टैंडर्ड के मुताबिक होना चाहिए. वैल्यू, सामान्य रेंज में होनी चाहिए.

फ़ील्ड	टाइप	ब्यौरा
latitude	दोगुनी	डिग्री में अक्षांश. यह [-90.0, +90.0] की रेंज में होना चाहिए. उदाहरण के लिए, 47.47583476464538.
longitude	दोगुनी	डिग्री में देशांतर. यह [-180.0, +180.0] की रेंज में होना चाहिए. उदाहरण के लिए, -121.73858779269906.

गड़बड़ी के कोड

वैल्यू	ब्यौरा
UnknownError	कोई ऐसी गड़बड़ी हुई जिसके बारे में जानकारी नहीं है.
NoMatchFound	अनुरोध के लिए कोई मैच नहीं मिला. अगर उपलब्ध हो, तो candidate_place_ids देखें.
AddressNotUnderstood	दिए गए पते के लिए जियोकोडिंग नहीं की जा सकी.
PlaceTypeMismatch	जवाब में जगह का टाइप, अनुरोध में दिए गए टाइप से मेल नहीं खाता. उदाहरण के लिए, locality का अनुरोध किया गया था, लेकिन administrative_area_level_2 मिला.
MultipleCandidatesFound	इनपुट से कई नतीजे मैच हुए. candidate_place_ids देखें. अगर उपलब्ध हो.
PlaceNameNotUnderstood	जगह के दिए गए नाम से, किसी क्षेत्र की पहचान नहीं की जा सकी.
UnitCodeNotFound	यूनिट कोड नहीं मिला. पुष्टि करें कि यूनिट कोड मान्य है और सही फ़ॉर्मैट में दिया गया है.
PlaceTypeNotAllowed	मैच किया गया जगह का आईडी, जगह के टाइप और देश की अनुमति वाली सूची में नहीं है.