Method: dataLayers.get

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

בקשת HTTP

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

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

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

פרמטרים
location

object (LatLng)

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

number

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

  • תמיד אפשר לציין ערך כלשהו עד 100 מיליון.
  • אפשר לציין ערכים מעל 100 מיליון, כל עוד 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, יכול להיות שיוחזרו תמונות באיכות HIGH. אם הערך הוא true,‏ requiredQuality מתפרש כאיכות הנדרשת המדויקת, ומוחזרות תמונות באיכות MEDIUM רק אם הערך של requiredQuality הוא MEDIUM.
experiments[]

enum (Experiment)

אופציונלי. מציינים את הניסויים בטרום-GA שרוצים להפעיל. בקשות שמשתמשות בשדה הזה מסווגות כמוצר בגרסת טרום-GA במסגרת התנאים הספציפיים לשירות של Google Maps Platform. למידע נוסף, אפשר לעיין ב[תיאורים של שלבי ההשקה]( https://cloud.google.com/maps-platform/terms/launch-stages).

גוף הבקשה

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

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של 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 קבלת כל הנתונים.