googleapis-common

What is googleapis-common?

The googleapis-common npm package provides common utilities and types for Google API clients. It is used internally by other Google API client libraries to handle common tasks such as authentication, request handling, and response parsing.

What are googleapis-common's main functionalities?

Authentication

This feature allows you to authenticate with Google APIs using the GoogleAuth class. The code sample demonstrates how to create an instance of GoogleAuth, obtain a client, and retrieve the project ID.

const { GoogleAuth } = require('googleapis-common');
const auth = new GoogleAuth({
  scopes: ['https://www.googleapis.com/auth/cloud-platform'],
});

async function authenticate() {
  const client = await auth.getClient();
  const projectId = await auth.getProjectId();
  console.log(`Authenticated with project ID: ${projectId}`);
}
authenticate();

Request Handling

This feature provides a way to handle API requests using the createAPIRequest function. The code sample shows how to set up the parameters for a GET request to a hypothetical Google API endpoint and handle the response.

const { createAPIRequest } = require('googleapis-common');

async function makeRequest() {
  const parameters = {
    options: {
      url: 'https://www.googleapis.com/someapi/v1/resource',
      method: 'GET',
    },
    params: {},
    requiredParams: [],
    pathParams: [],
    context: {},
  };

  const response = await createAPIRequest(parameters);
  console.log(response.data);
}
makeRequest();

Response Parsing

This feature allows you to parse responses from Google API requests. The code sample demonstrates how to make a request and parse the response data.

const { createAPIRequest } = require('googleapis-common');

async function parseResponse() {
  const parameters = {
    options: {
      url: 'https://www.googleapis.com/someapi/v1/resource',
      method: 'GET',
    },
    params: {},
    requiredParams: [],
    pathParams: [],
    context: {},
  };

  const response = await createAPIRequest(parameters);
  const data = response.data;
  console.log(`Parsed data: ${JSON.stringify(data)}`);
}
parseResponse();

Other packages similar to googleapis-common

google-auth-library

The google-auth-library package provides authentication support for Google APIs. It is similar to the authentication feature in googleapis-common but focuses solely on authentication and authorization.

axios

Axios is a popular HTTP client for making requests. While it is not specific to Google APIs, it can be used to handle HTTP requests and responses similarly to the request handling feature in googleapis-common.

googleapis

The googleapis package is a comprehensive client library for accessing Google APIs. It uses googleapis-common internally but provides a higher-level interface for interacting with various Google services.

README

Google APIs Common Module: Node.js Client

A common tooling library used by the googleapis npm module. You probably don't want to use this directly.

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

• Google APIs Common Module Node.js Client API Reference

• github.com/googleapis/nodejs-googleapis-common

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

• Versioning

• Contributing

• License

Quickstart

Installing the client library

npm install googleapis-common

The Google APIs Common Module 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 googleapis-common@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

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

Changelog

6.0.1 (2022-08-04)

Bug Fixes

• deps: update gaxios to 5.0.1 (#474) (2ec0be4)