google-ads-api 11.0.0 → 12.0.0

package/README.md

@@ -7,7 +7,7 @@
 </p>
 <p align="center">
   <a href="https://developers.google.com/google-ads/api/docs/release-notes">
-    <img src="https://img.shields.io/badge/google%20ads-v11.0.0-009688.svg?style=flat-square">
+    <img src="https://img.shields.io/badge/google%20ads-v12.0.0-009688.svg?style=flat-square">
   </a>
   <a href="https://www.npmjs.com/package/google-ads-api">
     <img src="https://img.shields.io/npm/v/google-ads-api.svg?style=flat-square">
@@ -19,7 +19,7 @@
 
 <p align="center">
   <a href="https://opteo.com">
-    <img src="https://app.opteo.com/img/opteo-icon-120.png">
+    <img src="https://app.opteo.com/favicon.png" width="90" height="90">
   </a>
 </p>
 
@@ -99,7 +99,7 @@ const customer = client.Customer({
 
 ## List accessible customers
 
-This is a special client method for listing the accessible customers for a given refresh token, and is equivalent to [CustomerService.listAccessibleCustomers](https://developers.google.com/google-ads/api/reference/rpc/v11/CustomerService#listaccessiblecustomers). It returns the resource names of available customer accounts.
+This is a special client method for listing the accessible customers for a given refresh token, and is equivalent to [CustomerService.listAccessibleCustomers](https://developers.google.com/google-ads/api/reference/rpc/v12/CustomerService#listaccessiblecustomers). It returns the resource names of available customer accounts.
 
 ```ts
 const client = new GoogleAdsApi({
@@ -563,11 +563,13 @@ const onQueryStart: OnQueryStart = async ({ cancel, editOptions }) => {
   }
 };
 
-const customer = client.Customer({
-  clientOptions,
-  customerOptions,
-  hooks: { onQueryStart },
-});
+const customer = client.Customer(
+  {
+    clientOptions,
+    customerOptions,
+  },
+  { onQueryStart }
+);
 ```
 
 ### On error hooks:
@@ -586,11 +588,13 @@ const onQueryError: OnQueryError = async ({ error }) => {
   console.log(error.message); // An Error or a GoogleAdsFailure
 };
 
-const customer = client.Customer({
-  clientOptions,
-  customerOptions,
-  hooks: { onQueryError },
-});
+const customer = client.Customer(
+  {
+    clientOptions,
+    customerOptions,
+  },
+  { onQueryError }
+);
 ```
 
 ### Post-request hooks:
@@ -609,20 +613,22 @@ const onQueryEnd: OnQueryEnd = async ({ response, resolve }) => {
   resolve([first]); // The supplied argument will become the alternative return value
 };
 
-const customer = client.Customer({
-  clientOptions,
-  customerOptions,
-  hooks: { onQueryEnd },
-});
+const customer = client.Customer(
+  {
+    clientOptions,
+    customerOptions,
+  },
+  { onQueryEnd }
+);
 ```
 
 ---
 
 ## Error handling
 
-All errors, apart from GRPC specific cases (such as a connection problem or timeout, [see more here](https://github.com/grpc/grpc/blob/master/doc/statuscodes.md)), are instances of a [GoogleAdsFailure](https://developers.google.com/google-ads/api/reference/rpc/v11/GoogleAdsFailure).
+All errors, apart from GRPC specific cases (such as a connection problem or timeout, [see more here](https://github.com/grpc/grpc/blob/master/doc/statuscodes.md)), are instances of a [GoogleAdsFailure](https://developers.google.com/google-ads/api/reference/rpc/v12/GoogleAdsFailure).
 
-You can find a list of all error types for a specific version in [the official documentation](https://developers.google.com/google-ads/api/reference/rpc/v11/AccessInvitationErrorEnum.AccessInvitationError), as well as more information about [handling errors here](https://developers.google.com/google-ads/api/docs/best-practices/error-types).
+You can find a list of all error types for a specific version in [the official documentation](https://developers.google.com/google-ads/api/reference/rpc/v12/AccessInvitationErrorEnum.AccessInvitationError), as well as more information about [handling errors here](https://developers.google.com/google-ads/api/docs/best-practices/error-types).
 
 ```ts
 import { errors } from "google-ads-api";

package/build/src/customer.js

@@ -40,7 +40,7 @@ class Customer extends serviceFactory_1.default {
       @hooks onQueryStart, onQueryError, onQueryEnd
     */
     async report(options) {
-        const { gaqlQuery, requestOptions } = query_1.buildQuery(options);
+        const { gaqlQuery, requestOptions } = (0, query_1.buildQuery)(options);
         const { response } = await this.querier(gaqlQuery, requestOptions, options);
         return response;
     }
@@ -50,7 +50,7 @@ class Customer extends serviceFactory_1.default {
     */
     async reportCount(options) {
         options.limit = 1; // must get at least one row
-        const { gaqlQuery, requestOptions } = query_1.buildQuery(options);
+        const { gaqlQuery, requestOptions } = (0, query_1.buildQuery)(options);
         // @ts-expect-error we do not allow this field in reportOptions, however it is still a valid request option
         requestOptions.return_total_results_count = true;
         const useHooks = false; // to avoid cacheing conflicts
@@ -66,7 +66,7 @@ class Customer extends serviceFactory_1.default {
       for await (const row of stream) { ... }
     */
     async *reportStream(reportOptions) {
-        const { gaqlQuery, requestOptions } = query_1.buildQuery(reportOptions);
+        const { gaqlQuery, requestOptions } = (0, query_1.buildQuery)(reportOptions);
         const stream = this.streamer(gaqlQuery, requestOptions, reportOptions);
         for await (const row of stream) {
             yield row;
@@ -82,7 +82,7 @@ class Customer extends serviceFactory_1.default {
       stream.on('end', () => { ... })
     */
     async reportStreamRaw(reportOptions) {
-        const { gaqlQuery, requestOptions } = query_1.buildQuery(reportOptions);
+        const { gaqlQuery, requestOptions } = (0, query_1.buildQuery)(reportOptions);
         const baseHookArguments = {
             credentials: this.credentials,
             query: gaqlQuery,
@@ -115,7 +115,7 @@ class Customer extends serviceFactory_1.default {
         const { service, request } = this.buildSearchRequestAndService(gaqlQuery, requestOptions);
         const searchResponse = await service.search(request, {
             otherArgs: { headers: this.callHeaders },
-            autoPaginate: false,
+            autoPaginate: false, // autoPaginate doesn't work
         });
         const response = searchResponse[0];
         const summaryRow = searchResponse[2].summary_row;
@@ -175,8 +175,8 @@ class Customer extends serviceFactory_1.default {
                 return this.clientOptions.disable_parsing
                     ? rows
                     : reportOptions
-                        ? parser_1.parse({ results: rows, reportOptions })
-                        : parser_1.parse({ results: rows, gaqlString: gaqlQuery });
+                        ? (0, parser_1.parse)({ results: rows, reportOptions })
+                        : (0, parser_1.parse)({ results: rows, gaqlString: gaqlQuery });
             };
             const { response, totalResultsCount } = await this.paginatedSearch(gaqlQuery, requestOptions, parsingWapper);
             if (this.hooks.onQueryEnd && useHooks) {
@@ -236,17 +236,17 @@ class Customer extends serviceFactory_1.default {
         });
         let streamFinished = false;
         const accumulator = [];
-        let nextChunk = utils_1.createNextChunkArrivedPromise();
+        let nextChunk = (0, utils_1.createNextChunkArrivedPromise)();
         stream.on("data", (chunk) => {
             const results = chunk.summary_row ? [chunk.summary_row] : chunk.results;
             const parsedResponse = this.clientOptions.disable_parsing
                 ? results
                 : reportOptions
-                    ? parser_1.parse({ results, reportOptions })
-                    : parser_1.parse({ results, gaqlString: gaqlQuery });
+                    ? (0, parser_1.parse)({ results, reportOptions })
+                    : (0, parser_1.parse)({ results, gaqlString: gaqlQuery });
             accumulator.push(...parsedResponse);
             nextChunk.resolve();
-            nextChunk = utils_1.createNextChunkArrivedPromise();
+            nextChunk = (0, utils_1.createNextChunkArrivedPromise)();
         });
         stream.on("error", (searchError) => {
             nextChunk.reject(searchError);

package/build/src/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/build/src/parser.js

@@ -39,7 +39,7 @@ exports.parse = parse;
 // This function assumes that a gaql query is of the format "select * * * from * ...".
 // Queries that are not in this format should have thrown an error when called.
 function getGAQLFields(gaqlString) {
-    const normalisedQuery = utils_1.normaliseQuery(gaqlString);
+    const normalisedQuery = (0, utils_1.normaliseQuery)(gaqlString);
     const fields = normalisedQuery
         .toLowerCase()
         .replace(/(^\s*select)|( from .*)|(\s+)/g, "")