@googlemaps/solar 0.6.0 → 0.7.1

package/build/protos/google/maps/solar/v1/solar_service.proto

@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -85,8 +85,20 @@ message FindClosestBuildingInsightsRequest {
   // imagery is returned if `required_quality` is set to `MEDIUM`.
   bool exact_quality_required = 4 [(google.api.field_behavior) = OPTIONAL];
 
-  // Optional. Specifies the pre-GA features to enable.
+  // Optional. Specifies the pre-GA experiments to enable. Requests using this
+  // field are classified as a pre-GA offering under the [Google Maps Platform
+  // Service Specific
+  // Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms).
+  // See [launch stage
+  // descriptions](https://cloud.google.com/maps-platform/terms/launch-stages)
+  // for more details.
   repeated Experiment experiments = 5 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. A list of
+  // [additional_insights][google.maps.solar.v1.FindClosestBuildingInsightsRequest.additional_insights]
+  // to be included in the response.
+  repeated AdditionalInsights additional_insights = 6
+      [(google.api.field_behavior) = OPTIONAL];
 }
 
 // A bounding box in lat/lng coordinates.
@@ -102,6 +114,30 @@ message LatLngBox {
 // Information about the location, dimensions, and solar potential of a
 // building.
 message BuildingInsights {
+  // Information about solar arrays detected on the building.
+  message DetectedArrays {
+    // Indicates the detection status of solar arrays for this building.
+    enum DetectionStatus {
+      // Unspecified status.
+      DETECTION_STATUS_UNSPECIFIED = 0;
+
+      // Detected solar array data is unavailable for this building.
+      DETECTION_STATUS_DATA_UNAVAILABLE = 1;
+
+      // At least one solar array has been detected for this building.
+      DETECTION_STATUS_ARRAYS_DETECTED = 2;
+
+      // No solar arrays detected for this building.
+      DETECTION_STATUS_NO_ARRAYS_DETECTED = 3;
+    }
+
+    // Indicates the detection status of solar arrays for this building.
+    DetectionStatus detection_status = 1;
+
+    // The date indicating when the latest solar array data was captured.
+    google.type.Date latest_capture_date = 3;
+  }
+
   // The resource name for the building, of the format `buildings/{place_id}`.
   string name = 1;
 
@@ -135,6 +171,11 @@ message BuildingInsights {
 
   // The quality of the imagery used to compute the data for this building.
   ImageryQuality imagery_quality = 10;
+
+  // Solar arrays detected on the building. This field is only populated if
+  // DETECTED_ARRAYS is included in the request's
+  // [FindClosestBuildingInsightsRequest.additional_insights][google.maps.solar.v1.FindClosestBuildingInsightsRequest.additional_insights].
+  DetectedArrays detected_arrays = 12;
 }
 
 // Information about the solar potential of a building. A number of
@@ -202,7 +243,7 @@ message SolarPotential {
   // Size and sunlight quantiles for each roof segment.
   repeated RoofSegmentSizeAndSunshineStats roof_segment_stats = 6;
 
-  // Each [SolarPanel] [google.maps.solar.v1.SolarPanel]
+  // Each [SolarPanel][google.maps.solar.v1.SolarPanel]
   // describes a single solar panel. They are listed in the order that
   // the panel layout algorithm placed this. This is usually, though
   // not always, in decreasing order of annual energy production.
@@ -566,7 +607,13 @@ message GetDataLayersRequest {
   // imagery is returned if `required_quality` is set to `MEDIUM`.
   bool exact_quality_required = 7 [(google.api.field_behavior) = OPTIONAL];
 
-  // Optional. Specifies the pre-GA experiments to enable.
+  // Optional. Specifies the pre-GA experiments to enable. Requests using this
+  // field are classified as a pre-GA offering under the [Google Maps Platform
+  // Service Specific
+  // Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms).
+  // See [launch stage descriptions](
+  // https://cloud.google.com/maps-platform/terms/launch-stages) for more
+  // details.
   repeated Experiment experiments = 8 [(google.api.field_behavior) = OPTIONAL];
 }
 
@@ -658,6 +705,21 @@ message GetGeoTiffRequest {
   string id = 1 [(google.api.field_behavior) = REQUIRED];
 }
 
+// Additional building information such as roof geometry and
+// solar panel arrays that can be returned in BuildingInsights.
+//
+// New values may be added to this enum in the future.
+enum AdditionalInsights {
+  // The default value. The default BuildingInsights will be returned.
+  ADDITIONAL_INSIGHTS_UNSPECIFIED = 0;
+
+  // Determines whether the response will include the detected arrays.
+  //
+  // If specified, the `detected_arrays` field will be populated in the
+  // response.
+  DETECTED_ARRAYS = 2;
+}
+
 // What subset of the solar information to return.
 enum DataLayerView {
   // Equivalent to FULL.

package/build/protos/protos.d.ts

@@ -127,6 +127,9 @@ export namespace google {
 
                     /** FindClosestBuildingInsightsRequest experiments */
                     experiments?: (google.maps.solar.v1.Experiment[]|null);
+
+                    /** FindClosestBuildingInsightsRequest additionalInsights */
+                    additionalInsights?: (google.maps.solar.v1.AdditionalInsights[]|null);
                 }
 
                 /** Represents a FindClosestBuildingInsightsRequest. */
@@ -150,6 +153,9 @@ export namespace google {
                     /** FindClosestBuildingInsightsRequest experiments. */
                     public experiments: google.maps.solar.v1.Experiment[];
 
+                    /** FindClosestBuildingInsightsRequest additionalInsights. */
+                    public additionalInsights: google.maps.solar.v1.AdditionalInsights[];
+
                     /**
                      * Creates a new FindClosestBuildingInsightsRequest instance using the specified properties.
                      * @param [properties] Properties to set
@@ -366,6 +372,9 @@ export namespace google {
 
                     /** BuildingInsights imageryQuality */
                     imageryQuality?: (google.maps.solar.v1.ImageryQuality|keyof typeof google.maps.solar.v1.ImageryQuality|null);
+
+                    /** BuildingInsights detectedArrays */
+                    detectedArrays?: (google.maps.solar.v1.BuildingInsights.IDetectedArrays|null);
                 }
 
                 /** Represents a BuildingInsights. */
@@ -410,6 +419,9 @@ export namespace google {
                     /** BuildingInsights imageryQuality. */
                     public imageryQuality: (google.maps.solar.v1.ImageryQuality|keyof typeof google.maps.solar.v1.ImageryQuality);
 
+                    /** BuildingInsights detectedArrays. */
+                    public detectedArrays?: (google.maps.solar.v1.BuildingInsights.IDetectedArrays|null);
+
                     /**
                      * Creates a new BuildingInsights instance using the specified properties.
                      * @param [properties] Properties to set
@@ -488,6 +500,123 @@ export namespace google {
                     public static getTypeUrl(typeUrlPrefix?: string): string;
                 }
 
+                namespace BuildingInsights {
+
+                    /** Properties of a DetectedArrays. */
+                    interface IDetectedArrays {
+
+                        /** DetectedArrays detectionStatus */
+                        detectionStatus?: (google.maps.solar.v1.BuildingInsights.DetectedArrays.DetectionStatus|keyof typeof google.maps.solar.v1.BuildingInsights.DetectedArrays.DetectionStatus|null);
+
+                        /** DetectedArrays latestCaptureDate */
+                        latestCaptureDate?: (google.type.IDate|null);
+                    }
+
+                    /** Represents a DetectedArrays. */
+                    class DetectedArrays implements IDetectedArrays {
+
+                        /**
+                         * Constructs a new DetectedArrays.
+                         * @param [properties] Properties to set
+                         */
+                        constructor(properties?: google.maps.solar.v1.BuildingInsights.IDetectedArrays);
+
+                        /** DetectedArrays detectionStatus. */
+                        public detectionStatus: (google.maps.solar.v1.BuildingInsights.DetectedArrays.DetectionStatus|keyof typeof google.maps.solar.v1.BuildingInsights.DetectedArrays.DetectionStatus);
+
+                        /** DetectedArrays latestCaptureDate. */
+                        public latestCaptureDate?: (google.type.IDate|null);
+
+                        /**
+                         * Creates a new DetectedArrays instance using the specified properties.
+                         * @param [properties] Properties to set
+                         * @returns DetectedArrays instance
+                         */
+                        public static create(properties?: google.maps.solar.v1.BuildingInsights.IDetectedArrays): google.maps.solar.v1.BuildingInsights.DetectedArrays;
+
+                        /**
+                         * Encodes the specified DetectedArrays message. Does not implicitly {@link google.maps.solar.v1.BuildingInsights.DetectedArrays.verify|verify} messages.
+                         * @param message DetectedArrays message or plain object to encode
+                         * @param [writer] Writer to encode to
+                         * @returns Writer
+                         */
+                        public static encode(message: google.maps.solar.v1.BuildingInsights.IDetectedArrays, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                        /**
+                         * Encodes the specified DetectedArrays message, length delimited. Does not implicitly {@link google.maps.solar.v1.BuildingInsights.DetectedArrays.verify|verify} messages.
+                         * @param message DetectedArrays message or plain object to encode
+                         * @param [writer] Writer to encode to
+                         * @returns Writer
+                         */
+                        public static encodeDelimited(message: google.maps.solar.v1.BuildingInsights.IDetectedArrays, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                        /**
+                         * Decodes a DetectedArrays message from the specified reader or buffer.
+                         * @param reader Reader or buffer to decode from
+                         * @param [length] Message length if known beforehand
+                         * @returns DetectedArrays
+                         * @throws {Error} If the payload is not a reader or valid buffer
+                         * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                         */
+                        public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.maps.solar.v1.BuildingInsights.DetectedArrays;
+
+                        /**
+                         * Decodes a DetectedArrays message from the specified reader or buffer, length delimited.
+                         * @param reader Reader or buffer to decode from
+                         * @returns DetectedArrays
+                         * @throws {Error} If the payload is not a reader or valid buffer
+                         * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                         */
+                        public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.maps.solar.v1.BuildingInsights.DetectedArrays;
+
+                        /**
+                         * Verifies a DetectedArrays message.
+                         * @param message Plain object to verify
+                         * @returns `null` if valid, otherwise the reason why it is not
+                         */
+                        public static verify(message: { [k: string]: any }): (string|null);
+
+                        /**
+                         * Creates a DetectedArrays message from a plain object. Also converts values to their respective internal types.
+                         * @param object Plain object
+                         * @returns DetectedArrays
+                         */
+                        public static fromObject(object: { [k: string]: any }): google.maps.solar.v1.BuildingInsights.DetectedArrays;
+
+                        /**
+                         * Creates a plain object from a DetectedArrays message. Also converts values to other types if specified.
+                         * @param message DetectedArrays
+                         * @param [options] Conversion options
+                         * @returns Plain object
+                         */
+                        public static toObject(message: google.maps.solar.v1.BuildingInsights.DetectedArrays, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+                        /**
+                         * Converts this DetectedArrays to JSON.
+                         * @returns JSON object
+                         */
+                        public toJSON(): { [k: string]: any };
+
+                        /**
+                         * Gets the default type url for DetectedArrays
+                         * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+                         * @returns The default type url
+                         */
+                        public static getTypeUrl(typeUrlPrefix?: string): string;
+                    }
+
+                    namespace DetectedArrays {
+
+                        /** DetectionStatus enum. */
+                        enum DetectionStatus {
+                            DETECTION_STATUS_UNSPECIFIED = 0,
+                            DETECTION_STATUS_DATA_UNAVAILABLE = 1,
+                            DETECTION_STATUS_ARRAYS_DETECTED = 2,
+                            DETECTION_STATUS_NO_ARRAYS_DETECTED = 3
+                        }
+                    }
+                }
+
                 /** Properties of a SolarPotential. */
                 interface ISolarPotential {
 
@@ -2387,6 +2516,12 @@ export namespace google {
                     public static getTypeUrl(typeUrlPrefix?: string): string;
                 }
 
+                /** AdditionalInsights enum. */
+                enum AdditionalInsights {
+                    ADDITIONAL_INSIGHTS_UNSPECIFIED = 0,
+                    DETECTED_ARRAYS = 2
+                }
+
                 /** DataLayerView enum. */
                 enum DataLayerView {
                     DATA_LAYER_VIEW_UNSPECIFIED = 0,