google-ads-api 20.0.0 → 20.0.1

package/build/src/protos/autogen/serviceFactory.js

@@ -5,7 +5,7 @@ const service_1 = require("../../service");
 const index_1 = require("../index");
 class ServiceFactory extends service_1.Service {
     constructor(clientOptions, customerOptions, hooks) {
-        super(clientOptions, customerOptions, hooks !== null && hooks !== void 0 ? hooks : {});
+        super(clientOptions, customerOptions, hooks ?? {});
     }
     /**
      * @link https://developers.google.com/google-ads/api/reference/rpc/v20/AccountBudgetProposalService

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

@@ -6,7 +6,7 @@ export import resources = protos.google.ads.googleads.v20.resources;
 export import services = protos.google.ads.googleads.v20.services;
 export import internalEnums = protos.google.ads.googleads.v20.enums;
 export { enums } from "./autogen/enums";
-export { fields } from "./autogen/fields";
+export { fields, fieldDataTypes } from "./autogen/fields";
 export { GoogleAdsServiceClient } from "google-ads-node";
 export type AllServices = Omit<typeof allProtos, typeof VERSION>;
 export type ServiceName = keyof Omit<typeof allProtos, typeof VERSION>;

package/build/src/protos/index.js

@@ -1,6 +1,6 @@
 "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
@@ -17,6 +17,7 @@ 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/query.js

@@ -51,7 +51,7 @@ exports.QueryError = {
     UNDEFINED_ENTITY: "The entity of the query must be defined.",
 };
 function buildSelectClause(attributes, metrics, segments) {
-    if (!(attributes === null || attributes === void 0 ? void 0 : attributes.length) && !(metrics === null || metrics === void 0 ? void 0 : metrics.length) && !(segments === null || segments === void 0 ? void 0 : segments.length)) {
+    if (!attributes?.length && !metrics?.length && !segments?.length) {
         throw new Error(exports.QueryError.MISSING_FIELDS);
     }
     const selections = [

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

@@ -14,18 +14,26 @@ const ttlcache_1 = __importDefault(require("@isaacs/ttlcache"));
 exports.FAILURE_KEY = `google.ads.googleads.${version_1.googleAdsVersion}.errors.googleadsfailure-bin`;
 // A global service cache to avoid re-initialising services
 const serviceCache = new ttlcache_1.default({
-    max: 1000,
+    max: 1_000,
     ttl: 10 * 60 * 1000, // 10 minutes
     dispose: async (service) => {
         // Close connections when services are removed from the cache
         await service.close();
     },
 });
+// A global access token cache used by REST calls. Issued tokens expire after 1 hour, so we cache them for 50 minutes.
+const accessTokenCache = new ttlcache_1.default({
+    max: 100_000,
+    ttl: 50 * 60 * 1000, // 50 minutes
+});
 class Service {
+    clientOptions;
+    customerOptions;
+    hooks;
     constructor(clientOptions, customerOptions, hooks) {
         this.clientOptions = clientOptions;
         this.customerOptions = customerOptions;
-        this.hooks = hooks !== null && hooks !== void 0 ? hooks : {};
+        this.hooks = hooks ?? {};
         // @ts-expect-error All fields don't need to be set here
         this.serviceCache = {};
     }
@@ -48,12 +56,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)) {
@@ -72,9 +98,8 @@ class Service {
         return client;
     }
     getGoogleAdsError(error) {
-        var _a;
         // @ts-expect-error No type exists for GA query error
-        if (typeof ((_a = error === null || error === void 0 ? void 0 : error.metadata) === null || _a === void 0 ? void 0 : _a.internalRepr.get(exports.FAILURE_KEY)) === "undefined") {
+        if (typeof error?.metadata?.internalRepr.get(exports.FAILURE_KEY) === "undefined") {
             return error;
         }
         // @ts-expect-error No type exists for GA query error
@@ -86,13 +111,12 @@ class Service {
         return googleAdsFailure;
     }
     decodePartialFailureError(response) {
-        var _a;
-        if (typeof (response === null || response === void 0 ? void 0 : response.partial_failure_error) === "undefined" ||
-            !(response === null || response === void 0 ? void 0 : response.partial_failure_error)) {
+        if (typeof response?.partial_failure_error === "undefined" ||
+            !response?.partial_failure_error) {
             return response;
         }
         const { details } = response.partial_failure_error;
-        const buffer = (_a = details === null || details === void 0 ? void 0 : details.find((d) => d.type_url.includes("errors.GoogleAdsFailure"))) === null || _a === void 0 ? void 0 : _a.value;
+        const buffer = details?.find((d) => d.type_url.includes("errors.GoogleAdsFailure"))?.value;
         if (typeof buffer === "undefined") {
             return response;
         }
@@ -123,15 +147,13 @@ class Service {
     buildMutationRequestAndService(mutations, options) {
         const service = this.loadService("GoogleAdsServiceClient");
         const mutateOperations = mutations.map((mutation) => {
-            var _a, _b;
             const opKey = (0, utils_1.toSnakeCase)(`${mutation.entity}Operation`);
             const operation = {
-                [(_a = mutation.operation) !== null && _a !== void 0 ? _a : "create"]: mutation.resource,
+                [mutation.operation ?? "create"]: mutation.resource,
             };
             if (mutation.operation === "create" &&
-                (
                 //@ts-ignore
-                (_b = mutation === null || mutation === void 0 ? void 0 : mutation.exempt_policy_violation_keys) === null || _b === void 0 ? void 0 : _b.length)) {
+                mutation?.exempt_policy_violation_keys?.length) {
                 //@ts-ignore
                 operation.exempt_policy_violation_keys =
                     mutation.exempt_policy_violation_keys;
@@ -154,13 +176,12 @@ class Service {
     }
     buildOperations(type, entities, message) {
         const ops = entities.map((e) => {
-            var _a;
             const op = {
                 [type]: e,
                 operation: type,
             };
             //@ts-ignore
-            if (type === "create" && ((_a = e === null || e === void 0 ? void 0 : e.exempt_policy_violation_keys) === null || _a === void 0 ? void 0 : _a.length)) {
+            if (type === "create" && e?.exempt_policy_violation_keys?.length) {
                 // @ts-expect-error Field required for policy violation exemptions
                 op.exempt_policy_violation_keys = e.exempt_policy_violation_keys;
                 //@ts-ignore

package/build/src/testUtils.d.ts

@@ -1,3 +1,4 @@
+import { Readable } from "stream";
 import { Customer } from "./customer";
 import { Hooks } from "./hooks";
 import { errors, GoogleAdsServiceClient, services } from "./protos";
@@ -11,7 +12,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;
@@ -26,6 +59,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;
@@ -61,6 +98,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

@@ -32,8 +32,12 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-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.mockStreamWithBadData = exports.mockStreamWithSummaryRow = 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;
+exports.mockGetAccessToken = mockGetAccessToken;
 exports.mockPaginatedSearch = mockPaginatedSearch;
 exports.mockSearchOnce = mockSearchOnce;
 exports.mockBuildSearchStreamRequestAndService = mockBuildSearchStreamRequestAndService;
@@ -42,6 +46,7 @@ exports.mockBuildMutateRequestAndService = mockBuildMutateRequestAndService;
 exports.mockGetGoogleAdsError = mockGetGoogleAdsError;
 exports.mockQuery = mockQuery;
 exports.mockParse = mockParse;
+exports.mockParseRest = mockParseRest;
 exports.noopParser = noopParser;
 exports.mockMethod = mockMethod;
 exports.failTestIfExecuted = failTestIfExecuted;
@@ -49,7 +54,9 @@ exports.newCustomer = newCustomer;
 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";
@@ -65,11 +72,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 },
 };
@@ -97,17 +138,42 @@ 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";
+    }));
+}
+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,
         };
     }));
@@ -198,7 +264,7 @@ function mockBuildMutateRequestAndService({ customer, shouldThrow = false, reque
             if (shouldThrow) {
                 throw new Error(exports.mockErrorMessage);
             }
-            return [response !== null && response !== void 0 ? response : exports.mockMutationReturnValue];
+            return [response ?? exports.mockMutationReturnValue];
         },
     };
     const spyBuild = jest
@@ -208,7 +274,7 @@ function mockBuildMutateRequestAndService({ customer, shouldThrow = false, reque
         .mockImplementation(() => {
         return {
             service: mockService,
-            request: request !== null && request !== void 0 ? request : {},
+            request: request ?? {},
         };
     });
     return { mockService, spyBuild };
@@ -235,6 +301,11 @@ function mockQuery(customer) {
 function mockParse(mockParsedValues) {
     return jest.spyOn(parser, "parse").mockImplementation(() => mockParsedValues);
 }
+function mockParseRest(mockParsedValues) {
+    return jest
+        .spyOn(parserRest, "decamelizeKeys")
+        .mockImplementation(() => mockParsedValues);
+}
 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

@@ -8,7 +8,6 @@ exports.toCamelCase = toCamelCase;
 exports.toSnakeCase = toSnakeCase;
 exports.recursiveFieldMaskSearch = recursiveFieldMaskSearch;
 exports.getFieldMask = getFieldMask;
-exports.createNextChunkArrivedPromise = createNextChunkArrivedPromise;
 const protos_1 = require("./protos");
 /**
  * @param micros Money value in micros format
@@ -100,17 +99,3 @@ function getFieldMask(data) {
         paths,
     });
 }
-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 };
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "google-ads-api",
-  "version": "20.0.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,7 +11,7 @@
     "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"
   },
@@ -19,22 +19,32 @@
   "license": "MIT",
   "dependencies": {
     "@isaacs/ttlcache": "^1.2.2",
-    "google-ads-node": "17.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.1-rc.1",
-    "long": "^4.0.0"
+    "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"
   },