google-ads-api 12.0.0 → 12.0.1

package/build/src/query.d.ts

@@ -6,6 +6,7 @@ declare enum QueryKeywords {
     WHERE = "WHERE",
     ORDER_BY = "ORDER BY",
     LIMIT = "LIMIT",
+    PARAMETERS = "PARAMETERS",
     AND = "AND",
     OR = "OR"
 }
@@ -16,7 +17,8 @@ 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 Query = `${SelectClause}${FromClause}${WhereClause}${OrderClause}${LimitClause}`;
+declare type ParametersClause = ` ${QueryKeywords.PARAMETERS} ${string}` | ``;
+declare type Query = `${SelectClause}${FromClause}${WhereClause}${OrderClause}${LimitClause}${ParametersClause}`;
 export declare const QueryError: {
     INVALID_CONSTRAINTS_FORMAT: string;
     INVALID_CONSTRAINT_KEY: string;
@@ -26,6 +28,7 @@ export declare const QueryError: {
     INVALID_FROM_DATE_TYPE: (fromDate: ReportOptions["from_date"]) => string;
     INVALID_TO_DATE_TYPE: (toDate: ReportOptions["to_date"]) => string;
     INVALID_LIMIT: string;
+    INVALID_PARAMETERS: string;
     INVALID_ORDER: string;
     INVALID_ORDERLY: string;
     INVALID_ORDERBY: string;
@@ -46,6 +49,7 @@ export declare function extractDateConstantConditions(dateConstant: ReportOption
 export declare function extractDateConditions(fromDate: ReportOptions["from_date"], toDate: ReportOptions["to_date"]): ConstraintString[];
 export declare function buildWhereClause(constraints: ReportOptions["constraints"], dateConstant: ReportOptions["date_constant"], fromDate: ReportOptions["from_date"], toDate: ReportOptions["to_date"]): WhereClause;
 export declare function buildLimitClause(limit: ReportOptions["limit"]): LimitClause;
+export declare function buildParametersClause(parameters: ReportOptions["parameters"]): ParametersClause;
 export declare function completeOrderly(orderly: string, entity: ReportOptions["entity"]): string;
 export declare function buildOrderClauseOld(orderBy: ReportOptions["order_by"], sortOrder: ReportOptions["sort_order"], entity: ReportOptions["entity"]): OrderClause;
 export declare function buildOrderClauseNew(order: Required<ReportOptions["order"]>, entity: ReportOptions["entity"]): OrderClause;

package/build/src/query.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildQuery = exports.buildRequestOptions = exports.buildOrderClause = exports.buildOrderClauseNew = exports.buildOrderClauseOld = exports.completeOrderly = exports.buildLimitClause = exports.buildWhereClause = exports.extractDateConditions = exports.extractDateConstantConditions = exports.extractConstraintConditions = exports.convertNumericEnumToString = exports.validateConstraintKeyAndValue = exports.buildFromClause = exports.buildSelectClause = exports.QueryError = void 0;
+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;
 const protos_1 = require("./protos");
 const types_1 = require("./types");
 var QueryKeywords;
@@ -10,6 +10,7 @@ var QueryKeywords;
     QueryKeywords["WHERE"] = "WHERE";
     QueryKeywords["ORDER_BY"] = "ORDER BY";
     QueryKeywords["LIMIT"] = "LIMIT";
+    QueryKeywords["PARAMETERS"] = "PARAMETERS";
     QueryKeywords["AND"] = "AND";
     QueryKeywords["OR"] = "OR";
 })(QueryKeywords || (QueryKeywords = {}));
@@ -24,6 +25,7 @@ exports.QueryError = {
     INVALID_FROM_DATE_TYPE: (fromDate) => `From date must be a string. Here, typeof from date is ${typeof fromDate}`,
     INVALID_TO_DATE_TYPE: (toDate) => `To date must be a string. Here, typeof to date is ${typeof toDate}`,
     INVALID_LIMIT: "Limit must be a positive integer.",
+    INVALID_PARAMETERS: "Parameters must be a string.",
     INVALID_ORDER: "Order must be an array.",
     INVALID_ORDERLY: "OrderBy arrays must only contain strings.",
     INVALID_ORDERBY: "OrderBy must be a string or an array of strings.",
@@ -194,6 +196,16 @@ function buildLimitClause(limit) {
     return ` ${QueryKeywords.LIMIT} ${limit}`;
 }
 exports.buildLimitClause = buildLimitClause;
+function buildParametersClause(parameters) {
+    if (typeof parameters === "undefined") {
+        return ``;
+    }
+    if (typeof parameters !== "string") {
+        throw new Error(exports.QueryError.INVALID_PARAMETERS);
+    }
+    return ` ${QueryKeywords.PARAMETERS} ${parameters}`;
+}
+exports.buildParametersClause = buildParametersClause;
 function completeOrderly(orderly, entity) {
     if (!orderly.length) {
         throw new Error(exports.QueryError.INVALID_ORDERLY);
@@ -277,11 +289,12 @@ function buildQuery(reportOptions) {
     const SELECT = buildSelectClause(reportOptions.attributes, reportOptions.metrics, reportOptions.segments);
     const FROM = buildFromClause(reportOptions.entity);
     const WHERE = buildWhereClause(reportOptions.constraints, reportOptions.date_constant, reportOptions.from_date, reportOptions.to_date);
-    const LIMIT = buildLimitClause(reportOptions.limit);
     const ORDER = buildOrderClause(reportOptions.order, reportOptions.order_by, reportOptions.sort_order, reportOptions.entity);
+    const LIMIT = buildLimitClause(reportOptions.limit);
+    const PARAMETERS = buildParametersClause(reportOptions.parameters);
     const requestOptions = buildRequestOptions(reportOptions);
     return {
-        gaqlQuery: `${SELECT}${FROM}${WHERE}${ORDER}${LIMIT}`,
+        gaqlQuery: `${SELECT}${FROM}${WHERE}${ORDER}${LIMIT}${PARAMETERS}`,
         requestOptions,
     };
 }

package/build/src/types.d.ts

@@ -12,6 +12,7 @@ export interface ReportOptions extends RequestOptions {
     metrics?: fields.Metrics;
     segments?: fields.Segments;
     constraints?: Constraints;
+    parameters?: string;
     limit?: number;
     order?: Order[];
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "google-ads-api",
-  "version": "12.0.0",
+  "version": "12.0.1",
   "description": "Google Ads API Client Library for Node.js",
   "repository": "https://github.com/Opteo/google-ads-api",
   "main": "build/src/index.js",