Solar API: Node.js Client

Solar API client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG .

• Solar API Node.js Client API Reference
• Solar API Documentation
• github.com/googleapis/google-cloud-node/packages/google-maps-solar

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained .

Table of contents:

• Quickstart
  • Before you begin
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

Quickstart

Before you begin

1. Select or create a Cloud Platform project .
2. Enable billing for your project .
3. Enable the Solar API API .
4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

 npm install @googlemaps/solar 

Using the client library

 /**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The longitude and latitude from which the API looks for the
 *  nearest known building.
 */
// const location = {
//   latitude: 37.7900161,
//   longitude: -122.3900146,
// };
/**
 *  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.
 */
// const requiredQuality = {}
/**
 *  Optional. Whether to require exact quality of the imagery.
 *  If set to false, the `required_quality` field is interpreted as the minimum
 *  required quality, such that HIGH quality imagery may be returned when
 *  `required_quality` is set to MEDIUM.  If set to true, `required_quality`
 *  is interpreted as the exact required quality and only `MEDIUM` quality
 *  imagery is returned if `required_quality` is set to `MEDIUM`.
 */
// const exactQualityRequired = true

// Imports the Solar library
const {SolarClient} = require(' @googlemaps/solar 
').v1;

// Instantiates a client
const solarClient = new SolarClient 
();

async function callFindClosestBuildingInsights() {
  // Construct request
  const request = {
    location,
    requiredQuality,
    exactQualityRequired,
  };

  // Run request
  const response = await solarClient.findClosestBuildingInsights(request);
  console.log(response);
}

callFindClosestBuildingInsights(); 

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample	Source Code	Try it
Solar.find_closest_building_insights	source code
Solar.get_data_layers	source code
Solar.get_geo_tiff	source code
Quickstart	source code

The Solar API Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule . Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

• Legacy versions are not tested in continuous integration.
• Some security patches and features cannot be backported.
• Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags . The dist-tags follow the naming convention legacy-(version) . For example, npm install @googlemaps/solar@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning .

This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide .

Please note that this README.md , the samples/README.md , and a variety of configuration files in this repository (including .nycrc and tsconfig.json ) are generated from a central template. To edit one of these files, make an edit to its templates in directory .

License

Apache Version 2.0

See LICENSE