google-ads-api 17.1.0-rest-beta → 19.0.0-rest-beta

package/README.md

@@ -350,7 +350,7 @@ const operations: MutateOperation<
       advertising_channel_type: enums.AdvertisingChannelType.SEARCH,
       status: enums.CampaignStatus.PAUSED,
       manual_cpc: {
-        enhanced_cpc_enabled: true,
+        enhanced_cpc_enabled: false,
       },
       // Use the temporary resource id which will be created in the previous operation
       campaign_budget: budgetResourceName,
@@ -443,7 +443,9 @@ If a summary row is requested in the `report` method, it will be included as the
 const [summaryRow, ...response] = await customer.report({
   entity: "campaign",
   metrics: ["metrics.clicks", "metrics.all_conversions"],
-  summary_row_setting: enums.SummaryRowSetting.SUMMARY_ROW_WITH_RESULTS,
+  search_settings: {
+    return_summary_row: enums.SummaryRowSetting.SUMMARY_ROW_WITH_RESULTS,
+  },
 });
 ```
 
@@ -453,7 +455,9 @@ If a summery row is requested in the `reportStream` method, it will be included
 const stream = customer.reportStream({
   entity: "campaign",
   metrics: ["metrics.clicks", "metrics.all_conversions"],
-  summary_row_setting: enums.SummaryRowSetting.SUMMARY_ROW_WITH_RESULTS,
+  search_settings: {
+    return_summary_row: enums.SummaryRowSetting.SUMMARY_ROW_WITH_RESULTS,
+  },
 });
 
 const accumulator = [];

package/build/src/customer.d.ts

@@ -4,21 +4,6 @@ import { Hooks } from "./hooks";
 import { services } from "./protos";
 import ServiceFactory from "./protos/autogen/serviceFactory";
 import { CustomerOptions, MutateOperation, MutateOptions, ReportOptions, RequestOptions } from "./types";
-/**
- * TODO:
- *  - rename querierRest to streamRest. Add hooks support to it. OK
- *  - write querierRest, using pagination. OK
- *  - make sure return_total_results_count works
- *  - make sure SUMMARY_ROW_SETTING works
- *  - adapt query()
- *  - adapt queryStream
- *  - adapt report()
- *  - adapt reportCount()
- *  - adapt reportStream()
- *  - reportStreamRaw() ?
- *  - bonus: use queryStream when the params allow it. Note: do it with native async generator to make it as fast as possible.
- *  - bonus: make it possible to cancel a stream or pagination when row count exceeds specified max
- */
 export declare class Customer extends ServiceFactory {
     constructor(clientOptions: ClientOptions, customerOptions: CustomerOptions, hooks?: Hooks);
     /**

package/build/src/customer.js

@@ -14,21 +14,6 @@ const serviceFactory_1 = __importDefault(require("./protos/autogen/serviceFactor
 const query_1 = require("./query");
 const version_1 = require("./version");
 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
- *  - write querierRest, using pagination. OK
- *  - make sure return_total_results_count works
- *  - make sure SUMMARY_ROW_SETTING works
- *  - adapt query()
- *  - adapt queryStream
- *  - adapt report()
- *  - adapt reportCount()
- *  - adapt reportStream()
- *  - reportStreamRaw() ?
- *  - bonus: use queryStream when the params allow it. Note: do it with native async generator to make it as fast as possible.
- *  - bonus: make it possible to cancel a stream or pagination when row count exceeds specified max
- */
 class Customer extends serviceFactory_1.default {
     constructor(clientOptions, customerOptions, hooks) {
         super(clientOptions, customerOptions, hooks ?? {});
@@ -71,8 +56,8 @@ class Customer extends serviceFactory_1.default {
     */
     async reportCount(options) {
         const { gaqlQuery, requestOptions } = (0, query_1.buildQuery)({ ...options, limit: 1 }); // must get at least one row
-        // @ts-expect-error we do not allow this field in reportOptions, however it is still a valid request option
-        requestOptions.return_total_results_count = true;
+        // We do not allow this field in reportOptions, however it is still a valid request option
+        requestOptions.search_settings = { return_total_results_count: true };
         const useHooks = false; // to avoid cacheing conflicts
         const { totalResultsCount } = await this.querier(gaqlQuery, requestOptions, options, useHooks);
         return totalResultsCount;
@@ -162,7 +147,7 @@ class Customer extends serviceFactory_1.default {
           When possible, use the searchStream method to avoid the overhead of pagination.
         */
         if (requestOptions.page_size === undefined &&
-            requestOptions.return_total_results_count === undefined) {
+            requestOptions.search_settings?.return_total_results_count === undefined) {
             // If no pagination or summary options are set, we can use the non-paginated search method.
             const { response } = await this.useStreamToImitateRegularSearch(gaqlQuery, requestOptions);
             return { response };
@@ -173,7 +158,7 @@ class Customer extends serviceFactory_1.default {
         let totalResultsCount = initialSearch.totalResultsCount;
         // Sometimes (when no results?) the totalResultsCount field is not included in the response.
         // In this case, we set it to 0.
-        if (requestOptions.return_total_results_count &&
+        if (requestOptions.search_settings?.return_total_results_count &&
             initialSearch.totalResultsCount === undefined) {
             totalResultsCount = 0;
         }