שליחת בקשה לשכבות נתונים

מפתחים באזור הכלכלי האירופי (EEA)

נקודת הקצה dataLayers מספקת מידע מפורט על אנרגיה סולארית באזור שמקיף מיקום מסוים. נקודת הקצה מחזירה 17 קובצי TIFF להורדה, כולל:

  • מודל דיגיטלי של פני השטח (DSM)
  • שכבה משולבת של RGB (תצלומי אוויר)
  • שכבת מסכה שמזהה את הגבולות של הניתוח
  • שטף סולארי שנתי, או התפוקה השנתית של משטח נתון
  • שטף סולארי חודשי, או התפוקה החודשית של משטח נתון
  • גוון שעתי (24 שעות)

מידע נוסף על האופן שבו Solar API מגדיר שטף זמין במאמר מושגים ב-Solar API.

מידע על בקשות של שכבות נתונים

בדוגמה הבאה מוצגת כתובת ה-URL של בקשת REST לשיטת dataLayers:

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

כוללים את הפרמטרים של כתובת ה-URL של הבקשה שמציינים את הפרטים הבאים:

  • קואורדינטות של קו הרוחב וקו האורך של המיקום
  • הרדיוס של האזור שמסביב למיקום
  • קבוצת המשנה של הנתונים שרוצים להחזיר (DSM,‏ RGB, מסכה, שטף שנתי או שטף חודשי)
  • האיכות המינימלית שמותרת בתוצאות
  • הקנה מידה המינימלי של הנתונים שיוחזרו, במטרים לכל פיקסל

דוגמה לבקשה של שכבות נתונים

בדוגמה הבאה מוצגת בקשה לקבלת כל נתוני התובנות לגבי בניין ברדיוס של 100 מטרים למיקום בקואורדינטות latitude = 37.4450 ו-longitude = -122.1390:

מפתח API

כדי לשלוח בקשה לכתובת ה-URL בתגובה, מוסיפים את מפתח ה-API לכתובת ה-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 של הדפדפן. העברת מפתח ה-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;
    },
  );
}
solar.ts

שדות וסוגי נתונים הם 'סוג' ב-TypeScript. בדוגמה הזו, אנחנו מגדירים סוג מותאם אישית לאחסון השדות שמעניינים אותנו בתגובה, כמו ערכי הפיקסלים והתיבה התוחמת של קווי הרוחב והאורך. אפשר לכלול עוד שדות לפי הצורך.

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

הגדרות של סוגי נתונים

סוגי הנתונים הנתמכים:

‫
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

ה-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=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 של תגובות, צריך לבצע אימות נוסף. אם משתמשים במפתח אימות, צריך לצרף את מפתח ה-API לכתובת ה-URL. אם אתם משתמשים באימות OAuth, אתם צריכים להוסיף כותרות OAuth.

מפתח API

כדי לשלוח בקשה לכתובת ה-URL בתגובה, מוסיפים את מפתח ה-API לכתובת ה-URL:

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

אפשר גם לשלוח בקשות HTTP על ידי הדבקת כתובת ה-URL בבקשת cURL בסרגל כתובות ה-URL של הדפדפן. העברת מפתח ה-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,
    },
  };
}
solar.ts

חוץ משכבת ה-RGB, כל קובצי ה-TIFF יוצגו כתמונות ריקות באפליקציות לצפייה בתמונות. כדי להציג קובצי TIFF שהורדתם, צריך לייבא אותם לתוכנת מיפוי, כמו QGIS.

המפרט המלא של הבקשה והתגובה האלה מופיע במסמכי העזר.

הבא
מידע על קובצי GeoTIFF