通过PHP使用Google API创建并公开共享Google表格

概述

在使用google sheets api通过编程方式创建新的电子表格时，一个常见的需求是使其能够通过链接访问，甚至公开共享。默认情况下，通过spreadsheets.create方法创建的表格是私有的。要实现“通过链接访问”或“公开共享”的功能，我们需要结合使用google sheets api来创建表格，以及google drive api来管理其权限。

步骤一：创建Google表格并获取其URL

首先，您需要使用Google Sheets API创建电子表格。在创建成功后，API响应中会包含一个spreadsheetId，这是构建表格访问链接的关键。

以下是使用PHP创建表格并获取其URL的示例代码：

<?php

require_once 'vendor/autoload.php'; // 确保已加载Composer依赖

// 假设 $client 变量已经过认证并配置，例如使用OAuth 2.0
// $client = new Google_Client();
// $client->setApplicationName('Google Sheets API PHP Quickstart');
// $client->setScopes([Google_Service_Sheets::SPREADSHEETS, Google_Service_Drive::DRIVE]);
// $client->setAuthConfig('credentials.json'); // 您的凭据文件
// $client->setAccessType('offline');
// $client->setPrompt('select_account consent');
// ... 认证流程 ...

$service = new Google_Service_Sheets($client);

$title = '我的新API创建表格'; // 您希望为表格设置的标题

// 创建一个新的Spreadsheet对象
$spreadsheetProperties = [
    'properties' => [
        'title' => $title,
    ]
];
$spreadsheet = new Google_Service_Sheets_Spreadsheet($spreadsheetProperties);

try {
    // 调用create方法创建表格，并指定只返回spreadsheetId字段以优化性能
    $createdSpreadsheet = $service->spreadsheets->create($spreadsheet, ['fields' => 'spreadsheetId']);
    $spreadsheetId = $createdSpreadsheet->spreadsheetId;

    // 构建新创建表格的URL
    $spreadsheetUrl = "https://docs.google.com/spreadsheets/d/" . $spreadsheetId . "/edit";

    printf("表格创建成功！\n");
    printf("表格ID: %s\n", $spreadsheetId);
    printf("表格URL: %s\n", $spreadsheetUrl);

} catch (Google\Service\Exception $e) {
    printf("创建表格时发生错误: %s\n", $e->getMessage());
}

?>

代码说明：

• Google_Service_Sheets($client)：初始化Sheets服务。
• Google_Service_Sheets_Spreadsheet：定义新表格的属性，这里只设置了标题。
• $service-youjiankuohaophpcnspreadsheets->create($spreadsheet, ['fields' => 'spreadsheetId'])：执行创建操作。通过['fields' => 'spreadsheetId']，我们明确指示API只返回表格ID，这是一种良好的实践，可以减少网络负载。
• $createdSpreadsheet->spreadsheetId：从API响应中提取新创建表格的唯一标识符。
• "https://docs.google.com/spreadsheets/d/" . $spreadsheetId . "/edit"：这是Google表格的标准URL格式，通过拼接spreadsheetId即可得到可访问的链接。

至此，您已经成功创建了一个Google表格并获取了其URL。然而，这个表格仍然是私有的，只有拥有相应Google账号权限的用户才能访问。

立即学习“PHP免费学习笔记（深入）”；

Google AI Studio

Google 推出的基于浏览器的集成开发环境

107

查看详情

步骤二：通过Google Drive API设置表格共享权限

要使表格能够通过链接公开访问（即“任何人都可以查看”），我们需要使用Google Drive API来修改其权限。Google Sheets文件本质上是存储在Google Drive中的文件，因此其权限管理也通过Drive API进行。

继续以上一步获取的$spreadsheetId，我们可以添加一个“任何人”都可以访问的权限。

<?php
// ... 承接上一步的代码，确保 $client 仍然可用且已认证 ...
// 确保 $spreadsheetId 变量已从上一步获取

if (isset($spreadsheetId)) {
    $driveService = new Google_Service_Drive($client);

    // 创建一个新的权限对象
    $newPermission = new Google_Service_Drive_Permission();
    $newPermission->setType('anyone'); // 设置权限类型为“任何人”
    $newPermission->setRole('reader'); // 设置角色为“阅读者”，也可以是'writer'（编辑者）

    try {
        // 将新权限应用到指定ID的表格
        $driveService->permissions->create($spreadsheetId, $newPermission);
        printf("表格已成功设置为通过链接公开共享（阅读者权限）。\n");
    } catch (Google\Service\Exception $e) {
        printf("设置表格共享权限时发生错误: %s\n", $e->getMessage());
    }
} else {
    printf("未获取到表格ID，无法设置共享权限。\n");
}

?>

代码说明：

• Google_Service_Drive($client)：初始化Drive服务。请确保您的$client配置包含了Google_Service_Drive::DRIVE范围。
• Google_Service_Drive_Permission()：创建一个权限对象。
• $newPermission->setType('anyone')：这是关键一步，它将权限授予给所有拥有链接的用户，无需登录Google账号。
• $newPermission->setRole('reader')：定义“任何人”的角色。
  • reader：只读权限。
  • writer：编辑权限（请谨慎使用，因为这意味着任何人都可以修改您的表格）。
• $driveService->permissions->create($spreadsheetId, $newPermission)：将定义的权限应用到之前创建的表格上。

注意事项

1. API Scope（授权范围）：确保您的Google Client在认证时包含了必要的API范围。对于创建表格，需要Google_Service_Sheets::SPREADSHEETS。对于管理权限，需要Google_Service_Drive::DRIVE或更具体的Google_Service_Drive::DRIVE_FILE。
2. 公共共享的风险：将表格设置为type('anyone')和role('reader')意味着任何知道链接的人都可以查看您的表格内容。如果表格包含敏感信息，请勿使用此方法。
3. 权限管理：如果您不希望公开共享表格，只需跳过步骤二的代码即可。表格将保持私有，仅由创建它的服务账号或明确共享的用户访问。
4. 错误处理：在实际生产环境中，务必添加健壮的错误处理机制来捕获API调用可能抛出的异常。

总结

通过结合使用Google Sheets API和Google Drive API，您可以灵活地通过PHP创建Google表格，并精确控制其访问权限。首先，使用Sheets API创建表格并获取其spreadsheetId，然后利用Drive API，通过permissions.create方法为该spreadsheetId对应的文件设置anyone类型的权限，从而实现通过链接公开访问或共享。理解并正确应用这些步骤，将使您能够高效地自动化Google表格的创建和权限管理流程。

以上就是通过PHP使用Google API创建并公开共享Google表格的详细内容，更多请关注php中文网其它相关文章！