Method: documents.create

Membuat dokumen kosong menggunakan judul yang diberikan dalam permintaan. Kolom lain dalam permintaan, termasuk konten yang diberikan, akan diabaikan.

Menampilkan dokumen yang dibuat.

Permintaan HTTP

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

URL ini menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi 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)
    },
    ...
  }
}
Kolom
documentId

string

Hanya output. ID dokumen.

title

string

Judul dokumen.

tabs[]

object (Tab)

Tab yang merupakan bagian dari dokumen.

Tab dapat berisi tab turunan, yaitu tab yang berada di dalam tab lain. Tab turunan diwakili oleh kolom Tab.childTabs.

revisionId

string

Hanya output. ID revisi dokumen. Dapat digunakan dalam permintaan update untuk menentukan revisi dokumen mana yang akan diterapkan update dan cara permintaan harus berperilaku jika dokumen telah diedit sejak revisi tersebut. Hanya diisi jika pengguna memiliki akses edit ke dokumen.

ID revisi bukan berupa angka berurutan, melainkan string buram. Format ID revisi dapat berubah dari waktu ke waktu. ID revisi yang dikembalikan hanya dijamin valid selama 24 jam setelah dikembalikan dan tidak dapat dibagikan kepada pengguna lain. Jika ID revisi tidak berubah di antara panggilan, berarti dokumen tidak berubah. Sebaliknya, ID yang berubah (untuk dokumen dan pengguna yang sama) biasanya berarti dokumen telah diperbarui. Namun, perubahan ID juga dapat disebabkan oleh faktor internal seperti perubahan format ID.

suggestionsViewMode

enum (SuggestionsViewMode)

Hanya output. Mode tampilan saran yang diterapkan ke dokumen.

Catatan: Saat mengedit dokumen, perubahan harus didasarkan pada dokumen dengan SUGGESTIONS_INLINE.

commentsViewMode

enum (CommentsViewMode)

Hanya output. Mode tampilan komentar yang diterapkan pada dokumen.

comments[]

object (CommentThread)

Hanya output. Komentar yang terkait dengan dokumen. Hanya diisi jika parameter commentsViewMode disetel untuk mewajibkan komentar (seperti COMMENTS_VIEW_MODE_INCLUDED).

suggestions[]

object (SuggestionThread)

Hanya output. Saran yang terkait dengan dokumen. Hanya diisi jika parameter commentsViewMode disetel untuk mewajibkan komentar (seperti COMMENTS_VIEW_MODE_INCLUDED).

body

object (Body)

Hanya output. Isi utama dokumen.

Kolom lama: Sebagai gantinya, gunakan Document.tabs.documentTab.body, yang mengekspos konten dokumen sebenarnya dari semua tab saat parameter includeTabsContent disetel ke true. Jika false atau tidak disetel, kolom ini berisi informasi tentang tab pertama dalam dokumen.

headers

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

Hanya output. Header dalam dokumen, yang dikelompokkan berdasarkan ID header.

Kolom lama: Sebagai gantinya, gunakan Document.tabs.documentTab.headers, yang mengekspos konten dokumen sebenarnya dari semua tab saat parameter includeTabsContent disetel ke true. Jika false atau tidak disetel, kolom ini berisi informasi tentang tab pertama dalam dokumen.

footers

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

Hanya output. Footer dalam dokumen, yang dikelompokkan berdasarkan ID footer.

Kolom lama: Sebagai gantinya, gunakan Document.tabs.documentTab.footers, yang mengekspos konten dokumen sebenarnya dari semua tab saat parameter includeTabsContent disetel ke true. Jika false atau tidak disetel, kolom ini berisi informasi tentang tab pertama dalam dokumen.

footnotes

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

Hanya output. Catatan kaki dalam dokumen, yang dikelompokkan berdasarkan ID catatan kaki.

Kolom lama: Sebagai gantinya, gunakan Document.tabs.documentTab.footnotes, yang mengekspos konten dokumen sebenarnya dari semua tab saat parameter includeTabsContent disetel ke true. Jika false atau tidak disetel, kolom ini berisi informasi tentang tab pertama dalam dokumen.

documentStyle

object (DocumentStyle)

Hanya output. Gaya dokumen.

Kolom lama: Sebagai gantinya, gunakan Document.tabs.documentTab.documentStyle, yang mengekspos konten dokumen sebenarnya dari semua tab saat parameter includeTabsContent disetel ke true. Jika false atau tidak disetel, kolom ini berisi informasi tentang tab pertama dalam dokumen.

suggestedDocumentStyleChanges

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

Hanya output. Perubahan gaya dokumen yang disarankan, yang dikelompokkan berdasarkan ID saran.

Kolom lama: Sebagai gantinya, gunakan Document.tabs.documentTab.suggestedDocumentStyleChanges, yang mengekspos konten dokumen sebenarnya dari semua tab saat parameter includeTabsContent disetel ke true. Jika false atau tidak disetel, kolom ini berisi informasi tentang tab pertama dalam dokumen.

namedStyles

object (NamedStyles)

Hanya output. Gaya bernama dokumen.

Kolom lama: Sebagai gantinya, gunakan Document.tabs.documentTab.namedStyles, yang mengekspos konten dokumen sebenarnya dari semua tab saat parameter includeTabsContent disetel ke true. Jika false atau tidak disetel, kolom ini berisi informasi tentang tab pertama dalam dokumen.

suggestedNamedStylesChanges

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

Hanya output. Perubahan yang disarankan pada gaya bernama dokumen, yang dikelompokkan berdasarkan ID saran.

Kolom lama: Sebagai gantinya, gunakan Document.tabs.documentTab.suggestedNamedStylesChanges, yang mengekspos konten dokumen sebenarnya dari semua tab saat parameter includeTabsContent disetel ke true. Jika false atau tidak disetel, kolom ini berisi informasi tentang tab pertama dalam dokumen.

lists

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

Hanya output. Daftar dalam dokumen, yang dikelompokkan berdasarkan ID daftar.

Kolom lama: Sebagai gantinya, gunakan Document.tabs.documentTab.lists, yang mengekspos konten dokumen sebenarnya dari semua tab saat parameter includeTabsContent disetel ke true. Jika false atau tidak disetel, kolom ini berisi informasi tentang tab pertama dalam dokumen.

namedRanges

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

Hanya output. Rentang bernama dalam dokumen, yang dikelompokkan berdasarkan nama.

Kolom lama: Sebagai gantinya, gunakan Document.tabs.documentTab.namedRanges, yang mengekspos konten dokumen sebenarnya dari semua tab saat parameter includeTabsContent disetel ke true. Jika false atau tidak disetel, kolom ini berisi informasi tentang tab pertama dalam dokumen.

inlineObjects

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

Hanya output. Objek inline dalam dokumen, yang dikelompokkan menurut ID objek.

Kolom lama: Sebagai gantinya, gunakan Document.tabs.documentTab.inlineObjects, yang mengekspos konten dokumen sebenarnya dari semua tab saat parameter includeTabsContent disetel ke true. Jika false atau tidak disetel, kolom ini berisi informasi tentang tab pertama dalam dokumen.

positionedObjects

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

Hanya output. Objek yang diposisikan dalam dokumen, yang dikelompokkan berdasarkan ID objek.

Kolom lama: Sebagai gantinya, gunakan Document.tabs.documentTab.positionedObjects, yang mengekspos konten dokumen sebenarnya dari semua tab saat parameter includeTabsContent disetel ke true. Jika false atau tidak disetel, kolom ini berisi informasi tentang tab pertama dalam dokumen.

Isi respons

Jika berhasil, isi respons akan memuat instance Document yang baru dibuat.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.