✨ TikTok Marketing Source: Add SparkAds Stream

airbyte-integrations/connectors/source-tiktok-marketing/acceptance-test-config.yml

@@ -52,6 +52,8 @@ acceptance_tests:
             bypass_reason: "System music provided by TikTok - very volatile data."
           - name: advertisers_audience_reports_lifetime
             bypass_reason: "No data in the integration test account. We should seed the sandbox later on."
+          - name: spark_ads
+            bypass_reason: "No data in the integration test account. We should seed the sandbox later on."
   full_refresh:
     tests:
       - config_path: "secrets/config.json"

airbyte-integrations/connectors/source-tiktok-marketing/integration_tests/configured_catalog.json

@@ -390,6 +390,17 @@
       "destination_sync_mode": "overwrite",
       "cursor_field": ["stat_time_day"],
       "primary_key": [["ad_id"], ["stat_time_day"], ["platform"]]
+    },
+    {
+      "stream": {
+        "name": "spark_ads",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh"],
+        "source_defined_primary_key": [["spark_ads_post_id"]]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "overwrite",
+      "primary_key": [["spark_ads_post_id"]]
     }
   ]
 }

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

@@ -11,7 +11,7 @@ data:
   connectorSubtype: api
   connectorType: source
   definitionId: 4bfac00d-ce15-44ff-95b9-9e3c3e8fbd35
-  dockerImageTag: 4.4.0
+  dockerImageTag: 4.5.0
   dockerRepository: airbyte/source-tiktok-marketing
   documentationUrl: https://docs.airbyte.com/integrations/sources/tiktok-marketing
   githubIssueLabel: source-tiktok-marketing

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

@@ -3,7 +3,7 @@ requires = [ "poetry-core>=1.0.0",]
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
-version = "4.4.0"
+version = "4.5.0"
 name = "source-tiktok-marketing"
 description = "Source implementation for Tiktok Marketing."
 authors = [ "Airbyte <contact@airbyte.io>",]
@@ -24,10 +24,10 @@ freezegun = "^1.1.0"
 source-tiktok-marketing = "source_tiktok_marketing.run:run"
 
 [tool.poetry.group.dev.dependencies]
-requests-mock = "==1.12.1"
+requests-mock = "*"
 timeout-decorator = "==0.5.0"
-pytest-mock = "^3.6.1"
-pytest = "^8.0.0"
+pytest-mock = "*"
+pytest = "*"
 
 
 [tool.poe]

airbyte-integrations/connectors/source-tiktok-marketing/source_tiktok_marketing/manifest.yaml

@@ -1626,6 +1626,47 @@ definitions:
       - type: CustomTransformation
         class_name: "source_tiktok_marketing.components.transformations.TransformEmptyMetrics"
 
+  spark_ads_stream:
+    type: DeclarativeStream
+    name: spark_ads
+    primary_key:
+      - spark_ads_post_id
+    retriever:
+      type: SimpleRetriever
+      requester:
+        $ref: "#/definitions/requester"
+        path: tt_video/list/
+      record_selector:
+        $ref: "#/definitions/record_selector"
+      paginator:
+        $ref: "#/definitions/paginator_page_increment"
+        pagination_strategy:
+          type: "PageIncrement"
+          page_size: 50
+          start_from_page: 1
+      partition_router:
+        type: SubstreamPartitionRouter
+        parent_stream_configs:
+          - type: ParentStreamConfig
+            parent_key: advertiser_id
+            request_option:
+              type: RequestOption
+              inject_into: request_parameter
+              field_name: advertiser_id
+            partition_field: advertiser_id
+            stream:
+              $ref: "#/definitions/advertisers_stream"
+    transformations:
+      - type: AddFields
+        fields:
+          - path:
+              - spark_ads_post_id
+            value: "{{ record['item_info']['item_id'] }}"
+    schema_loader:
+      type: InlineSchemaLoader
+      schema:
+        $ref: "#/definitions/schemas/spark_ads"
+
   schemas:
     advertiser_ids:
       $schema: http://json-schema.org/draft-07/schema#
@@ -4118,6 +4159,155 @@ definitions:
               type:
                 - "null"
                 - string
+    spark_ads:
+      $schema: http://json-schema.org/draft-07/schema#
+      additionalProperties: true
+      type: object
+      properties:
+        spark_ads_post_id:
+          type:
+            - "null"
+            - string
+        user_info:
+          type:
+            - "null"
+            - object
+          properties:
+            tiktok_name:
+              type:
+                - "null"
+                - string
+            identity_id:
+              type:
+                - "null"
+                - string
+            identity_type:
+              type:
+                - "null"
+                - string
+        item_info:
+          type:
+            - "null"
+            - object
+          properties:
+            anchor_list:
+              type:
+                - "null"
+                - array
+              items:
+                type:
+                  - "null"
+                  - object
+                properties:
+                  id:
+                    type:
+                      - "null"
+                      - string
+                  status:
+                    type:
+                      - "null"
+                      - string
+                  product_regions:
+                    type:
+                      - "null"
+                      - array
+                    items:
+                      type:
+                        - "null"
+                        - string
+                  url:
+                    type:
+                      - "null"
+                      - string
+                  title:
+                    type:
+                      - "null"
+                      - string
+            text:
+              type:
+                - "null"
+                - string
+            status:
+              type:
+                - "null"
+                - string
+            auth_code:
+              type:
+                - "null"
+                - string
+            item_id:
+              type:
+                - "null"
+                - string
+            item_type:
+              type:
+                - "null"
+                - string
+            carousel_info:
+              type:
+                - "null"
+                - object
+        auth_info:
+          type:
+            - "null"
+            - object
+          properties:
+            auth_start_time:
+              type:
+                - "null"
+                - string
+              format: date-time
+            ad_auth_status:
+              type:
+                - "null"
+                - string
+            invite_start_time:
+              type:
+                - "null"
+                - string
+              format: date-time
+            auth_end_time:
+              type:
+                - "null"
+                - string
+              format: date-time
+        video_info:
+          type:
+            - "null"
+            - object
+          properties:
+            duration:
+              type:
+                - "null"
+                - number
+            preview_url:
+              type:
+                - "null"
+                - string
+            bit_rate:
+              type:
+                - "null"
+                - integer
+            height:
+              type:
+                - "null"
+                - integer
+            width:
+              type:
+                - "null"
+                - integer
+            signature:
+              type:
+                - "null"
+                - string
+            size:
+              type:
+                - "null"
+                - integer
+            poster_url:
+              type:
+                - "null"
+                - string
 
 streams:
   - $ref: "#/definitions/advertiser_ids_stream"
@@ -4156,6 +4346,7 @@ streams:
   - $ref: "#/definitions/campaigns_reports_lifetime_stream"
   - $ref: "#/definitions/ad_groups_reports_lifetime_stream"
   - $ref: "#/definitions/advertisers_audience_reports_lifetime_stream"
+  - $ref: "#/definitions/spark_ads_stream"
 
 spec:
   type: Spec

airbyte-integrations/connectors/source-tiktok-marketing/unit_tests/test_source.py

@@ -14,7 +14,7 @@
 @pytest.mark.parametrize(
     "config, stream_len",
     [
-        ({"access_token": "token", "environment": {"app_id": "1111", "secret": "secret"}, "start_date": "2021-04-01"}, 36),
+        ({"access_token": "token", "environment": {"app_id": "1111", "secret": "secret"}, "start_date": "2021-04-01"}, 37),
         ({"access_token": "token", "start_date": "2021-01-01", "environment": {"advertiser_id": "1111"}}, 28),
         (
             {
@@ -23,7 +23,7 @@
                 "start_date": "2021-04-01",
                 "report_granularity": "LIFETIME",
             },
-            36,
+            37,
         ),
         (
             {
@@ -32,7 +32,7 @@
                 "start_date": "2021-04-01",
                 "report_granularity": "DAY",
             },
-            36,
+            37,
         ),
     ],
 )

docs/integrations/sources/tiktok-marketing.md

@@ -115,6 +115,7 @@ The TikTok Marketing source connector supports the following [sync modes](https:
 | CampaignsAudienceReportsDaily             | Prod,Sandbox | campaign_id, stat_time_day, gender, age    | Yes         |
 | CampaignsAudienceReportsByCountryDaily    | Prod,Sandbox | campaign_id, stat_time_day, country_code   | Yes         |
 | CampaignsAudienceReportsByPlatformDaily   | Prod,Sandbox | campaign_id, stat_time_day, platform       | Yes         |
+| SparkAds                                  | Prod         | spark_ads_post_id                          | No          |
 
 :::info
 
@@ -138,6 +139,7 @@ The connector is restricted by [requests limitation](https://business-api.tiktok
 
 | Version   | Date       | Pull Request                                             | Subject                                                                                                                                                                |
 |:----------|:-----------|:---------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 4.5.0 | 2025-03-07 | [45081](https://github.com/airbytehq/airbyte/pull/45081) | Add SparkAds stream |
 | 4.4.0 | 2025-03-07 | [55242](https://github.com/airbytehq/airbyte/pull/55242) | Promoting release candidate 4.4.0-rc3 to a main version. |
 | 4.4.0-rc3 | 2025-03-04 | [55194](https://github.com/airbytehq/airbyte/pull/55194) | Resolve state format issue |
 | 4.4.0-rc2 | 2025-02-20 | [53645)](https://github.com/airbytehq/airbyte/pull/53645) | Remove stream_state interpolation and custom cursors |