Method: dataLayers.get
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recebe informações solares para uma região ao redor de um local. Retorna um erro com o código NOT_FOUND se o local estiver fora da área de cobertura.
Solicitação HTTP
GET https://solar.googleapis.com/v1/dataLayers:get
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de consulta
| Parâmetros |
location |
object (LatLng)
Obrigatório. A longitude e a latitude do centro da região para extrair dados.
|
radiusMeters |
number
Obrigatório. O raio, em metros, que define a região ao redor do ponto central para que os dados serão retornados. As limitações desse valor são:
- É possível especificar qualquer valor até 100 m.
- Valores acima de 100 m podem ser especificados, desde que
radiusMeters <= pixelSizeMeters * 1000.
- No entanto, para valores acima de 175 m, o
DataLayerView na solicitação não pode incluir fluxo mensal ou sombra por hora.
|
view |
enum (DataLayerView)
Opcional. O subconjunto de dados desejado a ser retornado.
|
requiredQuality |
enum (ImageryQuality)
Opcional. O nível mínimo de qualidade permitido nos resultados. Nenhum resultado com qualidade inferior a esse será retornado. Não especificar isso é equivalente a restringir apenas a qualidade ALTA.
|
pixelSizeMeters |
number
Opcional. A escala mínima, em metros por pixel, dos dados a serem retornados. Os valores 0,1 (padrão, se esse campo não for definido explicitamente), 0,25, 0,5 e 1,0 são aceitos. Os componentes de imagem com resolução normal inferior a pixelSizeMeters serão retornados na resolução especificada por pixelSizeMeters. Os componentes de imagem com resolução normal igual ou superior a pixelSizeMeters serão retornados nessa resolução normal.
|
exactQualityRequired |
boolean
Opcional. Se a qualidade exata das imagens é necessária. Se definido como "false", o campo requiredQuality é interpretado como a qualidade mínima necessária. Assim, imagens de ALTA qualidade podem ser retornadas quando requiredQuality é definido como MEDIUM. Se definido como "true", requiredQuality é interpretado como a qualidade exata necessária, e apenas imagens de qualidade MEDIUM são retornadas se requiredQuality for definido como MEDIUM.
|
experiments[] |
enum (Experiment)
Opcional. Especifica os experimentos pré-GA a serem ativados.
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de DataLayers.
Escopos de autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/cloud-platform
DataLayerView
Qual subconjunto das informações solares retornar.
| Enums |
DATA_LAYER_VIEW_UNSPECIFIED |
É equivalente a "FULL". |
DSM_LAYER |
Receber apenas o DSM. |
IMAGERY_LAYERS |
Receba o DSM, o RGB e a máscara. |
IMAGERY_AND_ANNUAL_FLUX_LAYERS |
Receba o DSM, RGB, máscara e fluxo anual. |
IMAGERY_AND_ALL_FLUX_LAYERS |
Receba o DSM, RGB, máscara, fluxo anual e fluxo mensal. |
FULL_LAYERS |
Receber todos os dados. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-08-29 UTC.
[null,null,["Última atualização 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. |"]]
