Python的Google API客户端

2025 年 3 月 4 日 | 阅读 6 分钟

这个 Python 客户端库非常通用，允许开发者将其尽可能多的 Google 服务集成到他们的 Python 应用程序中。如果你需要与 Google Drive、Gmail、Google Sheets 或 YouTube 等服务交互，这个客户端提供了成功验证用户、发送请求和处理 Google API 响应的功能。

Google 的服务在我们的工作和日常生活中扮演着重要角色，包括 Google Drive 中的文档、Google Sheets 中的电子表格以及 Gmail 中的电子邮件。这些服务在应用程序中实现时，会利用 Google API 客户端提供这些服务的自动化和集成，而无需开发者花费时间自行管理HTTP 请求或身份验证过程。

该库支持许多 Google API，并内置了 OAuth 2.0 支持，可进行安全身份验证，并提供一次发送多个请求以加快数据处理和管理错误条件的功能，以获得用户友好的体验。它能够提供基础集成到全面的大规模集成解决方案。

核心上，Google API 客户端库简化了

身份验证和授权：根据当前文献，最常见的两种 Web 服务访问机制是 OAuth 2.0 支持。
服务访问：Google 的一些 API 包括 Drive、Sheets、YouTube 和 Gmail。
API 发现：可以通过更改设置与不同的 API 协同工作，而无需重新编程机器人。

这个 Python 客户端库通过通用的 HTTP 请求和响应与 Google REST API 进行通信，但为开发者提供了相当大的抽象层。

安装

在 Python 中开始使用 API 客户端库之前，必须先安装它。你可以使用 pip 进行安装。

此外，根据使用的服务，你可能需要 google-auth、google-auth-oauthlib 和 google-auth-httplib2 来处理凭证和身份验证。如下安装它们：

使用 Google API 进行身份验证

Google 使用 OAuth 2.0 来授予 API 访问权限。这意味着在使用该应用程序访问用户信息之前，必须对该应用程序进行身份验证。以下是设置身份验证的简单分步指南：

设置你的 Google Cloud 项目

要了解这些资源，你可以前往 Google Cloud Console。
目前，必须遵循的主要步骤是：打开一个项目并启用你想要的 API（例如，Google Drive API）。
开发 OAuth 凭证，包括客户端 ID 和客户端密钥。
下载 credentials.json 文件。

Python 中的 OAuth 流：要做到这一点，你需要利用 OAuth2。也就是说，需要有 0 凭证才能获得访问令牌。以下是如何实现此目标的示例。你可以按照下面的方法进行操作。

 
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
# If modifying scopes, delete the token.json file.
SCOPES = ['https://www.googleapis.com/auth/drive.metadata.readonly']
def authenticate():
    # Load credentials from file
    creds = None
    if os.path.exists('token.json'):
        creds = Credentials.from_authorized_user_file('token.json', SCOPES)    
    # If no valid credentials, perform the OAuth 2.0 flow
    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 credentials for future use
        with open('token.json', 'w') as token:
            token.write(creds.to_json())
    return creds   

输出

使用 Google Drive API

Google Drive API 提供了一个接口，用户可以通过该接口管理 Google Drive 中的文件。初始化会话后，你可以创建、读取、更新和删除文件。

 
from googleapiclient.discovery import build
def list_drive_files():
    creds = authenticate()
    service = build('drive', 'v3', credentials=creds)
    # Call the Drive v3 API
    results = service.files().list(pageSize=10).execute()
    items = results.get('files', [])
    if not items:
        print('No files found.')
    else:
        print('Files:')
        for item in items:
            print(f"{item['name']} ({item['id']})")
list_drive_files()   

输出

 
Files:
Document 1 (1rJNQb-uF2mZZPVZtDfVRkzo74g)
Document 2 (1fReDNopwJvCVJPPVU9DDDf3KO7)
Image.png (1oxKPKdfjgdfKJJF8ow-FK4d-owO)

输出将列出 Google Drive 中的文件以及分配给 Google Drive 中每个文件的文件 ID。此示例使用 Google Drive API 的 list() 方法来获取文件详细信息。

Google Sheets API

Google Sheets API 提供了在 Google Sheets 中读取、写入和修改数据的能力。这方便了数据处理过程，例如将数据导出为电子表格格式或拉取当前数据。

从 Google Sheet 读取数据

首先，我们需要在 Google Cloud Console 中启用 Google Sheets API，并使用以下范围进行授权：

以下是如何从 Google Sheet 读取数据：

 
from googleapiclient.discovery import build
# The ID and range of the spreadsheet
SHEET_ID = 'your_spreadsheet_id'
RANGE = 'Sheet1!A1:D10'
def read_sheet_data():
    creds = authenticate()
    service = build('sheets', 'v4', credentials=creds)
    sheet = service.spreadsheets()
    # Fetching data from the sheet
    result = sheet.values().get(spreadsheetId=SHEET_ID, range=RANGE).execute()
    values = result.get('values', [])
    if not values:
        print('No data found.')
    else:
        for row in values:
            print(row)
read_sheet_data()  

输出

 
['Name', 'Age', 'Gender', 'Occupation']
['Alice', '30', 'F', 'Engineer']
['Bob', '25', 'M', 'Designer']
['Eve', '35', 'F', 'Manager']

将数据写入 Google Sheet

要将数据写回 Google Sheet，你可以使用 update() 方法。

 
def write_sheet_data():
    creds = authenticate()
    service = build('sheets', 'v4', credentials=creds)
    sheet = service.spreadsheets()
    # Data to be written
    values = [
        ['Name', 'Age', 'Gender', 'Occupation'],
        ['John', '28', 'M', 'Architect'],
        ['Mia', '26', 'F', 'Developer']
    ]
    body = {'values': values}
    # Updating the sheet with the new data
    result = sheet.values().update(
        spreadsheetId=SHEET_ID,
        range='Sheet1!A1',
        valueInputOption='RAW',
        body=body).execute()
    print(f'{result.get("updatedCells")} cells updated.')
write_sheet_data()   

输出

 
8 cells updated.

Gmail API

Gmail API 提供了一种发送或接收电子邮件的方法，以及执行所有与电子邮件相关的任务。例如，它允许你设置你的 Python 应用程序自动发送电子邮件警报。

发送电子邮件

 
from email.mime.text import MIMEText
import base64
def create_message(sender, to, subject, message_text):
    message = MIMEText(message_text)
    message['to'] = to
    message['from'] = sender
    message['subject'] = subject
    return {'raw': base64.urlsafe_b64encode(message.as_bytes()).decode()}
def send_email():
    creds = authenticate()
    service = build('gmail', 'v1', credentials=creds)
    message = create_message('me', 'recipient@example.com', 'Test Email', 'This is a test email')
    sent_message = service.users().messages().send(userId='me', body=message).execute()
    print(f'Message Id: {sent_message["id"]}')
send_email()   

输出

 
Message Id: 17a8cc4e8d3d0a2b

批量请求

批量请求允许你在单个 HTTP 请求中运行多个请求，从而优化你的 API 调用。当你需要同时处理不同的对象时，例如读取文件、发送邮件或打开特定页面，这特别有用。

 
from googleapiclient.http import BatchHttpRequest
def callback(request_id, response, exception):
    if exception:
        print(f"Error: {exception}")
    else:
        print(f"Request {request_id} complete: {response}")
def batch_request_example():
    creds = authenticate()
    service = build('drive', 'v3', credentials=creds)
    batch = BatchHttpRequest(callback=callback)
    # Add multiple requests to the batch
    batch.add(service.files().get(fileId='file_id_1'))
    batch.add(service.files().get(fileId='file_id_2'))
    # Execute the batch request
    batch.execute()
batch_request_example()   

输出

 
Request 1 complete: {'id': 'file_id_1', 'name': 'Document 1'}
Request 2 complete: {'id': 'file_id_2', 'name': 'Document 2'}

以下是使用 Google Drive API 发送批量请求的示例：

错误处理和调试

在使用 Google API 客户端（Python）时，必须了解如何在应用程序中处理诸如令牌过期、速率限制和其他 API 错误之类的错误。

处理 API 错误

Google API 调用和响应中也包含错误消息，以防 API 请求出现问题。可以使用 Python 的 try-except 语句来处理这些错误。

以下是访问 Google Drive 时进行错误处理的示例：

 
from googleapiclient.errors import HttpError
def handle_drive_errors():
    creds = authenticate()
    service = build('drive', 'v3', credentials=creds)
    try:
        # Trying to access a non-existent file
        file = service.files().get(fileId='invalid_file_id').execute()
        print(file)
    except HttpError as error:
        print(f"An error occurred: {error}")
        # Additional error handling logic
        if error.resp.status == 404:
            print("File not found.")
        elif error.resp.status == 403:
            print("Access denied.")
        else:
            print("An unexpected error occurred.")    
handle_drive_errors()   

输出

 
An error occurred: <HttpError 404 when requesting https://www.googleapis.com/drive/v3/files/invalid_file_id returned "File not found".>
File not found.

结论

Google API 客户端（Python）是使用 Google 服务（如 Drive、Sheets 和 Gmail）在 Python 环境中的有效且高效的方式。它包含安全身份验证以防止未经授权的访问，批量处理以处理大量数据，以及错误处理，在自动化组织的业务流程和数据处理方面非常有效。无论项目规模大小，从小型应用程序到大规模使用，该客户端都使开发者能够轻松访问 API 并创建有效且稳固的 Google 结构。

下一主题Gps-tracker-using-python

Python的Google API客户端

安装

使用 Google API 进行身份验证

使用 Google Drive API

Google Sheets API

Gmail API

批量请求

错误处理和调试

结论

联系信息

关注我们

教程

面试题

在线编译器

Python

Java

.Net Framework

AI, ML and Data Science

Cloud Technology

B.Tech and MCA

Web Technology

PHP

Software Testing

Technical Interview

Java Interview

Python

Web Interview

Database Interview

B.Tech / MCA

Important Interview

Software Testing Interview

Company Interviews

Online Compilers

Multiple Choice Questions

其他

Python的Google API客户端

安装

使用 Google API 进行身份验证

使用 Google Drive API

Google Sheets API

Gmail API

批量请求

错误处理和调试

结论

相关帖子

Python中的Arduino编程

如何使用Python将文本文件读入列表或数组

Python中的keras.utils.to_categorical()

有哪些Python游戏引擎

如何从Python文本文件中删除特定行

Python中读取二进制文件

Python中的playsound模块

使用Python的GPS追踪器

Python 虚拟环境

以表格形式显示Pandas DataFrame

订阅 Tpoint Tech

联系信息

关注我们

教程

面试题

在线编译器