google-ads-api 14.2.0 → 16.0.0-rest-beta0

package/build/src/protos/index.d.ts

@@ -1,12 +1,12 @@
 import allProtos, { protos } from "google-ads-node";
-export declare const VERSION: "v14";
-export import common = protos.google.ads.googleads.v14.common;
-export import errors = protos.google.ads.googleads.v14.errors;
-export import resources = protos.google.ads.googleads.v14.resources;
-export import services = protos.google.ads.googleads.v14.services;
-export import internalEnums = protos.google.ads.googleads.v14.enums;
+export declare const VERSION: "v16";
+export import common = protos.google.ads.googleads.v16.common;
+export import errors = protos.google.ads.googleads.v16.errors;
+export import resources = protos.google.ads.googleads.v16.resources;
+export import services = protos.google.ads.googleads.v16.services;
+export import internalEnums = protos.google.ads.googleads.v16.enums;
 export { enums } from "./autogen/enums";
-export { fields } from "./autogen/fields";
+export { fields, fieldDataTypes } from "./autogen/fields";
 export { GoogleAdsServiceClient } from "google-ads-node";
 export declare type AllServices = Omit<typeof allProtos, typeof VERSION>;
 export declare type ServiceName = keyof Omit<typeof allProtos, typeof VERSION>;

package/build/src/protos/index.js

@@ -1,22 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.longrunning = exports.protobuf = exports.GoogleAdsServiceClient = exports.fields = exports.enums = exports.internalEnums = exports.services = exports.resources = exports.errors = exports.common = exports.VERSION = void 0;
+exports.longrunning = exports.protobuf = exports.GoogleAdsServiceClient = exports.fieldDataTypes = exports.fields = exports.enums = exports.internalEnums = exports.services = exports.resources = exports.errors = exports.common = exports.VERSION = void 0;
 const google_ads_node_1 = require("google-ads-node");
 const version_1 = require("../version");
 // "as vN" is required to avoid type issues later on
 exports.VERSION = version_1.googleAdsVersion;
 // -- Expose the googleads generated types --
 // The namespace path is shortened for ease of use
-exports.common = google_ads_node_1.protos.google.ads.googleads.v14.common;
-exports.errors = google_ads_node_1.protos.google.ads.googleads.v14.errors;
-exports.resources = google_ads_node_1.protos.google.ads.googleads.v14.resources;
-exports.services = google_ads_node_1.protos.google.ads.googleads.v14.services;
+exports.common = google_ads_node_1.protos.google.ads.googleads.v16.common;
+exports.errors = google_ads_node_1.protos.google.ads.googleads.v16.errors;
+exports.resources = google_ads_node_1.protos.google.ads.googleads.v16.resources;
+exports.services = google_ads_node_1.protos.google.ads.googleads.v16.services;
 // We compile enums ourselves, the Google ones should be used internally only
-exports.internalEnums = google_ads_node_1.protos.google.ads.googleads.v14.enums;
+exports.internalEnums = google_ads_node_1.protos.google.ads.googleads.v16.enums;
 var enums_1 = require("./autogen/enums");
 Object.defineProperty(exports, "enums", { enumerable: true, get: function () { return enums_1.enums; } });
 var fields_1 = require("./autogen/fields");
 Object.defineProperty(exports, "fields", { enumerable: true, get: function () { return fields_1.fields; } });
+Object.defineProperty(exports, "fieldDataTypes", { enumerable: true, get: function () { return fields_1.fieldDataTypes; } });
 // Common service used for report/query methods
 var google_ads_node_2 = require("google-ads-node");
 Object.defineProperty(exports, "GoogleAdsServiceClient", { enumerable: true, get: function () { return google_ads_node_2.GoogleAdsServiceClient; } });

package/build/src/service.d.ts

@@ -16,6 +16,7 @@ export declare class Service {
     get credentials(): CustomerCredentials;
     protected get callHeaders(): CallHeaders;
     private getCredentials;
+    getAccessToken(): Promise<string>;
     protected loadService<T = AllServices>(service: ServiceName): T;
     protected getGoogleAdsError(error: Error): errors.GoogleAdsFailure | Error;
     private decodeGoogleAdsFailureBuffer;

package/build/src/service.js

@@ -21,6 +21,11 @@ const serviceCache = new ttlcache_1.default({
         await service.close();
     },
 });
+// A global access token cache used by REST calls. Issued tokens expire after 1 hour.
+const accessTokenCache = new ttlcache_1.default({
+    max: 100000,
+    ttl: 50 * 60 * 1000, // 50 minutes
+});
 class Service {
     constructor(clientOptions, customerOptions, hooks) {
         this.clientOptions = clientOptions;
@@ -48,12 +53,30 @@ class Service {
         }
         return headers;
     }
+    // Used only by gRPC calls
     getCredentials() {
         const sslCreds = google_gax_1.grpc.credentials.createSsl();
         const authClient = new google_auth_library_1.UserRefreshClient(this.clientOptions.client_id, this.clientOptions.client_secret, this.customerOptions.refresh_token);
         const credentials = google_gax_1.grpc.credentials.combineChannelCredentials(sslCreds, google_gax_1.grpc.credentials.createFromGoogleCredential(authClient));
         return credentials;
     }
+    // Used only by REST calls
+    async getAccessToken() {
+        const cachedToken = accessTokenCache.get(this.customerOptions.refresh_token);
+        if (cachedToken) {
+            return cachedToken;
+        }
+        const oAuth2Client = new google_auth_library_1.OAuth2Client(this.clientOptions.client_id, this.clientOptions.client_secret);
+        oAuth2Client.setCredentials({
+            refresh_token: this.customerOptions.refresh_token,
+        });
+        const { token } = await oAuth2Client.getAccessToken();
+        if (typeof token !== "string") {
+            throw new Error("Failed to retrieve access token");
+        }
+        accessTokenCache.set(this.customerOptions.refresh_token, token);
+        return token;
+    }
     loadService(service) {
         const serviceCacheKey = `${service}_${this.customerOptions.refresh_token}`;
         if (serviceCache.has(serviceCacheKey)) {

package/build/src/testUtils.d.ts

@@ -1,4 +1,6 @@
+/// <reference types="node" />
 /// <reference types="jest" />
+import { Readable } from "stream";
 import { Customer } from "./customer";
 import { Hooks } from "./hooks";
 import { errors, GoogleAdsServiceClient, services } from "./protos";
@@ -12,7 +14,39 @@ export declare const MOCK_LOGIN_CID = "MOCK LOGIN CID";
 export declare const mockGaqlQuery = "SELECT campaign.resource_name FROM campaign LIMIT 1";
 export declare const mockReportOptions: ReportOptions;
 export declare const mockMutations: MutateOperation<any>[];
+export declare const mockSearchRawResult: {
+    totalResultsCount: number;
+    results: {
+        campaign: {
+            resourceName: string;
+        };
+    }[];
+}[];
+export declare const mockSearchRawResultWithSummaryRow: ({
+    totalResultsCount: number;
+    results: {
+        campaign: {
+            resourceName: string;
+        };
+    }[];
+    summaryRow?: undefined;
+} | {
+    summaryRow: {
+        metrics: {
+            clicks: number;
+            impressions: number;
+        };
+    };
+    totalResultsCount?: undefined;
+    results?: undefined;
+})[];
 export declare const mockQueryReturnValue: services.IGoogleAdsRow[];
+export declare const mockQueryReturnValueWithSummaryRow: services.IGoogleAdsRow[];
+export declare const mockQueryReturnValueUnparsed: {
+    campaign: {
+        resourceName: string;
+    };
+}[];
 export declare const mockSummaryRow: services.IGoogleAdsRow;
 export declare const mockTotalResultsCount = 23;
 export declare const mockMutationReturnValue: services.MutateGoogleAdsResponse;
@@ -27,6 +61,10 @@ export declare const mockError: {
 export declare const mockErrorMessage = "mock error message";
 export declare const mockParseValue: services.IGoogleAdsRow;
 export declare const mockParsedValues: services.IGoogleAdsRow[];
+export declare const mockStream: (data?: any) => Readable;
+export declare function mockGetAccessToken(customer: Customer): jest.SpyInstance;
+export declare const mockStreamWithSummaryRow: () => Readable;
+export declare const mockStreamWithBadData: () => Readable;
 export declare function mockPaginatedSearch(customer: Customer, includeTotalResultsCount?: boolean): jest.SpyInstance;
 export declare function mockSearchOnce({ customer, response, nextPageToken, includeTotalResultsCount, }: {
     customer: Customer;
@@ -62,6 +100,7 @@ export declare function mockBuildMutateRequestAndService({ customer, shouldThrow
 export declare function mockGetGoogleAdsError(customer: Customer): jest.SpyInstance;
 export declare function mockQuery(customer: Customer): jest.SpyInstance;
 export declare function mockParse(mockParsedValues: services.IGoogleAdsRow[]): jest.SpyInstance;
+export declare function mockParseRest(mockParsedValues: services.IGoogleAdsRow[]): jest.SpyInstance;
 export declare function noopParser(rows: services.IGoogleAdsRow[]): services.IGoogleAdsRow[];
 export declare function mockMethod(): {
     method(): void;

package/build/src/testUtils.js

@@ -22,12 +22,17 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.newCustomer = exports.failTestIfExecuted = exports.mockMethod = exports.noopParser = exports.mockParse = exports.mockQuery = exports.mockGetGoogleAdsError = exports.mockBuildMutateRequestAndService = exports.mockBuildSearchRequestAndService = exports.mockBuildSearchStreamRequestAndService = exports.mockSearchOnce = exports.mockPaginatedSearch = exports.mockParsedValues = exports.mockParseValue = exports.mockErrorMessage = exports.mockError = exports.mockMutationReturnValue = exports.mockTotalResultsCount = exports.mockSummaryRow = exports.mockQueryReturnValue = exports.mockMutations = exports.mockReportOptions = exports.mockGaqlQuery = exports.MOCK_LOGIN_CID = exports.MOCK_CID = exports.MOCK_REFRESH_TOKEN = exports.MOCK_DEVELOPER_TOKEN = exports.MOCK_CLIENT_SECRET = exports.MOCK_CLIENT_ID = void 0;
+exports.newCustomer = exports.failTestIfExecuted = exports.mockMethod = exports.noopParser = exports.mockParseRest = exports.mockParse = exports.mockQuery = exports.mockGetGoogleAdsError = exports.mockBuildMutateRequestAndService = exports.mockBuildSearchRequestAndService = exports.mockBuildSearchStreamRequestAndService = exports.mockSearchOnce = exports.mockPaginatedSearch = exports.mockStreamWithBadData = exports.mockStreamWithSummaryRow = exports.mockGetAccessToken = exports.mockStream = exports.mockParsedValues = exports.mockParseValue = exports.mockErrorMessage = exports.mockError = exports.mockMutationReturnValue = exports.mockTotalResultsCount = exports.mockSummaryRow = exports.mockQueryReturnValueUnparsed = exports.mockQueryReturnValueWithSummaryRow = exports.mockQueryReturnValue = exports.mockSearchRawResultWithSummaryRow = exports.mockSearchRawResult = exports.mockMutations = exports.mockReportOptions = exports.mockGaqlQuery = exports.MOCK_LOGIN_CID = exports.MOCK_CID = exports.MOCK_REFRESH_TOKEN = exports.MOCK_DEVELOPER_TOKEN = exports.MOCK_CLIENT_SECRET = exports.MOCK_CLIENT_ID = void 0;
 const stream_1 = require("stream");
 const customer_1 = require("./customer");
 const parser = __importStar(require("./parser"));
+const parserRest = __importStar(require("./parserRest"));
 const protos_1 = require("./protos");
+const lodash_1 = __importDefault(require("lodash"));
 exports.MOCK_CLIENT_ID = "MOCK CLIENT ID";
 exports.MOCK_CLIENT_SECRET = "MOCK CLIENT SECRET";
 exports.MOCK_DEVELOPER_TOKEN = "MOCK DEVELOPER TOKEN";
@@ -43,11 +48,45 @@ exports.mockReportOptions = {
 exports.mockMutations = [
     { resource: "abc", entity: "campaign", operation: "create" },
 ];
+exports.mockSearchRawResult = [
+    {
+        totalResultsCount: 23,
+        results: [
+            { campaign: { resourceName: "customers/1/campaigns/11" } },
+            { campaign: { resourceName: "customers/2/campaigns/22" } },
+            { campaign: { resourceName: "customers/3/campaigns/33" } },
+        ],
+    },
+];
+exports.mockSearchRawResultWithSummaryRow = [
+    {
+        totalResultsCount: 23,
+        results: [
+            { campaign: { resourceName: "customers/1/campaigns/11" } },
+            { campaign: { resourceName: "customers/2/campaigns/22" } },
+            { campaign: { resourceName: "customers/3/campaigns/33" } },
+        ],
+    },
+    {
+        summaryRow: { metrics: { clicks: 90, impressions: 153 } },
+    },
+];
 exports.mockQueryReturnValue = [
     { campaign: { resource_name: "customers/1/campaigns/11" } },
     { campaign: { resource_name: "customers/2/campaigns/22" } },
     { campaign: { resource_name: "customers/3/campaigns/33" } },
 ];
+exports.mockQueryReturnValueWithSummaryRow = [
+    { campaign: { resource_name: "customers/1/campaigns/11" } },
+    { campaign: { resource_name: "customers/2/campaigns/22" } },
+    { campaign: { resource_name: "customers/3/campaigns/33" } },
+    { metrics: { clicks: 90, impressions: 153 } },
+];
+exports.mockQueryReturnValueUnparsed = [
+    { campaign: { resourceName: "customers/1/campaigns/11" } },
+    { campaign: { resourceName: "customers/2/campaigns/22" } },
+    { campaign: { resourceName: "customers/3/campaigns/33" } },
+];
 exports.mockSummaryRow = {
     metrics: { clicks: 90, impressions: 153 },
 };
@@ -75,17 +114,43 @@ exports.mockParsedValues = [
     exports.mockParseValue,
     exports.mockParseValue,
 ];
+// Returns a stream that emits the provided values
+const mockStream = function (data = exports.mockSearchRawResult) {
+    const chunks = lodash_1.default.chunk(JSON.stringify(data), 10).map((c) => c.join("")); // random splits
+    const stream = new stream_1.Readable({ objectMode: true });
+    chunks.forEach((value) => stream.push(new Buffer(value)));
+    stream.push(null);
+    return stream;
+};
+exports.mockStream = mockStream;
+function mockGetAccessToken(customer) {
+    return (jest
+        .spyOn(customer, "getAccessToken")
+        // ts-expect-error
+        .mockImplementation(async () => {
+        return "mockedAccessTokenHere";
+    }));
+}
+exports.mockGetAccessToken = mockGetAccessToken;
+const mockStreamWithSummaryRow = function () {
+    return (0, exports.mockStream)(exports.mockSearchRawResultWithSummaryRow);
+};
+exports.mockStreamWithSummaryRow = mockStreamWithSummaryRow;
+const mockStreamWithBadData = function () {
+    return (0, exports.mockStream)({ results: 66 });
+};
+exports.mockStreamWithBadData = mockStreamWithBadData;
 function mockPaginatedSearch(customer, includeTotalResultsCount = false) {
     return (jest
         // @ts-expect-error private method
         .spyOn(customer, "paginatedSearch")
         // @ts-expect-error
-        .mockImplementation((gaqlQuery, requestOptions, _parser) => {
+        .mockImplementation((gaqlQuery, requestOptions) => {
         const totalResultsCount = includeTotalResultsCount
             ? exports.mockTotalResultsCount
             : undefined;
         return {
-            response: _parser(exports.mockQueryReturnValue),
+            response: exports.mockQueryReturnValue,
             totalResultsCount,
         };
     }));
@@ -221,6 +286,12 @@ function mockParse(mockParsedValues) {
     return jest.spyOn(parser, "parse").mockImplementation(() => mockParsedValues);
 }
 exports.mockParse = mockParse;
+function mockParseRest(mockParsedValues) {
+    return jest
+        .spyOn(parserRest, "decamelizeKeys")
+        .mockImplementation(() => mockParsedValues);
+}
+exports.mockParseRest = mockParseRest;
 function noopParser(rows) {
     return rows;
 }

package/build/src/utils.d.ts

@@ -47,8 +47,3 @@ export declare function toCamelCase(str: string): string;
 export declare function toSnakeCase(str: string): string;
 export declare function recursiveFieldMaskSearch(data: Record<string, any>): string[];
 export declare function getFieldMask(data: Record<string, any>): protobuf.FieldMask;
-export declare function createNextChunkArrivedPromise(): {
-    newPromise: Promise<unknown>;
-    resolve: () => void;
-    reject: (error: Error) => void;
-};

package/build/src/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createNextChunkArrivedPromise = exports.getFieldMask = exports.recursiveFieldMaskSearch = exports.toSnakeCase = exports.toCamelCase = exports.capitaliseFirstLetter = exports.normaliseQuery = exports.toMicros = exports.fromMicros = void 0;
+exports.getFieldMask = exports.recursiveFieldMaskSearch = exports.toSnakeCase = exports.toCamelCase = exports.capitaliseFirstLetter = exports.normaliseQuery = exports.toMicros = exports.fromMicros = void 0;
 const protos_1 = require("./protos");
 /**
  * @param micros Money value in micros format
@@ -100,18 +100,3 @@ function getFieldMask(data) {
     });
 }
 exports.getFieldMask = getFieldMask;
-function createNextChunkArrivedPromise() {
-    let resolvePromise = () => {
-        return;
-    };
-    let rejectPromise = (error) => {
-        throw error;
-    };
-    const newPromise = new Promise((resolve, reject) => {
-        // @ts-ignore
-        resolvePromise = resolve;
-        rejectPromise = reject;
-    });
-    return { newPromise, resolve: resolvePromise, reject: rejectPromise };
-}
-exports.createNextChunkArrivedPromise = createNextChunkArrivedPromise;

package/build/src/version.d.ts

@@ -1 +1 @@
-export declare const googleAdsVersion = "v14";
+export declare const googleAdsVersion = "v16";

package/build/src/version.js

@@ -1,4 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.googleAdsVersion = void 0;
-exports.googleAdsVersion = "v14";
+/*
+    How to upgrade google ads version:
+    1. Update google-ads-node & publish to NPM. Check that package for instructions.
+    2. Update google-ads-node & google-gax in package.json. google-gax should be the same version as google-ads-node.
+    3. Update the version in this file
+    4. Update the versions in src/protos/index.ts
+    5. Run `yarn compile` to update the generated files.
+        The `tsc` command might fail -- if so, temporarily add @ts-nocheck
+        to the top of problematic files so that the compile script can continue.
+        After the compile script has run, those @ts-nocheck lines should no longer be required.
+    6. Prettify the generated files so the the diffs are easier to read.
+    7. Check that the diffs are expected and that the generated files are correct. New Gads versions will often add new services, fields, and enums.
+    8. Test with `yarn test`
+    9. Test by linking to a real project and making some real requests.
+    10. Once confident, bump the major version & publish to NPM.
+*/
+exports.googleAdsVersion = "v16";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "google-ads-api",
-  "version": "14.2.0",
+  "version": "16.0.0-rest-beta0",
   "description": "Google Ads API Client Library for Node.js",
   "repository": "https://github.com/Opteo/google-ads-api",
   "main": "build/src/index.js",
@@ -11,26 +11,36 @@
     "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"
   },
   "author": "Opteo",
   "license": "MIT",
   "dependencies": {
     "@isaacs/ttlcache": "^1.2.2",
-    "google-ads-node": "^12.0.2",
+    "axios": "^1.6.7",
+    "circ-json": "^1.0.4",
+    "google-ads-node": "^13.0.0",
     "google-auth-library": "^7.1.0",
-    "google-gax": "^4.0.3",
-    "long": "^4.0.0"
+    "google-gax": "^4.3.1",
+    "long": "^4.0.0",
+    "map-obj": "^4.0.0",
+    "stream-json": "^1.8.0"
   },
   "devDependencies": {
     "@types/jest": "^29.0.1",
+    "@types/lodash": "^4.14.202",
     "@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",
+    "lodash": "^4.17.21",
     "pluralize": "^8.0.0",
+    "protobufjs": "^7.2.6",
     "ts-jest": "^29.0.0",
     "typescript": "^4.1.2"
   },