Method: documents.create

Tworzy pusty dokument z tytułem podanym w żądaniu. Pozostałe 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 będące częścią dokumentu.

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

revisionId

string

Tylko dane wyjściowe. Identyfikator wersji dokumentu. Można go używać w żądaniach aktualizacji, aby określić, do której wersji dokumentu mają zostać zastosowane aktualizacje i jak powinno działać żądanie, jeśli dokument był edytowany od czasu wprowadzenia tej wersji. To pole jest wypełniane tylko wtedy, gdy użytkownik ma uprawnienia do edycji dokumentu.

Identyfikator wersji nie jest liczbą sekwencyjną, ale nieprzezroczystym ciągiem. 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, dokument nie został zmieniony. Natomiast zmiana identyfikatora (tego samego dokumentu i użytkownika) oznacza zazwyczaj, ż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 widoku sugestii zastosowany do dokumentu.

Uwaga: podczas edytowania dokumentu zmiany muszą być wprowadzone w dokumencie z atrybutem SUGGESTIONS_INLINE.

body

object (Body)

Tylko dane wyjściowe. Główna treść 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, pogrupowane według identyfikatora stopki.

Starsza wersja pola: zamiast tego użyj pola Document.tabs.documentTab.footers, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli zasada ma wartość false lub jest nieskonfigurowana, 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;

Starsza wersja pola: zamiast tego użyj pola Document.tabs.documentTab.footnotes, które udostępnia rzeczywistą zawartość 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.

Starsza wersja pola: zamiast tego użyj pola Document.tabs.documentTab.documentStyle, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli zasada ma wartość false lub jest nieskonfigurowana, to pole zawiera informacje o pierwszej karcie w dokumencie.

suggestedDocumentStyleChanges

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

Tylko dane wyjściowe. Sugerowane zmiany stylu dokumentu oparte na identyfikatorze sugestii.

Starsza wersja pola: zamiast tego użyj pola Document.tabs.documentTab.suggestedDocumentStyleChanges, które udostępnia rzeczywistą zawartość 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.

Starsza wersja pola: zamiast tego użyj pola Document.tabs.documentTab.namedStyles, które udostępnia rzeczywistą zawartość 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 w nazwanych stylach dokumentu bazujących na identyfikatorze sugestii.

Starsza wersja pola: zamiast tego użyj pola Document.tabs.documentTab.suggestedNamedStylesChanges, które udostępnia rzeczywistą zawartość 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 pogrupowane według identyfikatora listy.

Starsza wersja pola: zamiast tego użyj pola Document.tabs.documentTab.lists, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli zasada ma wartość false lub jest nieskonfigurowana, 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.

Starsza wersja pola: zamiast tego użyj pola Document.tabs.documentTab.namedRanges, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli zasada ma wartość false lub jest nieskonfigurowana, 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.

Starsza wersja pola: zamiast tego użyj pola Document.tabs.documentTab.inlineObjects, które udostępnia rzeczywistą zawartość 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. Pozycjonowane obiekty w dokumencie z kluczem według identyfikatora obiektu.

Starsza wersja pola: zamiast tego użyj pola Document.tabs.documentTab.positionedObjects, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli zasada ma wartość false lub jest nieskonfigurowana, to pole zawiera informacje o pierwszej karcie w dokumencie.

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 dotyczącym autoryzacji.