Method: documents.create

Tworzy pusty dokument z tytułem podanym w żądaniu. Pozostałe pola w żądaniu, w tym 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),
  "commentsViewMode": enum (CommentsViewMode),
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "suggestions": [
    {
      object (SuggestionThread)
    }
  ],
  "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 zagnieżdżone w innych kartach. Karty podrzędne są reprezentowane przez pole Tab.childTabs.
revisionId

string

Tylko dane wyjściowe. Identyfikator wersji dokumentu. Może być używany w prośbach o aktualizację, aby określić, do której wersji dokumentu mają być stosowane aktualizacje, i jak prośba powinna się zachowywać, jeśli dokument został zmodyfikowany od czasu tej wersji. Wypełniane tylko wtedy, gdy użytkownik ma uprawnienia do edycji dokumentu.

Identyfikator wersji nie jest liczbą porządkową, ale nieprzejrzystym ciągiem znaków. Format identyfikatora wersji może się z czasem zmienić. Zwrócony identyfikator wersji jest ważny tylko przez 24 godziny od momentu zwrócenia i nie można go udostępniać 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ć jednak spowodowana również czynnikami wewnętrznymi, takimi jak zmiany 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 symbolem SUGGESTIONS_INLINE.
commentsViewMode

enum (CommentsViewMode)

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

comments[]

object (CommentThread)

Tylko dane wyjściowe. Komentarze powiązane z dokumentem. Wypełniony tylko wtedy, gdy parametr commentsViewMode jest ustawiony na wymaganie komentarzy (np. COMMENTS_VIEW_MODE_INCLUDED).

suggestions[]

object (SuggestionThread)

Tylko dane wyjściowe. sugestie powiązane z dokumentem; Wypełniony tylko wtedy, gdy parametr commentsViewMode jest ustawiony na wymaganie komentarzy (np. COMMENTS_VIEW_MODE_INCLUDED).

body

object (Body)

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

Pole starszego typu: zamiast niego używaj Document.tabs.documentTab.body, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.
headers

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

Tylko dane wyjściowe. Nagłówki w dokumencie, z kluczem w postaci identyfikatora nagłówka.

Pole starszego typu: zamiast niego używaj Document.tabs.documentTab.headers, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.
footers

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

Tylko dane wyjściowe. Stopki w dokumencie, z kluczem w postaci identyfikatora stopki.

Pole starszego typu: zamiast niego używaj Document.tabs.documentTab.footers, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.
footnotes

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

Tylko dane wyjściowe. Przypisy w dokumencie, z kluczem w postaci identyfikatora przypisu.

Pole starszego typu: zamiast niego używaj Document.tabs.documentTab.footnotes, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.
documentStyle

object (DocumentStyle)

Tylko dane wyjściowe. Styl dokumentu.

Pole starszego typu: zamiast niego używaj Document.tabs.documentTab.documentStyle, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.
suggestedDocumentStyleChanges

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

Tylko dane wyjściowe. Sugerowane zmiany stylu dokumentu, z kluczem w postaci identyfikatora sugestii.

Pole starszego typu: zamiast niego używaj Document.tabs.documentTab.suggestedDocumentStyleChanges, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.
namedStyles

object (NamedStyles)

Tylko dane wyjściowe. Style nazwane dokumentu.

Pole starszego typu: zamiast niego używaj Document.tabs.documentTab.namedStyles, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.
suggestedNamedStylesChanges

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

Tylko dane wyjściowe. Proponowane zmiany w nazwanych stylach dokumentu, z kluczem w postaci identyfikatora sugestii.

Pole starszego typu: zamiast niego używaj Document.tabs.documentTab.suggestedNamedStylesChanges, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.
lists

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

Tylko dane wyjściowe. Listy w dokumencie, z kluczem w postaci identyfikatora listy.

Pole starszego typu: zamiast niego używaj Document.tabs.documentTab.lists, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.
namedRanges

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

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

Pole starszego typu: zamiast niego używaj Document.tabs.documentTab.namedRanges, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.
inlineObjects

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

Tylko dane wyjściowe. Obiekty wbudowane w dokumencie, z kluczem w postaci identyfikatora obiektu.

Pole starszego typu: zamiast niego używaj Document.tabs.documentTab.inlineObjects, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.
positionedObjects

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

Tylko dane wyjściowe. Obiekty w dokumencie z określonym położeniem, z kluczami w postaci identyfikatorów obiektów.

Pole starszego typu: zamiast niego używaj Document.tabs.documentTab.positionedObjects, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono 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 po autoryzacji.