knitr::opts_chunk$set( collapse = TRUE, comment = "#>" )
The gcalendr
package makes it easier to work with the Google Calendar APIs from R.
This packages is governed by common policies recorded here. This package uses internal resources owned by the "Gcalendr" project on Google Cloud Platform. That is the name you will see in a consent screen.
Your use of Google APIs with the gcalendr
package is subject to the Google Calendar API
terms of service. See https://developers.google.com/terms/.
This package access Google resources from your local machine. Your machine communicates directly with the Google APIs.
The gcalendr
package project never receives your data or the permission to access your data. The owners of the project can only see anonymous, aggregated information about usage of tokens obtained through its OAuth client, such as which APIs and endpoints are being used.
Each package includes functions that you can execute in order to read or modify your own data. This can only happen after you provide a token, which requires that you authenticate yourself as a specific Google user and authorize these actions.
This package can help you get a token by guiding you through the OAuth flow in the browser. There you must consent to allow the gcalendr
package to operate on your behalf. The OAuth consent screen will describe the scope of what is being authorized, e.g., it will name the target API(s) and whether you are authorizing "read only" or "read and write" access.
There are two ways to use this package without authorizing the gcalendr
package: bring your own service account token or configure the package to use an OAuth client of your choice.
At the moment the gcalendr
package only provides read-only access to the API. Here is an overview of the scopes requested by the gcalendr
package and their rationale:
Scope | Purpose ----- | ---------- calendar.readonly | read-only access to Calendars calendar.events | read-only access to Events calendar.events.readonly | read-only access to Events calendar.settings.readonly | read-only access to Settings
The packages only communicate with Google APIs. No user data is shared with the owners of the gcalendr
package, RStudio, or any other servers.
This package may store your credentials on your local machine, for later reuse by you. Use caution when using this package on a shared machine.
By default, an OAuth token is cached in a local file, such as ~/.R/gargle/gargle-oauth
. See the documentation for gargle::gargle_options()
and gargle::credentials_user_oauth2()
for information on how to control the location of the token cache or suppress token caching, globally or at the individual token level.
Do not use an API key or client ID from the gcalendr
package in an external package or tool. Per the Google User Data Policy
https://developers.google.com/terms/api-services-user-data-policy, your
application must accurately represent itself when authenticating to Google API services.
If you use this package inside another package or application that executes its own logic --- as opposed to code in the gcalendr
package or by the user --- you must communicate this clearly to the user. Do not use credentials from the gcalendr
package; instead, use credentials associated with your project or your user.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.