API Reference google_api_calendar v0.21.3

Modules

API client metadata for GoogleApi.Calendar.V3.

API calls for all endpoints tagged Acl.

API calls for all endpoints tagged CalendarList.

API calls for all endpoints tagged Calendars.

API calls for all endpoints tagged Channels.

API calls for all endpoints tagged Colors.

API calls for all endpoints tagged Events.

API calls for all endpoints tagged Freebusy.

API calls for all endpoints tagged Settings.

Handle Tesla connections for GoogleApi.Calendar.V3.

Attributes

  • etag (type: String.t, default: nil) - ETag of the collection.
  • items (type: list(GoogleApi.Calendar.V3.Model.AclRule.t), default: nil) - List of rules on the access control list.
  • kind (type: String.t, default: calendar#acl) - Type of the collection ("calendar#acl").
  • nextPageToken (type: String.t, default: nil) - Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
  • nextSyncToken (type: String.t, default: nil) - Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.

Attributes

  • etag (type: String.t, default: nil) - ETag of the resource.
  • id (type: String.t, default: nil) - Identifier of the Access Control List (ACL) rule. See Sharing calendars.
  • kind (type: String.t, default: calendar#aclRule) - Type of the resource ("calendar#aclRule").
  • role (type: String.t, default: nil) - The role assigned to the scope. Possible values are:
    • "none" - Provides no access.
    • "freeBusyReader" - Provides read access to free/busy information.
    • "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
    • "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
    • "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
  • scope (type: GoogleApi.Calendar.V3.Model.AclRuleScope.t, default: nil) - The extent to which calendar access is granted by this ACL rule.

The extent to which calendar access is granted by this ACL rule.

Attributes

  • conferenceProperties (type: GoogleApi.Calendar.V3.Model.ConferenceProperties.t, default: nil) - Conferencing properties for this calendar, for example what types of conferences are allowed.
  • description (type: String.t, default: nil) - Description of the calendar. Optional.
  • etag (type: String.t, default: nil) - ETag of the resource.
  • id (type: String.t, default: nil) - Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
  • kind (type: String.t, default: calendar#calendar) - Type of the resource ("calendar#calendar").
  • location (type: String.t, default: nil) - Geographic location of the calendar as free-form text. Optional.
  • summary (type: String.t, default: nil) - Title of the calendar.
  • timeZone (type: String.t, default: nil) - The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.

Attributes

  • etag (type: String.t, default: nil) - ETag of the collection.
  • items (type: list(GoogleApi.Calendar.V3.Model.CalendarListEntry.t), default: nil) - Calendars that are present on the user's calendar list.
  • kind (type: String.t, default: calendar#calendarList) - Type of the collection ("calendar#calendarList").
  • nextPageToken (type: String.t, default: nil) - Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
  • nextSyncToken (type: String.t, default: nil) - Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.

Attributes

  • accessRole (type: String.t, default: nil) - The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
    • "freeBusyReader" - Provides read access to free/busy information.
    • "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
    • "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
    • "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
  • backgroundColor (type: String.t, default: nil) - 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. Optional.
  • colorId (type: String.t, default: nil) - 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. Optional.
  • conferenceProperties (type: GoogleApi.Calendar.V3.Model.ConferenceProperties.t, default: nil) - Conferencing properties for this calendar, for example what types of conferences are allowed.
  • defaultReminders (type: list(GoogleApi.Calendar.V3.Model.EventReminder.t), default: nil) - The default reminders that the authenticated user has for this calendar.
  • deleted (type: boolean(), default: false) - Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
  • description (type: String.t, default: nil) - Description of the calendar. Optional. Read-only.
  • etag (type: String.t, default: nil) - ETag of the resource.
  • foregroundColor (type: String.t, default: nil) - 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. Optional.
  • hidden (type: boolean(), default: false) - Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.
  • id (type: String.t, default: nil) - Identifier of the calendar.
  • kind (type: String.t, default: calendar#calendarListEntry) - Type of the resource ("calendar#calendarListEntry").
  • location (type: String.t, default: nil) - Geographic location of the calendar as free-form text. Optional. Read-only.
  • notificationSettings (type: GoogleApi.Calendar.V3.Model.CalendarListEntryNotificationSettings.t, default: nil) - The notifications that the authenticated user is receiving for this calendar.
  • primary (type: boolean(), default: false) - Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
  • selected (type: boolean(), default: false) - Whether the calendar content shows up in the calendar UI. Optional. The default is False.
  • summary (type: String.t, default: nil) - Title of the calendar. Read-only.
  • summaryOverride (type: String.t, default: nil) - The summary that the authenticated user has set for this calendar. Optional.
  • timeZone (type: String.t, default: nil) - The time zone of the calendar. Optional. Read-only.

The notifications that the authenticated user is receiving for this calendar.

Attributes

  • method (type: String.t, default: nil) - The method used to deliver the notification. The possible value is:
    • "email" - Notifications are sent via email.
      Required when adding a notification.
  • type (type: String.t, default: nil) - The type of notification. Possible values are:
    • "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).
      Required when adding a notification.

Attributes

  • address (type: String.t, default: nil) - The address where notifications are delivered for this channel.
  • expiration (type: String.t, default: nil) - Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
  • id (type: String.t, default: nil) - A UUID or similar unique string that identifies this channel.
  • kind (type: String.t, default: api#channel) - Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
  • params (type: map(), default: nil) - Additional parameters controlling delivery channel behavior. Optional.
  • payload (type: boolean(), default: nil) - A Boolean value to indicate whether payload is wanted. Optional.
  • resourceId (type: String.t, default: nil) - An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
  • resourceUri (type: String.t, default: nil) - A version-specific identifier for the watched resource.
  • token (type: String.t, default: nil) - An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
  • type (type: String.t, default: nil) - The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages.

Attributes

  • background (type: String.t, default: nil) - The background color associated with this color definition.
  • foreground (type: String.t, default: nil) - The foreground color that can be used to write on top of a background with 'background' color.

Attributes

  • calendar (type: %{optional(String.t) => GoogleApi.Calendar.V3.Model.ColorDefinition.t}, default: nil) - A global palette of calendar colors, mapping from the color ID to its definition. A calendarListEntry resource refers to one of these color IDs in its colorId field. Read-only.
  • event (type: %{optional(String.t) => GoogleApi.Calendar.V3.Model.ColorDefinition.t}, default: nil) - A global palette of event colors, mapping from the color ID to its definition. An event resource may refer to one of these color IDs in its colorId field. Read-only.
  • kind (type: String.t, default: calendar#colors) - Type of the resource ("calendar#colors").
  • updated (type: DateTime.t, default: nil) - Last modification time of the color palette (as a RFC3339 timestamp). Read-only.

Attributes

  • conferenceId (type: String.t, default: nil) - The ID of the conference. Can be used by developers to keep track of conferences, should not be displayed to users. The ID value is formed differently for each conference solution type: ` - eventHangout: ID is not set. - eventNamedHangout: ID is the name of the Hangout. - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc. - addOn: ID is defined by the third-party provider. Optional.
  • conferenceSolution (type: GoogleApi.Calendar.V3.Model.ConferenceSolution.t, default: nil) - The conference solution, such as Hangouts or Google Meet. Unset for a conference with a failed create request. Either conferenceSolution and at least one entryPoint, or createRequest is required.
  • createRequest (type: GoogleApi.Calendar.V3.Model.CreateConferenceRequest.t, default: nil) - A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field. Either conferenceSolution and at least one entryPoint, or createRequest is required.
  • entryPoints (type: list(GoogleApi.Calendar.V3.Model.EntryPoint.t), default: nil) - Information about individual conference entry points, such as URLs or phone numbers. All of them must belong to the same conference. Either conferenceSolution and at least one entryPoint, or createRequest is required.
  • notes (type: String.t, default: nil) - Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.
  • parameters (type: GoogleApi.Calendar.V3.Model.ConferenceParameters.t, default: nil) - Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
  • signature (type: String.t, default: nil) - The signature of the conference data. Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. Unset for a conference with a failed create request. Optional for a conference with a pending create request.

Attributes

  • addOnParameters (type: GoogleApi.Calendar.V3.Model.ConferenceParametersAddOnParameters.t, default: nil) - Additional add-on specific data.

Attributes

  • parameters (type: map(), default: nil) -

Attributes

  • allowedConferenceSolutionTypes (type: list(String.t), default: nil) - The types of conference solutions that are supported for this calendar. The possible values are:
    • "eventHangout"
    • "eventNamedHangout"
    • "hangoutsMeet" Optional.

Attributes

  • statusCode (type: String.t, default: nil) - The current status of the conference create request. Read-only. The possible values are:
    • "pending": the conference create request is still being processed.
    • "success": the conference create request succeeded, the entry points are populated.
    • "failure": the conference create request failed, there are no entry points.

Attributes

  • iconUri (type: String.t, default: nil) - The user-visible icon for this solution.
  • key (type: GoogleApi.Calendar.V3.Model.ConferenceSolutionKey.t, default: nil) - The key which can uniquely identify the conference solution for this event.
  • name (type: String.t, default: nil) - The user-visible name of this solution. Not localized.

Attributes

  • type (type: String.t, default: nil) - The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. The possible values are:

Attributes

  • conferenceSolutionKey (type: GoogleApi.Calendar.V3.Model.ConferenceSolutionKey.t, default: nil) - The conference solution, such as Hangouts or Google Meet.
  • requestId (type: String.t, default: nil) - The client-generated unique ID for this request. Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.
  • status (type: GoogleApi.Calendar.V3.Model.ConferenceRequestStatus.t, default: nil) - The status of the conference create request.

Attributes

  • accessCode (type: String.t, default: nil) - The access code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional.
  • entryPointFeatures (type: list(String.t), default: nil) - Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.
  • entryPointType (type: String.t, default: nil) - The type of the conference entry point. Possible values are:
    • "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
    • "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
    • "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
    • "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference.
  • label (type: String.t, default: nil) - The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. Examples:
    • for video: meet.google.com/aaa-bbbb-ccc
    • for phone: +1 123 268 2601
    • for sip: 12345678@altostrat.com
    • for more: should not be filled
      Optional.
  • meetingCode (type: String.t, default: nil) - The meeting code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional.
  • passcode (type: String.t, default: nil) - The passcode to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
  • password (type: String.t, default: nil) - The password to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional.
  • pin (type: String.t, default: nil) - The PIN to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional.
  • regionCode (type: String.t, default: nil) - The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. Calendar backend will populate this field only for EntryPointType.PHONE.
  • uri (type: String.t, default: nil) - The URI of the entry point. The maximum length is 1300 characters. Format:
    • for video, http: or https: schema is required.
    • for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
    • for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.
    • for more, http: or https: schema is required.

Attributes

  • domain (type: String.t, default: nil) - Domain, or broad category, of the error.
  • reason (type: String.t, default: nil) - Specific reason for the error. Some of the possible values are:
    • "groupTooBig" - The group of users requested is too large for a single query.
    • "tooManyCalendarsRequested" - The number of calendars requested is too large for a single query.
    • "notFound" - The requested resource was not found.
    • "internalError" - The API service has encountered an internal error. Additional error types may be added in the future, so clients should gracefully handle additional error statuses not included in this list.

Attributes

  • etag (type: String.t, default: nil) - ETag of the resource.
  • attendeesOmitted (type: boolean(), default: false) - Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
  • reminders (type: GoogleApi.Calendar.V3.Model.EventReminders.t, default: nil) - Information about the event's reminders for the authenticated user.
  • guestsCanSeeOtherGuests (type: boolean(), default: true) - Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
  • summary (type: String.t, default: nil) - Title of the event.
  • privateCopy (type: boolean(), default: false) - If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.
  • conferenceData (type: GoogleApi.Calendar.V3.Model.ConferenceData.t, default: nil) - The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
  • hangoutLink (type: String.t, default: nil) - An absolute link to the Google+ hangout associated with this event. Read-only.
  • attachments (type: list(GoogleApi.Calendar.V3.Model.EventAttachment.t), default: nil) - File attachments for the event. Currently only Google Drive attachments are supported. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event,
  • description (type: String.t, default: nil) - Description of the event. Can contain HTML. Optional.
  • kind (type: String.t, default: calendar#event) - Type of the resource ("calendar#event").
  • guestsCanModify (type: boolean(), default: false) - Whether attendees other than the organizer can modify the event. Optional. The default is False.
  • attendees (type: list(GoogleApi.Calendar.V3.Model.EventAttendee.t), default: nil) - The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.
  • start (type: GoogleApi.Calendar.V3.Model.EventDateTime.t, default: nil) - The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
  • creator (type: GoogleApi.Calendar.V3.Model.EventCreator.t, default: nil) - The creator of the event. Read-only.
  • anyoneCanAddSelf (type: boolean(), default: false) - Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.
  • organizer (type: GoogleApi.Calendar.V3.Model.EventOrganizer.t, default: nil) - The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.
  • location (type: String.t, default: nil) - Geographic location of the event as free-form text. Optional.
  • status (type: String.t, default: nil) - Status of the event. Optional. Possible values are:
    • "confirmed" - The event is confirmed. This is the default status.
    • "tentative" - The event is tentatively confirmed.
    • "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. A cancelled status represents two different states depending on the event type:
    • Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.
    • All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.
  • visibility (type: String.t, default: default) - Visibility of the event. Optional. Possible values are:
    • "default" - Uses the default visibility for events on the calendar. This is the default value.
    • "public" - The event is public and event details are visible to all readers of the calendar.
    • "private" - The event is private and only event attendees may view event details.
    • "confidential" - The event is private. This value is provided for compatibility reasons.
  • gadget (type: GoogleApi.Calendar.V3.Model.EventGadget.t, default: nil) - A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.
  • colorId (type: String.t, default: nil) - The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.
  • guestsCanInviteOthers (type: boolean(), default: true) - Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
  • extendedProperties (type: GoogleApi.Calendar.V3.Model.EventExtendedProperties.t, default: nil) - Extended properties of the event.
  • sequence (type: integer(), default: nil) - Sequence number as per iCalendar.
  • recurrence (type: list(String.t), default: nil) - List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
  • transparency (type: String.t, default: opaque) - Whether the event blocks time on the calendar. Optional. Possible values are:
    • "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.
    • "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
  • recurringEventId (type: String.t, default: nil) - For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
  • endTimeUnspecified (type: boolean(), default: false) - Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
  • id (type: String.t, default: nil) - Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
    • characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
    • the length of the ID must be between 5 and 1024 characters
    • the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. If you do not specify an ID, it will be automatically generated by the server. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
  • end (type: GoogleApi.Calendar.V3.Model.EventDateTime.t, default: nil) - The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
  • updated (type: DateTime.t, default: nil) - Last modification time of the event (as a RFC3339 timestamp). Read-only.
  • originalStartTime (type: GoogleApi.Calendar.V3.Model.EventDateTime.t, default: nil) - For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.
  • locked (type: boolean(), default: false) - Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
  • created (type: DateTime.t, default: nil) - Creation time of the event (as a RFC3339 timestamp). Read-only.
  • htmlLink (type: String.t, default: nil) - An absolute link to this event in the Google Calendar Web UI. Read-only.
  • source (type: GoogleApi.Calendar.V3.Model.EventSource.t, default: nil) - Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
  • eventType (type: String.t, default: default) - Specific type of the event. Read-only. Possible values are:
    • "default" - A regular event or not further specified.
    • "outOfOffice" - An out-of-office event.
  • iCalUID (type: String.t, default: nil) - Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

Attributes

  • fileId (type: String.t, default: nil) - ID of the attached file. Read-only. For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
  • fileUrl (type: String.t, default: nil) - URL link to the attachment. For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. Required when adding an attachment.
  • iconLink (type: String.t, default: nil) - URL link to the attachment's icon. Read-only.
  • mimeType (type: String.t, default: nil) - Internet media type (MIME type) of the attachment.
  • title (type: String.t, default: nil) - Attachment title.

Attributes

  • additionalGuests (type: integer(), default: 0) - Number of additional guests. Optional. The default is 0.
  • comment (type: String.t, default: nil) - The attendee's response comment. Optional.
  • displayName (type: String.t, default: nil) - The attendee's name, if available. Optional.
  • email (type: String.t, default: nil) - The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. Required when adding an attendee.
  • id (type: String.t, default: nil) - The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
  • optional (type: boolean(), default: false) - Whether this is an optional attendee. Optional. The default is False.
  • organizer (type: boolean(), default: nil) - Whether the attendee is the organizer of the event. Read-only. The default is False.
  • resource (type: boolean(), default: false) - Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.
  • responseStatus (type: String.t, default: nil) - The attendee's response status. Possible values are:
    • "needsAction" - The attendee has not responded to the invitation.
    • "declined" - The attendee has declined the invitation.
    • "tentative" - The attendee has tentatively accepted the invitation.
    • "accepted" - The attendee has accepted the invitation.
  • self (type: boolean(), default: false) - Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

The creator of the event. Read-only.

Attributes

  • date (type: Date.t, default: nil) - The date, in the format "yyyy-mm-dd", if this is an all-day event.
  • dateTime (type: DateTime.t, default: nil) - The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
  • timeZone (type: String.t, default: nil) - The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.

Extended properties of the event.

A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.

Attributes

  • method (type: String.t, default: nil) - The method used by this reminder. Possible values are:
    • "email" - Reminders are sent via email.
    • "popup" - Reminders are sent via a UI popup.
      Required when adding a reminder.
  • minutes (type: integer(), default: nil) - Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). Required when adding a reminder.

Information about the event's reminders for the authenticated user.

Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.

Attributes

  • accessRole (type: String.t, default: nil) - The user's access role for this calendar. Read-only. Possible values are:
    • "none" - The user has no access.
    • "freeBusyReader" - The user has read access to free/busy information.
    • "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
    • "writer" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
    • "owner" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
  • defaultReminders (type: list(GoogleApi.Calendar.V3.Model.EventReminder.t), default: nil) - The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True).
  • description (type: String.t, default: nil) - Description of the calendar. Read-only.
  • etag (type: String.t, default: nil) - ETag of the collection.
  • items (type: list(GoogleApi.Calendar.V3.Model.Event.t), default: nil) - List of events on the calendar.
  • kind (type: String.t, default: calendar#events) - Type of the collection ("calendar#events").
  • nextPageToken (type: String.t, default: nil) - Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
  • nextSyncToken (type: String.t, default: nil) - Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
  • summary (type: String.t, default: nil) - Title of the calendar. Read-only.
  • timeZone (type: String.t, default: nil) - The time zone of the calendar. Read-only.
  • updated (type: DateTime.t, default: nil) - Last modification time of the calendar (as a RFC3339 timestamp). Read-only.

Attributes

  • busy (type: list(GoogleApi.Calendar.V3.Model.TimePeriod.t), default: nil) - List of time ranges during which this calendar should be regarded as busy.
  • errors (type: list(GoogleApi.Calendar.V3.Model.Error.t), default: nil) - Optional error(s) (if computation for the calendar failed).

Attributes

  • calendars (type: list(String.t), default: nil) - List of calendars' identifiers within a group.
  • errors (type: list(GoogleApi.Calendar.V3.Model.Error.t), default: nil) - Optional error(s) (if computation for the group failed).

Attributes

  • calendarExpansionMax (type: integer(), default: nil) - Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50.
  • groupExpansionMax (type: integer(), default: nil) - Maximal number of calendar identifiers to be provided for a single group. Optional. An error is returned for a group with more members than this value. Maximum value is 100.
  • items (type: list(GoogleApi.Calendar.V3.Model.FreeBusyRequestItem.t), default: nil) - List of calendars and/or groups to query.
  • timeMax (type: DateTime.t, default: nil) - The end of the interval for the query formatted as per RFC3339.
  • timeMin (type: DateTime.t, default: nil) - The start of the interval for the query formatted as per RFC3339.
  • timeZone (type: String.t, default: UTC) - Time zone used in the response. Optional. The default is UTC.

Attributes

  • id (type: String.t, default: nil) - The identifier of a calendar or a group.

Attributes

  • calendars (type: %{optional(String.t) => GoogleApi.Calendar.V3.Model.FreeBusyCalendar.t}, default: nil) - List of free/busy information for calendars.
  • groups (type: %{optional(String.t) => GoogleApi.Calendar.V3.Model.FreeBusyGroup.t}, default: nil) - Expansion of groups.
  • kind (type: String.t, default: calendar#freeBusy) - Type of the resource ("calendar#freeBusy").
  • timeMax (type: DateTime.t, default: nil) - The end of the interval.
  • timeMin (type: DateTime.t, default: nil) - The start of the interval.

Attributes

  • etag (type: String.t, default: nil) - ETag of the resource.
  • id (type: String.t, default: nil) - The id of the user setting.
  • kind (type: String.t, default: calendar#setting) - Type of the resource ("calendar#setting").
  • value (type: String.t, default: nil) - Value of the user setting. The format of the value depends on the ID of the setting. It must always be a UTF-8 string of length up to 1024 characters.

Attributes

  • etag (type: String.t, default: nil) - Etag of the collection.
  • items (type: list(GoogleApi.Calendar.V3.Model.Setting.t), default: nil) - List of user settings.
  • kind (type: String.t, default: calendar#settings) - Type of the collection ("calendar#settings").
  • nextPageToken (type: String.t, default: nil) - Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
  • nextSyncToken (type: String.t, default: nil) - Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.

Attributes

  • end (type: DateTime.t, default: nil) - The (exclusive) end of the time period.
  • start (type: DateTime.t, default: nil) - The (inclusive) start of the time period.