REST Resource: spreadsheets.developerMetadata

Recurso: DeveloperMetadata

Metadados do desenvolvedor associados a um local ou objeto em uma planilha. Os metadados do desenvolvedor podem ser usados para associar dados arbitrários a várias partes de uma planilha e permanecem associados a esses locais à medida que se movem e a planilha é editada. Por exemplo, se os metadados do desenvolvedor estiverem associados à linha 5 e outra linha for inserida subsequentemente acima da linha 5, os metadados originais ainda estarão associados à linha à qual foram associados primeiro (que agora é a linha 6). Se o objeto associado for excluído, os metadados dele também serão excluídos.

Representação JSON 
{
  "metadataId": integer,
  "metadataKey": string,
  "metadataValue": string,
  "location": {
    object (DeveloperMetadataLocation)
  },
  "visibility": enum (DeveloperMetadataVisibility)
}
Campos
metadataId

integer

O ID exclusivo no escopo da planilha que identifica os metadados. Os IDs podem ser especificados quando os metadados são criados. Caso contrário, um será gerado e atribuído aleatoriamente. Precisa ser positivo.
metadataKey

string

A chave de metadados. Pode haver vários metadados em uma planilha com a mesma chave. Os metadados do desenvolvedor sempre precisam ter uma chave especificada.
metadataValue

string

Dados associados à chave de metadados.
location

object (DeveloperMetadataLocation)

O local onde os metadados estão associados.
visibility

enum (DeveloperMetadataVisibility)

A visibilidade dos metadados. Os metadados do desenvolvedor precisam sempre ter uma visibilidade especificada.

DeveloperMetadataLocation

Local em que os metadados podem ser associados em uma planilha.

Representação JSON 
{
  "locationType": enum (DeveloperMetadataLocationType),

  // Union field location can be only one of the following:
  "spreadsheet": boolean,
  "sheetId": integer,
  "dimensionRange": {
    object (DimensionRange)
  }
  // End of list of possible types for union field location.
}
Campos
locationType

enum (DeveloperMetadataLocationType)

O tipo de local que o objeto representa. Este campo é somente leitura.
Campo de união location. O local onde os metadados estão associados. location pode ser apenas de um dos tipos a seguir:
spreadsheet

boolean

Verdadeiro quando os metadados estão associados a uma planilha inteira.
sheetId

integer

O ID da planilha quando os metadados são associados a uma planilha inteira.
dimensionRange

object (DimensionRange)

Representa a linha ou coluna quando os metadados estão associados a uma dimensão. O DimensionRange especificado precisa representar uma única linha ou coluna. Ele não pode ser ilimitado ou abranger várias linhas ou colunas.

DeveloperMetadataLocationType

Uma enumeração dos tipos de locais em que os metadados do desenvolvedor podem ser associados.

Enums
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED Valor padrão.
ROW Metadados do desenvolvedor associados a uma dimensão de linha inteira.
COLUMN Metadados do desenvolvedor associados a uma dimensão de coluna inteira.
SHEET Metadados do desenvolvedor associados em uma planilha inteira.
SPREADSHEET Metadados do desenvolvedor associados em toda a planilha.

DeveloperMetadataVisibility

Uma enumeração de possíveis visibilidades de metadados.

Enums
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED Valor padrão.
DOCUMENT Os metadados visíveis no documento podem ser acessados em qualquer projeto de desenvolvedor com acesso ao documento.
PROJECT Os metadados visíveis no projeto só podem ser vistos e acessados pelo projeto de desenvolvedor que criou os metadados.

Métodos

get

 Retorna os metadados do desenvolvedor com o ID especificado.
Retorna todos os metadados do desenvolvedor que correspondem ao DataFilter especificado.