Acessar e modificar os metadados do desenvolvedor. Para criar novos metadados de desenvolvedor, use Range.addDeveloperMetadata(key), Sheet.addDeveloperMetadata(key) ou Spreadsheet.addDeveloperMetadata(key).
Métodos
| Método | Tipo de retorno | Breve descrição |
|---|---|---|
getId() | Integer | Retorna o ID exclusivo associado aos metadados desse desenvolvedor. |
getKey() | String | Retorna a chave associada aos metadados desse desenvolvedor. |
getLocation() | DeveloperMetadataLocation | Retorna o local desses metadados do desenvolvedor. |
getValue() | String | Retorna o valor associado aos metadados do desenvolvedor ou null caso esses metadados não tenham valor. |
getVisibility() | DeveloperMetadataVisibility | Retorna a visibilidade dos metadados desse desenvolvedor. |
moveToColumn(column) | DeveloperMetadata | Move os metadados do desenvolvedor para a coluna especificada. |
moveToRow(row) | DeveloperMetadata | Move os metadados do desenvolvedor para a linha especificada. |
moveToSheet(sheet) | DeveloperMetadata | Move os metadados do desenvolvedor para a página especificada. |
moveToSpreadsheet() | DeveloperMetadata | Move os metadados do desenvolvedor para a planilha de nível superior. |
remove() | void | Exclui esses metadados. |
setKey(key) | DeveloperMetadata | Define a chave dos metadados deste desenvolvedor para o valor especificado. |
setValue(value) | DeveloperMetadata | Define o valor associado aos metadados deste desenvolvedor como o valor especificado. |
setVisibility(visibility) | DeveloperMetadata | Define a visibilidade dos metadados do desenvolvedor como a visibilidade especificada. |
Documentação detalhada
getId()
Retorna o ID exclusivo associado aos metadados desse desenvolvedor.
Retorno
Integer: o ID exclusivo associado aos metadados do desenvolvedor.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getKey()
Retorna a chave associada aos metadados desse desenvolvedor.
Retorno
String: a chave associada aos metadados do desenvolvedor.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getLocation()
Retorna o local desses metadados do desenvolvedor.
Retorno
DeveloperMetadataLocation: o local dos metadados deste desenvolvedor.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getValue()
Retorna o valor associado aos metadados do desenvolvedor ou null caso esses metadados não tenham valor.
Retorno
String: o valor associado aos metadados do desenvolvedor ou null se esses metadados não tiverem valor.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getVisibility()
Retorna a visibilidade dos metadados desse desenvolvedor.
Retorno
DeveloperMetadataVisibility: a visibilidade dos metadados do desenvolvedor.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
moveToColumn(column)
Move os metadados do desenvolvedor para a coluna especificada. Caso o intervalo especificado não representa uma única coluna, uma exceção é gerada.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
column | Range | O intervalo que representa a coluna que é o novo local dos metadados do desenvolvedor. |
Retorno
DeveloperMetadata: os metadados do desenvolvedor para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
moveToRow(row)
Move os metadados do desenvolvedor para a linha especificada. Se o intervalo especificado não representar uma única linha, uma exceção será gerada.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
row | Range | O intervalo que representa a linha que é o novo local dos metadados do desenvolvedor. |
Retorno
DeveloperMetadata: os metadados do desenvolvedor para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
moveToSheet(sheet)
Move os metadados do desenvolvedor para a página especificada.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
sheet | Sheet | A planilha que é o novo local para a metata do desenvolvedor. |
Retorno
DeveloperMetadata: os metadados do desenvolvedor para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
moveToSpreadsheet()
Move os metadados do desenvolvedor para a planilha de nível superior.
Retorno
DeveloperMetadata: os metadados do desenvolvedor para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
remove()
Exclui esses metadados.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setKey(key)
Define a chave dos metadados deste desenvolvedor para o valor especificado.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
key | String | A nova chave a ser definida para esses metadados. |
Retorno
DeveloperMetadata: os metadados do desenvolvedor para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setValue(value)
Define o valor associado aos metadados deste desenvolvedor como o valor especificado.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
value | String | O novo valor a ser definido para o metadado. |
Retorno
DeveloperMetadata: os metadados do desenvolvedor para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setVisibility(visibility)
Define a visibilidade dos metadados do desenvolvedor como a visibilidade especificada.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
visibility | DeveloperMetadataVisibility | A nova visibilidade a ser definida para esses metadados. |
Retorno
DeveloperMetadata: os metadados do desenvolvedor para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets