@sonordev/contracts 2.21.0 → 2.23.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 +15 -0
- package/README.md +60 -1
- package/dist/outreach.js +1 -45
- package/dist/outreach.mjs +1 -45
- package/dist/resonance.d.ts +803 -82
- package/dist/resonance.js +336 -14
- package/dist/resonance.mjs +319 -15
- 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;
|
|
@@ -1372,10 +1419,26 @@ declare const websiteVisitFeed: Field<{
|
|
|
1372
1419
|
} & {}>;
|
|
1373
1420
|
export type ResonanceWebsiteVisitFeed = Value<typeof websiteVisitFeed>;
|
|
1374
1421
|
export declare const RESONANCE_WEBSITE_VISIT_FEED_JSON_SCHEMA: import("./wire-schema").JsonSchema;
|
|
1422
|
+
/** Explicit report-query choices, not configured attribution or Ads Manager equivalence. */
|
|
1423
|
+
export declare const RESONANCE_META_QUERY_ATTRIBUTION_WINDOWS: readonly ['1d_click', '7d_click', '1d_view'];
|
|
1424
|
+
export type ResonanceMetaQueryAttributionWindow = typeof RESONANCE_META_QUERY_ATTRIBUTION_WINDOWS[number];
|
|
1425
|
+
declare const metaReportingQuery: Field<{
|
|
1426
|
+
channelId: string;
|
|
1427
|
+
attributionWindow: "1d_click" | "1d_view" | "7d_click";
|
|
1428
|
+
actionReportTime: "conversion";
|
|
1429
|
+
basis: "explicit_query";
|
|
1430
|
+
} & {}>;
|
|
1375
1431
|
declare const providerReportingSelection: Field<{
|
|
1376
1432
|
agentContactId: string;
|
|
1377
1433
|
channelIds: string[];
|
|
1378
|
-
} & {
|
|
1434
|
+
} & {
|
|
1435
|
+
metaQueries?: ({
|
|
1436
|
+
channelId: string;
|
|
1437
|
+
attributionWindow: "1d_click" | "1d_view" | "7d_click";
|
|
1438
|
+
actionReportTime: "conversion";
|
|
1439
|
+
basis: "explicit_query";
|
|
1440
|
+
} & {})[] | undefined;
|
|
1441
|
+
}>;
|
|
1379
1442
|
declare const providerReportingGrant: Field<{
|
|
1380
1443
|
purpose: "provider_reporting_refresh";
|
|
1381
1444
|
orgId: string;
|
|
@@ -1383,7 +1446,15 @@ declare const providerReportingGrant: Field<{
|
|
|
1383
1446
|
agentContactId: string;
|
|
1384
1447
|
principalContactId: string;
|
|
1385
1448
|
channelIds: string[];
|
|
1386
|
-
} & {
|
|
1449
|
+
} & {
|
|
1450
|
+
metaQueries?: ({
|
|
1451
|
+
channelId: string;
|
|
1452
|
+
attributionWindow: "1d_click" | "1d_view" | "7d_click";
|
|
1453
|
+
actionReportTime: "conversion";
|
|
1454
|
+
basis: "explicit_query";
|
|
1455
|
+
} & {})[] | undefined;
|
|
1456
|
+
}>;
|
|
1457
|
+
export type ResonanceMetaReportingQuery = Value<typeof metaReportingQuery>;
|
|
1387
1458
|
export type ResonanceProviderReportingSelection = Value<typeof providerReportingSelection>;
|
|
1388
1459
|
export type ResonanceProviderReportingGrant = Value<typeof providerReportingGrant>;
|
|
1389
1460
|
export declare const parseResonanceProviderReportingSelection: (v: unknown) => ResonanceProviderReportingSelection;
|
|
@@ -1452,7 +1523,9 @@ declare const mandateScope: Field<{
|
|
|
1452
1523
|
retentionDays: number;
|
|
1453
1524
|
exclusionRuleIds: string[];
|
|
1454
1525
|
consentPurpose: "ad_personalization";
|
|
1455
|
-
} & {
|
|
1526
|
+
} & {
|
|
1527
|
+
minDaysSinceVisit?: number | undefined;
|
|
1528
|
+
})[];
|
|
1456
1529
|
goal: {
|
|
1457
1530
|
source: {
|
|
1458
1531
|
projectId: string;
|
|
@@ -1522,7 +1595,14 @@ declare const mandateScope: Field<{
|
|
|
1522
1595
|
agentContactId: string;
|
|
1523
1596
|
principalContactId: string;
|
|
1524
1597
|
channelIds: string[];
|
|
1525
|
-
} & {
|
|
1598
|
+
} & {
|
|
1599
|
+
metaQueries?: ({
|
|
1600
|
+
channelId: string;
|
|
1601
|
+
attributionWindow: "1d_click" | "1d_view" | "7d_click";
|
|
1602
|
+
actionReportTime: "conversion";
|
|
1603
|
+
basis: "explicit_query";
|
|
1604
|
+
} & {})[] | undefined;
|
|
1605
|
+
}) | undefined;
|
|
1526
1606
|
}>;
|
|
1527
1607
|
export type ResonanceMandateScope = Value<typeof mandateScope>;
|
|
1528
1608
|
export declare function parseResonanceMandateScope(v: unknown, preparedPlan?: unknown): ResonanceMandateScope;
|
|
@@ -2357,7 +2437,9 @@ declare const prepared: Field<{
|
|
|
2357
2437
|
retentionDays: number;
|
|
2358
2438
|
exclusionRuleIds: string[];
|
|
2359
2439
|
consentPurpose: "ad_personalization";
|
|
2360
|
-
} & {
|
|
2440
|
+
} & {
|
|
2441
|
+
minDaysSinceVisit?: number | undefined;
|
|
2442
|
+
})[];
|
|
2361
2443
|
objective: "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC";
|
|
2362
2444
|
pageRef: {
|
|
2363
2445
|
connectionId: string;
|
|
@@ -2408,6 +2490,19 @@ declare const prepared: Field<{
|
|
|
2408
2490
|
} & {}) | ({
|
|
2409
2491
|
mode: "provider_managed";
|
|
2410
2492
|
} & {}) | undefined;
|
|
2493
|
+
channelGroup?: ({
|
|
2494
|
+
key: string;
|
|
2495
|
+
label: string;
|
|
2496
|
+
} & {}) | undefined;
|
|
2497
|
+
property?: ({
|
|
2498
|
+
key: string;
|
|
2499
|
+
label: string;
|
|
2500
|
+
} & {}) | undefined;
|
|
2501
|
+
tier?: ({
|
|
2502
|
+
label: string;
|
|
2503
|
+
} & {}) | undefined;
|
|
2504
|
+
primaryText?: string | undefined;
|
|
2505
|
+
convertersAcknowledged?: true | undefined;
|
|
2411
2506
|
}) | ({
|
|
2412
2507
|
projectId: string;
|
|
2413
2508
|
site: string;
|
|
@@ -2782,7 +2877,9 @@ declare const prepared: Field<{
|
|
|
2782
2877
|
retentionDays: number;
|
|
2783
2878
|
exclusionRuleIds: string[];
|
|
2784
2879
|
consentPurpose: "ad_personalization";
|
|
2785
|
-
} & {
|
|
2880
|
+
} & {
|
|
2881
|
+
minDaysSinceVisit?: number | undefined;
|
|
2882
|
+
})[];
|
|
2786
2883
|
allocation: ({
|
|
2787
2884
|
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
2885
|
amountMicros: string;
|
|
@@ -3210,7 +3307,9 @@ declare const view: Field<{
|
|
|
3210
3307
|
retentionDays: number;
|
|
3211
3308
|
exclusionRuleIds: string[];
|
|
3212
3309
|
consentPurpose: "ad_personalization";
|
|
3213
|
-
} & {
|
|
3310
|
+
} & {
|
|
3311
|
+
minDaysSinceVisit?: number | undefined;
|
|
3312
|
+
})[];
|
|
3214
3313
|
objective: "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC";
|
|
3215
3314
|
pageRef: {
|
|
3216
3315
|
connectionId: string;
|
|
@@ -3261,6 +3360,19 @@ declare const view: Field<{
|
|
|
3261
3360
|
} & {}) | ({
|
|
3262
3361
|
mode: "provider_managed";
|
|
3263
3362
|
} & {}) | undefined;
|
|
3363
|
+
channelGroup?: ({
|
|
3364
|
+
key: string;
|
|
3365
|
+
label: string;
|
|
3366
|
+
} & {}) | undefined;
|
|
3367
|
+
property?: ({
|
|
3368
|
+
key: string;
|
|
3369
|
+
label: string;
|
|
3370
|
+
} & {}) | undefined;
|
|
3371
|
+
tier?: ({
|
|
3372
|
+
label: string;
|
|
3373
|
+
} & {}) | undefined;
|
|
3374
|
+
primaryText?: string | undefined;
|
|
3375
|
+
convertersAcknowledged?: true | undefined;
|
|
3264
3376
|
}) | ({
|
|
3265
3377
|
projectId: string;
|
|
3266
3378
|
site: string;
|
|
@@ -3485,11 +3597,11 @@ declare const metric: Field<({
|
|
|
3485
3597
|
projectId: string;
|
|
3486
3598
|
site: string;
|
|
3487
3599
|
campaignId: string;
|
|
3488
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
3600
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
3489
3601
|
source: "experiment" | "first_party" | "provider";
|
|
3490
3602
|
sourceRef: string;
|
|
3491
3603
|
goalRevision: string | null;
|
|
3492
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
3604
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
3493
3605
|
windowStart: string;
|
|
3494
3606
|
windowEnd: string;
|
|
3495
3607
|
timeZone: string;
|
|
@@ -3526,11 +3638,11 @@ declare const metric: Field<({
|
|
|
3526
3638
|
projectId: string;
|
|
3527
3639
|
site: string;
|
|
3528
3640
|
campaignId: string;
|
|
3529
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
3641
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
3530
3642
|
source: "experiment" | "first_party" | "provider";
|
|
3531
3643
|
sourceRef: string;
|
|
3532
3644
|
goalRevision: string | null;
|
|
3533
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
3645
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
3534
3646
|
windowStart: string;
|
|
3535
3647
|
windowEnd: string;
|
|
3536
3648
|
timeZone: string;
|
|
@@ -3718,7 +3830,9 @@ declare const mandateApproval: Field<{
|
|
|
3718
3830
|
retentionDays: number;
|
|
3719
3831
|
exclusionRuleIds: string[];
|
|
3720
3832
|
consentPurpose: "ad_personalization";
|
|
3721
|
-
} & {
|
|
3833
|
+
} & {
|
|
3834
|
+
minDaysSinceVisit?: number | undefined;
|
|
3835
|
+
})[];
|
|
3722
3836
|
goal: {
|
|
3723
3837
|
source: {
|
|
3724
3838
|
projectId: string;
|
|
@@ -3788,7 +3902,14 @@ declare const mandateApproval: Field<{
|
|
|
3788
3902
|
agentContactId: string;
|
|
3789
3903
|
principalContactId: string;
|
|
3790
3904
|
channelIds: string[];
|
|
3791
|
-
} & {
|
|
3905
|
+
} & {
|
|
3906
|
+
metaQueries?: ({
|
|
3907
|
+
channelId: string;
|
|
3908
|
+
attributionWindow: "1d_click" | "1d_view" | "7d_click";
|
|
3909
|
+
actionReportTime: "conversion";
|
|
3910
|
+
basis: "explicit_query";
|
|
3911
|
+
} & {})[] | undefined;
|
|
3912
|
+
}) | undefined;
|
|
3792
3913
|
};
|
|
3793
3914
|
} & {}>;
|
|
3794
3915
|
export type ResonanceMandateApprovalPayload = Value<typeof mandateApproval>;
|
|
@@ -4089,7 +4210,9 @@ declare const saveCommand: Field<{
|
|
|
4089
4210
|
retentionDays: number;
|
|
4090
4211
|
exclusionRuleIds: string[];
|
|
4091
4212
|
consentPurpose: "ad_personalization";
|
|
4092
|
-
} & {
|
|
4213
|
+
} & {
|
|
4214
|
+
minDaysSinceVisit?: number | undefined;
|
|
4215
|
+
})[];
|
|
4093
4216
|
objective: "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC";
|
|
4094
4217
|
pageRef: {
|
|
4095
4218
|
connectionId: string;
|
|
@@ -4140,6 +4263,19 @@ declare const saveCommand: Field<{
|
|
|
4140
4263
|
} & {}) | ({
|
|
4141
4264
|
mode: "provider_managed";
|
|
4142
4265
|
} & {}) | undefined;
|
|
4266
|
+
channelGroup?: ({
|
|
4267
|
+
key: string;
|
|
4268
|
+
label: string;
|
|
4269
|
+
} & {}) | undefined;
|
|
4270
|
+
property?: ({
|
|
4271
|
+
key: string;
|
|
4272
|
+
label: string;
|
|
4273
|
+
} & {}) | undefined;
|
|
4274
|
+
tier?: ({
|
|
4275
|
+
label: string;
|
|
4276
|
+
} & {}) | undefined;
|
|
4277
|
+
primaryText?: string | undefined;
|
|
4278
|
+
convertersAcknowledged?: true | undefined;
|
|
4143
4279
|
}) | ({
|
|
4144
4280
|
projectId: string;
|
|
4145
4281
|
site: string;
|
|
@@ -4525,11 +4661,11 @@ declare const reportedOptimizationEvidence: Field<{
|
|
|
4525
4661
|
projectId: string;
|
|
4526
4662
|
site: string;
|
|
4527
4663
|
campaignId: string;
|
|
4528
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
4664
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
4529
4665
|
source: "experiment" | "first_party" | "provider";
|
|
4530
4666
|
sourceRef: string;
|
|
4531
4667
|
goalRevision: string | null;
|
|
4532
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
4668
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
4533
4669
|
windowStart: string;
|
|
4534
4670
|
windowEnd: string;
|
|
4535
4671
|
timeZone: string;
|
|
@@ -4566,11 +4702,11 @@ declare const reportedOptimizationEvidence: Field<{
|
|
|
4566
4702
|
projectId: string;
|
|
4567
4703
|
site: string;
|
|
4568
4704
|
campaignId: string;
|
|
4569
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
4705
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
4570
4706
|
source: "experiment" | "first_party" | "provider";
|
|
4571
4707
|
sourceRef: string;
|
|
4572
4708
|
goalRevision: string | null;
|
|
4573
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
4709
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
4574
4710
|
windowStart: string;
|
|
4575
4711
|
windowEnd: string;
|
|
4576
4712
|
timeZone: string;
|
|
@@ -4795,11 +4931,11 @@ declare const finiteOptimizationEvidence: Field<{
|
|
|
4795
4931
|
projectId: string;
|
|
4796
4932
|
site: string;
|
|
4797
4933
|
campaignId: string;
|
|
4798
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
4934
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
4799
4935
|
source: "experiment" | "first_party" | "provider";
|
|
4800
4936
|
sourceRef: string;
|
|
4801
4937
|
goalRevision: string | null;
|
|
4802
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
4938
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
4803
4939
|
windowStart: string;
|
|
4804
4940
|
windowEnd: string;
|
|
4805
4941
|
timeZone: string;
|
|
@@ -4836,11 +4972,11 @@ declare const finiteOptimizationEvidence: Field<{
|
|
|
4836
4972
|
projectId: string;
|
|
4837
4973
|
site: string;
|
|
4838
4974
|
campaignId: string;
|
|
4839
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
4975
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
4840
4976
|
source: "experiment" | "first_party" | "provider";
|
|
4841
4977
|
sourceRef: string;
|
|
4842
4978
|
goalRevision: string | null;
|
|
4843
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
4979
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
4844
4980
|
windowStart: string;
|
|
4845
4981
|
windowEnd: string;
|
|
4846
4982
|
timeZone: string;
|
|
@@ -4869,11 +5005,11 @@ declare const finiteOptimizationEvidence: Field<{
|
|
|
4869
5005
|
projectId: string;
|
|
4870
5006
|
site: string;
|
|
4871
5007
|
campaignId: string;
|
|
4872
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
5008
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
4873
5009
|
source: "experiment" | "first_party" | "provider";
|
|
4874
5010
|
sourceRef: string;
|
|
4875
5011
|
goalRevision: string | null;
|
|
4876
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
5012
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
4877
5013
|
windowStart: string;
|
|
4878
5014
|
windowEnd: string;
|
|
4879
5015
|
timeZone: string;
|
|
@@ -4910,11 +5046,11 @@ declare const finiteOptimizationEvidence: Field<{
|
|
|
4910
5046
|
projectId: string;
|
|
4911
5047
|
site: string;
|
|
4912
5048
|
campaignId: string;
|
|
4913
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
5049
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
4914
5050
|
source: "experiment" | "first_party" | "provider";
|
|
4915
5051
|
sourceRef: string;
|
|
4916
5052
|
goalRevision: string | null;
|
|
4917
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
5053
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
4918
5054
|
windowStart: string;
|
|
4919
5055
|
windowEnd: string;
|
|
4920
5056
|
timeZone: string;
|
|
@@ -5067,11 +5203,11 @@ declare const optimizationEvidence: Field<({
|
|
|
5067
5203
|
projectId: string;
|
|
5068
5204
|
site: string;
|
|
5069
5205
|
campaignId: string;
|
|
5070
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
5206
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
5071
5207
|
source: "experiment" | "first_party" | "provider";
|
|
5072
5208
|
sourceRef: string;
|
|
5073
5209
|
goalRevision: string | null;
|
|
5074
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
5210
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
5075
5211
|
windowStart: string;
|
|
5076
5212
|
windowEnd: string;
|
|
5077
5213
|
timeZone: string;
|
|
@@ -5108,11 +5244,11 @@ declare const optimizationEvidence: Field<({
|
|
|
5108
5244
|
projectId: string;
|
|
5109
5245
|
site: string;
|
|
5110
5246
|
campaignId: string;
|
|
5111
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
5247
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
5112
5248
|
source: "experiment" | "first_party" | "provider";
|
|
5113
5249
|
sourceRef: string;
|
|
5114
5250
|
goalRevision: string | null;
|
|
5115
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
5251
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
5116
5252
|
windowStart: string;
|
|
5117
5253
|
windowEnd: string;
|
|
5118
5254
|
timeZone: string;
|
|
@@ -5288,11 +5424,11 @@ declare const optimizationEvidence: Field<({
|
|
|
5288
5424
|
projectId: string;
|
|
5289
5425
|
site: string;
|
|
5290
5426
|
campaignId: string;
|
|
5291
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
5427
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
5292
5428
|
source: "experiment" | "first_party" | "provider";
|
|
5293
5429
|
sourceRef: string;
|
|
5294
5430
|
goalRevision: string | null;
|
|
5295
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
5431
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
5296
5432
|
windowStart: string;
|
|
5297
5433
|
windowEnd: string;
|
|
5298
5434
|
timeZone: string;
|
|
@@ -5329,11 +5465,11 @@ declare const optimizationEvidence: Field<({
|
|
|
5329
5465
|
projectId: string;
|
|
5330
5466
|
site: string;
|
|
5331
5467
|
campaignId: string;
|
|
5332
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
5468
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
5333
5469
|
source: "experiment" | "first_party" | "provider";
|
|
5334
5470
|
sourceRef: string;
|
|
5335
5471
|
goalRevision: string | null;
|
|
5336
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
5472
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
5337
5473
|
windowStart: string;
|
|
5338
5474
|
windowEnd: string;
|
|
5339
5475
|
timeZone: string;
|
|
@@ -5551,11 +5687,11 @@ declare const optimizationEvidence: Field<({
|
|
|
5551
5687
|
projectId: string;
|
|
5552
5688
|
site: string;
|
|
5553
5689
|
campaignId: string;
|
|
5554
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
5690
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
5555
5691
|
source: "experiment" | "first_party" | "provider";
|
|
5556
5692
|
sourceRef: string;
|
|
5557
5693
|
goalRevision: string | null;
|
|
5558
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
5694
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
5559
5695
|
windowStart: string;
|
|
5560
5696
|
windowEnd: string;
|
|
5561
5697
|
timeZone: string;
|
|
@@ -5592,11 +5728,11 @@ declare const optimizationEvidence: Field<({
|
|
|
5592
5728
|
projectId: string;
|
|
5593
5729
|
site: string;
|
|
5594
5730
|
campaignId: string;
|
|
5595
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
5731
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
5596
5732
|
source: "experiment" | "first_party" | "provider";
|
|
5597
5733
|
sourceRef: string;
|
|
5598
5734
|
goalRevision: string | null;
|
|
5599
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
5735
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
5600
5736
|
windowStart: string;
|
|
5601
5737
|
windowEnd: string;
|
|
5602
5738
|
timeZone: string;
|
|
@@ -5625,11 +5761,11 @@ declare const optimizationEvidence: Field<({
|
|
|
5625
5761
|
projectId: string;
|
|
5626
5762
|
site: string;
|
|
5627
5763
|
campaignId: string;
|
|
5628
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
5764
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
5629
5765
|
source: "experiment" | "first_party" | "provider";
|
|
5630
5766
|
sourceRef: string;
|
|
5631
5767
|
goalRevision: string | null;
|
|
5632
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
5768
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
5633
5769
|
windowStart: string;
|
|
5634
5770
|
windowEnd: string;
|
|
5635
5771
|
timeZone: string;
|
|
@@ -5666,11 +5802,11 @@ declare const optimizationEvidence: Field<({
|
|
|
5666
5802
|
projectId: string;
|
|
5667
5803
|
site: string;
|
|
5668
5804
|
campaignId: string;
|
|
5669
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
5805
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
5670
5806
|
source: "experiment" | "first_party" | "provider";
|
|
5671
5807
|
sourceRef: string;
|
|
5672
5808
|
goalRevision: string | null;
|
|
5673
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
5809
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
5674
5810
|
windowStart: string;
|
|
5675
5811
|
windowEnd: string;
|
|
5676
5812
|
timeZone: string;
|
|
@@ -5945,6 +6081,17 @@ export type ResonanceOptimizationDecision = Value<typeof optimizationDecision>;
|
|
|
5945
6081
|
export declare function parseResonanceOptimizationDecision(v: unknown, evidence?: unknown, preparedPlan?: unknown): ResonanceOptimizationDecision;
|
|
5946
6082
|
export declare const RESONANCE_OPTIMIZATION_EVIDENCE_JSON_SCHEMA: import("./wire-schema").JsonSchema;
|
|
5947
6083
|
export declare const RESONANCE_OPTIMIZATION_DECISION_JSON_SCHEMA: import("./wire-schema").JsonSchema;
|
|
6084
|
+
/**
|
|
6085
|
+
* Capability witness for the browser Meta loader. The API issues it only after its dataset assertions pass; the
|
|
6086
|
+
* browser reads it, never decides it. It names the loader controls revision and the policy revision it was issued under.
|
|
6087
|
+
*/
|
|
6088
|
+
declare const metaBrowserWitness: Field<{
|
|
6089
|
+
controlsRevision: string;
|
|
6090
|
+
policyRevision: string;
|
|
6091
|
+
witnessId: string;
|
|
6092
|
+
assertedAt: string;
|
|
6093
|
+
} & {}>;
|
|
6094
|
+
export type ResonanceMetaBrowserWitness = Value<typeof metaBrowserWitness>;
|
|
5948
6095
|
declare const measurementConfig: Field<{
|
|
5949
6096
|
projectId: string;
|
|
5950
6097
|
site: string;
|
|
@@ -5965,7 +6112,15 @@ declare const measurementConfig: Field<{
|
|
|
5965
6112
|
provider: "meta_ads";
|
|
5966
6113
|
id: string;
|
|
5967
6114
|
pixelId: string;
|
|
5968
|
-
} & {
|
|
6115
|
+
} & {
|
|
6116
|
+
browserWitness?: ({
|
|
6117
|
+
controlsRevision: string;
|
|
6118
|
+
policyRevision: string;
|
|
6119
|
+
witnessId: string;
|
|
6120
|
+
assertedAt: string;
|
|
6121
|
+
} & {}) | undefined;
|
|
6122
|
+
tagManagerAttested?: boolean | undefined;
|
|
6123
|
+
}))[];
|
|
5969
6124
|
resourceRules: ({
|
|
5970
6125
|
id: string;
|
|
5971
6126
|
revision: string;
|
|
@@ -5979,7 +6134,9 @@ declare const measurementConfig: Field<{
|
|
|
5979
6134
|
} & {};
|
|
5980
6135
|
path: string;
|
|
5981
6136
|
interestKey: string;
|
|
5982
|
-
} & {
|
|
6137
|
+
} & {
|
|
6138
|
+
metaEligible?: boolean | undefined;
|
|
6139
|
+
})[];
|
|
5983
6140
|
} & {}>;
|
|
5984
6141
|
export type ResonanceMeasurementConfig = Value<typeof measurementConfig>;
|
|
5985
6142
|
export declare function parseResonanceMeasurementConfig(v: unknown): ResonanceMeasurementConfig;
|
|
@@ -6129,7 +6286,9 @@ declare const audienceDraft: Field<{
|
|
|
6129
6286
|
retentionDays: number;
|
|
6130
6287
|
policyRevision: string;
|
|
6131
6288
|
currentConsentPolicyRevision: string;
|
|
6132
|
-
} & {
|
|
6289
|
+
} & {
|
|
6290
|
+
minDaysSinceVisit?: number | undefined;
|
|
6291
|
+
};
|
|
6133
6292
|
} & {
|
|
6134
6293
|
expectedRevision?: number | undefined;
|
|
6135
6294
|
}>;
|
|
@@ -6262,7 +6421,15 @@ declare const measurementCurrent: Field<({
|
|
|
6262
6421
|
provider: "meta_ads";
|
|
6263
6422
|
id: string;
|
|
6264
6423
|
pixelId: string;
|
|
6265
|
-
} & {
|
|
6424
|
+
} & {
|
|
6425
|
+
browserWitness?: ({
|
|
6426
|
+
controlsRevision: string;
|
|
6427
|
+
policyRevision: string;
|
|
6428
|
+
witnessId: string;
|
|
6429
|
+
assertedAt: string;
|
|
6430
|
+
} & {}) | undefined;
|
|
6431
|
+
tagManagerAttested?: boolean | undefined;
|
|
6432
|
+
}))[];
|
|
6266
6433
|
resourceRules: ({
|
|
6267
6434
|
id: string;
|
|
6268
6435
|
revision: string;
|
|
@@ -6276,7 +6443,9 @@ declare const measurementCurrent: Field<({
|
|
|
6276
6443
|
} & {};
|
|
6277
6444
|
path: string;
|
|
6278
6445
|
interestKey: string;
|
|
6279
|
-
} & {
|
|
6446
|
+
} & {
|
|
6447
|
+
metaEligible?: boolean | undefined;
|
|
6448
|
+
})[];
|
|
6280
6449
|
} & {};
|
|
6281
6450
|
saveOperationId: string;
|
|
6282
6451
|
pages: ({
|
|
@@ -6320,7 +6489,15 @@ declare const measurementSnapshot: Field<{
|
|
|
6320
6489
|
provider: "meta_ads";
|
|
6321
6490
|
id: string;
|
|
6322
6491
|
pixelId: string;
|
|
6323
|
-
} & {
|
|
6492
|
+
} & {
|
|
6493
|
+
browserWitness?: ({
|
|
6494
|
+
controlsRevision: string;
|
|
6495
|
+
policyRevision: string;
|
|
6496
|
+
witnessId: string;
|
|
6497
|
+
assertedAt: string;
|
|
6498
|
+
} & {}) | undefined;
|
|
6499
|
+
tagManagerAttested?: boolean | undefined;
|
|
6500
|
+
}))[];
|
|
6324
6501
|
resourceRules: ({
|
|
6325
6502
|
id: string;
|
|
6326
6503
|
revision: string;
|
|
@@ -6334,7 +6511,9 @@ declare const measurementSnapshot: Field<{
|
|
|
6334
6511
|
} & {};
|
|
6335
6512
|
path: string;
|
|
6336
6513
|
interestKey: string;
|
|
6337
|
-
} & {
|
|
6514
|
+
} & {
|
|
6515
|
+
metaEligible?: boolean | undefined;
|
|
6516
|
+
})[];
|
|
6338
6517
|
} & {};
|
|
6339
6518
|
pages: ({
|
|
6340
6519
|
pageId: string;
|
|
@@ -6374,7 +6553,15 @@ declare const measurementSaveResponse: Field<{
|
|
|
6374
6553
|
provider: "meta_ads";
|
|
6375
6554
|
id: string;
|
|
6376
6555
|
pixelId: string;
|
|
6377
|
-
} & {
|
|
6556
|
+
} & {
|
|
6557
|
+
browserWitness?: ({
|
|
6558
|
+
controlsRevision: string;
|
|
6559
|
+
policyRevision: string;
|
|
6560
|
+
witnessId: string;
|
|
6561
|
+
assertedAt: string;
|
|
6562
|
+
} & {}) | undefined;
|
|
6563
|
+
tagManagerAttested?: boolean | undefined;
|
|
6564
|
+
}))[];
|
|
6378
6565
|
resourceRules: ({
|
|
6379
6566
|
id: string;
|
|
6380
6567
|
revision: string;
|
|
@@ -6388,7 +6575,9 @@ declare const measurementSaveResponse: Field<{
|
|
|
6388
6575
|
} & {};
|
|
6389
6576
|
path: string;
|
|
6390
6577
|
interestKey: string;
|
|
6391
|
-
} & {
|
|
6578
|
+
} & {
|
|
6579
|
+
metaEligible?: boolean | undefined;
|
|
6580
|
+
})[];
|
|
6392
6581
|
} & {};
|
|
6393
6582
|
pages: ({
|
|
6394
6583
|
pageId: string;
|
|
@@ -6440,7 +6629,15 @@ declare const measurementProjectionContext: Field<{
|
|
|
6440
6629
|
provider: "meta_ads";
|
|
6441
6630
|
id: string;
|
|
6442
6631
|
pixelId: string;
|
|
6443
|
-
} & {
|
|
6632
|
+
} & {
|
|
6633
|
+
browserWitness?: ({
|
|
6634
|
+
controlsRevision: string;
|
|
6635
|
+
policyRevision: string;
|
|
6636
|
+
witnessId: string;
|
|
6637
|
+
assertedAt: string;
|
|
6638
|
+
} & {}) | undefined;
|
|
6639
|
+
tagManagerAttested?: boolean | undefined;
|
|
6640
|
+
}))[];
|
|
6444
6641
|
resourceRules: ({
|
|
6445
6642
|
id: string;
|
|
6446
6643
|
revision: string;
|
|
@@ -6454,7 +6651,9 @@ declare const measurementProjectionContext: Field<{
|
|
|
6454
6651
|
} & {};
|
|
6455
6652
|
path: string;
|
|
6456
6653
|
interestKey: string;
|
|
6457
|
-
} & {
|
|
6654
|
+
} & {
|
|
6655
|
+
metaEligible?: boolean | undefined;
|
|
6656
|
+
})[];
|
|
6458
6657
|
} & {};
|
|
6459
6658
|
saveOperationId: string;
|
|
6460
6659
|
pages: ({
|
|
@@ -6502,7 +6701,15 @@ export declare function projectResonanceMeasurementConfiguration(value: Resonanc
|
|
|
6502
6701
|
provider: "meta_ads";
|
|
6503
6702
|
id: string;
|
|
6504
6703
|
pixelId: string;
|
|
6505
|
-
} & {
|
|
6704
|
+
} & {
|
|
6705
|
+
browserWitness?: ({
|
|
6706
|
+
controlsRevision: string;
|
|
6707
|
+
policyRevision: string;
|
|
6708
|
+
witnessId: string;
|
|
6709
|
+
assertedAt: string;
|
|
6710
|
+
} & {}) | undefined;
|
|
6711
|
+
tagManagerAttested?: boolean | undefined;
|
|
6712
|
+
}))[];
|
|
6506
6713
|
resourceRules: ({
|
|
6507
6714
|
id: string;
|
|
6508
6715
|
revision: string;
|
|
@@ -6516,7 +6723,9 @@ export declare function projectResonanceMeasurementConfiguration(value: Resonanc
|
|
|
6516
6723
|
} & {};
|
|
6517
6724
|
path: string;
|
|
6518
6725
|
interestKey: string;
|
|
6519
|
-
} & {
|
|
6726
|
+
} & {
|
|
6727
|
+
metaEligible?: boolean | undefined;
|
|
6728
|
+
})[];
|
|
6520
6729
|
} & {};
|
|
6521
6730
|
pages: {
|
|
6522
6731
|
pageId: string;
|
|
@@ -6588,7 +6797,9 @@ declare const metaSnapshot: Field<{
|
|
|
6588
6797
|
retentionDays: number;
|
|
6589
6798
|
exclusionRuleIds: string[];
|
|
6590
6799
|
consentPurpose: "ad_personalization";
|
|
6591
|
-
} & {
|
|
6800
|
+
} & {
|
|
6801
|
+
minDaysSinceVisit?: number | undefined;
|
|
6802
|
+
})[];
|
|
6592
6803
|
objective: "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC";
|
|
6593
6804
|
pageRef: {
|
|
6594
6805
|
connectionId: string;
|
|
@@ -6639,6 +6850,19 @@ declare const metaSnapshot: Field<{
|
|
|
6639
6850
|
} & {}) | ({
|
|
6640
6851
|
mode: "provider_managed";
|
|
6641
6852
|
} & {}) | undefined;
|
|
6853
|
+
channelGroup?: ({
|
|
6854
|
+
key: string;
|
|
6855
|
+
label: string;
|
|
6856
|
+
} & {}) | undefined;
|
|
6857
|
+
property?: ({
|
|
6858
|
+
key: string;
|
|
6859
|
+
label: string;
|
|
6860
|
+
} & {}) | undefined;
|
|
6861
|
+
tier?: ({
|
|
6862
|
+
label: string;
|
|
6863
|
+
} & {}) | undefined;
|
|
6864
|
+
primaryText?: string | undefined;
|
|
6865
|
+
convertersAcknowledged?: true | undefined;
|
|
6642
6866
|
};
|
|
6643
6867
|
account: {
|
|
6644
6868
|
id: string;
|
|
@@ -6681,7 +6905,9 @@ declare const metaSnapshot: Field<{
|
|
|
6681
6905
|
retentionDays: number;
|
|
6682
6906
|
exclusionRuleIds: string[];
|
|
6683
6907
|
consentPurpose: "ad_personalization";
|
|
6684
|
-
} & {
|
|
6908
|
+
} & {
|
|
6909
|
+
minDaysSinceVisit?: number | undefined;
|
|
6910
|
+
};
|
|
6685
6911
|
name: string;
|
|
6686
6912
|
resourceRuleRef: {
|
|
6687
6913
|
id: string;
|
|
@@ -6771,7 +6997,9 @@ declare const metaView: Field<({
|
|
|
6771
6997
|
retentionDays: number;
|
|
6772
6998
|
exclusionRuleIds: string[];
|
|
6773
6999
|
consentPurpose: "ad_personalization";
|
|
6774
|
-
} & {
|
|
7000
|
+
} & {
|
|
7001
|
+
minDaysSinceVisit?: number | undefined;
|
|
7002
|
+
})[];
|
|
6775
7003
|
objective: "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC";
|
|
6776
7004
|
pageRef: {
|
|
6777
7005
|
connectionId: string;
|
|
@@ -6822,6 +7050,19 @@ declare const metaView: Field<({
|
|
|
6822
7050
|
} & {}) | ({
|
|
6823
7051
|
mode: "provider_managed";
|
|
6824
7052
|
} & {}) | undefined;
|
|
7053
|
+
channelGroup?: ({
|
|
7054
|
+
key: string;
|
|
7055
|
+
label: string;
|
|
7056
|
+
} & {}) | undefined;
|
|
7057
|
+
property?: ({
|
|
7058
|
+
key: string;
|
|
7059
|
+
label: string;
|
|
7060
|
+
} & {}) | undefined;
|
|
7061
|
+
tier?: ({
|
|
7062
|
+
label: string;
|
|
7063
|
+
} & {}) | undefined;
|
|
7064
|
+
primaryText?: string | undefined;
|
|
7065
|
+
convertersAcknowledged?: true | undefined;
|
|
6825
7066
|
};
|
|
6826
7067
|
account: {
|
|
6827
7068
|
id: string;
|
|
@@ -6864,7 +7105,9 @@ declare const metaView: Field<({
|
|
|
6864
7105
|
retentionDays: number;
|
|
6865
7106
|
exclusionRuleIds: string[];
|
|
6866
7107
|
consentPurpose: "ad_personalization";
|
|
6867
|
-
} & {
|
|
7108
|
+
} & {
|
|
7109
|
+
minDaysSinceVisit?: number | undefined;
|
|
7110
|
+
};
|
|
6868
7111
|
name: string;
|
|
6869
7112
|
resourceRuleRef: {
|
|
6870
7113
|
id: string;
|
|
@@ -6902,6 +7145,268 @@ declare const metaView: Field<({
|
|
|
6902
7145
|
} & {})>;
|
|
6903
7146
|
export type ResonanceMetaConfigurationView = Value<typeof metaView>;
|
|
6904
7147
|
export declare const parseResonanceMetaConfigurationView: (v: unknown) => ResonanceMetaConfigurationView;
|
|
7148
|
+
/** Public vocabulary shared with the API classifier; classification remains provider-owned. */
|
|
7149
|
+
export declare const RESONANCE_META_AUDIENCE_VERDICTS: readonly ['ready', 'too_small', 'blocked', 'unknown'];
|
|
7150
|
+
export type ResonanceMetaAudienceVerdict = typeof RESONANCE_META_AUDIENCE_VERDICTS[number];
|
|
7151
|
+
export declare const RESONANCE_META_AUDIENCE_REASONS: readonly ['meta_audience_status_unreadable', 'meta_audience_status_unrecognized', 'meta_audience_integrity_flagged', 'meta_audience_account_inactive', 'meta_audience_pixel_problem', 'meta_audience_error', 'meta_audience_out_of_date', 'meta_audience_too_small', 'meta_audience_not_usable', 'meta_audience_prefill_failed', 'meta_audience_filling', 'meta_audience_category_unknown', 'meta_url_audience_unverified', 'meta_core_setup_suspected', 'meta_audience_fill_mismatch', 'meta_core_setup_attestation_missing', 'meta_flight_too_short_after_wait', 'meta_terms_nondiscrimination_pending', 'meta_terms_custom_audience_unconfirmed', 'meta_terms_business_tools_pending', 'meta_special_category_age_must_be_provider_managed', 'meta_special_category_genders_not_allowed', 'meta_audience_name_sensitive'];
|
|
7152
|
+
export type ResonanceMetaAudienceReason = typeof RESONANCE_META_AUDIENCE_REASONS[number];
|
|
7153
|
+
declare const metaRetargetingReadiness: Field<{
|
|
7154
|
+
schemaVersion: 1;
|
|
7155
|
+
projectId: string;
|
|
7156
|
+
campaignId: string;
|
|
7157
|
+
channelId: string;
|
|
7158
|
+
site: string;
|
|
7159
|
+
campaignRevision: number;
|
|
7160
|
+
accountBindingId: string;
|
|
7161
|
+
configuration: ({
|
|
7162
|
+
schemaVersion: 1;
|
|
7163
|
+
kind: "unconfigured";
|
|
7164
|
+
projectId: string;
|
|
7165
|
+
campaignId: string;
|
|
7166
|
+
channelId: string;
|
|
7167
|
+
configurationRevision: 0;
|
|
7168
|
+
} & {}) | ({
|
|
7169
|
+
schemaVersion: 1;
|
|
7170
|
+
kind: "configured";
|
|
7171
|
+
projectId: string;
|
|
7172
|
+
campaignId: string;
|
|
7173
|
+
channelId: string;
|
|
7174
|
+
configurationRevision: number;
|
|
7175
|
+
snapshot: {
|
|
7176
|
+
schemaVersion: 1;
|
|
7177
|
+
projectId: string;
|
|
7178
|
+
campaignId: string;
|
|
7179
|
+
channelId: string;
|
|
7180
|
+
site: string;
|
|
7181
|
+
campaignRevision: number;
|
|
7182
|
+
reviewedDefinitionDigest: string;
|
|
7183
|
+
configurationRevision: number;
|
|
7184
|
+
saveOperationId: string;
|
|
7185
|
+
channel: {
|
|
7186
|
+
projectId: string;
|
|
7187
|
+
site: string;
|
|
7188
|
+
id: string;
|
|
7189
|
+
destinationId: string;
|
|
7190
|
+
creativeIds: string[];
|
|
7191
|
+
localCampaignKey: string;
|
|
7192
|
+
kind: "meta_retargeting";
|
|
7193
|
+
provider: "meta_ads";
|
|
7194
|
+
accountBindingId: string;
|
|
7195
|
+
capabilityRevision: string;
|
|
7196
|
+
allocation: {
|
|
7197
|
+
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";
|
|
7198
|
+
amountMicros: string;
|
|
7199
|
+
} & {};
|
|
7200
|
+
budgetMode: "daily" | "lifetime";
|
|
7201
|
+
audienceRuleRefs: ({
|
|
7202
|
+
projectId: string;
|
|
7203
|
+
site: string;
|
|
7204
|
+
id: string;
|
|
7205
|
+
revision: string;
|
|
7206
|
+
policyRevision: string;
|
|
7207
|
+
retentionDays: number;
|
|
7208
|
+
exclusionRuleIds: string[];
|
|
7209
|
+
consentPurpose: "ad_personalization";
|
|
7210
|
+
} & {
|
|
7211
|
+
minDaysSinceVisit?: number | undefined;
|
|
7212
|
+
})[];
|
|
7213
|
+
objective: "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC";
|
|
7214
|
+
pageRef: {
|
|
7215
|
+
connectionId: string;
|
|
7216
|
+
externalId: string;
|
|
7217
|
+
revision: string;
|
|
7218
|
+
} & {};
|
|
7219
|
+
instagramRef: ({
|
|
7220
|
+
connectionId: string;
|
|
7221
|
+
externalId: string;
|
|
7222
|
+
revision: string;
|
|
7223
|
+
} & {}) | null;
|
|
7224
|
+
datasetRef: {
|
|
7225
|
+
id: string;
|
|
7226
|
+
revision: string;
|
|
7227
|
+
} & {};
|
|
7228
|
+
conversionGoalRef: {
|
|
7229
|
+
projectId: string;
|
|
7230
|
+
site: string;
|
|
7231
|
+
module: "booking" | "broadcast" | "business_brain" | "commerce" | "crm" | "experiment" | "files" | "forms" | "funnel" | "outreach" | "prepared_plan" | "publication";
|
|
7232
|
+
id: string;
|
|
7233
|
+
revision: string;
|
|
7234
|
+
digest: string;
|
|
7235
|
+
} & {};
|
|
7236
|
+
optimization: "landing_page_views" | "lead" | "purchase";
|
|
7237
|
+
billing: "impressions";
|
|
7238
|
+
bid: ({
|
|
7239
|
+
strategy: "lowest_cost";
|
|
7240
|
+
} & {}) | ({
|
|
7241
|
+
strategy: "cost_cap";
|
|
7242
|
+
cap: {
|
|
7243
|
+
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";
|
|
7244
|
+
amountMicros: string;
|
|
7245
|
+
} & {};
|
|
7246
|
+
} & {});
|
|
7247
|
+
localAdSetKey: string;
|
|
7248
|
+
localAdKey: string;
|
|
7249
|
+
budgetOwner: "adset" | "campaign";
|
|
7250
|
+
specialCategories: ("employment" | "financial_products_services" | "housing")[];
|
|
7251
|
+
countryCodes: string[];
|
|
7252
|
+
placement: "automatic";
|
|
7253
|
+
} & {
|
|
7254
|
+
ageConstraint?: ({
|
|
7255
|
+
mode: "bounded";
|
|
7256
|
+
min: number;
|
|
7257
|
+
max: number;
|
|
7258
|
+
} & {}) | ({
|
|
7259
|
+
mode: "omitted";
|
|
7260
|
+
} & {}) | ({
|
|
7261
|
+
mode: "provider_managed";
|
|
7262
|
+
} & {}) | undefined;
|
|
7263
|
+
channelGroup?: ({
|
|
7264
|
+
key: string;
|
|
7265
|
+
label: string;
|
|
7266
|
+
} & {}) | undefined;
|
|
7267
|
+
property?: ({
|
|
7268
|
+
key: string;
|
|
7269
|
+
label: string;
|
|
7270
|
+
} & {}) | undefined;
|
|
7271
|
+
tier?: ({
|
|
7272
|
+
label: string;
|
|
7273
|
+
} & {}) | undefined;
|
|
7274
|
+
primaryText?: string | undefined;
|
|
7275
|
+
convertersAcknowledged?: true | undefined;
|
|
7276
|
+
};
|
|
7277
|
+
account: {
|
|
7278
|
+
id: string;
|
|
7279
|
+
externalId: string;
|
|
7280
|
+
name: string | null;
|
|
7281
|
+
} & {};
|
|
7282
|
+
datasetName: string | null;
|
|
7283
|
+
pageName: string | null;
|
|
7284
|
+
instagramName: string | null;
|
|
7285
|
+
measurementConfigRef: {
|
|
7286
|
+
configRevision: string;
|
|
7287
|
+
policyRevision: string;
|
|
7288
|
+
digest: string;
|
|
7289
|
+
} & {};
|
|
7290
|
+
matchingProfileRef: {
|
|
7291
|
+
id: string;
|
|
7292
|
+
revision: number;
|
|
7293
|
+
digest: string;
|
|
7294
|
+
} & {};
|
|
7295
|
+
rules: ({
|
|
7296
|
+
id: string;
|
|
7297
|
+
revision: string;
|
|
7298
|
+
resource: {
|
|
7299
|
+
projectId: string;
|
|
7300
|
+
site: string;
|
|
7301
|
+
type: "article" | "listing" | "page" | "product";
|
|
7302
|
+
id: string;
|
|
7303
|
+
revision: string;
|
|
7304
|
+
} & {};
|
|
7305
|
+
path: string;
|
|
7306
|
+
label: string;
|
|
7307
|
+
} & {})[];
|
|
7308
|
+
audiences: ({
|
|
7309
|
+
audienceRuleRef: {
|
|
7310
|
+
projectId: string;
|
|
7311
|
+
site: string;
|
|
7312
|
+
id: string;
|
|
7313
|
+
revision: string;
|
|
7314
|
+
policyRevision: string;
|
|
7315
|
+
retentionDays: number;
|
|
7316
|
+
exclusionRuleIds: string[];
|
|
7317
|
+
consentPurpose: "ad_personalization";
|
|
7318
|
+
} & {
|
|
7319
|
+
minDaysSinceVisit?: number | undefined;
|
|
7320
|
+
};
|
|
7321
|
+
name: string;
|
|
7322
|
+
resourceRuleRef: {
|
|
7323
|
+
id: string;
|
|
7324
|
+
revision: string;
|
|
7325
|
+
} & {};
|
|
7326
|
+
excludedResourceRuleRefs: ({
|
|
7327
|
+
id: string;
|
|
7328
|
+
revision: string;
|
|
7329
|
+
} & {})[];
|
|
7330
|
+
selection: ({
|
|
7331
|
+
mode: "existing";
|
|
7332
|
+
nativeAudienceRef: {
|
|
7333
|
+
externalId: string;
|
|
7334
|
+
revision: string;
|
|
7335
|
+
} & {};
|
|
7336
|
+
nativeAudienceName: string | null;
|
|
7337
|
+
} & {}) | ({
|
|
7338
|
+
mode: "admitted_setup";
|
|
7339
|
+
setup: {
|
|
7340
|
+
kind: "meta_website_audience_v1";
|
|
7341
|
+
localOutputKey: string;
|
|
7342
|
+
specDigest: string;
|
|
7343
|
+
} & {};
|
|
7344
|
+
} & {});
|
|
7345
|
+
} & {})[];
|
|
7346
|
+
configurationDigest: string;
|
|
7347
|
+
} & {};
|
|
7348
|
+
currentCampaignRevision: number;
|
|
7349
|
+
currentDefinitionDigest: string;
|
|
7350
|
+
observedAt: string;
|
|
7351
|
+
expiresAt: string | null;
|
|
7352
|
+
readyForReview: boolean;
|
|
7353
|
+
reasonCodes: string[];
|
|
7354
|
+
pendingRequirements: string[];
|
|
7355
|
+
} & {});
|
|
7356
|
+
audiences: ({
|
|
7357
|
+
audienceRuleRef: {
|
|
7358
|
+
projectId: string;
|
|
7359
|
+
site: string;
|
|
7360
|
+
id: string;
|
|
7361
|
+
revision: string;
|
|
7362
|
+
policyRevision: string;
|
|
7363
|
+
retentionDays: number;
|
|
7364
|
+
exclusionRuleIds: string[];
|
|
7365
|
+
consentPurpose: "ad_personalization";
|
|
7366
|
+
} & {
|
|
7367
|
+
minDaysSinceVisit?: number | undefined;
|
|
7368
|
+
};
|
|
7369
|
+
name: string;
|
|
7370
|
+
includedPage: {
|
|
7371
|
+
resourceRuleRef: {
|
|
7372
|
+
id: string;
|
|
7373
|
+
revision: string;
|
|
7374
|
+
} & {};
|
|
7375
|
+
path: string;
|
|
7376
|
+
label: string | null;
|
|
7377
|
+
} & {};
|
|
7378
|
+
excludedPages: ({
|
|
7379
|
+
resourceRuleRef: {
|
|
7380
|
+
id: string;
|
|
7381
|
+
revision: string;
|
|
7382
|
+
} & {};
|
|
7383
|
+
path: string;
|
|
7384
|
+
label: string | null;
|
|
7385
|
+
} & {})[];
|
|
7386
|
+
nativeAudienceId: string | null;
|
|
7387
|
+
check: ({
|
|
7388
|
+
state: "not_checked";
|
|
7389
|
+
reasonCode: "configuration_unavailable" | "native_mapping_unavailable";
|
|
7390
|
+
} & {}) | ({
|
|
7391
|
+
state: "observed";
|
|
7392
|
+
mappingSource: "current_materialized_audience" | "selected_external_audience";
|
|
7393
|
+
verdict: "blocked" | "ready" | "too_small" | "unknown";
|
|
7394
|
+
reasonCodes: ("meta_audience_account_inactive" | "meta_audience_category_unknown" | "meta_audience_error" | "meta_audience_fill_mismatch" | "meta_audience_filling" | "meta_audience_integrity_flagged" | "meta_audience_name_sensitive" | "meta_audience_not_usable" | "meta_audience_out_of_date" | "meta_audience_pixel_problem" | "meta_audience_prefill_failed" | "meta_audience_status_unreadable" | "meta_audience_status_unrecognized" | "meta_audience_too_small" | "meta_core_setup_attestation_missing" | "meta_core_setup_suspected" | "meta_flight_too_short_after_wait" | "meta_special_category_age_must_be_provider_managed" | "meta_special_category_genders_not_allowed" | "meta_terms_business_tools_pending" | "meta_terms_custom_audience_unconfirmed" | "meta_terms_nondiscrimination_pending" | "meta_url_audience_unverified")[];
|
|
7395
|
+
size: ({
|
|
7396
|
+
lower: number;
|
|
7397
|
+
upper: number;
|
|
7398
|
+
} & {}) | null;
|
|
7399
|
+
observedAt: string;
|
|
7400
|
+
expiresAt: string | null;
|
|
7401
|
+
sizeObservedAt: null;
|
|
7402
|
+
sizeExpiresAt: null;
|
|
7403
|
+
} & {});
|
|
7404
|
+
} & {})[];
|
|
7405
|
+
} & {}>;
|
|
7406
|
+
export type ResonanceMetaRetargetingReadiness = Value<typeof metaRetargetingReadiness>;
|
|
7407
|
+
/** Public shape/scope only; never provider freshness, native authority, or launch permission. */
|
|
7408
|
+
export declare const parseResonanceMetaRetargetingReadiness: (v: unknown) => ResonanceMetaRetargetingReadiness;
|
|
7409
|
+
export declare const RESONANCE_META_RETARGETING_READINESS_JSON_SCHEMA: import("./wire-schema").JsonSchema;
|
|
6905
7410
|
declare const metaSaveResponse: Field<{
|
|
6906
7411
|
schemaVersion: 1;
|
|
6907
7412
|
snapshot: {
|
|
@@ -6939,7 +7444,9 @@ declare const metaSaveResponse: Field<{
|
|
|
6939
7444
|
retentionDays: number;
|
|
6940
7445
|
exclusionRuleIds: string[];
|
|
6941
7446
|
consentPurpose: "ad_personalization";
|
|
6942
|
-
} & {
|
|
7447
|
+
} & {
|
|
7448
|
+
minDaysSinceVisit?: number | undefined;
|
|
7449
|
+
})[];
|
|
6943
7450
|
objective: "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC";
|
|
6944
7451
|
pageRef: {
|
|
6945
7452
|
connectionId: string;
|
|
@@ -6990,6 +7497,19 @@ declare const metaSaveResponse: Field<{
|
|
|
6990
7497
|
} & {}) | ({
|
|
6991
7498
|
mode: "provider_managed";
|
|
6992
7499
|
} & {}) | undefined;
|
|
7500
|
+
channelGroup?: ({
|
|
7501
|
+
key: string;
|
|
7502
|
+
label: string;
|
|
7503
|
+
} & {}) | undefined;
|
|
7504
|
+
property?: ({
|
|
7505
|
+
key: string;
|
|
7506
|
+
label: string;
|
|
7507
|
+
} & {}) | undefined;
|
|
7508
|
+
tier?: ({
|
|
7509
|
+
label: string;
|
|
7510
|
+
} & {}) | undefined;
|
|
7511
|
+
primaryText?: string | undefined;
|
|
7512
|
+
convertersAcknowledged?: true | undefined;
|
|
6993
7513
|
};
|
|
6994
7514
|
account: {
|
|
6995
7515
|
id: string;
|
|
@@ -7032,7 +7552,9 @@ declare const metaSaveResponse: Field<{
|
|
|
7032
7552
|
retentionDays: number;
|
|
7033
7553
|
exclusionRuleIds: string[];
|
|
7034
7554
|
consentPurpose: "ad_personalization";
|
|
7035
|
-
} & {
|
|
7555
|
+
} & {
|
|
7556
|
+
minDaysSinceVisit?: number | undefined;
|
|
7557
|
+
};
|
|
7036
7558
|
name: string;
|
|
7037
7559
|
resourceRuleRef: {
|
|
7038
7560
|
id: string;
|
|
@@ -7115,7 +7637,9 @@ export declare function projectResonanceMetaConfiguration(v: unknown, currentMet
|
|
|
7115
7637
|
retentionDays: number;
|
|
7116
7638
|
exclusionRuleIds: string[];
|
|
7117
7639
|
consentPurpose: "ad_personalization";
|
|
7118
|
-
} & {
|
|
7640
|
+
} & {
|
|
7641
|
+
minDaysSinceVisit?: number | undefined;
|
|
7642
|
+
})[];
|
|
7119
7643
|
objective: "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC";
|
|
7120
7644
|
pageRef: {
|
|
7121
7645
|
connectionId: string;
|
|
@@ -7166,6 +7690,19 @@ export declare function projectResonanceMetaConfiguration(v: unknown, currentMet
|
|
|
7166
7690
|
} & {}) | ({
|
|
7167
7691
|
mode: "provider_managed";
|
|
7168
7692
|
} & {}) | undefined;
|
|
7693
|
+
channelGroup?: ({
|
|
7694
|
+
key: string;
|
|
7695
|
+
label: string;
|
|
7696
|
+
} & {}) | undefined;
|
|
7697
|
+
property?: ({
|
|
7698
|
+
key: string;
|
|
7699
|
+
label: string;
|
|
7700
|
+
} & {}) | undefined;
|
|
7701
|
+
tier?: ({
|
|
7702
|
+
label: string;
|
|
7703
|
+
} & {}) | undefined;
|
|
7704
|
+
primaryText?: string | undefined;
|
|
7705
|
+
convertersAcknowledged?: true | undefined;
|
|
7169
7706
|
};
|
|
7170
7707
|
account: {
|
|
7171
7708
|
id: string;
|
|
@@ -7208,7 +7745,9 @@ export declare function projectResonanceMetaConfiguration(v: unknown, currentMet
|
|
|
7208
7745
|
retentionDays: number;
|
|
7209
7746
|
exclusionRuleIds: string[];
|
|
7210
7747
|
consentPurpose: "ad_personalization";
|
|
7211
|
-
} & {
|
|
7748
|
+
} & {
|
|
7749
|
+
minDaysSinceVisit?: number | undefined;
|
|
7750
|
+
};
|
|
7212
7751
|
name: string;
|
|
7213
7752
|
resourceRuleRef: {
|
|
7214
7753
|
id: string;
|
|
@@ -7279,7 +7818,9 @@ export declare function projectResonanceMetaConfiguration(v: unknown, currentMet
|
|
|
7279
7818
|
retentionDays: number;
|
|
7280
7819
|
exclusionRuleIds: string[];
|
|
7281
7820
|
consentPurpose: "ad_personalization";
|
|
7282
|
-
} & {
|
|
7821
|
+
} & {
|
|
7822
|
+
minDaysSinceVisit?: number | undefined;
|
|
7823
|
+
})[];
|
|
7283
7824
|
objective: "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC";
|
|
7284
7825
|
pageRef: {
|
|
7285
7826
|
connectionId: string;
|
|
@@ -7330,6 +7871,19 @@ export declare function projectResonanceMetaConfiguration(v: unknown, currentMet
|
|
|
7330
7871
|
} & {}) | ({
|
|
7331
7872
|
mode: "provider_managed";
|
|
7332
7873
|
} & {}) | undefined;
|
|
7874
|
+
channelGroup?: ({
|
|
7875
|
+
key: string;
|
|
7876
|
+
label: string;
|
|
7877
|
+
} & {}) | undefined;
|
|
7878
|
+
property?: ({
|
|
7879
|
+
key: string;
|
|
7880
|
+
label: string;
|
|
7881
|
+
} & {}) | undefined;
|
|
7882
|
+
tier?: ({
|
|
7883
|
+
label: string;
|
|
7884
|
+
} & {}) | undefined;
|
|
7885
|
+
primaryText?: string | undefined;
|
|
7886
|
+
convertersAcknowledged?: true | undefined;
|
|
7333
7887
|
};
|
|
7334
7888
|
account: {
|
|
7335
7889
|
id: string;
|
|
@@ -7372,7 +7926,9 @@ export declare function projectResonanceMetaConfiguration(v: unknown, currentMet
|
|
|
7372
7926
|
retentionDays: number;
|
|
7373
7927
|
exclusionRuleIds: string[];
|
|
7374
7928
|
consentPurpose: "ad_personalization";
|
|
7375
|
-
} & {
|
|
7929
|
+
} & {
|
|
7930
|
+
minDaysSinceVisit?: number | undefined;
|
|
7931
|
+
};
|
|
7376
7932
|
name: string;
|
|
7377
7933
|
resourceRuleRef: {
|
|
7378
7934
|
id: string;
|
|
@@ -7423,7 +7979,14 @@ declare const mandateDraftRequest: Field<{
|
|
|
7423
7979
|
providerReporting?: ({
|
|
7424
7980
|
agentContactId: string;
|
|
7425
7981
|
channelIds: string[];
|
|
7426
|
-
} & {
|
|
7982
|
+
} & {
|
|
7983
|
+
metaQueries?: ({
|
|
7984
|
+
channelId: string;
|
|
7985
|
+
attributionWindow: "1d_click" | "1d_view" | "7d_click";
|
|
7986
|
+
actionReportTime: "conversion";
|
|
7987
|
+
basis: "explicit_query";
|
|
7988
|
+
} & {})[] | undefined;
|
|
7989
|
+
}) | undefined;
|
|
7427
7990
|
}>;
|
|
7428
7991
|
export type ResonanceMandateDraftRequest = Value<typeof mandateDraftRequest>;
|
|
7429
7992
|
export declare const parseResonanceMandateDraftRequest: (v: unknown) => ResonanceMandateDraftRequest;
|
|
@@ -7498,7 +8061,9 @@ declare const feedReview: Field<{
|
|
|
7498
8061
|
retentionDays: number;
|
|
7499
8062
|
exclusionRuleIds: string[];
|
|
7500
8063
|
consentPurpose: "ad_personalization";
|
|
7501
|
-
} & {
|
|
8064
|
+
} & {
|
|
8065
|
+
minDaysSinceVisit?: number | undefined;
|
|
8066
|
+
})[];
|
|
7502
8067
|
goal: {
|
|
7503
8068
|
source: {
|
|
7504
8069
|
projectId: string;
|
|
@@ -7568,7 +8133,14 @@ declare const feedReview: Field<{
|
|
|
7568
8133
|
agentContactId: string;
|
|
7569
8134
|
principalContactId: string;
|
|
7570
8135
|
channelIds: string[];
|
|
7571
|
-
} & {
|
|
8136
|
+
} & {
|
|
8137
|
+
metaQueries?: ({
|
|
8138
|
+
channelId: string;
|
|
8139
|
+
attributionWindow: "1d_click" | "1d_view" | "7d_click";
|
|
8140
|
+
actionReportTime: "conversion";
|
|
8141
|
+
basis: "explicit_query";
|
|
8142
|
+
} & {})[] | undefined;
|
|
8143
|
+
}) | undefined;
|
|
7572
8144
|
};
|
|
7573
8145
|
} & {};
|
|
7574
8146
|
mandateRef: {
|
|
@@ -7614,7 +8186,9 @@ declare const feedReview: Field<{
|
|
|
7614
8186
|
retentionDays: number;
|
|
7615
8187
|
exclusionRuleIds: string[];
|
|
7616
8188
|
consentPurpose: "ad_personalization";
|
|
7617
|
-
} & {
|
|
8189
|
+
} & {
|
|
8190
|
+
minDaysSinceVisit?: number | undefined;
|
|
8191
|
+
})[];
|
|
7618
8192
|
objective: "OUTCOME_LEADS" | "OUTCOME_SALES" | "OUTCOME_TRAFFIC";
|
|
7619
8193
|
pageRef: {
|
|
7620
8194
|
connectionId: string;
|
|
@@ -7665,6 +8239,19 @@ declare const feedReview: Field<{
|
|
|
7665
8239
|
} & {}) | ({
|
|
7666
8240
|
mode: "provider_managed";
|
|
7667
8241
|
} & {}) | undefined;
|
|
8242
|
+
channelGroup?: ({
|
|
8243
|
+
key: string;
|
|
8244
|
+
label: string;
|
|
8245
|
+
} & {}) | undefined;
|
|
8246
|
+
property?: ({
|
|
8247
|
+
key: string;
|
|
8248
|
+
label: string;
|
|
8249
|
+
} & {}) | undefined;
|
|
8250
|
+
tier?: ({
|
|
8251
|
+
label: string;
|
|
8252
|
+
} & {}) | undefined;
|
|
8253
|
+
primaryText?: string | undefined;
|
|
8254
|
+
convertersAcknowledged?: true | undefined;
|
|
7668
8255
|
};
|
|
7669
8256
|
account: {
|
|
7670
8257
|
id: string;
|
|
@@ -7707,7 +8294,9 @@ declare const feedReview: Field<{
|
|
|
7707
8294
|
retentionDays: number;
|
|
7708
8295
|
exclusionRuleIds: string[];
|
|
7709
8296
|
consentPurpose: "ad_personalization";
|
|
7710
|
-
} & {
|
|
8297
|
+
} & {
|
|
8298
|
+
minDaysSinceVisit?: number | undefined;
|
|
8299
|
+
};
|
|
7711
8300
|
name: string;
|
|
7712
8301
|
resourceRuleRef: {
|
|
7713
8302
|
id: string;
|
|
@@ -7752,10 +8341,10 @@ declare const publicObservationMetric: Field<({
|
|
|
7752
8341
|
projectId: string;
|
|
7753
8342
|
site: string;
|
|
7754
8343
|
campaignId: string;
|
|
7755
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
8344
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
7756
8345
|
sourceRef: string;
|
|
7757
8346
|
goalRevision: string | null;
|
|
7758
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
8347
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
7759
8348
|
windowStart: string;
|
|
7760
8349
|
windowEnd: string;
|
|
7761
8350
|
timeZone: string;
|
|
@@ -7797,10 +8386,10 @@ declare const publicObservationMetric: Field<({
|
|
|
7797
8386
|
projectId: string;
|
|
7798
8387
|
site: string;
|
|
7799
8388
|
campaignId: string;
|
|
7800
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
8389
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
7801
8390
|
sourceRef: string;
|
|
7802
8391
|
goalRevision: string | null;
|
|
7803
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
8392
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
7804
8393
|
windowStart: string;
|
|
7805
8394
|
windowEnd: string;
|
|
7806
8395
|
timeZone: string;
|
|
@@ -7925,10 +8514,10 @@ declare const observationsPage: Field<{
|
|
|
7925
8514
|
projectId: string;
|
|
7926
8515
|
site: string;
|
|
7927
8516
|
campaignId: string;
|
|
7928
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
8517
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
7929
8518
|
sourceRef: string;
|
|
7930
8519
|
goalRevision: string | null;
|
|
7931
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
8520
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
7932
8521
|
windowStart: string;
|
|
7933
8522
|
windowEnd: string;
|
|
7934
8523
|
timeZone: string;
|
|
@@ -7970,10 +8559,10 @@ declare const observationsPage: Field<{
|
|
|
7970
8559
|
projectId: string;
|
|
7971
8560
|
site: string;
|
|
7972
8561
|
campaignId: string;
|
|
7973
|
-
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "revenue" | "spend";
|
|
8562
|
+
name: "accepted_goals" | "clicks" | "conversion_rate" | "impressions" | "qualified_goals" | "reach" | "results" | "revenue" | "spend";
|
|
7974
8563
|
sourceRef: string;
|
|
7975
8564
|
goalRevision: string | null;
|
|
7976
|
-
countingUnit: "net_order" | "provider_aggregate" | "unique_qualified_contact" | "unique_source";
|
|
8565
|
+
countingUnit: "net_order" | "provider_aggregate" | "provider_unique_reach" | "unique_qualified_contact" | "unique_source";
|
|
7977
8566
|
windowStart: string;
|
|
7978
8567
|
windowEnd: string;
|
|
7979
8568
|
timeZone: string;
|
|
@@ -8052,3 +8641,135 @@ export declare function parseResonanceObservationsPage(v: unknown): ResonanceObs
|
|
|
8052
8641
|
export declare const RESONANCE_PUBLIC_OBSERVATION_METRIC_JSON_SCHEMA: import("./wire-schema").JsonSchema;
|
|
8053
8642
|
export declare const RESONANCE_OBSERVATION_SUPPORT_JSON_SCHEMA: import("./wire-schema").JsonSchema;
|
|
8054
8643
|
export declare const RESONANCE_OBSERVATIONS_PAGE_JSON_SCHEMA: import("./wire-schema").JsonSchema;
|
|
8644
|
+
/** Meta documents 180 days for a website audience's create parameter. Single source: the API and the editor import this, never a local copy. */
|
|
8645
|
+
export declare const META_WEBSITE_AUDIENCE_MAX_RETENTION_DAYS = 180;
|
|
8646
|
+
/** Meta allows at most ten rules per audience (inclusion, each exclusion, and a recency band). */
|
|
8647
|
+
export declare const META_AUDIENCE_RULE_LIMIT = 10;
|
|
8648
|
+
/** 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. */
|
|
8649
|
+
export declare const META_SAC_CUSTOM_AUDIENCE_EXCLUSION_VERIFIED: boolean;
|
|
8650
|
+
/** The call-to-action enums the Meta compiler accepts; the editor, the compiler and imports validate against this one list. */
|
|
8651
|
+
export declare const META_CALL_TO_ACTIONS: readonly ['LEARN_MORE', 'SIGN_UP', 'SHOP_NOW', 'APPLY_NOW', 'BOOK_TRAVEL', 'CONTACT_US', 'GET_QUOTE'];
|
|
8652
|
+
export type MetaCallToAction = typeof META_CALL_TO_ACTIONS[number];
|
|
8653
|
+
/** A property group holds one channel per property (and per tier). Twenty leaves room to add properties after launch. */
|
|
8654
|
+
export declare const RESONANCE_MAX_CHANNELS_PER_GROUP = 20;
|
|
8655
|
+
/** Provider metrics a report may carry. Reach is unique people, so it has its own counting unit and is never summed across channels. */
|
|
8656
|
+
export declare const RESONANCE_PROVIDER_METRIC_NAMES: readonly ['spend', 'impressions', 'clicks', 'reach', 'results'];
|
|
8657
|
+
type MetaChannelPlan = Extract<ResonanceChannelPlan, {
|
|
8658
|
+
kind: 'meta_retargeting';
|
|
8659
|
+
}>;
|
|
8660
|
+
/**
|
|
8661
|
+
* One audience's recency band and rule budget. `minDaysSinceVisit` keeps only people whose latest visit is at least that many days old,
|
|
8662
|
+
* so it must be shorter than the retention window. Meta caps the window and the rules; Google has no recency band.
|
|
8663
|
+
*/
|
|
8664
|
+
export declare function checkAudienceBand(ref: Pick<ResonanceAudienceRuleRef, 'retentionDays' | 'exclusionRuleIds' | 'minDaysSinceVisit'>, provider?: 'meta_ads' | 'google_ads', at?: string): void;
|
|
8665
|
+
/**
|
|
8666
|
+
* Channels that share a `channelGroup.key` share one dataset, account, Page and targeting profile; each property has its own destination;
|
|
8667
|
+
* tiers of one property do not overlap. Channels outside any group are not touched.
|
|
8668
|
+
*/
|
|
8669
|
+
export declare function checkChannelGroups(channels: readonly ResonanceChannelPlan[]): void;
|
|
8670
|
+
/**
|
|
8671
|
+
* 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.
|
|
8672
|
+
* It is a helper, not an authority: a person edits the result and the reviewed definition is what counts.
|
|
8673
|
+
*/
|
|
8674
|
+
export declare function splitBudget(total: Money, weights: readonly number[], quantumMicros: string): Money[];
|
|
8675
|
+
/**
|
|
8676
|
+
* Suggested shares, in basis points that add up to 10 000, proportional to each property's unique visitors with a floor and a ceiling.
|
|
8677
|
+
* A SUGGESTION only: equal weights are the default and a person approves any other split.
|
|
8678
|
+
*/
|
|
8679
|
+
export declare function suggestPropertyWeights(visitors: readonly number[], bounds?: {
|
|
8680
|
+
floorBasisPoints?: number;
|
|
8681
|
+
ceilingBasisPoints?: number;
|
|
8682
|
+
}): number[];
|
|
8683
|
+
export interface ResonancePropertyAddition {
|
|
8684
|
+
key: string;
|
|
8685
|
+
label: string;
|
|
8686
|
+
/** The destination for the property's page, created natively before expansion. */
|
|
8687
|
+
destinationId: string;
|
|
8688
|
+
/** The property's audience version, created natively before expansion. */
|
|
8689
|
+
audienceRuleRefs: ResonanceAudienceRuleRef[];
|
|
8690
|
+
/** Optional split weight; default is equal. */
|
|
8691
|
+
weight?: number;
|
|
8692
|
+
}
|
|
8693
|
+
/** A new channel is complete in every field except the creative, which a person supplies. */
|
|
8694
|
+
export type ResonancePropertyChannelProposal = Omit<MetaChannelPlan, 'creativeIds'> & {
|
|
8695
|
+
creativeIds: [];
|
|
8696
|
+
};
|
|
8697
|
+
export interface ResonancePropertyExpansion {
|
|
8698
|
+
channels: ResonancePropertyChannelProposal[];
|
|
8699
|
+
/** The whole group's allocations after the split: existing channels first, then the new ones. */
|
|
8700
|
+
allocations: {
|
|
8701
|
+
channelId: string;
|
|
8702
|
+
allocation: Money;
|
|
8703
|
+
}[];
|
|
8704
|
+
blockingReasons: string[];
|
|
8705
|
+
}
|
|
8706
|
+
/**
|
|
8707
|
+
* Adds property channels to a group. Pure: it builds each new channel from the group's first channel (the template), names it
|
|
8708
|
+
* `property_creative_required:<key>` until a person supplies a creative, and re-splits the group's existing total. It never sets a
|
|
8709
|
+
* creative, a converter acknowledgement or an approval, and a property already in the group is skipped, so expanding twice is a no-op.
|
|
8710
|
+
* The measurement rule, audience version and destination are native objects the API creates first and passes in.
|
|
8711
|
+
*/
|
|
8712
|
+
export declare function expandPropertyChannels(definition: ResonanceCampaignDefinition, groupKey: string, additions: readonly ResonancePropertyAddition[], options: {
|
|
8713
|
+
quantumMicros: string;
|
|
8714
|
+
weights?: Readonly<Record<string, number>>;
|
|
8715
|
+
}): ResonancePropertyExpansion;
|
|
8716
|
+
/**
|
|
8717
|
+
* Whether a targeting-level custom-audience exclusion, or an in-rule exclusion or band, may be used on a Meta channel.
|
|
8718
|
+
* Fail closed: under a special category the targeting-level form stays refused until META_SAC_CUSTOM_AUDIENCE_EXCLUSION_VERIFIED is true,
|
|
8719
|
+
* and the in-rule form is allowed only when Meta's own eligibility readback for that audience says so.
|
|
8720
|
+
*/
|
|
8721
|
+
export declare function metaExclusionPolicy(channel: Pick<MetaChannelPlan, 'specialCategories'>, use: {
|
|
8722
|
+
targetingLevel: boolean;
|
|
8723
|
+
inRule: boolean;
|
|
8724
|
+
}): {
|
|
8725
|
+
allowed: boolean;
|
|
8726
|
+
reason: 'meta_exclusion_targeting_blocked_special_category' | null;
|
|
8727
|
+
requiresEligibilityReadback: boolean;
|
|
8728
|
+
};
|
|
8729
|
+
type RatioInput = {
|
|
8730
|
+
name: string;
|
|
8731
|
+
source: string;
|
|
8732
|
+
state: string;
|
|
8733
|
+
windowStart: string;
|
|
8734
|
+
windowEnd: string;
|
|
8735
|
+
observationId?: string;
|
|
8736
|
+
channelId?: string;
|
|
8737
|
+
value: {
|
|
8738
|
+
kind: 'count';
|
|
8739
|
+
count: string;
|
|
8740
|
+
} | {
|
|
8741
|
+
kind: 'money';
|
|
8742
|
+
money: Money;
|
|
8743
|
+
} | {
|
|
8744
|
+
kind: 'ratio';
|
|
8745
|
+
numerator: string;
|
|
8746
|
+
denominator: string;
|
|
8747
|
+
} | null;
|
|
8748
|
+
};
|
|
8749
|
+
export type ProviderRatio = {
|
|
8750
|
+
state: 'observed';
|
|
8751
|
+
value: {
|
|
8752
|
+
kind: 'ratio';
|
|
8753
|
+
numerator: string;
|
|
8754
|
+
denominator: string;
|
|
8755
|
+
};
|
|
8756
|
+
} | {
|
|
8757
|
+
state: 'unknown';
|
|
8758
|
+
reasonCode: string;
|
|
8759
|
+
};
|
|
8760
|
+
export type ProviderCostPerResult = {
|
|
8761
|
+
state: 'observed';
|
|
8762
|
+
money: Money;
|
|
8763
|
+
} | {
|
|
8764
|
+
state: 'unknown';
|
|
8765
|
+
reasonCode: string;
|
|
8766
|
+
};
|
|
8767
|
+
/**
|
|
8768
|
+
* 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.
|
|
8769
|
+
* Inputs must be provider-sourced, observed, and share one observation, channel and window; anything else is unknown, never zero and never a guess.
|
|
8770
|
+
*/
|
|
8771
|
+
export declare function deriveProviderRatios(items: readonly RatioInput[]): {
|
|
8772
|
+
frequency: ProviderRatio;
|
|
8773
|
+
costPerResult: ProviderCostPerResult;
|
|
8774
|
+
reasonCodes: string[];
|
|
8775
|
+
};
|