Class DeveloperMetadata

Metadadosdo desenvolvedor

Acessar e modificar metadados do desenvolvedor. Para criar novos metadados do 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 a esses metadados do desenvolvedor.
getKey()	String	Retorna a chave associada aos metadados do desenvolvedor.
getLocation()	DeveloperMetadataLocation	Retorna o local desses metadados do desenvolvedor.
getValue()	String	Retorna o valor associado a esses metadados do desenvolvedor ou null se esses metadados não tiverem nenhum valor.
getVisibility()	DeveloperMetadataVisibility	Retorna a visibilidade desses metadados do desenvolvedor.
moveToColumn(column)	DeveloperMetadata	Move esses metadados do desenvolvedor para a coluna especificada.
moveToRow(row)	DeveloperMetadata	Move esses metadados do desenvolvedor para a linha especificada.
moveToSheet(sheet)	DeveloperMetadata	Move esses metadados do desenvolvedor para a planilha especificada.
moveToSpreadsheet()	DeveloperMetadata	Move esses metadados do desenvolvedor para a planilha de nível superior.
remove()	void	Exclui esses metadados.
setKey(key)	DeveloperMetadata	Define a chave desses metadados do desenvolvedor como o valor especificado.
setValue(value)	DeveloperMetadata	Define o valor associado a esses metadados do desenvolvedor como o valor especificado.
setVisibility(visibility)	DeveloperMetadata	Define a visibilidade desses metadados do desenvolvedor para a visibilidade especificada.

Documentação detalhada

getId()

Retorna o ID exclusivo associado a esses metadados do desenvolvedor.

Retornar

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 do desenvolvedor.

Retornar

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.

Retornar

DeveloperMetadataLocation: o local desses 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

---

getValue()

Retorna o valor associado a esses metadados do desenvolvedor ou null se esses metadados não tiverem nenhum valor.

Retornar

String: o valor associado a esses 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 desses metadados do desenvolvedor.

Retornar

DeveloperMetadataVisibility: a visibilidade desses 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 esses metadados do desenvolvedor para a coluna especificada. Se o intervalo especificado não representar uma única coluna, isso vai gerar uma exceção.

Parâmetros

Nome	Tipo	Descrição
column	Range	O intervalo que representa a coluna que é o novo local para esses metadados.

Retornar

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 esses metadados do desenvolvedor para a linha especificada. Se o intervalo especificado não representar uma única linha, isso gerará uma exceção.

Parâmetros

Nome	Tipo	Descrição
row	Range	O intervalo que representa a linha que é o novo local desses metadados.

Retornar

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 esses metadados do desenvolvedor para a planilha especificada.

Parâmetros

Nome	Tipo	Descrição
sheet	Sheet	A página que é o novo local para os metadados do desenvolvedor.

Retornar

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 esses metadados do desenvolvedor para a planilha de nível superior.

Retornar

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 desses metadados do desenvolvedor como o valor especificado.

Parâmetros

Nome	Tipo	Descrição
key	String	A nova chave a ser definida para esses metadados.

Retornar

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 a esses metadados do desenvolvedor como o valor especificado.

Parâmetros

Nome	Tipo	Descrição
value	String	O novo valor a ser definido para esses metadados.

Retornar

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 desses metadados do desenvolvedor para a visibilidade especificada.

Parâmetros

Nome	Tipo	Descrição
visibility	DeveloperMetadataVisibility	A nova visibilidade a ser definida para esses metadados.

Retornar

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