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

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

• क्षेत्र की जानकारी ढूंढने की सुविधा, जगह के नाम, 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

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

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

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

  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, FIPS कोड (सिर्फ़ अमेरिका के राज्यों और काउंटी के लिए) या ISO-3166-1 देश का कोड हो सकता है.
• place_type (ज़रूरी है) यह उस जगह के जगह के टाइप की वैल्यू है जिसे खोजना है.
• region_code मैच करने के लिए, जगह का दो अक्षरों वाला ISO-3166 देश/इलाका कोड. अगर जगह का टाइप 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 "कैलिफ़ोर्निया" है और place_type ADMINISTRATIVE_AREA_LEVEL_1 है, तो API, कैलिफ़ोर्निया के लिए जगह का आईडी, matched_place_id के तौर पर दिखाता है:

• place_type: ADMINISTRATIVE_AREA_LEVEL_1

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

अगर unit_code "6" (कैलिफ़ोर्निया के लिए FIPS कोड) है, 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 भाषा का इस्तेमाल किया जाता है.

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

// 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 आइडेंटिफ़ायर

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

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

जगह के टाइप

LatLng

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

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