Method: documents.create

Tworzy pusty dokument z tytułem podanym w żądaniu. Inne pola w żądaniu, w tym wszelkie podane 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,
  "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)
    },
    ...
  }
}
Pola
documentId

string

Tylko dane wyjściowe. Identyfikator dokumentu.
title

string

Tytuł dokumentu.
tabs[]

object (Tab)

karty, które są częścią dokumentu.

Karty mogą zawierać karty podrzędne, czyli karty umieszczone w innej karcie. Zakładki podrzędne są reprezentowane przez pole Tab.childTabs.
revisionId

string

Tylko dane wyjściowe. Identyfikator wersji dokumentu. Może być używany w żądaniach aktualizacji w celu określenia, do której wersji dokumentu mają zostać zastosowane zmiany, oraz jak żądanie powinno się zachowywać, jeśli dokument został zmieniony od tej wersji. Wypełniane tylko wtedy, gdy użytkownik ma uprawnienia do edycji dokumentu.

Identyfikator wersji to nieciągły ciąg znaków, a nie liczba. Format identyfikatora wersji może się z czasem zmieniać. Zwrócony identyfikator wersji jest gwarantowany tylko przez 24 godziny od momentu jego zwrotu i nie może być udostępniany innym użytkownikom. Jeśli identyfikator wersji nie zmienia się między wywołaniami, oznacza to, że dokument nie został zmieniony. Z kolei zmieniony identyfikator (w przypadku tego samego dokumentu i użytkownika) zwykle oznacza, że dokument został zaktualizowany. Zmiana identyfikatora może być też spowodowana czynnikami wewnętrznymi, np. zmianami formatu identyfikatora.
suggestionsViewMode

enum (SuggestionsViewMode)

Tylko dane wyjściowe. Tryb wyświetlania sugestii zastosowany w dokumencie.

Uwaga: podczas edytowania dokumentu zmiany muszą być oparte na dokumencie z wartością SUGGESTIONS_INLINE.
body

object (Body)

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

Pole starsze: zamiast tego użyj pola Document.tabs.documentTab.body, które wyświetla rzeczywiste treści dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli false lub nie jest ustawione, to pole zawiera informacje o pierwszej karcie w dokumencie.
headers

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

Tylko dane wyjściowe. Nagłówki w dokumencie, posortowane według identyfikatora nagłówka.

Pole starsze: zamiast tego użyj pola Document.tabs.documentTab.headers, które wyświetla rzeczywiste treści dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli false lub nie jest ustawione, to pole zawiera informacje o pierwszej karcie w dokumencie.
footers

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

Tylko dane wyjściowe. stopki w dokumencie, posortowane według identyfikatora stopki;

Pole starsze: zamiast tego użyj pola Document.tabs.documentTab.footers, które wyświetla rzeczywiste treści dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli false lub nie jest ustawione, to pole zawiera informacje o pierwszej karcie w dokumencie.
footnotes

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

Tylko dane wyjściowe. przypisy w dokumencie, posortowane według identyfikatora przypisu;

Pole starsze: zamiast tego użyj pola Document.tabs.documentTab.footnotes, które wyświetla rzeczywiste treści dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli false lub nie jest ustawione, to pole zawiera informacje o pierwszej karcie w dokumencie.
documentStyle

object (DocumentStyle)

Tylko dane wyjściowe. Styl dokumentu.

Pole starsze: zamiast tego użyj pola Document.tabs.documentTab.documentStyle, które wyświetla rzeczywiste treści dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli false lub nie jest ustawione, to pole zawiera informacje o pierwszej karcie w dokumencie.
suggestedDocumentStyleChanges

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

Tylko dane wyjściowe. Sugerowane zmiany stylu dokumentu, posortowane według identyfikatora sugestii.

Pole starsze: zamiast tego użyj pola Document.tabs.documentTab.suggestedDocumentStyleChanges, które wyświetla rzeczywiste treści dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli false lub nie jest ustawione, to pole zawiera informacje o pierwszej karcie w dokumencie.
namedStyles

object (NamedStyles)

Tylko dane wyjściowe. Nazwane style dokumentu.

Pole starsze: zamiast tego użyj pola Document.tabs.documentTab.namedStyles, które wyświetla rzeczywiste treści dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli false lub nie jest ustawione, to pole zawiera informacje o pierwszej karcie w dokumencie.
suggestedNamedStylesChanges

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

Tylko dane wyjściowe. Sugerowane zmiany nazwanych stylów dokumentu, posortowane według identyfikatora sugestii.

Pole starsze: zamiast tego użyj pola Document.tabs.documentTab.suggestedNamedStylesChanges, które wyświetla rzeczywiste treści dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli false lub nie jest ustawione, to pole zawiera informacje o pierwszej karcie w dokumencie.
lists

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

Tylko dane wyjściowe. Listy w dokumencie, posortowane według identyfikatora listy.

Pole starsze: zamiast tego użyj pola Document.tabs.documentTab.lists, które wyświetla rzeczywiste treści dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli false lub nie jest ustawione, to pole zawiera informacje o pierwszej karcie w dokumencie.
namedRanges

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

Tylko dane wyjściowe. Nazwane zakresy w dokumencie, posortowane według nazwy.

Pole starsze: zamiast tego użyj pola Document.tabs.documentTab.namedRanges, które wyświetla rzeczywiste treści dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli false lub nie jest ustawione, to pole zawiera informacje o pierwszej karcie w dokumencie.
inlineObjects

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

Tylko dane wyjściowe. Obiekty w dokumencie, których kluczem jest identyfikator obiektu.

Pole starsze: zamiast tego użyj pola Document.tabs.documentTab.inlineObjects, które wyświetla rzeczywiste treści dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli false lub nie jest ustawione, to pole zawiera informacje o pierwszej karcie w dokumencie.
positionedObjects

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

Tylko dane wyjściowe. Obiekty umieszczone w dokumencie, posortowane według identyfikatora obiektu.

Pole starsze: zamiast tego użyj pola Document.tabs.documentTab.positionedObjects, które wyświetla rzeczywiste treści dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli false lub nie jest ustawione, to pole zawiera informacje o pierwszej karcie w dokumencie.

Treść odpowiedzi

Jeśli operacja się powiedzie, 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 dotyczącym autoryzacji.