Skip to content

PLAT-287894: Add uncapped paid-media calculated-rate fields; deprecate capped originals #2202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ejsuncy wants to merge 1 commit into
base: master
Choose a base branch
from
Open

PLAT-287894: Add uncapped paid-media calculated-rate fields; deprecate capped originals #2202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions components/fieldgroups/paid-media/core-paid-media-attribution-metrics.example.1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"xdm:enabled": true,
"xdm:crossDeviceConversions": 425,
"xdm:crossDeviceConversionRate": 0.34,
"xdm:crossDeviceConversionRateUncapped": 1.27,
"xdm:deviceSwitchRate": 0.42,
"xdm:averageDevicesPerPath": 1.8,
"xdm:devicePathBreakdown": {
Expand Down
9 changes: 9 additions & 0 deletions components/fieldgroups/paid-media/core-paid-media-attribution-metrics.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,18 @@
"xdm:crossDeviceConversionRate": {
"type": "number",
"title": "Cross Device Conversion Rate",
"description": "(DEPRECATED — use xdm:crossDeviceConversionRateUncapped instead. Capped at 1.0 and cannot represent rates >1.0 where conversions outnumber the interactions used as the denominator.) Cross-device conversion rate.",
"meta:status": "deprecated",
"minimum": 0,
"maximum": 1
},
"xdm:crossDeviceConversionRateUncapped": {
"type": "number",
"title": "Cross Device Conversion Rate (Uncapped)",
"description": "Cross-device conversion rate. Can exceed 1.0 because conversions can outnumber the interactions used as the denominator.",
"meta:status": "stable",
"minimum": 0
},
"xdm:deviceSwitchRate": {
"type": "number",
"title": "Device Switch Rate",
Expand Down
1 change: 1 addition & 0 deletions components/fieldgroups/paid-media/core-paid-media-conversion-metrics.example.1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
"xdm:landingPageView": 2200
},
"xdm:conversionRate": 0.0352,
"xdm:conversionRateUncapped": 1.18,
"xdm:costPerAction": 10.23,
"xdm:conversionLag": 8.3,
"xdm:conversionPath": {
Expand Down
10 changes: 9 additions & 1 deletion components/fieldgroups/paid-media/core-paid-media-conversion-metrics.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,10 +112,18 @@
"xdm:conversionRate": {
"type": "number",
"title": "Conversion Rate",
"description": "Overall conversion rate",
"description": "(DEPRECATED — use xdm:conversionRateUncapped instead. Capped at 1.0 and cannot represent rates >1.0 where all-conversions counts include multiple conversions per click.) Overall conversion rate (conversions/clicks).",
"meta:status": "deprecated",
"minimum": 0,
"maximum": 1
},
"xdm:conversionRateUncapped": {
"type": "number",
"title": "Conversion Rate (Uncapped)",
"description": "Overall conversion rate (conversions/clicks). Can exceed 1.0 because all-conversions counts can include multiple conversions per click.",
"meta:status": "stable",
"minimum": 0
},
"xdm:costPerAction": {
"type": "number",
"title": "Cost Per Action",
Expand Down
2 changes: 2 additions & 0 deletions components/fieldgroups/paid-media/core-paid-media-cost-metrics.example.1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,11 @@
"xdm:budgetSpent": 18000,
"xdm:budgetRemaining": 42000,
"xdm:budgetUtilization": 0.3,
"xdm:budgetUtilizationUncapped": 1.05,
"xdm:dailyBudget": 2000,
"xdm:dailySpend": 600,
"xdm:dailyBudgetUtilization": 0.3,
"xdm:dailyBudgetUtilizationUncapped": 1.12,
"xdm:pacingStatus": "on_track",
"xdm:projectedSpend": 60000,
"xdm:budgetOverrun": 0,
Expand Down
18 changes: 18 additions & 0 deletions components/fieldgroups/paid-media/core-paid-media-cost-metrics.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,9 +216,18 @@
"xdm:budgetUtilization": {
"type": "number",
"title": "Budget Utilization",
"description": "(DEPRECATED — use xdm:budgetUtilizationUncapped instead. Capped at 1.0 and cannot represent over-spend where spend exceeds the allocated budget.) Ratio of budget spent to budget allocated.",
"meta:status": "deprecated",
"minimum": 0,
"maximum": 1
},
"xdm:budgetUtilizationUncapped": {
"type": "number",
"title": "Budget Utilization (Uncapped)",
"description": "Ratio of budget spent to budget allocated. Can exceed 1.0 when spend overruns the allocated budget.",
"meta:status": "stable",
"minimum": 0
},
"xdm:dailyBudget": {
"type": "number",
"title": "Daily Budget",
Expand All @@ -232,9 +241,18 @@
"xdm:dailyBudgetUtilization": {
"type": "number",
"title": "Daily Budget Utilization",
"description": "(DEPRECATED — use xdm:dailyBudgetUtilizationUncapped instead. Capped at 1.0 and cannot represent over-spend where daily spend exceeds the daily budget.) Ratio of daily spend to daily budget.",
"meta:status": "deprecated",
"minimum": 0,
"maximum": 1
},
"xdm:dailyBudgetUtilizationUncapped": {
"type": "number",
"title": "Daily Budget Utilization (Uncapped)",
"description": "Ratio of daily spend to daily budget. Can exceed 1.0 when daily spend overruns the daily budget.",
"meta:status": "stable",
"minimum": 0
},
"xdm:pacingStatus": {
"type": "string",
"title": "Pacing Status",
Expand Down
2 changes: 2 additions & 0 deletions components/fieldgroups/paid-media/core-paid-media-metrics.example.1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"xdm:reach": 26000,
"xdm:frequency": 1.92,
"xdm:ctr": 0.05,
"xdm:ctrUncapped": 0.05,
"xdm:cpm": 36.0,
"xdm:cpc": 7.2,
"xdm:conversions": 1250,
Expand All @@ -17,6 +18,7 @@
"xdm:videoCompletions": 5785,
"xdm:engagements": 12345,
"xdm:engagementRate": 0.247,
"xdm:engagementRateUncapped": 1.34,
"xdm:additionalMetrics": [
{
"xdm:metricName": "outbound_clicks",
Expand Down
20 changes: 18 additions & 2 deletions components/fieldgroups/paid-media/core-paid-media-metrics.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,18 @@
"xdm:ctr": {
"type": "number",
"title": "Click-Through Rate",
"description": "Click-through rate (clicks/impressions)",
"description": "(DEPRECATED — use xdm:ctrUncapped instead. Capped at 1.0 and cannot represent rates >1.0 reported by networks that count more tracked clicks than impressions.) Click-through rate (clicks/impressions).",
"meta:status": "deprecated",
"minimum": 0,
"maximum": 1
},
"xdm:ctrUncapped": {
"type": "number",
"title": "Click-Through Rate (Uncapped)",
"description": "Click-through rate (clicks/impressions). Can exceed 1.0 because networks may report more tracked clicks than impressions or inflate reported counts.",
"meta:status": "stable",
"minimum": 0
},
"xdm:cpm": {
"type": "number",
"title": "Cost Per Mille",
Expand Down Expand Up @@ -118,10 +126,18 @@
"xdm:engagementRate": {
"type": "number",
"title": "Engagement Rate",
"description": "Engagement rate (engagements/impressions)",
"description": "(DEPRECATED — use xdm:engagementRateUncapped instead. Capped at 1.0 and cannot represent rates >1.0 where a single impression yields multiple engagements.) Engagement rate (engagements/impressions).",
"meta:status": "deprecated",
"minimum": 0,
"maximum": 1
},
"xdm:engagementRateUncapped": {
"type": "number",
"title": "Engagement Rate (Uncapped)",
"description": "Engagement rate (engagements/impressions). Can exceed 1.0 because a single impression can yield multiple engagements (e.g. like, share, and comment).",
"meta:status": "stable",
"minimum": 0
},
"xdm:additionalMetrics": {
"title": "Additional Metrics",
"description": "Platform-specific or custom metrics not defined in core schema. Allows ingestion of arbitrary metrics from paid media network APIs without requiring schema changes. For conversion attribution window breakdown (Meta Insights API), use metricName like {actionType}_1d_click, {actionType}_7d_click, {actionType}_1d_view (e.g. purchases_1d_click, leads_7d_click) and metricType 'attribution'.",
Expand Down
2 changes: 2 additions & 0 deletions components/fieldgroups/paid-media/core-paid-media-quality-metrics.example.1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@
"xdm:overallQualityScore": 8.67,
"xdm:negativeActions": 25,
"xdm:negativeActionRate": 0.0005,
"xdm:negativeActionRateUncapped": 0.0005,
"xdm:positiveActions": 12345,
"xdm:positiveActionRate": 0.247,
"xdm:positiveActionRateUncapped": 1.41,
"xdm:brandSafetyScore": 9.5,
"xdm:viewabilityScore": 8.5,
"xdm:fraudScore": 0.5,
Expand Down
20 changes: 18 additions & 2 deletions components/fieldgroups/paid-media/core-paid-media-quality-metrics.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,18 @@
"xdm:negativeActionRate": {
"type": "number",
"title": "Negative Action Rate",
"description": "Rate of negative actions",
"description": "(DEPRECATED — use xdm:negativeActionRateUncapped instead. Capped at 1.0 and cannot represent rates >1.0 where a single impression yields multiple negative actions.) Rate of negative actions (negative actions/impressions).",
"meta:status": "deprecated",
"minimum": 0,
"maximum": 1
},
"xdm:negativeActionRateUncapped": {
"type": "number",
"title": "Negative Action Rate (Uncapped)",
"description": "Rate of negative actions (negative actions/impressions). Can exceed 1.0 because a single impression can yield multiple negative actions.",
"meta:status": "stable",
"minimum": 0
},
"xdm:positiveActions": {
"type": "integer",
"title": "Positive Actions",
Expand All @@ -74,10 +82,18 @@
"xdm:positiveActionRate": {
"type": "number",
"title": "Positive Action Rate",
"description": "Rate of positive actions",
"description": "(DEPRECATED — use xdm:positiveActionRateUncapped instead. Capped at 1.0 and cannot represent rates >1.0 where a single impression yields multiple positive actions.) Rate of positive actions (positive actions/impressions).",
"meta:status": "deprecated",
"minimum": 0,
"maximum": 1
},
"xdm:positiveActionRateUncapped": {
"type": "number",
"title": "Positive Action Rate (Uncapped)",
"description": "Rate of positive actions (positive actions/impressions). Can exceed 1.0 because a single impression can yield multiple positive actions.",
"meta:status": "stable",
"minimum": 0
},
"xdm:brandSafetyScore": {
"type": "number",
"title": "Brand Safety Score",
Expand Down