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

package/build/src/client.js

@@ -4,6 +4,7 @@ exports.Client = void 0;
 const customer_1 = require("./customer");
 const service_1 = require("./service");
 class Client {
+    options;
     constructor(options) {
         this.options = options;
     }

package/build/src/customer.js

@@ -13,7 +13,7 @@ const protos_1 = require("./protos");
 const serviceFactory_1 = __importDefault(require("./protos/autogen/serviceFactory"));
 const query_1 = require("./query");
 const version_1 = require("./version");
-const ROWS_PER_STREAMED_CHUNK = 10000; // From experience, this is what can be expected from the API.
+const ROWS_PER_STREAMED_CHUNK = 10_000; // From experience, this is what can be expected from the API.
 /**
  * TODO:
  *  - rename querierRest to streamRest. Add hooks support to it. OK
@@ -31,7 +31,7 @@ const ROWS_PER_STREAMED_CHUNK = 10000; // From experience, this is what can be e
  */
 class Customer extends serviceFactory_1.default {
     constructor(clientOptions, customerOptions, hooks) {
-        super(clientOptions, customerOptions, hooks !== null && hooks !== void 0 ? hooks : {});
+        super(clientOptions, customerOptions, hooks ?? {});
     }
     /**
       @description Single query using a raw GAQL string.
@@ -132,7 +132,6 @@ class Customer extends serviceFactory_1.default {
         });
     }
     async search(gaqlQuery, requestOptions) {
-        var _a, _b;
         const accessToken = await this.getAccessToken();
         try {
             const rawResponse = await (0, axios_1.default)(this.prepareGoogleAdsServicePostRequestArgs("search", accessToken, {
@@ -142,7 +141,7 @@ class Customer extends serviceFactory_1.default {
                 },
             }));
             const searchResponse = rawResponse.data;
-            const results = (_a = searchResponse.results) !== null && _a !== void 0 ? _a : [];
+            const results = searchResponse.results ?? [];
             const response = results.map((row) => this.decamelizeKeysIfNeeded(row));
             const summaryRow = this.decamelizeKeysIfNeeded(searchResponse.summaryRow);
             const nextPageToken = searchResponse.nextPageToken;
@@ -152,7 +151,7 @@ class Customer extends serviceFactory_1.default {
             return { response, nextPageToken, totalResultsCount, summaryRow };
         }
         catch (e) {
-            if ((_b = e.response) === null || _b === void 0 ? void 0 : _b.data.error.details[0]) {
+            if (e.response?.data.error.details[0]) {
                 throw new protos_1.errors.GoogleAdsFailure(this.decamelizeKeysIfNeeded(e.response.data.error.details[0]));
             }
             throw e;
@@ -231,7 +230,7 @@ class Customer extends serviceFactory_1.default {
                 if (summaryRow) {
                     foundSummaryRow = this.decamelizeKeysIfNeeded(summaryRow);
                 }
-                accumulator.push(...(results !== null && results !== void 0 ? results : []).map((row) => {
+                accumulator.push(...(results ?? []).map((row) => {
                     return this.decamelizeKeysIfNeeded(row);
                 }));
                 if (foundSummaryRow) {
@@ -300,7 +299,6 @@ class Customer extends serviceFactory_1.default {
         }
     }
     async *streamer(gaqlQuery, requestOptions = {}, reportOptions) {
-        var _a;
         const baseHookArguments = {
             credentials: this.credentials,
             query: gaqlQuery,
@@ -345,7 +343,7 @@ class Customer extends serviceFactory_1.default {
             const pipeline = (0, stream_chain_1.chain)([stream, parser, (0, StreamArray_1.streamArray)()]);
             let count = 0;
             for await (const data of pipeline) {
-                const results = (_a = data.value.results) !== null && _a !== void 0 ? _a : [data.value.summaryRow];
+                const results = data.value.results ?? [data.value.summaryRow];
                 count += results.length;
                 if (this.clientOptions.max_reporting_rows &&
                     count > this.clientOptions.max_reporting_rows &&
@@ -375,17 +373,22 @@ class Customer extends serviceFactory_1.default {
         }
     }
     async handleStreamError(e) {
-        var _a;
-        if (!((_a = e === null || e === void 0 ? void 0 : e.response) === null || _a === void 0 ? void 0 : _a.data)) {
+        if (!e?.response?.data) {
             throw e;
         }
         // The error is a stream, so some effort is required to parse it.
         const stream = e.response.data;
         const pipeline = (0, stream_chain_1.chain)([stream, (0, stream_json_1.parser)(), (0, StreamArray_1.streamArray)()]);
-        let googleAdsFailure;
+        const defaultErrorMessage = "Unknown GoogleAdsFailure";
+        let googleAdsFailure = new Error(defaultErrorMessage);
         // Only throw the first error.
         pipeline.once("data", (data) => {
-            googleAdsFailure = new protos_1.errors.GoogleAdsFailure(this.decamelizeKeysIfNeeded(data.value.error.details[0]));
+            if (data?.value?.error?.details?.[0]) {
+                googleAdsFailure = new protos_1.errors.GoogleAdsFailure(this.decamelizeKeysIfNeeded(data.value.error.details[0]));
+            }
+            else {
+                googleAdsFailure = new Error(data?.value?.error?.message ?? defaultErrorMessage, { cause: data?.value?.error ?? data?.value });
+            }
         });
         // Must always reject.
         await new Promise((_, reject) => {
@@ -472,15 +475,12 @@ class Customer extends serviceFactory_1.default {
         };
     }
     prepareGoogleAdsServicePostRequestArgs(functionName, accessToken, extra) {
-        var _a, _b;
         return {
             method: "POST",
             url: `https://googleads.googleapis.com/${version_1.googleAdsVersion}/customers/${this.customerOptions.customer_id}/googleAds:${functionName}`,
             headers: {
                 Authorization: `Bearer ${accessToken}`,
                 ...this.callHeaders,
-                "developer-token": (_a = this.clientOptions.developer_token) !== null && _a !== void 0 ? _a : "",
-                "login-customer-id": (_b = this.credentials.login_customer_id) !== null && _b !== void 0 ? _b : "",
             },
             ...extra,
         };

package/build/src/hooks.d.ts

@@ -1,11 +1,11 @@
 import { errors, services } from "./protos";
 import { CustomerCredentials, MutateOperation, ReportOptions, RequestOptions, MutateOptions } from "./types";
-export declare type BaseRequestHookArgs = {
+export type BaseRequestHookArgs = {
     credentials: CustomerCredentials;
     query: string;
     reportOptions?: ReportOptions;
 };
-export declare type BaseMutationHookArgs = {
+export type BaseMutationHookArgs = {
     credentials: CustomerCredentials;
     method: `${keyof typeof services}.${string}`;
 } & (// Mutation was executed with customer.mutateResources
@@ -16,37 +16,37 @@ export declare type BaseMutationHookArgs = {
     mutation: any;
     isServiceCall: true;
 });
-export declare type BaseServiceHookArgs = {
+export type BaseServiceHookArgs = {
     credentials: CustomerCredentials;
     method: `${keyof typeof services}.${string}`;
     requestOptions: any;
 };
-declare type StartHookArgs<T = RequestOptions | MutateOptions | any, A = void> = {
+type StartHookArgs<T = RequestOptions | MutateOptions | any, A = void> = {
     cancel: A extends void ? () => void : (args?: A) => void;
     editOptions: (options: Partial<T>) => void;
 };
-declare type ErrorHookArgs = {
+type ErrorHookArgs = {
     error: errors.GoogleAdsFailure | Error;
 };
-declare type EndHookArgs<T = services.IGoogleAdsRow[] | services.MutateGoogleAdsResponse> = {
+type EndHookArgs<T = services.IGoogleAdsRow[] | services.MutateGoogleAdsResponse> = {
     response?: T;
     resolve: (args: any) => void;
 };
-declare type HookArgs = StartHookArgs | ErrorHookArgs | EndHookArgs;
-declare type RequestHook<H extends HookArgs> = (a: BaseRequestHookArgs & H) => void;
-declare type MutationHook<H extends HookArgs> = (a: BaseMutationHookArgs & H) => void;
-declare type ServiceHook<H extends HookArgs> = (a: BaseServiceHookArgs & H) => void;
-export declare type OnQueryStart = RequestHook<StartHookArgs<RequestOptions, any>>;
-export declare type OnQueryError = RequestHook<ErrorHookArgs>;
-export declare type OnQueryEnd = RequestHook<EndHookArgs<services.IGoogleAdsRow[]>>;
-export declare type OnStreamStart = RequestHook<StartHookArgs<RequestOptions, void>>;
-export declare type OnStreamError = RequestHook<ErrorHookArgs>;
-export declare type OnMutationStart = MutationHook<StartHookArgs<MutateOptions, any>>;
-export declare type OnMutationError = MutationHook<ErrorHookArgs>;
-export declare type OnMutationEnd = MutationHook<EndHookArgs<services.MutateGoogleAdsResponse>>;
-export declare type OnServiceStart = ServiceHook<StartHookArgs<any, any>>;
-export declare type OnServiceError = ServiceHook<ErrorHookArgs>;
-export declare type OnServiceEnd = ServiceHook<EndHookArgs<any>>;
+type HookArgs = StartHookArgs | ErrorHookArgs | EndHookArgs;
+type RequestHook<H extends HookArgs> = (a: BaseRequestHookArgs & H) => void;
+type MutationHook<H extends HookArgs> = (a: BaseMutationHookArgs & H) => void;
+type ServiceHook<H extends HookArgs> = (a: BaseServiceHookArgs & H) => void;
+export type OnQueryStart = RequestHook<StartHookArgs<RequestOptions, any>>;
+export type OnQueryError = RequestHook<ErrorHookArgs>;
+export type OnQueryEnd = RequestHook<EndHookArgs<services.IGoogleAdsRow[]>>;
+export type OnStreamStart = RequestHook<StartHookArgs<RequestOptions, void>>;
+export type OnStreamError = RequestHook<ErrorHookArgs>;
+export type OnMutationStart = MutationHook<StartHookArgs<MutateOptions, any>>;
+export type OnMutationError = MutationHook<ErrorHookArgs>;
+export type OnMutationEnd = MutationHook<EndHookArgs<services.MutateGoogleAdsResponse>>;
+export type OnServiceStart = ServiceHook<StartHookArgs<any, any>>;
+export type OnServiceError = ServiceHook<ErrorHookArgs>;
+export type OnServiceEnd = ServiceHook<EndHookArgs<any>>;
 export interface Hooks {
     /**
      * @description Hook called before execution of a query in the `query` and `report` methods
@@ -149,11 +149,11 @@ export interface Hooks {
      */
     onServiceEnd?: OnServiceEnd;
 }
-export declare type HookedCancellation = {
+export type HookedCancellation = {
     cancelled: boolean;
     res?: any;
 };
-export declare type HookedResolution = {
+export type HookedResolution = {
     resolved: boolean;
     res?: any;
 };