✨ Source Bing Ads: Stream budget and product dimension performance report

airbyte-integrations/connectors/source-bing-ads/acceptance-test-config.yml

@@ -26,6 +26,16 @@ acceptance_tests:
           path: "integration_tests/expected_records.jsonl"
           extra_records: yes
         empty_streams:
+          - name: budget
+            bypass_reason: "Empty stream, testing in integration tests"
+          - name: product_dimension_performance_report_hourly
+            bypass_reason: "Empty stream, testing in integration tests"
+          - name: product_dimension_performance_report_daily
+            bypass_reason: "Empty stream, testing in integration tests"
+          - name: product_dimension_performance_report_weekly
+            bypass_reason: "Empty stream, testing in integration tests"
+          - name: product_dimension_performance_report_monthly
+            bypass_reason: "Empty stream, testing in integration tests"
           - name: account_performance_report_hourly
             bypass_reason: "Hourly reports are disabled, because sync is too long"
           - name: ad_group_performance_report_hourly
@@ -616,6 +626,16 @@ acceptance_tests:
           path: "integration_tests/expected_records_no_start_date.jsonl"
           extra_records: yes
         empty_streams:
+          - name: budget
+            bypass_reason: "Empty stream, testing in integration tests"
+          - name: product_dimension_performance_report_hourly
+            bypass_reason: "Empty stream, testing in integration tests"
+          - name: product_dimension_performance_report_daily
+            bypass_reason: "Empty stream, testing in integration tests"
+          - name: product_dimension_performance_report_weekly
+            bypass_reason: "Empty stream, testing in integration tests"
+          - name: product_dimension_performance_report_monthly
+            bypass_reason: "Empty stream, testing in integration tests"
           - name: app_install_ads
             bypass_reason: "Can not populate; new campaign with link to app needed; feature is not available yet"
           - name: app_install_ad_labels

airbyte-integrations/connectors/source-bing-ads/integration_tests/configured_catalog.json

@@ -18,6 +18,16 @@
       "sync_mode": "full_refresh",
       "destination_sync_mode": "append"
     },
+    {
+      "stream": {
+        "name": "budget",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh", "incremental"]
+      },
+      "sync_mode": "incremental",
+      "cursor_field": ["Modified Time"],
+      "destination_sync_mode": "append"
+    },
     {
       "stream": {
         "name": "campaigns",
@@ -585,6 +595,46 @@
       "sync_mode": "incremental",
       "cursor_field": ["TimePeriod"],
       "destination_sync_mode": "append"
+    },
+    {
+      "stream": {
+        "name": "product_dimension_performance_report_hourly",
+        "json_schema": {},
+        "supported_sync_modes": ["incremental", "full_refresh"]
+      },
+      "sync_mode": "incremental",
+      "cursor_field": ["TimePeriod"],
+      "destination_sync_mode": "append"
+    },
+    {
+      "stream": {
+        "name": "product_dimension_performance_report_daily",
+        "json_schema": {},
+        "supported_sync_modes": ["incremental", "full_refresh"]
+      },
+      "sync_mode": "incremental",
+      "cursor_field": ["TimePeriod"],
+      "destination_sync_mode": "append"
+    },
+    {
+      "stream": {
+        "name": "product_dimension_performance_report_weekly",
+        "json_schema": {},
+        "supported_sync_modes": ["incremental", "full_refresh"]
+      },
+      "sync_mode": "incremental",
+      "cursor_field": ["TimePeriod"],
+      "destination_sync_mode": "append"
+    },
+    {
+      "stream": {
+        "name": "product_dimension_performance_report_monthly",
+        "json_schema": {},
+        "supported_sync_modes": ["incremental", "full_refresh"]
+      },
+      "sync_mode": "incremental",
+      "cursor_field": ["TimePeriod"],
+      "destination_sync_mode": "append"
     }
   ]
 }

airbyte-integrations/connectors/source-bing-ads/metadata.yaml

@@ -16,7 +16,7 @@ data:
   connectorSubtype: api
   connectorType: source
   definitionId: 47f25999-dd5e-4636-8c39-e7cea2453331
-  dockerImageTag: 2.1.4
+  dockerImageTag: 2.2.0
   dockerRepository: airbyte/source-bing-ads
   documentationUrl: https://docs.airbyte.com/integrations/sources/bing-ads
   githubIssueLabel: source-bing-ads

airbyte-integrations/connectors/source-bing-ads/pyproject.toml

@@ -3,7 +3,7 @@ requires = [ "poetry-core>=1.0.0",]
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
-version = "2.1.4"
+version = "2.2.0"
 name = "source-bing-ads"
 description = "Source implementation for Bing Ads."
 authors = [ "Airbyte <[email protected]>",]

airbyte-integrations/connectors/source-bing-ads/source_bing_ads/bulk_streams.py

@@ -196,3 +196,12 @@ class AdGroupLabels(BingAdsBulkStream):
 
     data_scope = ["EntityData"]
     download_entities = ["AdGroupLabels"]
+
+
+class Budget(BingAdsBulkStream):
+    """
+    https://learn.microsoft.com/en-us/advertising/bulk-service/budget?view=bingads-13&viewFallbackFrom=bingads-13
+    """
+
+    data_scope = ["EntityData"]
+    download_entities = ["Budgets"]

airbyte-integrations/connectors/source-bing-ads/source_bing_ads/report_streams.py

@@ -670,6 +670,45 @@ class UserLocationPerformanceReportMonthly(UserLocationPerformanceReport):
     report_aggregation = "Monthly"
 
 
+class ProductDimensionPerformanceReport(BingAdsReportingServicePerformanceStream, ABC):
+    """
+    https://learn.microsoft.com/en-us/advertising/reporting-service/productdimensionperformancereportrequest?view=bingads-13
+    """
+
+    report_name: str = "ProductDimensionPerformanceReport"
+    report_schema_name = "product_dimension_performance_report"
+    primary_key = None
+
+    @property
+    def report_columns(self) -> Iterable[str]:
+        """AccountId is not in reporting columns for this report"""
+        properties = list(self.get_json_schema().get("properties", {}).keys())
+        properties.remove("AccountId")
+        return properties
+
+    def transform(self, record: MutableMapping[str, Any], stream_slice: Mapping[str, Any], **kwargs) -> MutableMapping[str, Any]:
+        record = super().transform(record, stream_slice)
+        record["AccountId"] = stream_slice["account_id"]
+        return record
+
+
+class ProductDimensionPerformanceReportHourly(HourlyReportTransformerMixin, ProductDimensionPerformanceReport):
+    report_aggregation = "Hourly"
+    report_schema_name = "product_dimension_performance_report_hourly"
+
+
+class ProductDimensionPerformanceReportDaily(ProductDimensionPerformanceReport):
+    report_aggregation = "Daily"
+
+
+class ProductDimensionPerformanceReportWeekly(ProductDimensionPerformanceReport):
+    report_aggregation = "Weekly"
+
+
+class ProductDimensionPerformanceReportMonthly(ProductDimensionPerformanceReport):
+    report_aggregation = "Monthly"
+
+
 class CustomReport(BingAdsReportingServicePerformanceStream, ABC):
     transformer: TypeTransformer = TypeTransformer(TransformConfig.DefaultSchemaNormalization)
     custom_report_columns = []

airbyte-integrations/connectors/source-bing-ads/source_bing_ads/schemas/budget.json

@@ -0,0 +1,39 @@
+{
+  "$schema": "https://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "Account Id": {
+      "type": ["null", "integer"]
+    },
+    "Type": {
+      "type": ["null", "string"]
+    },
+    "Status": {
+      "type": ["null", "string"]
+    },
+    "Id": {
+      "type": ["null", "integer"]
+    },
+    "Parent Id": {
+      "type": ["null", "integer"]
+    },
+    "Client Id": {
+      "type": ["null", "integer"]
+    },
+    "Modified Time": {
+      "type": ["null", "string"]
+    },
+    "Budget Id": {
+      "type": ["null", "integer"]
+    },
+    "Budget Name": {
+      "type": ["null", "string"]
+    },
+    "Budget": {
+      "type": ["null", "string"]
+    },
+    "Budget Type": {
+      "type": ["null", "string"]
+    }
+  }
+}