Google 日历与 Django 集成

Question

是否有完整的基于 Django 的 Google 日历集成示例？我正在通读 Google's example page，但底部的 link 已过时。

我特别纠结于刷新令牌，因为 Google 的示例只关注如何获取访问令牌。这就是我目前所拥有的：

@staff_member_required
def authorize_access(request):
    return redirect(get_flow(request).step1_get_authorize_url())

@staff_member_required
def oauth2_callback(request):
    credentials = get_flow(request).step2_exchange(request.GET['code'])

    store = get_store()
    store.put(credentials)
    credentials.set_store(store)

    return redirect('...')

def get_flow(request):
    flow = client.flow_from_clientsecrets(os.path.join(CREDENTIAL_DIR, CLIENT_SECRET_FILE),
                                      SCOPES,
                                      redirect_uri='%s://%s/google-calendar/oauth2-callback/' % (request.META['wsgi.url_scheme'], request.META['HTTP_HOST'],))
    flow.params['access_type'] = 'offline'
    flow.params['approval_prompt'] = 'force'

    return flow

def get_store():
    return oauth2client.file.Storage(os.path.join(CREDENTIAL_DIR, ACCESS_TOKEN_FILE))

def has_valid_api_credentials():
    credentials = get_store().get()
    return credentials is not None

def build_service():
    credentials = get_store().get()

    if not credentials:
        return None
    elif credentials.access_token_expired:
        http = credentials.refresh(httplib2.Http())
        http = get_store().get().authorize(http)
    else:
        http = credentials.authorize(httplib2.Http())

    service = discovery.build('calendar', 'v3', http=http)

    return service

def create_events(rental_request):
    service = build_service()

    event = service.events().insert(...).execute()

Answer 1

研究了很多不同的方法，我发现服务器到服务器的身份验证是我想要的。这样，用户就不必明确授予权限，也不必更新获得的授权令牌。相反，使用服务帐户，服务器可以自己进行调用。

在开始编码之前，您必须设置这样的服务帐户并将其添加到您希望服务帐户访问的日历中。 Google 已记下创建帐户的三个步骤 here. Afterwards, go to https://calendar.google.com，在屏幕左侧找到要与新服务帐户共享的日历，然后单击旁边的三角形。从下拉菜单中选择日历设置。这会将您带到一个屏幕，您将在其中找到稍后需要的日历 ID（因此请记下来），并且还会在顶部显示一个选项卡以共享对日历的访问权限。当 "person" 从服务帐户插入电子邮件地址时，为其赋予相应的权限并 单击保存 （如果不单击保存，则不会添加服务帐户） .

这个代码实际上非常优雅：

import os
from datetime import timedelta
import datetime
import pytz

import httplib2
from googleapiclient.discovery import build
from oauth2client.service_account import ServiceAccountCredentials

service_account_email = 'XXX@YYY.iam.gserviceaccount.com'

CLIENT_SECRET_FILE = 'creds.p12'

SCOPES = 'https://www.googleapis.com/auth/calendar'
scopes = [SCOPES]

def build_service():
    credentials = ServiceAccountCredentials.from_p12_keyfile(
        service_account_email=service_account_email,
        filename=CLIENT_SECRET_FILE,
        scopes=SCOPES
    )

    http = credentials.authorize(httplib2.Http())

    service = build('calendar', 'v3', http=http)

    return service


def create_event():
    service = build_service()

    start_datetime = datetime.datetime.now(tz=pytz.utc)
    event = service.events().insert(calendarId='<YOUR EMAIL HERE>@gmail.com', body={
        'summary': 'Foo',
        'description': 'Bar',
        'start': {'dateTime': start_datetime.isoformat()},
        'end': {'dateTime': (start_datetime + timedelta(minutes=15)).isoformat()},
    }).execute()

    print(event)

我正在使用 oauth2client 版本 2.2.0 (pip install oauth2client)。

希望这个回答对您有所帮助:)

Answer 2

由于这个 post 是很久以前的事了，所以我想分享我的 2020 年版本。感谢这个 post。对我实现目标帮助很大。

import datetime
from datetime import timedelta

import pytz
from googleapiclient.discovery import build
from oauth2client.service_account import ServiceAccountCredentials

service_account_email = "INSERT_HERE"
SCOPES = ["https://www.googleapis.com/auth/calendar"]
credentials = ServiceAccountCredentials.from_json_keyfile_name(
    filename="FILENAME.json", scopes=SCOPES
)


def build_service():
    service = build("calendar", "v3", credentials=credentials)
    return service


def create_event():
    service = build_service()

    start_datetime = datetime.datetime.now(tz=pytz.utc)
    event = (
        service.events()
        .insert(
            calendarId="CALENDARID@group.calendar.google.com",
            body={
                "summary": "Foo",
                "description": "Bar",
                "start": {"dateTime": start_datetime.isoformat()},
                "end": {
                    "dateTime": (start_datetime + timedelta(minutes=15)).isoformat()
                },
            },
        )
        .execute()
    )

    print(event)

create_event()

Answer 3

此处请注意：尽管代码有效，但根据 https://github.com/googleapis/google-auth-library-python/blob/7a8641a7f0718c0dce413436f23691e8590face1/docs/index.rst, oauth2client has been deprecated recently in favour of google-auth library - https://github.com/googleapis/google-auth-library-python/tree/edfe24602051969e32917e82bcedd2bace43e260

您可以在此处找到新库的文档 - https://google-auth.readthedocs.io/en/latest/user-guide.html

要使用新库，代码可以写成

import datetime
from datetime import timedelta

import pytz

from google.oauth2 import service_account

from googleapiclient.discovery import build

service_account_email = "app-calendar@xxxxxxxxx.iam.gserviceaccount.com"
SCOPES = ["https://www.googleapis.com/auth/calendar"]

credentials = service_account.Credentials.from_service_account_file('google_calendar_credential.json')
scoped_credentials = credentials.with_scopes(SCOPES)


def build_service():
    service = build("calendar", "v3", credentials=scoped_credentials)
    return service


def create_event():
    service = build_service()

    start_datetime = datetime.datetime.now(tz=pytz.utc)
    event = (
        service.events()
        .insert(
            calendarId="primary",
            body={
                "summary": "Foo 2",
                "description": "Bar",
                "start": {"dateTime": start_datetime.isoformat()},
                "end": {
                    "dateTime": (start_datetime + timedelta(minutes=15)).isoformat()
                },
            },
        )
        .execute()
    )

    print(event)

create_event()

由于我没有足够的声誉 post 作为评论，我 post 将其作为单独的 post

Answer 4

2022

感谢@joey Coder（我会把它添加为评论，但它太长了）

如果您希望您的网站或应用程序无需使用用户的 Google 帐户即可制作活动或日历，您应该使用服务帐户。

在 https://console.cloud.google.com/ 中选择您的项目或开始新项目。

在导航菜单中选择“APIs & Services” 启用新的 APIs 然后查找“日历 API”，启用 API

在“APIs & Services”>“凭据”下，select“创建凭据”并单击“服务帐户”，填写所需的名称，然后继续。将角色设置为所有者（或其他所需角色）（所有者授予您完全访问权限，您可能希望切换到功能较弱的权限）。点击“完成”

这会将您重定向到凭据页面。在“服务帐户”下单击所需的帐户（这会将您重定向到 IAM 和管理面板）在“密钥”选项卡下单击“添加密钥”和 select json，这会将 json 文件下载到您的计算机。

在 google 的日历页面中获取日历 ID 并将其添加到 AgendaClients“CalendarId”下的管理面板将服务帐户添加到以管理员身份共享的人员（更改事件）

这是我的 django 项目中的样子：

signals.py

import datetime
import json
import os

from django.db.models.signals import post_delete, post_save
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError
from oauth2client.service_account import ServiceAccountCredentials
from .models import  Event

# If modifying these scopes, delete the file token.json.
SCOPES = ["https://www.googleapis.com/auth/calendar"]


def get_service(refresh=False):
    credentials = ServiceAccountCredentials.from_json_keyfile_dict(
        json.loads(os.environ.get("client_secret")), scopes=SCOPES
    )
    # or if you have a file
    # credentials = ServiceAccountCredentials.from_json_keyfile_name(
    #     filename="file.json", scopes=SCOPES
    # )
    service = build("calendar", "v3", credentials=credentials)
    return service


def handle_event(sender, created, instance, **kwargs):
        """this function creates the events in the google agenda and updates them if changed in the website"""
        service = get_service()
        event = instance
        if not event.end_date:
            event.end_date = event.start_date
        if not event.end_time and event.start_time:
            event.end_time = event.start_time
        elif not event.end_time:
            event.end_time = datetime.datetime.min.time()
        if not event.start_time:
            event.start_time = datetime.datetime.min.time()
        if event.end_date < event.start_date:
            event.end_date, event.start_date = event.start_date, event.end_date
        queryset = Event.objects.filter(
            id=event.id
        )  # 
        # this is used so that we can update the google event within this signal without reshooting this signal(signals shot every time an object is saved)
        event = {
            "summary": event.description,
            "location": event.location or "",
            "description": (event.description + " " + event.summary),
            "start": {
                "dateTime": datetime.datetime.combine(
                    event.start_date, event.start_time
                ).isoformat(),
                "timeZone": "Europe/Amsterdam",
            },
            "end": {
                "dateTime": datetime.datetime.combine(
                    event.end_date, event.end_time
                ).isoformat(),
                "timeZone": "Europe/Amsterdam",
            },
            "recurrence": [],
            "reminders": {},
        }

        if created or not instance.google_link:
            try:
                event = (
                    service.events()
                    .insert(
                        calendarId=os.environ.get("calendarId"),
                        body=event,
                    )
                    .execute()
                )
                queryset.update(google_link=event["id"])
            except HttpError as error:
                # print("An error occurred: %s" % error)
                pass
        else:
            try:
                event = (
                    service.events()
                    .update(
                        calendarId=os.environ.get("calendarId"),
                        body=event,
                        eventId=instance.google_link,
                    )
                    .execute()
                )
                queryset.update(google_link=event["id"])
            except HttpError as error:
                # print("An error occurred: %s" % error)
                pass
        # print("#############ADDED NEW       #############")


def delete_event(sender, instance, **kwargs):
    """this function deletes an event from google agenda when deleted in the website"""
    try:
        service = get_service()
        service.events().delete(
            calendarId=os.environ.get("CalendarId"),
            eventId=instance.google_link,
        ).execute()
    except:
        pass


post_save.connect(handle_event, sender=Event)
post_delete.connect(delete_event, sender=Event)

models.py

class Event(models.Model):
    summary = models.CharField(max_length=50)
    description = models.CharField(max_length=50, null=True, blank=True)
    start_date = models.DateField()
    start_time = models.TimeField(null=True, blank=True)
    end_date = models.DateField(null=True, blank=True)
    end_time = models.TimeField(null=True, blank=True)
    location = models.CharField(max_length=50, null=True, blank=True)
    google_link = models.CharField(max_length=150, null=True, blank=True)
    # google link is used to edit events in google if you change them in your website

随时提出任何问题或指出任何问题

Google 日历与 Django 集成

Google Calendar Integration with Django

python

django

google-calendar-api

oauth-2.0

2022

signals.py

models.py