Python调用Google Apps Script：实现无缝自动化认证的教程

import os.path
from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient import errors
from googleapiclient.discovery import build

# 定义所需的API范围。建议仅使用脚本所需的最小范围。
# 以下范围列表涵盖了广泛的Apps Script和Drive操作，请根据实际需求进行调整。
SCOPES = [
    "https://www.googleapis.com/auth/script.projects",
    "https://www.googleapis.com/auth/script.external_request",
    "https://www.googleapis.com/auth/drive.readonly",
    "https://www.googleapis.com/auth/drive",
    "https://www.googleapis.com/auth/drive.scripts",
    "https://www.googleapis.com/auth/script.processes",
    "https://www.googleapis.com/auth/spreadsheets",
    "https://www.googleapis.com/auth/script.scriptapp",
]

def run_apps_script_with_auth(script_deployment_id: str, function_name: str):
    """
    使用持久化认证凭据调用Google Apps Script API。

    Args:
        script_deployment_id (str): Google Apps Script的部署ID（不是项目ID）。
        function_name (str): 要执行的Apps Script函数名称。
    """
    creds = None
    # 1. 检查是否存在token.json文件。如果存在，尝试加载凭据。
    # token.json存储了用户的访问和刷新令牌，在首次授权流程完成后自动创建。
    if os.path.exists("token.json"):
        creds = Credentials.from_authorized_user_file("token.json", SCOPES)

    # 2. 如果没有有效的凭据，或者凭据已过期且有刷新令牌，则刷新凭据。
    # 否则，启动新的认证流程。
    if not creds or not creds.valid:
        if creds and creds.expired and creds.refresh_token:
            # 凭据过期但有刷新令牌，使用刷新令牌获取新的访问令牌
            print("凭据已过期，正在尝试刷新令牌...")
            creds.refresh(Request())
        else:
            # 没有有效的凭据，或者刷新令牌也无效/不存在，启动新的认证流程。
            # 这会打开浏览器窗口，要求用户进行交互式授权。
            print("未找到有效凭据或凭据无效，正在启动新的认证流程...")
            flow = InstalledAppFlow.from_client_secrets_file(
                "credentials.json", SCOPES
            )
            creds = flow.run_local_server(port=0) # port=0 会自动选择一个可用端口

        # 3. 将新获得的或刷新的凭据保存到token.json文件中，以便下次运行使用。
        with open("token.json", "w") as token:
            token.write(creds.to_json())
        print("凭据已保存到 token.json。")

    try:
        # 4. 使用获得的凭据构建Google Apps Script API服务客户端。
        service = build("script", "v1", credentials=creds)

        # 5. 创建一个执行请求对象，指定要运行的Apps Script函数。
        request_body = {"function": function_name}

        # 6. 调用Apps Script API执行指定的函数。
        print(f"正在执行Apps Script: {function_name} (部署ID: {script_deployment_id})...")
        response = service.scripts().run(body=request_body, scriptId=script_deployment_id).execute()

        # 7. 处理API响应。
        if 'error' in response:
            # Apps Script执行失败，打印错误详情。
            error_details = response['error']['details']
            print(f"Apps Script执行失败。错误详情: {error_details}")
            # 可以根据需要解析更具体的错误信息，例如堆栈跟踪。
        else:
            # Apps Script执行成功，打印结果。
            print(f"Apps Script执行成功。结果: {response.get('response', {}).get('result')}")

    except errors.HttpError as error:
        # 捕获并打印Google API调用过程中发生的HTTP错误。
        print(f"Google API调用失败: {error.content}")
    except Exception as e:
        # 捕获其他潜在的运行时错误。
        print(f"发生未知错误: {e}")

# 示例用法
if __name__ == "__main__":
    # 替换为你的Google Apps Script部署ID和要执行的函数名。
    # 部署ID可以在Apps Script编辑器中，“部署”->“管理部署”中找到。
    my_script_deployment_id = "YOUR_APPS_SCRIPT_DEPLOYMENT_ID" # 例如：AKfycbxtDnDYa2mTZKB6WoqK_D9PDsLZyqb7GQAh7pvER-K-rMFXYNa6oVOhzXHsyfyl8vLz
    my_function_name = "helloWorld" # 你的Apps Script项目中定义的函数名

    # 首次运行时会打开浏览器进行授权，之后会复用token.json，实现自动化。
    run_apps_script_with_auth(my_script_deployment_id, my_function_name)