Endpoint dataLayers menyediakan panel surya yang mendetail informasi untuk wilayah yang mengelilingi lokasi tertentu. Endpoint menampilkan 17 file TIFF yang dapat didownload, termasuk:
- Model platform digital (DSM)
- Lapisan komposit RGB (citra udara)
- Lapisan mask yang mengidentifikasi batas-batas analisis
- Fluks matahari tahunan, atau hasil tahunan dari permukaan tertentu
- Fluks matahari bulanan, atau hasil bulanan dari permukaan tertentu
- Bayangan setiap jam (24 jam)
Untuk informasi selengkapnya tentang cara Solar API mendefinisikan fluks, lihat Konsep Solar API.
Tentang permintaan lapisan data
Contoh berikut menunjukkan URL permintaan REST ke dataLayers
berikut:
https://solar.googleapis.com/v1/dataLayers:get?parameters
Sertakan parameter URL permintaan Anda yang menentukan hal berikut:
- Koordinat lintang dan bujur lokasi
- Radius wilayah di sekitar lokasi
- Subset data yang akan ditampilkan (DSM, RGB, mask, fluks tahunan, atau bulanan fluks)
- Kualitas minimum yang diizinkan dalam hasil
- Skala minimum data yang akan ditampilkan, dalam meter per piksel
Contoh permintaan lapisan data
Contoh berikut meminta semua informasi insight gedung dalam jarak 100 meter radius untuk lokasi pada koordinat lintang = 37,4450 dan bujur = -122,1390:
Kunci API
Untuk membuat permintaan ke URL dalam respons, tambahkan kunci API Anda ke 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"
Anda juga dapat membuat permintaan HTTP dengan menempelkan URL dalam permintaan cURL ke kolom URL browser Anda. Dengan meneruskan kunci API, Anda akan memiliki kemampuan penggunaan dan analisis yang lebih baik serta kontrol akses yang lebih baik ke data respons.
Token OAuth
Catatan: Format ini hanya untuk lingkungan pengujian. Untuk informasi selengkapnya, lihat Menggunakan OAuth.
Untuk membuat permintaan ke URL dalam respons, teruskan nama project penagihan dan token OAuth Anda:
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
Untuk membuat permintaan ke URL dalam respons, sertakan API Anda atau token OAuth di dalam permintaan. Contoh berikut menggunakan API kunci:
/** * 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; }, ); }
Kolom dan jenis data adalah "type" di TypeScript. Dalam contoh ini, kami menentukan jenis kustom untuk menyimpan kolom minat dalam respons, seperti nilai piksel dan kotak pembatas lintang/bujur. Anda dapat menyertakan lebih banyak kolom sesuai keinginan.
export interface GeoTiff { width: number; height: number; rasters: Array<number>[]; bounds: Bounds; }
Definisi tipe data
Jenis data berikut ini didukung:
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; }; }
API menampilkan URL dalam format berikut:
https://solar.googleapis.com/v1/solar/geoTiff:get?id=HASHED_ID
URL ini dapat digunakan untuk mengakses file GeoTIFF dengan data yang diminta.
Contoh respons
Permintaan tersebut menghasilkan respons JSON dalam bentuk:
{ "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" }
Mengakses data respons
Mengakses data melalui URL respons memerlukan autentikasi tambahan. Jika Anda menggunakan kunci autentikasi, Anda harus menambahkan kunci API ke URL. Jika Anda menggunakan OAuth autentikasi, Anda harus menambahkan header OAuth.
Kunci API
Untuk membuat permintaan ke URL dalam respons, tambahkan kunci API Anda ke URL:
curl -X GET "https://solar.googleapis.com/v1/solar/geoTiff:get?id=fbde33e9cd16d5fd10d19a19dc580bc1-8614f599c5c264553f821cd034d5cf32&key=YOUR_API_KEY"
Anda juga dapat membuat permintaan HTTP dengan menempelkan URL dalam permintaan cURL ke kolom URL browser Anda. Dengan meneruskan kunci API, Anda akan memiliki kemampuan penggunaan dan analisis yang lebih baik serta kontrol akses yang lebih baik ke data respons.
Token OAuth
Untuk membuat permintaan ke URL dalam respons, teruskan nama project penagihan dan token OAuth Anda:
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
Contoh berikut menampilkan cara mendapatkan nilai data piksel (nilai informasi yang disimpan dalam {i>pixel<i} individual sebuah gambar digital, termasuk nilai warna dan atribut lainnya), hitung garis lintang dan garis bujur dari GeoTIFF, dan simpan dalam objek TypeScript.
Untuk contoh khusus ini, kami memilih untuk mengizinkan pemeriksaan jenis, mengurangi kesalahan jenis, menambah keandalan kode, dan membuatnya lebih mudah untuk pertahankan.
// 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, }, }; }
Dengan pengecualian lapisan RGB, semua file TIFF akan ditampilkan sebagai gambar kosong pada aplikasi penampil gambar. Untuk melihat file TIFF yang diunduh, impor ke dalam perangkat lunak aplikasi pemetaan, seperti QGIS.
Spesifikasi lengkap permintaan dan respons ini ada dalam referensi dokumentasi tambahan.