使用Google Sheets API更新DeveloperMetadata失败（PHP客户端）

你的代码无法更新DeveloperMetadata的核心原因是缺少目标元数据的定位信息——更新操作需要明确指定要修改的是哪一条元数据，仅提供key、value和visibility不足以让API定位到目标。

关键修正点： #

• 更新必须指定目标元数据的metadataId，同时要匹配元数据的location和visibility（确保定位准确）
• 代码中未定义$spreadsheet_id变量，需要补充传入
• 若未知目标元数据的ID，需先通过列表接口获取已有元数据的信息

修正后的完整代码示例： #

<?php
class GoogleSheetHelper {
    // 获取目标元数据的ID与位置信息
    private function get_existing_dev_meta($spreadsheet_id) {
        $client  = $this->get_client();
        $service = new Sheets($client);
        
        // 筛选文档级指定key的元数据
        $response = $service->spreadsheets_developerMetadata->listSpreadsheetsDeveloperMetadata($spreadsheet_id, [
            'metadataFilters' => [
                ['metadataKey' => 'new_meta_key', 'visibility' => 'DOCUMENT']
            ]
        ]);
        
        return $response->getDeveloperMetadata()[0] ?? null;
    }

    function update_dev_meta($spreadsheet_id) {
        // 先获取要更新的元数据
        $existing_meta = $this->get_existing_dev_meta($spreadsheet_id);
        if (!$existing_meta) {
            echo "未找到目标元数据";
            return false;
        }

        // 构建更新用的元数据对象，保留原ID、位置，修改目标值
        $dev_meta = new DeveloperMetadata();
        $dev_meta->setMetadataId($existing_meta->getMetadataId());
        $dev_meta->setLocation($existing_meta->getLocation());
        $dev_meta->setVisibility('DOCUMENT');
        $dev_meta->setMetadataKey('new_meta_key');
        $dev_meta->setMetadataValue('new_meta_value_updated');

        $update_req = new UpdateDeveloperMetadataRequest();
        $update_req->setDeveloperMetadata($dev_meta);
        // 指定仅更新元数据值，也可用'*'更新所有可修改字段
        $update_req->setFields('metadataValue');

        $request = new Request();
        $request->setUpdateDeveloperMetadata($update_req);

        $batch_update = new BatchUpdateSpreadsheetRequest();
        $batch_update->setRequests([$request]);

        $client  = $this->get_client();
        $service = new Sheets($client);

        try {
            return $service->spreadsheets->batchUpdate($spreadsheet_id, $batch_update);
        } catch (Exception $ex) {
            var_dump($ex->getErrors());
            return false;
        }
    }

    private function get_client($scopes = []) {
        $credential = 'location/of/credential.json';

        if (empty($credential)) {
            return null;
        }

        $default_scopes = [
            'https://www.googleapis.com/auth/drive',
            'https://www.googleapis.com/auth/spreadsheets',
        ];

        return new Client([
            'credentials' => $credential,
            'scopes'      => $default_scopes,
        ]);
    }
}

额外说明： #

• 若已明确目标元数据的metadataId，可跳过get_existing_dev_meta方法，直接在dev_meta中设置对应ID和位置
• setFields建议指定具体字段，避免不必要的字段更新，提升安全性与性能

内容的提问来源于stack exchange，提问作者sapayth