google-ads-api 19.0.0 → 19.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +40 -0
- package/build/src/types.d.ts +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
### Upcoming Breaking Changes
|
|
4
|
+
|
|
5
|
+
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:
|
|
6
|
+
|
|
7
|
+
- Fields with the enum value `0` will now be `undefined` instead
|
|
8
|
+
- Array-fields (such as `final_urls`) with the value `[]` will now be `undefined` instead
|
|
9
|
+
|
|
10
|
+
While these changes are inconvenient, the performance of the REST api is significantly better than the gRPC api, particularly for responses with many rows.
|
|
11
|
+
|
|
12
|
+
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.
|
|
13
|
+
|
|
14
|
+
## 19.0.1
|
|
15
|
+
|
|
16
|
+
- Fix issue with type interface for search_settings not showing any valid fields.
|
|
17
|
+
|
|
18
|
+
## 19.0.0
|
|
19
|
+
|
|
20
|
+
### Version Upgrade
|
|
21
|
+
|
|
22
|
+
- 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.
|
|
23
|
+
|
|
24
|
+
### Library Changes
|
|
25
|
+
|
|
26
|
+
- 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:
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
export type RequestOptions = Omit<
|
|
30
|
+
services.ISearchGoogleAdsRequest,
|
|
31
|
+
"customer_id" | "query" | "search_settings"
|
|
32
|
+
> & {
|
|
33
|
+
search_settings?: Omit<
|
|
34
|
+
services.ISearchSettings,
|
|
35
|
+
"return_total_results_count"
|
|
36
|
+
>;
|
|
37
|
+
};
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
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/build/src/types.d.ts
CHANGED
|
@@ -48,7 +48,7 @@ export type ConstraintType2 = {
|
|
|
48
48
|
export type Constraint = string | ConstraintType1 | ConstraintType2;
|
|
49
49
|
export type Constraints = Constraint[] | ConstraintType2;
|
|
50
50
|
export type RequestOptions = Omit<services.ISearchGoogleAdsRequest, "customer_id" | "query" | "search_settings"> & {
|
|
51
|
-
search_settings?: Omit<services.
|
|
51
|
+
search_settings?: Omit<services.ISearchSettings, "return_total_results_count">;
|
|
52
52
|
};
|
|
53
53
|
export type MutateOptions = Omit<services.IMutateGoogleAdsRequest, "customer_id" | "mutate_operations">;
|
|
54
54
|
export type MutateOperation<T> = {
|