Method: documents.create

Tworzy pusty dokument, używając tytułu podanego w żądaniu. Inne pola w żądaniu, w tym wszelkie dostarczone treści, są ignorowane.

Zwraca utworzony dokument.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis 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)
    },
    ...
  }
}
Pola
documentId

string

Tylko dane wyjściowe. Identyfikator dokumentu.

title

string

Tytuł dokumentu.

body

object (Body)

Tylko dane wyjściowe. Główna treść dokumentu.

headers

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

Tylko dane wyjściowe. Nagłówki w dokumencie uporządkowane według identyfikatora nagłówka.

footers

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

Tylko dane wyjściowe. Stopki w dokumencie oznaczone kluczem.

footnotes

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

Tylko dane wyjściowe. Przypisy w dokumencie oznaczone kluczami.

documentStyle

object (DocumentStyle)

Tylko dane wyjściowe. Styl dokumentu.

suggestedDocumentStyleChanges

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

Tylko dane wyjściowe. Sugerowane zmiany stylu dokumentu oznaczone kluczami identyfikatora sugestii.

namedStyles

object (NamedStyles)

Tylko dane wyjściowe. Style nazwane dokumentu.

suggestedNamedStylesChanges

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

Tylko dane wyjściowe. Sugerowane zmiany w nazwach napisanych w dokumencie według klucza sugestii.

lists

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

Tylko dane wyjściowe. Listy w dokumencie uporządkowane według identyfikatora listy.

namedRanges

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

Tylko dane wyjściowe. Zakresy nazwane w dokumencie, według nazwy.

revisionId

string

Tylko dane wyjściowe. Identyfikator wersji dokumentu. Tej opcji można używać w żądaniach aktualizacji, aby określić, do której wersji dokumentu mają zostać zastosowane aktualizacje i jak powinno ono zachowywać się po zmodyfikowaniu dokumentu. Pole wypełnione tylko wtedy, gdy użytkownik ma uprawnienia do edycji dokumentu.

Identyfikator wersji nie jest ciągiem ciągłym, ale nieprzejrzystym ciągiem. Format identyfikatora wersji może się z czasem zmieniać. Zwrócony identyfikator wersji jest ważny tylko przez 24 godziny po zwróceniu i nie można go udostępniać użytkownikom. Jeśli identyfikator wersji pozostaje niezmienny między wywołaniami, oznacza to, że dokument się nie zmienił. I odwrotnie, zmieniony identyfikator (tego samego dokumentu i użytkownika) zwykle oznacza, że dokument został zaktualizowany. Zmiana identyfikatora może też być spowodowana czynnikami wewnętrznymi, takimi jak zmiany formatu identyfikatora.

suggestionsViewMode

enum (SuggestionsViewMode)

Tylko dane wyjściowe. Tryb widoku sugestii zastosowany do dokumentu.

Uwaga: podczas edycji dokumentu zmiany muszą być oparte na dokumencie z opisem SUGGESTIONS_INLINE.

inlineObjects

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

Tylko dane wyjściowe. Obiekty w dokumencie, w których klucz jest podany według identyfikatora obiektu.

positionedObjects

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

Tylko dane wyjściowe. Obiekty umieszczone w dokumencie uporządkowane według identyfikatora obiektu.

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie zawierała nowo utworzoną instancję Document.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.