airbyte-source-google-search-console 1.6.0rc1__py3-none-any.whl → 1.7.0__py3-none-any.whl

{airbyte_source_google_search_console-1.6.0rc1.dist-info → airbyte_source_google_search_console-1.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: airbyte-source-google-search-console
-Version: 1.6.0rc1
+Version: 1.7.0
 Summary: Source implementation for Google Search Console.
 License: Elv2
 Author: Airbyte

{airbyte_source_google_search_console-1.6.0rc1.dist-info → airbyte_source_google_search_console-1.7.0.dist-info}/RECORD

@@ -2,24 +2,21 @@ source_google_search_console/__init__.py,sha256=HQCPu-CK7XmVDtP9rmTdB2XyraVCc6pv
 source_google_search_console/components.py,sha256=5o8kH2xwYUvk3yjnSd6okJVF2KBUqUIF4V97xRpPAyI,2803
 source_google_search_console/config_migrations.py,sha256=Cl4SUdJpAf6wMM_vVhqjjU89NfUq9LIGJ9zNrWiBk-A,4235
 source_google_search_console/exceptions.py,sha256=iD3jYC4WxVCEKGsqQ7Vaj1tbjhJZ4S5mnSDnwFJdsIQ,1097
-source_google_search_console/manifest.yaml,sha256=zoPWyJ7gwOOK6yKAk4H92cD-N7Xg3iHtp5hTT_e80QA,10974
+source_google_search_console/manifest.yaml,sha256=m6IhF4bRwF9nAivJev2ebB8QPvoKRbYixF-5ZKSBkms,25882
 source_google_search_console/run.py,sha256=TBkPlseTERarkj6wL8AMEKgm5Xsb2drnltPVH6257-M,2195
 source_google_search_console/schemas/search_analytics_all_fields.json,sha256=iQxRh_c_yz3uGofqpo1KX571TMmzYjKScb0PtI6SN_Q,1729
 source_google_search_console/schemas/search_analytics_by_date.json,sha256=meCbWDayc1y0q-Lu-CAdjQVnsM8xZBX3BdF129UC1P8,1388
 source_google_search_console/schemas/search_analytics_by_device.json,sha256=VtoFjmmv9rx-uhSFaRn0wm4LeSxRIaexrxg2Spvbneo,1525
 source_google_search_console/schemas/search_analytics_by_page.json,sha256=KyUojZc4Lv3hPswxIJzUL5QDNsbvSugGjl_uHGF7Am4,1473
 source_google_search_console/schemas/search_analytics_by_query.json,sha256=mYc1Fu1A5TWLZCApZSjjfs_urW5BRUCPQI3rw3yQjt4,1439
-source_google_search_console/schemas/search_analytics_keyword_page_report.json,sha256=hCQZbpW9UNiCOrnUMkj4oQdzY0k8Hqoh1XkuKHvyvZw,1681
-source_google_search_console/schemas/search_analytics_keyword_site_report_by_page.json,sha256=lFpbShmTQhFyySc_JCdIOqMP9RfOIA15fpQN9xNXtTI,1626
-source_google_search_console/schemas/search_analytics_keyword_site_report_by_site.json,sha256=AVUl5x9jLL0FcStbTR-FMy-_A7uM-VlrJ-kdCBXWz_g,1755
 source_google_search_console/schemas/search_analytics_page_report.json,sha256=-b0Y0LenTchS0q9A2aQ4hIjUjXkYF8erOtyrTMhf6MM,1776
 source_google_search_console/schemas/search_analytics_site_report_by_page.json,sha256=hWKHkm1reqGGu1dNcWBe6_XkZ5tK-UaiymrYRVgxRxI,1515
 source_google_search_console/schemas/search_analytics_site_report_by_site.json,sha256=rAh6LuNy7nCrrNM9MTd0qxAVc886ecQaqWRgV63OfyA,1408
 source_google_search_console/service_account_authenticator.py,sha256=pAWKAXfwfTY3xkXvQJH0EyFphFULdCIcC47YXYTO9X8,1307
-source_google_search_console/source.py,sha256=7FD4ciRrsptU7ZIxAU2xLC37bgjKWzNkflE9ybmgpXM,9113
-source_google_search_console/spec.json,sha256=WYtFvaSqWYGm1Dt2yV9G92U78Q94rh9oarbxJe3H7xo,8470
-source_google_search_console/streams.py,sha256=T0eqhmxGPDAfFNMXFfG_vM4aYHFaHAHHAoj6s5XnjnI,18760
-airbyte_source_google_search_console-1.6.0rc1.dist-info/METADATA,sha256=smSxRuSxL5aXxK-OcjVGdpR_jLJN_-dMEtsKyMu5Oww,5624
-airbyte_source_google_search_console-1.6.0rc1.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-airbyte_source_google_search_console-1.6.0rc1.dist-info/entry_points.txt,sha256=DMcgc9bCX-Vt6hm_68pa77qS3eGdeMhg-UdlFc-XKUM,85
-airbyte_source_google_search_console-1.6.0rc1.dist-info/RECORD,,
+source_google_search_console/source.py,sha256=ddqYq3ZSNrVtGvuQQ5WnHgMLuf92AtumzdDKWGffwRo,8721
+source_google_search_console/spec.json,sha256=SensIrWvoie2aGwxmgoMYpq2jb3XP3F2myQWCVQ4db8,8980
+source_google_search_console/streams.py,sha256=yb78hGaKPDCJoFqPSun3lDhr8VhSxcLgXTLtX2ouVpY,15804
+airbyte_source_google_search_console-1.7.0.dist-info/METADATA,sha256=R-pJQZUfWv2duwzSFWta7vbn8V01TeESsaoRO5728mo,5621
+airbyte_source_google_search_console-1.7.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+airbyte_source_google_search_console-1.7.0.dist-info/entry_points.txt,sha256=DMcgc9bCX-Vt6hm_68pa77qS3eGdeMhg-UdlFc-XKUM,85
+airbyte_source_google_search_console-1.7.0.dist-info/RECORD,,

source_google_search_console/manifest.yaml

@@ -199,10 +199,305 @@ definitions:
       schema:
         $ref: "#/schemas/sitemaps"
 
+  # This stream is only used as a parent stream for search_by_keyword substreams
+  search_appearances_stream:
+    type: DeclarativeStream
+    name: search_appearances
+    retriever:
+      type: SimpleRetriever
+      requester:
+        type: HttpRequester
+        url_base: https://www.googleapis.com/webmasters/v3
+        path: "/sites/{{ sanitize_url(stream_partition.get('site_url')) }}/searchAnalytics/query"
+        http_method: POST
+        authenticator: "#/definitions/selective_authenticator"
+        request_headers:
+          Content-Type: "application/json"
+        request_body_json:
+          startDate: "{{ config.get('start_date') }}"
+          endDate: "{{ config.get('end_date') }}"
+          dimensions: ["searchAppearance"]
+          type: "{{ stream_partition.get('search_type') }}"
+          aggregationType: auto
+          dataState: "{{ config.get('data_state', 'final') }}"
+      paginator:
+        type: DefaultPaginator
+        page_token_option:
+          type: RequestOption
+          field_name: startRow
+          inject_into: body_json
+        page_size_option:
+          type: RequestOption
+          field_name: rowLimit
+          inject_into: body_json
+        pagination_strategy:
+          type: OffsetIncrement
+          page_size: 25000
+          inject_on_first_request: true
+      record_selector:
+        type: RecordSelector
+        extractor:
+          type: DpathExtractor
+          field_path:
+            - rows
+      partition_router:
+        - type: ListPartitionRouter
+          values: "{{ config['site_urls'] }}"
+          cursor_field: site_url
+        - type: ListPartitionRouter
+          values:
+            - web
+            - news
+            - image
+            - video
+          cursor_field: search_type
+    transformations:
+      - type: AddFields
+        fields:
+          - path:
+              - searchAppearance
+            value: "{{ record['keys'][0] }}"
+      - type: RemoveFields
+        field_pointers:
+          - - keys
+
+  base_search_analytics_keyword_stream:
+    type: DeclarativeStream
+    retriever:
+      type: SimpleRetriever
+      requester:
+        type: HttpRequester
+        url_base: https://www.googleapis.com/webmasters/v3
+        path: "/sites/{{  sanitize_url(stream_partition.get('site_url')) }}/searchAnalytics/query"
+        http_method: POST
+        authenticator: "#/definitions/selective_authenticator"
+        request_headers:
+          Content-Type: "application/json"
+        request_body_json:
+          startDate: "{{ stream_interval.get('start_time') }}"
+          endDate: "{{ stream_interval.get('end_time') }}"
+          dimensions: "{{ parameters.get('dimensions') }}"
+          type: "{{ stream_partition.get('parent_slice', {}).get('search_type') }}"
+          aggregationType: "{{ 'auto' if config.get('always_use_aggregation_type_auto') else parameters.get('aggregationType') }}"
+          dataState: "{{ config.get('data_state', 'final') }}"
+          dimensionFilterGroups: "{{ [{'groupType': 'and', 'filters': {'dimension': 'searchAppearance', 'operator': 'equals', 'expression': stream_partition.get('search_appearance')}}] }}"
+        error_handler:
+          type: DefaultErrorHandler
+          response_filters:
+            - type: HttpResponseFilter
+              action: FAIL
+              http_codes:
+                - 400
+              error_message: >-
+                Invalid aggregationType '{{ parameters.get('aggregationType') }}' used in the body of the API request. If you see this error, enable the
+                'always_use_aggregation_type_auto' config setting which will automatically use aggregationType=auto
+      paginator:
+        type: DefaultPaginator
+        page_token_option:
+          type: RequestOption
+          field_name: startRow
+          inject_into: body_json
+        page_size_option:
+          type: RequestOption
+          field_name: rowLimit
+          inject_into: body_json
+        pagination_strategy:
+          type: OffsetIncrement
+          page_size: 25000
+          inject_on_first_request: true
+      record_selector:
+        type: RecordSelector
+        extractor:
+          type: DpathExtractor
+          field_path:
+            - rows
+      partition_router:
+        - type: ListPartitionRouter
+          values: "{{ config['site_urls'] }}"
+          cursor_field: site_url
+        - type: SubstreamPartitionRouter
+          parent_stream_configs:
+            - type: ParentStreamConfig
+              parent_key: searchAppearance
+              partition_field: search_appearance
+              stream:
+                $ref: "#/definitions/search_appearances_stream"
+    incremental_sync:
+      type: DatetimeBasedCursor
+      cursor_field: date
+      cursor_datetime_formats:
+        - "%Y-%m-%d"
+      datetime_format: "%Y-%m-%d"
+      start_datetime:
+        type: MinMaxDatetime
+        datetime: "{{ config.get('start_date', '2021-01-01') }}"
+        datetime_format: "%Y-%m-%d"
+      end_datetime:
+        type: MinMaxDatetime
+        datetime: "{{ config.get('end_date', today_utc()) }}"
+        datetime_format: "%Y-%m-%d"
+      step: P3D
+      cursor_granularity: P1D
+
+  search_analytics_keyword_page_report_stream:
+    $ref: "#/definitions/base_search_analytics_keyword_stream"
+    name: search_analytics_keyword_page_report
+    primary_key:
+      - site_url
+      - date
+      - country
+      - device
+      - query
+      - page
+      - search_type
+    transformations:
+      - type: AddFields
+        fields:
+          - path:
+              - site_url
+            value: "{{ stream_partition['site_url'] }}"
+          - path:
+              - search_type
+            value: "{{ stream_partition.get('parent_slice', {}).get('search_type') }}"
+      - type: AddFields
+        fields:
+          - path:
+              - date
+            value: "{{ record['keys'][0] }}"
+          - path:
+              - country
+            value: "{{ record['keys'][1] }}"
+          - path:
+              - device
+            value: "{{ record['keys'][2] }}"
+          - path:
+              - query
+            value: "{{ record['keys'][3] }}"
+          - path:
+              - page
+            value: "{{ record['keys'][4] }}"
+      - type: RemoveFields
+        field_pointers:
+          - - keys
+    schema_loader:
+      type: InlineSchemaLoader
+      schema:
+        $ref: "#/schemas/search_analytics_keyword_page_report"
+    $parameters:
+      aggregationType: auto
+      dimensions:
+        - date
+        - country
+        - device
+        - query
+        - page
+
+  search_analytics_keyword_site_report_by_page_stream:
+    $ref: "#/definitions/base_search_analytics_keyword_stream"
+    name: search_analytics_keyword_site_report_by_page
+    primary_key:
+      - site_url
+      - date
+      - country
+      - device
+      - query
+      - search_type
+    transformations:
+      - type: AddFields
+        fields:
+          - path:
+              - site_url
+            value: "{{ stream_partition['site_url'] }}"
+          - path:
+              - search_type
+            value: "{{ stream_partition.get('parent_slice', {}).get('search_type') }}"
+      - type: AddFields
+        fields:
+          - path:
+              - date
+            value: "{{ record['keys'][0] }}"
+          - path:
+              - country
+            value: "{{ record['keys'][1] }}"
+          - path:
+              - device
+            value: "{{ record['keys'][2] }}"
+          - path:
+              - query
+            value: "{{ record['keys'][3] }}"
+      - type: RemoveFields
+        field_pointers:
+          - - keys
+    schema_loader:
+      type: InlineSchemaLoader
+      schema:
+        $ref: "#/schemas/search_analytics_keyword_site_report_by_page"
+    $parameters:
+      aggregationType: byPage
+      dimensions:
+        - date
+        - country
+        - device
+        - query
+
+  search_analytics_keyword_site_report_by_site_stream:
+    $ref: "#/definitions/base_search_analytics_keyword_stream"
+    name: search_analytics_keyword_site_report_by_site
+    primary_key:
+      - site_url
+      - date
+      - country
+      - device
+      - query
+      - search_type
+    transformations:
+      - type: AddFields
+        fields:
+          - path:
+              - site_url
+            value: "{{ stream_partition['site_url'] }}"
+          - path:
+              - search_type
+            value: "{{ stream_partition.get('parent_slice', {}).get('search_type') }}"
+      - type: AddFields
+        fields:
+          - path:
+              - date
+            value: "{{ record['keys'][0] }}"
+          - path:
+              - country
+            value: "{{ record['keys'][1] }}"
+          - path:
+              - device
+            value: "{{ record['keys'][2] }}"
+          - path:
+              - query
+            value: "{{ record['keys'][3] }}"
+      - type: RemoveFields
+        field_pointers:
+          - - keys
+    schema_loader:
+      type: InlineSchemaLoader
+      schema:
+        $ref: "#/schemas/search_analytics_keyword_site_report_by_site"
+    $parameters:
+      aggregationType: byProperty
+      dimensions:
+        - date
+        - country
+        - device
+        - query
+
 streams:
-  - "#/definitions/search_analytics_by_country_stream"
+  # Regular streams
   - "#/definitions/sites_stream"
   - "#/definitions/sitemaps_stream"
+  # Search Analytics streams
+  - "#/definitions/search_analytics_by_country_stream"
+  # Search Analytics Keyword streams
+  - "#/definitions/search_analytics_keyword_page_report_stream"
+  - "#/definitions/search_analytics_keyword_site_report_by_page_stream"
+  - "#/definitions/search_analytics_keyword_site_report_by_site_stream"
 
 schemas:
   search_analytics_by_country:
@@ -339,3 +634,195 @@ schemas:
               type:
                 - "null"
                 - string
+
+  search_analytics_keyword_page_report:
+    $schema: "https://json-schema.org/draft-07/schema#"
+    type: object
+    additionalProperties: true
+    properties:
+      site_url:
+        description: The URL of the website being monitored.
+        type:
+          - "null"
+          - string
+      search_type:
+        description: "The type of search (e.g., web, image, video)."
+        type:
+          - "null"
+          - string
+      date:
+        description: The date of the search data collected.
+        type:
+          - "null"
+          - string
+        format: date
+      country:
+        description: The country where the search is made.
+        type:
+          - "null"
+          - string
+      device:
+        description: "The device type used for the search (e.g., desktop, mobile)."
+        type:
+          - "null"
+          - string
+      page:
+        description: The page URL on which the keyword appears in search results.
+        type:
+          - "null"
+          - string
+      query:
+        description: The search query used to find the site.
+        type:
+          - "null"
+          - string
+      clicks:
+        description: The number of clicks for the keyword on a specific page.
+        type:
+          - "null"
+          - integer
+      impressions:
+        description: The number of times the keyword appeared in search results.
+        type:
+          - "null"
+          - integer
+      ctr:
+        description: >-
+          Click-through rate which is the percentage of clicks divided by
+          impressions.
+        type:
+          - "null"
+          - number
+        multipleOf: 1.e-25
+      position:
+        description: The average position of the keyword on search results pages.
+        type:
+          - "null"
+          - number
+        multipleOf: 1.e-25
+
+  search_analytics_keyword_site_report_by_page:
+    $schema: "https://json-schema.org/draft-07/schema#"
+    type: object
+    additionalProperties: true
+    properties:
+      site_url:
+        description: The URL of the website for which the search analytics data is retrieved.
+        type:
+          - "null"
+          - string
+      search_type:
+        description: "The type of search conducted (e.g., web, image, video)."
+        type:
+          - "null"
+          - string
+      date:
+        description: The date when the search data was recorded.
+        type:
+          - "null"
+          - string
+        format: date
+      country:
+        description: The country from which the search query originated.
+        type:
+          - "null"
+          - string
+      device:
+        description: "The device type used for the search query (e.g., desktop, mobile)."
+        type:
+          - "null"
+          - string
+      query:
+        description: The search query used by the user.
+        type:
+          - "null"
+          - string
+      clicks:
+        description: The number of times users clicked on your website link in search results.
+        type:
+          - "null"
+          - integer
+      impressions:
+        description: The number of times your website link appeared in search results.
+        type:
+          - "null"
+          - integer
+      ctr:
+        description: "Click-through rate: Number of clicks divided by the number of impressions."
+        type:
+          - "null"
+          - number
+        multipleOf: 1.e-25
+      position:
+        description: The average position of your website link in search results.
+        type:
+          - "null"
+          - number
+        multipleOf: 1.e-25
+
+  search_analytics_keyword_site_report_by_site:
+    $schema: "https://json-schema.org/draft-07/schema#"
+    type: object
+    additionalProperties: true
+    properties:
+      site_url:
+        description: The URL of the site for which the search analytics data is recorded.
+        type:
+          - "null"
+          - string
+      search_type:
+        description: >-
+          The type of search (e.g., web search, image search) that generated the
+          analytics data.
+        type:
+          - "null"
+          - string
+      date:
+        description: The date for which the search analytics data is recorded.
+        type:
+          - "null"
+          - string
+        format: date
+      country:
+        description: The country from which the search originated.
+        type:
+          - "null"
+          - string
+      device:
+        description: >-
+          The type of device used by the user during the search (e.g., desktop,
+          mobile).
+        type:
+          - "null"
+          - string
+      query:
+        description: The search query used by the user to find the site in search results.
+        type:
+          - "null"
+          - string
+      clicks:
+        description: >-
+          The number of times users clicked on the search result linking to the
+          site.
+        type:
+          - "null"
+          - integer
+      impressions:
+        description: The number of times the site was shown in search results to users.
+        type:
+          - "null"
+          - integer
+      ctr:
+        description: >-
+          Click-through rate represents the percentage of users who clicked on the
+          site's link after seeing it in search results.
+        type:
+          - "null"
+          - number
+        multipleOf: 1.e-25
+      position:
+        description: The average ranking position of the site in search results.
+        type:
+          - "null"
+          - number
+        multipleOf: 1.e-25

source_google_search_console/source.py

@@ -3,7 +3,6 @@
 #
 
 import json
-import logging
 from typing import Any, List, Mapping, Optional, Tuple, Union
 from urllib.parse import urlparse
 
@@ -20,7 +19,6 @@ from airbyte_cdk.utils import AirbyteTracedException
 from source_google_search_console.exceptions import (
     InvalidSiteURLValidationError,
     UnauthorizedOauthError,
-    UnauthorizedServiceAccountError,
     UnidentifiedError,
 )
 from source_google_search_console.service_account_authenticator import ServiceAccountAuthenticator
@@ -31,9 +29,6 @@ from source_google_search_console.streams import (
     SearchAnalyticsByDevice,
     SearchAnalyticsByPage,
     SearchAnalyticsByQuery,
-    SearchAnalyticsKeywordPageReport,
-    SearchAnalyticsKeywordSiteReportByPage,
-    SearchAnalyticsKeywordSiteReportBySite,
     SearchAnalyticsPageReport,
     SearchAnalyticsSiteReportByPage,
     SearchAnalyticsSiteReportBySite,
@@ -159,15 +154,11 @@ class SourceGoogleSearchConsole(YamlDeclarativeSource):
                 SearchAnalyticsByQuery(**stream_config),
                 SearchAnalyticsByPage(**stream_config),
                 SearchAnalyticsAllFields(**stream_config),
-                SearchAnalyticsKeywordPageReport(**stream_config),
                 SearchAnalyticsPageReport(**stream_config),
                 SearchAnalyticsSiteReportBySite(**stream_config),
                 SearchAnalyticsSiteReportByPage(**stream_config),
-                SearchAnalyticsKeywordSiteReportByPage(**stream_config),
-                SearchAnalyticsKeywordSiteReportBySite(**stream_config),
             ]
         )
-
         streams = streams + self.get_custom_reports(config=config, stream_config=stream_config)
 
         return streams

source_google_search_console/spec.json

@@ -157,6 +157,13 @@
         "examples": ["final", "all"],
         "default": "final",
         "order": 6
+      },
+      "always_use_aggregation_type_auto": {
+        "type": "boolean",
+        "title": "Always Use Aggregation Type Auto",
+        "description": "Some search analytics streams fail with a 400 error if the specified `aggregationType` is not supported. This is customer implementation dependent and if this error is encountered, enable this setting which will override the existing `aggregationType` to use `auto` which should resolve the stream errors.",
+        "default": false,
+        "order": 7
       }
     }
   },

source_google_search_console/streams.py

@@ -322,71 +322,6 @@ class SearchAnalyticsAllFields(SearchAnalytics):
     dimensions = ["date", "country", "device", "page", "query"]
 
 
-class SearchAppearance(SearchAnalytics):
-    """
-    Dimension searchAppearance can't be used with other dimension.
-    search appearance data (AMP, blue link, rich result, and so on) must be queried using a two-step process.
-    https://developers.google.com/webmaster-tools/v1/how-tos/all-your-data#search-appearance-data
-    """
-
-    primary_key = None
-    dimensions = ["searchAppearance"]
-
-
-class SearchByKeyword(SearchAnalytics):
-    """
-    Adds searchAppearance value to dimensionFilterGroups in json body
-    https://developers.google.com/webmaster-tools/v1/how-tos/all-your-data#search-appearance-data
-
-    groupType: "and" - Whether all filters in this group must return true ("and"), or one or more must return true (not yet supported).
-    filters: {"dimension": "searchAppearance", "operator": "equals", "expression": keyword}
-    """
-
-    def stream_slices(
-        self, sync_mode: SyncMode, cursor_field: List[str] = None, stream_state: Mapping[str, Any] = None
-    ) -> Iterable[Optional[Mapping[str, Any]]]:
-        search_appearance_stream = SearchAppearance(self._http_client._session.auth, self._site_urls, self._start_date, self._end_date)
-
-        for stream_slice in super().stream_slices(sync_mode, cursor_field, stream_state):
-            keywords_records = search_appearance_stream.read_records(
-                sync_mode=SyncMode.full_refresh, stream_state=stream_state, stream_slice=stream_slice
-            )
-            keywords = {record["searchAppearance"] for record in keywords_records}
-
-            for keyword in keywords:
-                filters = {"dimension": "searchAppearance", "operator": "equals", "expression": keyword}
-                stream_slice["dimensionFilterGroups"] = [{"groupType": "and", "filters": filters}]
-
-                yield stream_slice
-
-    def request_body_json(
-        self,
-        stream_state: Mapping[str, Any] = None,
-        stream_slice: Mapping[str, Any] = None,
-        next_page_token: Mapping[str, Any] = None,
-    ) -> Optional[Union[Dict[str, Any], str]]:
-        data = super().request_body_json(stream_state, stream_slice, next_page_token)
-        data["dimensionFilterGroups"] = stream_slice["dimensionFilterGroups"]
-        return data
-
-
-class SearchAnalyticsKeywordPageReport(SearchByKeyword):
-    primary_key = ["site_url", "date", "country", "device", "query", "page", "search_type"]
-    dimensions = ["date", "country", "device", "query", "page"]
-
-
-class SearchAnalyticsKeywordSiteReportByPage(SearchByKeyword):
-    primary_key = ["site_url", "date", "country", "device", "query", "search_type"]
-    dimensions = ["date", "country", "device", "query"]
-    aggregation_type = QueryAggregationType.by_page
-
-
-class SearchAnalyticsKeywordSiteReportBySite(SearchByKeyword):
-    primary_key = ["site_url", "date", "country", "device", "query", "search_type"]
-    dimensions = ["date", "country", "device", "query"]
-    aggregation_type = QueryAggregationType.by_property
-
-
 class SearchAnalyticsSiteReportBySite(SearchAnalytics):
     primary_key = ["site_url", "date", "country", "device", "search_type"]
     dimensions = ["date", "country", "device"]

source_google_search_console/schemas/search_analytics_keyword_page_report.json

@@ -1,54 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "additionalProperties": true,
-  "properties": {
-    "site_url": {
-      "description": "The URL of the website being monitored.",
-      "type": ["null", "string"]
-    },
-    "search_type": {
-      "description": "The type of search (e.g., web, image, video).",
-      "type": ["null", "string"]
-    },
-    "date": {
-      "description": "The date of the search data collected.",
-      "type": ["null", "string"],
-      "format": "date"
-    },
-    "country": {
-      "description": "The country where the search is made.",
-      "type": ["null", "string"]
-    },
-    "device": {
-      "description": "The device type used for the search (e.g., desktop, mobile).",
-      "type": ["null", "string"]
-    },
-    "page": {
-      "description": "The page URL on which the keyword appears in search results.",
-      "type": ["null", "string"]
-    },
-    "query": {
-      "description": "The search query used to find the site.",
-      "type": ["null", "string"]
-    },
-    "clicks": {
-      "description": "The number of clicks for the keyword on a specific page.",
-      "type": ["null", "integer"]
-    },
-    "impressions": {
-      "description": "The number of times the keyword appeared in search results.",
-      "type": ["null", "integer"]
-    },
-    "ctr": {
-      "description": "Click-through rate which is the percentage of clicks divided by impressions.",
-      "type": ["null", "number"],
-      "multipleOf": 1e-25
-    },
-    "position": {
-      "description": "The average position of the keyword on search results pages.",
-      "type": ["null", "number"],
-      "multipleOf": 1e-25
-    }
-  }
-}

source_google_search_console/schemas/search_analytics_keyword_site_report_by_page.json

@@ -1,50 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "additionalProperties": true,
-  "properties": {
-    "site_url": {
-      "description": "The URL of the website for which the search analytics data is retrieved.",
-      "type": ["null", "string"]
-    },
-    "search_type": {
-      "description": "The type of search conducted (e.g., web, image, video).",
-      "type": ["null", "string"]
-    },
-    "date": {
-      "description": "The date when the search data was recorded.",
-      "type": ["null", "string"],
-      "format": "date"
-    },
-    "country": {
-      "description": "The country from which the search query originated.",
-      "type": ["null", "string"]
-    },
-    "device": {
-      "description": "The device type used for the search query (e.g., desktop, mobile).",
-      "type": ["null", "string"]
-    },
-    "query": {
-      "description": "The search query used by the user.",
-      "type": ["null", "string"]
-    },
-    "clicks": {
-      "description": "The number of times users clicked on your website link in search results.",
-      "type": ["null", "integer"]
-    },
-    "impressions": {
-      "description": "The number of times your website link appeared in search results.",
-      "type": ["null", "integer"]
-    },
-    "ctr": {
-      "description": "Click-through rate: Number of clicks divided by the number of impressions.",
-      "type": ["null", "number"],
-      "multipleOf": 1e-25
-    },
-    "position": {
-      "description": "The average position of your website link in search results.",
-      "type": ["null", "number"],
-      "multipleOf": 1e-25
-    }
-  }
-}

source_google_search_console/schemas/search_analytics_keyword_site_report_by_site.json

@@ -1,50 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "additionalProperties": true,
-  "properties": {
-    "site_url": {
-      "description": "The URL of the site for which the search analytics data is recorded.",
-      "type": ["null", "string"]
-    },
-    "search_type": {
-      "description": "The type of search (e.g., web search, image search) that generated the analytics data.",
-      "type": ["null", "string"]
-    },
-    "date": {
-      "description": "The date for which the search analytics data is recorded.",
-      "type": ["null", "string"],
-      "format": "date"
-    },
-    "country": {
-      "description": "The country from which the search originated.",
-      "type": ["null", "string"]
-    },
-    "device": {
-      "description": "The type of device used by the user during the search (e.g., desktop, mobile).",
-      "type": ["null", "string"]
-    },
-    "query": {
-      "description": "The search query used by the user to find the site in search results.",
-      "type": ["null", "string"]
-    },
-    "clicks": {
-      "description": "The number of times users clicked on the search result linking to the site.",
-      "type": ["null", "integer"]
-    },
-    "impressions": {
-      "description": "The number of times the site was shown in search results to users.",
-      "type": ["null", "integer"]
-    },
-    "ctr": {
-      "description": "Click-through rate represents the percentage of users who clicked on the site's link after seeing it in search results.",
-      "type": ["null", "number"],
-      "multipleOf": 1e-25
-    },
-    "position": {
-      "description": "The average ranking position of the site in search results.",
-      "type": ["null", "number"],
-      "multipleOf": 1e-25
-    }
-  }
-}