dataLayers एंडपॉइंट, किसी खास जगह के आस-पास के इलाके के लिए, सोलर एनर्जी से जुड़ी ज़्यादा जानकारी देता है. एंडपॉइंट, डाउनलोड की जा सकने वाली 17 TIFF फ़ाइलें दिखाता है. इनमें ये शामिल हैं:
- डिजिटल सर्फ़ेस मॉडल (डीएसएम)
- आरजीबी कंपोज़िट लेयर (हवाई फ़ोटोग्राफ़ी)
- विश्लेषण की सीमाओं की पहचान करने वाली मास्क लेयर
- सालाना सोलर फ़्लक्स या किसी सतह की सालाना पैदावार
- हर महीने मिलने वाला सौर फ़्लक्स या किसी सतह से हर महीने मिलने वाला पैदावार
- हर घंटे की छाया (24 घंटे)
Solar API, फ़्लक्स की परिभाषा कैसे तय करता है, इस बारे में ज़्यादा जानने के लिए, Solar API के कॉन्सेप्ट देखें.
डेटा लेयर के अनुरोधों के बारे में जानकारी
यहां दिए गए उदाहरण में, dataLayers
method के लिए REST अनुरोध का यूआरएल दिखाया गया है:
https://solar.googleapis.com/v1/dataLayers:get?parameters
अनुरोध यूआरएल के ऐसे पैरामीटर शामिल करें जिनसे ये चीज़ें पता चलें:
- जगह के अक्षांश और देशांतर के निर्देशांक
- जगह के आस-पास के इलाके का दायरा
- दिखाए जाने वाले डेटा का सबसेट (डीएसएम, आरजीबी, मास्क, सालाना फ़्लक्स या महीने का फ़्लक्स)
- नतीजों में कम से कम इतनी क्वालिटी की अनुमति है
- डेटा का कम से कम स्केल, पिक्सल के हिसाब से मीटर में
डेटा लेयर के अनुरोध का उदाहरण
नीचे दिए गए उदाहरण में, अक्षांश = 37.4450 और देशांतर = -122.1390 के निर्देशांक वाली जगह के लिए, 100 मीटर के दायरे में मौजूद इमारत की अहम जानकारी का अनुरोध किया गया है:
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"
}
रिस्पॉन्स का डेटा ऐक्सेस करना
रिस्पॉन्स यूआरएल के ज़रिए डेटा ऐक्सेस करने के लिए, पुष्टि करने की ज़रूरत होती है. अगर पुष्टि करने के लिए कुंजी का इस्तेमाल किया जाता है, तो आपको यूआरएल में अपनी एपीआई कुंजी जोड़नी होगी. अगर पुष्टि करने के लिए 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,
},
};
}
RGB लेयर को छोड़कर, सभी TIFF फ़ाइलें इमेज व्यूअर ऐप्लिकेशन में खाली इमेज के तौर पर दिखेंगी. डाउनलोड की गई TIFF फ़ाइलें देखने के लिए, उन्हें QGIS जैसे मैपिंग ऐप्लिकेशन सॉफ़्टवेयर में इंपोर्ट करें.
इस अनुरोध और रिस्पॉन्स की पूरी जानकारी, रेफ़रंस दस्तावेज़ में दी गई है.