डेटा लेयर का अनुरोध करना

dataLayers एंडपॉइंट में सोलर पैनल की ज़्यादा जानकारी मिलती है किसी खास जगह के आस-पास के इलाके की जानकारी. एंडपॉइंट, डाउनलोड की जा सकने वाली 17 TIFF फ़ाइलें दिखाता है. इनमें ये शामिल हैं:

  • डिजिटल सर्फ़ेस मॉडल (डीएसएम)
  • आरजीबी कंपोज़िट लेयर (एरियल इमेजरी)
  • एक मास्क लेयर, जो विश्लेषण की सीमाओं की पहचान करती है
  • सालाना सोलर फ़्लक्स या किसी सतह से होने वाला सालाना रेवेन्यू
  • हर महीने का सोलर फ़्लक्स या किसी जगह से हर महीने मिलने वाला रेवेन्यू
  • हर घंटे की छाया (24 घंटे)

सोलर एपीआई, फ़्लक्स के बारे में कैसे बताता है, इस बारे में ज़्यादा जानने के लिए यहां देखें Solar API कॉन्सेप्ट.

डेटा लेयर के अनुरोधों के बारे में जानकारी

इस उदाहरण में, dataLayers पर किए गए REST अनुरोध का यूआरएल दिखाया गया है तरीका:

https://solar.googleapis.com/v1/dataLayers:get?parameters

अनुरोध यूआरएल के ऐसे पैरामीटर शामिल करें जिनसे ये चीज़ें पता चलें:

  • किसी जगह के अक्षांश और देशांतर निर्देशांक
  • जगह के आस-पास के इलाके का दायरा
  • दिखाए जाने वाले डेटा का सबसेट (DSM, RGB, मास्क, सालाना फ़्लक्स या हर महीने) फ़्लक्स)
  • नतीजों में दिखाई गई कम से कम क्वालिटी
  • मीटर प्रति पिक्सल के हिसाब से, दिखाया जाने वाला डेटा का कम से कम स्केल

डेटा लेयर के अनुरोध का उदाहरण

यहां दिए गए उदाहरण में, 100 मीटर में इमारत की अहम जानकारी के लिए अनुरोध किया गया है अक्षांश के निर्देशांक पर जगह का दायरा = 37.4450 और देशांतर = -122.1390:

API कुंजी

जवाब में दिए गए यूआरएल पर अनुरोध करने के लिए, यूआरएल में अपनी एपीआई कुंजी जोड़ें:

curl -X GET "https://solar.googleapis.com/v1/dataLayers:get?location.latitude=37.4450&location.longitude=-122.1390&radiusMeters=100&view=FULL_LAYERS&requiredQuality=HIGH&exactQualityRequired=true&pixelSizeMeters=0.5&key=YOUR_API_KEY"

अपने ब्राउज़र के यूआरएल बार में, cURL अनुरोध में यूआरएल चिपकाकर भी एचटीटीपी अनुरोध किए जा सकते हैं. एपीआई पासकोड पास करने से, आपको इस्तेमाल और विश्लेषण से जुड़ी बेहतर सुविधाएं मिलती हैं. साथ ही, जवाब के डेटा का ऐक्सेस भी बेहतर तरीके से कंट्रोल किया जा सकता है.

OAuth टोकन

ध्यान दें: यह फ़ॉर्मैट सिर्फ़ टेस्टिंग एनवायरमेंट के लिए है. ज़्यादा जानकारी के लिए, OAuth का इस्तेमाल करना लेख पढ़ें.

जवाब में यूआरएल का अनुरोध करने के लिए, अपने बिलिंग प्रोजेक्ट का नाम और अपना OAuth टोकन पास करें:

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -H "X-Goog-User-Project: PROJECT_NUMBER_OR_ID" \
  "https://solar.googleapis.com/v1/dataLayers:get?location.latitude=37.4450&location.longitude=-122.1390&radius_meters=100&required_quality=HIGH&exactQualityRequired=true"
        

TypeScript

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

/**
 * Fetches the data layers information from the Solar API.
 *   https://developers.google.com/maps/documentation/solar/data-layers
 *
 * @param  {LatLng} location      Point of interest as latitude longitude.
 * @param  {number} radiusMeters  Radius of the data layer size in meters.
 * @param  {string} apiKey        Google Cloud API key.
 * @return {Promise<DataLayersResponse>}  Data Layers response.
 */
export async function getDataLayerUrls(
  location: LatLng,
  radiusMeters: number,
  apiKey: string,
): Promise<DataLayersResponse> {
  const args = {
    'location.latitude': location.latitude.toFixed(5),
    'location.longitude': location.longitude.toFixed(5),
    radius_meters: radiusMeters.toString(),
    // The Solar API always returns the highest quality imagery available.
    // By default the API asks for HIGH quality, which means that HIGH quality isn't available,
    // but there is an existing MEDIUM or LOW quality, it won't return anything.
    // Here we ask for *at least* LOW quality, but if there's a higher quality available,
    // the Solar API will return us the highest quality available.
    required_quality: 'LOW',
  };
  console.log('GET dataLayers\n', args);
  const params = new URLSearchParams({ ...args, key: apiKey });
  // https://developers.google.com/maps/documentation/solar/reference/rest/v1/dataLayers/get
  return fetch(`https://solar.googleapis.com/v1/dataLayers:get?${params}`).then(
    async (response) => {
      const content = await response.json();
      if (response.status != 200) {
        console.error('getDataLayerUrls\n', content);
        throw content;
      }
      console.log('dataLayersResponse', content);
      return content;
    },
  );
}

फ़ील्ड और डेटा का टाइप, TypeScript में एक "टाइप" होता है. इस उदाहरण में, हमने रुचि के फ़ील्ड संग्रहित करने के लिए एक कस्टम प्रकार तय किया है जैसे कि पिक्सल वैल्यू और अक्षांश/देशांतर बाउंडिंग बॉक्स. आपके पास ज़रूरत के हिसाब से ज़्यादा फ़ील्ड शामिल करने का विकल्प होता है.

export interface GeoTiff {
  width: number;
  height: number;
  rasters: Array<number>[];
  bounds: Bounds;
}

डेटा टाइप की परिभाषाएं

नीचे दिए गए डेटा टाइप काम करते हैं:

export interface DataLayersResponse {
  imageryDate: Date;
  imageryProcessedDate: Date;
  dsmUrl: string;
  rgbUrl: string;
  maskUrl: string;
  annualFluxUrl: string;
  monthlyFluxUrl: string;
  hourlyShadeUrls: string[];
  imageryQuality: 'HIGH' | 'MEDIUM' | 'LOW';
}

export interface Bounds {
  north: number;
  south: number;
  east: number;
  west: number;
}

// https://developers.google.com/maps/documentation/solar/reference/rest/v1/buildingInsights/findClosest
export interface BuildingInsightsResponse {
  name: string;
  center: LatLng;
  boundingBox: LatLngBox;
  imageryDate: Date;
  imageryProcessedDate: Date;
  postalCode: string;
  administrativeArea: string;
  statisticalArea: string;
  regionCode: string;
  solarPotential: SolarPotential;
  imageryQuality: 'HIGH' | 'MEDIUM' | 'LOW';
}

export interface SolarPotential {
  maxArrayPanelsCount: number;
  panelCapacityWatts: number;
  panelHeightMeters: number;
  panelWidthMeters: number;
  panelLifetimeYears: number;
  maxArrayAreaMeters2: number;
  maxSunshineHoursPerYear: number;
  carbonOffsetFactorKgPerMwh: number;
  wholeRoofStats: SizeAndSunshineStats;
  buildingStats: SizeAndSunshineStats;
  roofSegmentStats: RoofSegmentSizeAndSunshineStats[];
  solarPanels: SolarPanel[];
  solarPanelConfigs: SolarPanelConfig[];
  financialAnalyses: object;
}

export interface SizeAndSunshineStats {
  areaMeters2: number;
  sunshineQuantiles: number[];
  groundAreaMeters2: number;
}

export interface RoofSegmentSizeAndSunshineStats {
  pitchDegrees: number;
  azimuthDegrees: number;
  stats: SizeAndSunshineStats;
  center: LatLng;
  boundingBox: LatLngBox;
  planeHeightAtCenterMeters: number;
}

export interface SolarPanel {
  center: LatLng;
  orientation: 'LANDSCAPE' | 'PORTRAIT';
  segmentIndex: number;
  yearlyEnergyDcKwh: number;
}

export interface SolarPanelConfig {
  panelsCount: number;
  yearlyEnergyDcKwh: number;
  roofSegmentSummaries: RoofSegmentSummary[];
}

export interface RoofSegmentSummary {
  pitchDegrees: number;
  azimuthDegrees: number;
  panelsCount: number;
  yearlyEnergyDcKwh: number;
  segmentIndex: number;
}

export interface LatLng {
  latitude: number;
  longitude: number;
}

export interface LatLngBox {
  sw: LatLng;
  ne: LatLng;
}

export interface Date {
  year: number;
  month: number;
  day: number;
}

export interface RequestError {
  error: {
    code: number;
    message: string;
    status: string;
  };
}

एपीआई, नीचे दिए गए फ़ॉर्मैट में यूआरएल दिखाता है:

https://solar.googleapis.com/v1/solar/geoTiff:get?id=HASHED_ID

इन यूआरएल का इस्तेमाल, अनुरोध किए गए डेटा वाली GeoTIFF फ़ाइलों को ऐक्सेस करने के लिए किया जा सकता है.

रिस्पॉन्स का उदाहरण

अनुरोध करने पर, फ़ॉर्म में JSON रिस्पॉन्स मिलता है:

{
  "imageryDate": {
    "year": 2022,
    "month": 4,
    "day": 6
  },
  "imageryProcessedDate": {
    "year": 2023,
    "month": 8,
    "day": 4
  },
  "dsmUrl": "https://solar.googleapis.com/v1/geoTiff:get?id=MmQyMzI0NTMyZDc3YjBjNmQ3OTgyM2ZhNzMyNzk5NjItN2ZjODJlOThkNmQ5ZDdmZDFlNWU3MDY4YWFlMWU0ZGQ6UkdCOkhJR0g=",
  "rgbUrl": "https://solar.googleapis.com/v1/geoTiff:get?id=NzQwNGQ0NmUyMzAzYWRiNmMxNzMwZTJhN2IxMTc4NDctOTI5YTNkZTlkM2MzYjRiNjE4MGNkODVmNjNiNDhkMzE6UkdCOkhJR0g=",
  "maskUrl": "https://solar.googleapis.com/v1/geoTiff:get?id=ZTk1YTBlZmY5Y2FhMThlNWYzMWEzZGZhYzEzMGQzOTAtM2Q4NmUyMmM5ZThjZmE0YjhhZWMwN2UzYzdmYmQ3ZjI6TUFTSzpISUdI",
  "annualFluxUrl": "https://solar.googleapis.com/v1/geoTiff:get?id=OTE0OWIxZDM3NmNlYjkzMWY2YjQyYjY5Y2RkYzNiOTAtZjU5YTVjZGQ3MzE3ZTQ4NTNmN2M4ZmY2MWZlZGZkMzg6QU5OVUFMX0ZMVVg6SElHSA==",
  "monthlyFluxUrl": "https://solar.googleapis.com/v1/geoTiff:get?id=Y2NhOGRhOWI2MjVmYmNiZTY3Njk4Yjk0MGJhNTk1NDUtY2MyYTI4NDJmN2Q5YTI0MmY2NDQyZGUwZWJkMWQ0ZDg6TU9OVEhMWV9GTFVYOkhJR0g=",
  "hourlyShadeUrls": [
    "https://solar.googleapis.com/v1/geoTiff:get?id=OWFhOTZmNDU2OGQyNTYxYWQ4YjZkYjQ5NWI4Zjg1ODItZGEwNDNhMmM3NDU0MTY2OGIzZDY2OGU1NTY0NTFlMzE6TU9OVEhMWV9GTFVYOkhJR0g=",
    "https://solar.googleapis.com/v1/geoTiff:get?id=MTI1ZTI2YzM1ZTRlYjA3ZDM4NWE2ODY4MjUzZmIxZTMtNTRmYTI3YmQyYzVjZDcyYjc5ZTlmMTRjZjBmYTk4OTk6TU9OVEhMWV9GTFVYOkhJR0g=",
    ...
  ],
  "imageryQuality": "HIGH"
}

रिस्पॉन्स का डेटा ऐक्सेस करें

रिस्पॉन्स यूआरएल के ज़रिए डेटा ऐक्सेस करने के लिए, पुष्टि करने की ज़रूरत होती है. अगर आपको पुष्टि करने की कुंजी है, तो आपको URL में अपनी API कुंजी जोड़नी होगी. अगर OAuth का इस्तेमाल किया जा रहा है, तो पुष्टि करने के लिए, आपको OAuth हेडर जोड़ने होंगे.

API कुंजी

जवाब में दिए गए यूआरएल पर अनुरोध करने के लिए, यूआरएल में अपनी एपीआई कुंजी जोड़ें:

curl -X GET "https://solar.googleapis.com/v1/solar/geoTiff:get?id=fbde33e9cd16d5fd10d19a19dc580bc1-8614f599c5c264553f821cd034d5cf32&key=YOUR_API_KEY"

अपने ब्राउज़र के यूआरएल बार में, cURL अनुरोध में यूआरएल चिपकाकर भी एचटीटीपी अनुरोध किए जा सकते हैं. एपीआई पासकोड पास करने से, आपको इस्तेमाल और विश्लेषण से जुड़ी बेहतर सुविधाएं मिलती हैं. साथ ही, जवाब के डेटा का ऐक्सेस भी बेहतर तरीके से कंट्रोल किया जा सकता है.

OAuth टोकन

जवाब में यूआरएल का अनुरोध करने के लिए, अपने बिलिंग प्रोजेक्ट का नाम और अपना OAuth टोकन पास करें:

curl -X GET \
-H 'X-Goog-User-Project: PROJECT_NUMBER_OR_ID' \
-H "Authorization: Bearer $TOKEN" \
"https://solar.googleapis.com/v1/solar/geoTiff:get?id=fbde33e9cd16d5fd10d19a19dc580bc1-8614f599c5c264553f821cd034d5cf32"
        

TypeScript

नीचे दिए गए उदाहरण में, पिक्सल डेटा वैल्यू पाने का तरीका बताया गया है ( किसी डिजिटल इमेज के अलग-अलग पिक्सल में सेव की गई जानकारी. इसमें ये शामिल हैं रंग मान और अन्य विशेषताएँ), अक्षांश और देशांतर की गणना करें और GeoTIFF से देशांतर पर जाएं और उसे TypeScript ऑब्जेक्ट में सेव करें.

इस उदाहरण के लिए, हमने टाइप चेकिंग की अनुमति दी है, जिससे टाइप की गड़बड़ियों को कम करता है, आपके कोड को भरोसेमंद बनाता है, और काम को आसान बनाता है बनाए रखें.

// npm install geotiff geotiff-geokeys-to-proj4 proj4

import * as geotiff from 'geotiff';
import * as geokeysToProj4 from 'geotiff-geokeys-to-proj4';
import proj4 from 'proj4';

/**
 * Downloads the pixel values for a Data Layer URL from the Solar API.
 *
 * @param  {string} url        URL from the Data Layers response.
 * @param  {string} apiKey     Google Cloud API key.
 * @return {Promise<GeoTiff>}  Pixel values with shape and lat/lon bounds.
 */
export async function downloadGeoTIFF(url: string, apiKey: string): Promise<GeoTiff> {
  console.log(`Downloading data layer: ${url}`);

  // Include your Google Cloud API key in the Data Layers URL.
  const solarUrl = url.includes('solar.googleapis.com') ? url + `&key=${apiKey}` : url;
  const response = await fetch(solarUrl);
  if (response.status != 200) {
    const error = await response.json();
    console.error(`downloadGeoTIFF failed: ${url}\n`, error);
    throw error;
  }

  // Get the GeoTIFF rasters, which are the pixel values for each band.
  const arrayBuffer = await response.arrayBuffer();
  const tiff = await geotiff.fromArrayBuffer(arrayBuffer);
  const image = await tiff.getImage();
  const rasters = await image.readRasters();

  // Reproject the bounding box into lat/lon coordinates.
  const geoKeys = image.getGeoKeys();
  const projObj = geokeysToProj4.toProj4(geoKeys);
  const projection = proj4(projObj.proj4, 'WGS84');
  const box = image.getBoundingBox();
  const sw = projection.forward({
    x: box[0] * projObj.coordinatesConversionParameters.x,
    y: box[1] * projObj.coordinatesConversionParameters.y,
  });
  const ne = projection.forward({
    x: box[2] * projObj.coordinatesConversionParameters.x,
    y: box[3] * projObj.coordinatesConversionParameters.y,
  });

  return {
    // Width and height of the data layer image in pixels.
    // Used to know the row and column since Javascript
    // stores the values as flat arrays.
    width: rasters.width,
    height: rasters.height,
    // Each raster reprents the pixel values of each band.
    // We convert them from `geotiff.TypedArray`s into plain
    // Javascript arrays to make them easier to process.
    rasters: [...Array(rasters.length).keys()].map((i) =>
      Array.from(rasters[i] as geotiff.TypedArray),
    ),
    // The bounding box as a lat/lon rectangle.
    bounds: {
      north: ne.y,
      south: sw.y,
      east: ne.x,
      west: sw.x,
    },
  };
}

आरजीबी लेयर को छोड़कर, सभी TIFF फ़ाइलें खाली इमेज के तौर पर दिखेंगी इमेज व्यूअर ऐप्लिकेशन में. डाउनलोड की गई TIFF फ़ाइलें देखने के लिए, उन्हें मैपिंग ऐप्लिकेशन सॉफ़्टवेयर, जैसे कि QGIS.

इस अनुरोध और इसके जवाब की पूरी जानकारी इस रेफ़रंस में दी गई है दस्तावेज़ में दिया गया है.