Class DeveloperMetadata

DeveloperMetadata

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étodoTipo de retornoBreve descrição
getId()IntegerRetorna o ID exclusivo associado aos metadados desse desenvolvedor.
getKey()StringRetorna a chave associada aos metadados desse desenvolvedor.
getLocation()DeveloperMetadataLocationRetorna o local desses metadados do desenvolvedor.
getValue()StringRetorna o valor associado aos metadados do desenvolvedor ou null caso esses metadados não tenham valor.
getVisibility()DeveloperMetadataVisibilityRetorna a visibilidade dos metadados desse desenvolvedor.
moveToColumn(column)DeveloperMetadataMove os metadados do desenvolvedor para a coluna especificada.
moveToRow(row)DeveloperMetadataMove os metadados do desenvolvedor para a linha especificada.
moveToSheet(sheet)DeveloperMetadataMove os metadados do desenvolvedor para a página especificada.
moveToSpreadsheet()DeveloperMetadataMove os metadados do desenvolvedor para a planilha de nível superior.
remove()voidExclui esses metadados.
setKey(key)DeveloperMetadataDefine a chave dos metadados deste desenvolvedor para o valor especificado.
setValue(value)DeveloperMetadataDefine o valor associado aos metadados deste desenvolvedor como o valor especificado.
setVisibility(visibility)DeveloperMetadataDefine 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

NomeTipoDescrição
columnRangeO 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

NomeTipoDescrição
rowRangeO 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

NomeTipoDescrição
sheetSheetA 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

NomeTipoDescrição
keyStringA 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

NomeTipoDescrição
valueStringO 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

NomeTipoDescrição
visibilityDeveloperMetadataVisibilityA 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