Merge pull request #516 from Opteo/v20

v20 update

Author: Lewis-Clayton

.gitignore

@@ -79,4 +79,7 @@ typings/
 *.tsbuildinfo
 
 # Library build folder
-build
+build
+
+# Temporary compilation files
+fields.json

CHANGELOG.md

@@ -1,23 +1,26 @@
 # Changelog
 
-### Upcoming Breaking Changes
+### 20.0.1
 
-From v20 onwards this library will use the REST api for report, reportStream, search and searchStream. This will result in minor breaking changes to reporting calls:
+### Version Upgrade
+
+- Upgraded google-ads-api version to v20. Refer to Google ads release notes [here](https://developers.google.com/google-ads/api/docs/release-notes) for changes.
+
+### REST API
+
+- This library now uses the REST API for report, reportStream, search and searchStream. This will result in minor breaking changes to reporting calls:
 
 - Fields with the enum value `0` will now be `undefined` instead
 - Array-fields (such as `final_urls`) with the value `[]` will now be `undefined` instead
 
 While these changes are inconvenient, the performance of the REST api is significantly better than the gRPC api, particularly for responses with many rows.
 
-To prepare for this change, we recommend you use the install the `19.0.0-rest-beta` version of this library and test your application with it.
-
 ### 19.1.0
 
 ### Version Upgrade
 
 - Upgraded google-ads-api version to v19.1. Refer to Google ads release notes [here](https://developers.google.com/google-ads/api/docs/release-notes) for changes.
 
-
 ### 19.0.2
 
 - Fix issue with reportCount() not giving the correct total results count.

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-v19.1.0-009688.svg?style=flat-square">
+    <img src="https://img.shields.io/badge/google%20ads-v20.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">
@@ -26,7 +26,7 @@
 # Features
 
 - Simple and easy to use API
-- Uses [gRPC](https://grpc.io/) and [Protocol Buffers](https://developers.google.com/protocol-buffers/) internally (recommended by Google)
+- Uses [REST](https://developers.google.com/google-ads/api/rest/design/overview) and [Protocol Buffers](https://developers.google.com/protocol-buffers/) internally
 - Typescript definitions for all resources, enums, errors and services
 - Provides all API functionality
 
@@ -93,7 +93,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/v13/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/v20/CustomerService#listaccessiblecustomers). It returns the resource names of available customer accounts.
 
 ```ts
 const client = new GoogleAdsApi({
@@ -385,7 +385,7 @@ const keyword = "24 hour locksmith harlem";
 
 const operations: MutateOperation<
   resources.IAdGroupCriterion & {
-    exempt_policy_violation_keys?: google.ads.googleads.v19.common.IPolicyViolationKey[];
+    exempt_policy_violation_keys?: google.ads.googleads.v20.common.IPolicyViolationKey[];
   }
 >[] = [
   {
@@ -671,9 +671,9 @@ const customer = client.Customer(
 
 ## 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/v13/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/v20/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/v13/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/v20/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";

jest.config.js

@@ -3,7 +3,7 @@ module.exports = {
   preset: "ts-jest",
   testEnvironment: "node",
   clearMocks: true,
-  collectCoverage: true,
+  //collectCoverage: true,
   coveragePathIgnorePatterns: ["/node_modules/", "jest.config.js"],
   resetMocks: true,
   testMatch: [

package.json

@@ -1,6 +1,6 @@
 {
   "name": "google-ads-api",
-  "version": "19.1.0",
+  "version": "20.0.1",
   "description": "Google Ads API Client Library for Node.js",
   "repository": "https://github.com/Opteo/google-ads-api",
   "main": "build/src/index.js",
@@ -11,30 +11,40 @@
     "test": "jest",
     "lint": "eslint . --ext .ts",
     "build": "tsc",
-    "compile": "tsc && node build/scripts/index.js",
+    "compile": "esbuild --bundle --platform=node ./scripts/index.ts --outfile=./build/scripts/index.js && node ./build/scripts/index.js",
     "prepare": "rm -rf build && npm run build",
     "node": "tsx"
   },
   "author": "Opteo",
   "license": "MIT",
   "dependencies": {
     "@isaacs/ttlcache": "^1.2.2",
-    "google-ads-node": "16.0.0",
+    "axios": "^1.6.7",
+    "circ-json": "^1.0.4",
+    "google-ads-node": "17.0.1",
     "google-auth-library": "^9.15.1",
-    "google-gax": "^5.1.0-rc.1",
-    "long": "^4.0.0"
+    "google-gax": "^5.1.1-rc.1",
+    "long": "^4.0.0",
+    "map-obj": "^4.0.0",
+    "stream-json": "^1.8.0"
   },
   "devDependencies": {
     "@types/jest": "^29.0.1",
     "@types/long": "^4.0.0",
+    "@types/lodash": "^4.14.202",
     "@types/node": "^22.5.4",
     "@types/pluralize": "^0.0.29",
+    "@types/stream-json": "^1.7.7",
     "@typescript-eslint/eslint-plugin": "^4.8.2",
     "@typescript-eslint/parser": "^4.8.2",
+    "axios-mock-adapter": "^1.22.0",
+    "esbuild": "^0.20.1",
     "eslint": "^7.14.0",
-    "jest": "^29.0.3",
+    "jest": "^29.7.0",
+    "lodash": "^4.17.21",
     "pluralize": "^8.0.0",
-    "ts-jest": "^29.0.0",
+    "protobufjs": "^7.2.6",
+    "ts-jest": "^29.1.2",
     "tsx": "^4.19.3",
     "typescript": "^5.5.4"
   },

scripts/fields.ts

@@ -1,8 +1,24 @@
 import fs from "fs";
 import { FILES } from "./path";
-import { GoogleAdsApi, services, resources, enums } from "../src";
+import { GoogleAdsApi, resources, enums, services } from "../src";
 import { capitaliseFirstLetter, toCamelCase } from "../src/utils";
-
+import _ from "lodash";
+import protosJson from "google-ads-node/build/protos/protos.json";
+import { stringify } from "circ-json";
+
+import protobuf from "protobufjs";
+const root = protobuf.Root.fromJSON(protosJson);
+
+const primitiveTypes = [
+  "string",
+  "number",
+  "bool",
+  "int64",
+  "int32",
+  "double",
+  "float",
+  "bytes",
+];
 // Types
 interface Resource {
   attributes: string[];
@@ -34,7 +50,7 @@ export async function compileFields(): Promise<void> {
     login_customer_id: LOGIN_CUSTOMER_ID,
   });
 
-  // @ts-ignore
+  //@ts-ignore
   const [fields]: resources.GoogleAdsField[][] =
     // @ts-expect-error Protected usage is fine here
     await cus.googleAdsFields.searchGoogleAdsFields(
@@ -55,6 +71,12 @@ export async function compileFields(): Promise<void> {
       })
     );
 
+  // fs.writeFileSync("fields.json", JSON.stringify(fields));
+
+  // const fields: resources.GoogleAdsField[] = JSON.parse(
+  //   fs.readFileSync("fields.json").toString()
+  // );
+
   const resourceConstructs: { [resourceName: string]: Resource } = {};
   const enumFields: { [fieldName: string]: string } = {};
   const resourceNames: string[] = [];
@@ -158,6 +180,85 @@ export async function compileFields(): Promise<void> {
   });
 
   stream.write(`}`);
+
+  stream.write(
+    `\n\n/*  -- Field types (represented as circular JSON, used in REST parsing) --  */`
+  );
+  stream.write(`\nexport const fieldDataTypes = \``);
+
+  /*
+      Assemble a mega object that represents all the fields and their types,
+      recursively. This is used in the REST parsing to determine the type of
+      each field. This is a circular object, so it can't be stringified
+      normally. We'll use the circ-json package to stringify it.
+
+      See fieldDataTypes in autogen/fields.ts for an idea of the final product.
+  */
+  let mega: any = {};
+  function assembleMega(typeForLookup: string) {
+    if (typeForLookup.startsWith("com.")) {
+      typeForLookup = typeForLookup.replace("com.", "");
+    }
+    const foundMessage = root.lookupTypeOrEnum(typeForLookup);
+
+    if (mega[foundMessage.name]) {
+      return mega[foundMessage.name];
+    }
+
+    // @ts-ignore
+    if (foundMessage.valuesById) {
+      // @ts-ignore
+      return foundMessage.values;
+    }
+    const fields = foundMessage.fields;
+
+    const o: any = {};
+    mega[foundMessage.name] = o;
+    for (const fieldKey in fields) {
+      const fieldKeyType = fields[fieldKey].type;
+      if (primitiveTypes.includes(fieldKeyType)) {
+        o[fieldKey] = fieldKeyType.toUpperCase();
+        continue;
+      }
+
+      const parsedRef = assembleMega(fields[fieldKey].type);
+      o[fieldKey] = parsedRef;
+    }
+
+    mega[foundMessage.name] = o;
+
+    return o;
+  }
+
+  // Start by adding GoogleAdsFailure to the mega object. It's a special case that
+  // Doesn't exist the same way as other fields.
+  assembleMega("GoogleAdsFailure");
+
+  mega = {
+    ...mega,
+    ...mega.GoogleAdsFailure,
+  };
+
+  delete mega.GoogleAdsFailure;
+
+  // Now, loop through all the reporting fields and add them to the mega object
+  // Messages are the main challenge here, as they can contain other messages,
+  // Sometimes with infite recursion.
+  for (const field of fields.filter((field) => field.data_type === "MESSAGE")) {
+    _.set(mega, field.name!, assembleMega(field.type_url as string));
+  }
+  for (const field of fields.filter((field) => field.data_type !== "MESSAGE")) {
+    if (!_.get(mega, field.name!)) {
+      _.set(
+        mega,
+        field.name!,
+        (field.data_type as string).toUpperCase() as string
+      );
+    }
+  }
+
+  stream.write(stringify(mega));
+  stream.write(`\``);
   stream.end();
 }
 

src/client.ts

@@ -9,6 +9,7 @@ export interface ClientOptions {
   client_secret: string;
   developer_token: string;
   disable_parsing?: boolean;
+  max_reporting_rows?: number;
 }
 
 export class Client {