Method: dataLayers.get
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
اطلاعات خورشیدی را برای منطقه اطراف یک مکان دریافت می کند. اگر مکان خارج از منطقه تحت پوشش باشد، یک خطا با کد NOT_FOUND برمی‌گرداند.
درخواست HTTP
GET https://solar.googleapis.com/v1/dataLayers:get
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای پرس و جو
| پارامترها |
|---|
location | object ( LatLng ) مورد نیاز. طول و عرض جغرافیایی مرکز منطقه برای دریافت اطلاعات. |
radiusMeters | number مورد نیاز. شعاع، بر حسب متر، تعیین کننده منطقه اطراف آن نقطه مرکزی است که داده ها باید برای آن برگردانده شوند. محدودیت های این مقدار عبارتند از: - هر مقدار تا 100 متر همیشه می تواند مشخص شود.
- تا زمانی که
radiusMeters <= pixelSizeMeters * 1000 می توان مقادیر بیش از 100 متر را مشخص کرد. - با این حال، برای مقادیر بیش از 175 متر،
DataLayerView در درخواست نباید شامل شار ماهانه یا سایه ساعتی باشد.
|
view | enum ( DataLayerView ) اختیاری. زیرمجموعه مورد نظر از داده ها برای بازگشت. |
requiredQuality | enum ( ImageryQuality ) اختیاری. حداقل سطح کیفی مجاز در نتایج. هیچ نتیجه ای با کیفیت پایین تر از این برگردانده نمی شود. عدم تعیین این معادل محدود کردن فقط به کیفیت بالا است. |
pixelSizeMeters | number اختیاری. حداقل مقیاس، بر حسب متر در هر پیکسل، داده هایی که باید برگردانده شوند. مقادیر 0.1 (به طور پیش فرض، اگر این فیلد به طور صریح تنظیم نشده باشد)، 0.25، 0.5، و 1.0 پشتیبانی می شوند. اجزای تصویری که وضوح معمولی آنها کمتر از pixelSizeMeters است با وضوح مشخص شده توسط pixelSizeMeters برگردانده می شوند. اجزای تصویری که وضوح طبیعی آنها مساوی یا بزرگتر از pixelSizeMeters است، با وضوح عادی برگردانده می شوند. |
exactQualityRequired | boolean اختیاری. آیا به کیفیت دقیق تصاویر نیاز است. اگر روی نادرست تنظیم شود، فیلد requiredQuality به عنوان حداقل کیفیت مورد نیاز تفسیر می شود، به این ترتیب که تصاویر با کیفیت بالا ممکن است در صورت تنظیم requiredQuality روی MEDIUM، برگردانده شوند. اگر روی درست تنظیم شود، requiredQuality به عنوان کیفیت دقیق مورد نیاز تفسیر می‌شود و فقط تصاویر با کیفیت MEDIUM برگردانده می‌شوند در صورتی که requiredQuality روی MEDIUM تنظیم شده باشد. |
experiments[] | enum ( Experiment ) اختیاری. آزمایش‌های قبل از GA را برای فعال کردن مشخص می‌کند. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از DataLayers است.
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/cloud-platform
DataLayerView
کدام زیرمجموعه از اطلاعات خورشیدی را برگرداند.
| Enums |
|---|
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 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-08-29 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-08-29 بهوقت ساعت هماهنگ جهانی."],[[["\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. |"]]
