Wysyłanie żądania warstwy danych

Punkt końcowy dataLayers udostępnia szczegółowe informacje o energii słonecznej w regionie otaczającym określoną lokalizację. Punkt końcowy zwraca 17 plików TIFF do pobrania, w tym:

• Cyfrowy model powierzchni (DSM)
• Warstwy RGB (zdjęcia lotnicze)
• Warstwa maski, która określa granice analizy
• Roczny strumień energii słonecznej lub roczny plon danej powierzchni
• Miesięczny natężenie promieniowania słonecznego lub miesięczny plon danej powierzchni
• Cień godzinny (24 godziny)

Więcej informacji o tym, jak interfejs Solar API definiuje natężenie, znajdziesz w artykule Koncepcje dotyczące interfejsu Solar API.

Prośby o warstwy danych

Ten przykład pokazuje adres URL żądania REST do metody dataLayers:

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

Dołącz parametry adresu URL żądania, które określają:

• Współrzędne geograficzne lokalizacji
• Promień obszaru otaczającego lokalizację
• Podzbiór danych do zwrócenia (DSM, RGB, maska, roczny lub miesięczny flux)
• minimalna dopuszczalna jakość wyników,
• Minimalna skala danych do zwrócenia, w metrach na piksele

Przykład żądania warstw danych

W tym przykładzie żądamy wszystkich informacji o budynku w promieniu 100 metrów od lokalizacji o współrzędnych: szerokość geograficzna = 37,4450, długość geograficzna = -122,1390:

Klucz interfejsu API

Aby wysłać żądanie do adresu URL w odpowiedzi, dodaj do niego klucz interfejsu 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"

Możesz też wysyłać żądania HTTP, wklejając adres URL w żądaniu cURL na pasku adresu przeglądarki. Przekazanie klucza interfejsu API zapewnia lepsze możliwości korzystania i analizy oraz lepszą kontrolę dostępu do danych odpowiedzi.

Token OAuth

Uwaga: ten format jest przeznaczony tylko do środowiska testowego. Więcej informacji znajdziesz w artykule Używanie OAuth.

Aby przesłać żądanie do adresu URL w odpowiedzi, podaj nazwę projektu rozliczeniowego i token 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

Aby wysłać żądanie do adresu URL w odpowiedzi, dodaj do żądania klucz interfejsu API lub token OAuth. W tym przykładzie użyto klucza interfejsu 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;
    },
  );
}
solar.ts

Uwaga: przeczytaj przewodnik po korzystaniu z TypeScript i Map Google.

Pola i typy danych to „typy” w TypeScript. W tym przykładzie definiujemy typ niestandardowy, aby przechowywać w odpowiedzi pola, które nas interesują, takie jak wartości pikseli i ramka ograniczająca lat/long. W razie potrzeby możesz dodać więcej pól.

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

Uwaga: przeczytaj przewodnik po korzystaniu z TypeScript i Map Google.

Definicje typów danych

Obsługiwane są te typy danych:

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;
  };
}
solar.ts

Uwaga: przeczytaj przewodnik po korzystaniu z TypeScript i Map Google.

Interfejs API zwraca adresy URL w tym formacie:

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

Za pomocą tych adresów URL można uzyskać dostęp do plików GeoTIFF z wymaganymi danymi.

Przykładowa odpowiedź

Żądanie powoduje odpowiedź JSON w formie:

{
  "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"
}

Dostęp do danych odpowiedzi

Dostęp do danych za pomocą adresów URL odpowiedzi wymaga dodatkowego uwierzytelnienia. Jeśli używasz klucza uwierzytelniania, musisz dodać klucz interfejsu API do adresu URL. Jeśli używasz uwierzytelniania OAuth, musisz dodać nagłówki OAuth.

Klucz interfejsu API

Aby wysłać żądanie do adresu URL w odpowiedzi, dodaj do niego klucz interfejsu API:

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

Możesz też wysyłać żądania HTTP, wklejając adres URL w żądaniu cURL na pasku adresu przeglądarki. Przekazanie klucza interfejsu API zapewnia lepsze możliwości korzystania i analizy oraz lepszą kontrolę dostępu do danych odpowiedzi.

Token OAuth

Aby przesłać żądanie do adresu URL w odpowiedzi, podaj nazwę projektu rozliczeniowego i token 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

Ten przykład pokazuje, jak pobierać wartości danych pikseli (informacje przechowywane w poszczególnych pikselach obrazu cyfrowego, w tym wartości kolorów i inne atrybuty), obliczać szerokość i długość geograficzną z pliku GeoTIFF oraz przechowywać je w obiekcie TypeScript.

W tym przykładzie zdecydowaliśmy się na zezwolenie na sprawdzanie typu, co zmniejsza liczbę błędów typów, zwiększa niezawodność kodu i ułatwia jego utrzymanie.

// 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,
    },
  };
}
solar.ts

Uwaga: przeczytaj przewodnik po korzystaniu z TypeScript i Map Google.

Wszystkie pliki TIFF (z wyjątkiem warstwy RGB) będą wyświetlane jako puste obrazy w aplikacji do wyświetlania obrazów. Aby wyświetlić pobrane pliki TIFF, zaimportuj je do aplikacji do tworzenia map, takiej jak QGIS.

Pełna specyfikacja tego żądania i odpowiedzi znajduje się w dokumentacji referencyjnej.

Uwaga: adresy URL odpowiedzi są aktywne tylko przez 1 godzinę od momentu wysłania żądania. Aby uzyskać dostęp do adresów URL po upływie tego czasu, musisz ponownie wysłać żądanie do punktu końcowego dataLayers.