Class Drive

Drive Class

CreateObject Method

Will create a new object (new row in a worksheet) with the specified json data. Expects a json string with the object, as well as the type/table name. If not all fields of the type are passed, those missing will be filled as "null". Fields passed but not in the table, will be ignored.

□ Syntax

C#
public static void CreateObject(string jsonObject, string objTypeName, bool runtime = true)

Parameters

jsonObject

Json string with the object to be persisted.

objTypeName

Name of the table that will hold the object.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

CreateObject Method

Will create a new object (new row in a worksheet) with the specified field values. Expects a dictionary of field names and values to be stored, as well as the type/table name. If not all type fields available in the table are passed, those missing will be filled as "null". Fields passed but not in the table, will be ignored.

□ Syntax

C#
public static void CreateObject(Dictionary<string, string> fields, string objTypeName, bool runtime = true)

Parameters

fields

Dictionary of field names and values to be stored.

objTypeName

Name of the table that will hold the object.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

CreateObjects Method

Will create a number of objects (rows in a worksheet) from the specified json data. Expects a json string with the array of objects, as well as the type/table name. If not all type fields available in the table are passed, those missing will be filled as "null". Fields passed but not in the table, will be ignored.

□ Syntax

C#
public static void CreateObjects(string jsonObjects, string objTypeName, bool runtime = true)

Parameters

jsonObjects

Json string with the object to be persisted.

objTypeName

Name of the table that will hold the object.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

CreateTable Method

Will create a new table (new worksheet on the spreadsheet) with the specified name and headers. Expects an array of field names/headers, as well as the type/table name to be used.

□ Syntax

C#
public static void CreateTable(string[] headers, string tableTypeName, bool runtime = true)

Parameters

fields

String array with the names of the table headers.

tableTypeName

The name of the table to be created.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

GetObjectsByField Method

Retrieves from the spreadsheet an array of objects found by searching with the specified criteria. Expects the table name, the name of the field to search by, and the value to search.

□ Syntax

C#
public static void GetObjectsByField(string objTypeName, string searchFieldName, string searchValue, bool runtime = true)

Parameters

objTypeName

Name of the table to search.

searchFieldName

Name of the field to search by.

searchValue

Value to search for.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

GetCellValue Method

Retrieves from the spreadsheet an object by looking into a specified cell. Expects the table name, the column and row.

□ Syntax

C#
public static void GetCellValue(string objTypeName, string column, string row, bool runtime = true)

Parameters

objTypeName

Name of the table to search.

column

Cell column.

row

Cell row.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

GetTable Method

Retrieves from the spreadsheet an array of all the objects found in the specified table. Expects the table name.

□ Syntax

C#
public static void GetTable(string tableTypeName, bool runtime = true)

Parameters

tableTypeName

The name of the table to be retrieved.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

GetAllTables Method

Retrieves from the spreadsheet the data from all tables, in the form of one or more array of objects.

□ Syntax

C#
public static void GetAllTables(bool runtime = true)

Parameters

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

UpdateObjects Method

Updates one or more objects found by searching with the specified criteria. Expects the table name, the name of the field to search by, and the value to search, as well as the object in json format to be updated in the matching objects. The json must contain only those fields that one to be updated.

□ Syntax

C#
public static void UpdateObjects(string objTypeName, string searchFieldName, string searchValue, string jsonObject, bool create, bool runtime = true)

Parameters

objTypeName

Name of the table to search.

searchFieldName

Name of the field to search by.

searchValue

Value to search for.

jsonObject

Json string with the object to be updated.

create

Indicates whether a new object should be created with the json data provided, in the case that no objects are found matching the search criteria.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

SetCellValue Method

Updates a cell value specified by column and row coordinates. Expects the table name, the column and row coordinates, and the new value to be set. * Setting values by table cell coordinates is unsafe and error prone, to be used only on very specific scenarios. *

□ Syntax

C#
public static void SetCellValue(string objTypeName, string column, string row, string value, bool runtime = true)

Parameters

objTypeName

Name of the table to search.

column

Cell column.

row

Cell row.

value

New value to be set.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

DeleteObjects Method

Deletes one or more objects (rows) from a table (worksheet) found by searching with the specified criteria. Expects the table name, the name of the field to search by, and the value to search.

□ Syntax

C#
public static void DeleteObjects(string objTypeName, string searchFieldName, string searchValue, bool runtime = true)

Parameters

objTypeName

Name of the table to search.

searchFieldName

Name of the field to search by.

searchValue

Value to search for.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

GetBinaryFile Method

Retrieves a binary file by its Drive file id.

□ Syntax

C#
public static void GetBinaryFile(string id, bool runtime = true)

Parameters

Drive id of the file to retieve.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

GetTextFile Method

Retrieves a text file by its Drive file id.

□ Syntax

C#
public static void GetTextFile(string id, bool runtime = true)

Parameters

Drive id of the file to retieve.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

GetImageFile Method

Retrieves an image file by its Drive file id.

□ Syntax

C#
public static void GetImageFile(string id, bool runtime = true)

Parameters

Drive id of the file to retrieve.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

CreateImageFile Method

Creates a file with an specified name, format, and quality.

□ Syntax

C#
public static void CreateImageFile(Texture2D texture, string name, bool usePNG = true, int jpgQuality = 90, string folderName = null, string folderId = null, bool runtime = true)

Parameters

name

Name of the image file to create.

usePNG

Flag for the image format. Use true for PNG (default), or false for JPG.

jpgQuality

Used if JPG format is set. Expects a value from 1 to 100.

folderName

Optional name of the folder to which the file should be added.

folderId

Optional id of the folder to which the file should be added.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

CreateBinaryFile Method

Creates a file with an specified name, format, and quality.

□ Syntax

C#
public static void CreateBinaryFile(byte[] fileData, string fileName, string folderName = null, string folderId = null, bool runtime = true)

Parameters

fileData

File contents.

fileName

Name of the image file to create.

folderName

Optional name of the folder to which the file should be added.

folderId

Optional id of the folder to which the file should be added.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

CreateTextFile Method

Creates a file with an specified name, format, and quality.

□ Syntax

C#
public static void CreateTextFile(string fileData, string fileName, string folderName = null, string folderId = null, bool runtime = true)

Parameters

fileData

File contents.

fileName

Name of the image file to create.

folderName

Optional name of the folder to which the file should be added.

folderId

Optional id of the folder to which the file should be added.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

DeleteFile Method

Deletes a file specified by its id.

□ Syntax

C#
public static void DeleteFile(string fileId, bool runtime = true)

Parameters

fileId

Drive id of the file to delete.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

CreateFolder Method

Creates a file with an specified name, format, and quality.

□ Syntax

C#
public static void CreateFolder(string folderName, bool runtime = true)

Parameters

folderName

Name of the folder to be created.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

DeleteFolderByName Method

Deletes a file specified by its name.

□ Syntax

C#
public static void DeleteFolderByName(string folderName, bool runtime = true)

Parameters

folderName

Name of the folder to delete.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

DeleteFolderById Method

Deletes a file specified by its id.

□ Syntax

C#
public static void DeleteFolderById(string folderId, bool runtime = true)

Parameters

folderId

Drive id of the folder to delete.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

CreateCredentialsTable Method

Will create a new table (new worksheet on the spreadsheet) used by the sessions API (signup and login).

□ Syntax

C#
public static void CreateCredentialsTable(string tableName, bool runtime = true)

Parameters

tableName

The name of the table that will be used to store the users data.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

Signup Method

Sends a signup request, along with the base information required.

□ Syntax

C#
public static void Signup(string userName, string email, string pass, string id, string tableName, bool runtime = true)

Parameters

userName

The username that will be used for login.

The email address of the user.

pass

The password for the account to be created.

A value that can be used optionally for internal unique identification purposes.

tableName

The name of the table holding the users data.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

Sends a dynamic (data provided at runtime) login request, to start a session.

□ Syntax

C#
public static void Login(string userName, string pass, string tableName, bool runtime = true)

Parameters

userName

The username that will be used for login.

pass

The account password.

tableName

The name of the table holding the users data.

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

Logout Method

Sends a login request, to start a session. Username and session token are obtained (and sent) from the session context.

□ Syntax

C#
public static void Logout(bool runtime = true)

Parameters

runtime

Bool value indicating if the request was sent from Unity Editor or running game.

Drive Class

Enum QueryType

List containing all query types. Needed if want to make custom query methods, or adding new queries on the webservice.

□ □ Syntax

C#
public enum QueryType

Drive Class

Field responseCallback

Subscribe to this event to receive the response data from Google Drive.

□ Syntax

C#
public static UnityAction<DataContainer> responseCallback

Drive Class

Field errorResponseCallback

Subscribe to this event if you want to receive error callbacks.

□ Syntax

C#
public static UnityAction<string> errorResponseCallback

Google Drive For Unity

API Reference

GoogleSheetsForUnity namespace

Drive class

Methods

Events

Enums