◷ Reading Time: 39 minutes
Google Authenticate
Allows a specific google user account to use a Google API command. E.g., Google Calendar, Gmail.
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Authentication Token: name of the parameter that holds the Authentication result.
○ Email: the user’s Google email you want to use for the automation.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Authentication Token: name of the parameter that holds the Authentication result.
○ Email: the user’s Google email you want to use for the automation.
This Command will open your browser and prompts to be granted access. Make sure to select the correct account that corresponds to your Email parameter value.
The Authentication is only to be done once for each Google account you want to use. After this, you will be able to use the other Gsuite Extension’s Commands.
This will generate a token file which is saved in your window’s %appdata% folder. Deleting this file will prompt the grant access page again.
Google Drive
Upload File
Uploads the specified file to your Google Drive instance.
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the Uploaded File (Id, Name)
○ Email: the user’s Google email you want to use for the automation.
○ File Path: the local path of the file that you want to upload.
○ Folder Id (Optional): the ID of the folder where you want to upload the file. (Result of Find Files And Folders or Create Folder command or from the google drive url)
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Supports Team Drives: If True, the activity supports team drives. Default is false.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the Uploaded File (Id, Name)
○ Email: the user’s Google email you want to use for the automation.
○ File Path: the local path of the file that you want to upload.
○ Folder Id (Optional): the ID of the folder where you want to upload the file. (Result of Find Files And Folders or Create Folder command or from the google drive url)
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Supports Team Drives: If True, the activity supports team drives. Default is false.
Download File
Downloads a file from the user’s instance of Google Drive.
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the result (file path of the downloaded file)
○ Email: the user’s Google email you want to use for the automation.
○ File Id: the ID of the file that you want to download.
○ File Location: the file path where downloaded file will be saved. Will automatically create if the directory doesn’t exist.
○ Override File Name (Optional): override the original file name to be downloaded.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Supports Team Drives: If True, the activity supports team drives. Default is false.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the result (file path of the downloaded file)
○ Email: the user’s Google email you want to use for the automation.
○ File Id: the ID of the file that you want to download.
○ File Location: the file path where downloaded file will be saved. Will automatically create if the directory doesn’t exist.
○ Override File Name (Optional): override the original file name to be downloaded.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Supports Team Drives: If True, the activity supports team drives. Default is false.
Copy File
Copies a file on Google Drive.
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the Copied File (Id, Name)
○ Email: the user’s Google email you want to use for the automation.
○ File Id: the ID of the file that you want to copy.
○ File Name (Optional): the new name of the file that you want to copy.
○ Folder Id (Optional): the ID of the parent folder where you want to copy the file, no value will copy to the same parent folder.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Supports Team Drives: If True, the activity supports team drives. Default is false.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the Copied File (Id, Name)
○ Email: the user’s Google email you want to use for the automation.
○ File Id: the ID of the file that you want to copy.
○ File Name (Optional): the new name of the file that you want to copy.
○ Folder Id (Optional): the ID of the parent folder where you want to copy the file, no value will copy to the same parent folder.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Supports Team Drives: If True, the activity supports team drives. Default is false.
Create Folder
Creates a new folder inside the Google Drive.
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the Created Folder (Id, Name)
○ Email: the user’s Google email you want to use for the automation.
○ Folder Id (Optional): the ID of the folder where you want to create the folder. No value will create in root.
○ Folder Name: the name of the new folder.
○ Folder Description (Optional): the description of the new folder.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Supports Team Drives: If True, the activity supports team drives. Default is false.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the Created Folder (Id, Name)
○ Email: the user’s Google email you want to use for the automation.
○ Folder Id (Optional): the ID of the folder where you want to create the folder. No value will create in root.
○ Folder Name: the name of the new folder.
○ Folder Description (Optional): the description of the new folder.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Supports Team Drives: If True, the activity supports team drives. Default is false.
Move File
Moves a file hosted on Google Drive to a different folder.
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the Moved File (Id, Name)
○ Email: the user’s Google email you want to use for the automation.
○ File Id: the ID of the file that you want to move.
○ Folder Id: the ID of the folder where you want to move the file.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Supports Team Drives: If True, the activity supports team drives. Default is false.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the Moved File (Id, Name)
○ Email: the user’s Google email you want to use for the automation.
○ File Id: the ID of the file that you want to move.
○ Folder Id: the ID of the folder where you want to move the file.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Supports Team Drives: If True, the activity supports team drives. Default is false.
Delete File/Folder
Deletes a file/folder hosted on Google Drive
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the result (if successful: true or false)
○ Email: the user’s Google email you want to use for the automation.
○ File Id: the ID of the file/folder that you want to delete
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Supports Team Drives: If True, the activity supports team drives. Default is false.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the result (if successful: true or false)
○ Email: the user’s Google email you want to use for the automation.
○ File Id: the ID of the file/folder that you want to delete
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Supports Team Drives: If True, the activity supports team drives. Default is false.
Find Files and Folders
Looks for files on a Google Drive instance and returns the file information
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the List of Find Results (IsFolder, MimeType, Name, Id)
○ Email: the user’s Google email you want to use for the automation.
○ Max Results (Optional): limit the number of files that you want to return. By default (when empty) the value is 50; put 0 to return all records.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Search Expression: specifies the search parameters (e.g., file types, file names) that you want to use to locate files and folders. For example name contains ‘X’. For more information about search query, see https://developers.google.com/drive/api/v3/reference/query-ref and https://developers.google.com/drive/api/v3/search-files.
○ Supports Team Drives: If True, the activity supports team drives. Default is false.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the List of Find Results (IsFolder, MimeType, Name, Id)
○ Email: the user’s Google email you want to use for the automation.
○ Max Results (Optional): limit the number of files that you want to return. By default (when empty) the value is 50; put 0 to return all records.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Search Expression: specifies the search parameters (e.g., file types, file names) that you want to use to locate files and folders. For example name contains ‘X’. For more information about search query, see https://developers.google.com/drive/api/v3/reference/query-ref and https://developers.google.com/drive/api/v3/search-files.
○ Supports Team Drives: If True, the activity supports team drives. Default is false.
Create File Permission
Creates permission for the specific file
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the Permission Id.
○ Domain (Optional if grant type is not Domain): The domain to be granted permission.
○ Email: the user’s Google email you want to use for the automation.
○ Email Address (Optional if Grant Type is not User or Group): a user or group email to be granted permission.
○ Email Message (Optional): the notification email message to be sent.
○ Expiration Date (Optional): expiration date (mm/dd/yyyy) applicable only for User or Group.
○ File Id: the ID of the file that you want to create permissions for.
○ Grant Type: specify the entity to be granted permission.
– User: grants permission to a single user.
– Group: grants permission to a group.
– Domain: grants permission to a domain.
– Anyone: grants permission to anyone with access to the company domain.
○ Role: specify the file permission role to be granted. Owner can only be assigned for same email domain and the file should be created from Google Drive (Google Apps) or from this extension such as Google Docs and Sheets.
– Reader: the entity can read and download the file.
– Writer: the entity can edit the file.
– Owner: the entity owns the file.
– Commenter: the entity can comment on the file.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Supports Team Drives: If True, the activity supports team drives. Default is false.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the Permission Id.
○ Domain (Optional if grant type is not Domain): The domain to be granted permission.
○ Email: the user’s Google email you want to use for the automation.
○ Email Address (Optional if Grant Type is not User or Group): a user or group email to be granted permission.
○ Email Message (Optional): the notification email message to be sent.
○ Expiration Date (Optional): expiration date (mm/dd/yyyy) applicable only for User or Group.
○ File Id: the ID of the file that you want to create permissions for.
○ Grant Type: specify the entity to be granted permission.
– User: grants permission to a single user.
– Group: grants permission to a group.
– Domain: grants permission to a domain.
– Anyone: grants permission to anyone with access to the company domain.
○ Role: specify the file permission role to be granted. Owner can only be assigned for same email domain and the file should be created from Google Drive (Google Apps) or from this extension such as Google Docs and Sheets.
– Reader: the entity can read and download the file.
– Writer: the entity can edit the file.
– Owner: the entity owns the file.
– Commenter: the entity can comment on the file.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Supports Team Drives: If True, the activity supports team drives. Default is false.
Update File Permission
Updates the permission of a specified file
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Email: the user’s Google email you want to use for the automation.
○ Copy Result To (Optional): Target parameter to hold the Updated Permission (Id, GrantType, Role, Email, Domain).
○ File Id: the ID of the file that you want to update permission.
○ Permission: the ID of the permission that you want to update.
○ Remove Expiration: if true, the previous expiration date for the permission is removed.
○ Role: specify the file permission role to be granted. Owner can only be assigned for same email domain and the file should be created from Google Drive (Google Apps) or from this extension such Google Docs and Sheets.
– Reader: the entity can read and download the file.
– Writer: the entity can edit the file.
– Owner: the entity owns the file.
– Commenter: the entity can comment on the file.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Supports Team Drives: If True, the activity supports team drives. Default is false.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Email: the user’s Google email you want to use for the automation.
○ Copy Result To (Optional): Target parameter to hold the Updated Permission (Id, GrantType, Role, Email, Domain).
○ File Id: the ID of the file that you want to update permission.
○ Permission: the ID of the permission that you want to update.
○ Remove Expiration: if true, the previous expiration date for the permission is removed.
○ Role: specify the file permission role to be granted. Owner can only be assigned for same email domain and the file should be created from Google Drive (Google Apps) or from this extension such Google Docs and Sheets.
– Reader: the entity can read and download the file.
– Writer: the entity can edit the file.
– Owner: the entity owns the file.
– Commenter: the entity can comment on the file.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Supports Team Drives: If True, the activity supports team drives. Default is false.
Delete File Permission
Deletes permission to a file
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the result (if successful: true or false).
○ Email: the user’s Google email you want to use for the automation.
○ File Id: the ID of the file that you want to delete permission.
○ Permission: the ID of the permission that you want to delete.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Supports Team Drives: If True, the activity supports team drives. Default is false.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the result (if successful: true or false).
○ Email: the user’s Google email you want to use for the automation.
○ File Id: the ID of the file that you want to delete permission.
○ Permission: the ID of the permission that you want to delete.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Supports Team Drives: If True, the activity supports team drives. Default is false.
Get File Permissions
Gets the permissions for a specified file.
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the result of List of Permissions (Id, GrantType, Role, Email, Domain).
○ Email: the user’s Google email you want to use for the automation.
○ File Id: the ID of the file that you want to get existing permissions.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Supports Team Drives: If True, the activity supports team drives. Default is false.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the result of List of Permissions (Id, GrantType, Role, Email, Domain).
○ Email: the user’s Google email you want to use for the automation.
○ File Id: the ID of the file that you want to get existing permissions.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Supports Team Drives: If True, the activity supports team drives. Default is false.
Gmail
Send Mail Message
Sends an email using the Gmail platform
Summary
Properties
○ Attachments (Optional): The path to the items that you want attached in the email. Comma separated for multiple values.
○ Bcc (Optional): the hidden recipients of the email. Comma separated for multiple values.
○ Body: the body of the email.
○ Cc (Optional): the secondary recipients of the email. Comma separated for multiple values.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the mail id.
○ Email: the user’s Google email you want to use for the automation.
○ Is Draft?: If True, the message is saved as a draft instead of being sent.
○ Is Html?: If True, the body of the message is sent as HTML.
○ Subject: the subject of the email.
○ To: the main recipients of the email. Comma separated for multiple values.
○ Attachments (Optional): The path to the items that you want attached in the email. Comma separated for multiple values.
○ Bcc (Optional): the hidden recipients of the email. Comma separated for multiple values.
○ Body: the body of the email.
○ Cc (Optional): the secondary recipients of the email. Comma separated for multiple values.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the mail id.
○ Email: the user’s Google email you want to use for the automation.
○ Is Draft?: If True, the message is saved as a draft instead of being sent.
○ Is Html?: If True, the body of the message is sent as HTML.
○ Subject: the subject of the email.
○ To: the main recipients of the email. Comma separated for multiple values.
Change Labels
Updates the labels for a specified email. Overwriting the existing labels.
Summary
Properties
○ Add Labels: specifies the labels to apply. Comma separated for multiple values.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the result (if successful: true or false)
○ Email: the user’s Google email you want to use for the automation.
○ Mail Ids: the mail id/s to change the label. Comma separated for multiple values.
○ Remove Labels: specifies the labels to remove. Comma separated for multiple values.
○ Add Labels: specifies the labels to apply. Comma separated for multiple values.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the result (if successful: true or false)
○ Email: the user’s Google email you want to use for the automation.
○ Mail Ids: the mail id/s to change the label. Comma separated for multiple values.
○ Remove Labels: specifies the labels to remove. Comma separated for multiple values.
Get Mail Messages
Searches for and gets emails from a specified Gmail account.
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the result (if successful: true or false)
○ Email: the user’s Google email you want to use for the automation.
○ Include Spam/Trash: to include spam/trash messages.
○ Labels Filter (Optional): specifies the labels that you want to include in your search parameters. Comma separated for multiple values.
○ Max Results (Optional): specifies the maximum number of mails that you want to return. Default value is 50; put 0 to return all records.
○ Search Expression (Optional): the search parameters that you want to use to get mail messages. See https://support.google.com/mail/answer/7190?hl=en for more information.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the result (if successful: true or false)
○ Email: the user’s Google email you want to use for the automation.
○ Include Spam/Trash: to include spam/trash messages.
○ Labels Filter (Optional): specifies the labels that you want to include in your search parameters. Comma separated for multiple values.
○ Max Results (Optional): specifies the maximum number of mails that you want to return. Default value is 50; put 0 to return all records.
○ Search Expression (Optional): the search parameters that you want to use to get mail messages. See https://support.google.com/mail/answer/7190?hl=en for more information.
Google Calendar
Create Event
Creates a new event in the specified Calendar
Summary
Properties
○ Attendees (Optional): attendee email addresses you want to invite to the new event. Comma separated for multiple values.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the Create Event Result (Id, Url, Title).
○ Custom Recurrence Rule (Optional): creates recurring meeting using RRULE format. Ex: RRULE:FREQ=DAILY;COUNT=2. See https://developers.google.com/calendar/concepts/events-calendars#instances_and_exceptions and https://tools.ietf.org/html/rfc5545.
○ Description (Optional): description of the event. Can contain HTML.
○ Email: the user’s Google email you want to use for the automation.
○ End Date: the (exclusive) end date and time (mm/dd/yyyy time) of the event. Ex: 12/25/1990 12:30PM.
○ Ends after occurrence (Optional): integer value to repeat recurrence after how many occurrence is set.
○ Ends on (Optional): Recurrence to end on the specified date (mm/dd/yyyy).
○ Is All Day?: If True, the event will be whole day.
○ Location (Optional): geographic location of the event as free-form text.
○ Recurrence (Optional): set to recurring event
– None: no recurrence
– Daily: will recur daily
– Weekly: will recur weekly
– Yearly: will recur yearly
– WeeklyOnWeekDays: will recur weekly on week days
○ Send Updates: send notifications about the creation of the new event. ALL is the default value.
– All: notification is sent to all attendees.
– ExternalOnly: notification is sent only if the attendee has a non-Google calendar.
○ Start Date: the (inclusive) start date and time (mm/dd/yyyy time) of the event. Ex: 12/25/1990 12:30AM.
○ Status (Optional): status of the event. CONFIRMED is the default value.
– Confirmed: creates the event as confirmed
– Tentative: creates the event as tentative.
– Cancelled: creates the event as canceled.
○ Time Zone (Optional): formatted IANA Time Zone Database name. Ex:Europe/Zurich. See http://www.timezoneconverter.com/cgi-bin/zonehelp.
○ Title (Optional): title of the event.
○ Visibility (Optional): visibility of the event. DEFAULT is the default value.
– Default: creates the event with default visibility.
– Public: creates the event with public visibility. The event is visible to anyone with access to the calendar.
– Private: creates the event as private. The event is visible only to the participants.
– Confidential: creates the event as confidential.
– None: no notification is sent. Attendees with a non-Google calendar cannot see the event.
○ Attendees (Optional): attendee email addresses you want to invite to the new event. Comma separated for multiple values.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the Create Event Result (Id, Url, Title).
○ Custom Recurrence Rule (Optional): creates recurring meeting using RRULE format. Ex: RRULE:FREQ=DAILY;COUNT=2. See https://developers.google.com/calendar/concepts/events-calendars#instances_and_exceptions and https://tools.ietf.org/html/rfc5545.
○ Description (Optional): description of the event. Can contain HTML.
○ Email: the user’s Google email you want to use for the automation.
○ End Date: the (exclusive) end date and time (mm/dd/yyyy time) of the event. Ex: 12/25/1990 12:30PM.
○ Ends after occurrence (Optional): integer value to repeat recurrence after how many occurrence is set.
○ Ends on (Optional): Recurrence to end on the specified date (mm/dd/yyyy).
○ Is All Day?: If True, the event will be whole day.
○ Location (Optional): geographic location of the event as free-form text.
○ Recurrence (Optional): set to recurring event
– None: no recurrence
– Daily: will recur daily
– Weekly: will recur weekly
– Yearly: will recur yearly
– WeeklyOnWeekDays: will recur weekly on week days
○ Send Updates: send notifications about the creation of the new event. ALL is the default value.
– All: notification is sent to all attendees.
– ExternalOnly: notification is sent only if the attendee has a non-Google calendar.
○ Start Date: the (inclusive) start date and time (mm/dd/yyyy time) of the event. Ex: 12/25/1990 12:30AM.
○ Status (Optional): status of the event. CONFIRMED is the default value.
– Confirmed: creates the event as confirmed
– Tentative: creates the event as tentative.
– Cancelled: creates the event as canceled.
○ Time Zone (Optional): formatted IANA Time Zone Database name. Ex:Europe/Zurich. See http://www.timezoneconverter.com/cgi-bin/zonehelp.
○ Title (Optional): title of the event.
○ Visibility (Optional): visibility of the event. DEFAULT is the default value.
– Default: creates the event with default visibility.
– Public: creates the event with public visibility. The event is visible to anyone with access to the calendar.
– Private: creates the event as private. The event is visible only to the participants.
– Confidential: creates the event as confidential.
– None: no notification is sent. Attendees with a non-Google calendar cannot see the event.
Update Event
Modifies the specified details of an event
Summary
Properties
○ Attendees (Optional): attendee email addresses you want to invite to the new event. Comma separated for multiple values.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the result (if successful: true or false).
○ Custom Recurrence Rule (Optional): creates recurring meeting using RRULE format. Ex: RRULE:FREQ=DAILY;COUNT=2. See https://developers.google.com/calendar/concepts/events-calendars#instances_and_exceptions and https://tools.ietf.org/html/rfc5545.
○ Description (Optional): description of the event. Can contain HTML.
○ Email: the user’s Google email you want to use for the automation.
○ End Date (Optional): the (exclusive) end date and time (mm/dd/yyyy time) of the event. Ex: 12/25/1990 12:30PM.
○ Ends after occurrence (Optional): integer value to repeat recurrence after how many occurrence is set.
○ Ends on (Optional): Recurrence to end on the specified date (mm/dd/yyyy).
○ Event Id: Id of the event to be updated.
○ Is All Day? (Optional) : If true, the event will be whole day.
○ Location (Optional): geographic location of the event as free-form text.
○ Recurrence (Optional): set to recurring event
– None: no recurrence – will delete existing recurrence
– Daily: will recur daily
– Weekly: will recur weekly
– Yearly: will recur yearly
– WeeklyOnWeekDays: will recur weekly on week days
○ Send Updates: send notifications about the updated event. All is the default value.
– All: notification is sent to all attendees.
– ExternalOnly: notification is sent only if the attendee has a non-Google calendar.
– None: no notification is sent. Attendees with a non-Google calendar cannot see the event.
○ Start Date (Optional): the (inclusive) start date and time (mm/dd/yyyy time) of the event. Ex: 12/25/1990 12:30AM
○ Status (Optional): status of the event. Confirmed is the default value.
– Confirmed: creates the event as confirmed
– Tentative: creates the event as tentative.
– Cancelled: creates the event as canceled.
○ Time Zone (Optional): formatted IANA Time Zone Database name. Ex:Europe/Zurich. See http://www.timezoneconverter.com/cgi-bin/zonehelp.
○ Title (Optional): title of the event.
○ Visibility (Optional): visibility of the event. Default is the default value.
– Default: creates the event with default visibility.
– Public: creates the event with public visibility. The event is visible to anyone with access to the calendar.
– Private: creates the event as private. The event is visible only to the participants.
– Confidential: creates the event as confidential.
○ Attendees (Optional): attendee email addresses you want to invite to the new event. Comma separated for multiple values.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the result (if successful: true or false).
○ Custom Recurrence Rule (Optional): creates recurring meeting using RRULE format. Ex: RRULE:FREQ=DAILY;COUNT=2. See https://developers.google.com/calendar/concepts/events-calendars#instances_and_exceptions and https://tools.ietf.org/html/rfc5545.
○ Description (Optional): description of the event. Can contain HTML.
○ Email: the user’s Google email you want to use for the automation.
○ End Date (Optional): the (exclusive) end date and time (mm/dd/yyyy time) of the event. Ex: 12/25/1990 12:30PM.
○ Ends after occurrence (Optional): integer value to repeat recurrence after how many occurrence is set.
○ Ends on (Optional): Recurrence to end on the specified date (mm/dd/yyyy).
○ Event Id: Id of the event to be updated.
○ Is All Day? (Optional) : If true, the event will be whole day.
○ Location (Optional): geographic location of the event as free-form text.
○ Recurrence (Optional): set to recurring event
– None: no recurrence – will delete existing recurrence
– Daily: will recur daily
– Weekly: will recur weekly
– Yearly: will recur yearly
– WeeklyOnWeekDays: will recur weekly on week days
○ Send Updates: send notifications about the updated event. All is the default value.
– All: notification is sent to all attendees.
– ExternalOnly: notification is sent only if the attendee has a non-Google calendar.
– None: no notification is sent. Attendees with a non-Google calendar cannot see the event.
○ Start Date (Optional): the (inclusive) start date and time (mm/dd/yyyy time) of the event. Ex: 12/25/1990 12:30AM
○ Status (Optional): status of the event. Confirmed is the default value.
– Confirmed: creates the event as confirmed
– Tentative: creates the event as tentative.
– Cancelled: creates the event as canceled.
○ Time Zone (Optional): formatted IANA Time Zone Database name. Ex:Europe/Zurich. See http://www.timezoneconverter.com/cgi-bin/zonehelp.
○ Title (Optional): title of the event.
○ Visibility (Optional): visibility of the event. Default is the default value.
– Default: creates the event with default visibility.
– Public: creates the event with public visibility. The event is visible to anyone with access to the calendar.
– Private: creates the event as private. The event is visible only to the participants.
– Confidential: creates the event as confidential.
Add Event Attendees
Adds an attendee to an existing event
Summary
Properties
○ Attendees: attendee email addresses you want to invite to the event. Comma separated for multiple values.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials. ○ Copy Result To (Optional): Target parameter to hold the result (if successful: true or false)
○ Email: the user’s Google email you want to use for the automation.
○ Event Id: id of the event to add attendees
○ Send Updates: send notifications about the added attendees of the event. All is the default value.
– All: notification is sent to all attendees.
– ExternalOnly: notification is sent only if the attendee has a non-Google calendar.
– None: no notification is sent. Attendees with a non-Google calendar cannot see the event.
○ Attendees: attendee email addresses you want to invite to the event. Comma separated for multiple values.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials. ○ Copy Result To (Optional): Target parameter to hold the result (if successful: true or false)
○ Email: the user’s Google email you want to use for the automation.
○ Event Id: id of the event to add attendees
○ Send Updates: send notifications about the added attendees of the event. All is the default value.
– All: notification is sent to all attendees.
– ExternalOnly: notification is sent only if the attendee has a non-Google calendar.
– None: no notification is sent. Attendees with a non-Google calendar cannot see the event.
Search Events
Search events from the specified calendar that matches the search parameters
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the Search Event result (Id, Title, Description, Status, IsRecurringEvent, StartDate, EndDate)
○ Email: the user’s Google email you want to use for the automation.
○ End Date (Optional): Searches for events that occur before the given date. Ex: 12/25/1990.
○ Max Results: specifies the maximum number of events that you want to return. By default (when empty) the value is 50; put 0 to return all records.
○ Search Expression (Optional): Filter events whose title, description, location, or attendee list fields matching the free text query
○ Start Date (Optional): searches for events occurring after the specified date (mm/dd/yyyy). Ex: 12/25/1990
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the Search Event result (Id, Title, Description, Status, IsRecurringEvent, StartDate, EndDate)
○ Email: the user’s Google email you want to use for the automation.
○ End Date (Optional): Searches for events that occur before the given date. Ex: 12/25/1990.
○ Max Results: specifies the maximum number of events that you want to return. By default (when empty) the value is 50; put 0 to return all records.
○ Search Expression (Optional): Filter events whose title, description, location, or attendee list fields matching the free text query
○ Start Date (Optional): searches for events occurring after the specified date (mm/dd/yyyy). Ex: 12/25/1990
Delete Event
Deletes a specific event
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the result (if successful: true or false)
○ Email: the user’s Google email you want to use for the automation.
○ Event Id: id of the event to be deleted
○ Recurrence Option: specifies the recurring events you want to delete. ThisEvent is the default value.
– ThisEvent: deletes the specified event only.
– ThisAndFollowingEvents: deletes this event and all subsequent events.
– All: deletes all events in the series, including completed events.
○ Send Updates: send notifications about the deletion of the event. All is the default value.
– All: notification is sent to all attendees.
– ExternalOnly: notification is sent only if the attendee has a non-Google calendar.
– None: no notification is sent. Attendees with a non-Google calendar cannot see the event.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the result (if successful: true or false)
○ Email: the user’s Google email you want to use for the automation.
○ Event Id: id of the event to be deleted
○ Recurrence Option: specifies the recurring events you want to delete. ThisEvent is the default value.
– ThisEvent: deletes the specified event only.
– ThisAndFollowingEvents: deletes this event and all subsequent events.
– All: deletes all events in the series, including completed events.
○ Send Updates: send notifications about the deletion of the event. All is the default value.
– All: notification is sent to all attendees.
– ExternalOnly: notification is sent only if the attendee has a non-Google calendar.
– None: no notification is sent. Attendees with a non-Google calendar cannot see the event.
Google Docs
Create Document
Creates a new document in the user’s Google Drive default parent folder
Summary
Properties
○ Body (Optional): body of the document. Use \n for new line.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the created document result (Id, Url)
○ Email: the user’s Google email you want to use for the automation.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Title: title of the document
○ Body (Optional): body of the document. Use \n for new line.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the created document result (Id, Url)
○ Email: the user’s Google email you want to use for the automation.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Title: title of the document
Get Document
Returns the document you specify in the request
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the get document result (Id, Url, Body).
○ Email: the user’s Google email you want to use for the automation.
○ Id: id of the document.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the get document result (Id, Url, Body).
○ Email: the user’s Google email you want to use for the automation.
○ Id: id of the document.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
Get Text Index
Returns a list of indexes that represent the location of your specified text (only searches inside paragraphs).
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the List of Indexes (ExactStart, ExactEnd, Start, End)
○ Email: the user’s Google email you want to use for the automation. ○ Id: id of the document
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Text: text to search.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the List of Indexes (ExactStart, ExactEnd, Start, End)
○ Email: the user’s Google email you want to use for the automation. ○ Id: id of the document
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Text: text to search.
Insert Text
Inserts text at a specified location in the body of a Google document
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the document url.
○ Email: the user’s Google email you want to use for the automation.
○ Id: id of the document.
○ Index: index to insert the text.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Text: text to insert. For trailing/leading white space use \s.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the document url.
○ Email: the user’s Google email you want to use for the automation.
○ Id: id of the document.
○ Index: index to insert the text.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Text: text to insert. For trailing/leading white space use \s.
When doing multiple Insert Text, make sure to use Get Index every time as the indexes do change when the document is updated. Batch Update is recommended for this scenario.
Replace Text
Replaces all instances of specified text in the body of a Google document
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the document url.
○ Email: the user’s Google email you want to use for the automation.
○ Id: id of the document.
○ Is Case Sensitive?: indicates whether the text search is case sensitive.
○ Replace with: replacement text. For trailing/leading white space use \s.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Text: text to be replaced. For trailing/leading white space use \s.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the document url.
○ Email: the user’s Google email you want to use for the automation.
○ Id: id of the document.
○ Is Case Sensitive?: indicates whether the text search is case sensitive.
○ Replace with: replacement text. For trailing/leading white space use \s.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Text: text to be replaced. For trailing/leading white space use \s.
Batch Update
Sends a single update that includes the values from Text Insert and Replace Text
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the document url.
○ Email: the user’s Google email you want to use for the automation.
○ Id: id of the document.
○ Insert Texts: e.g., (text1;index1) OR (text1;index1, text2;index2) for multiple values. For trailing/leading white space use \s e.g. \stext1\s;index1.
○ Replace Texts: follows the format (text;replace;isCaseSensitive).
– e.g., (text1;replace1;true) OR (text1;replace1;false, text2;replace2;true) for multiple values. For trailing/leading white space use \s e.g text1;\sreplace1;false.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the document url.
○ Email: the user’s Google email you want to use for the automation.
○ Id: id of the document.
○ Insert Texts: e.g., (text1;index1) OR (text1;index1, text2;index2) for multiple values. For trailing/leading white space use \s e.g. \stext1\s;index1.
○ Replace Texts: follows the format (text;replace;isCaseSensitive).
– e.g., (text1;replace1;true) OR (text1;replace1;false, text2;replace2;true) for multiple values. For trailing/leading white space use \s e.g text1;\sreplace1;false.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
Google Sheets
Create Spreadsheet
Creates a new spreadsheet in the default parent folder
Summary
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Columns (Optional): specifies the number of columns you want to create in the initial sheet.
○ Copy Result To (Optional): Target parameter to hold the created spreadsheet result (Id, FileUrl).
○ Email: the user’s Google email you want to use for the automation.
○ Rows (Optional): specifies the number of rows you want to create in the initial sheet.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Spreadsheet Name (Optional): the name of the new spreadsheet. Untitled spreadsheet is the default name.
Add Sheet
Creates a new sheet inside a specified spreadsheet
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Columns (Optional): specifies the number of columns you want to create in the sheet. ○ Copy Result To (Optional): Target parameter to hold the spreadsheet file url.
○ Email: the user’s Google email you want to use for the automation.
○ Position Index (Optional): Specifies the new sheet location in the spreadsheet. If empty, a new sheet is added to the end of the spreadsheet and the first sheet is added at index 0.
○ Rows (Optional): specifies the number of rows you want to create in the sheet.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): The name for the new sheet. Default is Sheet(incrementing number).
○ Spreadsheet Id: The ID of the spreadsheet where you want to add the new sheet.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Columns (Optional): specifies the number of columns you want to create in the sheet. ○ Copy Result To (Optional): Target parameter to hold the spreadsheet file url.
○ Email: the user’s Google email you want to use for the automation.
○ Position Index (Optional): Specifies the new sheet location in the spreadsheet. If empty, a new sheet is added to the end of the spreadsheet and the first sheet is added at index 0.
○ Rows (Optional): specifies the number of rows you want to create in the sheet.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): The name for the new sheet. Default is Sheet(incrementing number).
○ Spreadsheet Id: The ID of the spreadsheet where you want to add the new sheet.
Write Cell
Writes a value into a cell within a Google SpreadSheet
Summary
Properties
○ Cell Address: the address of the cell that you want to write in (e.g. A1, B2).
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the spreadsheet file url.
○ Email: the user’s Google email you want to use for the automation.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): the name of the sheet that includes the cell you want to write in. The default value is the first sheet.
○ Spreadsheet Id: the ID of the SpreadSheet that includes the sheet and cell you want to write in.
○ Value: the content you want to write.
○ Cell Address: the address of the cell that you want to write in (e.g. A1, B2).
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the spreadsheet file url.
○ Email: the user’s Google email you want to use for the automation.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): the name of the sheet that includes the cell you want to write in. The default value is the first sheet.
○ Spreadsheet Id: the ID of the SpreadSheet that includes the sheet and cell you want to write in.
○ Value: the content you want to write.
Read Cell
Reads the value of a cell from a Google SpreadSheet.
Summary
Properties
○ Cell Address: the address of the cell that you want to read (e.g. A1, B2).
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To: Target parameter to hold the cell value
○ Email: the user’s Google email you want to use for the automation.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): the name of the sheet that includes the cell you want to read. The default value is the first sheet.
○ Spreadsheet Id: the ID of the Spreadsheet that includes the sheet and cell you want to read.
○ Cell Address: the address of the cell that you want to read (e.g. A1, B2).
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To: Target parameter to hold the cell value
○ Email: the user’s Google email you want to use for the automation.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): the name of the sheet that includes the cell you want to read. The default value is the first sheet.
○ Spreadsheet Id: the ID of the Spreadsheet that includes the sheet and cell you want to read.
Write Range
Writes the content of values in either rows or columns of a Google Spreadsheet
Summary
Properties
○ Cell Address: the list of values you want to write in (delimiter separated).
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the spreadsheet file url.
○ Delimiter: the character to separate the values, e.g., commas (,), semicolon (;).
○ Email: the user’s Google email you want to use for the automation.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): the name of the sheet that includes the cell you want to read. The default value is the first sheet.
○ Spreadsheet Id: the ID of the spreadsheet where you want to write the contents.
○ Values: the list of values you want to write in (delimiter separated).
○ Write Row: If true, values will be written in row else in column. Default is true.
○ Cell Address: the list of values you want to write in (delimiter separated).
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the spreadsheet file url.
○ Delimiter: the character to separate the values, e.g., commas (,), semicolon (;).
○ Email: the user’s Google email you want to use for the automation.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): the name of the sheet that includes the cell you want to read. The default value is the first sheet.
○ Spreadsheet Id: the ID of the spreadsheet where you want to write the contents.
○ Values: the list of values you want to write in (delimiter separated).
○ Write Row: If true, values will be written in row else in column. Default is true.
Copy Sheet
Copies a sheet from one spreadsheet and pastes it into the same or different spreadsheet.
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the new sheet name.
○ Copy Spreadsheet Id: the ID of the spreadsheet that you want to copy the sheet from.
○ Email: the user’s Google email you want to use for the automation.
○ Paste Spreadsheet Id: the of the spreadsheet that you want to paste the sheet.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): the name of the sheet that you want to copy. The default value is the first sheet.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the new sheet name.
○ Copy Spreadsheet Id: the ID of the spreadsheet that you want to copy the sheet from.
○ Email: the user’s Google email you want to use for the automation.
○ Paste Spreadsheet Id: the of the spreadsheet that you want to paste the sheet.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): the name of the sheet that you want to copy. The default value is the first sheet.
Rename Sheet
Renames an existing sheet
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the spreadsheet file url.
○ Email: the user’s Google email you want to use for the automation.
○ New Sheet Name: the new name for the specified sheet.
○ Original Sheet Name (Optional): the name of the sheet that you want to rename. The default value is the first Sheet.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Spreadsheet Id: the ID of the spreadsheet that contains the sheet you want to rename.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the spreadsheet file url.
○ Email: the user’s Google email you want to use for the automation.
○ New Sheet Name: the new name for the specified sheet.
○ Original Sheet Name (Optional): the name of the sheet that you want to rename. The default value is the first Sheet.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Spreadsheet Id: the ID of the spreadsheet that contains the sheet you want to rename.
Delete Sheet
Deletes a sheet from a spreadsheet document.
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the spreadsheet file url.
○ Email: the user’s Google email you want to use for the automation.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): the name of the sheet that you want to delete. The default value is the first sheet.
○ Spreadsheet Id: the ID of the spreadsheet that includes the sheet you want to delete.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the spreadsheet file url.
○ Email: the user’s Google email you want to use for the automation.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): the name of the sheet that you want to delete. The default value is the first sheet.
○ Spreadsheet Id: the ID of the spreadsheet that includes the sheet you want to delete.
Get Sheets
Returns a list of all sheet names in a workbook
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To: Target parameter to hold the list of all sheet names
○ Email: the user’s Google email you want to use for the automation.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Spreadsheet Id: the ID of the spreadsheet that you want to retrieve information from.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To: Target parameter to hold the list of all sheet names
○ Email: the user’s Google email you want to use for the automation.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Spreadsheet Id: the ID of the spreadsheet that you want to retrieve information from.
Add/Delete Column
Adds empty rows or removes existing rows from a specified sheet
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Column Position: position where you want to add/delete the column (e.g. 1, 10).
○ Copy Result To (Optional): Target parameter to hold the spreadsheet file url.
○ Email: the user’s Google email you want to use for the automation.
○ Mode: specifies whether you want to add or delete columns.
– Insert: add columns
– Delete: delete columns
○ Number of Columns: the number of columns that you want to add or delete.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): The name of the sheet that you want to add columns to or delete columns from. The default value is the first Sheet.
○ Spreadsheet Id: the ID of the spreadsheet that contains the sheet you want to add columns to or delete columns from.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Column Position: position where you want to add/delete the column (e.g. 1, 10).
○ Copy Result To (Optional): Target parameter to hold the spreadsheet file url.
○ Email: the user’s Google email you want to use for the automation.
○ Mode: specifies whether you want to add or delete columns.
– Insert: add columns
– Delete: delete columns
○ Number of Columns: the number of columns that you want to add or delete.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): The name of the sheet that you want to add columns to or delete columns from. The default value is the first Sheet.
○ Spreadsheet Id: the ID of the spreadsheet that contains the sheet you want to add columns to or delete columns from.
Add/Delete Row
Adds empty rows or removes existing rows from a specified sheet
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the spreadsheet file url
○ Email: the user’s Google email you want to use for the automation.
○ Mode: specifies whether you want to add or delete rows.
– Insert: add columns
– Delete: delete columns
○ Number of Rows: the number of rows that you want to add or delete.
○ Row Position: position where you want to add/delete the row (e.g. 1, 10)
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): The name of the sheet that you want to add rows to or delete rows from. The default value is the first Sheet.
○ Spreadsheet Id: the ID of the spreadsheet that contains the sheet you want to add rows to or delete rows from.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the spreadsheet file url
○ Email: the user’s Google email you want to use for the automation.
○ Mode: specifies whether you want to add or delete rows.
– Insert: add columns
– Delete: delete columns
○ Number of Rows: the number of rows that you want to add or delete.
○ Row Position: position where you want to add/delete the row (e.g. 1, 10)
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): The name of the sheet that you want to add rows to or delete rows from. The default value is the first Sheet.
○ Spreadsheet Id: the ID of the spreadsheet that contains the sheet you want to add rows to or delete rows from.
Read Column
Reads all content of the filled cells in a column (indicated by the starting cell) from the Spreadsheet.
Summary
Properties
○ Cell Address: the address of the first cell in the column. All cells that contain content in the specified column are read (e.g., A1, B1).
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To: Target parameter to hold the list of contents of the column.
○ Email: the user’s Google email you want to use for the automation.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): the name of the sheet to read the column. The default value is the first sheet.
○ Spreadsheet Id: the ID of the spreadsheet that includes the sheet and the column you want to read.
○ Cell Address: the address of the first cell in the column. All cells that contain content in the specified column are read (e.g., A1, B1).
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To: Target parameter to hold the list of contents of the column.
○ Email: the user’s Google email you want to use for the automation.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): the name of the sheet to read the column. The default value is the first sheet.
○ Spreadsheet Id: the ID of the spreadsheet that includes the sheet and the column you want to read.
Read Row
Reads all the cells content included in a specified Spreadsheet row.
Summary
Properties
○ Cell Address: the address of the first cell in the row. All cells that contain content in the specified row are read (e.g., A1, B1).
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To: Target parameter to hold the list of contents of the row.
○ Email: the user’s Google email you want to use for the automation.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): the name of the sheet to read the row. The default value is the first sheet.
○ Spreadsheet Id: the ID of the spreadsheet that includes the sheet and the row you want to read.
○ Cell Address: the address of the first cell in the row. All cells that contain content in the specified row are read (e.g., A1, B1).
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To: Target parameter to hold the list of contents of the row.
○ Email: the user’s Google email you want to use for the automation.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): the name of the sheet to read the row. The default value is the first sheet.
○ Spreadsheet Id: the ID of the spreadsheet that includes the sheet and the row you want to read.
Copy Paste Range
Copies and pastes a range of specified cells into a specified sheet.
Summary
Properties
○ Cell Address: the name of the sheet to read the row. The default value is the first sheet.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the spreadsheet file url.
○ Email: the user’s Google email you want to use for the automation.
○ End Range: specifies the end range of cells that you want to copy (E.g., A5).
○ From Sheet Name (Optional): the name of the sheet that you want to copy data from. The default value is the first Sheet.
○ Paste Orientation: the orientation of the paste data.
– Normal: normal paste.
– Transpose: indicates that the copied rows will paste as columns and the copied columns paste as rows.
○ Paste Type: the format to paste the copied data.
– Normal: paste values, formulas, formats and merges.
– Values: paste values only, without formulas, formats and merges.
– Format: pastes format and data validation only.
– NoBorders: pastes values, formulas, formats and merges, all without borders.
– Formula: pastes the formula only.
– DataValidation: pastes data validation only.
– ConditionalFormatting: pastes the conditional formatting only.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Spreadsheet Id: the ID of the spreadsheet that contains the sheet you want to paste data into.
○ Start Range: specifies the start range of cells that you want to copy (E.g., A1).
○ To Sheet Name (Optional : the name of the sheet that you want to paste data into. The default value is the first Sheet.
○ Cell Address: the name of the sheet to read the row. The default value is the first sheet.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the spreadsheet file url.
○ Email: the user’s Google email you want to use for the automation.
○ End Range: specifies the end range of cells that you want to copy (E.g., A5).
○ From Sheet Name (Optional): the name of the sheet that you want to copy data from. The default value is the first Sheet.
○ Paste Orientation: the orientation of the paste data.
– Normal: normal paste.
– Transpose: indicates that the copied rows will paste as columns and the copied columns paste as rows.
○ Paste Type: the format to paste the copied data.
– Normal: paste values, formulas, formats and merges.
– Values: paste values only, without formulas, formats and merges.
– Format: pastes format and data validation only.
– NoBorders: pastes values, formulas, formats and merges, all without borders.
– Formula: pastes the formula only.
– DataValidation: pastes data validation only.
– ConditionalFormatting: pastes the conditional formatting only.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Spreadsheet Id: the ID of the spreadsheet that contains the sheet you want to paste data into.
○ Start Range: specifies the start range of cells that you want to copy (E.g., A1).
○ To Sheet Name (Optional : the name of the sheet that you want to paste data into. The default value is the first Sheet.
Read Range
Reads the contents of a range in a Google Spreadsheet.
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To: Target parameter to hold a list of values from the range read.
○ Email: the user’s Google email you want to use for the automation.
○ End Range: specifies the end range of content that you want to read (E.g., B5).
○ Remove Empty Cells: If true, empty cells will be excluded. Default is False.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): The name of the sheet that includes the range you want to read. The default value is the first Sheet.
○ Spreadsheet Id: the ID of the spreadsheet that includes the sheets you want to read.
○ Start Range: specifies the start range of content that you want to read. E.g A1.
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To: Target parameter to hold a list of values from the range read.
○ Email: the user’s Google email you want to use for the automation.
○ End Range: specifies the end range of content that you want to read (E.g., B5).
○ Remove Empty Cells: If true, empty cells will be excluded. Default is False.
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): The name of the sheet that includes the range you want to read. The default value is the first Sheet.
○ Spreadsheet Id: the ID of the spreadsheet that includes the sheets you want to read.
○ Start Range: specifies the start range of content that you want to read. E.g A1.
Delete Range
Deletes a specified range of cells and shifts the remaining cells up or left.
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the spreadsheet file url.
○ Email: the user’s Google email you want to use for the automation.
○ End Range: specifies the end range of cells that you want to delete (E.g., A5).
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): The name of the sheet that includes the range you want to delete. The default value is the first Sheet.
○ Shift: indicates whether you want to shift the remaining cells after deleting the specified range.
– NoShift: the data in the cells located outside of the Range is unchanged and the remaining cells are left blank.
– Up: the data in the cells located below the Range is moved up to populate the remaining cells.
– Left: the data in the cells located to the right of the Range is moved left to populate the remaining cells.
○ Spreadsheet Id: the ID of the spreadsheet that you want to make changes to.
○ Start Range: specifies the start range of cells that you want to delete (E.g., A1).
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the spreadsheet file url.
○ Email: the user’s Google email you want to use for the automation.
○ End Range: specifies the end range of cells that you want to delete (E.g., A5).
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): The name of the sheet that includes the range you want to delete. The default value is the first Sheet.
○ Shift: indicates whether you want to shift the remaining cells after deleting the specified range.
– NoShift: the data in the cells located outside of the Range is unchanged and the remaining cells are left blank.
– Up: the data in the cells located below the Range is moved up to populate the remaining cells.
– Left: the data in the cells located to the right of the Range is moved left to populate the remaining cells.
○ Spreadsheet Id: the ID of the spreadsheet that you want to make changes to.
○ Start Range: specifies the start range of cells that you want to delete (E.g., A1).
Clear Range
Clears the values in a specified range of cells. Only clears values, all other settings are kept.
Summary
Properties
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the spreadsheet file url.
○ Email: the user’s Google email you want to use for the automation.
○ End Range: specifies the end range of cells that you want to clear (E.g, A5).
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): The name of the sheet that includes the range you want to clear. The default value is the first Sheet.
○ Spreadsheet Id: the ID of the spreadsheet that you want to make changes to.
○ Start Range: specifies the start range of cells that you want to clear (E.g., A1).
○ Client Id: the Client Id from your OAuth credentials.
○ Client Secret: the Client Secret from your OAuth credentials.
○ Copy Result To (Optional): Target parameter to hold the spreadsheet file url.
○ Email: the user’s Google email you want to use for the automation.
○ End Range: specifies the end range of cells that you want to clear (E.g, A5).
○ Service Account Key Path: the json file path (generated from your service account key credentials).
○ Sheet Name (Optional): The name of the sheet that includes the range you want to clear. The default value is the first Sheet.
○ Spreadsheet Id: the ID of the spreadsheet that you want to make changes to.
○ Start Range: specifies the start range of cells that you want to clear (E.g., A1).