Updated README: fixed API version (v19)

Change-Id: I613a574b27345ba37b06b7df33f8acf093e182f3

Author: evil-shrike

js/README.md

@@ -1,86 +1,99 @@
 # Google Ads API Report Fetcher (gaarf)
+
 Node.js version of Google Ads API Report Fetcher tool a.k.a. `gaarf`.
 Please see the full documentation in the root [README](https://github.com/google/ads-api-report-fetcher/README.md).
 
-Supports [Ads API v17.1](https://developers.google.com/google-ads/api/docs/release-notes#v17).
-
 <p align="center">
   <a href="https://developers.google.com/google-ads/api/docs/release-notes">
-    <img src="https://img.shields.io/badge/google%20ads-v17.0.0-009688.svg?style=flat-square"/>
+    <img src="https://img.shields.io/badge/google%20ads-v19.0.0-009688.svg?style=flat-square"/>
   </a>
   <a href="https://www.npmjs.com/package/google-ads-api-report-fetcher">
     <img src="https://img.shields.io/npm/v/google-ads-api-report-fetcher.svg?style=flat-square" />
   </a>
   <a>
     <img src="https://img.shields.io/npm/dm/google-ads-api-report-fetcher.svg?style=flat-square" />
   </a>
-  [![Code Style: Google](https://img.shields.io/badge/code%20style-google-blueviolet.svg)](https://github.com/google/gts)
+  <a href="https://github.com/google/gts">
+    <img src="https://img.shields.io/badge/code%20style-google-blueviolet.svg"  />
+  </a>
 </p>
 
 ## Table of content
 
- - [Overview](#overview)
- - [Command Line](#command-line)
-      - [Install globally](#install-globally)
-      - [Running from folder](#running-from-folder)
-      - [Config files](#config-files)
-          - [Ads API config](#ads-api-config)
- - [Library](#library)
- - [Development](#development)
-
+- [Overview](#overview)
+- [Command Line](#command-line)
+  - [Install globally](#install-globally)
+  - [Running from folder](#running-from-folder)
+  - [Config files](#config-files)
+    - [Ads API config](#ads-api-config)
+- [Library](#library)
+- [Development](#development)
 
 ## Overview
->You need [Node.js](https://nodejs.org/) to run the tool.
-v16 should be sufficient.
+
+> You need [Node.js](https://nodejs.org/) to run the tool.
+> v16 should be sufficient.
 
 ## Command Line
+
 ### Install globally
+
 ```shell
 npm i google-ads-api-report-fetcher -g
 ```
+
 then you can run the tool with `gaarf` and `gaarf-bq` commands:
+
 ```shell
 gaarf <files> [options]
 ```
 
+If you have both versions install (Python and Node) you can run the Node-version explicitly via `gaarf-node` alias.
+
 Documentation on available options see in the root [README.md](../README.md).
 
 ### Running from folder
+
 If you cloned the repo into "ads-api-fetcher" folder, then
 run `npm i --production` in ads-api-fetcher/js folder,
 after than we can run the tool directly:
+
 ```shell
 ads-api-fetcher/js/gaarf <files> [options]
 ```
+
 or
+
 ```shell
 node ads-api-fetcher/js/dist/cli.js <files> [options]
 ```
 
-
 ### Config files
+
 Besides passing options explicitly (see the root [README.me](../README.md) for
 full description) you can use config files.
 By default the tool will try to find `.gaarfrc` starting from the current folder
 up to the root. If found, options from that file will be used if they weren't
 supplied via command line.
 
 Example of `.gaarfrc`:
+
 ```json
 {
- "ads-config": ".config/google-ads.yaml",
- "output": "bq",
- "csv.destination-folder": "output",
- "macro": {
-   "start_date": "2022-01-01",
-   "end_date": "2022-02-10"
- },
- "account": 1234567890,
- "bq.project": "myproject",
- "bq.dataset": "mydataset",
- "bq.dump-schema": true
+  "ads-config": ".config/google-ads.yaml",
+  "output": "bq",
+  "csv.destination-folder": "output",
+  "macro": {
+    "start_date": "2022-01-01",
+    "end_date": "2022-02-10"
+  },
+  "account": 1234567890,
+  "bq.project": "myproject",
+  "bq.dataset": "mydataset",
+  "bq.dump-schema": true
 }
 ```
+
 Please note that options with nested values, like 'bq.project', can be specified
 either as objects (see "macro") or as flatten names ("bq.project").
 
@@ -91,6 +104,7 @@ file (as alternative to JSON) with a similar structure:
 `gaarf <files> --config=gaarf.yaml`
 
 Example of a yaml config:
+
 ```yaml
 ads-config: .config/google-ads.yaml
 output: bq
@@ -104,26 +118,30 @@ bq.dataset: mydataset
 ```
 
 Similarly a config file can be provided for the gaarf-bq tool:
+
 ```
 gaarf-bq bq-queries/*.sql --config=gaarf-bq.yaml
 ```
-(again it can be either YAML or JSON)
 
+(again it can be either YAML or JSON)
 
 #### Ads API config
+
 There are two mechanisms for supplying Ads API configuration (developer token, etc ).
 Either via a separated yaml-file whose name is set in `ads-config` argument or
 via separated CLI arguments starting `ads.*` (e.g. `--ads.client_id`) or
 in a config file (`ads` object):
+
 ```json
 {
- "ads": {
-   "client_id": "...",
-   "developer_token": ".."
- },
- "output": "bq",
+  "ads": {
+    "client_id": "...",
+    "developer_token": ".."
+  },
+  "output": "bq"
 }
 ```
+
 Such a yaml-file is a standard way to configure Ads API Python client -
 see [example](https://github.com/googleads/google-ads-python/blob/HEAD/google-ads.yaml).
 
@@ -132,25 +150,26 @@ search for a local file "google-ads.yaml" and if it exists it will be used.
 
 See more help with `--help` option.
 
-
 ## Library
+
 How to use Gaarf as a library in your own code.
 First you need to create an instance of `GoogleAdsApiClient` which represents the Ads API
 (it's a tiny wrapper around [Opteo/google-ads-api library](https://github.com/Opteo/google-ads-api) - open-source Ads API client for NodeJS).
 
 > NOTE: there is no an official Ads API client for NodeJS from Google, but the Opteo's client
-is a result of collaboration between Opteo and Google, so it's kinda a semi-official client.
+> is a result of collaboration between Opteo and Google, so it's kinda a semi-official client.
 
 `GoogleAdsApiClient` expects an object with Ads API access settings (TS-interface `GoogleAdsApiConfig`).
 You can construct it manually or load from a yaml or json file (e.g. google-ads.yaml)
 using `loadAdsConfigFromFile` function.
+
 ```ts
 import {
   GoogleAdsApiClient,
   AdsQueryExecutor,
   loadAdsConfigFromFile,
-  CsvWriter}
-  from 'google-ads-api-report-fetcher';
+  CsvWriter,
+} from 'google-ads-api-report-fetcher';
 
 const adsConfig = await loadAdsConfigFromFile('google-ads.yaml');
 const client = new GoogleAdsApiClient(adsConfig);
@@ -168,24 +187,39 @@ for (let scriptPath of scriptPaths) {
 
 If you need to process results from queries (and not just rely on a writer) then
 use `executeGen` method (it's a async generator):
+
 ```ts
-  let results = await executor
-    .executeGen(scriptName, queryText, customers, params, writer);
-  for await (let res of results) {
-    //res.rows - array of rows for one customer
-  }
+let results = await executor.executeGen(
+  scriptName,
+  queryText,
+  customers,
+  params,
+  writer
+);
+for await (let res of results) {
+  //res.rows - array of rows for one customer
+}
 ```
 
-
 To execute a single query for a single customer use `executeOne` method:
+
 ```ts
-  let query = executor.parseQuery(queryText, params);
-  let result = await executor.executeOne(query, customerId);
+let query = executor.parseQuery(queryText, params);
+let result = await executor.executeOne(query, customerId);
 ```
 
-# Development
-## Run typescript directly
+## Development
+
+### Run typescript directly
+
 ```
 node -r ./node_modules/ts-node/register src/cli.ts ...
 ```
 
+## License
+
+[Apache-2.0](LICENSE)
+
+## Disclaimer
+
+This is not an officially supported Google product.