google-ads-node

Google Ads Node

Google Ads API client library for Node.js

⚠️ Warning ⚠️

You're probably looking for our easy-to-use Google Ads API client library google-ads-api.

This library (google-ads-node) is the compiled output of the experimental Google Ads API Bazel build files, and will require some work to use as a standalone library, for which we currently provide no documentation.

Install

npm install google-ads-node

Upgrading API Versions

• Update to the latest gapic-tools version in /package/googleads-nodejs/package.json.
• Update to the latest google-gax version in /package/googleads-nodejs/package.json & /package.json.
• Update GOOGLE_ADS_VERSION in the Makefile to the latest version (if required).
• Run make protos to pull in the new protos and compile them. This command will take around 10 minutes. There are often errors here that need to be fixed due to changes in bazel, the docker image, or the protos themselves. Fix these errors as they come up.
• If upgrading to a new major version delete the old version folders from package/googleads-nodejs/protos/google/ads/googleads/{OLD_VERSION}, package/googleads-nodejs/src/{OLD_VERSION} and package/googleads-nodejs/samples/generated/{OLD_VERSION}.
• Run yarn to prepare the package and install the latest dependencies.
• You may find that the tsc build fails because of camelcase issues. If so, make sure that the compile-protos command in /package/googleads-nodejs/package.json includes all required arguments, like so: compileProtos --keep-case --force-number src
• Update any references to old version numbers in tests/protos.js.
• Run yarn test to make sure everything worked.
• Double check that any files that should have been updated have been.
• Update the readme to reflect the new Google Ads API version number
• Make a pull request, get it approved and merged into master.
• Publish to npm.