Method: documents.create

Создает пустой документ, используя заголовок, указанный в запросе. Другие поля в запросе, включая любой предоставленный контент, игнорируются.

Возвращает созданный документ.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Тело запроса

Тело запроса содержит данные со следующей структурой:

Представление JSON
{
  "documentId": string,
  "title": string,
  "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)
    },
    ...
  },
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
Поля
documentId

string

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

title

string

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

body

object ( Body )

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

headers

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

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

footers

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

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

footnotes

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

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

documentStyle

object ( DocumentStyle )

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

suggestedDocumentStyleChanges

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

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

namedStyles

object ( NamedStyles )

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

suggestedNamedStylesChanges

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

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

lists

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

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

namedRanges

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

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

revisionId

string

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

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

suggestionsViewMode

enum ( SuggestionsViewMode )

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

Примечание. При редактировании документа изменения должны основываться на документе с SUGGESTIONS_INLINE .

inlineObjects

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

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

positionedObjects

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

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

Тело ответа

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

Области авторизации

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

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

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