Required. The longitude and latitude for the center of the region to get data for.
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 <= pixelSizeMeters * 1000.
However, for values over 175m, the DataLayerView in the request must not include monthly flux or hourly shade.
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.
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.
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.
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of DataLayers.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
DataLayerView
What subset of the solar information to return.
Enums
DATA_LAYER_VIEW_UNSPECIFIED
Equivalent to FULL.
DSM_LAYER
Get the DSM only.
IMAGERY_LAYERS
Get the DSM, RGB, and mask.
IMAGERY_AND_ANNUAL_FLUX_LAYERS
Get the DSM, RGB, mask, and annual flux.
IMAGERY_AND_ALL_FLUX_LAYERS
Get the DSM, RGB, mask, annual flux, and monthly flux.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-27 UTC."],[[["Retrieves solar information for a specified region using latitude, longitude, and radius."],["Allows customization of data retrieval with parameters like `view`, `requiredQuality`, `pixelSizeMeters`, and `exactQualityRequired`."],["Returns an error if the location is outside the coverage area or if radius exceeds limitations."],["Requires authorization with the `https://www.googleapis.com/auth/cloud-platform` scope."],["Response includes a `DataLayers` object containing the requested solar data subset if successful."]]],["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"]]
