Skip to content

Commit 353810d

Browse files
authored
Normalize defaultFields across ad connectors (#1247)
1 parent c77a80d commit 353810d

6 files changed

Lines changed: 44 additions & 44 deletions

File tree

packages/connectors/src/Sources/CriteoAds/CriteoAdsAPIReference/CriteoAdsFieldsSchema.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ var CriteoAdsFieldsSchema = {
1212
documentation: "https://developers.criteo.com/marketing-solutions/docs/campaign-statistics",
1313
fields: adStatisticsFields,
1414
uniqueKeys: ["CampaignId", "AdvertiserId", "AdsetId", "AdId", "Day"],
15-
defaultFields: ["Day", "CampaignId", "Campaign", "AdvertiserId", "Advertiser", "AdsetId", "Adset", "AdId", "Ad", "Clicks", "Displays", "AdvertiserCost", "SalesClientAttribution", "RevenueGeneratedClientAttribution"],
15+
defaultFields: ["Clicks", "Displays", "AdvertiserCost", "Campaign", "Advertiser", "Adset", "Ad", "Currency"],
1616
destinationName: "criteo_ads_statistics",
1717
isTimeSeries: true
1818
}

packages/connectors/src/Sources/FacebookMarketing/MarketingAPIReference/FieldsSchema.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ var FacebookMarketingFieldsSchema = {
100100
"fields": adAccountInsightsFieldsByCountry,
101101
"breakdowns": ["country"],
102102
'uniqueKeys': ["ad_id", "date_start", "date_stop", "country"],
103-
'defaultFields': ["account_id", "account_name", "campaign_id", "campaign_name", "adset_id", "adset_name", "ad_name", "impressions", "reach", "clicks", "spend", "cpc", "cpm", "ctr", "frequency", "actions", "action_values"],
103+
'defaultFields': ["account_currency", "account_id", "account_name", "ad_name", "adset_id", "adset_name", "campaign_id", "campaign_name", "clicks", "impressions", "inline_link_clicks", "reach", "spend"],
104104
"isTimeSeries": true,
105105
"destinationName": "facebook_ads_ad_account_insights_by_country"
106106
},
@@ -165,7 +165,7 @@ var FacebookMarketingFieldsSchema = {
165165
"documentation": "https://developers.facebook.com/docs/marketing-api/reference/adgroup/",
166166
"fields": adGroupFields,
167167
'uniqueKeys': ["id"],
168-
'defaultFields': ["name", "account_id", "status", "effective_status", "adset_id", "campaign_id", "creative_id", "created_time", "updated_time"],
168+
'defaultFields': ["account_id", "creative_effective_object_story_id", "creative_name", "creative_object_story_spec", "creative_url_tags", "creative_asset_groups_spec", "name"],
169169
"isTimeSeries": false,
170170
"destinationName": "facebook_ads_ad_group"
171171
},
@@ -252,4 +252,4 @@ var FacebookMarketingFieldsSchema = {
252252
// "fields" : adCampaignInsightsFields,
253253
// "destinationName": "facebook_ads_ad_campaign_group_insights"
254254
// }
255-
}
255+
}

packages/connectors/src/Sources/LinkedInAds/LinkedInAdsAPIReference/LinkedInAdsFieldsSchema.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ var LinkedInAdsFieldsSchema = {
1212
"documentation": "https://learn.microsoft.com/en-us/linkedin/marketing/integrations/ads/account-structure/create-and-manage-accounts",
1313
"fields": adAccountFields,
1414
"uniqueKeys": ["id"],
15-
"defaultFields": ["id", "name", "status", "currency", "type", "reference"],
15+
"defaultFields": ["name", "currency"],
1616
"destinationName": "linkedin_ads_ad_accounts"
1717
},
1818
"adCampaignGroups": {
@@ -21,7 +21,7 @@ var LinkedInAdsFieldsSchema = {
2121
"documentation": "https://learn.microsoft.com/en-us/linkedin/marketing/integrations/ads/account-structure/create-and-manage-campaign-groups",
2222
"fields": adCampaignGroupFields,
2323
"uniqueKeys": ["id"],
24-
"defaultFields": ["id", "name", "status", "account", "objectiveType", "runSchedule", "totalBudget", "servingStatuses"],
24+
"defaultFields": ["name", "status", "account"],
2525
"destinationName": "linkedin_ads_ad_campaign_groups"
2626
},
2727
"adCampaigns": {
@@ -30,7 +30,7 @@ var LinkedInAdsFieldsSchema = {
3030
"documentation": "https://learn.microsoft.com/en-us/linkedin/marketing/integrations/ads/account-structure/create-and-manage-campaigns",
3131
"fields": adCampaignFields,
3232
"uniqueKeys": ["id"],
33-
"defaultFields": ["id", "name", "status", "account", "campaignGroup", "objectiveType", "type", "runSchedule"],
33+
"defaultFields": ["account", "costType", "dailyBudget", "locale", "name", "objectiveType", "totalBudget", "type", "unitCost", "status", "format"],
3434
"destinationName": "linkedin_ads_ad_campaigns"
3535
},
3636
"creatives": {
@@ -39,7 +39,7 @@ var LinkedInAdsFieldsSchema = {
3939
"documentation": "https://learn.microsoft.com/en-us/linkedin/marketing/integrations/ads/account-structure/create-and-manage-creatives",
4040
"fields": creativesFields,
4141
"uniqueKeys": ["id"],
42-
"defaultFields": ["id", "name", "intendedStatus", "account", "campaign", "isServing", "createdAt"],
42+
"defaultFields": ["account", "intendedStatus", "name"],
4343
"destinationName": "linkedin_ads_creatives"
4444
},
4545
"adAnalytics": {
@@ -48,7 +48,7 @@ var LinkedInAdsFieldsSchema = {
4848
"documentation": "https://learn.microsoft.com/en-us/linkedin/marketing/integrations/ads-reporting/ads-reporting",
4949
"fields": adAnalyticsFields,
5050
"uniqueKeys": ["dateRangeStart", "dateRangeEnd", "pivotValues"],
51-
"defaultFields": ["dateRangeStart", "dateRangeEnd", "pivotValues", "impressions", "clicks", "costInLocalCurrency", "costInUsd", "totalEngagements", "landingPageClicks", "externalWebsiteConversions"],
51+
"defaultFields": ["actionClicks", "adUnitClicks", "approximateMemberReach", "clicks", "commentLikes", "comments", "companyPageClicks", "conversionValueInLocalCurrency", "costInLocalCurrency", "costInUsd", "externalWebsiteConversions", "externalWebsitePostClickConversions", "externalWebsitePostViewConversions", "follows", "impressions", "landingPageClicks", "leadGenerationMailContactInfoShares", "leadGenerationMailInterestedClicks", "likes", "oneClickLeadFormOpens", "oneClickLeads", "opens", "otherEngagements", "reactions", "sends", "shares", "textUrlClicks", "totalEngagements", "viralClicks", "viralCommentLikes", "viralComments", "viralCompanyPageClicks", "viralExternalWebsiteConversions", "viralExternalWebsitePostClickConversions", "viralFollows", "viralImpressions", "viralLandingPageClicks", "viralLikes", "viralOneClickLeadFormOpens", "viralOneClickLeads", "viralOtherEngagements", "viralReactions", "viralShares", "viralTotalEngagements"],
5252
"destinationName": "linkedin_ads_ad_analytics",
5353
"isTimeSeries": true
5454
}

packages/connectors/src/Sources/RedditAds/RedditAdsAPIReference/FieldsSchema.js

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ var RedditFieldsSchema = {
1212
"documentation": "https://ads-api.reddit.com/docs/v3/operations/Get%20Me",
1313
"fields": adAccountUserFields,
1414
"uniqueKeys": ["id"],
15-
"defaultFields": ["id", "email", "firstname", "lastname", "reddit_user_id", "reddit_username"],
15+
"defaultFields": ["email", "firstname", "lastname", "reddit_user_id", "reddit_username"],
1616
"destinationName": "reddit_ads_ad_account_user"
1717
},
1818
"ad-account": {
@@ -21,7 +21,7 @@ var RedditFieldsSchema = {
2121
"documentation": "https://ads-api.reddit.com/docs/v3/operations/Get%20Ad%20Account",
2222
"fields": adAccountFields,
2323
"uniqueKeys": ["id"],
24-
"defaultFields": ["id", "name", "type", "currency", "attribution_type", "click_attribution_window", "view_attribution_window", "created_at", "modified_at"],
24+
"defaultFields": ["name", "type", "currency", "attribution_type", "click_attribution_window", "view_attribution_window", "created_at", "modified_at"],
2525
"destinationName": "reddit_ads_ad_account"
2626
},
2727
"ad-group": {
@@ -30,7 +30,7 @@ var RedditFieldsSchema = {
3030
"documentation": "https://ads-api.reddit.com/docs/v3/operations/List%20Ad%20Groups",
3131
"fields": adGroupFields,
3232
"uniqueKeys": ["id"],
33-
"defaultFields": ["id", "name", "ad_account_id", "campaign_id", "configured_status", "effective_status", "bid_strategy", "bid_type", "goal_type", "start_time", "end_time", "is_campaign_budget_optimization"],
33+
"defaultFields": ["name", "ad_account_id", "campaign_id", "configured_status", "effective_status", "bid_strategy", "bid_type", "goal_type", "start_time", "end_time", "is_campaign_budget_optimization"],
3434
"destinationName": "reddit_ads_ad_group",
3535
"parameters": {
3636
"pageSize": {
@@ -46,7 +46,7 @@ var RedditFieldsSchema = {
4646
"documentation": "https://ads-api.reddit.com/docs/v3/operations/List%20Ads",
4747
"fields": adsFields,
4848
"uniqueKeys": ["id"],
49-
"defaultFields": ["id", "name", "type", "ad_account_id", "ad_group_id", "campaign_id", "configured_status", "effective_status", "post_id"],
49+
"defaultFields": ["ad_account_id", "campaign_id", "name"],
5050
"destinationName": "reddit_ads_ads"
5151
},
5252
"campaigns": {
@@ -55,7 +55,7 @@ var RedditFieldsSchema = {
5555
"documentation": "https://ads-api.reddit.com/docs/v3/operations/List%20Campaigns",
5656
"fields": campaignsFields,
5757
"uniqueKeys": ["id"],
58-
"defaultFields": ["id", "name", "objective", "ad_account_id", "configured_status", "effective_status", "spend_cap", "created_at"],
58+
"defaultFields": ["ad_account_id", "name"],
5959
"destinationName": "reddit_ads_campaigns"
6060
},
6161
"user-custom-audience": {
@@ -64,7 +64,7 @@ var RedditFieldsSchema = {
6464
"documentation": "https://ads-api.reddit.com/docs/v3/operations/List%20User%20Custom%20Audiences",
6565
"fields": userCustomAudienceFields,
6666
"uniqueKeys": ["id"],
67-
"defaultFields": ["id", "name", "type", "status", "ad_account_id", "size_range_lower", "size_range_upper"],
67+
"defaultFields": ["name", "type", "status", "ad_account_id", "size_range_lower", "size_range_upper"],
6868
"destinationName": "reddit_ads_user_custom_audience"
6969
},
7070
"funding-instruments": {
@@ -73,7 +73,7 @@ var RedditFieldsSchema = {
7373
"documentation": "https://ads-api.reddit.com/docs/v3/operations/List%20Funding%20Instruments",
7474
"fields": fundingInstrumentFields,
7575
"uniqueKeys": ["id"],
76-
"defaultFields": ["id", "name", "currency", "credit_limit", "billable_amount", "is_servable"],
76+
"defaultFields": ["name", "currency", "credit_limit", "billable_amount", "is_servable"],
7777
"destinationName": "reddit_ads_funding_instruments"
7878
},
7979
"lead-gen-form": {
@@ -82,7 +82,7 @@ var RedditFieldsSchema = {
8282
"documentation": "https://ads-api.reddit.com/docs/v3/operations/List%20Lead%20Gen%20Forms",
8383
"fields": leadGenFormFields,
8484
"uniqueKeys": ["id"],
85-
"defaultFields": ["id", "name", "ad_account_id", "prompt", "created_at"],
85+
"defaultFields": ["name", "ad_account_id", "prompt", "created_at"],
8686
"destinationName": "reddit_ads_lead_gen_form"
8787
},
8888
"report": {
@@ -91,7 +91,7 @@ var RedditFieldsSchema = {
9191
"documentation": "https://ads-api.reddit.com/docs/v3/operations/List%20Ad%20Metrics",
9292
"fields": reportFields,
9393
"uniqueKeys": ["ad_id", "date"],
94-
"defaultFields": ["ad_id", "date", "impressions", "clicks", "spend", "ctr", "cpc", "ecpm", "reach", "frequency", "key_conversion_total_count", "key_conversion_ecpa", "conversion_purchase_clicks", "conversion_purchase_total_value", "conversion_roas"],
94+
"defaultFields": ["impressions", "clicks", "spend", "ctr", "cpc", "ecpm", "reach", "frequency", "key_conversion_total_count", "key_conversion_ecpa", "conversion_purchase_clicks", "conversion_purchase_total_value", "conversion_roas"],
9595
"destinationName": "reddit_ads_report",
9696
"isTimeSeries": true
9797
},
@@ -101,7 +101,7 @@ var RedditFieldsSchema = {
101101
"documentation": "https://ads-api.reddit.com/docs/v3/operations/List%20Ad%20Metrics",
102102
"fields": reportCountryFields,
103103
"uniqueKeys": ["ad_id", "date", "country"],
104-
"defaultFields": ["ad_id", "date", "country", "impressions", "clicks", "spend", "ctr", "cpc", "ecpm", "reach", "frequency", "key_conversion_total_count", "key_conversion_ecpa", "conversion_purchase_clicks", "conversion_purchase_total_value", "conversion_roas"],
104+
"defaultFields": ["clicks", "hour", "impressions", "post_id", "spend"],
105105
"destinationName": "reddit_ads_report_by_COUNTRY",
106106
"isTimeSeries": true
107107
},
@@ -111,7 +111,7 @@ var RedditFieldsSchema = {
111111
"documentation": "https://ads-api.reddit.com/docs/v3/operations/List%20Ad%20Metrics",
112112
"fields": reportAdGroupIdFields,
113113
"uniqueKeys": ["ad_id", "date", "ad_group_id"],
114-
"defaultFields": ["ad_id", "date", "ad_group_id", "impressions", "clicks", "spend", "ctr", "cpc", "ecpm", "reach", "frequency", "key_conversion_total_count", "key_conversion_ecpa", "conversion_purchase_clicks", "conversion_purchase_total_value", "conversion_roas"],
114+
"defaultFields": ["impressions", "clicks", "spend", "ctr", "cpc", "ecpm", "reach", "frequency", "key_conversion_total_count", "key_conversion_ecpa", "conversion_purchase_clicks", "conversion_purchase_total_value", "conversion_roas"],
115115
"destinationName": "reddit_ads_report_by_AD_GROUP_ID",
116116
"isTimeSeries": true
117117
},
@@ -121,7 +121,7 @@ var RedditFieldsSchema = {
121121
"documentation": "https://ads-api.reddit.com/docs/v3/operations/List%20Ad%20Metrics",
122122
"fields": reportCampaignIdFields,
123123
"uniqueKeys": ["ad_id", "date", "campaign_id"],
124-
"defaultFields": ["ad_id", "date", "campaign_id", "impressions", "clicks", "spend", "ctr", "cpc", "ecpm", "reach", "frequency", "key_conversion_total_count", "key_conversion_ecpa", "conversion_purchase_clicks", "conversion_purchase_total_value", "conversion_roas"],
124+
"defaultFields": ["impressions", "clicks", "spend", "ctr", "cpc", "ecpm", "reach", "frequency", "key_conversion_total_count", "key_conversion_ecpa", "conversion_purchase_clicks", "conversion_purchase_total_value", "conversion_roas"],
125125
"destinationName": "reddit_ads_report_by_CAMPAIGN_ID",
126126
"isTimeSeries": true
127127
},
@@ -131,7 +131,7 @@ var RedditFieldsSchema = {
131131
"documentation": "https://ads-api.reddit.com/docs/v3/operations/List%20Ad%20Metrics",
132132
"fields": reportDmaBasedFields,
133133
"uniqueKeys": ["ad_id", "date", "dma"],
134-
"defaultFields": ["ad_id", "date", "dma", "impressions", "clicks", "spend", "ctr", "cpc", "ecpm", "reach", "frequency", "key_conversion_total_count", "key_conversion_ecpa", "conversion_purchase_clicks", "conversion_purchase_total_value", "conversion_roas"],
134+
"defaultFields": ["impressions", "clicks", "spend", "ctr", "cpc", "ecpm", "reach", "frequency", "key_conversion_total_count", "key_conversion_ecpa", "conversion_purchase_clicks", "conversion_purchase_total_value", "conversion_roas"],
135135
"destinationName": "reddit_ads_report_by_DMA",
136136
"isTimeSeries": true
137137
},
@@ -141,7 +141,7 @@ var RedditFieldsSchema = {
141141
"documentation": "https://ads-api.reddit.com/docs/v3/operations/List%20Ad%20Metrics",
142142
"fields": reportInterestFields,
143143
"uniqueKeys": ["ad_id", "date", "interest"],
144-
"defaultFields": ["ad_id", "date", "interest", "impressions", "clicks", "spend", "ctr", "cpc", "ecpm", "reach", "frequency", "key_conversion_total_count", "key_conversion_ecpa", "conversion_purchase_clicks", "conversion_purchase_total_value", "conversion_roas"],
144+
"defaultFields": ["impressions", "clicks", "spend", "ctr", "cpc", "ecpm", "reach", "frequency", "key_conversion_total_count", "key_conversion_ecpa", "conversion_purchase_clicks", "conversion_purchase_total_value", "conversion_roas"],
145145
"destinationName": "reddit_ads_report_by_INTEREST",
146146
"isTimeSeries": true
147147
},
@@ -151,7 +151,7 @@ var RedditFieldsSchema = {
151151
"documentation": "https://ads-api.reddit.com/docs/v3/operations/List%20Ad%20Metrics",
152152
"fields": reportKeywordFields,
153153
"uniqueKeys": ["ad_id", "date", "keyword"],
154-
"defaultFields": ["ad_id", "date", "keyword", "impressions", "clicks", "spend", "ctr", "cpc", "ecpm", "reach", "frequency", "key_conversion_total_count", "key_conversion_ecpa", "conversion_purchase_clicks", "conversion_purchase_total_value", "conversion_roas"],
154+
"defaultFields": ["impressions", "clicks", "spend", "ctr", "cpc", "ecpm", "reach", "frequency", "key_conversion_total_count", "key_conversion_ecpa", "conversion_purchase_clicks", "conversion_purchase_total_value", "conversion_roas"],
155155
"destinationName": "reddit_ads_report_by_KEYWORD",
156156
"isTimeSeries": true
157157
},
@@ -161,7 +161,7 @@ var RedditFieldsSchema = {
161161
"documentation": "https://ads-api.reddit.com/docs/v3/operations/List%20Ad%20Metrics",
162162
"fields": reportPlacementFields,
163163
"uniqueKeys": ["ad_id", "date", "placement"],
164-
"defaultFields": ["ad_id", "date", "placement", "impressions", "clicks", "spend", "ctr", "cpc", "ecpm", "reach", "frequency", "key_conversion_total_count", "key_conversion_ecpa", "conversion_purchase_clicks", "conversion_purchase_total_value", "conversion_roas"],
164+
"defaultFields": ["impressions", "clicks", "spend", "ctr", "cpc", "ecpm", "reach", "frequency", "key_conversion_total_count", "key_conversion_ecpa", "conversion_purchase_clicks", "conversion_purchase_total_value", "conversion_roas"],
165165
"destinationName": "reddit_ads_report_by_PLACEMENT",
166166
"isTimeSeries": true
167167
},
@@ -171,7 +171,7 @@ var RedditFieldsSchema = {
171171
"documentation": "https://ads-api.reddit.com/docs/v3/operations/List%20Ad%20Metrics",
172172
"fields": reportAdAccountIdFields,
173173
"uniqueKeys": ["ad_id", "date", "account_id"],
174-
"defaultFields": ["ad_id", "date", "account_id", "impressions", "clicks", "spend", "ctr", "cpc", "ecpm", "reach", "frequency", "key_conversion_total_count", "key_conversion_ecpa", "conversion_purchase_clicks", "conversion_purchase_total_value", "conversion_roas"],
174+
"defaultFields": ["impressions", "clicks", "spend", "ctr", "cpc", "ecpm", "reach", "frequency", "key_conversion_total_count", "key_conversion_ecpa", "conversion_purchase_clicks", "conversion_purchase_total_value", "conversion_roas"],
175175
"destinationName": "reddit_ads_report_by_AD_ACCOUNT_ID",
176176
"isTimeSeries": true
177177
},
@@ -181,7 +181,7 @@ var RedditFieldsSchema = {
181181
"documentation": "https://ads-api.reddit.com/docs/v3/operations/List%20Ad%20Metrics",
182182
"fields": reportCommunityFields,
183183
"uniqueKeys": ["ad_id", "date", "community"],
184-
"defaultFields": ["ad_id", "date", "community", "impressions", "clicks", "spend", "ctr", "cpc", "ecpm", "reach", "frequency", "key_conversion_total_count", "key_conversion_ecpa", "conversion_purchase_clicks", "conversion_purchase_total_value", "conversion_roas"],
184+
"defaultFields": ["impressions", "clicks", "spend", "ctr", "cpc", "ecpm", "reach", "frequency", "key_conversion_total_count", "key_conversion_ecpa", "conversion_purchase_clicks", "conversion_purchase_total_value", "conversion_roas"],
185185
"destinationName": "reddit_ads_report_by_COMMUNITY",
186186
"isTimeSeries": true
187187
}

0 commit comments

Comments
 (0)