Veri katmanı isteğinde bulunma

dataLayers uç noktası, belirli bir konumu çevreleyen bölge için ayrıntılı güneş enerjisi bilgileri sağlar. Uç nokta, aşağıdakiler dahil olmak üzere 17 indirilebilir TIFF dosyası döndürür:

  • Dijital yüzey modeli (DSM)
  • RGB kompozit katman (havadan görüntüler)
  • Analizin sınırlarını belirleyen bir maske katmanı
  • Yıllık güneş akısı veya belirli bir yüzeyin yıllık verimi
  • Aylık güneş akısı veya belirli bir yüzeyin aylık getirisi
  • Saatlik gölge (24 saat)

Solar API'nin akışı nasıl tanımladığı hakkında daha fazla bilgi edinmek için Solar API Concepts'e bakın.

Veri katmanı istekleri hakkında

Aşağıdaki örnekte dataLayers yöntemine gönderilen bir REST isteğinin URL'si gösterilmektedir:

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

Aşağıdakileri belirten istek URL'si parametrelerinizi ekleyin:

  • Konumun enlem ve boylam koordinatları
  • Konumu çevreleyen bölgenin yarıçapı
  • Döndürülecek verilerin alt kümesi (DSM, RGB, maske, yıllık akı veya aylık akı)
  • Sonuçlarda izin verilen minimum kalite
  • Döndürülecek minimum veri ölçeği (metre başına piksel başına)

Örnek veri katmanları isteği

Aşağıdaki örnekte, konumun 100 metrelik bir yarıçapı içindeki tüm bina analizleri bilgileri, enlem = 37,4450 ve boylam = -122.1390 koordinatlarında istenir:

API anahtarı

Yanıttaki URL'ye bir istekte bulunmak için API anahtarınızı URL'ye ekleyin:

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&pixelSizeMeters=0.5&key=YOUR_API_KEY"

cURL isteğindeki URL'yi tarayıcınızın URL çubuğuna yapıştırarak da HTTP isteğinde bulunabilirsiniz. API anahtarının iletilmesi, daha iyi kullanım ve analiz özelliklerinin yanı sıra yanıt verilerine erişimi daha iyi kontrol etmenizi sağlar.

OAuth jetonu

Not: Bu biçim, yalnızca test ortamı içindir. Daha fazla bilgi edinmek için OAuth'u kullanma başlıklı makaleye göz atın.

Yanıttaki URL'ye bir istekte bulunmak için faturalandırma projenizin adını ve OAuth jetonunuzu iletin:

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"
        

TypeScript

Yanıttaki URL'ye bir istekte bulunmak için isteğe API anahtarınızı veya OAuth jetonunu ekleyin. Aşağıdaki örnekte API anahtarı kullanılmaktadır:

/**
 * 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;
    },
  );
}

Alanlar ve veri türü, TypeScript'te bir "type"dır. Bu örnekte, piksel değerleri ve enlem/boylam sınırlama kutusu gibi yanıttaki ilgili alanları depolamak için özel bir tür tanımlıyoruz. İsterseniz daha fazla alan ekleyebilirsiniz.

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

Veri türü tanımları

Aşağıdaki veri türleri desteklenir:

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'leri aşağıdaki biçimde döndürür:

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

Bu URL'ler, istenen verilerle GeoTIFF dosyalarına erişmek için kullanılabilir.

Örnek yanıt

İstek şu biçimde bir JSON yanıtı oluşturur:

{
  "imageryDate": {
    "year": 2019,
    "month": 7,
    "day": 9
  },
  "imageryProcessedDate": {
    "year": 2022,
    "month": 3,
    "day": 21
  },
  "dsmUrl": "https://solar.googleapis.com/v1/geoTiff:get?id=14f82e6931a8c33fc31ab8378e51804a-852f4ca7f056addda5b8fcb93e02c2fd",
  "rgbUrl": "https://solar.googleapis.com/v1/geoTiff:get?id=bf769c43d72eb85493b20df583bc0c95-d13126638efaa89e44951abc8664d6a3",
  "maskUrl": "https://solar.googleapis.com/v1/geoTiff:get?id=ed089240efc78e417c96a945460830ef-e666758b7cc183f82d1c7b7a891f858b",
  "annualFluxUrl": "https://solar.googleapis.com/v1/geoTiff:get?id=aaa2637073d62cc7331d067eb7080bbe-f94eab79915f66759f5265b2ff8b1ad4",
  "monthlyFluxUrl": "https://solar.googleapis.com/v1/geoTiff:get?id=d1608d342a3d0393b5decd063d330271-2a2e27504a2009cad1f1f3d2b471bcd3",
  "hourlyShadeUrls": [
    "https://solar.googleapis.com/v1/geoTiff:get?id=541c2f32b936f190f7562309ea1d60fc-432bf94bcd0dc918f0c828d07aa00e7c",
    "https://solar.googleapis.com/v1/geoTiff:get?id=4eb7a0b9c0f34e0e746816d0f3085274-4794b9eb35ab18ad4fbe2c3ee59f151d",
    ...
  ],
  "imageryQuality": "HIGH"
}

Yanıt verilerine erişme

Verilere yanıt URL'leri üzerinden erişmek için ek kimlik doğrulama gerekir. Kimlik doğrulama anahtarı kullanıyorsanız API anahtarınızı URL'ye eklemeniz gerekir. OAuth kimlik doğrulamasını kullanıyorsanız OAuth üstbilgileri eklemeniz gerekir.

API anahtarı

Yanıttaki URL'ye bir istekte bulunmak için API anahtarınızı URL'ye ekleyin:

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

cURL isteğindeki URL'yi tarayıcınızın URL çubuğuna yapıştırarak da HTTP isteğinde bulunabilirsiniz. API anahtarının iletilmesi, daha iyi kullanım ve analiz özelliklerinin yanı sıra yanıt verilerine erişimi daha iyi kontrol etmenizi sağlar.

OAuth jetonu

Yanıttaki URL'ye bir istekte bulunmak için faturalandırma projenizin adını ve OAuth jetonunuzu iletin:

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

Aşağıdaki örnekte, piksel veri değerlerinin (renk değerleri ve diğer özellikler dahil, bir dijital resmin bağımsız piksellerinde depolanan bilgiler), GeoTIFF'ten enlem ve boylamın nasıl hesaplanacağı ve bir TypeScript nesnesinde nasıl depolanacağı gösterilmektedir.

Bu özel örnekte, tür hatalarını azaltan, kodunuzun güvenilirliğini artıran ve bakımını kolaylaştıran tür kontrolüne izin vermeyi seçtik.

// 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 katmanı hariç, tüm TIFF dosyaları resim görüntüleyici uygulamalarında boş resim olarak görüntülenir. İndirilen TIFF dosyalarını görüntülemek için QGIS gibi bir eşleme uygulaması yazılımına aktarın.

Bu istek ve yanıtın tam spesifikasyonunu referans belgelerde bulabilirsiniz.