रीजन लुकअप एपीआई का इस्तेमाल करें

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

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

इस क्षेत्र के अलग-अलग टाइप के साथ काम करता है

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

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

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

  1. कंसोल में ज़ोन लुकअप एपीआई चालू करें.
  2. ओपन सोर्स लाइब्रेरी इंस्टॉल करें: npm install @googlemaps/region-lookup

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

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

  • इलाके की जानकारी का पता लगाने के अनुरोधों के लिए, ये चीज़ें इंपोर्ट करें:

    import {
      lookupRegion,
      LookupRegionRequestData,
      LookupRegionResponseData,
      LookupRegionResponse,
      RegionIdentifier
    } from "@googlemaps/region-lookup";
    
  • इलाके के हिसाब से खोज के अनुरोधों के लिए, इन्हें इंपोर्ट करें:

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

इलाका खोजने के अनुरोध

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

  • place या unit_code (ज़रूरी है) जगह का नाम (place) या unit_code. unit_code, एफ़आईपीएस कोड (सिर्फ़ अमेरिका के राज्यों और काउंटी में) या 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 पैरामीटर ज़रूरी है. अगर कुछ भी तय नहीं किया गया है, तो गड़बड़ी दिखेगी.

अगर place_type, COUNTRY न हो, तो region_code पैरामीटर ज़रूरी है.

place और unit_code ऐसी जगह बताते हैं जिसके लिए जगह के आईडी से मिलान करना होता है. उदाहरण के लिए, अगर place "कैलिफ़ोर्निया" है और 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_type के बताए जाने पर ये नतीजे दिखाता है:

  • 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 होगा.

नीचे दिए गए उदाहरण में, Burbank, CA के लिए एक लुकअप अनुरोध दिखाया गया है.

// 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 "जगह" है, तो मान्य place "Palo Alto, CA" हो सकता है. अगर place_type `POSTAL_CODE` है, तो जगह का नाम "94109" के तौर पर मान्य हो सकता है. अगर place_type `COUNTRY` है, तो मान्य place "अमेरिका" हो सकता है वगैरह. अगर place_type `COUNTRY` है, तो place बताने के लिए, region_code की ज़रूरत होती है.
unit_code स्ट्रिंग एफ़आईपी के राज्य या काउंटी कोड (सिर्फ़ अमेरिका) या ISO-3166-1 देश के कोड जिनका मिलान किया जाना है. क्षेत्र का आईडी देखने के लिए, unit_code फ़ील्ड को place_type के साथ इस्तेमाल किया जाता है. उदाहरण के लिए: अगर place_type COUNTRY है, तो एक मान्य यूनिट_कोड "US" (अमेरिका के लिए ISO-3166-1 ऐल्फ़ा-2 कोड) या "BR" (ब्राज़ील के लिए ISO-3166-1 ऐल्फ़ा-2 कोड) हो सकता है. अगर place_type, ADMINISTRATIVE_AREA_LEVEL_1 (राज्य) है और Region_code "US" है, तो एक मान्य unit_code "6" (कैलिफ़ोर्निया के लिए एफ़आईपी कोड) या "12"(फ़्लोरिडा के लिए एफ़आईपी कोड ) हो सकता है. अगरplace_type, ADMINISTRATIVE_AREA_LEVEL_2 (county) औरregion_code "US" है, तो यूनिट_कोड "6001" (कैलिफ़ोर्निया की ऐलामेडा काउंटी के लिए एफ़आईपी कोड) या "12086" (फ़्लोरिडा में मायामी-डेड काउंटी के लिए एफ़आईपी कोड) हो सकता है. एफ़आईपी कोड के बारे में बताते समय 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 मेल खाने वाली जगह का आईडी, देश और जगह के टाइप की, अनुमति वाली सूची में शामिल नहीं है.