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

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

  • इलाके का पता लगाने की सुविधा, जगह के नाम, एफ़आईपीएस कोड (सिर्फ़ अमेरिका के राज्यों और काउंटी के लिए) या आईएसओ-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";
    

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

इलाके का लुकअप अनुरोध, जगह का नाम या आइडेंटिफ़ायर कोड लेता है और जगह का आईडी दिखाता है. किसी क्षेत्र को खोजने के लिए, 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 पैरामीटर में से कोई एक पैरामीटर ज़रूरी है. अगर कोई भी वैल्यू नहीं दी गई है, तो गड़बड़ी का मैसेज दिखता है.

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

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" (कैलिफ़ोर्निया के लिए 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_types के लिए ये नतीजे दिखाता है:

  • place_type: COUNTRY

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

अगर कोई मैच नहीं मिलता है, तो 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 "जगह" है, तो मान्य place "पालो अल्टो, सीए" हो सकता है. अगर place_type `POSTAL_CODE` है, तो जगह का मान्य नाम "94109" हो सकता है. अगर place_type की वैल्यू `COUNTRY` है, तो place के लिए "United States" वगैरह जैसी कोई मान्य वैल्यू दी जा सकती है. अगर place की वैल्यू दी गई है, तो region_code की वैल्यू देना ज़रूरी है. हालांकि, अगर place_type की वैल्यू `COUNTRY` है, तो region_code की वैल्यू देना ज़रूरी नहीं है.
unit_code स्ट्रिंग एफ़आईपी के राज्य या काउंटी कोड (सिर्फ़ अमेरिका के लिए) या देश का 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" (फ़्लोरिडा के मियामी-डेड काउंटी के लिए एफ़आईपीएस कोड) हो सकता है. एफ़आईपी कोड की जानकारी देते समय, region_code की वैल्यू देना ज़रूरी है. ISO-3166-1 वाले देश के कोड के लिए, region_code को अनदेखा किया जाता है.
place_type PlaceType ज़रूरी है. मैच करने के लिए इलाके का टाइप.
region_code स्ट्रिंग उस जगह के लिए दो अक्षर वाला आईएसओ-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 स्ट्रिंग मैच करने वाली जगह के लिए, दो अक्षरों वाला आईएसओ-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 मैच होने वाला प्लेस आईडी, जगह के टाइप और देश की अनुमति वाली सूची में नहीं है.