Skip to content

Update fields in source-connectors specifications: google-sheets #9208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jan 25, 2022
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"sourceDefinitionId": "71607ba1-c0ac-4799-8049-7f4b90dd50f7",
"name": "Google Sheets",
"dockerRepository": "airbyte/source-google-sheets",
"dockerImageTag": "0.2.7",
"dockerImageTag": "0.2.9",
"documentationUrl": "https://docs.airbyte.io/integrations/sources/google-sheets",
"icon": "google-sheets.svg"
}
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@
- name: Google Sheets
sourceDefinitionId: 71607ba1-c0ac-4799-8049-7f4b90dd50f7
dockerRepository: airbyte/source-google-sheets
dockerImageTag: 0.2.8
dockerImageTag: 0.2.9
documentationUrl: https://docs.airbyte.io/integrations/sources/google-sheets
icon: google-sheets.svg
sourceType: file
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,5 @@ COPY google_sheets_source ./google_sheets_source
ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]

LABEL io.airbyte.version=0.2.8
LABEL io.airbyte.version=0.2.9
LABEL io.airbyte.name=airbyte/source-google-sheets

Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,14 @@
"properties": {
"spreadsheet_id": {
"type": "string",
"title": "Spreadsheet ID",
"description": "The ID of the spreadsheet to be replicated."
},
"credentials": {
"type": "object",
"oneOf": [
{
"title": "Authenticate via Google (Oauth)",
"title": "Authenticate via Google (OAuth)",
"type": "object",
"required": [
"auth_type",
Expand All @@ -31,19 +32,19 @@
"client_id": {
"title": "Client ID",
"type": "string",
"description": "The Client ID of your developer application",
"description": "The Client ID of your Google Sheets developer application.",
"airbyte_secret": true
},
"client_secret": {
"title": "Client Secret",
"type": "string",
"description": "The client secret of your developer application",
"description": "The Client Secret of your Google Sheets developer application.",
"airbyte_secret": true
},
"refresh_token": {
"title": "Refresh Token",
"type": "string",
"description": "A refresh token generated using the above client ID and secret",
"description": "The token for obtaining new access token.",
"airbyte_secret": true
}
}
Expand All @@ -59,7 +60,8 @@
},
"service_account_info": {
"type": "string",
"description": "The JSON key of the service account to use for authorization",
"title": "Service Account Information.",
"description": "The JSON key of the service account to use for authorization.",
"airbyte_secret": true,
"examples": [
"{ \"type\": \"service_account\", \"project_id\": YOUR_PROJECT_ID, \"private_key_id\": YOUR_PRIVATE_KEY, ... }"
Expand Down
11 changes: 6 additions & 5 deletions docs/integrations/sources/google-sheets.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,16 @@ This section should contain a table with the following format:

At the time of writing, the [Google API rate limit](https://developers.google.com/sheets/api/limits) is 100 requests per 100 seconds per user and 500 requests per 100 seconds per project. Airbyte batches requests to the API in order to efficiently pull data and respects these rate limits. It is recommended that you use the same service user \(see the "Creating a service user" section below for more information on how to create one\) for no more than 3 instances of the Google Sheets Source to ensure high transfer speeds.

## Getting Started (Airbyte Cloud)
To configure the connector you'll need to:
## Getting Started (Airbyte Cloud)
To configure the connector you'll need to:

* Authorize your Google account via OAuth
* The ID of the spreadsheet you'd like to sync

### Setup Guide

#### Authorization
Click on the "Sign in with Google" button and authorize via your Google account.
Click on the "Sign in with Google" button and authorize via your Google account.

#### Sheet ID
you'll need the ID of the Spreadsheet you'd like to sync. To get it, navigate to the spreadsheet in your browser, then copy the portion of the URL which comes after "/d" and before "/edit" or "/view". This is the highlighted portion of the screenshot below:
Expand All @@ -57,7 +57,7 @@ To configure the Google Sheets Source for syncs, you'll need the following:
* Enable the Google Sheets API for your personal or organization account
* Enable the Google Drive API for your personal or organization account
* Create a service account with permissions to access the Google Sheets and Drive APIs
* Create a Service Account Key for the Service Account
* Create a Service Account Key for the Service Account
* Share the spreadsheets you'd like to sync with the Service Account created above
* The ID of the spreadsheet you'd like to sync

Expand Down Expand Up @@ -98,12 +98,13 @@ Finally, you'll need the ID of the Spreadsheet you'd like to sync. To get it, na
The Airbyte UI will ask for two things:

1. The spreadsheet ID
2. The content of the credentials JSON you created in the "Create a Service Account and Service Account Key" step above. This should be as simple as opening the file and copy-pasting all its contents into this field in the Airbyte UI.
2. The content of the credentials JSON you created in the "Create a Service Account and Service Account Key" step above. This should be as simple as opening the file and copy-pasting all its contents into this field in the Airbyte UI.

## Changelog

| Version | Date | Pull Request | Subject |
|:--------| :-------- | :----- |:------------------------------------------------------------------------------|
| 0.2.9 | 2022-01-25 | [9208](https://github.com/airbytehq/airbyte/pull/9208) | Update title and descriptions |
| 0.2.7 | 2021-09-27 | [8470](https://github.com/airbytehq/airbyte/pull/8470) | Migrate to the CDK |
| 0.2.6 | 2021-09-27 | [6354](https://github.com/airbytehq/airbyte/pull/6354) | Support connecting via Oauth webflow |
| 0.2.5 | 2021-09-12 | [5972](https://github.com/airbytehq/airbyte/pull/5972) | Fix full_refresh test by adding supported_sync_modes to Stream initialization |
Expand Down