google-ads-api 16.0.0 → 17.0.0-beta.0

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

@@ -1,14 +1,14 @@
 import allProtos, { protos } from "google-ads-node";
-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 declare const VERSION: "v17";
+export import common = protos.google.ads.googleads.v17.common;
+export import errors = protos.google.ads.googleads.v17.errors;
+export import resources = protos.google.ads.googleads.v17.resources;
+export import services = protos.google.ads.googleads.v17.services;
+export import internalEnums = protos.google.ads.googleads.v17.enums;
 export { enums } from "./autogen/enums";
 export { fields } 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>;
+export type AllServices = Omit<typeof allProtos, typeof VERSION>;
+export type ServiceName = keyof Omit<typeof allProtos, typeof VERSION>;
 export import protobuf = protos.google.protobuf;
 export import longrunning = protos.google.longrunning;

package/build/src/protos/index.js

@@ -7,12 +7,12 @@ const version_1 = require("../version");
 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.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;
+exports.common = google_ads_node_1.protos.google.ads.googleads.v17.common;
+exports.errors = google_ads_node_1.protos.google.ads.googleads.v17.errors;
+exports.resources = google_ads_node_1.protos.google.ads.googleads.v17.resources;
+exports.services = google_ads_node_1.protos.google.ads.googleads.v17.services;
 // We compile enums ourselves, the Google ones should be used internally only
-exports.internalEnums = google_ads_node_1.protos.google.ads.googleads.v16.enums;
+exports.internalEnums = google_ads_node_1.protos.google.ads.googleads.v17.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");

package/build/src/query.d.ts

@@ -10,15 +10,15 @@ declare enum QueryKeywords {
     AND = "AND",
     OR = "OR"
 }
-declare type ParsedConstraintValue = string | number | boolean;
-declare type ConstraintString = `${string} ${ConstraintOperation} ${ParsedConstraintValue}`;
-declare type SelectClause = `${QueryKeywords.SELECT} ${string}`;
-declare type FromClause = ` ${QueryKeywords.FROM} ${fields.Resource}`;
-declare type WhereClause = ` ${QueryKeywords.WHERE} ${string}` | ``;
-export declare type OrderClause = ` ${QueryKeywords.ORDER_BY} ${string} ${SortOrder}` | ` ${QueryKeywords.ORDER_BY} ${string}` | ``;
-declare type LimitClause = ` ${QueryKeywords.LIMIT} ${number}` | ``;
-declare type ParametersClause = ` ${QueryKeywords.PARAMETERS} ${string}` | ``;
-declare type Query = `${SelectClause}${FromClause}${WhereClause}${OrderClause}${LimitClause}${ParametersClause}`;
+type ParsedConstraintValue = string | number | boolean;
+type ConstraintString = `${string} ${ConstraintOperation} ${ParsedConstraintValue}`;
+type SelectClause = `${QueryKeywords.SELECT} ${string}`;
+type FromClause = ` ${QueryKeywords.FROM} ${fields.Resource}`;
+type WhereClause = ` ${QueryKeywords.WHERE} ${string}` | ``;
+export type OrderClause = ` ${QueryKeywords.ORDER_BY} ${string} ${SortOrder}` | ` ${QueryKeywords.ORDER_BY} ${string}` | ``;
+type LimitClause = ` ${QueryKeywords.LIMIT} ${number}` | ``;
+type ParametersClause = ` ${QueryKeywords.PARAMETERS} ${string}` | ``;
+type Query = `${SelectClause}${FromClause}${WhereClause}${OrderClause}${LimitClause}${ParametersClause}`;
 export declare const QueryError: {
     INVALID_CONSTRAINTS_FORMAT: string;
     INVALID_CONSTRAINT_KEY: string;

package/build/src/query.js

@@ -1,6 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildQuery = exports.buildRequestOptions = exports.buildOrderClause = exports.buildOrderClauseNew = exports.buildOrderClauseOld = exports.completeOrderly = exports.buildParametersClause = exports.buildLimitClause = exports.buildWhereClause = exports.extractDateConditions = exports.extractDateConstantConditions = exports.extractConstraintConditions = exports.convertNumericEnumToString = exports.validateConstraintKeyAndValue = exports.buildFromClause = exports.buildSelectClause = exports.QueryError = void 0;
+exports.QueryError = void 0;
+exports.buildSelectClause = buildSelectClause;
+exports.buildFromClause = buildFromClause;
+exports.validateConstraintKeyAndValue = validateConstraintKeyAndValue;
+exports.convertNumericEnumToString = convertNumericEnumToString;
+exports.extractConstraintConditions = extractConstraintConditions;
+exports.extractDateConstantConditions = extractDateConstantConditions;
+exports.extractDateConditions = extractDateConditions;
+exports.buildWhereClause = buildWhereClause;
+exports.buildLimitClause = buildLimitClause;
+exports.buildParametersClause = buildParametersClause;
+exports.completeOrderly = completeOrderly;
+exports.buildOrderClauseOld = buildOrderClauseOld;
+exports.buildOrderClauseNew = buildOrderClauseNew;
+exports.buildOrderClause = buildOrderClause;
+exports.buildRequestOptions = buildRequestOptions;
+exports.buildQuery = buildQuery;
 const protos_1 = require("./protos");
 const types_1 = require("./types");
 var QueryKeywords;
@@ -45,14 +61,12 @@ function buildSelectClause(attributes, metrics, segments) {
     ].join(", ");
     return `${QueryKeywords.SELECT} ${selections}`;
 }
-exports.buildSelectClause = buildSelectClause;
 function buildFromClause(entity) {
     if (typeof entity === "undefined") {
         throw new Error(exports.QueryError.UNDEFINED_ENTITY);
     }
     return ` ${QueryKeywords.FROM} ${entity}`;
 }
-exports.buildFromClause = buildFromClause;
 function validateConstraintKeyAndValue(key, op, val) {
     if (typeof val === "number" || typeof val === "boolean") {
         return { op: "=", val: convertNumericEnumToString(key, val) };
@@ -81,7 +95,6 @@ function validateConstraintKeyAndValue(key, op, val) {
     }
     throw new Error(exports.QueryError.INVALID_CONSTRAINT_VALUE(key, val));
 }
-exports.validateConstraintKeyAndValue = validateConstraintKeyAndValue;
 function convertNumericEnumToString(key, val) {
     // @ts-expect-error key does not always match an enum field
     if (protos_1.fields.enumFields[key] && typeof val === "number") {
@@ -93,7 +106,6 @@ function convertNumericEnumToString(key, val) {
     }
     return val;
 }
-exports.convertNumericEnumToString = convertNumericEnumToString;
 function extractConstraintConditions(constraints) {
     if (typeof constraints === "undefined") {
         return [];
@@ -138,7 +150,6 @@ function extractConstraintConditions(constraints) {
         throw new Error(exports.QueryError.INVALID_CONSTRAINTS_FORMAT);
     }
 }
-exports.extractConstraintConditions = extractConstraintConditions;
 function extractDateConstantConditions(dateConstant) {
     if (typeof dateConstant === "undefined") {
         return [];
@@ -148,7 +159,6 @@ function extractDateConstantConditions(dateConstant) {
     }
     return [`segments.date DURING ${dateConstant}`];
 }
-exports.extractDateConstantConditions = extractDateConstantConditions;
 function extractDateConditions(fromDate, toDate) {
     if (typeof fromDate === "undefined" && typeof toDate === "undefined") {
         return [];
@@ -171,7 +181,6 @@ function extractDateConditions(fromDate, toDate) {
         `segments.date <= "${toDate}"`,
     ];
 }
-exports.extractDateConditions = extractDateConditions;
 function buildWhereClause(constraints, dateConstant, fromDate, toDate) {
     const constraintClauses = extractConstraintConditions(constraints);
     const dateConstantClauses = extractDateConstantConditions(dateConstant);
@@ -185,7 +194,6 @@ function buildWhereClause(constraints, dateConstant, fromDate, toDate) {
         ? ` ${QueryKeywords.WHERE} ${whereClauses}`
         : ``;
 }
-exports.buildWhereClause = buildWhereClause;
 function buildLimitClause(limit) {
     if (typeof limit === "undefined") {
         return ``;
@@ -195,7 +203,6 @@ function buildLimitClause(limit) {
     }
     return ` ${QueryKeywords.LIMIT} ${limit}`;
 }
-exports.buildLimitClause = buildLimitClause;
 function buildParametersClause(parameters) {
     if (typeof parameters === "undefined") {
         return ``;
@@ -205,7 +212,6 @@ function buildParametersClause(parameters) {
     }
     return ` ${QueryKeywords.PARAMETERS} ${parameters}`;
 }
-exports.buildParametersClause = buildParametersClause;
 function completeOrderly(orderly, entity) {
     if (!orderly.length) {
         throw new Error(exports.QueryError.INVALID_ORDERLY);
@@ -222,7 +228,6 @@ function completeOrderly(orderly, entity) {
         throw new Error(exports.QueryError.INVALID_ORDERLY);
     }
 }
-exports.completeOrderly = completeOrderly;
 function buildOrderClauseOld(orderBy, sortOrder, entity) {
     if (typeof orderBy === "undefined") {
         return ``;
@@ -253,7 +258,6 @@ function buildOrderClauseOld(orderBy, sortOrder, entity) {
         throw new Error(exports.QueryError.INVALID_ORDERBY);
     }
 }
-exports.buildOrderClauseOld = buildOrderClauseOld;
 function buildOrderClauseNew(order, entity) {
     if (!order || !Array.isArray(order)) {
         throw new Error(exports.QueryError.INVALID_ORDER);
@@ -270,7 +274,6 @@ function buildOrderClauseNew(order, entity) {
         .join(", ");
     return ` ${QueryKeywords.ORDER_BY} ${orders}`;
 }
-exports.buildOrderClauseNew = buildOrderClauseNew;
 function buildOrderClause(order, orderBy, sortOrder, entity) {
     if (order) {
         return buildOrderClauseNew(order, entity);
@@ -279,12 +282,10 @@ function buildOrderClause(order, orderBy, sortOrder, entity) {
         return buildOrderClauseOld(orderBy, sortOrder, entity);
     }
 }
-exports.buildOrderClause = buildOrderClause;
 function buildRequestOptions(reportOptions) {
     const { page_size, page_token, validate_only, summary_row_setting } = reportOptions;
     return { page_size, page_token, validate_only, summary_row_setting };
 }
-exports.buildRequestOptions = buildRequestOptions;
 function buildQuery(reportOptions) {
     const SELECT = buildSelectClause(reportOptions.attributes, reportOptions.metrics, reportOptions.segments);
     const FROM = buildFromClause(reportOptions.entity);
@@ -298,4 +299,3 @@ function buildQuery(reportOptions) {
         requestOptions,
     };
 }
-exports.buildQuery = buildQuery;

package/build/src/service.d.ts

@@ -2,7 +2,7 @@ import { ClientOptions } from "./client";
 import { AllServices, errors, GoogleAdsServiceClient, ServiceName, services } from "./protos";
 import { CustomerOptions, CustomerCredentials, RequestOptions, MutateOperation, MutateOptions } from "./types";
 import { Hooks } from "./hooks";
-export declare const FAILURE_KEY: string;
+export declare const FAILURE_KEY = "google.ads.googleads.v17.errors.googleadsfailure-bin";
 export interface CallHeaders {
     "developer-token": string;
     "login-customer-id"?: string;

package/build/src/service.js

@@ -15,7 +15,7 @@ exports.FAILURE_KEY = `google.ads.googleads.${version_1.googleAdsVersion}.errors
 // A global service cache to avoid re-initialising services
 const serviceCache = new ttlcache_1.default({
     max: 1000,
-    ttl: 10 * 60 * 1000,
+    ttl: 10 * 60 * 1000, // 10 minutes
     dispose: async (service) => {
         // Close connections when services are removed from the cache
         await service.close();

package/build/src/testUtils.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="jest" />
 import { Customer } from "./customer";
 import { Hooks } from "./hooks";
 import { errors, GoogleAdsServiceClient, services } from "./protos";

package/build/src/testUtils.js

@@ -23,7 +23,19 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 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.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.mockPaginatedSearch = mockPaginatedSearch;
+exports.mockSearchOnce = mockSearchOnce;
+exports.mockBuildSearchStreamRequestAndService = mockBuildSearchStreamRequestAndService;
+exports.mockBuildSearchRequestAndService = mockBuildSearchRequestAndService;
+exports.mockBuildMutateRequestAndService = mockBuildMutateRequestAndService;
+exports.mockGetGoogleAdsError = mockGetGoogleAdsError;
+exports.mockQuery = mockQuery;
+exports.mockParse = mockParse;
+exports.noopParser = noopParser;
+exports.mockMethod = mockMethod;
+exports.failTestIfExecuted = failTestIfExecuted;
+exports.newCustomer = newCustomer;
 const stream_1 = require("stream");
 const customer_1 = require("./customer");
 const parser = __importStar(require("./parser"));
@@ -90,7 +102,6 @@ function mockPaginatedSearch(customer, includeTotalResultsCount = false) {
         };
     }));
 }
-exports.mockPaginatedSearch = mockPaginatedSearch;
 function mockSearchOnce({ customer, response, nextPageToken, includeTotalResultsCount, }) {
     return (jest
         // @ts-expect-error private method
@@ -106,7 +117,6 @@ function mockSearchOnce({ customer, response, nextPageToken, includeTotalResults
         };
     }));
 }
-exports.mockSearchOnce = mockSearchOnce;
 function mockBuildSearchStreamRequestAndService(customer) {
     const mockStream = new stream_1.Readable({ objectMode: true });
     const mockStreamData = (results) => {
@@ -145,7 +155,6 @@ function mockBuildSearchStreamRequestAndService(customer) {
         mockStreamEnd,
     };
 }
-exports.mockBuildSearchStreamRequestAndService = mockBuildSearchStreamRequestAndService;
 function mockBuildSearchRequestAndService({ customer, shouldThrow = false, includeSummaryRow = false, includeTotalResultsCount = false, }) {
     const mockService = {
         search: () => {
@@ -173,7 +182,6 @@ function mockBuildSearchRequestAndService({ customer, shouldThrow = false, inclu
     });
     return { mockService, spyBuild };
 }
-exports.mockBuildSearchRequestAndService = mockBuildSearchRequestAndService;
 function mockBuildMutateRequestAndService({ customer, shouldThrow = false, request, response, }) {
     const mockService = {
         mutate() {
@@ -195,7 +203,6 @@ function mockBuildMutateRequestAndService({ customer, shouldThrow = false, reque
     });
     return { mockService, spyBuild };
 }
-exports.mockBuildMutateRequestAndService = mockBuildMutateRequestAndService;
 function mockGetGoogleAdsError(customer) {
     return (jest
         // @ts-expect-error protected method
@@ -203,7 +210,6 @@ function mockGetGoogleAdsError(customer) {
         // @ts-expect-error
         .mockImplementation(() => exports.mockError));
 }
-exports.mockGetGoogleAdsError = mockGetGoogleAdsError;
 function mockQuery(customer) {
     return (jest
         // @ts-expect-error private method
@@ -216,15 +222,12 @@ function mockQuery(customer) {
         };
     }));
 }
-exports.mockQuery = mockQuery;
 function mockParse(mockParsedValues) {
     return jest.spyOn(parser, "parse").mockImplementation(() => mockParsedValues);
 }
-exports.mockParse = mockParse;
 function noopParser(rows) {
     return rows;
 }
-exports.noopParser = noopParser;
 function mockMethod() {
     return {
         method() {
@@ -232,11 +235,9 @@ function mockMethod() {
         },
     };
 }
-exports.mockMethod = mockMethod;
 function failTestIfExecuted() {
     expect(true).toBeFalsy();
 }
-exports.failTestIfExecuted = failTestIfExecuted;
 function newCustomer(hooks, disableParsing = false) {
     return new customer_1.Customer({
         client_id: exports.MOCK_CLIENT_ID,
@@ -249,4 +250,3 @@ function newCustomer(hooks, disableParsing = false) {
         login_customer_id: exports.MOCK_LOGIN_CID,
     }, hooks);
 }
-exports.newCustomer = newCustomer;

package/build/src/types.d.ts

@@ -5,7 +5,7 @@ export interface CustomerOptions {
     login_customer_id?: string;
     linked_customer_id?: string;
 }
-export declare type CustomerCredentials = Pick<CustomerOptions, "customer_id" | "login_customer_id" | "linked_customer_id">;
+export type CustomerCredentials = Pick<CustomerOptions, "customer_id" | "login_customer_id" | "linked_customer_id">;
 export interface ReportOptions extends RequestOptions {
     entity: fields.Resource;
     attributes?: fields.Attributes;
@@ -27,32 +27,32 @@ export interface ReportOptions extends RequestOptions {
     from_date?: string;
     to_date?: string;
 }
-export declare type DateConstant = "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_BUSINESS_WEEK" | "THIS_MONTH" | "LAST_MONTH" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_WEEK_SUN_TODAY" | "THIS_WEEK_MON_TODAY" | "LAST_WEEK_SUN_SAT" | "LAST_WEEK_MON_SUN";
+export type DateConstant = "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_BUSINESS_WEEK" | "THIS_MONTH" | "LAST_MONTH" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_WEEK_SUN_TODAY" | "THIS_WEEK_MON_TODAY" | "LAST_WEEK_SUN_SAT" | "LAST_WEEK_MON_SUN";
 export declare const dateConstants: DateConstant[];
-export declare type SortOrder = "ASC" | "DESC";
+export type SortOrder = "ASC" | "DESC";
 export interface Order {
     field: ConstraintKey;
     sort_order?: SortOrder;
 }
-export declare type ConstraintKey = fields.Attribute | fields.Metric | fields.Segment;
-export declare type ConstraintValue = number | string | boolean | (number | string)[];
-export declare type ConstraintOperation = "=" | "!=" | ">" | ">=" | "<" | "<=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE" | "CONTAINS ANY" | "CONTAINS ALL" | "CONTAINS NONE" | "IS NULL" | "IS NOT NULL" | "DURING" | "BETWEEN" | "REGEXP_MATCH" | "NOT REGEXP_MATCH";
-export declare type ConstraintType1 = {
+export type ConstraintKey = fields.Attribute | fields.Metric | fields.Segment;
+export type ConstraintValue = number | string | boolean | (number | string)[];
+export type ConstraintOperation = "=" | "!=" | ">" | ">=" | "<" | "<=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE" | "CONTAINS ANY" | "CONTAINS ALL" | "CONTAINS NONE" | "IS NULL" | "IS NOT NULL" | "DURING" | "BETWEEN" | "REGEXP_MATCH" | "NOT REGEXP_MATCH";
+export type ConstraintType1 = {
     key: ConstraintKey;
     op: ConstraintOperation;
     val: ConstraintValue;
 };
-export declare type ConstraintType2 = {
+export type ConstraintType2 = {
     [C in ConstraintKey]?: ConstraintValue;
 };
-export declare type Constraint = string | ConstraintType1 | ConstraintType2;
-export declare type Constraints = Constraint[] | ConstraintType2;
-export declare type RequestOptions = Omit<services.ISearchGoogleAdsRequest, "customer_id" | "query" | "return_total_results_count">;
-export declare type MutateOptions = Omit<services.IMutateGoogleAdsRequest, "customer_id" | "mutate_operations">;
-export declare type MutateOperation<T> = {
+export type Constraint = string | ConstraintType1 | ConstraintType2;
+export type Constraints = Constraint[] | ConstraintType2;
+export type RequestOptions = Omit<services.ISearchGoogleAdsRequest, "customer_id" | "query" | "return_total_results_count">;
+export type MutateOptions = Omit<services.IMutateGoogleAdsRequest, "customer_id" | "mutate_operations">;
+export type MutateOperation<T> = {
     resource: T;
     entity: fields.Resource;
     operation?: "create" | "update" | "remove";
     exempt_policy_violation_keys?: services.AdGroupCriterionOperation["exempt_policy_violation_keys"];
 } & Partial<Omit<T, "toJSON">>;
-export declare type PageToken = services.ISearchGoogleAdsResponse["next_page_token"];
+export type PageToken = services.ISearchGoogleAdsResponse["next_page_token"];

package/build/src/utils.js

@@ -1,6 +1,14 @@
 "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.fromMicros = fromMicros;
+exports.toMicros = toMicros;
+exports.normaliseQuery = normaliseQuery;
+exports.capitaliseFirstLetter = capitaliseFirstLetter;
+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
@@ -11,7 +19,6 @@ const protos_1 = require("./protos");
 function fromMicros(micros) {
     return micros / 1000000;
 }
-exports.fromMicros = fromMicros;
 /**
  * @param value Money value in decimal format
  * @description Converts a number to micro format
@@ -21,7 +28,6 @@ exports.fromMicros = fromMicros;
 function toMicros(value) {
     return Math.round(value * 1000000);
 }
-exports.toMicros = toMicros;
 /**
  * @param query String gaql query
  * @description Normalises a query by replacing multiple whitespace with single whitespace
@@ -35,7 +41,6 @@ exports.toMicros = toMicros;
 function normaliseQuery(query) {
     return `${query.replace(/\s{2,}/g, " ")}`;
 }
-exports.normaliseQuery = normaliseQuery;
 /**
  * @param str
  * @description Capitalises the first letter of a string
@@ -45,7 +50,6 @@ exports.normaliseQuery = normaliseQuery;
 function capitaliseFirstLetter(str) {
     return (str.charAt(0).toUpperCase() + str.slice(1));
 }
-exports.capitaliseFirstLetter = capitaliseFirstLetter;
 /**
  * @param str
  * @description Converts a string to a camel case string. Works on space case, snake case and title case strings.
@@ -58,7 +62,6 @@ function toCamelCase(str) {
         .replace(/(_)([A-Za-z])/g, (pattern) => pattern[1].toUpperCase()) // replace "_x" patterns with "X"
         .replace(/^([A-Z])/g, (pattern) => pattern.toLowerCase()); // capitalises the first letter of the string
 }
-exports.toCamelCase = toCamelCase;
 /**
  * @param str
  * @description Converts a string to a snake case string. Works on space case, camel case and title case strings.
@@ -71,7 +74,6 @@ function toSnakeCase(str) {
         .replace(/(?<!(^|_))([A-Z])/g, (pattern) => "_" + pattern) // places an underscore before any capital chars, unless there is already an underscore or it is the first char of the string
         .toLowerCase();
 }
-exports.toSnakeCase = toSnakeCase;
 function recursiveFieldMaskSearch(data) {
     const paths = [];
     for (const key of Object.keys(data)) {
@@ -91,7 +93,6 @@ function recursiveFieldMaskSearch(data) {
     }
     return paths;
 }
-exports.recursiveFieldMaskSearch = recursiveFieldMaskSearch;
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function getFieldMask(data) {
     const paths = recursiveFieldMaskSearch(data);
@@ -99,7 +100,6 @@ function getFieldMask(data) {
         paths,
     });
 }
-exports.getFieldMask = getFieldMask;
 function createNextChunkArrivedPromise() {
     let resolvePromise = () => {
         return;
@@ -114,4 +114,3 @@ function createNextChunkArrivedPromise() {
     });
     return { newPromise, resolve: resolvePromise, reject: rejectPromise };
 }
-exports.createNextChunkArrivedPromise = createNextChunkArrivedPromise;

package/build/src/version.d.ts

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

package/build/src/version.js

@@ -4,17 +4,19 @@ exports.googleAdsVersion = void 0;
 /*
     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.
+    2. Update google-ads-node & google-gax in package.json. google-gax must be the same version as google-ads-node,
+        Otherwise you are likely to get a `TypeError: Channel credentials must be a ChannelCredentials object` error.
     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.
+        The compile step depends on some environment variables being set (see scripts/fields.ts), so make sure to set those.
     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";
+exports.googleAdsVersion = "v17";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "google-ads-api",
-  "version": "16.0.0",
+  "version": "17.0.0-beta.0",
   "description": "Google Ads API Client Library for Node.js",
   "repository": "https://github.com/Opteo/google-ads-api",
   "main": "build/src/index.js",
@@ -18,13 +18,14 @@
   "license": "MIT",
   "dependencies": {
     "@isaacs/ttlcache": "^1.2.2",
-    "google-ads-node": "^13.0.0",
+    "google-ads-node": "^14.0.0-beta.1",
     "google-auth-library": "^7.1.0",
-    "google-gax": "^4.3.1",
+    "google-gax": "^4.4.1",
     "long": "^4.0.0"
   },
   "devDependencies": {
     "@types/jest": "^29.0.1",
+    "@types/node": "^22.5.4",
     "@types/pluralize": "^0.0.29",
     "@typescript-eslint/eslint-plugin": "^4.8.2",
     "@typescript-eslint/parser": "^4.8.2",
@@ -32,7 +33,7 @@
     "jest": "^29.0.3",
     "pluralize": "^8.0.0",
     "ts-jest": "^29.0.0",
-    "typescript": "^4.1.2"
+    "typescript": "^5.5.4"
   },
   "keywords": [
     "google ads",