Recurso: DeveloperMetadata
Os 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. Eles permanecerão associados nesses locais à medida que forem migrados e a planilha for editada. Por exemplo, se os metadados do desenvolvedor estiverem associados à linha 5 e outra linha for inserida logo acima da linha 5, os metadados originais ainda serão associados à linha a que ela estava associada pela primeira vez (o 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 ( |
Campos | |
---|---|
metadataId |
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 |
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 |
Dados associados à chave de metadados. |
location |
O local a que os metadados estão associados. |
visibility |
A visibilidade dos metadados. Os metadados do desenvolvedor precisam sempre ter uma visibilidade especificada. |
Localização de metadados do desenvolvedor
Um local onde os metadados podem ser associados em uma planilha.
Representação JSON |
---|
{ "locationType": enum ( |
Campos | |
---|---|
locationType |
O tipo de local que este 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 |
Verdadeiro quando os metadados estão associados a uma planilha inteira. |
sheetId |
O ID da página quando os metadados estão associados a uma página inteira. |
dimensionRange |
Representa a linha ou coluna quando os metadados estão associados a uma dimensão. O |
Tipo de local dos metadados do desenvolvedor
Uma enumeração dos tipos de local a que os metadados do desenvolvedor podem ser associados.
Enums | |
---|---|
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED |
Valor padrão. |
ROW |
Os metadados do desenvolvedor associados a uma dimensão de linha inteira. |
COLUMN |
Os metadados do desenvolvedor associados a uma dimensão de coluna inteira. |
SHEET |
Os metadados do desenvolvedor associados a uma página inteira. |
SPREADSHEET |
Os metadados do desenvolvedor associados a toda a planilha. |
Metadados de desenvolvedor
Uma enumeração das possíveis visibilidades de metadados.
Enums | |
---|---|
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED |
Valor padrão. |
DOCUMENT |
Os metadados visíveis podem ser acessados de qualquer projeto de desenvolvedor que tenha acesso ao documento. |
PROJECT |
Os metadados visíveis para o projeto só ficam visíveis e podem ser acessados pelo projeto do desenvolvedor que criou os metadados. |
Métodos |
|
---|---|
|
Retorna os metadados do desenvolvedor com o ID especificado. |
|
Retorna todos os metadados do desenvolvedor que correspondem ao DataFilter especificado. |