Com o recurso de metadados do desenvolvedor, você pode associar metadados a várias entidades e locais em uma planilha. Em seguida, você pode consultar esses metadados e usá-los para encontrar os objetos a que estão associados.
Você pode associar metadados a linhas, colunas, páginas ou planilhas.
Os metadados do desenvolvedor permitem executar operações como:
Associe dados arbitrários a várias entidades e locais em uma planilha. Por exemplo, associe
totalsà coluna D ouresponseId = 1234à linha 7.Encontrar todos os locais e dados associados a uma chave de metadados ou atributo específico: por exemplo, considerando a chave
totalsassociada à coluna D ou comresponseId, retorne todas as linhas com os metadadosresponseIde o valor de metadados associados a elas.Encontrar todos os dados associados a uma entidade ou um local específico: por exemplo, na coluna D, retornar todos os metadados associados a esse local.
Recuperar valores em um local especificando metadados associados: por exemplo, considerando que
totalsretorne uma representação dos valores contidos na coluna ou linha associada ou, em umsummary, retorne uma representação do recurso da planilha associado.Atualizar valores em um local especificando metadados associados: por exemplo, em vez de atualizar os valores em uma linha com a notação A1, atualize os valores indicando um ID de metadados.
Ler e gravar metadados
O recurso spreadsheets.developerMetadata fornece acesso aos metadados do desenvolvedor associados a um local ou objeto em uma planilha.
Sobre os metadados do desenvolvedor
Esta seção descreve alguns aspectos importantes dos metadados do desenvolvedor que você precisa considerar ao trabalhar com a API Sheets.
Metadados como tags
Um dos usos dos metadados do desenvolvedor é uma tag que nomeia um local na planilha usando apenas uma chave e um local. Por
exemplo, você pode associar headerRow a uma linha específica ou totals a
uma coluna específica de uma página. As tags podem ser usadas para vincular semanticamente partes de uma planilha a campos em uma ferramenta ou banco de dados de terceiros, para que as alterações na planilha não corrompam seu aplicativo.
Metadados como propriedades
Os metadados criados ao especificar uma chave, um local e um valor atua como um par de chave-valor associado a esse local em uma página. Por exemplo, você pode associar:
formResponseId = resp123com uma linhalastUpdated = 1477369882com uma coluna.
Com isso, você armazena e acessa propriedades nomeadas personalizadas associadas a áreas ou dados específicos em uma planilha.
Metadados visíveis do projeto x documento
Para evitar que um projeto de desenvolvedor interfira nos metadados de outro, há
duas configurações de visibility de metadados: project e document. Com a API Sheets, os metadados do projeto só ficam visíveis e acessíveis no projeto do desenvolvedor que os criou. Os metadados do documento podem ser acessados de qualquer projeto de desenvolvedor com
acesso ao documento.
As consultas que não especificam explicitamente uma visibilidade retornam metadados de documento correspondentes e metadados de projeto correspondentes ao projeto de desenvolvedor que fez a solicitação.
Exclusividade
As chaves de metadados não precisam ser exclusivas, mas o metadataId precisa ser
diferente. Se você criar metadados e não especificar o campo de ID, a API atribuirá um. Esse ID pode ser usado para identificar os
metadados, enquanto as chaves e outros atributos podem ser usados para identificar conjuntos de
metadados.
Criar metadados
Para criar metadados, use o método batchUpdate e forneça um createDeveloperMetadataRequest com metadataKey, location e visibility. Também é possível
especificar um metadataValue ou um metadataId explícito.
Se você especificar um ID que já está em uso, a solicitação não será bem-sucedida. Se você não fornecer um ID, a API atribuirá um.
Mostrar um exemplo
Neste exemplo, fornecemos uma chave, um valor e uma linha na solicitação. A resposta retorna esses valores de metadados do desenvolvedor, além do ID de metadados atribuído.
Solicitação
{
"requests": [
{
"createDeveloperMetadata": {
"developerMetadata": {
"location": {
"dimensionRange": {
"sheetId": sheetId,
"dimension": "ROWS",
"startIndex": 6,
"endIndex": 7
}
},
"visibility": "DOCUMENT",
"metadataKey": "Sales",
"metadataValue": "2022"
}
}
}
]
}
Resposta
{
"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"
}
}
}
]
}
Ler um único item de metadados
Para recuperar um único metadados de desenvolvedor, use o método
spreadsheets.developerMetadata.get,
especificando o spreadsheetId que contém os metadados e o metadataId exclusivo dos metadados do desenvolvedor.
Mostrar um exemplo
Solicitação
Neste exemplo, fornecemos o ID da planilha e o ID dos metadados na solicitação. A resposta retorna os valores de metadados do desenvolvedor para o ID de metadados.
GET https://sheets.googleapis.com/v4/spreadsheets/spreadsheetId/developerMetadata/metadataId
Resposta
{
"metadataId": metadataId,
"metadataKey": "Sales",
"metadataValue": "2022",
"location": {
"locationType": "ROW",
"dimensionRange": {
"sheetId": sheetId,
"dimension": "ROWS",
"startIndex": 6,
"endIndex": 7
}
},
"visibility": "DOCUMENT"
}
Ler vários itens de metadados
Para recuperar vários itens de metadados do desenvolvedor, use o
método
spreadsheets.developerMetadata.search. Você precisará especificar um DataFilter que corresponda aos metadados atuais em qualquer
combinação de propriedades, como chave, valor, local ou visibilidade.
Mostrar um exemplo
Neste exemplo, fornecemos vários IDs de metadados na solicitação. A resposta retorna os valores de metadados do desenvolvedor para cada ID de metadados.
Solicitação
{
"dataFilters": [
{
"developerMetadataLookup": {
"metadataId": metadataId
}
},
{
"developerMetadataLookup": {
"metadataId": metadataId
}
}
]
}
Resposta
{
"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
}
}
]
}
]
}
Atualizar metadados
Para atualizar os metadados do desenvolvedor, use o método
spreadsheets.batchUpdate
e forneça um
UpdateDeveloperMetadataRequest.
É necessário especificar um
DataFilter
que direcione os metadados a serem atualizados, um objeto
DeveloperMetadata
com os novos valores e uma máscara de campo
descrevendo os campos a serem atualizados.
Mostrar um exemplo
Neste exemplo, fornecemos os IDs de metadados, de planilha e uma nova chave de metadados na solicitação. A resposta retorna esses valores de metadados do desenvolvedor, além da chave de metadados atualizada.
Solicitação
{
"requests": [
{
"updateDeveloperMetadata": {
"dataFilters": [
{
"developerMetadataLookup": {
"metadataId": metadataId
}
}
],
"developerMetadata": {
"location": {
"sheetId": sheetId
},
"metadataKey": "SalesUpdated"
},
"fields": "location,metadataKey"
}
}
]
}
Resposta
{
"spreadsheetId": spreadsheetId,
"replies": [
{
"updateDeveloperMetadata": {
"developerMetadata": [
{
"metadataId": metadataId,
"metadataKey": "SalesUpdated",
"metadataValue": "2022",
"location": {
"locationType": "SHEET",
"sheetId": sheetId
},
"visibility": "DOCUMENT"
}
]
}
}
]
}
Excluir metadados
Para excluir metadados do desenvolvedor, use o método batchUpdate e forneça um DeleteDeveloperMetadataRequest.
É necessário especificar um DataFilter para selecionar os metadados que você quer
excluir.
Mostrar um exemplo
Neste exemplo, fornecemos o ID de metadados na solicitação. A resposta retorna os valores de metadados do desenvolvedor para o ID de metadados.
Para confirmar se os metadados do desenvolvedor foram removidos, use o método spreadsheets.developerMetadata.get, especificando o ID de metadados excluídos. Você vai receber uma resposta do código de status HTTP 404: Not Found com a seguinte mensagem: "Não há metadados de desenvolvedor com o ID metadataId.
Solicitação
{
"requests": [
{
"deleteDeveloperMetadata": {
"dataFilter": {
"developerMetadataLookup": {
"metadataId": metadataId
}
}
}
}
]
}
Resposta
{
"spreadsheetId": spreadsheetId,
"replies": [
{
"deleteDeveloperMetadata": {
"deletedDeveloperMetadata": [
{
"metadataId": metadataId,
"metadataKey": "SalesUpdated",
"metadataValue": "2022",
"location": {
"locationType": "SHEET",
"sheetId": sheetId
},
"visibility": "DOCUMENT"
}
]
}
}
]
}
Ler e gravar valores associados a metadados
Também é possível recuperar e atualizar valores de células em linhas e colunas especificando os metadados do desenvolvedor associados
e os valores que você quer atualizar. Para fazer isso, use o método apropriado abaixo com um
DataFilter correspondente.
Receber valores de células por metadados
Para receber valores de célula por metadados, use o método spreadsheets.values.batchGetByDataFilter. Você precisará especificar o ID da planilha e um ou mais filtros de dados que correspondam aos metadados.
Mostrar um exemplo
Neste exemplo, fornecemos o ID de metadados na solicitação. A resposta retorna os valores das células de linha (número do modelo, vendas mensais) para o ID de metadados.
Solicitação
{
"dataFilters": [
{
"developerMetadataLookup": {
"metadataId": metadataId
}
}
],
"majorDimension": "ROWS"
}
Resposta
{
"spreadsheetId": spreadsheetId,
"valueRanges": [
{
"valueRange": {
"range": "Sheet7!A7:Z7",
"majorDimension": "ROWS",
"values": [
[
"W-24",
"74"
]
]
},
"dataFilters": [
{
"developerMetadataLookup": {
"metadataId": metadataId
}
}
]
}
]
}
Acessar planilha por metadados
Ao recuperar uma planilha, retorne um subconjunto de dados com o método spreadsheets.getByDataFilter. Você precisará especificar o ID da planilha e um ou mais filtros de dados que correspondam aos metadados.
Essa solicitação funciona como uma solicitação "planilha GET" normal, mas a lista de metadados correspondido pelos filtros de dados especificados determina quais planilhas, dados de grade e outros recursos de objeto com metadados são retornados. Se
includeGridData for definido como verdadeiro, os dados de grade que cruzam os intervalos de grade especificados
também serão retornados para a planilha.
Mostrar um exemplo
Nesse exemplo, fornecemos o ID de metadados e definimos includeGridData como "false" na solicitação. A resposta retorna as propriedades da planilha e da planilha.
Solicitação
{
"dataFilters": [
{
"developerMetadataLookup": {
"metadataId": metadataId
}
}
],
"includeGridData": false
}
Resposta
{
"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
}
Atualizar valores por metadados
Para atualizar valores de células que correspondem a metadados específicos, use o método
spreadsheets.values.batchUpdateByDataFilter. É necessário especificar o ID da planilha, valueInputOption, e um ou mais DataFilterValueRange que correspondem aos metadados.
Mostrar um exemplo
Neste exemplo, fornecemos o ID de metadados e os valores de linha atualizados na solicitação. A resposta retorna as propriedades e os dados atualizados do ID de metadados.
Solicitação
{
"data": [
{
"dataFilter": {
"developerMetadataLookup": {
"metadataId": metadataId
}
},
"majorDimension": "ROWS",
"values": [
[
"W-24",
"84"
]
]
}
],
"includeValuesInResponse": true,
"valueInputOption": "USER_ENTERED"
}
Resposta
{
"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"
]
]
}
}
]
}
Limpar valores por metadados
Para limpar os valores de células que correspondem a metadados específicos, use o método spreadsheets.values.batchClearByDataFilter. É necessário especificar um filtro de dados para selecionar os metadados que você quer limpar.
Mostrar um exemplo
Solicitação
Neste exemplo, fornecemos o ID de metadados na solicitação. A resposta retorna o ID da planilha e os intervalos apagados.
{
"dataFilters": [
{
"developerMetadataLookup": {
"metadataId": metadataId
}
}
]
}
Resposta
{
"spreadsheetId": spreadsheetId,
"clearedRanges": [
"Sheet7!A7:Z7"
]
}
Limites de armazenamento de metadados
Há um limite na quantidade total de metadados que podem ser armazenados em uma planilha. Esse limite é medido em caracteres e é composto por dois componentes:
| Item | Alocação do limite de armazenamento |
|---|---|
| Planilha | 30.000 caracteres |
| Cada página de uma planilha | 30.000 caracteres |
Você pode armazenar até 30.000 caracteres na planilha. Além disso, você pode armazenar 30.000 caracteres para cada página de uma planilha (30.000 para a página um, 30.000 para a página 2 e assim por diante). Assim,uma planilha com três páginas pode conter até 120.000 caracteres de metadados de desenvolvedor.
Cada caractere nos atributos de chave e valor de um objeto developerMetadata
é contabilizado nesse limite.