Fix(Source-Facebook-Marketing): Update breakdown schema for BaseInsightStream

airbyte-integrations/connectors/source-facebook-marketing/metadata.yaml

@@ -10,7 +10,7 @@ data:
   connectorSubtype: api
   connectorType: source
   definitionId: e7778cfc-e97c-4458-9ecb-b4f2bba8946c
-  dockerImageTag: 3.4.0
+  dockerImageTag: 3.4.1
   dockerRepository: airbyte/source-facebook-marketing
   documentationUrl: https://docs.airbyte.com/integrations/sources/facebook-marketing
   githubIssueLabel: source-facebook-marketing

airbyte-integrations/connectors/source-facebook-marketing/pyproject.toml

@@ -3,7 +3,7 @@ requires = [ "poetry-core>=1.0.0",]
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
-version = "3.4.0"
+version = "3.4.1"
 name = "source-facebook-marketing"
 description = "Source implementation for Facebook Marketing."
 authors = [ "Airbyte <[email protected]>",]

airbyte-integrations/connectors/source-facebook-marketing/source_facebook_marketing/schemas/ads_insights_breakdowns.json

@@ -12,54 +12,58 @@
       "description": "The identifier for the mobile app associated with the ad.",
       "type": ["null", "string"]
     },
-    "body_asset_id": {
-      "description": "The ID of the main content or message of the ad.",
-      "type": ["null", "string"]
-    },
     "body_asset": {
       "description": "The main content or message of the ad.",
       "type": ["null", "object"],
       "properties": {
-        "text": { "type": ["null", "string"] },
-        "id": { "type": ["null", "string"] }
+        "id": { "type": ["null", "string"] },
+        "text": { "type": ["null", "string"] }
       }
     },
-    "call_to_action_asset_id": {
-      "description": "The ID of the specific action encouraged by the ad.",
+    "body_asset_id": {
+      "description": "The ID of the main content or message of the ad.",
       "type": ["null", "string"]
     },
+    "breakdown_reporting_ad_id": {
+      "type": ["null", "string"],
+      "description": "The ID of the ad for breakdown reporting."
+    },
     "call_to_action_asset": {
       "description": "The specific action encouraged by the ad.",
       "type": ["null", "object"],
       "properties": {
-        "name": {
-          "type": ["null", "string"]
-        },
-        "id": {
-          "type": ["null", "string"]
-        }
+        "id": { "type": ["null", "string"] },
+        "name": { "type": ["null", "string"] }
       }
     },
-    "country": {
-      "description": "The country where the ad is being displayed.",
+    "call_to_action_asset_id": {
+      "description": "The ID of the specific action encouraged by the ad.",
       "type": ["null", "string"]
     },
-    "description_asset_id": {
-      "description": "The ID of additional descriptive text accompanying the ad content.",
+    "coarse_conversion_value": {
+      "type": ["null", "string"],
+      "description": "Coarse conversion value for the ad."
+    },
+    "conversion_destination": {
+      "type": ["null", "string"],
+      "description": "The destination of the conversion."
+    },
+    "country": {
+      "description": "The country where the ad is being displayed.",
       "type": ["null", "string"]
     },
     "description_asset": {
       "description": "Additional descriptive text accompanying the ad content.",
       "type": ["null", "object"],
       "properties": {
-        "text": {
-          "type": ["null", "string"]
-        },
-        "id": {
-          "type": ["null", "string"]
-        }
+        "id": { "type": ["null", "string"] },
+        "text": { "type": ["null", "string"] }
       }
     },
+    "description_asset_id": {
+      "description": "The ID of additional descriptive text accompanying the ad content.",
+      "type": ["null", "string"]
+    },
     "device_platform": {
       "description": "The device platform (e.g., mobile, desktop) targeted by the ad.",
       "type": ["null", "string"]
@@ -68,6 +72,10 @@
       "description": "Designated Market Area for ad targeting in the United States.",
       "type": ["null", "string"]
     },
+    "fidelity_type": {
+      "type": ["null", "string"],
+      "description": "The fidelity type of the ad."
+    },
     "frequency_value": {
       "description": "The number of times an ad was shown to a unique user.",
       "type": ["null", "string"]
@@ -84,35 +92,91 @@
       "description": "Hourly statistical data aggregated based on the audience's time zone.",
       "type": ["null", "string"]
     },
-    "image_asset_id": {
-      "description": "The ID of the image asset used in the ad.",
-      "type": ["null", "string"]
+    "hsid": {
+      "type": ["null", "string"],
+      "description": "HSID for the ad."
     },
     "image_asset": {
       "description": "The image asset used in the ad.",
       "type": ["null", "object"],
       "properties": {
         "hash": { "type": ["null", "string"] },
-        "url": { "type": ["null", "string"] },
-        "id": { "type": ["null", "string"] }
+        "id": { "type": ["null", "string"] },
+        "url": { "type": ["null", "string"] }
       }
     },
+    "image_asset_id": {
+      "description": "The ID of the image asset used in the ad.",
+      "type": ["null", "string"]
+    },
     "impression_device": {
       "description": "The device type (e.g., smartphone, tablet) that generated the ad impression.",
       "type": ["null", "string"]
     },
-    "link_url_asset_id": {
-      "description": "The ID of the URL linked to by the ad.",
-      "type": ["null", "string"]
+    "is_conversion_id_modeled": {
+      "type": ["null", "boolean"],
+      "description": "Indicates if the conversion ID is modeled."
+    },
+    "is_rendered_as_delayed_skip_ad": {
+      "type": ["null", "boolean"],
+      "description": "Indicates if the ad is rendered as a delayed skip ad."
+    },
+    "landing_destination": {
+      "type": ["null", "string"],
+      "description": "The landing destination of the ad."
     },
     "link_url_asset": {
       "description": "The URL linked to by the ad.",
       "type": ["null", "object"],
       "properties": {
-        "website_url": { "type": ["null", "string"] },
-        "id": { "type": ["null", "string"] }
+        "id": { "type": ["null", "string"] },
+        "website_url": { "type": ["null", "string"] }
       }
     },
+    "link_url_asset_id": {
+      "description": "The ID of the URL linked to by the ad.",
+      "type": ["null", "string"]
+    },
+    "marketing_messages_btn_name": {
+      "type": ["null", "string"],
+      "description": "The button name for marketing messages."
+    },
+    "mdsa_landing_destination": {
+      "type": ["null", "string"],
+      "description": "MDSA landing destination."
+    },
+    "media_asset_url": {
+      "type": ["null", "string"],
+      "description": "URL of the media asset."
+    },
+    "media_creator": {
+      "type": ["null", "string"],
+      "description": "Creator of the media."
+    },
+    "media_destination_url": {
+      "type": ["null", "string"],
+      "description": "Destination URL of the media."
+    },
+    "media_format": {
+      "type": ["null", "string"],
+      "description": "Format of the media."
+    },
+    "media_origin_url": {
+      "type": ["null", "string"],
+      "description": "Origin URL of the media."
+    },
+    "media_text_content": {
+      "type": ["null", "string"],
+      "description": "Text content of the media."
+    },
+    "media_type": {
+      "type": ["null", "string"],
+      "description": "Type of the media."
+    },
+    "mmm": {
+      "description": "The Marketing Mix Model (MMM) used to measure the ad campaign.",
+      "type": ["null", "string"]
+    },
     "place_page_id": {
       "description": "The identifier of the Facebook Page associated with the ad.",
       "type": ["null", "string"]
@@ -121,6 +185,10 @@
       "description": "The position where the ad appears on the platform (e.g., News Feed, right column).",
       "type": ["null", "string"]
     },
+    "postback_sequence_index": {
+      "type": ["null", "integer"],
+      "description": "Index of the postback sequence."
+    },
     "product_id": {
       "description": "The identifier of the product featured in the ad.",
       "type": ["null", "string"]
@@ -129,40 +197,88 @@
       "description": "The platform on which the ad is published (e.g., Facebook, Instagram).",
       "type": ["null", "string"]
     },
+    "redownload": {
+      "type": ["null", "boolean"],
+      "description": "Indicates if the ad is a redownload."
+    },
     "region": {
       "description": "The region being targeted by the ad campaign.",
       "type": ["null", "string"]
     },
+    "signal_source_bucket": {
+      "type": ["null", "string"],
+      "description": "Signal source bucket."
+    },
+    "skan_campaign_id": {
+      "type": ["null", "string"],
+      "description": "SKAN campaign ID."
+    },
     "skan_conversion_id": {
       "description": "The identifier used for measurement and attribution in the SkAdNetwork framework.",
       "type": ["null", "string"]
     },
-    "title_asset_id": {
-      "description": "The ID of the title or headline of the ad.",
-      "type": ["null", "string"]
+    "skan_version": {
+      "type": ["null", "string"],
+      "description": "SKAN version."
+    },
+    "sot_attribution_model_type": {
+      "type": ["null", "string"],
+      "description": "Type of the SOT attribution model."
+    },
+    "sot_attribution_window": {
+      "type": ["null", "string"],
+      "description": "Attribution window for SOT."
+    },
+    "sot_channel": {
+      "type": ["null", "string"],
+      "description": "Channel for SOT."
+    },
+    "sot_event_type": {
+      "type": ["null", "string"],
+      "description": "Event type for SOT."
+    },
+    "sot_source": {
+      "type": ["null", "string"],
+      "description": "Source for SOT."
+    },
+    "standard_event_content_type": {
+      "type": ["null", "string"],
+      "description": "Content type for standard events."
     },
     "title_asset": {
       "description": "The title or headline of the ad.",
       "type": ["null", "object"],
       "properties": {
-        "text": { "type": ["null", "string"] },
-        "id": { "type": ["null", "string"] }
+        "id": { "type": ["null", "string"] },
+        "text": { "type": ["null", "string"] }
       }
     },
-    "video_asset_id": {
-      "description": "The ID of the video asset used in the ad.",
+    "title_asset_id": {
+      "description": "The ID of the title or headline of the ad.",
       "type": ["null", "string"]
     },
+    "user_persona_id": {
+      "type": ["null", "string"],
+      "description": "ID of the user persona."
+    },
+    "user_persona_name": {
+      "type": ["null", "string"],
+      "description": "Name of the user persona."
+    },
     "video_asset": {
       "description": "The video asset used in the ad.",
       "type": ["null", "object"],
       "properties": {
-        "video_id": { "type": ["null", "string"] },
-        "url": { "type": ["null", "string"] },
+        "id": { "type": ["null", "string"] },
         "thumbnail_url": { "type": ["null", "string"] },
-        "video_name": { "type": ["null", "string"] },
-        "id": { "type": ["null", "string"] }
+        "url": { "type": ["null", "string"] },
+        "video_id": { "type": ["null", "string"] },
+        "video_name": { "type": ["null", "string"] }
       }
+    },
+    "video_asset_id": {
+      "description": "The ID of the video asset used in the ad.",
+      "type": ["null", "string"]
     }
   }
 }

airbyte-integrations/connectors/source-facebook-marketing/unit_tests/test_base_insight_streams.py

@@ -8,10 +8,13 @@
 import pytest
 from freezegun import freeze_time
 from pendulum import duration
+from source_facebook_marketing.spec import ValidBreakdowns
 from source_facebook_marketing.streams import AdsInsights
 from source_facebook_marketing.streams.async_job import AsyncJob, InsightAsyncJob
 
 from airbyte_cdk.models import SyncMode
+from airbyte_cdk.sources.streams.core import package_name_from_class
+from airbyte_cdk.sources.utils.schema_helpers import ResourceSchemaLoader
 
 
 @pytest.fixture(name="api")
@@ -762,3 +765,21 @@ def test_object_pk_added_to_schema(self, api, some_config, breakdowns, expect_pk
         assert stream.primary_key == expect_pks
         for pk in expect_pks:
             assert pk in schema["properties"]
+
+    def test_all_breakdowns_have_schemas(self):
+        stream = AdsInsights(
+            api=None,
+            account_ids=["act_123"],
+            start_date=datetime.today().replace(hour=0, minute=0, second=0, microsecond=0),
+            end_date=datetime.today().replace(hour=0, minute=0, second=0, microsecond=0),
+        )
+        loader = ResourceSchemaLoader(package_name_from_class(stream.__class__))
+        breakdowns_properties = loader.get_schema("ads_insights_breakdowns")["properties"]
+
+        valid_breakdowns = [breakdown.name for breakdown in ValidBreakdowns]
+
+        # Check for missing breakdowns
+        missing_breakdowns = [b for b in valid_breakdowns if b not in breakdowns_properties]
+        assert (
+            not missing_breakdowns
+        ), f"Schema file 'ads_insights_breakdowns.json' is missing definitions for breakdowns: {missing_breakdowns}"

docs/integrations/sources/facebook-marketing.md

@@ -269,6 +269,7 @@ This response indicates that the Facebook Graph API requires you to reduce the f
 
 | Version | Date       | Pull Request                                             | Subject                                                                                                                                                                                                                                                                                           |
 |:--------|:-----------|:---------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 3.4.1 | 2024-03-14 | [55760](https://github.com/airbytehq/airbyte/pull/55760) | Fixed KeyError during discovery due to outdated breakdown schema|
 | 3.4.0 | 2024-12-24 | [50418](https://github.com/airbytehq/airbyte/pull/50418) | Add `learning_stage_info` field to `ad_sets` stream |
 | 3.3.35 | 2025-03-08 | [55307](https://github.com/airbytehq/airbyte/pull/55307) | Update dependencies |
 | 3.3.34 | 2025-03-01 | [54990](https://github.com/airbytehq/airbyte/pull/54990) | Update dependencies |