REST Resource: spreadsheets.developerMetadata

리소스: DeveloperMetadata

스프레드시트의 위치 또는 객체와 연결된 개발자 메타데이터입니다. 개발자 메타데이터는 임의의 데이터를 스프레드시트의 다양한 부분과 연결하는 데 사용할 수 있으며, 데이터가 이동하고 스프레드시트가 수정될 때도 해당 위치에서 연결된 상태로 유지됩니다. 예를 들어 개발자 메타데이터가 행 5와 연결되고 나중에 다른 행이 5행 위에 삽입되는 경우 원래 메타데이터는 여전히 처음 연결된 행 (현재 행 6)과 연결됩니다. 연결된 객체가 삭제되면 객체의 메타데이터도 삭제됩니다.

JSON 표현 
{
  "metadataId": integer,
  "metadataKey": string,
  "metadataValue": string,
  "location": {
    object (DeveloperMetadataLocation)
  },
  "visibility": enum (DeveloperMetadataVisibility)
}
입력란
metadataId

integer

메타데이터를 식별하는 스프레드시트 범위의 고유 ID입니다. 메타데이터를 만들 때 ID를 지정할 수 있으며, 지정하지 않으면 무작위로 생성되어 할당됩니다. 양수여야 합니다.
metadataKey

string

메타데이터 키입니다. 하나의 스프레드시트에 동일한 키를 가진 여러 메타데이터가 있을 수 있습니다. 개발자 메타데이터에는 항상 키가 지정되어 있어야 합니다.
metadataValue

string

메타데이터의 키와 연결된 데이터입니다.
location

object (DeveloperMetadataLocation)

메타데이터가 연결된 위치입니다.
visibility

enum (DeveloperMetadataVisibility)

메타데이터 공개 상태 개발자 메타데이터에는 항상 공개 상태가 지정되어 있어야 합니다.

DeveloperMetadataLocation

스프레드시트에서 메타데이터가 연결될 수 있는 위치입니다.

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.
}
입력란
locationType

enum (DeveloperMetadataLocationType)

이 객체가 나타내는 위치 유형입니다. 이 필드는 읽기 전용입니다.
통합 필드 location. 메타데이터가 연결된 위치입니다. location은 다음 중 하나여야 합니다.
spreadsheet

boolean

메타데이터가 전체 스프레드시트와 연결된 경우 true입니다.
sheetId

integer

메타데이터가 전체 시트와 연결된 경우 시트의 ID입니다.
dimensionRange

object (DimensionRange)

메타데이터가 측정기준과 연결된 경우 행 또는 열을 나타냅니다. 지정된 DimensionRange은(는) 단일 행 또는 열을 나타내야 합니다. 제한되지 않거나 여러 행 또는 열에 걸쳐 확장될 수 없습니다.

DeveloperMetadataLocationType

개발자 메타데이터가 연결될 수 있는 위치 유형의 열거형입니다.

열거형
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED 기본값
ROW 전체 행 측정기준에 연결된 개발자 메타데이터입니다.
COLUMN 전체 열 측정기준에 연결된 개발자 메타데이터입니다.
SHEET 전체 시트에 연결된 개발자 메타데이터입니다.
SPREADSHEET 전체 스프레드시트에 연결된 개발자 메타데이터입니다.

DeveloperMetadataVisibility

가능한 메타데이터 가시성의 열거형입니다.

열거형
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED 기본값
DOCUMENT 문서에 표시되는 메타데이터는 문서에 액세스할 수 있는 모든 개발자 프로젝트에서 액세스할 수 있습니다.
PROJECT 프로젝트에 표시되는 메타데이터는 메타데이터를 생성한 개발자 프로젝트에서만 보고 액세스할 수 있습니다.

메서드

get

 지정된 ID의 개발자 메타데이터를 반환합니다.
지정된 DataFilter와 일치하는 모든 개발자 메타데이터를 반환합니다.