✨ Source Instagram: add new fields for streams StoryInsights and Medi…

…aInsights (#41937) Co-authored-by: Natik Gadzhi <natik@respawn.io> Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
airbytehq · Jul 29, 2024 · b4bda3b · b4bda3b
1 parent 04739c5
commit b4bda3b
Show file tree

Hide file tree

Showing 14 changed files with 294 additions and 33 deletions.
diff --git a/airbyte-integrations/connectors/source-instagram/.gitignore b/airbyte-integrations/connectors/source-instagram/.gitignore
@@ -1 +1,3 @@
 NEW_SOURCE_CHECKLIST.md
+.python-version
+.venv
diff --git a/airbyte-integrations/connectors/source-instagram/metadata.yaml b/airbyte-integrations/connectors/source-instagram/metadata.yaml
@@ -7,7 +7,7 @@ data:
   connectorSubtype: api
   connectorType: source
   definitionId: 6acf6b55-4f1e-4fca-944e-1a3caef8aba8
-  dockerImageTag: 3.0.22
+  dockerImageTag: 3.1.0
   dockerRepository: airbyte/source-instagram
   githubIssueLabel: source-instagram
   icon: instagram.svg

diff --git a/airbyte-integrations/connectors/source-instagram/pyproject.toml b/airbyte-integrations/connectors/source-instagram/pyproject.toml
@@ -3,7 +3,7 @@ requires = [ "poetry-core>=1.0.0",]
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
-version = "3.0.22"
+version = "3.1.0"
 name = "source-instagram"
 description = "Source implementation for Instagram."
 authors = [ "Airbyte <contact@airbyte.io>",]

diff --git a/airbyte-integrations/connectors/source-instagram/source_instagram/manifest.yaml b/airbyte-integrations/connectors/source-instagram/source_instagram/manifest.yaml
@@ -119,16 +119,16 @@ definitions:
             metric: >-
               {% if stream_partition.media_insights_info.media_product_type ==
               "REELS" %}{{
-              'comments,ig_reels_avg_watch_time,ig_reels_video_view_total_time,likes,plays,reach,saved,shares'
+              'comments,ig_reels_avg_watch_time,ig_reels_video_view_total_time,likes,plays,reach,saved,shares,ig_reels_aggregated_all_plays_count,clips_replays_count'
               }}{% elif stream_partition.media_insights_info.media_type ==
               "VIDEO" and
               stream_partition.media_insights_info.media_product_type == "FEED"
               %}{{  'impressions,reach,saved,video_views'}}{% elif
               stream_partition.media_insights_info.media_type == "VIDEO" %}{{
-              'impressions,reach,saved,video_views,likes,comments,shares'
+              'impressions,reach,saved,video_views,likes,comments,shares,follows,profile_visits'
               }}{%elif stream_partition.media_insights_info.media_type ==
-              "CAROUSEL_ALBUM"%}{{ 'impressions,reach,saved,video_views' }}{% else %}{{
-              'impressions,reach,saved,video_views,likes,comments,shares' }}{%
+              "CAROUSEL_ALBUM"%}{{ 'impressions,reach,saved,video_views,shares,follows,profile_visits' }}{% else %}{{
+              'impressions,reach,saved,video_views,likes,comments,shares,follows,profile_visits' }}{%
               endif %}
           error_handler:
             type: CompositeErrorHandler
@@ -448,7 +448,7 @@ definitions:
           path: "{{ stream_partition.story_insights_info.story_id }}/insights"
           http_method: GET
           request_parameters:
-            metric: impressions,reach,replies
+            metric: impressions,reach,replies,follows,profile_visits,shares,total_interactions
           error_handler:
             type: CompositeErrorHandler
             error_handlers:
@@ -854,6 +854,26 @@ schemas:
         type:
           - "null"
           - integer
+      ig_reels_aggregated_all_plays_count:
+        description: The number of times of Instagram Reels gets reproduced after an impression is counted.
+        type:
+          - "null"
+          - integer
+      clips_replays_count:
+        description: The number of times the reel gets reproduced after the first one.
+        type:
+          - "null"
+          - integer
+      follows:
+        description: The number of accounts that started to follow the profile.
+        type:
+          - "null"
+          - integer
+      profile_visits:
+        description: The number of times the profile has been visited.
+        type:
+          - "null"
+          - integer
     required:
       - id
   Users:
@@ -1076,6 +1096,26 @@ schemas:
         type:
           - "null"
           - integer
+      follows:
+        description: The number of accounts that started to follow the account.
+        type:
+          - "null"
+          - integer
+      profile_visits:
+        description: The number of times the profile was visited.
+        type:
+          - "null"
+          - integer
+      shares:
+        description: The number of times the story has been shared.
+        type:
+          - "null"
+          - integer
+      total_interactions:
+        description¨: The number of replies and shares of the story.
+        type:
+          - "null"
+          - integer
   Api:
     type: object
     $schema: http://json-schema.org/schema#

diff --git a/...yte-integrations/connectors/source-instagram/source_instagram/schemas/media_insights.json b/...yte-integrations/connectors/source-instagram/source_instagram/schemas/media_insights.json
@@ -14,11 +14,11 @@
       "type": ["null", "string"]
     },
     "ig_reels_avg_watch_time": {
-      "description": "The average watch time of Instagram Reels videos in seconds.",
+      "description": "The average watch time of Instagram Reels videos in milliseconds.",
       "type": ["null", "number"]
     },
     "ig_reels_video_view_total_time": {
-      "description": "The total watch time of Instagram Reels videos in seconds.",
+      "description": "The total watch time of Instagram Reels videos in milliseconds.",
       "type": ["null", "number"]
     },
     "impressions": {
@@ -56,6 +56,22 @@
     "plays": {
       "description": "The number of times the media has been played.",
       "type": ["null", "integer"]
+    },
+    "ig_reels_aggregated_all_plays_count": {
+      "description": "The number of times of Instagram Reels gets reproduced after an impression is counted.",
+      "type": ["null", "integer"]
+    },
+    "clips_replays_count": {
+      "description": "The number of times the reel gets reproduced again.",
+      "type": ["null", "integer"]
+    },
+    "follows": {
+      "description": "The number of accounts that started to follow the profile.",
+      "type": ["null", "integer"]
+    },
+    "profile_visits": {
+      "description": "The number of times the profile has been visited.",
+      "type": ["null", "integer"]
     }
   }
 }
diff --git a/...yte-integrations/connectors/source-instagram/source_instagram/schemas/story_insights.json b/...yte-integrations/connectors/source-instagram/source_instagram/schemas/story_insights.json
@@ -24,6 +24,22 @@
     "replies": {
       "description": "The number of replies or interactions generated by the story.",
       "type": ["null", "integer"]
+    },
+    "follows": {
+      "description": "The number of accounts that started to follow the account.",
+      "type": ["null", "integer"]
+    },
+    "profile_visits": {
+      "description": "The number of times the profile was visited.",
+      "type": ["null", "integer"]
+    },
+    "shares": {
+      "description": "The number of times the story has been shared.",
+      "type": ["null", "integer"]
+    },
+    "total_interactions": {
+      "description": "The number of replies and shares of the story.",
+      "type": ["null", "integer"]
     }
   }
 }
diff --git a/...te-integrations/connectors/source-instagram/unit_tests/integration/test_media_insights.py b/...te-integrations/connectors/source-instagram/unit_tests/integration/test_media_insights.py
@@ -45,7 +45,6 @@
 _STREAM_NAME = "media_insights"
 
 
-
 MEDIA_ID_REELS = "84386203808767123"
 MEDIA_ID_VIDEO_FEED = "90014330517797123"
 MEDIA_ID_VIDEO = "09894619573775123"
@@ -72,13 +71,14 @@
     GENERAL_MEDIA: MEDIA_ID_GENERAL_MEDIA
 }
 
-METRICS_GENERAL_MEDIA = ["impressions", "reach", "saved", "video_views", "likes", "comments", "shares"]
+METRICS_GENERAL_MEDIA = ["impressions", "reach", "saved", "video_views", "likes", "comments", "shares", "follows", "profile_visits"]
 
 _METRICS = {
-    MEDIA_ID_REELS: ["comments", "ig_reels_avg_watch_time", "ig_reels_video_view_total_time", "likes", "plays", "reach", "saved", "shares"],
+    MEDIA_ID_REELS: ["comments", "ig_reels_avg_watch_time", "ig_reels_video_view_total_time", "likes", "plays", "reach", "saved", "shares",
+                     "ig_reels_aggregated_all_plays_count", "clips_replays_count"],
     MEDIA_ID_VIDEO_FEED: ["impressions", "reach", "saved", "video_views"],
-    MEDIA_ID_VIDEO: ["impressions", "reach", "saved", "video_views", "likes", "comments", "shares"],
-    MEDIA_ID_CAROUSEL_ALBUM: ["impressions", "reach", "saved", "video_views"],
+    MEDIA_ID_VIDEO: ["impressions", "reach", "saved", "video_views", "likes", "comments", "shares", "follows", "profile_visits"],
+    MEDIA_ID_CAROUSEL_ALBUM: ["impressions", "reach", "saved", "video_views", "shares", "follows", "profile_visits"],
     MEDIA_ID_GENERAL_MEDIA: METRICS_GENERAL_MEDIA,
     # Reusing general media metrics for error scenarios
     MEDIA_ID_ERROR_POSTED_BEFORE_BUSINESS: METRICS_GENERAL_MEDIA,

diff --git a/...te-integrations/connectors/source-instagram/unit_tests/integration/test_story_insights.py b/...te-integrations/connectors/source-instagram/unit_tests/integration/test_story_insights.py
@@ -48,7 +48,7 @@
 HAPPY_PATH = 'story_insights_happy_path'
 ERROR_10 = 'story_insights_error_code_10'
 
-_METRICS = ["impressions", "reach", "replies"]
+_METRICS = ["impressions", "reach", "replies", "follows", "profile_visits", "shares", "total_interactions"]
 
 
 

diff --git a/...source-instagram/unit_tests/resource/http/response/media_insights_for_carousel_album.json b/...source-instagram/unit_tests/resource/http/response/media_insights_for_carousel_album.json
@@ -47,6 +47,42 @@
       "title": "Video Views",
       "description": "The number of times videos in your carousel album were viewed.",
       "id": "66123508374641123/insights/video_views/lifetime"
+    },
+    {
+      "name": "shares",
+      "period": "lifetime",
+      "values": [
+        {
+          "value": 3
+        }
+      ],
+      "title": "Shares title",
+      "description": "Shares description.",
+      "id": "66123508374641123/insights/shares/lifetime"
+    },
+    {
+      "name": "follows",
+      "period": "lifetime",
+      "values": [
+        {
+          "value": 53
+        }
+      ],
+      "title": "Follows title",
+      "description": "Follows description.",
+      "id": "66123508374641123/insights/follows/lifetime"
+    },
+    {
+      "name": "profile_visits",
+      "period": "lifetime",
+      "values": [
+        {
+          "value": 9
+        }
+      ],
+      "title": "Profile visits title",
+      "description": "Profile visits description.",
+      "id": "66123508374641123/insights/profile_visits/lifetime"
     }
   ]
 }
diff --git a/.../source-instagram/unit_tests/resource/http/response/media_insights_for_general_media.json b/.../source-instagram/unit_tests/resource/http/response/media_insights_for_general_media.json
@@ -83,6 +83,30 @@
       "title": "Shares",
       "description": "The number of shares of your media.",
       "id": "35076616084176123/insights/shares/lifetime"
+    },
+    {
+      "name": "follows",
+      "period": "lifetime",
+      "values": [
+        {
+          "value": 53
+        }
+      ],
+      "title": "Follows title",
+      "description": "Follows description.",
+      "id": "35076616084176123/insights/follows/lifetime"
+    },
+    {
+      "name": "profile_visits",
+      "period": "lifetime",
+      "values": [
+        {
+          "value": 9
+        }
+      ],
+      "title": "Profile visits title",
+      "description": "Profile visits description.",
+      "id": "35076616084176123/insights/profile_visits/lifetime"
     }
   ]
 }
diff --git a/...nnectors/source-instagram/unit_tests/resource/http/response/media_insights_for_reels.json b/...nnectors/source-instagram/unit_tests/resource/http/response/media_insights_for_reels.json
@@ -95,6 +95,30 @@
       "title": "Shares",
       "description": "The number of shares of your reel.",
       "id": "84386203808767123/insights/shares/lifetime"
+    },
+    {
+      "name": "ig_reels_aggregated_all_plays_count",
+      "period": "lifetime",
+      "values": [
+        {
+          "value": 383
+        }
+      ],
+      "title": "IG reels aggregated all plays count title",
+      "description": "IG reels aggregated all plays count description.",
+      "id": "84386203808767123/insights/ig_reels_aggregated_all_plays_count/lifetime"
+    },
+    {
+      "name": "clips_replays_count",
+      "period": "lifetime",
+      "values": [
+        {
+          "value": 102
+        }
+      ],
+      "title": "Clip Replays Count title",
+      "description": "Clip Replays Count description.",
+      "id": "84386203808767123/insights/clips_replays_count/lifetime"
     }
   ]
 }
diff --git a/...nnectors/source-instagram/unit_tests/resource/http/response/media_insights_for_video.json b/...nnectors/source-instagram/unit_tests/resource/http/response/media_insights_for_video.json
@@ -83,6 +83,30 @@
       "title": "Shares",
       "description": "The number of shares of your video.",
       "id": "09894619573775123/insights/shares/lifetime"
+    },
+    {
+      "name": "follows",
+      "period": "lifetime",
+      "values": [
+        {
+          "value": 53
+        }
+      ],
+      "title": "Follows title",
+      "description": "Follows description.",
+      "id": "09894619573775123/insights/follows/lifetime"
+    },
+    {
+      "name": "profile_visits",
+      "period": "lifetime",
+      "values": [
+        {
+          "value": 9
+        }
+      ],
+      "title": "Profile visits title",
+      "description": "Profile visits description.",
+      "id": "09894619573775123/insights/profile_visits/lifetime"
     }
   ]
 }