@sonordev/contracts 2.21.0 → 2.22.0
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 +10 -0
- package/README.md +18 -1
- package/dist/outreach.js +1 -45
- package/dist/outreach.mjs +1 -45
- package/dist/resonance.d.ts +483 -76
- package/dist/resonance.js +262 -10
- package/dist/resonance.mjs +250 -11
- package/package.json +1 -1
package/dist/resonance.d.ts
CHANGED
|
@@ -155,7 +155,9 @@ declare const audience: Field<{
|
|
|
155
155
|
retentionDays: number;
|
|
156
156
|
exclusionRuleIds: string[];
|
|
157
157
|
consentPurpose: "ad_personalization";
|
|
158
|
-
} & {
|
|
158
|
+
} & {
|
|
159
|
+
minDaysSinceVisit?: number | undefined;
|
|
160
|
+
}>;
|
|
159
161
|
declare const experiment: Field<{
|
|
160
162
|
projectId: string;
|
|
161
163
|
site: string;
|
|
@@ -456,7 +458,9 @@ declare const channel: Field<({
|
|
|
456
458
|
retentionDays: number;
|
|
457
459
|
exclusionRuleIds: string[];
|
|
458
460
|
consentPurpose: "ad_personalization";
|
|
459
|
-
} & {
|
|
461
|
+
} & {
|
|
462
|
+
minDaysSinceVisit?: number | undefined;
|
|
463
|
+
})[];
|
|
460
464
|
objective: "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC";
|
|
461
465
|
pageRef: {
|
|
462
466
|
connectionId: string;
|
|
@@ -507,6 +511,19 @@ declare const channel: Field<({
|
|
|
507
511
|
} & {}) | ({
|
|
508
512
|
mode: "provider_managed";
|
|
509
513
|
} & {}) | undefined;
|
|
514
|
+
channelGroup?: ({
|
|
515
|
+
key: string;
|
|
516
|
+
label: string;
|
|
517
|
+
} & {}) | undefined;
|
|
518
|
+
property?: ({
|
|
519
|
+
key: string;
|
|
520
|
+
label: string;
|
|
521
|
+
} & {}) | undefined;
|
|
522
|
+
tier?: ({
|
|
523
|
+
label: string;
|
|
524
|
+
} & {}) | undefined;
|
|
525
|
+
primaryText?: string | undefined;
|
|
526
|
+
convertersAcknowledged?: true | undefined;
|
|
510
527
|
}) | ({
|
|
511
528
|
projectId: string;
|
|
512
529
|
site: string;
|
|
@@ -690,7 +707,9 @@ declare const definition: Field<{
|
|
|
690
707
|
retentionDays: number;
|
|
691
708
|
exclusionRuleIds: string[];
|
|
692
709
|
consentPurpose: "ad_personalization";
|
|
693
|
-
} & {
|
|
710
|
+
} & {
|
|
711
|
+
minDaysSinceVisit?: number | undefined;
|
|
712
|
+
})[];
|
|
694
713
|
objective: "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC";
|
|
695
714
|
pageRef: {
|
|
696
715
|
connectionId: string;
|
|
@@ -741,6 +760,19 @@ declare const definition: Field<{
|
|
|
741
760
|
} & {}) | ({
|
|
742
761
|
mode: "provider_managed";
|
|
743
762
|
} & {}) | undefined;
|
|
763
|
+
channelGroup?: ({
|
|
764
|
+
key: string;
|
|
765
|
+
label: string;
|
|
766
|
+
} & {}) | undefined;
|
|
767
|
+
property?: ({
|
|
768
|
+
key: string;
|
|
769
|
+
label: string;
|
|
770
|
+
} & {}) | undefined;
|
|
771
|
+
tier?: ({
|
|
772
|
+
label: string;
|
|
773
|
+
} & {}) | undefined;
|
|
774
|
+
primaryText?: string | undefined;
|
|
775
|
+
convertersAcknowledged?: true | undefined;
|
|
744
776
|
}) | ({
|
|
745
777
|
projectId: string;
|
|
746
778
|
site: string;
|
|
@@ -1076,7 +1108,9 @@ declare const draft: Field<{
|
|
|
1076
1108
|
retentionDays: number;
|
|
1077
1109
|
exclusionRuleIds: string[];
|
|
1078
1110
|
consentPurpose: "ad_personalization";
|
|
1079
|
-
} & {
|
|
1111
|
+
} & {
|
|
1112
|
+
minDaysSinceVisit?: number | undefined;
|
|
1113
|
+
})[];
|
|
1080
1114
|
objective: "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC";
|
|
1081
1115
|
pageRef: {
|
|
1082
1116
|
connectionId: string;
|
|
@@ -1127,6 +1161,19 @@ declare const draft: Field<{
|
|
|
1127
1161
|
} & {}) | ({
|
|
1128
1162
|
mode: "provider_managed";
|
|
1129
1163
|
} & {}) | undefined;
|
|
1164
|
+
channelGroup?: ({
|
|
1165
|
+
key: string;
|
|
1166
|
+
label: string;
|
|
1167
|
+
} & {}) | undefined;
|
|
1168
|
+
property?: ({
|
|
1169
|
+
key: string;
|
|
1170
|
+
label: string;
|
|
1171
|
+
} & {}) | undefined;
|
|
1172
|
+
tier?: ({
|
|
1173
|
+
label: string;
|
|
1174
|
+
} & {}) | undefined;
|
|
1175
|
+
primaryText?: string | undefined;
|
|
1176
|
+
convertersAcknowledged?: true | undefined;
|
|
1130
1177
|
}) | ({
|
|
1131
1178
|
projectId: string;
|
|
1132
1179
|
site: string;
|
|
@@ -1452,7 +1499,9 @@ declare const mandateScope: Field<{
|
|
|
1452
1499
|
retentionDays: number;
|
|
1453
1500
|
exclusionRuleIds: string[];
|
|
1454
1501
|
consentPurpose: "ad_personalization";
|
|
1455
|
-
} & {
|
|
1502
|
+
} & {
|
|
1503
|
+
minDaysSinceVisit?: number | undefined;
|
|
1504
|
+
})[];
|
|
1456
1505
|
goal: {
|
|
1457
1506
|
source: {
|
|
1458
1507
|
projectId: string;
|
|
@@ -2357,7 +2406,9 @@ declare const prepared: Field<{
|
|
|
2357
2406
|
retentionDays: number;
|
|
2358
2407
|
exclusionRuleIds: string[];
|
|
2359
2408
|
consentPurpose: "ad_personalization";
|
|
2360
|
-
} & {
|
|
2409
|
+
} & {
|
|
2410
|
+
minDaysSinceVisit?: number | undefined;
|
|
2411
|
+
})[];
|
|
2361
2412
|
objective: "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC";
|
|
2362
2413
|
pageRef: {
|
|
2363
2414
|
connectionId: string;
|
|
@@ -2408,6 +2459,19 @@ declare const prepared: Field<{
|
|
|
2408
2459
|
} & {}) | ({
|
|
2409
2460
|
mode: "provider_managed";
|
|
2410
2461
|
} & {}) | undefined;
|
|
2462
|
+
channelGroup?: ({
|
|
2463
|
+
key: string;
|
|
2464
|
+
label: string;
|
|
2465
|
+
} & {}) | undefined;
|
|
2466
|
+
property?: ({
|
|
2467
|
+
key: string;
|
|
2468
|
+
label: string;
|
|
2469
|
+
} & {}) | undefined;
|
|
2470
|
+
tier?: ({
|
|
2471
|
+
label: string;
|
|
2472
|
+
} & {}) | undefined;
|
|
2473
|
+
primaryText?: string | undefined;
|
|
2474
|
+
convertersAcknowledged?: true | undefined;
|
|
2411
2475
|
}) | ({
|
|
2412
2476
|
projectId: string;
|
|
2413
2477
|
site: string;
|
|
@@ -2782,7 +2846,9 @@ declare const prepared: Field<{
|
|
|
2782
2846
|
retentionDays: number;
|
|
2783
2847
|
exclusionRuleIds: string[];
|
|
2784
2848
|
consentPurpose: "ad_personalization";
|
|
2785
|
-
} & {
|
|
2849
|
+
} & {
|
|
2850
|
+
minDaysSinceVisit?: number | undefined;
|
|
2851
|
+
})[];
|
|
2786
2852
|
allocation: ({
|
|
2787
2853
|
currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRU" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLE" | "SLL" | "SOS" | "SRD" | "SSP" | "STN" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VES" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XCG" | "XDR" | "XOF" | "XPF" | "XSU" | "YER" | "ZAR" | "ZMW" | "ZWG" | "ZWL";
|
|
2788
2854
|
amountMicros: string;
|
|
@@ -3210,7 +3276,9 @@ declare const view: Field<{
|
|
|
3210
3276
|
retentionDays: number;
|
|
3211
3277
|
exclusionRuleIds: string[];
|
|
3212
3278
|
consentPurpose: "ad_personalization";
|
|
3213
|
-
} & {
|
|
3279
|
+
} & {
|
|
3280
|
+
minDaysSinceVisit?: number | undefined;
|
|
3281
|
+
})[];
|
|
3214
3282
|
objective: "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC";
|
|
3215
3283
|
pageRef: {
|
|
3216
3284
|
connectionId: string;
|
|
@@ -3261,6 +3329,19 @@ declare const view: Field<{
|
|
|
3261
3329
|
} & {}) | ({
|
|
3262
3330
|
mode: "provider_managed";
|
|
3263
3331
|
} & {}) | undefined;
|
|
3332
|
+
channelGroup?: ({
|
|
3333
|
+
key: string;
|
|
3334
|
+
label: string;
|
|
3335
|
+
} & {}) | undefined;
|
|
3336
|
+
property?: ({
|
|
3337
|
+
key: string;
|
|
3338
|
+
label: string;
|
|
3339
|
+
} & {}) | undefined;
|
|
3340
|
+
tier?: ({
|
|
3341
|
+
label: string;
|
|
3342
|
+
} & {}) | undefined;
|
|
3343
|
+
primaryText?: string | undefined;
|
|
3344
|
+
convertersAcknowledged?: true | undefined;
|
|
3264
3345
|
}) | ({
|
|
3265
3346
|
projectId: string;
|
|
3266
3347
|
site: string;
|
|
@@ -3485,11 +3566,11 @@ declare const metric: Field<({
|
|
|
3485
3566
|
projectId: string;
|
|
3486
3567
|
site: string;
|
|
3487
3568
|
campaignId: string;
|
|
3488
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
3569
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
3489
3570
|
source: "experiment" | "first_party" | "provider";
|
|
3490
3571
|
sourceRef: string;
|
|
3491
3572
|
goalRevision: string | null;
|
|
3492
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
3573
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
3493
3574
|
windowStart: string;
|
|
3494
3575
|
windowEnd: string;
|
|
3495
3576
|
timeZone: string;
|
|
@@ -3526,11 +3607,11 @@ declare const metric: Field<({
|
|
|
3526
3607
|
projectId: string;
|
|
3527
3608
|
site: string;
|
|
3528
3609
|
campaignId: string;
|
|
3529
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
3610
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
3530
3611
|
source: "experiment" | "first_party" | "provider";
|
|
3531
3612
|
sourceRef: string;
|
|
3532
3613
|
goalRevision: string | null;
|
|
3533
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
3614
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
3534
3615
|
windowStart: string;
|
|
3535
3616
|
windowEnd: string;
|
|
3536
3617
|
timeZone: string;
|
|
@@ -3718,7 +3799,9 @@ declare const mandateApproval: Field<{
|
|
|
3718
3799
|
retentionDays: number;
|
|
3719
3800
|
exclusionRuleIds: string[];
|
|
3720
3801
|
consentPurpose: "ad_personalization";
|
|
3721
|
-
} & {
|
|
3802
|
+
} & {
|
|
3803
|
+
minDaysSinceVisit?: number | undefined;
|
|
3804
|
+
})[];
|
|
3722
3805
|
goal: {
|
|
3723
3806
|
source: {
|
|
3724
3807
|
projectId: string;
|
|
@@ -4089,7 +4172,9 @@ declare const saveCommand: Field<{
|
|
|
4089
4172
|
retentionDays: number;
|
|
4090
4173
|
exclusionRuleIds: string[];
|
|
4091
4174
|
consentPurpose: "ad_personalization";
|
|
4092
|
-
} & {
|
|
4175
|
+
} & {
|
|
4176
|
+
minDaysSinceVisit?: number | undefined;
|
|
4177
|
+
})[];
|
|
4093
4178
|
objective: "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC";
|
|
4094
4179
|
pageRef: {
|
|
4095
4180
|
connectionId: string;
|
|
@@ -4140,6 +4225,19 @@ declare const saveCommand: Field<{
|
|
|
4140
4225
|
} & {}) | ({
|
|
4141
4226
|
mode: "provider_managed";
|
|
4142
4227
|
} & {}) | undefined;
|
|
4228
|
+
channelGroup?: ({
|
|
4229
|
+
key: string;
|
|
4230
|
+
label: string;
|
|
4231
|
+
} & {}) | undefined;
|
|
4232
|
+
property?: ({
|
|
4233
|
+
key: string;
|
|
4234
|
+
label: string;
|
|
4235
|
+
} & {}) | undefined;
|
|
4236
|
+
tier?: ({
|
|
4237
|
+
label: string;
|
|
4238
|
+
} & {}) | undefined;
|
|
4239
|
+
primaryText?: string | undefined;
|
|
4240
|
+
convertersAcknowledged?: true | undefined;
|
|
4143
4241
|
}) | ({
|
|
4144
4242
|
projectId: string;
|
|
4145
4243
|
site: string;
|
|
@@ -4525,11 +4623,11 @@ declare const reportedOptimizationEvidence: Field<{
|
|
|
4525
4623
|
projectId: string;
|
|
4526
4624
|
site: string;
|
|
4527
4625
|
campaignId: string;
|
|
4528
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
4626
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
4529
4627
|
source: "experiment" | "first_party" | "provider";
|
|
4530
4628
|
sourceRef: string;
|
|
4531
4629
|
goalRevision: string | null;
|
|
4532
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
4630
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
4533
4631
|
windowStart: string;
|
|
4534
4632
|
windowEnd: string;
|
|
4535
4633
|
timeZone: string;
|
|
@@ -4566,11 +4664,11 @@ declare const reportedOptimizationEvidence: Field<{
|
|
|
4566
4664
|
projectId: string;
|
|
4567
4665
|
site: string;
|
|
4568
4666
|
campaignId: string;
|
|
4569
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
4667
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
4570
4668
|
source: "experiment" | "first_party" | "provider";
|
|
4571
4669
|
sourceRef: string;
|
|
4572
4670
|
goalRevision: string | null;
|
|
4573
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
4671
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
4574
4672
|
windowStart: string;
|
|
4575
4673
|
windowEnd: string;
|
|
4576
4674
|
timeZone: string;
|
|
@@ -4795,11 +4893,11 @@ declare const finiteOptimizationEvidence: Field<{
|
|
|
4795
4893
|
projectId: string;
|
|
4796
4894
|
site: string;
|
|
4797
4895
|
campaignId: string;
|
|
4798
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
4896
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
4799
4897
|
source: "experiment" | "first_party" | "provider";
|
|
4800
4898
|
sourceRef: string;
|
|
4801
4899
|
goalRevision: string | null;
|
|
4802
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
4900
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
4803
4901
|
windowStart: string;
|
|
4804
4902
|
windowEnd: string;
|
|
4805
4903
|
timeZone: string;
|
|
@@ -4836,11 +4934,11 @@ declare const finiteOptimizationEvidence: Field<{
|
|
|
4836
4934
|
projectId: string;
|
|
4837
4935
|
site: string;
|
|
4838
4936
|
campaignId: string;
|
|
4839
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
4937
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
4840
4938
|
source: "experiment" | "first_party" | "provider";
|
|
4841
4939
|
sourceRef: string;
|
|
4842
4940
|
goalRevision: string | null;
|
|
4843
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
4941
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
4844
4942
|
windowStart: string;
|
|
4845
4943
|
windowEnd: string;
|
|
4846
4944
|
timeZone: string;
|
|
@@ -4869,11 +4967,11 @@ declare const finiteOptimizationEvidence: Field<{
|
|
|
4869
4967
|
projectId: string;
|
|
4870
4968
|
site: string;
|
|
4871
4969
|
campaignId: string;
|
|
4872
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
4970
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
4873
4971
|
source: "experiment" | "first_party" | "provider";
|
|
4874
4972
|
sourceRef: string;
|
|
4875
4973
|
goalRevision: string | null;
|
|
4876
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
4974
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
4877
4975
|
windowStart: string;
|
|
4878
4976
|
windowEnd: string;
|
|
4879
4977
|
timeZone: string;
|
|
@@ -4910,11 +5008,11 @@ declare const finiteOptimizationEvidence: Field<{
|
|
|
4910
5008
|
projectId: string;
|
|
4911
5009
|
site: string;
|
|
4912
5010
|
campaignId: string;
|
|
4913
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
5011
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
4914
5012
|
source: "experiment" | "first_party" | "provider";
|
|
4915
5013
|
sourceRef: string;
|
|
4916
5014
|
goalRevision: string | null;
|
|
4917
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
5015
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
4918
5016
|
windowStart: string;
|
|
4919
5017
|
windowEnd: string;
|
|
4920
5018
|
timeZone: string;
|
|
@@ -5067,11 +5165,11 @@ declare const optimizationEvidence: Field<({
|
|
|
5067
5165
|
projectId: string;
|
|
5068
5166
|
site: string;
|
|
5069
5167
|
campaignId: string;
|
|
5070
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
5168
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
5071
5169
|
source: "experiment" | "first_party" | "provider";
|
|
5072
5170
|
sourceRef: string;
|
|
5073
5171
|
goalRevision: string | null;
|
|
5074
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
5172
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
5075
5173
|
windowStart: string;
|
|
5076
5174
|
windowEnd: string;
|
|
5077
5175
|
timeZone: string;
|
|
@@ -5108,11 +5206,11 @@ declare const optimizationEvidence: Field<({
|
|
|
5108
5206
|
projectId: string;
|
|
5109
5207
|
site: string;
|
|
5110
5208
|
campaignId: string;
|
|
5111
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
5209
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
5112
5210
|
source: "experiment" | "first_party" | "provider";
|
|
5113
5211
|
sourceRef: string;
|
|
5114
5212
|
goalRevision: string | null;
|
|
5115
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
5213
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
5116
5214
|
windowStart: string;
|
|
5117
5215
|
windowEnd: string;
|
|
5118
5216
|
timeZone: string;
|
|
@@ -5288,11 +5386,11 @@ declare const optimizationEvidence: Field<({
|
|
|
5288
5386
|
projectId: string;
|
|
5289
5387
|
site: string;
|
|
5290
5388
|
campaignId: string;
|
|
5291
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
5389
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
5292
5390
|
source: "experiment" | "first_party" | "provider";
|
|
5293
5391
|
sourceRef: string;
|
|
5294
5392
|
goalRevision: string | null;
|
|
5295
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
5393
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
5296
5394
|
windowStart: string;
|
|
5297
5395
|
windowEnd: string;
|
|
5298
5396
|
timeZone: string;
|
|
@@ -5329,11 +5427,11 @@ declare const optimizationEvidence: Field<({
|
|
|
5329
5427
|
projectId: string;
|
|
5330
5428
|
site: string;
|
|
5331
5429
|
campaignId: string;
|
|
5332
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
5430
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
5333
5431
|
source: "experiment" | "first_party" | "provider";
|
|
5334
5432
|
sourceRef: string;
|
|
5335
5433
|
goalRevision: string | null;
|
|
5336
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
5434
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
5337
5435
|
windowStart: string;
|
|
5338
5436
|
windowEnd: string;
|
|
5339
5437
|
timeZone: string;
|
|
@@ -5551,11 +5649,11 @@ declare const optimizationEvidence: Field<({
|
|
|
5551
5649
|
projectId: string;
|
|
5552
5650
|
site: string;
|
|
5553
5651
|
campaignId: string;
|
|
5554
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
5652
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
5555
5653
|
source: "experiment" | "first_party" | "provider";
|
|
5556
5654
|
sourceRef: string;
|
|
5557
5655
|
goalRevision: string | null;
|
|
5558
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
5656
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
5559
5657
|
windowStart: string;
|
|
5560
5658
|
windowEnd: string;
|
|
5561
5659
|
timeZone: string;
|
|
@@ -5592,11 +5690,11 @@ declare const optimizationEvidence: Field<({
|
|
|
5592
5690
|
projectId: string;
|
|
5593
5691
|
site: string;
|
|
5594
5692
|
campaignId: string;
|
|
5595
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
5693
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
5596
5694
|
source: "experiment" | "first_party" | "provider";
|
|
5597
5695
|
sourceRef: string;
|
|
5598
5696
|
goalRevision: string | null;
|
|
5599
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
5697
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
5600
5698
|
windowStart: string;
|
|
5601
5699
|
windowEnd: string;
|
|
5602
5700
|
timeZone: string;
|
|
@@ -5625,11 +5723,11 @@ declare const optimizationEvidence: Field<({
|
|
|
5625
5723
|
projectId: string;
|
|
5626
5724
|
site: string;
|
|
5627
5725
|
campaignId: string;
|
|
5628
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
5726
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
5629
5727
|
source: "experiment" | "first_party" | "provider";
|
|
5630
5728
|
sourceRef: string;
|
|
5631
5729
|
goalRevision: string | null;
|
|
5632
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
5730
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
5633
5731
|
windowStart: string;
|
|
5634
5732
|
windowEnd: string;
|
|
5635
5733
|
timeZone: string;
|
|
@@ -5666,11 +5764,11 @@ declare const optimizationEvidence: Field<({
|
|
|
5666
5764
|
projectId: string;
|
|
5667
5765
|
site: string;
|
|
5668
5766
|
campaignId: string;
|
|
5669
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
5767
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
5670
5768
|
source: "experiment" | "first_party" | "provider";
|
|
5671
5769
|
sourceRef: string;
|
|
5672
5770
|
goalRevision: string | null;
|
|
5673
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
5771
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
5674
5772
|
windowStart: string;
|
|
5675
5773
|
windowEnd: string;
|
|
5676
5774
|
timeZone: string;
|
|
@@ -5945,6 +6043,17 @@ export type ResonanceOptimizationDecision = Value<typeof optimizationDecision>;
|
|
|
5945
6043
|
export declare function parseResonanceOptimizationDecision(v: unknown, evidence?: unknown, preparedPlan?: unknown): ResonanceOptimizationDecision;
|
|
5946
6044
|
export declare const RESONANCE_OPTIMIZATION_EVIDENCE_JSON_SCHEMA: import("./wire-schema").JsonSchema;
|
|
5947
6045
|
export declare const RESONANCE_OPTIMIZATION_DECISION_JSON_SCHEMA: import("./wire-schema").JsonSchema;
|
|
6046
|
+
/**
|
|
6047
|
+
* Capability witness for the browser Meta loader. The API issues it only after its dataset assertions pass; the
|
|
6048
|
+
* browser reads it, never decides it. It names the loader controls revision and the policy revision it was issued under.
|
|
6049
|
+
*/
|
|
6050
|
+
declare const metaBrowserWitness: Field<{
|
|
6051
|
+
controlsRevision: string;
|
|
6052
|
+
policyRevision: string;
|
|
6053
|
+
witnessId: string;
|
|
6054
|
+
assertedAt: string;
|
|
6055
|
+
} & {}>;
|
|
6056
|
+
export type ResonanceMetaBrowserWitness = Value<typeof metaBrowserWitness>;
|
|
5948
6057
|
declare const measurementConfig: Field<{
|
|
5949
6058
|
projectId: string;
|
|
5950
6059
|
site: string;
|
|
@@ -5965,7 +6074,15 @@ declare const measurementConfig: Field<{
|
|
|
5965
6074
|
provider: "meta_ads";
|
|
5966
6075
|
id: string;
|
|
5967
6076
|
pixelId: string;
|
|
5968
|
-
} & {
|
|
6077
|
+
} & {
|
|
6078
|
+
browserWitness?: ({
|
|
6079
|
+
controlsRevision: string;
|
|
6080
|
+
policyRevision: string;
|
|
6081
|
+
witnessId: string;
|
|
6082
|
+
assertedAt: string;
|
|
6083
|
+
} & {}) | undefined;
|
|
6084
|
+
tagManagerAttested?: boolean | undefined;
|
|
6085
|
+
}))[];
|
|
5969
6086
|
resourceRules: ({
|
|
5970
6087
|
id: string;
|
|
5971
6088
|
revision: string;
|
|
@@ -5979,7 +6096,9 @@ declare const measurementConfig: Field<{
|
|
|
5979
6096
|
} & {};
|
|
5980
6097
|
path: string;
|
|
5981
6098
|
interestKey: string;
|
|
5982
|
-
} & {
|
|
6099
|
+
} & {
|
|
6100
|
+
metaEligible?: boolean | undefined;
|
|
6101
|
+
})[];
|
|
5983
6102
|
} & {}>;
|
|
5984
6103
|
export type ResonanceMeasurementConfig = Value<typeof measurementConfig>;
|
|
5985
6104
|
export declare function parseResonanceMeasurementConfig(v: unknown): ResonanceMeasurementConfig;
|
|
@@ -6129,7 +6248,9 @@ declare const audienceDraft: Field<{
|
|
|
6129
6248
|
retentionDays: number;
|
|
6130
6249
|
policyRevision: string;
|
|
6131
6250
|
currentConsentPolicyRevision: string;
|
|
6132
|
-
} & {
|
|
6251
|
+
} & {
|
|
6252
|
+
minDaysSinceVisit?: number | undefined;
|
|
6253
|
+
};
|
|
6133
6254
|
} & {
|
|
6134
6255
|
expectedRevision?: number | undefined;
|
|
6135
6256
|
}>;
|
|
@@ -6262,7 +6383,15 @@ declare const measurementCurrent: Field<({
|
|
|
6262
6383
|
provider: "meta_ads";
|
|
6263
6384
|
id: string;
|
|
6264
6385
|
pixelId: string;
|
|
6265
|
-
} & {
|
|
6386
|
+
} & {
|
|
6387
|
+
browserWitness?: ({
|
|
6388
|
+
controlsRevision: string;
|
|
6389
|
+
policyRevision: string;
|
|
6390
|
+
witnessId: string;
|
|
6391
|
+
assertedAt: string;
|
|
6392
|
+
} & {}) | undefined;
|
|
6393
|
+
tagManagerAttested?: boolean | undefined;
|
|
6394
|
+
}))[];
|
|
6266
6395
|
resourceRules: ({
|
|
6267
6396
|
id: string;
|
|
6268
6397
|
revision: string;
|
|
@@ -6276,7 +6405,9 @@ declare const measurementCurrent: Field<({
|
|
|
6276
6405
|
} & {};
|
|
6277
6406
|
path: string;
|
|
6278
6407
|
interestKey: string;
|
|
6279
|
-
} & {
|
|
6408
|
+
} & {
|
|
6409
|
+
metaEligible?: boolean | undefined;
|
|
6410
|
+
})[];
|
|
6280
6411
|
} & {};
|
|
6281
6412
|
saveOperationId: string;
|
|
6282
6413
|
pages: ({
|
|
@@ -6320,7 +6451,15 @@ declare const measurementSnapshot: Field<{
|
|
|
6320
6451
|
provider: "meta_ads";
|
|
6321
6452
|
id: string;
|
|
6322
6453
|
pixelId: string;
|
|
6323
|
-
} & {
|
|
6454
|
+
} & {
|
|
6455
|
+
browserWitness?: ({
|
|
6456
|
+
controlsRevision: string;
|
|
6457
|
+
policyRevision: string;
|
|
6458
|
+
witnessId: string;
|
|
6459
|
+
assertedAt: string;
|
|
6460
|
+
} & {}) | undefined;
|
|
6461
|
+
tagManagerAttested?: boolean | undefined;
|
|
6462
|
+
}))[];
|
|
6324
6463
|
resourceRules: ({
|
|
6325
6464
|
id: string;
|
|
6326
6465
|
revision: string;
|
|
@@ -6334,7 +6473,9 @@ declare const measurementSnapshot: Field<{
|
|
|
6334
6473
|
} & {};
|
|
6335
6474
|
path: string;
|
|
6336
6475
|
interestKey: string;
|
|
6337
|
-
} & {
|
|
6476
|
+
} & {
|
|
6477
|
+
metaEligible?: boolean | undefined;
|
|
6478
|
+
})[];
|
|
6338
6479
|
} & {};
|
|
6339
6480
|
pages: ({
|
|
6340
6481
|
pageId: string;
|
|
@@ -6374,7 +6515,15 @@ declare const measurementSaveResponse: Field<{
|
|
|
6374
6515
|
provider: "meta_ads";
|
|
6375
6516
|
id: string;
|
|
6376
6517
|
pixelId: string;
|
|
6377
|
-
} & {
|
|
6518
|
+
} & {
|
|
6519
|
+
browserWitness?: ({
|
|
6520
|
+
controlsRevision: string;
|
|
6521
|
+
policyRevision: string;
|
|
6522
|
+
witnessId: string;
|
|
6523
|
+
assertedAt: string;
|
|
6524
|
+
} & {}) | undefined;
|
|
6525
|
+
tagManagerAttested?: boolean | undefined;
|
|
6526
|
+
}))[];
|
|
6378
6527
|
resourceRules: ({
|
|
6379
6528
|
id: string;
|
|
6380
6529
|
revision: string;
|
|
@@ -6388,7 +6537,9 @@ declare const measurementSaveResponse: Field<{
|
|
|
6388
6537
|
} & {};
|
|
6389
6538
|
path: string;
|
|
6390
6539
|
interestKey: string;
|
|
6391
|
-
} & {
|
|
6540
|
+
} & {
|
|
6541
|
+
metaEligible?: boolean | undefined;
|
|
6542
|
+
})[];
|
|
6392
6543
|
} & {};
|
|
6393
6544
|
pages: ({
|
|
6394
6545
|
pageId: string;
|
|
@@ -6440,7 +6591,15 @@ declare const measurementProjectionContext: Field<{
|
|
|
6440
6591
|
provider: "meta_ads";
|
|
6441
6592
|
id: string;
|
|
6442
6593
|
pixelId: string;
|
|
6443
|
-
} & {
|
|
6594
|
+
} & {
|
|
6595
|
+
browserWitness?: ({
|
|
6596
|
+
controlsRevision: string;
|
|
6597
|
+
policyRevision: string;
|
|
6598
|
+
witnessId: string;
|
|
6599
|
+
assertedAt: string;
|
|
6600
|
+
} & {}) | undefined;
|
|
6601
|
+
tagManagerAttested?: boolean | undefined;
|
|
6602
|
+
}))[];
|
|
6444
6603
|
resourceRules: ({
|
|
6445
6604
|
id: string;
|
|
6446
6605
|
revision: string;
|
|
@@ -6454,7 +6613,9 @@ declare const measurementProjectionContext: Field<{
|
|
|
6454
6613
|
} & {};
|
|
6455
6614
|
path: string;
|
|
6456
6615
|
interestKey: string;
|
|
6457
|
-
} & {
|
|
6616
|
+
} & {
|
|
6617
|
+
metaEligible?: boolean | undefined;
|
|
6618
|
+
})[];
|
|
6458
6619
|
} & {};
|
|
6459
6620
|
saveOperationId: string;
|
|
6460
6621
|
pages: ({
|
|
@@ -6502,7 +6663,15 @@ export declare function projectResonanceMeasurementConfiguration(value: Resonanc
|
|
|
6502
6663
|
provider: "meta_ads";
|
|
6503
6664
|
id: string;
|
|
6504
6665
|
pixelId: string;
|
|
6505
|
-
} & {
|
|
6666
|
+
} & {
|
|
6667
|
+
browserWitness?: ({
|
|
6668
|
+
controlsRevision: string;
|
|
6669
|
+
policyRevision: string;
|
|
6670
|
+
witnessId: string;
|
|
6671
|
+
assertedAt: string;
|
|
6672
|
+
} & {}) | undefined;
|
|
6673
|
+
tagManagerAttested?: boolean | undefined;
|
|
6674
|
+
}))[];
|
|
6506
6675
|
resourceRules: ({
|
|
6507
6676
|
id: string;
|
|
6508
6677
|
revision: string;
|
|
@@ -6516,7 +6685,9 @@ export declare function projectResonanceMeasurementConfiguration(value: Resonanc
|
|
|
6516
6685
|
} & {};
|
|
6517
6686
|
path: string;
|
|
6518
6687
|
interestKey: string;
|
|
6519
|
-
} & {
|
|
6688
|
+
} & {
|
|
6689
|
+
metaEligible?: boolean | undefined;
|
|
6690
|
+
})[];
|
|
6520
6691
|
} & {};
|
|
6521
6692
|
pages: {
|
|
6522
6693
|
pageId: string;
|
|
@@ -6588,7 +6759,9 @@ declare const metaSnapshot: Field<{
|
|
|
6588
6759
|
retentionDays: number;
|
|
6589
6760
|
exclusionRuleIds: string[];
|
|
6590
6761
|
consentPurpose: "ad_personalization";
|
|
6591
|
-
} & {
|
|
6762
|
+
} & {
|
|
6763
|
+
minDaysSinceVisit?: number | undefined;
|
|
6764
|
+
})[];
|
|
6592
6765
|
objective: "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC";
|
|
6593
6766
|
pageRef: {
|
|
6594
6767
|
connectionId: string;
|
|
@@ -6639,6 +6812,19 @@ declare const metaSnapshot: Field<{
|
|
|
6639
6812
|
} & {}) | ({
|
|
6640
6813
|
mode: "provider_managed";
|
|
6641
6814
|
} & {}) | undefined;
|
|
6815
|
+
channelGroup?: ({
|
|
6816
|
+
key: string;
|
|
6817
|
+
label: string;
|
|
6818
|
+
} & {}) | undefined;
|
|
6819
|
+
property?: ({
|
|
6820
|
+
key: string;
|
|
6821
|
+
label: string;
|
|
6822
|
+
} & {}) | undefined;
|
|
6823
|
+
tier?: ({
|
|
6824
|
+
label: string;
|
|
6825
|
+
} & {}) | undefined;
|
|
6826
|
+
primaryText?: string | undefined;
|
|
6827
|
+
convertersAcknowledged?: true | undefined;
|
|
6642
6828
|
};
|
|
6643
6829
|
account: {
|
|
6644
6830
|
id: string;
|
|
@@ -6681,7 +6867,9 @@ declare const metaSnapshot: Field<{
|
|
|
6681
6867
|
retentionDays: number;
|
|
6682
6868
|
exclusionRuleIds: string[];
|
|
6683
6869
|
consentPurpose: "ad_personalization";
|
|
6684
|
-
} & {
|
|
6870
|
+
} & {
|
|
6871
|
+
minDaysSinceVisit?: number | undefined;
|
|
6872
|
+
};
|
|
6685
6873
|
name: string;
|
|
6686
6874
|
resourceRuleRef: {
|
|
6687
6875
|
id: string;
|
|
@@ -6771,7 +6959,9 @@ declare const metaView: Field<({
|
|
|
6771
6959
|
retentionDays: number;
|
|
6772
6960
|
exclusionRuleIds: string[];
|
|
6773
6961
|
consentPurpose: "ad_personalization";
|
|
6774
|
-
} & {
|
|
6962
|
+
} & {
|
|
6963
|
+
minDaysSinceVisit?: number | undefined;
|
|
6964
|
+
})[];
|
|
6775
6965
|
objective: "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC";
|
|
6776
6966
|
pageRef: {
|
|
6777
6967
|
connectionId: string;
|
|
@@ -6822,6 +7012,19 @@ declare const metaView: Field<({
|
|
|
6822
7012
|
} & {}) | ({
|
|
6823
7013
|
mode: "provider_managed";
|
|
6824
7014
|
} & {}) | undefined;
|
|
7015
|
+
channelGroup?: ({
|
|
7016
|
+
key: string;
|
|
7017
|
+
label: string;
|
|
7018
|
+
} & {}) | undefined;
|
|
7019
|
+
property?: ({
|
|
7020
|
+
key: string;
|
|
7021
|
+
label: string;
|
|
7022
|
+
} & {}) | undefined;
|
|
7023
|
+
tier?: ({
|
|
7024
|
+
label: string;
|
|
7025
|
+
} & {}) | undefined;
|
|
7026
|
+
primaryText?: string | undefined;
|
|
7027
|
+
convertersAcknowledged?: true | undefined;
|
|
6825
7028
|
};
|
|
6826
7029
|
account: {
|
|
6827
7030
|
id: string;
|
|
@@ -6864,7 +7067,9 @@ declare const metaView: Field<({
|
|
|
6864
7067
|
retentionDays: number;
|
|
6865
7068
|
exclusionRuleIds: string[];
|
|
6866
7069
|
consentPurpose: "ad_personalization";
|
|
6867
|
-
} & {
|
|
7070
|
+
} & {
|
|
7071
|
+
minDaysSinceVisit?: number | undefined;
|
|
7072
|
+
};
|
|
6868
7073
|
name: string;
|
|
6869
7074
|
resourceRuleRef: {
|
|
6870
7075
|
id: string;
|
|
@@ -6939,7 +7144,9 @@ declare const metaSaveResponse: Field<{
|
|
|
6939
7144
|
retentionDays: number;
|
|
6940
7145
|
exclusionRuleIds: string[];
|
|
6941
7146
|
consentPurpose: "ad_personalization";
|
|
6942
|
-
} & {
|
|
7147
|
+
} & {
|
|
7148
|
+
minDaysSinceVisit?: number | undefined;
|
|
7149
|
+
})[];
|
|
6943
7150
|
objective: "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC";
|
|
6944
7151
|
pageRef: {
|
|
6945
7152
|
connectionId: string;
|
|
@@ -6990,6 +7197,19 @@ declare const metaSaveResponse: Field<{
|
|
|
6990
7197
|
} & {}) | ({
|
|
6991
7198
|
mode: "provider_managed";
|
|
6992
7199
|
} & {}) | undefined;
|
|
7200
|
+
channelGroup?: ({
|
|
7201
|
+
key: string;
|
|
7202
|
+
label: string;
|
|
7203
|
+
} & {}) | undefined;
|
|
7204
|
+
property?: ({
|
|
7205
|
+
key: string;
|
|
7206
|
+
label: string;
|
|
7207
|
+
} & {}) | undefined;
|
|
7208
|
+
tier?: ({
|
|
7209
|
+
label: string;
|
|
7210
|
+
} & {}) | undefined;
|
|
7211
|
+
primaryText?: string | undefined;
|
|
7212
|
+
convertersAcknowledged?: true | undefined;
|
|
6993
7213
|
};
|
|
6994
7214
|
account: {
|
|
6995
7215
|
id: string;
|
|
@@ -7032,7 +7252,9 @@ declare const metaSaveResponse: Field<{
|
|
|
7032
7252
|
retentionDays: number;
|
|
7033
7253
|
exclusionRuleIds: string[];
|
|
7034
7254
|
consentPurpose: "ad_personalization";
|
|
7035
|
-
} & {
|
|
7255
|
+
} & {
|
|
7256
|
+
minDaysSinceVisit?: number | undefined;
|
|
7257
|
+
};
|
|
7036
7258
|
name: string;
|
|
7037
7259
|
resourceRuleRef: {
|
|
7038
7260
|
id: string;
|
|
@@ -7115,7 +7337,9 @@ export declare function projectResonanceMetaConfiguration(v: unknown, currentMet
|
|
|
7115
7337
|
retentionDays: number;
|
|
7116
7338
|
exclusionRuleIds: string[];
|
|
7117
7339
|
consentPurpose: "ad_personalization";
|
|
7118
|
-
} & {
|
|
7340
|
+
} & {
|
|
7341
|
+
minDaysSinceVisit?: number | undefined;
|
|
7342
|
+
})[];
|
|
7119
7343
|
objective: "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC";
|
|
7120
7344
|
pageRef: {
|
|
7121
7345
|
connectionId: string;
|
|
@@ -7166,6 +7390,19 @@ export declare function projectResonanceMetaConfiguration(v: unknown, currentMet
|
|
|
7166
7390
|
} & {}) | ({
|
|
7167
7391
|
mode: "provider_managed";
|
|
7168
7392
|
} & {}) | undefined;
|
|
7393
|
+
channelGroup?: ({
|
|
7394
|
+
key: string;
|
|
7395
|
+
label: string;
|
|
7396
|
+
} & {}) | undefined;
|
|
7397
|
+
property?: ({
|
|
7398
|
+
key: string;
|
|
7399
|
+
label: string;
|
|
7400
|
+
} & {}) | undefined;
|
|
7401
|
+
tier?: ({
|
|
7402
|
+
label: string;
|
|
7403
|
+
} & {}) | undefined;
|
|
7404
|
+
primaryText?: string | undefined;
|
|
7405
|
+
convertersAcknowledged?: true | undefined;
|
|
7169
7406
|
};
|
|
7170
7407
|
account: {
|
|
7171
7408
|
id: string;
|
|
@@ -7208,7 +7445,9 @@ export declare function projectResonanceMetaConfiguration(v: unknown, currentMet
|
|
|
7208
7445
|
retentionDays: number;
|
|
7209
7446
|
exclusionRuleIds: string[];
|
|
7210
7447
|
consentPurpose: "ad_personalization";
|
|
7211
|
-
} & {
|
|
7448
|
+
} & {
|
|
7449
|
+
minDaysSinceVisit?: number | undefined;
|
|
7450
|
+
};
|
|
7212
7451
|
name: string;
|
|
7213
7452
|
resourceRuleRef: {
|
|
7214
7453
|
id: string;
|
|
@@ -7279,7 +7518,9 @@ export declare function projectResonanceMetaConfiguration(v: unknown, currentMet
|
|
|
7279
7518
|
retentionDays: number;
|
|
7280
7519
|
exclusionRuleIds: string[];
|
|
7281
7520
|
consentPurpose: "ad_personalization";
|
|
7282
|
-
} & {
|
|
7521
|
+
} & {
|
|
7522
|
+
minDaysSinceVisit?: number | undefined;
|
|
7523
|
+
})[];
|
|
7283
7524
|
objective: "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC";
|
|
7284
7525
|
pageRef: {
|
|
7285
7526
|
connectionId: string;
|
|
@@ -7330,6 +7571,19 @@ export declare function projectResonanceMetaConfiguration(v: unknown, currentMet
|
|
|
7330
7571
|
} & {}) | ({
|
|
7331
7572
|
mode: "provider_managed";
|
|
7332
7573
|
} & {}) | undefined;
|
|
7574
|
+
channelGroup?: ({
|
|
7575
|
+
key: string;
|
|
7576
|
+
label: string;
|
|
7577
|
+
} & {}) | undefined;
|
|
7578
|
+
property?: ({
|
|
7579
|
+
key: string;
|
|
7580
|
+
label: string;
|
|
7581
|
+
} & {}) | undefined;
|
|
7582
|
+
tier?: ({
|
|
7583
|
+
label: string;
|
|
7584
|
+
} & {}) | undefined;
|
|
7585
|
+
primaryText?: string | undefined;
|
|
7586
|
+
convertersAcknowledged?: true | undefined;
|
|
7333
7587
|
};
|
|
7334
7588
|
account: {
|
|
7335
7589
|
id: string;
|
|
@@ -7372,7 +7626,9 @@ export declare function projectResonanceMetaConfiguration(v: unknown, currentMet
|
|
|
7372
7626
|
retentionDays: number;
|
|
7373
7627
|
exclusionRuleIds: string[];
|
|
7374
7628
|
consentPurpose: "ad_personalization";
|
|
7375
|
-
} & {
|
|
7629
|
+
} & {
|
|
7630
|
+
minDaysSinceVisit?: number | undefined;
|
|
7631
|
+
};
|
|
7376
7632
|
name: string;
|
|
7377
7633
|
resourceRuleRef: {
|
|
7378
7634
|
id: string;
|
|
@@ -7498,7 +7754,9 @@ declare const feedReview: Field<{
|
|
|
7498
7754
|
retentionDays: number;
|
|
7499
7755
|
exclusionRuleIds: string[];
|
|
7500
7756
|
consentPurpose: "ad_personalization";
|
|
7501
|
-
} & {
|
|
7757
|
+
} & {
|
|
7758
|
+
minDaysSinceVisit?: number | undefined;
|
|
7759
|
+
})[];
|
|
7502
7760
|
goal: {
|
|
7503
7761
|
source: {
|
|
7504
7762
|
projectId: string;
|
|
@@ -7614,7 +7872,9 @@ declare const feedReview: Field<{
|
|
|
7614
7872
|
retentionDays: number;
|
|
7615
7873
|
exclusionRuleIds: string[];
|
|
7616
7874
|
consentPurpose: "ad_personalization";
|
|
7617
|
-
} & {
|
|
7875
|
+
} & {
|
|
7876
|
+
minDaysSinceVisit?: number | undefined;
|
|
7877
|
+
})[];
|
|
7618
7878
|
objective: "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC";
|
|
7619
7879
|
pageRef: {
|
|
7620
7880
|
connectionId: string;
|
|
@@ -7665,6 +7925,19 @@ declare const feedReview: Field<{
|
|
|
7665
7925
|
} & {}) | ({
|
|
7666
7926
|
mode: "provider_managed";
|
|
7667
7927
|
} & {}) | undefined;
|
|
7928
|
+
channelGroup?: ({
|
|
7929
|
+
key: string;
|
|
7930
|
+
label: string;
|
|
7931
|
+
} & {}) | undefined;
|
|
7932
|
+
property?: ({
|
|
7933
|
+
key: string;
|
|
7934
|
+
label: string;
|
|
7935
|
+
} & {}) | undefined;
|
|
7936
|
+
tier?: ({
|
|
7937
|
+
label: string;
|
|
7938
|
+
} & {}) | undefined;
|
|
7939
|
+
primaryText?: string | undefined;
|
|
7940
|
+
convertersAcknowledged?: true | undefined;
|
|
7668
7941
|
};
|
|
7669
7942
|
account: {
|
|
7670
7943
|
id: string;
|
|
@@ -7707,7 +7980,9 @@ declare const feedReview: Field<{
|
|
|
7707
7980
|
retentionDays: number;
|
|
7708
7981
|
exclusionRuleIds: string[];
|
|
7709
7982
|
consentPurpose: "ad_personalization";
|
|
7710
|
-
} & {
|
|
7983
|
+
} & {
|
|
7984
|
+
minDaysSinceVisit?: number | undefined;
|
|
7985
|
+
};
|
|
7711
7986
|
name: string;
|
|
7712
7987
|
resourceRuleRef: {
|
|
7713
7988
|
id: string;
|
|
@@ -7752,10 +8027,10 @@ declare const publicObservationMetric: Field<({
|
|
|
7752
8027
|
projectId: string;
|
|
7753
8028
|
site: string;
|
|
7754
8029
|
campaignId: string;
|
|
7755
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
8030
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
7756
8031
|
sourceRef: string;
|
|
7757
8032
|
goalRevision: string | null;
|
|
7758
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
8033
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
7759
8034
|
windowStart: string;
|
|
7760
8035
|
windowEnd: string;
|
|
7761
8036
|
timeZone: string;
|
|
@@ -7797,10 +8072,10 @@ declare const publicObservationMetric: Field<({
|
|
|
7797
8072
|
projectId: string;
|
|
7798
8073
|
site: string;
|
|
7799
8074
|
campaignId: string;
|
|
7800
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
8075
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
7801
8076
|
sourceRef: string;
|
|
7802
8077
|
goalRevision: string | null;
|
|
7803
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
8078
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
7804
8079
|
windowStart: string;
|
|
7805
8080
|
windowEnd: string;
|
|
7806
8081
|
timeZone: string;
|
|
@@ -7925,10 +8200,10 @@ declare const observationsPage: Field<{
|
|
|
7925
8200
|
projectId: string;
|
|
7926
8201
|
site: string;
|
|
7927
8202
|
campaignId: string;
|
|
7928
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
8203
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
7929
8204
|
sourceRef: string;
|
|
7930
8205
|
goalRevision: string | null;
|
|
7931
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
8206
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
7932
8207
|
windowStart: string;
|
|
7933
8208
|
windowEnd: string;
|
|
7934
8209
|
timeZone: string;
|
|
@@ -7970,10 +8245,10 @@ declare const observationsPage: Field<{
|
|
|
7970
8245
|
projectId: string;
|
|
7971
8246
|
site: string;
|
|
7972
8247
|
campaignId: string;
|
|
7973
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
8248
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
7974
8249
|
sourceRef: string;
|
|
7975
8250
|
goalRevision: string | null;
|
|
7976
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
8251
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
7977
8252
|
windowStart: string;
|
|
7978
8253
|
windowEnd: string;
|
|
7979
8254
|
timeZone: string;
|
|
@@ -8052,3 +8327,135 @@ export declare function parseResonanceObservationsPage(v: unknown): ResonanceObs
|
|
|
8052
8327
|
export declare const RESONANCE_PUBLIC_OBSERVATION_METRIC_JSON_SCHEMA: import("./wire-schema").JsonSchema;
|
|
8053
8328
|
export declare const RESONANCE_OBSERVATION_SUPPORT_JSON_SCHEMA: import("./wire-schema").JsonSchema;
|
|
8054
8329
|
export declare const RESONANCE_OBSERVATIONS_PAGE_JSON_SCHEMA: import("./wire-schema").JsonSchema;
|
|
8330
|
+
/** Meta documents 180 days for a website audience's create parameter. Single source: the API and the editor import this, never a local copy. */
|
|
8331
|
+
export declare const META_WEBSITE_AUDIENCE_MAX_RETENTION_DAYS = 180;
|
|
8332
|
+
/** Meta allows at most ten rules per audience (inclusion, each exclusion, and a recency band). */
|
|
8333
|
+
export declare const META_AUDIENCE_RULE_LIMIT = 10;
|
|
8334
|
+
/** Targeting-level exclusion under a special category stays refused until a real call proves it (probes G-4 and P-X1); only a reviewed release flips this. */
|
|
8335
|
+
export declare const META_SAC_CUSTOM_AUDIENCE_EXCLUSION_VERIFIED: boolean;
|
|
8336
|
+
/** The call-to-action enums the Meta compiler accepts; the editor, the compiler and imports validate against this one list. */
|
|
8337
|
+
export declare const META_CALL_TO_ACTIONS: readonly ['LEARN_MORE', 'SIGN_UP', 'SHOP_NOW', 'APPLY_NOW', 'BOOK_TRAVEL', 'CONTACT_US', 'GET_QUOTE'];
|
|
8338
|
+
export type MetaCallToAction = typeof META_CALL_TO_ACTIONS[number];
|
|
8339
|
+
/** A property group holds one channel per property (and per tier). Twenty leaves room to add properties after launch. */
|
|
8340
|
+
export declare const RESONANCE_MAX_CHANNELS_PER_GROUP = 20;
|
|
8341
|
+
/** Provider metrics a report may carry. Reach is unique people, so it has its own counting unit and is never summed across channels. */
|
|
8342
|
+
export declare const RESONANCE_PROVIDER_METRIC_NAMES: readonly ['spend', 'impressions', 'clicks', 'reach', 'results'];
|
|
8343
|
+
type MetaChannelPlan = Extract<ResonanceChannelPlan, {
|
|
8344
|
+
kind: 'meta_retargeting';
|
|
8345
|
+
}>;
|
|
8346
|
+
/**
|
|
8347
|
+
* One audience's recency band and rule budget. `minDaysSinceVisit` keeps only people whose latest visit is at least that many days old,
|
|
8348
|
+
* so it must be shorter than the retention window. Meta caps the window and the rules; Google has no recency band.
|
|
8349
|
+
*/
|
|
8350
|
+
export declare function checkAudienceBand(ref: Pick<ResonanceAudienceRuleRef, 'retentionDays' | 'exclusionRuleIds' | 'minDaysSinceVisit'>, provider?: 'meta_ads' | 'google_ads', at?: string): void;
|
|
8351
|
+
/**
|
|
8352
|
+
* Channels that share a `channelGroup.key` share one dataset, account, Page and targeting profile; each property has its own destination;
|
|
8353
|
+
* tiers of one property do not overlap. Channels outside any group are not touched.
|
|
8354
|
+
*/
|
|
8355
|
+
export declare function checkChannelGroups(channels: readonly ResonanceChannelPlan[]): void;
|
|
8356
|
+
/**
|
|
8357
|
+
* Splits a total across weights in whole provider quanta (largest remainder, ties to the lower index), so the shares add up to the total exactly.
|
|
8358
|
+
* It is a helper, not an authority: a person edits the result and the reviewed definition is what counts.
|
|
8359
|
+
*/
|
|
8360
|
+
export declare function splitBudget(total: Money, weights: readonly number[], quantumMicros: string): Money[];
|
|
8361
|
+
/**
|
|
8362
|
+
* Suggested shares, in basis points that add up to 10 000, proportional to each property's unique visitors with a floor and a ceiling.
|
|
8363
|
+
* A SUGGESTION only: equal weights are the default and a person approves any other split.
|
|
8364
|
+
*/
|
|
8365
|
+
export declare function suggestPropertyWeights(visitors: readonly number[], bounds?: {
|
|
8366
|
+
floorBasisPoints?: number;
|
|
8367
|
+
ceilingBasisPoints?: number;
|
|
8368
|
+
}): number[];
|
|
8369
|
+
export interface ResonancePropertyAddition {
|
|
8370
|
+
key: string;
|
|
8371
|
+
label: string;
|
|
8372
|
+
/** The destination for the property's page, created natively before expansion. */
|
|
8373
|
+
destinationId: string;
|
|
8374
|
+
/** The property's audience version, created natively before expansion. */
|
|
8375
|
+
audienceRuleRefs: ResonanceAudienceRuleRef[];
|
|
8376
|
+
/** Optional split weight; default is equal. */
|
|
8377
|
+
weight?: number;
|
|
8378
|
+
}
|
|
8379
|
+
/** A new channel is complete in every field except the creative, which a person supplies. */
|
|
8380
|
+
export type ResonancePropertyChannelProposal = Omit<MetaChannelPlan, 'creativeIds'> & {
|
|
8381
|
+
creativeIds: [];
|
|
8382
|
+
};
|
|
8383
|
+
export interface ResonancePropertyExpansion {
|
|
8384
|
+
channels: ResonancePropertyChannelProposal[];
|
|
8385
|
+
/** The whole group's allocations after the split: existing channels first, then the new ones. */
|
|
8386
|
+
allocations: {
|
|
8387
|
+
channelId: string;
|
|
8388
|
+
allocation: Money;
|
|
8389
|
+
}[];
|
|
8390
|
+
blockingReasons: string[];
|
|
8391
|
+
}
|
|
8392
|
+
/**
|
|
8393
|
+
* Adds property channels to a group. Pure: it builds each new channel from the group's first channel (the template), names it
|
|
8394
|
+
* `property_creative_required:<key>` until a person supplies a creative, and re-splits the group's existing total. It never sets a
|
|
8395
|
+
* creative, a converter acknowledgement or an approval, and a property already in the group is skipped, so expanding twice is a no-op.
|
|
8396
|
+
* The measurement rule, audience version and destination are native objects the API creates first and passes in.
|
|
8397
|
+
*/
|
|
8398
|
+
export declare function expandPropertyChannels(definition: ResonanceCampaignDefinition, groupKey: string, additions: readonly ResonancePropertyAddition[], options: {
|
|
8399
|
+
quantumMicros: string;
|
|
8400
|
+
weights?: Readonly<Record<string, number>>;
|
|
8401
|
+
}): ResonancePropertyExpansion;
|
|
8402
|
+
/**
|
|
8403
|
+
* Whether a targeting-level custom-audience exclusion, or an in-rule exclusion or band, may be used on a Meta channel.
|
|
8404
|
+
* Fail closed: under a special category the targeting-level form stays refused until META_SAC_CUSTOM_AUDIENCE_EXCLUSION_VERIFIED is true,
|
|
8405
|
+
* and the in-rule form is allowed only when Meta's own eligibility readback for that audience says so.
|
|
8406
|
+
*/
|
|
8407
|
+
export declare function metaExclusionPolicy(channel: Pick<MetaChannelPlan, 'specialCategories'>, use: {
|
|
8408
|
+
targetingLevel: boolean;
|
|
8409
|
+
inRule: boolean;
|
|
8410
|
+
}): {
|
|
8411
|
+
allowed: boolean;
|
|
8412
|
+
reason: 'meta_exclusion_targeting_blocked_special_category' | null;
|
|
8413
|
+
requiresEligibilityReadback: boolean;
|
|
8414
|
+
};
|
|
8415
|
+
type RatioInput = {
|
|
8416
|
+
name: string;
|
|
8417
|
+
source: string;
|
|
8418
|
+
state: string;
|
|
8419
|
+
windowStart: string;
|
|
8420
|
+
windowEnd: string;
|
|
8421
|
+
observationId?: string;
|
|
8422
|
+
channelId?: string;
|
|
8423
|
+
value: {
|
|
8424
|
+
kind: 'count';
|
|
8425
|
+
count: string;
|
|
8426
|
+
} | {
|
|
8427
|
+
kind: 'money';
|
|
8428
|
+
money: Money;
|
|
8429
|
+
} | {
|
|
8430
|
+
kind: 'ratio';
|
|
8431
|
+
numerator: string;
|
|
8432
|
+
denominator: string;
|
|
8433
|
+
} | null;
|
|
8434
|
+
};
|
|
8435
|
+
export type ProviderRatio = {
|
|
8436
|
+
state: 'observed';
|
|
8437
|
+
value: {
|
|
8438
|
+
kind: 'ratio';
|
|
8439
|
+
numerator: string;
|
|
8440
|
+
denominator: string;
|
|
8441
|
+
};
|
|
8442
|
+
} | {
|
|
8443
|
+
state: 'unknown';
|
|
8444
|
+
reasonCode: string;
|
|
8445
|
+
};
|
|
8446
|
+
export type ProviderCostPerResult = {
|
|
8447
|
+
state: 'observed';
|
|
8448
|
+
money: Money;
|
|
8449
|
+
} | {
|
|
8450
|
+
state: 'unknown';
|
|
8451
|
+
reasonCode: string;
|
|
8452
|
+
};
|
|
8453
|
+
/**
|
|
8454
|
+
* The only place provider ratios are computed. Frequency is impressions over reach; cost per result is spend over results, rounded half to even at one micro.
|
|
8455
|
+
* Inputs must be provider-sourced, observed, and share one observation, channel and window; anything else is unknown, never zero and never a guess.
|
|
8456
|
+
*/
|
|
8457
|
+
export declare function deriveProviderRatios(items: readonly RatioInput[]): {
|
|
8458
|
+
frequency: ProviderRatio;
|
|
8459
|
+
costPerResult: ProviderCostPerResult;
|
|
8460
|
+
reasonCodes: string[];
|
|
8461
|
+
};
|