batch
Batch lists events using a CSV file as input.
Synopsis
Implements the API documented at https://developers.google.com/calendar/api/v3/reference/events/list
gsm events list batch [flags]
Options
--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.
--calendarId_ALL string Same as calendarId 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
-h, --help help for batch
--iCalUID int ICalUID sets the optional parameter "iCalUID": Specifies event ID in the iCalendar format to be included in the response.
--maxAttendees int The maximum number of attendees to include in the response.
If there are more than the specified number of attendees, only the participant is returned.
--maxAttendees_ALL int Same as maxAttendees but value is applied to all lines in the CSV file
--orderBy int The order of the events returned in the result. Optional. The default is an unspecified, stable order.
Acceptable values are:
startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)
updated - Order by last modification time (ascending).
--orderBy_ALL string Same as orderBy but value is applied to all lines in the CSV file
--path string Path of the import file (CSV)
--privateExtendedProperty int Properties that are private to the copy of the event that appears on this calendar.
--privateExtendedProperty_ALL strings Same as privateExtendedProperty but value is applied to all lines in the CSV file
--q int Free text search terms to find events that match these terms in any field, except for extended properties.
--q_ALL string Same as q but value is applied to all lines in the CSV file
--sharedExtendedProperty int Properties that are shared between copies of the event on other attendees' calendars.
--sharedExtendedProperty_ALL strings Same as sharedExtendedProperty but value is applied to all lines in the CSV file
--showDeleted int Whether to include deleted events (with status equals "cancelled") in the result.
Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False.
If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned.
--showDeleted_ALL Same as showDeleted but value is applied to all lines in the CSV file
--showHiddenInvitations int Whether to include hidden invitations in the result.
--showHiddenInvitations_ALL Same as showHiddenInvitations but value is applied to all lines in the CSV file
--singleEvents int Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves.
--singleEvents_ALL Same as singleEvents but value is applied to all lines in the CSV file
--skipHeader Whether to skip the first row (header)
--timeMax int Upper bound (exclusive) for an event's start time to filter by.
Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z.
Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.
--timeMax_ALL string Same as timeMax but value is applied to all lines in the CSV file
--timeMin int Lower bound (exclusive) for an event's end time to filter by.
Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z.
Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.
--timeMin_ALL string Same as timeMin but value is applied to all lines in the CSV file
--timeZone int Time zone used in the response. Optional.
The default is the time zone of the calendar.
--timeZone_ALL string Same as timeZone but value is applied to all lines in the CSV file
--updatedMin int Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by.
When specified, entries deleted since this time will always be included regardless of showDeleted.
--updatedMin_ALL string Same as updatedMin 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 events list - Returns events on the specified calendar.