aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 18 insertions, 16 deletions
diff --git a/README.md b/README.md
index 9470411..04e7667 100644
--- a/README.md
+++ b/README.md
@@ -67,16 +67,21 @@ This tap:
67 - Process/send records to target 67 - Process/send records to target
68 68
69## Authentication 69## Authentication
70The [**Google Sheets Setup & Authentication**](https://drive.google.com/open?id=1FojlvtLwS0-BzGS37R0jEXtwSHqSiO1Uw-7RKQQO-C4) Google Doc provides instructions show how to configure the Google Cloud API credentials to enable Google Drive and Google Sheets APIs, configure Google Cloud to authorize/verify your domain ownership, generate an API key (client_id, client_secret), authenticate and generate a refresh_token, and prepare your tap config.json with the necessary parameters. 70
71- Enable Googe Drive APIs and Authorization Scope: https://www.googleapis.com/auth/drive.metadata.readonly 71You will need a Google developer project to use this tool. After [creating a project](https://console.developers.google.com/projectcreate) (or selecting an existing one) in your Google developers console the authentication can be configured in two different ways:
72- Enable Google Sheets API and Authorization Scope: https://www.googleapis.com/auth/spreadsheets.readonly 72
73- Tap config.json parameters: 73- Via an OAuth client which will ask the user to login to its Google user account.
74 - client_id: identifies your application 74
75 - client_secret: authenticates your application 75 Please check the [“Creating application credentials”](https://github.com/googleapis/google-api-python-client/blob/d0110cf4f7aaa93d6f56fc028cd6a1e3d8dd300a/docs/oauth-installed.md#creating-application-credentials) paragraph of the Google Python library to download your Google credentials file.
76 - refresh_token: generates an access token to authorize your session 76
77 - spreadsheet_id: unique identifier for each spreadsheet in Google Drive 77- Via a Service account (ideal for server-to-server communication)
78 - start_date: absolute minimum start date to check file modified 78
79 - user_agent: tap-name and email address; identifies your application in the Remote API server logs 79 Please check the [“Creating a service account”](https://github.com/googleapis/google-api-python-client/blob/d0110cf4f7aaa93d6f56fc028cd6a1e3d8dd300a/docs/oauth-server.md#creating-a-service-account) paragraph of the Google Python library to download your Google Service Account key file.
80
81- Tap `config.json` parameters:
82 - `credentials_file`: the path to a valid Google credentials file (Either an OAuth client secrets file or a Service Account key file)
83 - `spreadsheet_id`: unique identifier for each spreadsheet in Google Drive
84 - `start_date`: absolute minimum start date to check file modified
80 85
81## Quick Start 86## Quick Start
82 87
@@ -103,16 +108,13 @@ The [**Google Sheets Setup & Authentication**](https://drive.google.com/open?id=
103 - [singer-tools](https://github.com/singer-io/singer-tools) 108 - [singer-tools](https://github.com/singer-io/singer-tools)
104 - [target-stitch](https://github.com/singer-io/target-stitch) 109 - [target-stitch](https://github.com/singer-io/target-stitch)
105 110
1063. Create your tap's `config.json` file. Include the client_id, client_secret, refresh_token, site_urls (website URL properties in a comma delimited list; do not include the domain-level property in the list), start_date (UTC format), and user_agent (tap name with the api user email address). 1113. Create your tap's `config.json` file. Include the `credentials_file` path to your google secrets file as described in the [Authentication](#authentication) paragraph.
107 112
108 ```json 113 ```json
109 { 114 {
110 "client_id": "YOUR_CLIENT_ID", 115 "credentials_file": "PATH_TO_YOUR_GOOGLE_CREDENTIALS_FILE",
111 "client_secret": "YOUR_CLIENT_SECRET",
112 "refresh_token": "YOUR_REFRESH_TOKEN",
113 "spreadsheet_id": "YOUR_GOOGLE_SPREADSHEET_ID", 116 "spreadsheet_id": "YOUR_GOOGLE_SPREADSHEET_ID",
114 "start_date": "2019-01-01T00:00:00Z", 117 "start_date": "2019-01-01T00:00:00Z"
115 "user_agent": "tap-google-sheets <api_user_email@example.com>"
116 } 118 }
117 ``` 119 ```
118 120