RPA.Cloud.Google library | Robocorp documentation

RPA.Cloud.Google

Keyword for sharing drive file or folder.

Arguments

Argument	Type	Default value	Description
file_id	str, None	None	drive file id
file_dict	dict, None	None	file dictionary returned by Search Drive Files
query	str, None	None	drive query string to find target file, needs to match 1 file
source	str, None	None	name of the folder to search files in, is by default drive's root folder
email	str, None	None	user or group email address if share type is DriveType.USER or DriveType.GROUP
domain	str, None	None	domain name if share type is DriveType.DOMAIN
role	DriveRole	READER	see DriveRole enum for possible values, defaults to DriveRole.READER
share_type	DriveType	USER	see DriveType enum for possible values, defaults to DriveType.USER
notification	bool	False	whether to send notificatin email, defaults to False
notification_message	str, None	None	optional message to include with the notification

Parameters file_id, file_dict, query and source can be used to select files to which sharing is added to.

If share is added to a folder, all files within that folder get same sharing permissions.

param file_dict:
param file_id:	drive file id
	file dictionary returned by Search Drive Files
param query:	drive query string to find target file, needs to match 1 file
param source:	name of the folder to search files in, is by default drive's root folder
param email:	user or group email address if share type is DriveType.USER or DriveType.GROUP
param domain:	domain name if share type is DriveType.DOMAIN
param role:	see `DriveRole` enum for possible values, defaults to DriveRole.READER
param share_type:
	see `DriveType` enum for possible values, defaults to DriveType.USER
param notification:
	whether to send notificatin email, defaults to False
param notification_message:
	optional message to include with the notification
return:	share response dictionary containing 'file_id' and 'permission_id'

# Add file share for a email address with email notification Add Drive Share ... query=name = 'okta.png' ... email=robocorp.tester@gmail.com ... notification=True ... notification_message=Hello. I have shared 'okta.png' with you for review. # Add file share for a domain Add Drive Share ... query=name = 'okta.png' ... domain=robocorp.com # Add folder share for a email address ${folder}= Create Drive Directory attachments-for-the-task ${share}= Add Drive Share ... file_id=${folder}[id] ... email=robocorp.tester@gmail.com ... role=writer Log To Console Share details: ${share}[file_id], ${share}[permission_id]

Analyze Sentiment

Analyze sentiment in a text file

Arguments

Argument	Type	Default value	Description
text	str, None	None	source text
text_file	str, None	None	source text file
file_type	TextType	TEXT	type of text, PLAIN_TEXT (default) or HTML
json_file	str, None	None	json target to save result, defaults to None
lang	str, None	None	language code of the source, defaults to None

param text_file:
param text:	source text
	source text file
param file_type:
	type of text, PLAIN_TEXT (default) or HTML
param json_file:
	json target to save result, defaults to None
param lang:	language code of the source, defaults to None
return:	analysis response

# For list of supported languages:

Examples

Robot Framework

${result}= Analyze Sentiment ${text} ${result}= Analyze Sentiment text_file=${CURDIR}${/}test.txt

Annotate Image

Annotate image

Arguments

Argument	Type	Default value	Description
image_file	str	null	source image file path
image_uri	str	null	Google Cloud Storage URI
json_file	str, None	None	json target to save result

param image_file:
	source image file path
param image_uri:
	Google Cloud Storage URI
param json_file:
	json target to save result
return:	detection response

Examples

Robot Framework

${result}= Annotate Image image_file=${CURDIR}${/}test.png ... json_file=${CURDIR}${/}result.json

Annotate Video

Annotate video

Arguments

Argument	Type	Default value	Description
video_file	str, None	None	local file path to input video
video_uri	str, None	None	Google Cloud Storage URI to input video
features	str, None	None	list of annotation features to detect, defaults to LABEL_DETECTION,SHOT_CHANGE_DETECTION
output_uri	str, None	None	Google Cloud Storage URI to store response json
json_file	str, None	None	json target to save result
timeout	int	300	timeout for operation in seconds

Possible values for features:

FEATURE_UNSPECIFIED, Unspecified.
LABEL_DETECTION, Label detection. Detect objects, such as dog or flower.
SHOT_CHANGE_DETECTION, Shot change detection.
EXPLICIT_CONTENT_DETECTION, Explicit content detection.
SPEECH_TRANSCRIPTION, Speech transcription.
TEXT_DETECTION, OCR text detection and tracking.
OBJECT_TRACKING, Object detection and tracking.
LOGO_RECOGNITION, Logo detection, tracking, and recognition.

If video_uri is given then that is used even if video_file is given.

param video_file:
	local file path to input video
param video_uri:
	Google Cloud Storage URI to input video
param features:	list of annotation features to detect, defaults to LABEL_DETECTION,SHOT_CHANGE_DETECTION
param output_uri:
	Google Cloud Storage URI to store response json
param json_file:
	json target to save result
param timeout:	timeout for operation in seconds
return:	annotate result

Examples

Robot Framework

${result}= Annotate Video video_uri=gs://videointelligence/movie.mp4 ... features=TEXT_DETECTION,LABEL_DETECTION ... output_uri=gs://videointelligence/movie_annotations.json ... json_file=${CURDIR}${/}videoannotations.json

Classify Text

Classify text

Arguments

Argument	Type	Default value	Description
text	str, None	None	source text
text_file	str, None	None	source text file
file_type	TextType	TEXT	type of text, PLAIN_TEXT (default) or HTML
json_file	str, None	None	json target to save result, defaults to None
lang	str, None	None	language code of the source, defaults to None

param text_file:
param text:	source text
	source text file
param file_type:
	type of text, PLAIN_TEXT (default) or HTML
param json_file:
	json target to save result, defaults to None
param lang:	language code of the source, defaults to None
return:	classify response

# For list of supported languages:

Examples

Robot Framework

${result}= Classify Text ${text} ${result}= Classify Text text_file=${CURDIR}${/}test.txt

Clear Sheet Values

Clear cell values for range of cells within a spreadsheet

Arguments

Argument	Type	Default value	Description
spreadsheet_id	str	null	target spreadsheet
sheet_range	str	null	target sheet range

param spreadsheet_id:
	target spreadsheet
param sheet_range:
	target sheet range
return:	operation result

Examples

Python

result = GOOGLE.clear_sheet_values(spreadsheet_id, "A1:C1")

Robot Framework

${result}= Clear Sheet Values ${SPREADSHEET_ID} A1:C1

Copy Sheet

Copy sheet into the spreadsheet as new sheet

Arguments

Argument	Type	Default value	Description
spreadsheet_id	str	null	id of the spreadsheet
source_sheet_name	str	null	name of the source sheet
new_sheet_name	str	null	name for the new sheet
insertSheetIndex	int, None	None	zero based index where the new sheet should be inserted, defaults to None

param spreadsheet_id:
	id of the spreadsheet
param source_sheet_name:
	name of the source sheet
param new_sheet_name:
	name for the new sheet
param insertSheetIndex:
	zero based index where the new sheet should be inserted, defaults to None
return:	operation result as an dictionary

Examples

Python

result = GOOGLE.copy_sheet( spreadsheet_id, "Existing sheet", "Copy of existing sheet" )

Robot Framework

${result}= Copy Sheet ... ${SPREADSHEET_ID} ... Existing sheet ... Copy of existing sheet

Copy Spreadsheet

Copy spreadsheet to target spreadsheet

Arguments

Argument	Type	Default value	Description
spreadsheet_id	str	null	ID of the spreadsheet to copy
target_spreadsheet_id	str	null	ID of the target spreadsheet

NOTE: service account user must have access also to target spreadsheet

param spreadsheet_id:
	ID of the spreadsheet to copy
param target_spreadsheet_id:
	ID of the target spreadsheet
return:	operation result

Examples

Python

result = GOOGLE.copy_spreadsheet( spreadsheet_id, source_spreadsheet_id, target_spreadsheet_id)

Robot Framework

${result}= Copy Spreadsheet ${SPREADSHEET_ID} ${ANOTHER_SPREADSHEET_ID}

Create Drive Directory

Create new directory to Google Drive

Arguments

Argument	Type	Default value	Description
folder	str, None	None	name for the new directory
parent_folder	str, None	None	top level directory for new directory

param parent_folder:
param folder:	name for the new directory
	top level directory for new directory
return:	dictionary containing folder ID and folder URL

Examples

${folder}= Create Drive Directory example-folder Log To Console Google Drive folder ID: ${folder}[id] Log To Console Google Drive folder URL: ${folder}[url]

Create Sheet

Create sheet into the spreadsheet

Arguments

Argument	Type	Default value	Description
spreadsheet_id	str	null	id of the spreadsheet
sheet_name	str	null	name for the new sheet

param spreadsheet_id:
	id of the spreadsheet
param sheet_name:
	name for the new sheet
return:	operation result as an dictionary

Examples

Python

result = GOOGLE.create_sheet(spreadsheet_id, "New sheet")

Robot Framework

${result}= Create Sheet ${SPREADSHEET_ID} New sheet

Create Spreadsheet

Create empty sheet with a title

Arguments

Argument	Type	Default value	Description
title	str	null	name as string

param title:	name as string
return:	created spreadsheet_id

Examples

Python

result = GOOGLE.create_spreadsheet("name of the spreadsheet")

Robot Framework

${result}= Create Sheet Example Sheet

Create Storage Bucket

Create Google Cloud Storage bucket

Arguments

Argument	Type	Default value	Description
bucket_name	str	null	name as string

param bucket_name:
	name as string
return:	bucket

Examples

Robot Framework

${result}= Create Storage Bucket visionfolder

Delete Drive File

Delete file specified by id, file dictionary or query string

Arguments

Argument	Type	Default value	Description
file_id	str, None	None	drive file id
file_dict	dict, None	None	file dictionary returned by Search Drive Files
query	str, None	None	drive query string to find target file, needs to match 1 file unless parameter multiple_ok is set to True
multiple_ok	bool	False	set to True if it is ok to perform delete on more than 1 file
suppress_errors	bool	False	on True will log warning message instead of raising an exception, defaults to False

Note. Be extra careful when calling this keyword!

param file_dict:
param file_id:	drive file id
	file dictionary returned by Search Drive Files
param query:	drive query string to find target file, needs to match 1 file unless parameter multiple_ok is set to True
param multiple_ok:
	set to True if it is ok to perform delete on more than 1 file
param suppress_errors:
	on True will log warning message instead of raising an exception, defaults to False
return:	how many files where deleted

Examples

${folder_id}= Get Drive Folder Id datafolder ${deleted}= Delete Drive File query=name contains '.json' and '${folder_id}' in parents ... multiple_ok=True

Delete Sheet

Delete a sheet from the spreadsheet.

Arguments

Argument	Type	Default value	Description
spreadsheet_id	str	null	id of the spreadsheet
sheet_name	str	null	name of the sheet to delete

param spreadsheet_id:
	id of the spreadsheet
param sheet_name:
	name of the sheet to delete
return:	operation result as an dictionary

Examples

Python

result = GOOGLE.delete_sheet(spreadsheet_id, "Sheet1")

Robot Framework

${result}= Delete Sheet ${SPREADSHEET_ID} Sheet1

Delete Storage Bucket

Delete Google Cloud Storage bucket

Arguments

Argument	Type	Default value	Description
bucket_name	str	null	name as string

Bucket needs to be empty before it can be deleted.

param bucket_name:
	name as string

Examples

Robot Framework

${result}= Delete Storage Bucket visionfolder

Delete Storage Files

Delete files in the bucket

Arguments

Argument	Type	Default value	Description
bucket_name	str	null	name as string
files	Any	null	single file, list of files or comma separated list of files

Files need to be object name in the bucket.

param bucket_name:

name as string

param files:

single file, list of files or comma separated list of files

return:

list of files which could not be deleted

Examples

Robot Framework

${result}= Delete Storage Files ${BUCKET_NAME} file1,file2

Detect Document

Detect document

Arguments

Argument	Type	Default value	Description
image_file	str, None	None	source image file path
image_uri	str, None	None	Google Cloud Storage URI
json_file	str, None	None	json target to save result

param image_file:
	source image file path
param image_uri:
	Google Cloud Storage URI
param json_file:
	json target to save result
return:	detection response

Examples

Robot Framework

${result}= Detect Document image_file=${CURDIR}${/}test.png ... json_file=${CURDIR}${/}result.json

Detect Labels

Detect labels in the image

Arguments

Argument	Type	Default value	Description
image_file	str, None	None	source image file path
image_uri	str, None	None	source image uri
json_file	str, None	None	json target to save result

param image_file:
	source image file path
param image_uri:
	source image uri
param json_file:
	json target to save result
return:	detection response

Examples

Robot Framework

${result}= Detect Labels image_file=${CURDIR}${/}test.png ... json_file=${CURDIR}${/}result.json

Detect Text

Detect text in the image

Arguments

Argument	Type	Default value	Description
image_file	str, None	None	source image file path
image_uri	str, None	None	Google Cloud Storage URI
json_file	str, None	None	json target to save result

param image_file:
	source image file path
param image_uri:
	Google Cloud Storage URI
param json_file:
	json target to save result
return:	detection response

Examples

Robot Framework

${result}= Detect Text image_file=${CURDIR}${/}test.png ... json_file=${CURDIR}${/}result.json

Download Drive Files

Download files specified by file dictionary or query string

Arguments

Argument	Type	Default value	Description
file_dict	dict, None	None	file dictionary returned by Search Drive Files
query	str, None	None	drive query string to find target files, defaults to None
source	str, None	None	source directory where query is executed
limit	int, None	None	maximum amount of files that are downloaded, defaults to None
timeout	float, None	None	maximum allowed time in seconds for download process

Parameters start, limit and timeout are used only when downloading files defined by query parameter.

param file_dict:
	file dictionary returned by Search Drive Files
param query:	drive query string to find target files, defaults to None
param source:	source directory where query is executed
param limit:	maximum amount of files that are downloaded, defaults to None
param timeout:	maximum allowed time in seconds for download process
return:	list of downloaded files

Examples

${files}= Search Drive Files query=name contains '.json' FOR ${f} IN @{files} IF ${f}[size] < 2000 Download Drive Files file_dict=${f} END END ${folder_id}= Get Drive Folder Id datafolder Download Drive Files query=name contains '.json' and '${folder_id}' in parents

Download Storage Files

Download files from a bucket

Arguments

Argument	Type	Default value	Description
bucket_name	str	null	name as string
files	Any	null	list of object names or dictionary of object names and target files

Example files: files = {"mytestimg": "image1.png", "mydoc": "google.pdf"}

param bucket_name:
	name as string
param files:	list of object names or dictionary of object names and target files
return:	list of files which could not be downloaded

Examples

Robot Framework

${result}= Download Storage Files ${BUCKET_NAME} test1.txt,test2.txt

Export Drive File

Export Google Drive file using Drive export links

Arguments

Argument	Type	Default value	Description
file_id	str, None	None	drive file id
file_dict	dict, None	None	file dictionary returned by Search Drive Files
target_file	str, None	None	name for the exported file
mimetype	str	application/pdf	export mimetype, defaults to "application/pdf"

param file_dict:
param file_id:	drive file id
	file dictionary returned by Search Drive Files
param target_file:
	name for the exported file
param mimetype:	export mimetype, defaults to "application/pdf"
return:	file path to the exported file

Examples

${files}= Drive Search Files query=name contains 'my example worksheet' Export Drive File file_dict=${files}[0]

Face Detection

Detect faces

Arguments

Argument	Type	Default value	Description
image_file	str, None	None	source image file path
image_uri	str, None	None	Google Cloud Storage URI
json_file	str, None	None	json target to save result

param image_file:
	source image file path
param image_uri:
	Google Cloud Storage URI
param json_file:
	json target to save result
return:	detection response

Examples

Robot Framework

${result}= Face Detection image_uri=gs://vision/faces.png ... json_file=${CURDIR}${/}result.json

Generic Spreadsheet Batch Update

This keyword allows to do generic batch update to the spreadsheet.

Arguments

Argument	Type	Default value	Description
spreadsheet_id	str	null	id of the spreadsheet
body	Dict	null	body of the batch update request

For more information on the batch update: https://googleapis.github.io/google-api-python-client/docs/dyn/sheets_v4.spreadsheets.html#create

List of possible requests actions (body can contain multiple at the same time):

addBanding

addChart

addConditionalFormatRule

addDataSource

addDimensionGroup

addFilterView

addNamedRange

addProtectedRange

addSheet (keyword Create sheet)

addSlicer

appendCells

appendDimension

autoFill

autoResizeDimensions

clearBasicFilter

copyPaste

createDeveloperMetadata

cutPaste

deleteBanding

deleteConditionalFormatRule

deleteDataSource

deleteDeveloperMetadata

deleteDimension

deleteDimensionGroup

deleteDuplicates

deleteEmbeddedObject

deleteFilterView

deleteNamedRange

deleteProtectedRange

deleteRange

deleteSheet (keyword Delete sheet)

duplicateFilterView

duplicateSheet (keyword Copy sheet)

findReplace

insertDimension

insertRange

mergeCells

moveDimension

pasteData

randomizeRange

refreshDataSource

repeatCell

setBasicFilter

setDataValidation

sortRange

textToColumns

trimWhitespace

unmergeCells

updateBanding

updateBorders

updateCells

updateChartSpec

updateConditionalFormatRule

updateDataSource

updateDeveloperMetadata

updateDimensionGroup

updateDimensionProperties

updateEmbeddedObjectBorder

updateEmbeddedObjectPosition

updateFilterView

updateNamedRange

updateProtectedRange

updateSheetProperties (keyword Rename sheet)

updateSlicerSpec

updateSpreadsheetProperties

param spreadsheet_id:
	id of the spreadsheet
param body:	body of the batch update request
return:	operation result as an dictionary

Examples

Python

body = {"requests": {"deleteSheet": {"sheetId": "333555666"}}} result = GOOGLE.generic_spreadsheet_batch_update(spreadsheet_id, body)

Robot Framework

${body}= Evaluate {"requests": {"deleteSheet": {"sheetId": "333555666"}}} ${result}= Generic Spreadsheet Batch Update ${SPREADSHEET_ID} ${body}

Get All Sheet Values

Get values from the range in the spreadsheet

Arguments

Argument	Type	Default value	Description
spreadsheet_id	str	null	target spreadsheet
sheet_name	str, None	None	target sheet (default first sheet)
value_render_option	str	UNFORMATTED_VALUE	how values should be represented in the output defaults to "UNFORMATTED_VALUE"
datetime_render_option	str	FORMATTED_STRING	how dates, times, and durations should be represented in the output, defaults to "FORMATTED_STRING"

param spreadsheet_id:
	target spreadsheet
param sheet_name:
	target sheet (default first sheet)
param value_render_option:
	how values should be represented in the output defaults to "UNFORMATTED_VALUE"
param datetime_render_option:
	how dates, times, and durations should be represented in the output, defaults to "FORMATTED_STRING"
return:	operation result

Examples

Python

result = GOOGLE.get_all_sheet_values(spreadsheet_id)

Robot Framework

${values}= Get All Sheet Values ${SHEET_ID} sheet1

Get Document Entities

Helper keyword for getting document entities from a Process Document response object.

Arguments

Argument	Type	Default value	Description
document	Document	null	the document response object

For examples. see Process Document keyword

param document:	the document response object
return:	detected entities in the document response as a list

Get Document Languages

Helper keyword for getting detected languages from a Process Document response object.

Arguments

Argument	Type	Default value	Description
document	Document	null	the document response object

For examples. see Process Document keyword

param document:	the document response object
return:	detected languages in the document response as a list

Get Drive File By Id

Get file dictionary by its file id.

Arguments

Argument	Type	Default value	Description
file_id	str	null	id of the file in the Google Drive
suppress_errors	bool	False	on True will log warning message instead of raising an exception, defaults to False (exception is raised)

param suppress_errors:
param file_id:	id of the file in the Google Drive
	on True will log warning message instead of raising an exception, defaults to False (exception is raised)
return:	dictionary containing file information

Examples

${file_dict}= Get Drive File By ID file_id=${FILE_ID}

Get Drive Folder Id

Get file id for the folder

Arguments

Argument	Type	Default value	Description
folder	str, None	None	name of the folder to identify, by default returns drive's root folder id
parent_folder	str, None	None	can be used to narrow search by giving parent folder name
details	bool	False	on True will return folder dictionary, on False (default) folder id is returned

param parent_folder:
param folder:	name of the folder to identify, by default returns drive's root folder id
	can be used to narrow search by giving parent folder name
param details:	on True will return folder dictionary, on False (default) folder id is returned
return:	file id of the folder or file dictionary when details = True

Examples

${root_id}= Get Drive Folder Id # returns Drive root folder id ${folder_id}= Get Drive Folder Id subdir

Get Sheet Values

Get values from the range in the spreadhsheet

Arguments

Argument	Type	Default value	Description
spreadsheet_id	str	null	target spreadsheet
sheet_range	str, None	None	target sheet range
value_render_option	str	UNFORMATTED_VALUE	how values should be represented in the output defaults to "UNFORMATTED_VALUE"
datetime_render_option	str	FORMATTED_STRING	how dates, times, and durations should be represented in the output, defaults to "FORMATTED_STRING"

param spreadsheet_id:
	target spreadsheet
param sheet_range:
	target sheet range
param value_render_option:
	how values should be represented in the output defaults to "UNFORMATTED_VALUE"
param datetime_render_option:
	how dates, times, and durations should be represented in the output, defaults to "FORMATTED_STRING"
return:	operation result

Examples

Python

result = GOOGLE.get_sheet_values(spreadsheet_id, "A1:C1")

Robot Framework

${values}= Get Sheet Values ${SPREADSHEET_ID} A1:C1

Get Spreadsheet Basic Information

Get title, id, url and sheets information from the spreadsheet.

Arguments

Argument	Type	Default value	Description
spreadsheet_id	str	null	ID of the spreadsheet

param spreadsheet_id:
	ID of the spreadsheet
return:	operation result as an dictionary

Get Spreadsheet Details

Returns spreadsheet information as a dictionary.

Arguments

Argument	Type	Default value	Description
spreadsheet_id	str	null	ID of the spreadsheet

param spreadsheet_id:
	ID of the spreadsheet
return:	operation result as an dictionary

Get Storage Bucket

Get Google Cloud Storage bucket

Arguments

Argument	Type	Default value	Description
bucket_name	str	null	name as string

param bucket_name:
	name as string
return:	bucket

Examples

Robot Framework

${result}= Get Bucket visionfolder

Init Apps Script

Initialize Google Apps Script client

Arguments

Argument	Type	Default value	Description
service_account	str, None	None	file path to service account file
credentials	str, None	None	file path to credentials file
use_robocorp_vault	bool, None	None	use credentials in Robocorp Vault
scopes	list, None	None	list of extra authentication scopes
token_file	str, None	None	file path to token file

param service_account:
	file path to service account file
param credentials:
	file path to credentials file
param use_robocorp_vault:
	use credentials in Robocorp Vault
param scopes:	list of extra authentication scopes
param token_file:
	file path to token file

Init Document AI

Initialize Google Cloud Document AI client

Arguments

Argument	Type	Default value	Description
service_account	str, None	None	file path to service account file
region	str, None	us	region of the service
use_robocorp_vault	bool, None	None	use credentials in Robocorp Vault
token_file	str, None	None	file path to token file

param service_account:
	file path to service account file
param region:	region of the service
param use_robocorp_vault:
	use credentials in Robocorp Vault
param token_file:
	file path to token file

Robot Framework example:

# Init using Service Account from a file Init Document AI ${CURDIR}${/}service_account.json region=eu # Init using OAuth token from a file and default "us" region Init Document AI ${CURDIR}${/}token.json # Init using service account file from the Robocorp Vault Set Robocorp Vault ... vault_name=DocumentAI ... vault_secret_key=google-sa Init Document AI region=eu use_robocorp_vault=True

Python example:

GOOGLE = Google() GOOGLE.set_robocorp_vault("DocumentAI", "google-sa") GOOGLE.init_document_ai(region="eu", use_robocorp_vault=True)

Init Drive

Initialize Google Drive client

Arguments

Argument	Type	Default value	Description
service_account	str, None	None	file path to service account file
credentials	str, None	None	file path to credentials file
use_robocorp_vault	bool, None	None	use credentials in Robocorp Vault
scopes	list, None	None	list of extra authentication scopes
token_file	str, None	None	file path to token file

param service_account:
	file path to service account file
param credentials:
	file path to credentials file
param use_robocorp_vault:
	use credentials in Robocorp Vault
param scopes:	list of extra authentication scopes
param token_file:
	file path to token file

Init Gmail

Initialize Google Gmail client

Arguments

Argument	Type	Default value	Description
service_account	str, None	None	file path to service account file
credentials	str, None	None	file path to credentials file
use_robocorp_vault	bool, None	None	use credentials in Robocorp Vault
scopes	list, None	None	list of extra authentication scopes
token_file	str, None	None	file path to token file

param service_account:
	file path to service account file
param credentials:
	file path to credentials file
param use_robocorp_vault:
	use credentials in Robocorp Vault
param scopes:	list of extra authentication scopes
param token_file:
	file path to token file

Init Natural Language

Initialize Google Cloud Natural Language client

Arguments

Argument	Type	Default value	Description
service_account	str, None	None	file path to service account file
use_robocorp_vault	bool, None	None	use credentials in Robocorp Vault
token_file	str, None	None	file path to token file

param service_account:
	file path to service account file
param use_robocorp_vault:
	use credentials in Robocorp Vault
param token_file:
	file path to token file

Init Sheets

Initialize Google Sheets client

Arguments

Argument	Type	Default value	Description
service_account	str, None	None	file path to service account file
credentials	str, None	None	file path to credentials file
use_robocorp_vault	bool, None	None	use credentials in Robocorp Vault
scopes	list, None	None	list of extra authentication scopes
token_file	str, None	None	file path to token file

param service_account:
	file path to service account file
param credentials:
	file path to credentials file
param use_robocorp_vault:
	use credentials in Robocorp Vault
param scopes:	list of extra authentication scopes
param token_file:
	file path to token file

Init Speech To Text

Initialize Google Cloud Speech to Text client

Arguments

Argument	Type	Default value	Description
service_account	str, None	None	file path to service account file
use_robocorp_vault	bool, None	None	use credentials in Robocorp Vault
token_file	str, None	None	file path to token file

param service_account:
	file path to service account file
param use_robocorp_vault:
	use credentials in Robocorp Vault
param token_file:
	file path to token file

Init Storage

Initialize Google Cloud Storage client

Arguments

Argument	Type	Default value	Description
service_account	str, None	None	file path to service account file
use_robocorp_vault	bool, None	None	use credentials in Robocorp Vault
token_file	str, None	None	file path to token file

param service_account:
	file path to service account file
param use_robocorp_vault:
	use credentials in Robocorp Vault
param token_file:
	file path to token file

Init Text To Speech

Initialize Google Cloud Text to Speech client

Arguments

Argument	Type	Default value	Description
service_account	str, None	None	file path to service account file
use_robocorp_vault	bool, None	None	use credentials in Robocorp Vault
token_file	str, None	None	file path to token file

param service_account:
	file path to service account file
param use_robocorp_vault:
	use credentials in Robocorp Vault
param token_file:
	file path to token file

Init Translation

Initialize Google Cloud Translation client

Arguments

Argument	Type	Default value	Description
project_identifier	str	null	identifier for Translation project
service_account	str, None	None	file path to service account file
use_robocorp_vault	bool, None	None	use credentials in Robocorp Vault
token_file	str, None	None	file path to token file

param project_identifier:
	identifier for Translation project
param service_account:
	file path to service account file
param use_robocorp_vault:
	use credentials in Robocorp Vault
param token_file:
	file path to token file

Init Video Intelligence

Initialize Google Cloud Video Intelligence client

Arguments

Argument	Type	Default value	Description
service_account	str, None	None	file path to service account file
use_robocorp_vault	bool, None	None	use credentials in Robocorp Vault
token_file	str, None	None	file path to token file

param service_account:
	file path to service account file
param use_robocorp_vault:
	use credentials in Robocorp Vault
param token_file:
	file path to token file

Init Vision

Initialize Google Cloud Vision client

Arguments

Argument	Type	Default value	Description
service_account	str, None	None	file path to service account file
use_robocorp_vault	bool, None	None	use credentials in Robocorp Vault
token_file	str, None	None	file path to token file

param service_account:
	file path to service account file
param use_robocorp_vault:
	use credentials in Robocorp Vault
param token_file:
	file path to token file

Insert Sheet Values

Insert values into sheet cells

Arguments

Argument	Type	Default value	Description
spreadsheet_id	str	null	target spreadsheet
sheet_range	str	null	target sheet range
values	list	null	list of values to insert into sheet
major_dimension	str	COLUMNS	major dimension of the values, default COLUMNS
value_input_option	str	USER_ENTERED	controls whether input strings are parsed or not, default USER_ENTERED

param spreadsheet_id:
	target spreadsheet
param sheet_range:
	target sheet range
param values:	list of values to insert into sheet
param major_dimension:
	major dimension of the values, default COLUMNS
param value_input_option:
	controls whether input strings are parsed or not, default USER_ENTERED
return:	operation result

Examples

Python

values = [[11, 12, 13], ['aa', 'bb', 'cc']] result = GOOGLE.insert_sheet_values(spreadsheet_id, "A:C", values)

Robot Framework

${values} Evaluate [[11, 12, 13], ['aa', 'bb', 'cc']] ${result}= Insert Sheet Values ${SPREADSHEET_ID} A:B ${values} ${result}= Insert Sheet Values ${SPREADSHEET_ID} A:B ${values} ROWS

List Messages

List messages

Arguments

Argument	Type	Default value	Description
user_id	str	null	user's email address. The special value me can be used to indicate the authenticated user.
query	str	null	message query
folder_name	str, None	None	path where attachments are saved, default current directory
label_ids	list, None	None	message label ids
max_results	int, None	None	maximum number of message to return
include_json	bool	False	include original response json
include_spam	bool	False	include messages from SPAM and TRASH

param folder_name:
param user_id:	user's email address. The special value me can be used to indicate the authenticated user.
param query:	message query
	path where attachments are saved, default current directory
param label_ids:
	message label ids
param max_results:
	maximum number of message to return
param include_json:
	include original response json
param include_spam:
	include messages from SPAM and TRASH
return:	messages

Examples

${messages}= List Messages me ... from:mika@robocorp.com ... folder_name=${CURDIR}${/}target ... include_json=True FOR ${msg} IN @{messages} Log Many ${msg} END

List Processors

List existing document AI processors from given project and region.

Arguments

Argument	Type	Default value	Description
project_id	str	null	Google Cloud project ID
region	str	null	Google Cloud region of the processor

Requires documentai.processors.list permission.

param project_id:
	Google Cloud project ID
param region:	Google Cloud region of the processor
return:	list of available processors as a list

Robot Framework example:

@{processors}= List Processors ${PROJECT_ID} eu FOR ${p} IN @{processors} # name: projects/PROJECT_ID/locations/REGION/processors/PROCESSOR_ID Log To Console Processor name: ${p.name} Log To Console Processor type: ${p.type_} Log To Console Processor display name: ${p.display_name} END

Python example:

processors = GOOGLE.list_processors(PROJECT_ID, "eu") for p in processors: print(f"Processor name: {p.name}") print(f"Processor type: {p.type_}") print(f"Processor name: {p.display_name}")

List Shared Drive Files

Keyword for listing shared files in the source folder.

Arguments

Argument	Type	Default value	Description
query	str, None	None	drive query string to find target files
source	str, None	None	source directory where query is executed

Alias keyword for Search Drive Files which can be used to list only files which have been shared.

param query:	drive query string to find target files
param source:	source directory where query is executed
return:	list of shared files

Examples

${shared}= List Shared Drive Files source=subfolder FOR ${file} IN @{shared} Log To Console ${file} END

List Storage Buckets

List Google Cloud Storage buckets

return:	list of buckets

Examples

Robot Framework

${buckets}= List Storage Buckets FOR ${bucket} IN @{buckets} Log ${bucket} END

List Storage Files

List files in the bucket

Arguments

Argument	Type	Default value	Description
bucket_name	str	null	name as string

param bucket_name:
	name as string
return:	list of object names in the bucket

Examples

Robot Framework

${files}= List Storage Files ${BUCKET_NAME} FOR ${bucket} IN @{files} Log ${file} END

List Supported Voices

List supported voices for the speech

Arguments

Argument	Type	Default value	Description
language_code	str, None	None	voice languages to list, defaults to None (all)

param language_code:
	voice languages to list, defaults to None (all)
return:	list of supported voices

Examples

Robot Framework

${result}= List Supported Voices en-US

Load Document Response

Loads the binary object saved by Save Document Response into documentai.Document format which is accessible by helper keywords.

Arguments

Argument	Type	Default value	Description
filepath	str	null	source file to read binary document object from

param filepath:	source file to read binary document object from
return:	processed document response object

Robot Framework example:

# load previously saved response ${document}= Load Document Response ${CURDIR}${/}google_processed.response ${entities}= Get Document Entities ${document}

Python example:

document = GOOGLE.load_document_response("google_doc.response") entities = GOOGLE.get_document_entities(document) for ent in entities: print(ent)

Move Drive File

Move file specified by id, file dictionary or query string into target folder

Arguments

Argument	Type	Default value	Description
file_id	str, None	None	drive file id
file_dict	dict, None	None	file dictionary returned by Search Drive Files
query	str, None	None	drive query string to find target file, needs to match 1 file
source	str, None	None	name of the folder to move file from, is by default drive's root folder id
target	str, None	None	name of the folder to move file into, is by default drive's root folder id
multiple_ok	bool	False	if True then moving more than 1 file

param file_dict:
param file_id:	drive file id
	file dictionary returned by Search Drive Files
param query:	drive query string to find target file, needs to match 1 file
param source:	name of the folder to move file from, is by default drive's root folder id
param target:	name of the folder to move file into, is by default drive's root folder id
param multiple_ok:
	if True then moving more than 1 file
return:	list of file ids

Examples

${source_id}= Get Drive Folder Id sourcefolder ${query}= Set Variable name contains '.json' and '${sourceid}' in parents ${files}= Move Drive File query=${query} folder=target_folder multiple_ok=True

Process Document

Process document in the Google Cloud platform using given document processor ID within given project and region.

Arguments

Argument	Type	Default value	Description
project_id	str	null	Google Cloud project ID
region	str	null	Google Cloud region of the processor
processor_id	str	null	ID of the document processor
file_path	str	null	filepath of the document to process
mime_type	str, None	None	given mime type of document (optional), if not given it is auto detected

For a full list of Document response object attributes, please reference this page.

param project_id:
	Google Cloud project ID
param region:	Google Cloud region of the processor
param processor_id:
	ID of the document processor
param file_path:
	filepath of the document to process
param mime_type:
	given mime type of document (optional), if not given it is auto detected
return:	processed document response object

Robot Framework example:

${document}= Process Document ... project_id=${GOOGLE_PROJECT_ID} ... region=eu ... processor_id=${RECEIPT_PROCESSOR_ID} ... file_path=${CURDIR}${/}mydocument.pdf ${entities}= Get Document Entities ${document} FOR ${ent} IN @{entities} Log To Console Entity: ${ent} END ${languages}= Get Document Languages ${document} Log To Console Languages: ${languages}

Python example:

document = GOOGLE.process_document( project_id=PROJECT_ID, region="eu", processor_id=PROCESSOR_ID, file_path="./files/mydocument.pdf", ) entities = GOOGLE.get_document_entities(document) for ent in entities: print(ent) languages = GOOGLE.get_document_languages(document) for lang in languages: print(lang)

Recognize Text From Audio

Recognize text in the audio file

Arguments

Argument	Type	Default value	Description
audio_file	str, None	None	local audio file path
audio_uri	str, None	None	Google Cloud Storage URI
encoding	str, None	None	audio file encoding
language_code	str	en_US	language in the audio
audio_channel_count	int	2	number of audio channel
sample_rate	int, None	None	rate in hertz, for example 16000

param audio_file:
	local audio file path
param audio_uri:
	Google Cloud Storage URI
param encoding:	audio file encoding
param language_code:
	language in the audio
param audio_channel_count:
	number of audio channel
param sample_rate:
	rate in hertz, for example 16000
return:	recognized texts

Examples

Robot Framework

${result}= Recognize Text From Audio audio_file=${CURDIR}${/}test.mp3

Remove All Drive Shares

Keyword for removing all shares from selected files (only owner permission is retained).

Arguments

Argument	Type	Default value	Description
file_id	str, None	None	drive file id
file_dict	dict, None	None	file dictionary returned by Search Drive Files
query	str, None	None	drive query string to find target files
suppress_errors	bool	False	on True will log warning message instead of raising an exception, defaults to False (exception is raised)

param file_dict:
param file_id:	drive file id
	file dictionary returned by Search Drive Files
param query:	drive query string to find target files
param suppress_errors:
	on True will log warning message instead of raising an exception, defaults to False (exception is raised)
return:	list of dictionaries containing information of file permissions removed

Examples

${removed}= Remove All Drive Shares file_id=${FOLDER_ID}

Keyword for removing share from file or folder based on criteria.

Arguments

Argument	Type	Default value	Description
email	str, None	None	email address of the permission to remove
domain	str, None	None	domain name of the permission to remove
permission_id	str, None	None	id of the permission to remove
file_id	str, None	None	drive file id
file_dict	dict, None	None	file dictionary returned by Search Drive Files
query	str, None	None	drive query string to find target files
source	str, None	None	name of the folder to search files in, is by default drive's root folder
suppress_errors	bool	False	on True will log warning message instead of raising an exception, defaults to False (exception is raised)

Parameters file_id, file_dict, query and source can be used to select files from which sharing is removed.

Parameters email, domain or permission_id can be used to select which share is removed from selected files.

param permission_id:
param email:	email address of the permission to remove
param domain:	domain name of the permission to remove
	id of the permission to remove
param file_id:	drive file id
param file_dict:
	file dictionary returned by Search Drive Files
param query:	drive query string to find target files
param source:	name of the folder to search files in, is by default drive's root folder
param suppress_errors:
	on True will log warning message instead of raising an exception, defaults to False (exception is raised)
return:	list of dictionaries containing information of file permissions removed

Examples

# Remove domain shares for files in the folder ${FOLDER_NAME} ${removed}= Remove Drive Share By Criteria ... domain=robocorp.com ... source=${FOLDER_NAME} # Remove email share for a file ${removed}= Remove Drive Share By Criteria ... query=name = 'okta.png' ... email=robocorp.tester@gmail.com

Keyword for removing share permission of file or folder permission id.

Arguments

Argument	Type	Default value	Description
permission_id	str	null	id of the permission to remove
file_id	str, None	None	drive file id
file_dict	dict, None	None	file dictionary returned by Search Drive Files
query	str, None	None	drive query string to find target file, needs to match 1 file
source	str, None	None	name of the folder to search files in, is by default drive's root folder
suppress_errors	bool	False	on True will log warning message instead of raising an exception, defaults to False (exception is raised)

Parameters file_id, file_dict, query and source can be used to select files from which sharing is removed.

param permission_id:
	id of the permission to remove
param file_id:	drive file id
param file_dict:
	file dictionary returned by Search Drive Files
param query:	drive query string to find target file, needs to match 1 file
param source:	name of the folder to search files in, is by default drive's root folder
param suppress_errors:
	on True will log warning message instead of raising an exception, defaults to False (exception is raised)
return:	dictionary of permission response

Examples

${share}= Add Drive Share ... query=name = 'sharable-files' and mimeType = 'application/vnd.google-apps.folder' ... email=robocorp.tester@gmail.com # # Remove Drive Share By Permission Id ${share}[permission_id] ${share}[file_id]

Rename Sheet

Rename sheet in the spreadsheet

Arguments

Argument	Type	Default value	Description
spreadsheet_id	str	null	id of the spreadsheet
sheet_name	str	null	existing name of the sheet
new_sheet_name	str	null	name for the new sheet

param spreadsheet_id:
	id of the spreadsheet
param sheet_name:
	existing name of the sheet
param new_sheet_name:
	name for the new sheet
return:	operation result as an dictionary

Examples

Python

result = GOOGLE.rename_sheet(spreadsheet_id, "Sheet1", "New name")

Robot Framework

${result}= Rename Sheet ${SPREADSHEET_ID} Sheet1 New name

Run Script

Run the Google Apps Script function

Arguments

Argument	Type	Default value	Description
script_id	str	null	Google Script identifier
function_name	str	null	name of the script function
parameters	dict, None	None	script function parameters as a dictionary

param script_id:
	Google Script identifier
param function_name:
	name of the script function
param parameters:
	script function parameters as a dictionary
raises AssertionError:
	thrown when Google Script returns errors

Examples

&{params}= Create Dictionary formid=aaad4232 formvalues=1,2,3 ${response}= Run Script abc21397283712da submit_form ${params} Log Many ${response}

Save Document Response

Save Process Document response into a binary file.

Arguments

Argument	Type	Default value	Description
document	Document	null	response document object
filepath	str	null	target file to save binary object into

param document:	response document object
param filepath:	target file to save binary object into

Robot Framework example:

${document}= Process Document ... project_id=101134120147 ... region=eu ... processor_id=${RECEIPT_PROCESSOR} ... file_path=${file_in} # save response for later Save Document Response ${CURDIR}${/}google_processed.response

Python example:

document = GOOGLE.process_document( project_id=PROJECT_ID, region="eu", processor_id=PROCESSOR_ID, file_path="./files/receipt1.jpg", ) GOOGLE.save_document_response(document, "receipt.response")

Search Drive Files

Search Google Drive for files matching query string

Arguments

Argument	Type	Default value	Description
query	str, None	None	search string, defaults to None which means that all files and folders are returned
recurse	bool	False	set to True if search should recursive
source	str, None	None	source directory where query is executed

param query:	search string, defaults to None which means that all files and folders are returned
param recurse:	set to True if search should recursive
param source:	source directory where query is executed
return:	list of files

Examples

${files}= Search Drive Files query=name contains 'hello' ${files}= Search Drive Files query=modifiedTime > '2020-06-04T12:00:00' ${files}= Search Drive Files query=mimeType contains 'image/' or mimeType contains 'video/' ${files}= Search Drive Files query=name contains '.yaml' recurse=True ${files}= Search Drive Files query=name contains '.yaml' source=datadirectory

Send Message

Send an email message.

Arguments

Argument	Type	Default value	Description
sender	str	null	message sender
to	str	null	message recipient
subject	str	null	message subject
message_text	str	null	message body text
attachments	list, None	None
html	bool	False	set to True if message body is HTML (default False, plain text)

param message_text:
param sender:	message sender
param to:	message recipient
param subject:	message subject
	message body text
param attachment:
	list of files to add as message attachments
param html:	set to True if message body is HTML (default False, plain text)
return:	sent message

Examples

${attachments}= Create List ... ${CURDIR}${/}random.txt ... ${CURDIR}${/}source.png Send Message me ... mika@robocorp.com ... message subject ... body of the message ... ${attachments}

Set Robocorp Vault

Set Robocorp Vault name and secret key name :param vault_name: Robocorp Vault name :param vault_secret_key: Robocorp Vault secret key name :param auth_type: either serviceaccount or token

Arguments

Argument	Type	Default value
vault_name	str, None	None
vault_secret_key	str, None	None
auth_type	str	serviceaccount

Synthesize Speech

Synthesize speech synchronously

Arguments

Argument	Type	Default value	Description
text	str	null	input text to synthesize
language	str	en-US	voice language, defaults to "en-US"
name	str	en-US-Standard-B	voice name, defaults to "en-US-Standard-B"
gender	str	MALE	voice gender, defaults to "MALE"
encoding	str	MP3	result encoding type, defaults to "MP3"
target_file	str	synthesized.mp3	save synthesized output to file, defaults to "synthesized.mp3"

param target_file:
param text:	input text to synthesize
param language:	voice language, defaults to "en-US"
param name:	voice name, defaults to "en-US-Standard-B"
param gender:	voice gender, defaults to "MALE"
param encoding:	result encoding type, defaults to "MP3"
	save synthesized output to file, defaults to "synthesized.mp3"
return:	synthesized output in bytes

Examples

Robot Framework

${result}= Synthesize Speech ${text}

To Column Letter

Convert a column number into a column letter(s).

Arguments

Argument	Type	Default value	Description
number	int	null	column number to convert

param number:	column number to convert
return:	column letter(s)

Translate

Translate text

Arguments

Argument	Type	Default value	Description
text	list, str	null	text to translate
source_language	str, None	None	language code
target_language	str, None	None	language code
mime_type	TextType, None	None	text or html

param source_language:
param text:	text to translate
	language code
param target_language:
	language code
param mime_type:
	text or html
return:	translated text

Examples

Robot Framework

${result}= Translate ${TEXT} target_language=de

Update Drive File

Update file specified by id, file dictionary or query string

Arguments

Argument	Type	Default value	Description
file_id	str, None	None	drive file id
file_dict	dict, None	None	file dictionary returned by Drive Search Files
query	str, None	None	drive query string to find target file, needs to match 1 file
source	str, None	None	source directory where query is executed
action	UpdateAction	star	update action, default star file
multiple_ok	bool	False	set to True if it is ok to perform update on more than 1 file

Possible actions: - star - unstar - trash - untrash

param file_dict:
param file_id:	drive file id
	file dictionary returned by Drive Search Files
param query:	drive query string to find target file, needs to match 1 file
param source:	source directory where query is executed
param action:	update action, default star file
param multiple_ok:
	set to True if it is ok to perform update on more than 1 file
return:	number of updated files

Examples

${folder_id}= Get Drive Folder Id datafolder ${updated}= Update Drive File query=name contains '.json' and '${folder_id}' in parents ... action=star ... multiple_ok=True

Update Sheet Values

Insert values into sheet cells

Arguments

Argument	Type	Default value	Description
spreadsheet_id	str	null	target spreadsheet
sheet_range	str	null	target sheet range
values	list	null	list of values to insert into sheet
major_dimension	str	COLUMNS	major dimension of the values, default COLUMNS
value_input_option	str	USER_ENTERED	controls whether input strings are parsed or not, default USER_ENTERED

param spreadsheet_id:
	target spreadsheet
param sheet_range:
	target sheet range
param values:	list of values to insert into sheet
param major_dimension:
	major dimension of the values, default COLUMNS
param value_input_option:
	controls whether input strings are parsed or not, default USER_ENTERED
return:	operation result

Examples

Python

row_data = [[11, 12, 13], ['aa', 'bb', 'cc']] result = GOOGLE.update_sheet_values( spreadsheet_id, "A1:C1", row_data, "ROWS )

Robot Framework

${row} Evaluate [[22, 33 ,44]] ${result}= Update Sheet Values ... ${SPREADSHEET_ID} ... A6:C6 ... ${row} ... ROWS

Upload Drive File

Upload files into Drive

Arguments

Argument	Type	Default value	Description
filename	str, None	None	name of the file to upload
folder	str, None	None	target folder for upload
overwrite	bool	False	set to True if already existing file should be overwritten
make_dir	bool	False	set to True if folder should be created if it does not exist

param overwrite:
param filename:	name of the file to upload
param folder:	target folder for upload
	set to True if already existing file should be overwritten
param make_dir:	set to True if folder should be created if it does not exist
return:	uploaded file id

Argument	Type	Default value	Description
bucket_name	str	null	name as string
filename	str	null	filepath to upload file
target_name	str	null	target object name

param bucket_name:
	name as string
param filename:	filepath to upload file
param target_name:
	target object name

Examples

Robot Framework

Upload Storage File ${BUCKET_NAME} ... ${CURDIR}${/}test.txt test.txt

Upload Storage Files

Upload files into a bucket

Arguments

Argument	Type	Default value	Description
bucket_name	str	null	name as string
files	dict	null	dictionary of object names and filepaths

Example files: files = {"mytestimg": "image1.png", "mydoc": "google.pdf"}

param bucket_name:
	name as string
param files:	dictionary of object names and filepaths

Examples

Robot Framework

${files}= Create Dictionary ... test1.txt ${CURDIR}${/}test1.txt ... test2.txt ${CURDIR}${/}test2.txt Upload Storage Files ${BUCKET_NAME} ${files}