RPA.Cloud.Google
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: | source text |
---|---|
param text_file: | |
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
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
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
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: | source text |
---|---|
param text_file: | |
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
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
Robot Framework
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
Robot Framework
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
Robot Framework
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 folder: | name for the new directory |
---|---|
param parent_folder: | |
top level directory for new directory | |
return: | dictionary containing folder ID and folder URL |
Examples
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
Robot Framework
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
Robot Framework
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
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_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 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
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
Robot Framework
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
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
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
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
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
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
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
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_id: | drive file id |
---|---|
param file_dict: | |
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
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
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
Robot Framework
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
Robot Framework
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 |
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 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 file_id: | id of the file in the Google Drive |
---|---|
param suppress_errors: | |
on True will log warning message instead of raising an exception, defaults to False (exception is raised) | |
return: | dictionary containing file information |
Examples
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 folder: | name of the folder to identify, by default returns drive's root folder id |
---|---|
param parent_folder: | |
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
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
Robot Framework
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 |
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 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
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 |
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:
Python example:
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 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
Robot Framework
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 user_id: | user's email address. The special value me can be used to indicate the authenticated user. |
---|---|
param query: | message query |
param folder_name: | |
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
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:
Python example:
List Google Cloud Storage buckets
return: | list of buckets |
---|
Examples
Robot Framework
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
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
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:
Python example:
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_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 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
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:
Python example:
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
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
Robot Framework
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
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:
Python example:
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
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 sender: | message sender |
---|---|
param to: | message recipient |
param subject: | message subject |
param message_text: | |
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
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 | Description |
---|---|---|---|
vault_name | str, None | None | |
vault_secret_key | str, None | None | |
auth_type | str | serviceaccount |
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 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" |
param target_file: | |
save synthesized output to file, defaults to "synthesized.mp3" | |
return: | synthesized output in bytes |
Examples
Robot Framework
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 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 text: | text to translate |
---|---|
param source_language: | |
language code | |
param target_language: | |
language code | |
param mime_type: | |
text or html | |
return: | translated text |
Examples
Robot Framework
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_id: | drive file id |
---|---|
param file_dict: | |
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
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
Robot Framework
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 filename: | name of the file to upload |
---|---|
param folder: | target folder for upload |
param overwrite: | |
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 |
Examples
Upload a file into a bucket
Arguments
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 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