google-ads-api 24.1.0 → 25.1.0-beta.0

package/build/esm/types.d.ts

@@ -0,0 +1,75 @@
+import { services, fields } from "./protos/index.js";
+export interface CustomerOptions {
+    customer_id: string;
+    refresh_token: string;
+    login_customer_id?: string;
+    linked_customer_id?: string;
+}
+export type CustomerCredentials = Pick<CustomerOptions, "customer_id" | "login_customer_id" | "linked_customer_id">;
+export interface ReportOptions extends RequestOptions {
+    entity: fields.Resource;
+    attributes?: fields.Attributes;
+    metrics?: fields.Metrics;
+    segments?: fields.Segments;
+    constraints?: Constraints;
+    parameters?: string;
+    limit?: number;
+    order?: Order[];
+    /**
+     * @deprecated `order_by` will be removed in a future version. Migration to the `order` report option key is advised.
+     */
+    order_by?: ConstraintKey | ConstraintKey[];
+    /**
+     * @deprecated `sort_order` will be removed in a future version. Migration to the `order` report option key is advised.
+     */
+    sort_order?: SortOrder;
+    date_constant?: DateConstant;
+    from_date?: string;
+    to_date?: string;
+}
+/**
+ * Add back optional return_total_results_count as it is still a valid request option
+ */
+type SearchSettingsWithOptionalTotalCount = {
+    search_settings?: Pick<services.ISearchSettings, "return_total_results_count" | "return_summary_row">;
+};
+/**
+ * Request Options with optional total count in search_settings
+ */
+export type RequestOptionsWithTotalResults = Omit<RequestOptions, "search_settings"> & SearchSettingsWithOptionalTotalCount;
+/**
+ * Report Options with optional total count in search_settings
+ */
+export type ReportOptionsWithTotalResults = Omit<ReportOptions, "search_settings"> & SearchSettingsWithOptionalTotalCount;
+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 type SortOrder = "ASC" | "DESC";
+export interface Order {
+    field: ConstraintKey;
+    sort_order?: SortOrder;
+}
+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 type ConstraintType2 = {
+    [C in ConstraintKey]?: ConstraintValue;
+};
+export type Constraint = string | ConstraintType1 | ConstraintType2;
+export type Constraints = Constraint[] | ConstraintType2;
+export type RequestOptions = Omit<services.ISearchGoogleAdsRequest, "customer_id" | "query" | "search_settings"> & {
+    search_settings?: Omit<services.ISearchSettings, "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 type PageToken = services.ISearchGoogleAdsResponse["next_page_token"];
+export {};

package/build/esm/types.js

@@ -0,0 +1,14 @@
+export const dateConstants = [
+    "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",
+];

package/build/esm/utils.d.ts

@@ -0,0 +1,49 @@
+import { protobuf } from "./protos/index.js";
+/**
+ * @param micros Money value in micros format
+ * @description Converts a micro amount to a normalised value
+ * @example
+ * const cost = fromMicros(campaign.metrics.costMicros)
+ */
+export declare function fromMicros(micros: number): number;
+/**
+ * @param value Money value in decimal format
+ * @description Converts a number to micro format
+ * @example
+ * const costMicros = toMicros(12.5) // 12,500,000
+ */
+export declare function toMicros(value: number): number;
+/**
+ * @param query String gaql query
+ * @description Normalises a query by replacing multiple whitespace with single whitespace
+ * @example
+ * const gaqlQuery =
+ *  `SELECT campaign.name
+ *  FROM campaign
+ *  LIMIT 10`
+ * const normalisedQuery = normaliseQuery(gaqlQuery) // "SELECT campaign.name FROM campaign LIMIT 10"
+ */
+export declare function normaliseQuery(query: string): string;
+/**
+ * @param str
+ * @description Capitalises the first letter of a string
+ * @example
+ * const capitalisedString = capitaliseFirstLetter("adGroupCriterionSimulation") // "AdGroupCriterionSimulation"
+ */
+export declare function capitaliseFirstLetter<T extends string>(str: string): Capitalize<T>;
+/**
+ * @param str
+ * @description Converts a string to a camel case string. Works on space case, snake case and title case strings.
+ * @example
+ * const camelCaseString = toCamelCase("ad_group_criterion_simulation") // "adGroupCriterionSimulation"
+ */
+export declare function toCamelCase(str: string): string;
+/**
+ * @param str
+ * @description Converts a string to a snake case string. Works on space case, camel case and title case strings.
+ * @example
+ * const snakeCaseString = toSnakeCase("adGroupCriterionSimulation") // "ad_group_criterion_simulation"
+ */
+export declare function toSnakeCase(str: string): string;
+export declare function recursiveFieldMaskSearch(data: Record<string, any>, ancestors?: Set<object>): string[];
+export declare function getFieldMask(data: Record<string, any>): protobuf.FieldMask;

package/build/esm/utils.js

@@ -0,0 +1,108 @@
+import long from "long";
+import { protobuf } from "./protos/index.js";
+/**
+ * @param micros Money value in micros format
+ * @description Converts a micro amount to a normalised value
+ * @example
+ * const cost = fromMicros(campaign.metrics.costMicros)
+ */
+export function fromMicros(micros) {
+    return micros / 1000000;
+}
+/**
+ * @param value Money value in decimal format
+ * @description Converts a number to micro format
+ * @example
+ * const costMicros = toMicros(12.5) // 12,500,000
+ */
+export function toMicros(value) {
+    return Math.round(value * 1000000);
+}
+/**
+ * @param query String gaql query
+ * @description Normalises a query by replacing multiple whitespace with single whitespace
+ * @example
+ * const gaqlQuery =
+ *  `SELECT campaign.name
+ *  FROM campaign
+ *  LIMIT 10`
+ * const normalisedQuery = normaliseQuery(gaqlQuery) // "SELECT campaign.name FROM campaign LIMIT 10"
+ */
+export function normaliseQuery(query) {
+    return `${query.replace(/\s{2,}/g, " ")}`;
+}
+/**
+ * @param str
+ * @description Capitalises the first letter of a string
+ * @example
+ * const capitalisedString = capitaliseFirstLetter("adGroupCriterionSimulation") // "AdGroupCriterionSimulation"
+ */
+export function capitaliseFirstLetter(str) {
+    return (str.charAt(0).toUpperCase() + str.slice(1));
+}
+/**
+ * @param str
+ * @description Converts a string to a camel case string. Works on space case, snake case and title case strings.
+ * @example
+ * const camelCaseString = toCamelCase("ad_group_criterion_simulation") // "adGroupCriterionSimulation"
+ */
+export function toCamelCase(str) {
+    return str
+        .replace(/\s+/g, "_") // convert spaces to underscores
+        .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
+}
+/**
+ * @param str
+ * @description Converts a string to a snake case string. Works on space case, camel case and title case strings.
+ * @example
+ * const snakeCaseString = toSnakeCase("adGroupCriterionSimulation") // "ad_group_criterion_simulation"
+ */
+export function toSnakeCase(str) {
+    return str
+        .replace(/\s+/g, "_") // convert spaces to underscores
+        .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();
+}
+export function recursiveFieldMaskSearch(data, 
+// eslint-disable-next-line @typescript-eslint/ban-types
+ancestors = new Set()) {
+    if (ancestors.has(data)) {
+        throw new Error("Cannot build a field mask from an object containing a circular reference");
+    }
+    ancestors.add(data);
+    const paths = [];
+    for (const key of Object.keys(data)) {
+        if (key === "resourceName") {
+            continue;
+        }
+        const fieldKey = toSnakeCase(key);
+        const value = data[key];
+        if (typeof value === "object" &&
+            !Array.isArray(value) &&
+            !ArrayBuffer.isView(value) &&
+            !long.isLong(value) &&
+            value !== null) {
+            if (Object.keys(value).length === 0) {
+                paths.push(fieldKey);
+            }
+            else {
+                const children = recursiveFieldMaskSearch(value, ancestors);
+                for (const child of children) {
+                    paths.push(`${fieldKey}.${child}`);
+                }
+            }
+            continue;
+        }
+        paths.push(fieldKey);
+    }
+    ancestors.delete(data);
+    return paths;
+}
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function getFieldMask(data) {
+    const paths = recursiveFieldMaskSearch(data);
+    return new protobuf.FieldMask({
+        paths,
+    });
+}

package/build/esm/version.d.ts

@@ -0,0 +1 @@
+export declare const googleAdsVersion = "v25";

package/build/esm/version.js

@@ -0,0 +1 @@
+export const googleAdsVersion = "v25";

package/package.json

@@ -1,16 +1,20 @@
 {
   "name": "google-ads-api",
-  "version": "24.1.0",
+  "version": "25.1.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",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Opteo/google-ads-api.git"
+  },
+  "main": "./build/cjs/index.js",
   "files": [
-    "build/src"
+    "build/cjs",
+    "build/esm"
   ],
   "scripts": {
     "test": "jest",
     "lint": "eslint . --ext .ts",
-    "build": "tsc",
+    "build": "tsc -p tsconfig.cjs.json && tsc -p tsconfig.esm.json && printf '{\"type\":\"module\"}' > build/esm/package.json",
     "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"
@@ -21,9 +25,9 @@
     "@isaacs/ttlcache": "^1.4.0",
     "axios": "^1.6.7",
     "circ-json": "^1.0.4",
-    "google-ads-node": "24.1.0",
-    "google-auth-library": "^9.15.1",
-    "google-gax": "^5.0.7",
+    "google-ads-node": "25.1.0-beta.0",
+    "google-auth-library": "^11.0.2",
+    "google-gax": "^6.3.0",
     "long": "^4.0.0",
     "stream-json": "^1.8.0"
   },
@@ -60,8 +64,43 @@
     "adwords javascript",
     "gads"
   ],
-  "resolutions": {
-    "google-auth-library": "^9.15.1"
+  "packageManager": "yarn@1.22.21+sha1.1959a18351b811cdeedbd484a8f86c3cc3bbaf72",
+  "type": "commonjs",
+  "engines": {
+    "node": ">=22"
   },
-  "packageManager": "yarn@1.22.21+sha1.1959a18351b811cdeedbd484a8f86c3cc3bbaf72"
+  "types": "./build/cjs/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./build/esm/index.d.ts",
+        "default": "./build/esm/index.js"
+      },
+      "require": {
+        "types": "./build/cjs/index.d.ts",
+        "default": "./build/cjs/index.js"
+      }
+    },
+    "./enums": {
+      "import": {
+        "types": "./build/esm/protos/autogen/enums.d.ts",
+        "default": "./build/esm/protos/autogen/enums.js"
+      },
+      "require": {
+        "types": "./build/cjs/protos/autogen/enums.d.ts",
+        "default": "./build/cjs/protos/autogen/enums.js"
+      }
+    },
+    "./fields": {
+      "import": {
+        "types": "./build/esm/protos/autogen/fields.d.ts",
+        "default": "./build/esm/protos/autogen/fields.js"
+      },
+      "require": {
+        "types": "./build/cjs/protos/autogen/fields.d.ts",
+        "default": "./build/cjs/protos/autogen/fields.js"
+      }
+    },
+    "./package.json": "./package.json"
+  }
 }

package/build/src/index.d.ts

@@ -1,8 +0,0 @@
-export { Client as GoogleAdsApi, ClientOptions } from "./client";
-export { common, enums, fields, errors, resources, services, longrunning, protobuf, } from "./protos/index";
-export { fromMicros, toMicros } from "./utils";
-export { parse } from "./parser";
-export * as ResourceNames from "./protos/autogen/resourceNames";
-export { CustomerOptions, ReportOptions, MutateOperation, Constraint, Constraints, } from "./types";
-export { Hooks, OnQueryStart, OnQueryError, OnQueryEnd, OnStreamStart, OnStreamError, OnMutationStart, OnMutationError, OnMutationEnd, OnServiceStart, OnServiceError, OnServiceEnd, } from "./hooks";
-export { Customer } from "./customer";