Method: dataLayers.get

אחזור מידע על אנרגיה סולארית באזור שמקיף מיקום מסוים. הפונקציה מחזירה שגיאה עם קוד NOT_FOUND אם המיקום נמצא מחוץ לאזור הכיסוי.

בקשת HTTP

GET https://solar.googleapis.com/v1/dataLayers:get

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

פרמטרים של שאילתה

פרמטרים
location

object (LatLng)

חובה. קו האורך וקו הרוחב של מרכז האזור שעבורו רוצים לקבל נתונים.
radiusMeters

number

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

  • תמיד אפשר לציין ערך של עד 100 מ'.
  • אפשר לציין ערכים מעל 100m, כל עוד radiusMeters <= pixelSizeMeters * 1000.
  • עם זאת, לערכים מעל 175m, השדה DataLayerView בבקשה לא יכול לכלול נתוני פליטה חודשיים או נתוני צל שעתי.
view

enum (DataLayerView)

אופציונלי. קבוצת המשנה הרצויה של הנתונים להחזרה.
requiredQuality

enum (ImageryQuality)

אופציונלי. רמת האיכות המינימלית המותרת בתוצאות. לא תוחזר תוצאה באיכות נמוכה יותר. אם לא מציינים את הערך הזה, המשמעות היא הגבלה לתמונות באיכות גבוהה בלבד.
pixelSizeMeters

number

אופציונלי. קנה המידה המינימלי, במטרים לכל פיקסל, של הנתונים שיוחזרו. הערכים הנתמכים הם 0.1 (ברירת המחדל, אם השדה הזה לא מוגדר באופן מפורש), 0.25, 0.5 ו-1.0. רכיבי תמונות שהרזולוציה הרגילה שלהם קטנה מ-pixelSizeMeters יחזרו ברזולוציה שצוינה ב-pixelSizeMeters. רכיבי תמונות שהרזולוציה הרגילה שלהם שווה ל-pixelSizeMeters או גדולה ממנה יחזרו ברזולוציה הרגילה הזו.
exactQualityRequired

boolean

אופציונלי. האם לדרוש איכות מדויקת של התמונות. אם הערך מוגדר כ-false, השדה requiredQuality מפורש כאיכות המינימלית הנדרשת, כך שיכול להיות שתוחזר תמונה באיכות גבוהה כשהערך של requiredQuality מוגדר כ-MEDIUM. אם הערך מוגדר כ-true, הערך requiredQuality מפורש כאיכות הנדרשת המדויקת, ורק תמונות באיכות MEDIUM יחזרו אם הערך של requiredQuality מוגדר כ-MEDIUM.
experiments[]

enum (Experiment)

אופציונלי. מציינים את הניסויים במצב טרום-זמינות לכלל המשתמשים שרוצים להפעיל.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם הפעולה מצליחה, גוף התגובה מכיל מופע של DataLayers.

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

  • https://www.googleapis.com/auth/cloud-platform

DataLayerView

קבוצת המשנה של המידע על האנרגיה הסולארית שתוחזר.

טיפוסים בני מנייה (enum)
DATA_LAYER_VIEW_UNSPECIFIED שווה ערך ל-FULL.
DSM_LAYER קבלת DSM בלבד.
IMAGERY_LAYERS מקבלים את ה-DSM, ה-RGB והמסכה.
IMAGERY_AND_ANNUAL_FLUX_LAYERS הצגת DSM,‏ RGB,‏ מסכה וזרימה שנתית.
IMAGERY_AND_ALL_FLUX_LAYERS הצגת DSM,‏ RGB,‏ מסכה, פליטה שנתית ופליטה חודשית.
FULL_LAYERS אחזור כל הנתונים.