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 |
אחזור כל הנתונים. |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-08-29 (שעון UTC).
[null,null,["עדכון אחרון: 2025-08-29 (שעון UTC)."],[[["\u003cp\u003eRetrieves solar information for a specified region using latitude, longitude, and radius.\u003c/p\u003e\n"],["\u003cp\u003eAllows customization of data retrieval with parameters like \u003ccode\u003eview\u003c/code\u003e, \u003ccode\u003erequiredQuality\u003c/code\u003e, \u003ccode\u003epixelSizeMeters\u003c/code\u003e, and \u003ccode\u003eexactQualityRequired\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eReturns an error if the location is outside the coverage area or if radius exceeds limitations.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes a \u003ccode\u003eDataLayers\u003c/code\u003e object containing the requested solar data subset if successful.\u003c/p\u003e\n"]]],["This content details how to retrieve solar information for a specific region via a `GET` request to `https://solar.googleapis.com/v1/dataLayers:get`. The request requires parameters like `location` (latitude/longitude), `radiusMeters`, and optional parameters including `view`, `requiredQuality`, `pixelSizeMeters` and `exactQualityRequired`. The body is empty and a successful response will provide solar data via `DataLayers`. Specific authorization scope `https://www.googleapis.com/auth/cloud-platform` is required. `DataLayerView` allows one to define the solar information subset to be retrieved.\n"],null,["# Method: dataLayers.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [DataLayerView](#DataLayerView)\n- [Try it!](#try-it)\n\nGets solar information for a region surrounding a location. Returns an error with code `NOT_FOUND` if the location is outside the coverage area.\n\n### HTTP request\n\n`GET https://solar.googleapis.com/v1/dataLayers:get`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `location` | `object (`[LatLng](/maps/documentation/solar/reference/rest/v1/LatLng)`)` Required. The longitude and latitude for the center of the region to get data for. |\n| `radiusMeters` | `number` Required. The radius, in meters, defining the region surrounding that centre point for which data should be returned. The limitations on this value are: - Any value up to 100m can always be specified. - Values over 100m can be specified, as long as `radiusMeters` \\\u003c= `pixelSizeMeters * 1000`. - However, for values over 175m, the `DataLayerView` in the request must not include monthly flux or hourly shade. |\n| `view` | `enum (`[DataLayerView](/maps/documentation/solar/reference/rest/v1/dataLayers/get#DataLayerView)`)` Optional. The desired subset of the data to return. |\n| `requiredQuality` | `enum (`[ImageryQuality](/maps/documentation/solar/reference/rest/v1/dataLayers#ImageryQuality)`)` Optional. The minimum quality level allowed in the results. No result with lower quality than this will be returned. Not specifying this is equivalent to restricting to HIGH quality only. |\n| `pixelSizeMeters` | `number` Optional. The minimum scale, in meters per pixel, of the data to return. Values of 0.1 (the default, if this field is not set explicitly), 0.25, 0.5, and 1.0 are supported. Imagery components whose normal resolution is less than `pixelSizeMeters` will be returned at the resolution specified by `pixelSizeMeters`; imagery components whose normal resolution is equal to or greater than `pixelSizeMeters` will be returned at that normal resolution. |\n| `exactQualityRequired` | `boolean` Optional. Whether to require exact quality of the imagery. If set to false, the `requiredQuality` field is interpreted as the minimum required quality, such that HIGH quality imagery may be returned when `requiredQuality` is set to MEDIUM. If set to true, `requiredQuality` is interpreted as the exact required quality and only `MEDIUM` quality imagery is returned if `requiredQuality` is set to `MEDIUM`. |\n| `experiments[]` | `enum (`[Experiment](/maps/documentation/solar/reference/rest/v1/Experiment)`)` Optional. Specifies the pre-GA experiments to enable. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [DataLayers](/maps/documentation/solar/reference/rest/v1/dataLayers#DataLayers).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nDataLayerView\n-------------\n\nWhat subset of the solar information to return.\n\n| Enums ||\n|----------------------------------|--------------------------------------------------------|\n| `DATA_LAYER_VIEW_UNSPECIFIED` | Equivalent to FULL. |\n| `DSM_LAYER` | Get the DSM only. |\n| `IMAGERY_LAYERS` | Get the DSM, RGB, and mask. |\n| `IMAGERY_AND_ANNUAL_FLUX_LAYERS` | Get the DSM, RGB, mask, and annual flux. |\n| `IMAGERY_AND_ALL_FLUX_LAYERS` | Get the DSM, RGB, mask, annual flux, and monthly flux. |\n| `FULL_LAYERS` | Get all data. |"]]
