@googlemaps/streetview-publish
v0.1.0
Published
client for Node.js
Downloads
2
Readme
: Node.js Client
client for Node.js
A comprehensive list of changes in each version may be found in the CHANGELOG.
Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.
Table of contents:
Quickstart
Installing the client library
npm install @googlemaps/streetview-publish
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. Specifies if a download URL for the photos bytes should be
* returned in the Photos response.
*/
// const view = {}
/**
* Optional. The maximum number of photos to return.
* `pageSize` must be non-negative. If `pageSize` is zero or is not provided,
* the default page size of 100 is used.
* The number of photos returned in the response may be less than `pageSize`
* if the number of photos that belong to the user is less than `pageSize`.
*/
// const pageSize = 1234
/**
* Optional. The
* nextPageToken google.streetview.publish.v1.ListPhotosResponse.next_page_token
* value returned from a previous
* ListPhotos google.streetview.publish.v1.StreetViewPublishService.ListPhotos
* request, if any.
*/
// const pageToken = 'abc123'
/**
* Optional. The filter expression. For example:
* `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`.
* The filters supported are: `placeId`, `min_latitude`, `max_latitude`,
* `min_longitude`, `max_longitude`. See https://google.aip.dev/160 for more
* information.
*/
// const filter = 'abc123'
/**
* Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more
* information, see
* http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
* If language_code is unspecified, the user's language preference for Google
* services is used.
*/
// const languageCode = 'abc123'
// Imports the Publish library
const {StreetViewPublishServiceClient} =
require('@googlemaps/streetview-publish').v1;
// Instantiates a client
const publishClient = new StreetViewPublishServiceClient();
async function callListPhotos() {
// Construct request
const request = {
view,
};
// Run request
const iterable = publishClient.listPhotosAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListPhotos();
Samples
Samples are in the samples/
directory. Each sample's README.md
has instructions for running its sample.
| Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | | Street_view_publish_service.batch_delete_photos | source code | | | Street_view_publish_service.batch_get_photos | source code | | | Street_view_publish_service.batch_update_photos | source code | | | Street_view_publish_service.create_photo | source code | | | Street_view_publish_service.create_photo_sequence | source code | | | Street_view_publish_service.delete_photo | source code | | | Street_view_publish_service.delete_photo_sequence | source code | | | Street_view_publish_service.get_photo | source code | | | Street_view_publish_service.get_photo_sequence | source code | | | Street_view_publish_service.list_photo_sequences | source code | | | Street_view_publish_service.list_photos | source code | | | Street_view_publish_service.start_photo_sequence_upload | source code | | | Street_view_publish_service.start_upload | source code | | | Street_view_publish_service.update_photo | source code | | | Quickstart | source code | |
The 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/streetview-publish@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