| 1 | <p align="center">
|
| 2 | <a href="https://github.com/opteo/google-ads-node">
|
| 3 | Google Ads Node
|
| 4 | </a>
|
| 5 | </p>
|
| 6 |
|
| 7 | <p align="center">
|
| 8 | Google Ads API client library for Node.js
|
| 9 | </p>
|
| 10 |
|
| 11 |
|
| 12 | <p align="center">
|
| 13 | <a href="https://developers.google.com/google-ads/api/docs/release-notes">
|
| 14 | <img src="https://img.shields.io/badge/google%20ads-v8-009688.svg?style=flat-square">
|
| 15 | </a>
|
| 16 | <a href="https://www.npmjs.com/package/google-ads-node">
|
| 17 | <img src="https://img.shields.io/npm/v/google-ads-node.svg?style=flat-square">
|
| 18 | </a>
|
| 19 | <a>
|
| 20 | <img src="https://img.shields.io/npm/dm/google-ads-node.svg?style=flat-square">
|
| 21 | </a>
|
| 22 | </p>
|
| 23 |
|
| 24 | <p align="center">
|
| 25 | <a href="https://opteo.com">
|
| 26 | <img src="https://app.opteo.com/icons/logo.svg">
|
| 27 | </a>
|
| 28 | </p>
|
| 29 |
|
| 30 | ## ⚠️ Warning ⚠️
|
| 31 |
|
| 32 | You're probably looking for our easy-to-use Google Ads API client library [google-ads-api](https://github.com/opteo/google-ads-api).
|
| 33 |
|
| 34 | This library (google-ads-node) is the compiled output of the experimental [Google Ads API Bazel build files](https://github.com/googleapis/googleapis/tree/master/google/ads/googleads#build-files-experimental), and will require some work to use as a standalone library, for which we currently provide no documentation.
|
| 35 |
|
| 36 | ## Install
|
| 37 |
|
| 38 | ```
|
| 39 | npm install google-ads-node
|
| 40 | ```
|
| 41 |
|
| 42 | ## Standalone
|
| 43 |
|
| 44 | _Documentation for this will be released soon_
|
| 45 |
|
| 46 | ## Upgrading API Versions
|
| 47 |
|
| 48 | 1. Fetch the latest changes in [Opteo/gax-nodejs](https://github.com/Opteo/gax-nodejs).
|
| 49 | 1. Update the official google-gax dependency to the latest version in `package.json`.
|
| 50 | 1. Update `GOOGLE_ADS_VERSION` in the Makefile to the latest version (if required).
|
| 51 | 1. Run `make protos` to pull in the new protos and compile them.
|
| 52 | 1. If upgrading to a new major version delete the old version folders from `package/googleads-nodejs/protos/google/ads/googleads/{OLD_VERSION}` and `package/googleads-nodejs/src/{OLD_VERSION}`.
|
| 53 | 1. Run `yarn` to prepare the package and install the latest dependencies.
|
| 54 | 1. Run `yarn test` to make sure everything worked (you may need to update the version numbers here).
|
| 55 | 1. Double check that any files that should have been updated have been.
|
| 56 | 1. Update the readme to reflect the new Google Ads API version number
|
| 57 | 1. Make a pull request, get it approved and merged into `master`.
|
| 58 | 1. Publish to npm.
|