airflow.providers.google.suite.hooks.calendar

This module contains a Google Calendar API hook.

Module Contents

Classes

GoogleCalendarHook

Interact with Google Calendar via Google Cloud connection.
class airflow.providers.google.suite.hooks.calendar.GoogleCalendarHook(api_version, gcp_conn_id='google_cloud_default', delegate_to=None, impersonation_chain=None)[source]

Bases: airflow.providers.google.common.hooks.base_google.GoogleBaseHook

Interact with Google Calendar via Google Cloud connection.

Reading and writing cells in Google Sheet: https://developers.google.com/calendar/api/v3/reference

Parameters

  • gcp_conn_id (str) – The connection ID to use when fetching connection info.

  • api_version (str) – API Version. For example v3

  • delegate_to (str | None) – The account to impersonate using domain-wide delegation of authority, if any. For this to work, the service account making the request must have domain-wide delegation enabled.

  • impersonation_chain (str | Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account.

get_conn()[source]

Retrieve connection to Google Calendar.

Returns

Google Calendar services object.

Return type

Any

get_events(calendar_id='primary', i_cal_uid=None, max_attendees=None, max_results=None, order_by=None, private_extended_property=None, q=None, shared_extended_property=None, show_deleted=False, show_hidden_invitation=False, single_events=False, sync_token=None, time_max=None, time_min=None, time_zone=None, updated_min=None)[source]

Get events from Google Calendar from a single calendar_id.

https://developers.google.com/calendar/api/v3/reference/events/list

Parameters

  • calendar_id (str) – The Google Calendar ID to interact with

  • i_cal_uid (str | None) – Optional. Specifies event ID in the iCalendar format in the response.

  • max_attendees (int | None) – Optional. If there are more than the specified number of attendees, only the participant is returned.

  • max_results (int | None) – Optional. Maximum number of events returned on one result page. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events

  • order_by (str | None) – Optional. Acceptable values are "startTime" or “updated”

  • private_extended_property (str | None) – Optional. Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.

  • q (str | None) – Optional. Free text search.

  • shared_extended_property (str | None) – Optional. Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.

  • show_deleted (bool | None) – Optional. False by default

  • show_hidden_invitation (bool | None) – Optional. False by default

  • single_events (bool | None) – Optional. False by default

  • sync_token (str | None) – Optional. Token obtained from the nextSyncToken field returned

  • time_max (datetime.datetime | None) – Optional. Upper bound (exclusive) for an event’s start time to filter by. Default is no filter

  • time_min (datetime.datetime | None) – Optional. Lower bound (exclusive) for an event’s end time to filter by. Default is no filter

  • time_zone (str | None) – Optional. Time zone used in response. Default is calendars time zone.

  • updated_min (datetime.datetime | None) – Optional. Lower bound for an event’s last modification time

create_event(event, calendar_id='primary', conference_data_version=0, max_attendees=None, send_notifications=False, send_updates='false', supports_attachments=False)[source]

Create event on the specified calendar.

https://developers.google.com/calendar/api/v3/reference/events/insert.

Parameters

  • calendar_id (str) – The Google Calendar ID to interact with

  • conference_data_version (int | None) – Optional. Version number of conference data supported by the API client.

  • max_attendees (int | None) – Optional. If there are more than the specified number of attendees, only the participant is returned.

  • send_notifications (bool | None) – Optional. Default is False

  • send_updates (str | None) – Optional. Default is “false”. Acceptable values as “all”, “none”, "externalOnly" https://developers.google.com/calendar/api/v3/reference/events#resource

Was this entry helpful?