@getlatedev/node 0.2.1120 → 0.2.1122
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/README.md +1 -1
- package/dist/index.d.mts +95 -6
- package/dist/index.d.ts +95 -6
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +36 -5
- package/src/generated/types.gen.ts +95 -6
package/README.md
CHANGED
|
@@ -864,7 +864,7 @@ try {
|
|
|
864
864
|
| `conversions.getConversionMetrics()` | Get attribution metrics |
|
|
865
865
|
| `conversions.getConversionsQuality()` | Get Event Match Quality |
|
|
866
866
|
| `conversions.updateAdConversionGoals()` | Update account conversion goals |
|
|
867
|
-
| `conversions.updateConversionAction()` |
|
|
867
|
+
| `conversions.updateConversionAction()` | Update a conversion action's settings |
|
|
868
868
|
| `conversions.updateConversionDestination()` | Update a conversion destination |
|
|
869
869
|
| `conversions.updateCustomConversionGoal()` | Update a custom conversion goal |
|
|
870
870
|
| `conversions.deleteConversionDestination()` | Delete a conversion destination |
|
package/dist/index.d.mts
CHANGED
|
@@ -42260,7 +42260,33 @@ type GetAdReviewResponse = ({
|
|
|
42260
42260
|
} | null;
|
|
42261
42261
|
}>;
|
|
42262
42262
|
/**
|
|
42263
|
-
*
|
|
42263
|
+
* Google only. ad_group_ad.policy_summary.approval_status, verbatim.
|
|
42264
|
+
*/
|
|
42265
|
+
approvalStatus?: (string) | null;
|
|
42266
|
+
/**
|
|
42267
|
+
* Google only. ad_group_ad.policy_summary.policy_topic_entries.
|
|
42268
|
+
*/
|
|
42269
|
+
policyTopics?: Array<{
|
|
42270
|
+
topic?: (string) | null;
|
|
42271
|
+
/**
|
|
42272
|
+
* PROHIBITED, LIMITED, FULLY_LIMITED, DESCRIPTIVE, BROADENING, AREA_OF_INTEREST_ONLY.
|
|
42273
|
+
*/
|
|
42274
|
+
type?: (string) | null;
|
|
42275
|
+
/**
|
|
42276
|
+
* Google's PolicyTopicEvidence objects, verbatim.
|
|
42277
|
+
*/
|
|
42278
|
+
evidences?: Array<{
|
|
42279
|
+
[key: string]: unknown;
|
|
42280
|
+
}>;
|
|
42281
|
+
/**
|
|
42282
|
+
* Google's PolicyTopicConstraint objects, verbatim.
|
|
42283
|
+
*/
|
|
42284
|
+
constraints?: Array<{
|
|
42285
|
+
[key: string]: unknown;
|
|
42286
|
+
}>;
|
|
42287
|
+
}>;
|
|
42288
|
+
/**
|
|
42289
|
+
* When the verdict was read from the platform.
|
|
42264
42290
|
*/
|
|
42265
42291
|
readAt?: string;
|
|
42266
42292
|
};
|
|
@@ -43007,7 +43033,7 @@ type GetAdsActivityLogData = {
|
|
|
43007
43033
|
*/
|
|
43008
43034
|
accountId: string;
|
|
43009
43035
|
/**
|
|
43010
|
-
* Meta ad account id (act_<n>).
|
|
43036
|
+
* Meta ad account id (act_<n>), or the Google customer id (digits only).
|
|
43011
43037
|
*/
|
|
43012
43038
|
adAccountId: string;
|
|
43013
43039
|
/**
|
|
@@ -43019,11 +43045,11 @@ type GetAdsActivityLogData = {
|
|
|
43019
43045
|
*/
|
|
43020
43046
|
limit?: number;
|
|
43021
43047
|
/**
|
|
43022
|
-
* Client-side filter to one
|
|
43048
|
+
* Client-side filter to one object id (campaign, ad set / ad group or ad).
|
|
43023
43049
|
*/
|
|
43024
43050
|
objectId?: string;
|
|
43025
43051
|
/**
|
|
43026
|
-
* Start of range (YYYY-MM-DD).
|
|
43052
|
+
* Start of range (YYYY-MM-DD). Google: at most 29 days ago, the default.
|
|
43027
43053
|
*/
|
|
43028
43054
|
since?: string;
|
|
43029
43055
|
/**
|
|
@@ -49559,6 +49585,30 @@ type CreateConversionActionData = {
|
|
|
49559
49585
|
* When true, always use defaultValue and ignore any value sent with the event. Defaults to true when defaultValue is set.
|
|
49560
49586
|
*/
|
|
49561
49587
|
alwaysUseDefaultValue?: boolean;
|
|
49588
|
+
/**
|
|
49589
|
+
* conversion_action.category. Defaults to DEFAULT on create.
|
|
49590
|
+
*/
|
|
49591
|
+
category?: 'DEFAULT' | 'PAGE_VIEW' | 'PURCHASE' | 'SIGNUP' | 'DOWNLOAD' | 'ADD_TO_CART' | 'BEGIN_CHECKOUT' | 'SUBSCRIBE_PAID' | 'PHONE_CALL_LEAD' | 'IMPORTED_LEAD' | 'SUBMIT_LEAD_FORM' | 'BOOK_APPOINTMENT' | 'REQUEST_QUOTE' | 'GET_DIRECTIONS' | 'OUTBOUND_CLICK' | 'CONTACT' | 'ENGAGEMENT' | 'STORE_VISIT' | 'STORE_SALE' | 'QUALIFIED_LEAD' | 'CONVERTED_LEAD';
|
|
49592
|
+
/**
|
|
49593
|
+
* ONE_PER_CLICK counts one conversion per ad click (leads); MANY_PER_CLICK counts every one (purchases).
|
|
49594
|
+
*/
|
|
49595
|
+
countingType?: 'ONE_PER_CLICK' | 'MANY_PER_CLICK';
|
|
49596
|
+
/**
|
|
49597
|
+
* ISO 4217 currency of defaultValue (value_settings.default_currency_code).
|
|
49598
|
+
*/
|
|
49599
|
+
defaultCurrency?: string;
|
|
49600
|
+
/**
|
|
49601
|
+
* Days after an ad click a conversion still counts.
|
|
49602
|
+
*/
|
|
49603
|
+
clickThroughLookbackWindowDays?: number;
|
|
49604
|
+
/**
|
|
49605
|
+
* Days after an ad view a view-through conversion still counts.
|
|
49606
|
+
*/
|
|
49607
|
+
viewThroughLookbackWindowDays?: number;
|
|
49608
|
+
/**
|
|
49609
|
+
* true = primary (counts toward bidding when its goal is biddable), false = secondary.
|
|
49610
|
+
*/
|
|
49611
|
+
primaryForGoal?: boolean;
|
|
49562
49612
|
};
|
|
49563
49613
|
};
|
|
49564
49614
|
type CreateConversionActionResponse = ({
|
|
@@ -49627,10 +49677,37 @@ type UpdateConversionActionData = {
|
|
|
49627
49677
|
* @deprecated
|
|
49628
49678
|
*/
|
|
49629
49679
|
customerId?: string;
|
|
49680
|
+
name?: string;
|
|
49630
49681
|
/**
|
|
49631
|
-
*
|
|
49682
|
+
* REMOVED removes the action and must be sent alone; ENABLED restores a removed one.
|
|
49683
|
+
*/
|
|
49684
|
+
status?: 'ENABLED' | 'REMOVED';
|
|
49685
|
+
defaultValue?: number;
|
|
49686
|
+
alwaysUseDefaultValue?: boolean;
|
|
49687
|
+
/**
|
|
49688
|
+
* conversion_action.category. Defaults to DEFAULT on create.
|
|
49689
|
+
*/
|
|
49690
|
+
category?: 'DEFAULT' | 'PAGE_VIEW' | 'PURCHASE' | 'SIGNUP' | 'DOWNLOAD' | 'ADD_TO_CART' | 'BEGIN_CHECKOUT' | 'SUBSCRIBE_PAID' | 'PHONE_CALL_LEAD' | 'IMPORTED_LEAD' | 'SUBMIT_LEAD_FORM' | 'BOOK_APPOINTMENT' | 'REQUEST_QUOTE' | 'GET_DIRECTIONS' | 'OUTBOUND_CLICK' | 'CONTACT' | 'ENGAGEMENT' | 'STORE_VISIT' | 'STORE_SALE' | 'QUALIFIED_LEAD' | 'CONVERTED_LEAD';
|
|
49691
|
+
/**
|
|
49692
|
+
* ONE_PER_CLICK counts one conversion per ad click (leads); MANY_PER_CLICK counts every one (purchases).
|
|
49693
|
+
*/
|
|
49694
|
+
countingType?: 'ONE_PER_CLICK' | 'MANY_PER_CLICK';
|
|
49695
|
+
/**
|
|
49696
|
+
* ISO 4217 currency of defaultValue (value_settings.default_currency_code).
|
|
49697
|
+
*/
|
|
49698
|
+
defaultCurrency?: string;
|
|
49699
|
+
/**
|
|
49700
|
+
* Days after an ad click a conversion still counts.
|
|
49701
|
+
*/
|
|
49702
|
+
clickThroughLookbackWindowDays?: number;
|
|
49703
|
+
/**
|
|
49704
|
+
* Days after an ad view a view-through conversion still counts.
|
|
49632
49705
|
*/
|
|
49633
|
-
|
|
49706
|
+
viewThroughLookbackWindowDays?: number;
|
|
49707
|
+
/**
|
|
49708
|
+
* true = primary (counts toward bidding when its goal is biddable), false = secondary.
|
|
49709
|
+
*/
|
|
49710
|
+
primaryForGoal?: boolean;
|
|
49634
49711
|
};
|
|
49635
49712
|
path: {
|
|
49636
49713
|
/**
|
|
@@ -49641,9 +49718,21 @@ type UpdateConversionActionData = {
|
|
|
49641
49718
|
};
|
|
49642
49719
|
type UpdateConversionActionResponse = ({
|
|
49643
49720
|
customerId?: string;
|
|
49721
|
+
/**
|
|
49722
|
+
* The action id with the fields written, echoed back.
|
|
49723
|
+
*/
|
|
49644
49724
|
action?: {
|
|
49645
49725
|
id?: string;
|
|
49726
|
+
name?: string;
|
|
49727
|
+
status?: string;
|
|
49646
49728
|
primaryForGoal?: boolean;
|
|
49729
|
+
category?: string;
|
|
49730
|
+
countingType?: string;
|
|
49731
|
+
defaultValue?: number;
|
|
49732
|
+
defaultCurrency?: string;
|
|
49733
|
+
alwaysUseDefaultValue?: boolean;
|
|
49734
|
+
clickThroughLookbackWindowDays?: number;
|
|
49735
|
+
viewThroughLookbackWindowDays?: number;
|
|
49647
49736
|
};
|
|
49648
49737
|
});
|
|
49649
49738
|
type UpdateConversionActionError = (ErrorResponse | unknown);
|
package/dist/index.d.ts
CHANGED
|
@@ -42260,7 +42260,33 @@ type GetAdReviewResponse = ({
|
|
|
42260
42260
|
} | null;
|
|
42261
42261
|
}>;
|
|
42262
42262
|
/**
|
|
42263
|
-
*
|
|
42263
|
+
* Google only. ad_group_ad.policy_summary.approval_status, verbatim.
|
|
42264
|
+
*/
|
|
42265
|
+
approvalStatus?: (string) | null;
|
|
42266
|
+
/**
|
|
42267
|
+
* Google only. ad_group_ad.policy_summary.policy_topic_entries.
|
|
42268
|
+
*/
|
|
42269
|
+
policyTopics?: Array<{
|
|
42270
|
+
topic?: (string) | null;
|
|
42271
|
+
/**
|
|
42272
|
+
* PROHIBITED, LIMITED, FULLY_LIMITED, DESCRIPTIVE, BROADENING, AREA_OF_INTEREST_ONLY.
|
|
42273
|
+
*/
|
|
42274
|
+
type?: (string) | null;
|
|
42275
|
+
/**
|
|
42276
|
+
* Google's PolicyTopicEvidence objects, verbatim.
|
|
42277
|
+
*/
|
|
42278
|
+
evidences?: Array<{
|
|
42279
|
+
[key: string]: unknown;
|
|
42280
|
+
}>;
|
|
42281
|
+
/**
|
|
42282
|
+
* Google's PolicyTopicConstraint objects, verbatim.
|
|
42283
|
+
*/
|
|
42284
|
+
constraints?: Array<{
|
|
42285
|
+
[key: string]: unknown;
|
|
42286
|
+
}>;
|
|
42287
|
+
}>;
|
|
42288
|
+
/**
|
|
42289
|
+
* When the verdict was read from the platform.
|
|
42264
42290
|
*/
|
|
42265
42291
|
readAt?: string;
|
|
42266
42292
|
};
|
|
@@ -43007,7 +43033,7 @@ type GetAdsActivityLogData = {
|
|
|
43007
43033
|
*/
|
|
43008
43034
|
accountId: string;
|
|
43009
43035
|
/**
|
|
43010
|
-
* Meta ad account id (act_<n>).
|
|
43036
|
+
* Meta ad account id (act_<n>), or the Google customer id (digits only).
|
|
43011
43037
|
*/
|
|
43012
43038
|
adAccountId: string;
|
|
43013
43039
|
/**
|
|
@@ -43019,11 +43045,11 @@ type GetAdsActivityLogData = {
|
|
|
43019
43045
|
*/
|
|
43020
43046
|
limit?: number;
|
|
43021
43047
|
/**
|
|
43022
|
-
* Client-side filter to one
|
|
43048
|
+
* Client-side filter to one object id (campaign, ad set / ad group or ad).
|
|
43023
43049
|
*/
|
|
43024
43050
|
objectId?: string;
|
|
43025
43051
|
/**
|
|
43026
|
-
* Start of range (YYYY-MM-DD).
|
|
43052
|
+
* Start of range (YYYY-MM-DD). Google: at most 29 days ago, the default.
|
|
43027
43053
|
*/
|
|
43028
43054
|
since?: string;
|
|
43029
43055
|
/**
|
|
@@ -49559,6 +49585,30 @@ type CreateConversionActionData = {
|
|
|
49559
49585
|
* When true, always use defaultValue and ignore any value sent with the event. Defaults to true when defaultValue is set.
|
|
49560
49586
|
*/
|
|
49561
49587
|
alwaysUseDefaultValue?: boolean;
|
|
49588
|
+
/**
|
|
49589
|
+
* conversion_action.category. Defaults to DEFAULT on create.
|
|
49590
|
+
*/
|
|
49591
|
+
category?: 'DEFAULT' | 'PAGE_VIEW' | 'PURCHASE' | 'SIGNUP' | 'DOWNLOAD' | 'ADD_TO_CART' | 'BEGIN_CHECKOUT' | 'SUBSCRIBE_PAID' | 'PHONE_CALL_LEAD' | 'IMPORTED_LEAD' | 'SUBMIT_LEAD_FORM' | 'BOOK_APPOINTMENT' | 'REQUEST_QUOTE' | 'GET_DIRECTIONS' | 'OUTBOUND_CLICK' | 'CONTACT' | 'ENGAGEMENT' | 'STORE_VISIT' | 'STORE_SALE' | 'QUALIFIED_LEAD' | 'CONVERTED_LEAD';
|
|
49592
|
+
/**
|
|
49593
|
+
* ONE_PER_CLICK counts one conversion per ad click (leads); MANY_PER_CLICK counts every one (purchases).
|
|
49594
|
+
*/
|
|
49595
|
+
countingType?: 'ONE_PER_CLICK' | 'MANY_PER_CLICK';
|
|
49596
|
+
/**
|
|
49597
|
+
* ISO 4217 currency of defaultValue (value_settings.default_currency_code).
|
|
49598
|
+
*/
|
|
49599
|
+
defaultCurrency?: string;
|
|
49600
|
+
/**
|
|
49601
|
+
* Days after an ad click a conversion still counts.
|
|
49602
|
+
*/
|
|
49603
|
+
clickThroughLookbackWindowDays?: number;
|
|
49604
|
+
/**
|
|
49605
|
+
* Days after an ad view a view-through conversion still counts.
|
|
49606
|
+
*/
|
|
49607
|
+
viewThroughLookbackWindowDays?: number;
|
|
49608
|
+
/**
|
|
49609
|
+
* true = primary (counts toward bidding when its goal is biddable), false = secondary.
|
|
49610
|
+
*/
|
|
49611
|
+
primaryForGoal?: boolean;
|
|
49562
49612
|
};
|
|
49563
49613
|
};
|
|
49564
49614
|
type CreateConversionActionResponse = ({
|
|
@@ -49627,10 +49677,37 @@ type UpdateConversionActionData = {
|
|
|
49627
49677
|
* @deprecated
|
|
49628
49678
|
*/
|
|
49629
49679
|
customerId?: string;
|
|
49680
|
+
name?: string;
|
|
49630
49681
|
/**
|
|
49631
|
-
*
|
|
49682
|
+
* REMOVED removes the action and must be sent alone; ENABLED restores a removed one.
|
|
49683
|
+
*/
|
|
49684
|
+
status?: 'ENABLED' | 'REMOVED';
|
|
49685
|
+
defaultValue?: number;
|
|
49686
|
+
alwaysUseDefaultValue?: boolean;
|
|
49687
|
+
/**
|
|
49688
|
+
* conversion_action.category. Defaults to DEFAULT on create.
|
|
49689
|
+
*/
|
|
49690
|
+
category?: 'DEFAULT' | 'PAGE_VIEW' | 'PURCHASE' | 'SIGNUP' | 'DOWNLOAD' | 'ADD_TO_CART' | 'BEGIN_CHECKOUT' | 'SUBSCRIBE_PAID' | 'PHONE_CALL_LEAD' | 'IMPORTED_LEAD' | 'SUBMIT_LEAD_FORM' | 'BOOK_APPOINTMENT' | 'REQUEST_QUOTE' | 'GET_DIRECTIONS' | 'OUTBOUND_CLICK' | 'CONTACT' | 'ENGAGEMENT' | 'STORE_VISIT' | 'STORE_SALE' | 'QUALIFIED_LEAD' | 'CONVERTED_LEAD';
|
|
49691
|
+
/**
|
|
49692
|
+
* ONE_PER_CLICK counts one conversion per ad click (leads); MANY_PER_CLICK counts every one (purchases).
|
|
49693
|
+
*/
|
|
49694
|
+
countingType?: 'ONE_PER_CLICK' | 'MANY_PER_CLICK';
|
|
49695
|
+
/**
|
|
49696
|
+
* ISO 4217 currency of defaultValue (value_settings.default_currency_code).
|
|
49697
|
+
*/
|
|
49698
|
+
defaultCurrency?: string;
|
|
49699
|
+
/**
|
|
49700
|
+
* Days after an ad click a conversion still counts.
|
|
49701
|
+
*/
|
|
49702
|
+
clickThroughLookbackWindowDays?: number;
|
|
49703
|
+
/**
|
|
49704
|
+
* Days after an ad view a view-through conversion still counts.
|
|
49632
49705
|
*/
|
|
49633
|
-
|
|
49706
|
+
viewThroughLookbackWindowDays?: number;
|
|
49707
|
+
/**
|
|
49708
|
+
* true = primary (counts toward bidding when its goal is biddable), false = secondary.
|
|
49709
|
+
*/
|
|
49710
|
+
primaryForGoal?: boolean;
|
|
49634
49711
|
};
|
|
49635
49712
|
path: {
|
|
49636
49713
|
/**
|
|
@@ -49641,9 +49718,21 @@ type UpdateConversionActionData = {
|
|
|
49641
49718
|
};
|
|
49642
49719
|
type UpdateConversionActionResponse = ({
|
|
49643
49720
|
customerId?: string;
|
|
49721
|
+
/**
|
|
49722
|
+
* The action id with the fields written, echoed back.
|
|
49723
|
+
*/
|
|
49644
49724
|
action?: {
|
|
49645
49725
|
id?: string;
|
|
49726
|
+
name?: string;
|
|
49727
|
+
status?: string;
|
|
49646
49728
|
primaryForGoal?: boolean;
|
|
49729
|
+
category?: string;
|
|
49730
|
+
countingType?: string;
|
|
49731
|
+
defaultValue?: number;
|
|
49732
|
+
defaultCurrency?: string;
|
|
49733
|
+
alwaysUseDefaultValue?: boolean;
|
|
49734
|
+
clickThroughLookbackWindowDays?: number;
|
|
49735
|
+
viewThroughLookbackWindowDays?: number;
|
|
49647
49736
|
};
|
|
49648
49737
|
});
|
|
49649
49738
|
type UpdateConversionActionError = (ErrorResponse | unknown);
|
package/dist/index.js
CHANGED
|
@@ -36,7 +36,7 @@ module.exports = __toCommonJS(index_exports);
|
|
|
36
36
|
// package.json
|
|
37
37
|
var package_default = {
|
|
38
38
|
name: "@getlatedev/node",
|
|
39
|
-
version: "0.2.
|
|
39
|
+
version: "0.2.1122",
|
|
40
40
|
description: "The official Node.js library for the Zernio API",
|
|
41
41
|
main: "dist/index.js",
|
|
42
42
|
module: "dist/index.mjs",
|
package/dist/index.mjs
CHANGED
|
@@ -5,7 +5,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
|
|
|
5
5
|
// package.json
|
|
6
6
|
var package_default = {
|
|
7
7
|
name: "@getlatedev/node",
|
|
8
|
-
version: "0.2.
|
|
8
|
+
version: "0.2.1122",
|
|
9
9
|
description: "The official Node.js library for the Zernio API",
|
|
10
10
|
main: "dist/index.js",
|
|
11
11
|
module: "dist/index.mjs",
|
package/package.json
CHANGED
package/src/generated/sdk.gen.ts
CHANGED
|
@@ -10699,7 +10699,16 @@ export const getAdPreviews = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
10699
10699
|
* not deliver, and every rejection reason with TikTok's suggestion and the piece of content it
|
|
10700
10700
|
* refers to. Read-only, so it works on a paused ad without re-enabling it.
|
|
10701
10701
|
*
|
|
10702
|
-
*
|
|
10702
|
+
* **Google**: reads `ad_group_ad.policy_summary` live. `approvalStatus` and `reviewStatus` are
|
|
10703
|
+
* Google's verbatim (`approvalStatus`: APPROVED, APPROVED_LIMITED, AREA_OF_INTEREST_ONLY,
|
|
10704
|
+
* DISAPPROVED, UNKNOWN; `reviewStatus`: REVIEW_IN_PROGRESS, REVIEWED, UNDER_APPEAL,
|
|
10705
|
+
* ELIGIBLE_MAY_SERVE); `approved` is true for the three approved statuses, false for
|
|
10706
|
+
* DISAPPROVED, null otherwise. `policyTopics` carries every policy topic entry with its
|
|
10707
|
+
* `type` (PROHIBITED, LIMITED, ...) and Google's `evidences` and `constraints` verbatim; each
|
|
10708
|
+
* PROHIBITED topic is also listed in `rejections` (reason = the topic). The `forbidden*`
|
|
10709
|
+
* arrays are TikTok-only and always empty on Google.
|
|
10710
|
+
*
|
|
10711
|
+
* TikTok uses `/ad/review_info/`; every other platform returns 501. On TikTok, use it alongside the ad's
|
|
10703
10712
|
* `platformStatus`: TikTok reports `AD_STATUS_AUDIT` while the ad is in review and
|
|
10704
10713
|
* `AD_STATUS_AD_PRE_ONLINE` once it passed and is about to deliver (both map to
|
|
10705
10714
|
* `status: pending_review`); `AD_STATUS_AUDIT_DENY` maps to `rejected`.
|
|
@@ -11057,6 +11066,19 @@ export const listAdsBusinessCenters = <ThrowOnError extends boolean = false>(opt
|
|
|
11057
11066
|
|
|
11058
11067
|
/**
|
|
11059
11068
|
* Ad account change / audit log
|
|
11069
|
+
* **Google**: reads the customer's `change_event` history, newest first. Google keeps 30 days
|
|
11070
|
+
* of it, so `since` defaults to 29 days ago and an older `since` returns 400; `until`
|
|
11071
|
+
* defaults to today. Each change is mapped onto the Meta row shape: `event_type` =
|
|
11072
|
+
* resource_change_operation (CREATE, UPDATE, REMOVE), `event_time` = change_date_time,
|
|
11073
|
+
* `actor_name` = user_email, `object_type` = change_resource_type, `object_id` = the last numeric id
|
|
11074
|
+
* of `object_resource_name`, `application_name` = client_type, `changed_fields` (array), and
|
|
11075
|
+
* `extra_data` = a JSON string `{ old, new }` with Google's old and new resource.
|
|
11076
|
+
* Pass `paging.after` back as `after` for the next page; it is null when nothing older is
|
|
11077
|
+
* left. A page never splits a change batch (the changes of one request share an
|
|
11078
|
+
* `event_time`), so a page can hold fewer rows than `limit` while more follow, or more
|
|
11079
|
+
* when one batch is larger than `limit`. `adAccountId` is the numeric customer id.
|
|
11080
|
+
*
|
|
11081
|
+
* **Meta**:
|
|
11060
11082
|
* Account-level audit log from Meta's `/act_X/activities`: who changed what and when
|
|
11061
11083
|
* (creates, edits, status flips, budget changes...) with Meta's translated event names and
|
|
11062
11084
|
* the structured before/after in `extra_data`. Rows are returned verbatim. Meta has no
|
|
@@ -13247,10 +13269,19 @@ export const updateAdConversionGoals = <ThrowOnError extends boolean = false>(op
|
|
|
13247
13269
|
};
|
|
13248
13270
|
|
|
13249
13271
|
/**
|
|
13250
|
-
*
|
|
13251
|
-
*
|
|
13252
|
-
*
|
|
13253
|
-
*
|
|
13272
|
+
* Update a conversion action's settings
|
|
13273
|
+
* Updates a Google Ads conversion action in one mutate, each field sent written on its own
|
|
13274
|
+
* update mask leaf so omitted fields keep their value. Send at least one field.
|
|
13275
|
+
*
|
|
13276
|
+
* `primaryForGoal` sets `primary_for_goal`: a primary action counts toward its goal's
|
|
13277
|
+
* bidding and the Conversions column; a secondary one is observation-only (All
|
|
13278
|
+
* conversions). `countingType`, `category`, the value settings (`defaultValue`,
|
|
13279
|
+
* `defaultCurrency`, `alwaysUseDefaultValue`) and the click-through / view-through
|
|
13280
|
+
* lookback windows map to the same-named conversion_action fields.
|
|
13281
|
+
*
|
|
13282
|
+
* `status: REMOVED` removes the action (Google keeps it, with its history, as REMOVED) and
|
|
13283
|
+
* must be sent alone; `status: ENABLED` restores a removed action. Google refuses HIDDEN
|
|
13284
|
+
* on website actions, so it is not offered.
|
|
13254
13285
|
*/
|
|
13255
13286
|
export const updateConversionAction = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<UpdateConversionActionData, ThrowOnError>) => {
|
|
13256
13287
|
return (options?.client ?? client).patch<UpdateConversionActionResponse, UpdateConversionActionError, ThrowOnError>({
|
|
@@ -42791,7 +42791,33 @@ export type GetAdReviewResponse = ({
|
|
|
42791
42791
|
} | null;
|
|
42792
42792
|
}>;
|
|
42793
42793
|
/**
|
|
42794
|
-
*
|
|
42794
|
+
* Google only. ad_group_ad.policy_summary.approval_status, verbatim.
|
|
42795
|
+
*/
|
|
42796
|
+
approvalStatus?: (string) | null;
|
|
42797
|
+
/**
|
|
42798
|
+
* Google only. ad_group_ad.policy_summary.policy_topic_entries.
|
|
42799
|
+
*/
|
|
42800
|
+
policyTopics?: Array<{
|
|
42801
|
+
topic?: (string) | null;
|
|
42802
|
+
/**
|
|
42803
|
+
* PROHIBITED, LIMITED, FULLY_LIMITED, DESCRIPTIVE, BROADENING, AREA_OF_INTEREST_ONLY.
|
|
42804
|
+
*/
|
|
42805
|
+
type?: (string) | null;
|
|
42806
|
+
/**
|
|
42807
|
+
* Google's PolicyTopicEvidence objects, verbatim.
|
|
42808
|
+
*/
|
|
42809
|
+
evidences?: Array<{
|
|
42810
|
+
[key: string]: unknown;
|
|
42811
|
+
}>;
|
|
42812
|
+
/**
|
|
42813
|
+
* Google's PolicyTopicConstraint objects, verbatim.
|
|
42814
|
+
*/
|
|
42815
|
+
constraints?: Array<{
|
|
42816
|
+
[key: string]: unknown;
|
|
42817
|
+
}>;
|
|
42818
|
+
}>;
|
|
42819
|
+
/**
|
|
42820
|
+
* When the verdict was read from the platform.
|
|
42795
42821
|
*/
|
|
42796
42822
|
readAt?: string;
|
|
42797
42823
|
};
|
|
@@ -43582,7 +43608,7 @@ export type GetAdsActivityLogData = {
|
|
|
43582
43608
|
*/
|
|
43583
43609
|
accountId: string;
|
|
43584
43610
|
/**
|
|
43585
|
-
* Meta ad account id (act_<n>).
|
|
43611
|
+
* Meta ad account id (act_<n>), or the Google customer id (digits only).
|
|
43586
43612
|
*/
|
|
43587
43613
|
adAccountId: string;
|
|
43588
43614
|
/**
|
|
@@ -43594,11 +43620,11 @@ export type GetAdsActivityLogData = {
|
|
|
43594
43620
|
*/
|
|
43595
43621
|
limit?: number;
|
|
43596
43622
|
/**
|
|
43597
|
-
* Client-side filter to one
|
|
43623
|
+
* Client-side filter to one object id (campaign, ad set / ad group or ad).
|
|
43598
43624
|
*/
|
|
43599
43625
|
objectId?: string;
|
|
43600
43626
|
/**
|
|
43601
|
-
* Start of range (YYYY-MM-DD).
|
|
43627
|
+
* Start of range (YYYY-MM-DD). Google: at most 29 days ago, the default.
|
|
43602
43628
|
*/
|
|
43603
43629
|
since?: string;
|
|
43604
43630
|
/**
|
|
@@ -50515,6 +50541,30 @@ export type CreateConversionActionData = {
|
|
|
50515
50541
|
* When true, always use defaultValue and ignore any value sent with the event. Defaults to true when defaultValue is set.
|
|
50516
50542
|
*/
|
|
50517
50543
|
alwaysUseDefaultValue?: boolean;
|
|
50544
|
+
/**
|
|
50545
|
+
* conversion_action.category. Defaults to DEFAULT on create.
|
|
50546
|
+
*/
|
|
50547
|
+
category?: 'DEFAULT' | 'PAGE_VIEW' | 'PURCHASE' | 'SIGNUP' | 'DOWNLOAD' | 'ADD_TO_CART' | 'BEGIN_CHECKOUT' | 'SUBSCRIBE_PAID' | 'PHONE_CALL_LEAD' | 'IMPORTED_LEAD' | 'SUBMIT_LEAD_FORM' | 'BOOK_APPOINTMENT' | 'REQUEST_QUOTE' | 'GET_DIRECTIONS' | 'OUTBOUND_CLICK' | 'CONTACT' | 'ENGAGEMENT' | 'STORE_VISIT' | 'STORE_SALE' | 'QUALIFIED_LEAD' | 'CONVERTED_LEAD';
|
|
50548
|
+
/**
|
|
50549
|
+
* ONE_PER_CLICK counts one conversion per ad click (leads); MANY_PER_CLICK counts every one (purchases).
|
|
50550
|
+
*/
|
|
50551
|
+
countingType?: 'ONE_PER_CLICK' | 'MANY_PER_CLICK';
|
|
50552
|
+
/**
|
|
50553
|
+
* ISO 4217 currency of defaultValue (value_settings.default_currency_code).
|
|
50554
|
+
*/
|
|
50555
|
+
defaultCurrency?: string;
|
|
50556
|
+
/**
|
|
50557
|
+
* Days after an ad click a conversion still counts.
|
|
50558
|
+
*/
|
|
50559
|
+
clickThroughLookbackWindowDays?: number;
|
|
50560
|
+
/**
|
|
50561
|
+
* Days after an ad view a view-through conversion still counts.
|
|
50562
|
+
*/
|
|
50563
|
+
viewThroughLookbackWindowDays?: number;
|
|
50564
|
+
/**
|
|
50565
|
+
* true = primary (counts toward bidding when its goal is biddable), false = secondary.
|
|
50566
|
+
*/
|
|
50567
|
+
primaryForGoal?: boolean;
|
|
50518
50568
|
};
|
|
50519
50569
|
};
|
|
50520
50570
|
|
|
@@ -50592,10 +50642,37 @@ export type UpdateConversionActionData = {
|
|
|
50592
50642
|
* @deprecated
|
|
50593
50643
|
*/
|
|
50594
50644
|
customerId?: string;
|
|
50645
|
+
name?: string;
|
|
50595
50646
|
/**
|
|
50596
|
-
*
|
|
50647
|
+
* REMOVED removes the action and must be sent alone; ENABLED restores a removed one.
|
|
50648
|
+
*/
|
|
50649
|
+
status?: 'ENABLED' | 'REMOVED';
|
|
50650
|
+
defaultValue?: number;
|
|
50651
|
+
alwaysUseDefaultValue?: boolean;
|
|
50652
|
+
/**
|
|
50653
|
+
* conversion_action.category. Defaults to DEFAULT on create.
|
|
50654
|
+
*/
|
|
50655
|
+
category?: 'DEFAULT' | 'PAGE_VIEW' | 'PURCHASE' | 'SIGNUP' | 'DOWNLOAD' | 'ADD_TO_CART' | 'BEGIN_CHECKOUT' | 'SUBSCRIBE_PAID' | 'PHONE_CALL_LEAD' | 'IMPORTED_LEAD' | 'SUBMIT_LEAD_FORM' | 'BOOK_APPOINTMENT' | 'REQUEST_QUOTE' | 'GET_DIRECTIONS' | 'OUTBOUND_CLICK' | 'CONTACT' | 'ENGAGEMENT' | 'STORE_VISIT' | 'STORE_SALE' | 'QUALIFIED_LEAD' | 'CONVERTED_LEAD';
|
|
50656
|
+
/**
|
|
50657
|
+
* ONE_PER_CLICK counts one conversion per ad click (leads); MANY_PER_CLICK counts every one (purchases).
|
|
50658
|
+
*/
|
|
50659
|
+
countingType?: 'ONE_PER_CLICK' | 'MANY_PER_CLICK';
|
|
50660
|
+
/**
|
|
50661
|
+
* ISO 4217 currency of defaultValue (value_settings.default_currency_code).
|
|
50662
|
+
*/
|
|
50663
|
+
defaultCurrency?: string;
|
|
50664
|
+
/**
|
|
50665
|
+
* Days after an ad click a conversion still counts.
|
|
50666
|
+
*/
|
|
50667
|
+
clickThroughLookbackWindowDays?: number;
|
|
50668
|
+
/**
|
|
50669
|
+
* Days after an ad view a view-through conversion still counts.
|
|
50597
50670
|
*/
|
|
50598
|
-
|
|
50671
|
+
viewThroughLookbackWindowDays?: number;
|
|
50672
|
+
/**
|
|
50673
|
+
* true = primary (counts toward bidding when its goal is biddable), false = secondary.
|
|
50674
|
+
*/
|
|
50675
|
+
primaryForGoal?: boolean;
|
|
50599
50676
|
};
|
|
50600
50677
|
path: {
|
|
50601
50678
|
/**
|
|
@@ -50607,9 +50684,21 @@ export type UpdateConversionActionData = {
|
|
|
50607
50684
|
|
|
50608
50685
|
export type UpdateConversionActionResponse = ({
|
|
50609
50686
|
customerId?: string;
|
|
50687
|
+
/**
|
|
50688
|
+
* The action id with the fields written, echoed back.
|
|
50689
|
+
*/
|
|
50610
50690
|
action?: {
|
|
50611
50691
|
id?: string;
|
|
50692
|
+
name?: string;
|
|
50693
|
+
status?: string;
|
|
50612
50694
|
primaryForGoal?: boolean;
|
|
50695
|
+
category?: string;
|
|
50696
|
+
countingType?: string;
|
|
50697
|
+
defaultValue?: number;
|
|
50698
|
+
defaultCurrency?: string;
|
|
50699
|
+
alwaysUseDefaultValue?: boolean;
|
|
50700
|
+
clickThroughLookbackWindowDays?: number;
|
|
50701
|
+
viewThroughLookbackWindowDays?: number;
|
|
50613
50702
|
};
|
|
50614
50703
|
});
|
|
50615
50704
|
|