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

Только вывод. Идентификатор документа.

title

string

Название документа.

tabs[]

object ( Tab )

Вкладки, являющиеся частью документа.

Вкладки могут содержать дочерние вкладки, то есть вкладку, вложенную в другую вкладку. Дочерние вкладки обозначаются полем Tab.childTabs .

revisionId

string

Только для вывода. Идентификатор ревизии документа. Может использоваться в запросах на обновление, чтобы указать, к какой ревизии документа следует применить обновления и как должен вести себя запрос, если документ был отредактирован после этой ревизии. Заполняется только в том случае, если у пользователя есть доступ к редактированию документа.

Идентификатор ревизии — это не порядковый номер, а непрозрачная строка. Формат идентификатора ревизии может меняться со временем. Гарантируется, что возвращаемый идентификатор ревизии будет действителен только в течение 24 часов после его возврата и не может быть передан другим пользователям. Если идентификатор ревизии не изменился между вызовами, значит, документ не изменился. И наоборот, изменение идентификатора (для того же документа и пользователя) обычно означает, что документ был обновлен. Однако изменение идентификатора также может быть вызвано внутренними факторами, такими как изменение формата идентификатора.

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 )

Только вывод. Основная часть документа.

Устаревшее поле: Вместо него используйте Document.tabs.documentTab.body , которое отображает фактическое содержимое документа со всех вкладок, если параметр includeTabsContent установлен в true . Если false или поле не задано, оно содержит информацию о первой вкладке в документе.

headers

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

Только вывод. Заголовки документа, отсортированные по идентификатору заголовка.

Устаревшее поле: Вместо этого используйте Document.tabs.documentTab.headers , которое отображает фактическое содержимое документа со всех вкладок, если параметр includeTabsContent установлен в true . Если false или поле не задано, оно содержит информацию о первой вкладке в документе.

footers

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

Только для вывода. Нижние колонтитулы документа, отсортированные по идентификатору нижнего колонтитула.

Устаревшее поле: Вместо него используйте Document.tabs.documentTab.footers , которое отображает фактическое содержимое документа со всех вкладок, если параметр includeTabsContent установлен в true . Если false или поле не задано, оно содержит информацию о первой вкладке в документе.

footnotes

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

Только вывод. Сноски в документе, отсортированные по идентификатору сноски.

Устаревшее поле: Вместо него используйте Document.tabs.documentTab.footnotes , которое отображает фактическое содержимое документа со всех вкладок, если параметр includeTabsContent установлен в true . Если false или поле не задано, оно содержит информацию о первой вкладке в документе.

documentStyle

object ( DocumentStyle )

Только вывод. Стиль документа.

Устаревшее поле: Вместо этого используйте Document.tabs.documentTab.documentStyle , которое отображает фактическое содержимое документа со всех вкладок, если параметр includeTabsContent установлен в true . Если false или поле не задано, оно содержит информацию о первой вкладке в документе.

suggestedDocumentStyleChanges

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

Только вывод. Предложенные изменения стиля документа, обозначенные идентификатором предложения.

Устаревшее поле: Вместо этого используйте Document.tabs.documentTab.suggestedDocumentStyleChanges , которое отображает фактическое содержимое документа со всех вкладок, если параметр includeTabsContent установлен в true . Если false или поле не задано, оно содержит информацию о первой вкладке в документе.

namedStyles

object ( NamedStyles )

Только для вывода. Именованные стили документа.

Устаревшее поле: Вместо этого используйте Document.tabs.documentTab.namedStyles , которое отображает фактическое содержимое документа со всех вкладок, если параметр includeTabsContent установлен в true . Если false или поле не задано, оно содержит информацию о первой вкладке в документе.

suggestedNamedStylesChanges

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

Только вывод. Предлагаемые изменения именованных стилей документа, сгруппированные по идентификатору предложения.

Устаревшее поле: Вместо этого используйте Document.tabs.documentTab.suggestedNamedStylesChanges , которое отображает фактическое содержимое документа со всех вкладок, если параметр includeTabsContent установлен в true . Если false или поле не задано, оно содержит информацию о первой вкладке в документе.

lists

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

Только вывод. Списки в документе, отсортированные по идентификатору списка.

Устаревшее поле: Вместо этого используйте Document.tabs.documentTab.lists , которое отображает фактическое содержимое документа со всех вкладок, если параметр includeTabsContent установлен в true . Если false или поле не задано, оно содержит информацию о первой вкладке в документе.

namedRanges

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

Только для вывода. Именованные диапазоны в документе, отсортированные по имени.

Устаревшее поле: Вместо него используйте Document.tabs.documentTab.namedRanges , которое отображает фактическое содержимое документа со всех вкладок, если параметр includeTabsContent установлен в true . Если false или поле не задано, оно содержит информацию о первой вкладке в документе.

inlineObjects

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

Только вывод. Встроенные объекты в документе, идентифицированные по идентификатору объекта.

Устаревшее поле: Вместо этого используйте Document.tabs.documentTab.inlineObjects , которое отображает фактическое содержимое документа со всех вкладок, если параметр includeTabsContent установлен в true . Если false или поле не задано, оно содержит информацию о первой вкладке в документе.

positionedObjects

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

Только вывод. Позиционированные объекты в документе, отсортированные по идентификатору объекта.

Устаревшее поле: Вместо этого используйте Document.tabs.documentTab.positionedObjects , которое отображает фактическое содержимое документа со всех вкладок, если параметр includeTabsContent установлен в true . Если false или поле не задано, оно содержит информацию о первой вкладке в документе.

Ответный текст

В случае успеха тело ответа будет содержать вновь созданный экземпляр объекта Document .

Области полномочий

Требуется один из следующих диапазонов аутентификации OAuth:

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

Для получения более подробной информации см. руководство по авторизации .