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

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

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";
  

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

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

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

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

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

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" है, तो API निम्नलिखित 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 आइडेंटिफ़ायर

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