dataLayers エンドポイントは、指定した場所周辺の太陽光発電についての詳細な情報を提供します。エンドポイントから、次のような 17 個のダウンロード可能な TIFF ファイルが返されます。
- 数値表層モデル(DSM)
- RGB 合成レイヤ(航空画像)
- 分析の境界を識別するマスクレイヤ
- 年間太陽光束、または特定の表面の年間降雨量
- 1 か月の太陽光束、または特定の地表の月間収量
- 1 時間ごとの日陰(24 時間)
Solar API がフラックスを定義する方法の詳細については、Solar API のコンセプトをご覧ください。
データレイヤのリクエストについて
次の例は、dataLayers
メソッドに対する REST リクエストの URL を示しています。
https://solar.googleapis.com/v1/dataLayers:get?parameters
以下を指定するリクエスト URL パラメータを含めます。
- 場所の緯度と経度の座標
- 地域を囲む地域の半径
- 返されるデータのサブセット(DSM、RGB、マスク、年間フラックス、または月間フラックス)
- 結果で許容される最低品質
- 返されるデータの最小スケール(ピクセルあたりのメートル単位)
データレイヤ リクエストの例
次の例では、緯度 = 37.4450、経度 = -122.1390 の座標のロケーションから、半径 100 m のすべての建物分析情報情報をリクエストします。
API キー
レスポンスの URL にリクエストを行うには、URL の末尾に 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 リクエストの URL をブラウザの URL バーに貼り付けて、HTTP リクエストを行うこともできます。API キーを渡すことで、使用状況や分析機能を利用しやすくなり、レスポンス データへのアクセス制御もしやすくなります。
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 にリクエストを送信するには、リクエストに API キーまたは OAuth トークンを含めます。次の例では、API キーを使用しています。
/** * 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 の「"type"」です。この例では、レスポンス内の目的のフィールド(ピクセル値や緯度/経度の境界ボックスなど)を格納するカスタムタイプを定義します。必要に応じて、さらにフィールドを含めることができます。
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; }; }
API は次の形式で 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=6d654a0300e454f4c6db7fff24d7ab98-f51261151c9d4c7e055dd21ce57fa3b5", "rgbUrl": "https://solar.googleapis.com/v1/geoTiff:get?id=7c71f407a36c1cd051f5ada9c17a6cb8-4b1a9e2b489656febfb7676f205aea1d", "maskUrl": "https://solar.googleapis.com/v1/geoTiff:get?id=814470096c53cb221b524119e1e2700c-ac51cf76452dd6c2e843e6b11922ccc0", "annualFluxUrl": "https://solar.googleapis.com/v1/geoTiff:get?id=e044991d7f376dc23f9abe8d4efc909b-982983cd98d0572b9d62ca0a2db38eb3", "monthlyFluxUrl": "https://solar.googleapis.com/v1/geoTiff:get?id=9b4638db10d2d58560b9f1e9fb013551-dff565175a1e6861a7afb62ece41e218", "hourlyShadeUrls": [ "https://solar.googleapis.com/v1/geoTiff:get?id=9aa96f4568d2561ad8b6db495b8f8582-da043a2c74541668b3d668e556451e31", "https://solar.googleapis.com/v1/geoTiff:get?id=125e26c35e4eb07d385a6868253fb1e3-54fa27bd2c5cd72b79e9f14cf0fa9899", ... ], "imageryQuality": "HIGH" }
レスポンス データにアクセスする
レスポンス URL を介してデータにアクセスするには、追加の認証が必要です。認証キーを使用する場合は、API キーを URL に追加する必要があります。OAuth 認証を使用する場合は、OAuth ヘッダーを追加する必要があります。
API キー
レスポンスの URL にリクエストを行うには、URL の末尾に API キーを追加します。
curl -X GET "https://solar.googleapis.com/v1/solar/geoTiff:get?id=fbde33e9cd16d5fd10d19a19dc580bc1-8614f599c5c264553f821cd034d5cf32&key=YOUR_API_KEY"
cURL リクエストの URL をブラウザの URL バーに貼り付けて、HTTP リクエストを行うこともできます。API キーを渡すことで、使用状況や分析機能を利用しやすくなり、レスポンス データへのアクセス制御もしやすくなります。
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, }, }; }
RGB レイヤを除き、画像ビューア アプリケーションではすべての TIFF ファイルが空白の画像として表示されます。ダウンロードした TIFF ファイルを表示するには、QGIS などの地図作成アプリケーション ソフトウェアにインポートします。
このリクエストとレスポンスの詳細な仕様については、リファレンス ドキュメントをご覧ください。