توفّر نقطة نهاية dataLayers معلومات تفصيلية عن مصادر الطاقة الشمسية. معلومات لمنطقة محيطة بموقع محدد. تقوم نقطة النهاية بإرجاع 17 ملف TIFF قابل للتنزيل، بما في ذلك:
- نموذج السطح الرقمي (DSM)
- الطبقة المركّبة بنموذج أحمر أخضر أزرق (صور جوية)
- يشير هذا المصطلح إلى طبقة قناع تحدّد حدود التحليل.
- التدفق السنوي للشمس أو الناتج السنوي لسطح معين
- تدفق الشمس الشهري أو الأرباح الشهرية لسطح معيّن
- خدمة الظل كل ساعة (على مدار 24 ساعة)
لمزيد من المعلومات عن كيفية تعريف واجهة برمجة التطبيقات Solar للتدفق، يمكنك الاطّلاع على مفاهيم Sollar API:
لمحة عن طلبات طبقات البيانات
يعرض المثال التالي عنوان URL لطلب REST المُرسَل إلى جهاز dataLayers
.
:
https://solar.googleapis.com/v1/dataLayers:get?parameters
أدرِج مَعلمات عنوان URL للطلب التي تحدِّد ما يلي:
- إحداثيات خط العرض وخط الطول للموقع
- النطاق الجغرافي للمنطقة المحيطة بالموقع الجغرافي
- المجموعة الفرعية من البيانات المراد عرضها (DSM أو نموذج أحمر أخضر أزرق أو قناع أو التدفق السنوي أو شهريًا التدفق)
- الحد الأدنى للجودة المسموح به في النتائج
- الحد الأدنى لمقياس البيانات المراد عرضها، بالمتر لكل بكسل
مثال على طلب طبقات البيانات
يطلب المثال التالي جميع معلومات إحصاءات المبنى في مقياس 100 متر نصف القطر للموقع عند إحداثيات خط العرض = 37.4450 خط الطول = -122.1390:
مفتاح واجهة برمجة التطبيقات
لتقديم طلب إلى عنوان URL في الردّ، أضِف مفتاح واجهة برمجة التطبيقات إلى عنوان URL:
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"
يمكنك أيضًا إجراء طلبات HTTP من خلال لصق عنوان URL في طلب cURL في شريط عنوان URL بالمتصفح. يؤدي تمرير مفتاح واجهة برمجة التطبيقات إلى توفير إمكانات أفضل للاستخدام والإحصاءات، والتحكّم بشكل أفضل في الوصول إلى بيانات الاستجابة.
رمز OAuth المميز
ملاحظة: هذا التنسيق مخصّص لبيئة اختبار فقط. لمزيد من المعلومات، يُرجى الاطّلاع على استخدام OAuth.
لإرسال طلب إلى عنوان URL في الردّ، أدخِل اسم مشروع الفوترة ورمز 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
لإرسال طلب إلى عنوان URL في الردّ، يجب تضمين إما واجهة برمجة التطبيقات أو رمز 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; }, ); }
الحقول ونوع البيانات هي "type" في 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; }; }
تعرض واجهة برمجة التطبيقات عناوين URL بالتنسيق التالي:
https://solar.googleapis.com/v1/solar/geoTiff:get?id=HASHED_ID
يمكن استخدام عناوين URL هذه للوصول إلى ملفات 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 للاستجابة مصادقة إضافية. في حال استخدام مفتاح مصادقة، فيجب عليك إلحاق مفتاح واجهة برمجة التطبيقات بعنوان URL. في حال استخدام OAuth يجب إضافة عناوين OAuth.
مفتاح واجهة برمجة التطبيقات
لتقديم طلب إلى عنوان URL في الردّ، أضِف مفتاح واجهة برمجة التطبيقات إلى عنوان URL:
curl -X GET "https://solar.googleapis.com/v1/solar/geoTiff:get?id=fbde33e9cd16d5fd10d19a19dc580bc1-8614f599c5c264553f821cd034d5cf32&key=YOUR_API_KEY"
يمكنك أيضًا إجراء طلبات HTTP من خلال لصق عنوان URL في طلب cURL في شريط عنوان URL بالمتصفح. يؤدي تمرير مفتاح واجهة برمجة التطبيقات إلى توفير إمكانات أفضل للاستخدام والإحصاءات، والتحكّم بشكل أفضل في الوصول إلى بيانات الاستجابة.
رمز OAuth المميز
لإرسال طلب إلى عنوان URL في الردّ، أدخِل اسم مشروع الفوترة ورمز 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.
يمكنك العثور على المواصفات الكاملة لهذا الطلب والردّ في المرجع. ذات الصلة.