airbyte-source-google-search-console 1.4.0__tar.gz → 1.4.3__tar.gz

{airbyte_source_google_search_console-1.4.0 → airbyte_source_google_search_console-1.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: airbyte-source-google-search-console
-Version: 1.4.0
+Version: 1.4.3
 Summary: Source implementation for Google Search Console.
 Home-page: https://airbyte.com
 License: Elv2
@@ -12,7 +12,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Dist: airbyte-cdk (>=0,<1)
+Requires-Dist: airbyte-cdk (==0.90.0)
 Requires-Dist: google-api-python-client (==2.105.0)
 Requires-Dist: google-auth (==2.23.3)
 Project-URL: Documentation, https://docs.airbyte.com/integrations/sources/google-search-console
@@ -21,32 +21,33 @@ Description-Content-Type: text/markdown
 
 # Google-Search-Console source connector
 
-
 This is the repository for the Google-Search-Console source connector, written in Python.
 For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/google-search-console).
 
 ## Local development
 
 ### Prerequisites
-* Python (~=3.9)
-* Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
 
+- Python (~=3.9)
+- Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
 
 ### Installing the connector
+
 From this connector directory, run:
+
 ```bash
 poetry install --with dev
 ```
 
-
 ### Create credentials
+
 **If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/google-search-console)
 to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_google_search_console/spec.yaml` file.
 Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
 See `sample_files/sample_config.json` for a sample config file.
 
-
 ### Locally running the connector
+
 ```
 poetry run source-google-search-console spec
 poetry run source-google-search-console check --config secrets/config.json
@@ -55,23 +56,28 @@ poetry run source-google-search-console read --config secrets/config.json --cata
 ```
 
 ### Running unit tests
+
 To run unit tests locally, from the connector directory run:
+
 ```
 poetry run pytest unit_tests
 ```
 
 ### Building the docker image
+
 1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
 2. Run the following command to build the docker image:
+
 ```bash
 airbyte-ci connectors --name=source-google-search-console build
 ```
 
 An image will be available on your host with the tag `airbyte/source-google-search-console:dev`.
 
-
 ### Running as a docker container
+
 Then run any of the connector commands as follows:
+
 ```
 docker run --rm airbyte/source-google-search-console:dev spec
 docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-google-search-console:dev check --config /secrets/config.json
@@ -80,18 +86,23 @@ docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integrat
 ```
 
 ### Running our CI test suite
+
 You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
+
 ```bash
 airbyte-ci connectors --name=source-google-search-console test
 ```
 
 ### Customizing acceptance Tests
+
 Customize `acceptance-test-config.yml` file to configure acceptance tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
 If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.
 
 ### Dependency Management
-All of your dependencies should be managed via Poetry. 
+
+All of your dependencies should be managed via Poetry.
 To add a new dependency, run:
+
 ```bash
 poetry add <package-name>
 ```
@@ -99,14 +110,17 @@ poetry add <package-name>
 Please commit the changes to `pyproject.toml` and `poetry.lock` files.
 
 ## Publishing a new version of the connector
+
 You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
+
 1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-google-search-console test`
-2. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)): 
-    - bump the `dockerImageTag` value in in `metadata.yaml`
-    - bump the `version` value in `pyproject.toml`
+2. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)):
+   - bump the `dockerImageTag` value in in `metadata.yaml`
+   - bump the `version` value in `pyproject.toml`
 3. Make sure the `metadata.yaml` content is up to date.
 4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/google-search-console.md`).
 5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).
 6. Pat yourself on the back for being an awesome contributor.
 7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
 8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.
+

{airbyte_source_google_search_console-1.4.0 → airbyte_source_google_search_console-1.4.3}/README.md

@@ -1,31 +1,32 @@
 # Google-Search-Console source connector
 
-
 This is the repository for the Google-Search-Console source connector, written in Python.
 For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/google-search-console).
 
 ## Local development
 
 ### Prerequisites
-* Python (~=3.9)
-* Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
 
+- Python (~=3.9)
+- Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
 
 ### Installing the connector
+
 From this connector directory, run:
+
 ```bash
 poetry install --with dev
 ```
 
-
 ### Create credentials
+
 **If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/google-search-console)
 to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_google_search_console/spec.yaml` file.
 Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
 See `sample_files/sample_config.json` for a sample config file.
 
-
 ### Locally running the connector
+
 ```
 poetry run source-google-search-console spec
 poetry run source-google-search-console check --config secrets/config.json
@@ -34,23 +35,28 @@ poetry run source-google-search-console read --config secrets/config.json --cata
 ```
 
 ### Running unit tests
+
 To run unit tests locally, from the connector directory run:
+
 ```
 poetry run pytest unit_tests
 ```
 
 ### Building the docker image
+
 1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
 2. Run the following command to build the docker image:
+
 ```bash
 airbyte-ci connectors --name=source-google-search-console build
 ```
 
 An image will be available on your host with the tag `airbyte/source-google-search-console:dev`.
 
-
 ### Running as a docker container
+
 Then run any of the connector commands as follows:
+
 ```
 docker run --rm airbyte/source-google-search-console:dev spec
 docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-google-search-console:dev check --config /secrets/config.json
@@ -59,18 +65,23 @@ docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integrat
 ```
 
 ### Running our CI test suite
+
 You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
+
 ```bash
 airbyte-ci connectors --name=source-google-search-console test
 ```
 
 ### Customizing acceptance Tests
+
 Customize `acceptance-test-config.yml` file to configure acceptance tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
 If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.
 
 ### Dependency Management
-All of your dependencies should be managed via Poetry. 
+
+All of your dependencies should be managed via Poetry.
 To add a new dependency, run:
+
 ```bash
 poetry add <package-name>
 ```
@@ -78,14 +89,16 @@ poetry add <package-name>
 Please commit the changes to `pyproject.toml` and `poetry.lock` files.
 
 ## Publishing a new version of the connector
+
 You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
+
 1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-google-search-console test`
-2. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)): 
-    - bump the `dockerImageTag` value in in `metadata.yaml`
-    - bump the `version` value in `pyproject.toml`
+2. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)):
+   - bump the `dockerImageTag` value in in `metadata.yaml`
+   - bump the `version` value in `pyproject.toml`
 3. Make sure the `metadata.yaml` content is up to date.
 4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/google-search-console.md`).
 5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).
 6. Pat yourself on the back for being an awesome contributor.
 7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
-8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.
+8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.

{airbyte_source_google_search_console-1.4.0 → airbyte_source_google_search_console-1.4.3}/pyproject.toml

@@ -5,7 +5,7 @@ requires = [
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
-version = "1.4.0"
+version = "1.4.3"
 name = "airbyte-source-google-search-console"
 description = "Source implementation for Google Search Console."
 authors = [
@@ -23,7 +23,7 @@ packages = [
 [tool.poetry.dependencies]
 python = "^3.9,<3.12"
 google-api-python-client = "==2.105.0"
-airbyte-cdk = "^0"
+airbyte-cdk = "0.90.0"
 google-auth = "==2.23.3"
 
 [tool.poetry.scripts]

airbyte_source_google_search_console-1.4.3/source_google_search_console/schemas/search_analytics_all_fields.json

@@ -0,0 +1,53 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "site_url": {
+      "description": "The URL of the site from which the data originates.",
+      "type": ["null", "string"]
+    },
+    "search_type": {
+      "description": "The type of search (e.g., web, image, video) that triggered the search result.",
+      "type": ["null", "string"]
+    },
+    "date": {
+      "description": "The date when the search query occurred.",
+      "type": ["null", "string"],
+      "format": "date"
+    },
+    "country": {
+      "description": "The country from which the search query originated.",
+      "type": ["null", "string"]
+    },
+    "device": {
+      "description": "The type of device used by the user (e.g., desktop, mobile).",
+      "type": ["null", "string"]
+    },
+    "page": {
+      "description": "The page URL that appeared in the search results.",
+      "type": ["null", "string"]
+    },
+    "query": {
+      "description": "The search query entered by the user.",
+      "type": ["null", "string"]
+    },
+    "clicks": {
+      "description": "The number of times users clicked on the search result for a specific query.",
+      "type": ["null", "integer"]
+    },
+    "impressions": {
+      "description": "The number of times a search result appeared in response to a query.",
+      "type": ["null", "integer"]
+    },
+    "ctr": {
+      "description": "Click-through rate, calculated as clicks divided by impressions.",
+      "type": ["null", "number"],
+      "multipleOf": 1e-25
+    },
+    "position": {
+      "description": "The average position of the search result on the search engine results page.",
+      "type": ["null", "number"],
+      "multipleOf": 1e-25
+    }
+  }
+}

airbyte_source_google_search_console-1.4.3/source_google_search_console/schemas/search_analytics_by_country.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "site_url": {
+      "description": "The URL of the site for which the search analytics data is being reported.",
+      "type": ["null", "string"]
+    },
+    "search_type": {
+      "description": "The type of search (web search, image search, video search, etc.) for which the data is being reported.",
+      "type": ["null", "string"]
+    },
+    "date": {
+      "description": "The date for which the search analytics data is being reported.",
+      "type": ["null", "string"],
+      "format": "date"
+    },
+    "country": {
+      "description": "The country for which the search analytics data is being reported.",
+      "type": ["null", "string"]
+    },
+    "clicks": {
+      "description": "The number of times users clicked on the search result for a specific country.",
+      "type": ["null", "integer"]
+    },
+    "impressions": {
+      "description": "The total number of times a search result was shown in search results for a specific country.",
+      "type": ["null", "integer"]
+    },
+    "ctr": {
+      "description": "The click-through rate, i.e., the ratio of clicks to impressions for a specific country.",
+      "type": ["null", "number"],
+      "multipleOf": 1e-25
+    },
+    "position": {
+      "description": "The average position at which the site's search result appeared for a specific country.",
+      "type": ["null", "number"],
+      "multipleOf": 1e-25
+    }
+  }
+}

airbyte_source_google_search_console-1.4.3/source_google_search_console/schemas/search_analytics_by_date.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "site_url": {
+      "description": "The URL of the site for which the search analytics data is being reported.",
+      "type": ["null", "string"]
+    },
+    "search_type": {
+      "description": "The type of search query (e.g., web, image, video) that generated the search analytics data.",
+      "type": ["null", "string"]
+    },
+    "date": {
+      "description": "The date for which the search analytics data is being reported.",
+      "type": ["null", "string"],
+      "format": "date"
+    },
+    "clicks": {
+      "description": "The total number of times users clicked on the search result for the site URL on the specific date.",
+      "type": ["null", "integer"]
+    },
+    "impressions": {
+      "description": "The number of times the site URL was displayed in the search results to users on the specific date.",
+      "type": ["null", "integer"]
+    },
+    "ctr": {
+      "description": "The click-through rate (CTR) represents the percentage of total impressions that resulted in a click to the site URL.",
+      "type": ["null", "number"],
+      "multipleOf": 1e-25
+    },
+    "position": {
+      "description": "The average position of the site URL in the search results pages for the specific date.",
+      "type": ["null", "number"],
+      "multipleOf": 1e-25
+    }
+  }
+}

airbyte_source_google_search_console-1.4.3/source_google_search_console/schemas/search_analytics_by_device.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "site_url": {
+      "description": "The URL of the site for which search analytics data is being provided.",
+      "type": ["null", "string"]
+    },
+    "search_type": {
+      "description": "The type of search performed (e.g., web search, image search, video search).",
+      "type": ["null", "string"]
+    },
+    "date": {
+      "description": "The date for which the search analytics data is provided.",
+      "type": ["null", "string"],
+      "format": "date"
+    },
+    "device": {
+      "description": "The type of device used by the user for the search query (e.g., desktop, mobile).",
+      "type": ["null", "string"]
+    },
+    "clicks": {
+      "description": "The total number of times a user clicked on a search result linking to the target site.",
+      "type": ["null", "integer"]
+    },
+    "impressions": {
+      "description": "The total number of times a user saw a link to the target site in search results.",
+      "type": ["null", "integer"]
+    },
+    "ctr": {
+      "description": "Click-through rate represents the ratio of clicks to impressions, showing the effectiveness of your site in attracting clicks from search results.",
+      "type": ["null", "number"],
+      "multipleOf": 1e-25
+    },
+    "position": {
+      "description": "The average position of the site's URLs in search results for the given query or queries.",
+      "type": ["null", "number"],
+      "multipleOf": 1e-25
+    }
+  }
+}

airbyte_source_google_search_console-1.4.3/source_google_search_console/schemas/search_analytics_by_page.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "site_url": {
+      "description": "The URL of the site for which the search analytics data is being reported.",
+      "type": ["null", "string"]
+    },
+    "search_type": {
+      "description": "The type of search query that led to the page being displayed in search results.",
+      "type": ["null", "string"]
+    },
+    "date": {
+      "description": "The date for which the search analytics data is reported.",
+      "type": ["null", "string"],
+      "format": "date"
+    },
+    "page": {
+      "description": "The URL of the specific page being analyzed for search analytics data.",
+      "type": ["null", "string"]
+    },
+    "clicks": {
+      "description": "The number of times a user clicked on the search result linking to the page.",
+      "type": ["null", "integer"]
+    },
+    "impressions": {
+      "description": "The number of times a page from the site appeared in the search results viewed by users.",
+      "type": ["null", "integer"]
+    },
+    "ctr": {
+      "description": "Click-through rate (CTR) is the ratio of clicks to impressions, indicating the effectiveness of the page in generating clicks.",
+      "type": ["null", "number"],
+      "multipleOf": 1e-25
+    },
+    "position": {
+      "description": "The average position at which the page appeared in search results.",
+      "type": ["null", "number"],
+      "multipleOf": 1e-25
+    }
+  }
+}

airbyte_source_google_search_console-1.4.3/source_google_search_console/schemas/search_analytics_by_query.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "site_url": {
+      "description": "The URL of the site for which the search analytics data is captured.",
+      "type": ["null", "string"]
+    },
+    "search_type": {
+      "description": "The type of search result (e.g., web, image, video) for the specific query.",
+      "type": ["null", "string"]
+    },
+    "date": {
+      "description": "The date for which the search analytics data is recorded.",
+      "type": ["null", "string"],
+      "format": "date"
+    },
+    "query": {
+      "description": "The search query for which the search analytics data is recorded.",
+      "type": ["null", "string"]
+    },
+    "clicks": {
+      "description": "The number of times users clicked on the search result for the specific query.",
+      "type": ["null", "integer"]
+    },
+    "impressions": {
+      "description": "The number of times the search result was displayed for the specific query.",
+      "type": ["null", "integer"]
+    },
+    "ctr": {
+      "description": "The click-through rate (percentage) for the specific query, calculated as clicks divided by impressions.",
+      "type": ["null", "number"],
+      "multipleOf": 1e-25
+    },
+    "position": {
+      "description": "The average position at which the search result appeared for the specific query.",
+      "type": ["null", "number"],
+      "multipleOf": 1e-25
+    }
+  }
+}

airbyte_source_google_search_console-1.4.3/source_google_search_console/schemas/search_analytics_keyword_page_report.json

@@ -0,0 +1,54 @@
+{
+  "$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
+    }
+  }
+}

airbyte_source_google_search_console-1.4.3/source_google_search_console/schemas/search_analytics_keyword_site_report_by_page.json

@@ -0,0 +1,50 @@
+{
+  "$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
+    }
+  }
+}