# ReadSheet

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Unknown

Source code: <https://github.com/FrendsPlatform/Frends.GoogleSheets/tree/main/Frends.GoogleSheets.ReadSheet>

{% tabs %}
{% tab title="Parameter: Input" %}

| Name                     | Description                                                                                                                                            |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| SpreadsheetId : `String` | <p>The ID of the spreadsheet.</p><p><br>Default: <code>-</code><br>Example: <code>abcdef12345...98765ABC</code></p>                                    |
| Range : `String`         | <p>The range of cells to read from the sheet, in A1 notation.</p><p><br>Default: <code>Sheet1!A1:C10</code><br>Example: <code>Sheet1!A1:C10</code></p> |
| {% endtab %}             |                                                                                                                                                        |

{% tab title="Parameter: Connection" %}

| Name                            | Description                                                                                                                                                                                       |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 🗝ServiceAccountJson : `String` | <p>JSON string containing service account credentials.</p><p><br>Default: <code>-</code><br>Example: <code>{ "type": "service\_account", "project\_id": ..., "private\_key\_id": ... }</code></p> |
| {% endtab %}                    |                                                                                                                                                                                                   |

{% tab title="Parameter: Options" %}

| Name                             | Description                                                                                                                    |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| ThrowErrorOnFailure : `Boolean`  | <p>Whether to throw an error on failure.</p><p><br>Default: <code>True</code><br>Example: <code>false</code></p>               |
| ErrorMessageOnFailure : `String` | <p>Overrides the error message on failure.</p><p><br>Default: <code>-</code><br>Example: <code>Custom error message</code></p> |
| {% endtab %}                     |                                                                                                                                |

{% tab title="Result: Result" %}

| Name                      | Description                                                                                                                    |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Success : `Boolean`       | <p>Indicates if the task completed successfully.<br>Example: <code>true</code></p>                                             |
| Data : `Object`           | Sheet cell data read from the specified range.                                                                                 |
| Range : `String`          | Range that was read from the sheet.                                                                                            |
| MajorDimension : `String` | Major dimension of the returned data (ROWS or COLUMNS).                                                                        |
| ETag : `String`           | ETag of the response.                                                                                                          |
| Error : `Error`           | <p>Error that occurred during task execution.<br>Example: <code>object { string Message, Exception AdditionalInfo }</code></p> |
| {% endtab %}              |                                                                                                                                |

{% tab title="Changelog" %}

## Changelog

### \[1.0.0] - 2025-09-10

#### Changed

* Initial implementation
  {% endtab %}
  {% endtabs %}