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

package/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Changelog
+
+### Upcoming Breaking Changes
+
+From v20 onwards this library will use the REST api for report, reportStream, search and searchStream. This will result in minor breaking changes to reporting calls:
+
+- Fields with the enum value `0` will now be `undefined` instead
+- Array-fields (such as `final_urls`) with the value `[]` will now be `undefined` instead
+
+While these changes are inconvenient, the performance of the REST api is significantly better than the gRPC api, particularly for responses with many rows.
+
+To prepare for this change, we recommend you use the install the `19.0.0-rest-beta` version of this library and test your application with it.
+
+## 19.0.1
+
+- Fix issue with type interface for search_settings not showing any valid fields.
+
+## 19.0.0
+
+### Version Upgrade
+
+- Upgraded google-ads-api version to v19. Refer to Google ads release notes [here](https://developers.google.com/google-ads/api/docs/release-notes) for changes.
+
+### Library Changes
+
+- We currently do not support `return_total_results_count` on search_settings for SearchGoogleAdsRequest. Please use `reportCount()` instead. This has been reflected in the `RequestOptions` type:
+
+```ts
+export type RequestOptions = Omit<
+  services.ISearchGoogleAdsRequest,
+  "customer_id" | "query" | "search_settings"
+> & {
+  search_settings?: Omit<
+    services.ISearchSettings,
+    "return_total_results_count"
+  >;
+};
+```
+
+For more information please see the `SearchSettings` reference on the Google document [here](https://developers.google.com/google-ads/api/reference/rpc/v19/SearchSettings).

package/README.md

@@ -444,7 +444,7 @@ const [summaryRow, ...response] = await customer.report({
   entity: "campaign",
   metrics: ["metrics.clicks", "metrics.all_conversions"],
   search_settings: {
-    return_summary_row: enums.SummaryRowSetting.SUMMARY_ROW_WITH_RESULTS,
+    return_summary_row: true,
   },
 });
 ```
@@ -456,7 +456,7 @@ const stream = customer.reportStream({
   entity: "campaign",
   metrics: ["metrics.clicks", "metrics.all_conversions"],
   search_settings: {
-    return_summary_row: enums.SummaryRowSetting.SUMMARY_ROW_WITH_RESULTS,
+    return_summary_row: true,
   },
 });
 

package/build/src/customer.d.ts

@@ -3,7 +3,7 @@ import { ClientOptions } from "./client";
 import { Hooks } from "./hooks";
 import { services } from "./protos";
 import ServiceFactory from "./protos/autogen/serviceFactory";
-import { CustomerOptions, MutateOperation, MutateOptions, ReportOptions, RequestOptions } from "./types";
+import { CustomerOptions, MutateOperation, MutateOptions, ReportOptions, ReportOptionsWithTotalResults, RequestOptions } from "./types";
 export declare class Customer extends ServiceFactory {
     constructor(clientOptions: ClientOptions, customerOptions: CustomerOptions, hooks?: Hooks);
     /**
@@ -30,7 +30,7 @@ export declare class Customer extends ServiceFactory {
       @description Get the total row count of a report.
       @hooks none
     */
-    reportCount(options: Readonly<ReportOptions>): Promise<number | undefined>;
+    reportCount(options: Readonly<ReportOptionsWithTotalResults>): Promise<number | undefined>;
     /**
       @description Stream query using ReportOptions. If a generic type is provided, it must be the type of a single row.
       If a summary row is requested then this will be the last emitted row of the stream.

package/build/src/customer.js

@@ -55,7 +55,8 @@ class Customer extends serviceFactory_1.default {
       @hooks none
     */
     async reportCount(options) {
-        const { gaqlQuery, requestOptions } = (0, query_1.buildQuery)({ ...options, limit: 1 }); // must get at least one row
+        // must get at least one row
+        const { gaqlQuery, requestOptions } = (0, query_1.buildQuery)({ ...options, limit: 1 });
         // 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
@@ -147,7 +148,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.search_settings?.return_total_results_count === undefined) {
+            !requestOptions.search_settings?.return_summary_row) {
             // 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 };

package/build/src/query.d.ts

@@ -1,5 +1,5 @@
 import { fields } from "./protos";
-import { ConstraintKey, ConstraintOperation, ConstraintValue, ReportOptions, RequestOptions, SortOrder } from "./types";
+import { ConstraintKey, ConstraintOperation, ConstraintValue, ReportOptions, RequestOptions, RequestOptionsWithTotalResults, SortOrder } from "./types";
 declare enum QueryKeywords {
     SELECT = "SELECT",
     FROM = "FROM",
@@ -57,6 +57,6 @@ export declare function buildOrderClause(order: Readonly<ReportOptions["order"]>
 export declare function buildRequestOptions(reportOptions: Readonly<ReportOptions>): RequestOptions;
 export declare function buildQuery(reportOptions: Readonly<ReportOptions>): {
     gaqlQuery: Query;
-    requestOptions: RequestOptions;
+    requestOptions: RequestOptionsWithTotalResults;
 };
 export {};

package/build/src/types.d.ts

@@ -27,6 +27,20 @@ export interface ReportOptions extends RequestOptions {
     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";
@@ -48,7 +62,7 @@ export type ConstraintType2 = {
 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.SearchGoogleAdsRequest["search_settings"], "return_total_results_count">;
+    search_settings?: Omit<services.ISearchSettings, "return_total_results_count">;
 };
 export type MutateOptions = Omit<services.IMutateGoogleAdsRequest, "customer_id" | "mutate_operations">;
 export type MutateOperation<T> = {
@@ -58,3 +72,4 @@ export type MutateOperation<T> = {
     exempt_policy_violation_keys?: services.AdGroupCriterionOperation["exempt_policy_violation_keys"];
 } & Partial<Omit<T, "toJSON">>;
 export type PageToken = services.ISearchGoogleAdsResponse["next_page_token"];
+export {};

package/package.json

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