Method: documents.create

요청에 제공된 제목을 사용하여 빈 문서를 만듭니다. 제공된 콘텐츠를 포함한 요청의 다른 필드는 무시됩니다.

생성된 문서를 반환합니다.

HTTP 요청

POST https://docs.googleapis.com/v1/documents

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

요청 본문

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

JSON 표현
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "commentsViewMode": enum (CommentsViewMode),
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "suggestions": [
    {
      object (SuggestionThread)
    }
  ],
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
필드
documentId

string

출력 전용입니다. 문서의 ID입니다.

title

string

문서 제목입니다.

tabs[]

object (Tab)

출력 전용입니다. 문서에 포함된 탭

탭에는 하위 탭(다른 탭 내에 중첩된 탭)이 포함될 수 있습니다. 하위 탭은 Tab.childTabs 필드로 표시됩니다.

revisionId

string

출력 전용입니다. 문서의 버전 ID입니다. 업데이트 요청에서 업데이트를 적용할 문서의 버전을 지정하고 해당 버전 이후 문서가 수정된 경우 요청이 어떻게 작동해야 하는지 지정하는 데 사용할 수 있습니다. 사용자에게 문서에 대한 수정 액세스 권한이 있는 경우에만 채워집니다.

버전 ID는 순차 번호가 아닌 불투명 문자열입니다. 수정 ID의 형식은 시간이 지남에 따라 변경될 수 있습니다. 반환된 버전 ID는 반환된 후 24시간 동안만 유효하며 사용자 간에 공유할 수 없습니다. 호출 간에 버전 ID가 변경되지 않으면 문서가 변경되지 않은 것입니다. 반대로 동일한 문서와 사용자의 ID가 변경되면 일반적으로 문서가 업데이트되었음을 의미합니다. 하지만 ID 형식 변경과 같은 내부 요인으로 인해 ID가 변경될 수도 있습니다.

suggestionsViewMode

enum (SuggestionsViewMode)

출력 전용입니다. 문서에 적용된 제안 보기 모드입니다.

참고: 문서를 수정할 때는 SUGGESTIONS_INLINE가 있는 문서를 기반으로 변경해야 합니다.

commentsViewMode

enum (CommentsViewMode)

출력 전용입니다. 문서에 적용된 댓글 보기 모드입니다.

comments[]

object (CommentThread)

출력 전용입니다. 문서와 연결된 댓글입니다. commentsViewMode 매개변수가 댓글이 필요하도록 설정된 경우에만 채워집니다 (예: COMMENTS_VIEW_MODE_INCLUDED).

suggestions[]

object (SuggestionThread)

출력 전용입니다. 문서와 연결된 제안입니다. commentsViewMode 매개변수가 댓글이 필요하도록 설정된 경우에만 채워집니다 (예: COMMENTS_VIEW_MODE_INCLUDED).

body

object (Body)

출력 전용입니다. 문서의 본문입니다.

기존 필드: 대신 includeTabsContent 매개변수가 true로 설정된 경우 모든 탭의 실제 문서 콘텐츠를 노출하는 Document.tabs.documentTab.body를 사용하세요. false이거나 설정되지 않은 경우 이 필드에는 문서의 첫 번째 탭에 관한 정보가 포함됩니다.

headers

map (key: string, value: object (Header))

출력 전용입니다. 문서의 헤더로, 헤더 ID를 키로 사용합니다.

기존 필드: 대신 includeTabsContent 매개변수가 true로 설정된 경우 모든 탭의 실제 문서 콘텐츠를 노출하는 Document.tabs.documentTab.headers를 사용하세요. false이거나 설정되지 않은 경우 이 필드에는 문서의 첫 번째 탭에 관한 정보가 포함됩니다.

footers

map (key: string, value: object (Footer))

출력 전용입니다. 문서의 바닥글입니다. 바닥글 ID로 키가 지정됩니다.

기존 필드: 대신 includeTabsContent 매개변수가 true로 설정된 경우 모든 탭의 실제 문서 콘텐츠를 노출하는 Document.tabs.documentTab.footers를 사용하세요. false이거나 설정되지 않은 경우 이 필드에는 문서의 첫 번째 탭에 관한 정보가 포함됩니다.

footnotes

map (key: string, value: object (Footnote))

출력 전용입니다. 문서의 각주로, 각주 ID를 키로 사용합니다.

기존 필드: 대신 includeTabsContent 매개변수가 true로 설정된 경우 모든 탭의 실제 문서 콘텐츠를 노출하는 Document.tabs.documentTab.footnotes를 사용하세요. false이거나 설정되지 않은 경우 이 필드에는 문서의 첫 번째 탭에 관한 정보가 포함됩니다.

documentStyle

object (DocumentStyle)

출력 전용입니다. 문서의 스타일입니다.

기존 필드: 대신 includeTabsContent 매개변수가 true로 설정된 경우 모든 탭의 실제 문서 콘텐츠를 노출하는 Document.tabs.documentTab.documentStyle를 사용하세요. false이거나 설정되지 않은 경우 이 필드에는 문서의 첫 번째 탭에 관한 정보가 포함됩니다.

suggestedDocumentStyleChanges

map (key: string, value: object (SuggestedDocumentStyle))

출력 전용입니다. 제안 ID를 키로 하는 문서 스타일의 제안된 변경사항입니다.

기존 필드: 대신 includeTabsContent 매개변수가 true로 설정된 경우 모든 탭의 실제 문서 콘텐츠를 노출하는 Document.tabs.documentTab.suggestedDocumentStyleChanges를 사용하세요. false이거나 설정되지 않은 경우 이 필드에는 문서의 첫 번째 탭에 관한 정보가 포함됩니다.

namedStyles

object (NamedStyles)

출력 전용입니다. 문서의 이름이 지정된 스타일입니다.

기존 필드: 대신 includeTabsContent 매개변수가 true로 설정된 경우 모든 탭의 실제 문서 콘텐츠를 노출하는 Document.tabs.documentTab.namedStyles를 사용하세요. false이거나 설정되지 않은 경우 이 필드에는 문서의 첫 번째 탭에 관한 정보가 포함됩니다.

suggestedNamedStylesChanges

map (key: string, value: object (SuggestedNamedStyles))

출력 전용입니다. 제안 ID로 키가 지정된 문서의 명명된 스타일의 제안된 변경사항입니다.

기존 필드: 대신 includeTabsContent 매개변수가 true로 설정된 경우 모든 탭의 실제 문서 콘텐츠를 노출하는 Document.tabs.documentTab.suggestedNamedStylesChanges를 사용하세요. false이거나 설정되지 않은 경우 이 필드에는 문서의 첫 번째 탭에 관한 정보가 포함됩니다.

lists

map (key: string, value: object (List))

출력 전용입니다. 문서의 목록으로, 목록 ID를 키로 사용합니다.

기존 필드: 대신 includeTabsContent 매개변수가 true로 설정된 경우 모든 탭의 실제 문서 콘텐츠를 노출하는 Document.tabs.documentTab.lists를 사용하세요. false이거나 설정되지 않은 경우 이 필드에는 문서의 첫 번째 탭에 관한 정보가 포함됩니다.

namedRanges

map (key: string, value: object (NamedRanges))

출력 전용입니다. 문서의 이름이 지정된 범위입니다. 이름으로 키가 지정됩니다.

기존 필드: 대신 includeTabsContent 매개변수가 true로 설정된 경우 모든 탭의 실제 문서 콘텐츠를 노출하는 Document.tabs.documentTab.namedRanges를 사용하세요. false이거나 설정되지 않은 경우 이 필드에는 문서의 첫 번째 탭에 관한 정보가 포함됩니다.

inlineObjects

map (key: string, value: object (InlineObject))

출력 전용입니다. 문서의 인라인 객체로, 객체 ID를 키로 사용합니다.

기존 필드: 대신 includeTabsContent 매개변수가 true로 설정된 경우 모든 탭의 실제 문서 콘텐츠를 노출하는 Document.tabs.documentTab.inlineObjects를 사용하세요. false이거나 설정되지 않은 경우 이 필드에는 문서의 첫 번째 탭에 관한 정보가 포함됩니다.

positionedObjects

map (key: string, value: object (PositionedObject))

출력 전용입니다. 문서에서 위치가 지정된 객체입니다. 객체 ID를 키로 사용합니다.

기존 필드: 대신 includeTabsContent 매개변수가 true로 설정된 경우 모든 탭의 실제 문서 콘텐츠를 노출하는 Document.tabs.documentTab.positionedObjects를 사용하세요. false이거나 설정되지 않은 경우 이 필드에는 문서의 첫 번째 탭에 관한 정보가 포함됩니다.

응답 본문

성공한 경우 응답 본문에 새로 생성된 Document의 인스턴스가 포함됩니다.

승인 범위

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

  • https://www.googleapis.com/auth/documents
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file

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