使用 google Sheets API 获取列的元数据

Question

我有一个 Google 电子表格，我正在使用 google-python-api-client 包连接并与之交互。在this description on metadata search 以及请求正文中的链接之后，我编写了一个函数来获取范围的元数据：

def get_metadata_by_range(range_: Union[dict, str]) -> dict:
    if isinstance(range_, str):
        print("String range: ", range_)
        request_body = {"dataFilters": \
                            {"a1Range": range_}}
    elif isinstance(range_, dict):
        print("Dict range: ", range_)
        request_body = {"dataFilters": \
                            [{"gridRange": range_}]}
    else:
        return None
    request = service.spreadsheets().developerMetadata().\
            search(spreadsheetId=SPREADSHEET_ID, body=request_body)
    return request.execute()

使用范围调用它，无论是 A1 表示法还是 gridRange 都会导致发生错误。例如，使用 get_metadata_by_range("Metadata!A:A") 这一行调用它会导致以下回溯。

String range:  Metadata!A:A
Traceback (most recent call last):
  File "oqc_server/fab/gapc.py", line 82, in <module>
    get_metadata_by_range("Metadata!A:A")
  File "oqc_server/fab/gapc.py", line 69, in get_metadata_by_range
    return request.execute()
  File "/media/kajsa/Storage/Projects/oqc_server/venv/lib/python3.7/site-packages/googleapiclient/_helpers.py", line 130, in positional_wrapper
    return wrapped(*args, **kwargs)
  File "/media/kajsa/Storage/Projects/oqc_server/venv/lib/python3.7/site-packages/googleapiclient/http.py", line 856, in execute
    raise HttpError(resp, content, uri=self.uri)
googleapiclient.errors.HttpError: <HttpError 500 when requesting https://sheets.googleapis.com/v4/spreadsheets/1RhheCsI3kHrm8yK2Yio2kAOU4VOzYdz-eK0vjiMY7co/developerMetadata:search?alt=json returned "Internal error encountered."

关于导致此问题的原因以及如何解决它的任何想法？

Answer 1

• 您希望使用 Sheets API 的 Method: spreadsheets.developerMetadata.search 方法从范围内搜索和检索开发者元数据。
• 您希望使用 google-api-python-client 和 python 来实现此目的。
• 您已经能够使用 Sheets API 获取和放置电子表格的值。

如果我的理解是正确的，那么这个答案呢？请认为这只是几个可能的答案之一。

修改点：

• 当你想用范围搜索开发者元数据时，请将gridrange设置为dataFilters[].developerMetadataLookup.metadataLocation.dimensionRange。
  • 当范围设置为dataFilters[].a1Range 和dataFilters[].gridRange 时，我可以确认发生了同样的错误。

示例脚本：

从范围中检索开发者元数据的示例脚本如下。使用前请先设置spreadsheet_id和sheet_id的变量。

service = build('sheets', 'v4', credentials=creds)
spreadsheet_id = '###'  # Please set the Spreadsheet ID.
sheet_id = ###  # Please set the sheet ID.

search_developer_metadata_request_body = {
    "dataFilters": [
        {
            "developerMetadataLookup": {
                "metadataLocation": {
                    "dimensionRange": {
                        "sheetId": sheet_id,
                        "dimension": "COLUMNS",
                        "startIndex": 0,
                        "endIndex": 1
                    }
                }
            }
        }
    ]
}

request = service.spreadsheets().developerMetadata().search(
    spreadsheetId=spreadsheet_id, body=search_developer_metadata_request_body)
response = request.execute()
print(response)

• 上述脚本从sheet_id 的“A”列检索开发者元数据。

注意：

• 请根据您的实际脚本修改上述脚本。
• 在当前阶段，可以将开发人员元数据添加到电子表格、电子表格中的每个表格以及行和列。请注意这一点。 Ref

参考资料：

• Method: spreadsheets.developerMetadata.search
• Adding Developer Metadata- DeveloperMetadataLookup

如果我误解了您的问题并且这不是您想要的方向，我深表歉意。

Answer 2

developerMetadata 存在与作为过滤器传递的 a1Range 对象相关的错误。

编辑

我再次检查了该错误并已实施修复。