একটি ডেটা স্তর অনুরোধ করুন

ডেটালেয়ার এন্ডপয়েন্ট একটি নির্দিষ্ট অবস্থানের আশেপাশের একটি অঞ্চলের জন্য বিশদ সৌর তথ্য প্রদান করে। এন্ডপয়েন্ট 17টি ডাউনলোডযোগ্য TIFF ফাইল প্রদান করে, যার মধ্যে রয়েছে:

  • ডিজিটাল সারফেস মডেল (DSM)
  • RGB যৌগিক স্তর (বায়বীয় চিত্র)
  • একটি মুখোশ স্তর যা বিশ্লেষণের সীমানা চিহ্নিত করে
  • বার্ষিক সৌর প্রবাহ, বা প্রদত্ত পৃষ্ঠের বার্ষিক ফলন
  • মাসিক সৌর প্রবাহ, বা প্রদত্ত পৃষ্ঠের মাসিক ফলন
  • প্রতি ঘন্টায় ছায়া (24 ঘন্টা)

সোলার এপিআই কীভাবে ফ্লাক্সকে সংজ্ঞায়িত করে সে সম্পর্কে আরও তথ্যের জন্য, সোলার এপিআই ধারণাগুলি দেখুন।

তথ্য স্তর অনুরোধ সম্পর্কে

নিম্নলিখিত উদাহরণটি dataLayers পদ্ধতিতে একটি REST অনুরোধের URL দেখায়:

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

আপনার অনুরোধের URL প্যারামিটারগুলি অন্তর্ভুক্ত করুন যা নিম্নলিখিতগুলি নির্দিষ্ট করে:

  • অবস্থানের অক্ষাংশ এবং দ্রাঘিমাংশ স্থানাঙ্ক
  • অবস্থানের পার্শ্ববর্তী অঞ্চলের ব্যাসার্ধ
  • ফেরত দেওয়ার জন্য ডেটার উপসেট (DSM, RGB, মাস্ক, বার্ষিক ফ্লাক্স, বা মাসিক ফ্লাক্স)
  • ফলাফলে অনুমোদিত ন্যূনতম গুণমান
  • প্রতি পিক্সেলে মিটারে ডেটার ন্যূনতম স্কেল

উদাহরণ ডেটা স্তর অনুরোধ

নিম্নলিখিত উদাহরণটি অক্ষাংশ = 37.4450 এবং দ্রাঘিমাংশ = -122.1390 ​​এর স্থানাঙ্কে অবস্থানের জন্য 100 মিটার ব্যাসার্ধে সমস্ত বিল্ডিং অন্তর্দৃষ্টি তথ্যের জন্য অনুরোধ করে:

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

এছাড়াও আপনি আপনার ব্রাউজারের URL বারে cURL অনুরোধে 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"
        

টাইপস্ক্রিপ্ট

প্রতিক্রিয়াতে 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;
    },
  );
}

ক্ষেত্র এবং ডেটার ধরন টাইপস্ক্রিপ্টে একটি "টাইপ" । এই উদাহরণে, আমরা প্রতিক্রিয়াতে আগ্রহের ক্ষেত্রগুলি যেমন পিক্সেল মান এবং ল্যাট/লং বাউন্ডিং বক্স সংরক্ষণ করতে একটি কাস্টম প্রকার সংজ্ঞায়িত করি। আপনি পছন্দসই হিসাবে আরো ক্ষেত্র অন্তর্ভুক্ত করতে পারেন.

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 নিম্নলিখিত বিন্যাসে ইউআরএল প্রদান করে:

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

অনুরোধ করা ডেটা সহ জিওটিআইএফএফ ফাইলগুলি অ্যাক্সেস করতে এই URLগুলি ব্যবহার করা যেতে পারে৷

উদাহরণ প্রতিক্রিয়া

অনুরোধটি ফর্মটিতে একটি JSON প্রতিক্রিয়া তৈরি করে:

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

প্রতিক্রিয়া ডেটা অ্যাক্সেস করুন

প্রতিক্রিয়া URL-এর মাধ্যমে ডেটা অ্যাক্সেস করার জন্য অতিরিক্ত প্রমাণীকরণ প্রয়োজন। আপনি যদি একটি প্রমাণীকরণ কী ব্যবহার করেন, তাহলে আপনাকে অবশ্যই URL-এ আপনার API কী যুক্ত করতে হবে। আপনি যদি OAuth প্রমাণীকরণ ব্যবহার করেন, তাহলে আপনাকে অবশ্যই OAuth শিরোনাম যোগ করতে হবে।

API কী

প্রতিক্রিয়াতে URL-এ একটি অনুরোধ করতে, URL-এ আপনার API কী যুক্ত করুন:

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

এছাড়াও আপনি আপনার ব্রাউজারের URL বারে cURL অনুরোধে 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"
        

টাইপস্ক্রিপ্ট

নিচের উদাহরণটি দেখায় কিভাবে পিক্সেল ডেটা মান (রঙের মান এবং অন্যান্য বৈশিষ্ট্য সহ একটি ডিজিটাল চিত্রের পৃথক পিক্সেলে সংরক্ষিত তথ্য), 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৷

এই অনুরোধ এবং প্রতিক্রিয়ার সম্পূর্ণ স্পেসিফিকেশন রেফারেন্স ডকুমেন্টেশনে রয়েছে।