@googlemaps/solar 0.5.2 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -77,7 +77,6 @@ Samples are in the [`samples/`][homepage_samples] directory. Each sample's `READ
77
77
 
78
78
  | Sample | Source Code |
79
79
  | --------------------------- | --------------------------------- |
80
- | maps | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-solar/samples/generated/v1/snippet_metadata_google.maps.solar.v1.json) |
81
80
  | find closest building insights | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-solar/samples/generated/v1/solar.find_closest_building_insights.js) |
82
81
  | get data layers | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-solar/samples/generated/v1/solar.get_data_layers.js) |
83
82
  | get geo tiff | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-solar/samples/generated/v1/solar.get_geo_tiff.js) |
@@ -114,7 +113,7 @@ More Information: [Google Cloud Platform Launch Stages][launch_stages]
114
113
 
115
114
  ## Contributing
116
115
 
117
- Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-solar/CONTRIBUTING.md).
116
+ Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md).
118
117
 
119
118
  Please note that this `README.md`
120
119
  and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)
@@ -124,7 +123,7 @@ are generated from a central template.
124
123
 
125
124
  Apache Version 2.0
126
125
 
127
- See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-solar/LICENSE)
126
+ See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
128
127
 
129
128
  [shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
130
129
  [projects]: https://console.cloud.google.com/project
@@ -1,4 +1,4 @@
1
- // Copyright 2025 Google LLC
1
+ // Copyright 2026 Google LLC
2
2
  //
3
3
  // Licensed under the Apache License, Version 2.0 (the "License");
4
4
  // you may not use this file except in compliance with the License.
@@ -85,8 +85,20 @@ message FindClosestBuildingInsightsRequest {
85
85
  // imagery is returned if `required_quality` is set to `MEDIUM`.
86
86
  bool exact_quality_required = 4 [(google.api.field_behavior) = OPTIONAL];
87
87
 
88
- // Optional. Specifies the pre-GA features to enable.
88
+ // Optional. Specifies the pre-GA experiments to enable. Requests using this
89
+ // field are classified as a pre-GA offering under the [Google Maps Platform
90
+ // Service Specific
91
+ // Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms).
92
+ // See [launch stage
93
+ // descriptions](https://cloud.google.com/maps-platform/terms/launch-stages)
94
+ // for more details.
89
95
  repeated Experiment experiments = 5 [(google.api.field_behavior) = OPTIONAL];
96
+
97
+ // Optional. A list of
98
+ // [additional_insights][google.maps.solar.v1.FindClosestBuildingInsightsRequest.additional_insights]
99
+ // to be included in the response.
100
+ repeated AdditionalInsights additional_insights = 6
101
+ [(google.api.field_behavior) = OPTIONAL];
90
102
  }
91
103
 
92
104
  // A bounding box in lat/lng coordinates.
@@ -102,6 +114,30 @@ message LatLngBox {
102
114
  // Information about the location, dimensions, and solar potential of a
103
115
  // building.
104
116
  message BuildingInsights {
117
+ // Information about solar arrays detected on the building.
118
+ message DetectedArrays {
119
+ // Indicates the detection status of solar arrays for this building.
120
+ enum DetectionStatus {
121
+ // Unspecified status.
122
+ DETECTION_STATUS_UNSPECIFIED = 0;
123
+
124
+ // Detected solar array data is unavailable for this building.
125
+ DETECTION_STATUS_DATA_UNAVAILABLE = 1;
126
+
127
+ // At least one solar array has been detected for this building.
128
+ DETECTION_STATUS_ARRAYS_DETECTED = 2;
129
+
130
+ // No solar arrays detected for this building.
131
+ DETECTION_STATUS_NO_ARRAYS_DETECTED = 3;
132
+ }
133
+
134
+ // Indicates the detection status of solar arrays for this building.
135
+ DetectionStatus detection_status = 1;
136
+
137
+ // The date indicating when the latest solar array data was captured.
138
+ google.type.Date latest_capture_date = 3;
139
+ }
140
+
105
141
  // The resource name for the building, of the format `buildings/{place_id}`.
106
142
  string name = 1;
107
143
 
@@ -135,6 +171,11 @@ message BuildingInsights {
135
171
 
136
172
  // The quality of the imagery used to compute the data for this building.
137
173
  ImageryQuality imagery_quality = 10;
174
+
175
+ // Solar arrays detected on the building. This field is only populated if
176
+ // DETECTED_ARRAYS is included in the request's
177
+ // [FindClosestBuildingInsightsRequest.additional_insights][google.maps.solar.v1.FindClosestBuildingInsightsRequest.additional_insights].
178
+ DetectedArrays detected_arrays = 12;
138
179
  }
139
180
 
140
181
  // Information about the solar potential of a building. A number of
@@ -202,7 +243,7 @@ message SolarPotential {
202
243
  // Size and sunlight quantiles for each roof segment.
203
244
  repeated RoofSegmentSizeAndSunshineStats roof_segment_stats = 6;
204
245
 
205
- // Each [SolarPanel] [google.maps.solar.v1.SolarPanel]
246
+ // Each [SolarPanel][google.maps.solar.v1.SolarPanel]
206
247
  // describes a single solar panel. They are listed in the order that
207
248
  // the panel layout algorithm placed this. This is usually, though
208
249
  // not always, in decreasing order of annual energy production.
@@ -566,7 +607,13 @@ message GetDataLayersRequest {
566
607
  // imagery is returned if `required_quality` is set to `MEDIUM`.
567
608
  bool exact_quality_required = 7 [(google.api.field_behavior) = OPTIONAL];
568
609
 
569
- // Optional. Specifies the pre-GA experiments to enable.
610
+ // Optional. Specifies the pre-GA experiments to enable. Requests using this
611
+ // field are classified as a pre-GA offering under the [Google Maps Platform
612
+ // Service Specific
613
+ // Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms).
614
+ // See [launch stage descriptions](
615
+ // https://cloud.google.com/maps-platform/terms/launch-stages) for more
616
+ // details.
570
617
  repeated Experiment experiments = 8 [(google.api.field_behavior) = OPTIONAL];
571
618
  }
572
619
 
@@ -658,6 +705,21 @@ message GetGeoTiffRequest {
658
705
  string id = 1 [(google.api.field_behavior) = REQUIRED];
659
706
  }
660
707
 
708
+ // Additional building information such as roof geometry and
709
+ // solar panel arrays that can be returned in BuildingInsights.
710
+ //
711
+ // New values may be added to this enum in the future.
712
+ enum AdditionalInsights {
713
+ // The default value. The default BuildingInsights will be returned.
714
+ ADDITIONAL_INSIGHTS_UNSPECIFIED = 0;
715
+
716
+ // Determines whether the response will include the detected arrays.
717
+ //
718
+ // If specified, the `detected_arrays` field will be populated in the
719
+ // response.
720
+ DETECTED_ARRAYS = 2;
721
+ }
722
+
661
723
  // What subset of the solar information to return.
662
724
  enum DataLayerView {
663
725
  // Equivalent to FULL.