SynSys.GSpreadsheetEasyAccess 1.1.0

What is GSpreadsheetEasyAccess?

A Google libraries wrapper for an easy and efficient way of interacting with Google Sheets.

Description

Original libraries have a multitude of types but the .NET example highlights the main ones, such as GoogleWebAuthorizationBroker, SheetsService, Request, ValueRange. At the same time, the general Google Sheets API documentation talks about higher level concepts, namely authentication, the difference between human and service accounts, user scopes, etc. Original libraries lack the types and methods reflecting these concepts. We wanted to see them reflected in our library.

Main types

• GCPApplication - an application on the Google Cloud Platform connected to Google Sheet API.
  It can only be used after user authentication.
• Principal - represents an object that needs to be granted access to a resource.
• OAuthSheetsScope - account scope.
• SheetModel - represents a single Google spreadsheet sheet. It consists of rows, while rows consist of cells.

These aren't all the types represented in the library, they aren't important enough to be worth mentioning.

GCPApplication

The main library type which allows you to:

• Authenticate users;
• Access an existing Google spreadsheet sheet;
• Create sheet;
• Update sheet.

Principal

The basic authentication type. There are other specific types that need to be used in your own code.

• UserAccount.
  User accounts are managed as Google accounts, they represent a developer, administrator or any other user interacting with Google Cloud. This is used for scenarios where your application needs to access resources on behalf of a user.
  Scopes need to be set for user accounts. OAuth scopes limit the actions your application can perform on behalf of the end user. Set the minimum size needed for your use case. The class implements only a part of the scopes in Google Sheets API v4.
  For additional information see end user authentication.

• ServiceAccount.
  Service accounts are managed by IAM and represent non-human users. This is used for scenarios where your application needs to access resources or perform actions on its own, for example, launching App Engine applications or interacting with Compute Engine instances. Take note that Google only allows service accounts to read public access spreadsheets! For additional information see service account authentication.

SheetModel

A type the state of which should match the desired state of a Google spreadsheet sheet. This type allows you to:

• Add new rows;
• Delete rows;
• Change cell values;
• Add new column;
• Delete column;
• Check header validity.

All changes reflected in the SheetModel instance show the GCPApplication what changes need to be made in a Google spreadsheet sheet.

Exceptions

Most methods throw exceptions. This is outlined in each method's documentation. Exception descriptions are outlined only in the corresponding exception's documentation. For example, the sheet header check method may throw InvalidSheetHeadException if the header lacks some column names.