Skip to content

Commit fb78869

Browse files
authored
Merge pull request #209750 from Clare-Zheng82/0830-Add_GoogleSheet_connector_doc
[New feature] - Add Googlesheets connector doc
2 parents 044e360 + 846451c commit fb78869

File tree

4 files changed

+122
-0
lines changed

4 files changed

+122
-0
lines changed

articles/data-factory/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -445,6 +445,8 @@ items:
445445
href: connector-google-bigquery.md
446446
- name: Google Cloud Storage
447447
href: connector-google-cloud-storage.md
448+
- name: Google Sheets
449+
href: connector-google-sheets.md
448450
- name: Greenplum
449451
href: connector-greenplum.md
450452
- name: HBase
Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
---
2+
title: Transform data in Google Sheets (Preview)
3+
titleSuffix: Azure Data Factory & Azure Synapse
4+
description: Learn how to transform data in Google Sheets (Preview) by using Data Factory or Azure Synapse Analytics.
5+
ms.author: jianleishen
6+
author: jianleishen
7+
ms.service: data-factory
8+
ms.subservice: data-movement
9+
ms.topic: conceptual
10+
ms.custom: synapse
11+
ms.date: 08/30/2022
12+
---
13+
14+
# Transform data in Google Sheets (Preview) using Azure Data Factory or Synapse Analytics
15+
16+
[!INCLUDE[appliesto-adf-asa-md](includes/appliesto-adf-asa-md.md)]
17+
18+
This article outlines how to use Data Flow to transform data in Google Sheets (Preview). To learn more, read the introductory article for [Azure Data Factory](introduction.md) or [Azure Synapse Analytics](../synapse-analytics/overview-what-is.md).
19+
20+
> [!IMPORTANT]
21+
> This connector is currently in preview. You can try it out and give us feedback. If you want to take a dependency on preview connectors in your solution, please contact [Azure support](https://azure.microsoft.com/support/).
22+
23+
## Supported capabilities
24+
25+
This Google Sheets connector is supported for the following capabilities:
26+
27+
| Supported capabilities|IR |
28+
|---------| --------|
29+
|[Mapping data flow](concepts-data-flow-overview.md) (source/-)|① |
30+
31+
<small>*&#9312; Azure integration runtime &#9313; Self-hosted integration runtime*</small>
32+
33+
For a list of data stores that are supported as sources/sinks, see the [Supported data stores](connector-overview.md#supported-data-stores) table.
34+
35+
## Create a Google Sheets linked service using UI
36+
37+
Use the following steps to create a Google Sheets linked service in the Azure portal UI.
38+
39+
1. Browse to the Manage tab in your Azure Data Factory or Synapse workspace and select Linked Services, then select New:
40+
41+
# [Azure Data Factory](#tab/data-factory)
42+
43+
:::image type="content" source="media/doc-common-process/new-linked-service.png" alt-text="Screenshot of creating a new linked service with Azure Data Factory U I.":::
44+
45+
# [Azure Synapse](#tab/synapse-analytics)
46+
47+
:::image type="content" source="media/doc-common-process/new-linked-service-synapse.png" alt-text="Screenshot of creating a new linked service with Azure Synapse U I.":::
48+
49+
2. Search for Google Sheets (Preview) and select the Google Sheets (Preview) connector.
50+
51+
:::image type="content" source="media/connector-google-sheets/google-sheets-connector.png" alt-text="Screenshot showing selecting Google Sheets connector.":::
52+
53+
3. Configure the service details, test the connection, and create the new linked service.
54+
55+
:::image type="content" source="media/connector-google-sheets/configure-google-sheets-linked-service.png" alt-text="Screenshot of configuration for Google Sheets linked service.":::
56+
57+
## Connector configuration details
58+
59+
The following sections provide information about properties that are used to define Data Factory and Synapse pipeline entities specific to Google Sheets.
60+
61+
## Linked service properties
62+
63+
The following properties are supported for the Google Sheets linked service:
64+
65+
| Property | Description | Required |
66+
|:--- |:--- |:--- |
67+
| type | The type property must be set to **GoogleSheets**. | Yes |
68+
| apiToken | Specify an API token for the Google Sheets. Mark this field as **SecureString** to store it securely. Or, you can [reference a secret stored in Azure Key Vault](store-credentials-in-key-vault.md). |Yes |
69+
70+
**Example:**
71+
72+
```json
73+
{
74+
"name": "GoogleSheetsLinkedService",
75+
"properties": {
76+
"type": "GoogleSheets",
77+
"typeProperties": {
78+
"apiToken": {
79+
"type": "SecureString",
80+
"value": "<API token>"
81+
}
82+
}
83+
}
84+
}
85+
```
86+
87+
## Mapping data flow properties
88+
89+
When transforming data in mapping data flow, you can read resources from Google Sheets. For more information, see the [source transformation](data-flow-source.md) in mapping data flows. You can only use an [inline dataset](data-flow-source.md#inline-datasets) as source type.
90+
91+
92+
### Source transformation
93+
94+
The below table lists the properties supported by Google Sheets source. You can edit these properties in the **Source options** tab.
95+
96+
| Name | Description | Required | Allowed values | Data flow script property |
97+
| ---- | ----------- | -------- | -------------- | ---------------- |
98+
| SpreadSheet ID | The spreadsheet ID in your Google Sheets. Make sure the general access of the spreadsheet is set as **Anyone with the link**. | Yes | String | spreadSheetId |
99+
| Sheet name | The name of the sheet in the spreadsheet. | Yes | String | sheetName |
100+
| Start cell | The start cell of the sheet from where the data is required, for example A2, B4. | Yes | String | startCell |
101+
| End cell | The end cell of the sheet till where the data is required, for example F10, S600. | Yes | String | endCell |
102+
103+
#### Google Sheets source script example
104+
105+
When you use Google Sheets as source type, the associated data flow script is:
106+
107+
```
108+
source(allowSchemaDrift: true,
109+
validateSchema: false,
110+
store: 'googlesheets',
111+
format: 'rest',
112+
spreadSheetId: $spreadSheetId,
113+
startCell: 'A2',
114+
endCell: 'F10',
115+
sheetName: 'Sheet1') ~> GoogleSheetsSource
116+
```
117+
118+
## Next steps
119+
120+
For a list of data stores supported as sources and sinks by the copy activity, see [Supported data stores](copy-activity-overview.md#supported-data-stores-and-formats).
27.3 KB
Loading
15.5 KB
Loading

0 commit comments

Comments
 (0)