借助开发者元数据功能，您可以在电子表格中将元数据与各种实体和位置相关联。然后，您可以查询此元数据，并使用它查找与其关联的对象。
您可以将元数据与行、列、工作表或电子表格相关联。
开发者元数据让您可以执行各种操作，例如：
将任意数据与电子表格中的各种实体和位置关联 - 例如，将
totals与 D 列关联，或将responseId = 1234与第 7 行关联。查找与特定元数据键或属性关联的所有位置和数据：例如，假设与列 D 关联的键为
totals，或者假设responseId，则返回包含responseId元数据和与其关联的元数据值的所有行。查找与特定实体或位置关联的所有数据：例如，假设 D 列返回与该位置关联的所有元数据。
通过指定关联的元数据检索某个位置中的值：例如，假设
totals，则返回关联列或行中所包含值的表示；或者假设summary，则返回关联工作表资源的表示。通过指定关联的元数据更新某个位置中的值：例如，通过指示元数据 ID 来更新值，而不是通过 A1 表示法更新某一行中的值。
读取和写入元数据
spreadsheets.developerMetadata 资源可让您访问与电子表格中的位置或对象关联的开发者元数据。
开发者元数据简介
本部分介绍了在使用 Sheets API 时应考虑的开发者元数据的一些关键方面。
元数据作为标记
开发者元数据的一种用途是标记，它只使用键和位置即可在电子表格中为地点命名。例如，您可以将 headerRow 与工作表中的特定行相关联，或将 totals 与特定列相关联。代码可用于在语义上将电子表格中的部分绑定到第三方工具或数据库中的字段，因此，对电子表格的更改不会严重影响您的应用。
元数据作为属性
通过指定键、位置和值创建的元数据会作为与工作表中相应位置关联的键值对。例如，您可以关联：
formResponseId = resp123包含行lastUpdated = 1477369882包含列。
这样一来，您可以存储和访问与电子表格中的特定区域或数据关联的自定义命名属性。
项目可见元数据与文档可见元数据
为了防止一个开发者项目干扰另一个开发者项目的元数据，存在 2 种元数据 visibility 设置：project 和 document。使用 Google 表格 API 时，项目元数据仅对创建它的开发者项目可见并且仅能从这个项目访问。文档元数据可以从具有该文档访问权限的任何开发者项目访问。
没有明确指定可见性的查询将返回发起请求的开发者项目的匹配文档元数据和匹配项目元数据。
唯一性
元数据键不必是唯一的，但 metadataId 必须是唯一的。如果您创建元数据时不指定其 ID 字段，API 将分配一个 ID。此 ID 可用于标识元数据，而键和其他属性则可用于标识元数据集。
创建元数据
如需创建元数据，请使用 batchUpdate 方法，并提供包含 metadataKey、location 和 visibility 的 createDeveloperMetadataRequest。您可以选择指定 metadataValue 或显式 metadataId。
如果您指定的 ID 已被使用，请求将会失败。如果您未提供 ID，该 API 会分配一个 ID。
显示示例
在此示例中，我们在请求中提供了键、值和行。响应会返回这些开发者元数据值，以及分配的元数据 ID。
请求
{
"requests": [
{
"createDeveloperMetadata": {
"developerMetadata": {
"location": {
"dimensionRange": {
"sheetId": sheetId,
"dimension": "ROWS",
"startIndex": 6,
"endIndex": 7
}
},
"visibility": "DOCUMENT",
"metadataKey": "Sales",
"metadataValue": "2022"
}
}
}
]
}答案
{
"spreadsheetId": spreadsheetId,
"replies": [
{
"createDeveloperMetadata": {
"developerMetadata": {
"metadataId": metadataId,
"metadataKey": "Sales",
"metadataValue": "2022",
"location": {
"locationType": "ROW",
"dimensionRange": {
"sheetId": sheetId,
"dimension": "ROWS",
"startIndex": 6,
"endIndex": 7
}
},
"visibility": "DOCUMENT"
}
}
}
]
}读取单个元数据项
如需检索单个不同的开发者元数据，请使用 spreadsheets.developerMetadata.get 方法，指定包含元数据的 spreadsheetId 以及开发者元数据的唯一 metadataId。
显示示例
请求
在此示例中，我们在请求中提供了电子表格 ID 和元数据 ID。响应会返回相应元数据 ID 的开发者元数据值。
GET https://sheets.googleapis.com/v4/spreadsheets/spreadsheetId/developerMetadata/metadataId
答案
{
"metadataId": metadataId,
"metadataKey": "Sales",
"metadataValue": "2022",
"location": {
"locationType": "ROW",
"dimensionRange": {
"sheetId": sheetId,
"dimension": "ROWS",
"startIndex": 6,
"endIndex": 7
}
},
"visibility": "DOCUMENT"
}读取多个元数据项
如需检索开发者元数据的多个项，请使用 spreadsheets.developerMetadata.search 方法。您需要指定一个 DataFilter，该 DataFilter 应与键、值、位置或可见性等属性的任意组合中现有元数据匹配。
显示示例
在此示例中，我们在请求中提供了多个元数据 ID。响应会返回每个元数据 ID 的开发者元数据值。
请求
{
"dataFilters": [
{
"developerMetadataLookup": {
"metadataId": metadataId
}
},
{
"developerMetadataLookup": {
"metadataId": metadataId
}
}
]
}答案
{
"matchedDeveloperMetadata": [
{
"developerMetadata": {
"metadataId": metadataId,
"metadataKey": "Revenue",
"metadataValue": "2022",
"location": {
"locationType": "SHEET",
"sheetId": sheetId
},
"visibility": "DOCUMENT"
},
"dataFilters": [
{
"developerMetadataLookup": {
"metadataId": metadataId
}
}
]
},
{
"developerMetadata": {
"metadataId": metadataId,
"metadataKey": "Sales",
"metadataValue": "2022",
"location": {
"locationType": "SHEET",
"sheetId": sheetId
},
"visibility": "DOCUMENT"
},
"dataFilters": [
{
"developerMetadataLookup": {
"metadataId": metadataId
}
}
]
}
]
}更新元数据
如需更新开发者元数据，请使用 spreadsheets.batchUpdate 方法并提供 UpdateDeveloperMetadataRequest。您需要指定一个定位到要更新的元数据的 DataFilter、一个包含新值的 DeveloperMetadata 对象，以及一个描述要更新的字段的字段掩码。
显示示例
在此示例中，我们在请求中提供了元数据 ID、工作表 ID 和新的元数据键。响应会返回这些开发者元数据值，以及更新后的元数据键。
请求
{
"requests": [
{
"updateDeveloperMetadata": {
"dataFilters": [
{
"developerMetadataLookup": {
"metadataId": metadataId
}
}
],
"developerMetadata": {
"location": {
"sheetId": sheetId
},
"metadataKey": "SalesUpdated"
},
"fields": "location,metadataKey"
}
}
]
}答案
{
"spreadsheetId": spreadsheetId,
"replies": [
{
"updateDeveloperMetadata": {
"developerMetadata": [
{
"metadataId": metadataId,
"metadataKey": "SalesUpdated",
"metadataValue": "2022",
"location": {
"locationType": "SHEET",
"sheetId": sheetId
},
"visibility": "DOCUMENT"
}
]
}
}
]
}删除元数据
如需删除开发者元数据，请使用 batchUpdate 方法并提供 DeleteDeveloperMetadataRequest。您需要指定一个 DataFilter 来选择要删除的元数据。
显示示例
在此示例中，我们在请求中提供元数据 ID。响应会返回相应元数据 ID 的开发者元数据值。
如需确认开发者元数据已移除，请使用 spreadsheets.developerMetadata.get 方法，指定已删除的元数据 ID。您应该会收到 404: Not Found HTTP 状态代码响应，其中包含一条消息，内容为“No developer metadata with ID metadataId”。
请求
{
"requests": [
{
"deleteDeveloperMetadata": {
"dataFilter": {
"developerMetadataLookup": {
"metadataId": metadataId
}
}
}
}
]
}答案
{
"spreadsheetId": spreadsheetId,
"replies": [
{
"deleteDeveloperMetadata": {
"deletedDeveloperMetadata": [
{
"metadataId": metadataId,
"metadataKey": "SalesUpdated",
"metadataValue": "2022",
"location": {
"locationType": "SHEET",
"sheetId": sheetId
},
"visibility": "DOCUMENT"
}
]
}
}
]
}读取和写入与元数据关联的值
您还可以指定关联的开发者元数据以及要更新的值，以检索和更新行和列中的单元格值。为此，请将下方适当的方法与匹配的 DataFilter 结合使用。
按元数据获取单元格值
如需按元数据获取单元格值，请使用 spreadsheets.values.batchGetByDataFilter 方法。您需要指定电子表格 ID 以及与元数据匹配的一个或多个数据过滤条件。
显示示例
在此示例中，我们在请求中提供元数据 ID。响应会返回元数据 ID 的行单元格值（型号、月度销量）。
请求
{
"dataFilters": [
{
"developerMetadataLookup": {
"metadataId": metadataId
}
}
],
"majorDimension": "ROWS"
}答案
{
"spreadsheetId": spreadsheetId,
"valueRanges": [
{
"valueRange": {
"range": "Sheet7!A7:Z7",
"majorDimension": "ROWS",
"values": [
[
"W-24",
"74"
]
]
},
"dataFilters": [
{
"developerMetadataLookup": {
"metadataId": metadataId
}
}
]
}
]
}通过元数据获取电子表格
检索电子表格时，您可以使用 spreadsheets.getByDataFilter 方法返回部分数据。您需要指定电子表格 ID 以及与元数据匹配的一个或多个数据过滤条件。
除了指定的数据过滤器匹配的元数据列表决定要返回的工作表、网格数据和带有元数据的其他对象资源外，此请求将作为常规的“spreadsheet GET”请求。如果将 includeGridData 设置为 true，系统还会为工作表返回与指定网格范围相交的网格数据。
显示示例
在此示例中，我们在请求中提供元数据 ID 并将 includeGridData 设置为 false。响应会同时返回电子表格和工作表属性。
请求
{
"dataFilters": [
{
"developerMetadataLookup": {
"metadataId": metadataId
}
}
],
"includeGridData": false
}答案
{ "spreadsheetId": spreadsheetId, "properties": { "title": "Sales Sheet", "locale": "en_US", "autoRecalc": "ON_CHANGE", "timeZone": "America/Los_Angeles", "defaultFormat": { "backgroundColor": { "red": 1, "green": 1, "blue": 1 }, "padding": { "top": 2, "right": 3, "bottom": 2, "left": 3 }, "verticalAlignment": "BOTTOM", "wrapStrategy": "OVERFLOW_CELL", "textFormat": { "foregroundColor": {}, "fontFamily": "arial,sans,sans-serif", "fontSize": 10, "bold": false, "italic": false, "strikethrough": false, "underline": false, "foregroundColorStyle": { "rgbColor": {} } }, "backgroundColorStyle": { "rgbColor": { "red": 1, "green": 1, "blue": 1 } } }, "spreadsheetTheme": { "primaryFontFamily": "Arial", "themeColors": [ { "colorType": "TEXT", "color": { "rgbColor": {} } }, { "colorType": "BACKGROUND", "color": { "rgbColor": { "red": 1, "green": 1, "blue": 1 } } }, { "colorType": "ACCENT1", "color": { "rgbColor": { "red": 0.25882354, "green": 0.52156866, "blue": 0.95686275 } } }, { "colorType": "ACCENT2", "color": { "rgbColor": { "red": 0.91764706, "green": 0.2627451, "blue": 0.20784314 } } }, { "colorType": "ACCENT3", "color": { "rgbColor": { "red": 0.9843137, "green": 0.7372549, "blue": 0.015686275 } } }, { "colorType": "ACCENT4", "color": { "rgbColor": { "red": 0.20392157, "green": 0.65882355, "blue": 0.3254902 } } }, { "colorType": "ACCENT5", "color": { "rgbColor": { "red": 1, "green": 0.42745098, "blue": 0.003921569 } } }, { "colorType": "ACCENT6", "color": { "rgbColor": { "red": 0.27450982, "green": 0.7411765, "blue": 0.7764706 } } }, { "colorType": "LINK", "color": { "rgbColor": { "red": 0.06666667, "green": 0.33333334, "blue": 0.8 } } } ] } }, "sheets": [ { "properties": { "sheetId": sheetId, "title": "Sheet7", "index": 7, "sheetType": "GRID", "gridProperties": { "rowCount": 1000, "columnCount": 26 } } } ], "spreadsheetUrl": spreadsheetUrl }
按元数据更新值
如需更新与特定元数据匹配的单元格值，请使用 spreadsheets.values.batchUpdateByDataFilter 方法。您需要指定电子表格 ID（valueInputOption）以及与元数据匹配的一个或多个 DataFilterValueRange。
显示示例
在此示例中，我们在请求中提供元数据 ID 和更新后的行值。响应会返回元数据 ID 的更新后属性和数据。
请求
{
"data": [
{
"dataFilter": {
"developerMetadataLookup": {
"metadataId": metadataId
}
},
"majorDimension": "ROWS",
"values": [
[
"W-24",
"84"
]
]
}
],
"includeValuesInResponse": true,
"valueInputOption": "USER_ENTERED"
}答案
{
"spreadsheetId": spreadsheetId,
"totalUpdatedRows": 1,
"totalUpdatedColumns": 2,
"totalUpdatedCells": 2,
"totalUpdatedSheets": 1,
"responses": [
{
"updatedRange": "Sheet7!A7:B7",
"updatedRows": 1,
"updatedColumns": 2,
"updatedCells": 2,
"dataFilter": {
"developerMetadataLookup": {
"metadataId": metadataId
}
},
"updatedData": {
"range": "Sheet7!A7:Z7",
"majorDimension": "ROWS",
"values": [
[
"W-24",
"84"
]
]
}
}
]
}按元数据清除值
如需清除与特定元数据匹配的单元格值，请使用 spreadsheets.values.batchClearByDataFilter 方法。您需要指定一个数据过滤条件来选择要清除的元数据。
显示示例
请求
在此示例中，我们在请求中提供元数据 ID。响应会返回电子表格 ID 和已清除的范围。
{
"dataFilters": [
{
"developerMetadataLookup": {
"metadataId": metadataId
}
}
]
}答案
{
"spreadsheetId": spreadsheetId,
"clearedRanges": [
"Sheet7!A7:Z7"
]
}元数据存储限制
您可以存储在电子表格中的元数据总量存在限额。此限额以字符数计算，由 2 个组成部分组成：
| 项 | 存储空间上限分配 |
|---|---|
| 电子表格 | 3 万个字符 |
| 电子表格中的每个工作表 | 3 万个字符 |
您最多可以为电子表格存储 30,000 个字符。此外，您还可以为电子表格中的每个工作表存储 3 万个字符（第一个工作表 3 万个字符，第二个工作表 3 万个字符，依此类推）。因此，具有 3 个页面的电子表格最多可以包含 120,000 个字符的开发者元数据。
developerMetadata 对象的键和值属性中的每个字符都会计入此限制。