🎉 Source Pinterest: filters for entity statuses

airbyte-config/init/src/main/resources/seed/source_definitions.yaml

@@ -952,7 +952,7 @@
 - name: Pinterest
   sourceDefinitionId: 5cb7e5fe-38c2-11ec-8d3d-0242ac130003
   dockerRepository: airbyte/source-pinterest
-  dockerImageTag: 0.1.8
+  dockerImageTag: 0.1.9
   documentationUrl: https://docs.airbyte.com/integrations/sources/pinterest
   icon: pinterest.svg
   sourceType: api

airbyte-config/init/src/main/resources/seed/source_specs.yaml

@@ -9346,7 +9346,7 @@
     supportsNormalization: false
     supportsDBT: false
     supported_destination_sync_modes: []
-- dockerImage: "airbyte/source-pinterest:0.1.8"
+- dockerImage: "airbyte/source-pinterest:0.1.9"
   spec:
     documentationUrl: "https://docs.airbyte.com/integrations/sources/pinterest"
     connectionSpecification:
@@ -9364,6 +9364,20 @@
             \ it would be defaulted to latest allowed date by api (914 days from today)."
           examples:
           - "2022-07-28"
+        status:
+          title: "Status"
+          description: "Entity statuses based off of campaigns, ad_groups, and ads.\
+            \ If you do not have a status set, it will be ignored completely."
+          type:
+          - "array"
+          - "null"
+          items:
+            type: "string"
+            enum:
+            - "ACTIVE"
+            - "PAUSED"
+            - "ARCHIVED"
+          uniqueItems: true
         credentials:
           title: "Authorization Method"
           type: "object"

airbyte-integrations/connectors/source-pinterest/Dockerfile

@@ -34,5 +34,5 @@ COPY source_pinterest ./source_pinterest
 ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
 ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
 
-LABEL io.airbyte.version=0.1.8
+LABEL io.airbyte.version=0.1.9
 LABEL io.airbyte.name=airbyte/source-pinterest

airbyte-integrations/connectors/source-pinterest/source_pinterest/schemas/ad_account_analytics.json

@@ -7,7 +7,7 @@
       "format": "date"
     },
     "AD_ACCOUNT_ID": {
-      "type": ["null", "string"]
+      "type": ["string"]
     },
     "AD_ID": {
       "type": ["null", "string"]

airbyte-integrations/connectors/source-pinterest/source_pinterest/schemas/ad_group_analytics.json

@@ -7,7 +7,7 @@
       "format": "date"
     },
     "AD_ACCOUNT_ID": {
-      "type": ["integer"]
+      "type": ["string"]
     },
     "AD_ID": {
       "type": ["null", "string"]

airbyte-integrations/connectors/source-pinterest/source_pinterest/schemas/campaign_analytics.json

@@ -7,7 +7,7 @@
       "format": "date"
     },
     "AD_ACCOUNT_ID": {
-      "type": ["null", "integer"]
+      "type": ["string"]
     },
     "AD_ID": {
       "type": ["null", "string"]

airbyte-integrations/connectors/source-pinterest/source_pinterest/source.py

@@ -257,8 +257,13 @@ def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str:
 
 
 class Campaigns(ServerSideFilterStream):
+    def __init__(self, parent: HttpStream, with_data_slices: bool = True, status_filter: str = "", **kwargs):
+        super().__init__(parent, with_data_slices, **kwargs)
+        self.status_filter = status_filter
+
     def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str:
-        return f"ad_accounts/{stream_slice['parent']['id']}/campaigns"
+        params = f"?entity_statuses={self.status_filter}" if self.status_filter else ""
+        return f"ad_accounts/{stream_slice['parent']['id']}/campaigns{params}"
 
 
 class CampaignAnalytics(PinterestAnalyticsStream):
@@ -269,8 +274,13 @@ def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str:
 
 
 class AdGroups(ServerSideFilterStream):
+    def __init__(self, parent: HttpStream, with_data_slices: bool = True, status_filter: str = "", **kwargs):
+        super().__init__(parent, with_data_slices, **kwargs)
+        self.status_filter = status_filter
+
     def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str:
-        return f"ad_accounts/{stream_slice['parent']['id']}/ad_groups"
+        params = f"?entity_statuses={self.status_filter}" if self.status_filter else ""
+        return f"ad_accounts/{stream_slice['parent']['id']}/ad_groups{params}"
 
 
 class AdGroupAnalytics(PinterestAnalyticsStream):
@@ -281,8 +291,13 @@ def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str:
 
 
 class Ads(ServerSideFilterStream):
+    def __init__(self, parent: HttpStream, with_data_slices: bool = True, status_filter: str = "", **kwargs):
+        super().__init__(parent, with_data_slices, **kwargs)
+        self.status_filter = status_filter
+
     def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str:
-        return f"ad_accounts/{stream_slice['parent']['id']}/ads"
+        params = f"?entity_statuses={self.status_filter}" if self.status_filter else ""
+        return f"ad_accounts/{stream_slice['parent']['id']}/ads{params}"
 
 
 class AdAnalytics(PinterestAnalyticsStream):
@@ -338,18 +353,19 @@ def check_connection(self, logger, config) -> Tuple[bool, any]:
     def streams(self, config: Mapping[str, Any]) -> List[Stream]:
         config = self._validate_and_transform(config)
         config["authenticator"] = self.get_authenticator(config)
+        status = ",".join(config.get("status")) if config.get("status") else None
         return [
             AdAccountAnalytics(AdAccounts(config), config=config),
             AdAccounts(config),
             AdAnalytics(Ads(AdAccounts(config), with_data_slices=False, config=config), config=config),
             AdGroupAnalytics(AdGroups(AdAccounts(config), with_data_slices=False, config=config), config=config),
-            AdGroups(AdAccounts(config), config=config),
-            Ads(AdAccounts(config), config=config),
+            AdGroups(AdAccounts(config), status_filter=status, config=config),
+            Ads(AdAccounts(config), status_filter=status, config=config),
             BoardPins(Boards(config), config=config),
             BoardSectionPins(BoardSections(Boards(config), config=config), config=config),
             BoardSections(Boards(config), config=config),
             Boards(config),
             CampaignAnalytics(Campaigns(AdAccounts(config), with_data_slices=False, config=config), config=config),
-            Campaigns(AdAccounts(config), config=config),
+            Campaigns(AdAccounts(config), status_filter=status, config=config),
             UserAccountAnalytics(None, config=config),
         ]

airbyte-integrations/connectors/source-pinterest/source_pinterest/spec.json

@@ -13,6 +13,16 @@
         "description": "A date in the format YYYY-MM-DD. If you have not set a date, it would be defaulted to latest allowed date by api (914 days from today).",
         "examples": ["2022-07-28"]
       },
+      "status": {
+        "title": "Status",
+        "description": "Entity statuses based off of campaigns, ad_groups, and ads. If you do not have a status set, it will be ignored completely.",
+        "type": ["array", "null"],
+        "items": {
+          "type": "string",
+          "enum": ["ACTIVE", "PAUSED", "ARCHIVED"]
+        },
+        "uniqueItems": true
+      },
       "credentials": {
         "title": "Authorization Method",
         "type": "object",
@@ -112,4 +122,4 @@
       }
     }
   }
-}
+}

docs/integrations/sources/pinterest.md

@@ -67,6 +67,7 @@ The connector is restricted by the Pinterest [requests limitation](https://devel
 
 | Version | Date       | Pull Request                                             | Subject                                                                                                 |
 | :------ | :--------- | :------------------------------------------------------- | :------------------------------------------------------------------------------------------------------ |
+| 0.1.9   | 2022-09-06 | [15074](https://github.com/airbytehq/airbyte/pull/15074) | Added filter based on statuses |
 | 0.1.8   | 2022-10-21 | [18285](https://github.com/airbytehq/airbyte/pull/18285) | Fix type of `start_date`                                                                                |
 | 0.1.7   | 2022-09-29 | [17387](https://github.com/airbytehq/airbyte/pull/17387) | Set `start_date` dynamically based on API restrictions.                                                 |
 | 0.1.6   | 2022-09-28 | [17304](https://github.com/airbytehq/airbyte/pull/17304) | Use CDK 0.1.89                                                                                          |