batch
Batch patches existing calendar list entries using a CSV file as input.
Synopsis
Implements the API documented at https://developers.google.com/calendar/api/v3/reference/calendarList/patch
gsm calendarLists patch batch [flags]
Options
--backgroundColor int The main color of the calendar in the hexadecimal format "#0088aa".
This property supersedes the index-based colorId property.
To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods.
--backgroundColor_ALL string Same as backgroundColor but value is applied to all lines in the CSV file
--batchThreads int Specify the number of threads that should be used for batch commands (overrides value in config file. Max 16)
--calendarId int Calendar identifier. To retrieve calendar IDs call the calendarList.list method.
If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
--colorId int The color of the calendar.
This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint).
This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties.
--colorId_ALL string Same as colorId but value is applied to all lines in the CSV file
--colorRgbFormat int Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB).
If this feature is used, the index-based colorId field will be set to the best matching option automatically.
--colorRgbFormat_ALL Same as colorRgbFormat but value is applied to all lines in the CSV file
--defaultReminders int The default reminders that the authenticated user has for this calendar.
Must be given in the form of '--defaultReminders "method=[popup|email];minutes[0-40320]
Where
email - Reminders are sent via email.
popup - Reminders are sent via a UI popup.
--defaultReminders_ALL strings Same as defaultReminders but value is applied to all lines in the CSV file
--delimiter string Delimiter to use for CSV columns. Must be exactly one character. Default is ';'
--fields int Fields allows partial responses to be retrieved.
See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
--fields_ALL string Same as fields but value is applied to all lines in the CSV file
--foregroundColor int The foreground color of the calendar in the hexadecimal format "#ffffff".
This property supersedes the index-based colorId property.
To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods.
--foregroundColor_ALL string Same as foregroundColor but value is applied to all lines in the CSV file
-h, --help help for batch
--hidden int Whether the calendar has been hidden from the list.
--hidden_ALL Same as hidden but value is applied to all lines in the CSV file
--id int Identifier of the calendar.
--notificationsType int The type of notification.
[eventCreation|eventChange|eventCancellation|eventResponse|agenda]
eventCreation - Notification sent when a new event is put on the calendar.
eventChange - Notification sent when an event is changed.
eventCancellation - Notification sent when an event is cancelled.
eventResponse - Notification sent when an attendee responds to the event invitation.
agenda - An agenda with the events of the day (sent out in the morning).
Note that all notifications are sent via email ("method" is always set to "email" atomatically)
--notificationsType_ALL strings Same as notificationsType but value is applied to all lines in the CSV file
--path string Path of the import file (CSV)
--selected int Whether the calendar content shows up in the calendar UI
--selected_ALL Same as selected but value is applied to all lines in the CSV file
--skipHeader Whether to skip the first row (header)
--summaryOverride int The summary that the authenticated user has set for this calendar.
--summaryOverride_ALL string Same as summaryOverride but value is applied to all lines in the CSV file
Options inherited from parent commands
--compressOutput By default, GSM outputs "pretty" (indented) objects. By setting this flag, GSM's output will be compressed. This may or may not improve performance in scripts.
--config string config file (default is $HOME/.config/gsm/.gsm.yaml)
--delay int This delay (plus a random jitter between 0 and 50) will be applied after every command to avoid reaching quota and rate limits. Set to 0 to disable.
--dwdSubject string Specify a subject used for DWD impersonation (overrides value in config file)
--log string Set the path of the log file. Default is either ~/gsm.log or defined in your config file
--maxElapsedTime int This is the maximum total time that will be spent retrying a request in minutes. (default 15)
--maxRetryInterval int This is the maximum interval that will be used between retry attempts in seconds. (default 320)
--redirectPort int This is the TCP port on which GSM will create web server if you authenticate with a user account for the first time. This is necessary for the OAuth flow. See https://developers.google.com/identity/protocols/oauth2/native-app#redirect-uri_loopback (default 8081)
--retryOn ints Specify the HTTP error code(s) that GSM should retry on. Note that GSM will always retry on HTTP 403 errors that indicate a quota / rate limit error
--streamOutput Setting this flag will cause GSM to output slice values to stdout one by one, instead of one large object
SEE ALSO
- gsm calendarLists patch - Updates an existing calendar on the user’s calendar list. This method supports patch semantics.