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),
  "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)
    },
    ...
  }
}
Поля
document Id

string

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

title

string

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

tabs[]

object ( Tab )

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

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

revision Id

string

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

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

suggestions View Mode

enum ( SuggestionsViewMode )

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

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

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 или не установлено, это поле содержит информацию о первой вкладке в документе.

document Style

object ( DocumentStyle )

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

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

suggested Document Style Changes

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

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

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

named Styles

object ( NamedStyles )

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

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

suggested Named Styles Changes

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 или не установлено, это поле содержит информацию о первой вкладке в документе.

named Ranges

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

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

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

inline Objects

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

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

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

positioned Objects

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

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