在 Google 日历 API 中使用哪个日历 ID？

Question

我目前通过 Google 日历 API 检索我的组织（家庭）Google 日历，使用 Python。

作为参考，两种情况下使用的凭据文件都是（(...) 是经过编辑的信息）

{
  "type": "service_account",
  "project_id": "da(...)",
  "private_key_id": "8(...)4",
  "private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvAI(...)Kag==\n-----END PRIVATE KEY-----\n",
  "client_email": "da(...)@(...).iam.gserviceaccount.com",
  "client_id": "1(...)9",
  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
  "token_uri": "https://oauth2.googleapis.com/token",
  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/da(...)iam.gserviceaccount.com"
}

我想将其移植到 Go。为此，我使用了以下代码（部分复制自 the documentation）

package main

import (
    "context"
    "fmt"
    "time"

    log "github.com/sirupsen/logrus"

    "google.golang.org/api/calendar/v3"
    "google.golang.org/api/option"
)

func googlecalendar() (err error) {
    ctx := context.Background()
    calendarService, err := calendar.NewService(ctx, option.WithCredentialsFile("googlecalendar.json"))
    if err != nil {
        return err
    }
    t := time.Now().Format(time.RFC3339)
    events, err := calendarService.Events.List("john@example.com").ShowDeleted(false).
        SingleEvents(true).TimeMin(t).MaxResults(10).OrderBy("startTime").Do()
    if err != nil {
        log.Fatalf("Unable to retrieve next ten of the user's events: %v", err)
    }
    fmt.Println("Upcoming events:")
    if len(events.Items) == 0 {
        fmt.Println("No upcoming events found.")
    } else {
        for _, item := range events.Items {
            date := item.Start.DateTime
            if date == "" {
                date = item.Start.Date
            }
            fmt.Printf("%v (%v)\n", item.Summary, date)
        }
    }
    return nil
}

上面的代码中john@example.com是Google日历中提供的“日历ID”（当然代码中使用的是实际ID）。这输出错误

time="2021-05-05T11:39:12+02:00" level=fatal msg="Unable to retrieve next ten of the user's events: googleapi: Error 404: Not Found, notFound"

我的理解是，这意味着john@example.com没有被识别。为什么？

当我使用 primary 而不是 john@example.com 时（如文档中所示），代码运行正确并输出

Upcoming events:
No upcoming events found.

这意味着 整个身份验证部分似乎有效（使用与 Python 中相同的 JSON 凭据，从控制台检索）- 它只是对日历的引用不正确。如何解决这个问题？

根据评论中的请求，下面是通用的 Python 代码（有效）。

import json
import logging.config
import os

import arrow
import googleapiclient.discovery
import paho.mqtt.publish
from google.oauth2 import service_account as google_oauth2_service_account


# setup logging
logging.config.dictConfig({
    'formatters': {
        'standard': {
            'format': "%(asctime)s [%(module)s] %(levelname)s %(message)s"
        },
    },
    'handlers': {
        'default': {
            'formatter': 'standard',
            'class': 'logging.StreamHandler',
        },
    },
    'loggers': {
        '': {  # root logger
            'handlers': ['default'],
            'level': logging.ERROR,
            'propagate': False
        },
        'googlecalendar': {
            'handlers': ['default'],
            'level': logging.DEBUG if os.environ.get('DEBUG', '').lower() == 'true' else logging.INFO,
            'propagate': False
        },
    },
    "disable_existing_loggers": True,
    "version": 1,
})
log = logging.getLogger('googlecalendar')


def getevents(calendar=None, google_service =None):
    now = arrow.now()
    try:
        events_result = google_service.events().list(
            calendarId=calendar,
            timeMin=now.shift(days=0).isoformat(),
            timeMax=now.shift(days=+7).isoformat(),
            singleEvents=True,
            orderBy='startTime'
        ).execute()
    except Exception as e:
        log.error(f"error connecting to google for {calendar}: {e}")
        return

    # transform events and send out
    events = []
    if events_result.get('items'):
        # remove multiday items (no strat or end date)
        for i in events_result['items']:
            # try to extract the data, some are not available so the event is not interesing (multiday, ...)
            try:
                events.append({
                    'start': arrow.get(i['start']['dateTime']).isoformat(),
                    'end': arrow.get(i['end']['dateTime']).isoformat(),
                    'timestamp': arrow.get(i['start']['dateTime']).timestamp,
                    'name': i['summary'],
                    'id': i['id'],
                    'important': True if i.get('colorId') else False
                })
            except KeyError:
                pass

    # send the data to MQTT
    # (...)

    log.debug(f"{calendar}: {events}")


google_credentials = google_oauth2_service_account.Credentials.from_service_account_info(
    {
      "type": "service_account",
      "project_id": "da(...)",
      "private_key_id": "8(...)4",
      "private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvAI(...)Kag==\n-----END PRIVATE KEY-----\n",
      "client_email": "da(...)@(...).iam.gserviceaccount.com",
      "client_id": "1(...)9",
      "auth_uri": "https://accounts.google.com/o/oauth2/auth",
      "token_uri": "https://oauth2.googleapis.com/token",
      "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
      "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/da(...)iam.gserviceaccount.com"
    },
    scopes=['https://www.googleapis.com/auth/calendar'],
    subject='john@example.com'
)
google_service = googleapiclient.discovery.build('calendar', 'v3', credentials=google_credentials, cache_discovery=False)

for calendar in [
    "john@example.com",
    "mary@example.net",
    "something_idsd@group.calendar.google.com",
]:
    getevents(calendar=calendar, google_service=google_service)

Answer 1

回答

你得到的结果是正常的，问题是你没有执行Domain-Wide Delegation correctly。我得出这个结论是因为以下场景：

日历 ID：john@example.com。如果服务账号没有给用户留下深刻印象，估计找不到用户的日历。
日历 ID：primary。如果服务帐户的主日历没有任何事件，预计 list 方法不会 return 任何结果。

解决方案

将您的代码与文档中的代码进行比较，我看不出您将 config.Subject = userEmail 放在哪里，正如@DalmTo 所说。尝试 following code 创建日历服务：

  ctx := context.Background()

  jsonCredentials, err := ioutil.ReadFile("googlecalendar.json")
  if err != nil {
    return nil, err
  }

  config, err := google.JWTConfigFromJSON(jsonCredentials, "https://www.googleapis.com/auth/calendar")
  if err != nil {
    return nil, fmt.Errorf("JWTConfigFromJSON: %v", err)
  }
  config.Subject = "john@example.com"

  ts := config.TokenSource(ctx)

  calendarService, err := calendar.NewService(ctx, option.WithTokenSource(ts))

参考文献：

Domain-Wide Delegation

在 Google 日历 API 中使用哪个日历 ID？

Which Calendar ID to use in Google Calendar API?

google-calendar-api

go

回答

解决方案

参考文献：