Method: documents.create

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

Menampilkan dokumen yang dibuat.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

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

string

Hanya output. ID dokumen.

title

string

Judul dokumen.

body

object (Body)

Hanya output. Isi utama dokumen.

headers

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

Hanya output. Header dalam dokumen, yang dikunci oleh ID header.

footers

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

Hanya output. Footer dalam dokumen, yang dikunci oleh ID footer.

footnotes

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

Hanya output. Catatan kaki dalam dokumen, yang dikunci oleh ID catatan kaki.

documentStyle

object (DocumentStyle)

Hanya output. Gaya dokumen.

suggestedDocumentStyleChanges

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

Hanya output. Perubahan yang disarankan pada gaya dokumen, dikunci oleh ID saran.

namedStyles

object (NamedStyles)

Hanya output. Gaya dokumen yang bernama.

suggestedNamedStylesChanges

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

Hanya output. Perubahan yang disarankan pada gaya dokumen yang diberi nama, yang terkunci berdasarkan ID saran.

lists

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

Hanya output. Daftar dalam dokumen, yang terkunci dengan ID daftar.

namedRanges

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

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

revisionId

string

Hanya output. ID revisi dokumen. Dapat digunakan dalam permintaan pembaruan untuk menentukan revisi dokumen yang akan diterapkan pembaruan dan perilaku permintaan jika dokumen telah diedit sejak revisi tersebut. Hanya diisi jika pengguna memiliki akses edit ke dokumen.

ID revisi bukan angka berurutan, melainkan string buram. Format ID revisi dapat berubah dari waktu ke waktu. ID revisi yang ditampilkan hanya dijamin valid selama 24 jam setelah dikembalikan dan tidak dapat dibagikan kepada pengguna. 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, ID yang berubah 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 yang berisi SUGGESTIONS_INLINE.

inlineObjects

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

Hanya output. Objek inline di dokumen, yang dikunci oleh ID objek.

positionedObjects

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

Hanya output. Objek yang diposisikan dalam dokumen, yang dikunci oleh ID objek.

Isi respons

Jika berhasil, isi respons 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.