تقديم طلب لطبقة البيانات

توفر نقطة نهاية dataLayers معلومات مفصلة عن الطاقة الشمسية لمنطقة تحيط بموقع محدد. تعرض نقطة النهاية 17 ملف TIFF قابل للتنزيل، بما في ذلك:

  • نموذج السطح الرقمي (DSM)
  • الطبقة المركّبة بنموذج أحمر أخضر أزرق (صور جوية)
  • يشير هذا المصطلح إلى طبقة قناع تحدِّد حدود التحليل.
  • التدفق الشمسي السنوي أو العائد السنوي لسطح معيّن
  • التدفق الشمسي الشهري، أو العائد الشهري لسطح معيّن
  • ظلال ساعة (24 ساعة)

لمزيد من المعلومات حول كيفية تعريف Solar API للتدفق، يُرجى الاطّلاع على Solar API Concepts.

لمحة عن طلبات طبقات البيانات

يوضح المثال التالي عنوان URL لطلب REST إلى الطريقة dataLayers:

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

يمكنك تضمين مَعلمات عناوين URL للطلب التي تحدِّد ما يلي:

  • إحداثيات خط العرض وخط الطول للموقع
  • نصف قطر المنطقة المحيطة بالموقع الجغرافي
  • المجموعة الفرعية من البيانات المراد عرضها (DSM أو RGB أو القناع أو التدفق السنوي أو التدفق الشهري)
  • أدنى جودة مسموح بها في النتائج
  • الحد الأدنى لمقياس البيانات المطلوب عرضها، بالمتر لكل بكسل

مثال على طلب طبقات البيانات

يطلب المثال التالي جميع معلومات إحصاءات المباني في نصف قطر 100 متر للموقع في إحداثيات خط العرض = 37.4450 وخط الطول = -122.1390:

مفتاح واجهة برمجة التطبيقات

لتقديم طلب إلى عنوان URL في الردّ، عليك إلحاق مفتاح واجهة برمجة التطبيقات بعنوان 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&pixelSizeMeters=0.5&key=YOUR_API_KEY"

يمكنك أيضًا إجراء طلبات HTTP من خلال لصق عنوان URL في طلب cURL في شريط عناوين URL في المتصفّح. ويتيح لك تمرير مفتاح واجهة برمجة التطبيقات إمكانات أفضل لاستخدام الإحصاءات والتحكُّم بشكل أفضل في الوصول إلى بيانات الردود.

رمز 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 بالتنسيق التالي:

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

مثال على إجابة

وسينتج عن الطلب استجابة 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 إذا كنت تستخدم مصادقة OAuth، يجب إضافة عناوين OAuth.

مفتاح واجهة برمجة التطبيقات

لتقديم طلب إلى عنوان URL في الردّ، عليك إلحاق مفتاح واجهة برمجة التطبيقات بعنوان URL:

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

يمكنك أيضًا إجراء طلبات HTTP من خلال لصق عنوان URL في طلب cURL في شريط عناوين URL في المتصفّح. ويتيح لك تمرير مفتاح واجهة برمجة التطبيقات إمكانات أفضل لاستخدام الإحصاءات والتحكُّم بشكل أفضل في الوصول إلى بيانات الردود.

رمز 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"
        

وباستثناء طبقة نموذج أحمر أخضر أزرق، سيتم عرض جميع ملفات TIFF كصور فارغة في تطبيقات عارض الصور. لعرض ملفات TIFF التي تم تنزيلها، يمكنك استيرادها إلى برنامج تطبيق ربط، مثل QGIS.

يمكنك الاطّلاع على المواصفات الكاملة لهذا الطلب والردّ في المستندات المرجعية.