Requests

요청

문서에 적용할 단일 업데이트입니다.

JSON 표현
{

  // Union field request can be only one of the following:
  "replaceAllText": {
    object (ReplaceAllTextRequest)
  },
  "insertText": {
    object (InsertTextRequest)
  },
  "updateTextStyle": {
    object (UpdateTextStyleRequest)
  },
  "createParagraphBullets": {
    object (CreateParagraphBulletsRequest)
  },
  "deleteParagraphBullets": {
    object (DeleteParagraphBulletsRequest)
  },
  "createNamedRange": {
    object (CreateNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "updateParagraphStyle": {
    object (UpdateParagraphStyleRequest)
  },
  "deleteContentRange": {
    object (DeleteContentRangeRequest)
  },
  "insertInlineImage": {
    object (InsertInlineImageRequest)
  },
  "insertTable": {
    object (InsertTableRequest)
  },
  "insertTableRow": {
    object (InsertTableRowRequest)
  },
  "insertTableColumn": {
    object (InsertTableColumnRequest)
  },
  "deleteTableRow": {
    object (DeleteTableRowRequest)
  },
  "deleteTableColumn": {
    object (DeleteTableColumnRequest)
  },
  "insertPageBreak": {
    object (InsertPageBreakRequest)
  },
  "deletePositionedObject": {
    object (DeletePositionedObjectRequest)
  },
  "updateTableColumnProperties": {
    object (UpdateTableColumnPropertiesRequest)
  },
  "updateTableCellStyle": {
    object (UpdateTableCellStyleRequest)
  },
  "updateTableRowStyle": {
    object (UpdateTableRowStyleRequest)
  },
  "replaceImage": {
    object (ReplaceImageRequest)
  },
  "updateDocumentStyle": {
    object (UpdateDocumentStyleRequest)
  },
  "mergeTableCells": {
    object (MergeTableCellsRequest)
  },
  "unmergeTableCells": {
    object (UnmergeTableCellsRequest)
  },
  "createHeader": {
    object (CreateHeaderRequest)
  },
  "createFooter": {
    object (CreateFooterRequest)
  },
  "createFootnote": {
    object (CreateFootnoteRequest)
  },
  "replaceNamedRangeContent": {
    object (ReplaceNamedRangeContentRequest)
  },
  "updateSectionStyle": {
    object (UpdateSectionStyleRequest)
  },
  "insertSectionBreak": {
    object (InsertSectionBreakRequest)
  },
  "deleteHeader": {
    object (DeleteHeaderRequest)
  },
  "deleteFooter": {
    object (DeleteFooterRequest)
  },
  "pinTableHeaderRows": {
    object (PinTableHeaderRowsRequest)
  }
  // End of list of possible types for union field request.
}
필드
공용체 필드 request는 적용할 특정 요청입니다. 정확히 1개의 필드가 필요합니다. request는 다음 중 하나여야 합니다.
replaceAllText

object (ReplaceAllTextRequest)

지정된 텍스트의 모든 인스턴스를 바꿉니다.

insertText

object (InsertTextRequest)

지정된 위치에 텍스트를 삽입합니다.

updateTextStyle

object (UpdateTextStyleRequest)

지정된 범위에서 텍스트 스타일을 업데이트합니다.

createParagraphBullets

object (CreateParagraphBulletsRequest)

단락의 글머리기호를 만듭니다.

deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

단락에서 글머리기호를 삭제합니다.

createNamedRange

object (CreateNamedRangeRequest)

이름이 지정된 범위를 만듭니다.

deleteNamedRange

object (DeleteNamedRangeRequest)

이름이 지정된 범위를 삭제합니다.

updateParagraphStyle

object (UpdateParagraphStyleRequest)

지정된 범위에서 단락 스타일을 업데이트합니다.

deleteContentRange

object (DeleteContentRangeRequest)

문서에서 콘텐츠를 삭제합니다.

insertInlineImage

object (InsertInlineImageRequest)

지정된 위치에 인라인 이미지를 삽입합니다.

insertTable

object (InsertTableRequest)

지정된 위치에 테이블을 삽입합니다.

insertTableRow

object (InsertTableRowRequest)

빈 행을 테이블에 삽입합니다.

insertTableColumn

object (InsertTableColumnRequest)

빈 열을 테이블에 삽입합니다.

deleteTableRow

object (DeleteTableRowRequest)

테이블에서 행을 삭제합니다.

deleteTableColumn

object (DeleteTableColumnRequest)

테이블에서 열을 삭제합니다.

insertPageBreak

object (InsertPageBreakRequest)

지정된 위치에 페이지 나누기를 삽입합니다.

deletePositionedObject

object (DeletePositionedObjectRequest)

문서에서 배치된 객체를 삭제합니다.

updateTableColumnProperties

object (UpdateTableColumnPropertiesRequest)

테이블의 열 속성을 업데이트합니다.

updateTableCellStyle

object (UpdateTableCellStyleRequest)

표 셀의 스타일을 업데이트합니다.

updateTableRowStyle

object (UpdateTableRowStyleRequest)

테이블의 행 스타일을 업데이트합니다.

replaceImage

object (ReplaceImageRequest)

문서의 이미지를 대체합니다.

updateDocumentStyle

object (UpdateDocumentStyleRequest)

문서의 스타일을 업데이트합니다.

mergeTableCells

object (MergeTableCellsRequest)

테이블의 셀을 병합합니다.

unmergeTableCells

object (UnmergeTableCellsRequest)

표의 셀을 병합 취소합니다.

createHeader

object (CreateHeaderRequest)

헤더를 만듭니다.

createFootnote

object (CreateFootnoteRequest)

각주를 만듭니다.

replaceNamedRangeContent

object (ReplaceNamedRangeContentRequest)

이름이 지정된 범위의 콘텐츠를 바꿉니다.

updateSectionStyle

object (UpdateSectionStyleRequest)

지정된 범위의 섹션 스타일을 업데이트합니다.

insertSectionBreak

object (InsertSectionBreakRequest)

지정된 위치에 섹션 나누기를 삽입합니다.

deleteHeader

object (DeleteHeaderRequest)

문서에서 헤더를 삭제합니다.

pinTableHeaderRows

object (PinTableHeaderRowsRequest)

테이블의 고정된 헤더 행 수를 업데이트합니다.

모든 텍스트 요청 교체

기준과 일치하는 모든 텍스트 인스턴스를 replace text로 바꿉니다.

JSON 표현
{
  "replaceText": string,

  // Union field criteria can be only one of the following:
  "containsText": {
    object (SubstringMatchCriteria)
  }
  // End of list of possible types for union field criteria.
}
필드
replaceText

string

일치하는 텍스트를 대체할 텍스트입니다.

공용체 필드 criteria는 대체할 텍스트를 일치시키는 데 사용되는 기준입니다. criteria는 다음 중 하나여야 합니다.
containsText

object (SubstringMatchCriteria)

문서에서 이 하위 문자열과 일치하는 텍스트를 찾습니다.

하위 문자열 일치 기준

문서의 특정 텍스트 문자열과 일치하는 기준입니다.

JSON 표현
{
  "text": string,
  "matchCase": boolean
}
필드
text

string

문서에서 검색할 텍스트입니다.

matchCase

boolean

검색의 대소문자 사용 여부를 나타냅니다.

  • True : 대소문자를 구분하는 검색입니다.
  • False : 검색 시 대소문자를 구분하지 않습니다.

텍스트 삽입 요청

지정된 위치에 텍스트를 삽입합니다.

JSON 표현
{
  "text": string,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
필드
text

string

삽입할 텍스트입니다.

줄바꿈 문자를 삽입하면 해당 색인에 새 Paragraph가 암시적으로 생성됩니다. 목록 및 글머리기호를 비롯하여 현재 삽입 색인의 단락에서 새 단락의 단락 스타일이 복사됩니다.

삽입된 텍스트의 텍스트 스타일은 자동으로 결정되며 일반적으로 인접한 텍스트의 스타일은 유지합니다. 대부분의 경우 삽입된 텍스트의 텍스트 스타일이 삽입 색인 바로 앞 텍스트와 일치합니다.

유니코드 기본 다국어 영역 비공개 사용 영역 (U+E000-U+F8FF)의 일부 제어 문자 (U+0000-U+0008, U+000C-U+001F)와 삽입된 텍스트는 목록에서 제거됩니다.

공용체 필드 insertion_location는 텍스트를 삽입할 위치입니다. insertion_location는 다음 중 하나여야 합니다.
location

object (Location)

문서의 특정 색인에 텍스트를 삽입합니다.

기존 Paragraph의 경계 내에 텍스트를 삽입해야 합니다. 예를 들어 테이블의 시작 색인 (즉, 테이블과 이전 단락 사이에)을 삽입할 수 없습니다. 텍스트는 이전 단락에 삽입되어야 합니다.

endOfSegmentLocation

object (EndOfSegmentLocation)

머리글, 바닥글, 각주 또는 문서 본문의 끝에 텍스트를 삽입합니다.

위치

문서의 특정 위치입니다.

JSON 표현
{
  "segmentId": string,
  "index": integer
}
필드
segmentId

string

위치가 포함된 머리글, 바닥글 또는 각주의 ID입니다. 빈 세그먼트 ID는 문서의 본문을 나타냅니다.

index

integer

UTF-16 코드 단위의 0 기준 색인입니다.

색인은 segmentId로 지정된 세그먼트의 시작 부분을 기준으로 합니다.

세그먼트 끝 지점

본문, 머리글, 바닥글 또는 각주 끝에 있는 위치입니다. 위치는 문서 세그먼트의 마지막 줄바꿈 바로 앞에 있습니다.

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

string

위치가 포함된 머리글, 바닥글 또는 각주의 ID입니다. 빈 세그먼트 ID는 문서의 본문을 나타냅니다.

UpdateTextStyleRequest

텍스트 스타일을 업데이트합니다.

JSON 표현
{
  "textStyle": {
    object (TextStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}
필드
textStyle

object (TextStyle)

텍스트에 설정할 스타일입니다.

특정 스타일의 값이 상위 요소의 값과 일치하면 해당 스타일이 상속으로 설정됩니다.

특정 텍스트 스타일을 변경하면 Docs 편집기의 동작을 미러링하기 위해 다른 변경사항이 발생할 수 있습니다. 자세한 내용은 TextStyle 문서를 참조하세요.

fields

string (FieldMask format)

업데이트해야 하는 필드입니다.

하나 이상의 필드를 지정해야 합니다. 루트 textStyle는 암시적이므로 지정해서는 안 됩니다. 단일 "*"를 모든 필드를 나열하는 약식으로 사용할 수 있습니다.

예를 들어 텍스트 스타일을 굵게 표시하려면 fields"bold"로 설정합니다.

속성을 기본값으로 재설정하려면 필드 마스크에 필드 이름을 포함하지만 필드 자체는 설정하지 않은 상태로 둡니다.

공용체 필드 insertion_location는 텍스트 스타일이 업데이트되는 데 사용되는 범위의 유형입니다. insertion_location는 다음 중 하나여야 합니다.
range

object (Range)

스타일을 지정할 텍스트 범위입니다.

인접한 줄바꿈을 포함하도록 범위를 확장할 수 있습니다.

범위에 목록에 속한 단락이 완전히 포함된 경우 단락의 글머리기호도 일치하는 텍스트 스타일로 업데이트됩니다.

상대적 UpdateTextStyleRequest 내에는 범위를 삽입할 수 없습니다.

CreateParagraphBullet요청

지정된 범위와 겹치는 모든 단락에 글머리기호를 만듭니다.

각 단락 앞에 중첩된 탭을 집계하여 각 단락의 중첩 수준이 결정됩니다. 글머리기호 및 해당 단락 사이의 불필요한 공백이 발생하지 않도록 이 요청은 이 선행 탭을 삭제합니다. 이렇게 하면 텍스트 일부의 색인이 변경될 수 있습니다.

업데이트 중인 단락 바로 앞에 있는 단락이 일치하는 미리 설정이 있는 목록에 있으면 업데이트 중인 단락이 이전 목록에 추가됩니다.

JSON 표현
{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
필드
range

object (Range)

글머리기호 사전 설정을 적용할 범위입니다.

bulletPreset

enum (BulletGlyphPreset)

사용할 글머리기호 글리프의 종류입니다.

글머리기호 글리프 사전 설정

목록에 대한 글머리 기호 글리프의 미리 설정된 패턴

이러한 패턴은 다음과 같은 유형의 글머리 기호를 사용합니다.

  • ARROW: 유니코드 U+2794 코드 포인트에 해당하는 화살표
  • ARROW3D: 유니코드 U+27a2 코드 포인트에 해당하는 3D 음영이 있는 화살표
  • CHECKBOX: 유니코드 U+274f 코드 포인트에 해당하는 빈 정사각형입니다.
  • CIRCLE: 유니코드 U+25cb 코드 포인트에 해당하는 빈 원
  • DIAMOND : 유니코드 U+25c6 코드 포인트에 해당하는 다이아몬드입니다.
  • DIAMONDX: 유니코드 U+2756 코드 포인트에 해당하는 'x'가 있는 다이아몬드
  • HOLLOWDIAMOND: 유니코드 U+25c7 코드 포인트에 해당하는 빈 다이아몬드입니다.
  • DISC: 유니코드 U+25cf 코드 포인트에 해당하는 실선 원입니다.
  • SQUARE: 유니코드 U+25a0 코드 포인트에 해당하는 실선입니다.
  • STAR: 유니코드 U+2605 코드 포인트에 해당하는 별표
  • ALPHA: 'a', 'b', 'c'와 같은 소문자입니다.
  • UPPERALPHA: 'A', 'B', 'C'와 같은 대문자입니다.
  • DECIMAL : '1', '2', '3'과 같은 숫자입니다.
  • ZERODECIMAL: 한 자리 숫자가 0으로 시작하는 숫자(예: '01', '02', '03')입니다. 자릿수가 2자리 이상인 경우에는 앞에 0이 붙지 않습니다.
  • ROMAN : 'i', 'ii', 'iii'와 같은 소문자 로마 숫자.
  • UPPERROMAN: 'I', 'II', 'III'과 같이 로마자로 된 대문자입니다.
  • LEFTTRIANGLE: 유니코드 U+25c4 코드 포인트에 해당하는 왼쪽을 가리키는 삼각형
열거형
BULLET_GLYPH_PRESET_UNSPECIFIED 글머리기호 글리프 사전 설정이 지정되지 않았습니다.
BULLET_DISC_CIRCLE_SQUARE 처음 3개의 목록 중첩 수준을 위한 DISC, CIRCLE, SQUARE 글머리 기호 글리프가 있는 글머리기호 목록입니다.
BULLET_DIAMONDX_ARROW3D_SQUARE 처음 3개의 목록 중첩 수준을 위한 DIAMONDX, ARROW3D, SQUARE 글머리 기호 글리프가 있는 글머리기호 목록입니다.
BULLET_CHECKBOX 모든 목록 중첩 수준의 CHECKBOX 글머리 기호 글머리 기호가 포함된 글머리기호 목록입니다.
BULLET_ARROW_DIAMOND_DISC 처음 3개의 목록 중첩 수준을 위한 ARROW, DIAMOND, DISC 글머리 기호 글리프가 있는 글머리기호 목록입니다.
BULLET_STAR_CIRCLE_SQUARE 처음 3개의 목록 중첩 수준을 위한 STAR, CIRCLE, SQUARE 글머리 기호 글리프가 있는 글머리기호 목록입니다.
BULLET_ARROW3D_CIRCLE_SQUARE 처음 3개의 목록 중첩 수준을 위한 ARROW3D, CIRCLE, SQUARE 글머리 기호 글리프가 있는 글머리기호 목록입니다.
BULLET_LEFTTRIANGLE_DIAMOND_DISC 처음 3개의 목록 중첩 수준을 위한 LEFTTRIANGLE, DIAMOND, DISC 글머리 기호 글리프가 있는 글머리기호 목록입니다.
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE 처음 3개의 목록 중첩 수준을 위한 DIAMONDX, HOLLOWDIAMOND, SQUARE 글머리 기호 글리프가 있는 글머리기호 목록입니다.
BULLET_DIAMOND_CIRCLE_SQUARE 처음 3개의 목록 중첩 수준을 위한 DIAMOND, CIRCLE, SQUARE 글머리 기호 글리프가 있는 글머리기호 목록입니다.
NUMBERED_DECIMAL_ALPHA_ROMAN 처음 3개의 목록 중첩 수준과 그 뒤에 마침표가 오는 DECIMAL, ALPHA, ROMAN 숫자 글리프가 포함된 번호가 매겨진 목록
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS 처음 3개의 목록 중첩 수준에 대한 DECIMAL, ALPHAROMAN 숫자 글리프, 이어서 괄호가 있는 번호 매기기 목록
NUMBERED_DECIMAL_NESTED 마침표로 구분된 DECIMAL 숫자 글리프가 포함된 번호 매기기 목록. 여기서 각 중첩 수준은 이전 중첩 수준의 글리프를 접두어로 사용합니다. 예: '1.', '1.1.', '2.', '2.2.'
NUMBERED_UPPERALPHA_ALPHA_ROMAN 처음 3개의 목록 중첩 수준과 그 뒤에 마침표가 오는 UPPERALPHA, ALPHA, ROMAN 숫자 글리프가 포함된 번호가 매겨진 목록
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL 처음 3개의 목록 중첩 수준과 그 뒤에 마침표가 오는 UPPERROMAN, UPPERALPHA, DECIMAL 숫자 글리프가 포함된 번호가 매겨진 목록
NUMBERED_ZERODECIMAL_ALPHA_ROMAN 처음 3개의 목록 중첩 수준과 그 뒤에 마침표가 오는 ZERODECIMAL, ALPHA, ROMAN 숫자 글리프가 포함된 번호가 매겨진 목록

DeleteParagraphBullet요청

지정된 범위와 겹치는 모든 단락에서 글머리기호를 삭제합니다.

각 단락의 중첩 수준은 해당 단락의 시작 부분에 들여쓰기를 추가하여 시각적으로 유지됩니다.

JSON 표현
{
  "range": {
    object (Range)
  }
}
필드
range

object (Range)

글머리기호를 삭제할 범위입니다.

요청 이름 생성 범위 요청

지정된 범위를 참조하는 NamedRange를 만듭니다.

JSON 표현
{
  "name": string,
  "range": {
    object (Range)
  }
}
필드
name

string

NamedRange의 이름입니다. 이름은 고유하지 않아도 됩니다.

이름은 1자 이상, 256자(영문 기준) 이하여야 하며, UTF-16 코드 단위로 측정됩니다.

range

object (Range)

이름을 적용할 범위입니다.

삭제 요청 이름 범위

NamedRange를 삭제합니다.

JSON 표현
{

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "name": string
  // End of list of possible types for union field named_range_reference.
}
필드
공용체 필드 named_range_reference는 삭제할 범위를 결정하는 값입니다. 정확히 1개를 설정해야 합니다. named_range_reference는 다음 중 하나여야 합니다.
namedRangeId

string

삭제할 이름이 지정된 범위의 ID입니다.

name

string

삭제할 범위의 이름입니다. 지정된 이름의 이름이 지정된 모든 범위가 삭제됩니다.

UpdateParagraphStyleRequest 클래스의 생성자

지정된 범위와 겹치는 모든 단락의 스타일을 업데이트합니다.

JSON 표현
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}
필드
paragraphStyle

object (ParagraphStyle)

단락에 설정할 스타일입니다.

특정 단락 스타일을 변경하면 Docs 편집기의 동작을 반영하기 위해 다른 변경사항이 적용될 수 있습니다. 자세한 내용은 ParagraphStyle 문서를 참조하세요.

fields

string (FieldMask format)

업데이트해야 하는 필드입니다.

하나 이상의 필드를 지정해야 합니다. 루트 paragraphStyle는 암시적이므로 지정해서는 안 됩니다. 단일 "*"를 모든 필드를 나열하는 약식으로 사용할 수 있습니다.

예를 들어 단락 스타일의 정렬 속성을 업데이트하려면 fields"alignment"로 설정합니다.

속성을 기본값으로 재설정하려면 필드 마스크에 필드 이름을 포함하지만 필드 자체는 설정하지 않은 상태로 둡니다.

공용체 필드 insertion_location는 단락 스타일이 업데이트되는 데 사용되는 범위 유형입니다. insertion_location는 다음 중 하나여야 합니다.
range

object (Range)

스타일을 적용할 단락과 겹치는 범위입니다.

DeleteContentRangeRequest

문서에서 콘텐츠를 삭제합니다.

JSON 표현
{
  "range": {
    object (Range)
  }
}
필드
range

object (Range)

삭제할 콘텐츠의 범위입니다.

단락 경계를 가로지르는 텍스트를 삭제하면 두 단락이 병합되면서 단락 스타일, 목록, 배치된 객체 및 북마크가 변경될 수 있습니다.

특정 범위를 삭제하려고 하면 문서 구조가 잘못될 수 있으며, 이 경우 400 잘못된 요청 오류가 반환됩니다.

다음은 잘못된 삭제 요청의 몇 가지 예입니다.

인라인 이미지 요청 삽입

지정된 위치에 이미지가 포함된 InlineObject를 삽입합니다.

JSON 표현
{
  "uri": string,
  "objectSize": {
    object (Size)
  },

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
필드
uri

string

이미지 URI입니다.

삽입 시 이미지를 한 번 가져오고 문서 내에 표시하기 위해 사본이 저장됩니다. 이미지 크기는 50MB 미만이어야 하고, 25메가픽셀 이하여야 하며, PNG, JPEG, GIF 형식 중 하나여야 합니다.

제공된 URI는 공개적으로 액세스할 수 있어야 하며 길이는 최대 2KB여야 합니다. URI 자체는 이미지와 함께 저장되고 ImageProperties.content_uri 필드를 통해 노출됩니다.

objectSize

object (Size)

문서에 표시되는 이미지 크기입니다. 이 속성은 선택사항이며 문서에 있는 이미지의 최종 크기는 다음 규칙에 따라 결정됩니다. * 너비와 높이 모두 지정되지 않은 경우 이미지의 기본 크기는 해상도를 기준으로 계산됩니다. * 한 크기가 지정된 경우 다른 치수는 이미지의 가로세로 비율을 유지하도록 계산됩니다. * 너비와 높이를 모두 지정한 경우 이미지의 가로세로 비율은 유지하면서 제공된 크기에 맞게 크기가 조정됩니다.

공용체 필드 insertion_location는 이미지를 삽입할 위치입니다. insertion_location는 다음 중 하나여야 합니다.
location

object (Location)

문서의 특정 색인에 이미지를 삽입합니다.

이미지는 기존 Paragraph의 경계 내에 삽입되어야 합니다. 예를 들어 테이블의 시작 색인 (즉, 테이블과 이전 단락 사이)에는 삽입할 수 없습니다.

인라인 이미지는 각주 또는 방정식 내에 삽입할 수 없습니다.

endOfSegmentLocation

object (EndOfSegmentLocation)

머리글, 바닥글 또는 문서 본문 끝에 텍스트를 삽입합니다.

각주 안에 인라인 이미지를 삽입할 수 없습니다.

테이블 삽입 요청

지정된 위치에 테이블을 삽입합니다.

삽입된 테이블 앞에 줄바꿈 문자가 삽입됩니다.

JSON 표현
{
  "rows": integer,
  "columns": integer,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
필드
rows

integer

테이블의 행 수입니다.

columns

integer

테이블의 열 수입니다.

공용체 필드 insertion_location는 테이블이 삽입될 위치입니다. insertion_location는 다음 중 하나여야 합니다.
location

object (Location)

특정 모델 색인에 테이블을 삽입합니다.

삽입된 테이블 앞에 줄바꿈 문자가 삽입되므로 테이블 시작 색인은 지정된 위치 색인 + 1에 있습니다.

테이블은 기존 Paragraph의 경계 내에 삽입되어야 합니다. 예를 들어 테이블의 시작 색인 (즉, 기존 테이블과 이전 단락 사이에)을 삽입할 수 없습니다.

표는 각주 또는 방정식 내에 삽입할 수 없습니다.

endOfSegmentLocation

object (EndOfSegmentLocation)

지정된 머리글, 바닥글 또는 문서 본문의 끝에 표를 삽입합니다. 삽입된 테이블 앞에 줄바꿈 문자가 삽입됩니다.

각주 안에 표를 삽입할 수 없습니다.

테이블 행 요청 삽입

빈 행을 테이블에 삽입합니다.

JSON 표현
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}
필드
tableCellLocation

object (TableCellLocation)

행이 삽입되는 참조 테이블 셀 위치입니다.

참조 셀이 있는 행 위 또는 아래에 새 행이 삽입됩니다. 참조 셀이 병합된 셀인 경우 병합된 셀 위 또는 아래에 새로운 행이 삽입됩니다.

insertBelow

boolean

참조 셀 위치 아래에 새 행을 삽입할지 여부입니다.

  • True : 셀 아래에 삽입합니다.
  • False : 셀 위에 삽입합니다.

테이블 셀 위치

표 내의 단일 셀 위치

JSON 표현
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}
필드
tableStartLocation

object (Location)

문서에서 테이블이 시작되는 위치입니다.

rowIndex

integer

0부터 시작하는 행 색인입니다. 예를 들어 테이블의 두 번째 행의 행 색인은 1입니다.

columnIndex

integer

0부터 시작하는 열 색인입니다. 예를 들어 테이블의 두 번째 열에는 열 색인이 1입니다.

테이블 열 요청 삽입

빈 열을 테이블에 삽입합니다.

JSON 표현
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}
필드
tableCellLocation

object (TableCellLocation)

열이 삽입되는 참조 테이블 셀 위치입니다.

참조 셀이 있는 열의 왼쪽 (또는 오른쪽)에 새 열이 삽입됩니다. 참조 셀이 병합된 셀인 경우 병합된 셀의 왼쪽 (또는 오른쪽)에 새 열이 삽입됩니다.

insertRight

boolean

참조 셀 위치의 오른쪽에 새 열을 삽입할지 여부입니다.

  • True : 오른쪽에 삽입합니다.
  • False : 왼쪽에 삽입합니다.

테이블 행 요청 삭제

테이블에서 행을 삭제합니다.

JSON 표현
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
필드
tableCellLocation

object (TableCellLocation)

행이 삭제되는 참조 테이블 셀 위치입니다.

이 셀의 행이 삭제됩니다. 여러 행에 걸쳐 있는 병합된 셀인 경우 셀을 포함하는 모든 행이 삭제됩니다. 이 삭제 후에도 테이블에 남아 있는 행이 없으면 전체 테이블이 삭제됩니다.

DeleteTableColumnRequest

테이블에서 열을 삭제합니다.

JSON 표현
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
필드
tableCellLocation

object (TableCellLocation)

열을 삭제할 참조 테이블 셀 위치입니다.

이 셀 범위에 있는 열이 삭제됩니다. 여러 열에 걸쳐 있는 병합된 셀인 경우 셀을 포함하는 모든 열이 삭제됩니다. 이 삭제 후에도 테이블에 남아 있는 열이 없으면 전체 테이블이 삭제됩니다.

페이지 나누기 요청 삽입

지정된 위치에 페이지 나누기 뒤에 줄바꿈을 삽입합니다.

JSON 표현
{

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
필드
공용체 필드 insertion_location는 페이지 나누기가 삽입될 위치입니다. insertion_location는 다음 중 하나여야 합니다.
location

object (Location)

문서의 특정 색인에 페이지 나누기를 삽입합니다.

페이지 나누기는 기존 Paragraph의 경계 내에 삽입해야 합니다. 예를 들어 테이블의 시작 색인 (즉, 테이블과 이전 단락 사이)에는 삽입할 수 없습니다.

표, 등식, 각주, 머리글 또는 바닥글에는 페이지 나누기를 삽입할 수 없습니다. 페이지 나누기는 본문 내부에만 삽입할 수 있으므로 segment ID 필드는 비어 있어야 합니다.

endOfSegmentLocation

object (EndOfSegmentLocation)

문서 본문 끝에 페이지 나누기를 삽입합니다.

페이지 나누기는 각주, 머리글 또는 바닥글 내에 삽입할 수 없습니다. 페이지 나누기는 본문 내부에만 삽입할 수 있으므로 segment ID 필드는 비어 있어야 합니다.

DeletePositionedObjectRequest

문서에서 PositionedObject를 삭제합니다.

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

string

삭제할 배치된 객체의 ID입니다.

UpdateTableColumnPropertiesRequest

테이블에 있는 열의 TableColumnProperties를 업데이트합니다.

JSON 표현
{
  "tableStartLocation": {
    object (Location)
  },
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}
필드
tableStartLocation

object (Location)

문서에서 테이블이 시작되는 위치입니다.

columnIndices[]

integer

속성을 업데이트해야 하는 0부터 시작하는 열 색인의 목록 색인이 지정되지 않으면 모든 열이 업데이트됩니다.

tableColumnProperties

object (TableColumnProperties)

업데이트할 테이블 열 속성입니다.

tableColumnProperties#width 값이 5포인트 (5/72인치) 미만이면 400 잘못된 요청 오류가 반환됩니다.

fields

string (FieldMask format)

업데이트해야 하는 필드입니다.

하나 이상의 필드를 지정해야 합니다. 루트 tableColumnProperties는 암시적이므로 지정해서는 안 됩니다. 단일 "*"를 모든 필드를 나열하는 약식으로 사용할 수 있습니다.

예를 들어 열 너비를 업데이트하려면 fields"width"로 설정합니다.

UpdateTableCellStyleRequest 클래스의 생성자

표 셀 범위의 스타일을 업데이트합니다.

JSON 표현
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "fields": string,

  // Union field cells can be only one of the following:
  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
  // End of list of possible types for union field cells.
}
필드
tableCellStyle

object (TableCellStyle)

표 셀에 설정할 스타일입니다.

테두리를 업데이트할 때 셀이 인접한 셀과 테두리를 공유하면 인접한 셀의 해당 테두리 속성도 업데이트됩니다. 병합되어 표시되지 않는 테두리는 업데이트되지 않습니다.

동일한 요청에서 인접한 셀이 공유한 테두리를 업데이트하면 테두리 업데이트가 충돌할 수 있으므로 테두리 업데이트는 다음과 같은 순서로 적용됩니다.

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string (FieldMask format)

업데이트해야 하는 필드입니다.

하나 이상의 필드를 지정해야 합니다. 루트 tableCellStyle는 암시적이므로 지정해서는 안 됩니다. 단일 "*"를 모든 필드를 나열하는 약식으로 사용할 수 있습니다.

예를 들어 표 셀 배경 색상을 업데이트하려면 fields"backgroundColor"로 설정합니다.

속성을 기본값으로 재설정하려면 필드 마스크에 필드 이름을 포함하지만 필드 자체는 설정하지 않은 상태로 둡니다.

공용체 필드 cells는 업데이트할 셀입니다. cells는 다음 중 하나여야 합니다.
tableRange

object (TableRange)

업데이트가 적용되는 테이블의 하위 집합을 나타내는 테이블 범위입니다.

tableStartLocation

object (Location)

문서에서 테이블이 시작되는 위치입니다. 이 플래그를 지정하면 업데이트가 테이블의 모든 셀에 적용됩니다.

테이블 범위

테이블 범위는 테이블의 하위 집합에 대한 참조를 나타냅니다.

표 범위에 의해 지정된 셀이 반드시 직사각형인 것은 아닙니다. 예를 들어 마지막 행의 모든 셀이 함께 병합되는 3x3 테이블이 있다고 가정해 보겠습니다. 표는 다음과 같습니다.

 [   ][   ][   ]
 [   ][   ][   ]
 [             ]

테이블 셀 위치 = (tableStartLocation, row = 0, column = 0), row span = 3 및 column span = 2인 테이블 범위는 다음 셀을 지정합니다.

 [ x ][ x ][   ]
 [ x ][ x ][   ]
 [ x    x    x ]
JSON 표현
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}
필드
tableCellLocation

object (TableCellLocation)

표 범위가 시작되는 셀 위치입니다.

rowSpan

integer

테이블 범위의 행 범위입니다.

columnSpan

integer

테이블 범위의 열 스팬입니다.

표 행 스타일 요청

테이블에 있는 행의 TableRowStyle을 업데이트합니다.

JSON 표현
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}
필드
tableStartLocation

object (Location)

문서에서 테이블이 시작되는 위치입니다.

rowIndices[]

integer

스타일을 업데이트해야 하는 0부터 시작하는 행 색인의 목록. 인덱스를 지정하지 않으면 모든 행이 업데이트됩니다.

tableRowStyle

object (TableRowStyle)

행에 설정할 스타일입니다.

fields

string (FieldMask format)

업데이트해야 하는 필드입니다.

하나 이상의 필드를 지정해야 합니다. 루트 tableRowStyle는 암시적이므로 지정해서는 안 됩니다. 단일 "*"를 모든 필드를 나열하는 약식으로 사용할 수 있습니다.

예를 들어 최소 행 높이를 업데이트하려면 fields"minRowHeight"로 설정합니다.

이미지 교체 요청

기존 이미지를 새 이미지로 바꿉니다.

이미지를 바꾸면 Docs 편집기의 동작을 미러링하기 위해 기존 이미지에서 일부 image effects가 삭제됩니다.

JSON 표현
{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod)
}
필드
imageObjectId

string

대체할 기존 이미지의 ID입니다. ID는 get 요청의 응답에서 가져올 수 있습니다.

uri

string

새 이미지의 URI입니다.

삽입 시 이미지를 한 번 가져오고 문서 내에 표시하기 위해 사본이 저장됩니다. 이미지는 50MB 미만이어야 하고, 25메가픽셀 이하여야 하며, PNG, JPEG, GIF 형식이어야 합니다.

제공된 URI의 길이는 2KB를 초과할 수 없습니다. URI는 이미지와 함께 저장되고 ImageProperties.source_uri 필드를 통해 노출됩니다.

imageReplaceMethod

enum (ImageReplaceMethod)

대체 메서드입니다.

ImageReplace 메서드

이미지 대체 메서드입니다.

열거형
IMAGE_REPLACE_METHOD_UNSPECIFIED 지정되지 않은 이미지 대체 메서드입니다. 이 값은 사용할 수 없습니다.
CENTER_CROP 원본 이미지의 경계를 채우도록 이미지의 크기를 조정하고 중앙에 배치합니다. 원본 이미지의 경계를 채우기 위해 이미지를 자를 수 있습니다. 이미지의 렌더링된 크기는 원본 이미지와 동일합니다.

UpdateDocumentStyleRequest

DocumentStyle를 업데이트합니다.

JSON 표현
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string
}
필드
documentStyle

object (DocumentStyle)

문서에 설정할 스타일입니다.

특정 문서 스타일을 변경하면 Docs 편집기의 동작을 미러링하기 위해 다른 변경사항이 발생할 수 있습니다. 자세한 내용은 DocumentStyle 문서를 참조하세요.

fields

string (FieldMask format)

업데이트해야 하는 필드입니다.

하나 이상의 필드를 지정해야 합니다. 루트 documentStyle는 암시적이므로 지정해서는 안 됩니다. 단일 "*"를 모든 필드를 나열하는 약식으로 사용할 수 있습니다.

예를 들어 배경을 업데이트하려면 fields"background"로 설정합니다.

MergeTableCellsRequest 클래스의 생성자

Table의 셀을 병합합니다.

JSON 표현
{
  "tableRange": {
    object (TableRange)
  }
}
필드
tableRange

object (TableRange)

표에서 병합할 셀을 지정하는 테이블 범위입니다.

병합되는 셀의 모든 텍스트는 범위의 '헤드' 셀에 연결되고 저장됩니다. 콘텐츠 방향이 왼쪽에서 오른쪽일 때 범위의 왼쪽 상단 셀이며, 그렇지 않은 경우 범위의 오른쪽 상단 셀입니다.

범위가 직사각형이 아닌 경우 (이미 병합된 셀을 포함하는 경우 또는 테이블이 직사각형이 아닌 경우에 발생할 수 있음) 400 잘못된 요청 오류가 반환됩니다.

병합되지 않은 테이블 셀 요청

Table에서 셀 병합을 취소합니다.

JSON 표현
{
  "tableRange": {
    object (TableRange)
  }
}
필드
tableRange

object (TableRange)

표에서 병합 취소할 셀을 지정합니다.

이 범위의 모든 병합된 셀은 병합 취소되며 이미 병합 취소된 셀은 영향을 받지 않습니다. 범위에 병합된 셀이 없으면 아무 작업도 수행되지 않습니다.

병합된 셀에 텍스트가 있는 경우 병합되지 않은 셀의 블록 블록의 '헤드' 셀에 텍스트가 그대로 유지됩니다. 'head' 셀은 콘텐츠 방향이 왼쪽에서 오른쪽일 때 왼쪽 상단 셀이고 그렇지 않으면 오른쪽 상단 셀입니다.

CreateHeaderRequest 클래스의 생성자

Header를 만듭니다. 새 헤더는 지정된 경우 SectionBreak의 위치에 있는 SectionStyle에 적용됩니다. 지정하지 않으면 DocumentStyle에 적용됩니다.

지정된 유형의 헤더가 이미 있는 경우 400 잘못된 요청 오류가 반환됩니다.

JSON 표현
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
필드
type

enum (HeaderFooterType)

만들 헤더의 유형입니다.

sectionBreakLocation

object (Location)

이 헤더가 속한 섹션이 시작되는 SectionBreak의 위치입니다. `sectionBreakLocation'이 설정되지 않았거나 문서 본문의 첫 번째 섹션 나누기를 참조하는 경우 헤더가 DocumentStyle에 적용됩니다.

헤더 바닥글 유형

만들 수 있는 머리글 및 바닥글의 유형입니다.

열거형
DEFAULT 기본 머리글/바닥글

CreateFooterRequest

Footer를 만듭니다. 새 바닥글은 SectionBreak 위치에 있는 SectionStyle에 적용됩니다(지정된 경우). 그렇지 않으면 DocumentStyle에 적용됩니다.

지정된 유형의 바닥글이 이미 있는 경우 400 잘못된 요청 오류가 반환됩니다.

JSON 표현
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
필드
type

enum (HeaderFooterType)

만들 바닥글의 유형입니다.

sectionBreakLocation

object (Location)

이 바닥글이 속해야 하는 SectionStyle가 있는 섹션 바로 앞에 있는 SectionBreak의 위치입니다. 이 설정이 지정되지 않거나 문서의 첫 번째 섹션 나누기를 참조하는 경우 푸터는 문서 스타일에 적용됩니다.

CreateFootnoteRequest

Footnote 세그먼트를 만들고 지정된 위치에 새 FootnoteReference를 삽입합니다.

Footnote 세그먼트에는 공백 뒤에 줄바꿈 문자가 뒤따릅니다.

JSON 표현
{

  // Union field footnote_reference_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field footnote_reference_location.
}
필드
공용체 필드 footnote_reference_location는 각주 참조를 삽입할 위치입니다. footnote_reference_location는 다음 중 하나여야 합니다.
location

object (Location)

문서의 특정 색인에 각주 참조를 삽입합니다.

각주 참조는 기존 Paragraph의 경계 내에 삽입해야 합니다. 예를 들어 테이블의 시작 색인 (즉, 테이블과 이전 단락 사이)에는 삽입할 수 없습니다.

각주 참조는 등식, 머리글, 바닥글 또는 각주 안에 삽입할 수 없습니다. 각주 참조는 본문에만 삽입할 수 있으므로 segment ID 필드는 비어 있어야 합니다.

endOfSegmentLocation

object (EndOfSegmentLocation)

문서 본문 끝에 각주 참조를 삽입합니다.

각주 참조를 머리글, 바닥글 또는 각주 안에 삽입할 수 없습니다. 각주 참조는 본문에만 삽입할 수 있으므로 segment ID 필드는 비어 있어야 합니다.

대체 이름 콘텐츠 범위 요청

지정된 NamedRange 또는 NamedRanges의 콘텐츠를 지정된 대체 콘텐츠로 바꿉니다.

개별 NamedRange은 불연속적인 여러 ranges로 구성될 수 있습니다. 이 경우 첫 번째 범위의 콘텐츠만 대체됩니다. 다른 범위와 콘텐츠가 삭제됩니다.

범위를 교체하거나 삭제하여 문서 구조가 잘못될 경우 400 잘못된 요청 오류가 반환됩니다.

JSON 표현
{

  // Union field replacement_content can be only one of the following:
  "text": string
  // End of list of possible types for union field replacement_content.

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "namedRangeName": string
  // End of list of possible types for union field named_range_reference.
}
필드
공용체 필드 replacement_content는 이름이 지정된 범위의 기존 콘텐츠를 대체할 콘텐츠입니다. replacement_content는 다음 중 하나여야 합니다.
text

string

지정된 이름이 지정된 범위의 콘텐츠를 지정된 텍스트로 바꿉니다.

공용체 필드 named_range_reference는 콘텐츠를 대체할 이름이 지정된 범위에 대한 참조입니다. named_range_reference는 다음 중 하나여야 합니다.
namedRangeId

string

콘텐츠를 대체할 이름이 지정된 범위의 ID입니다.

지정된 ID로 명명된 범위가 없으면 400 잘못된 요청 오류가 반환됩니다.

namedRangeName

string

콘텐츠를 대체할 NamedRanges의 이름입니다.

특정 이름의 named ranges가 여러 개 있다면 각 항목의 내용이 대체됩니다. 지정된 이름의 명명된 범위가 없으면 요청이 노옵스(no-ops)입니다.

UpdateSectionStyleRequest

SectionStyle를 업데이트합니다.

JSON 표현
{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}
필드
range

object (Range)

스타일을 지정할 섹션과 겹치는 범위입니다.

섹션 나누기는 본문 내부에만 삽입할 수 있으므로 segment ID 필드는 비어 있어야 합니다.

sectionStyle

object (SectionStyle)

섹션에서 설정할 스타일입니다.

특정 섹션 스타일을 변경하면 Docs 편집기의 동작을 반영하기 위해 다른 변경사항이 발생할 수 있습니다. 자세한 내용은 SectionStyle 문서를 참조하세요.

fields

string (FieldMask format)

업데이트해야 하는 필드입니다.

하나 이상의 필드를 지정해야 합니다. 루트 sectionStyle는 암시적이므로 지정해서는 안 됩니다. 단일 "*"를 모든 필드를 나열하는 약식으로 사용할 수 있습니다.

예를 들어 왼쪽 여백을 업데이트하려면 fields"marginLeft"로 설정합니다.

섹션 나누기 요청

지정된 위치에 섹션 나누기를 삽입합니다.

섹션 나누기 앞에 줄바꿈 문자가 삽입됩니다.

JSON 표현
{
  "sectionType": enum (SectionType),

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
필드
sectionType

enum (SectionType)

삽입할 섹션의 유형입니다.

공용체 필드 insertion_location는 줄바꿈이 삽입될 위치입니다. insertion_location는 다음 중 하나여야 합니다.
location

object (Location)

문서의 특정 색인에서 줄바꿈 및 섹션 나누기를 삽입합니다.

기존 Paragraph의 경계 내에 섹션 나누기를 삽입해야 합니다. 예를 들어 테이블의 시작 색인 (즉, 테이블과 이전 단락 사이)에는 삽입할 수 없습니다.

표, 방정식, 각주, 머리글 또는 바닥글에는 섹션 나누기를 삽입할 수 없습니다. 섹션 나누기는 본문 내부에만 삽입할 수 있으므로 segment ID 필드는 비어 있어야 합니다.

endOfSegmentLocation

object (EndOfSegmentLocation)

문서 본문의 끝에 줄바꿈 및 섹션 나누기를 삽입합니다.

각주, 머리글 또는 바닥글 내에 섹션 나누기를 삽입할 수 없습니다. 섹션 나누기는 본문 내부에만 삽입할 수 있으므로 segment ID 필드는 비어 있어야 합니다.

헤더 삭제 요청

문서에서 Header를 삭제합니다.

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

string

삭제할 헤더의 ID입니다. 이 헤더가 DocumentStyle에 정의되면 이 헤더에 대한 참조가 삭제되어 문서의 첫 번째 섹션에 이 유형의 헤더가 생성되지 않습니다. 이 헤더가 SectionStyle에 정의되면 이 헤더에 대한 참조가 삭제되고 이 유형의 헤더가 이전 섹션에서 계속됩니다.

FooterRequest 삭제

문서에서 Footer를 삭제합니다.

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

string

삭제할 바닥글의 ID입니다. 이 바닥글이 DocumentStyle에 정의되면 이 바닥글에 대한 참조가 삭제되어 문서의 첫 번째 섹션에 해당 바닥글이 생성되지 않습니다. 이 바닥글이 SectionStyle에 정의된 경우 이 바닥글에 대한 참조가 삭제되고 이제 이전 섹션에서 이 바닥글이 계속 유지됩니다.

고정 표 헤더 행 요청

테이블의 고정된 테이블 헤더 행 수를 업데이트합니다.

JSON 표현
{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}
필드
tableStartLocation

object (Location)

문서에서 테이블이 시작되는 위치입니다.

pinnedHeaderRowsCount

integer

고정할 테이블의 행 수입니다. 여기서 0은 모든 행이 고정 해제되었음을 의미합니다.