Method: labels.delta

일련의 업데이트 요청을 적용하여 새로운 초안 버전을 생성함으로써 단일 라벨을 업데이트합니다. 일괄 업데이트가 모두 또는 전혀 없음: 업데이트 요청 중 하나라도 유효하지 않으면 변경사항이 적용되지 않습니다. 그 결과로 생성된 초안 버전이 게시되어야 변경사항을 Drive 항목에 사용할 수 있습니다.

HTTP 요청

POST https://drivelabels.googleapis.com/v2/{name=labels/*}:delta

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
name

string

필수 항목입니다. 업데이트할 라벨의 리소스 이름입니다.

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "writeControl": {
    object (WriteControl)
  },
  "requests": [
    {
      object (Request)
    }
  ],
  "useAdminAccess": boolean,
  "view": enum (LabelView),
  "languageCode": string
}
필드
writeControl

object (WriteControl)

쓰기 요청 실행 방법을 제어할 수 있습니다.
requests[]

object (Request)

라벨에 적용할 업데이트 목록입니다. 요청은 지정된 순서대로 적용됩니다.
useAdminAccess

boolean

사용자의 관리자 사용자 인증 정보를 사용하려면 true로 설정하세요. 서버에서 액세스를 허용하기 전에 사용자가 라벨의 관리자인지 확인합니다.
view

enum (LabelView)

지정하면 표시된 뷰에 속한 특정 필드만 반환됩니다.
languageCode

string

include_label_in_response가 true일 때 현지화된 필드 라벨을 평가하는 데 사용할 BCP-47 언어 코드입니다.

응답 본문

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

라벨 업데이트에 대한 응답입니다.

JSON 표현 
{
  "responses": [
    {
      object (Response)
    }
  ],
  "updatedLabel": {
    object (Label)
  }
}
필드
responses[]

object (Response)

업데이트의 답장입니다. 이렇게 하면 업데이트와 1:1로 매핑되지만 일부 요청에 대한 응답은 비어 있을 수 있습니다.
updatedLabel

object (Label)

업데이트가 적용된 후의 라벨입니다. [BatchUpdateLabelResponse2.include_label_in_response] 가 true이고 오류가 없는 경우에만 설정됩니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/drive.labels
  • https://www.googleapis.com/auth/drive.admin.labels

자세한 내용은 승인 가이드를 참조하세요.

요청

라벨에 적용할 단일 유형의 업데이트입니다.

JSON 표현 
{

  // Union field kind can be only one of the following:
  "updateLabel": {
    object (UpdateLabelPropertiesRequest)
  },
  "createField": {
    object (CreateFieldRequest)
  },
  "updateField": {
    object (UpdateFieldPropertiesRequest)
  },
  "updateFieldType": {
    object (UpdateFieldTypeRequest)
  },
  "enableField": {
    object (EnableFieldRequest)
  },
  "disableField": {
    object (DisableFieldRequest)
  },
  "deleteField": {
    object (DeleteFieldRequest)
  },
  "createSelectionChoice": {
    object (CreateSelectionChoiceRequest)
  },
  "updateSelectionChoiceProperties": {
    object (UpdateSelectionChoicePropertiesRequest)
  },
  "enableSelectionChoice": {
    object (EnableSelectionChoiceRequest)
  },
  "disableSelectionChoice": {
    object (DisableSelectionChoiceRequest)
  },
  "deleteSelectionChoice": {
    object (DeleteSelectionChoiceRequest)
  }
  // End of list of possible types for union field kind.
}
필드
통합 필드 kind. 업데이트의 종류입니다. 정확히 1개의 필드가 필요합니다. kind은 다음 중 하나여야 합니다.
updateLabel

object (UpdateLabelPropertiesRequest)

라벨 속성을 업데이트합니다.
createField

object (CreateFieldRequest)

새 필드를 만듭니다.
updateField

object (UpdateFieldPropertiesRequest)

필드의 기본 속성을 업데이트합니다.
updateFieldType

object (UpdateFieldTypeRequest)

필드 유형 또는 유형 옵션을 업데이트합니다.
enableField

object (EnableFieldRequest)

필드를 사용 설정합니다.
disableField

object (DisableFieldRequest)

필드를 사용 중지합니다.
deleteField

object (DeleteFieldRequest)

라벨에서 필드를 삭제합니다.
createSelectionChoice

object (CreateSelectionChoiceRequest)

Selection 필드 내에 Choice를 생성합니다.
updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesRequest)

선택 필드 내에서 선택 속성을 업데이트합니다.
enableSelectionChoice

object (EnableSelectionChoiceRequest)

선택 필드 내에서 선택을 사용 설정합니다.
disableSelectionChoice

object (DisableSelectionChoiceRequest)

선택 입력란에서 선택을 사용 중지합니다.
deleteSelectionChoice

object (DeleteSelectionChoiceRequest)

선택 필드 내에서 선택을 삭제합니다.

UpdateLabelPropertiesRequest

라벨의 기본 속성을 업데이트합니다.

JSON 표현 
{
  "updateMask": string,
  "properties": {
    object (Properties)
  }
}
필드
updateMask

string (FieldMask format)

업데이트해야 하는 필드입니다. 하나 이상의 필드를 지정해야 합니다. 루트 label_properties은(는) 암시되며 지정해서는 안 됩니다. 단일 *를 모든 필드를 업데이트하는 약식 기호로 사용할 수 있습니다.
properties

object (Properties)

필수 항목입니다. 업데이트할 라벨 속성입니다.

CreateFieldRequest

라벨 내에 필드 만들기 요청입니다.

JSON 표현 
{
  "field": {
    object (Field)
  }
}
필드
field

object (Field)

필수 항목입니다. 만들 필드입니다.

UpdateFieldPropertiesRequest

필드 속성 업데이트 요청입니다.

JSON 표현 
{
  "updateMask": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
필드
updateMask

string (FieldMask format)

업데이트해야 하는 필드입니다. 하나 이상의 필드를 지정해야 합니다. 루트 properties은(는) 암시되며 지정해서는 안 됩니다. 단일 *를 모든 필드를 업데이트하는 약식 기호로 사용할 수 있습니다.
id

string

필수 항목입니다. 업데이트할 필드입니다.
properties

object (Properties)

필수 항목입니다. 기본 필드 속성

UpdateFieldTypeRequest

필드 유형 변경 요청입니다.

JSON 표현 
{
  "updateMask": string,
  "id": string,

  // Union field type_options can be only one of the following:
  "textOptions": {
    object (TextOptions)
  },
  "longTextOptions": {
    object (LongTextOptions)
  },
  "integerOptions": {
    object (IntegerOptions)
  },
  "dateOptions": {
    object (DateOptions)
  },
  "selectionOptions": {
    object (SelectionOptions)
  },
  "userOptions": {
    object (UserOptions)
  }
  // End of list of possible types for union field type_options.
}
필드
updateMask

string (FieldMask format)

업데이트해야 하는 필드입니다. 하나 이상의 필드를 지정해야 합니다. type_options의 루트는 암시되며 지정해서는 안 됩니다. 단일 *를 모든 필드를 업데이트하는 약식 기호로 사용할 수 있습니다.
id

string

필수 항목입니다. 업데이트할 필드입니다.

통합 필드 type_options.

type_options는 다음 중 하나여야 합니다.
textOptions

object (TextOptions)

필드를 텍스트로 업데이트합니다.
longTextOptions

object (LongTextOptions)

필드를 긴 텍스트로 업데이트합니다.
integerOptions

object (IntegerOptions)

필드를 정수로 업데이트합니다.
dateOptions

object (DateOptions)

필드를 날짜로 업데이트합니다.
selectionOptions

object (SelectionOptions)

필드를 선택 항목으로 업데이트합니다.
userOptions

object (UserOptions)

필드를 사용자로 업데이트합니다.

LongTextOptions

Long Text 필드 유형의 옵션을 선택합니다.

JSON 표현 
{
  "minLength": integer,
  "maxLength": integer
}
필드
minLength

integer

출력 전용입니다. 텍스트 필드 값의 최소 유효 길이입니다.
maxLength

integer

출력 전용입니다. 텍스트 필드 값의 최대 유효 길이입니다.

EnableFieldRequest

필드 사용 설정 요청입니다.

JSON 표현 
{
  "id": string
}
필드
id

string

필수 항목입니다. 사용 설정할 필드의 ID입니다.

DisableFieldRequest

필드 사용 중지 요청입니다.

JSON 표현 
{
  "updateMask": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
필드
updateMask

string (FieldMask format)

업데이트해야 하는 필드입니다. 하나 이상의 필드를 지정해야 합니다. 루트 disabledPolicy은(는) 암시되며 지정해서는 안 됩니다. 단일 *를 모든 필드를 업데이트하는 약식 기호로 사용할 수 있습니다.
id

string

필수 항목입니다. 사용 중지할 필드의 키입니다.
disabledPolicy

object (DisabledPolicy)

필수 항목입니다. 필드 사용 중지 정책

DeleteFieldRequest

필드 삭제 요청입니다.

JSON 표현 
{
  "id": string
}
필드
id

string

필수 항목입니다. 삭제할 필드의 ID입니다.

CreateSelectionChoiceRequest

선택 옵션 생성 요청입니다.

JSON 표현 
{
  "fieldId": string,
  "choice": {
    object (Choice)
  }
}
필드
fieldId

string

필수 항목입니다. Choice를 만들 선택 필드입니다.
choice

object (Choice)

필수 항목입니다. 창작의 선택

UpdateSelectionChoicePropertiesRequest

선택 속성 업데이트 요청입니다.

JSON 표현 
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
필드
updateMask

string (FieldMask format)

업데이트해야 하는 필드입니다. 하나 이상의 필드를 지정해야 합니다. 루트 properties은(는) 암시되며 지정해서는 안 됩니다. 단일 *를 모든 필드를 업데이트하는 약식 기호로 사용할 수 있습니다.
fieldId

string

필수 항목입니다. 업데이트할 선택 필드입니다.
id

string

필수 항목입니다. 업데이트할 선택입니다.
properties

object (Properties)

필수 항목입니다. 업데이트할 선택 속성입니다.

EnableSelectionChoiceRequest

선택 사용 설정 요청입니다.

JSON 표현 
{
  "fieldId": string,
  "id": string
}
필드
fieldId

string

필수 항목입니다. 선택을 사용 설정하는 선택 필드입니다.
id

string

필수 항목입니다. 사용 설정 선택

DisableSelectionChoiceRequest

선택 사용 중지 요청입니다.

JSON 표현 
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
필드
updateMask

string (FieldMask format)

업데이트해야 하는 필드입니다. 하나 이상의 필드를 지정해야 합니다. 루트 disabledPolicy은(는) 암시되며 지정해서는 안 됩니다. 단일 *를 모든 필드를 업데이트하는 약식 기호로 사용할 수 있습니다.
fieldId

string

필수 항목입니다. 선택을 사용 중지할 선택 필드입니다.
id

string

필수 항목입니다. 사용 중지를 선택합니다.
disabledPolicy

object (DisabledPolicy)

필수 항목입니다. 업데이트할 사용 중지된 정책입니다.

DeleteSelectionChoiceRequest

선택 삭제 요청입니다.

JSON 표현 
{
  "fieldId": string,
  "id": string
}
필드
fieldId

string

필수 항목입니다. 선택사항이 삭제되는 선택 필드입니다.
id

string

필수 항목입니다. 삭제를 선택합니다.

응답

업데이트의 단일 응답입니다.

JSON 표현 
{

  // Union field response can be only one of the following:
  "updateLabel": {
    object (UpdateLabelPropertiesResponse)
  },
  "createField": {
    object (CreateFieldResponse)
  },
  "updateField": {
    object (UpdateFieldPropertiesResponse)
  },
  "updateFieldType": {
    object (UpdateFieldTypeResponse)
  },
  "enableField": {
    object (EnableFieldResponse)
  },
  "disableField": {
    object (DisableFieldResponse)
  },
  "deleteField": {
    object (DeleteFieldResponse)
  },
  "createSelectionChoice": {
    object (CreateSelectionChoiceResponse)
  },
  "updateSelectionChoiceProperties": {
    object (UpdateSelectionChoicePropertiesResponse)
  },
  "enableSelectionChoice": {
    object (EnableSelectionChoiceResponse)
  },
  "disableSelectionChoice": {
    object (DisableSelectionChoiceResponse)
  },
  "deleteSelectionChoice": {
    object (DeleteSelectionChoiceResponse)
  }
  // End of list of possible types for union field response.
}
필드
통합 필드 response. 해당 요청에 대한 응답입니다. response은 다음 중 하나여야 합니다.
updateLabel

object (UpdateLabelPropertiesResponse)

라벨의 기본 속성이 업데이트되었습니다.
createField

object (CreateFieldResponse)

새 필드를 만듭니다.
updateField

object (UpdateFieldPropertiesResponse)

필드의 기본 속성을 업데이트합니다.
updateFieldType

object (UpdateFieldTypeResponse)

필드 유형 또는 유형 옵션을 업데이트합니다.
enableField

object (EnableFieldResponse)

필드를 사용 설정합니다.
disableField

object (DisableFieldResponse)

필드를 사용 중지합니다.
deleteField

object (DeleteFieldResponse)

라벨에서 필드를 삭제합니다.
createSelectionChoice

object (CreateSelectionChoiceResponse)

선택 필드에 추가할 새로운 선택 목록 옵션을 만듭니다.
updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesResponse)

선택 필드 내에서 Choice를 업데이트합니다.
enableSelectionChoice

object (EnableSelectionChoiceResponse)

선택 필드 내에서 Choice를 사용 설정합니다.
disableSelectionChoice

object (DisableSelectionChoiceResponse)

선택 필드 내에서 선택을 사용 중지합니다.
deleteSelectionChoice

object (DeleteSelectionChoiceResponse)

선택 필드에서 Choice를 삭제합니다.

UpdateLabelPropertiesResponse

라벨 속성 업데이트 후의 응답입니다.

CreateFieldResponse

필드 생성 후 응답입니다.

JSON 표현 
{
  "id": string,
  "priority": integer
}
필드
id

string

생성된 필드의 필드입니다. 만들기 요청에서 키를 비워두면 키가 자동으로 생성되며 여기에서 확인할 수 있습니다.
priority

integer

생성된 필드의 우선순위입니다. 우선순위는 필드 (1~n) 사이에 연속된 우선순위를 보장하기 위해 지정된 우선순위에서 변경될 수 있습니다.

UpdateFieldPropertiesResponse

필드 속성 업데이트 후의 응답입니다.

JSON 표현 
{
  "priority": integer
}
필드
priority

integer

업데이트된 필드의 우선순위입니다. 우선순위는 필드 (1~n) 사이에 연속된 우선순위를 보장하기 위해 지정된 우선순위에서 변경될 수 있습니다.

UpdateFieldTypeResponse

필드 유형 업데이트 후의 응답입니다.

EnableFieldResponse

다음 필드 활성화에 대한 응답입니다.

DisableFieldResponse

다음 필드가 사용 중지되었습니다.

DeleteFieldResponse

필드 삭제 이후 응답입니다.

CreateSelectionChoiceResponse

선택 선택 생성 후 표시되는 응답입니다.

JSON 표현 
{
  "fieldId": string,
  "id": string
}
필드
fieldId

string

서버에서 생성한 필드의 ID입니다.
id

string

필드 내에서 생성된 선택 항목의 서버 생성 ID

UpdateSelectionChoicePropertiesResponse

선택 선택 속성 업데이트 후의 응답

JSON 표현 
{
  "priority": integer
}
필드
priority

integer

업데이트된 선택 항목의 우선순위입니다. 선택 항목 (1-n) 사이에 연속된 우선순위를 보장하기 위해 우선순위는 지정된 우선순위에서 변경될 수 있습니다.

EnableSelectionChoiceResponse

선택 사용 설정 후 응답

DisableSelectionChoiceResponse

사용 중지 선택 후 응답

DeleteSelectionChoiceResponse

선택 삭제 후의 응답입니다.