Requests

Permintaan

Satu update untuk diterapkan pada dokumen.

Representasi JSON 
{

  // Union field request can be only one of the following:
  "replaceAllText": {
    object (ReplaceAllTextRequest)
  },
  "insertText": {
    object (InsertTextRequest)
  },
  "updateTextStyle": {
    object (UpdateTextStyleRequest)
  },
  "createParagraphBullets": {
    object (CreateParagraphBulletsRequest)
  },
  "deleteParagraphBullets": {
    object (DeleteParagraphBulletsRequest)
  },
  "createNamedRange": {
    object (CreateNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "updateParagraphStyle": {
    object (UpdateParagraphStyleRequest)
  },
  "deleteContentRange": {
    object (DeleteContentRangeRequest)
  },
  "insertInlineImage": {
    object (InsertInlineImageRequest)
  },
  "insertTable": {
    object (InsertTableRequest)
  },
  "insertTableRow": {
    object (InsertTableRowRequest)
  },
  "insertTableColumn": {
    object (InsertTableColumnRequest)
  },
  "deleteTableRow": {
    object (DeleteTableRowRequest)
  },
  "deleteTableColumn": {
    object (DeleteTableColumnRequest)
  },
  "insertPageBreak": {
    object (InsertPageBreakRequest)
  },
  "deletePositionedObject": {
    object (DeletePositionedObjectRequest)
  },
  "updateTableColumnProperties": {
    object (UpdateTableColumnPropertiesRequest)
  },
  "updateTableCellStyle": {
    object (UpdateTableCellStyleRequest)
  },
  "updateTableRowStyle": {
    object (UpdateTableRowStyleRequest)
  },
  "replaceImage": {
    object (ReplaceImageRequest)
  },
  "updateDocumentStyle": {
    object (UpdateDocumentStyleRequest)
  },
  "mergeTableCells": {
    object (MergeTableCellsRequest)
  },
  "unmergeTableCells": {
    object (UnmergeTableCellsRequest)
  },
  "createHeader": {
    object (CreateHeaderRequest)
  },
  "createFooter": {
    object (CreateFooterRequest)
  },
  "createFootnote": {
    object (CreateFootnoteRequest)
  },
  "replaceNamedRangeContent": {
    object (ReplaceNamedRangeContentRequest)
  },
  "updateSectionStyle": {
    object (UpdateSectionStyleRequest)
  },
  "insertSectionBreak": {
    object (InsertSectionBreakRequest)
  },
  "deleteHeader": {
    object (DeleteHeaderRequest)
  },
  "deleteFooter": {
    object (DeleteFooterRequest)
  },
  "pinTableHeaderRows": {
    object (PinTableHeaderRowsRequest)
  }
  // End of list of possible types for union field request.
}
Kolom
Kolom union request. Permintaan tertentu untuk diterapkan. Hanya satu kolom yang wajib diisi. request hanya dapat berupa salah satu dari berikut:
replaceAllText

object (ReplaceAllTextRequest)

Mengganti semua instance teks yang ditentukan.

insertText

object (InsertTextRequest)

Menyisipkan teks di lokasi yang ditentukan.

updateTextStyle

object (UpdateTextStyleRequest)

Memperbarui gaya teks pada rentang yang ditentukan.

createParagraphBullets

object (CreateParagraphBulletsRequest)

Membuat butir untuk paragraf.

deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

Menghapus butir dari paragraf.

createNamedRange

object (CreateNamedRangeRequest)

Membuat rentang bernama.

deleteNamedRange

object (DeleteNamedRangeRequest)

Menghapus rentang bernama.

updateParagraphStyle

object (UpdateParagraphStyleRequest)

Memperbarui gaya paragraf pada rentang yang ditentukan.

deleteContentRange

object (DeleteContentRangeRequest)

Menghapus konten dari dokumen.

insertInlineImage

object (InsertInlineImageRequest)

Menyisipkan gambar inline di lokasi yang ditentukan.

insertTable

object (InsertTableRequest)

Menyisipkan tabel di lokasi yang ditentukan.

insertTableRow

object (InsertTableRowRequest)

Menyisipkan baris kosong ke dalam tabel.

insertTableColumn

object (InsertTableColumnRequest)

Menyisipkan kolom kosong ke tabel.

deleteTableRow

object (DeleteTableRowRequest)

Menghapus baris dari tabel.

deleteTableColumn

object (DeleteTableColumnRequest)

Menghapus kolom dari tabel.

insertPageBreak

object (InsertPageBreakRequest)

Menyisipkan batas halaman di lokasi yang ditentukan.

deletePositionedObject

object (DeletePositionedObjectRequest)

Menghapus objek yang diposisikan dari dokumen.

updateTableColumnProperties

object (UpdateTableColumnPropertiesRequest)

Memperbarui properti kolom dalam tabel.

updateTableCellStyle

object (UpdateTableCellStyleRequest)

Memperbarui gaya sel tabel.

updateTableRowStyle

object (UpdateTableRowStyleRequest)

Memperbarui gaya baris dalam tabel.

replaceImage

object (ReplaceImageRequest)

Mengganti gambar dalam dokumen.

updateDocumentStyle

object (UpdateDocumentStyleRequest)

Memperbarui gaya dokumen.

mergeTableCells

object (MergeTableCellsRequest)

Menggabungkan sel dalam tabel.

unmergeTableCells

object (UnmergeTableCellsRequest)

Pisahkan sel dalam tabel.

createHeader

object (CreateHeaderRequest)

Membuat header.

createFootnote

object (CreateFootnoteRequest)

Membuat catatan kaki.

replaceNamedRangeContent

object (ReplaceNamedRangeContentRequest)

Mengganti konten dalam rentang bernama.

updateSectionStyle

object (UpdateSectionStyleRequest)

Memperbarui gaya bagian dari rentang yang ditentukan.

insertSectionBreak

object (InsertSectionBreakRequest)

Menyisipkan batas bagian di lokasi yang ditentukan.

deleteHeader

object (DeleteHeaderRequest)

Menghapus header dari dokumen.

pinTableHeaderRows

object (PinTableHeaderRowsRequest)

Memperbarui jumlah baris header yang disematkan dalam tabel.

GantiSemuaTeksPermintaan

Mengganti semua kemunculan teks yang cocok dengan kriteria dengan replace text.

Representasi JSON 
{
  "replaceText": string,

  // Union field criteria can be only one of the following:
  "containsText": {
    object (SubstringMatchCriteria)
  }
  // End of list of possible types for union field criteria.
}
Kolom
replaceText

string

Teks yang akan menggantikan teks yang cocok.

Kolom union criteria. Kriteria yang digunakan agar cocok dengan teks yang akan diganti. criteria hanya dapat berupa salah satu dari berikut:
containsText

object (SubstringMatchCriteria)

Menemukan teks dalam dokumen yang cocok dengan substring ini.

SubstringMatchCriteria

Kriteria yang cocok dengan string teks tertentu dalam dokumen.

Representasi JSON 
{
  "text": string,
  "matchCase": boolean
}
Kolom
text

string

Teks yang akan ditelusuri dalam dokumen.

matchCase

boolean

Menunjukkan apakah penelusuran harus mematuhi kasus:

  • True : penelusuran peka huruf besar/kecil.
  • False : penelusuran tidak peka huruf besar/kecil.

SisipkanTeksPermintaan

Menyisipkan teks di lokasi yang ditentukan.

Representasi JSON 
{
  "text": string,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Kolom
text

string

Teks yang akan disisipkan.

Menyisipkan karakter baris baru secara implisit akan membuat Paragraph baru pada indeks tersebut. Gaya paragraf dari paragraf baru akan disalin dari paragraf pada indeks penyisipan saat ini, termasuk daftar dan butir.

Gaya teks untuk teks yang disisipkan akan ditentukan secara otomatis, umumnya mempertahankan gaya teks di dekatnya. Pada umumnya, gaya teks untuk teks yang disisipkan akan cocok dengan teks tepat sebelum indeks penyisipan.

Beberapa karakter kontrol (U+0000-U+0008, U+000C-U+001F) dan karakter dari Area Penggunaan Pribadi Bidang Multibahasa Dasar Unicode (U+E000-U+F8FF) akan dihapus dari teks yang disisipkan.

Kolom union insertion_location. Lokasi tempat teks akan disisipkan. insertion_location hanya dapat berupa salah satu dari berikut:
location

object (Location)

Menyisipkan teks pada indeks tertentu dalam dokumen.

Teks harus disisipkan di dalam batas Paragraph yang ada. Misalnya, teks tidak dapat disisipkan di indeks awal tabel (yaitu antara tabel dan paragraf sebelumnya). Teks harus disisipkan di paragraf sebelumnya.

endOfSegmentLocation

object (EndOfSegmentLocation)

Menyisipkan teks di akhir header, footer, catatan kaki, atau isi dokumen.

Lokasi

Lokasi tertentu dalam dokumen.

Representasi JSON 
{
  "segmentId": string,
  "index": integer
}
Kolom
segmentId

string

ID header, footer, atau catatan kaki di lokasi. ID segmen kosong menandakan isi dokumen.

index

integer

Indeks berbasis nol, dalam unit kode UTF-16.

Indeks relatif terhadap awal segmen yang ditentukan oleh segmentId.

EndOfSegmenLocation

Lokasi di akhir isi, header, footer, atau catatan kaki. Lokasi tepat sebelum baris baru terakhir di segmen dokumen.

Representasi JSON 
{
  "segmentId": string
}
Kolom
segmentId

string

ID header, footer, atau catatan kaki di lokasi. ID segmen kosong menandakan isi dokumen.

UpdateTextStyleRequest

Memperbarui gaya teks.

Representasi JSON 
{
  "textStyle": {
    object (TextStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}
Kolom
textStyle

object (TextStyle)

Gaya yang akan ditetapkan pada teks.

Jika nilai untuk gaya tertentu cocok dengan gaya induk, gaya tersebut akan disetel untuk mewarisi.

Perubahan gaya teks tertentu dapat menyebabkan perubahan lain agar mencerminkan perilaku editor Dokumen. Lihat dokumentasi TextStyle untuk informasi selengkapnya.

fields

string (FieldMask format)

Kolom yang harus diperbarui.

Setidaknya satu kolom harus ditentukan. Root textStyle bersifat implisit dan tidak boleh ditentukan. Satu "*" dapat digunakan sebagai singkatan untuk mencantumkan setiap kolom.

Misalnya, untuk memperbarui gaya teks menjadi cetak tebal, tetapkan fields ke "bold".

Untuk mereset properti ke nilai defaultnya, sertakan nama kolomnya dalam mask kolom, tetapi kosongkan kolomnya.

Kolom union insertion_location. Jenis rentang yang digunakan untuk memperbarui gaya teks. insertion_location hanya dapat berupa salah satu dari berikut:
range

object (Range)

Rentang teks yang akan diberi gaya.

Rentang dapat diperluas untuk menyertakan baris baru yang berdekatan.

Jika rentang tersebut sepenuhnya berisi paragraf yang termasuk dalam daftar, butir paragraf juga akan diperbarui dengan gaya teks yang cocok.

Rentang tidak dapat disisipkan di dalam UpdateTextStyleRequest relatif.

CreateParagraphBulletsRequest

Membuat butir untuk semua paragraf yang tumpang tindih dengan rentang yang diberikan.

Tingkat tingkatan setiap paragraf akan ditentukan dengan menghitung tab terdepan di depan setiap paragraf. Untuk menghindari kelebihan ruang antara butir dan paragraf yang sesuai, tab utama tersebut akan dihapus oleh permintaan ini. Hal ini dapat mengubah indeks bagian teks.

Jika paragraf tepat sebelum paragraf diperbarui ada dalam daftar dengan preset yang cocok, paragraf yang diperbarui akan ditambahkan ke daftar sebelumnya.

Representasi JSON 
{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
Kolom
range

object (Range)

Rentang untuk menerapkan preset butir.

bulletPreset

enum (BulletGlyphPreset)

Jenis glyph butir yang akan digunakan.

ButirGllyPreset

Pola preset glyph butir untuk daftar.

Pola ini menggunakan butir-butir berikut:

  • ARROW : Panah, yang sesuai dengan titik kode Unicode U+2794
  • ARROW3D : Panah dengan bayangan 3D, yang sesuai dengan titik kode Unicode U+27a2
  • CHECKBOX : Persegi berongga, yang sesuai dengan titik kode Unicode U+274f
  • CIRCLE : Lingkaran berongga, yang sesuai dengan titik kode Unicode U+25cb
  • DIAMOND : Berlian padat, sesuai dengan titik kode Unicode U+25c6
  • DIAMONDX : Berlian dengan 'x', yang sesuai dengan titik kode Unicode U+2756
  • HOLLOWDIAMOND : Berlian berongga, sesuai dengan titik kode Unicode U+25c7
  • DISC : Lingkaran solid, yang sesuai dengan titik kode Unicode U+25cf
  • SQUARE : Kotak yang solid, yang sesuai dengan titik kode Unicode U+25a0
  • STAR : Bintang, yang sesuai dengan titik kode Unicode U+2605
  • ALPHA : Huruf kecil, seperti 'a', 'b', atau 'c'.
  • UPPERALPHA : Huruf besar, seperti 'A', 'B', atau 'C'.
  • DECIMAL : Angka, seperti '1', '2', atau '3'.
  • ZERODECIMAL : Angka dengan angka satu digit diawali dengan angka nol, seperti '01', '02', atau '03'. Angka dengan lebih dari satu digit tidak diawali dengan angka nol.
  • ROMAN : Angka romawi kecil, seperti 'i', 'ii', atau 'iii'.
  • UPPERROMAN : Angka romawi besar, seperti 'I', 'II', atau 'III'.
  • LEFTTRIANGLE : Segitiga yang mengarah ke kiri, sesuai dengan titik kode Unicode U+25c4
Enumerasi
BULLET_GLYPH_PRESET_UNSPECIFIED Preset glyph butir tidak ditentukan.
BULLET_DISC_CIRCLE_SQUARE Daftar berbutir dengan glyph butir DISC, CIRCLE dan SQUARE untuk 3 tingkat hierarki daftar pertama.
BULLET_DIAMONDX_ARROW3D_SQUARE Daftar berbutir dengan glyph butir DIAMONDX, ARROW3D dan SQUARE untuk 3 tingkat hierarki daftar pertama.
BULLET_CHECKBOX Daftar berbutir dengan CHECKBOX glyph butir untuk semua tingkat hierarki daftar.
BULLET_ARROW_DIAMOND_DISC Daftar berbutir dengan glyph butir ARROW, DIAMOND dan DISC untuk 3 tingkat hierarki daftar pertama.
BULLET_STAR_CIRCLE_SQUARE Daftar berbutir dengan glyph butir STAR, CIRCLE dan SQUARE untuk 3 tingkat hierarki daftar pertama.
BULLET_ARROW3D_CIRCLE_SQUARE Daftar berbutir dengan glyph butir ARROW3D, CIRCLE dan SQUARE untuk 3 tingkat hierarki daftar pertama.
BULLET_LEFTTRIANGLE_DIAMOND_DISC Daftar berbutir dengan glyph butir LEFTTRIANGLE, DIAMOND dan DISC untuk 3 tingkat hierarki daftar pertama.
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE Daftar berbutir dengan glyph butir DIAMONDX, HOLLOWDIAMOND dan SQUARE untuk 3 tingkat hierarki daftar pertama.
BULLET_DIAMOND_CIRCLE_SQUARE Daftar berbutir dengan glyph butir DIAMOND, CIRCLE dan SQUARE untuk 3 tingkat hierarki daftar pertama.
NUMBERED_DECIMAL_ALPHA_ROMAN Daftar bernomor dengan glyph numerik DECIMAL, ALPHA, dan ROMAN untuk 3 tingkat hierarki daftar pertama, diikuti dengan titik.
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS Daftar bernomor dengan DECIMAL, ALPHA dan ROMAN glyph numerik untuk 3 tingkat hierarki daftar pertama, diikuti dengan tanda kurung.
NUMBERED_DECIMAL_NESTED Daftar bernomor dengan glyph numerik DECIMAL yang dipisahkan oleh titik, yang setiap nesting level menggunakan glyph level bertingkat sebelumnya sebagai awalan. Misalnya: '1.', '1.1.', '2.', '2.2.'.
NUMBERED_UPPERALPHA_ALPHA_ROMAN Daftar bernomor dengan glyph numerik UPPERALPHA, ALPHA, dan ROMAN untuk 3 tingkat hierarki daftar pertama, diikuti dengan titik.
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL Daftar bernomor dengan glyph numerik UPPERROMAN, UPPERALPHA, dan DECIMAL untuk 3 tingkat hierarki daftar pertama, diikuti dengan titik.
NUMBERED_ZERODECIMAL_ALPHA_ROMAN Daftar bernomor dengan glyph numerik ZERODECIMAL, ALPHA, dan ROMAN untuk 3 tingkat hierarki daftar pertama, diikuti dengan titik.

HapusParagraphBulletsRequest

Menghapus butir dari semua paragraf yang tumpang tindih dengan rentang yang diberikan.

Tingkat tingkatan setiap paragraf akan dipertahankan secara visual dengan menambahkan indentasi ke awal paragraf yang sesuai.

Representasi JSON 
{
  "range": {
    object (Range)
  }
}
Kolom
range

object (Range)

Rentang yang akan dihapus butirnya.

CreateNamedRangeRequest

Membuat NamedRange yang mereferensikan rentang yang ditentukan.

Representasi JSON 
{
  "name": string,
  "range": {
    object (Range)
  }
}
Kolom
name

string

Nama NamedRange. Nama tidak harus unik.

Nama harus memiliki minimal 1 karakter dan tidak lebih dari 256 karakter, yang diukur dalam unit kode UTF-16.

range

object (Range)

Rentang untuk menerapkan nama.

HapusNamedRangeRequest

Menghapus NamedRange.

Representasi JSON 
{

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "name": string
  // End of list of possible types for union field named_range_reference.
}
Kolom
Kolom union named_range_reference. Nilai yang menentukan rentang atau rentang yang akan dihapus. Hanya satu yang harus ditetapkan. named_range_reference hanya dapat berupa salah satu dari berikut:
namedRangeId

string

ID rentang bernama yang akan dihapus.

name

string

Nama rentang yang akan dihapus. Semua rentang bernama dengan nama yang diberikan akan dihapus.

UpdateParagraphStyleRequest

Memperbarui gaya semua paragraf yang tumpang-tindih dengan rentang yang diberikan.

Representasi JSON 
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}
Kolom
paragraphStyle

object (ParagraphStyle)

Gaya yang akan ditetapkan pada paragraf.

Perubahan gaya paragraf tertentu dapat menyebabkan perubahan lain agar mencerminkan perilaku editor Dokumen. Lihat dokumentasi ParagraphStyle untuk informasi selengkapnya.

fields

string (FieldMask format)

Kolom yang harus diperbarui.

Setidaknya satu kolom harus ditentukan. Root paragraphStyle bersifat implisit dan tidak boleh ditentukan. Satu "*" dapat digunakan sebagai singkatan untuk mencantumkan setiap kolom.

Misalnya, untuk memperbarui properti perataan gaya paragraf, tetapkan fields ke "alignment".

Untuk mereset properti ke nilai defaultnya, sertakan nama kolomnya dalam mask kolom, tetapi kosongkan kolomnya.

Kolom union insertion_location. Jenis rentang yang digunakan untuk memperbarui gaya paragraf. insertion_location hanya dapat berupa salah satu dari berikut:
range

object (Range)

Rentang tumpang-tindih paragraf untuk diberi gaya.

MenghapusContentRangeRequest

Menghapus konten dari dokumen.

Representasi JSON 
{
  "range": {
    object (Range)
  }
}
Kolom
range

object (Range)

Rentang konten yang akan dihapus.

Menghapus teks yang melintasi batas paragraf dapat mengakibatkan perubahan pada gaya paragraf, daftar, objek yang diposisikan, dan bookmark saat kedua paragraf digabungkan.

Mencoba menghapus rentang tertentu dapat mengakibatkan struktur dokumen yang tidak valid, dalam kasus tersebut, error permintaan 400 ditampilkan.

Beberapa contoh permintaan penghapusan yang tidak valid meliputi:

InsertInlineImageRequest

Menyisipkan InlineObject yang berisi gambar di lokasi yang ditentukan.

Representasi JSON 
{
  "uri": string,
  "objectSize": {
    object (Size)
  },

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Kolom
uri

string

URI gambar.

Gambar diambil satu kali pada waktu penyisipan dan salinan disimpan untuk ditampilkan di dalam dokumen. Gambar harus berukuran kurang dari 50 MB, tidak boleh melebihi 25 megapiksel, dan harus menggunakan salah satu format PNG, JPEG, atau GIF.

URI yang disediakan harus dapat diakses secara publik dan panjangnya maksimum 2 kB. URI itu sendiri disimpan dengan gambar, dan ditampilkan melalui kolom ImageProperties.content_uri.

objectSize

object (Size)

Ukuran gambar yang akan ditampilkan seperti dalam dokumen. Properti ini bersifat opsional dan ukuran akhir gambar dalam dokumen ditentukan oleh aturan berikut: * Jika lebar atau tinggi tidak ditentukan, ukuran default gambar akan dihitung berdasarkan resolusinya. * Jika satu dimensi ditentukan, dimensi lain akan dihitung untuk mempertahankan rasio lebar tinggi gambar. * Jika lebar dan tinggi ditentukan, gambar akan disesuaikan dengan dimensi yang disediakan sambil mempertahankan rasio lebar tingginya.

Kolom union insertion_location. Lokasi tempat gambar akan disisipkan. insertion_location hanya dapat berupa salah satu dari berikut:
location

object (Location)

Menyisipkan gambar pada indeks tertentu dalam dokumen.

Gambar harus disisipkan di dalam batas Paragraph yang ada. Misalnya, nilai tersebut tidak dapat disisipkan pada indeks awal tabel (yaitu antara tabel dan paragraf sebelumnya).

Gambar inline tidak dapat disisipkan di dalam catatan kaki atau persamaan.

endOfSegmentLocation

object (EndOfSegmentLocation)

Menyisipkan teks di akhir header, footer, atau isi dokumen.

Gambar inline tidak dapat disisipkan di dalam catatan kaki.

MasukkanTabel

Menyisipkan tabel di lokasi yang ditentukan.

Karakter baris baru akan disisipkan sebelum tabel yang disisipkan.

Representasi JSON 
{
  "rows": integer,
  "columns": integer,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Kolom
rows

integer

Jumlah baris dalam tabel.

columns

integer

Jumlah kolom dalam tabel.

Kolom union insertion_location. Lokasi tempat tabel akan disisipkan. insertion_location hanya dapat berupa salah satu dari berikut:
location

object (Location)

Menyisipkan tabel pada indeks model tertentu.

Karakter baris baru akan disisipkan sebelum tabel yang disisipkan, sehingga indeks awal tabel akan berada di indeks lokasi yang ditentukan + 1.

Tabel harus disisipkan di dalam batas Paragraph yang ada. Misalnya, tabel tersebut tidak dapat disisipkan pada indeks awal tabel (yaitu antara tabel yang ada dan paragraf sebelumnya).

Tabel tidak dapat disisipkan di dalam catatan kaki atau persamaan.

endOfSegmentLocation

object (EndOfSegmentLocation)

Menyisipkan tabel di akhir header, footer, atau isi dokumen tertentu. Karakter baris baru akan disisipkan sebelum tabel yang disisipkan.

Tabel tidak dapat disisipkan di dalam catatan kaki.

SisipkanTabelTabel

Menyisipkan baris kosong ke dalam tabel.

Representasi JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}
Kolom
tableCellLocation

object (TableCellLocation)

Lokasi sel tabel referensi tempat baris akan disisipkan.

Baris baru akan disisipkan di atas (atau di bawah) baris tempat sel referensi berada. Jika sel referensi adalah sel gabungan, baris baru akan disisipkan di atas (atau di bawah) sel gabungan.

insertBelow

boolean

Apakah baris baru akan disisipkan di bawah lokasi sel referensi.

  • True : masukkan di bawah sel.
  • False : sisipkan di atas sel.

LokasiTabel

Lokasi satu sel dalam tabel.

Representasi JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}
Kolom
tableStartLocation

object (Location)

Lokasi tempat tabel dimulai di dokumen.

rowIndex

integer

Indeks baris berbasis nol. Misalnya, baris kedua dalam tabel memiliki indeks baris 1.

columnIndex

integer

Indeks kolom berbasis nol. Misalnya, kolom kedua dalam tabel memiliki indeks kolom 1.

SisipkanTableColumnRequest

Menyisipkan kolom kosong ke tabel.

Representasi JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}
Kolom
tableCellLocation

object (TableCellLocation)

Lokasi sel tabel referensi tempat kolom akan disisipkan.

Kolom baru akan dimasukkan ke sebelah kiri (atau kanan) kolom tempat sel referensi berada. Jika sel referensi adalah sel gabungan, kolom baru akan disisipkan di sebelah kiri (atau kanan) sel gabungan.

insertRight

boolean

Apakah kolom baru akan disisipkan di sebelah kanan lokasi sel referensi.

  • True : masukkan ke sebelah kanan.
  • False : masukkan ke kiri.

MenghapusTableRowRequest

Menghapus baris dari tabel.

Representasi JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
Kolom
tableCellLocation

object (TableCellLocation)

Lokasi sel tabel referensi tempat baris akan dihapus.

Baris span sel ini akan dihapus. Jika ini adalah sel gabungan yang mencakup beberapa baris, semua baris yang mencakup sel akan dihapus. Jika tidak ada baris yang tersisa di tabel setelah penghapusan ini, seluruh tabel akan dihapus.

MenghapusTableColumnRequest

Menghapus kolom dari tabel.

Representasi JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
Kolom
tableCellLocation

object (TableCellLocation)

Lokasi sel tabel referensi tempat kolom akan dihapus.

Kolom span sel ini akan dihapus. Jika ini adalah sel gabungan yang mencakup beberapa kolom, semua kolom yang mencakup sel akan dihapus. Jika tidak ada kolom yang tersisa di tabel setelah penghapusan ini, seluruh tabel akan dihapus.

InsertPageBreakRequest

Menyisipkan batas halaman, diikuti dengan baris baru di lokasi yang ditentukan.

Representasi JSON 
{

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Kolom
Kolom union insertion_location. Lokasi tempat batas halaman akan disisipkan. insertion_location hanya dapat berupa salah satu dari berikut:
location

object (Location)

Menyisipkan batas halaman pada indeks tertentu dalam dokumen.

Batas halaman harus disisipkan di dalam batas Paragraph yang ada. Misalnya, nilai tersebut tidak dapat disisipkan pada indeks awal tabel (yaitu antara tabel dan paragraf sebelumnya).

Batas halaman tidak dapat disisipkan di dalam tabel, persamaan, catatan kaki, header, atau footer. Karena batas halaman hanya dapat disisipkan di dalam isi, kolom segment ID harus kosong.

endOfSegmentLocation

object (EndOfSegmentLocation)

Menyisipkan batas halaman di akhir isi dokumen.

Batas halaman tidak dapat disisipkan di dalam catatan kaki, header, atau footer. Karena batas halaman hanya dapat disisipkan di dalam isi, kolom segment ID harus kosong.

MenghapusPositionPositionedObjectRequest

Menghapus PositionedObject dari dokumen.

Representasi JSON 
{
  "objectId": string
}
Kolom
objectId

string

ID objek yang diposisikan untuk dihapus.

UpdateTableColumnPropertiesRequest

Memperbarui TableColumnProperties kolom dalam tabel.

Representasi JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}
Kolom
tableStartLocation

object (Location)

Lokasi tempat tabel dimulai di dokumen.

columnIndices[]

integer

Daftar indeks kolom berbasis nol yang propertinya harus diperbarui. Jika tidak ada indeks yang ditentukan, semua kolom akan diperbarui.

tableColumnProperties

object (TableColumnProperties)

Properti kolom tabel yang akan diperbarui.

Jika nilai tableColumnProperties#width kurang dari 5 (5/72 inci), error permintaan 400 akan ditampilkan.

fields

string (FieldMask format)

Kolom yang harus diperbarui.

Setidaknya satu kolom harus ditentukan. Root tableColumnProperties bersifat implisit dan tidak boleh ditentukan. Satu "*" dapat digunakan sebagai singkatan untuk mencantumkan setiap kolom.

Misalnya untuk memperbarui lebar kolom, tetapkan fields ke "width".

MengupdateTableCellStyleRequest

Memperbarui gaya rentang sel tabel.

Representasi JSON 
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "fields": string,

  // Union field cells can be only one of the following:
  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
  // End of list of possible types for union field cells.
}
Kolom
tableCellStyle

object (TableCellStyle)

Gaya yang akan ditetapkan pada sel tabel.

Saat memperbarui batas, jika sel berbagi batas dengan sel yang berdekatan, properti batas yang sesuai dari sel yang berdekatan juga diperbarui. Batas yang digabungkan dan tidak terlihat tidak diperbarui.

Karena memperbarui batas yang dibagikan oleh sel yang berdekatan dalam permintaan yang sama dapat menyebabkan pembaruan batas yang bertentangan, pembaruan batas diterapkan dalam urutan berikut:

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string (FieldMask format)

Kolom yang harus diperbarui.

Setidaknya satu kolom harus ditentukan. Root tableCellStyle bersifat implisit dan tidak boleh ditentukan. Satu "*" dapat digunakan sebagai singkatan untuk mencantumkan setiap kolom.

Misalnya untuk memperbarui warna latar belakang sel tabel, tetapkan fields ke "backgroundColor".

Untuk mereset properti ke nilai defaultnya, sertakan nama kolomnya dalam mask kolom, tetapi kosongkan kolomnya.

Kolom union cells. Sel yang akan diperbarui. cells hanya dapat berupa salah satu dari berikut:
tableRange

object (TableRange)

Rentang tabel yang mewakili subset tabel yang menerapkan update.

tableStartLocation

object (Location)

Lokasi tempat tabel dimulai di dokumen. Jika ditentukan, update akan diterapkan ke semua sel dalam tabel.

RentangTabel

Rentang tabel mewakili referensi ke subkumpulan tabel.

Penting untuk diperhatikan bahwa sel yang ditentukan oleh rentang tabel tidak harus berbentuk persegi panjang. Misalnya, kita memiliki tabel 3 x 3 yang semua sel di baris terakhir digabungkan. Tabel tersebut terlihat seperti ini: 

 [   ][   ][   ]
 [   ][   ][   ]
 [             ]

Rentang tabel dengan lokasi sel tabel = (tableStartLocation, baris = 0, kolom = 0), span baris = 3, dan span kolom = 2 akan menentukan sel berikut: 

 [ x ][ x ][   ]
 [ x ][ x ][   ]
 [ x    x    x ]
Representasi JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}
Kolom
tableCellLocation

object (TableCellLocation)

Lokasi sel tempat rentang tabel dimulai.

rowSpan

integer

Span baris dari rentang tabel.

columnSpan

integer

Span kolom dari rentang tabel.

UpdateTableRowStyleRequest

Memperbarui TableRowStyle baris dalam tabel.

Representasi JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}
Kolom
tableStartLocation

object (Location)

Lokasi tempat tabel dimulai di dokumen.

rowIndices[]

integer

Daftar indeks baris berbasis nol yang gayanya harus diperbarui. Jika tidak ada indeks yang ditentukan, semua baris akan diperbarui.

tableRowStyle

object (TableRowStyle)

Gaya yang akan ditetapkan pada baris.

fields

string (FieldMask format)

Kolom yang harus diperbarui.

Setidaknya satu kolom harus ditentukan. Root tableRowStyle bersifat implisit dan tidak boleh ditentukan. Satu "*" dapat digunakan sebagai singkatan untuk mencantumkan setiap kolom.

Misalnya untuk memperbarui tinggi baris minimum, tetapkan fields ke "minRowHeight".

GantiGambarPermintaan

Menggantikan gambar yang ada dengan gambar baru.

Mengganti gambar akan menghapus beberapa image effects dari gambar yang ada untuk mencerminkan perilaku editor Dokumen.

Representasi JSON 
{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod)
}
Kolom
imageObjectId

string

ID gambar yang ada yang akan diganti. ID dapat diambil dari respons permintaan get.

uri

string

URI gambar baru.

Gambar diambil satu kali pada waktu penyisipan dan salinan disimpan untuk ditampilkan di dalam dokumen. Gambar harus kurang dari 50 MB, tidak boleh melebihi 25 megapiksel, dan harus memiliki format PNG, JPEG, atau GIF.

URI yang disediakan tidak boleh melebihi panjang 2 KB. URI disimpan dengan gambar, dan ditampilkan melalui kolom ImageProperties.source_uri.

imageReplaceMethod

enum (ImageReplaceMethod)

Metode penggantian.

ImageReplaceMethod

Metode penggantian gambar.

Enumerasi
IMAGE_REPLACE_METHOD_UNSPECIFIED Metode penggantian gambar tidak ditentukan. Nilai ini tidak boleh digunakan.
CENTER_CROP Menskalakan dan memusatkan gambar untuk mengisi batas gambar asli. Gambar dapat dipangkas untuk mengisi batas gambar asli. Ukuran gambar yang dirender akan sama dengan ukuran gambar asli.

UpdateDocumentStyleRequest

Mengupdate DocumentStyle.

Representasi JSON 
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string
}
Kolom
documentStyle

object (DocumentStyle)

Gaya yang akan ditetapkan pada dokumen.

Perubahan gaya dokumen tertentu dapat menyebabkan perubahan lain untuk mencerminkan perilaku editor Dokumen. Lihat dokumentasi DocumentStyle untuk informasi selengkapnya.

fields

string (FieldMask format)

Kolom yang harus diperbarui.

Setidaknya satu kolom harus ditentukan. Root documentStyle bersifat implisit dan tidak boleh ditentukan. Satu "*" dapat digunakan sebagai singkatan untuk mencantumkan setiap kolom.

Misalnya, untuk mengupdate latar belakang, tetapkan fields ke "background".

MergeTableCellsRequest

Menggabungkan sel dalam Table.

Representasi JSON 
{
  "tableRange": {
    object (TableRange)
  }
}
Kolom
tableRange

object (TableRange)

Rentang tabel yang menentukan sel tabel yang akan digabungkan.

Teks apa pun dalam sel yang digabungkan akan digabungkan dan disimpan dalam sel "head" rentang. Ini adalah sel kiri atas rentang saat arah konten dari kiri ke kanan, dan sel kanan atas rentang.

Jika rentang tersebut bukan persegi panjang (yang dapat terjadi dalam beberapa kasus dengan rentang tersebut mencakup sel yang sudah digabung atau yang tabelnya tidak persegi panjang), error permintaan 400 akan ditampilkan.

UnmergeTableCellsRequest

Pisahkan sel dalam Table.

Representasi JSON 
{
  "tableRange": {
    object (TableRange)
  }
}
Kolom
tableRange

object (TableRange)

Rentang tabel yang menentukan sel tabel yang akan dipisah.

Semua sel gabungan dalam rentang ini akan dipisahkan, dan sel yang sudah terpisah tidak akan terpengaruh. Jika rentang tidak memiliki sel yang digabungkan, permintaan tidak akan melakukan apa pun.

Jika ada teks di salah satu sel yang digabungkan, teks akan tetap berada di sel "kepala" dari blok sel yang dihasilkan. Sel "kepala" adalah sel kiri atas jika arah konten dari kiri ke kanan, dan kanan atas jika sebaliknya.

CreateHeaderRequest

Membuat Header. Header baru diterapkan ke SectionStyle di lokasi SectionBreak jika ditentukan, jika tidak, header tersebut diterapkan ke DocumentStyle.

Jika header jenis yang ditentukan sudah ada, error permintaan 400 yang buruk akan ditampilkan.

Representasi JSON 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Kolom
type

enum (HeaderFooterType)

Jenis header yang akan dibuat.

sectionBreakLocation

object (Location)

Lokasi SectionBreak yang memulai bagian yang seharusnya untuk header ini. Jika `sectionBreakLocation' tidak ditetapkan atau mengacu pada batas bagian pertama dalam isi dokumen, header akan berlaku untuk DocumentStyle

JenisFooterHeader

Jenis header dan footer yang dapat dibuat.

Enumerasi
DEFAULT Header/footer default.

MembuatFooterRequest

Membuat Footer. Footer baru diterapkan ke SectionStyle di lokasi SectionBreak jika ditentukan, jika tidak, footer tersebut diterapkan ke DocumentStyle.

Jika footer jenis yang ditentukan sudah ada, error permintaan 400 yang buruk akan ditampilkan.

Representasi JSON 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Kolom
type

enum (HeaderFooterType)

Jenis footer yang akan dibuat.

sectionBreakLocation

object (Location)

Lokasi SectionBreak tepat sebelum bagian yang SectionStyle tempat footer ini seharusnya berada. Jika tidak ditetapkan atau merujuk pada batas bagian pertama dalam dokumen, footer akan berlaku untuk gaya dokumen.

CreateFootnoteRequest

Membuat segmen Footnote dan menyisipkan FootnoteReference baru ke lokasi yang ditentukan.

Segmen Footnote baru akan berisi spasi yang diikuti dengan karakter baris baru.

Representasi JSON 
{

  // Union field footnote_reference_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field footnote_reference_location.
}
Kolom
Kolom union footnote_reference_location. Lokasi untuk menyisipkan referensi catatan kaki. footnote_reference_location hanya dapat berupa salah satu dari berikut:
location

object (Location)

Menyisipkan referensi catatan kaki di indeks tertentu dalam dokumen.

Referensi catatan kaki harus dimasukkan ke dalam batas Paragraph yang ada. Misalnya, nilai tersebut tidak dapat disisipkan pada indeks awal tabel (yaitu antara tabel dan paragraf sebelumnya).

Referensi catatan kaki tidak dapat disisipkan di dalam persamaan, header, footer, atau catatan kaki. Karena referensi catatan kaki hanya dapat disisipkan dalam isi, kolom segment ID harus kosong.

endOfSegmentLocation

object (EndOfSegmentLocation)

Menyisipkan referensi catatan kaki di akhir isi dokumen.

Referensi catatan kaki tidak dapat disisipkan di dalam header, footer, atau catatan kaki. Karena referensi catatan kaki hanya dapat disisipkan dalam isi, kolom segment ID harus kosong.

GantiNamedRangeContentRequest

Mengganti konten NamedRange atau NamedRanges yang ditentukan dengan konten pengganti yang diberikan.

Perhatikan bahwa satu NamedRange dapat terdiri dari beberapa ranges yang terputus-putus. Dalam hal ini, hanya konten di rentang pertama yang akan diganti. Rentang lain dan kontennya akan dihapus.

Jika mengganti atau menghapus rentang akan mengakibatkan struktur dokumen tidak valid, error permintaan 400 akan ditampilkan.

Representasi JSON 
{

  // Union field replacement_content can be only one of the following:
  "text": string
  // End of list of possible types for union field replacement_content.

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "namedRangeName": string
  // End of list of possible types for union field named_range_reference.
}
Kolom
Kolom union replacement_content. Konten yang akan menggantikan konten yang ada dari rentang bernama. replacement_content hanya dapat berupa salah satu dari berikut:
text

string

Mengganti konten rentang bernama yang ditentukan dengan teks tertentu.

Kolom union named_range_reference. Referensi ke rentang bernama yang kontennya akan diganti. named_range_reference hanya dapat berupa salah satu dari berikut:
namedRangeId

string

ID rentang bernama yang kontennya akan diganti.

Jika tidak ada rentang yang dinamai dengan ID yang diberikan, error permintaan 400 yang buruk akan ditampilkan.

namedRangeName

string

Nama NamedRanges yang kontennya akan diganti.

Jika ada beberapa named ranges dengan nama yang diberikan, maka setiap konten akan diganti. Jika tidak ada rentang bernama dengan nama yang ditentukan, permintaan tidak akan dioperasikan.

UpdateSectionStyleRequest

Mengupdate SectionStyle.

Representasi JSON 
{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}
Kolom
range

object (Range)

Rentang tumpang tindih bagian untuk menata gaya.

Karena batas bagian hanya dapat disisipkan di dalam isi, kolom segment ID harus kosong.

sectionStyle

object (SectionStyle)

Gaya yang akan ditetapkan pada bagian.

Perubahan gaya bagian tertentu dapat menyebabkan perubahan lain untuk mencerminkan perilaku editor Dokumen. Lihat dokumentasi SectionStyle untuk informasi selengkapnya.

fields

string (FieldMask format)

Kolom yang harus diperbarui.

Setidaknya satu kolom harus ditentukan. Root sectionStyle bersifat implisit dan tidak boleh ditentukan. Satu "*" dapat digunakan sebagai singkatan untuk mencantumkan setiap kolom.

Misalnya untuk memperbarui margin kiri, tetapkan fields ke "marginLeft".

InsertSectionBreakRequest

Menyisipkan batas bagian di lokasi tertentu.

Karakter baris baru akan disisipkan sebelum batas bagian.

Representasi JSON 
{
  "sectionType": enum (SectionType),

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Kolom
sectionType

enum (SectionType)

Jenis bagian yang akan disisipkan.

Kolom union insertion_location. Lokasi tempat jeda akan disisipkan. insertion_location hanya dapat berupa salah satu dari berikut:
location

object (Location)

Menyisipkan baris baru dan batas bagian di indeks tertentu dalam dokumen.

Batas bagian harus disisipkan di dalam batas Paragraph yang ada. Misalnya, nilai tersebut tidak dapat disisipkan pada indeks awal tabel (yaitu antara tabel dan paragraf sebelumnya).

Batas bagian tidak dapat disisipkan di dalam tabel, persamaan, catatan kaki, header, atau footer. Karena batas bagian hanya dapat disisipkan di dalam isi, kolom segment ID harus kosong.

endOfSegmentLocation

object (EndOfSegmentLocation)

Menyisipkan baris baru dan batas bagian di akhir isi dokumen.

Batas bagian tidak dapat disisipkan di dalam catatan kaki, header, atau footer. Karena batas bagian hanya dapat disisipkan di dalam isi, kolom segment ID harus kosong.

HapusHeaderRequest

Menghapus Header dari dokumen.

Representasi JSON 
{
  "headerId": string
}
Kolom
headerId

string

ID header yang akan dihapus. Jika header ini ditentukan pada DocumentStyle, referensi ke header ini akan dihapus, sehingga tidak ada header dari jenis tersebut untuk bagian pertama dokumen. Jika header ini ditentukan pada SectionStyle, referensi ke header ini akan dihapus dan header jenis tersebut sekarang akan dilanjutkan dari bagian sebelumnya.

MenghapusFooterRequest

Menghapus Footer dari dokumen.

Representasi JSON 
{
  "footerId": string
}
Kolom
footerId

string

ID footer yang akan dihapus. Jika footer ini ditentukan pada DocumentStyle, referensi ke footer ini akan dihapus, sehingga tidak ada footer dari jenis tersebut untuk bagian pertama dokumen. Jika footer ini ditentukan di SectionStyle, referensi ke footer ini akan dihapus dan footer dari jenis tersebut sekarang dilanjutkan dari bagian sebelumnya.

PinTableHeaderRowsRequest

Memperbarui jumlah baris header tabel yang disematkan dalam tabel.

Representasi JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}
Kolom
tableStartLocation

object (Location)

Lokasi tempat tabel dimulai di dokumen.

pinnedHeaderRowsCount

integer

Jumlah baris tabel yang akan disematkan, dengan 0 menunjukkan bahwa semua baris tidak disematkan.