Python の Google Calendar API の認証の有効期間の設定について

Question

Python の Google Calendar API の認証の有効期間について質問させてください。

expiredが設定される条件の有無、および、expiredの設定方法について教えて頂けないでしょうか？

私の環境で公式サイトのプログラムを実行したところcreds.refresh(Request())のロジックを通っていません。

printで値をを出力したところcreds.validがTrueでした。
credsの内容をそのまま出力したところexpiredの日付の記述もありませんでした。
以下はgoogle.auth.credentials moduleのURLです。
https://google-auth.readthedocs.io/en/latest/reference/google.auth.credentials.html

以下Python の Google Calender APIの公式のURLです。
https://developers.google.com/calendar/quickstart/python

公式のサンプルを一部抜粋

if os.path.exists('token.pickle'):
    with open('token.pickle', 'rb') as token:
        creds = pickle.load(token)
# If there are no (valid) credentials available, let the user log in.
if not creds or not creds.valid:
    if creds and creds.expired and creds.refresh_token:
        creds.refresh(Request())
    else:
        flow = InstalledAppFlow.from_client_secrets_file(
            'credentials.json', SCOPES)
        creds = flow.run_local_server(port=0)
    # Save the credentials for the next run
    with open('token.pickle', 'wb') as token:
        pickle.dump(creds, token)

print(creds.to_json())
service = build('calendar', 'v3', credentials=creds)

実行結果

{"token": "ya29.a0AfHxxxxxxx", "refresh_token": "1//0euR5aD1RP7Qxxxxx", "token_uri": "https://oauth2.googleapis.com/token", "client_id": "3783162xxxxxxx9m.apps.googleusercontent.com", "client_secret": "HE8IkGcZxxxxxxx", "scopes": ["https://www.googleapis.com/auth/calendar.readonly"]}

補足情報（FW/ツールのバージョンなど）

raspberry pi 3
No LSB modules are available.
Distributor ID:	Raspbian
Description:	Raspbian GNU/Linux 10 (buster)
Release:	10
Codename:	buster

macOS big sur　version 11.2.1

Answer 1

credsの内容をそのまま出力したところexpiredの日付の記述もありませんでした。

credsの内容を、どの段階で、どのように出力されたのかこちらでは分かりかねますが、
reflesh()関数もしくは、InstalledAppFlow.from_client_secrets_file()関数を実行した後
Credentialsオブジェクトの中にある、expiryが有効期限を表すdatetimeオブジェクトです。
（こちらの環境はwindows10です）

https://google-auth.readthedocs.io/en/latest/reference/google.auth.credentials.html#google.auth.credentials.Credentials.expiry

（なお、このオブジェクトはnaiveであり、暗黙的にUTCであるように思われますので注意が必要です）

expiryは、おおむね作成時刻(更新時刻)の1時間後で設定されます。

※少なくともGoogle Calendar APIの場合、ユーザー側で任意の有効期限は設定できないと思います。
私は試しませんが、こちらでtoken.pickle内のexpiryを故意に延長したcredsをbuild関数に渡しても、おそらく無視されるでしょう（非推奨）。
したがって、質問文で引用されている公式サンプルコードのように、有効期限を過ぎているかどうかを調べ、過ぎているならば、reflesh()を実行して有効期限を延長する（正確には、有効期限が延長された新しいトークンを取得する）というのが通常の使い方になります。

下記は、公式サンプルコードに、トークンの有効期限を日本時間で表示する部分を追加したものになります。

from __future__ import print_function
import datetime
import pickle
import os.path
from googleapiclient.discovery import build
from google_auth_oauthlib.flow import InstalledAppFlow
from google.auth.transport.requests import Request
from datetime import datetime, timedelta, timezone
# If modifying these scopes, delete the file token.pickle.
SCOPES = ['https://www.googleapis.com/auth/calendar.readonly']

+JST = timezone(timedelta(hours=+9), 'JST')

+def conv_jst(d:datetime):
+    if d.tzinfo is None or d.tzinfo.utcoffset is None:
+        return (d.replace(tzinfo=timezone.utc)).astimezone(JST)

def main():
    """Shows basic usage of the Google Calendar API.
    Prints the start and name of the next 10 events on the user's calendar.
    """
+    print("現在時刻: ",datetime.now(JST))
    creds = None
    # The file token.pickle stores the user's access and refresh tokens, and is
    # created automatically when the authorization flow completes for the first
    # time.
    if os.path.exists('token.pickle'):
        with open('token.pickle', 'rb') as token:
            creds = pickle.load(token)
    # If there are no (valid) credentials available, let the user log in.

    if not creds or not creds.valid:
        if creds and creds.expired and creds.refresh_token:
+            old_expiry_time = creds.expiry
+            print("credentialの有効期限が古いです。：",conv_jst(old_expiry_time))
            creds.refresh(Request())
+            print("有効期限を更新しました。")
+            print("更新前",conv_jst(old_expiry_time)," -> 更新後:", conv_jst(creds.expiry))
        else:
            flow = InstalledAppFlow.from_client_secrets_file(
                'credentials.json', SCOPES)
            creds = flow.run_local_server(port=0)

        # Save the credentials for the next run
        with open('token.pickle', 'wb') as token:
            pickle.dump(creds, token)
+    print("更新チェックが完了しました。:")
+    print("有効:", creds.valid)
+    print("有効期限:", conv_jst(creds.expiry))
    service = build('calendar', 'v3', credentials=creds)

    # Call the Calendar API
    now = datetime.utcnow().isoformat() + 'Z' # 'Z' indicates UTC time
    print('Getting the upcoming 10 events')
    events_result = service.events().list(calendarId='primary', timeMin=now,
                                        maxResults=10, singleEvents=True,
                                        orderBy='startTime').execute()
    events = events_result.get('items', [])

    if not events:
        print('No upcoming events found.')
    for event in events:
        start = event['start'].get('dateTime', event['start'].get('date'))
        print(start, event['summary'])


if __name__ == '__main__':
    main()

Comments

[nori_nori]

qnoir様
ご回答ありがとうございます。
お世話になっております。

私の環境では
print(creds.to_json())
にしても質問文の実行結果のようになってしまいます。
できればexpiredの情報が含まれてほしいのですが、どうやっても含まれてない状態です。
ログイン認証要求を初回だけ出るだけでその後、
最低一ヶ月ほどはログイン画面が出ないでアクセスしたいのです。
最低一日一回はアクセスします。

そのため有効期限が必要なのかなと思ってますが、expiredがなくても済みそうならそれでも大丈夫です。
公式のコードとは違いますが以下はそれ用に作ったコードです。

from __future__ import print_function
import datetime
import pickle
import os.path
from googleapiclient.discovery import build
from google_auth_oauthlib.flow import InstalledAppFlow
from google.auth.transport.requests import Request

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

def main():
creds = None
if os.path.exists('token.pickle'):
with open('token.pickle', 'rb') as token:
creds = pickle.load(token)
creds.refresh(Request()) # 外部APIに接続

else:
# from_client_secrets_file returns google_auth_oauthlib.flow.Flow object
flow = InstalledAppFlow.from_client_secrets_file(
'credentials.json', SCOPES) # 外部APIに接続
creds = flow.run_console() # 外部APIに接続

# Save the credentials for the next run
with open('token.pickle', 'wb') as token:
pickle.dump(creds, token)

print(creds.to_json())
service = build('calendar', 'v3', credentials=creds)

# Call the Calendar API
now = datetime.datetime.utcnow().isoformat() + 'Z' # 'Z' indicates UTC time
print('Getting the upcoming 10 events')
events_result = service.events().list(calendarId='primary', timeMin=now,
maxResults=10, singleEvents=True,
orderBy='startTime').execute()
events = events_result.get('items', [])

if not events:
print('No upcoming events found.')
for event in events:
start = event['start'].get('dateTime', event['start'].get('date'))
print(start, event['summary'])

if __name__ == '__main__':
main()

流れとしては

token.pickleの有無
↓
(有)credsのrefresh (無)初回ログインでcreds生成
↓
credsを元にtoken.pickleを書き込み
↓
一日最低一回以上繰り返し

このやり方でも問題なければいいのですが、
検証中でしてご存知であればご教授ください。
よろしくお願い致します。